import type { MatcherContext } from 'expect' import { toMatchInlineSnapshot } from 'jest-snapshot' import { assertHasRedbox, getRedboxCallStack, getRedboxComponentStack, getRedboxDescription, getRedboxEnvironmentLabel, getRedboxSource, getRedboxLabel, getRedboxTotalErrorCount, openRedbox, } from './next-test-utils' import type { Playwright } from 'next-webdriver' import { NextInstance } from 'e2e-utils' declare global { namespace jest { // eslint-disable-next-line @typescript-eslint/no-unused-vars -- module augmentation needs to match generic params even if unused interface Matchers { /** * Inline snapshot matcher for a Redbox that's popped up by default. * When a Redbox is hidden at first and requires manual display by clicking the toast, * use {@link toDisplayCollapsedRedbox} instead. * * * If the project root appears in the snapshot, pass in the `NextInstance` * as well to normalize the snapshot e.g. `await expect({ browser, next }).toDisplayRedbox()`. * * Unintented content in the snapshot should be reported to the Next.js DX team. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * Any node_modules in the snapshot would be unintended. * Differences in the snapshot between Turbopack and Webpack would be unintended. * * @param inlineSnapshot - The snapshot to compare against. */ toDisplayRedbox( inlineSnapshot?: string, opts?: ErrorSnapshotOptions ): Promise /** * Inline snapshot matcher for a Redbox that's collapsed by default. * When a Redbox is immediately displayed, * use {@link toDisplayRedbox} instead. * * If the project root appears in the snapshot, pass in the `NextInstance` * as well to normalize the snapshot e.g. `await expect({ browser, next }).toDisplayCollapsedRedbox()`. * * Unintented content in the snapshot should be reported to the Next.js DX team. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * `` in the snapshot would be unintended. * Any node_modules in the snapshot would be unintended. * Differences in the snapshot between Turbopack and Webpack would be unintended. * * @param inlineSnapshot - The snapshot to compare against. */ toDisplayCollapsedRedbox( inlineSnapshot?: string, opts?: ErrorSnapshotOptions ): Promise } } } interface ErrorSnapshotOptions { label?: boolean } interface ErrorSnapshot { environmentLabel: string | null label: string | null description: string | null componentStack?: string source: string | null stack: string[] | null } async function createErrorSnapshot( browser: Playwright, next: NextInstance | null, { label: includeLabel = true }: ErrorSnapshotOptions = {} ): Promise { const [label, environmentLabel, description, source, stack, componentStack] = await Promise.all([ includeLabel ? getRedboxLabel(browser) : null, getRedboxEnvironmentLabel(browser), getRedboxDescription(browser), getRedboxSource(browser), getRedboxCallStack(browser), getRedboxComponentStack(browser), ]) // We don't need to test the codeframe logic everywhere. // Here we focus on the cursor position of the top most frame // From // // pages/index.js (3:11) @ eval // // 1 | export default function Page() { // 2 | [1, 2, 3].map(() => { // > 3 | throw new Error("anonymous error!"); // | ^ // 4 | }) // 5 | } // // to // // pages/index.js (3:11) @ Page // > 3 | throw new Error("anonymous error!"); // | ^ let focusedSource = source if (source !== null) { focusedSource = '' const sourceFrameLines = source.split('\n') for (let i = 0; i < sourceFrameLines.length; i++) { const sourceFrameLine = sourceFrameLines[i].trimEnd() if (sourceFrameLine === '') { continue } if (sourceFrameLine.startsWith('>')) { // This is where the cursor will point // Include the cursor and nothing below since it's just surrounding code. focusedSource += '\n' + sourceFrameLine focusedSource += '\n' + sourceFrameLines[i + 1] break } const isCodeFrameLine = /^ {2}\s*\d+ \|/.test(sourceFrameLine) if (!isCodeFrameLine) { focusedSource += '\n' + sourceFrameLine } } focusedSource = focusedSource.trim() if (next !== null) { focusedSource = focusedSource.replaceAll( next.testDir, '' ) } // This is the processed path the nextjs file from node_modules, // likely not being processed properly and it's not deterministic among tests. // e.g. it could be a encoded url of loader path: // ../packages/next/dist/build/webpack/loaders/next-app-loader/index.js... const sourceLines = focusedSource.split('\n') if ( sourceLines[0].startsWith('./node_modules/.pnpm/next@file+') || sourceLines[0].startsWith('./node_modules/.pnpm/file+') || // e.g. "next-app-loader?" (in rspack, the loader doesn't seem to be prefixed with node_modules) /^next-[a-zA-Z0-9\-_]+?-loader\?/.test(sourceLines[0]) ) { focusedSource = `` + '\n' + sourceLines.slice(1).join('\n') } } let sanitizedDescription = description if (sanitizedDescription) { sanitizedDescription = sanitizedDescription .replace(/{imported module [^}]+}/, '') .replace(/\w+_WEBPACK_IMPORTED_MODULE_\w+/, '') if (next !== null) { sanitizedDescription = sanitizedDescription.replace( next.testDir, '' ) } } const snapshot: ErrorSnapshot = { environmentLabel, label: label ?? '', description: sanitizedDescription, source: focusedSource, stack: next !== null && stack !== null ? stack.map((stackframe) => { return stackframe.replace(next.testDir, '') }) : stack, } // Hydration diffs are only relevant to some specific errors // so we hide them from the snapshots unless they are present. if (componentStack !== null) { snapshot.componentStack = componentStack } return snapshot } type RedboxSnapshot = ErrorSnapshot | ErrorSnapshot[] async function createRedboxSnapshot( browser: Playwright, next: NextInstance | null, opts?: ErrorSnapshotOptions ): Promise { const errorTally = await getRedboxTotalErrorCount(browser) const errorSnapshots: ErrorSnapshot[] = [] for (let errorIndex = 0; errorIndex < errorTally; errorIndex++) { const errorSnapshot = await createErrorSnapshot(browser, next, opts) errorSnapshots.push(errorSnapshot) if (errorIndex < errorTally - 1) { // Go to next error await browser .waitForElementByCss('[data-nextjs-dialog-error-next]') .click() // TODO: Wait for suspended content if the click triggered it. await browser.waitForElementByCss( `[data-nextjs-dialog-error-index="${errorIndex + 1}"]` ) } } return errorSnapshots.length === 1 ? // Most of the Redbox tests will just show a single error. // We optimize display for that case. errorSnapshots[0] : errorSnapshots } expect.extend({ async toDisplayRedbox( this: MatcherContext, browserOrContext: Playwright | { browser: Playwright; next: NextInstance }, expectedRedboxSnapshot?: string, opts?: ErrorSnapshotOptions ) { let browser: Playwright let next: NextInstance | null if ('browser' in browserOrContext && 'next' in browserOrContext) { browser = browserOrContext.browser next = browserOrContext.next } else { browser = browserOrContext next = null } // Otherwise jest uses the async stack trace which makes it impossible to know the actual callsite of `toMatchSpeechInlineSnapshot`. // @ts-expect-error -- Not readonly this.error = new Error() // Abort test on first mismatch. // Subsequent actions will be based on an incorrect state otherwise and almost always fail as well. // TODO: Actually, we may want to proceed. Kinda nice to also do more assertions later. this.dontThrow = () => {} try { await assertHasRedbox(browser) } catch (cause) { // argument length is relevant. // Jest will update absent snapshots but fail if you specify a snapshot even if undefined. if (expectedRedboxSnapshot === undefined) { return toMatchInlineSnapshot.call(this, String(cause.message)) } else { return toMatchInlineSnapshot.call( this, String(cause.message), expectedRedboxSnapshot ) } } const redbox = await createRedboxSnapshot(browser, next, opts) // argument length is relevant. // Jest will update absent snapshots but fail if you specify a snapshot even if undefined. if (expectedRedboxSnapshot === undefined) { return toMatchInlineSnapshot.call(this, redbox) } else { return toMatchInlineSnapshot.call(this, redbox, expectedRedboxSnapshot) } }, async toDisplayCollapsedRedbox( this: MatcherContext, browserOrContext: Playwright | { browser: Playwright; next: NextInstance }, expectedRedboxSnapshot?: string, opts?: ErrorSnapshotOptions ) { let browser: Playwright let next: NextInstance | null if ('browser' in browserOrContext && 'next' in browserOrContext) { browser = browserOrContext.browser next = browserOrContext.next } else { browser = browserOrContext next = null } // Otherwise jest uses the async stack trace which makes it impossible to know the actual callsite of `toMatchSpeechInlineSnapshot`. // @ts-expect-error -- Not readonly this.error = new Error() // Abort test on first mismatch. // Subsequent actions will be based on an incorrect state otherwise and almost always fail as well. // TODO: Actually, we may want to proceed. Kinda nice to also do more assertions later. this.dontThrow = () => {} try { await openRedbox(browser) } catch (cause) { // argument length is relevant. // Jest will update absent snapshots but fail if you specify a snapshot even if undefined. if (expectedRedboxSnapshot === undefined) { return toMatchInlineSnapshot.call( this, String(cause.message) // Should switch to `toDisplayRedbox` not `assertHasRedbox` .replace('assertHasRedbox', 'toDisplayRedbox') ) } else { return toMatchInlineSnapshot.call( this, String(cause.message) // Should switch to `toDisplayRedbox` not `assertHasRedbox` .replace('assertHasRedbox', 'toDisplayRedbox'), expectedRedboxSnapshot ) } } const redbox = await createRedboxSnapshot(browser, next, opts) // argument length is relevant. // Jest will update absent snapshots but fail if you specify a snapshot even if undefined. if (expectedRedboxSnapshot === undefined) { return toMatchInlineSnapshot.call(this, redbox) } else { return toMatchInlineSnapshot.call(this, redbox, expectedRedboxSnapshot) } }, })