feat: Set $feature_flag_error on $feature_flag_called (#94)

dustinbyrne · web-flow · commit 04e4df012a50 · 2025-12-19T17:00:48.000-05:00
* feat: Set `$feature_flag_error` on `$feature_flag_called`

* chore: phpcs lint warnings

* chore: Ignore side effect warning

It's due to us requiring error_log_mock
diff --git a/lib/Client.php b/lib/Client.php
@@ -260,6 +260,7 @@ public function getFeatureFlag(
             $groupProperties
         );
         $result = null;
+        $featureFlagError = null;
 
         foreach ($this->featureFlags as $flag) {
             if ($flag["key"] == $key) {
@@ -290,17 +291,48 @@ public function getFeatureFlag(
         if (!$flagWasEvaluatedLocally && !$onlyEvaluateLocally) {
             try {
                 $response = $this->fetchFlagsResponse($distinctId, $groups, $personProperties, $groupProperties);
+                $errors = [];
+
+                if (isset($response['errorsWhileComputingFlags']) && $response['errorsWhileComputingFlags']) {
+                    $errors[] = FeatureFlagError::ERRORS_WHILE_COMPUTING_FLAGS;
+                }
+
                 $requestId = isset($response['requestId']) ? $response['requestId'] : null;
                 $evaluatedAt = isset($response['evaluatedAt']) ? $response['evaluatedAt'] : null;
                 $flagDetail = isset($response['flags'][$key]) ? $response['flags'][$key] : null;
                 $featureFlags = $response['featureFlags'] ?? [];
                 if (array_key_exists($key, $featureFlags)) {
                     $result = $featureFlags[$key];
                 } else {
+                    $errors[] = FeatureFlagError::FLAG_MISSING;
                     $result = null;
                 }
+
+                if (!empty($errors)) {
+                    $featureFlagError = implode(',', $errors);
+                }
+            } catch (HttpException $e) {
+                error_log("[PostHog][Client] Unable to get feature variants: " . $e->getMessage());
+                switch ($e->getErrorType()) {
+                    case HttpException::QUOTA_LIMITED:
+                        $featureFlagError = FeatureFlagError::QUOTA_LIMITED;
+                        break;
+                    case HttpException::TIMEOUT:
+                        $featureFlagError = FeatureFlagError::TIMEOUT;
+                        break;
+                    case HttpException::CONNECTION_ERROR:
+                        $featureFlagError = FeatureFlagError::CONNECTION_ERROR;
+                        break;
+                    case HttpException::API_ERROR:
+                        $featureFlagError = FeatureFlagError::apiError($e->getStatusCode());
+                        break;
+                    default:
+                        $featureFlagError = FeatureFlagError::UNKNOWN_ERROR;
+                }
+                $result = null;
             } catch (Exception $e) {
-                error_log("[PostHog][Client] Unable to get feature variants:" . $e->getMessage());
+                error_log("[PostHog][Client] Unable to get feature variants: " . $e->getMessage());
+                $featureFlagError = FeatureFlagError::UNKNOWN_ERROR;
                 $result = null;
             }
         }
@@ -325,6 +357,10 @@ public function getFeatureFlag(
                 $properties['$feature_flag_reason'] = $flagDetail['reason']['description'];
             }
 
+            if (!is_null($featureFlagError)) {
+                $properties['$feature_flag_error'] = $featureFlagError;
+            }
+
             $this->capture([
                 "properties" => $properties,
                 "distinct_id" => $distinctId,
@@ -355,10 +391,7 @@ public function getFeatureFlagPayload(
         array $personProperties = array(),
         array $groupProperties = array(),
     ): mixed {
-        $results = json_decode(
-            $this->flags($distinctId, $groups, $personProperties, $groupProperties),
-            true
-        );
+        $results = $this->flags($distinctId, $groups, $personProperties, $groupProperties);
 
         if (isset($results['featureFlags'][$key]) === false || $results['featureFlags'][$key] !== true) {
             return null;
@@ -517,10 +550,7 @@ private function fetchFlagsResponse(
         array $personProperties = [],
         array $groupProperties = []
     ): ?array {
-        return json_decode(
-            $this->flags($distinctId, $groups, $personProperties, $groupProperties),
-            true
-        );
+        return $this->flags($distinctId, $groups, $personProperties, $groupProperties);
     }
 
     /**
@@ -600,9 +630,39 @@ public function getFlagsEtag(): ?string
         return $this->flagsEtag;
     }
 
-    private function normalizeFeatureFlags(string $response): string
+    /**
+     * Normalize feature flags response to ensure consistent format.
+     * Decodes JSON, checks for quota limits, and transforms v4 to v3 format.
+     *
+     * @param string $response The raw JSON response
+     * @return array The normalized response
+     * @throws HttpException On invalid JSON or quota limit
+     */
+    private function normalizeFeatureFlags(string $response): array
     {
         $decoded = json_decode($response, true);
+
+        if (!is_array($decoded)) {
+            throw new HttpException(
+                HttpException::API_ERROR,
+                0,
+                "Invalid JSON response"
+            );
+        }
+
+        // Check for quota limit in response body
+        if (
+            isset($decoded['quotaLimited'])
+            && is_array($decoded['quotaLimited'])
+            && in_array('feature_flags', $decoded['quotaLimited'])
+        ) {
+            throw new HttpException(
+                HttpException::QUOTA_LIMITED,
+                0,
+                "Feature flags quota limited"
+            );
+        }
+
         if (isset($decoded['flags']) && !empty($decoded['flags'])) {
             // This is a v4 response, we need to transform it to a v3 response for backwards compatibility
             $transformedFlags = [];
@@ -619,18 +679,27 @@ private function normalizeFeatureFlags(string $response): string
             }
             $decoded['featureFlags'] = $transformedFlags;
             $decoded['featureFlagPayloads'] = $transformedPayloads;
-            return json_encode($decoded);
         }
 
-        return $response;
+        return $decoded;
     }
 
+    /**
+     * Fetch feature flags from the PostHog API.
+     *
+     * @param string $distinctId The user's distinct ID
+     * @param array $groups Group identifiers
+     * @param array $personProperties Person properties for flag evaluation
+     * @param array $groupProperties Group properties for flag evaluation
+     * @return array The normalized feature flags response
+     * @throws HttpException On network errors, API errors, or quota limits
+     */
     public function flags(
         string $distinctId,
         array $groups = array(),
         array $personProperties = [],
         array $groupProperties = []
-    ) {
+    ): array {
         $payload = array(
             'api_key' => $this->apiKey,
             'distinct_id' => $distinctId,
@@ -648,7 +717,7 @@ public function flags(
             $payload["group_properties"] = $groupProperties;
         }
 
-        $response = $this->httpClient->sendRequest(
+        $httpResponse = $this->httpClient->sendRequest(
             '/flags/?v=2',
             json_encode($payload),
             [
@@ -659,9 +728,42 @@ public function flags(
                 "shouldRetry" => false,
                 "timeout" => $this->featureFlagsRequestTimeout
             ]
-        )->getResponse();
+        );
+
+        $responseCode = $httpResponse->getResponseCode();
+        $curlErrno = $httpResponse->getCurlErrno();
+
+        if ($responseCode === 0) {
+            // CURLE_OPERATION_TIMEDOUT (28)
+            // https://curl.se/libcurl/c/libcurl-errors.html
+            if ($curlErrno === 28) {
+                throw new HttpException(
+                    HttpException::TIMEOUT,
+                    0,
+                    "Request timed out"
+                );
+            }
+            // Consider everything else a connection error
+            // CURLE_COULDNT_RESOLVE_HOST (6)
+            // CURLE_COULDNT_CONNECT (7)
+            // CURLE_WEIRD_SERVER_REPLY (8)
+            // etc.
+            throw new HttpException(
+                HttpException::CONNECTION_ERROR,
+                0,
+                "Connection error (curl errno: {$curlErrno})"
+            );
+        }
+
+        if ($responseCode >= 400) {
+            throw new HttpException(
+                HttpException::API_ERROR,
+                $responseCode,
+                "API error: HTTP {$responseCode}"
+            );
+        }
 
-        return $this->normalizeFeatureFlags($response);
+        return $this->normalizeFeatureFlags($httpResponse->getResponse());
     }
 
     /**
diff --git a/lib/FeatureFlagError.php b/lib/FeatureFlagError.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace PostHog;
+
+class FeatureFlagError
+{
+    /**
+     * Server returned errorsWhileComputingFlags=true
+     */
+    public const ERRORS_WHILE_COMPUTING_FLAGS = 'errors_while_computing_flags';
+
+    /**
+     * Requested flag not in API response
+     */
+    public const FLAG_MISSING = 'flag_missing';
+
+    /**
+     * Rate/quota limit exceeded
+     */
+    public const QUOTA_LIMITED = 'quota_limited';
+
+    /**
+     * Request timed out
+     */
+    public const TIMEOUT = 'timeout';
+
+    /**
+     * Network connectivity issue
+     */
+    public const CONNECTION_ERROR = 'connection_error';
+
+    /**
+     * Unexpected exceptions
+     */
+    public const UNKNOWN_ERROR = 'unknown_error';
+
+    /**
+     * Create an API error with HTTP status code
+     *
+     * @param int $status HTTP status code
+     * @return string Error string in format "api_error_{status}"
+     */
+    public static function apiError(int $status): string
+    {
+        return "api_error_{$status}";
+    }
+}
diff --git a/lib/HttpClient.php b/lib/HttpClient.php
@@ -155,6 +155,7 @@ private function executePost($ch, bool $includeEtag = false): HttpResponse
     {
         $response = curl_exec($ch);
         $responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
+        $curlErrno = curl_errno($ch);
         $etag = null;
 
         if ($includeEtag && $response !== false) {
@@ -168,10 +169,10 @@ private function executePost($ch, bool $includeEtag = false): HttpResponse
                 $etag = trim($matches[1]);
             }
 
-            return new HttpResponse($body, $responseCode, $etag);
+            return new HttpResponse($body, $responseCode, $etag, $curlErrno);
         }
 
-        return new HttpResponse($response, $responseCode);
+        return new HttpResponse($response, $responseCode, null, $curlErrno);
     }
 
     private function handleError($code, $message)
diff --git a/lib/HttpException.php b/lib/HttpException.php
@@ -0,0 +1,74 @@
+<?php
+
+namespace PostHog;
+
+/**
+ * Exception for HTTP-related errors during API requests.
+ *
+ * This exception captures both the error type and HTTP status code
+ * to enable specific error handling for different failure scenarios.
+ */
+class HttpException extends \Exception
+{
+    /**
+     * Request timed out
+     */
+    public const TIMEOUT = 'timeout';
+
+    /**
+     * Network connectivity issue
+     */
+    public const CONNECTION_ERROR = 'connection_error';
+
+    /**
+     * Rate/quota limit exceeded
+     */
+    public const QUOTA_LIMITED = 'quota_limited';
+
+    /**
+     * HTTP 4xx/5xx error from API
+     */
+    public const API_ERROR = 'api_error';
+
+    /**
+     * @var string
+     */
+    private string $errorType;
+
+    /**
+     * @var int
+     */
+    private int $statusCode;
+
+    /**
+     * @param string $errorType One of the error type constants (TIMEOUT, CONNECTION_ERROR, etc.)
+     * @param int $statusCode HTTP status code (0 for connection/timeout errors)
+     * @param string $message Error message
+     */
+    public function __construct(string $errorType, int $statusCode = 0, string $message = '')
+    {
+        $this->errorType = $errorType;
+        $this->statusCode = $statusCode;
+        parent::__construct($message);
+    }
+
+    /**
+     * Get the error type constant
+     *
+     * @return string One of TIMEOUT, CONNECTION_ERROR, QUOTA_LIMITED, API_ERROR
+     */
+    public function getErrorType(): string
+    {
+        return $this->errorType;
+    }
+
+    /**
+     * Get the HTTP status code
+     *
+     * @return int HTTP status code (0 for connection/timeout errors)
+     */
+    public function getStatusCode(): int
+    {
+        return $this->statusCode;
+    }
+}
diff --git a/lib/HttpResponse.php b/lib/HttpResponse.php
@@ -7,12 +7,14 @@ class HttpResponse
     private $response;
     private $responseCode;
     private $etag;
+    private $curlErrno;
 
-    public function __construct($response, $responseCode, ?string $etag = null)
+    public function __construct($response, $responseCode, ?string $etag = null, int $curlErrno = 0)
     {
         $this->response = $response;
         $this->responseCode = $responseCode;
         $this->etag = $etag;
+        $this->curlErrno = $curlErrno;
     }
 
     /**
@@ -48,4 +50,14 @@ public function isNotModified(): bool
     {
         return $this->responseCode === 304;
     }
+
+    /**
+     * Get the curl error number (0 if no error)
+     *
+     * @return int
+     */
+    public function getCurlErrno(): int
+    {
+        return $this->curlErrno;
+    }
 }
diff --git a/test/FeatureFlagErrorTest.php b/test/FeatureFlagErrorTest.php
diff --git a/test/MockedHttpClient.php b/test/MockedHttpClient.php

Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,7 @@ private function executePost($ch, bool $includeEtag = false): HttpResponse`
`155`	`155`	`{`
`156`	`156`	`$response = curl_exec($ch);`
`157`	`157`	`$responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);`
	`158`	`+ $curlErrno = curl_errno($ch);`
`158`	`159`	`$etag = null;`
`159`	`160`
`160`	`161`	`if ($includeEtag && $response !== false) {`
`@@ -168,10 +169,10 @@ private function executePost($ch, bool $includeEtag = false): HttpResponse`
`168`	`169`	`$etag = trim($matches[1]);`
`169`	`170`	`}`
`170`	`171`
`171`		`- return new HttpResponse($body, $responseCode, $etag);`
	`172`	`+ return new HttpResponse($body, $responseCode, $etag, $curlErrno);`
`172`	`173`	`}`
`173`	`174`
`174`		`- return new HttpResponse($response, $responseCode);`
	`175`	`+ return new HttpResponse($response, $responseCode, null, $curlErrno);`
`175`	`176`	`}`
`176`	`177`
`177`	`178`	`private function handleError($code, $message)`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,14 @@ class HttpResponse`
`7`	`7`	`private $response;`
`8`	`8`	`private $responseCode;`
`9`	`9`	`private $etag;`
	`10`	`+ private $curlErrno;`
`10`	`11`
`11`		`- public function __construct($response, $responseCode, ?string $etag = null)`
	`12`	`+ public function __construct($response, $responseCode, ?string $etag = null, int $curlErrno = 0)`
`12`	`13`	`{`
`13`	`14`	`$this->response = $response;`
`14`	`15`	`$this->responseCode = $responseCode;`
`15`	`16`	`$this->etag = $etag;`
	`17`	`+ $this->curlErrno = $curlErrno;`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`/**`
`@@ -48,4 +50,14 @@ public function isNotModified(): bool`
`48`	`50`	`{`
`49`	`51`	`return $this->responseCode === 304;`
`50`	`52`	`}`
	`53`	`+`
	`54`	`+ /**`
	`55`	`+ * Get the curl error number (0 if no error)`
	`56`	`+ *`
	`57`	`+ * @return int`
	`58`	`+ */`
	`59`	`+ public function getCurlErrno(): int`
	`60`	`+ {`
	`61`	`+ return $this->curlErrno;`
	`62`	`+ }`
`51`	`63`	`}`