phpredis integration (#1)

Author: apache-hb

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2021 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

VERSION

@@ -0,0 +1 @@
+1.0.0

composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "launchdarkly/server-sdk-redis-phpredis",
+    "description": "LaunchDarkly PHP SDK Redis integration using the phpredis extension",
+    "keywords": [
+        "launchdarkly",
+        "launchdarkly php"
+    ],
+    "homepage": "https://github.com/launchdarkly/php-server-sdk-redis-phpredis",
+    "license": "Apache-2.0",
+    "authors": [
+        {
+            "name": "LaunchDarkly <sdks@launchdarkly.com>",
+            "homepage": "http://www.launchdarkly.com/"
+        }
+    ],
+    "require": {
+        "php": ">=7.3",
+        "launchdarkly/server-sdk": "^4"
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

src/PHPRedis.php

@@ -0,0 +1,42 @@
+<?php
+namespace LaunchDarkly\Integrations;
+
+/**
+ * Integration with a Redis data store using the `phpredis` extension.
+ */
+class PHPRedis
+{
+    /**
+     * Configures an adapter for reading feature flag data from Redis using persistent connections.
+     *
+     * To use this method, you must have installed the `phpredis` extension. After calling this
+     * method, store its return value in the `feature_requester` property of your client configuration:
+     *
+     *     $fr = LaunchDarkly\Integrations\PHPRedis::featureRequester([ "redis_prefix" => "env1" ]);
+     *     $config = [ "feature_requester" => $fr ];
+     *     $client = new LDClient("sdk_key", $config);
+     *
+     * For more about using LaunchDarkly with databases, see the
+     * [SDK reference guide](https://docs.launchdarkly.com/sdk/features/storing-data).
+     *
+     * @param array $options  Configuration settings (can also be passed in the main client configuration):
+     *   - `redis_host`: hostname of the Redis server; defaults to `localhost`
+     *   - `redis_port`: port of the Redis server; defaults to 6379
+     *   - `redis_timeout`: connection timeout in seconds; defaults to 5
+     *   - `redis_prefix`: a string to be prepended to all database keys; corresponds to the prefix
+     * setting in ld-relay
+     *   - `phpredis_client`: an already-configured Redis client instance if you wish to reuse one
+     *   - `apc_expiration`: expiration time in seconds for local caching, if `APCu` is installed
+     * @return mixed  an object to be stored in the `feature_requester` configuration property
+     */
+    public static function featureRequester($options = array())
+    {
+        if (!extension_loaded('redis')) {
+            throw new \RuntimeException("phpredis extension is required to use Integrations\\PHPRedis");
+        }
+
+        return function ($baseUri, $sdkKey, $baseOptions) use ($options) {
+            return new Impl\PHPRedisFeatureRequester($baseUri, $sdkKey, array_merge($baseOptions, $options));
+        };
+    }
+}

src/PHPRedisFeatureRequester.php

@@ -0,0 +1,65 @@
+<?php
+namespace LaunchDarkly\Impl\Integrations;
+
+use LaunchDarkly\Impl\Integrations\FeatureRequesterBase;
+
+class PHPRedisFeatureRequester extends FeatureRequesterBase
+{
+    /** @var array */
+    private $_redisOptions;
+    /** @var \Redis */
+    private $_redisInstance;
+    /** @var string */
+    private $_prefix;
+
+    public function __construct($baseUri, $sdkKey, $options)
+    {
+        parent::__construct($baseUri, $sdkKey, $options);
+
+        $this->_prefix = $options['redis_prefix'] ?? 'launchdarkly';
+
+        $client = $this->_options['phpredis_client'] ?? null;
+        if ($client instanceof Redis) {
+            $this->_redisInstance = $client;
+        } else {
+            $this->_redisOptions = [
+                "timeout" => $options['redis_timeout'] ?? 5,
+                "host" => $options['redis_host'] ?? 'localhost',
+                "port" => $options['redis_port'] ?? 6379
+            ];
+        }
+    }
+
+    protected function readItemString($namespace, $key)
+    {
+        $redis = $this->getConnection();
+        return $redis->hget($namespace, $key);
+    }
+
+    protected function readItemStringList($namespace)
+    {
+        $redis = $this->getConnection();
+        $raw = $redis->hgetall($namespace);
+        return $raw ? array_values($raw) : null;
+    }
+
+    /**
+     * @return \Redis
+     */
+    protected function getConnection()
+    {
+        if ($this->_redisInstance instanceof Redis) {
+            return $this->_redisInstance;
+        }
+
+        $redis = new \Redis();
+        $redis->pconnect(
+            $this->_redisOptions["host"],
+            $this->_redisOptions["port"],
+            $this->_redisOptions["timeout"],
+            'launchdarkly/php-server-sdk-redis-phpredis'
+        );
+        $redis->setOption(\Redis::OPT_PREFIX, "$this->_prefix:");	// use custom prefix on all keys
+        return $this->_redisInstance = $redis;
+    }
+}