fix: move logging utils within runtime

Author: posva

packages/nuxt/src/logging.ts

@@ -19,7 +19,7 @@ import type {
 import { markRaw } from 'vue'
 import type { NuxtVueFireAppCheckOptions } from './runtime/app-check'
 import { addMissingAlias } from './firebaseAliases'
-import { log } from './logging'
+import { log } from './runtime/logging'
 
 export interface VueFireNuxtModuleOptions {
   /**

packages/nuxt/src/module.ts

@@ -5,7 +5,7 @@ import { getCookie } from 'h3'
 // FirebaseError is an interface here but is a class in firebase/app
 import type { FirebaseError } from 'firebase-admin'
 import { AUTH_COOKIE_NAME } from '../auth/api.session'
-import { log } from '../../logging'
+import { log } from '../logging'
 import { defineNuxtPlugin, useRequestEvent } from '#app'
 
 /**

packages/nuxt/src/runtime/admin/plugin-auth-user.server.ts

@@ -7,7 +7,7 @@ import {
   // renamed because there seems to be a global Credential type in vscode
   Credential as FirebaseAdminCredential,
 } from 'firebase-admin/app'
-import { log } from '../../logging'
+import { log } from '../logging'
 import { defineNuxtPlugin, useAppConfig } from '#app'
 
 export default defineNuxtPlugin((nuxtApp) => {
@@ -43,17 +43,18 @@ export default defineNuxtPlugin((nuxtApp) => {
           privateKey: FIREBASE_PRIVATE_KEY.replace(/\\n/g, '\n'),
         })
       } else if (process.env.GOOGLE_APPLICATION_CREDENTIALS) {
-        console.log(
-          '[VueFire]: using GOOGLE_APPLICATION_CREDENTIALS env variable'
-        )
+        log('using GOOGLE_APPLICATION_CREDENTIALS env variable')
         // automatically picks up the service account file path from the env variable
         credential = applicationDefault()
       } else {
-        // TODO: add link to docs
-        console.warn(`\
-[VueFire]: You must provide an "admin.serviceAccount" path to your json so it's picked up during development. See https://firebase.google.com/docs/admin/setup#initialize-sdk for more information. Note that you can also set the GOOGLE_APPLICATION_CREDENTIALS env variable to a full resolved path or a JSON string.
+        // TODO: add link to vuefire docs
+        log(
+          'warn',
+          `\
+You must provide an "admin.serviceAccount" path to your json so it's picked up during development. See https://firebase.google.com/docs/admin/setup#initialize-sdk for more information. Note that you can also set the GOOGLE_APPLICATION_CREDENTIALS env variable to a full resolved path or a JSON string.
 You can also set the FIREBASE_CLIENT_EMAIL, FIREBASE_PRIVATE_KEY and FIREBASE_PROJECT_ID env variables in production if you are deploying to something else than Firebase Cloud Functions.
-`)
+`
+        )
         throw new Error('admin-app/missing-credentials')
       }
 

packages/nuxt/src/runtime/admin/plugin.server.ts

@@ -2,7 +2,7 @@ import { deleteApp, FirebaseApp, initializeApp } from 'firebase/app'
 import { User } from 'firebase/auth'
 import LRU from 'lru-cache'
 import { UserSymbol } from '../admin/plugin-auth-user.server'
-import { log } from '../../logging'
+import { log } from '../logging'
 import { defineNuxtPlugin, useAppConfig } from '#app'
 
 // TODO: allow customizing

packages/nuxt/src/runtime/app/plugin.server.ts

@@ -8,7 +8,7 @@ import {
   deleteCookie,
   sendRedirect,
 } from 'h3'
-import { log } from '../../logging'
+import { log } from '../logging'
 import { AUTH_COOKIE_MAX_AGE, AUTH_COOKIE_NAME } from './api.session'
 
 // This version is used at https://github.com/FirebaseExtended/firebase-framework-tools/blob/e69f5bdd44695274ad88dbb4e21aac778ba60cc8/src/firebase-aware.ts#L39 but doesn't work locally. Should it maybe be used in production only? Seems unlikely.

packages/nuxt/src/runtime/auth/api.session-verification.ts

@@ -3,7 +3,7 @@ import type { User } from 'firebase/auth'
 import { VueFireAuthServer } from 'vuefire/server'
 import { UserSymbol } from '../admin/plugin-auth-user.server'
 import { defineNuxtPlugin } from '#app'
-import { log } from '../../logging'
+import { log } from '../logging'
 
 /**
  * Setups the auth state based on the cookie.

packages/nuxt/src/runtime/auth/plugin.server.ts

@@ -0,0 +1,24 @@
+export type LogType = 'debug' | 'info' | 'warn' | 'error' | 'trace' | 'log'
+
+// TODO: allow disabling logs with some env variables
+
+export function log(type: LogType, ...args: any[]): void
+export function log(...args: any[]): void
+export function log(...args: unknown[]): void {
+  const [typeOrLog, ...rest] = args
+  if (isLogType(typeOrLog)) {
+    console[typeOrLog]('[VueFire]:', ...rest)
+  } else {
+    console.log('[VueFire]:', ...args)
+  }
+}
+
+function isLogType(logType: unknown): logType is LogType {
+  return (
+    logType === 'debug' ||
+    logType === 'info' ||
+    logType === 'warn' ||
+    logType === 'error' ||
+    logType === 'trace'
+  )
+}