[Lock] Add LockKeyNormalizer

valtzu · valtzu · commit a9201d2a6257 · 2025-07-21T13:32:54.000+03:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -115,6 +115,7 @@
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\LockInterface;
 use Symfony\Component\Lock\PersistingStoreInterface;
+use Symfony\Component\Lock\Serializer\LockKeyNormalizer;
 use Symfony\Component\Lock\Store\StoreFactory;
 use Symfony\Component\Mailer\Bridge as MailerBridge;
 use Symfony\Component\Mailer\Command\MailerTestCommand;
@@ -2199,6 +2200,11 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
     {
         $loader->load('lock.php');
 
+        // BC layer Lock < 7.3
+        if (!interface_exists(DenormalizerInterface::class) || !class_exists(LockKeyNormalizer::class)) {
+            $container->removeDefinition('serializer.normalizer.lock_key');
+        }
+
         foreach ($config['resources'] as $resourceName => $resourceStores) {
             if (0 === \count($resourceStores)) {
                 continue;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/lock.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/lock.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Symfony\Component\Lock\LockFactory;
+use Symfony\Component\Lock\Serializer\LockKeyNormalizer;
 use Symfony\Component\Lock\Store\CombinedStore;
 use Symfony\Component\Lock\Strategy\ConsensusStrategy;
 
@@ -26,5 +27,8 @@
             ->args([abstract_arg('Store')])
             ->call('setLogger', [service('logger')->ignoreOnInvalid()])
             ->tag('monolog.logger', ['channel' => 'lock'])
+
+        ->set('serializer.normalizer.lock_key', LockKeyNormalizer::class)
+            ->tag('serializer.normalizer', ['built_in' => true, 'priority' => -880])
     ;
 };
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.4
+---
+
+ * Add `LockKeyNormalizer`
+
 7.3
 ---
 
diff --git a/src/Symfony/Component/Lock/Serializer/LockKeyNormalizer.php b/src/Symfony/Component/Lock/Serializer/LockKeyNormalizer.php
@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Serializer;
+
+use Symfony\Component\Lock\Key;
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * Normalize {@see Key} instance to transfer an acquired lock between processes.
+ *
+ * @author Valtteri R <valtzu@gmail.com>
+ */
+class LockKeyNormalizer implements NormalizerInterface, DenormalizerInterface
+{
+    public function getSupportedTypes(?string $format): array
+    {
+        return [Key::class => true];
+    }
+
+    /**
+     * @param Key $data
+     */
+    public function normalize(mixed $data, ?string $format = null, array $context = []): array
+    {
+        return (fn () => array_intersect_key(get_object_vars($this), array_flip($this->__sleep())))->bindTo($data, Key::class)();
+    }
+
+    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
+    {
+        return $data instanceof Key;
+    }
+
+    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): Key
+    {
+        $key = (new \ReflectionClass(Key::class))->newInstanceWithoutConstructor();
+        (function () use ($data) {
+            foreach ($this->__sleep() as $serializedField) {
+                $this->$serializedField = $data[$serializedField];
+            }
+        })->bindTo($key, Key::class)();
+
+        return $key;
+    }
+
+    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool
+    {
+        return Key::class === $type;
+    }
+}
diff --git a/src/Symfony/Component/Lock/Tests/Serializer/LockKeyNormalizerTest.php b/src/Symfony/Component/Lock/Tests/Serializer/LockKeyNormalizerTest.php
@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Tests\Serializer;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Lock\Exception\UnserializableKeyException;
+use Symfony\Component\Lock\Key;
+use Symfony\Component\Lock\Serializer\LockKeyNormalizer;
+
+class LockKeyNormalizerTest extends TestCase
+{
+    private LockKeyNormalizer $normalizer;
+
+    protected function setUp(): void
+    {
+        $this->normalizer = new LockKeyNormalizer();
+    }
+
+    public function testNormalizeAndDenormalize()
+    {
+        $key = new Key(__METHOD__);
+        $key->reduceLifetime(1);
+        $key->setState('foo', 'bar');
+
+        $copy = $this->normalizer->denormalize($this->normalizer->normalize($key), Key::class);
+        $this->assertSame($key->getState('foo'), $copy->getState('foo'));
+        $this->assertEqualsWithDelta($key->getRemainingLifetime(), $copy->getRemainingLifetime(), 0.001);
+    }
+
+    public function testNormalizingUnserializableLockThrows()
+    {
+        $key = new Key(__METHOD__);
+        $key->markUnserializable();
+
+        $this->expectException(UnserializableKeyException::class);
+        $this->normalizer->normalize($key);
+    }
+}
diff --git a/src/Symfony/Component/Lock/composer.json b/src/Symfony/Component/Lock/composer.json
@@ -21,7 +21,8 @@
     },
     "require-dev": {
         "doctrine/dbal": "^3.6|^4",
-        "predis/predis": "^1.1|^2.0"
+        "predis/predis": "^1.1|^2.0",
+        "symfony/serializer": "^6.4|^7.0"
     },
     "conflict": {
         "doctrine/dbal": "<3.6",
