feat: FeatureRequester requires configured ClientInterface

Author: keelerm84

src/LaunchDarkly/Impl/Integrations/RedisFeatureRequester.php

@@ -3,58 +3,34 @@
 namespace LaunchDarkly\Impl\Integrations;
 
 use LaunchDarkly\Integrations;
-use Predis\Client;
 use Predis\ClientInterface;
 
 class RedisFeatureRequester extends FeatureRequesterBase
 {
-    public ?ClientInterface $_connection = null;
-    public ?array $_redisOptions = null;
-    public ?string $_prefix;
-
-    public function __construct(string $baseUri, string $sdkKey, array $options)
-    {
+    private readonly string $prefix;
+
+    /**
+     * @param array<string,mixed> $options
+     *   - `prefix`: namespace prefix to add to all hash keys
+     */
+    public function __construct(
+        private readonly ClientInterface $connection,
+        string $baseUri,
+        string $sdkKey,
+        array $options
+    ) {
         parent::__construct($baseUri, $sdkKey, $options);
-
-        $this->_prefix = $options['redis_prefix'] ?? null;
-        if ($this->_prefix === null || $this->_prefix === '') {
-            $this->_prefix = Integrations\Redis::DEFAULT_PREFIX;
-        }
-
-        $client = $options['predis_client'] ?? null;
-        if ($client instanceof ClientInterface) {
-            $this->_connection = $client;
-        } else {
-            $this->_redisOptions = [
-                "scheme" => "tcp",
-                "timeout" => $options['redis_timeout'] ?? 5,
-                "host" => $options['redis_host'] ?? 'localhost',
-                "port" => $options['redis_port'] ?? 6379
-            ];
-
-            $this->_redisOptions = array_merge($this->_redisOptions, $options['predis_options'] ?? []);
-        }
+        $this->prefix = $options['prefix'] ?? Integrations\Redis::DEFAULT_PREFIX;
     }
 
     protected function readItemString(string $namespace, string $key): ?string
     {
-        $redis = $this->getConnection();
-        return $redis->hget("$this->_prefix:$namespace", $key);
+        return $this->connection->hget("$this->prefix:$namespace", $key);
     }
 
     protected function readItemStringList(string $namespace): ?array
     {
-        $redis = $this->getConnection();
-        $raw = $redis->hgetall("$this->_prefix:$namespace");
+        $raw = $this->connection->hgetall("$this->prefix:$namespace");
         return $raw ? array_values($raw) : null;
     }
-
-    protected function getConnection(): ClientInterface
-    {
-        if ($this->_connection == null) {
-            $this->_connection = new Client($this->_redisOptions);
-        }
-
-        return $this->_connection;
-    }
 }

src/LaunchDarkly/Integrations/Redis.php

@@ -2,8 +2,8 @@
 
 namespace LaunchDarkly\Integrations;
 
-use LaunchDarkly\Impl\Integrations\RedisFeatureRequester;
 use LaunchDarkly\Impl\Integrations\RedisBigSegmentsStore;
+use LaunchDarkly\Impl\Integrations\RedisFeatureRequester;
 use LaunchDarkly\Subsystems;
 use Predis\ClientInterface;
 use Psr\Log\LoggerInterface;
@@ -20,39 +20,29 @@ class Redis
      *
      * After calling this method, store its return value in the `feature_requester` property of your client configuration:
      *
-     *     $fr = LaunchDarkly\Integrations\Redis::featureRequester([ "redis_prefix" => "env1" ]);
-     *     $config = [ "feature_requester" => $fr ];
+     *     $fr = LaunchDarkly\Integrations\Redis::featureRequester(["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
-     *   - `predis_client`: an already-configured Predis client instance if you wish to reuse one; if
-     * specified, this will cause all other options except `redis_prefix` and `apc_expiration`
-     * to be ignored
-     *   - `predis_options`: an array of connection options to be passed directly to the Predis client;
-     * these can include any options supported by `Predis\Client`, and will override any equivalent
-     * top-level options (for instance, `"host"` in `predis_options` takes priority over `"redis_host"`
-     * at the top level)
-     *   - `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
+     * @param array<string, mixed> $options Configuration settings (can also be passed in the main client configuration):
+     *   - `prefix`: a string to be prepended to all database keys; corresponds
+     *   to the prefix setting in ld-relay
+     * @return callable(string, string, array): Subsystems\FeatureRequester
      */
-    public static function featureRequester(array $options = [])
+    public static function featureRequester(ClientInterface $client, array $options = []): callable
     {
-        return function (string $baseUri, string $sdkKey, array $baseOptions) use ($options) {
-            return new RedisFeatureRequester($baseUri, $sdkKey, array_merge($baseOptions, $options));
+        return function (string $baseUri, string $sdkKey, array $baseOptions) use ($client, $options): Subsystems\FeatureRequester {
+            return new RedisFeatureRequester($client, $baseUri, $sdkKey, array_merge($baseOptions, $options));
         };
     }
 
     /**
      * @param array<string,mixed> $options
-     *   - `prefix`: namespace prefix to add to all hash keys
+     *   - `prefix`: a string to be prepended to all database keys; corresponds
+     *   to the prefix setting in ld-relay
      * @return callable(LoggerInterface, array): Subsystems\BigSegmentsStore
      */
     public static function bigSegmentsStore(ClientInterface $client, array $options = []): callable

tests/DatabaseFeatureRequesterTestBase.php

@@ -54,8 +54,8 @@ protected function putSerializedItem(
         string $namespace,
         string $key,
         int $version,
-        string $json): void
-    {
+        string $json
+    ): void {
         throw new \RuntimeException("test class did not implement putSerializedItem");
     }
 
@@ -149,7 +149,7 @@ public function testAllFeaturesWithEmptyStore(?string $prefix): void
         $fr = $this->makeRequester($prefix);
 
         $flags = $fr->getAllFeatures();
-        $this->assertEquals(array(), $flags);
+        $this->assertEquals([], $flags);
     }
 
     /**
@@ -228,10 +228,20 @@ public function testPrefixIndependence(): void
     private function setupForPrefix(?string $prefix, string $flagKey, string $segmentKey, int $flagVersion): void
     {
         $segmentVersion = $flagVersion * 2;
-        $this->putSerializedItem($prefix, 'features', $flagKey, $flagVersion,
-            self::makeFlagJson($flagKey, $flagVersion));
-        $this->putSerializedItem($prefix, 'segments', $segmentKey, $segmentVersion,
-            self::makeSegmentJson($flagKey, $segmentVersion));
+        $this->putSerializedItem(
+            $prefix,
+            'features',
+            $flagKey,
+            $flagVersion,
+            self::makeFlagJson($flagKey, $flagVersion)
+        );
+        $this->putSerializedItem(
+            $prefix,
+            'segments',
+            $segmentKey,
+            $segmentVersion,
+            self::makeSegmentJson($flagKey, $segmentVersion)
+        );
     }
 
     private function verifyForPrefix($fr, string $flagKey, string $segmentKey, int $flagVersion): void
@@ -265,7 +275,7 @@ public function prefixParameters(): array
 
     private static function makeFlagJson(string $key, int $version, bool $deleted = false): string|bool
     {
-        return json_encode(array(
+        return json_encode([
             'key' => $key,
             'version' => $version,
             'on' => true,
@@ -282,19 +292,19 @@ private static function makeFlagJson(string $key, int $version, bool $deleted =
                 false,
             ],
             'deleted' => $deleted
-        ));
+        ]);
     }
 
     private static function makeSegmentJson(string $key, int $version, bool $deleted = false): string|bool
     {
-        return json_encode(array(
+        return json_encode([
             'key' => $key,
             'version' => $version,
-            'included' => array(),
-            'excluded' => array(),
+            'included' => [],
+            'excluded' => [],
             'rules' => [],
             'salt' => '',
             'deleted' => $deleted
-        ));
+        ]);
     }
 }