Merge pull request #276 from boesing/bugfix/serializer-serializes-token

`Serializer` plugin has to serialize `token` to enable `StorageInterface#checkAndSetItem` comparing the correct values

Author: boesing

src/Storage/Plugin/Serializer.php

@@ -93,6 +93,10 @@ public function onWriteItemPre(Event $event)
         $serializer      = $this->getOptions()->getSerializer();
         $params          = $event->getParams();
         $params['value'] = $serializer->serialize($params['value']);
+        /** Passed by {@see AbstractAdapter::checkAndSetItem()}. Used to compare with the already cached value. */
+        if (isset($params['token'])) {
+            $params['token'] = $serializer->serialize($params['token']);
+        }
     }
 
     /**

test/Storage/Adapter/AbstractAdapterTest.php

@@ -14,6 +14,7 @@
 use Laminas\Cache\Storage\Capabilities;
 use Laminas\Cache\Storage\Event;
 use Laminas\Cache\Storage\Plugin\PluginOptions;
+use Laminas\Cache\Storage\Plugin\Serializer;
 use Laminas\Cache\Storage\PostEvent;
 use Laminas\EventManager\ResponseCollection;
 use LaminasTest\Cache\Storage\TestAsset\MockPlugin;
@@ -30,6 +31,7 @@
 use function call_user_func_array;
 use function count;
 use function current;
+use function serialize;
 use function ucfirst;
 
 final class AbstractAdapterTest extends TestCase
@@ -962,4 +964,24 @@ protected function getMockForAbstractAdapter(array $methods = []): MockObject&Ab
 
         return $adapter;
     }
+
+    public function testCanCompareOldValueWithTokenWhenUsedWithSerializerPlugin(): void
+    {
+        $storage = $this->getMockForAbstractAdapter();
+        $storage
+            ->addPlugin(new Serializer());
+        $storage
+            ->expects(self::once())
+            ->method('internalSetItem')
+            ->with('foo', serialize('baz'))
+            ->willReturn(true);
+
+        $storage
+            ->expects(self::once())
+            ->method('internalGetItem')
+            ->with('foo')
+            ->willReturn(serialize('bar'));
+
+        self::assertTrue($storage->checkAndSetItem('bar', 'foo', 'baz'));
+    }
 }

test/Storage/Plugin/SerializerTest.php

@@ -220,4 +220,19 @@ public function testOnIncrementItemWillAssumeZeroForNonExistingCacheItem(): void
 
         self::assertEquals(10, $plugin->onIncrementItemPre($event));
     }
+
+    public function testonWriteItemPreSerializesTokenOncePassed(): void
+    {
+        $plugin     = new Serializer();
+        $parameters = new ArrayObject([
+            'key'   => 'foo',
+            'value' => 10,
+            'token' => 10,
+        ]);
+        $event      = new Event('foo', $this->createMock(StorageInterface::class), $parameters);
+
+        $plugin->onWriteItemPre($event);
+
+        self::assertSame($parameters['value'], $parameters['token']);
+    }
 }