Automaticaly release lock on destruction

jderusse · jderusse · commit 309a6c1216f1 · 2017-03-23T22:55:25.000+01:00
diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -37,7 +37,7 @@ 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
+     * @param float  $ttl      Maximum expected lock duration in seconds
      *
      * @return Lock
      */
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -33,9 +33,9 @@ final class Lock implements LockInterface, LoggerAwareInterface
     private $ttl;
 
     /**
-     * @param Key            $key
-     * @param StoreInterface $store
-     * @param float|null     $ttl
+     * @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
      */
     public function __construct(Key $key, StoreInterface $store, $ttl = null)
     {
@@ -46,6 +46,20 @@ public function __construct(Key $key, StoreInterface $store, $ttl = null)
         $this->logger = new NullLogger();
     }
 
+    /**
+     * Automatically release the underlying lock when the object is destructed.
+     */
+    public function __destruct()
+    {
+        try {
+            if ($this->isAcquired()) {
+                $this->release();
+            }
+        } catch (\Throwable $e) {
+        } catch (\Exception $e) {
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
diff --git a/src/Symfony/Component/Lock/Store/SemaphoreStore.php b/src/Symfony/Component/Lock/Store/SemaphoreStore.php
@@ -99,7 +99,7 @@ public function delete(Key $key)
      */
     public function putOffExpiration(Key $key, $ttl)
     {
-        // do nothing, the flock locks forever.
+        // do nothing, the semaphore locks forever.
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/Tests/LockTest.php b/src/Symfony/Component/Lock/Tests/LockTest.php
@@ -103,7 +103,7 @@ public function testIsAquired()
         $lock = new Lock($key, $store, 10);
 
         $store
-            ->expects($this->once())
+            ->expects($this->atLeast(1))
             ->method('exists')
             ->with($key)
             ->willReturn(true);
@@ -123,14 +123,31 @@ public function testRelease()
             ->with($key);
 
         $store
-            ->expects($this->once())
+            ->expects($this->atLeast(1))
             ->method('exists')
             ->with($key)
             ->willReturn(false);
 
         $lock->release();
     }
 
+    public function testReleaseOnDestruction()
+    {
+        $key = new Key(uniqid(__METHOD__, true));
+        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $lock = new Lock($key, $store, 10);
+
+        $store
+            ->method('exists')
+            ->willReturnOnConsecutiveCalls(array(true, false))
+        ;
+        $store
+            ->expects($this->once())
+            ->method('delete')
+        ;
+        unset($lock);
+    }
+
     /**
      * @expectedException \Symfony\Component\Lock\Exception\LockReleasingException
      */
@@ -141,12 +158,12 @@ public function testReleaseThrowsExceptionIfNotWellDeleted()
         $lock = new Lock($key, $store, 10);
 
         $store
-            ->expects($this->once())
+            ->expects($this->atLeast(1))
             ->method('delete')
             ->with($key);
 
         $store
-            ->expects($this->once())
+            ->expects($this->atLeast(1))
             ->method('exists')
             ->with($key)
             ->willReturn(true);

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct(StoreInterface $store)`
`37`	`37`	`* Creates a lock for the given resource.`
`38`	`38`	`*`
`39`	`39`	`* @param string $resource The resource to lock`
`40`		`- * @param float $ttl maximum expected lock duration`
	`40`	`+ * @param float $ttl Maximum expected lock duration in seconds`
`41`	`41`	`*`
`42`	`42`	`* @return Lock`
`43`	`43`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public function delete(Key $key)`
`99`	`99`	`*/`
`100`	`100`	`public function putOffExpiration(Key $key, $ttl)`
`101`	`101`	`{`
`102`		`- // do nothing, the flock locks forever.`
	`102`	`+ // do nothing, the semaphore locks forever.`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`/**`