refactor: sqlAdminRootUrl to sqlAdminAPIEndpoint

GoogleCloudPlatform · Sep 27, 2023 · aeecd31 · aeecd31
1 parent e6e916d
commit aeecd31
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 24 deletions.
diff --git a/src/connector.ts b/src/connector.ts
@@ -147,7 +147,7 @@ class CloudSQLInstanceMap extends Map {
 }
 
 interface ConnectorOptions {
-  sqlAdminRootUrl?: string;
+  sqlAdminAPIEndpoint?: string;
 }
 
 // The Connector class is the main public API to interact
@@ -156,9 +156,9 @@ export class Connector {
   private readonly instances: CloudSQLInstanceMap;
   private readonly sqlAdminFetcher: SQLAdminFetcher;
 
-  constructor({sqlAdminRootUrl}: ConnectorOptions = {}) {
+  constructor({sqlAdminAPIEndpoint}: ConnectorOptions = {}) {
     this.instances = new CloudSQLInstanceMap();
-    this.sqlAdminFetcher = new SQLAdminFetcher({sqlAdminRootUrl});
+    this.sqlAdminFetcher = new SQLAdminFetcher({sqlAdminAPIEndpoint});
   }
 
   // Connector.getOptions is a method that accepts a Cloud SQL instance

diff --git a/src/sqladmin-fetcher.ts b/src/sqladmin-fetcher.ts
@@ -70,19 +70,19 @@ function cleanGaxiosConfig() {
 
 export interface SQLAdminFetcherOptions {
   loginAuth?: GoogleAuth;
-  sqlAdminRootUrl?: string;
+  sqlAdminAPIEndpoint?: string;
 }
 
 export class SQLAdminFetcher {
   private readonly client: sqladmin_v1beta4.Sqladmin;
   private readonly auth: GoogleAuth;
 
-  constructor({loginAuth, sqlAdminRootUrl}: SQLAdminFetcherOptions = {}) {
+  constructor({loginAuth, sqlAdminAPIEndpoint}: SQLAdminFetcherOptions = {}) {
     const auth = new GoogleAuth({
       scopes: ['https://www.googleapis.com/auth/sqlservice.admin'],
     });
     this.client = new Sqladmin({
-      rootUrl: sqlAdminRootUrl,
+      rootUrl: sqlAdminAPIEndpoint,
       auth,
       userAgentDirectives: [
         {

diff --git a/test/connector.ts b/test/connector.ts
@@ -627,22 +627,22 @@ t.test('Connector force refresh on socket connection error', async t => {
   connector.close();
 });
 
-t.test('Connector, custom sqlAdminRootUrl', async t => {
-  const expectedSqlAdminRootUrl = 'https://sqladmin.mydomain.com';
-  let actualSqlAdminRootUrl: string | undefined;
+t.test('Connector, custom sqlAdminAPIEndpoint', async t => {
+  const expectedsqlAdminAPIEndpoint = 'https://sqladmin.mydomain.com';
+  let actualsqlAdminAPIEndpoint: string | undefined;
   // mocks sql admin fetcher to check that the custom
-  // sqlAdminRootUrl is correctly passed into it
+  // sqlAdminAPIEndpoint is correctly passed into it
   const {Connector} = t.mock('../src/connector', {
     '../src/sqladmin-fetcher': {
       SQLAdminFetcher: class {
-        constructor({sqlAdminRootUrl}: SQLAdminFetcherOptions) {
-          actualSqlAdminRootUrl = sqlAdminRootUrl;
+        constructor({sqlAdminAPIEndpoint}: SQLAdminFetcherOptions) {
+          actualsqlAdminAPIEndpoint = sqlAdminAPIEndpoint;
         }
       },
     },
   });
 
-  new Connector({sqlAdminRootUrl: expectedSqlAdminRootUrl});
+  new Connector({sqlAdminAPIEndpoint: expectedsqlAdminAPIEndpoint});
 
-  t.same(actualSqlAdminRootUrl, expectedSqlAdminRootUrl);
+  t.same(actualsqlAdminAPIEndpoint, expectedsqlAdminAPIEndpoint);
 });
diff --git a/test/sqladmin-fetcher.ts b/test/sqladmin-fetcher.ts
@@ -42,11 +42,11 @@ const ephCertResponse = {
 const mockRequest = (
   instanceInfo: InstanceConnectionInfo,
   overrides?: sqladmin_v1beta4.Schema$ConnectSettings,
-  sqlAdminRootUrl?: string
+  sqlAdminAPIEndpoint?: string
 ): void => {
   const {projectId, regionId, instanceId} = instanceInfo;
 
-  nock(sqlAdminRootUrl ?? 'https://sqladmin.googleapis.com')
+  nock(sqlAdminAPIEndpoint ?? 'https://sqladmin.googleapis.com')
     .get(
       `/sql/v1beta4/projects/${projectId}/instances/${instanceId}/connectSettings`
     )
@@ -101,15 +101,15 @@ t.test('getInstanceMetadata', async t => {
 
 t.test('getInstanceMetadata custom SQL Admin API endpoint', async t => {
   setupCredentials(t);
-  const sqlAdminRootUrl = 'https://sqladmin.mydomain.com';
+  const sqlAdminAPIEndpoint = 'https://sqladmin.mydomain.com';
   const instanceConnectionInfo: InstanceConnectionInfo = {
     projectId: 'my-project',
     regionId: 'us-east1',
     instanceId: 'my-instance',
   };
-  mockRequest(instanceConnectionInfo, {}, sqlAdminRootUrl);
+  mockRequest(instanceConnectionInfo, {}, sqlAdminAPIEndpoint);
 
-  const fetcher = new SQLAdminFetcher({sqlAdminRootUrl});
+  const fetcher = new SQLAdminFetcher({sqlAdminAPIEndpoint});
   const instanceMetadata = await fetcher.getInstanceMetadata(
     instanceConnectionInfo
   );
@@ -252,11 +252,11 @@ t.test('getInstanceMetadata invalid region', async t => {
 const mockGenerateEphemeralCertRequest = (
   instanceInfo: InstanceConnectionInfo,
   overrides?: sqladmin_v1beta4.Schema$GenerateEphemeralCertResponse,
-  sqlAdminRootUrl?: string
+  sqlAdminAPIEndpoint?: string
 ): void => {
   const {projectId, instanceId} = instanceInfo;
 
-  nock(sqlAdminRootUrl ?? 'https://sqladmin.googleapis.com')
+  nock(sqlAdminAPIEndpoint ?? 'https://sqladmin.googleapis.com')
     .post(
       `/sql/v1beta4/projects/${projectId}/instances/${instanceId}:generateEphemeralCert`
     )
@@ -294,15 +294,19 @@ t.test('getEphemeralCertificate', async t => {
 
 t.test('getEphemeralCertificate custom SQL Admin API endpoint', async t => {
   setupCredentials(t);
-  const sqlAdminRootUrl = 'https://sqladmin.mydomain.com';
+  const sqlAdminAPIEndpoint = 'https://sqladmin.mydomain.com';
   const instanceConnectionInfo: InstanceConnectionInfo = {
     projectId: 'my-project',
     regionId: 'us-east1',
     instanceId: 'my-instance',
   };
-  mockGenerateEphemeralCertRequest(instanceConnectionInfo, {}, sqlAdminRootUrl);
+  mockGenerateEphemeralCertRequest(
+    instanceConnectionInfo,
+    {},
+    sqlAdminAPIEndpoint
+  );
 
-  const fetcher = new SQLAdminFetcher({sqlAdminRootUrl});
+  const fetcher = new SQLAdminFetcher({sqlAdminAPIEndpoint});
   const ephemeralCert = await fetcher.getEphemeralCertificate(
     instanceConnectionInfo,
     'key',