refactor getting authentication details for the Redis cluster

Signed-off-by: Robin Brabants <[email protected]>
laminas · Nov 20, 2024 · 89ff261 · 89ff261
1 parent 11115cc
commit 89ff261
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 23 deletions.
diff --git a/src/Exception/InvalidRedisClusterConfigurationException.php b/src/Exception/InvalidRedisClusterConfigurationException.php
@@ -42,4 +42,9 @@ public static function fromInvalidSeedsConfiguration(string $seed): self
             )
         );
     }
+
+    public static function fromMissingRequiredPassword(): self
+    {
+        return new self('If a Redis user is provided, a password has to be configured as well.');
+    }
 }
diff --git a/src/RedisClusterOptions.php b/src/RedisClusterOptions.php
@@ -64,7 +64,7 @@ final class RedisClusterOptions extends AdapterOptions
     /** @psalm-var array<positive-int,mixed> */
     private array $libOptions = [];
 
-    private ?string $username = null;
+    private string $user = '';
 
     private string $password = '';
 
@@ -250,17 +250,17 @@ public function getLibOption(int $option, mixed $default = null): mixed
         return $this->libOptions[$option] ?? $default;
     }
 
-    public function getUsername(): ?string
+    public function getUser(): string
     {
-        return $this->username;
+        return $this->user;
     }
 
     /**
      * @psalm-param non-empty-string $username
      */
-    public function setUsername(string $username): void
+    public function setUser(string $user): void
     {
-        $this->username = $username;
+        $this->user = $user;
     }
 
     public function getPassword(): string
@@ -276,18 +276,6 @@ public function setPassword(string $password): void
         $this->password = $password;
     }
 
-    /**
-     * @return array<int,string|null>|string|null
-     */
-    public function getAuthentication(): array|string|null
-    {
-        $password = $this->password === '' ? null : $this->password;
-        if ($this->username !== null && $this->username !== '') {
-            return [$this->username, $password];
-        }
-        return $password;
-    }
-
     public function getSslContext(): ?SslContext
     {
         return $this->sslContext;

diff --git a/src/RedisClusterResourceManager.php b/src/RedisClusterResourceManager.php
@@ -48,13 +48,26 @@ public function getResource(): RedisClusterFromExtension
 
     private function createRedisResource(RedisClusterOptions $options): RedisClusterFromExtension
     {
+        $user     = $options->getUser();
+        $password = $options->getPassword();
+
+        if ($user !== '' && $password !== '') {
+            $authentication = [$user, $password];
+        } elseif ($user !== '' && $password === '') {
+            throw InvalidRedisClusterConfigurationException::fromMissingRequiredPassword();
+        } elseif ($user === '' && $password !== '') {
+            $authentication = [$password];
+        } else {
+            $authentication = null;
+        }
+
         if ($options->hasName()) {
             return $this->createRedisResourceFromName(
                 $options->getName(),
                 $options->getTimeout(),
                 $options->getReadTimeout(),
                 $options->isPersistent(),
-                $options->getAuthentication(),
+                $authentication,
                 $options->getSslContext()
             );
         }
@@ -72,20 +85,21 @@ private function createRedisResource(RedisClusterOptions $options): RedisCluster
             $options->getTimeout(),
             $options->getReadTimeout(),
             $options->isPersistent(),
-            $options->getAuthentication(),
+            $authentication,
             $options->getSslContext()?->toSslContextArray()
         );
     }
 
     /**
      * @psalm-param non-empty-string $name
+     * @psalm-param array{0: non-empty-string, 1?: non-empty-string}|null $fallbackAuthentication
      */
     private function createRedisResourceFromName(
         string $name,
         float $fallbackTimeout,
         float $fallbackReadTimeout,
         bool $persistent,
-        array|string|null $fallbackAuthentication,
+        array|null $fallbackAuthentication,
         ?SslContext $sslContext
     ): RedisClusterFromExtension {
         try {

diff --git a/test/unit/RedisClusterOptionsTest.php b/test/unit/RedisClusterOptionsTest.php
@@ -72,7 +72,7 @@ public function testCanHandleOptionsWithNodename(): void
         self::assertEquals(2.0, $options->getReadTimeout());
         self::assertFalse($options->isPersistent());
         self::assertEquals('1.0', $options->getRedisVersion());
-        self::assertNull($options->getUsername());
+        self::assertEmpty($options->getUser());
         self::assertEquals('secret', $options->getPassword());
     }
 
@@ -84,15 +84,15 @@ public function testCanHandleOptionsWithSeeds(): void
             'read_timeout'  => 2.0,
             'persistent'    => false,
             'redis_version' => '1.0',
-            'username'      => 'user',
+            'user'      => 'user',
         ]);
 
         self::assertEquals(['localhost:1234'], $options->getSeeds());
         self::assertEquals(1.0, $options->getTimeout());
         self::assertEquals(2.0, $options->getReadTimeout());
         self::assertFalse($options->isPersistent());
         self::assertEquals('1.0', $options->getRedisVersion());
-        self::assertEquals('user', $options->getUsername());
+        self::assertEquals('user', $options->getUser());
         self::assertEquals('', $options->getPassword());
     }
-Original file line number
+Diff line change
@@ Expand Up @@
                 )
             );
         }
+        public static function fromMissingRequiredPassword(): self
+        {
+            return new self('If a Redis user is provided, a password has to be configured as well.');
+        }
     }