prepare 4.3.0 release

README.md

@@ -124,6 +124,11 @@ The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-rela
             'event_publisher_class' => 'LaunchDarkly\GuzzleEventPublisher',
             'events_uri' => 'http://your-ldrelay-host:8030'
 
+Using flag data from a file
+---------------------------
+
+For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See [`FileDataFeatureRequester`](https://github.com/launchdarkly/php-client/blob/master/FileDataFeatureRequester.php) and ["Reading flags from a file"](https://docs.launchdarkly.com/docs/reading-flags-from-a-file).
+
 Testing
 -------
 
@@ -140,7 +145,7 @@ Contributing
 We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
 
 About LaunchDarkly
------------
+------------------
 
 * LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
     * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.

src/LaunchDarkly/FileDataFeatureRequester.php

@@ -0,0 +1,132 @@
+<?php
+namespace LaunchDarkly;
+
+/**
+ * This component allows you to use local files as a source of feature flag state. This would
+ * typically be used in a test environment, to operate using a predetermined feature flag state
+ * without an actual LaunchDarkly connection.
+ * <p>
+ * To use this component, create an instance of this class, passing the path(s) of your data
+ * file(s). Then place the resulting object in your LaunchDarkly client configuration with the
+ * key "feature_requester".
+ * <pre>
+ *     $file_data = new FileDataFeatureRequester("./testData/flags.json");
+ *     $config = array("feature_requester" => $file_data, "send_events" => false);
+ *     $client = new LDClient("sdk_key", $config);
+ * </pre>
+ * <p>
+ * This will cause the client <i>not</i> to connect to LaunchDarkly to get feature flags. (Note
+ * that in this example, <code>send_events</core> is also set to false so that it will not
+ * connect to LaunchDarkly to send analytics events either.)
+ * <p>
+ */
+class FileDataFeatureRequester implements FeatureRequester
+{
+    /** @var array  */
+    private $_filePaths;
+    /** @var array */
+    private $_flags;
+    /** @var array  */
+    private $_segments;
+
+    public function __construct($filePaths)
+    {
+        $this->_filePaths = is_array($filePaths) ? $filePaths : array($filePaths);
+        $this->_flags = array();
+        $this->_segments = array();
+        $this->readAllData();
+    }
+
+    /**
+     * Gets an individual feature flag
+     *
+     * @param $key string feature key
+     * @return FeatureFlag|null The decoded FeatureFlag, or null if missing
+     */
+    public function getFeature($key)
+    {
+        return isset($this->_flags[$key]) ? $this->_flags[$key] : null;
+    }
+
+    /**
+     * Gets an individual user segment
+     *
+     * @param $key string segment key
+     * @return Segment|null The decoded Segment, or null if missing
+     */
+    public function getSegment($key)
+    {
+        return isset($this->_segments[$key]) ? $this->_segments[$key] : null;
+    }
+
+    /**
+     * Gets all feature flags
+     *
+     * @return array()|null The decoded FeatureFlags, or null if missing
+     */
+    public function getAllFeatures()
+    {
+        return $this->_flags;
+    }
+
+    private function readAllData()
+    {
+        $flags = array();
+        $segments = array();
+        foreach ($this->_filePaths as $filePath) {
+            $this->loadFile($filePath, $flags, $segments);
+        }
+        $this->_flags = $flags;
+        $this->_segments = $segments;
+    }
+
+    private function loadFile($filePath, &$flags, &$segments)
+    {
+        $content = file_get_contents($filePath);
+        $data = json_decode($content, true);
+        if ($data == null) {
+            throw new \InvalidArgumentException("File is not valid JSON: " + $filePath);
+        }
+        if (isset($data['flags'])) {
+            foreach ($data['flags'] as $key => $value) {
+                $flag = FeatureFlag::decode($value);
+                $this->tryToAdd($flags, $key, $flag, "feature flag");
+            }
+        }
+        if (isset($data['flagValues'])) {
+            foreach ($data['flagValues'] as $key => $value) {
+                $flag = FeatureFlag::decode(array(
+                    "key" => $key,
+                    "version" => 1,
+                    "on" => false,
+                    "prerequisites" => array(),
+                    "salt" => "",
+                    "targets" => array(),
+                    "rules" => array(),
+                    "fallthrough" => array(),
+                    "offVariation" => 0,
+                    "variations" => array($value),
+                    "deleted" => false,
+                    "trackEvents" => false,
+                    "clientSide" => false
+                ));
+                $this->tryToAdd($flags, $key, $flag, "feature flag");
+            }
+        }
+        if (isset($data['segments'])) {
+            foreach ($data['segments'] as $key => $value) {
+                $segment = Segment::decode($value);
+                $this->tryToAdd($segments, $key, $segment, "user segment");
+            }
+        }
+    }
+
+    private function tryToAdd(&$array, $key, $item, $kind)
+    {
+        if (isset($array[$key])) {
+            throw new \InvalidArgumentException("File data contains more than one " . $kind . " with key: " . $key);
+        } else {
+            $array[$key] = $item;
+        }
+    }
+}

tests/FileDataFeatureRequesterTest.php

@@ -0,0 +1,38 @@
+<?php
+namespace LaunchDarkly\Tests;
+
+use LaunchDarkly\FileDataFeatureRequester;
+use LaunchDarkly\LDUser;
+
+class FileDataFeatureRequesterTest extends \PHPUnit_Framework_TestCase
+{
+    public function testLoadsFile()
+    {
+        $fr = new FileDataFeatureRequester("./tests/filedata/all-properties.json");
+        $flag1 = $fr->getFeature("flag1");
+        $this->assertEquals("flag1", $flag1->getKey());
+        $flag2 = $fr->getFeature("flag2");
+        $this->assertEquals("flag2", $flag2->getKey());
+        $seg1 = $fr->getSegment("seg1");
+        $this->assertEquals("seg1", $seg1->getKey());
+    }
+
+    public function testLoadsMultipleFiles()
+    {
+        $fr = new FileDataFeatureRequester(array("./tests/filedata/flag-only.json",
+            "./tests/filedata/segment-only.json"));
+        $flag1 = $fr->getFeature("flag1");
+        $this->assertEquals("flag1", $flag1->getKey());
+        $seg1 = $fr->getSegment("seg1");
+        $this->assertEquals("seg1", $seg1->getKey());
+    }
+
+    public function testShortcutFlagCanBeEvaluated()
+    {
+        $fr = new FileDataFeatureRequester("./tests/filedata/all-properties.json");
+        $flag2 = $fr->getFeature("flag2");
+        $this->assertEquals("flag2", $flag2->getKey());
+        $result = $flag2->evaluate(new LDUser("user"), null);
+        $this->assertEquals("value2", $result->getDetail()->getValue());
+    }
+}

tests/filedata/all-properties.json

@@ -0,0 +1,35 @@
+{
+  "flags": {
+    "flag1": {
+      "key": "flag1",
+      "version": 1,
+      "deleted": false,
+      "on": true,
+      "prerequisites": [],
+      "targets": [],
+      "rules": [],
+      "fallthrough": {
+        "variation": 2
+      },
+      "variations": [ "fall", "off", "on" ],
+      "offVariation": 0,
+      "salt": "",
+      "trackEvents": false,
+      "clientSide": false
+    }
+  },
+  "flagValues": {
+    "flag2": "value2"
+  },
+  "segments": {
+    "seg1": {
+      "key": "seg1",
+      "version": 1,
+      "deleted": false,
+      "included": ["user1"],
+      "excluded": [],
+      "rules": [],
+      "salt": ""
+    }
+  }
+}

tests/filedata/flag-only.json

@@ -0,0 +1,21 @@
+{
+  "flags": {
+    "flag1": {
+      "key": "flag1",
+      "version": 1,
+      "deleted": false,
+      "on": true,
+      "prerequisites": [],
+      "targets": [],
+      "rules": [],
+      "fallthrough": {
+        "variation": 2
+      },
+      "variations": [ "fall", "off", "on" ],
+      "offVariation": 0,
+      "salt": "",
+      "trackEvents": false,
+      "clientSide": false
+    }
+  }
+}

tests/filedata/segment-only.json

@@ -0,0 +1,13 @@
+{
+  "segments": {
+  	"seg1": {
+			"key": "seg1",
+			"version": 1,
+			"deleted": false,
+      "included": ["user1"],
+      "excluded": [],
+      "rules": [],
+      "salt": ""
+  	}
+  }
+}