Skip to content

Commit fc79403

Browse files
ztannerztanner
committed
[DevOverlay]: enable by default
1 parent 026f00e commit fc79403

File tree

17 files changed

+82
-40
lines changed

17 files changed

+82
-40
lines changed

‎.github/workflows/build_and_test.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ jobs:
581581
uses: ./.github/workflows/build_reusable.yml
582582
with:
583583
nodeVersion: 18.18.2
584-
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=true NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" node run-tests.js --timings -c ${TEST_CONCURRENCY} --type integration
584+
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=false NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" node run-tests.js --timings -c ${TEST_CONCURRENCY} --type integration
585585
stepName: 'test-ppr-integration'
586586
secrets: inherit
587587

@@ -596,7 +596,7 @@ jobs:
596596
group: [1/6, 2/6, 3/6, 4/6, 5/6, 6/6]
597597
uses: ./.github/workflows/build_reusable.yml
598598
with:
599-
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=true NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" NEXT_TEST_MODE=dev node run-tests.js --timings -g ${{ matrix.group }} -c ${TEST_CONCURRENCY} --type development
599+
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=false NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" NEXT_TEST_MODE=dev node run-tests.js --timings -g ${{ matrix.group }} -c ${TEST_CONCURRENCY} --type development
600600
stepName: 'test-ppr-dev-${{ matrix.group }}'
601601
secrets: inherit
602602

@@ -611,7 +611,7 @@ jobs:
611611
group: [1/7, 2/7, 3/7, 4/7, 5/7, 6/7, 7/7]
612612
uses: ./.github/workflows/build_reusable.yml
613613
with:
614-
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=true NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" NEXT_TEST_MODE=start node run-tests.js --timings -g ${{ matrix.group }} -c ${TEST_CONCURRENCY} --type production
614+
afterBuild: __NEXT_EXPERIMENTAL_PPR=true __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY=false NEXT_EXTERNAL_TESTS_FILTERS="test/ppr-tests-manifest.json" NEXT_TEST_MODE=start node run-tests.js --timings -g ${{ matrix.group }} -c ${TEST_CONCURRENCY} --type production
615615
stepName: 'test-ppr-prod-${{ matrix.group }}'
616616
secrets: inherit
617617

‎packages/next/src/server/config-shared.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1253,7 +1253,7 @@ export const defaultConfig: NextConfig = {
12531253
staticGenerationMinPagesPerWorker: 25,
12541254
dynamicIO: false,
12551255
inlineCss: false,
1256-
newDevOverlay: false,
1256+
newDevOverlay: true,
12571257
streamingMetadata: false,
12581258
htmlLimitedBots: undefined,
12591259
useCache: undefined,

‎packages/next/src/server/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -923,8 +923,8 @@ function assignDefaults(
923923
// TODO(jiwon): remove once we've made new UI default
924924
// Enable reactOwnerStack when newDevOverlay is enabled to have
925925
// better call stack output in the new UI.
926-
if (process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true') {
927-
result.experimental.newDevOverlay = true
926+
if (process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'false') {
927+
result.experimental.newDevOverlay = false
928928
}
929929
if (result.experimental.newDevOverlay) {
930930
result.experimental.reactOwnerStack = true

‎run-tests.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,17 @@ const ENDGROUP = process.env.CI ? '##[endgroup]' : ''
5050

5151
const externalTestsFilter = getTestFilter()
5252

53+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
54+
if (!process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY) {
55+
console.log('Setting __NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY to true')
56+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY = 'true'
57+
} else {
58+
console.log(
59+
'__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY is already set to',
60+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY
61+
)
62+
}
63+
5364
const timings = []
5465
const DEFAULT_NUM_RETRIES = 2
5566
const DEFAULT_CONCURRENCY = 2

‎test/development/acceptance-app/version-staleness.test.ts

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ function getStaleness(browser: BrowserInterface) {
1111
.text()
1212
}
1313

14+
const isNewDevOverlay =
15+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
16+
1417
describe('Error Overlay version staleness', () => {
1518
const { next } = nextTestSetup({
1619
files: new FileRef(path.join(__dirname, 'fixtures', 'default-template')),
@@ -47,14 +50,29 @@ describe('Error Overlay version staleness', () => {
4750

4851
await session.openRedbox()
4952

50-
if (process.env.TURBOPACK) {
51-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
52-
`"Next.js (1.0.0) is outdated (learn more) (Turbopack)"`
53-
)
53+
if (isNewDevOverlay) {
54+
if (process.env.TURBOPACK) {
55+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
56+
"Next.js 1.0.0 (outdated)
57+
(learn more)
58+
Turbopack"
59+
`)
60+
} else {
61+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
62+
"Next.js 1.0.0 (outdated)
63+
(learn more)"
64+
`)
65+
}
5466
} else {
55-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
56-
`"Next.js (1.0.0) is outdated (learn more)"`
57-
)
67+
if (process.env.TURBOPACK) {
68+
expect(await getStaleness(browser)).toMatchInlineSnapshot(
69+
`"Next.js (1.0.0) is outdated (learn more) (Turbopack)"`
70+
)
71+
} else {
72+
expect(await getStaleness(browser)).toMatchInlineSnapshot(
73+
`"Next.js (1.0.0) is outdated (learn more)"`
74+
)
75+
}
5876
}
5977
})
6078

@@ -83,13 +101,16 @@ describe('Error Overlay version staleness', () => {
83101
)
84102

85103
if (process.env.TURBOPACK) {
86-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
87-
`"Next.js (2.0.0) is outdated (learn more) (Turbopack)"`
88-
)
104+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
105+
"Next.js 2.0.0 (outdated)
106+
(learn more)
107+
Turbopack"
108+
`)
89109
} else {
90-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
91-
`"Next.js (2.0.0) is outdated (learn more)"`
92-
)
110+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
111+
"Next.js 2.0.0 (outdated)
112+
(learn more)"
113+
`)
93114
}
94115
})
95116

@@ -115,13 +136,16 @@ describe('Error Overlay version staleness', () => {
115136
)
116137

117138
if (process.env.TURBOPACK) {
118-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
119-
`"Next.js (3.0.0) is outdated (learn more) (Turbopack)"`
120-
)
139+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
140+
"Next.js 3.0.0 (outdated)
141+
(learn more)
142+
Turbopack"
143+
`)
121144
} else {
122-
expect(await getStaleness(browser)).toMatchInlineSnapshot(
123-
`"Next.js (3.0.0) is outdated (learn more)"`
124-
)
145+
expect(await getStaleness(browser)).toMatchInlineSnapshot(`
146+
"Next.js 3.0.0 (outdated)
147+
(learn more)"
148+
`)
125149
}
126150
})
127151
})

‎test/development/app-dir/owner-stack-invalid-element-type/invalid-element-type.test.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ import {
88
} from 'next-test-utils'
99

1010
// TODO: When owner stack is enabled by default, remove the condition and only keep one test
11-
const isOwnerStackEnabled = process.env.__NEXT_EXPERIMENTAL_PPR === 'true'
11+
const isOwnerStackEnabled =
12+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
1213

1314
;(isOwnerStackEnabled ? describe.skip : describe)(
1415
'app-dir - invalid-element-type',

‎test/development/app-dir/owner-stack-invalid-element-type/owner-stack-invalid-element-type.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
// TODO: When owner stack is enabled by default, remove the condition and only keep one test
99
const isOwnerStackEnabled =
1010
process.env.TEST_OWNER_STACK !== 'false' ||
11-
process.env.__NEXT_EXPERIMENTAL_PPR === 'true'
11+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
1212

1313
;(isOwnerStackEnabled ? describe : describe.skip)(
1414
'app-dir - owner-stack-invalid-element-type',

‎test/development/app-dir/owner-stack-react-missing-key-prop/owner-stack-react-missing-key-prop.test.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import {
66
} from 'next-test-utils'
77

88
// TODO: When owner stack is enabled by default, remove the condition and only keep one test
9-
const isOwnerStackEnabled = process.env.__NEXT_EXPERIMENTAL_PPR === 'true'
9+
const isOwnerStackEnabled =
10+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
1011

1112
;(isOwnerStackEnabled ? describe : describe.skip)(
1213
'app-dir - owner-stack-react-missing-key-prop',

‎test/development/app-dir/owner-stack-react-missing-key-prop/react-missing-key-prop.test.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import {
66
} from 'next-test-utils'
77

88
// TODO: When owner stack is enabled by default, remove the condition and only keep one test
9-
const isOwnerStackEnabled = process.env.__NEXT_EXPERIMENTAL_PPR === 'true'
9+
const isOwnerStackEnabled =
10+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
1011

1112
async function getStackFramesContent(browser) {
1213
await hasRedboxCallStack(browser)

‎test/development/app-dir/owner-stack/owner-stack.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ describe('app-dir - owner-stack', () => {
7171
return log.message.includes('Error: browser error')
7272
}).message
7373

74-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
74+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
7575
if (isNewDevOverlay) {
7676
if (process.env.TURBOPACK) {
7777
expect(normalizeStackTrace(errorLog)).toMatchInlineSnapshot(`

‎test/development/app-dir/server-component-next-dynamic-ssr-false/server-component-next-dynamic-ssr-false.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {
55
getRedboxSource,
66
} from 'next-test-utils'
77

8-
// Enabling PPR testing also enables the new dev overlay.
8+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
99
const isNewDevOverlay =
1010
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
1111

@@ -24,7 +24,7 @@ describe('app-dir - server-component-next-dynamic-ssr-false', () => {
2424

2525
expect(redbox.description).toBe('Failed to compile')
2626

27-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
27+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
2828
if (isNewDevOverlay) {
2929
if (process.env.TURBOPACK) {
3030
expect(redbox.source).toMatchInlineSnapshot(`

‎test/development/app-dir/ssr-in-rsc/ssr-in-rsc.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ describe('react-dom/server in React Server environment', () => {
394394
}
395395
`)
396396
} else {
397-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
397+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
398398
if (isNewDevOverlay) {
399399
expect(redbox).toMatchInlineSnapshot(`
400400
{

‎test/e2e/app-dir/dynamic-io/dynamic-io.server-action.test.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,12 @@ describe('dynamic-io', () => {
2525
expect(await browser.elementByCss('p').text()).toBe('result')
2626
})
2727

28-
if (process.env.__NEXT_EXPERIMENTAL_PPR && isNextDev) {
29-
// TODO(react-time-info): Remove this branch for PPR in dev mode when the
28+
if (
29+
(process.env.__NEXT_EXPERIMENTAL_PPR ||
30+
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY) &&
31+
isNextDev
32+
) {
33+
// TODO(react-time-info): Remove this branch for experimental React in dev mode when the
3034
// issue is resolved where the inclusion of server timings in the RSC
3135
// payload makes the serialized bound args not suitable to be used as a
3236
// cache key.

‎test/e2e/app-dir/error-on-next-codemod-comment/error-on-next-codemod-comment.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ describe('app-dir - error-on-next-codemod-comment', () => {
2626

2727
await assertHasRedbox(browser)
2828

29-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
29+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
3030
if (isNewDevOverlay) {
3131
if (process.env.TURBOPACK) {
3232
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`

‎test/e2e/app-dir/use-cache-unknown-cache-kind/use-cache-unknown-cache-kind.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ describe('use-cache-unknown-cache-kind', () => {
9090

9191
expect(errorDescription).toBe('Failed to compile')
9292

93-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
93+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
9494
if (isNewDevOverlay) {
9595
if (isTurbopack) {
9696
expect(errorSource).toMatchInlineSnapshot(`

‎test/e2e/app-dir/use-cache-without-experimental-flag/use-cache-without-experimental-flag.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ describe('use-cache-without-experimental-flag', () => {
8989

9090
expect(errorDescription).toBe('Failed to compile')
9191

92-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
92+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
9393
if (isNewDevOverlay) {
9494
if (isTurbopack) {
9595
expect(errorSource).toMatchInlineSnapshot(`

‎test/lib/next-test-utils.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export { shouldRunTurboDevTest }
3636
export const nextServer = server
3737
export const pkg = _pkg
3838

39-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
39+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
4040
const isNewDevOverlay =
4141
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
4242

@@ -1020,7 +1020,7 @@ export function getRedboxNavText(browser: BrowserInterface): Promise<string> {
10201020
}
10211021

10221022
export async function getRedboxTotalErrorCount(browser: BrowserInterface) {
1023-
// TODO(jiwon): Remove this once we have a new dev overlay at stable.
1023+
// TODO(new-dev-overlay): Remove this once we have a new dev overlay at stable.
10241024
if (isNewDevOverlay) {
10251025
// N/M\nNext.js X.Y.Z -> M
10261026
const text = (await getRedboxNavText(browser)) || ''

0 commit comments

Comments
 (0)