minor #32492 [Lock] feature: lock split interface fix post-merge review (Simperfit)

nicolas-grekas · nicolas-grekas · commit e80d4057f998 · 2019-07-18T15:47:02.000+02:00
This PR was squashed before being merged into the 4.4 branch (closes #32492). Discussion ---------- [Lock] feature: lock split interface fix post-merge review | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yesish  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | none  | License | MIT | Doc PR | none   see #32198 (review) Commits ------- 8173c47 [Lock] feature: lock split interface fix post-merge review
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -105,7 +105,7 @@ Lock
 ----
 
  * Deprecated `Symfony\Component\Lock\StoreInterface` in favor of `Symfony\Component\Lock\BlockingStoreInterface` and
-   `Symfony\Component\Lock\PersistStoreInterface`.
+   `Symfony\Component\Lock\PersistingStoreInterface`.
  * `Factory` is deprecated, use `LockFactory` instead
 
 Messenger
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -311,7 +311,7 @@ Lock
 ----
 
  * Removed `Symfony\Component\Lock\StoreInterface` in favor of `Symfony\Component\Lock\BlockingStoreInterface` and
-   `Symfony\Component\Lock\PersistStoreInterface`.
+   `Symfony\Component\Lock\PersistingStoreInterface`.
  * Removed `Factory`, use `LockFactory` instead
 
 Messenger
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -73,7 +73,7 @@
 use Symfony\Component\Lock\Lock;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\LockInterface;
-use Symfony\Component\Lock\PersistStoreInterface;
+use Symfony\Component\Lock\PersistingStoreInterface;
 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\StoreFactory;
 use Symfony\Component\Lock\StoreInterface;
@@ -1606,7 +1606,7 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
                             $container->setDefinition($connectionDefinitionId, $connectionDefinition);
                         }
 
-                        $storeDefinition = new Definition(PersistStoreInterface::class);
+                        $storeDefinition = new Definition(PersistingStoreInterface::class);
                         $storeDefinition->setPublic(false);
                         $storeDefinition->setFactory([StoreFactory::class, 'createStore']);
                         $storeDefinition->setArguments([new Reference($connectionDefinitionId)]);
@@ -1649,13 +1649,13 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
                 $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(PersistingStoreInterface::class, new Alias('lock.store', false));
                 $container->setAlias(Factory::class, new Alias('lock.factory', false));
                 $container->setAlias(LockFactory::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.'.store', PersistingStoreInterface::class, $resourceName.'.lock.store');
                 $container->registerAliasForArgument('lock.'.$resourceName.'.factory', Factory::class, $resourceName.'.lock.factory');
                 $container->registerAliasForArgument('lock.'.$resourceName.'.factory', LockFactory::class, $resourceName.'.lock.factory');
                 $container->registerAliasForArgument('lock.'.$resourceName, LockInterface::class, $resourceName.'.lock');
diff --git a/src/Symfony/Component/Lock/BlockingStoreInterface.php b/src/Symfony/Component/Lock/BlockingStoreInterface.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Lock;
 
 use Symfony\Component\Lock\Exception\LockConflictedException;
-use Symfony\Component\Lock\Exception\NotSupportedException;
 
 /**
  * @author Hamza Amrouche <hamza.simperfit@gmail.com>
@@ -22,15 +21,7 @@ interface BlockingStoreInterface
     /**
      * Waits until a key becomes free, then stores the resource.
      *
-     * If the store does not support this feature it should throw a NotSupportedException.
-     *
      * @throws LockConflictedException
-     * @throws NotSupportedException
      */
     public function waitAndSave(Key $key);
-
-    /**
-     * Checks if the store can wait until a key becomes free before storing the resource.
-     */
-    public function supportsWaitAndSave(): bool;
 }
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -5,7 +5,7 @@ CHANGELOG
 -----
 
  * added InvalidTtlException  
- * deprecated `Symfony\Component\Lock\StoreInterface` in favor of `Symfony\Component\Lock\BlockingStoreInterface` and `Symfony\Component\Lock\PersistStoreInterface`
+ * deprecated `StoreInterface` in favor of `BlockingStoreInterface` and `PersistingStoreInterface`
    
 4.2.0
 -----
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -37,12 +37,12 @@ final class Lock implements LockInterface, LoggerAwareInterface
     private $dirty = false;
 
     /**
-     * @param Key                   $key         Resource to lock
-     * @param PersistStoreInterface $store       Store used to handle lock persistence
-     * @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
+     * @param Key                      $key         Resource to lock
+     * @param PersistingStoreInterface $store       Store used to handle lock persistence
+     * @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 __construct(Key $key, PersistStoreInterface $store, float $ttl = null, bool $autoRelease = true)
+    public function __construct(Key $key, PersistingStoreInterface $store, float $ttl = null, bool $autoRelease = true)
     {
         $this->store = $store;
         $this->key = $key;
@@ -71,7 +71,7 @@ public function acquire($blocking = false)
     {
         try {
             if ($blocking) {
-                if (!$this->store instanceof StoreInterface && !($this->store instanceof BlockingStoreInterface && $this->store->supportsWaitAndSave())) {
+                if (!$this->store instanceof StoreInterface && !$this->store instanceof BlockingStoreInterface) {
                     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/PersistingStoreInterface.php b/src/Symfony/Component/Lock/PersistingStoreInterface.php
@@ -18,7 +18,7 @@
 /**
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-interface PersistStoreInterface
+interface PersistingStoreInterface
 {
     /**
      * Stores the resource if it's not locked by someone else.
diff --git a/src/Symfony/Component/Lock/Store/CombinedStore.php b/src/Symfony/Component/Lock/Store/CombinedStore.php
@@ -18,7 +18,7 @@
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\PersistStoreInterface;
+use Symfony\Component\Lock\PersistingStoreInterface;
 use Symfony\Component\Lock\StoreInterface;
 use Symfony\Component\Lock\Strategy\StrategyInterface;
 
@@ -32,22 +32,22 @@ class CombinedStore implements StoreInterface, LoggerAwareInterface
     use LoggerAwareTrait;
     use ExpiringStoreTrait;
 
-    /** @var PersistStoreInterface[] */
+    /** @var PersistingStoreInterface[] */
     private $stores;
     /** @var StrategyInterface */
     private $strategy;
 
     /**
-     * @param PersistStoreInterface[] $stores   The list of synchronized stores
-     * @param StrategyInterface       $strategy
+     * @param PersistingStoreInterface[] $stores   The list of synchronized stores
+     * @param StrategyInterface          $strategy
      *
      * @throws InvalidArgumentException
      */
     public function __construct(array $stores, StrategyInterface $strategy)
     {
         foreach ($stores as $store) {
-            if (!$store instanceof PersistStoreInterface) {
-                throw new InvalidArgumentException(sprintf('The store must implement "%s". Got "%s".', PersistStoreInterface::class, \get_class($store)));
+            if (!$store instanceof PersistingStoreInterface) {
+                throw new InvalidArgumentException(sprintf('The store must implement "%s". Got "%s".', PersistingStoreInterface::class, \get_class($store)));
             }
         }
 
@@ -95,6 +95,8 @@ public function save(Key $key)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated since Symfony 4.4.
      */
     public function waitAndSave(Key $key)
     {
@@ -186,12 +188,4 @@ public function exists(Key $key)
 
         return false;
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function supportsWaitAndSave(): bool
-    {
-        return false;
-    }
 }
diff --git a/src/Symfony/Component/Lock/Store/FlockStore.php b/src/Symfony/Component/Lock/Store/FlockStore.php
@@ -65,14 +65,6 @@ public function waitAndSave(Key $key)
         $this->lock($key, true);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function supportsWaitAndSave(): bool
-    {
-        return true;
-    }
-
     private function lock(Key $key, $blocking)
     {
         // The lock is maybe already acquired.
diff --git a/src/Symfony/Component/Lock/Store/MemcachedStore.php b/src/Symfony/Component/Lock/Store/MemcachedStore.php
@@ -71,10 +71,12 @@ public function save(Key $key)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated since Symfony 4.4.
      */
     public function waitAndSave(Key $key)
     {
-        @trigger_error(sprintf('%s() is deprecated since Symfony 4.4 and will be removed in Symfony 5.0.', __METHOD__));
+        @trigger_error(sprintf('%s() is deprecated since Symfony 4.4 and will be removed in Symfony 5.0.', __METHOD__), E_USER_DEPRECATED);
         throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks.', \get_class($this)));
     }
 
diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -74,6 +74,8 @@ public function save(Key $key)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated since Symfony 4.4.
      */
     public function waitAndSave(Key $key)
     {
diff --git a/src/Symfony/Component/Lock/Store/RetryTillSaveStore.php b/src/Symfony/Component/Lock/Store/RetryTillSaveStore.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Lock\BlockingStoreInterface;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
-use Symfony\Component\Lock\PersistStoreInterface;
+use Symfony\Component\Lock\PersistingStoreInterface;
 use Symfony\Component\Lock\StoreInterface;
 
 /**
@@ -26,7 +26,7 @@
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  */
-class RetryTillSaveStore implements PersistStoreInterface, BlockingStoreInterface, StoreInterface, LoggerAwareInterface
+class RetryTillSaveStore implements PersistingStoreInterface, BlockingStoreInterface, StoreInterface, LoggerAwareInterface
 {
     use LoggerAwareTrait;
 
@@ -35,11 +35,11 @@ class RetryTillSaveStore implements PersistStoreInterface, BlockingStoreInterfac
     private $retryCount;
 
     /**
-     * @param PersistStoreInterface $decorated  The decorated StoreInterface
-     * @param int                   $retrySleep Duration in ms between 2 retry
-     * @param int                   $retryCount Maximum amount of retry
+     * @param PersistingStoreInterface $decorated  The decorated StoreInterface
+     * @param int                      $retrySleep Duration in ms between 2 retry
+     * @param int                      $retryCount Maximum amount of retry
      */
-    public function __construct(PersistStoreInterface $decorated, int $retrySleep = 100, int $retryCount = PHP_INT_MAX)
+    public function __construct(PersistingStoreInterface $decorated, int $retrySleep = 100, int $retryCount = PHP_INT_MAX)
     {
         $this->decorated = $decorated;
         $this->retrySleep = $retrySleep;
@@ -101,12 +101,4 @@ public function exists(Key $key)
     {
         return $this->decorated->exists($key);
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function supportsWaitAndSave(): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Symfony/Component/Lock/Store/SemaphoreStore.php b/src/Symfony/Component/Lock/Store/SemaphoreStore.php
@@ -113,12 +113,4 @@ public function exists(Key $key)
     {
         return $key->hasState(__CLASS__);
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function supportsWaitAndSave(): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Symfony/Component/Lock/Store/ZookeeperStore.php b/src/Symfony/Component/Lock/Store/ZookeeperStore.php
@@ -84,6 +84,8 @@ public function exists(Key $key): bool
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated since Symfony 4.4.
      */
     public function waitAndSave(Key $key)
     {
diff --git a/src/Symfony/Component/Lock/StoreInterface.php b/src/Symfony/Component/Lock/StoreInterface.php
@@ -19,9 +19,9 @@
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
  *
- * @deprecated "Symfony\Component\Lock\StoreInterface" is deprecated since Symfony 4.4 and has been split into "Symfony\Component\Lock\PersistStoreInterface", "Symfony\Component\Lock\BlockingStoreInterface".'
+ * @deprecated since Symfony 4.4, use PersistingStoreInterface and BlockingStoreInterface instead
  */
-interface StoreInterface extends PersistStoreInterface
+interface StoreInterface extends PersistingStoreInterface
 {
     /**
      * Waits until a key becomes free, then stores the resource.
diff --git a/src/Symfony/Component/Lock/Tests/LockTest.php b/src/Symfony/Component/Lock/Tests/LockTest.php
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

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`/**`
`19`	`19`	`* @author Jérémy Derussé <jeremy@derusse.com>`
`20`	`20`	`*/`
`21`		`-interface PersistStoreInterface`
	`21`	`+interface PersistingStoreInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* Stores the resource if it's not locked by someone else.`
Original file line number	Diff line number	Diff line change
`@@ -65,14 +65,6 @@ public function waitAndSave(Key $key)`
`65`	`65`	`$this->lock($key, true);`
`66`	`66`	`}`
`67`	`67`
`68`		`- /**`
`69`		`- * {@inheritdoc}`
`70`		`- */`
`71`		`- public function supportsWaitAndSave(): bool`
`72`		`- {`
`73`		`- return true;`
`74`		`- }`
`75`		`-`
`76`	`68`	`private function lock(Key $key, $blocking)`
`77`	`69`	`{`
`78`	`70`	`// The lock is maybe already acquired.`
Original file line number	Diff line number	Diff line change
`@@ -71,10 +71,12 @@ public function save(Key $key)`
`71`	`71`
`72`	`72`	`/**`
`73`	`73`	`* {@inheritdoc}`
	`74`	`+ *`
	`75`	`+ * @deprecated since Symfony 4.4.`
`74`	`76`	`*/`
`75`	`77`	`public function waitAndSave(Key $key)`
`76`	`78`	`{`
`77`		`- @trigger_error(sprintf('%s() is deprecated since Symfony 4.4 and will be removed in Symfony 5.0.', __METHOD__));`
	`79`	`+ @trigger_error(sprintf('%s() is deprecated since Symfony 4.4 and will be removed in Symfony 5.0.', __METHOD__), E_USER_DEPRECATED);`
`78`	`80`	`throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks.', \get_class($this)));`
`79`	`81`	`}`
`80`	`82`