feat(DecisionListener): Adds experiment decision listener. (#161)

Author: rashidsp

src/Optimizely/Optimizely.php

@@ -406,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();
+
+        $attributes = $attributes ?: [];
+        $this->notificationCenter->sendNotifications(
+            NotificationType::DECISION,
+            array(
+                DecisionInfoTypes::EXPERIMENT,
+                $userId,
+                $attributes,
+                (object) array(
+                    'experimentKey'=> $experiment->getKey(),
+                    'variationKey'=> $variationKey
+                )
+            )
+        );
 
-        return $variation->getKey();
+        return $variationKey;
     }
 
     /**

tests/OptimizelyTest.php

@@ -664,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));
@@ -2097,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));