Kristaps Fabians Geikins
90 lines
2.5 KiB
TypeScript
90 lines
2.5 KiB
TypeScript
import type { NuxtApp } from '#app'
|
|
import type { Optional } from '@speckle/shared'
|
|
import { buildFakePinoLogger } from '~~/lib/core/helpers/observability'
|
|
|
|
export type AppLogger = ReturnType<typeof useLogger>
|
|
|
|
export const useLogger = () => {
|
|
return useNuxtApp().$logger
|
|
}
|
|
|
|
/**
|
|
* Use when you need to be sure that the real structured pino logger is available
|
|
* (it isn't in some early startup contexts like apollo link setup)
|
|
*/
|
|
export const useStrictLogger = async (
|
|
options?: Partial<{ dontNotifyFallback: boolean }>
|
|
) => {
|
|
const { dontNotifyFallback } = options || {}
|
|
|
|
let nuxtApp: Optional<NuxtApp> = undefined
|
|
try {
|
|
nuxtApp = useNuxtApp()
|
|
} catch {
|
|
// suppress 'nuxt is not available'
|
|
}
|
|
|
|
if (nuxtApp?.$logger) return nuxtApp?.$logger
|
|
|
|
// Nuxt app not found in this scope
|
|
const err = new Error(
|
|
'Nuxt app for logger not found! Initializing fallback structured logger...'
|
|
)
|
|
|
|
let logger: ReturnType<typeof buildFakePinoLogger>
|
|
if (import.meta.server) {
|
|
const { buildLogger } = await import('~/server/lib/core/helpers/observability')
|
|
logger = buildLogger('info', import.meta.dev ? true : false) // no runtime config, so falling back to default settings
|
|
} else {
|
|
logger = buildFakePinoLogger()
|
|
}
|
|
|
|
if (!dontNotifyFallback) logger.error(err)
|
|
|
|
return logger
|
|
}
|
|
|
|
/**
|
|
* Use when you need to be sure that the real structured pino logger is available
|
|
* (it isn't in some early startup contexts like apollo link setup)
|
|
*
|
|
* The async version is better in that it will build a real pino logger, but in sync contexts
|
|
* you can use this one that will at least fallback to console.log/warn/error
|
|
*/
|
|
export const useStrictLoggerSync = (
|
|
options?: Partial<{ dontNotifyFallback: boolean }>
|
|
) => {
|
|
const { dontNotifyFallback } = options || {}
|
|
|
|
let nuxtApp: Optional<NuxtApp> = undefined
|
|
try {
|
|
nuxtApp = useNuxtApp()
|
|
} catch {
|
|
// suppress 'nuxt is not available'
|
|
}
|
|
|
|
if (nuxtApp?.$logger) return nuxtApp?.$logger
|
|
|
|
// Nuxt app not found in this scope
|
|
const err = new Error(
|
|
'Nuxt app for logger not found! Initializing fallback structured logger...'
|
|
)
|
|
const logger = buildFakePinoLogger()
|
|
|
|
if (!dontNotifyFallback) logger.error(err)
|
|
|
|
return logger
|
|
}
|
|
|
|
/**
|
|
* Short-cut to useLogger().debug, useful when you quickly want to console.log something during development.
|
|
* Calls to this are skipped outside of dev mode.
|
|
*/
|
|
export const useDevLogger = () => {
|
|
if (!import.meta.dev) return noop
|
|
|
|
const logger = useLogger()
|
|
const debug = logger.debug.bind(logger)
|
|
return debug as (...args: unknown[]) => void
|
|
}
|