Merge pull request #285 from saloonphp/feature/v3-contract-friendly-retries-2

Feature | V3 Contract Friendly Retries

Author: Sammyjo20

src/Helpers/RetryHelper.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Saloon\Helpers;
+
+use Saloon\Contracts\Request;
+use Saloon\Contracts\Connector;
+
+/**
+ * @internal
+ */
+final class RetryHelper
+{
+    /**
+     * Get max tries on a connector or request
+     */
+    public static function getMaxTries(Connector $connector, Request $request): int
+    {
+        $maxTries = 1;
+
+        if (property_exists($connector, 'tries') && is_int($connector->tries)) {
+            $maxTries = $connector->tries;
+        }
+
+        if (property_exists($request, 'tries') && is_int($request->tries)) {
+            $maxTries = $request->tries;
+        }
+
+        if ($maxTries <= 0) {
+            $maxTries = 1;
+        }
+
+        return $maxTries;
+    }
+
+    /**
+     * Get retry interval on a connector or request
+     */
+    public static function getRetryInterval(Connector $connector, Request $request): int
+    {
+        $retryInterval = 0;
+
+        if (property_exists($connector, 'retryInterval') && is_int($connector->retryInterval)) {
+            $retryInterval = $connector->retryInterval;
+        }
+
+        if (property_exists($request, 'retryInterval') && is_int($request->retryInterval)) {
+            $retryInterval = $request->retryInterval;
+        }
+
+        if ($retryInterval <= 0) {
+            $retryInterval = 0;
+        }
+
+        return $retryInterval;
+    }
+
+    /**
+     * Should throw on max tries
+     */
+    public static function getThrowOnMaxTries(Connector $connector, Request $request): bool
+    {
+        $throwOnMaxTries = true;
+
+        if (property_exists($connector, 'throwOnMaxTries') && is_bool($connector->throwOnMaxTries)) {
+            $throwOnMaxTries = $connector->throwOnMaxTries;
+        }
+
+        if (property_exists($request, 'throwOnMaxTries') && is_bool($request->throwOnMaxTries)) {
+            $throwOnMaxTries = $request->throwOnMaxTries;
+        }
+
+        return $throwOnMaxTries;
+    }
+}

src/Http/Connector.php

@@ -16,7 +16,7 @@
 use Saloon\Traits\Connector\SendsRequests;
 use Saloon\Traits\Auth\AuthenticatesRequests;
 use Saloon\Traits\RequestProperties\HasDelay;
-use Saloon\Traits\RequestProperties\HasTries;
+use Saloon\Traits\RequestProperties\Retryable;
 use Saloon\Traits\Responses\HasCustomResponses;
 use Saloon\Traits\Request\CreatesDtoFromResponse;
 use Saloon\Contracts\Connector as ConnectorContract;
@@ -39,6 +39,6 @@ abstract class Connector implements ConnectorContract, HasDebuggingContract
     use Makeable;
     use HasPool;
     use HasDelay;
-    use HasTries;
+    use Retryable;
     use HasDebugging;
 }

src/Http/Request.php

@@ -13,26 +13,26 @@
 use Saloon\Traits\HandlesPsrRequest;
 use Saloon\Traits\ManagesExceptions;
 use Saloon\Traits\Auth\AuthenticatesRequests;
-use Saloon\Traits\RequestProperties\HasTries;
+use Saloon\Traits\RequestProperties\Retryable;
 use Saloon\Traits\Responses\HasCustomResponses;
 use Saloon\Contracts\Request as RequestContract;
 use Saloon\Traits\Request\CreatesDtoFromResponse;
 use Saloon\Traits\RequestProperties\HasRequestProperties;
 
 abstract class Request implements RequestContract
 {
+    use CreatesDtoFromResponse;
     use AuthenticatesRequests;
     use HasRequestProperties;
-    use CreatesDtoFromResponse;
     use HasCustomResponses;
     use ManagesExceptions;
     use HandlesPsrRequest;
     use HasMockClient;
     use Conditionable;
     use HasDebugging;
+    use Retryable;
     use Bootable;
     use Makeable;
-    use HasTries;
 
     /**
      * Define the HTTP method.

src/Traits/Connector/SendsRequests.php

@@ -5,12 +5,16 @@
 namespace Saloon\Traits\Connector;
 
 use LogicException;
+use Saloon\Helpers\Helpers;
+use InvalidArgumentException;
 use Saloon\Contracts\Request;
 use Saloon\Contracts\Response;
 use GuzzleHttp\Promise\Promise;
+use Saloon\Helpers\RetryHelper;
 use Saloon\Http\PendingRequest;
 use Saloon\Contracts\MockClient;
 use GuzzleHttp\Promise\PromiseInterface;
+use Saloon\Traits\RequestProperties\Retryable;
 use Saloon\Exceptions\Request\RequestException;
 use Saloon\Exceptions\Request\FatalRequestException;
 use Saloon\Contracts\PendingRequest as PendingRequestContract;
@@ -32,17 +36,9 @@ public function send(Request $request, MockClient $mockClient = null, callable $
             $handleRetry = static fn (): bool => true;
         }
 
-        $maxTries = $request->tries ?? $this->tries ?? 1;
-        $retryInterval = $request->retryInterval ?? $this->retryInterval ?? 0;
-        $throwOnMaxTries = $request->throwOnMaxTries ?? $this->throwOnMaxTries ?? true;
-
-        if ($maxTries <= 0) {
-            $maxTries = 1;
-        }
-
-        if ($retryInterval <= 0) {
-            $retryInterval = 0;
-        }
+        $maxTries = RetryHelper::getMaxTries($this, $request);
+        $retryInterval = RetryHelper::getRetryInterval($this, $request);
+        $throwOnMaxTries = RetryHelper::getThrowOnMaxTries($this, $request);
 
         $attempts = 0;
 
@@ -155,6 +151,10 @@ public function sendAsync(Request $request, MockClient $mockClient = null): Prom
      */
     public function sendAndRetry(Request $request, int $tries, int $interval = 0, callable $handleRetry = null, bool $throw = true, MockClient $mockClient = null): Response
     {
+        if (! array_key_exists(Retryable::class, Helpers::classUsesRecursive($request))) {
+            throw new InvalidArgumentException('The request class must use the "Retryable" trait.');
+        }
+
         $request->tries = $tries;
         $request->retryInterval = $interval;
         $request->throwOnMaxTries = $throw;

src/Traits/RequestProperties/HasTries.php …c/Traits/RequestProperties/Retryable.phpsrc/Traits/RequestProperties/HasTries.php renamed to src/Traits/RequestProperties/Retryable.php src/Traits/RequestProperties/HasTries.php renamed to src/Traits/RequestProperties/Retryable.php

@@ -8,7 +8,7 @@
 use Saloon\Exceptions\Request\RequestException;
 use Saloon\Exceptions\Request\FatalRequestException;
 
-trait HasTries
+trait Retryable
 {
     /**
      * The number of times a request should be retried if a failure response is returned.