Add missing types in Core (#1475)

* Add missing types in Core

* Regenerate the Psalm baseline

Those errors are false positives due to a type declaration in
symfony/http-client that is not precise enough.

Author: stof

phpstan.neon.dist

@@ -11,8 +11,6 @@ parameters:
         - src/*/tests/*
         - src/**/tests/*
         - src/CodeGenerator/src/Generator/TestGenerator.php
-        - src/Core/src/AbstractApi.php # requires symfony/http-client: 5.2
-        - src/Core/src/HttpClient/AwsRetryStrategy.php # requires symfony/http-client: 5.2
         - src/Core/src/Test/TestCase.php
         - src/Integration/Laravel/Filesystem/src/AsyncAwsFilesystemManager.php
         - src/Integration/Laravel/Filesystem/src/AsyncAwsFilesystemAdapter.php

psalm.baseline.xml

@@ -35,6 +35,14 @@
         }]]></code>
     </InvalidCatch>
   </file>
+  <file src="src/Core/src/Response.php">
+    <LessSpecificReturnStatement>
+      <code><![CDATA[$this->httpResponse->getHeaders(false)]]></code>
+    </LessSpecificReturnStatement>
+    <MoreSpecificReturnType>
+      <code><![CDATA[array<string, list<string>>]]></code>
+    </MoreSpecificReturnType>
+  </file>
   <file src="src/Core/src/Waiter.php">
     <PossiblyUndefinedVariable>
       <code>$exception</code>

src/Core/src/AbstractApi.php

@@ -10,6 +10,7 @@
 use AsyncAws\Core\Credentials\ChainProvider;
 use AsyncAws\Core\Credentials\CredentialProvider;
 use AsyncAws\Core\EndpointDiscovery\EndpointCache;
+use AsyncAws\Core\EndpointDiscovery\EndpointInterface;
 use AsyncAws\Core\Exception\InvalidArgument;
 use AsyncAws\Core\Exception\LogicException;
 use AsyncAws\Core\Exception\RuntimeException;
@@ -47,7 +48,7 @@ abstract class AbstractApi
     private $credentialProvider;
 
     /**
-     * @var Signer[]
+     * @var array<string, Signer>
      */
     private $signers;
 
@@ -67,7 +68,7 @@ abstract class AbstractApi
     private $endpointCache;
 
     /**
-     * @param Configuration|array $configuration
+     * @param Configuration|array<Configuration::OPTION_*, string|null> $configuration
      */
     public function __construct($configuration = [], ?CredentialProvider $credentialProvider = null, ?HttpClientInterface $httpClient = null, ?LoggerInterface $logger = null)
     {
@@ -151,7 +152,7 @@ final protected function getResponse(Request $request, ?RequestContext $context
             $request->setHeader('content-length', (string) $length);
         }
 
-        // Some servers (like testing Docker Images) does not supports `Transfer-Encoding: chunked` requests.
+        // Some servers (like testing Docker Images) does not support `Transfer-Encoding: chunked` requests.
         // The body is converted into string to prevent curl using `Transfer-Encoding: chunked` unless it really has to.
         if (($requestBody = $request->getBody()) instanceof StringStream) {
             $requestBody = $requestBody->stringify();
@@ -178,7 +179,7 @@ final protected function getResponse(Request $request, ?RequestContext $context
     }
 
     /**
-     * @return callable[]
+     * @return array<string, callable(string, string): Signer>
      */
     protected function getSignerFactories(): array
     {
@@ -229,9 +230,9 @@ protected function getEndpointMetadata(?string $region): array
     /**
      * Build the endpoint full uri.
      *
-     * @param string  $uri    or path
-     * @param array   $query  parameters that should go in the query string
-     * @param ?string $region region provided by the user in the `@region` parameter of the Input
+     * @param string                $uri    or path
+     * @param array<string, string> $query  parameters that should go in the query string
+     * @param ?string               $region region provided by the user in the `@region` parameter of the Input
      */
     protected function getEndpoint(string $uri, array $query, ?string $region): string
     {
@@ -263,11 +264,19 @@ protected function getEndpoint(string $uri, array $query, ?string $region): stri
         return $endpoint . (false === strpos($endpoint, '?') ? '?' : '&') . http_build_query($query, '', '&', \PHP_QUERY_RFC3986);
     }
 
+    /**
+     * @return EndpointInterface[]
+     */
     protected function discoverEndpoints(?string $region): array
     {
         throw new LogicException(sprintf('The Client "%s" must implement the "%s" method.', \get_class($this), 'discoverEndpoints'));
     }
 
+    /**
+     * @param array<string, string> $query
+     *
+     * @return string
+     */
     private function getDiscoveredEndpoint(string $uri, array $query, ?string $region, bool $usesEndpointDiscovery, bool $requiresEndpointDiscovery)
     {
         if (!$this->configuration->isDefault('endpoint')) {
@@ -314,7 +323,7 @@ private function getDiscoveredEndpoint(string $uri, array $query, ?string $regio
     /**
      * @param ?string $region region provided by the user in the `@region` parameter of the Input
      */
-    private function getSigner(?string $region)
+    private function getSigner(?string $region): Signer
     {
         /** @var string $region */
         $region = $region ?? ($this->configuration->isDefault('region') ? null : $this->configuration->get('region'));

src/Core/src/AwsClientFactory.php

@@ -61,7 +61,7 @@
 class AwsClientFactory
 {
     /**
-     * @var array
+     * @var array<string, mixed>
      */
     private $serviceCache;
 
@@ -86,7 +86,7 @@ class AwsClientFactory
     private $logger;
 
     /**
-     * @param Configuration|array $configuration
+     * @param Configuration|array<Configuration::OPTION_*, string|null> $configuration
      */
     public function __construct($configuration = [], ?CredentialProvider $credentialProvider = null, ?HttpClientInterface $httpClient = null, ?LoggerInterface $logger = null)
     {

src/Core/src/AwsError/AwsError.php

@@ -7,12 +7,24 @@
  */
 final class AwsError
 {
+    /**
+     * @var string|null
+     */
     private $code;
 
+    /**
+     * @var string|null
+     */
     private $message;
 
+    /**
+     * @var string|null
+     */
     private $type;
 
+    /**
+     * @var string|null
+     */
     private $detail;
 
     public function __construct(?string $code, ?string $message, ?string $type, ?string $detail)

src/Core/src/AwsError/AwsErrorFactoryInterface.php

@@ -11,5 +11,8 @@ interface AwsErrorFactoryInterface
 {
     public function createFromResponse(ResponseInterface $response): AwsError;
 
+    /**
+     * @param array<string, list<string>> $headers
+     */
     public function createFromContent(string $content, array $headers): AwsError;
 }

src/Core/src/AwsError/ChainAwsErrorFactory.php

@@ -11,6 +11,9 @@ class ChainAwsErrorFactory implements AwsErrorFactoryInterface
 {
     use AwsErrorFactoryFromResponseTrait;
 
+    /**
+     * @var AwsErrorFactoryInterface[]
+     */
     private $factories;
 
     /**

src/Core/src/AwsError/JsonRestAwsErrorFactory.php

@@ -23,6 +23,10 @@ public function createFromContent(string $content, array $headers): AwsError
         }
     }
 
+    /**
+     * @param array<string, mixed>        $body
+     * @param array<string, list<string>> $headers
+     */
     private static function parseJson(array $body, array $headers): AwsError
     {
         $code = null;

src/Core/src/AwsError/JsonRpcAwsErrorFactory.php

@@ -23,6 +23,10 @@ public function createFromContent(string $content, array $headers): AwsError
         }
     }
 
+    /**
+     * @param array<string, mixed>        $body
+     * @param array<string, list<string>> $headers
+     */
     private static function parseJson(array $body, array $headers): AwsError
     {
         $code = null;

src/Core/src/Configuration.php

@@ -88,11 +88,20 @@ final class Configuration
         self::OPTION_ENDPOINT_DISCOVERY_ENABLED => 'false',
     ];
 
+    /**
+     * @var array<self::OPTION_*, string|null>
+     */
     private $data = [];
 
+    /**
+     * @var array<self::OPTION_*, bool>
+     */
     private $userData = [];
 
-    public static function create(array $options)
+    /**
+     * @param array<self::OPTION_*, string|null> $options
+     */
+    public static function create(array $options): self
     {
         if (0 < \count($invalidOptions = array_diff_key($options, self::AVAILABLE_OPTIONS))) {
             throw new InvalidArgument(sprintf('Invalid option(s) "%s" passed to "%s::%s". ', implode('", "', array_keys($invalidOptions)), __CLASS__, __METHOD__));
@@ -118,6 +127,8 @@ public static function optionExists(string $optionName): bool
     }
 
     /**
+     * @param self::OPTION_* $name
+     *
      * @psalm-return (
      *     $name is
      *       self::OPTION_REGION
@@ -141,6 +152,9 @@ public function get(string $name): ?string
         return $this->data[$name] ?? null;
     }
 
+    /**
+     * @param self::OPTION_* $name
+     */
     public function has(string $name): bool
     {
         if (!isset(self::AVAILABLE_OPTIONS[$name])) {
@@ -150,6 +164,9 @@ public function has(string $name): bool
         return isset($this->data[$name]);
     }
 
+    /**
+     * @param self::OPTION_* $name
+     */
     public function isDefault(string $name): bool
     {
         if (!isset(self::AVAILABLE_OPTIONS[$name])) {
@@ -159,6 +176,11 @@ public function isDefault(string $name): bool
         return empty($this->userData[$name]);
     }
 
+    /**
+     * @param array<self::OPTION_*, string|null> $options
+     *
+     * @return array<self::OPTION_*, string|null>
+     */
     private static function parseEnvironmentVariables(array $options): array
     {
         foreach (self::FALLBACK_OPTIONS as $fallbackGroup) {
@@ -187,6 +209,8 @@ private static function parseEnvironmentVariables(array $options): array
 
     /**
      * Look for "region" in the configured ini files.
+     *
+     * @return array<self::OPTION_*, string|null>
      */
     private static function parseIniFiles(Configuration $configuration): array
     {
@@ -215,6 +239,8 @@ private static function parseIniFiles(Configuration $configuration): array
 
     /**
      * Add array options to the configuration object.
+     *
+     * @param array<self::OPTION_*, string|null> $options
      */
     private static function populateConfiguration(Configuration $configuration, array $options): void
     {

src/Core/src/Credentials/CacheProvider.php

@@ -17,10 +17,13 @@
 final class CacheProvider implements CredentialProvider, ResetInterface
 {
     /**
-     * @var (Credentials|null)[]
+     * @var array<string, Credentials|null>
      */
     private $cache = [];
 
+    /**
+     * @var CredentialProvider
+     */
     private $decorated;
 
     public function __construct(CredentialProvider $decorated)

src/Core/src/Credentials/ChainProvider.php

@@ -21,15 +21,18 @@
  */
 final class ChainProvider implements CredentialProvider, ResetInterface
 {
+    /**
+     * @var iterable<CredentialProvider>
+     */
     private $providers;
 
     /**
-     * @var (CredentialProvider|null)[]
+     * @var array<string, CredentialProvider|null>
      */
     private $lastSuccessfulProvider = [];
 
     /**
-     * @param CredentialProvider[] $providers
+     * @param iterable<CredentialProvider> $providers
      */
     public function __construct(iterable $providers)
     {

src/Core/src/Credentials/ConfigurationProvider.php

@@ -20,8 +20,14 @@ final class ConfigurationProvider implements CredentialProvider
 {
     use DateFromResult;
 
+    /**
+     * @var LoggerInterface
+     */
     private $logger;
 
+    /**
+     * @var HttpClientInterface|null
+     */
     private $httpClient;
 
     public function __construct(?HttpClientInterface $httpClient = null, ?LoggerInterface $logger = null)

src/Core/src/Credentials/ContainerProvider.php

@@ -22,10 +22,19 @@ final class ContainerProvider implements CredentialProvider
 {
     private const ENDPOINT = 'http://169.254.170.2';
 
+    /**
+     * @var LoggerInterface
+     */
     private $logger;
 
+    /**
+     * @var HttpClientInterface
+     */
     private $httpClient;
 
+    /**
+     * @var float
+     */
     private $timeout;
 
     public function __construct(?HttpClientInterface $httpClient = null, ?LoggerInterface $logger = null, float $timeout = 1.0)

src/Core/src/Credentials/Credentials.php

@@ -15,12 +15,24 @@ final class Credentials implements CredentialProvider
 {
     private const EXPIRATION_DRIFT = 30;
 
+    /**
+     * @var string
+     */
     private $accessKeyId;
 
+    /**
+     * @var string
+     */
     private $secretKey;
 
+    /**
+     * @var string|null
+     */
     private $sessionToken;
 
+    /**
+     * @var \DateTimeImmutable|null
+     */
     private $expireDate;
 
     public function __construct(

src/Core/src/Credentials/IniFileLoader.php

@@ -24,6 +24,9 @@ final class IniFileLoader
     public const KEY_SOURCE_PROFILE = 'source_profile';
     public const KEY_WEB_IDENTITY_TOKEN_FILE = 'web_identity_token_file';
 
+    /**
+     * @var LoggerInterface
+     */
     private $logger;
 
     public function __construct(?LoggerInterface $logger = null)
@@ -34,7 +37,7 @@ public function __construct(?LoggerInterface $logger = null)
     /**
      * @param string[] $filepaths
      *
-     * @return string[][]
+     * @return array<string, array<string, string>>
      */
     public function loadProfiles(array $filepaths): array
     {
@@ -83,6 +86,9 @@ private function getHomeDir(): string
         return ($homeDrive && $homePath) ? $homeDrive . $homePath : '/';
     }
 
+    /**
+     * @return array<string, string[]>
+     */
     private function parseIniFile(string $filepath): array
     {
         if (false === $data = parse_ini_string(