[Lock] remove StoreInterface in favor off PersistStoreInterface

Simperfit · Simperfit · commit a37c0dcddec7 · 2019-07-16T08:10:47.000+02:00
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -301,6 +301,11 @@ Intl
  * Removed `Intl::getLocaleBundle()`, use `Locales` instead
  * Removed `Intl::getRegionBundle()`, use `Countries` instead
 
+Lock
+----
+
+* Removed `Symfony\Component\Lock\StoreInterface` in favor of `Symfony\Component\Lock\BlockingStoreInterface` and `Symfony\Component\Lock\PersistStoreInterface`
+
 Messenger
 ---------
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -74,7 +74,6 @@
 use Symfony\Component\Lock\PersistStoreInterface;
 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\StoreFactory;
-use Symfony\Component\Lock\StoreInterface;
 use Symfony\Component\Mailer\Mailer;
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
 use Symfony\Component\Messenger\MessageBus;
@@ -1441,7 +1440,7 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
                             $container->setDefinition($connectionDefinitionId, $connectionDefinition);
                         }
 
-                        $storeDefinition = new Definition(StoreInterface::class);
+                        $storeDefinition = new Definition(PersistStoreInterface::class);
                         $storeDefinition->setPublic(false);
                         $storeDefinition->setFactory([StoreFactory::class, 'createStore']);
                         $storeDefinition->setArguments([new Reference($connectionDefinitionId)]);
@@ -1483,12 +1482,10 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
                 $container->setAlias('lock.store', new Alias('lock.'.$resourceName.'.store', false));
                 $container->setAlias('lock.factory', new Alias('lock.'.$resourceName.'.factory', false));
                 $container->setAlias('lock', new Alias('lock.'.$resourceName, false));
-                $container->setAlias(StoreInterface::class, new Alias('lock.store', false));
                 $container->setAlias(PersistStoreInterface::class, new Alias('lock.store', false));
                 $container->setAlias(Factory::class, new Alias('lock.factory', false));
                 $container->setAlias(LockInterface::class, new Alias('lock', false));
             } else {
-                $container->registerAliasForArgument('lock.'.$resourceName.'.store', StoreInterface::class, $resourceName.'.lock.store');
                 $container->registerAliasForArgument('lock.'.$resourceName.'.store', PersistStoreInterface::class, $resourceName.'.lock.store');
                 $container->registerAliasForArgument('lock.'.$resourceName.'.factory', Factory::class, $resourceName.'.lock.factory');
                 $container->registerAliasForArgument('lock.'.$resourceName, LockInterface::class, $resourceName.'.lock');
diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -28,7 +28,7 @@ class Factory implements LoggerAwareInterface
 
     private $store;
 
-    public function __construct(StoreInterface $store)
+    public function __construct(PersistStoreInterface $store)
     {
         $this->store = $store;
 
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -71,7 +71,7 @@ public function acquire($blocking = false): ?bool
     {
         try {
             if ($blocking) {
-                if (!$this->store instanceof StoreInterface && !($this->store instanceof BlockingStoreInterface && $this->store->supportsWaitAndSave())) {
+                if (!($this->store instanceof BlockingStoreInterface && $this->store->supportsWaitAndSave())) {
                     throw new NotSupportedException(sprintf('The store "%s" does not support blocking locks.', \get_class($this->store)));
                 }
                 $this->store->waitAndSave($this->key);
diff --git a/src/Symfony/Component/Lock/Store/CombinedStore.php b/src/Symfony/Component/Lock/Store/CombinedStore.php
@@ -19,15 +19,14 @@
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\PersistStoreInterface;
-use Symfony\Component\Lock\StoreInterface;
 use Symfony\Component\Lock\Strategy\StrategyInterface;
 
 /**
- * CombinedStore is a StoreInterface implementation able to manage and synchronize several StoreInterfaces.
+ * CombinedStore is a PersistStoreInterface implementation able to manage and synchronize several StoreInterfaces.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class CombinedStore implements StoreInterface, LoggerAwareInterface
+class CombinedStore implements PersistStoreInterface, LoggerAwareInterface
 {
     use LoggerAwareTrait;
     use ExpiringStoreTrait;
diff --git a/src/Symfony/Component/Lock/Store/FlockStore.php b/src/Symfony/Component/Lock/Store/FlockStore.php
@@ -16,10 +16,10 @@
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\LockStorageException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * FlockStore is a StoreInterface implementation using the FileSystem flock.
+ * FlockStore is a PersistStoreInterface implementation using the FileSystem flock.
  *
  * Original implementation in \Symfony\Component\Filesystem\LockHandler.
  *
@@ -28,7 +28,7 @@
  * @author Romain Neutron <imprec@gmail.com>
  * @author Nicolas Grekas <p@tchwork.com>
  */
-class FlockStore implements StoreInterface, BlockingStoreInterface
+class FlockStore implements PersistStoreInterface, BlockingStoreInterface
 {
     private $lockPath;
 
diff --git a/src/Symfony/Component/Lock/Store/MemcachedStore.php b/src/Symfony/Component/Lock/Store/MemcachedStore.php
@@ -15,14 +15,14 @@
 use Symfony\Component\Lock\Exception\InvalidTtlException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * MemcachedStore is a StoreInterface implementation using Memcached as store engine.
+ * MemcachedStore is a PersistStoreInterface implementation using Memcached as store engine.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class MemcachedStore implements StoreInterface
+class MemcachedStore implements PersistStoreInterface
 {
     use ExpiringStoreTrait;
 
diff --git a/src/Symfony/Component/Lock/Store/PdoStore.php b/src/Symfony/Component/Lock/Store/PdoStore.php
@@ -19,10 +19,10 @@
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * PdoStore is a StoreInterface implementation using a PDO connection.
+ * PdoStore is a PersistStoreInterface implementation using a PDO connection.
  *
  * Lock metadata are stored in a table. You can use createTable() to initialize
  * a correctly defined table.
@@ -34,7 +34,7 @@
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class PdoStore implements StoreInterface
+class PdoStore implements PersistStoreInterface
 {
     use ExpiringStoreTrait;
 
diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -17,14 +17,14 @@
 use Symfony\Component\Lock\Exception\InvalidTtlException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * RedisStore is a StoreInterface implementation using Redis as store engine.
+ * RedisStore is a PersistStoreInterface implementation using Redis as store engine.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class RedisStore implements StoreInterface
+class RedisStore implements PersistStoreInterface
 {
     use ExpiringStoreTrait;
 
diff --git a/src/Symfony/Component/Lock/Store/RetryTillSaveStore.php b/src/Symfony/Component/Lock/Store/RetryTillSaveStore.php
@@ -18,15 +18,14 @@
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\PersistStoreInterface;
-use Symfony\Component\Lock\StoreInterface;
 
 /**
- * RetryTillSaveStore is a StoreInterface implementation which decorate a non blocking StoreInterface to provide a
+ * RetryTillSaveStore is a PersistStoreInterface implementation which decorate a non blocking PersistStoreInterface to provide a
  * blocking storage.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class RetryTillSaveStore implements PersistStoreInterface, BlockingStoreInterface, StoreInterface, LoggerAwareInterface
+class RetryTillSaveStore implements PersistStoreInterface, BlockingStoreInterface, LoggerAwareInterface
 {
     use LoggerAwareTrait;
 
@@ -35,7 +34,7 @@ class RetryTillSaveStore implements PersistStoreInterface, BlockingStoreInterfac
     private $retryCount;
 
     /**
-     * @param PersistStoreInterface $decorated  The decorated StoreInterface
+     * @param PersistStoreInterface $decorated  The decorated PersistStoreInterface
      * @param int                   $retrySleep Duration in ms between 2 retry
      * @param int                   $retryCount Maximum amount of retry
      */
diff --git a/src/Symfony/Component/Lock/Store/SemaphoreStore.php b/src/Symfony/Component/Lock/Store/SemaphoreStore.php
@@ -15,14 +15,14 @@
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * SemaphoreStore is a StoreInterface implementation using Semaphore as store engine.
+ * SemaphoreStore is a PersistStoreInterface implementation using Semaphore as store engine.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class SemaphoreStore implements StoreInterface, BlockingStoreInterface
+class SemaphoreStore implements PersistStoreInterface, BlockingStoreInterface
 {
     /**
      * Returns whether or not the store is supported.
diff --git a/src/Symfony/Component/Lock/Store/StoreFactory.php b/src/Symfony/Component/Lock/Store/StoreFactory.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Cache\Traits\RedisClusterProxy;
 use Symfony\Component\Cache\Traits\RedisProxy;
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
  * StoreFactory create stores and connections.
@@ -27,7 +27,7 @@ class StoreFactory
     /**
      * @param \Redis|\RedisArray|\RedisCluster|\Predis\Client|\Memcached|\Zookeeper|string $connection Connection or DSN or Store short name
      *
-     * @return StoreInterface
+     * @return PersistStoreInterface
      */
     public static function createStore($connection)
     {
diff --git a/src/Symfony/Component/Lock/Store/ZookeeperStore.php b/src/Symfony/Component/Lock/Store/ZookeeperStore.php
@@ -16,14 +16,14 @@
 use Symfony\Component\Lock\Exception\LockReleasingException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
- * ZookeeperStore is a StoreInterface implementation using Zookeeper as store engine.
+ * ZookeeperStore is a PersistStoreInterface implementation using Zookeeper as store engine.
  *
  * @author Ganesh Chandrasekaran <gchandrasekaran@wayfair.com>
  */
-class ZookeeperStore implements StoreInterface
+class ZookeeperStore implements PersistStoreInterface
 {
     use ExpiringStoreTrait;
 
diff --git a/src/Symfony/Component/Lock/StoreInterface.php b/src/Symfony/Component/Lock/StoreInterface.php
diff --git a/src/Symfony/Component/Lock/Tests/FactoryTest.php b/src/Symfony/Component/Lock/Tests/FactoryTest.php
@@ -15,7 +15,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Lock\Factory;
 use Symfony\Component\Lock\LockInterface;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
  * @author Jérémy Derussé <jeremy@derusse.com>
@@ -24,7 +24,7 @@ class FactoryTest extends TestCase
 {
     public function testCreateLock()
     {
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
         $factory = new Factory($store);
         $factory->setLogger($logger);
diff --git a/src/Symfony/Component/Lock/Tests/LockFactoryTest.php b/src/Symfony/Component/Lock/Tests/LockFactoryTest.php
@@ -15,7 +15,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\LockInterface;
-use Symfony\Component\Lock\StoreInterface;
+use Symfony\Component\Lock\PersistStoreInterface;
 
 /**
  * @author Jérémy Derussé <jeremy@derusse.com>
@@ -24,7 +24,7 @@ class LockFactoryTest extends TestCase
 {
     public function testCreateLock()
     {
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
         $factory = new LockFactory($store);
         $factory->setLogger($logger);
diff --git a/src/Symfony/Component/Lock/Tests/LockTest.php b/src/Symfony/Component/Lock/Tests/LockTest.php
@@ -18,7 +18,6 @@
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\Lock;
 use Symfony\Component\Lock\PersistStoreInterface;
-use Symfony\Component\Lock\StoreInterface;
 
 /**
  * @author Jérémy Derussé <jeremy@derusse.com>
@@ -41,7 +40,7 @@ public function testAcquireNoBlocking()
     public function testAcquireNoBlockingStoreInterface()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store);
 
         $store
@@ -59,7 +58,7 @@ public function testAcquireNoBlockingStoreInterface()
     public function testPassingOldStoreInterface()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store);
 
         $store
@@ -86,7 +85,7 @@ public function testAcquireReturnsFalse()
     public function testAcquireReturnsFalseStoreInterface()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store);
 
         $store
@@ -121,7 +120,7 @@ public function testAcquireBlocking()
     public function testAcquireSetsTtl()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store, 10);
 
         $store
@@ -138,7 +137,7 @@ public function testAcquireSetsTtl()
     public function testRefresh()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store, 10);
 
         $store
@@ -152,7 +151,7 @@ public function testRefresh()
     public function testRefreshCustom()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store, 10);
 
         $store
@@ -201,7 +200,7 @@ public function testRelease()
     public function testReleaseStoreInterface()
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store, 10);
 
         $store
@@ -356,7 +355,7 @@ public function testExpiration($ttls, $expected)
     public function testExpirationStoreInterface($ttls, $expected)
     {
         $key = new Key(uniqid(__METHOD__, true));
-        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $store = $this->getMockBuilder(PersistStoreInterface::class)->getMock();
         $lock = new Lock($key, $store, 10);
 
         foreach ($ttls as $ttl) {
diff --git a/src/Symfony/Component/Lock/Tests/Store/AbstractStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/AbstractStoreTest.php
diff --git a/src/Symfony/Component/Lock/Tests/Store/BlockingStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/BlockingStoreTestTrait.php
diff --git a/src/Symfony/Component/Lock/Tests/Store/CombinedStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/CombinedStoreTest.php
diff --git a/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class Factory implements LoggerAwareInterface`
`28`	`28`
`29`	`29`	`private $store;`
`30`	`30`
`31`		`- public function __construct(StoreInterface $store)`
	`31`	`+ public function __construct(PersistStoreInterface $store)`
`32`	`32`	`{`
`33`	`33`	`$this->store = $store;`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public function acquire($blocking = false): ?bool`
`71`	`71`	`{`
`72`	`72`	`try {`
`73`	`73`	`if ($blocking) {`
`74`		`- if (!$this->store instanceof StoreInterface && !($this->store instanceof BlockingStoreInterface && $this->store->supportsWaitAndSave())) {`
	`74`	`+ if (!($this->store instanceof BlockingStoreInterface && $this->store->supportsWaitAndSave())) {`
`75`	`75`	`throw new NotSupportedException(sprintf('The store "%s" does not support blocking locks.', \get_class($this->store)));`
`76`	`76`	`}`
`77`	`77`	`$this->store->waitAndSave($this->key);`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,10 @@`
`16`	`16`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`17`	`17`	`use Symfony\Component\Lock\Exception\LockStorageException;`
`18`	`18`	`use Symfony\Component\Lock\Key;`
`19`		`-use Symfony\Component\Lock\StoreInterface;`
	`19`	`+use Symfony\Component\Lock\PersistStoreInterface;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * FlockStore is a StoreInterface implementation using the FileSystem flock.`
	`22`	`+ * FlockStore is a PersistStoreInterface implementation using the FileSystem flock.`
`23`	`23`	`*`
`24`	`24`	`* Original implementation in \Symfony\Component\Filesystem\LockHandler.`
`25`	`25`	`*`
`@@ -28,7 +28,7 @@`
`28`	`28`	`* @author Romain Neutron <imprec@gmail.com>`
`29`	`29`	`* @author Nicolas Grekas <p@tchwork.com>`
`30`	`30`	`*/`
`31`		`-class FlockStore implements StoreInterface, BlockingStoreInterface`
	`31`	`+class FlockStore implements PersistStoreInterface, BlockingStoreInterface`
`32`	`32`	`{`
`33`	`33`	`private $lockPath;`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@`
`19`	`19`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`20`	`20`	`use Symfony\Component\Lock\Exception\NotSupportedException;`
`21`	`21`	`use Symfony\Component\Lock\Key;`
`22`		`-use Symfony\Component\Lock\StoreInterface;`
	`22`	`+use Symfony\Component\Lock\PersistStoreInterface;`
`23`	`23`
`24`	`24`	`/**`
`25`		`- * PdoStore is a StoreInterface implementation using a PDO connection.`
	`25`	`+ * PdoStore is a PersistStoreInterface implementation using a PDO connection.`
`26`	`26`	`*`
`27`	`27`	`* Lock metadata are stored in a table. You can use createTable() to initialize`
`28`	`28`	`* a correctly defined table.`
`@@ -34,7 +34,7 @@`
`34`	`34`	`*`
`35`	`35`	`* @author Jérémy Derussé <jeremy@derusse.com>`
`36`	`36`	`*/`
`37`		`-class PdoStore implements StoreInterface`
	`37`	`+class PdoStore implements PersistStoreInterface`
`38`	`38`	`{`
`39`	`39`	`use ExpiringStoreTrait;`
`40`	`40`