From 36cb6765e0d0eafba2679edb6c9528d0d84dfe59 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=94=D0=BC=D0=B8=D1=82=D1=80=D0=B8=D0=B9?=
 <Gerych84@gmail.com>
Date: Thu, 14 Mar 2024 14:08:06 +0300
Subject: [PATCH] Custom serializer support

---
 src/DbCache.php             | 13 ++++----
 src/PhpSerializer.php       | 27 ++++++++++++++++
 src/SerializerInterface.php | 12 +++++++
 tests/PhpSerializerTest.php | 64 +++++++++++++++++++++++++++++++++++++
 4 files changed, 110 insertions(+), 6 deletions(-)
 create mode 100644 src/PhpSerializer.php
 create mode 100644 src/SerializerInterface.php
 create mode 100644 tests/PhpSerializerTest.php

diff --git a/src/DbCache.php b/src/DbCache.php
index 0170b17..c84889c 100644
--- a/src/DbCache.php
+++ b/src/DbCache.php
@@ -21,10 +21,8 @@
 use function is_string;
 use function iterator_to_array;
 use function random_int;
-use function serialize;
 use function strpbrk;
 use function time;
-use function unserialize;
 
 /**
  * DbCache stores cache data in a database table.
@@ -37,6 +35,7 @@ final class DbCache implements CacheInterface
 
     private string $loggerMessageDelete = 'Unable to delete cache data: ';
     private string $loggerMessageUpdate = 'Unable to update cache data: ';
+    private SerializerInterface $serializer;
 
     /**
      * @param ConnectionInterface $db The database connection instance.
@@ -48,8 +47,10 @@ final class DbCache implements CacheInterface
     public function __construct(
         private ConnectionInterface $db,
         private string $table = '{{%yii_cache}}',
-        public int $gcProbability = 100
+        public int $gcProbability = 100,
+        ?SerializerInterface $serializer = null
     ) {
+        $this->serializer = $serializer ?? new PhpSerializer();
     }
 
     /**
@@ -75,7 +76,7 @@ public function get(string $key, mixed $default = null): mixed
         /** @var bool|float|int|string|null $value */
         $value = $this->getData($key, ['data'], 'scalar');
 
-        return $value === false ? $default : unserialize((string) $value);
+        return $value === false ? $default : $this->serializer->restore((string) $value);
     }
 
     /**
@@ -142,7 +143,7 @@ public function getMultiple(iterable $keys, mixed $default = null): iterable
             }
 
             /** @psalm-var string */
-            $values[$value['id']] = unserialize((string) $value['data']);
+            $values[$value['id']] = $this->serializer->restore((string) $value['data']);
         }
 
         /** @psalm-var iterable<string,mixed> */
@@ -289,7 +290,7 @@ private function deleteData(array|string|bool $id): bool
     private function buildDataRow(string $id, ?int $ttl, mixed $value, bool $associative): array
     {
         $expire = $this->isInfinityTtl($ttl) ? null : ((int) $ttl + time());
-        $data = new Param(serialize($value), PDO::PARAM_LOB);
+        $data = new Param($this->serializer->serialize($value), PDO::PARAM_LOB);
 
         if ($associative) {
             return ['id' => $id, 'expire' => $expire, 'data' => $data];
diff --git a/src/PhpSerializer.php b/src/PhpSerializer.php
new file mode 100644
index 0000000..55a29ce
--- /dev/null
+++ b/src/PhpSerializer.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Cache\Db;
+
+use function serialize;
+use function unserialize;
+
+final class PhpSerializer implements SerializerInterface
+{
+    public function serialize(mixed $value): string
+    {
+        return serialize($value);
+    }
+
+    /**
+     * @param string $value
+     * @return mixed
+     *
+     * @psalm-suppress MixedArgumentTypeCoercion
+     */
+    public function restore(string $value): mixed
+    {
+        return unserialize($value);
+    }
+}
diff --git a/src/SerializerInterface.php b/src/SerializerInterface.php
new file mode 100644
index 0000000..a864767
--- /dev/null
+++ b/src/SerializerInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Cache\Db;
+
+interface SerializerInterface
+{
+    public function serialize(mixed $value): string;
+
+    public function restore(string $value): mixed;
+}
diff --git a/tests/PhpSerializerTest.php b/tests/PhpSerializerTest.php
new file mode 100644
index 0000000..e73c28a
--- /dev/null
+++ b/tests/PhpSerializerTest.php
@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Cache\Db\Tests;
+
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Yiisoft\Cache\Db\PhpSerializer;
+
+use function pi;
+
+use const PHP_INT_MAX;
+
+final class PhpSerializerTest extends TestCase
+{
+    public static function serializeDataProvider(): array
+    {
+        $object = new stdClass();
+        $object->foo = 'bar';
+        $object->bar = 'foo';
+
+        return [
+            [
+                true,
+            ],
+            [
+                PHP_INT_MAX,
+            ],
+            [
+                pi(),
+            ],
+            [
+                'string',
+            ],
+            [
+                [
+                    'key' => 'value',
+                    'foo' => 'bar',
+                ],
+            ],
+            [
+                $object,
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider serializeDataProvider
+     * @param mixed $data
+     * @return void
+     */
+    public function testSerialize(mixed $data): void
+    {
+        $serializer = new PhpSerializer();
+        $result = $serializer->serialize($data);
+
+        if (is_object($data)) {
+            self::assertEquals($data, $serializer->restore($result));
+        } else {
+            self::assertSame($data, $serializer->restore($result));
+        }
+    }
+}