Merge pull request #491 from HubSpot/feature/updateRetryMiddlewareFactory

Update retry middleware factory

Author: ksvirkou-hubspot

lib/RetryMiddlewareFactory.php

@@ -8,24 +8,34 @@
 
 class RetryMiddlewareFactory
 {
+    public const DEFAULT_MAX_RETRIES = 5;
+    public const INTERNAL_ERROR_RANGES = [
+        ['from' => 500, 'to' => 503],
+        ['from' => 520, 'to' => 599]
+    ];
+
     public static function createInternalErrorsMiddleware(
         ?callable $delayFunction = null,
-        int $maxRetries = 5
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
     ) {
-        return static::createMiddlewareByHttpCodeRange(500, 504, $delayFunction, $maxRetries);
+        return static::createMiddlewareByHttpCodeRanges(
+            static::INTERNAL_ERROR_RANGES,
+            $delayFunction,
+            $maxRetries
+        );
     }
 
     public static function createRateLimitMiddleware(
         ?callable $delayFunction = null,
-        int $maxRetries = 5
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
     ) {
         return static::createMiddlewareByHttpCodes([429], $delayFunction, $maxRetries);
     }
 
     public static function createMiddlewareByHttpCodes(
         array $codes,
-        callable $delayFunction,
-        int $maxRetries = 5
+        ?callable $delayFunction,
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
     ): callable {
         return Middleware::retry(
             static::getRetryFunction($codes, $maxRetries),
@@ -36,41 +46,73 @@ public static function createMiddlewareByHttpCodes(
     public static function createMiddlewareByHttpCodeRange(
         int $from,
         int $to,
-        callable $delayFunction,
-        int $maxRetries = 5
+        ?callable $delayFunction,
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
+    ): callable {
+        return static::createMiddlewareByHttpCodeRanges([[$from, $to]], $delayFunction, $maxRetries);
+    }
+
+    /**
+     * Create middleware by http code ranges
+     * @param array $ranges [['from' => int, 'to' => int]]
+     */
+    public static function createMiddlewareByHttpCodeRanges(
+        array $ranges,
+        ?callable $delayFunction,
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
     ): callable {
         return Middleware::retry(
-            static::getRetryFunctionByRange($from, $to, $maxRetries),
+            static::getRetryFunctionByRanges($ranges, $maxRetries),
             $delayFunction
         );
     }
 
-    public static function getRetryFunctionByRange(
-        int $from,
-        int $to,
-        int $maxRetries = 5
-    ) {
+    /**
+     * Get retry function by code ranges
+     * @param array $ranges [['from' => int, 'to' => int]]
+     */
+    public static function getRetryFunctionByRanges(
+        array $ranges,
+        int $maxRetries
+    ): callable {
         return function (
             $retries,
             Request $request,
             ?Response $response = null
-        ) use ($from, $to, $maxRetries) {
+        ) use ($ranges, $maxRetries) {
             if ($retries >= $maxRetries) {
                 return false;
             }
 
-            if ($response instanceof Response) {
-                if (($response->getStatusCode() >= $from) && ($response->getStatusCode() <= $to)) {
-                    return true;
+            if (!$response instanceof Response) {
+                return false;
+            }
+
+            $statusCode = $response->getStatusCode();
+            foreach ($ranges as $range) {
+                if (key_exists('from', $range) && key_exists('to', $range)) {
+                    if ($statusCode >= $range['from'] && $statusCode <= $range['to']) {
+                        return true;
+                    }
                 }
             }
 
             return false;
         };
     }
 
-    public static function getRetryFunction(array $codes, int $maxRetries = 5)
-    {
+    public static function getRetryFunctionByRange(
+        int $from,
+        int $to,
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
+    ): callable {
+        return static::getRetryFunctionByRanges([['from' => $from, 'to' => $to]], $maxRetries);
+    }
+
+    public static function getRetryFunction(
+        array $codes,
+        int $maxRetries = static::DEFAULT_MAX_RETRIES
+    ): callable {
         return function (
             $retries,
             Request $request,