fix linter issue

Signed-off-by: Thomas Poignant <[email protected]>

Author: thomaspoignant

providers/GoFeatureFlag/.php-cs-fixer.cache

@@ -0,0 +1 @@
+{"php":"8.0.30","version":"3.57.1","indent":"    ","lineEnding":"\n","rules":{"binary_operator_spaces":{"default":"at_least_single_space"},"blank_line_after_opening_tag":true,"blank_line_between_import_groups":true,"blank_lines_before_namespace":true,"braces_position":{"allow_single_line_empty_anonymous_classes":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_type_declaration":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_parentheses":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"imports_order":["class","function","const"],"sort_algorithm":"none"},"return_type_declaration":true,"short_scalar_cast":true,"single_import_per_statement":{"group_to_single_imports":false},"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"unary_operator_spaces":{"only_dec_inc":true},"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"control_structure_braces":true,"control_structure_continuation_position":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"attribute_placement":"ignore","on_multiline":"ensure_fully_multiline"},"no_break_comment":true,"no_closing_tag":true,"no_multiple_statements_per_line":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_line_after_imports":true,"spaces_inside_parentheses":true,"statement_indentation":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true},"hashes":{"tests\/unit\/controller\/OfrepApiTest.php":"ffc7e3ab94b4c58eb9b413fef1bef9de","tests\/unit\/GoFeatureFlagProviderTest.php":"062d381339c3bb95bd08b9fa05d1462a","tests\/TestCase.php":"efc0a05509f7101e640d29ec146c0aff","src\/util\/Validator.php":"527ab649217b08b455e0180e91817197","src\/config\/Config.php":"7a6642e67f641b823c4b1be1db0fc7d6","src\/controller\/OfrepApi.php":"bce6659287817694140d38bb23de0b60","src\/GoFeatureFlagProvider.php":"0535e5b9a10f7095225b332dadb6948b","src\/model\/OfrepApiResponse.php":"b34e7d13b252e0c6a722dbaefcbf2862","src\/exception\/RateLimitedException.php":"ac00860fc0c226c57774ddf246b7c5e0","src\/exception\/BaseGoffException.php":"18c57afd49dec676d9693c6bf3c014aa","src\/exception\/UnknownOfrepException.php":"0e429ddf9505f315e00bdb1991d4b0a9","src\/exception\/BaseOfrepException.php":"88dee34dc35e403219477ff521d7f225","src\/exception\/UnauthorizedException.php":"efb5188ddad635e8ee03bb887fa12fea","src\/exception\/InvalidConfigException.php":"34c2b8ba731cb801298ef08ddcb93f75","src\/exception\/ParseException.php":"f1a06dad98c1912857a72da31272a7d5","src\/exception\/InvalidContextException.php":"49da7c5d08ae5067d79fd053ab6adf7d","src\/exception\/FlagNotFoundException.php":"8910ff8e0f0ed12acbd5d414a5b12d5b","src\/util\/Mapper.php":"5e3e560cdad10c83da46e3e976f54bbb","src\/model\/OfrepApiSuccessResponse.php":"64ed4fbac2a5ebaa5765cc767b291c5f","src\/model\/OfrepApiErrorResponse.php":"ce96a809b1d4ec87b2794a9535a514d2"}}

providers/GoFeatureFlag/README.md

@@ -44,6 +44,7 @@ The constructor of the config object has the following options:
 | `endpoint`      | **(mandatory)** The URL to access to the relay-proxy.<br />*(example: `https://relay.proxy.gofeatureflag.org/`)* |
 | `apiKey`        | The token used to call the relay proxy.                                                                          |
 | `customHeaders` | Any headers you want to add to call the relay-proxy.                                                             |
+| `httpclient`    | The HTTP Client to use (if you want to use a custom one). _It has to be a `PSR-7` compliant implementation._     |
 
 The only required option to create a `GoFeatureFlagProvider` is the URL _(`endpoint`)_ to your GO Feature Flag relay-proxy instance.
 
@@ -62,7 +63,7 @@ $api->setProvider($provider);
 $client = $api->getClient();
 $evaluationContext = new MutableEvaluationContext(
       "214b796a-807b-4697-b3a3-42de0ec10a37", 
-      new Attributes(["email" => "[email protected]"])
+      new Attributes(["email" => '[email protected]'])
   );
 
 $value = $client->getBooleanDetails('integer_key', false, $evaluationContext);

providers/GoFeatureFlag/composer.json

@@ -18,8 +18,9 @@
   ],
   "require": {
     "php": "^8",
+    "guzzlehttp/guzzle": "^7.9",
     "open-feature/sdk": "^2.0",
-    "guzzlehttp/guzzle": "^7.9"
+    "psr/http-message": "^2.0"
   },
   "require-dev": {
     "phpunit/phpunit": "^9",
@@ -68,7 +69,7 @@
       "@dev:analyze:phpstan",
       "@dev:analyze:psalm"
     ],
-    "dev:analyze:phpstan": "phpstan analyse --ansi --debug --memory-limit=512M",
+    "dev:analyze:phpstan": "phpstan   --ansi --debug --memory-limit=512M",
     "dev:analyze:psalm": "psalm",
     "dev:build:clean": "git clean -fX build/",
     "dev:lint": [

providers/GoFeatureFlag/phpstan.neon.dist

@@ -3,9 +3,6 @@ parameters:
     level: max
     paths:
         - ./src
-        - ./tests
     excludePaths:
         - */tests/fixtures/*
         - */tests/*/fixtures/*
-        # TODO: Implement gRPC Completely
-        - ./src/grpc

providers/GoFeatureFlag/src/GoFeatureFlagProvider.php

@@ -4,6 +4,14 @@
 
 namespace OpenFeature\Providers\GoFeatureFlag;
 
+use DateTime;
+use OpenFeature\Providers\GoFeatureFlag\config\Config;
+use OpenFeature\Providers\GoFeatureFlag\controller\OfrepApi;
+use OpenFeature\Providers\GoFeatureFlag\exception\BaseOfrepException;
+use OpenFeature\Providers\GoFeatureFlag\exception\InvalidConfigException;
+use OpenFeature\Providers\GoFeatureFlag\exception\InvalidContextException;
+use OpenFeature\Providers\GoFeatureFlag\model\OfrepApiErrorResponse;
+use OpenFeature\Providers\GoFeatureFlag\util\Validator;
 use OpenFeature\implementation\common\Metadata;
 use OpenFeature\implementation\provider\AbstractProvider;
 use OpenFeature\implementation\provider\ResolutionDetailsBuilder;
@@ -13,15 +21,15 @@
 use OpenFeature\interfaces\provider\Provider;
 use OpenFeature\interfaces\provider\Reason;
 use OpenFeature\interfaces\provider\ResolutionDetails;
-use OpenFeature\Providers\GoFeatureFlag\config\Config;
-use OpenFeature\Providers\GoFeatureFlag\controller\OfrepApi;
-use OpenFeature\Providers\GoFeatureFlag\exception\BaseOfrepException;
-use OpenFeature\Providers\GoFeatureFlag\exception\InvalidConfigException;
-use OpenFeature\Providers\GoFeatureFlag\util\Validator;
+use Throwable;
+
+use function array_key_exists;
+use function gettype;
+use function implode;
 
 class GoFeatureFlagProvider extends AbstractProvider implements Provider
 {
-    protected static string $CLIENT_NAME = 'GO Feature Flag Provider';
+    protected static string $NAME = 'GO Feature Flag Provider';
     private OfrepApi $ofrepApi;
 
     /**
@@ -30,15 +38,15 @@ class GoFeatureFlagProvider extends AbstractProvider implements Provider
     public function __construct(Config $config)
     {
         Validator::validateConfig($config);
-        if (is_array($config->getCustomHeaders()) && !array_key_exists("Content-Type", $config->getCustomHeaders())) {
-            $config->getCustomHeaders()["Content-Type"] = "application/json";
+        if (!array_key_exists('Content-Type', $config->getCustomHeaders())) {
+            $config->addCustomHeader('Content-Type', 'application/json');
         }
         $this->ofrepApi = new OfrepApi($config);
     }
 
     public function getMetadata(): Metadata
     {
-        return new Metadata(self::$CLIENT_NAME);
+        return new Metadata(static::$NAME);
     }
 
     public function resolveBooleanValue(string $flagKey, bool $defaultValue, ?EvaluationContext $context = null): ResolutionDetails
@@ -47,25 +55,33 @@ public function resolveBooleanValue(string $flagKey, bool $defaultValue, ?Evalua
     }
 
     /**
+     * @param array<mixed>|array<string, mixed>|bool|DateTime|float|int|string|null $defaultValue
      * @param array<string> $allowedClasses
      */
-    private function evaluate(string $flagKey, mixed $defaultValue, array $allowedClasses, EvaluationContext $evaluationContext = null): ResolutionDetails
+    private function evaluate(string $flagKey, array | string | bool | DateTime | float | int | null $defaultValue, array $allowedClasses, ?EvaluationContext $evaluationContext = null): ResolutionDetails
     {
         try {
-            Validator::validateEvaluationContext($evaluationContext);
             Validator::validateFlagKey($flagKey);
 
+            if ($evaluationContext === null) {
+                throw new InvalidContextException('Evaluation context is null');
+            }
+            if ($evaluationContext->getTargetingKey() === null || $evaluationContext->getTargetingKey() === '') {
+                throw new InvalidContextException('Missing targetingKey in evaluation context');
+            }
+
             $apiResp = $this->ofrepApi->evaluate($flagKey, $evaluationContext);
 
-            if ($apiResp->isError()) {
+            if ($apiResp instanceof OfrepApiErrorResponse) {
                 $err = new ResolutionError(
-                    $apiResp->getErrorCode() ?? ErrorCode::GENERAL(),
-                    $apiResp->getErrorDetails()
+                    $apiResp->getErrorCode(),
+                    $apiResp->getErrorDetails(),
                 );
+
                 return (new ResolutionDetailsBuilder())
                     ->withValue($defaultValue)
                     ->withError($err)
-                    ->withReason(Reason::ERROR)
+                    ->withReason($apiResp->getReason())
                     ->build();
             }
 
@@ -74,39 +90,45 @@ private function evaluate(string $flagKey, mixed $defaultValue, array $allowedCl
                     ->withReason(Reason::ERROR)
                     ->withError(new ResolutionError(
                         ErrorCode::TYPE_MISMATCH(),
-                        "Invalid type for $flagKey, got " . gettype($apiResp->getValue()) . " expected " . implode(", ", $allowedClasses)))
+                        "Invalid type for $flagKey, got " . gettype($apiResp->getValue()) . ' expected ' . implode(', ', $allowedClasses),
+                    ))
                     ->withValue($defaultValue)
                     ->build();
             }
+
             return (new ResolutionDetailsBuilder())
                 ->withValue($apiResp->getValue())
                 ->withReason($apiResp->getReason())
                 ->withVariant($apiResp->getVariant())
                 ->build();
-
         } catch (BaseOfrepException $e) {
             $err = new ResolutionError($e->getErrorCode(), $e->getMessage());
+
             return (new ResolutionDetailsBuilder())
                 ->withValue($defaultValue)
                 ->withError($err)
                 ->withReason(Reason::ERROR)
                 ->build();
-        } catch (\Exception $e) {
+        } catch (Throwable $e) {
             return (new ResolutionDetailsBuilder())
                 ->withValue($defaultValue)
-                ->withError(new ResolutionError(ErrorCode::GENERAL(), "An error occurred while evaluating the flag: " . $e->getMessage()))
+                ->withError(new ResolutionError(ErrorCode::GENERAL(), 'An error occurred while evaluating the flag: ' . $e->getMessage()))
                 ->withReason(Reason::ERROR)
                 ->build();
         }
     }
 
+    /**
+     * @param array<string> $allowedClasses
+     */
     private function isValidType(mixed $value, array $allowedClasses): bool
     {
         foreach ($allowedClasses as $class) {
             if ($value instanceof $class || gettype($value) === $class) {
                 return true;
             }
         }
+
         return false;
     }
 

providers/GoFeatureFlag/src/config/Config.php

@@ -4,33 +4,57 @@
 
 namespace OpenFeature\Providers\GoFeatureFlag\config;
 
+use Psr\Http\Client\ClientInterface;
+
 class Config
 {
     private string $endpoint;
+    /**
+     * @var array<string, string>
+     */
     private array $customHeaders = [];
 
-    public function __construct(string $endpoint, ?string $apiKey = '', ?array $custom_headers = [])
+    /**
+     * @var ClientInterface|null - The HTTP Client to use (if you want to use a custom one)
+     */
+    private ?ClientInterface $httpclient;
+
+    /**
+     * @param string $endpoint - The endpoint to your GO Feature Flag Instance
+     * @param string|null $apiKey - API Key to use to connect to GO Feature Flag
+     * @param array<string, string>|null $customHeaders - Custom headers you want to send
+     * @param ClientInterface|null $httpclient - The HTTP Client to use (if you want to use a custom one)
+     */
+    public function __construct(string $endpoint, ?string $apiKey = '', ?array $customHeaders = [], ?ClientInterface $httpclient = null)
     {
+        $this->httpclient = $httpclient;
         $this->endpoint = $endpoint;
-        $this->customHeaders = $custom_headers;
+        $this->customHeaders = $customHeaders ?? [];
         if ($apiKey !== null && $apiKey !== '') {
             $this->customHeaders['Authorization'] = 'Bearer ' . $apiKey;
         }
     }
 
-    /**
-     * @return string
-     */
     public function getEndpoint(): string
     {
         return $this->endpoint;
     }
 
     /**
-     * @return array
+     * @return array<string, string>
      */
     public function getCustomHeaders(): array
     {
         return $this->customHeaders;
     }
+
+    public function addCustomHeader(string $key, string $value): void
+    {
+        $this->customHeaders[$key] = $value;
+    }
+
+    public function getHttpClient(): ?ClientInterface
+    {
+        return $this->httpclient;
+    }
 }