Merge pull request #1 from Superbalist/implement-unique-client-identifier

add support for unique client identifier

Author: matthewgoslett

README.md

@@ -27,6 +27,13 @@ $client = new \Google\Cloud\PubSub\PubSubClient([
 $adapter = new \Superbalist\PubSub\GoogleCloud\GoogleCloudPubSubAdapter($client);
 
 
+// disable auto topic & subscription creation
+$adapter->setAutoCreateTopics(false); // this is true by default
+$adapter->setAutoCreateSubscriptions(false); // this is true by default
+
+// set a unique client identifier for the subscriber
+$adapter->setClientIdentifier('search_service');
+
 // consume messages
 // note: this is a blocking call
 $adapter->subscribe('my_channel', function ($message) {
@@ -38,10 +45,6 @@ $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

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.0 - 2016-10-05
+
+* Add new `$clientIdentifier` & `setClientIdentifier()` functionality to allow subscribers to use the same, or unique identifiers.
+
 ## 1.0.2 - 2016-09-26
 
 * Allow for google/cloud ^0.8.0 and ^0.9.0

src/GoogleCloudPubSubAdapter.php

@@ -13,6 +13,11 @@ class GoogleCloudPubSubAdapter implements PubSubAdapterInterface
      */
     protected $client;
 
+    /**
+     * @var string
+     */
+    protected $clientIdentifier;
+
     /**
      * @var bool
      */
@@ -25,12 +30,14 @@ class GoogleCloudPubSubAdapter implements PubSubAdapterInterface
 
     /**
      * @param PubSubClient $client
+     * @param string $clientIdentifier
      * @param bool $autoCreateTopics
      * @param bool $autoCreateSubscriptions
      */
-    public function __construct(PubSubClient $client, $autoCreateTopics = true, $autoCreateSubscriptions = true)
+    public function __construct(PubSubClient $client, $clientIdentifier = null, $autoCreateTopics = true, $autoCreateSubscriptions = true)
     {
         $this->client = $client;
+        $this->clientIdentifier = $clientIdentifier;
         $this->autoCreateTopics = $autoCreateTopics;
         $this->autoCreateSubscriptions = $autoCreateSubscriptions;
     }
@@ -45,6 +52,32 @@ public function getClient()
         return $this->client;
     }
 
+    /**
+     * Set the unique client identifier.
+     *
+     * The client identifier is used when creating a subscription to a topic.
+     *
+     * A topic can have multiple subscribers connected.
+     * If all subscribers use the same client identifier, the messages will load-balance across them.
+     * If all subscribers have different client identifiers, the messages will be dispatched all of them.
+     *
+     * @param string $clientIdentifier
+     */
+    public function setClientIdentifier($clientIdentifier)
+    {
+        $this->clientIdentifier = $clientIdentifier;
+    }
+
+    /**
+     * Return the unique client identifier.
+     *
+     * @return string
+     */
+    public function getClientIdentifier()
+    {
+        return $this->clientIdentifier;
+    }
+
     /**
      * Set whether or not topics will be auto created.
      *
@@ -156,7 +189,8 @@ protected function getTopicForChannel($channel)
     protected function getSubscriptionForChannel($channel)
     {
         $topic = $this->getTopicForChannel($channel);
-        $subscription = $topic->subscription($channel);
+        $clientIdentifier = $this->clientIdentifier ? $this->clientIdentifier : 'default';
+        $subscription = $topic->subscription($clientIdentifier);
         if ($this->autoCreateSubscriptions && !$subscription->exists()) {
             $subscription->create();
         }

tests/GoogleCloudPubSubAdapterTest.php

@@ -18,6 +18,16 @@ public function testGetClient()
         $this->assertSame($client, $adapter->getClient());
     }
 
+    public function testGetSetClientIdentifier()
+    {
+        $client = Mockery::mock(PubSubClient::class);
+        $adapter = new GoogleCloudPubSubAdapter($client);
+        $this->assertNull($adapter->getClientIdentifier());
+
+        $adapter->setClientIdentifier('my_identifier');
+        $this->assertEquals('my_identifier', $adapter->getClientIdentifier());
+    }
+
     public function testGetSetAutoCreateTopics()
     {
         $client = Mockery::mock(PubSubClient::class);
@@ -104,7 +114,7 @@ public function testPublishWhenAutoTopicCreationIsDisabled()
             ->once()
             ->andReturn($topic);
 
-        $adapter = new GoogleCloudPubSubAdapter($client, false);
+        $adapter = new GoogleCloudPubSubAdapter($client, null, false);
 
         $adapter->publish('channel_name', ['hello' => 'world']);
     }
@@ -162,7 +172,7 @@ public function testSubscribeWhenSubscriptionMustBeCreated()
             ->andReturn(true);
         $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('subscription')
-            ->with('channel_name')
+            ->with('default')
             ->once()
             ->andReturn($subscription);
 
@@ -237,7 +247,7 @@ public function testSubscribeWhenSubscriptionExists()
             ->andReturn(true);
         $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('subscription')
-            ->with('channel_name')
+            ->with('default')
             ->once()
             ->andReturn($subscription);
 
@@ -310,7 +320,7 @@ public function testSubscribeWhenAutoTopicCreationIsDisabled()
             ->andReturn(true);
         $topic->shouldNotHaveReceived('create');
         $topic->shouldReceive('subscription')
-            ->with('channel_name')
+            ->with('default')
             ->once()
             ->andReturn($subscription);
 
@@ -320,7 +330,7 @@ public function testSubscribeWhenAutoTopicCreationIsDisabled()
             ->once()
             ->andReturn($topic);
 
-        $adapter = new GoogleCloudPubSubAdapter($client, true, false);
+        $adapter = new GoogleCloudPubSubAdapter($client, null, true, false);
 
         $handler1 = Mockery::mock(\stdClass::class);
         $handler1->shouldReceive('handle')