Add supports for multi-region (#466)

* Allow custom region at run time

* Regenerate code

* Add changelog entry

* Add docbloc on Input without members

Author: jderusse

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 0.5.0
 
+### Added
+
+- Add support for multiregion via `@region` input parameter.
+
 ### Changed
 
 - The `StreamableBodyInterface::getChunks` now returns a iterrable of string.

src/AbstractApi.php

@@ -44,9 +44,9 @@ abstract class AbstractApi
     private $credentialProvider;
 
     /**
-     * @var Signer
+     * @var Signer[]
      */
-    private $signer;
+    private $signers;
 
     /**
      * @param Configuration|array $configuration
@@ -78,10 +78,10 @@ final public function getConfiguration(): Configuration
     final public function presign(Input $input, ?\DateTimeImmutable $expires = null): string
     {
         $request = $input->request();
-        $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery()));
+        $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery(), $input->getRegion()));
 
         if (null !== $credentials = $this->credentialProvider->getCredentials($this->configuration)) {
-            $this->getSigner()->presign($request, $credentials, new RequestContext(['expirationDate' => $expires]));
+            $this->getSigner($input->getRegion())->presign($request, $credentials, new RequestContext(['expirationDate' => $expires]));
         }
 
         return $request->getEndpoint();
@@ -95,10 +95,10 @@ abstract protected function getSignatureScopeName(): string;
 
     final protected function getResponse(Request $request, ?RequestContext $context = null): Response
     {
-        $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery()));
+        $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery(), $context ? $context->getRegion() : null));
 
         if (null !== $credentials = $this->credentialProvider->getCredentials($this->configuration)) {
-            $this->getSigner()->sign($request, $credentials, $context ?? new RequestContext());
+            $this->getSigner($context ? $context->getRegion() : null)->sign($request, $credentials, $context ?? new RequestContext());
         }
 
         $length = $request->getBody()->length();
@@ -142,11 +142,11 @@ protected function getSignerFactories(): array
      * @param string $uri   or path
      * @param array  $query parameters that should go in the query string
      */
-    private function getEndpoint(string $uri, array $query): string
+    private function getEndpoint(string $uri, array $query, ?string $region): string
     {
         /** @psalm-suppress PossiblyNullArgument */
         $endpoint = strtr($this->configuration->get('endpoint'), [
-            '%region%' => $this->configuration->get('region'),
+            '%region%' => $region ?? $this->configuration->get('region'),
             '%service%' => $this->getServiceCode(),
         ]);
         $endpoint .= $uri;
@@ -157,19 +157,20 @@ private function getEndpoint(string $uri, array $query): string
         return $endpoint . (false === \strpos($endpoint, '?') ? '?' : '&') . http_build_query($query);
     }
 
-    private function getSigner()
+    private function getSigner(?string $region)
     {
-        if (null === $this->signer) {
+        if (!isset($this->signers[$region])) {
             /** @var string $region */
-            $region = $this->configuration->get(Configuration::OPTION_REGION);
+            $region = $region ?? $this->configuration->get(Configuration::OPTION_REGION);
             $factories = $this->getSignerFactories();
             if (!isset($factories[$signatureVersion = $this->getSignatureVersion()])) {
                 throw new InvalidArgument(sprintf('The signature "%s" is not implemented.', $signatureVersion));
             }
 
-            $this->signer = $factories[$signatureVersion]($this->getSignatureScopeName(), $region);
+            $this->signers[$region] = $factories[$signatureVersion]($this->getSignatureScopeName(), $region);
         }
 
-        return $this->signer;
+        /** @psalm-suppress PossiblyNullArrayOffset */
+        return $this->signers[$region];
     }
 }

src/Input.php

@@ -9,7 +9,24 @@
  *
  * @internal
  */
-interface Input
+abstract class Input
 {
-    public function request(): Request;
+    public $region;
+
+    /**
+     * @param array{
+     *   @region?: ?string,
+     * } $input
+     */
+    protected function __construct(array $input)
+    {
+        $this->region = $input['@region'] ?? null;
+    }
+
+    public function getRegion(): ?string
+    {
+        return $this->region;
+    }
+
+    abstract public function request(): Request;
 }

src/RequestContext.php

@@ -14,6 +14,7 @@
 class RequestContext
 {
     public const AVAILABLE_OPTIONS = [
+        'region' => true,
         'operation' => true,
         'expirationDate' => true,
         'currentDate' => true,
@@ -24,6 +25,11 @@ class RequestContext
      */
     private $operation;
 
+    /**
+     * @var string|null
+     */
+    private $region;
+
     /**
      * @var \DateTimeImmutable|null
      */
@@ -37,6 +43,7 @@ class RequestContext
     /**
      * @param array{
      *  operation?: null|string
+     *  region?: null|string
      *  expirationDate?: null|\DateTimeImmutable
      *  currentDate?: null|\DateTimeImmutable
      * }
@@ -57,6 +64,11 @@ public function getOperation(): ?string
         return $this->operation;
     }
 
+    public function getRegion(): ?string
+    {
+        return $this->region;
+    }
+
     public function getExpirationDate(): ?\DateTimeImmutable
     {
         return $this->expirationDate;

src/Sts/Input/AssumeRoleRequest.php

@@ -9,7 +9,7 @@
 use AsyncAws\Core\Sts\ValueObject\PolicyDescriptorType;
 use AsyncAws\Core\Sts\ValueObject\Tag;
 
-final class AssumeRoleRequest implements Input
+final class AssumeRoleRequest extends Input
 {
     /**
      * The Amazon Resource Name (ARN) of the role to assume.
@@ -124,6 +124,7 @@ final class AssumeRoleRequest implements Input
      *   ExternalId?: string,
      *   SerialNumber?: string,
      *   TokenCode?: string,
+     *   @region?: string,
      * } $input
      */
     public function __construct(array $input = [])
@@ -138,6 +139,7 @@ public function __construct(array $input = [])
         $this->ExternalId = $input['ExternalId'] ?? null;
         $this->SerialNumber = $input['SerialNumber'] ?? null;
         $this->TokenCode = $input['TokenCode'] ?? null;
+        parent::__construct($input);
     }
 
     public static function create($input): self

src/Sts/Input/AssumeRoleWithWebIdentityRequest.php

@@ -8,7 +8,7 @@
 use AsyncAws\Core\Stream\StreamFactory;
 use AsyncAws\Core\Sts\ValueObject\PolicyDescriptorType;
 
-final class AssumeRoleWithWebIdentityRequest implements Input
+final class AssumeRoleWithWebIdentityRequest extends Input
 {
     /**
      * The Amazon Resource Name (ARN) of the role that the caller is assuming.
@@ -86,6 +86,7 @@ final class AssumeRoleWithWebIdentityRequest implements Input
      *   PolicyArns?: \AsyncAws\Core\Sts\ValueObject\PolicyDescriptorType[],
      *   Policy?: string,
      *   DurationSeconds?: int,
+     *   @region?: string,
      * } $input
      */
     public function __construct(array $input = [])
@@ -97,6 +98,7 @@ public function __construct(array $input = [])
         $this->PolicyArns = array_map([PolicyDescriptorType::class, 'create'], $input['PolicyArns'] ?? []);
         $this->Policy = $input['Policy'] ?? null;
         $this->DurationSeconds = $input['DurationSeconds'] ?? null;
+        parent::__construct($input);
     }
 
     public static function create($input): self

src/Sts/Input/GetCallerIdentityRequest.php

@@ -6,11 +6,21 @@
 use AsyncAws\Core\Request;
 use AsyncAws\Core\Stream\StreamFactory;
 
-final class GetCallerIdentityRequest implements Input
+final class GetCallerIdentityRequest extends Input
 {
+    /**
+     * @param array{
+     *   @region?: string,
+     * } $input
+     */
+    public function __construct(array $input = [])
+    {
+        parent::__construct($input);
+    }
+
     public static function create($input): self
     {
-        return $input instanceof self ? $input : new self();
+        return $input instanceof self ? $input : new self($input);
     }
 
     /**

src/Sts/StsClient.php

@@ -35,11 +35,13 @@ class StsClient extends AbstractApi
      *   ExternalId?: string,
      *   SerialNumber?: string,
      *   TokenCode?: string,
+     *   @region?: string,
      * }|AssumeRoleRequest $input
      */
     public function assumeRole($input): AssumeRoleResponse
     {
-        $response = $this->getResponse(AssumeRoleRequest::create($input)->request(), new RequestContext(['operation' => 'AssumeRole']));
+        $input = AssumeRoleRequest::create($input);
+        $response = $this->getResponse($input->request(), new RequestContext(['operation' => 'AssumeRole', 'region' => $input->getRegion()]));
 
         return new AssumeRoleResponse($response);
     }
@@ -59,11 +61,13 @@ public function assumeRole($input): AssumeRoleResponse
      *   PolicyArns?: \AsyncAws\Core\Sts\ValueObject\PolicyDescriptorType[],
      *   Policy?: string,
      *   DurationSeconds?: int,
+     *   @region?: string,
      * }|AssumeRoleWithWebIdentityRequest $input
      */
     public function assumeRoleWithWebIdentity($input): AssumeRoleWithWebIdentityResponse
     {
-        $response = $this->getResponse(AssumeRoleWithWebIdentityRequest::create($input)->request(), new RequestContext(['operation' => 'AssumeRoleWithWebIdentity']));
+        $input = AssumeRoleWithWebIdentityRequest::create($input);
+        $response = $this->getResponse($input->request(), new RequestContext(['operation' => 'AssumeRoleWithWebIdentity', 'region' => $input->getRegion()]));
 
         return new AssumeRoleWithWebIdentityResponse($response);
     }
@@ -73,11 +77,14 @@ public function assumeRoleWithWebIdentity($input): AssumeRoleWithWebIdentityResp
      *
      * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#getcalleridentity
      *
-     * @param array|GetCallerIdentityRequest $input
+     * @param array{
+     *   @region?: string,
+     * }|GetCallerIdentityRequest $input
      */
     public function getCallerIdentity($input = []): GetCallerIdentityResponse
     {
-        $response = $this->getResponse(GetCallerIdentityRequest::create($input)->request(), new RequestContext(['operation' => 'GetCallerIdentity']));
+        $input = GetCallerIdentityRequest::create($input);
+        $response = $this->getResponse($input->request(), new RequestContext(['operation' => 'GetCallerIdentity', 'region' => $input->getRegion()]));
 
         return new GetCallerIdentityResponse($response);
     }