Stop using AppEngine to check database mode (#5261)

* Stop using AppEngine to check database mode

* fixing tests

* Removing unnecessary check for cloud resource location

* remove outdated test

* add changelog

Author: joehan

CHANGELOG.md

@@ -1,2 +1,3 @@
-- Refactor Functions Emulator. (#5422)
-- Fix race condition when discovering functions. (#5444)
+- Refactors Functions Emulator. (#5422)
+- Fixes race condition when discovering functions. (#5444)
+- Fixes issue where `init firestore` was unecessarilly checking for default resource location. (#5230 and #5452)

src/firestore/checkDatabaseType.ts

@@ -1,21 +1,24 @@
-import { appengineOrigin } from "../api";
+import { firestoreOrigin } from "../api";
 import { Client } from "../apiv2";
 import { logger } from "../logger";
 
 /**
  * Determine the Firestore database type for a given project. One of:
  *   - DATABASE_TYPE_UNSPECIFIED (unspecified)
- *   - CLOUD_DATASTORE (Datastore legacy)
- *   - CLOUD_FIRESTORE (Firestore native mode)
- *   - CLOUD_DATASTORE_COMPATIBILITY (Firestore datastore mode)
+ *   - DATASTORE_MODE(Datastore legacy)
+ *   - FIRESTORE_NATIVE (Firestore native mode)
  *
  * @param projectId the Firebase project ID.
  */
-export async function checkDatabaseType(projectId: string): Promise<string | undefined> {
+export async function checkDatabaseType(
+  projectId: string
+): Promise<"DATASTORE_MODE" | "FIRESTORE_NATIVE" | "DATABASE_TYPE_UNSPECIFIED" | undefined> {
   try {
-    const client = new Client({ urlPrefix: appengineOrigin, apiVersion: "v1" });
-    const resp = await client.get<{ databaseType?: string }>(`/apps/${projectId}`);
-    return resp.body.databaseType;
+    const client = new Client({ urlPrefix: firestoreOrigin, apiVersion: "v1" });
+    const resp = await client.get<{
+      type?: "DATASTORE_MODE" | "FIRESTORE_NATIVE" | "DATABASE_TYPE_UNSPECIFIED";
+    }>(`/projects/${projectId}/databases/(default)`);
+    return resp.body.type;
   } catch (err: any) {
     logger.debug("error getting database type", err);
     return undefined;

src/init/features/firestore/index.ts

@@ -1,6 +1,5 @@
 import { logger } from "../../../logger";
 import * as apiEnabled from "../../../ensureApiEnabled";
-import { ensureLocationSet } from "../../../ensureCloudResourceLocation";
 import { requirePermissions } from "../../../requirePermissions";
 import { checkDatabaseType } from "../../../firestore/checkDatabaseType";
 import * as rules from "./rules";
@@ -36,14 +35,13 @@ async function checkProjectSetup(setup: any, config: any, options: any) {
 
   if (!dbType) {
     throw firestoreUnusedError;
-  } else if (dbType !== "CLOUD_FIRESTORE") {
+  } else if (dbType !== "FIRESTORE_NATIVE") {
     throw new FirebaseError(
       `It looks like this project is using Cloud Datastore or Cloud Firestore in Datastore mode. The Firebase CLI can only manage projects using Cloud Firestore in Native mode. For more information, visit https://cloud.google.com/datastore/docs/firestore-or-datastore`,
       { exit: 1 }
     );
   }
 
-  ensureLocationSet(setup.projectLocation, "Cloud Firestore");
   await requirePermissions({ ...options, project: setup.projectId });
 }
 

src/test/init/features/firestore.spec.ts

@@ -21,7 +21,7 @@ describe("firestore", () => {
 
     // By default, mock Firestore enabled in Native mode
     checkApiStub.returns(true);
-    checkDbTypeStub.returns("CLOUD_FIRESTORE");
+    checkDbTypeStub.returns("FIRESTORE_NATIVE");
   });
 
   afterEach(() => {
@@ -46,15 +46,6 @@ describe("firestore", () => {
       expect(_.get(setup, "config.firestore")).to.deep.equal({});
     });
 
-    it("should error when cloud resource location is not set", async () => {
-      const setup = { config: {}, projectId: "my-project-123" };
-
-      await expect(firestore.doSetup(setup, {}, {})).to.eventually.be.rejectedWith(
-        FirebaseError,
-        "Cloud resource location is not set"
-      );
-    });
-
     it("should error when the firestore API is not enabled", async () => {
       checkApiStub.returns(false);