prepare 3.5.0 release

.circleci/config.yml

@@ -18,20 +18,17 @@ php-docker-template: &php-docker-template
         name: validate composer.json
         command: composer validate
     - run:
-        name: install current dependencies
+        name: install dependencies
         command: composer install --no-progress
     - run:
-        name: run tests with current dependency versions
+        name: run tests with highest compatible dependency versions
         command: vendor/bin/phpunit --log-junit ~/phpunit/junit.xml --coverage-text tests
     - store_test_results:
         path: ~/phpunit
     - store_artifacts:
         path: ~/phpunit
     - run:
-        name: run tests with highest available dependency versions
-        command: composer update --no-progress && vendor/bin/phpunit tests
-    - run:
-        name: run tests with lowest available dependency versions
+        name: run tests with lowest compatible dependency versions
         # we skip this for 7.2 because the lowest compatible version of PHPUnit has a bug:
         # https://github.com/sebastianbergmann/comparator/pull/30
         command: |
@@ -44,18 +41,30 @@ jobs:
     <<: *php-docker-template
     docker:
       - image: circleci/php:5.6.34-cli-jessie
+      - image: amazon/dynamodb-local
+      - image: consul
+      - image: redis
   test-7.0:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.0.28-cli-jessie
+      - image: amazon/dynamodb-local
+      - image: consul
+      - image: redis
   test-7.1:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.1.15-cli-jessie
+      - image: amazon/dynamodb-local
+      - image: consul
+      - image: redis
   test-7.2:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.2.3-cli-stretch
+      - image: amazon/dynamodb-local
+      - image: consul
+      - image: redis
 
   test-5.5: # CircleCI doesn't provide a Docker image for 5.5
     machine:
@@ -68,6 +77,14 @@ jobs:
             sudo apt-get install circleci-php-5.5.36 &&
             php -r "copy('https://getcomposer.org/installer', '/tmp/composer-setup.php');" &&
             sudo php /tmp/composer-setup.php --install-dir=/usr/local/bin --filename=composer
+      - run:
+          name: install Docker
+          command: |
+            sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" &&
+            sudo apt-get -q update &&
+            sudo apt-cache policy docker-ce &&
+            sudo apt-get -qy install docker-ce
+      - run: sudo apt-get -qy install redis-server
       - checkout
       - run:
           name: validate composer.json
@@ -78,6 +95,20 @@ jobs:
       - run:
           name: run php-cs-fixer
           command: vendor/bin/php-cs-fixer fix --diff --dry-run --verbose
+      - run:
+          name: start DynamoDB
+          command: docker run -p 8000:8000 amazon/dynamodb-local
+          background: true
+      - run:
+          name: download Consul
+          command: wget https://releases.hashicorp.com/consul/0.8.0/consul_0.8.0_linux_amd64.zip
+      - run:
+          name: extract Consul
+          command: unzip consul_0.8.0_linux_amd64.zip
+      - run:
+          name: start Consul
+          command: ./consul agent -dev
+          background: true
       - run:
           name: run tests
           command: vendor/bin/phpunit --log-junit ~/phpunit/junit.xml --coverage-text tests

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to the LaunchDarkly PHP SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [3.5.0] - 2019-01-30
+### Added:
+- It is now possible to use Consul or DynamoDB as a data store with `ld-relay`, similar to the existing Redis integration. See `LaunchDarkly\Integrations\Consul` and `LaunchDarkly\Integrations\DynamoDb`, and the reference guide [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+- When using the Redis integration, you can specify a Redis connection timeout different from the default of 5 seconds by setting the option `redis_timeout` to the desired number of seconds. (Thanks, [jjozefowicz](https://github.com/launchdarkly/php-client/pull/113)!)
+- It is now possible to inject feature flags into the client from local JSON files, replacing the normal LaunchDarkly connection. This would typically be for testing purposes. See `LaunchDarkly\Integrations\Files`.
+- The `allFlagsState` method now accepts a new option, `detailsOnlyForTrackedFlags`, which reduces the size of the JSON representation of the flag state by omitting some metadata. Specifically, it omits any data that is normally used for generating detailed evaluation events if a flag does not have event tracking or debugging turned on.
+
+### Changed:
+- The `feature_requester` and `event_publisher` configuration options now work differently: you can still set them to an instance of an implementation object, but you can also set them to a class or a class name (i.e. the same as the `feature_requester_class` option), or a factory function. Therefore, the `_class` versions of these options are no longer necessary. However, the old semantics still work, so you can for instance set `event_publisher_class` to `"LaunchDarkly\GuzzleEventPublisher"`, even though the new preferred way is to set `event_publisher` to `LaunchDarkly\Integrations\Guzzle::featureRequester()`.
+
+### Fixed:
+- JSON data from `allFlagsState` is now slightly smaller even if you do not use the new option described above, because it omits the flag property for event tracking unless that property is true.
+- The `$_anonymous` property of the `LDUser` class was showing up as public rather than protected. (Thanks, [dstockto](https://github.com/launchdarkly/php-client/pull/114)!)
+
 ## [3.4.1] - 2018-09-25
 ### Fixed:
 - Improved the performance of `allFlags`/`allFlagsState` by not making redundant individual requests for prerequisite flags, when a flag is being evaluated that has prerequisites. Instead it will reuse the same flag data that it already obtained from LaunchDarkly in the "get all the flags" request.

README.md

@@ -64,33 +64,71 @@ With Guzzle, you could persist your cache somewhere other than the default in-me
 Using LD-Relay
 ==============
 
-The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-relay)) consumes the LaunchDarkly streaming API and can update
-a Redis cache operating in your production environment. The ld-relay offers many benefits such as performance and feature flag consistency. With PHP applications, we strongly recommend setting up ld-relay with a Redis store.
+The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-relay)) consumes the LaunchDarkly streaming API and can update a database cache operating in your production environment. The ld-relay offers many benefits such as performance and feature flag consistency. With PHP applications, we strongly recommend setting up ld-relay with a database store. The database can be Redis, Consul, or DynamoDB. (For more about using LaunchDarkly with databases, see the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).)
 
 1. Set up ld-relay in [daemon-mode](https://github.com/launchdarkly/ld-relay#redis-storage-and-daemon-mode) with Redis
 
-2. Require Predis as a dependency:
+2. Add the necessary dependency for the chosen database.
+
+    For Redis:
 
         php composer.phar require "predis/predis:1.0.*"
 
-3. Create the LDClient with the Redis feature requester as an option:
+    For Consul:
+
+        php composer.phar require "sensiolabs/consul-php-sdk:2.*"
+
+    For DynamoDB:
+
+        php composer.phar require "aws/aws-sdk-php:3.*"
+
+3. Create the LDClient with the appropriate parameters for the chosen database. These examples show all of the available options.
+
+    For Redis:
 
         $client = new LaunchDarkly\LDClient("your_sdk_key", [
-            'feature_requester_class' => 'LaunchDarkly\LDDFeatureRequester',
-            'redis_host' => 'your.redis.host',
-            'redis_port' => 6379
+            'feature_requester' => LaunchDarkly\Integrations\Redis::featureRequester(),
+            'redis_host' => 'your.redis.host',  // defaults to "localhost" if not specified
+            'redis_port' => 6379,               // defaults to 6379 if not specified
+            'redis_timeout' => 5,               // connection timeout in seconds; defaults to 5
+            'redis_prefix' => 'env1'            // corresponds to the prefix setting in ld-relay
+            'predis_client' => $myClient        // use this if you have already configured a Predis client instance
         ]);
 
-4. If ld-relay is configured for [event forwarding](https://github.com/launchdarkly/ld-relay#event-forwarding), you can configure the LDClient to publish events to ld-relay instead of directly to `events.launchdarkly.com`. Using `GuzzleEventPublisher` with ld-relay event forwarding can be an efficient alternative to the default `curl`-based event publishing.
+    For Consul:
 
         $client = new LaunchDarkly\LDClient("your_sdk_key", [
-            'event_publisher_class' => 'LaunchDarkly\GuzzleEventPublisher',
-            'events_uri' => 'http://your-ldrelay-host:8030',
-            'feature_requester_class' => 'LaunchDarkly\LDDFeatureRequester',
-            'redis_host' => 'your.redis.host',
-            'redis_port' => 6379
+            'feature_requester' => LaunchDarkly\Integrations\Consul::featureRequester(),
+            'consul_uri' => 'http://localhost:8500',  // this is the default
+            'consul_prefix' => 'env1',                // corresponds to the prefix setting in ld-relay
+            'consul_options' => array(),              // you may pass any options supported by the Guzzle client
+            'apc_expiration' => 30                    // expiration time for local caching, if you have apcu installed
         ]);
 
+    For DynamoDB:
+
+        $client = new LaunchDarkly\LDClient("your_sdk_key", [
+            'feature_requester' => LaunchDarkly\Integrations\DynamoDb::featureRequester(),
+            'dynamodb_table' => 'your.table.name',  // required
+            'dynamodb_prefix' => 'env1',            // corresponds to the prefix setting in ld-relay
+            'dynamodb_options' => array(),          // you may pass any options supported by the AWS SDK
+            'apc_expiration' => 30                  // expiration time for local caching, if you have apcu installed
+        ]);
+
+4. If you are using DynamoDB, you must create your table manually. It must have a partition key called "namespace", and a sort key called "key" (both strings). Note that by default the AWS SDK will attempt to get your AWS credentials and region from environment variables and/or local configuration files, but you may also specify them in `dynamodb_options`.
+
+5. If ld-relay is configured for [event forwarding](https://github.com/launchdarkly/ld-relay#event-forwarding), you can configure the LDClient to publish events to ld-relay instead of directly to `events.launchdarkly.com`. Using the `Guzzle` implementation of event publishing with ld-relay event forwarding can be an efficient alternative to the default `curl`-based event publishing.
+
+    To forward events, add the following configuration properties to the configuration shown above:
+
+            'event_publisher' => LaunchDarkly\Integrations\Guzzle::eventPublisher(),
+            'events_uri' => 'http://your-ldrelay-host:8030'
+
+Using flag data from a file
+---------------------------
+
+For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See [`LaunchDarkly\Integrations\Files`](https://github.com/launchdarkly/php-client/blob/master/src/LaunchDarkly/Integrations/Files.php) and ["Reading flags from a file"](https://docs.launchdarkly.com/docs/reading-flags-from-a-file).
+
 Testing
 -------
 
@@ -107,7 +145,7 @@ Contributing
 We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
 
 About LaunchDarkly
------------
+------------------
 
 * LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
     * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
@@ -119,9 +157,9 @@ About LaunchDarkly
     * [JavaScript](http://docs.launchdarkly.com/docs/js-sdk-reference "LaunchDarkly JavaScript SDK")
     * [PHP](http://docs.launchdarkly.com/docs/php-sdk-reference "LaunchDarkly PHP SDK")
     * [Python](http://docs.launchdarkly.com/docs/python-sdk-reference "LaunchDarkly Python SDK")
-    * [Python Twisted](http://docs.launchdarkly.com/docs/python-twisted-sdk-reference "LaunchDarkly Python Twisted SDK")
     * [Go](http://docs.launchdarkly.com/docs/go-sdk-reference "LaunchDarkly Go SDK")
     * [Node.JS](http://docs.launchdarkly.com/docs/node-sdk-reference "LaunchDarkly Node SDK")
+    * [Electron](http://docs.launchdarkly.com/docs/electron-sdk-reference "LaunchDarkly Electron SDK")
     * [.NET](http://docs.launchdarkly.com/docs/dotnet-sdk-reference "LaunchDarkly .Net SDK")
     * [Ruby](http://docs.launchdarkly.com/docs/ruby-sdk-reference "LaunchDarkly Ruby SDK")
     * [iOS](http://docs.launchdarkly.com/docs/ios-sdk-reference "LaunchDarkly iOS SDK")

VERSION

@@ -1 +1 @@
-3.4.1
+3.5.0

composer.json

@@ -19,18 +19,22 @@
         "psr/log": "^1.0"
     },
     "require-dev": {
+        "aws/aws-sdk-php": "^3.86",
         "friendsofphp/php-cs-fixer": "~2.2.19",
         "guzzlehttp/guzzle": "^6.2.1",
         "kevinrob/guzzle-cache-middleware": "^1.4.1",
         "phpdocumentor/phpdocumentor": "^2.0",
         "phpunit/phpunit": ">=4.8.26 <5.4",
         "predis/predis": "^1.0",
+        "sensiolabs/consul-php-sdk": ">=2.1 <3.0",
         "zendframework/zend-serializer": "^2.7"
     },
     "suggest": {
         "guzzlehttp/guzzle": "(^6.2.1) Required when using GuzzleEventPublisher or the default FeatureRequester",
         "kevinrob/guzzle-cache-middleware": "(^1.4.1) Recommended for performance when using the default FeatureRequester",
-        "predis/predis": "(^1.0) Required when using LDDFeatureRequester"
+        "predis/predis": "(^1.0) Required when using LDDFeatureRequester",
+        "aws/aws-sdk-php": "(^3.86) Required when using DynamoDbFeatureRequester",
+        "sensiolabs/consul-php-sdk": "(>=2.1 <3.0) Required when using ConsulFeatureRequester"
     },
     "autoload": {
         "psr-4": {