Enable usage of username in dsn (#678)

Closes #673
snc · Nov 10, 2022 · 5797249 · 5797249
1 parent e7ee8c4
commit 5797249
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 12 deletions.
diff --git a/src/Factory/PhpredisClientFactory.php b/src/Factory/PhpredisClientFactory.php
@@ -152,7 +152,7 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array
             $client->connect(...$connectParameters);
         }
 
-        $username = $options['parameters']['username'] ?? null;
+        $username = $dsn->getUsername() ?? $options['parameters']['username'] ?? null;
         $password = $dsn->getPassword() ?? $options['parameters']['password'] ?? null;
         if ($username !== null && $password !== null) {
             $client->auth([$username, $password]);

diff --git a/tests/DependencyInjection/SncRedisExtensionTest.php b/tests/DependencyInjection/SncRedisExtensionTest.php
@@ -429,11 +429,12 @@ public function testPhpRedisDuplicatedParameters(): void
 
         $this->assertSame(2, $defaultParameters->getArgument(2)['parameters']['database']);
         $this->assertSame('otherpassword', $defaultParameters->getArgument(2)['parameters']['password']);
+        $this->assertSame('otherusername', $defaultParameters->getArgument(2)['parameters']['username']);
 
         $redis = $container->get('snc_redis.default');
 
         $this->assertSame(1, $redis->getDBNum());
-        $this->assertSame('sncredis', $redis->getAuth());
+        $this->assertSame(['snc_redis', 'snc_password'], $redis->getAuth());
     }
 
     /**
@@ -733,11 +734,12 @@ private function getPhpRedisYamlConfigWithDuplicatedParameters(): string
     default:
         type: phpredis
         alias: default
-        dsn: redis://redis:sncredis@localhost/1
+        dsn: redis://snc_redis:snc_password@localhost:8000/1
         options:
             parameters:
                 database: 2
                 password: otherpassword
+                username: otherusername
 EOF;
     }
 

diff --git a/tests/Factory/PhpredisClientFactoryTest.php b/tests/Factory/PhpredisClientFactoryTest.php
@@ -130,7 +130,7 @@ public function testDsnConfig(): void
 
         $client = $factory->create(
             Redis::class,
-            ['redis://redis:sncredis@localhost:6379/2'],
+            ['redis://sncredis@localhost:6379/2'],
             [
                 'parameters' => [
                     'database' => 3,
@@ -148,13 +148,43 @@ public function testDsnConfig(): void
         $this->assertNull($client->getPersistentID());
     }
 
+    public function testDsnConfigWithUsername(): void
+    {
+        $this->logger->method('debug')->withConsecutive(
+            [$this->stringContains('Executing command "CONNECT localhost 8000 5')],
+            ['Executing command "AUTH snc_redis snc_password"'],
+            ['Executing command "SELECT 0"'],
+        );
+
+        $factory = new PhpredisClientFactory(new RedisCallInterceptor($this->redisLogger));
+
+        $client = $factory->create(
+            Redis::class,
+            ['redis://snc_redis:snc_password@localhost:8000/0'],
+            [
+                'parameters' => [
+                    'database' => 3,
+                    'password' => 'secret',
+                ],
+                'connection_timeout' => 5,
+            ],
+            'alias_test',
+            true,
+        );
+
+        $this->assertInstanceOf(Redis::class, $client);
+        $this->assertSame(0, $client->getDBNum());
+        $this->assertSame(['snc_redis', 'snc_password'], $client->getAuth());
+        $this->assertNull($client->getPersistentID());
+    }
+
     public function testNestedDsnConfig(): void
     {
         $factory = new PhpredisClientFactory(new RedisCallInterceptor($this->redisLogger));
 
         $client = $factory->create(
             Redis::class,
-            [['redis://redis:sncredis@localhost:6379/2']],
+            [['redis://sncredis@localhost:6379/2']],
             [
                 'parameters' => [
                     'database' => 3,
@@ -234,7 +264,7 @@ public function testMethodsWithVariadicParameters(): void
 
         $client = $factory->create(
             Redis::class,
-            ['redis://redis:sncredis@localhost:6379/2'],
+            ['redis://sncredis@localhost:6379/2'],
             [
                 'parameters' => [
                     'database' => 3,
@@ -265,7 +295,7 @@ public function testMethodWithPassByRefArgument(): void
 
         $client = $factory->create(
             Redis::class,
-            ['redis://redis:sncredis@localhost:6379/2'],
+            ['redis://sncredis@localhost:6379/2'],
             ['connection_timeout' => 5],
             'alias_test',
             true,

diff --git a/tests/Functional/App/config.yaml b/tests/Functional/App/config.yaml
@@ -19,20 +19,20 @@ snc_redis:
         default:
             type: phpredis
             alias: default
-            dsn: redis://redis:sncredis@localhost
+            dsn: redis://sncredis@localhost
             logging: '%kernel.debug%'
         cache:
             type: predis
             alias: cache
-            dsn: redis://redis:sncredis@localhost/1
+            dsn: redis://sncredis@localhost/1
             logging: false
         cluster:
             type: predis
             alias: cluster
             dsn:
-              - redis://redis:sncredis@127.0.0.1/3
-              - redis://redis:sncredis@127.0.0.1/4
-              - redis://redis:sncredis@127.0.0.1/5
+              - redis://sncredis@127.0.0.1/3
+              - redis://sncredis@127.0.0.1/4
+              - redis://sncredis@127.0.0.1/5
             options:
                 prefix: foo
                 profile: 2.4