Generate Exceptions (#921)

* Generate Exceptions

* Add documentation on top of class

* Leverage the new AwsErrorFactory

* Fix __constructor signature in  GeneratedException

* Fix private vs protected

* Generate all methods

* Fix things

* Add constraint in composer.Json

* Add changelog entry

Author: jderusse

CHANGELOG.md

@@ -6,6 +6,9 @@
 
 - Changed case of object's properties to camelCase.
 - Added documentation in class's headers.
+- Removed `final` from `ClientException` and `ServerException`.
+- Make Responses thrown Business Exception when AwsErrorCode <-> Exception class mapping provided through RequestContext.
+- Added Business Exceptions.
 
 ## 1.8.0
 

src/AbstractApi.php

@@ -167,7 +167,7 @@ final protected function getResponse(Request $request, ?RequestContext $context
             ]);
         }
 
-        return new Response($response, $this->httpClient, $this->logger, $this->awsErrorFactory, $debug);
+        return new Response($response, $this->httpClient, $this->logger, $this->awsErrorFactory, $debug, $context ? $context->getExceptionMapping() : []);
     }
 
     /**

src/Exception/Http/ClientException.php

@@ -11,7 +11,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-final class ClientException extends \RuntimeException implements ClientExceptionInterface, HttpException
+class ClientException extends \RuntimeException implements ClientExceptionInterface, HttpException
 {
     use HttpExceptionTrait;
 }

src/Exception/Http/HttpExceptionTrait.php

@@ -46,6 +46,8 @@ public function __construct(ResponseInterface $response, AwsError $awsError = nu
         }
 
         parent::__construct($message, $code);
+
+        $this->populateResult($response);
     }
 
     public function getResponse(): ResponseInterface
@@ -72,4 +74,8 @@ public function getAwsDetail(): ?string
     {
         return $this->awsError ? $this->awsError->getDetail() : null;
     }
+
+    protected function populateResult(ResponseInterface $response): void
+    {
+    }
 }

src/Exception/Http/ServerException.php

@@ -11,7 +11,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-final class ServerException extends \RuntimeException implements HttpException, ServerExceptionInterface
+class ServerException extends \RuntimeException implements HttpException, ServerExceptionInterface
 {
     use HttpExceptionTrait;
 }

src/RequestContext.php

@@ -18,6 +18,7 @@ class RequestContext
         'operation' => true,
         'expirationDate' => true,
         'currentDate' => true,
+        'exceptionMapping' => true,
     ];
 
     /**
@@ -40,12 +41,18 @@ class RequestContext
      */
     private $currentDate;
 
+    /**
+     * @var array<string, string>
+     */
+    private $exceptionMapping = [];
+
     /**
      * @param array{
      *  operation?: null|string
      *  region?: null|string
      *  expirationDate?: null|\DateTimeImmutable
      *  currentDate?: null|\DateTimeImmutable
+     *  exceptionMapping?: string[]
      * }
      */
     public function __construct(array $options = [])
@@ -78,4 +85,9 @@ public function getCurrentDate(): ?\DateTimeImmutable
     {
         return $this->currentDate;
     }
+
+    public function getExceptionMapping(): array
+    {
+        return $this->exceptionMapping;
+    }
 }

src/Response.php

@@ -83,13 +83,19 @@ class Response
      */
     private $debug;
 
-    public function __construct(ResponseInterface $response, HttpClientInterface $httpClient, LoggerInterface $logger, AwsErrorFactoryInterface $awsErrorFactory = null, bool $debug = false)
+    /**
+     * @var array<string, string>
+     */
+    private $exceptionMapping;
+
+    public function __construct(ResponseInterface $response, HttpClientInterface $httpClient, LoggerInterface $logger, AwsErrorFactoryInterface $awsErrorFactory = null, bool $debug = false, array $exceptionMapping = [])
     {
         $this->httpResponse = $response;
         $this->httpClient = $httpClient;
         $this->logger = $logger;
         $this->awsErrorFactory = $awsErrorFactory ?? new ChainAwsErrorFactory();
         $this->debug = $debug;
+        $this->exceptionMapping = $exceptionMapping;
     }
 
     public function __destruct()
@@ -373,24 +379,27 @@ private function defineResolveStatus(): void
         }
 
         if (300 <= $statusCode) {
-            $awsErrorFactory = $this->awsErrorFactory;
-            $httpResponse = $this->httpResponse;
-            $this->resolveResult = static function () use ($awsErrorFactory, $httpResponse): HttpException {
-                try {
-                    $awsError = $awsErrorFactory->createFromResponse($httpResponse);
-                } catch (UnparsableResponse $e) {
-                    $awsError = null;
-                }
-                $statusCode = $httpResponse->getStatusCode();
-                if (500 <= $statusCode) {
-                    return new ServerException($httpResponse, $awsError);
-                }
+            try {
+                $awsError = $this->awsErrorFactory->createFromResponse($this->httpResponse);
+            } catch (UnparsableResponse $e) {
+                $awsError = null;
+            }
 
-                if (400 <= $statusCode) {
-                    return new ClientException($httpResponse, $awsError);
-                }
+            if ((null !== $awsCode = ($awsError ? $awsError->getCode() : null)) && isset($this->exceptionMapping[$awsCode])) {
+                $exceptionClass = $this->exceptionMapping[$awsCode];
+            } elseif (500 <= $statusCode) {
+                $exceptionClass = ServerException::class;
+            } elseif (400 <= $statusCode) {
+                $exceptionClass = ClientException::class;
+            } else {
+                $exceptionClass = RedirectionException::class;
+            }
 
-                return new RedirectionException($httpResponse, $awsError);
+            $httpResponse = $this->httpResponse;
+            /** @psalm-suppress MoreSpecificReturnType */
+            $this->resolveResult = static function () use ($exceptionClass, $httpResponse, $awsError): HttpException {
+                /** @psalm-suppress LessSpecificReturnStatement */
+                return new $exceptionClass($httpResponse, $awsError);
             };
 
             return;

src/Result.php

@@ -29,6 +29,11 @@ class Result
 
     private $response;
 
+    /**
+     * @var array<string, string>
+     */
+    private $exceptionMapping;
+
     /**
      * @var self[]
      */

src/Sts/Exception/ExpiredTokenException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace AsyncAws\Core\Sts\Exception;
+
+use AsyncAws\Core\Exception\Http\ClientException;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+/**
+ * The web identity token that was passed is expired or is not valid. Get a new identity token from the identity
+ * provider and then retry the request.
+ */
+final class ExpiredTokenException extends ClientException
+{
+    protected function populateResult(ResponseInterface $response): void
+    {
+        $data = new \SimpleXMLElement($response->getContent(false));
+        if (0 < $data->Error->count()) {
+            $data = $data->Error;
+        }
+        if (null !== $v = (($v = $data->message) ? (string) $v : null)) {
+            $this->message = $v;
+        }
+    }
+}

src/Sts/Exception/IDPCommunicationErrorException.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace AsyncAws\Core\Sts\Exception;
+
+use AsyncAws\Core\Exception\Http\ClientException;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+/**
+ * The request could not be fulfilled because the identity provider (IDP) that was asked to verify the incoming identity
+ * token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited
+ * number of times so that you don't exceed the request rate. If the error persists, the identity provider might be down
+ * or not responding.
+ */
+final class IDPCommunicationErrorException extends ClientException
+{
+    protected function populateResult(ResponseInterface $response): void
+    {
+        $data = new \SimpleXMLElement($response->getContent(false));
+        if (0 < $data->Error->count()) {
+            $data = $data->Error;
+        }
+        if (null !== $v = (($v = $data->message) ? (string) $v : null)) {
+            $this->message = $v;
+        }
+    }
+}