Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/kind-waves-sip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"posthog-php": patch
"posthog-laravel": patch
---

Suppress definition-load warnings for client-only flags. Preserve PHP's fresh-response-only warning policy to avoid per-request log spam from shared-cache readers, while reconciling warning history on cache loads so flags warn again after returning from client-only runtime.
62 changes: 48 additions & 14 deletions lib/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -1772,7 +1772,7 @@ public function loadFlags()
if ($cachedData !== null) {
$normalizedData = $this->normalizeFlagDefinitionCacheData($cachedData);
if ($normalizedData !== null) {
$this->applyFlagDefinitions($normalizedData);
$this->applyFlagDefinitions($normalizedData, false);
if ($this->debug) {
error_log("[PostHog][Client] Using cached flag definitions from external cache");
}
Expand Down Expand Up @@ -1878,31 +1878,37 @@ private function fetchAndApplyFlagDefinitionsFromApi(): void
$this->flagsEtag = $response->getEtag();

$data = $this->normalizeFlagDefinitionData($payload);
$this->applyFlagDefinitions($data);
// Only a fresh response warns: PHP builds a client per request, and a 304 or a shared-cache
// load carries definitions that a fresh response already warned about.
$this->warnAboutUnresolvableFlags();
$this->applyFlagDefinitions($data, true);
$this->storeFlagDefinitionsInCacheProvider($data);
}

/**
* Warn about flags whose definition local evaluation cannot resolve. Each flag is warned about
* once per client until its definition changes.
* once per client until its definition changes. Cache loads reconcile history without emitting
* warnings on every PHP-FPM request.
*
* @param bool $emitWarnings Whether this load fetched a fresh API response.
* @return void
*/
private function warnAboutUnresolvableFlags(): void
private function warnAboutUnresolvableFlags(bool $emitWarnings): void
{
if (!$emitWarnings && $this->warnedUnresolvableFlags === []) {
return;
}

$flagKeysByReason = [
UnresolvedFlagReason::EXPERIENCE_CONTINUITY => [],
UnresolvedFlagReason::UNSUPPORTED_DEFINITION => [],
];
// Rebuilt from the current definitions, so a flag that is deleted or becomes resolvable is
// forgotten and warns again if it later returns to an unresolvable definition.
// Rebuilt from the current definitions, so deleted, resolvable or client-only flags are
// forgotten and warn again if they later return to an eligible unresolvable definition.
$warnedFlags = [];
$uncheckedFlags = [];
foreach ($this->featureFlags as $flag) {
if (!is_array($flag) || !is_string($flag['key'] ?? null)) {
if (
!is_array($flag) || !is_string($flag['key'] ?? null)
|| ($flag['evaluation_runtime'] ?? null) === 'client'
) {
continue;
}
try {
Expand All @@ -1920,13 +1926,20 @@ private function warnAboutUnresolvableFlags(): void
if ($reason === null) {
continue;
}
$fingerprint = ($flag['version'] ?? '') . ':' . sha1(serialize($flag)) . ':' . $reason;
$warnedFlags[$flag['key']] = $fingerprint;
if (($this->warnedUnresolvableFlags[$flag['key']] ?? null) !== $fingerprint) {
$fingerprint = ($flag['version'] ?? '') . ':'
. sha1(serialize($this->sortFlagDefinitionKeys($flag))) . ':' . $reason;
$alreadyWarned = ($this->warnedUnresolvableFlags[$flag['key']] ?? null) === $fingerprint;
if ($emitWarnings || $alreadyWarned) {
$warnedFlags[$flag['key']] = $fingerprint;
}
if ($emitWarnings && !$alreadyWarned) {
$flagKeysByReason[$reason][] = $flag['key'];
}
}
$this->warnedUnresolvableFlags = $warnedFlags;
if (!$emitWarnings) {
return;
}

$experienceContinuityFlags = $flagKeysByReason[UnresolvedFlagReason::EXPERIENCE_CONTINUITY];
if (count($experienceContinuityFlags) > 0) {
Expand Down Expand Up @@ -1966,6 +1979,25 @@ private function warnAboutUnresolvableFlags(): void
}
}

/**
* Sort object keys recursively for warning deduplication without changing condition list order.
*
* @param array<mixed> $definition
* @return array<mixed>
*/
private function sortFlagDefinitionKeys(array $definition): array
{
if (!array_is_list($definition)) {
ksort($definition, SORT_STRING);
}
foreach ($definition as $key => $value) {
if (is_array($value)) {
$definition[$key] = $this->sortFlagDefinitionKeys($value);
}
}
return $definition;
}

/**
* Normalize API flag definition data using SDK defaults for optional fields.
*
Expand Down Expand Up @@ -2027,9 +2059,10 @@ private function normalizeFlagDefinitionCacheData(array $data): ?array
* Apply flag definitions to in-memory state.
*
* @param array<string, mixed> $data
* @param bool $emitWarnings Whether this load fetched a fresh API response.
* @return void
*/
private function applyFlagDefinitions(array $data): void
private function applyFlagDefinitions(array $data, bool $emitWarnings): void
{
$this->featureFlags = $data['flags'];
$this->groupTypeMapping = $data['group_type_mapping'];
Expand All @@ -2046,6 +2079,7 @@ private function applyFlagDefinitions(array $data): void
}

$this->flagDefinitionsLoaded = true;
$this->warnAboutUnresolvableFlags($emitWarnings);
Comment thread
marandaneto marked this conversation as resolved.
Resolved
}

/**
Expand Down
Loading
Loading