add variation index to feature request events

eli-darkly · eli-darkly · commit 3224f382d148 · 2018-04-30T13:49:02.000-07:00
diff --git a/src/LaunchDarkly/CurlEventPublisher.php b/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");
diff --git a/src/LaunchDarkly/EventPublisher.php b/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
diff --git a/src/LaunchDarkly/FeatureFlag.php b/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
      */
diff --git a/src/LaunchDarkly/GuzzleEventPublisher.php b/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']
diff --git a/src/LaunchDarkly/LDClient.php b/src/LaunchDarkly/LDClient.php
@@ -149,7 +149,7 @@ public function variation($key, $user, $default = false)
 
         try {
             if (is_null($user) || is_null($user->getKey())) {
-                $this->_sendFlagRequestEvent($key, $user, $default, $default);
+                $this->_sendFlagRequestEvent($key, $user, null, $default, $default);
                 $this->_logger->warning("Variation called with null user or null user key! Returning default value");
                 return $default;
             }
@@ -164,7 +164,7 @@ 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;
             }
             $evalResult = $flag->evaluate($user, $this->_featureRequester);
@@ -173,15 +173,15 @@ 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();
             }
         } 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 +326,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)
diff --git a/src/LaunchDarkly/Util.php b/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();

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`	`*/`
`7`	`7`	`interface EventPublisher`
`8`	`8`	`{`
	`9`	`+ const CURRENT_SCHEMA_VERSION = 2;`
	`10`	`+`
`9`	`11`	`/**`
`10`	`12`	`* @param string $sdkKey The SDK key for your account`
`11`	`13`	`* @param mixed[] $options Client configuration settings`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ public function variation($key, $user, $default = false)`
`149`	`149`
`150`	`150`	`try {`
`151`	`151`	`if (is_null($user) \|\| is_null($user->getKey())) {`
`152`		`- $this->_sendFlagRequestEvent($key, $user, $default, $default);`
	`152`	`+ $this->_sendFlagRequestEvent($key, $user, null, $default, $default);`
`153`	`153`	`$this->_logger->warning("Variation called with null user or null user key! Returning default value");`
`154`	`154`	`return $default;`
`155`	`155`	`}`
`@@ -164,7 +164,7 @@ public function variation($key, $user, $default = false)`
`164`	`164`	`}`
`165`	`165`
`166`	`166`	`if (is_null($flag)) {`
`167`		`- $this->_sendFlagRequestEvent($key, $user, $default, $default);`
	`167`	`+ $this->_sendFlagRequestEvent($key, $user, null, $default, $default);`
`168`	`168`	`return $default;`
`169`	`169`	`}`
`170`	`170`	`$evalResult = $flag->evaluate($user, $this->_featureRequester);`
`@@ -173,15 +173,15 @@ public function variation($key, $user, $default = false)`
`173`	`173`	`$this->_eventProcessor->enqueue($e);`
`174`	`174`	`}`
`175`	`175`	`}`
`176`		`- if ($evalResult->getValue() !== null) {`
`177`		`- $this->_sendFlagRequestEvent($key, $user, $evalResult->getValue(), $default, $flag->getVersion());`
	`176`	`+ if ($evalResult !== null && $evalResult->getValue() !== null) {`
	`177`	`+ $this->_sendFlagRequestEvent($key, $user, $evalResult->getVariation(), $evalResult->getValue(), $default, $flag->getVersion());`
`178`	`178`	`return $evalResult->getValue();`
`179`	`179`	`}`
`180`	`180`	`} catch (\Exception $e) {`
`181`	`181`	`$this->_logger->error("Caught $e");`
`182`	`182`	`}`
`183`	`183`	`try {`
`184`		`- $this->_sendFlagRequestEvent($key, $user, $default, $default);`
	`184`	`+ $this->_sendFlagRequestEvent($key, $user, null, $default, $default);`
`185`	`185`	`} catch (\Exception $e) {`
`186`	`186`	`$this->_logger->error("Caught $e");`
`187`	`187`	`}`
`@@ -326,17 +326,18 @@ public function flush()`
`326`	`326`	`/**`
`327`	`327`	`* @param $key string`
`328`	`328`	`* @param $user LDUser`
	`329`	`+ * @param $variation int \| null`
`329`	`330`	`* @param $value mixed`
`330`	`331`	`* @param $default`
`331`	`332`	`* @param $version int \| null`
`332`	`333`	`* @param string \| null $prereqOf`
`333`	`334`	`*/`
`334`		`- protected function _sendFlagRequestEvent($key, $user, $value, $default, $version = null, $prereqOf = null)`
	`335`	`+ protected function _sendFlagRequestEvent($key, $user, $variation, $value, $default, $version = null, $prereqOf = null)`
`335`	`336`	`{`
`336`	`337`	`if ($this->isOffline() \|\| !$this->_send_events) {`
`337`	`338`	`return;`
`338`	`339`	`}`
`339`		`- $this->_eventProcessor->enqueue(Util::newFeatureRequestEvent($key, $user, $value, $default, $version, $prereqOf));`
	`340`	`+ $this->_eventProcessor->enqueue(Util::newFeatureRequestEvent($key, $user, $variation, $value, $default, $version, $prereqOf));`
`340`	`341`	`}`
`341`	`342`
`342`	`343`	`protected function _get_default($key, $default)`