feat: add universeDomain option to Connector (#331)

GoogleCloudPlatform · Apr 24, 2024 · 651634d · 651634d
1 parent b7f1974
commit 651634d
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 19 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/connector.ts b/src/connector.ts
@@ -150,6 +150,11 @@ class CloudSQLInstanceMap extends Map {
 interface ConnectorOptions {
   auth?: GoogleAuth<AuthClient> | AuthClient;
   sqlAdminAPIEndpoint?: string;
+  /**
+   * The Trusted Partner Cloud (TPC) Domain DNS of the service used to make requests.
+   * Defaults to `googleapis.com`.
+   */
+  universeDomain?: string;
 }
 
 // The Connector class is the main public API to interact
@@ -163,6 +168,7 @@ export class Connector {
     this.sqlAdminFetcher = new SQLAdminFetcher({
       loginAuth: opts.auth,
       sqlAdminAPIEndpoint: opts.sqlAdminAPIEndpoint,
+      universeDomain: opts.universeDomain,
     });
   }
 

diff --git a/src/sqladmin-fetcher.ts b/src/sqladmin-fetcher.ts
@@ -71,13 +71,18 @@ function cleanGaxiosConfig() {
 export interface SQLAdminFetcherOptions {
   loginAuth?: GoogleAuth<AuthClient> | AuthClient;
   sqlAdminAPIEndpoint?: string;
+  universeDomain?: string;
 }
 
 export class SQLAdminFetcher {
   private readonly client: sqladmin_v1beta4.Sqladmin;
   private readonly auth: GoogleAuth<AuthClient>;
 
-  constructor({loginAuth, sqlAdminAPIEndpoint}: SQLAdminFetcherOptions = {}) {
+  constructor({
+    loginAuth,
+    sqlAdminAPIEndpoint,
+    universeDomain,
+  }: SQLAdminFetcherOptions = {}) {
     let auth: GoogleAuth<AuthClient>;
 
     if (loginAuth instanceof GoogleAuth) {
@@ -98,6 +103,7 @@ export class SQLAdminFetcher {
           version: 'LIBRARY_SEMVER_VERSION',
         },
       ],
+      universeDomain: universeDomain,
     });
 
     if (loginAuth instanceof GoogleAuth) {

diff --git a/test/connector.ts b/test/connector.ts
@@ -646,3 +646,23 @@ t.test('Connector, custom sqlAdminAPIEndpoint', async t => {
 
   t.same(actualsqlAdminAPIEndpoint, expectedsqlAdminAPIEndpoint);
 });
+
+t.test('Connector, custom universeDomain', async t => {
+  const expectedUniverseDomain = 'mydomain.com';
+  let actualUniverseDomain: string | undefined;
+  // mocks sql admin fetcher to check that the custom
+  // universeDomain is correctly passed into it
+  const {Connector} = t.mockRequire('../src/connector', {
+    '../src/sqladmin-fetcher': {
+      SQLAdminFetcher: class {
+        constructor({universeDomain}: SQLAdminFetcherOptions) {
+          actualUniverseDomain = universeDomain;
+        }
+      },
+    },
+  });
+
+  new Connector({universeDomain: expectedUniverseDomain});
+
+  t.same(actualUniverseDomain, expectedUniverseDomain);
+});