feat: add support for custom user agent

GoogleCloudPlatform · Jan 3, 2025 · dd20563 · dd20563
1 parent 20a12da
commit dd20563
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/src/connector.ts b/src/connector.ts
@@ -148,6 +148,7 @@ interface ConnectorOptions {
    * Defaults to `googleapis.com`.
    */
   universeDomain?: string;
+  userAgent?: string;
 }
 
 // The Connector class is the main public API to interact
@@ -164,6 +165,7 @@ export class Connector {
       loginAuth: opts.auth,
       sqlAdminAPIEndpoint: opts.sqlAdminAPIEndpoint,
       universeDomain: opts.universeDomain,
+      userAgent: opts.userAgent,
     });
     this.localProxies = new Set();
     this.sockets = new Set();

diff --git a/src/sqladmin-fetcher.ts b/src/sqladmin-fetcher.ts
@@ -82,6 +82,7 @@ export interface SQLAdminFetcherOptions {
   loginAuth?: GoogleAuth<AuthClient> | AuthClient;
   sqlAdminAPIEndpoint?: string;
   universeDomain?: string;
+  userAgent?: string;
 }
 
 export class SQLAdminFetcher {
@@ -92,6 +93,7 @@ export class SQLAdminFetcher {
     loginAuth,
     sqlAdminAPIEndpoint,
     universeDomain,
+    userAgent,
   }: SQLAdminFetcherOptions = {}) {
     let auth: GoogleAuth<AuthClient>;
 
@@ -111,6 +113,7 @@ export class SQLAdminFetcher {
         {
           product: 'cloud-sql-nodejs-connector',
           version: 'LIBRARY_SEMVER_VERSION',
+          comment: userAgent,
         },
       ],
       universeDomain: universeDomain,

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