#36337: Respect serialization and compression of phpredis during locking

- Support phpredis serialization when locking (none, php, json, igbinary, msgpack).
- Support phpredis compression when locking (none, lzf, zstd, lz4).

Author: TheLevti

src/Illuminate/Cache/RedisLock.php

@@ -2,6 +2,8 @@
 
 namespace Illuminate\Cache;
 
+use UnexpectedValueException;
+
 class RedisLock extends Lock
 {
     /**
@@ -48,7 +50,42 @@ public function acquire()
      */
     public function release()
     {
-        return (bool) $this->redis->eval(LuaScripts::releaseLock(), 1, $this->name, $this->owner);
+        $owner = $this->owner;
+
+        /* If a serialization mode such as "php" or "igbinary" and/or a
+         * compression mode such as "lzf" or "zstd" is enabled, the owner
+         * must be serialized and/or compressed by us, because phpredis does
+         * not do this for the eval command.
+         *
+         * Name must not be modified!
+         */
+        if ($this->isPhpRedis()) {
+            $owner = $this->redis->client()->_serialize($owner);
+
+            // Check first whether enabled at all before checking each as most likely it is not used.
+            if ($this->isPhpRedisCompressionEnabled()) {
+                if ($this->isPhpRedisLzfEnabled()) {
+                    $owner = \lzf_compress($owner);
+                } elseif ($this->isPhpRedisZstdEnabled()) {
+                    $owner = \zstd_compress(
+                        $owner,
+                        $this->redis->client()->getOption(constant('Redis::OPT_COMPRESSION_LEVEL'))
+                    );
+                } elseif ($this->isPhpRedisLz4Enabled()) {
+                    $owner = \lz4_compress(
+                        $owner,
+                        $this->redis->client()->getOption(constant('Redis::OPT_COMPRESSION_LEVEL'))
+                    );
+                } else {
+                    throw new UnexpectedValueException(sprintf(
+                        'Unknown phpredis compression in use (%d). Unable to release lock.',
+                        $this->redis->client()->getOption(constant('Redis::OPT_COMPRESSION'))
+                    ));
+                }
+            }
+        }
+
+        return (bool) $this->redis->eval(LuaScripts::releaseLock(), 1, $this->name, $owner);
     }
 
     /**
@@ -80,4 +117,104 @@ public function getConnectionName()
     {
         return $this->redis->getName();
     }
+
+    /**
+     * Determines whether compression is enabled for the phpredis connection.
+     *
+     * @return bool
+     */
+    private function isPhpRedisCompressionEnabled()
+    {
+        $compressionOpt = constant('Redis::OPT_COMPRESSION');
+        $compressionNone = constant('Redis::COMPRESSION_NONE');
+
+        if ($this->redis->client()->getOption($compressionOpt) === $compressionNone) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Determines whether lzf compression is enabled for the phpredis connection.
+     *
+     * @return bool
+     */
+    private function isPhpRedisLzfEnabled()
+    {
+        $lzfConst = 'Redis::COMPRESSION_LZF';
+        if (! defined($lzfConst)) {
+            return false;
+        }
+
+        $lzfCompression = constant($lzfConst);
+        $compressionOpt = constant('Redis::OPT_COMPRESSION');
+
+        if ($this->redis->client()->getOption($compressionOpt) === $lzfCompression) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Determines whether zstd compression is enabled for the phpredis connection.
+     *
+     * @return bool
+     */
+    private function isPhpRedisZstdEnabled()
+    {
+        $zstdConst = 'Redis::COMPRESSION_ZSTD';
+        if (! defined($zstdConst)) {
+            return false;
+        }
+
+        $zstdCompression = constant($zstdConst);
+        $compressionOpt = constant('Redis::OPT_COMPRESSION');
+
+        if ($this->redis->client()->getOption($compressionOpt) === $zstdCompression) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Determines whether lz4 compression is enabled for the phpredis connection.
+     *
+     * @return bool
+     */
+    private function isPhpRedisLz4Enabled()
+    {
+        $lz4Const = 'Redis::COMPRESSION_LZ4';
+        if (! defined($lz4Const)) {
+            return false;
+        }
+
+        $lz4Compression = constant($lz4Const);
+        $compressionOpt = constant('Redis::OPT_COMPRESSION');
+
+        if ($this->redis->client()->getOption($compressionOpt) === $lz4Compression) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Determines whether the client used to connect to redis is one from the
+     * phpredis extension.
+     *
+     * @return bool
+     */
+    private function isPhpRedis()
+    {
+        $client = $this->redis->client();
+        $clientClass = get_class($client);
+        if ($clientClass === 'Redis' || $clientClass === 'RedisCluster') {
+            return true;
+        }
+
+        return false;
+    }
 }