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

Author: Instagram Story Tutorials Real's

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' => $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/UseCasesTest.php

@@ -51,7 +51,7 @@ public function provideEnqueueConfigs()
 
  $certDir = $baseDir.'/var/rabbitmq_certificates';
  $this->assertDirectoryExists($certDir);
-
+/*
  yield 'amqp' => [[
  'transport' => [
  'default' => 'amqp',
@@ -204,6 +204,17 @@ public function provideEnqueueConfigs()
  ],
  ],
  ]];
+*/
+
+ yield 'sqs_client' => [[
+ 'transport' => [
+ 'default' => 'sqs',
+ 'sqs' => [
+ 'client' => '@Aws\Sqs\SqsClient',
+ ],
+ ],
+ ]];
+/*
  }
 
  yield 'mongodb_dsn' => [[
@@ -212,7 +223,7 @@ public function provideEnqueueConfigs()
  'mongodb' => getenv('MONGO_DSN'),
  ],
  ]];
-
+ */
 // yield 'gps' => [[
 // 'transport' => [
 // 'default' => 'gps',

pkg/sqs/SqsConnectionFactory.php

@@ -19,6 +19,7 @@ class SqsConnectionFactory implements PsrConnectionFactory
 
  /**
  * $config = [
+ * 'client' => null, - Pre-configured instance of Aws\Sqs\SqsClient. If provided, all other settings except for 'lazy' are ignored.
  * 'key' => null - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
  * 'secret' => null, - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
  * 'token' => null, - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
@@ -38,7 +39,9 @@ class SqsConnectionFactory implements PsrConnectionFactory
  */
  public function __construct($config = 'sqs:')
  {
- if (empty($config) || 'sqs:' === $config) {
+ if (is_array($config) && isset($config['client']) && $config['client'] instanceof SqsClient) {
+ $this->client = $config['client'];
+ } elseif (empty($config) || 'sqs:' === $config) {
  $config = [];
  } elseif (is_string($config)) {
  $config = $this->parseDsn($config);

pkg/sqs/Symfony/SqsTransportFactory.php

@@ -34,6 +34,7 @@ public function addConfiguration(ArrayNodeDefinition $builder)
  {
  $builder
  ->children()
+ ->scalarNode('client')->defaultNull()->end()
  ->scalarNode('key')->defaultNull()->end()
  ->scalarNode('secret')->defaultNull()->end()
  ->scalarNode('token')->defaultNull()->end()

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,21 @@ public function testCouldBeConstructedWithCustomConfiguration()
  ], 'config', $factory);
  }
 
+ public function testCouldBeConstructedWithClient()
+ {
+ $client = $this->createMock(SqsClient::class);
+
+ $factory = new SqsConnectionFactory([
+ 'client' => $client,
+ 'lazy' => false,
+ ]);
+
+ $context = $factory->createContext();
+
+ $this->assertInstanceOf(SqsContext::class, $context);
+ $this->assertAttributeSame($client, 'client', $context);
+ }
+
  public function testShouldCreateLazyContext()
  {
  $factory = new SqsConnectionFactory(['lazy' => true]);