fix: Firestore Client caching stub in bad state issue (#2365)

* [Fix] Fix Firestore Client caching stub in bad state issue

* fix: Firestore Client caching stub in bad state issue

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* fix: Firestore Client caching stub in bad state issue

* cleanup and test

* Add logging

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Mark Duckworth <[email protected]>

Author: 3 people

dev/src/v1/firestore_client.ts

@@ -31,6 +31,7 @@ import type {
 import {Transform, PassThrough} from 'stream';
 import * as protos from '../../protos/firestore_v1_proto_api';
 import jsonProtos = require('../../protos/v1.json');
+import {logger} from '../logger';
 
 /**
  * Client JSON configuration object, loaded from
@@ -62,6 +63,7 @@ export class FirestoreClient {
   private _defaults: {[method: string]: gax.CallSettings};
   private _universeDomain: string;
   private _servicePath: string;
+  private _stubFailed = false;
   auth: gax.GoogleAuth;
   descriptors: Descriptors = {
     page: {},
@@ -289,10 +291,13 @@ export class FirestoreClient {
    */
   initialize() {
     // If the client stub promise is already initialized, return immediately.
-    if (this.firestoreStub) {
+    if (this.firestoreStub && !this._stubFailed) {
       return this.firestoreStub;
     }
 
+    // Reset _stubFailed because we are re-attempting create
+    this._stubFailed = false;
+
     // Put together the "service stub" for
     // google.firestore.v1.Firestore.
     this.firestoreStub = this._gaxGrpc.createStub(
@@ -328,8 +333,8 @@ export class FirestoreClient {
     ];
     for (const methodName of firestoreStubMethods) {
       const callPromise = this.firestoreStub.then(
-        stub =>
-          (...args: Array<{}>) => {
+        stub => {
+          return (...args: Array<{}>) => {
             if (this._terminated) {
               if (methodName in this.descriptors.stream) {
                 const stream = new PassThrough({objectMode: true});
@@ -347,9 +352,19 @@ export class FirestoreClient {
             }
             const func = stub[methodName];
             return func.apply(stub, args);
-          },
-        (err: Error | null | undefined) => () => {
-          throw err;
+          };
+        },
+        (err: Error | null | undefined) => {
+          this._stubFailed = true;
+          logger(
+            'initialize',
+            null,
+            'Failed to create the gax client stub.',
+            err
+          );
+          return () => {
+            throw err;
+          };
         }
       );
 

dev/test/gapic_firestore_v1.ts

@@ -26,6 +26,7 @@ import * as firestoreModule from '../src/v1';
 import {PassThrough} from 'stream';
 
 import {protobuf, LocationProtos} from 'google-gax';
+import {expect} from 'chai';
 
 // Dynamically loaded proto JSON is needed to get the type information
 // to fill in default values for request objects
@@ -3173,4 +3174,51 @@ describe('v1.FirestoreClient', () => {
       );
     });
   });
+
+  describe('initialize', () => {
+    it('retries on error', async () => {
+      const client = new firestoreModule.FirestoreClient({
+        credentials: {client_email: 'bogus', private_key: 'bogus'},
+        projectId: 'bogus',
+      });
+      const createStubStub = sinon.stub();
+      createStubStub.returns(Promise.reject('error'));
+
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore -- typing not required for testing
+      client['_gaxGrpc'] = {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore -- typing not required for testing
+        createStub: createStubStub,
+      };
+
+      try {
+        await client.initialize();
+      } catch (e: unknown) {
+        expect(e).to.equal('error');
+      }
+
+      try {
+        await client.initialize();
+      } catch (e: unknown) {
+        expect(e).to.equal('error');
+      }
+
+      expect(createStubStub.callCount).to.equal(2);
+    });
+
+    it('does not recreate stub when one exists', async () => {
+      const client = new firestoreModule.FirestoreClient({
+        credentials: {client_email: 'bogus', private_key: 'bogus'},
+        projectId: 'bogus',
+      });
+
+      const createStubSpy = sinon.spy(client['_gaxGrpc'], 'createStub');
+
+      await client.initialize();
+      await client.initialize();
+
+      expect(createStubSpy.callCount).to.equal(1);
+    });
+  });
 });