Unverified Commit f3533cb2 authored by Hendrik Liebau's avatar Hendrik Liebau Committed by GitHub

Show readable hook names in stack frames (#72340)

parent b9dcc6c3
......@@ -8,10 +8,10 @@ use crate::{
next_client::context::ClientContextType,
next_config::NextConfig,
next_shared::transforms::{
get_next_dynamic_transform_rule, get_next_font_transform_rule, get_next_image_rule,
get_next_lint_transform_rule, get_next_modularize_imports_rule,
get_next_pages_transforms_rule, get_server_actions_transform_rule,
next_amp_attributes::get_next_amp_attr_rule,
debug_fn_name::get_debug_fn_name_rule, get_next_dynamic_transform_rule,
get_next_font_transform_rule, get_next_image_rule, get_next_lint_transform_rule,
get_next_modularize_imports_rule, get_next_pages_transforms_rule,
get_server_actions_transform_rule, next_amp_attributes::get_next_amp_attr_rule,
next_cjs_optimizer::get_next_cjs_optimizer_rule,
next_disallow_re_export_all_in_page::get_next_disallow_export_all_in_page_rule,
next_page_config::get_next_page_config_rule,
......@@ -43,6 +43,10 @@ pub async fn get_next_client_transforms_rules(
rules.push(get_next_font_transform_rule(enable_mdx_rs));
if mode.await?.is_development() {
rules.push(get_debug_fn_name_rule(enable_mdx_rs));
}
let mut is_app_dir = false;
match context_ty {
......
use anyhow::Result;
use async_trait::async_trait;
use next_custom_transforms::transforms::debug_fn_name::debug_fn_name;
use swc_core::ecma::{ast::Program, visit::VisitMutWith};
use turbo_tasks::Vc;
use turbopack::module_options::{ModuleRule, ModuleRuleEffect};
use turbopack_ecmascript::{CustomTransformer, EcmascriptInputTransform, TransformContext};
use super::module_rule_match_js_no_url;
pub fn get_debug_fn_name_rule(enable_mdx_rs: bool) -> ModuleRule {
let debug_fn_name_transform =
EcmascriptInputTransform::Plugin(Vc::cell(Box::new(DebugFnNameTransformer {}) as _));
ModuleRule::new(
module_rule_match_js_no_url(enable_mdx_rs),
vec![ModuleRuleEffect::ExtendEcmascriptTransforms {
prepend: Vc::cell(vec![]),
append: Vc::cell(vec![debug_fn_name_transform]),
}],
)
}
#[derive(Debug)]
struct DebugFnNameTransformer {}
#[async_trait]
impl CustomTransformer for DebugFnNameTransformer {
#[tracing::instrument(level = tracing::Level::TRACE, name = "debug_fn_name", skip_all)]
async fn transform(&self, program: &mut Program, _ctx: &TransformContext<'_>) -> Result<()> {
program.visit_mut_with(&mut debug_fn_name());
Ok(())
}
}
pub(crate) mod debug_fn_name;
pub(crate) mod emotion;
pub(crate) mod modularize_imports;
pub(crate) mod next_amp_attributes;
......
......@@ -219,6 +219,7 @@ function getBaseSWCOptions({
// On server side of pages router we prefer CJS.
preferEsm: esm,
lintCodemodComments: true,
debugFunctionName: development,
}
}
......
......@@ -141,7 +141,7 @@ describe.each(['default', 'turbo'])('Error recovery app %s', () => {
await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
"index.js (7:11) @ eval
"index.js (7:11) @ Index.useCallback[increment]
5 | const increment = useCallback(() => {
6 | setCount(c => c + 1)
......
......@@ -107,7 +107,7 @@ describe.each(['default', 'turbo'])('ReactRefreshLogBox %s', () => {
await session.assertHasRedbox()
if (isTurbopack) {
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
"index.js (7:11) @ <unknown>
"index.js (7:11) @ Index.useCallback[increment]
5 | const increment = useCallback(() => {
6 | setCount(c => c + 1)
......@@ -119,7 +119,7 @@ describe.each(['default', 'turbo'])('ReactRefreshLogBox %s', () => {
`)
} else {
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
"index.js (7:11) @ eval
"index.js (7:11) @ Index.useCallback[increment]
5 | const increment = useCallback(() => {
6 | setCount(c => c + 1)
......
......@@ -127,7 +127,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -222,7 +222,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -312,7 +312,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -388,7 +388,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -474,7 +474,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -561,7 +561,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} onError={function}>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......
'use client'
import { useCallback } from 'react'
const Button = ({ message }: { message: string }) => {
const handleClick = useCallback(() => {
throw new Error(message)
}, [message])
return (
<button type="button" onClick={handleClick}>
Click me
</button>
)
}
export default function Page() {
return <Button message="Kaputt!" />
}
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
'use client'
import { useEffect } from 'react'
export default function Page() {
useEffect(() => {
throw new Error('error in useEffect')
}, [])
return <p>Hello world!</p>
}
import { nextTestSetup } from 'e2e-utils'
import {
assertHasRedbox,
getRedboxSource,
waitForAndOpenRuntimeError,
} from 'next-test-utils'
describe('hook-function-names', () => {
const { next, isTurbopack } = nextTestSetup({
files: __dirname,
})
it('should show readable hook names in stacks', async () => {
const browser = await next.browser('/button')
await browser.elementByCss('button').click()
await waitForAndOpenRuntimeError(browser)
if (isTurbopack) {
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
"app/button/page.tsx (7:11) @ Button.useCallback[handleClick]
5 | const Button = ({ message }: { message: string }) => {
6 | const handleClick = useCallback(() => {
> 7 | throw new Error(message)
| ^
8 | }, [message])
9 |
10 | return ("
`)
} else {
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
"app/button/page.tsx (7:11) @ Button.useCallback[handleClick]
5 | const Button = ({ message }: { message: string }) => {
6 | const handleClick = useCallback(() => {
> 7 | throw new Error(message)
| ^
8 | }, [message])
9 |
10 | return ("
`)
}
})
it('should show readable hook names in stacks for default-exported components', async () => {
const browser = await next.browser('/')
await assertHasRedbox(browser)
if (isTurbopack) {
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
"app/page.tsx (7:11) @ Page.useEffect
5 | export default function Page() {
6 | useEffect(() => {
> 7 | throw new Error('error in useEffect')
| ^
8 | }, [])
9 |
10 | return <p>Hello world!</p>"
`)
} else {
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
"app/page.tsx (7:11) @ Page.useEffect
5 | export default function Page() {
6 | useEffect(() => {
> 7 | throw new Error('error in useEffect')
| ^
8 | }, [])
9 |
10 | return <p>Hello world!</p>"
`)
}
})
})
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}
module.exports = nextConfig
......@@ -38,7 +38,7 @@ const appDir = join(__dirname, '../')
// TODO: add win32 snapshot
} else {
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
"pages/index.js (5:11) @ eval
"pages/index.js (5:11) @ Index.useEffect
3 | export default function Index(props) {
4 | useEffect(() => {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment