Add verbosity flag (#6429)

* Add verbosity flag * Fixme fix * Changed name, added SILENT --------- Co-authored-by: joehan <[email protected]>
firebase · Oct 10, 2023 · 6c83905 · 6c83905
1 parent b36700f
commit 6c83905
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 4 deletions.
diff --git a/src/commands/emulators-exec.ts b/src/commands/emulators-exec.ts
@@ -12,6 +12,7 @@ export const command = new Command("emulators:exec <script>")
   .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
   .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_UI, commandUtils.DESC_UI)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   .action((script: string, options: any) => {

diff --git a/src/commands/emulators-start.ts b/src/commands/emulators-start.ts
@@ -24,6 +24,7 @@ export const command = new Command("emulators:start")
   .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
   .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)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   .action((options: any) => {
     const killSignalPromise = commandUtils.shutdownWhenKilled(options);

diff --git a/src/emulator/commandUtils.ts b/src/emulator/commandUtils.ts
@@ -47,6 +47,10 @@ export const EXPORT_ON_EXIT_USAGE_ERROR =
 
 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";
+export const FLAG_VERBOSITY = `${FLAG_VERBOSITY_NAME} <verbosity>`;
+export const DESC_VERBOSITY = "One of: DEBUG, INFO, QUIET, SILENT. "; // TODO complete the rest
+
 export const FLAG_UI = "--ui";
 export const DESC_UI = "run the Emulator UI";
 

diff --git a/src/emulator/controller.ts b/src/emulator/controller.ts
@@ -32,7 +32,7 @@ import { ExportMetadata, HubExport } from "./hubExport";
 import { EmulatorUI } from "./ui";
 import { LoggingEmulator } from "./loggingEmulator";
 import * as dbRulesConfig from "../database/rulesConfig";
-import { EmulatorLogger } from "./emulatorLogger";
+import { EmulatorLogger, Verbosity } from "./emulatorLogger";
 import { EmulatorHubClient } from "./hubClient";
 import { confirm } from "../prompt";
 import {
@@ -247,6 +247,7 @@ function findExportMetadata(importPath: string): ExportMetadata | undefined {
 
 interface EmulatorOptions extends Options {
   extDevEnv?: Record<string, string>;
+  logVerbosity?: "DEBUG" | "INFO" | "QUIET" | "SILENT";
 }
 
 /**
@@ -286,6 +287,10 @@ export async function startAll(
       throw new FirebaseError(JAVA_DEPRECATION_WARNING);
     }
   }
+  if (options.logVerbosity) {
+    EmulatorLogger.setVerbosity(Verbosity[options.logVerbosity]);
+  }
+
   const hubLogger = EmulatorLogger.forEmulator(Emulators.HUB);
   hubLogger.logLabeled("BULLET", "emulators", `Starting emulators: ${targets.join(", ")}`);
 

diff --git a/src/emulator/emulatorLogger.ts b/src/emulator/emulatorLogger.ts
@@ -32,18 +32,23 @@ export enum Verbosity {
   DEBUG = 0,
   INFO = 1,
   QUIET = 2,
+  SILENT = 3,
 }
 export type ExtensionLogInfo = {
   ref?: string;
   instanceId?: string;
 };
 
 export class EmulatorLogger {
-  static verbosity: Verbosity = Verbosity.DEBUG;
+  private static verbosity: Verbosity = Verbosity.DEBUG;
   static warnOnceCache = new Set<string>();
 
   constructor(public readonly name: string, private data: LogData = {}) {}
 
+  static setVerbosity(verbosity: Verbosity) {
+    EmulatorLogger.verbosity = verbosity;
+  }
+
   static forEmulator(emulator: Emulators) {
     return new EmulatorLogger(emulator, {
       metadata: {

diff --git a/src/emulator/functionsEmulator.ts b/src/emulator/functionsEmulator.ts
@@ -215,7 +215,7 @@ export class FunctionsEmulator implements EmulatorInstance {
 
   constructor(private args: FunctionsEmulatorArgs) {
     // TODO: Would prefer not to have static state but here we are!
-    EmulatorLogger.verbosity = this.args.quiet ? Verbosity.QUIET : Verbosity.DEBUG;
+    EmulatorLogger.setVerbosity(this.args.quiet ? Verbosity.QUIET : Verbosity.DEBUG);
     // When debugging is enabled, the "timeout" feature needs to be disabled so that
     // functions don't timeout while a breakpoint is active.
     if (this.args.debugPort) {

diff --git a/src/utils.ts b/src/utils.ts
@@ -194,7 +194,7 @@ export function logLabeledWarning(
 }
 
 /**
- * Log an rror statement with a red bullet at the start of the line.
+ * Log an error statement with a red bullet at the start of the line.
  */
 export function logLabeledError(
   label: string,