prepare 3.1.0 release

.circleci/config.yml

@@ -0,0 +1,98 @@
+version: 2
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test-5.5
+      - test-5.6
+      - test-7.0
+      - test-7.1
+      - test-7.2
+      - integration-test
+
+php-docker-template: &php-docker-template
+  steps:
+    - checkout
+    - run:
+        name: install current dependencies
+        command: composer install --no-progress
+    - run:
+        name: run tests with current 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
+        # we skip this for 7.2 because the lowest compatible version of PHPUnit has a bug:
+        # https://github.com/sebastianbergmann/comparator/pull/30
+        command: |
+          if [[ $CIRCLE_JOB != test-7.2 ]]; then
+            composer update --prefer-lowest --no-progress && vendor/bin/phpunit tests;
+          fi
+
+jobs:
+  test-5.6:
+    <<: *php-docker-template
+    docker:
+      - image: circleci/php:5.6.34-cli-jessie
+  test-7.0:
+    <<: *php-docker-template
+    docker:
+      - image: circleci/php:7.0.28-cli-jessie
+  test-7.1:
+    <<: *php-docker-template
+    docker:
+      - image: circleci/php:7.1.15-cli-jessie
+  test-7.2:
+    <<: *php-docker-template
+    docker:
+      - image: circleci/php:7.2.3-cli-stretch
+
+  test-5.5: # CircleCI doesn't provide a Docker image for 5.5
+    machine:
+      image: circleci/classic:latest # Ubuntu 14.04
+    steps:
+      - run:
+          name: install PHP and Composer
+          command: |
+            sudo apt-get update &&
+            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
+      - checkout
+      - run:
+          name: update dependencies # the dependencies in composer.lock don't work with 5.5
+          command: composer update --no-progress
+      - run:
+          name: run tests
+          command: vendor/bin/phpunit --log-junit ~/phpunit/junit.xml --coverage-text tests
+      - store_test_results:
+          path: ~/phpunit
+      - store_artifacts:
+          path: ~/phpunit
+
+  integration-test:
+    docker:
+      - image: circleci/php:5.6.34-cli-jessie
+      - image: redis
+    steps:
+      - checkout
+      - run:
+          name: setup apcu
+          command: |
+            pecl config-set php_ini /usr/local/etc/php/php.ini
+            yes '' | sudo pecl install -f apcu-4.0.10 || true;
+            echo "extension=apcu.so" | sudo tee -a /usr/local/etc/php/conf.d/apcu.ini;
+            echo "apc.enable_cli = 1" | sudo tee -a /usr/local/etc/php/conf.d/apcu.ini
+      - run: composer update --no-progress
+      - run: vendor/bin/phpunit --log-junit ~/phpunit/junit.xml integration-tests/LDDFeatureRequesterTest.php
+      - store_test_results:
+          path: ~/phpunit
+      - store_artifacts:
+          path: ~/phpunit

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to the LaunchDarkly PHP SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [3.1.0] - 2018-04-30
+### Added
+- Analytics events for feature evaluations now have a `variation` property (the variation index) as well as `value`. This will allow for better performance in future versions of [`ld-relay`](https://github.com/launchdarkly/ld-relay) when it is used with the PHP client.
+### Fixed
+- Fixed a bug that made segment-based rules always fall through when using `LDDFeatureRequester`.
+
 ## [3.0.0] - 2018-02-21
 ### Added
 - Support for a new LaunchDarkly feature: reusable user segments.

README.md

@@ -1,8 +1,6 @@
 LaunchDarkly SDK for PHP
 ===========================
 
-[![Code Climate](https://codeclimate.com/github/launchdarkly/php-client/badges/gpa.svg)](https://codeclimate.com/github/launchdarkly/php-client)
-
 [![Circle CI](https://circleci.com/gh/launchdarkly/php-client.svg?style=svg)](https://circleci.com/gh/launchdarkly/php-client)
 
 Requirements

VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

src/LaunchDarkly/CurlEventPublisher.php

@@ -60,6 +60,7 @@ private function createArgs($payload)
         $args.= " -H 'Content-Type: application/json'";
         $args.= " -H " . escapeshellarg("Authorization: " . $this->_sdkKey);
         $args.= " -H 'User-Agent: PHPClient/" . LDClient::VERSION . "'";
+        $args.= " -H 'X-LaunchDarkly-Event-Schema: " . EventPublisher::CURRENT_SCHEMA_VERSION . "'";
         $args.= " -H 'Accept: application/json'";
         $args.= " -d " . escapeshellarg($payload);
         $args.= " " . escapeshellarg($scheme . $this->_host . ":" . $this->_port . $this->_path . "/bulk");

src/LaunchDarkly/EventPublisher.php

@@ -6,6 +6,8 @@
  */
 interface EventPublisher
 {
+    const CURRENT_SCHEMA_VERSION = 2;
+
     /**
      * @param string $sdkKey The SDK key for your account
      * @param mixed[] $options Client configuration settings

src/LaunchDarkly/FeatureFlag.php

@@ -95,18 +95,18 @@ public function evaluate($user, $featureRequester)
         if ($this->isOn()) {
             $result = $this->_evaluate($user, $featureRequester, $prereqEvents);
             if ($result !== null) {
-                return new EvalResult($result, $prereqEvents);
+                return $result;
             }
         }
-        $offVariation = $this->getOffVariationValue();
-        return new EvalResult($offVariation, $prereqEvents);
+        $offVariationValue = $this->getOffVariationValue();
+        return new EvalResult($this->_offVariation, $offVariationValue, $prereqEvents);
     }
 
     /**
      * @param $user LDUser
      * @param $featureRequester FeatureRequester
      * @param $events
-     * @return mixed|null
+     * @return EvalResult|null
      */
     private function _evaluate($user, $featureRequester, &$events)
     {
@@ -120,21 +120,26 @@ private function _evaluate($user, $featureRequester, &$events)
                         return null;
                     } elseif ($prereqFeatureFlag->isOn()) {
                         $prereqEvalResult = $prereqFeatureFlag->_evaluate($user, $featureRequester, $events);
-                        $variation = $prereqFeatureFlag->getVariation($prereq->getVariation());
-                        if ($prereqEvalResult === null || $variation === null || $prereqEvalResult !== $variation) {
+                        $variation = $prereq->getVariation();
+                        if ($prereqEvalResult === null || $variation === null || $prereqEvalResult->getVariation() !== $variation) {
                             $prereqOk = false;
                         }
                     } else {
                         $prereqOk = false;
                     }
-                    array_push($events, Util::newFeatureRequestEvent($prereqFeatureFlag->getKey(), $user, $prereqEvalResult, null, $prereqFeatureFlag->getVersion(), $this->_key));
+                    array_push($events, Util::newFeatureRequestEvent($prereqFeatureFlag->getKey(), $user,
+                        $prereqEvalResult === null ? null : $prereqEvalResult->getVariation(),
+                        $prereqEvalResult === null ? null : $prereqEvalResult->getValue(),
+                        null, $prereqFeatureFlag->getVersion(), $this->_key));
                 } catch (EvaluationException $e) {
                     $prereqOk = false;
                 }
             }
         }
         if ($prereqOk) {
-            return $this->getVariation($this->evaluateIndex($user, $featureRequester));
+            $variation = $this->evaluateIndex($user, $featureRequester);
+            $value = $this->getVariation($variation);
+            return new EvalResult($variation, $value, $events);
         }
         return null;
     }
@@ -221,6 +226,7 @@ public function isDeleted()
 
 class EvalResult
 {
+    private $_variation = null;
     private $_value = null;
     /** @var array */
     private $_prerequisiteEvents = [];
@@ -230,12 +236,21 @@ class EvalResult
      * @param null $value
      * @param array $prerequisiteEvents
      */
-    public function __construct($value, array $prerequisiteEvents)
+    public function __construct($variation, $value, array $prerequisiteEvents)
     {
+        $this->_variation = $variation;
         $this->_value = $value;
         $this->_prerequisiteEvents = $prerequisiteEvents;
     }
 
+    /**
+     * @return int
+     */
+    public function getVariation()
+    {
+        return $this->_variation;
+    }
+
     /**
      * @return null
      */

src/LaunchDarkly/GuzzleEventPublisher.php

@@ -39,7 +39,8 @@ public function __construct($sdkKey, array $options = array())
                 'Content-Type'  => 'application/json',
                 'Authorization' => $this->_sdkKey,
                 'User-Agent'    => 'PHPClient/' . LDClient::VERSION,
-                'Accept'        => 'application/json'
+                'Accept'        => 'application/json',
+                'X-LaunchDarkly-Event-Schema' => strval(EventPublisher::CURRENT_SCHEMA_VERSION)
             ],
             'timeout' => $options['timeout'],
             'connect_timeout' => $options['connect_timeout']

src/LaunchDarkly/LDClient.php

@@ -19,7 +19,7 @@ class LDClient
 {
     const DEFAULT_BASE_URI = 'https://app.launchdarkly.com';
     const DEFAULT_EVENTS_URI = 'https://events.launchdarkly.com';
-    const VERSION = '3.0.0';
+    const VERSION = '3.1.0';
 
     /** @var string */
     protected $_sdkKey;
@@ -148,12 +148,7 @@ public function variation($key, $user, $default = false)
         }
 
         try {
-            if (is_null($user) || is_null($user->getKey())) {
-                $this->_sendFlagRequestEvent($key, $user, $default, $default);
-                $this->_logger->warning("Variation called with null user or null user key! Returning default value");
-                return $default;
-            }
-            if ($user->isKeyBlank()) {
+            if (!is_null($user) && $user->isKeyBlank()) {
                 $this->_logger->warning("User key is blank. Flag evaluation will proceed, but the user will not be stored in LaunchDarkly.");
             }
             try {
@@ -164,7 +159,12 @@ public function variation($key, $user, $default = false)
             }
 
             if (is_null($flag)) {
-                $this->_sendFlagRequestEvent($key, $user, $default, $default);
+                $this->_sendFlagRequestEvent($key, $user, null, $default, $default);
+                return $default;
+            }
+            if (is_null($user) || is_null($user->getKey())) {
+                $this->_sendFlagRequestEvent($key, $user, null, $default, $default, $flag->getVersion());
+                $this->_logger->warning("Variation called with null user or null user key! Returning default value");
                 return $default;
             }
             $evalResult = $flag->evaluate($user, $this->_featureRequester);
@@ -173,15 +173,18 @@ public function variation($key, $user, $default = false)
                     $this->_eventProcessor->enqueue($e);
                 }
             }
-            if ($evalResult->getValue() !== null) {
-                $this->_sendFlagRequestEvent($key, $user, $evalResult->getValue(), $default, $flag->getVersion());
+            if ($evalResult !== null && $evalResult->getValue() !== null) {
+                $this->_sendFlagRequestEvent($key, $user, $evalResult->getVariation(), $evalResult->getValue(), $default, $flag->getVersion());
                 return $evalResult->getValue();
+            } else {
+                $this->_sendFlagRequestEvent($key, $user, null, $default, $default, $flag->getVersion());
+                return $default;
             }
         } catch (\Exception $e) {
             $this->_logger->error("Caught $e");
         }
         try {
-            $this->_sendFlagRequestEvent($key, $user, $default, $default);
+            $this->_sendFlagRequestEvent($key, $user, null, $default, $default);
         } catch (\Exception $e) {
             $this->_logger->error("Caught $e");
         }
@@ -326,17 +329,18 @@ public function flush()
     /**
      * @param $key string
      * @param $user LDUser
+     * @param $variation int | null
      * @param $value mixed
      * @param $default
      * @param $version int | null
      * @param string | null $prereqOf
      */
-    protected function _sendFlagRequestEvent($key, $user, $value, $default, $version = null, $prereqOf = null)
+    protected function _sendFlagRequestEvent($key, $user, $variation, $value, $default, $version = null, $prereqOf = null)
     {
         if ($this->isOffline() || !$this->_send_events) {
             return;
         }
-        $this->_eventProcessor->enqueue(Util::newFeatureRequestEvent($key, $user, $value, $default, $version, $prereqOf));
+        $this->_eventProcessor->enqueue(Util::newFeatureRequestEvent($key, $user, $variation, $value, $default, $version, $prereqOf));
     }
 
     protected function _get_default($key, $default)

src/LaunchDarkly/LDDFeatureRequester.php

@@ -98,7 +98,7 @@ public function getSegment($key)
         $raw = $this->get_from_cache($this->_segments_key, $key);
         if ($raw === null) {
             $redis = $this->get_connection();
-            $raw = $redis->hget($this->_features_key, $key);
+            $raw = $redis->hget($this->_segments_key, $key);
             if ($raw) {
                 $this->store_in_cache($this->_segments_key, $key, $raw);
             }

src/LaunchDarkly/Util.php

@@ -37,10 +37,11 @@ public static function currentTimeUnixMillis()
      * @param null $prereqOf string | null
      * @return array
      */
-    public static function newFeatureRequestEvent($key, $user, $value, $default, $version = null, $prereqOf = null)
+    public static function newFeatureRequestEvent($key, $user, $variation, $value, $default, $version = null, $prereqOf = null)
     {
         $event = array();
         $event['user'] = $user;
+        $event['variation'] = $variation;
         $event['value'] = $value;
         $event['kind'] = "feature";
         $event['creationDate'] = Util::currentTimeUnixMillis();