add functionality to enable/disable auto topic & subscription creation

Author: matthewgoslett

README.md

@@ -26,6 +26,7 @@ $client = new \Google\Cloud\PubSub\PubSubClient([
 
 $adapter = new \Superbalist\PubSub\GoogleCloud\GoogleCloudPubSubAdapter($client);
 
+
 // consume messages
 // note: this is a blocking call
 $adapter->subscribe('my_channel', function ($message) {
@@ -37,6 +38,10 @@ $adapter->publish('my_channel', 'HELLO WORLD');
 $adapter->publish('my_channel', json_encode(['hello' => 'world']));
 $adapter->publish('my_channel', 1);
 $adapter->publish('my_channel', false);
+
+// disable auto topic & subscription creation
+$adapter->setAutoCreateTopics(false); // this is true by default
+$adapter->setAutoCreateSubscriptions(false); // this is true by default
 ```
 
 ## Examples

changelog.md

@@ -3,8 +3,7 @@
 ## 1.0.1 - ?
 
 * Ack messages individually after callable returns successfully
-
-* Initial release
+* Add functionality to enable/disable auto topic & subscription creation
 
 ## 1.0.0 - 2016-09-05
 

src/GoogleCloudPubSubAdapter.php

@@ -13,12 +13,26 @@ class GoogleCloudPubSubAdapter implements PubSubAdapterInterface
      */
     protected $client;
 
+    /**
+     * @var bool
+     */
+    protected $autoCreateTopics;
+
+    /**
+     * @var bool
+     */
+    protected $autoCreateSubscriptions;
+
     /**
      * @param PubSubClient $client
+     * @param bool $autoCreateTopics
+     * @param bool $autoCreateSubscriptions
      */
-    public function __construct(PubSubClient $client)
+    public function __construct(PubSubClient $client, $autoCreateTopics = true, $autoCreateSubscriptions = true)
     {
         $this->client = $client;
+        $this->autoCreateTopics = $autoCreateTopics;
+        $this->autoCreateSubscriptions = $autoCreateSubscriptions;
     }
 
     /**
@@ -31,6 +45,46 @@ public function getClient()
         return $this->client;
     }
 
+    /**
+     * Set whether or not topics will be auto created.
+     *
+     * @param bool $autoCreateTopics
+     */
+    public function setAutoCreateTopics($autoCreateTopics)
+    {
+        $this->autoCreateTopics = $autoCreateTopics;
+    }
+
+    /**
+     * Check whether or not topics will be auto created.
+     *
+     * @return bool
+     */
+    public function areTopicsAutoCreated()
+    {
+        return $this->autoCreateTopics;
+    }
+
+    /**
+     * Set whether or not subscriptions will be auto created.
+     *
+     * @param bool $autoCreateSubscriptions
+     */
+    public function setAutoCreateSubscriptions($autoCreateSubscriptions)
+    {
+        $this->autoCreateSubscriptions = $autoCreateSubscriptions;
+    }
+
+    /**
+     * Check whether or not subscriptions will be auto created.
+     *
+     * @return bool
+     */
+    public function areSubscriptionsAutoCreated()
+    {
+        return $this->autoCreateSubscriptions;
+    }
+
     /**
      * Subscribe a handler to a channel.
      *
@@ -85,7 +139,7 @@ public function publish($channel, $message)
     protected function getTopicForChannel($channel)
     {
         $topic = $this->client->topic($channel);
-        if (!$topic->exists()) {
+        if ($this->autoCreateTopics && !$topic->exists()) {
             $topic->create();
         }
         return $topic;
@@ -103,7 +157,7 @@ protected function getSubscriptionForChannel($channel)
     {
         $topic = $this->getTopicForChannel($channel);
         $subscription = $topic->subscription($channel);
-        if (!$subscription->exists()) {
+        if ($this->autoCreateSubscriptions && !$subscription->exists()) {
             $subscription->create();
         }
         return $subscription;

tests/GoogleCloudPubSubAdapterTest.php

@@ -18,6 +18,26 @@ public function testGetClient()
         $this->assertSame($client, $adapter->getClient());
     }
 
+    public function testGetSetAutoCreateTopics()
+    {
+        $client = Mockery::mock(PubSubClient::class);
+        $adapter = new GoogleCloudPubSubAdapter($client);
+        $this->assertTrue($adapter->areTopicsAutoCreated());
+
+        $adapter->setAutoCreateTopics(false);
+        $this->assertFalse($adapter->areTopicsAutoCreated());
+    }
+
+    public function testGetSetAutoCreateSubscriptions()
+    {
+        $client = Mockery::mock(PubSubClient::class);
+        $adapter = new GoogleCloudPubSubAdapter($client);
+        $this->assertTrue($adapter->areSubscriptionsAutoCreated());
+
+        $adapter->setAutoCreateSubscriptions(false);
+        $this->assertFalse($adapter->areSubscriptionsAutoCreated());
+    }
+
     public function testPublishWhenTopicMustBeCreated()
     {
         $topic = Mockery::mock(Topic::class);
@@ -49,7 +69,7 @@ public function testPublishWhenTopicExists()
         $topic->shouldReceive('exists')
             ->once()
             ->andReturn(true);
-        $topic->shouldNotReceive('create');
+        $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('publish')
             ->with([
                 'data' => 'a:1:{s:5:"hello";s:5:"world";}',
@@ -67,6 +87,28 @@ public function testPublishWhenTopicExists()
         $adapter->publish('channel_name', ['hello' => 'world']);
     }
 
+    public function testPublishWhenAutoTopicCreationIsDisabled()
+    {
+        $topic = Mockery::mock(Topic::class);
+        $topic->shouldNotHaveReceived('exists');
+        $topic->shouldNotHaveReceived('create');
+        $topic->shouldReceive('publish')
+            ->with([
+                'data' => 'a:1:{s:5:"hello";s:5:"world";}',
+            ])
+            ->once();
+
+        $client = Mockery::mock(PubSubClient::class);
+        $client->shouldReceive('topic')
+            ->with('channel_name')
+            ->once()
+            ->andReturn($topic);
+
+        $adapter = new GoogleCloudPubSubAdapter($client, false);
+
+        $adapter->publish('channel_name', ['hello' => 'world']);
+    }
+
     public function testSubscribeWhenSubscriptionMustBeCreated()
     {
         $messageBatch1 = [
@@ -118,7 +160,7 @@ public function testSubscribeWhenSubscriptionMustBeCreated()
         $topic->shouldReceive('exists')
             ->once()
             ->andReturn(true);
-        $topic->shouldNotReceive('create');
+        $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('subscription')
             ->with('channel_name')
             ->once()
@@ -172,7 +214,7 @@ public function testSubscribeWhenSubscriptionExists()
         $subscription->shouldReceive('exists')
             ->once()
             ->andReturn(true);
-        $subscription->shouldNotReceive('create');
+        $subscription->shouldNotHaveReceived('create');
         $subscription->shouldReceive('pull')
             ->once()
             ->andReturn($messageBatch1);
@@ -193,7 +235,7 @@ public function testSubscribeWhenSubscriptionExists()
         $topic->shouldReceive('exists')
             ->once()
             ->andReturn(true);
-        $topic->shouldNotReceive('create');
+        $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('subscription')
             ->with('channel_name')
             ->once()
@@ -217,4 +259,77 @@ public function testSubscribeWhenSubscriptionExists()
 
         $adapter->subscribe('channel_name', [$handler1, 'handle']);
     }
+
+    public function testSubscribeWhenAutoTopicCreationIsDisabled()
+    {
+        $messageBatch1 = [
+            [
+                'ackId' => 1,
+                'message' => [
+                    'data' => base64_encode('a:1:{s:5:"hello";s:5:"world";}')
+                ],
+            ],
+            [
+                'ackId' => 2,
+                'message' => [
+                    'data' => base64_encode('this is a string')
+                ],
+            ],
+        ];
+        $messageBatch2 = [
+            [
+                'ackId' => 3,
+                'message' => [
+                    'data' => base64_encode('unsubscribe')
+                ],
+            ],
+        ];
+
+        $subscription = Mockery::mock(Subscription::class);
+        $subscription->shouldNotHaveReceived('exists');
+        $subscription->shouldNotHaveReceived('create');
+        $subscription->shouldReceive('pull')
+            ->once()
+            ->andReturn($messageBatch1);
+        $subscription->shouldReceive('acknowledge')
+            ->with(1)
+            ->once();
+        $subscription->shouldReceive('acknowledge')
+            ->with(2)
+            ->once();
+        $subscription->shouldReceive('pull')
+            ->once()
+            ->andReturn($messageBatch2);
+        $subscription->shouldReceive('acknowledge')
+            ->with(3)
+            ->once();
+
+        $topic = Mockery::mock(Topic::class);
+        $topic->shouldReceive('exists')
+            ->once()
+            ->andReturn(true);
+        $topic->shouldNotHaveReceived('create');
+        $topic->shouldReceive('subscription')
+            ->with('channel_name')
+            ->once()
+            ->andReturn($subscription);
+
+        $client = Mockery::mock(PubSubClient::class);
+        $client->shouldReceive('topic')
+            ->with('channel_name')
+            ->once()
+            ->andReturn($topic);
+
+        $adapter = new GoogleCloudPubSubAdapter($client, true, false);
+
+        $handler1 = Mockery::mock(\stdClass::class);
+        $handler1->shouldReceive('handle')
+            ->with(['hello' => 'world'])
+            ->once();
+        $handler1->shouldReceive('handle')
+            ->with('this is a string')
+            ->once();
+
+        $adapter->subscribe('channel_name', [$handler1, 'handle']);
+    }
 }