Deprecate lock.store aliases

Author: jderusse

CHANGELOG.md

@@ -11,6 +11,7 @@ CHANGELOG
  * deprecated `RetryTillSaveStore`, logic has been moved in `Lock` and is not needed anymore.
  * added `InMemoryStore`
  * added `PostgreSqlStore`
+ * added the `LockFactory::CreateLockFromKey()` method.
 
 5.1.0
 -----

LockFactory.php

@@ -43,7 +43,19 @@ public function __construct(PersistingStoreInterface $store)
      */
     public function createLock(string $resource, ?float $ttl = 300.0, bool $autoRelease = true): LockInterface
     {
-        $lock = new Lock(new Key($resource), $this->store, $ttl, $autoRelease);
+        return $this->createLockFromKey(new Key($resource), $ttl, $autoRelease);
+    }
+
+    /**
+     * Creates a lock from the given key.
+     *
+     * @param Key        $key         The key containing the lock's state
+     * @param float|null $ttl         Maximum expected lock duration in seconds
+     * @param bool       $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed
+     */
+    public function createLockFromKey(Key $key, ?float $ttl = 300.0, bool $autoRelease = true): LockInterface
+    {
+        $lock = new Lock($key, $this->store, $ttl, $autoRelease);
         $lock->setLogger($this->logger);
 
         return $lock;

Tests/LockFactoryTest.php

@@ -13,8 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\LockFactory;
-use Symfony\Component\Lock\LockInterface;
 use Symfony\Component\Lock\PersistingStoreInterface;
 
 /**
@@ -25,12 +25,61 @@ class LockFactoryTest extends TestCase
     public function testCreateLock()
     {
         $store = $this->getMockBuilder(PersistingStoreInterface::class)->getMock();
+        $store->expects($this->any())->method('exists')->willReturn(false);
+
+        $keys = [];
+        $store
+            ->expects($this->exactly(2))
+            ->method('save')
+            ->with($this->callback(function ($key) use (&$keys) {
+                $keys[] = $key;
+
+                return true;
+            }))
+            ->willReturn(true);
+
         $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
         $factory = new LockFactory($store);
         $factory->setLogger($logger);
 
-        $lock = $factory->createLock('foo');
+        $lock1 = $factory->createLock('foo');
+        $lock2 = $factory->createLock('foo');
+
+        // assert lock1 and lock2 don't share the same state
+        $lock1->acquire();
+        $lock2->acquire();
+
+        $this->assertNotSame($keys[0], $keys[1]);
+    }
+
+    public function testCreateLockFromKey()
+    {
+        $store = $this->getMockBuilder(PersistingStoreInterface::class)->getMock();
+        $store->expects($this->any())->method('exists')->willReturn(false);
+
+        $keys = [];
+        $store
+            ->expects($this->exactly(2))
+            ->method('save')
+            ->with($this->callback(function ($key) use (&$keys) {
+                $keys[] = $key;
+
+                return true;
+            }))
+            ->willReturn(true);
+
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $factory = new LockFactory($store);
+        $factory->setLogger($logger);
+
+        $key = new Key('foo');
+        $lock1 = $factory->createLockFromKey($key);
+        $lock2 = $factory->createLockFromKey($key);
+
+        // assert lock1 and lock2 share the same state
+        $lock1->acquire();
+        $lock2->acquire();
 
-        $this->assertInstanceOf(LockInterface::class, $lock);
+        $this->assertSame($keys[0], $keys[1]);
     }
 }