bug #39434 [Cache] Bugfix provide the correct host and port when throwing the exception (renan)

nicolas-grekas · nicolas-grekas · commit f66b853f4acc · 2020-12-10T18:35:09.000+01:00
This PR was merged into the 5.3-dev branch. Discussion ---------- [Cache] Bugfix provide the correct host and port when throwing the exception | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | none | License | MIT | Doc PR | none The message before was including the result of the `getMasterAddrByName` call of which ended with: ``` Failed to retrieve master information from master name "mymaster" and address ":0". ``` Commits ------- 276bbb5 [Cache] Bugfix provide the correct host and port when throwing the exception
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php
@@ -41,4 +41,13 @@ public function testInvalidDSNHasBothClusterAndSentinel()
         $dsn = 'redis:?host[redis1]&host[redis2]&host[redis3]&redis_cluster=1&redis_sentinel=mymaster';
         RedisAdapter::createConnection($dsn);
     }
+
+    public function testExceptionMessageWhenFailingToRetrieveMasterInformation()
+    {
+        $hosts = getenv('REDIS_SENTINEL_HOSTS');
+        $firstHost = explode(' ', $hosts)[0];
+        $this->expectException('Symfony\Component\Cache\Exception\InvalidArgumentException');
+        $this->expectExceptionMessage('Failed to retrieve master information from master name "invalid-masterset-name" and address "'.$firstHost.'".');
+        AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => 'invalid-masterset-name']);
+    }
 }
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -186,9 +186,11 @@ public static function createConnection($dsn, array $options = [])
                 if (isset($params['redis_sentinel'])) {
                     $sentinel = new \RedisSentinel($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout']);
 
-                    if (![$host, $port] = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {
+                    if (!$address = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {
                         throw new InvalidArgumentException(sprintf('Failed to retrieve master information from master name "%s" and address "%s:%d".', $params['redis_sentinel'], $host, $port));
                     }
+
+                    [$host, $port] = $address;
                 }
 
                 try {

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,13 @@ public function testInvalidDSNHasBothClusterAndSentinel()`
`41`	`41`	`$dsn = 'redis:?host[redis1]&host[redis2]&host[redis3]&redis_cluster=1&redis_sentinel=mymaster';`
`42`	`42`	`RedisAdapter::createConnection($dsn);`
`43`	`43`	`}`
	`44`	`+`
	`45`	`+ public function testExceptionMessageWhenFailingToRetrieveMasterInformation()`
	`46`	`+ {`
	`47`	`+ $hosts = getenv('REDIS_SENTINEL_HOSTS');`
	`48`	`+ $firstHost = explode(' ', $hosts)[0];`
	`49`	`+ $this->expectException('Symfony\Component\Cache\Exception\InvalidArgumentException');`
	`50`	`+ $this->expectExceptionMessage('Failed to retrieve master information from master name "invalid-masterset-name" and address "'.$firstHost.'".');`
	`51`	`+ AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => 'invalid-masterset-name']);`
	`52`	`+ }`
`44`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -186,9 +186,11 @@ public static function createConnection($dsn, array $options = [])`
`186`	`186`	`if (isset($params['redis_sentinel'])) {`
`187`	`187`	`$sentinel = new \RedisSentinel($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout']);`
`188`	`188`
`189`		`- if (![$host, $port] = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {`
	`189`	`+ if (!$address = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {`
`190`	`190`	`throw new InvalidArgumentException(sprintf('Failed to retrieve master information from master name "%s" and address "%s:%d".', $params['redis_sentinel'], $host, $port));`
`191`	`191`	`}`
	`192`	`+`
	`193`	`+ [$host, $port] = $address;`
`192`	`194`	`}`
`193`	`195`
`194`	`196`	`try {`