Merge branch 'main' into release/v1.5.3

Author: jswift

src/BigCommerce/Api/Generic/BatchUpdateResource.php

@@ -4,15 +4,20 @@
 
 use BigCommerce\ApiV3\Client;
 use BigCommerce\ApiV3\ResponseModels\PaginatedResponse;
+use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\RequestOptions;
+use Psr\Http\Client\RequestExceptionInterface;
 use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 
 trait BatchUpdateResource
 {
     abstract public function batchUpdate(array $resources): PaginatedResponse;
     abstract protected function multipleResourcesEndpoint(): string;
     abstract public function getClient(): Client;
 
+    private int $maxRetries = 0;
+
     protected function maxBatchSize(): int
     {
         return 10;
@@ -21,20 +26,46 @@ protected function maxBatchSize(): int
     /**
      * @param array $resources
      * @return ResponseInterface[]
+     * @throws RequestExceptionInterface
      */
     protected function batchUpdateResource(array $resources): array
     {
         $chunks = array_chunk($resources, $this->maxBatchSize());
-        $responses = [];
-        foreach ($chunks as $chunk) {
-            $responses[] = $this->getClient()->getRestClient()->put(
-                $this->multipleResourcesEndpoint(),
-                [
-                    RequestOptions::JSON => $chunk,
-                ]
-            );
+        return array_map(fn($chunk) => $this->putRequestWithRetries($chunk), $chunks);
+    }
+
+    private function putRequestWithRetries($data): ResponseInterface
+    {
+        $retriesRemaining = $this->getMaxRetries() + 1;
+
+        while ($retriesRemaining-- > 0) {
+            try {
+                return $this->getClient()->getRestClient()->put(
+                    $this->multipleResourcesEndpoint(),
+                    [
+                        RequestOptions::JSON => $data,
+                    ]
+                );
+            } catch (\Exception $exception) {
+                if (!in_array($exception->getCode(), $this->retryOnErrorCodes()) || $retriesRemaining <= 0) {
+                    throw $exception;
+                }
+            }
         }
+    }
 
-        return $responses;
+    protected function retryOnErrorCodes(): array
+    {
+        return [500, 502, 503, 504];
+    }
+
+    public function getMaxRetries(): int
+    {
+        return $this->maxRetries;
+    }
+
+    public function setMaxRetries(int $maxRetries): void
+    {
+        $this->maxRetries = $maxRetries;
     }
 }

tests/BigCommerce/Api/Redirects/RedirectsApiTest.php

@@ -5,6 +5,7 @@
 use BigCommerce\ApiV3\ResourceModels\Redirect\Redirect;
 use BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo;
 use BigCommerce\Tests\BigCommerceApiTest;
+use GuzzleHttp\Exception\RequestException;
 
 class RedirectsApiTest extends BigCommerceApiTest
 {
@@ -38,4 +39,23 @@ public function testCanDeleteRedirects()
         $this->getApi()->redirects()->delete([1, 2, 3]);
         $this->assertEquals('storefront/redirects', $this->getLastRequestPath());
     }
+
+    public function testRetryOnError()
+    {
+        $this->setReturnData('blank.json', 503, [], 3);
+        $redirect = new Redirect();
+        $redirect->from_path = '/old-url';
+        $redirect->site_id = 0;
+        $redirect->toProduct(1);
+
+        //https://httpbin.org/status/502
+        $redirectsApi = $this->getApi()->redirects();
+        $redirectsApi->setMaxRetries(2);
+        try {
+            $redirectsApi->upsert([$redirect]);
+            $this->assertFalse(true, 'Exception not raised');
+        } catch (RequestException $e) {
+            $this->assertCount(3, $this->getRequestHistory());
+        }
+    }
 }

tests/BigCommerce/BigCommerceApiTest.php

@@ -37,11 +37,18 @@ protected function setUp(): void
         );
     }
 
-    protected function setReturnData(string $filename, int $statusCode = 200, array $headers = []): void
-    {
-        $mock = new MockHandler([
-            new Response($statusCode, $headers, file_get_contents(self::RESPONSES_PATH . $filename)),
-        ]);
+    protected function setReturnData(
+        string $filename,
+        int $statusCode = 200,
+        array $headers = [],
+        int $numberOfResponses = 1
+    ): void {
+        $responses = [];
+        for ($i = 1; $i <= $numberOfResponses; $i++) {
+            $responses[] = new Response($statusCode, $headers, file_get_contents(self::RESPONSES_PATH . $filename));
+        }
+
+        $mock = new MockHandler($responses);
 
         $handlerStack = HandlerStack::create($mock);
         $handlerStack->push(Middleware::history($this->container));