Skip to content

Commit 6fe9c17

Browse files
thomaspoignantthomaspoignant
committed
fix linter issue
Signed-off-by: Thomas Poignant <[email protected]>
1 parent cb5035f commit 6fe9c17

23 files changed

+548
-451
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $api->setProvider($provider);
6262
$client = $api->getClient();
6363
$evaluationContext = new MutableEvaluationContext(
6464
"214b796a-807b-4697-b3a3-42de0ec10a37",
65-
new Attributes(["email" => "[email protected]"])
65+
new Attributes(["email" => '[email protected]'])
6666
);
6767

6868
$value = $client->getBooleanDetails('integer_key', false, $evaluationContext);

‎providers/GoFeatureFlag/composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"@dev:analyze:phpstan",
6969
"@dev:analyze:psalm"
7070
],
71-
"dev:analyze:phpstan": "phpstan analyse --ansi --debug --memory-limit=512M",
71+
"dev:analyze:phpstan": "phpstan --ansi --debug --memory-limit=512M",
7272
"dev:analyze:psalm": "psalm",
7373
"dev:build:clean": "git clean -fX build/",
7474
"dev:lint": [

‎providers/GoFeatureFlag/phpstan.neon.dist‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ parameters:
33
level: max
44
paths:
55
- ./src
6-
- ./tests
76
excludePaths:
87
- */tests/fixtures/*
98
- */tests/*/fixtures/*
10-
# TODO: Implement gRPC Completely
11-
- ./src/grpc

‎providers/GoFeatureFlag/src/GoFeatureFlagProvider.php‎

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44

55
namespace OpenFeature\Providers\GoFeatureFlag;
66

7+
use DateTime;
8+
use OpenFeature\Providers\GoFeatureFlag\config\Config;
9+
use OpenFeature\Providers\GoFeatureFlag\controller\OfrepApi;
10+
use OpenFeature\Providers\GoFeatureFlag\exception\BaseOfrepException;
11+
use OpenFeature\Providers\GoFeatureFlag\exception\InvalidConfigException;
12+
use OpenFeature\Providers\GoFeatureFlag\exception\InvalidContextException;
13+
use OpenFeature\Providers\GoFeatureFlag\model\OfrepApiErrorResponse;
14+
use OpenFeature\Providers\GoFeatureFlag\util\Validator;
715
use OpenFeature\implementation\common\Metadata;
816
use OpenFeature\implementation\provider\AbstractProvider;
917
use OpenFeature\implementation\provider\ResolutionDetailsBuilder;
@@ -13,15 +21,15 @@
1321
use OpenFeature\interfaces\provider\Provider;
1422
use OpenFeature\interfaces\provider\Reason;
1523
use OpenFeature\interfaces\provider\ResolutionDetails;
16-
use OpenFeature\Providers\GoFeatureFlag\config\Config;
17-
use OpenFeature\Providers\GoFeatureFlag\controller\OfrepApi;
18-
use OpenFeature\Providers\GoFeatureFlag\exception\BaseOfrepException;
19-
use OpenFeature\Providers\GoFeatureFlag\exception\InvalidConfigException;
20-
use OpenFeature\Providers\GoFeatureFlag\util\Validator;
24+
use Throwable;
25+
26+
use function array_key_exists;
27+
use function gettype;
28+
use function implode;
2129

2230
class GoFeatureFlagProvider extends AbstractProvider implements Provider
2331
{
24-
protected static string $CLIENT_NAME = 'GO Feature Flag Provider';
32+
protected static string $NAME = 'GO Feature Flag Provider';
2533
private OfrepApi $ofrepApi;
2634

2735
/**
@@ -30,15 +38,15 @@ class GoFeatureFlagProvider extends AbstractProvider implements Provider
3038
public function __construct(Config $config)
3139
{
3240
Validator::validateConfig($config);
33-
if (is_array($config->getCustomHeaders()) && !array_key_exists("Content-Type", $config->getCustomHeaders())) {
34-
$config->getCustomHeaders()["Content-Type"] = "application/json";
41+
if (!array_key_exists('Content-Type', $config->getCustomHeaders())) {
42+
$config->addCustomHeader('Content-Type', 'application/json');
3543
}
3644
$this->ofrepApi = new OfrepApi($config);
3745
}
3846

3947
public function getMetadata(): Metadata
4048
{
41-
return new Metadata(self::$CLIENT_NAME);
49+
return new Metadata(static::$NAME);
4250
}
4351

4452
public function resolveBooleanValue(string $flagKey, bool $defaultValue, ?EvaluationContext $context = null): ResolutionDetails
@@ -47,25 +55,33 @@ public function resolveBooleanValue(string $flagKey, bool $defaultValue, ?Evalua
4755
}
4856

4957
/**
58+
* @param array<mixed>|array<string, mixed>|bool|DateTime|float|int|string|null $defaultValue
5059
* @param array<string> $allowedClasses
5160
*/
52-
private function evaluate(string $flagKey, mixed $defaultValue, array $allowedClasses, EvaluationContext $evaluationContext = null): ResolutionDetails
61+
private function evaluate(string $flagKey, array | string | bool | DateTime | float | int | null $defaultValue, array $allowedClasses, ?EvaluationContext $evaluationContext = null): ResolutionDetails
5362
{
5463
try {
55-
Validator::validateEvaluationContext($evaluationContext);
5664
Validator::validateFlagKey($flagKey);
5765

66+
if ($evaluationContext === null) {
67+
throw new InvalidContextException('Evaluation context is null');
68+
}
69+
if ($evaluationContext->getTargetingKey() === null || $evaluationContext->getTargetingKey() === '') {
70+
throw new InvalidContextException('Missing targetingKey in evaluation context');
71+
}
72+
5873
$apiResp = $this->ofrepApi->evaluate($flagKey, $evaluationContext);
5974

60-
if ($apiResp->isError()) {
75+
if ($apiResp instanceof OfrepApiErrorResponse) {
6176
$err = new ResolutionError(
62-
$apiResp->getErrorCode() ?? ErrorCode::GENERAL(),
63-
$apiResp->getErrorDetails()
77+
$apiResp->getErrorCode(),
78+
$apiResp->getErrorDetails(),
6479
);
80+
6581
return (new ResolutionDetailsBuilder())
6682
->withValue($defaultValue)
6783
->withError($err)
68-
->withReason(Reason::ERROR)
84+
->withReason($apiResp->getReason())
6985
->build();
7086
}
7187

@@ -74,39 +90,45 @@ private function evaluate(string $flagKey, mixed $defaultValue, array $allowedCl
7490
->withReason(Reason::ERROR)
7591
->withError(new ResolutionError(
7692
ErrorCode::TYPE_MISMATCH(),
77-
"Invalid type for $flagKey, got " . gettype($apiResp->getValue()) . " expected " . implode(", ", $allowedClasses)))
93+
"Invalid type for $flagKey, got " . gettype($apiResp->getValue()) . ' expected ' . implode(', ', $allowedClasses),
94+
))
7895
->withValue($defaultValue)
7996
->build();
8097
}
98+
8199
return (new ResolutionDetailsBuilder())
82100
->withValue($apiResp->getValue())
83101
->withReason($apiResp->getReason())
84102
->withVariant($apiResp->getVariant())
85103
->build();
86-
87104
} catch (BaseOfrepException $e) {
88105
$err = new ResolutionError($e->getErrorCode(), $e->getMessage());
106+
89107
return (new ResolutionDetailsBuilder())
90108
->withValue($defaultValue)
91109
->withError($err)
92110
->withReason(Reason::ERROR)
93111
->build();
94-
} catch (\Exception $e) {
112+
} catch (Throwable $e) {
95113
return (new ResolutionDetailsBuilder())
96114
->withValue($defaultValue)
97-
->withError(new ResolutionError(ErrorCode::GENERAL(), "An error occurred while evaluating the flag: " . $e->getMessage()))
115+
->withError(new ResolutionError(ErrorCode::GENERAL(), 'An error occurred while evaluating the flag: ' . $e->getMessage()))
98116
->withReason(Reason::ERROR)
99117
->build();
100118
}
101119
}
102120

121+
/**
122+
* @param array<string> $allowedClasses
123+
*/
103124
private function isValidType(mixed $value, array $allowedClasses): bool
104125
{
105126
foreach ($allowedClasses as $class) {
106127
if ($value instanceof $class || gettype($value) === $class) {
107128
return true;
108129
}
109130
}
131+
110132
return false;
111133
}
112134

‎providers/GoFeatureFlag/src/config/Config.php‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,40 @@
77
class Config
88
{
99
private string $endpoint;
10+
/**
11+
* @var array<string, string>
12+
*/
1013
private array $customHeaders = [];
1114

12-
public function __construct(string $endpoint, ?string $apiKey = '', ?array $custom_headers = [])
15+
/**
16+
* @param string $endpoint - The endpoint to your GO Feature Flag Instance
17+
* @param string|null $apiKey - API Key to use to connect to GO Feature Flag
18+
* @param array<string, string>|null $customHeaders - Custom headers you want to send
19+
*/
20+
public function __construct(string $endpoint, ?string $apiKey = '', ?array $customHeaders = [])
1321
{
1422
$this->endpoint = $endpoint;
15-
$this->customHeaders = $custom_headers;
23+
$this->customHeaders = $customHeaders ?? [];
1624
if ($apiKey !== null && $apiKey !== '') {
1725
$this->customHeaders['Authorization'] = 'Bearer ' . $apiKey;
1826
}
1927
}
2028

21-
/**
22-
* @return string
23-
*/
2429
public function getEndpoint(): string
2530
{
2631
return $this->endpoint;
2732
}
2833

2934
/**
30-
* @return array
35+
* @return array<string, string>
3136
*/
3237
public function getCustomHeaders(): array
3338
{
3439
return $this->customHeaders;
3540
}
41+
42+
public function addCustomHeader(string $key, string $value): void
43+
{
44+
$this->customHeaders[$key] = $value;
45+
}
3646
}

‎providers/GoFeatureFlag/src/controller/OfrepApi.php‎

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,29 @@
44

55
namespace OpenFeature\Providers\GoFeatureFlag\controller;
66

7-
use Exception;
87
use GuzzleHttp\Client;
98
use GuzzleHttp\Exception\GuzzleException;
10-
use OpenFeature\interfaces\flags\EvaluationContext;
119
use OpenFeature\Providers\GoFeatureFlag\config\Config;
1210
use OpenFeature\Providers\GoFeatureFlag\exception\BaseOfrepException;
1311
use OpenFeature\Providers\GoFeatureFlag\exception\FlagNotFoundException;
1412
use OpenFeature\Providers\GoFeatureFlag\exception\ParseException;
1513
use OpenFeature\Providers\GoFeatureFlag\exception\RateLimitedException;
1614
use OpenFeature\Providers\GoFeatureFlag\exception\UnauthorizedException;
1715
use OpenFeature\Providers\GoFeatureFlag\exception\UnknownOfrepException;
18-
use OpenFeature\Providers\GoFeatureFlag\model\OfrepApiResponse;
16+
use OpenFeature\Providers\GoFeatureFlag\model\OfrepApiErrorResponse;
17+
use OpenFeature\Providers\GoFeatureFlag\model\OfrepApiSuccessResponse;
18+
use OpenFeature\Providers\GoFeatureFlag\util\Validator;
19+
use OpenFeature\interfaces\flags\EvaluationContext;
1920
use Psr\Http\Message\ResponseInterface;
21+
use Throwable;
22+
23+
use function array_merge;
24+
use function is_numeric;
25+
use function json_decode;
26+
use function json_encode;
27+
use function rtrim;
28+
use function strtotime;
29+
use function time;
2030

2131
class OfrepApi
2232
{
@@ -40,7 +50,7 @@ public function __construct(Config $config)
4050
* @throws UnknownOfrepException
4151
* @throws BaseOfrepException
4252
*/
43-
public function evaluate(string $flagKey, EvaluationContext $evaluationContext): OfrepApiResponse
53+
public function evaluate(string $flagKey, EvaluationContext $evaluationContext): OfrepApiSuccessResponse | OfrepApiErrorResponse
4454
{
4555
try {
4656
if ($this->retryAfter !== null) {
@@ -51,25 +61,22 @@ public function evaluate(string $flagKey, EvaluationContext $evaluationContext):
5161
}
5262
}
5363

54-
$base_uri = $this->options->getEndpoint();
55-
$evaluateApiPath = rtrim($base_uri, '/') . "/ofrep/v1/evaluate/flags/{$flagKey}";
56-
$headers = [
57-
'Content-Type' => 'application/json'
58-
];
59-
60-
if ($this->options->getCustomHeaders() !== null) {
61-
$headers = array_merge($headers, $this->options->getCustomHeaders());
62-
}
64+
$baseUri = $this->options->getEndpoint();
65+
$evaluateApiPath = rtrim($baseUri, '/') . "/ofrep/v1/evaluate/flags/{$flagKey}";
66+
$headers = array_merge(
67+
['Content-Type' => 'application/json'],
68+
$this->options->getCustomHeaders(),
69+
);
6370

6471
$fields = array_merge(
6572
$evaluationContext->getAttributes()->toArray(),
66-
['targetingKey' => $evaluationContext->getTargetingKey()]
73+
['targetingKey' => $evaluationContext->getTargetingKey()],
6774
);
6875

6976
$requestBody = json_encode(['context' => $fields]);
7077
$response = $this->client->post($evaluateApiPath, [
7178
'headers' => $headers,
72-
'body' => $requestBody
79+
'body' => $requestBody,
7380
]);
7481

7582
switch ($response->getStatusCode()) {
@@ -84,33 +91,40 @@ public function evaluate(string $flagKey, EvaluationContext $evaluationContext):
8491
throw new FlagNotFoundException($flagKey, $response);
8592
case 429:
8693
$this->parseRetryLaterHeader($response);
94+
8795
throw new RateLimitedException($response);
8896
default:
8997
throw new UnknownOfrepException($response);
9098
}
9199
} catch (BaseOfrepException $e) {
92100
throw $e;
93-
} catch (GuzzleException|Exception $e) {
101+
} catch (GuzzleException | Throwable $e) {
94102
throw new UnknownOfrepException(null, $e);
95103
}
96104
}
97105

98106
/**
99107
* @throws ParseException
100108
*/
101-
private function parseSuccessResponse(ResponseInterface $response): OfrepApiResponse
109+
private function parseSuccessResponse(ResponseInterface $response): OfrepApiSuccessResponse
102110
{
111+
/** @var array<string, mixed> $parsed */
103112
$parsed = json_decode($response->getBody()->getContents(), true);
104-
return OfrepApiResponse::createSuccessResponse($parsed);
113+
$parsed = Validator::validateSuccessApiResponse($parsed);
114+
115+
return new OfrepApiSuccessResponse($parsed);
105116
}
106117

107118
/**
108119
* @throws ParseException
109120
*/
110-
private function parseErrorResponse(ResponseInterface $response): OfrepApiResponse
121+
private function parseErrorResponse(ResponseInterface $response): OfrepApiErrorResponse
111122
{
123+
/** @var array<string, mixed> $parsed */
112124
$parsed = json_decode($response->getBody()->getContents(), true);
113-
return OfrepApiResponse::createErrorResponse($parsed);
125+
$parsed = Validator::validateErrorApiResponse($parsed);
126+
127+
return new OfrepApiErrorResponse($parsed);
114128
}
115129

116130
private function parseRetryLaterHeader(ResponseInterface $response): void
@@ -119,10 +133,11 @@ private function parseRetryLaterHeader(ResponseInterface $response): void
119133
if ($retryAfterHeader) {
120134
if (is_numeric($retryAfterHeader)) {
121135
// Retry-After is in seconds
122-
$this->retryAfter = time() + (int)$retryAfterHeader;
136+
$this->retryAfter = time() + (int) $retryAfterHeader;
123137
} else {
124138
// Retry-After is in HTTP-date format
125-
$this->retryAfter = strtotime($retryAfterHeader);
139+
$retryTime = strtotime($retryAfterHeader);
140+
$this->retryAfter = $retryTime !== false ? $retryTime : null;
126141
}
127142
}
128143
}

‎providers/GoFeatureFlag/src/exception/BaseGoffException.php‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@
44

55
namespace OpenFeature\Providers\GoFeatureFlag\exception;
66

7+
use Exception;
78
use OpenFeature\interfaces\provider\ErrorCode;
89
use Psr\Http\Message\ResponseInterface;
10+
use Throwable;
911

10-
abstract class BaseGoffException extends \Exception
12+
abstract class BaseGoffException extends Exception
1113
{
1214
private string $customMessage;
1315
private ?ResponseInterface $response;
1416
private ErrorCode $errorCode;
1517

16-
public function __construct(string $message, ErrorCode $errorCode, ?ResponseInterface $response, int $code = 0, \Exception $previous = null)
18+
public function __construct(string $message, ErrorCode $errorCode, ?ResponseInterface $response, int $code = 0, ?Throwable $previous = null)
1719
{
1820
$this->customMessage = $message;
1921
$this->response = $response;
@@ -35,4 +37,4 @@ public function getErrorCode(): ErrorCode
3537
{
3638
return $this->errorCode;
3739
}
38-
}
40+
}

0 commit comments

Comments
 (0)