Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 86 additions & 2 deletions packages/vite/src/shared/__tests__/forwardConsole.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
import { describe, expect, test } from 'vitest'
import { formatConsoleArgs } from '../forwardConsole'
import { afterEach, describe, expect, test, vi } from 'vitest'
import {
formatConsoleArgs,
setupForwardConsoleHandler,
} from '../forwardConsole'

afterEach(() => {
vi.restoreAllMocks()
vi.unstubAllGlobals()
})

function waitForUnhandledRejectionCheck() {
return new Promise((resolve) => setTimeout(resolve, 0))
}

describe('formatConsoleArgs', () => {
test('formats placeholders', () => {
Expand Down Expand Up @@ -59,3 +71,75 @@ describe('formatConsoleArgs', () => {
)
})
})

describe('setupForwardConsoleHandler', () => {
test('swallows transport errors while forwarding unhandled rejections', async () => {
const transport = {
send: vi
.fn()
.mockRejectedValue(new Error('send was called before connect')),
}
const unhandledRejections: unknown[] = []
const onUnhandledRejection = (reason: unknown) => {
unhandledRejections.push(reason)
}
process.on('unhandledRejection', onUnhandledRejection)

try {
const window = new EventTarget()
vi.stubGlobal('window', window)
setupForwardConsoleHandler(transport as any, {
enabled: true,
unhandledErrors: true,
logLevels: [],
})

const event = new Event('unhandledrejection') as Event & {
reason: unknown
}
Object.defineProperty(event, 'reason', {
value: new Error('original rejection'),
})
window.dispatchEvent(event)

await waitForUnhandledRejectionCheck()

expect(transport.send).toHaveBeenCalledTimes(1)
expect(unhandledRejections).toEqual([])
} finally {
process.off('unhandledRejection', onUnhandledRejection)
}
})

test('swallows transport errors while forwarding console logs', async () => {
const consoleDebug = vi.spyOn(console, 'debug').mockImplementation(() => {})
const transport = {
send: vi
.fn()
.mockRejectedValue(new Error('send was called before connect')),
}
const unhandledRejections: unknown[] = []
const onUnhandledRejection = (reason: unknown) => {
unhandledRejections.push(reason)
}
process.on('unhandledRejection', onUnhandledRejection)

try {
setupForwardConsoleHandler(transport as any, {
enabled: true,
unhandledErrors: false,
logLevels: ['debug'],
})

console.debug('after disconnect')

await waitForUnhandledRejectionCheck()

expect(consoleDebug).toHaveBeenCalledWith('after disconnect')
expect(transport.send).toHaveBeenCalledTimes(1)
expect(unhandledRejections).toEqual([])
} finally {
process.off('unhandledRejection', onUnhandledRejection)
}
})
})
43 changes: 24 additions & 19 deletions packages/vite/src/shared/forwardConsole.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,32 +28,37 @@ export function setupForwardConsoleHandler(
return
}

function sendForwardConsolePayload(data: ForwardConsolePayload) {
transport
.send({
type: 'custom',
event: 'vite:forward-console',
data,
})
.catch(() => {
// Ignore forwarding failures, e.g. when the WebSocket was disconnected.
// Re-throwing here would trigger `unhandledrejection` and recurse.
})
}

function sendError(type: 'error' | 'unhandled-rejection', error: any) {
transport.send({
type: 'custom',
event: 'vite:forward-console',
sendForwardConsolePayload({
type,
data: {
type,
data: {
name: error?.name || 'Unknown Error',
message: error?.message || String(error),
stack: error?.stack,
},
} satisfies ForwardConsolePayload,
name: error?.name || 'Unknown Error',
message: error?.message || String(error),
stack: error?.stack,
},
})
}

function sendLog(level: ForwardConsoleLogLevel, args: unknown[]) {
transport.send({
type: 'custom',
event: 'vite:forward-console',
sendForwardConsolePayload({
type: 'log',
data: {
type: 'log',
data: {
level,
message: formatConsoleArgs(args),
},
} satisfies ForwardConsolePayload,
level,
message: formatConsoleArgs(args),
},
})
}

Expand Down
Loading