Create new NotExpirableStoreException for stores that don't support expiration of locks.

GaneshChandrasekaran-zz · GaneshChandrasekaran-zz · commit a5b504bcc083 · 2018-10-04T22:09:20.000+05:30
diff --git a/src/Symfony/Component/Console/Command/LockableTrait.php b/src/Symfony/Component/Console/Command/LockableTrait.php
@@ -48,7 +48,7 @@ private function lock($name = null, $blocking = false)
             $store = new FlockStore();
         }
 
-        $this->lock = (new Factory($store))->createLock($name ?: $this->getName());
+        $this->lock = (new Factory($store))->createLock($name ?: $this->getName(), null);
         if (!$this->lock->acquire($blocking)) {
             $this->lock = null;
 
diff --git a/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php b/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php
@@ -47,7 +47,7 @@ public function testLockReturnsFalseIfAlreadyLockedByAnotherCommand()
             $store = new FlockStore();
         }
 
-        $lock = (new Factory($store))->createLock($command->getName());
+        $lock = (new Factory($store))->createLock($command->getName(), null);
         $lock->acquire();
 
         $tester = new CommandTester($command);
diff --git a/src/Symfony/Component/Lock/Exception/NotExpirableStoreException.php b/src/Symfony/Component/Lock/Exception/NotExpirableStoreException.php
@@ -0,0 +1,21 @@
+<?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\Exception;
+
+/**
+ * NotExpirableStoreException is thrown when a store doesn't support expiration of locks.
+ *
+ * @author Ganesh Chandrasekaran <gchandrasekaran@wayfair.com>
+ */
+class NotExpirableStoreException extends \LogicException implements ExceptionInterface
+{
+}
diff --git a/src/Symfony/Component/Lock/Store/CombinedStore.php b/src/Symfony/Component/Lock/Store/CombinedStore.php
@@ -17,6 +17,7 @@
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\LockExpiredException;
+use Symfony\Component\Lock\Exception\NotExpirableStoreException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
@@ -102,6 +103,7 @@ public function putOffExpiration(Key $key, $ttl)
     {
         $successCount = 0;
         $failureCount = 0;
+        $notExpirableStoresCount = 0;
         $storesCount = \count($this->stores);
         $expireAt = microtime(true) + $ttl;
 
@@ -115,6 +117,9 @@ public function putOffExpiration(Key $key, $ttl)
 
                 $store->putOffExpiration($key, $adjustedTtl);
                 ++$successCount;
+            } catch (NotExpirableStoreException $e) {
+                $this->logger->notice('This store does not support expiration of locks.', $store);
+                ++$notExpirableStoresCount;
             } catch (\Exception $e) {
                 $this->logger->warning('One store failed to put off the expiration of the "{resource}" lock.', array('resource' => $key, 'store' => $store, 'exception' => $e));
                 ++$failureCount;
@@ -125,6 +130,10 @@ public function putOffExpiration(Key $key, $ttl)
             }
         }
 
+        if ($notExpirableStoresCount === $storesCount) {
+            throw new NotExpirableStoreException();
+        }
+
         if ($key->isExpired()) {
             throw new LockExpiredException(sprintf('Failed to put off the expiration of the "%s" lock within the specified time.', $key));
         }
diff --git a/src/Symfony/Component/Lock/Store/FlockStore.php b/src/Symfony/Component/Lock/Store/FlockStore.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\LockStorageException;
+use Symfony\Component\Lock\Exception\NotExpirableStoreException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
 
@@ -108,7 +109,7 @@ private function lock(Key $key, $blocking)
      */
     public function putOffExpiration(Key $key, $ttl)
     {
-        // do nothing, the flock locks forever.
+        throw new NotExpirableStoreException();
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/Store/SemaphoreStore.php b/src/Symfony/Component/Lock/Store/SemaphoreStore.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
+use Symfony\Component\Lock\Exception\NotExpirableStoreException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
 
@@ -102,7 +103,7 @@ public function delete(Key $key)
      */
     public function putOffExpiration(Key $key, $ttl)
     {
-        // do nothing, the semaphore locks forever.
+        throw new NotExpirableStoreException();
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/Store/ZookeeperStore.php b/src/Symfony/Component/Lock/Store/ZookeeperStore.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Lock\Exception\LockAcquiringException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\LockReleasingException;
+use Symfony\Component\Lock\Exception\NotExpirableStoreException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
@@ -91,7 +92,7 @@ public function waitAndSave(Key $key)
      */
     public function putOffExpiration(Key $key, $ttl)
     {
-        throw new NotSupportedException();
+        throw new NotExpirableStoreException();
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/StoreInterface.php b/src/Symfony/Component/Lock/StoreInterface.php
@@ -49,6 +49,7 @@ public function waitAndSave(Key $key);
      * @param float $ttl amount of second to keep the lock in the store
      *
      * @throws LockConflictedException
+     * @throws NotExpirableStoreException
      * @throws NotSupportedException
      */
     public function putOffExpiration(Key $key, $ttl);
diff --git a/src/Symfony/Component/Lock/Tests/Store/FlockStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/FlockStoreTest.php
@@ -20,6 +20,7 @@
 class FlockStoreTest extends AbstractStoreTest
 {
     use BlockingStoreTestTrait;
+    use NotExpiringStoreTestTrait;
 
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Component/Lock/Tests/Store/NotExpiringStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/NotExpiringStoreTestTrait.php
@@ -0,0 +1,37 @@
+<?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\Store;
+
+use Symfony\Component\Lock\Key;
+
+/**
+ * @author Ganesh Chandrasekaran <gchandrasekaran@wayfair.com>
+ */
+trait NotExpiringStoreTestTrait
+{
+    /**
+     * @see AbstractStoreTest::getStore()
+     */
+    abstract protected function getStore();
+
+    /**
+     * @expectedException \Symfony\Component\Lock\Exception\NotExpirableStoreException
+     */
+    public function testPutOffExpirationThrowsException()
+    {
+        $store = $this->getStore();
+        $key = new Key(uniqid(__METHOD__, true));
+
+        $store->save($key);
+        $store->putOffExpiration($key, 10.0);
+    }
+}
diff --git a/src/Symfony/Component/Lock/Tests/Store/SemaphoreStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/SemaphoreStoreTest.php
@@ -22,6 +22,7 @@
 class SemaphoreStoreTest extends AbstractStoreTest
 {
     use BlockingStoreTestTrait;
+    use NotExpiringStoreTestTrait;
 
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Component/Lock/Tests/Store/ZookeeperStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/ZookeeperStoreTest.php
@@ -22,6 +22,8 @@
  */
 class ZookeeperStoreTest extends AbstractStoreTest
 {
+    use NotExpiringStoreTestTrait;
+
     public function getStore(): ZookeeperStore
     {
         $zookeeper_server = getenv('ZOOKEEPER_HOST').':2181';

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ private function lock($name = null, $blocking = false)`
`48`	`48`	`$store = new FlockStore();`
`49`	`49`	`}`
`50`	`50`
`51`		`- $this->lock = (new Factory($store))->createLock($name ?: $this->getName());`
	`51`	`+ $this->lock = (new Factory($store))->createLock($name ?: $this->getName(), null);`
`52`	`52`	`if (!$this->lock->acquire($blocking)) {`
`53`	`53`	`$this->lock = null;`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function testLockReturnsFalseIfAlreadyLockedByAnotherCommand()`
`47`	`47`	`$store = new FlockStore();`
`48`	`48`	`}`
`49`	`49`
`50`		`- $lock = (new Factory($store))->createLock($command->getName());`
	`50`	`+ $lock = (new Factory($store))->createLock($command->getName(), null);`
`51`	`51`	`$lock->acquire();`
`52`	`52`
`53`	`53`	`$tester = new CommandTester($command);`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Symfony\Component\Lock\Exception\InvalidArgumentException;`
`15`	`15`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`16`	`16`	`use Symfony\Component\Lock\Exception\LockStorageException;`
	`17`	`+use Symfony\Component\Lock\Exception\NotExpirableStoreException;`
`17`	`18`	`use Symfony\Component\Lock\Key;`
`18`	`19`	`use Symfony\Component\Lock\StoreInterface;`
`19`	`20`
`@@ -108,7 +109,7 @@ private function lock(Key $key, $blocking)`
`108`	`109`	`*/`
`109`	`110`	`public function putOffExpiration(Key $key, $ttl)`
`110`	`111`	`{`
`111`		`- // do nothing, the flock locks forever.`
	`112`	`+ throw new NotExpirableStoreException();`
`112`	`113`	`}`
`113`	`114`
`114`	`115`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Lock\Exception\InvalidArgumentException;`
`15`	`15`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
	`16`	`+use Symfony\Component\Lock\Exception\NotExpirableStoreException;`
`16`	`17`	`use Symfony\Component\Lock\Key;`
`17`	`18`	`use Symfony\Component\Lock\StoreInterface;`
`18`	`19`
`@@ -102,7 +103,7 @@ public function delete(Key $key)`
`102`	`103`	`*/`
`103`	`104`	`public function putOffExpiration(Key $key, $ttl)`
`104`	`105`	`{`
`105`		`- // do nothing, the semaphore locks forever.`
	`106`	`+ throw new NotExpirableStoreException();`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ public function waitAndSave(Key $key);`
`49`	`49`	`* @param float $ttl amount of second to keep the lock in the store`
`50`	`50`	`*`
`51`	`51`	`* @throws LockConflictedException`
	`52`	`+ * @throws NotExpirableStoreException`
`52`	`53`	`* @throws NotSupportedException`
`53`	`54`	`*/`
`54`	`55`	`public function putOffExpiration(Key $key, $ttl);`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`class FlockStoreTest extends AbstractStoreTest`
`21`	`21`	`{`
`22`	`22`	`use BlockingStoreTestTrait;`
	`23`	`+ use NotExpiringStoreTestTrait;`
`23`	`24`
`24`	`25`	`/**`
`25`	`26`	`* {@inheritdoc}`