Emulator edition

schema/firebase-config.json

@@ -1412,6 +1412,9 @@
                 "firestore": {
                     "additionalProperties": false,
                     "properties": {
+                        "edition": {
+                            "type": "string"
+                        },
                         "host": {
                             "type": "string"
                         },

src/commands/emulators-start.ts

@@ -25,6 +25,7 @@
   .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)
   .option(commandUtils.FLAG_EXPORT_ON_EXIT, commandUtils.DESC_EXPORT_ON_EXIT)
   .option(commandUtils.FLAG_VERBOSITY, commandUtils.DESC_VERBOSITY)
+  .option(commandUtils.FLAG_EDITION, commandUtils.DESC_EDITION)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   .action((options: Options) => {
     const killSignalPromise = commandUtils.shutdownWhenKilled(options);
@@ -35,7 +36,7 @@
         try {
           ({ deprecationNotices } = await controller.startAll(options));
           await sendVSCodeMessage({ message: VSCODE_MESSAGE.EMULATORS_STARTED });
         } catch (e: any) {
           await sendVSCodeMessage({ message: VSCODE_MESSAGE.EMULATORS_START_ERRORED });
           await controller.cleanShutdown();
           throw e;
@@ -61,7 +62,7 @@
     if (info) {
       reservedPorts.push(info.port);
     }
     controller.filterEmulatorTargets(options).forEach((emulator: Emulators) => {
       reservedPorts.push(...(EmulatorRegistry.getInfo(emulator)?.reservedPorts || []));
     });
   }
@@ -94,7 +95,7 @@
 
   emulatorsTable.push(
     ...controller
       .filterEmulatorTargets(options)
       .map((emulator) => {
         const emulatorName = Constants.description(emulator).replace(/ emulator/i, "");
         const isSupportedByUi = EMULATORS_SUPPORTED_BY_UI.includes(emulator);
@@ -126,9 +127,9 @@
     extensionsTable = extensionsEmulatorInstance.extensionsInfoTable();
   }
   const hubInfo = EmulatorRegistry.getInfo(Emulators.HUB);
   logger.info(`\n${successMessageTable}
 
 ${emulatorsTable}
 ${
   hubInfo
     ? clc.blackBright(`  Emulator Hub host: ${hubInfo.host} port: ${hubInfo.port}`)

src/emulator/commandUtils.ts

@@ -46,6 +46,9 @@
   `"${FLAG_EXPORT_ON_EXIT_NAME}" must be used with "${FLAG_IMPORT}"` +
   ` or provide a dir directly to "${FLAG_EXPORT_ON_EXIT}"`;
 
+export const FLAG_EDITION = "--edition [edition]";
+export const DESC_EDITION = "start emulator in either standard or enterprise edition.";
+
 export const EXPORT_ON_EXIT_CWD_DANGER = `"${FLAG_EXPORT_ON_EXIT_NAME}" must not point to the current directory or parents. Please choose a new/dedicated directory for exports.`;
 
 export const FLAG_VERBOSITY_NAME = "--log-verbosity";
@@ -82,7 +85,7 @@
  * specify an emulator address.
  */
 export function printNoticeIfEmulated(
   options: any,
   emulator: Emulators.DATABASE | Emulators.FIRESTORE,
 ): void {
   if (emulator !== Emulators.DATABASE && emulator !== Emulators.FIRESTORE) {
@@ -110,7 +113,7 @@
  * an emulator port that the command actually talks to production.
  */
 export async function warnEmulatorNotSupported(
   options: any,
   emulator: Emulators.DATABASE | Emulators.FIRESTORE,
 ): Promise<void> {
   if (emulator !== Emulators.DATABASE && emulator !== Emulators.FIRESTORE) {
@@ -137,8 +140,8 @@
   }
 }
 
 export async function errorMissingProject(options: any): Promise<void> {
   if (!options.project) {
     throw new FirebaseError(
       "Project is not defined. Either use `--project` or use `firebase use` to set your active project.",
     );

src/emulator/controller.ts

@@ -642,10 +642,26 @@ export async function startAll(
     const firestoreAddr = legacyGetFirstAddr(Emulators.FIRESTORE);
     const websocketPort = legacyGetFirstAddr("firestore.websocket").port;
 
+    if (options.edition !== undefined) {
+      utils.assertIsString(options.edition, "edition");
+    }
+    const edition = (
+      (options.edition as string) ||
+      options.config.src.emulators?.firestore?.edition ||
+      "standard"
+    ).toLowerCase();
+    if (edition !== "standard" && edition !== "enterprise") {
+      throw new FirebaseError(
+        "The Firestore emulator edition must be either 'standard' or 'enterprise'.",
+        { exit: 1 },
+      );
+    }
+
     const args: FirestoreEmulatorArgs = {
       host: firestoreAddr.host,
       port: firestoreAddr.port,
       websocket_port: websocketPort,
+      "database-edition": edition,
       project_id: projectId,
       auto_download: true,
     };
@@ -730,6 +746,11 @@ export async function startAll(
 
     const firestoreEmulator = new FirestoreEmulator(args);
     await startEmulator(firestoreEmulator);
+    firestoreLogger.logLabeled(
+      "SUCCESS",
+      Emulators.FIRESTORE,
+      `Firestore Emulator was started in ${edition} edition.`,
+    );
     firestoreLogger.logLabeled(
       "SUCCESS",
       Emulators.FIRESTORE,

src/emulator/downloadableEmulators.ts

@@ -244,6 +244,7 @@ const Commands: { [s in DownloadableEmulators]: DownloadableEmulatorCommand } =
       "host",
       "rules",
       "websocket_port",
+      "database-edition",
       "functions_emulator",
       "seed_from_export",
       "project_id",

src/emulator/firestoreEmulator.ts

@@ -14,6 +14,7 @@ export interface FirestoreEmulatorArgs {
   port?: number;
   host?: string;
   websocket_port?: number;
+  "database-edition"?: string;
   project_id?: string;
   rules?: string;
   functions_emulator?: string;

src/firebaseConfig.ts

@@ -240,6 +240,7 @@ export type EmulatorsConfig = {
     host?: string;
     port?: number;
     websocketPort?: number;
+    edition?: string;
   };
   functions?: {
     host?: string;

src/options.ts

@@ -26,6 +26,7 @@ export interface BaseOptions {
   // Emulator specific import/export options
   exportOnExit?: boolean | string;
   import?: string;
+  edition?: string;
 
   isMCP?: boolean;