[sns] added possibility to define already existing topics (prevent create topic call) php-enqueue#1022

Author: Igor Paramonov

pkg/sns/SnsConnectionFactory.php

@@ -24,13 +24,14 @@ class SnsConnectionFactory implements ConnectionFactory
 
     /**
      * $config = [
-     *   'key' => null                AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
+     *   '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.
      *   'region' => null,            (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
      *   'version' => '2012-11-05',   (string, required) The version of the webservice to utilize
      *   'lazy' => true,              Enable lazy connection (boolean)
-     *   'endpoint' => null           (string, default=null) The full URI of the webservice. This is only required when connecting to a custom endpoint e.g. localstack
+     *   'endpoint' => null,          (string, default=null) The full URI of the webservice. This is only required when connecting to a custom endpoint e.g. localstack
+     *   'topic_arns' => [],          (array<string>) The list of existing topic arns
      * ].
      *
      * or
@@ -71,7 +72,7 @@ public function __construct($config = 'sns:')
      */
     public function createContext(): Context
     {
-        return new SnsContext($this->establishConnection(), $this->config);
+        return new SnsContext($this->establishConnection(), $this->config, $this->config['topic_arns']);
     }
 
     private function establishConnection(): SnsClient
@@ -132,6 +133,9 @@ private function parseDsn(string $dsn): array
             'version' => $dsn->getString('version'),
             'lazy' => $dsn->getBool('lazy'),
             'endpoint' => $dsn->getString('endpoint'),
+            'topic_arns' => ($topicArns = $dsn->getString('topic_arns'))
+                ? array_filter(explode(',', $topicArns))
+                : [],
         ]), function ($value) { return null !== $value; });
     }
 
@@ -145,6 +149,7 @@ private function defaultConfig(): array
             'version' => '2010-03-31',
             'lazy' => true,
             'endpoint' => null,
+            'topic_arns' => [],
         ];
     }
 }

pkg/sns/SnsContext.php

@@ -31,12 +31,11 @@ class SnsContext implements Context
 
     private $topicArns;
 
-    public function __construct(SnsClient $client, array $config)
+    public function __construct(SnsClient $client, array $config, array $topicArns = [])
     {
         $this->client = $client;
         $this->config = $config;
-
-        $this->topicArns = [];
+        $this->topicArns = $topicArns;
     }
 
     /**

pkg/sns/Tests/SnsConnectionFactoryConfigTest.php

@@ -64,6 +64,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => true,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -77,6 +78,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => true,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -90,6 +92,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => true,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -103,6 +106,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => false,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -116,6 +120,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => false,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -129,6 +134,7 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => false,
                 'endpoint' => null,
+                'topic_arns' => [],
             ],
         ];
 
@@ -148,6 +154,24 @@ public static function provideConfigs()
                 'version' => '2010-03-31',
                 'lazy' => false,
                 'endpoint' => 'http://localstack:1111',
+                'topic_arns' => [],
+            ],
+        ];
+
+        yield [
+            ['dsn' => 'sns:?topic_arns=arn:aws:sns:us-east-1:123456789012:topic1,arn:aws:sns:us-west-2:123456789012:topic2'],
+            [
+                'key' => null,
+                'secret' => null,
+                'token' => null,
+                'region' => null,
+                'version' => '2010-03-31',
+                'lazy' => true,
+                'endpoint' => null,
+                'topic_arns' => [
+                    'arn:aws:sns:us-east-1:123456789012:topic1',
+                    'arn:aws:sns:us-west-2:123456789012:topic2',
+                ],
             ],
         ];
     }

pkg/sns/Tests/SnsConnectionFactoryTest.php

@@ -33,6 +33,7 @@ public function testCouldBeConstructedWithEmptyConfiguration()
             'region' => null,
             'version' => '2010-03-31',
             'endpoint' => null,
+             'topic_arns' => [],
         ], 'config', $factory);
     }
 
@@ -48,6 +49,7 @@ public function testCouldBeConstructedWithCustomConfiguration()
             'region' => null,
             'version' => '2010-03-31',
             'endpoint' => null,
+             'topic_arns' => [],
         ], 'config', $factory);
     }