chore: Cleanup and strict types

keelerm84 · keelerm84 · commit 8c0f461670a1 · 2025-01-17T11:47:25.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,11 +1,11 @@
 name: Run CI
 on:
   push:
-    branches: [ main ]
+    branches: [ main, 'feat/**' ]
     paths-ignore:
       - '**.md' # Do not need to run CI for markdown changes.
   pull_request:
-    branches: [ main ]
+    branches: [ main, 'feat/**' ]
     paths-ignore:
       - '**.md'
 
diff --git a/Makefile b/Makefile
@@ -7,7 +7,7 @@ help: #! Show this help message
 
 .PHONY: test
 test: #! Run unit tests
-	php -d xdebug.mode=coverage vendor/bin/phpunit
+	php vendor/bin/phpunit
 
 .PHONY: coverage
 coverage: #! Run unit tests with test coverage
diff --git a/README.md b/README.md
@@ -6,9 +6,9 @@
 
 This library provides a Redis-backed data source for the [LaunchDarkly PHP SDK](https://github.com/launchdarkly/php-server-sdk), replacing the default behavior of querying the LaunchDarkly service endpoints. The underlying Redis client implementation is the [`phpredis`](https://github.com/phpredis/phpredis) extension. If you want to use the Predis package instead, see https://github.com/launchdarkly/php-server-sdk-redis-predis.
 
-The minimum version of the LaunchDarkly PHP SDK for use with this library is 4.0.0. In earlier versions of the SDK, the Redis integrations were bundled in the main SDK package.
+The minimum version of the LaunchDarkly PHP SDK for use with this library is 6.4.0.
 
-The minimum PHP version is 7.3.
+The minimum PHP version is 8.1.
 
 For more information, see [our SDK documentation](https://docs.launchdarkly.com/sdk/features/storing-data).
 
@@ -27,15 +27,13 @@ php composer.phar install launchdarkly/server-sdk-redis-phpredis --save
 3. In your SDK configuration code, configure the Redis integration:
 
 ```php
-    $fr = LaunchDarkly\Integrations\PHPRedis::featureRequester([
-        "prefix" => "my-key-prefix"
-    ]);
-    $config = [ "feature_requester" => $fr ];
+    $fr = LaunchDarkly\Integrations\PHPRedis::featureRequester(
+        $redisClient, ["prefix" => "my-key-prefix"]
+    );
+    $config = ["feature_requester" => $fr];
     $client = new LDClient("sdk_key", $config);
 ```
 
-By default, the store will try to connect to a local Redis instance on port 6379. You may specify an alternate configuration as described in the API documentation for `PHPRedis::featureRequester`. Make sure the `prefix` option corresponds to the key prefix that is being used by the Relay Proxy.
-
 ## 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:
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,10 +1,20 @@
 <?xml version="1.0"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" beStrictAboutChangesToGlobalState="true" beStrictAboutOutputDuringTests="true" beStrictAboutResourceUsageDuringSmallTests="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutTodoAnnotatedTests="true" verbose="true">
-  
+
   <logging>
     <junit outputFile="phpunit/junit.xml"/>
   </logging>
 
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <report>
+      <html outputDirectory="build/phpunit/html-coverage"/>
+      <xml outputDirectory="build/phpunit/xml-coverage"/>
+    </report>
+  </coverage>
+
   <testsuites>
     <testsuite name="Unit Tests">
       <directory>tests</directory>
diff --git a/src/LaunchDarkly/Impl/Integrations/PHPRedisFeatureRequester.php b/src/LaunchDarkly/Impl/Integrations/PHPRedisFeatureRequester.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly\Impl\Integrations;
 
 use LaunchDarkly\Integrations;
@@ -30,12 +32,24 @@ public function __construct(
 
     protected function readItemString(string $namespace, string $key): ?string
     {
-        return $this->client->hget("$this->prefix:$namespace", $key);
+        /** @var string|false */
+        $result = $this->client->hget("$this->prefix:$namespace", $key);
+        if ($result === false) {
+            return null;
+        }
+
+        return $result;
     }
 
     protected function readItemStringList(string $namespace): ?array
     {
+        /** @var ?array<string, string>|false */
         $raw = $this->client->hgetall("$this->prefix:$namespace");
-        return $raw ? array_values($raw) : null;
+
+        if ($raw === null || $raw === false) {
+            return null;
+        }
+
+        return array_values($raw);
     }
 }
diff --git a/src/LaunchDarkly/Integrations/PHPRedis.php b/src/LaunchDarkly/Integrations/PHPRedis.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly\Integrations;
 
 use LaunchDarkly\Impl\Integrations;
@@ -21,9 +23,11 @@ class PHPRedis
      * 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);
+     * ```php
+     * $fr = LaunchDarkly\Integrations\PHPRedis::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).
@@ -50,10 +54,12 @@ public static function featureRequester(Redis $client, $options = []): callable
      *
      * After calling this method, store its return value in the `store` property of your Big Segment configuration:
      *
-     *     $store = LaunchDarkly\Integrations\PHPRedis::bigSegmentsStore(["prefix" => "env1"]);
-     *     $bigSegmentsConfig = new LaunchDarkly\BigSegmentConfig(store: $store);
-     *     $config = ["big_segments" => $bigSegmentsConfig];
-     *     $client = new LDClient("sdk_key", $config);
+     * ```php
+     * $store = LaunchDarkly\Integrations\PHPRedis::bigSegmentsStore(["prefix" => "env1"]);
+     * $bigSegmentsConfig = new LaunchDarkly\BigSegmentConfig(store: $store);
+     * $config = ["big_segments" => $bigSegmentsConfig];
+     * $client = new LDClient("sdk_key", $config);
+     * ```
      *
      * @param array<string,mixed> $options
      *   - `prefix`: a string to be prepended to all database keys; corresponds
diff --git a/tests/Impl/Integrations/PHPRedisBigSegmentsStoreTest.php b/tests/Impl/Integrations/PHPRedisBigSegmentsStoreTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly\Impl\Integrations\Tests\Impl\Integrations;
 
 use LaunchDarkly\Impl\Integrations\PHPRedisBigSegmentsStore;
diff --git a/tests/Impl/Integrations/PHPRedisFeatureRequesterTest.php b/tests/Impl/Integrations/PHPRedisFeatureRequesterTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly\Impl\Integrations\Tests\Impl\Integrations;
 
 use LaunchDarkly\Impl\Model\FeatureFlag;
