Merge pull request #444 from elazar/feature/sqs-connection-factory-client

WIP: Add support for using a pre-configured client with the SQS driver

Author: makasim

docs/bundle/config_reference.md

@@ -228,6 +228,7 @@ enqueue:
             polling_interval:     1000
             lazy:                 true
         sqs:
+            client:               null
             key:                  null
             secret:               null
             token:                null

docs/transport/sqs.md

@@ -34,6 +34,10 @@ $factory = new SqsConnectionFactory('sqs:?key=aKey&secret=aSecret&region=aRegion
 
 $psrContext = $factory->createContext();
 
+// using a pre-configured client
+$client = new Aws\Sqs\SqsClient([ /* ... */ ]);
+$factory = new SqsConnectionFactory($client);
+
 // if you have enqueue/enqueue library installed you can use a function from there to create the context
 $psrContext = \Enqueue\dsn_to_context('sqs:');
 ```
@@ -109,4 +113,4 @@ $fooQueue = $psrContext->createQueue('foo');
 $psrContext->purge($fooQueue);
 ```
 
-[back to index](../index.md)
+[back to index](../index.md)

pkg/enqueue-bundle/Tests/Functional/App/config/custom-config.yml

@@ -1,7 +1,9 @@
 parameters:
     locale: 'en'
     secret: 'ThisTokenIsNotSoSecretChangeIt'
-
+    env(AWS_SQS_REGION): 'us-east-1'
+    env(AWS_SQS_KEY): 'key'
+    env(AWS_SQS_SECRET): 'secret'
 
 framework:
     #esi:             ~
@@ -33,3 +35,14 @@ services:
         public: true
         tags:
             - { name: 'enqueue.client.processor' }
+
+    test.sqs_client:
+        public: true
+        class: Aws\Sqs\SqsClient
+        arguments:
+            -
+                region: '%env(AWS_SQS_REGION)%'
+                version: '2012-11-05'
+                credentials:
+                    key: '%env(AWS_SQS_KEY)%'
+                    secret: '%env(AWS_SQS_SECRET)%'

pkg/enqueue-bundle/Tests/Functional/UseCasesTest.php

@@ -204,6 +204,15 @@ public function provideEnqueueConfigs()
                     ],
                 ],
             ]];
+
+            yield 'sqs_client' => [[
+                'transport' => [
+                    'default' => 'sqs',
+                    'sqs' => [
+                        'client' => 'test.sqs_client',
+                    ],
+                ],
+            ]];
         }
 
         yield 'mongodb_dsn' => [[

pkg/sqs/SqsConnectionFactory.php

@@ -34,11 +34,16 @@ class SqsConnectionFactory implements PsrConnectionFactory
      * sqs:
      * sqs::?key=aKey&secret=aSecret&token=aToken
      *
-     * @param array|string|null $config
+     * @param array|string|SqsClient|null $config
      */
     public function __construct($config = 'sqs:')
     {
-        if (empty($config) || 'sqs:' === $config) {
+        if ($config instanceof SqsClient) {
+            $this->client = $config;
+            $this->config = ['lazy' => false] + $this->defaultConfig();
+
+            return;
+        } elseif (empty($config) || 'sqs:' === $config) {
             $config = [];
         } elseif (is_string($config)) {
             $config = $this->parseDsn($config);

pkg/sqs/Symfony/SqsTransportFactory.php

@@ -34,10 +34,11 @@ public function addConfiguration(ArrayNodeDefinition $builder)
     {
         $builder
             ->children()
+                ->scalarNode('client')->defaultNull()->end()
                 ->scalarNode('key')->defaultNull()->end()
                 ->scalarNode('secret')->defaultNull()->end()
                 ->scalarNode('token')->defaultNull()->end()
-                ->scalarNode('region')->isRequired()->end()
+                ->scalarNode('region')->end()
                 ->integerNode('retries')->defaultValue(3)->end()
                 ->scalarNode('version')->cannotBeEmpty()->defaultValue('2012-11-05')->end()
                 ->booleanNode('lazy')
@@ -53,8 +54,10 @@ public function addConfiguration(ArrayNodeDefinition $builder)
      */
     public function createConnectionFactory(ContainerBuilder $container, array $config)
     {
+        $arguments = empty($config['client']) ? $config : new Reference($config['client']);
+
         $factory = new Definition(SqsConnectionFactory::class);
-        $factory->setArguments([$config]);
+        $factory->setArguments([$arguments]);
 
         $factoryId = sprintf('enqueue.transport.%s.connection_factory', $this->getName());
         $container->setDefinition($factoryId, $factory);

pkg/sqs/Tests/SqsConnectionFactoryTest.php

@@ -2,6 +2,7 @@
 
 namespace Enqueue\Sqs\Tests;
 
+use Aws\Sqs\SqsClient;
 use Enqueue\Sqs\SqsConnectionFactory;
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Test\ClassExtensionTrait;
@@ -48,6 +49,18 @@ public function testCouldBeConstructedWithCustomConfiguration()
         ], 'config', $factory);
     }
 
+    public function testCouldBeConstructedWithClient()
+    {
+        $client = $this->createMock(SqsClient::class);
+
+        $factory = new SqsConnectionFactory($client);
+
+        $context = $factory->createContext();
+
+        $this->assertInstanceOf(SqsContext::class, $context);
+        $this->assertAttributeSame($client, 'client', $context);
+    }
+
     public function testShouldCreateLazyContext()
     {
         $factory = new SqsConnectionFactory(['lazy' => true]);

pkg/sqs/Tests/Symfony/SqsTransportFactoryTest.php

@@ -64,6 +64,7 @@ public function testShouldAllowAddConfiguration()
             'version' => 'theVersion',
             'lazy' => false,
             'endpoint' => 'theEndpoint',
+            'client' => null,
         ], $config);
     }