feat: Handle TooManyRequestsHttpException

Author: LevFlavien

spec/Client/HttpExceptionHandlerSpec.php

@@ -10,6 +10,7 @@
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
 use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
+use Akeneo\Pim\ApiClient\Exception\TooManyRequestsHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnauthorizedHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnprocessableEntityHttpException;
 use Akeneo\Pim\ApiClient\Client\HttpExceptionHandler;
@@ -221,6 +222,26 @@ function it_throws_bad_request_exception_when_status_code_422(
             ->during('transformResponseToException', [$request, $response]);
     }
 
+    function it_throws_bad_request_exception_when_status_code_429(
+        RequestInterface $request,
+        ResponseInterface $response,
+        StreamInterface $responseBody
+    ) {
+        $response->getStatusCode()->willReturn(429);
+        $response->getBody()->willReturn($responseBody);
+        $responseBody->getContents()->willReturn('Too Many Requests');
+        $responseBody->getContents()->shouldBeCalled();
+        $this
+            ->shouldThrow(
+                new TooManyRequestsHttpException(
+                    'Too Many Requests',
+                    $request->getWrappedObject(),
+                    $response->getWrappedObject()
+                )
+            )
+            ->during('transformResponseToException', [$request, $response]);
+    }
+
     function it_throws_bad_request_exception_when_status_code_4xx(
         RequestInterface $request,
         ResponseInterface $response,

src/Client/HttpExceptionHandler.php

@@ -10,6 +10,7 @@
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
 use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
+use Akeneo\Pim\ApiClient\Exception\TooManyRequestsHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnauthorizedHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnprocessableEntityHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnsupportedMediaTypeHttpException;
@@ -80,6 +81,10 @@ public function transformResponseToException(
             throw new UnprocessableEntityHttpException($this->getResponseMessage($response), $request, $response);
         }
 
+        if (HttpClient::HTTP_TOO_MANY_REQUESTS === $response->getStatusCode()) {
+            throw new TooManyRequestsHttpException($response->getBody()->getContents(), $request, $response);
+        }
+
         if ($this->isApiClientErrorStatusCode($response->getStatusCode())) {
             throw new ClientErrorHttpException($this->getResponseMessage($response), $request, $response);
         }

src/Exception/TooManyRequestsHttpException.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\Exception;
+
+/**
+ * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
+ * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+class TooManyRequestsHttpException extends ClientErrorHttpException
+{
+    /**
+     * How much time must be waited before next request. Result in seconds.
+     */
+    public function getRetryAfter(): int
+    {
+        $response = $this->getResponse();
+
+        if (!$response->hasHeader('Retry-After')) {
+            throw new RuntimeException('Cannot find Retry-After header.');
+        }
+
+        $retryAfter = $response->getHeader('Retry-After')[0];
+
+        if (preg_match('/^\d+$/', $retryAfter)) {
+            return (int) $retryAfter;
+        }
+
+        throw new RuntimeException('Cannot parse Retry-After header. Value must be seconds.');
+    }
+
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#too-many-requests-exception)';
+    }
+}

tests/Exception/TooManyRequestsHttpExceptionTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\tests\Exception;
+
+use Akeneo\Pim\ApiClient\Exception\RuntimeException;
+use Akeneo\Pim\ApiClient\Exception\TooManyRequestsHttpException;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class TooManyRequestsHttpExceptionTest extends TestCase
+{
+    private RequestInterface $request;
+
+    public function setUp(): void
+    {
+        $this->request = $this->createMock(RequestInterface::class);
+    }
+
+    public function testRetryAfter(): void
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->method('hasHeader')->willReturn(true);
+        $response->method('getHeader')->willReturn(['10']);
+
+        $exception = new TooManyRequestsHttpException('Too Many Requests', $this->request, $response, null);
+
+        $this->assertSame(
+            10,
+            $exception->getRetryAfter()
+        );
+    }
+
+    public function testCannotFindRetryAfterHeader(): void
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->method('hasHeader')->willReturn(false);
+
+        $exception = new TooManyRequestsHttpException('Too Many Requests', $this->request, $response, null);
+
+        $this->expectException(RuntimeException::class);
+
+        $exception->getRetryAfter();
+    }
+
+    public function testCannotParseRetryAfterHeader(): void
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->method('hasHeader')->willReturn(true);
+        $response->method('getHeader')->willReturn([0 => 'Wed, 21 Oct 2015 07:28:00 GMT']);
+
+        $exception = new TooManyRequestsHttpException('Too Many Requests', $this->request, $response, null);
+
+        $this->expectException(RuntimeException::class);
+
+        $exception->getRetryAfter();
+    }
+}