fix(emulators): activate without enabled option in dev

Author: posva

packages/nuxt/src/module.ts

@@ -36,7 +36,7 @@ export default defineNuxtModule<VueFireNuxtModuleOptions>({
 
   defaults: {
     optionsApiPlugin: false,
-    emulators: true,
+    emulators: { enabled: true },
   },
 
   async setup(options, nuxt) {
@@ -51,16 +51,6 @@ export default defineNuxtModule<VueFireNuxtModuleOptions>({
     const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
     const templatesDir = fileURLToPath(new URL('../templates', import.meta.url))
 
-    // we need this to avoid some warnings about missing credentials and ssr
-    const emulatorsConfig = await willUseEmulators(
-      options,
-      resolve(nuxt.options.rootDir, 'firebase.json'),
-      logger
-    )
-
-    // to handle TimeStamp and GeoPoints objects
-    addPlugin(resolve(runtimeDir, 'payload-plugin'))
-
     // TODO: I don't think the appConfig is the right place to store these as it makes things reactive
     // Let plugins and the user access the firebase config within the app
     nuxt.options.appConfig.firebaseConfig = markRaw(options.config)
@@ -73,13 +63,23 @@ export default defineNuxtModule<VueFireNuxtModuleOptions>({
         emulators: {
           enabled:
             typeof options.emulators === 'object'
-              ? options.emulators.enabled
+              ? options.emulators.enabled ?? true // allows user to comment out enabled: false
               : !!options.emulators,
           ...(typeof options.emulators === 'object' ? options.emulators : {}),
         },
       },
     }
 
+    // we need this to avoid some warnings about missing credentials and ssr
+    const emulatorsConfig = await willUseEmulators(
+      nuxt.options.runtimeConfig.vuefire.options!,
+      resolve(nuxt.options.rootDir, 'firebase.json'),
+      logger
+    )
+
+    // to handle TimeStamp and GeoPoints objects
+    addPlugin(resolve(runtimeDir, 'payload-plugin'))
+
     nuxt.options.build.transpile.push(runtimeDir)
     nuxt.options.build.transpile.push(templatesDir)
 
@@ -194,7 +194,11 @@ export default defineNuxtModule<VueFireNuxtModuleOptions>({
     // Emulators must be enabled after the app is initialized but before some APIs like auth.signinWithCustomToken() are called
 
     if (emulatorsConfig) {
-      const emulators = detectEmulators(options, emulatorsConfig, logger)
+      const emulators = detectEmulators(
+        nuxt.options.runtimeConfig.vuefire.options!,
+        emulatorsConfig,
+        logger
+      )
       // add the option to disable the warning. It only exists in Auth
       if (emulators?.auth) {
         emulators.auth.options =

packages/nuxt/src/module/emulators.ts

@@ -1,15 +1,16 @@
-import { readFile, stat, access, constants } from 'node:fs/promises'
+import { readFile, access, constants } from 'node:fs/promises'
 import stripJsonComments from 'strip-json-comments'
 import type { ConsolaInstance } from 'consola'
-import type { VueFireNuxtModuleOptions } from './options'
+import type { VueFireNuxtModuleOptionsResolved } from './options'
 
 export async function willUseEmulators(
-  { emulators }: VueFireNuxtModuleOptions,
+  { emulators }: VueFireNuxtModuleOptionsResolved,
   firebaseJsonPath: string,
   logger: ConsolaInstance
 ): Promise<NonNullable<FirebaseEmulatorsJSON['emulators']> | null> {
   const isEmulatorEnabled =
-    (typeof emulators === 'object' ? emulators.enabled : !!emulators) &&
+    // emulators is always defined
+    emulators.enabled &&
     // Disable emulators on production unless the user explicitly enables them
     (process.env.NODE_ENV !== 'production' || process.env.VUEFIRE_EMULATORS)
 
@@ -26,10 +27,6 @@ export async function willUseEmulators(
     return null
   }
 
-  const fileStats = await stat(firebaseJsonPath)
-  if (!fileStats.isFile()) {
-    return null
-  }
   let firebaseJson: FirebaseEmulatorsJSON | null = null
   try {
     firebaseJson = JSON.parse(
@@ -54,31 +51,34 @@ export async function willUseEmulators(
  * @param logger - The logger instance
  */
 export function detectEmulators(
-  { emulators: _emulatorsOptions, auth }: VueFireNuxtModuleOptions,
-  emulators: NonNullable<FirebaseEmulatorsJSON['emulators']>,
+  {
+    emulators: _vuefireEmulatorsOptions,
+    auth,
+  }: VueFireNuxtModuleOptionsResolved,
+  firebaseEmulatorsConfig: NonNullable<FirebaseEmulatorsJSON['emulators']>,
   logger: ConsolaInstance
 ) {
   // normalize the emulators option
-  const emulatorsOptions =
-    typeof _emulatorsOptions === 'object'
-      ? _emulatorsOptions
+  const vuefireEmulatorsOptions =
+    typeof _vuefireEmulatorsOptions === 'object'
+      ? _vuefireEmulatorsOptions
       : {
-          enabled: _emulatorsOptions,
+          enabled: _vuefireEmulatorsOptions,
         }
 
-  if (!emulators) {
-    if (emulatorsOptions.enabled !== false) {
+  if (!firebaseEmulatorsConfig) {
+    if (vuefireEmulatorsOptions.enabled !== false) {
       logger.warn(
         'You enabled emulators but there is no `emulators` key in your `firebase.json` file. Emulators will not be enabled.'
       )
     }
     return
   }
 
-  const defaultHost: string = emulatorsOptions.host || '127.0.0.1'
+  const defaultHost: string = vuefireEmulatorsOptions.host || '127.0.0.1'
 
   const emulatorsToEnable = services.reduce((acc, service) => {
-    if (emulators[service]) {
+    if (firebaseEmulatorsConfig[service]) {
       // these env variables are automatically picked up by the admin SDK too
       // https://firebase.google.com/docs/emulator-suite/connect_rtdb?hl=en&authuser=0#admin_sdks
       // Also, Firestore is the only one that has a different env variable
@@ -109,7 +109,7 @@ export function detectEmulators(
       }
 
       // take the values from the firebase.json file
-      const emulatorsServiceConfig = emulators[service]
+      const emulatorsServiceConfig = firebaseEmulatorsConfig[service]
       // they might be picked up from the environment variables
       host ??= emulatorsServiceConfig?.host || defaultHost
       port ??= emulatorsServiceConfig?.port

packages/nuxt/src/module/options.ts

@@ -77,5 +77,5 @@ export interface VueFireNuxtModuleOptions {
 
 export interface VueFireNuxtModuleOptionsResolved
   extends Omit<VueFireNuxtModuleOptions, 'emulators'> {
-  emulators: Exclude<VueFireNuxtModuleOptions['emulators'], boolean>
+  emulators: Exclude<VueFireNuxtModuleOptions['emulators'], boolean | undefined>
 }