Merge pull request #31 from launchdarkly/eb/ch24449/less-metadata

add option to reduce front-end metadata for untracked flags

Author: eli-darkly

src/LaunchDarkly/FeatureFlagsState.php

@@ -28,17 +28,21 @@ public function __construct($valid, $flagValues = array(), $flagMetadata = array
     /**
      * Used internally to build the state map.
      */
-    public function addFlag($flag, $detail, $withReason = false)
+    public function addFlag($flag, $detail, $withReason = false, $detailsOnlyIfTracked = false)
     {
         $this->_flagValues[$flag->getKey()] = $detail->getValue();
         $meta = array();
+        if (!$detailsOnlyIfTracked || $flag->isTrackEvents() || $flag->getDebugEventsUntilDate()) {
+            $meta['version'] = $flag->getVersion();
+            if ($withReason) {
+                $meta['reason'] = $detail->getReason();
+            }
+        }
         if (!is_null($detail->getVariationIndex())) {
             $meta['variation'] = $detail->getVariationIndex();
         }
-        $meta['version'] = $flag->getVersion();
-        $meta['trackEvents'] = $flag->isTrackEvents();
-        if ($withReason) {
-            $meta['reason'] = $detail->getReason();
+        if ($flag->isTrackEvents()) {
+            $meta['trackEvents'] = true;
         }
         if ($flag->getDebugEventsUntilDate()) {
             $meta['debugEventsUntilDate'] = $flag->getDebugEventsUntilDate();

src/LaunchDarkly/LDClient.php

@@ -356,12 +356,13 @@ public function allFlagsState($user, $options = array())
         $state = new FeatureFlagsState(true);
         $clientOnly = isset($options['clientSideOnly']) && $options['clientSideOnly'];
         $withReasons = isset($options['withReasons']) && $options['withReasons'];
+        $detailsOnlyIfTracked = isset($options['detailsOnlyForTrackedFlags']) && $options['detailsOnlyForTrackedFlags'];
         foreach ($flags as $key => $flag) {
             if ($clientOnly && !$flag->isClientSide()) {
                 continue;
             }
             $result = $flag->evaluate($user, $preloadedRequester);
-            $state->addFlag($flag, $result->getDetail(), $withReasons);
+            $state->addFlag($flag, $result->getDetail(), $withReasons, $detailsOnlyIfTracked);
         }
         return $state;
     }

tests/FeatureFlagsStateTest.php

@@ -106,8 +106,7 @@ public function testCanConvertToJson()
             '$flagsState' => array(
                 'key1' => array(
                     'variation' => 0,
-                    'version' => 100,
-                    'trackEvents' => false
+                    'version' => 100
                 ),
                 'key2' => array(
                     'variation' => 1,

tests/LDClientTest.php

@@ -401,6 +401,93 @@ public function testAllFlagsStateCanFilterForClientSideFlags()
         $this->assertEquals(array('client-side-1' => 'value1', 'client-side-2' => 'value2'), $state->toValuesMap());
     }
 
+    public function testAllFlagsStateCanOmitDetailsForUntrackedFlags()
+    {
+        $flag1Json = array(
+            'key' => 'flag1',
+            'version' => 100,
+            'deleted' => false,
+            'on' => false,
+            'targets' => array(),
+            'prerequisites' => array(),
+            'rules' => array(),
+            'offVariation' => 0,
+            'fallthrough' => null,
+            'variations' => array('value1'),
+            'salt' => '',
+            'trackEvents' => false
+        );
+        $flag2Json = array(
+            'key' => 'flag2',
+            'version' => 200,
+            'deleted' => false,
+            'on' => false,
+            'targets' => array(),
+            'prerequisites' => array(),
+            'rules' => array(),
+            'offVariation' => 0,
+            'fallthrough' => null,
+            'variations' => array('value2'),
+            'salt' => '',
+            'trackEvents' => true
+        );
+        $flag3Json = array(
+            'key' => 'flag3',
+            'version' => 300,
+            'deleted' => false,
+            'on' => false,
+            'targets' => array(),
+            'prerequisites' => array(),
+            'rules' => array(),
+            'offVariation' => 0,
+            'fallthrough' => null,
+            'variations' => array('value3'),
+            'salt' => '',
+            'trackEvents' => false,
+            'debugEventsUntilDate' => 1000
+        );
+        $flag1 = FeatureFlag::decode($flag1Json);
+        $flag2 = FeatureFlag::decode($flag2Json);
+        $flag3 = FeatureFlag::decode($flag3Json);
+
+        MockFeatureRequester::$flags = array('flag1' => $flag1, 'flag2' => $flag2, 'flag3' => $flag3);
+        $client = new LDClient("someKey", array(
+            'feature_requester_class' => MockFeatureRequester::class,
+            'events' => false
+            ));
+
+        $builder = new LDUserBuilder(3);
+        $user = $builder->build();
+        $state = $client->allFlagsState($user, array('withReasons' => true, 'detailsOnlyForTrackedFlags' => true));
+         
+        $this->assertTrue($state->isValid());
+        $this->assertEquals(array('flag1' => 'value1', 'flag2' => 'value2', 'flag3' => 'value3'), $state->toValuesMap());
+        $expectedState = array(
+            'flag1' => 'value1',
+            'flag2' => 'value2',
+            'flag3' => 'value3',
+            '$flagsState' => array(
+                'flag1' => array(
+                    'variation' => 0,
+                ),
+                'flag2' => array(
+                    'variation' =>  0,
+                    'version' => 200,
+                    'reason' => array('kind' => 'OFF'),
+                    'trackEvents' => true
+                ),
+                'flag3' => array(
+                    'variation' => 0,
+                    'version' => 300,
+                    'reason' => array('kind' => 'OFF'),
+                    'debugEventsUntilDate' => 1000
+                )
+            ),
+            '$valid' => true
+        );
+        $this->assertEquals($expectedState, $state->jsonSerialize());
+    }
+
     public function testOnlyValidFeatureRequester()
     {
         $this->setExpectedException(InvalidArgumentException::class);