API - getEnabledFeatures (#81)

Author: oakbani

src/Optimizely/Optimizely.php

@@ -501,6 +501,32 @@ public function isFeatureEnabled($featureFlagKey, $userId, $attributes = null)
         return true;
     }
 
+    /**
+     * Get keys of all feature flags which are enabled for the user
+     * @param  string User ID
+     * @param  array Associative array of user attributes
+     * @return array List of feature flag keys
+     */
+    public function getEnabledFeatures($userId, $attributes = null)
+    {
+        $enabledFeatureKeys = [];
+
+        if (!$this->_isValid) {
+            $this->_logger->log(Logger::ERROR, "Datafile has invalid format. Failing '".__FUNCTION__."'.");
+            return $enabledFeatureKeys;
+        }
+
+        $featureFlags = $this->_config->getFeatureFlags();
+        foreach ($featureFlags as $feature){
+            $featureKey = $feature->getKey();
+            if ($this->isFeatureEnabled($featureKey, $userId, $attributes) === true) {
+                $enabledFeatureKeys[] = $featureKey;
+            }
+        }
+
+        return $enabledFeatureKeys;
+    }
+
     /**
      * Get the string value of the specified variable in the feature flag.
      * @param  string Feature flag key

src/Optimizely/ProjectConfig.php

@@ -272,6 +272,14 @@ public function getRevision()
         return $this->_revision;
     }
 
+    /**
+     * @return array List of feature flags parsed from the datafile
+     */
+    public function getFeatureFlags()
+    {
+        return $this->_featureFlags;
+    }
+
     /**
      * @param $groupId string ID of the group.
      *

tests/OptimizelyTest.php

@@ -2159,6 +2159,95 @@ public function testIsFeatureEnabledGivenFeatureFlagIsEnabledAndUserIsNotBeingEx
         );
     }
 
+    public function testGetEnabledFeaturesGivenInvalidDataFile()
+    {
+        $optlyObject = new Optimizely('Random datafile');
+
+        $this->expectOutputRegex("/Datafile has invalid format. Failing 'getEnabledFeatures'./");
+
+        $this->assertEmpty($optlyObject->getEnabledFeatures("user_id", []));   
+    }
+
+    public function testGetEnabledFeaturesGivenNoFeatureIsEnabledForUser()
+    {
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile))
+            ->setMethods(array('isFeatureEnabled'))
+            ->getMock();
+
+       // Mock isFeatureEnabled to return false for all calls
+        $optimizelyMock->expects($this->exactly(8))
+            ->method('isFeatureEnabled')
+            ->will($this->returnValue(false));
+
+        $this->assertEmpty($optimizelyMock->getEnabledFeatures("user_id", []));
+    }
+
+    public function testGetEnabledFeaturesGivenFeaturesAreEnabledForUser()
+    {
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile))
+            ->setMethods(array('isFeatureEnabled'))
+            ->getMock();
+
+        $map = [
+            ['boolean_feature','user_id', [], true],
+            ['double_single_variable_feature','user_id', [], false],
+            ['integer_single_variable_feature','user_id', [], false],
+            ['boolean_single_variable_feature','user_id', [], true],
+            ['string_single_variable_feature','user_id', [], false],
+            ['multi_variate_feature','user_id', [], false],
+            ['mutex_group_feature','user_id', [], false],
+            ['empty_feature','user_id', [], true],
+        ];
+
+       // Mock isFeatureEnabled to return specific values
+        $optimizelyMock->expects($this->exactly(8))
+            ->method('isFeatureEnabled')
+            ->will($this->returnValueMap($map));
+
+        $this->assertEquals(
+            ['boolean_feature', 'boolean_single_variable_feature', 'empty_feature'],
+            $optimizelyMock->getEnabledFeatures("user_id", [])
+        );
+    }
+
+    public function testGetEnabledFeaturesWithUserAttributes()
+    {
+        $optimizelyMock = $this->getMockBuilder(Optimizely::class)
+            ->setConstructorArgs(array($this->datafile))
+            ->setMethods(array('isFeatureEnabled'))
+            ->getMock();
+
+        $userAttributes = [
+            'device_type' => 'iPhone',
+            'company' => 'Optimizely',
+            'location' => 'San Francisco'
+        ];
+
+        $map = [
+            ['boolean_feature','user_id', $userAttributes, false],
+            ['double_single_variable_feature','user_id', $userAttributes, false],
+            ['integer_single_variable_feature','user_id', $userAttributes, false],
+            ['boolean_single_variable_feature','user_id', $userAttributes, false],
+            ['string_single_variable_feature','user_id', $userAttributes, false],
+            ['multi_variate_feature','user_id', $userAttributes, false],
+            ['mutex_group_feature','user_id', $userAttributes, false],
+            ['empty_feature','user_id', $userAttributes, true],
+        ];
+
+        // Assert that isFeatureEnabled is called with the same attributes and mock to return value map
+        $optimizelyMock->expects($this->exactly(8))
+            ->method('isFeatureEnabled')
+            ->with()
+            ->will($this->returnValueMap($map));
+
+        $this->assertEquals(
+            ['empty_feature'],
+            $optimizelyMock->getEnabledFeatures("user_id", $userAttributes)
+        );
+    }
+
     public function testGetFeatureVariableValueForTypeGivenInvalidArguments()
     {
         // should return null and log a message when feature flag key is empty