changed lock interfaces

Author: desperado

src/AmpLock.php

@@ -12,13 +12,21 @@
 
 namespace ServiceBus\Mutex;
 
-use function Amp\asyncCall;
+use function Amp\call;
+use Amp\Promise;
 
 /**
- *
+ * @internal
  */
 final class AmpLock implements Lock
 {
+    /**
+     * Lock identifier.
+     *
+     * @var string
+     */
+    private $id;
+
     /**
      * The function to be called on release or null if the lock has been released.
      *
@@ -27,10 +35,12 @@ final class AmpLock implements Lock
     private $releaser;
 
     /**
+     * @param string        $id
      * @param callable|null $releaser
      */
-    public function __construct(?callable $releaser)
+    public function __construct(string $id, ?callable $releaser)
     {
+        $this->id       = $id;
         $this->releaser = $releaser;
     }
 
@@ -45,17 +55,29 @@ public function released(): bool
     /**
      * {@inheritdoc}
      */
-    public function release(): void
+    public function id(): string
     {
-        if (null === $this->releaser)
-        {
-            return;
-        }
+        return $this->id;
+    }
 
-        $releaser       = $this->releaser;
-        $this->releaser = null;
+    /**
+     * {@inheritdoc}
+     */
+    public function release(): Promise
+    {
+        /** @psalm-suppress MixedTypeCoercion */
+        return call(
+            function(): \Generator
+            {
+                if (null !== $this->releaser)
+                {
+                    $releaser       = $this->releaser;
+                    $this->releaser = null;
 
-        asyncCall($releaser);
+                    yield call($releaser);
+                }
+            }
+        );
     }
 
     public function __destruct()

src/FileMutex.php renamed to src/FilesystemMutex.php

@@ -15,20 +15,33 @@
 use function Amp\asyncCall;
 use function Amp\call;
 use function Amp\File\get;
-use function Amp\File\touch;
+use function Amp\File\put;
 use function Amp\File\unlink;
 use Amp\Delayed;
 use Amp\Promise;
 use ServiceBus\Mutex\Exceptions\SyncException;
 
 /**
  * It can be used when several processes are running within the same host.
+ *
+ * @internal
+ *
+ * @see FilesystemMutexFactory
  */
-final class FileMutex implements Mutex
+final class FilesystemMutex implements Mutex
 {
     const LATENCY_TIMEOUT = 50;
 
     /**
+     * Mutex identifier.
+     *
+     * @var string
+     */
+    private $id;
+
+    /**
+     * Barrier file path.
+     *
      * @var string
      */
     private $filePath;
@@ -41,21 +54,25 @@ final class FileMutex implements Mutex
     private $release;
 
     /**
+     * @param string $id
      * @param string $filePath
      */
-    public function __construct(string $filePath)
+    public function __construct(string $id, string $filePath)
     {
+        $this->id       = $id;
         $this->filePath = $filePath;
         $this->release  = function(): \Generator
         {
             try
             {
                 yield unlink($this->filePath);
             }
+            // @codeCoverageIgnoreStart
             catch (\Throwable $throwable)
             {
                 /** Not interests */
             }
+            // @codeCoverageIgnoreEnd
         };
     }
 
@@ -81,9 +98,9 @@ function(): \Generator
                         yield new Delayed(self::LATENCY_TIMEOUT);
                     }
 
-                    yield touch($this->filePath);
+                    yield put($this->filePath, '');
 
-                    return new AmpLock($this->release);
+                    return new AmpLock($this->id, $this->release);
                 }
                 catch (\Throwable $throwable)
                 {

src/FilesystemMutexFactory.php

@@ -33,8 +33,8 @@ public function __construct(string $storageDirectory)
     /**
      * {@inheritdoc}
      */
-    public function create(string $key): Mutex
+    public function create(string $id): Mutex
     {
-        return new FileMutex(\sprintf('%s/%s', $this->storageDirectory, \sha1($key)));
+        return new FilesystemMutex($id, \sprintf('%s/%s', $this->storageDirectory, \sha1($id)));
     }
 }

src/InMemoryMutex.php

@@ -19,6 +19,10 @@
 
 /**
  * Can only be used when working in one process.
+ *
+ * @internal
+ *
+ * @see InMemoryMutexFactory
  */
 final class InMemoryMutex implements Mutex
 {
@@ -27,19 +31,19 @@ final class InMemoryMutex implements Mutex
     /**
      * @var string
      */
-    private $key;
+    private $id;
 
     /**
-     * @param string $key
+     * @param string $id
      */
-    public function __construct(string $key)
+    public function __construct(string $id)
     {
-        $this->key = $key;
+        $this->id = $id;
     }
 
     public function __destruct()
     {
-        InMemoryMutexStorage::instance()->unlock($this->key);
+        InMemoryMutexStorage::instance()->unlock($this->id);
     }
 
     /**
@@ -52,17 +56,18 @@ public function acquire(): Promise
         return call(
             function(): \Generator
             {
-                while (InMemoryMutexStorage::instance()->has($this->key))
+                while (InMemoryMutexStorage::instance()->has($this->id))
                 {
                     yield new Delayed(self::LATENCY_TIMEOUT);
                 }
 
-                InMemoryMutexStorage::instance()->lock($this->key);
+                InMemoryMutexStorage::instance()->lock($this->id);
 
                 return new AmpLock(
+                    $this->id,
                     function(): void
                     {
-                        InMemoryMutexStorage::instance()->unlock($this->key);
+                        InMemoryMutexStorage::instance()->unlock($this->id);
                     }
                 );
             }

src/InMemoryMutexFactory.php

@@ -20,8 +20,8 @@ final class InMemoryMutexFactory implements MutexFactory
     /**
      * {@inheritdoc}
      */
-    public function create(string $key): Mutex
+    public function create(string $id): Mutex
     {
-        return new InMemoryMutex($key);
+        return new InMemoryMutex($id);
     }
 }

src/Lock.php

@@ -12,11 +12,20 @@
 
 namespace ServiceBus\Mutex;
 
+use Amp\Promise;
+
 /**
  *
  */
 interface Lock
 {
+    /**
+     * Receive lock identifier.
+     *
+     * @return string
+     */
+    public function id(): string;
+
     /**
      * Checks if the lock has already been released.
      *
@@ -27,7 +36,7 @@ public function released(): bool;
     /**
      * Releases the lock. No-op if the lock has already been released.
      *
-     * @return void
+     * @return Promise
      */
-    public function release(): void;
+    public function release(): Promise;
 }

src/Mutex.php

@@ -25,7 +25,6 @@ interface Mutex
      * @throws \ServiceBus\Mutex\Exceptions\SyncException An error occurs when attempting to obtain the lock
      *
      * @return \Amp\Promise<\ServiceBus\Mutex\Lock>
-     *
      */
     public function acquire(): Promise;
 }

src/MutexFactory.php

@@ -20,9 +20,9 @@ interface MutexFactory
     /**
      * Create lock for specified operation.
      *
-     * @param string $key
+     * @param string $id
      *
      * @return Mutex
      */
-    public function create(string $key): Mutex;
+    public function create(string $id): Mutex;
 }

tests/FilesystemMutexFactoryTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * PHP Mutex implementation.
+ *
+ * @author  Maksim Masiukevich <[email protected]>
+ * @license MIT
+ * @license https://opensource.org/licenses/MIT
+ */
+
+declare(strict_types = 1);
+
+namespace ServiceBus\Mutex\Tests;
+
+use PHPUnit\Framework\TestCase;
+use ServiceBus\Mutex\FilesystemMutex;
+use ServiceBus\Mutex\FilesystemMutexFactory;
+
+/**
+ *
+ */
+final class FilesystemMutexFactoryTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @throws \Throwable
+     *
+     * @return void
+     */
+    public function create(): void
+    {
+        $mutex = (new FilesystemMutexFactory(\sys_get_temp_dir()))->create(__CLASS__);
+
+        static::assertInstanceOf(FilesystemMutex::class, $mutex);
+    }
+}