Merge pull request #48 from php-lock/issue-47

#47 fix edge case where the lock is acquired during the deadline

Author: Willem Stuursma-Ruwen

classes/util/Loop.php

@@ -39,7 +39,7 @@ class Loop
     /**
      * @var bool True while code execution is repeating.
      */
-    private $looping;
+    private $looping = false;
 
     /**
      * Sets the timeout. The default is 3 seconds.
@@ -57,7 +57,6 @@ public function __construct(int $timeout = 3)
         }
 
         $this->timeout = $timeout;
-        $this->looping = false;
     }
 
     /**
@@ -98,7 +97,10 @@ public function execute(callable $code)
         for ($i = 0; $this->looping && microtime(true) < $deadline; ++$i) {
             $result = $code();
             if (!$this->looping) { // @phpstan-ignore-line
-                break;
+                /*
+                 * The $code callback has called $this->end() and the lock has been acquired.
+                 */
+                return $result;
             }
 
             // Calculate max time remaining, don't sleep any longer than that.
@@ -120,10 +122,6 @@ public function execute(callable $code)
             usleep($usecToSleep);
         }
 
-        if (microtime(true) >= $deadline) {
-            throw TimeoutException::create($this->timeout);
-        }
-
-        return $result;
+        throw TimeoutException::create($this->timeout);
     }
 }

tests/mutex/MutexConcurrencyTest.php

@@ -3,6 +3,7 @@
 namespace malkusch\lock\mutex;
 
 use Eloquent\Liberator\Liberator;
+use PHPUnit\Framework\Constraint\IsType;
 use PHPUnit\Framework\TestCase;
 use Predis\Client;
 use Redis;
@@ -252,7 +253,13 @@ public function provideMutexFactories()
 
             'semaphore' => [function ($timeout = 3) use ($filename): Mutex {
                 $semaphore = sem_get(ftok($filename, 'b'));
-                $this->assertTrue($semaphore instanceof \SysvSemaphore || is_resource($semaphore)); // @phpstan-ignore-line
+                $this->assertThat(
+                    $semaphore,
+                    $this->logicalOr(
+                        $this->isInstanceOf(\SysvSemaphore::class),
+                        new IsType(IsType::TYPE_RESOURCE)
+                    )
+                );
 
                 return new SemaphoreMutex($semaphore);
             }],

tests/util/LoopTest.php

@@ -58,10 +58,9 @@ public function testExecutionWithinTimeout()
     /**
      * Tests exceeding the execution timeout.
      */
-    public function testExceedTimeout()
+    public function testExceedTimeoutIsAcceptableIfEndWasCalled()
     {
-        $this->expectException(TimeoutException::class);
-        $this->expectExceptionMessage('Timeout of 1 seconds exceeded.');
+        $this->expectNotToPerformAssertions();
 
         $loop = new Loop(1);
         $loop->execute(function () use ($loop): void {