bug #59661 [Lock] Fix Predis error handling (HypeMC)

nicolas-grekas · nicolas-grekas · commit c6336470f2f3 · 2025-02-04T15:22:06.000+01:00
This PR was merged into the 7.2 branch. Discussion ---------- [Lock] Fix Predis error handling | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #59686 | License | MIT #59348 completely broke the Redis store when used with a service, eg: ```yaml framework: lock: resources: default: snc_redis.default ``` The assumption that `exceptions` is always `false` is only correct when a DSN is used. Commits ------- b20892f [Lock] Fix Predis error handling
diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Lock\Store;
 
 use Predis\Response\Error;
+use Predis\Response\ServerException;
 use Relay\Relay;
 use Symfony\Component\Lock\Exception\InvalidTtlException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
@@ -284,21 +285,18 @@ private function evaluate(string $script, string $resource, array $args): mixed
 
         \assert($this->redis instanceof \Predis\ClientInterface);
 
-        $result = $this->redis->evalSha($scriptSha, 1, $resource, ...$args);
-        if ($result instanceof Error && str_starts_with($result->getMessage(), self::NO_SCRIPT_ERROR_MESSAGE_PREFIX)) {
-            $result = $this->redis->script('LOAD', $script);
-            if ($result instanceof Error) {
-                throw new LockStorageException($result->getMessage());
+        try {
+            return $this->handlePredisError(fn () => $this->redis->evalSha($scriptSha, 1, $resource, ...$args));
+        } catch (LockStorageException $e) {
+            // Fallthrough only if we need to load the script
+            if (!str_starts_with($e->getMessage(), self::NO_SCRIPT_ERROR_MESSAGE_PREFIX)) {
+                throw $e;
             }
-
-            $result = $this->redis->evalSha($scriptSha, 1, $resource, ...$args);
         }
 
-        if ($result instanceof Error) {
-            throw new LockStorageException($result->getMessage());
-        }
+        $this->handlePredisError(fn () => $this->redis->script('LOAD', $script));
 
-        return $result;
+        return $this->handlePredisError(fn () => $this->redis->evalSha($scriptSha, 1, $resource, ...$args));
     }
 
     private function getUniqueToken(Key $key): string
@@ -347,4 +345,26 @@ private function getNowCode(): string
             now = math.floor(now * 1000)
         ';
     }
+
+    /**
+     * @template T
+     *
+     * @param callable(): T $callback
+     *
+     * @return T
+     */
+    private function handlePredisError(callable $callback): mixed
+    {
+        try {
+            $result = $callback();
+        } catch (ServerException $e) {
+            throw new LockStorageException($e->getMessage(), $e->getCode(), $e);
+        }
+
+        if ($result instanceof Error) {
+            throw new LockStorageException($result->getMessage());
+        }
+
+        return $result;
+    }
 }
diff --git a/src/Symfony/Component/Lock/Tests/Store/PredisStoreWithExceptionsTest.php b/src/Symfony/Component/Lock/Tests/Store/PredisStoreWithExceptionsTest.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Tests\Store;
+
+/**
+ * @group integration
+ */
+class PredisStoreWithExceptionsTest extends AbstractRedisStoreTestCase
+{
+    public static function setUpBeforeClass(): void
+    {
+        $redis = new \Predis\Client(array_combine(['host', 'port'], explode(':', getenv('REDIS_HOST')) + [1 => null]));
+        try {
+            $redis->connect();
+        } catch (\Exception $e) {
+            self::markTestSkipped($e->getMessage());
+        }
+    }
+
+    protected function getRedisConnection(): \Predis\Client
+    {
+        $redis = new \Predis\Client(array_combine(['host', 'port'], explode(':', getenv('REDIS_HOST')) + [1 => null]));
+        $redis->connect();
+
+        return $redis;
+    }
+}
diff --git a/src/Symfony/Component/Lock/Tests/Store/PredisStoreWithoutExceptionsTest.php b/src/Symfony/Component/Lock/Tests/Store/PredisStoreWithoutExceptionsTest.php
@@ -16,7 +16,7 @@
  *
  * @group integration
  */
-class PredisStoreTest extends AbstractRedisStoreTestCase
+class PredisStoreWithoutExceptionsTest extends AbstractRedisStoreTestCase
 {
     public static function setUpBeforeClass(): void
     {

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @group integration`
`18`	`18`	`*/`
`19`		`-class PredisStoreTest extends AbstractRedisStoreTestCase`
	`19`	`+class PredisStoreWithoutExceptionsTest extends AbstractRedisStoreTestCase`
`20`	`20`	`{`
`21`	`21`	`public static function setUpBeforeClass(): void`
`22`	`22`	`{`