Rename TimeoutException to LockAcquireTimeoutException (#70)

Author: mvorisek

README.md

@@ -1,6 +1,7 @@
 **[Requirements](#requirements)** |
 **[Installation](#installation)** |
 **[Usage](#usage)** |
+**[Authors](#authors)** |
 **[License](#license)**
 
 # php-lock/lock
@@ -198,10 +199,10 @@ The **MemcachedMutex** is a spinlock implementation which uses the
 
 Example:
 ```php
-$memcache = new \Memcached();
-$memcache->addServer('localhost', 11211);
+$memcached = new \Memcached();
+$memcached->addServer('localhost', 11211);
 
-$mutex = new MemcachedMutex('balance', $memcache);
+$mutex = new MemcachedMutex('balance', $memcached);
 $mutex->synchronized(function () use ($bankAccount, $amount) {
     $balance = $bankAccount->getBalance();
     $balance -= $amount;
@@ -263,7 +264,7 @@ $mutex->synchronized(function () use ($bankAccount, $amount) {
 #### TransactionalMutex
 
 The **TransactionalMutex**
-delegates the serialization to the DBS. The exclusive code is executed within
+delegates the serialization to the database. The exclusive code is executed within
 a transaction. It's up to you to set the correct transaction isolation level.
 However if the transaction fails (i.e. a `PDOException` was thrown), the code
 will be executed again in a new transaction. Therefore the code must not have
@@ -350,9 +351,9 @@ $mutex->synchronized(function () use ($bankAccount, $amount) {
 
 ## Authors
 
-Since year 2015 the development was led by Markus Malkusch, Willem Stuursma-Ruwen, Michael Voříšek and many GitHub contributors.
+Since year 2015 the development was led by Markus Malkusch, Willem Stuursma-Ruwen and many GitHub contributors.
 
-Currently this library is maintained by Michael Voříšek - [GitHub][https://github.com/mvorisek] and [LinkedIn][https://www.linkedin.com/mvorisek].
+Currently this library is maintained by Michael Voříšek - [GitHub](https://github.com/mvorisek) | [LinkedIn](https://www.linkedin.com/mvorisek).
 
 Commercial support is available.
 
@@ -364,10 +365,10 @@ This project is free and is licensed under the MIT.
 [2]: https://github.com/nrk/predis
 [3]: http://php.net/manual/en/book.pcntl.php
 [4]: https://getcomposer.org/
-[5]: https://github.com/php-lock/lock/blob/35526aee28/src/mutex/Mutex.php#L15
-[6]: https://github.com/php-lock/lock/blob/35526aee28/src/mutex/Mutex.php#L38
-[7]: https://github.com/php-lock/lock/blob/35526aee28/src/mutex/Mutex.php#L60
-[8]: https://github.com/php-lock/lock/blob/35526aee28/src/util/DoubleCheckedLocking.php#L63
+[5]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Mutex/Mutex.php#L15
+[6]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Mutex/Mutex.php#L38
+[7]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Mutex/Mutex.php#L60
+[8]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Util/DoubleCheckedLocking.php#L61
 [9]: https://en.wikipedia.org/wiki/Double-checked_locking
-[10]: https://github.com/php-lock/lock/blob/35526aee28/src/mutex/LockMutex.php
-[11]: https://github.com/php-lock/lock/blob/35526aee28/src/exception/LockReleaseException.php
+[10]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Mutex/AbstractLockMutex.php
+[11]: https://github.com/php-lock/lock/blob/3ca295ccda/src/Exception/LockReleaseException.php

composer.json

@@ -10,7 +10,7 @@
         "flock",
         "semaphore",
         "redlock",
-        "memcache",
+        "memcached",
         "redis",
         "advisory-locks",
         "mysql",

src/Exception/DeadlineException.php

@@ -4,4 +4,4 @@
 
 namespace Malkusch\Lock\Exception;
 
-class DeadlineException extends \RuntimeException implements PhpLockException {}
+class DeadlineException extends \RuntimeException {}

src/Exception/ExecutionOutsideLockException.php

@@ -4,50 +4,31 @@
 
 namespace Malkusch\Lock\Exception;
 
+use Malkusch\Lock\Util\LockUtil;
+
 /**
- * Execution outside lock exception.
- *
  * This exception should be thrown when for example the lock is released or the
  * lock times out before the critical code has finished execution. This is a
  * serious exception. Side effects might have happened while the critical code
  * was executed outside of the lock which should not be trusted to be valid.
  *
- * Should only be used in contexts where the is being released.
+ * Should only be used in contexts where the lock is being released.
  *
  * @see \Malkusch\Lock\Mutex\AbstractSpinlockMutex::unlock()
  */
 class ExecutionOutsideLockException extends LockReleaseException
 {
     /**
-     * Creates a new instance of the ExecutionOutsideLockException class.
-     *
      * @param float $elapsedTime Total elapsed time of the synchronized code callback execution
      * @param float $timeout     The lock timeout in seconds
      */
     public static function create(float $elapsedTime, float $timeout): self
     {
-        $elapsedTimeStr = (string) round($elapsedTime, 6);
-        if (\is_finite($elapsedTime) && strpos($elapsedTimeStr, '.') === false) {
-            $elapsedTimeStr .= '.0';
-        }
-
-        $timeoutStr = (string) round($timeout, 6);
-        if (\is_finite($timeout) && strpos($timeoutStr, '.') === false) {
-            $timeoutStr .= '.0';
-        }
-
-        $overTime = round($elapsedTime, 6) - round($timeout, 6);
-        $overTimeStr = (string) round($overTime, 6);
-        if (\is_finite($timeout) && strpos($overTimeStr, '.') === false) {
-            $overTimeStr .= '.0';
-        }
-
         return new self(\sprintf(
-            'The code executed for %s seconds. But the timeout is %s ' .
-            'seconds. The last %s seconds were executed outside of the lock.',
-            $elapsedTimeStr,
-            $timeoutStr,
-            $overTimeStr
+            'The code executed for %s seconds. But the timeout is %s seconds. The last %s seconds were executed outside of the lock.',
+            LockUtil::getInstance()->formatTimeout($elapsedTime),
+            LockUtil::getInstance()->formatTimeout($timeout),
+            LockUtil::getInstance()->formatTimeout(round($elapsedTime, 6) - round($timeout, 6))
         ));
     }
 }

src/Exception/LockAcquireException.php

@@ -5,9 +5,8 @@
 namespace Malkusch\Lock\Exception;
 
 /**
- * Lock acquire exception.
+ * Failed to acquire a lock.
  *
- * Used when the lock could not be acquired. This exception implies that the
- * critical code was not executed, or at least had no side effects.
+ * This exception implies that the critical code was not executed.
  */
 class LockAcquireException extends MutexException {}

src/Exception/LockAcquireTimeoutException.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Malkusch\Lock\Exception;
+
+use Malkusch\Lock\Util\LockUtil;
+
+class LockAcquireTimeoutException extends LockAcquireException
+{
+    /**
+     * @param float $acquireTimeout In seconds
+     */
+    public static function create(float $acquireTimeout): self
+    {
+        return new self('Lock acquire timeout of '
+            . LockUtil::getInstance()->formatTimeout($acquireTimeout)
+            . ' seconds has been exceeded');
+    }
+}

src/Exception/LockReleaseException.php

@@ -5,31 +5,22 @@
 namespace Malkusch\Lock\Exception;
 
 /**
- * Lock release exception.
+ * Failed to release the lock.
  *
- * Failed to release the lock. Take this exception very serious. Failing to
- * release a lock might have the potential to introduce deadlocks. Also the
+ * Take this exception very serious.
+ *
+ * Failing to release a lock might have the potential to introduce deadlocks. Also the
  * critical code was executed i.e. side effects may have happened.
  */
 class LockReleaseException extends MutexException
 {
-    /**
-     * Result that has been returned during the critical code execution.
-     *
-     * @var mixed
-     */
+    /** @var mixed */
     private $codeResult;
 
-    /**
-     * Exception that has happened during the critical code execution.
-     *
-     * @var \Throwable|null
-     */
-    private $codeException;
+    private ?\Throwable $codeException = null;
 
     /**
-     * Gets the result that has been returned during the critical code
-     * execution.
+     * Gets the result that has been returned during the critical code execution.
      *
      * @return mixed The return value of the executed code block
      */
@@ -39,10 +30,7 @@ public function getCodeResult()
     }
 
     /**
-     * Sets the result that has been returned during the critical code
-     * execution.
-     *
-     * @param mixed $codeResult The return value of the executed code block
+     * @param mixed $codeResult
      *
      * @return $this
      */
@@ -54,22 +42,14 @@ public function setCodeResult($codeResult): self
     }
 
     /**
-     * Gets the exception that has happened during the synchronized code
-     * execution.
-     *
-     * @return \Throwable|null The exception thrown by the code block or null when there has been no exception
+     * Gets the exception that has happened during the synchronized code execution.
      */
     public function getCodeException(): ?\Throwable
     {
         return $this->codeException;
     }
 
     /**
-     * Sets the exception that has happened during the critical code
-     * execution.
-     *
-     * @param \Throwable $codeException The exception thrown by the code block
-     *
      * @return $this
      */
     public function setCodeException(\Throwable $codeException): self

src/Exception/MutexException.php

@@ -5,13 +5,10 @@
 namespace Malkusch\Lock\Exception;
 
 /**
- * Mutex exception.
- *
- * Generic exception for any other not covered reason. Usually extended by
- * child classes.
+ * Usually extended by more meaningful classes.
  */
-class MutexException extends \RuntimeException implements PhpLockException
+class MutexException extends \RuntimeException
 {
     /** Not enough redis servers */
-    public const REDIS_NOT_ENOUGH_SERVERS = 1;
+    public const CODE_REDLOCK_NOT_ENOUGH_SERVERS = 23786;
 }