feat: Allow for topics to updated via a new method

PubSub/src/Connection/ConnectionInterface.php

@@ -38,6 +38,11 @@ public function getTopic(array $args);
      */
     public function deleteTopic(array $args);
 
+    /**
+     * @param array $args
+     */
+    public function updateTopic(array $args);
+
     /**
      * @param array $args
      */

PubSub/src/Connection/Grpc.php

@@ -30,6 +30,7 @@
 use Google\Cloud\PubSub\V1\PushConfig;
 use Google\Cloud\PubSub\V1\SubscriberClient;
 use Google\Cloud\PubSub\V1\Subscription;
+use Google\Cloud\PubSub\V1\Topic;
 use Google\Protobuf\Duration;
 use Google\Protobuf\FieldMask;
 use Google\Protobuf\Timestamp;
@@ -134,6 +135,33 @@ public function deleteTopic(array $args)
         ]);
     }
 
+    /**
+     * @param array $args
+     */
+    public function updateTopic(array $args)
+    {
+        $updateMaskPaths = [];
+        foreach (explode(',', $this->pluck('updateMask', $args)) as $path) {
+            $updateMaskPaths[] = Serializer::toSnakeCase($path);
+        }
+
+        $fieldMask = new FieldMask([
+            'paths' => $updateMaskPaths
+        ]);
+
+        $topic = $this->serializer->decodeMessage(
+            new Topic,
+            $this->pluck('topic', $args)
+        );
+
+        unset($args['name']);
+        return $this->send([$this->publisherClient, 'updateTopic'], [
+            $topic,
+            $fieldMask,
+            $args
+        ]);
+    }
+
     /**
      * @param array $args
      */

PubSub/src/Connection/Rest.php

@@ -73,6 +73,11 @@ public function createTopic(array $args)
         return $this->send('topics', 'create', $args);
     }
 
+    public function updateTopic(array $args)
+    {
+        return $this->send('topics', 'patch', $args);
+    }
+
     /**
      * @param array $args
      */

PubSub/src/Topic.php

@@ -182,6 +182,91 @@ public function create(array $options = [])
         return $this->info;
     }
 
+    /**
+     * Update the topic.
+     *
+     * Note that the topic's name and kms key name are immutable properties and may not be modified.
+     *
+     * Example:
+     * ```
+     * $topic->update([
+     *     'messageStoragePolicy' => [
+     *         'allowedPersistenceRegions' => ['us-central1']
+     *     ]
+     * ]);
+     * ```
+     *
+     *```
+     * // Updating labels with an explicit update mask
+     * $topic->update([
+     *     'labels' => [ 'foo' => 'bar' ]
+     * ], [
+     *     'updateMask' => [ 'labels' ]
+     * ]);
+     * ```
+     *
+     * @param array $topic {
+     *     The Topic data.
+     *
+     *    @type array $labels Key value pairs used to organize your resources.
+     *    @type string $kmsKeyName The resource name of the Cloud KMS
+     *          CryptoKey to be used to protect access to messages published on this
+     *          topic. The expected format is:
+     *          `projects/my-project/locations/kr-location/keyRings/my-kr/cryptoKeys/my-key`.
+     *          This is an experimental feature and is not recommended for production use.
+     *    @type array $messageStoragePolicy Policy constraining the set of
+     *          Google Cloud Platform regions where messages published to the
+     *          topic may be stored. If not present, then no constraints are in
+     *          effect.
+     *    @type string[] $messageStoragePolicy.allowedPersistenceRegions A list
+     *          of IDs of GCP regions where messages that are published to the
+     *          topic may be persisted in storage. Messages published by
+     *          publishers running in non-allowed GCP regions (or running
+     *          outside of GCP altogether) will be routed for storage in one of
+     *          the allowed regions. An empty list means that no regions are
+     *          allowed, and is not a valid configuration.    * }
+     * @param array $options [optional] Configuration options.
+     * @param array $options.updateMask A list of field paths to be modified. Nested
+     *    key names should be dot-separated, e.g. `messageStoragePolicy.allowedPersistenceRegions`.
+     *    Google Cloud PHP will attempt to infer this value on your
+     *    behalf, however modification of map fields with arbitrary keys
+     *    (such as labels or push config attributes) requires an explicit
+     *    update mask.
+     * @return array The topic info.
+     */
+    public function update(array $topic, array $options = [])
+    {
+        $updateMaskPaths = $this->pluck('updateMask', $options, false) ?: [];
+
+        if (!$updateMaskPaths) {
+            $iterator = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($topic));
+            foreach ($iterator as $leafValue) {
+                $excludes = ['name', 'kmsKeyName'];
+                $keys = [];
+                foreach (range(0, $iterator->getDepth()) as $depth) {
+                    $key = $iterator->getSubIterator($depth)->key();
+                    if (!is_string($key)) {
+                        break;
+                    }
+                    $keys[] = $key;
+                }
+
+                $path = implode('.', $keys);
+                if (!in_array($path, $excludes)) {
+                    $updateMaskPaths[] = $path;
+                }
+            }
+        }
+
+        return $this->info = $this->connection->updateTopic([
+            'name' => $this->name,
+            'topic' => [
+                'name' => $this->name,
+            ] + $topic,
+            'updateMask' => implode(',', $updateMaskPaths)
+        ] + $options);
+    }
+
     /**
      * Delete a topic.
      *

PubSub/tests/Snippet/TopicTest.php

@@ -98,6 +98,34 @@ public function testCreate()
         $this->assertEquals([], $res->returnVal());
     }
 
+    public function testUpdate()
+    {
+        $snippet = $this->snippetFromMethod(Topic::class, 'update');
+        $snippet->addLocal('topic', $this->topic);
+
+        $this->connection->updateTopic(Argument::any())
+            ->shouldBeCalled();
+
+        $this->topic->___setProperty('connection', $this->connection->reveal());
+
+        $snippet->invoke();
+    }
+
+    public function testUpdateWithMask()
+    {
+        $snippet = $this->snippetFromMethod(Topic::class, 'update', 1);
+        $snippet->addLocal('topic', $this->topic);
+
+        $this->connection->updateTopic(Argument::allOf(
+            Argument::withKey('topic'),
+            Argument::withKey('updateMask')
+        ))->shouldBeCalled();
+
+        $this->topic->___setProperty('connection', $this->connection->reveal());
+
+        $snippet->invoke();
+    }
+
     public function testDelete()
     {
         $snippet = $this->snippetFromMethod(Topic::class, 'delete');

PubSub/tests/System/ManageTopicsTest.php

@@ -77,4 +77,44 @@ public function testReloadTopic($client)
         $this->assertTrue($client->topic($shortName)->exists());
         $this->assertEquals($topic->name(), $topic->reload()['name']);
     }
+
+    /**
+     * @dataProvider clientProvider
+     */
+    public function testUpdateTopic($client)
+    {
+        $topics = $client->topics();
+        $topic = $topics->current();
+
+        $policy = [
+                'allowedPersistenceRegions' => ['us-central1', 'us-east1']
+        ];
+
+        $topic->update([
+            'messageStoragePolicy' => $policy
+        ]);
+
+        $this->assertEquals($policy, $topic->info()['messageStoragePolicy']);
+    }
+
+    /**
+     * @dataProvider clientProvider
+     */
+    public function testUpdateTopicWithUpdateMask($client)
+    {
+        $topics = $client->topics();
+        $topic = $topics->current();
+
+        $labels = [
+            'foo' => 'bar'
+        ];
+
+        $topic->update([
+            'labels' => $labels
+        ], [
+            'updateMask' => [ 'labels' ]
+        ]);
+
+        $this->assertEquals($labels, $topic->info()['labels']);
+    }
 }

PubSub/tests/Unit/Connection/GrpcTest.php

@@ -22,6 +22,7 @@
 use Google\Cloud\PubSub\Connection\Grpc;
 use Google\Cloud\Core\Testing\GrpcTestTrait;
 use Google\ApiCore\Serializer;
+use Google\Cloud\PubSub\V1\Topic;
 use Google\Protobuf\FieldMask;
 use Google\Protobuf\Timestamp;
 use Prophecy\Argument;
@@ -118,12 +119,30 @@ public function methodProvider()
         $subscription->setRetainAckedMessages(true);
 
         $serializer = new Serializer();
-        $fieldMask = $serializer->decodeMessage(new FieldMask(), ['paths' => ['retain_acked_messages']]);
+        $subscriptionFieldMask = $serializer->decodeMessage(new FieldMask(), ['paths' => ['retain_acked_messages']]);
 
         $time = (new \DateTime)->format('Y-m-d\TH:i:s.u\Z');
         $timestamp = $serializer->decodeMessage(new Timestamp(), $this->formatTimestampForApi($time));
 
+        $topic = new Topic;
+        $topic->setLabels(['foo' => 'bar']);
+        $topic->setName('projects/foo/topics/bar');
+        $topicFieldMask = $serializer->decodeMessage(new FieldMask(), ['paths' => ['labels']]);
+
         return [
+            [
+                'updateTopic',
+                [
+                    'topic' => [
+                        'name' => 'projects/foo/topics/bar',
+                        'labels' => [
+                            'foo' => 'bar'
+                        ]
+                    ],
+                    'updateMask' => 'labels'
+                ],
+                [$topic, $topicFieldMask, []]
+            ],
             [
                 'updateSubscription',
                 [
@@ -133,7 +152,7 @@ public function methodProvider()
                     ],
                     'updateMask' => 'retainAckedMessages'
                 ],
-                [$subscription, $fieldMask, []]
+                [$subscription, $subscriptionFieldMask, []]
             ],
             [
                 'listSnapshots',

PubSub/tests/Unit/Connection/RestTest.php

@@ -94,6 +94,7 @@ public function methodProvider()
             ['createTopic'],
             ['getTopic'],
             ['deleteTopic'],
+            ['updateTopic'],
             ['listTopics'],
             ['publishMessage'],
             ['listSubscriptionsByTopic'],

PubSub/tests/Unit/TopicTest.php

@@ -71,6 +71,51 @@ public function testCreate()
         $this->assertEquals('projects/project-name/topics/topic-name', $res['name']);
     }
 
+    public function testUpdate()
+    {
+        $this->connection->updateTopic(Argument::allOf(
+            Argument::withEntry('topic', [
+                'name' => $this->topic->name(),
+                'foo' => 'bar'
+            ]),
+            Argument::withEntry('updateMask', 'foo')
+        ))->shouldBeCalled()->willReturn([
+            'foo' => 'bar'
+        ]);
+
+        $this->topic->___setProperty('connection', $this->connection->reveal());
+
+        $res = $this->topic->update(['foo' => 'bar']);
+
+        $this->assertEquals(['foo' => 'bar'], $res);
+        $this->assertEquals('bar', $this->topic->info()['foo']);
+    }
+
+    public function testUpdateWithImmutableFields()
+    {
+        $this->connection->updateTopic(Argument::allOf(
+            Argument::withEntry('topic', [
+                'name' => $this->topic->name(),
+                'foo' => 'bar',
+                'kmsKeyName' => 'example-key'
+            ]),
+            Argument::withEntry('updateMask', 'foo')
+        ))->shouldBeCalled()->willReturn([
+            'foo' => 'bar'
+        ]);
+
+        $this->topic->___setProperty('connection', $this->connection->reveal());
+
+        $res = $this->topic->update([
+            'foo' => 'bar',
+            'name' => $this->topic->name(),
+            'kmsKeyName' => 'example-key'
+        ]);
+
+        $this->assertEquals(['foo' => 'bar'], $res);
+        $this->assertEquals('bar', $this->topic->info()['foo']);
+    }
+
     public function testDelete()
     {
         $this->connection->deleteTopic(Argument::withEntry('foo', 'bar'))