Merge pull request #36 from launchdarkly/eb/ch28432/consul

add Consul integration

Author: eli-darkly

.circleci/config.yml

@@ -42,21 +42,25 @@ jobs:
     docker:
       - image: circleci/php:5.6.34-cli-jessie
       - image: amazon/dynamodb-local
+      - image: consul
   test-7.0:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.0.28-cli-jessie
       - image: amazon/dynamodb-local
+      - image: consul
   test-7.1:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.1.15-cli-jessie
       - image: amazon/dynamodb-local
+      - image: consul
   test-7.2:
     <<: *php-docker-template
     docker:
       - image: circleci/php:7.2.3-cli-stretch
       - image: amazon/dynamodb-local
+      - image: consul
 
   test-5.5: # CircleCI doesn't provide a Docker image for 5.5
     machine:
@@ -90,6 +94,16 @@ jobs:
           name: start DynamoDB
           command: docker run -p 8000:8000 amazon/dynamodb-local
           background: true
+      - run:
+          name: download Consul
+          command: wget https://releases.hashicorp.com/consul/0.8.0/consul_0.8.0_linux_amd64.zip
+      - run:
+          name: extract Consul
+          command: unzip consul_0.8.0_linux_amd64.zip
+      - run:
+          name: start Consul
+          command: ./consul agent -dev
+          background: true
       - run:
           name: run tests
           command: vendor/bin/phpunit --log-junit ~/phpunit/junit.xml --coverage-text tests

README.md

@@ -64,7 +64,7 @@ With Guzzle, you could persist your cache somewhere other than the default in-me
 Using LD-Relay
 ==============
 
-The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-relay)) consumes the LaunchDarkly streaming API and can update a database cache operating in your production environment. The ld-relay offers many benefits such as performance and feature flag consistency. With PHP applications, we strongly recommend setting up ld-relay with a database store. The database can be Redis or DynamoDB. (For more about using LaunchDarkly with Redis or DynamoDB, see the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).)
+The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-relay)) consumes the LaunchDarkly streaming API and can update a database cache operating in your production environment. The ld-relay offers many benefits such as performance and feature flag consistency. With PHP applications, we strongly recommend setting up ld-relay with a database store. The database can be Redis, Consul, or DynamoDB. (For more about using LaunchDarkly with databases, see the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).)
 
 1. Set up ld-relay in [daemon-mode](https://github.com/launchdarkly/ld-relay#redis-storage-and-daemon-mode) with Redis
 
@@ -74,6 +74,10 @@ The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-rela
 
         php composer.phar require "predis/predis:1.0.*"
 
+    For Consul:
+
+        php composer.phar require "sensiolabs/consul-php-sdk:2.*"
+
     For DynamoDB:
 
         php composer.phar require "aws/aws-sdk-php:3.*"
@@ -91,6 +95,16 @@ The LaunchDarkly Relay Proxy ([ld-relay](https://github.com/launchdarkly/ld-rela
             'predis_client' => $myClient        // use this if you have already configured a Predis client instance
         ]);
 
+    For Consul:
+
+        $client = new LaunchDarkly\LDClient("your_sdk_key", [
+            'feature_requester' => 'LaunchDarkly\ConsulFeatureRequester',
+            'consul_uri' => 'http://localhost:8500',  // this is the default
+            'consul_prefix' => 'env1',                // corresponds to the prefix setting in ld-relay
+            'consul_options' => array(),              // you may pass any options supported by the Guzzle client
+            'apc_expiration' => 30                    // expiration time for local caching, if you have apcu installed
+        ]);
+
     For DynamoDB:
 
         $client = new LaunchDarkly\LDClient("your_sdk_key", [

composer.json

@@ -26,13 +26,15 @@
         "phpdocumentor/phpdocumentor": "^2.0",
         "phpunit/phpunit": ">=4.8.26 <5.4",
         "predis/predis": "^1.0",
+        "sensiolabs/consul-php-sdk": ">=2.1 <3.0",
         "zendframework/zend-serializer": "^2.7"
     },
     "suggest": {
         "guzzlehttp/guzzle": "(^6.2.1) Required when using GuzzleEventPublisher or the default FeatureRequester",
         "kevinrob/guzzle-cache-middleware": "(^1.4.1) Recommended for performance when using the default FeatureRequester",
         "predis/predis": "(^1.0) Required when using LDDFeatureRequester",
-        "aws/aws-sdk-php": "(^3.86) Required when using DynamoDbFeatureRequester"
+        "aws/aws-sdk-php": "(^3.86) Required when using DynamoDbFeatureRequester",
+        "sensiolabs/consul-php-sdk": "(>=2.1 <3.0) Required when using ConsulFeatureRequester"
     },
     "autoload": {
         "psr-4": {

src/LaunchDarkly/ConsulFeatureRequester.php

@@ -0,0 +1,68 @@
+<?php
+namespace LaunchDarkly;
+
+use SensioLabs\Consul\Exception\ClientException;
+use SensioLabs\Consul\ServiceFactory;
+
+class ConsulFeatureRequester extends FeatureRequesterBase
+{
+    /** @var string */
+    protected $_prefix;
+    /** @var \SensioLabs\Consul\Services\KV */
+    protected $_kvClient;
+
+    public function __construct($baseUri, $sdkKey, $options)
+    {
+        parent::__construct($baseUri, $sdkKey, $options);
+
+        $consulOpts = isset($options['consul_options']) ? $options['consul_options'] : array();
+        if (isset($options['consul_uri'])) {
+            $consulOpts['base_uri'] = $options['consul_uri'];
+        }
+        $sf = new ServiceFactory($consulOpts);
+        $this->_kvClient = $sf->get('kv');
+
+        $prefix = isset($options['consul_prefix']) ? $options['consul_prefix'] : 'launchdarkly';
+        $this->_prefix = $prefix . '/';
+    }
+
+    protected function readItemString($namespace, $key)
+    {
+        try {
+            $resp = $this->_kvClient->get($this->makeKey($namespace, $key));
+        } catch (ClientException $e) {
+            if ($e->getCode() === 404) {
+                return null;
+            }
+            throw $e;
+        }
+        $results = $resp->json();
+        if (count($results) != 1) {
+            return null;
+        }
+        return base64_decode($results[0]['Value']);
+    }
+
+    protected function readItemStringList($namespace)
+    {
+        try {
+            $resp = $this->_kvClient->get($this->makeKey($namespace, ''), array('recurse' => true));
+        } catch (ClientException $e) {
+            if ($e->getCode() === 404) {
+                return array();
+            }
+            throw $e;
+        }
+        $results = $resp->json();
+        $ret = array();
+        foreach ($results as $result) {
+            $ret[] = base64_decode($result['Value']);
+        }
+        return $ret;
+    }
+
+    private function makeKey($namespace, $key)
+    {
+        return $this->_prefix . $namespace . '/' . $key;
+    }
+}

src/LaunchDarkly/FeatureRequesterBase.php

@@ -167,6 +167,9 @@ protected function getJsonItemList($namespace)
             $values = json_decode($raw, true);
         } else {
             $values = $this->readItemStringList($namespace);
+            if (!$values) {
+                $values = array();
+            }
             $this->putCachedString($namespace, self::ALL_ITEMS_KEY, json_encode($values));
         }
         foreach ($values as $i => $s) {

tests/ConsulFeatureRequesterTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace LaunchDarkly\Tests;
+
+use LaunchDarkly\ConsulFeatureRequester;
+use SensioLabs\Consul\Exception\ClientException;
+use SensioLabs\Consul\ServiceFactory;
+
+class ConsulFeatureRequesterTest extends FeatureRequesterTestBase
+{
+    const TABLE_NAME = 'test-table';
+    const PREFIX = 'test';
+
+    private static $kvClient;
+
+    public static function setUpBeforeClass()
+    {
+        $sf = new ServiceFactory();
+        self::$kvClient = $sf->get('kv');
+    }
+
+    protected function makeRequester()
+    {
+        $options = array(
+            'consul_prefix' => self::PREFIX
+        );
+        return new ConsulFeatureRequester('', '', $options);
+    }
+
+    protected function putItem($namespace, $key, $version, $json)
+    {
+        self::$kvClient->put(self::PREFIX . '/' . $namespace . '/' . $key, $json);
+    }
+
+    protected function deleteExistingData()
+    {
+        try {
+            $resp = self::$kvClient->get(self::PREFIX . '/', array('keys' => true, 'recurse' => true));
+        } catch (ClientException $e) {
+            if ($e->getCode() === 404) {
+                return;
+            }
+            throw $e;
+        }
+        $results = $resp->json();
+        foreach ($results as $key) {
+            self::$kvClient->delete($key);
+        }
+    }
+}