fix: reuse auth across clients (#1527)

* chore: fix owlbot configs, regenerate

* Apply suggestions from code review

* WIP - two different ways

* don't overwrite handwritten methods

* change to sync file read

* chore: periodic regen

* run postprocessor

* upgrade dependencies to node 18

* Revert "upgrade dependencies to node 18"

This reverts commit b7ca3fc.

* periodic regeneration + update to node 18 on autogen branch

* fix lint errors

* more lint fixes

* fix: reuse auth

* update to ensure suboptions get passed to gax

* lint

Author: leahecole

package.json

@@ -35,7 +35,7 @@
     "compile-protos": "compileProtos src",
     "docs": "jsdoc -c .jsdoc.js",
     "fix": "gts fix",
-    "gen-central-client": "tsc scripts/gen_uber_class.ts && cd scripts && node gen_uber_class.js && cd ..",
+    "gen-central-client": "tsc scripts/gen_uber_class.ts && cd scripts && node gen_uber_class.js && rm gen_uber_class.js && cd ..",
     "lint": "gts check",
     "prelint": "cd samples; npm link ../; npm install",
     "prepare": "npm run compile-protos && npm run gen-central-client && npm run compile",

scripts/gen_uber_class.ts

@@ -250,7 +250,7 @@ function makeImports(clients: string[]) {
   imports = imports.concat('} from ".";');
   const staticImports = `
   import type * as gax from "google-gax";
-  import {Callback, CallOptions, ClientOptions, PaginationCallback} from "google-gax";
+  import {Callback, CallOptions, ClientOptions, GoogleAuth, PaginationCallback} from "google-gax";
   import {Transform} from 'stream';
   `;
 
@@ -334,8 +334,10 @@ function buildClientConstructor(clients: string[]) {
   * @param {object} [SubClientOptions] - These options will be shared across subclients.
   * To have sub-clients with different options, instantiate each client separately.
   */`;
-  let constructorInitializers =
-    '\tconstructor(options?: BigQueryClientOptions, subClientOptions?: SubClientOptions){\n';
+  let constructorInitializers = `\tconstructor(options?: BigQueryClientOptions, subClientOptions?: SubClientOptions){
+        subClientOptions = subClientOptions || {};
+        subClientOptions.opts = subClientOptions.opts || {};\n\n`;
+  let clientCounter = 0;
   for (const client in clients) {
     const clientName = parseClientName(clients[client]);
     variableDecl = variableDecl.concat(
@@ -344,6 +346,16 @@ function buildClientConstructor(clients: string[]) {
     constructorInitializers = constructorInitializers.concat(
       `\t\tthis.${clientName} = options?.${clientName} ?? new ${clients[client]}(subClientOptions?.opts, subClientOptions?.gaxInstance);\n`,
     );
+    // add statement about auth only after the first subClient
+    if (clientCounter === 0) {
+      constructorInitializers =
+        constructorInitializers.concat(`\n\t\t// utilize whatever auth was created with the first client for the rest of the clients
+    // this will either be what the user passed into subClientOptions.opts.auth, or whatever was
+    // initialized by default in gax. We reuse this auth rather than instantiating a default ourselves
+    // so that we do not have to keep this code in sync with gax
+    subClientOptions.opts.auth = this.${clientName}.auth;\n\n`);
+      clientCounter++;
+    }
   }
   constructorInitializers = constructorInitializers.concat('\t}');
   let output = 'export class BigQueryClient{\n';

src/bigquery.ts

@@ -29,6 +29,7 @@ import {
   Callback,
   CallOptions,
   ClientOptions,
+  GoogleAuth,
   PaginationCallback,
 } from 'google-gax';
 import {Transform} from 'stream';
@@ -103,12 +104,22 @@ export class BigQueryClient {
     options?: BigQueryClientOptions,
     subClientOptions?: SubClientOptions,
   ) {
+    subClientOptions = subClientOptions || {};
+    subClientOptions.opts = subClientOptions.opts || {};
+
     this.datasetClient =
       options?.datasetClient ??
       new DatasetServiceClient(
         subClientOptions?.opts,
         subClientOptions?.gaxInstance,
       );
+
+    // utilize whatever auth was created with the first client for the rest of the clients
+    // this will either be what the user passed into subClientOptions.opts.auth, or whatever was
+    // initialized by default in gax. We reuse this auth rather than instantiating a default ourselves
+    // so that we do not have to keep this code in sync with gax
+    subClientOptions.opts.auth = this.datasetClient.auth;
+
     this.tableClient =
       options?.tableClient ??
       new TableServiceClient(

test/bigquery_test.ts

@@ -34,6 +34,7 @@ import {
   JobServiceClient,
   RoutineServiceClient,
 } from '../src';
+import {GoogleAuth} from 'google-gax';
 
 // this test assumes that the npm "pretest" session has been run
 // and the client was regenerated immediately before these tests are run
@@ -68,7 +69,7 @@ describe('BigQueryClient handwritten methods work as expected', () => {
 
 describe('BigQueryClient autogenerated methods work as expected', () => {
   describe('BigQueryClient should be able to handle passing in clients and options', () => {
-    const subOptions: SubClientOptions = {
+    let subOptions: SubClientOptions = {
       opts: {
         universeDomain: 'fake-universe-domain',
       },
@@ -145,6 +146,28 @@ describe('BigQueryClient autogenerated methods work as expected', () => {
         'bigquery.fake-universe-domain',
       );
     });
+    it('creates a central client and auth is reused across clients', () => {
+      subOptions = {
+        opts: {
+          auth: new GoogleAuth({apiKey: 'fake-key'}),
+        },
+      };
+
+      const client = new BigQueryClient({}, subOptions);
+      assert.ok(client);
+      assert.strictEqual(
+        client.datasetClient.auth.apiKey,
+        'fake-key', // would be null if auth was initialized by default
+      );
+      assert.deepStrictEqual(client.tableClient.auth.apiKey, 'fake-key');
+      assert.deepStrictEqual(client.jobClient.auth.apiKey, 'fake-key');
+      assert.deepStrictEqual(client.routineClient.auth.apiKey, 'fake-key');
+      assert.deepStrictEqual(client.modelClient.auth.apiKey, 'fake-key');
+      assert.deepStrictEqual(
+        client.rowAccessPolicyClient.auth.apiKey,
+        'fake-key',
+      );
+    });
   });
 
   // It is not important that these unit tests validate the responses