Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow injecting user-facing logger #493

Merged
merged 2 commits into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion node/bundler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export interface BundleOptions {
onAfterDownload?: OnAfterDownloadHook
onBeforeDownload?: OnBeforeDownloadHook
systemLogger?: LogFunction
userLogger?: LogFunction
vendorDirectory?: string
}

Expand All @@ -52,11 +53,12 @@ export const bundle = async (
internalSrcFolder,
onAfterDownload,
onBeforeDownload,
userLogger,
systemLogger,
vendorDirectory,
}: BundleOptions = {},
) => {
const logger = getLogger(systemLogger, debug)
const logger = getLogger(systemLogger, userLogger, debug)
const featureFlags = getFlags(inputFeatureFlags)
const options: DenoOptions = {
debug,
Expand Down
24 changes: 17 additions & 7 deletions node/logger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ afterEach(() => {
console.log = consoleLog
})

test('Prints user logs to stdout', () => {
test('Prints user logs to stdout if no user logger is provided', () => {
const mockConsoleLog = vi.fn()
console.log = mockConsoleLog

const logger1 = getLogger(noopLogger, true)
const logger2 = getLogger(noopLogger, false)
const logger1 = getLogger(noopLogger, undefined, true)
const logger2 = getLogger(noopLogger, undefined, false)

logger1.user('Hello with `debug: true`')
logger2.user('Hello with `debug: false`')
Expand All @@ -28,13 +28,23 @@ test('Prints user logs to stdout', () => {
expect(mockConsoleLog).toHaveBeenNthCalledWith(2, 'Hello with `debug: false`')
})

test('Prints user logs to user logger provided', () => {
const userLogger = vi.fn()
const logger = getLogger(noopLogger, userLogger, true)

logger.user('Hello!')

expect(userLogger).toHaveBeenCalledTimes(1)
expect(userLogger).toHaveBeenNthCalledWith(1, 'Hello!')
})

test('Prints system logs to the system logger provided', () => {
const mockSystemLog = vi.fn()
const mockConsoleLog = vi.fn()
console.log = mockSystemLog

const logger1 = getLogger(mockSystemLog, true)
const logger2 = getLogger(mockSystemLog, false)
const logger1 = getLogger(mockSystemLog, undefined, true)
const logger2 = getLogger(mockSystemLog, undefined, false)

logger1.system('Hello with `debug: true`')
logger2.system('Hello with `debug: false`')
Expand All @@ -49,8 +59,8 @@ test('Prints system logs to stdout if there is no system logger provided and `de
const mockConsoleLog = vi.fn()
console.log = mockConsoleLog

const logger1 = getLogger(undefined, true)
const logger2 = getLogger(undefined, false)
const logger1 = getLogger(undefined, undefined, true)
const logger2 = getLogger(undefined, undefined, false)

logger1.system('Hello with `debug: true`')
logger2.system('Hello with `debug: false`')
Expand Down
5 changes: 3 additions & 2 deletions node/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ interface Logger {
user: LogFunction
}

const getLogger = (systemLogger?: LogFunction, debug = false): Logger => {
const getLogger = (systemLogger?: LogFunction, userLogger?: LogFunction, debug = false): Logger => {
// If there is a system logger configured, we'll use that. If there isn't,
// we'll pipe system logs to stdout if `debug` is enabled and swallow them
// otherwise.
const system = systemLogger ?? (debug ? console.log : noopLogger)
const user = userLogger ?? console.log

return {
system,
user: console.log,
user,
}
}

Expand Down