Add APC-enabled LDD requester, integ tests

Author: mrdon

.gitignore

@@ -2,3 +2,6 @@
 /doc/
 *.iml
 composer.phar
+.vagrant
+integration-tests/vendor
+integration-tests/composer.lock

integration-tests/LDDFeatureRequesterTest.php

@@ -0,0 +1,66 @@
+<?php
+namespace LaunchDarkly\Tests;
+
+require_once 'vendor/autoload.php';
+
+use LaunchDarkly\LDClient;
+use LaunchDarkly\LDUserBuilder;
+
+class LDDFeatureRetrieverTest extends \PHPUnit_Framework_TestCase {
+
+    public function testGet() {
+        $redis = new \Predis\Client(array(
+                                      "scheme" => "tcp",
+                                      "host" => 'localhost',
+                                      "port" => 6379));
+        $client = new LDClient("BOGUS_API_KEY", array('feature_requester_class' => '\\LaunchDarkly\\LDDFeatureRequester'));
+        $builder = new LDUserBuilder(3);
+        $user = $builder->build();
+
+        $redis->del("launchdarkly:features");
+        $this->assertEquals("jim", $client->toggle('foo', $user, 'jim'));
+        $redis->hset("launchdarkly:features", 'foo', $this->gen_feature("foo", "bar"));
+        $this->assertEquals("bar", $client->toggle('foo', $user, 'jim'));
+    }
+
+    public function testGetApc() {
+        $redis = new \Predis\Client(array(
+                                        "scheme" => "tcp",
+                                        "host" => 'localhost',
+                                        "port" => 6379));
+        $client = new LDClient("BOGUS_API_KEY", array('feature_requester_class' => '\\LaunchDarkly\\ApcLDDFeatureRequester',
+            'apc_expiration' => 1));
+        $builder = new LDUserBuilder(3);
+        $user = $builder->build();
+
+        $redis->del("launchdarkly:features");
+        $this->assertEquals("jim", $client->toggle('foo', $user, 'jim'));
+        $redis->hset("launchdarkly:features", 'foo', $this->gen_feature("foo", "bar"));
+        $this->assertEquals("bar", $client->toggle('foo', $user, 'jim'));
+
+        # cached value so not updated
+        $redis->hset("launchdarkly:features", 'foo', $this->gen_feature("foo", "baz"));
+        $this->assertEquals("bar", $client->toggle('foo', $user, 'jim'));
+
+        apc_delete("launchdarkly:features.foo");
+        $this->assertEquals("baz", $client->toggle('foo', $user, 'jim'));
+    }
+
+    private function gen_feature($key, $val) {
+        $data = <<<EOF
+           {"name": "Feature $key", "key": "$key", "kind": "flag", "salt": "Zm9v", "on": true,
+            "variations": [{"value": "$val", "weight": 100,
+                            "targets": [{"attribute": "key", "op": "in", "values": []}],
+                            "userTarget": {"attribute": "key", "op": "in", "values": []}},
+                           {"value": false, "weight": 0,
+                            "targets": [{"attribute": "key", "op": "in", "values": []}],
+                            "userTarget": {"attribute": "key", "op": "in", "values": []}}],
+            "commitDate": "2015-09-08T21:24:16.712Z",
+            "creationDate": "2015-09-08T21:06:16.527Z",
+            "version": 4}
+EOF;
+         return $data;
+    }
+
+}
+

integration-tests/README.txt

@@ -0,0 +1,7 @@
+To run the tests, run:
+  
+  vagrant up
+  vagrant ssh
+  cd project/integration-tests
+  vendor/phpunit/phpunit/phpunit LDDFeatureRequesterTest.php
+

integration-tests/Vagrantfile

@@ -0,0 +1,51 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  # All Vagrant configuration is done here. The most common configuration
+  # options are documented and commented below. For a complete reference,
+  # please see the online documentation at vagrantup.com.
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "ubuntu/trusty64"
+
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  config.vm.box_url = "https://vagrantcloud.com/ubuntu/boxes/trusty64"
+
+  config.vm.provision :shell, path: "bootstrap.sh"
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network :forwarded_port, guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network :private_network, ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network :public_network
+
+  # If true, then any SSH connections made will enable agent forwarding.
+  # Default value: false
+  # config.ssh.forward_agent = true
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  config.vm.synced_folder "..", "/home/vagrant/project"
+
+  config.vm.provider :virtualbox do |vb|
+    vb.auto_nat_dns_proxy = false
+    vb.customize ["modifyvm", :id, "--natdnsproxy1", "off" ]
+    vb.customize ["modifyvm", :id, "--natdnshostresolver1", "off" ]
+    vb.customize ["modifyvm", :id, "--memory", "2048"]
+  end
+end

integration-tests/bootstrap.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# init
+apt-get update 2> /dev/null
+
+# redis
+apt-get install -y redis-server 2> /dev/null
+
+# ntp
+apt-get install ntp -y 2> /dev/null
+service ntp restart
+
+# install dependencies and services
+apt-get install unzip -y 2> /dev/null
+apt-get install -y vim curl 2> /dev/null
+apt-get install git -y 2> /dev/null
+
+# PHP things
+echo "Install PHP things"
+apt-get install -y php-apc 2> /dev/null
+apt-get install -y phpunit 2> /dev/null
+
+# phpbrew stuff for 5.4
+apt-get build-dep php5 2> /dev/null
+apt-get install -y php5 php5-dev php-pear autoconf automake curl build-essential libxslt1-dev re2c libxml2 libxml2-dev php5-cli bison libbz2-dev libreadline-dev 2> /dev/null
+apt-get install -y libfreetype6 libfreetype6-dev libpng12-0 libpng12-dev libjpeg-dev libjpeg8-dev libjpeg8  libgd-dev libgd3 libxpm4 libltdl7 libltdl-dev 2> /dev/null
+apt-get install -y libssl-dev openssl 2> /dev/null
+apt-get install -y gettext libgettextpo-dev libgettextpo0 2> /dev/null
+apt-get install -y php5-cli 2> /dev/null
+apt-get install -y libmcrypt-dev 2> /dev/null
+apt-get install -y libreadline-dev 2> /dev/null
+
+# set vim tabs
+cat <<EOF > /home/vagrant/.vimrc
+set tabstop=4
+EOF
+chown vagrant.vagrant /home/vagrant/.vimrc
+
+su - vagrant
+cd ~vagrant
+pwd
+curl -s -L -O https://github.com/phpbrew/phpbrew/raw/master/phpbrew
+chmod +x phpbrew
+sudo mv phpbrew /usr/bin/phpbrew
+phpbrew init
+phpbrew known --update
+phpbrew update
+phpbrew install 5.4.34 +default
+
+echo "source $HOME/.phpbrew/bashrc" >> /home/vagrant/.bashrc
+source $HOME/.bashrc
+phpbrew switch php-5.4.34
+phpbrew ext install apc
+echo "apc.enable_cli = 1" >> ~/.phpbrew/php/php-5.4.34/etc/php.ini
+
+
+cd /home/vagrant/project/integration-tests
+curl -sS https://getcomposer.org/installer | php
+php composer.phar install

integration-tests/composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "launchdarkly/launchdarkly-php-integration-tests",
+    "description": "Integration tests",
+    "homepage": "https://github.com/launchdarkly/php-client",
+    "license": "Apache-2.0",
+    "authors": [
+        {
+            "name": "LaunchDarkly <team@launchdarkly.com>",
+            "homepage": "http://launchdarkly.com/"
+        }
+    ],
+    "require": {
+        "php": ">=5.3",
+        "predis/predis": "1.0.*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "4.3.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "": "../src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "": "."
+        }
+    }
+}

src/LaunchDarkly/ApcLDDFeatureRequester.php

@@ -0,0 +1,40 @@
+<?php
+namespace LaunchDarkly;
+
+
+/**
+ * Feature requester from an LDD-populated redis, with APC caching
+ *
+ * @package LaunchDarkly
+ */
+class ApcLDDFeatureRequester extends LDDFeatureRequester {
+    protected $_expiration = 30;
+
+    function __construct($baseUri, $apiKey, $options) {
+        parent::__construct($baseUri, $apiKey, $options);
+
+        if (isset($options['apc_expiration'])) {
+            $this->_expiration = (int)$options['apc_expiration'];
+        }
+    }
+
+
+    protected function get_from_cache($key) {
+        $key = self::make_cache_key($key);
+        $enabled = apc_fetch($key);
+        if ($enabled === false) {
+            return null;
+        }
+        else {
+            return $enabled;
+        }
+    }
+
+    protected function store_in_cache($key, $val) {
+        apc_add($this->make_cache_key($key), $val, $this->_expiration);
+    }
+
+    private function make_cache_key($name) {
+        return $this->_features_key.'.'.$name;
+    }
+}

src/LaunchDarkly/FeatureRequester.php

@@ -7,7 +7,7 @@ interface FeatureRequester {
      * Gets feature data from a likely cached store
      *
      * @param $key string feature key
-     * @return mixed|null The decoded JSON feature data, or null if missing
+     * @return array|null The decoded JSON feature data, or null if missing
      */
     public function get($key);
 }

src/LaunchDarkly/GuzzleFeatureRequester.php

@@ -36,7 +36,7 @@ function __construct($baseUri, $apiKey, $options) {
      * Gets feature data from a likely cached store
      *
      * @param $key string feature key
-     * @return mixed The decoded JSON feature data, or null if missing
+     * @return array|null The decoded JSON feature data, or null if missing
      */
     public function get($key) {
         try {

src/LaunchDarkly/LDClient.php

@@ -17,7 +17,7 @@ class LDClient {
     protected $_offline;
 
     /** @var  FeatureRequester */
-    protected $_featureRetriever;
+    protected $_featureRequester;
 
     /**
      * Creates a new client instance that connects to LaunchDarkly.
@@ -50,12 +50,12 @@ public function __construct($apiKey, $options = array()) {
 
         $this->_eventProcessor = new EventProcessor($apiKey, $options);
 
-        if (isset($options['feature_retriever_class'])) {
-            $featureRetrieverClass = $options['feature_retriever_class'];
+        if (isset($options['feature_requester_class'])) {
+            $featureRequesterClass = $options['feature_requester_class'];
         } else {
-            $featureRetrieverClass = '\\LaunchDarkly\\GuzzleFeatureRequester';
+            $featureRequesterClass = '\\LaunchDarkly\\GuzzleFeatureRequester';
         }
-        $this->_featureRetriever = new $featureRetrieverClass($this->_baseUri, $apiKey, $options);
+        $this->_featureRequester = new $featureRequesterClass($this->_baseUri, $apiKey, $options);
     }
 
     public function getFlag($key, $user, $default = false) {
@@ -184,7 +184,7 @@ protected function _sendFlagRequestEvent($key, $user, $value) {
 
     protected function _toggle($key, $user, $default) {
         try {
-            $data = $this->_featureRetriever->get($key);
+            $data = $this->_featureRequester->get($key);
             if ($data == null) {
                 error_log("LDClient::_toggle received null from retriever, using default");
                 return $default;

src/LaunchDarkly/LDDFeatureRetriever.php renamed to src/LaunchDarkly/LDDFeatureRequester.php

@@ -11,14 +11,15 @@ class LDDFeatureRequester implements FeatureRequester {
     function __construct($baseUri, $apiKey, $options) {
         $this->_baseUri = $baseUri;
         $this->_apiKey = $apiKey;
-        $this->_options = $options;
         if (!isset($options['redis_host'])) {
             $options['redis_host'] = 'localhost';
         }
         if (!isset($options['redis_port'])) {
             $options['redis_port'] = 6379;
         }
 
+        $this->_options = $options;
+
         $prefix = "launchdarkly";
         if (isset($options['redis_prefix'])) {
             $prefix = $options['redis_prefix'];
@@ -39,16 +40,37 @@ protected function get_connection() {
      * Gets feature data from a likely cached store
      *
      * @param $key string feature key
-     * @return mixed The decoded JSON feature data, or null if missing
+     * @return array|null The decoded JSON feature data, or null if missing
      */
     public function get($key) {
-        $redis = $this->get_connection();
-        $raw = $redis->hget($this->_features_key, $key);
-        if ($raw) {
-            return json_decode($raw);
+        $raw = $this->get_from_cache($key);
+        if ($raw === null) {
+            $redis = $this->get_connection();
+            $raw = $redis->hget($this->_features_key, $key);
+            if ($raw) {
+                $this->store_in_cache($key, $raw);
+            }
         }
-        else {
+        if ($raw) {
+            return json_decode($raw, True);
+        } else {
             return null;
         }
     }
+
+    /**
+     * Gets the value from local cache. No-op by default.
+     * @param $key string The feature key
+     * @return null|array The feature data or null if missing
+     */
+    protected function get_from_cache($key) {
+        return null;
+    }
+
+    /**
+     * Stores the feature data into the local cache.  No-op by default.
+     * @param $key string The feature key
+     * @param $val array The feature data
+     */
+    protected function store_in_cache($key, $val) {}
 }