Configurable autorelease

jderusse · jderusse · commit 70a01ac2aa3e · 2017-09-28T12:45:44.000+02:00
diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -36,14 +36,15 @@ public function __construct(StoreInterface $store)
     /**
      * Creates a lock for the given resource.
      *
-     * @param string $resource The resource to lock
-     * @param float  $ttl      Maximum expected lock duration in seconds
+     * @param string $resource    The resource to lock
+     * @param float  $ttl         Maximum expected lock duration in seconds
+     * @param bool   $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed
      *
      * @return Lock
      */
-    public function createLock($resource, $ttl = 300.0)
+    public function createLock($resource, $ttl = 300.0, $autoRelease = true)
     {
-        $lock = new Lock(new Key($resource), $this->store, $ttl);
+        $lock = new Lock(new Key($resource), $this->store, $ttl, $autoRelease);
         $lock->setLogger($this->logger);
 
         return $lock;
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -32,34 +32,35 @@ final class Lock implements LockInterface, LoggerAwareInterface
     private $store;
     private $key;
     private $ttl;
+    private $autoRelease;
     private $dirty = false;
 
     /**
-     * @param Key            $key   Resource to lock
-     * @param StoreInterface $store Store used to handle lock persistence
-     * @param float|null     $ttl   Maximum expected lock duration in seconds
+     * @param Key            $key         Resource to lock
+     * @param StoreInterface $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, StoreInterface $store, $ttl = null)
+    public function __construct(Key $key, StoreInterface $store, $ttl = null, $autoRelease = true)
     {
         $this->store = $store;
         $this->key = $key;
         $this->ttl = $ttl;
+        $this->autoRelease = (bool) $autoRelease;
 
         $this->logger = new NullLogger();
     }
 
     /**
-     * Automatically release the underlying lock when the object is destructed.
+     * Automatically releases the underlying lock when the object is destructed.
      */
     public function __destruct()
     {
-        try {
-            if ($this->dirty && $this->isAcquired()) {
-                $this->release();
-            }
-        } catch (\Throwable $e) {
-        } catch (\Exception $e) {
+        if (!$this->autoRelease || !$this->dirty || !$this->isAcquired()) {
+            return;
         }
+
+        $this->release();
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/Tests/LockTest.php b/src/Symfony/Component/Lock/Tests/LockTest.php
@@ -106,7 +106,7 @@ public function testIsAquired()
             ->expects($this->any())
             ->method('exists')
             ->with($key)
-            ->willReturn(true);
+            ->will($this->onConsecutiveCalls(true, false));
 
         $this->assertTrue($lock->isAcquired());
     }
@@ -150,6 +150,25 @@ public function testReleaseOnDestruction()
         unset($lock);
     }
 
+    public function testNoAutoReleaseWhenNotConfigured()
+    {
+        $key = new Key(uniqid(__METHOD__, true));
+        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $lock = new Lock($key, $store, 10, false);
+
+        $store
+            ->method('exists')
+            ->willReturnOnConsecutiveCalls(array(true, false))
+        ;
+        $store
+            ->expects($this->never())
+            ->method('delete')
+        ;
+
+        $lock->acquire(false);
+        unset($lock);
+    }
+
     /**
      * @expectedException \Symfony\Component\Lock\Exception\LockReleasingException
      */

Original file line number	Diff line number	Diff line change
`@@ -36,14 +36,15 @@ public function __construct(StoreInterface $store)`
`36`	`36`	`/**`
`37`	`37`	`* Creates a lock for the given resource.`
`38`	`38`	`*`
`39`		`- * @param string $resource The resource to lock`
`40`		`- * @param float $ttl Maximum expected lock duration in seconds`
	`39`	`+ * @param string $resource The resource to lock`
	`40`	`+ * @param float $ttl Maximum expected lock duration in seconds`
	`41`	`+ * @param bool $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed`
`41`	`42`	`*`
`42`	`43`	`* @return Lock`
`43`	`44`	`*/`
`44`		`- public function createLock($resource, $ttl = 300.0)`
	`45`	`+ public function createLock($resource, $ttl = 300.0, $autoRelease = true)`
`45`	`46`	`{`
`46`		`- $lock = new Lock(new Key($resource), $this->store, $ttl);`
	`47`	`+ $lock = new Lock(new Key($resource), $this->store, $ttl, $autoRelease);`
`47`	`48`	`$lock->setLogger($this->logger);`
`48`	`49`
`49`	`50`	`return $lock;`