Unverified Commit fc5bea4c authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

[dev-overlay] always display bundler name on version info (#77739)

### Why?

Previously, we indicated the bundler name only for Turbopack. To better
indicate the user which bundler the app is running (especially when
sharing errors via screenshot), always display bundler name on version
info.

| Webpack | Rspack |
|--------|--------|
| ![CleanShot 2025-04-02 at 19 04
34@2x](https://github.com/user-attachments/assets/621a1057-f05f-4dc4-98d9-beaa7dc2eba1)
| ![CleanShot 2025-04-02 at 19 04
04@2x](https://github.com/user-attachments/assets/1529a189-65c9-4c02-9c71-8a4f95b2ef05)
|

Closes NDX-986

---------
Co-authored-by: 's avatarJiachi Liu <inbox@huozhi.im>
parent 5c499049
...@@ -133,6 +133,11 @@ export function getDefineEnv({ ...@@ -133,6 +133,11 @@ export function getDefineEnv({
}), }),
'process.turbopack': isTurbopack, 'process.turbopack': isTurbopack,
'process.env.TURBOPACK': isTurbopack, 'process.env.TURBOPACK': isTurbopack,
'process.env.__NEXT_BUNDLER': isTurbopack
? 'Turbopack'
: process.env.NEXT_RSPACK
? 'Rspack'
: 'Webpack',
// TODO: enforce `NODE_ENV` on `process.env`, and add a test: // TODO: enforce `NODE_ENV` on `process.env`, and add a test:
'process.env.NODE_ENV': 'process.env.NODE_ENV':
dev || config.experimental.allowDevelopmentBuild dev || config.experimental.allowDevelopmentBuild
......
...@@ -17,8 +17,12 @@ export function ErrorOverlayNav({ ...@@ -17,8 +17,12 @@ export function ErrorOverlayNav({
activeIdx, activeIdx,
setActiveIndex, setActiveIndex,
versionInfo, versionInfo,
isTurbopack,
}: ErrorOverlayNavProps) { }: ErrorOverlayNavProps) {
const bundlerName = (process.env.__NEXT_BUNDLER || 'Webpack') as
| 'Webpack'
| 'Turbopack'
| 'Rspack'
return ( return (
<div data-nextjs-error-overlay-nav> <div data-nextjs-error-overlay-nav>
<Notch side="left"> <Notch side="left">
...@@ -33,7 +37,7 @@ export function ErrorOverlayNav({ ...@@ -33,7 +37,7 @@ export function ErrorOverlayNav({
<Notch side="right"> <Notch side="right">
<VersionStalenessInfo <VersionStalenessInfo
versionInfo={versionInfo} versionInfo={versionInfo}
isTurbopack={isTurbopack} bundlerName={bundlerName}
/> />
</Notch> </Notch>
)} )}
......
...@@ -88,6 +88,15 @@ export const Turbopack: Story = { ...@@ -88,6 +88,15 @@ export const Turbopack: Story = {
versionInfo: { versionInfo: {
...mockVersionInfo.fresh, ...mockVersionInfo.fresh,
}, },
isTurbopack: true, bundlerName: 'Turbopack',
},
}
export const Rspack: Story = {
args: {
versionInfo: {
...mockVersionInfo.fresh,
},
bundlerName: 'Rspack',
}, },
} }
...@@ -3,23 +3,21 @@ import { cx } from '../../utils/cx' ...@@ -3,23 +3,21 @@ import { cx } from '../../utils/cx'
export function VersionStalenessInfo({ export function VersionStalenessInfo({
versionInfo, versionInfo,
isTurbopack, bundlerName,
}: { }: {
versionInfo: VersionInfo versionInfo: VersionInfo
isTurbopack?: boolean // Passed from parent for easier handling in Storybook.
bundlerName: 'Webpack' | 'Turbopack' | 'Rspack'
}) { }) {
const { staleness } = versionInfo const { staleness } = versionInfo
let { text, indicatorClass, title } = getStaleness(versionInfo) let { text, indicatorClass, title } = getStaleness(versionInfo)
const isTurbopack = bundlerName === 'Turbopack'
const shouldBeLink = staleness.startsWith('stale') const shouldBeLink = staleness.startsWith('stale')
if (shouldBeLink) { if (shouldBeLink) {
return ( return (
<a <a
className={cx( className="nextjs-container-build-error-version-status dialog-exclude-closing-from-outside-click"
'nextjs-container-build-error-version-status',
'dialog-exclude-closing-from-outside-click',
isTurbopack && 'turbopack-border'
)}
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
href="https://nextjs.org/docs/messages/version-staleness" href="https://nextjs.org/docs/messages/version-staleness"
...@@ -30,7 +28,9 @@ export function VersionStalenessInfo({ ...@@ -30,7 +28,9 @@ export function VersionStalenessInfo({
<span data-nextjs-version-checker title={title}> <span data-nextjs-version-checker title={title}>
{text} {text}
</span> </span>
{isTurbopack && <span className="turbopack-text">Turbopack</span>} <span className={cx(isTurbopack && 'turbopack-text')}>
{bundlerName}
</span>
</a> </a>
) )
} }
...@@ -41,7 +41,7 @@ export function VersionStalenessInfo({ ...@@ -41,7 +41,7 @@ export function VersionStalenessInfo({
<span data-nextjs-version-checker title={title}> <span data-nextjs-version-checker title={title}>
{text} {text}
</span> </span>
{isTurbopack && <span className="turbopack-text">Turbopack</span>} <span className={cx(isTurbopack && 'turbopack-text')}>{bundlerName}</span>
</span> </span>
) )
} }
......
...@@ -52,10 +52,16 @@ describe('Error Overlay version staleness', () => { ...@@ -52,10 +52,16 @@ describe('Error Overlay version staleness', () => {
"Next.js 1.0.0 (outdated) "Next.js 1.0.0 (outdated)
Turbopack" Turbopack"
`) `)
} else if (process.env.NEXT_RSPACK) {
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
"Next.js 1.0.0 (outdated)
Rspack"
`)
} else { } else {
expect(await getStaleness(browser)).toMatchInlineSnapshot( expect(await getStaleness(browser)).toMatchInlineSnapshot(`
`"Next.js 1.0.0 (outdated)"` "Next.js 1.0.0 (outdated)
) Webpack"
`)
} }
}) })
...@@ -85,13 +91,19 @@ describe('Error Overlay version staleness', () => { ...@@ -85,13 +91,19 @@ describe('Error Overlay version staleness', () => {
if (process.env.TURBOPACK) { if (process.env.TURBOPACK) {
expect(await getStaleness(browser)).toMatchInlineSnapshot(` expect(await getStaleness(browser)).toMatchInlineSnapshot(`
"Next.js 2.0.0 (outdated) "Next.js 2.0.0 (outdated)
Turbopack" Turbopack"
`) `)
} else if (process.env.NEXT_RSPACK) {
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
"Next.js 2.0.0 (outdated)
Rspack"
`)
} else { } else {
expect(await getStaleness(browser)).toMatchInlineSnapshot( expect(await getStaleness(browser)).toMatchInlineSnapshot(`
`"Next.js 2.0.0 (outdated)"` "Next.js 2.0.0 (outdated)
) Webpack"
`)
} }
}) })
...@@ -118,13 +130,19 @@ describe('Error Overlay version staleness', () => { ...@@ -118,13 +130,19 @@ describe('Error Overlay version staleness', () => {
if (process.env.TURBOPACK) { if (process.env.TURBOPACK) {
expect(await getStaleness(browser)).toMatchInlineSnapshot(` expect(await getStaleness(browser)).toMatchInlineSnapshot(`
"Next.js 3.0.0 (outdated) "Next.js 3.0.0 (outdated)
Turbopack" Turbopack"
`) `)
} else if (process.env.NEXT_RSPACK) {
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
"Next.js 3.0.0 (outdated)
Rspack"
`)
} else { } else {
expect(await getStaleness(browser)).toMatchInlineSnapshot( expect(await getStaleness(browser)).toMatchInlineSnapshot(`
`"Next.js 3.0.0 (outdated)"` "Next.js 3.0.0 (outdated)
) Webpack"
`)
} }
}) })
}) })
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