Add predis v2 support + relay support + linter fixes

.github/workflows/audit.yml

@@ -55,7 +55,7 @@ jobs:
           echo "::endgroup::"
 
       - name: Auditor
-        uses: docker://nbgrp/auditor:0.22.0
+        uses: docker://nbgrp/auditor:0.24.0
 
       - name: Tests
         run: vendor/bin/simple-phpunit

composer.json

@@ -23,7 +23,7 @@
         "nbgrp/singlea-contracts": "^1",
         "psr/cache": "^3",
         "psr/log": "^3",
-        "snc/redis-bundle": "^3.6 || ^4",
+        "snc/redis-bundle": "^4.5",
         "symfony/cache": "^6.4",
         "symfony/cache-contracts": "^3",
         "symfony/config": "^6.4",
@@ -43,10 +43,11 @@
         "symfony/security-core": "^6.4",
         "symfony/security-http": "^6.4",
         "symfony/uid": "^6.4",
-        "web-token/jwt-framework": "^3.0.7"
+        "web-token/jwt-framework": "^3.2"
     },
     "require-dev": {
-        "predis/predis": "^1",
+        "ext-redis": "*",
+        "predis/predis": "^2",
         "psr/event-dispatcher": "^1",
         "psr/event-dispatcher-implementation": "1.0",
         "roave/security-advisories": "dev-latest",

grumphp.yml

@@ -25,21 +25,19 @@ grumphp:
     phpmd:
       ruleset: [ 'phpmd-ruleset' ]
       whitelist_patterns: [ '/^src\/(.*)/' ]
-      exclude:
-        - 'src/Bundles/*/Tests'
 
     phpmnd:
       directory: 'src'
-      exclude_name:
-        - 'Configuration.php'
-        - 'JwtFetcherConfigFactory.php'
-        - 'JwtTokenizerConfigFactory.php'
-      exclude:
-        - 'Bundles/*/Tests'
+      exclude_path:
+        - 'Bundles/Jwt/FeatureConfig/JwtTokenizerConfigFactory.php'
+        - 'Bundles/JwtFetcher/FeatureConfig/JwtFetcherConfigFactory.php'
+        - 'Bundles/Redis/Tests/DependencyInjection/Compiler/AddFeatureConfigManagersPassTest.php'
+        - 'Bundles/Singlea/Tests/Command/Client/PurgeTest.php'
 
     phpstan:
       use_grumphp_paths: false
 
-    psalm: ~
+    psalm:
+      no_cache: true
 
     securitychecker_local: ~

phpstan.neon

@@ -15,3 +15,8 @@ parameters:
 
   checkGenericClassInNonGenericObjectType: false
   checkMissingIterableValueType: false
+
+  ignoreErrors:
+    -
+      message: '#Call to an undefined method Predis#'
+      path: src/Bundles/Redis/*

phpunit.xml.dist

@@ -5,10 +5,12 @@
          bootstrap="vendor/autoload.php"
 >
     <php>
+        <ini name="display_errors" value="1" />
         <ini name="error_reporting" value="-1" />
         <ini name="memory_limit" value="-1" />
         <server name="APP_ENV" value="test" force="true" />
-        <server name="SYMFONY_PHPUNIT_VERSION" value="9.5" />
+        <server name="SHELL_VERBOSITY" value="-1" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="9.6" />
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[indirect]=1" />
     </php>
 

psalm.xml

@@ -34,6 +34,7 @@
 
     <stubs>
         <file name=".psalm/stubs/igbinary.phpstub" />
+        <file name=".psalm/stubs/predis.phpstub" />
     </stubs>
 
     <plugins>

src/Bundles/Jwt/JwtTokenizer.php

@@ -54,7 +54,6 @@ public function tokenize(string $subject, array $payload, TokenizerConfigInterfa
         $jweConfig = $config->getJweConfig();
 
         if ($jweConfig === null) {
-            /** @psalm-suppress InvalidArgument */
             $jws = $this->jwsBuilderFactory->create([$jwsConfig->getAlgorithm()])
                 ->withPayload(json_encode($payload, \JSON_THROW_ON_ERROR)) // @phan-suppress-current-line PhanPossiblyFalseTypeArgument
                 ->addSignature($jwsConfig->getJwk(), [

src/Bundles/JwtFetcher/JwtFetcher.php

@@ -70,7 +70,6 @@ public function fetch(array $requestData, FetcherConfigInterface $config): array
     private function makeRequestJwt(array $payload, JwtFetcherConfig $config): string
     {
         $jwsConfig = $config->getRequestJwsConfig();
-        /** @psalm-suppress InvalidArgument */
         $jws = $this->jwsBuilderFactory->create([$jwsConfig->getAlgorithm()])
             ->withPayload(json_encode($payload, \JSON_THROW_ON_ERROR)) // @phan-suppress-current-line PhanPossiblyFalseTypeArgument
             ->addSignature($jwsConfig->getJwk(), [

src/Bundles/Redis/ClientManager.php

@@ -12,13 +12,13 @@ final class ClientManager implements ClientManagerInterface
 {
     public function __construct(
         private readonly string $key,
-        private readonly \Predis\ClientInterface|\Redis|\RedisCluster $redis,
+        private readonly \Predis\ClientInterface|\Redis|\RedisCluster|\Relay\Relay $redis,
         private readonly ?LoggerInterface $logger = null,
     ) {}
 
     public function exists(string $id, bool $touch = true): bool
     {
-        $exists = (bool) $this->redis->hexists($this->key, $id);
+        $exists = (bool) $this->redis->hExists($this->key, $id);
         if ($exists && $touch) {
             $this->touch($id);
         }
@@ -29,15 +29,15 @@ public function exists(string $id, bool $touch = true): bool
     public function touch(string $id): void
     {
         try {
-            $this->redis->hset($this->key, $id, (string) time());
+            $this->redis->hSet($this->key, $id, (string) time());
         } finally {
             $this->logger?->debug('Key "'.$this->key.'": client '.$id.' touched.');
         }
     }
 
     public function getLastAccess(string $id): \DateTimeImmutable
     {
-        $timestamp = $this->redis->hget($this->key, $id);
+        $timestamp = $this->redis->hGet($this->key, $id);
         if (!is_numeric($timestamp)) {
             throw new \InvalidArgumentException('Unknown id specified: '.$id);
         }
@@ -50,27 +50,25 @@ public function findInactiveSince(\DateTimeInterface $datetime): iterable
         $inactiveIds = null;
         $error = null;
 
+        $script = <<<'LUA'
+            local last_access = redis.call('hgetall', KEYS[1])
+            local ids = {}
+
+            for i = 1, #last_access, 2 do
+               if last_access[i + 1] <= KEYS[2] then
+                  ids[#ids + 1] = last_access[i]
+               end
+            end
+
+            return ids
+            LUA;
+        $args = [$this->key, (string) $datetime->getTimestamp()];
+
         try {
-            /** @psalm-suppress MixedAssignment */
-            $inactiveIds = $this->redis->eval(
-                <<<'LUA'
-                    local last_access = redis.call('hgetall', KEYS[1])
-                    local ids = {}
-
-                    for i = 1, #last_access, 2 do
-                       if last_access[i + 1] <= KEYS[2] then
-                          ids[#ids + 1] = last_access[i]
-                       end
-                    end
-
-                    return ids
-                    LUA,
-                [
-                    $this->key,
-                    $datetime->getTimestamp(),
-                ],
-                2,
-            );
+            /** @psalm-suppress InvalidArgument, MixedAssignment */
+            $inactiveIds = $this->redis instanceof \Predis\ClientInterface
+                ? $this->redis->eval($script, \count($args), ...$args)
+                : $this->redis->eval($script, $args, \count($args));
         } catch (\Throwable $exception) {
             $error = $exception->getMessage();
         }
@@ -91,7 +89,7 @@ public function findInactiveSince(\DateTimeInterface $datetime): iterable
 
     public function findOldest(): ?string
     {
-        $ids = $this->redis->hkeys($this->key);
+        $ids = $this->redis->hKeys($this->key);
 
         if (!\is_array($ids) || empty($ids)) {
             return null;
@@ -102,15 +100,24 @@ public function findOldest(): ?string
         return (string) reset($ids);
     }
 
+    /**
+     * @psalm-suppress InvalidArgument, MixedAssignment
+     */
     public function remove(string ...$ids): int
     {
         if (empty($ids)) {
             return 0;
         }
 
         try {
-            /** @psalm-suppress InvalidArgument, InvalidCast */
-            return (int) $this->redis->hdel($this->key, ...$ids); // @phan-suppress-current-line PhanParamTooManyUnpack, PhanTypeMismatchArgumentProbablyReal
+            if ($this->redis instanceof \Predis\ClientInterface) {
+                /** @psalm-suppress RedundantCast */
+                return (int) $this->redis->hDel($this->key, $ids);
+            }
+
+            $result = $this->redis->hDel($this->key, ...$ids);
+
+            return \is_int($result) ? $result : 0;
         } finally {
             $this->logger?->debug('Key "'.$this->key.'": clients removed: '.implode(', ', $ids).'.');
         }
@@ -119,7 +126,8 @@ public function remove(string ...$ids): int
     private function getRedisLastError(): ?string
     {
         $error = null;
-        if ($this->redis instanceof \Redis || $this->redis instanceof \RedisCluster) {
+        if ($this->redis instanceof \Redis || $this->redis instanceof \RedisCluster || $this->redis instanceof \Relay\Relay) {
+            /** @var string|null $error */
             $error = $this->redis->getLastError();
             $this->redis->clearLastError();
         }

src/Bundles/Redis/FeatureConfigManagerFactory.php

@@ -15,7 +15,7 @@ final class FeatureConfigManagerFactory
 {
     public function __invoke(
         string $key,
-        \Predis\ClientInterface|\Redis|\RedisCluster $redis,
+        \Predis\ClientInterface|\Redis|\RedisCluster|\Relay\Relay $redis,
         FeatureConfigMarshallerInterface $marshaller,
         FeatureConfigEncryptorInterface $encryptor,
         bool $required,
@@ -24,7 +24,7 @@ public function __invoke(
         return new class($key, $redis, $marshaller, $encryptor, $required, $logger) implements FeatureConfigManagerInterface {
             public function __construct(
                 private readonly string $key,
-                private readonly \Predis\ClientInterface|\Redis|\RedisCluster $redis,
+                private readonly \Predis\ClientInterface|\Redis|\RedisCluster|\Relay\Relay $redis,
                 private readonly FeatureConfigMarshallerInterface $marshaller,
                 private readonly FeatureConfigEncryptorInterface $encryptor,
                 private readonly bool $required,
@@ -43,7 +43,7 @@ public function isRequired(): bool
 
             public function exists(string $id): bool
             {
-                return (bool) $this->redis->hexists($this->key, $id);
+                return (bool) $this->redis->hExists($this->key, $id);
             }
 
             public function persist(string $id, FeatureConfigInterface $config, string $secret): void
@@ -52,7 +52,7 @@ public function persist(string $id, FeatureConfigInterface $config, string $secr
                 $value = $this->encryptor->encrypt($value, $secret);
 
                 try {
-                    $this->redis->hset($this->key, $id, $value);
+                    $this->redis->hSet($this->key, $id, $value);
                 } finally {
                     $this->logger?->debug('Key "'.$this->key.'": config '.$id.' persisted.');
                 }
@@ -61,7 +61,7 @@ public function persist(string $id, FeatureConfigInterface $config, string $secr
             public function find(string $id, string $secret): ?FeatureConfigInterface
             {
                 /** @var string|false $value */
-                $value = $this->redis->hget($this->key, $id);
+                $value = $this->redis->hGet($this->key, $id);
                 if (\is_string($value)) {
                     return $this->marshaller->unmarshall(
                         $this->encryptor->decrypt($value, $secret),
@@ -71,15 +71,24 @@ public function find(string $id, string $secret): ?FeatureConfigInterface
                 return null;
             }
 
+            /**
+             * @psalm-suppress InvalidArgument, MixedAssignment
+             */
             public function remove(string ...$ids): int
             {
                 if (empty($ids)) {
                     return 0;
                 }
 
                 try {
-                    /** @psalm-suppress InvalidArgument, InvalidCast */
-                    return (int) $this->redis->hdel($this->key, ...$ids); // @phan-suppress-current-line PhanParamTooManyUnpack, PhanTypeMismatchArgumentProbablyReal
+                    if ($this->redis instanceof \Predis\ClientInterface) {
+                        /** @psalm-suppress RedundantCast */
+                        return (int) $this->redis->hDel($this->key, $ids);
+                    }
+
+                    $result = $this->redis->hDel($this->key, ...$ids);
+
+                    return \is_int($result) ? $result : 0;
                 } finally {
                     $this->logger?->debug('Key "'.$this->key.'": configs removed: '.implode(', ', $ids).'.');
                 }

src/Bundles/Redis/Tests/ClientManagerTest.php

@@ -29,7 +29,7 @@ public function testExists(bool $touch, bool $exists, bool $expected): void
         $redis = $this->createMock(\Redis::class);
         $redis
             ->expects(self::once())
-            ->method('hexists')
+            ->method('hExists')
             ->with($key, $id)
             ->willReturn($exists)
         ;
@@ -39,7 +39,7 @@ public function testExists(bool $touch, bool $exists, bool $expected): void
         if ($touch) {
             $redis
                 ->expects(self::once())
-                ->method('hset')
+                ->method('hSet')
                 ->with($key, $id, self::stringContains(substr((string) time(), 0, -2)))
             ;
 
@@ -50,7 +50,7 @@ public function testExists(bool $touch, bool $exists, bool $expected): void
         } else {
             $redis
                 ->expects(self::never())
-                ->method('hset')
+                ->method('hSet')
             ;
 
             $logger
@@ -93,7 +93,7 @@ public function testGetLastAccessUnknownException(): void
         $redis = $this->createMock(\Redis::class);
         $redis
             ->expects(self::once())
-            ->method('hget')
+            ->method('hGet')
             ->with($key, $id)
             ->willReturn(false)
         ;
@@ -114,7 +114,7 @@ public function testGetLastAccess(): void
         $redis = $this->createMock(\Redis::class);
         $redis
             ->expects(self::once())
-            ->method('hget')
+            ->method('hGet')
             ->with($key, $id)
             ->willReturn('1609495200')
         ;
@@ -180,7 +180,7 @@ public function testFindOldest(array $keys, ?string $expected): void
         $redis = $this->createMock(\Redis::class);
         $redis
             ->expects(self::once())
-            ->method('hkeys')
+            ->method('hKeys')
             ->willReturn($keys)
         ;
 
@@ -207,7 +207,7 @@ public function provideRemoveCases(): iterable
                 $redis = $this->createMock(\Redis::class);
                 $redis
                     ->expects(self::once())
-                    ->method('hdel')
+                    ->method('hDel')
                     ->with('key', '1', '2')
                     ->willReturn(2)
                 ;
@@ -232,7 +232,7 @@ public function provideRemoveCases(): iterable
                 $redis = $this->createMock(\Redis::class);
                 $redis
                     ->expects(self::once())
-                    ->method('hdel')
+                    ->method('hDel')
                     ->with('key', '1', '2')
                     ->willReturn(0)
                 ;
@@ -257,7 +257,7 @@ public function provideRemoveCases(): iterable
                 $redis = $this->createMock(\Redis::class);
                 $redis
                     ->expects(self::never())
-                    ->method('hdel')
+                    ->method('hDel')
                 ;
 
                 return $redis;