Skip to content

Commit 6218ede

Browse files
thomaspoignantthomaspoignant
committed
Goff PHP Provider initial commit
Signed-off-by: Thomas Poignant <[email protected]>
1 parent 77d389d commit 6218ede

28 files changed

+1982
-0
lines changed

‎.github/workflows/php-ci.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ jobs:
1919
- hooks/Validators
2020
- providers/Flagd
2121
- providers/Split
22+
- providers/GoFeatureFlag
2223
# - providers/CloudBees
2324
fail-fast: false
2425

‎.github/workflows/split_monorepo.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,17 @@ jobs:
8787
targetRepo: split-provider
8888
targetBranch: refs/tags/${{ github.event.release.tag_name }}
8989
filterArguments: '--subdirectory-filter providers/Split/ --force'
90+
91+
split-provider-go-feature-flag:
92+
runs-on: ubuntu-latest
93+
steps:
94+
- name: checkout
95+
run: git clone "$GITHUB_SERVER_URL"/"$GITHUB_REPOSITORY" "$GITHUB_WORKSPACE" && cd "$GITHUB_WORKSPACE" && git checkout "$GITHUB_SHA"
96+
- name: push-provider-split
97+
uses: tcarrio/git-filter-repo-docker-action@v1
98+
with:
99+
privateKey: ${{ secrets.SSH_PRIVATE_KEY }}
100+
targetOrg: open-feature-php
101+
targetRepo: go-feature-flag-provider
102+
targetBranch: refs/tags/${{ github.event.release.tag_name }}
103+
filterArguments: '--subdirectory-filter providers/GoFeatureFlag/ --force'

‎providers/GoFeatureFlag/.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/composer.lock
2+
/vendor
3+
/build

‎providers/GoFeatureFlag/README.md

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<p align="center">
2+
<img width="400" src="https://raw.githubusercontent.com/thomaspoignant/go-feature-flag/main/gofeatureflag.svg" alt="go-feature-flag logo" />
3+
4+
</p>
5+
6+
# GO Feature Flag - OpenFeature PHP provider
7+
<p align="center">
8+
<a href="https://packagist.org/packages/open-feature/go-feature-flag"><img src="https://img.shields.io/packagist/v/open-feature/go-feature-flag-provider?color=blue&logo=php" /></a>
9+
<a href="https://packagist.org/packages/open-feature/go-feature-flag"><img src="https://img.shields.io/packagist/dt/open-feature/go-feature-flag-provider?logo=php" /></a>
10+
<img alt="Packagist Version" src="https://img.shields.io/packagist/v/open-feature/go-feature-flag-provider?logo=php&color=blue">
11+
<a href="https://gofeatureflag.org/"><img src="https://img.shields.io/badge/%F0%9F%93%92-Website-blue" alt="Documentation"></a>
12+
<a href="https://github.com/thomaspoignant/go-feature-flag/issues"><img src="https://img.shields.io/badge/%E2%9C%8F%EF%B8%8F-issues-red" alt="Issues"></a>
13+
<a href="https://gofeatureflag.org/slack"><img src="https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=green" alt="Join us on slack"></a>
14+
</p>
15+
16+
This repository contains the official PHP OpenFeature provider for accessing your feature flags with [GO Feature Flag](https://gofeatureflag.org).
17+
18+
In conjunction with the [OpenFeature SDK](https://openfeature.dev/docs/reference/concepts/provider) you will be able
19+
to evaluate your feature flags in your Ruby applications.
20+
21+
For documentation related to flags management in GO Feature Flag,
22+
refer to the [GO Feature Flag documentation website](https://gofeatureflag.org/docs).
23+
24+
### Functionalities:
25+
- Manage the integration of the OpenFeature PHP SDK and GO Feature Flag relay-proxy.
26+
27+
## Dependency Setup
28+
29+
### Composer
30+
31+
```shell
32+
composer require open-feature/go-feature-flag-provider
33+
```
34+
## Getting started
35+
36+
### Initialize the provider
37+
38+
The `GoFeatureFlagProvider` takes a config object as parameter to be initialized.
39+
40+
The constructor of the config object has the following options:
41+
42+
| **Option** | **Description** |
43+
|-----------------|------------------------------------------------------------------------------------------------------------------|
44+
| `endpoint` | **(mandatory)** The URL to access to the relay-proxy.<br />*(example: `https://relay.proxy.gofeatureflag.org/`)* |
45+
| `apiKey` | The token used to call the relay proxy. |
46+
| `customHeaders` | Any headers you want to add to call the relay-proxy. |
47+
48+
The only required option to create a `GoFeatureFlagProvider` is the URL _(`endpoint`)_ to your GO Feature Flag relay-proxy instance.
49+
50+
```php
51+
use OpenFeature\Providers\GoFeatureFlag\config\Config;
52+
use OpenFeature\Providers\GoFeatureFlag\GoFeatureFlagProvider;
53+
use OpenFeature\implementation\flags\MutableEvaluationContext;
54+
use OpenFeature\implementation\flags\Attributes;
55+
use OpenFeature\OpenFeatureAPI;
56+
57+
$config = new Config('http://gofeatureflag.org', 'my-api-key);
58+
$provider = new GoFeatureFlagProvider($config);
59+
60+
$api = OpenFeatureAPI::getInstance();
61+
$api->setProvider($provider);
62+
$client = $api->getClient();
63+
$evaluationContext = new MutableEvaluationContext(
64+
"214b796a-807b-4697-b3a3-42de0ec10a37",
65+
new Attributes(["email" => "[email protected]"])
66+
);
67+
68+
$value = $client->getBooleanDetails('integer_key', false, $evaluationContext);
69+
if ($value) {
70+
echo "The flag is enabled";
71+
} else {
72+
echo "The flag is disabled";
73+
}
74+
```
75+
76+
The evaluation context is the way for the client to specify contextual data that GO Feature Flag uses to evaluate the feature flags, it allows to define rules on the flag.
77+
78+
The `targeting_key` is mandatory for GO Feature Flag to evaluate the feature flag, it could be the id of a user, a session ID or anything you find relevant to use as identifier during the evaluation.
79+
80+
81+
### Evaluate a feature flag
82+
The client is used to retrieve values for the current `EvaluationContext`.
83+
For example, retrieving a boolean value for the flag **"my-flag"**:
84+
85+
```php
86+
$value = $client->getBooleanDetails('integer_key', false, $evaluationContext);
87+
if ($value) {
88+
echo "The flag is enabled";
89+
} else {
90+
echo "The flag is disabled";
91+
}
92+
```
93+
94+
GO Feature Flag supports different all OpenFeature supported types of feature flags, it means that you can use all the accessor directly
95+
```php
96+
// Bool
97+
$client->getBooleanDetails('my-flag-key', false, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
98+
$client->getBooleanValue('my-flag-key', false, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
99+
100+
// String
101+
$client->getStringDetails('my-flag-key', "default", new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
102+
$client->getStringValue('my-flag-key', "default", new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
103+
104+
// Integer
105+
$client->getIntegerDetails('my-flag-key', 1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
106+
$client->getIntegerValue('my-flag-key', 1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
107+
108+
// Float
109+
$client->getFloatDetails('my-flag-key', 1.1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
110+
$client->getFloatValue('my-flag-key', 1.1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
111+
112+
// Object
113+
$client->getObjectDetails('my-flag-key', ["default" => true], new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
114+
$client->getObjectValue('my-flag-key', ["default" => true], new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37"));
115+
```
116+
117+
## Features status
118+
119+
| Status | Feature | Description |
120+
|-------|-----------------|----------------------------------------------------------------------------|
121+
| ✅ | Flag evaluation | It is possible to evaluate all the type of flags |
122+
| ❌ | Caching | Mechanism is in place to refresh the cache in case of configuration change |
123+
| ❌ | Event Streaming | Not supported by the SDK |
124+
| ❌ | Logging | Not supported by the SDK |
125+
| ❌ | Flag Metadata | Not supported by the SDK |
126+
127+
128+
<sub>**Implemented**: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub>
129+
130+
## Contributing
131+
This project welcomes contributions from the community.
132+
If you're interested in contributing, see the [contributors' guide](https://github.com/thomaspoignant/go-feature-flag/blob/main/CONTRIBUTING.md) for some helpful tips.
133+
134+
### PHP Versioning
135+
This library targets PHP version 8.0 and newer. As long as you have any compatible version of PHP on your system you should be able to utilize the OpenFeature SDK.
136+
137+
This package also has a .tool-versions file for use with PHP version managers like asdf.
138+
139+
### Installation and Dependencies
140+
Install dependencies with `composer install`, it will update the `composer.lock` with the most recent compatible versions.
141+
142+
We value having as few runtime dependencies as possible. The addition of any dependencies requires careful consideration and review.
143+

‎providers/GoFeatureFlag/composer.json

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"require": {
3+
"php": "^8",
4+
"open-feature/sdk": "^2.0",
5+
"guzzlehttp/guzzle": "^7.9"
6+
},
7+
"require-dev": {
8+
"phpunit/phpunit": "^9",
9+
"mockery/mockery": "^1.6",
10+
"spatie/phpunit-snapshot-assertions": "^4.2"
11+
},
12+
"minimum-stability": "dev",
13+
"prefer-stable": true,
14+
"autoload": {
15+
"psr-4": {
16+
"OpenFeature\\Providers\\GoFeatureFlag\\": "src/"
17+
}
18+
},
19+
"autoload-dev": {
20+
"psr-4": {
21+
"OpenFeature\\Providers\\GoFeatureFlag\\Test\\": "tests/"
22+
}
23+
}
24+
}

‎providers/GoFeatureFlag/phpcs.xml.dist

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0"?>
2+
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
3+
4+
<arg name="extensions" value="php"/>
5+
<arg name="colors"/>
6+
<arg value="sp"/>
7+
8+
<file>./src</file>
9+
<file>./tests</file>
10+
11+
<exclude-pattern>*/tests/fixtures/*</exclude-pattern>
12+
<exclude-pattern>*/tests/*/fixtures/*</exclude-pattern>
13+
14+
<rule ref="Ramsey">
15+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
16+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousErrorNaming"/>
17+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/>
18+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
19+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
20+
21+
<exclude name="Generic.Files.LineLength.TooLong"/>
22+
<exclude name="Generic.Commenting.Todo.TaskFound"/>
23+
</rule>
24+
25+
</ruleset>

‎providers/GoFeatureFlag/phpstan.neon.dist

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
parameters:
2+
tmpDir: ./build/cache/phpstan
3+
level: max
4+
paths:
5+
- ./src
6+
- ./tests
7+
excludePaths:
8+
- */tests/fixtures/*
9+
- */tests/*/fixtures/*
10+
# TODO: Implement gRPC Completely
11+
- ./src/grpc

‎providers/GoFeatureFlag/phpunit.xml.dist

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
4+
bootstrap="./vendor/autoload.php"
5+
cacheResultFile="./build/cache/phpunit.result.cache"
6+
colors="true"
7+
verbose="true">
8+
9+
<testsuites>
10+
<testsuite name="unit">
11+
<directory>./tests/unit</directory>
12+
</testsuite>
13+
</testsuites>
14+
15+
<coverage processUncoveredFiles="true">
16+
<include>
17+
<directory suffix=".php">./src</directory>
18+
</include>
19+
</coverage>
20+
21+
<php>
22+
<ini name="date.timezone" value="UTC"/>
23+
</php>
24+
25+
</phpunit>

‎providers/GoFeatureFlag/psalm-baseline.xml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<files psalm-version="3.9.5@0cfe565d0afbcd31eadcc281b9017b5692911661"/>

‎providers/GoFeatureFlag/psalm.xml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0"?>
2+
<psalm xmlns="https://getpsalm.org/schema/config"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
5+
errorLevel="1"
6+
cacheDirectory="./build/cache/psalm"
7+
errorBaseline="./psalm-baseline.xml">
8+
9+
<projectFiles>
10+
<directory name="./src"/>
11+
<ignoreFiles>
12+
<directory name="./tests"/>
13+
<directory name="./vendor"/>
14+
</ignoreFiles>
15+
</projectFiles>
16+
17+
</psalm>

0 commit comments

Comments
 (0)