[12.x] Parse Redis "friendly" algorithm names into integers (#56800)

* Parse algorithm names

* add parenthesis

* Update RedisCacheIntegrationTest.php

* dont fail with int-based invalid backoff algorithms

* refac

Author: mateusjatenee

src/Illuminate/Redis/Connectors/PhpRedisConnector.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Redis as RedisFacade;
 use Illuminate\Support\Str;
+use InvalidArgumentException;
 use LogicException;
 use Redis;
 use RedisCluster;
@@ -92,7 +93,7 @@ protected function createClient(array $config)
             }
 
             if (array_key_exists('backoff_algorithm', $config)) {
-                $client->setOption(Redis::OPT_BACKOFF_ALGORITHM, $config['backoff_algorithm']);
+                $client->setOption(Redis::OPT_BACKOFF_ALGORITHM, $this->parseBackoffAlgorithm($config['backoff_algorithm']));
             }
 
             if (array_key_exists('backoff_base', $config)) {
@@ -241,4 +242,29 @@ protected function formatHost(array $options)
 
         return $options['host'];
     }
+
+    /**
+     * Parse a "friendly" backoff algorithm name into an integer.
+     *
+     * @param  mixed  $algorithm
+     * @return int
+     *
+     * @throws \InvalidArgumentException
+     */
+    protected function parseBackoffAlgorithm(mixed $algorithm)
+    {
+        if (is_int($algorithm)) {
+            return $algorithm;
+        }
+
+        return match ($algorithm) {
+            'default' => Redis::BACKOFF_ALGORITHM_DEFAULT,
+            'decorrelated_jitter' => Redis::BACKOFF_ALGORITHM_DECORRELATED_JITTER,
+            'equal_jitter' => Redis::BACKOFF_ALGORITHM_EQUAL_JITTER,
+            'exponential' => Redis::BACKOFF_ALGORITHM_EXPONENTIAL,
+            'uniform' => Redis::BACKOFF_ALGORITHM_UNIFORM,
+            'constant' => Redis::BACKOFF_ALGORITHM_CONSTANT,
+            default => throw new InvalidArgumentException("Algorithm [{$algorithm}] is not a valid PhpRedis backoff algorithm.")
+        };
+    }
 }

tests/Cache/RedisCacheIntegrationTest.php

@@ -5,9 +5,14 @@
 use Illuminate\Cache\RateLimiter;
 use Illuminate\Cache\RedisStore;
 use Illuminate\Cache\Repository;
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Testing\Concerns\InteractsWithRedis;
+use Illuminate\Redis\RedisManager;
+use Illuminate\Support\Env;
+use InvalidArgumentException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Redis;
 
 class RedisCacheIntegrationTest extends TestCase
 {
@@ -82,4 +87,92 @@ public function testRedisCacheAddNull($driver)
         $repository->forever('k', null);
         $this->assertFalse($repository->add('k', 'v', 60));
     }
+
+    #[DataProvider('phpRedisBackoffAlgorithmsProvider')]
+    public function testPhpRedisBackoffAlgorithmParsing($friendlyAlgorithmName, $expectedAlgorithm)
+    {
+        $host = Env::get('REDIS_HOST', '127.0.0.1');
+        $port = Env::get('REDIS_PORT', 6379);
+
+        $manager = new RedisManager(new Application(), 'phpredis', [
+            'default' => [
+                'host' => $host,
+                'port' => $port,
+                'backoff_algorithm' => $friendlyAlgorithmName,
+            ],
+        ]);
+
+        $this->assertEquals(
+            $expectedAlgorithm,
+            $manager->connection()->client()->getOption(Redis::OPT_BACKOFF_ALGORITHM)
+        );
+    }
+
+    #[DataProvider('phpRedisBackoffAlgorithmsProvider')]
+    public function testPhpRedisBackoffAlgorithm($friendlyAlgorithm, $expectedAlgorithm)
+    {
+        $host = Env::get('REDIS_HOST', '127.0.0.1');
+        $port = Env::get('REDIS_PORT', 6379);
+
+        $manager = new RedisManager(new Application(), 'phpredis', [
+            'default' => [
+                'host' => $host,
+                'port' => $port,
+                'backoff_algorithm' => $expectedAlgorithm,
+            ],
+        ]);
+
+        $this->assertEquals(
+            $expectedAlgorithm,
+            $manager->connection()->client()->getOption(Redis::OPT_BACKOFF_ALGORITHM)
+        );
+    }
+
+    public function testAnInvalidPhpRedisBackoffAlgorithmIsConvertedToDefault()
+    {
+        $host = Env::get('REDIS_HOST', '127.0.0.1');
+        $port = Env::get('REDIS_PORT', 6379);
+
+        $manager = new RedisManager(new Application(), 'phpredis', [
+            'default' => [
+                'host' => $host,
+                'port' => $port,
+                'backoff_algorithm' => 7,
+            ],
+        ]);
+
+        $this->assertEquals(
+            Redis::BACKOFF_ALGORITHM_DEFAULT,
+            $manager->connection()->client()->getOption(Redis::OPT_BACKOFF_ALGORITHM)
+        );
+    }
+
+    public function testItFailsWithAnInvalidPhpRedisAlgorithm()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Algorithm [foo] is not a valid PhpRedis backoff algorithm');
+
+        $host = Env::get('REDIS_HOST', '127.0.0.1');
+        $port = Env::get('REDIS_PORT', 6379);
+
+        (new RedisManager(new Application(), 'phpredis', [
+            'default' => [
+                'host' => $host,
+                'port' => $port,
+                'backoff_algorithm' => 'foo',
+            ],
+        ]))->connection();
+    }
+
+    public static function phpRedisBackoffAlgorithmsProvider()
+    {
+        return [
+            ['default', Redis::BACKOFF_ALGORITHM_DEFAULT],
+            ['decorrelated_jitter', Redis::BACKOFF_ALGORITHM_DECORRELATED_JITTER],
+            ['equal_jitter', Redis::BACKOFF_ALGORITHM_EQUAL_JITTER],
+            ['exponential', Redis::BACKOFF_ALGORITHM_EXPONENTIAL],
+            ['uniform', Redis::BACKOFF_ALGORITHM_UNIFORM],
+            ['constant', Redis::BACKOFF_ALGORITHM_CONSTANT],
+        ];
+    }
 }