|
| 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 | +| `httpclient` | The HTTP Client to use (if you want to use a custom one). _It has to be a `PSR-7` compliant implementation._ | |
| 48 | + |
| 49 | +The only required option to create a `GoFeatureFlagProvider` is the URL _(`endpoint`)_ to your GO Feature Flag relay-proxy instance. |
| 50 | + |
| 51 | +```php |
| 52 | +use OpenFeature\Providers\GoFeatureFlag\config\Config; |
| 53 | +use OpenFeature\Providers\GoFeatureFlag\GoFeatureFlagProvider; |
| 54 | +use OpenFeature\implementation\flags\MutableEvaluationContext; |
| 55 | +use OpenFeature\implementation\flags\Attributes; |
| 56 | +use OpenFeature\OpenFeatureAPI; |
| 57 | + |
| 58 | +$config = new Config('http://gofeatureflag.org', 'my-api-key'); |
| 59 | +$provider = new GoFeatureFlagProvider($config); |
| 60 | + |
| 61 | +$api = OpenFeatureAPI::getInstance(); |
| 62 | +$api->setProvider($provider); |
| 63 | +$client = $api->getClient(); |
| 64 | +$evaluationContext = new MutableEvaluationContext( |
| 65 | + "214b796a-807b-4697-b3a3-42de0ec10a37", |
| 66 | + new Attributes(["email" => 'contact@gofeatureflag.org']) |
| 67 | + ); |
| 68 | + |
| 69 | +$value = $client->getBooleanDetails('integer_key', false, $evaluationContext); |
| 70 | +if ($value) { |
| 71 | + echo "The flag is enabled"; |
| 72 | +} else { |
| 73 | + echo "The flag is disabled"; |
| 74 | +} |
| 75 | +``` |
| 76 | + |
| 77 | +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. |
| 78 | + |
| 79 | +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. |
| 80 | + |
| 81 | + |
| 82 | +### Evaluate a feature flag |
| 83 | +The client is used to retrieve values for the current `EvaluationContext`. |
| 84 | +For example, retrieving a boolean value for the flag **"my-flag"**: |
| 85 | + |
| 86 | +```php |
| 87 | +$value = $client->getBooleanDetails('integer_key', false, $evaluationContext); |
| 88 | +if ($value) { |
| 89 | + echo "The flag is enabled"; |
| 90 | +} else { |
| 91 | + echo "The flag is disabled"; |
| 92 | +} |
| 93 | +``` |
| 94 | + |
| 95 | +GO Feature Flag supports different all OpenFeature supported types of feature flags, it means that you can use all the accessor directly |
| 96 | +```php |
| 97 | +// Bool |
| 98 | +$client->getBooleanDetails('my-flag-key', false, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 99 | +$client->getBooleanValue('my-flag-key', false, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 100 | + |
| 101 | +// String |
| 102 | +$client->getStringDetails('my-flag-key', "default", new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 103 | +$client->getStringValue('my-flag-key', "default", new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 104 | + |
| 105 | +// Integer |
| 106 | +$client->getIntegerDetails('my-flag-key', 1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 107 | +$client->getIntegerValue('my-flag-key', 1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 108 | + |
| 109 | +// Float |
| 110 | +$client->getFloatDetails('my-flag-key', 1.1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 111 | +$client->getFloatValue('my-flag-key', 1.1, new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 112 | + |
| 113 | +// Object |
| 114 | +$client->getObjectDetails('my-flag-key', ["default" => true], new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 115 | +$client->getObjectValue('my-flag-key', ["default" => true], new MutableEvaluationContext("214b796a-807b-4697-b3a3-42de0ec10a37")); |
| 116 | +``` |
| 117 | + |
| 118 | +## Features status |
| 119 | + |
| 120 | +| Status | Feature | Description | |
| 121 | +|-------|-----------------|----------------------------------------------------------------------------| |
| 122 | +| ✅ | Flag evaluation | It is possible to evaluate all the type of flags | |
| 123 | +| ❌ | Caching | Mechanism is in place to refresh the cache in case of configuration change | |
| 124 | +| ❌ | Event Streaming | Not supported by the SDK | |
| 125 | +| ❌ | Logging | Not supported by the SDK | |
| 126 | +| ❌ | Flag Metadata | Not supported by the SDK | |
| 127 | + |
| 128 | + |
| 129 | +<sub>**Implemented**: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub> |
| 130 | + |
| 131 | +## Contributing |
| 132 | +This project welcomes contributions from the community. |
| 133 | +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. |
| 134 | + |
| 135 | +### PHP Versioning |
| 136 | +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. |
| 137 | + |
| 138 | +This package also has a .tool-versions file for use with PHP version managers like asdf. |
| 139 | + |
| 140 | +### Installation and Dependencies |
| 141 | +Install dependencies with `composer install`, it will update the `composer.lock` with the most recent compatible versions. |
| 142 | + |
| 143 | +We value having as few runtime dependencies as possible. The addition of any dependencies requires careful consideration and review. |
| 144 | + |
0 commit comments