feat: preferRest app option for Firestore

etc/firebase-admin.api.md

@@ -73,6 +73,7 @@ export interface AppOptions {
     databaseAuthVariableOverride?: object | null;
     databaseURL?: string;
     httpAgent?: Agent;
+    preferRest?: boolean;
     projectId?: string;
     serviceAccountId?: string;
     storageBucket?: string;

etc/firebase-admin.app.api.md

@@ -23,6 +23,7 @@ export interface AppOptions {
     databaseAuthVariableOverride?: object | null;
     databaseURL?: string;
     httpAgent?: Agent;
+    preferRest?: boolean;
     projectId?: string;
     serviceAccountId?: string;
     storageBucket?: string;

package.json

@@ -198,7 +198,7 @@
     "uuid": "^8.3.2"
   },
   "optionalDependencies": {
-    "@google-cloud/firestore": "^6.0.0",
+    "@google-cloud/firestore": "^6.2.0",
     "@google-cloud/storage": "^6.1.0"
   },
   "devDependencies": {

src/app/core.ts

@@ -83,6 +83,14 @@ export interface AppOptions {
    * specifying an HTTP Agent in the corresponding factory methods.
    */
   httpAgent?: Agent;
+
+  /**
+   * Prefer REST transport for Firestore.
+   * By default, Firestore will use gRPC. Pass preferRest: true to use
+   * HTTP/1.1 REST transport if possible. Note that gRPC will still be
+   * used for calls that need bi-directional streaming.
+   */
+  preferRest?: boolean;
 }
 
 /**

src/firestore/firestore-internal.ts

@@ -57,6 +57,7 @@ export function getFirestoreOptions(app: App): Settings {
 
   const projectId: string | null = utils.getExplicitProjectId(app);
   const credential = app.options.credential;
+  const preferRest = app.options.preferRest;
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const { version: firebaseVersion } = require('../../package.json');
   if (credential instanceof ServiceAccountCredential) {
@@ -69,12 +70,15 @@ export function getFirestoreOptions(app: App): Settings {
       // guaranteed to be available.
       projectId: projectId!,
       firebaseVersion,
+      preferRest,
     };
   } else if (isApplicationDefault(app.options.credential)) {
     // Try to use the Google application default credentials.
     // If an explicit project ID is not available, let Firestore client discover one from the
     // environment. This prevents the users from having to set GOOGLE_CLOUD_PROJECT in GCP runtimes.
-    return validator.isNonEmptyString(projectId) ? { projectId, firebaseVersion } : { firebaseVersion };
+    return validator.isNonEmptyString(projectId)
+      ? { projectId, firebaseVersion, preferRest }
+      : { firebaseVersion, preferRest };
   }
 
   throw new FirebaseFirestoreError({

test/unit/firestore/firestore.spec.ts

@@ -31,6 +31,9 @@ describe('Firestore', () => {
   let mockApp: FirebaseApp;
   let mockCredentialApp: FirebaseApp;
   let projectIdApp: FirebaseApp;
+  let preferRestAppDefault: FirebaseApp;
+  let preferRestAppCredentials: FirebaseApp;
+  let preferRestAppProjectId: FirebaseApp;
   let firestore: any;
 
   let appCredentials: string | undefined;
@@ -70,6 +73,18 @@ describe('Firestore', () => {
       credential: mocks.credential,
       projectId: 'explicit-project-id',
     });
+    preferRestAppDefault = mocks.appWithOptions({
+      preferRest: true,
+    });
+    preferRestAppCredentials = mocks.appWithOptions({
+      credential: mocks.credential,
+      preferRest: true,
+    });
+    preferRestAppProjectId = mocks.appWithOptions({
+      credential: mocks.credential,
+      projectId: 'explicit-project-id',
+      preferRest: true,
+    });
     firestore = new FirestoreService(mockApp);
   });
 
@@ -210,4 +225,26 @@ describe('Firestore', () => {
       });
     });
   });
+
+  describe('options.preferRest', () => {
+    it('should set preferRest in Firestore options - default', () => {
+      const options = getFirestoreOptions(preferRestAppDefault);
+      expect(options.preferRest).to.be.true;
+    });
+
+    it('should set preferRest in Firestore options - credentials', () => {
+      const options = getFirestoreOptions(preferRestAppCredentials);
+      expect(options.preferRest).to.be.true;
+    });
+
+    it('should set preferRest in Firestore options - projectId', () => {
+      const options = getFirestoreOptions(preferRestAppProjectId);
+      expect(options.preferRest).to.be.true;
+    });
+
+    it('should not set preferRest in Firestore options by default', () => {
+      const options = getFirestoreOptions(mockApp);
+      expect(options.preferRest).to.be.undefined;
+    });
+  });
 });