From 22fd4f94d810c3c3453cc2034e4360644e991c79 Mon Sep 17 00:00:00 2001
From: Aleksandr Denisyuk <rb4@inbox.ru>
Date: Mon, 24 Jan 2022 17:05:11 +0300
Subject: [PATCH] Add NullBackOff

---
 docs/index.md             | 14 ++++++++++++++
 src/NullBackOff.php       | 20 ++++++++++++++++++++
 tests/NullBackOffTest.php | 22 ++++++++++++++++++++++
 3 files changed, 56 insertions(+)
 create mode 100644 src/NullBackOff.php
 create mode 100644 tests/NullBackOffTest.php

diff --git a/docs/index.md b/docs/index.md
index 13ead24..7d04bab 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -159,6 +159,7 @@ The following back-off decorators are available:
 - [ExponentialBackOff](../src/ExponentialBackOff.php)
 - [DecorrelatedBackOff](../src/DecorrelatedBackOff.php)
 - [ImmediatelyThrowableBackOff](../src/ImmediatelyThrowableBackOff.php)
+- [NullBackOff](../src/NullBackOff.php)
 
 ## Retry exceptions
 
@@ -168,6 +169,7 @@ Configure BackOff and ExceptionClassifier to retry your business logic when an e
 <?php
 
 use Orangesoft\BackOff\ExponentialBackOff;
+use Orangesoft\BackOff\NullBackOff;
 use Orangesoft\BackOff\Duration\Seconds;
 use Orangesoft\BackOff\Retry\ExceptionClassifier\ExceptionClassifier;
 use Orangesoft\BackOff\Retry\Retry;
@@ -184,6 +186,18 @@ $exceptionClassifier = new ExceptionClassifier([
 $retry = new Retry($backOff, $exceptionClassifier);
 ```
 
+If you don't need any back-off at all use NullBackOff which just count attempts:
+
+```php
+$backOff = new NullBackOff(maxAttempts: 3);
+
+$exceptionClassifier = new ExceptionClassifier([
+    \RuntimeException::class,
+]);
+
+$retry = new Retry($backOff, $exceptionClassifier);
+```
+
 Put the business logic in a callback function and call it:
 
 ```php
diff --git a/src/NullBackOff.php b/src/NullBackOff.php
new file mode 100644
index 0000000..c2f238e
--- /dev/null
+++ b/src/NullBackOff.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Orangesoft\BackOff;
+
+final class NullBackOff implements BackOffInterface
+{
+    public function __construct(
+        private int|float $maxAttempts = 3,
+    ) {
+    }
+
+    public function backOff(int $attempt, \Throwable $throwable): void
+    {
+        if ($attempt > $this->maxAttempts) {
+            throw $throwable;
+        }
+    }
+}
diff --git a/tests/NullBackOffTest.php b/tests/NullBackOffTest.php
new file mode 100644
index 0000000..73f807b
--- /dev/null
+++ b/tests/NullBackOffTest.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Orangesoft\BackOff\Tests;
+
+use Orangesoft\BackOff\NullBackOff;
+use PHPUnit\Framework\TestCase;
+
+class NullBackOffTest extends TestCase
+{
+    public function testBackOff(): void
+    {
+        $nullBackOff = new NullBackOff(maxAttempts: 3);
+
+        $throwable = new \Exception();
+
+        $this->expectExceptionObject($throwable);
+
+        $nullBackOff->backOff(4, $throwable);
+    }
+}