Add more precise types for the Symfony bundle (#1490)

stof · web-flow · commit b9d7689f2d4e · 2023-07-02T08:27:19.000+02:00
diff --git a/src/Integration/Symfony/Bundle/src/DependencyInjection/AsyncAwsExtension.php b/src/Integration/Symfony/Bundle/src/DependencyInjection/AsyncAwsExtension.php
@@ -22,6 +22,9 @@
 
 class AsyncAwsExtension extends Extension
 {
+    /**
+     * @param mixed[] $configs
+     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
@@ -33,6 +36,33 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->autowireServices($container, $usedServices);
     }
 
+    /**
+     * @param array{
+     *     register_service: bool,
+     *     logger?: string|null,
+     *     http_client?: string|null,
+     *     credential_provider: string|null,
+     *     credential_provider_cache: string|null,
+     *     config: array<string, mixed>,
+     *     secrets: array{
+     *          enabled: bool,
+     *          client: string|null,
+     *          path: string|null,
+     *          recursive: bool,
+     *          cache: array{enabled: bool, pool: string, ttl: int},
+     *     },
+     *     clients: array<string, array{
+     *          type: string,
+     *          register_service: bool,
+     *          logger?: string|null,
+     *          http_client?: string|null,
+     *          credential_provider: string|null,
+     *          config: array<string, mixed>,
+     *     }>,
+     * } $config
+     *
+     * @return array<string, string|null>
+     */
     private function registerConfiguredServices(ContainerBuilder $container, array $config): array
     {
         $availableServices = AwsPackagesProvider::getAllServices();
@@ -59,6 +89,20 @@ private function registerConfiguredServices(ContainerBuilder $container, array $
         return $usedServices;
     }
 
+    /**
+     * @param array{
+     *     register_service: bool,
+     *     clients: array<string, mixed>,
+     *     logger?: string|null,
+     *     http_client?: string|null,
+     *     credential_provider: string|null,
+     *     credential_provider_cache: string|null,
+     *     config: array<string, mixed>,
+     * } $config
+     * @param array<string, string|null> $usedServices
+     *
+     * @return array<string, string|null>
+     */
     private function registerInstalledServices(ContainerBuilder $container, array $config, array $usedServices): array
     {
         if (!$config['register_service']) {
@@ -84,6 +128,17 @@ private function registerInstalledServices(ContainerBuilder $container, array $c
         return $usedServices;
     }
 
+    /**
+     * @param array{
+     *     register_service: bool,
+     *     logger?: string|null,
+     *     http_client?: string|null,
+     *     credential_provider: string|null,
+     *     credential_provider_cache: string|null,
+     *     config: array<string, mixed>,
+     *     ...
+     * } $config
+     */
     private function addServiceDefinition(ContainerBuilder $container, string $name, array $config, string $clientClass): void
     {
         if (\array_key_exists('logger', $config)) {
@@ -147,6 +202,24 @@ private function addServiceDefinition(ContainerBuilder $container, string $name,
         $container->setDefinition(sprintf('async_aws.client.%s', $name), $definition);
     }
 
+    /**
+     * @param array{
+     *     register_service: bool,
+     *     logger?: string|null,
+     *     http_client?: string|null,
+     *     credential_provider: string|null,
+     *     credential_provider_cache: string|null,
+     *     config: array<string, mixed>,
+     *     secrets: array{
+     *          enabled: bool,
+     *          client: string|null,
+     *          path: string|null,
+     *          recursive: bool,
+     *          cache: array{enabled: bool, pool: string, ttl: int},
+     *     },
+     *     clients: array<string, array{type: string, ...}>,
+     * } $config
+     */
     private function registerEnvLoader(ContainerBuilder $container, array $config): void
     {
         if (!$config['secrets']['enabled']) {
@@ -201,6 +274,9 @@ private function registerEnvLoader(ContainerBuilder $container, array $config):
         }
     }
 
+    /**
+     * @param array<string, string|null> $usedServices
+     */
     private function autowireServices(ContainerBuilder $container, array $usedServices): void
     {
         $awsServices = AwsPackagesProvider::getAllServices();
diff --git a/src/Integration/Symfony/Bundle/src/DependencyInjection/AwsPackagesProvider.php b/src/Integration/Symfony/Bundle/src/DependencyInjection/AwsPackagesProvider.php
@@ -4,8 +4,13 @@
 
 namespace AsyncAws\Symfony\Bundle\DependencyInjection;
 
+use AsyncAws\Core\AbstractApi;
+
 class AwsPackagesProvider
 {
+    /**
+     * @return array<string, array{class: class-string<AbstractApi>, package: string}>
+     */
     public static function getAllServices(): array
     {
         return [
@@ -172,6 +177,9 @@ public static function getAllServices(): array
         ];
     }
 
+    /**
+     * @return list<string>
+     */
     public static function getServiceNames(): array
     {
         $services = self::getAllServices();
diff --git a/src/Integration/Symfony/Bundle/src/DependencyInjection/Configuration.php b/src/Integration/Symfony/Bundle/src/DependencyInjection/Configuration.php
@@ -63,7 +63,12 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    private static function validateType(?array $clients)
+    /**
+     * @param null|array<string, array{type?: string, ...}> $clients
+     *
+     * @return array<string, array{type?: string, ...}>
+     */
+    private static function validateType(?array $clients): array
     {
         if (null === $clients) {
             return [];
diff --git a/src/Integration/Symfony/Bundle/src/Secrets/CachedEnvVarLoader.php b/src/Integration/Symfony/Bundle/src/Secrets/CachedEnvVarLoader.php
@@ -8,10 +8,19 @@
 
 class CachedEnvVarLoader implements EnvVarLoaderInterface
 {
+    /**
+     * @var EnvVarLoaderInterface
+     */
     private $decorated;
 
+    /**
+     * @var CacheInterface
+     */
     private $cache;
 
+    /**
+     * @var int
+     */
     private $ttl;
 
     public function __construct(EnvVarLoaderInterface $decorated, CacheInterface $cache, int $ttl)
diff --git a/src/Integration/Symfony/Bundle/src/Secrets/SsmVault.php b/src/Integration/Symfony/Bundle/src/Secrets/SsmVault.php
@@ -8,10 +8,19 @@
 
 class SsmVault implements EnvVarLoaderInterface
 {
+    /**
+     * @var SsmClient
+     */
     private $client;
 
+    /**
+     * @var string
+     */
     private $path;
 
+    /**
+     * @var bool
+     */
     private $recursive;
 
     public function __construct(SsmClient $client, ?string $path, bool $recursive)
diff --git a/src/Integration/Symfony/Bundle/src/VarDumper/ResultCaster.php b/src/Integration/Symfony/Bundle/src/VarDumper/ResultCaster.php
@@ -9,7 +9,12 @@
 
 class ResultCaster
 {
-    public static function castResult(Result $result, array $a, Stub $stub, bool $isNested)
+    /**
+     * @param array<string, mixed> $a
+     *
+     * @return array<string, mixed>
+     */
+    public static function castResult(Result $result, array $a, Stub $stub, bool $isNested): array
     {
         foreach (["\0AsyncAws\\Core\\Result\0httpClient", "\0AsyncAws\\Core\\Result\0response", "\0AsyncAws\\Core\\Result\0prefetchResults", Caster::PREFIX_PROTECTED . 'awsClient', Caster::PREFIX_PROTECTED . 'input'] as $k) {
             if (\array_key_exists($k, $a)) {
@@ -21,7 +26,12 @@ public static function castResult(Result $result, array $a, Stub $stub, bool $is
         return $a;
     }
 
-    public static function castWaiter(Waiter $waiter, array $a, Stub $stub, bool $isNested)
+    /**
+     * @param array<string, mixed> $a
+     *
+     * @return array<string, mixed>
+     */
+    public static function castWaiter(Waiter $waiter, array $a, Stub $stub, bool $isNested): array
     {
         foreach (["\0AsyncAws\\Core\\Waiter\0httpClient", "\0AsyncAws\\Core\\Waiter\0response", Caster::PREFIX_PROTECTED . 'awsClient', Caster::PREFIX_PROTECTED . 'input'] as $k) {
             if (\array_key_exists($k, $a)) {

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,13 @@`
`4`	`4`
`5`	`5`	`namespace AsyncAws\Symfony\Bundle\DependencyInjection;`
`6`	`6`
	`7`	`+use AsyncAws\Core\AbstractApi;`
	`8`	`+`
`7`	`9`	`class AwsPackagesProvider`
`8`	`10`	`{`
	`11`	`+ /**`
	`12`	`+ * @return array<string, array{class: class-string<AbstractApi>, package: string}>`
	`13`	`+ */`
`9`	`14`	`public static function getAllServices(): array`
`10`	`15`	`{`
`11`	`16`	`return [`
`@@ -172,6 +177,9 @@ public static function getAllServices(): array`
`172`	`177`	`];`
`173`	`178`	`}`
`174`	`179`
	`180`	`+ /**`
	`181`	`+ * @return list<string>`
	`182`	`+ */`
`175`	`183`	`public static function getServiceNames(): array`
`176`	`184`	`{`
`177`	`185`	`$services = self::getAllServices();`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,12 @@ public function getConfigTreeBuilder(): TreeBuilder`
`63`	`63`	`return $treeBuilder;`
`64`	`64`	`}`
`65`	`65`
`66`		`- private static function validateType(?array $clients)`
	`66`	`+ /**`
	`67`	`+ * @param null\|array<string, array{type?: string, ...}> $clients`
	`68`	`+ *`
	`69`	`+ * @return array<string, array{type?: string, ...}>`
	`70`	`+ */`
	`71`	`+ private static function validateType(?array $clients): array`
`67`	`72`	`{`
`68`	`73`	`if (null === $clients) {`
`69`	`74`	`return [];`