[11.x] Fix Cache component to be aware of phpredis serialization and compression settings (#54221)

* Add phpredis support to the cache component

- Fix cache component not being able to handle serialized or compressed phpredis connections

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: TheLevti

src/Illuminate/Cache/LuaScripts.php

@@ -4,6 +4,22 @@
 
 class LuaScripts
 {
+    /**
+     * Get the Lua script that sets a key only when it does not yet exist.
+     *
+     * KEYS[1] - The name of the key
+     * ARGV[1] - The value of the key
+     * ARGV[2] - The number of seconds the key should be valid
+     *
+     * @return string
+     */
+    public static function add()
+    {
+        return <<<'LUA'
+return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])
+LUA;
+    }
+
     /**
      * Get the Lua script to atomically release a lock.
      *

src/Illuminate/Cache/RedisStore.php

@@ -68,9 +68,11 @@ public function __construct(Redis $redis, $prefix = '', $connection = 'default')
      */
     public function get($key)
     {
-        $value = $this->connection()->get($this->prefix.$key);
+        $connection = $this->connection();
+
+        $value = $connection->get($this->prefix.$key);
 
-        return ! is_null($value) ? $this->unserialize($value) : null;
+        return ! is_null($value) ? $this->connectionAwareUnserialize($value, $connection) : null;
     }
 
     /**
@@ -89,12 +91,14 @@ public function many(array $keys)
 
         $results = [];
 
-        $values = $this->connection()->mget(array_map(function ($key) {
+        $connection = $this->connection();
+
+        $values = $connection->mget(array_map(function ($key) {
             return $this->prefix.$key;
         }, $keys));
 
         foreach ($values as $index => $value) {
-            $results[$keys[$index]] = ! is_null($value) ? $this->unserialize($value) : null;
+            $results[$keys[$index]] = ! is_null($value) ? $this->connectionAwareUnserialize($value, $connection) : null;
         }
 
         return $results;
@@ -110,8 +114,10 @@ public function many(array $keys)
      */
     public function put($key, $value, $seconds)
     {
-        return (bool) $this->connection()->setex(
-            $this->prefix.$key, (int) max(1, $seconds), $this->serialize($value)
+        $connection = $this->connection();
+
+        return (bool) $connection->setex(
+            $this->prefix.$key, (int) max(1, $seconds), $this->connectionAwareSerialize($value, $connection)
         );
     }
 
@@ -165,10 +171,10 @@ public function putMany(array $values, $seconds)
      */
     public function add($key, $value, $seconds)
     {
-        $lua = "return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])";
+        $connection = $this->connection();
 
-        return (bool) $this->connection()->eval(
-            $lua, 1, $this->prefix.$key, $this->serialize($value), (int) max(1, $seconds)
+        return (bool) $connection->eval(
+            LuaScripts::add(), 1, $this->prefix.$key, $this->pack($value, $connection), (int) max(1, $seconds)
         );
     }
 
@@ -205,7 +211,9 @@ public function decrement($key, $value = 1)
      */
     public function forever($key, $value)
     {
-        return (bool) $this->connection()->set($this->prefix.$key, $this->serialize($value));
+        $connection = $this->connection();
+
+        return (bool) $connection->set($this->prefix.$key, $this->connectionAwareSerialize($value, $connection));
     }
 
     /**
@@ -414,6 +422,28 @@ public function setPrefix($prefix)
         $this->prefix = $prefix;
     }
 
+    /**
+     * Prepare a value to be used with the Redis cache store when used by eval scripts.
+     *
+     * @param  mixed  $value
+     * @param  \Illuminate\Redis\Connections\Connection  $connection
+     * @return mixed
+     */
+    protected function pack($value, $connection)
+    {
+        if ($connection instanceof PhpRedisConnection) {
+            if ($connection->serialized()) {
+                return $connection->pack([$value])[0];
+            }
+
+            if ($connection->compressed()) {
+                return $connection->pack([$this->serialize($value)])[0];
+            }
+        }
+
+        return $this->serialize($value);
+    }
+
     /**
      * Serialize the value.
      *
@@ -435,4 +465,36 @@ protected function unserialize($value)
     {
         return is_numeric($value) ? $value : unserialize($value);
     }
+
+    /**
+     * Handle connection specific considerations when a value needs to be serialized.
+     *
+     * @param  mixed  $value
+     * @param  \Illuminate\Redis\Connections\Connection  $connection
+     * @return mixed
+     */
+    protected function connectionAwareSerialize($value, $connection)
+    {
+        if ($connection instanceof PhpRedisConnection && $connection->serialized()) {
+            return $value;
+        }
+
+        return $this->serialize($value);
+    }
+
+    /**
+     * Handle connection specific considerations when a value needs to be unserialized.
+     *
+     * @param  mixed  $value
+     * @param  \Illuminate\Redis\Connections\Connection  $connection
+     * @return mixed
+     */
+    protected function connectionAwareUnserialize($value, $connection)
+    {
+        if ($connection instanceof PhpRedisConnection && $connection->serialized()) {
+            return $value;
+        }
+
+        return $this->unserialize($value);
+    }
 }

src/Illuminate/Redis/Connections/PacksPhpRedisValues.php

@@ -82,6 +82,17 @@ public function pack(array $values): array
         return array_map($processor, $values);
     }
 
+    /**
+     * Determine if serialization is enabled.
+     *
+     * @return bool
+     */
+    public function serialized(): bool
+    {
+        return defined('Redis::OPT_SERIALIZER') &&
+               $this->client->getOption(Redis::OPT_SERIALIZER) !== Redis::SERIALIZER_NONE;
+    }
+
     /**
      * Determine if compression is enabled.
      *