Merge pull request #19 from Flagsmith/release/3.0.0

Release 3.0.0

Author: dabeeeenster

.github/workflows/pull-requests.yml

@@ -20,15 +20,16 @@ jobs:
         steps:
             - name: Cloning repo
               uses: actions/checkout@v2
-#              with:
-#                  fetch-depth: 0
-#                  submodules: recursive
+              with:
+                  fetch-depth: 0
+                  submodules: recursive
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
                   version: '{{ matrix.php-version }}'
                   tools: php-cs-fixer, phpunit
+                  extensions: "bcmath, gmp"
 
             - name: Get composer cache directory
               id: composer-cache

.gitignore

@@ -1,4 +1,5 @@
 vendor
 package-lock.json
 composer.lock
-/node_modules/
+/node_modules/
+.env

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tests/Engine/EngineTests/EngineTestData"]
+	path = tests/Engine/EngineTests/EngineTestData
+	url = [email protected]:Flagsmith/engine-test-data.git

README.md

@@ -9,6 +9,19 @@
 
 The SDK for PHP applications for [https://www.flagsmith.com/](https://www.flagsmith.com/).
 
+## Requirements
+
+The Flagsmith PHP SDK requires the following PHP extensions to be enabled. These are essentials for the library to function properly.
+
+- bc-math
+- gmp
+
+Please view the documentation here to install the extensions, if you haven't already. For [BC-Math](https://www.php.net/manual/en/bc.installation.php) and [GMP](https://www.php.net/manual/en/gmp.installation.php). To enable for docker containers, please have a look at our sample in the example directory.
+
+## Local Evaluation
+
+Since PHP requests are separate, there is little benefit to use local evaluation without caching. To enable local evaluation, please set the environmentTtl value (>0) and using PSR simple cache implementation.
+
 ## Adding to your project
 
 For full documentation visit [https://docs.flagsmith.com/clients/php/](https://docs.flagsmith.com/clients/php/)

composer.json

@@ -1,6 +1,7 @@
 {
     "name": "flagsmith/flagsmith-php-client",
     "type": "library",
+    "version": "3.0.0",
     "license": "BSD-3-Clause",
     "authors": [
         {
@@ -20,11 +21,14 @@
         "guzzlehttp/guzzle": "^7.3",
         "guzzlehttp/psr7": "^2.1.0",
         "phpunit/phpunit": "^9.5",
-        "friendsofphp/php-cs-fixer": "^3.6"
+        "symfony/cache": "^5.4.6",
+        "friendsofphp/php-cs-fixer": "^3.6",
+        "doppiogancio/mocked-client": "^3.0"
     },
     "autoload": {
         "psr-4": {
-            "Flagsmith\\": "src"
+            "Flagsmith\\": "src",
+            "FlagsmithTest\\": "tests"
         }
     }
 }

examples/.env.sample

@@ -0,0 +1 @@
+API_KEY=API_KEY

examples/Dockerfile

@@ -18,10 +18,16 @@ RUN apt-get update && apt-get install -y \
     libreadline-dev \
     libfreetype6-dev \
     libxml2-dev \
+    libgmp-dev \
     g++
 
 COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
 
+RUN docker-php-ext-install bcmath
+
+RUN docker-php-ext-install gmp
+
 WORKDIR /var/code
 
+
 CMD ["tail", "-f", "/dev/null"]

examples/README.md

@@ -6,11 +6,16 @@ This example uses the following packages to invoke Flagsmith APIs.
 - Nyholm/PSR7
 - Symfony/HTTP-client
 - PHP-HTTP/httplug
+- Slim micro framework
+- Slim-twig
 
 ## Steps
 ```sh
+rm -rf ./vendor/
+composer clear-cache
 composer install
 php index.php
+php -S 0.0.0.0:8000
 ```
 
 Returns a response of all the flags present.
@@ -21,11 +26,56 @@ More examples will be added for all methods and endpoints.
 
 The following steps can be used to run the files in a docker container.
 
+Note: Please copy .env.sample as .env and replace the API key in the .env file.
+
 ```sh
 docker-compose up -d
-docker exec -it app composer install
-docker exec -it app index.php
+docker exec -it example-app sh -c "rm -rf ./vendor/"
+docker exec -it example-app composer clear-cache
+docker exec -it example-app composer install
+docker exec -it example-app php -S 0.0.0.0:8000
+```
+
+# Reduce Flagsmith calls with local evaluation
+
+You can reduce network calls by using local evaluations.
+
+```php
+$flagsmith = (new Flagsmith(TOKEN));
+// This will load the environment from cache (or API, if cache does not exist.)
+$flagsmith->updateEnvironment();
+```
+
+ It is recommended to use a psr simple-cache implementation to cache the environment document between multiple requests.
+
+```sh
+composer require symfony/cache
 ```
 
+```php
+$flagsmith = (new Flagsmith(TOKEN))
+  ->withCache(new Psr16Cache(new FilesystemAdapter()));
+// Cache the environment call to reduce network calls for each and every evaluation.
+// This will load the environment from cache (or API, if cache does not exist.)
+$flagsmith->updateEnvironment();
+```
+
+An optional cron job can be added to refresh this cache at a set time depending on your choice. Please set EnvironmentTTL value for this purpose.
+
+```php
+// the environment will be cached for 100 seconds.
+$flagsmith = $flagsmith->withEnvironmentTtl(100);
+$flagsmith->updateEnvironment();
+```
+
+```sh
+* * * 1 40 php index.php # using cli
+* * * 1 40 curl http://localhost:8000/ # using http
+```
+
+Note:
+- Please note that for the environment cache, please use the server key generated from the Flagsmith Settings menu. The key's prefix is `ser.`.
+- The cache is important for concurrent requests. Without cache, each request in PHP is a different process with its own memory objects. The cache (filesystem or other) would enforce that the network call is reduced to a file system one.
+
 ## Troubleshooting
 If you see dependency related issues. Try backing up and removing your composer.lock file and then running composer install

examples/composer.json

@@ -1,8 +1,13 @@
 {
   "require": {
-    "nyholm/psr7": "1.4.1",
-    "flagsmith/flagsmith-php-client": "^2.1",
+    "nyholm/psr7": "^1.5",
+    "flagsmith/flagsmith-php-client": "dev-main",
     "symfony/http-client": "^5.4",
-    "php-http/httplug": "^2.2"
+    "php-http/httplug": "^2.2",
+    "symfony/cache": "^5.4",
+    "slim/slim": "4.*",
+    "slim/twig-view": "^3.3",
+    "nyholm/psr7-server": "^1.0",
+    "php-http/cache-plugin": "^1.7"
   }
 }

examples/docker-compose.yml

@@ -2,8 +2,12 @@ version: "3"
 
 services:
   app:
-    container_name: app
+    container_name: example-app
     build: ./
+    environment:
+      API_KEY: ${API_KEY}
+    ports:
+      - 8000:8000
     volumes:
       - ./:/var/code
     command: tail -f /dev/null