feat: add universe domain support to core, bigquery, storage, and pubsub (#6850)

Author: bshaffer

composer.json

@@ -5,7 +5,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": ">=7.4",
-        "google/cloud-core": "^1.52.7",
+        "google/cloud-core": "^1.53",
         "google/gax": "^1.26.0"
     },
     "require-dev": {

src/Connection/Grpc.php

@@ -56,6 +56,9 @@ class Grpc implements ConnectionInterface
     use EmulatorTrait;
     use GrpcTrait;
 
+    /**
+     * @deprecated
+     */
     const BASE_URI = 'https://pubsub.googleapis.com/';
 
     const COMPRESSION_HEADER_KEY = 'grpc-internal-encoding-request';
@@ -112,7 +115,8 @@ public function __construct(array $config = [])
             PubSubClient::VERSION,
             isset($config['authHttpHandler'])
                 ? $config['authHttpHandler']
-                : null
+                : null,
+            $config['universeDomain'] ?? null
         );
 
         $config += ['emulatorHost' => null];
@@ -127,6 +131,10 @@ public function __construct(array $config = [])
                 $this->emulatorGapicConfig($config['emulatorHost'])
             );
         }
+
+        if (isset($config['universeDomain'])) {
+            $grpcConfig['universeDomain'] = $config['universeDomain'];
+        }
         //@codeCoverageIgnoreEnd
 
         $this->clientConfig = $grpcConfig;

src/Connection/Rest.php

@@ -17,6 +17,7 @@
 
 namespace Google\Cloud\PubSub\Connection;
 
+use Google\Auth\GetUniverseDomainInterface;
 use Google\Cloud\Core\EmulatorTrait;
 use Google\Cloud\Core\RequestBuilder;
 use Google\Cloud\Core\RequestWrapper;
@@ -39,19 +40,28 @@ class Rest implements ConnectionInterface
     use RestTrait;
     use UriTrait;
 
+    /**
+     * @deprecated
+     */
     const BASE_URI = 'https://pubsub.googleapis.com/';
 
+    private const BASE_URI_TEMPLATE = 'https://pubsub.UNIVERSE_DOMAIN';
+
     /**
      * @param array $config
      */
     public function __construct(array $config = [])
     {
-        $config += ['emulatorHost' => null];
+        $config += [
+            'emulatorHost' => null,
+            'universeDomain' => GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN,
+        ];
 
-        $baseUri = $this->getApiEndpoint(self::BASE_URI, $config);
         if ((bool) $config['emulatorHost']) {
             $baseUri = $this->emulatorBaseUri($config['emulatorHost']);
             $config['shouldSignRequest'] = false;
+        } else {
+            $baseUri = $this->getApiEndpoint(null, $config, self::BASE_URI_TEMPLATE);
         }
 
         $config += [

tests/Unit/Connection/GrpcTest.php

@@ -77,6 +77,30 @@ public function testApiEndpoint()
         $this->assertEquals($expected, $grpc->config['apiEndpoint']);
     }
 
+
+    /**
+     * @dataProvider clientUniverseDomainConfigProvider
+     */
+    public function testUniverseDomain($config, $expectedUniverseDomain, $domainConfigExists = true)
+    {
+        $grpc = new GrpcStub($config);
+
+        if ($domainConfigExists) {
+            $this->assertEquals($expectedUniverseDomain, $grpc->config['universeDomain']);
+        } else {
+            $this->assertArrayNotHasKey('universeDomain', $grpc->config);
+        }
+    }
+
+    public function clientUniverseDomainConfigProvider()
+    {
+        return [
+            [[], 'googleapis.com', false],
+            [['universeDomain' => 'googleapis.com'], 'googleapis.com'],
+            [['universeDomain' => 'abc.def.ghi'], 'abc.def.ghi'],
+        ];
+    }
+
     public function testUpdateTopic()
     {
         $topic = new Topic();

tests/Unit/Connection/RestTest.php

@@ -27,6 +27,7 @@
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Http\Message\RequestInterface;
+use UnexpectedValueException;
 
 /**
  * @group pubsub
@@ -46,21 +47,33 @@ public function setUp(): void
         $this->successBody = '{"canI":"kickIt"}';
     }
 
-    public function testApiEndpoint()
+    /**
+     * @dataProvider clientUniverseDomainConfigProvider
+     */
+    public function testApiEndpointForUniverseDomain($config, $expectedEndpoint, $expectException = false)
     {
-        $endpoint = 'https://foobar.com/';
-        $rest = TestHelpers::stub(Rest::class, [
-            [
-                'apiEndpoint' => $endpoint
-            ]
-        ], ['requestBuilder']);
+        if ($expectException) {
+            $this->expectException(UnexpectedValueException::class);
+        }
+        $rest = TestHelpers::stub(Rest::class, [$config], ['requestBuilder']);
 
         $rb = $rest->___getProperty('requestBuilder');
         $r = new \ReflectionObject($rb);
         $p = $r->getProperty('baseUri');
         $p->setAccessible(true);
 
-        $this->assertEquals($endpoint, $p->getValue($rb));
+        $this->assertEquals($expectedEndpoint, $p->getValue($rb));
+    }
+
+    public function clientUniverseDomainConfigProvider()
+    {
+        return [
+            [[], 'https://pubsub.googleapis.com/'], // default
+            [['apiEndpoint' => 'https://foobar.com'], 'https://foobar.com/'],
+            [['universeDomain' => 'googleapis.com'], 'https://pubsub.googleapis.com/'],
+            [['universeDomain' => 'abc.def.ghi'], 'https://pubsub.abc.def.ghi/'],
+            [['universeDomain' => null], '', true],
+        ];
     }
 
     /**