feature: add ability to inject a custom S3 client on aws s3 resolver

Author: deguif

DependencyInjection/Factory/Resolver/AwsS3ResolverFactory.php

@@ -12,6 +12,8 @@
 namespace Liip\ImagineBundle\DependencyInjection\Factory\Resolver;
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
@@ -21,10 +23,15 @@ class AwsS3ResolverFactory extends AbstractResolverFactory
     public function create(ContainerBuilder $container, $resolverName, array $config)
     {
         $awsS3ClientId = 'liip_imagine.cache.resolver.'.$resolverName.'.client';
-        $awsS3ClientDefinition = new Definition('Aws\S3\S3Client');
-        $awsS3ClientDefinition->setFactory(['Aws\S3\S3Client', 'factory']);
-        $awsS3ClientDefinition->addArgument($config['client_config']);
-        $container->setDefinition($awsS3ClientId, $awsS3ClientDefinition);
+
+        if ($config['client_id']) {
+            $container->setAlias($awsS3ClientId, new Alias($config['client_id']));
+        } else {
+            $awsS3ClientDefinition = new Definition('Aws\S3\S3Client');
+            $awsS3ClientDefinition->setFactory(['Aws\S3\S3Client', 'factory']);
+            $awsS3ClientDefinition->addArgument($config['client_config']);
+            $container->setDefinition($awsS3ClientId, $awsS3ClientDefinition);
+        }
 
         $resolverDefinition = $this->getChildResolverDefinition();
         $resolverDefinition->replaceArgument(0, new Reference($awsS3ClientId));
@@ -94,6 +101,9 @@ public function addConfiguration(ArrayNodeDefinition $builder)
                 ->scalarNode('cache_prefix')
                     ->defaultValue('')
                 ->end()
+                ->scalarNode('client_id')
+                    ->defaultNull()
+                ->end()
                 ->arrayNode('client_config')
                     ->isRequired()
                     ->prototype('variable')
@@ -116,6 +126,22 @@ public function addConfiguration(ArrayNodeDefinition $builder)
                         ->prototype('scalar')
                     ->end()
                 ->end()
+            ->end()
+            ->beforeNormalization()
+                ->ifTrue(static function ($v) {
+                    return isset($v['client_id']) && isset($v['client_config']);
+                })
+                ->thenInvalid('Children config "client_id" and "client_config" cannot be configured at the same time.')
+            ->end()
+            ->beforeNormalization()
+                ->ifTrue(static function ($v) {
+                    return isset($v['client_id']);
+                })
+                ->then(function ($config) {
+                    $config['client_config'] = [];
+
+                    return $config;
+                })
             ->end();
     }
 }

Tests/DependencyInjection/Factory/Resolver/AwsS3ResolverFactoryTest.php

@@ -54,6 +54,7 @@ public function testCreateResolverDefinitionOnCreate(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'theBucket',
             'acl' => 'theAcl',
@@ -85,6 +86,7 @@ public function testCreateS3ClientDefinitionOnCreate(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => ['theClientConfigKey' => 'theClientConfigVal'],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -108,6 +110,7 @@ public function testCreateS3ClientDefinitionWithFactoryOnCreate(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => ['theClientConfigKey' => 'theClientConfigVal'],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -121,13 +124,37 @@ public function testCreateS3ClientDefinitionWithFactoryOnCreate(): void
         $this->assertSame([S3Client::class, 'factory'], $clientDefinition->getFactory());
     }
 
+    public function testCreateS3ClientAliasOnCreate(): void
+    {
+        $container = new ContainerBuilder();
+
+        $resolver = new AwsS3ResolverFactory();
+
+        $resolver->create($container, 'the_resolver_name', [
+            'client_id' => 's3.client.default',
+            'client_config' => [],
+            'bucket' => 'aBucket',
+            'acl' => 'aAcl',
+            'get_options' => [],
+            'put_options' => [],
+            'cache' => false,
+            'proxies' => [],
+        ]);
+
+        $this->assertTrue($container->hasAlias('liip_imagine.cache.resolver.the_resolver_name.client'));
+
+        $clientAlias = $container->getAlias('liip_imagine.cache.resolver.the_resolver_name.client');
+        $this->assertSame('s3.client.default', (string) $clientAlias);
+    }
+
     public function testWrapResolverWithProxyOnCreateWithoutCache(): void
     {
         $container = new ContainerBuilder();
 
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -162,6 +189,7 @@ public function testWrapResolverWithCacheOnCreateWithoutProxy(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -197,6 +225,7 @@ public function testWrapResolverWithProxyAndCacheOnCreate(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -240,6 +269,7 @@ public function testWrapResolverWithProxyMatchReplaceStrategyOnCreate(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -272,6 +302,7 @@ public function testSetCachePrefixIfDefined(): void
         $resolver = new AwsS3ResolverFactory();
 
         $resolver->create($container, 'the_resolver_name', [
+            'client_id' => null,
             'client_config' => [],
             'bucket' => 'aBucket',
             'acl' => 'aAcl',
@@ -311,7 +342,7 @@ public function testThrowBucketNotSetOnAddConfiguration(): void
     public function testThrowClientConfigNotSetOnAddConfiguration(): void
     {
         $this->expectException(\Symfony\Component\Config\Definition\Exception\InvalidConfigurationException::class);
-        $this->expectExceptionMessageMatchesBC('/^The child (node|config) "client_config" (at path|under) "aws_s3" must be configured\.$/');
+        $this->expectExceptionMessageMatchesBC('/^At least "client_id" or "client_config" child config under "aws_s3" must be configured.$/');
 
         $treeBuilder = new TreeBuilder('aws_s3');
         $rootNode = method_exists(TreeBuilder::class, 'getRootNode')