Merge 9aea1e1 into 7073e25

optimizely · Mar 28, 2019 · 4766af1 · 4766af1
2 parents 7073e25 + 9aea1e1
commit 4766af1
Show file tree

Hide file tree

Showing 4 changed files with 181 additions and 5 deletions.
diff --git a/src/Optimizely/Enums/DecisionInfoTypes.php b/src/Optimizely/Enums/DecisionInfoTypes.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Optimizely\Enums;
+
+class DecisionInfoTypes
+{
+    const EXPERIMENT = "experiment";
+    const FEATURE = "feature";
+    const FEATURE_VARIABLE = "feature_variable";
+}
diff --git a/src/Optimizely/Notification/NotificationType.php b/src/Optimizely/Notification/NotificationType.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2017, Optimizely Inc and Contributors
+ * Copyright 2017, 2019, Optimizely Inc and Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ class NotificationType
 {
     // format is EVENT: list of parameters to callback.
     const ACTIVATE = "ACTIVATE:experiment, user_id, attributes, variation, event";
+    const DECISION = "DECISION:type, user_id, attributes, decision_info";
     const TRACK = "TRACK:event_key, user_id, attributes, event_tags, event";
 
     public static function isNotificationTypeValid($notification_type)

diff --git a/src/Optimizely/Optimizely.php b/src/Optimizely/Optimizely.php
@@ -27,6 +27,7 @@
 use Optimizely\DecisionService\FeatureDecision;
 use Optimizely\Entity\Experiment;
 use Optimizely\Entity\FeatureVariable;
+use Optimizely\Enums\DecisionInfoTypes;
 use Optimizely\ErrorHandler\ErrorHandlerInterface;
 use Optimizely\ErrorHandler\NoOpErrorHandler;
 use Optimizely\Event\Builder\EventBuilder;
@@ -405,11 +406,23 @@ public function getVariation($experimentKey, $userId, $attributes = null)
         }
 
         $variation = $this->_decisionService->getVariation($experiment, $userId, $attributes);
-        if (is_null($variation)) {
-            return null;
-        }
+        $variationKey = ($variation === null) ? null : $variation->getKey();
 
-        return $variation->getKey();
+        $attributes = $attributes ?: [];
+        $this->notificationCenter->sendNotifications(
+            NotificationType::DECISION,
+            array(
+                DecisionInfoTypes::EXPERIMENT,
+                $userId,
+                $attributes,
+                (object) array(
+                    'experimentKey'=> $experiment->getKey(),
+                    'variationKey'=> $variationKey
+                )
+            )
+        );
+
+        return $variationKey;
     }
 
     /**

diff --git a/tests/OptimizelyTest.php b/tests/OptimizelyTest.php
@@ -20,6 +20,7 @@
 use Monolog\Logger;
 use Optimizely\DecisionService\DecisionService;
 use Optimizely\DecisionService\FeatureDecision;
+use Optimizely\Enums\DecisionInfoTypes;
 use Optimizely\ErrorHandler\NoOpErrorHandler;
 use Optimizely\Event\LogEvent;
 use Optimizely\Exceptions\InvalidAttributeException;
@@ -663,6 +664,72 @@ public function testActivateExperimentNotRunning()
         $this->assertNull($optimizelyMock->activate('paused_experiment', 'test_user', null));
     }
 
+    public function testActivateCallsDecisionListenerWhenUserInExperiment()
+    {
+        $userAttributes = [
+            'device_type' => 'iPhone',
+            'company' => 'Optimizely',
+            'location' => 'San Francisco'
+        ];
+
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile, new ValidEventDispatcher(), $this->loggerMock))
+            ->setMethods(array('sendImpressionEvent'))
+            ->getMock();
+
+        $arrayParam = array(
+            DecisionInfoTypes::EXPERIMENT,
+            'test_user',
+            [
+                'device_type' => 'iPhone',
+                'company' => 'Optimizely',
+                'location' => 'San Francisco'
+            ],
+            (object) array(
+                'experimentKey'=> 'test_experiment',
+                'variationKey'=> 'control'
+            )
+        );
+        $this->notificationCenterMock->expects($this->once())
+            ->method('sendNotifications')
+            ->with(
+                NotificationType::DECISION,
+                $arrayParam
+            );
+        $optimizelyMock->notificationCenter = $this->notificationCenterMock;
+
+        // Call activate
+        $optimizelyMock->activate('test_experiment', 'test_user', $userAttributes);
+    }
+
+    public function testActivateCallsDecisionListenerWhenUserNotInExperiment()
+    {
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile, new ValidEventDispatcher(), $this->loggerMock))
+            ->setMethods(array('sendImpressionEvent'))
+            ->getMock();
+
+        $arrayParam = array(
+            DecisionInfoTypes::EXPERIMENT,
+            'test_user',
+            [],
+            (object) array(
+                'experimentKey'=> 'test_experiment',
+                'variationKey'=> null
+            )
+        );
+        $this->notificationCenterMock->expects($this->once())
+            ->method('sendNotifications')
+            ->with(
+                NotificationType::DECISION,
+                $arrayParam
+            );
+        $optimizelyMock->notificationCenter = $this->notificationCenterMock;
+
+        // Call activate
+        $optimizelyMock->activate('test_experiment', 'test_user');
+    }
+
     public function testGetVariationInvalidOptimizelyObject()
     {
         $optlyObject = new Optimizely('Random datafile', null, new DefaultLogger(Logger::INFO, self::OUTPUT_STREAM));
@@ -2096,6 +2163,76 @@ public function testGetVariationBucketingIdAttribute()
         $this->assertNull($variationKey, sprintf('Invalid variation key "%s" for getVariation with bucketing ID "%s".', $variationKey, $this->testBucketingIdControl));
     }
 
+    public function testGetVariationCallsDecisionListenerWhenUserInExperiment()
+    {
+        $userAttributes = [
+            'device_type' => 'iPhone',
+            'company' => 'Optimizely',
+            'location' => 'San Francisco'
+        ];
+
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile, new ValidEventDispatcher(), $this->loggerMock))
+            ->setMethods(array('sendImpressionEvent'))
+            ->getMock();
+
+        $arrayParam = array(
+            DecisionInfoTypes::EXPERIMENT,
+            'test_user',
+            [
+                'device_type' => 'iPhone',
+                'company' => 'Optimizely',
+                'location' => 'San Francisco'
+            ],
+            (object) array(
+                'experimentKey'=> 'test_experiment',
+                'variationKey'=> 'control'
+            )
+        );
+        $this->notificationCenterMock->expects($this->once())
+            ->method('sendNotifications')
+            ->with(
+                NotificationType::DECISION,
+                $arrayParam
+            );
+        $optimizelyMock->notificationCenter = $this->notificationCenterMock;
+
+        // Call getVariation
+        $optimizelyMock->getVariation('test_experiment', 'test_user', $userAttributes);
+    }
+
+    public function testGetVariationCallsDecisionListenerWhenUserNotInExperiment()
+    {
+        $userAttributes = [
+            'device_type' => 'android'
+        ];
+
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile, new ValidEventDispatcher(), $this->loggerMock))
+            ->setMethods(array('sendImpressionEvent'))
+            ->getMock();
+
+        $arrayParam = array(
+            DecisionInfoTypes::EXPERIMENT,
+            'test_user',
+            ['device_type' => 'android'],
+            (object) array(
+                'experimentKey'=> 'test_experiment',
+                'variationKey'=> null
+            )
+        );
+        $this->notificationCenterMock->expects($this->once())
+            ->method('sendNotifications')
+            ->with(
+                NotificationType::DECISION,
+                $arrayParam
+            );
+        $optimizelyMock->notificationCenter = $this->notificationCenterMock;
+
+        // Call getVariation
+        $optimizelyMock->getVariation('test_experiment', 'test_user', $userAttributes);
+    }
+
     public function testIsFeatureEnabledGivenInvalidDataFile()
     {
         $optlyObject = new Optimizely('Random datafile', null, new DefaultLogger(Logger::INFO, self::OUTPUT_STREAM));