File size: 9,424 Bytes
1e92f2d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
import { createSandbox } from 'development-sandbox'
import { FileRef, nextTestSetup } from 'e2e-utils'
import { outdent } from 'outdent'
import path from 'path'

const isRspack = process.env.NEXT_RSPACK !== undefined

describe('ReactRefreshLogBox _app _document', () => {
  const { isTurbopack, next } = nextTestSetup({
    files: new FileRef(path.join(__dirname, 'fixtures', 'default-template')),
    skipStart: true,
  })

  test('empty _app shows logbox', async () => {
    await using sandbox = await createSandbox(
      next,
      new Map([['pages/_app.js', ``]])
    )
    const { browser, session } = sandbox
    await expect(browser).toDisplayRedbox(`
     {
       "description": "The default export is not a React Component in page: "/_app"",
       "environmentLabel": null,
       "label": "Runtime Error",
       "source": null,
       "stack": [],
     }
    `)

    await session.patch(
      'pages/_app.js',
      outdent`
        function MyApp({ Component, pageProps }) {
          return <Component {...pageProps} />;
        }
        export default MyApp
      `
    )
    await session.assertNoRedbox()
  })

  test('empty _document shows logbox', async () => {
    await using sandbox = await createSandbox(
      next,
      new Map([['pages/_document.js', ``]])
    )
    const { browser, session } = sandbox

    await expect(browser).toDisplayRedbox(`
     {
       "description": "The default export is not a React Component in page: "/_document"",
       "environmentLabel": null,
       "label": "Runtime Error",
       "source": null,
       "stack": [],
     }
    `)

    await session.patch(
      'pages/_document.js',
      outdent`
        import Document, { Html, Head, Main, NextScript } from 'next/document'

        class MyDocument extends Document {
          static async getInitialProps(ctx) {
            const initialProps = await Document.getInitialProps(ctx)
            return { ...initialProps }
          }

          render() {
            return (
              <Html>
                <Head />
                <body>
                  <Main />
                  <NextScript />
                </body>
              </Html>
            )
          }
        }

        export default MyDocument
      `
    )
    await session.assertNoRedbox()
  })

  test('_app syntax error shows logbox', async () => {
    await using sandbox = await createSandbox(
      next,
      new Map([
        [
          'pages/_app.js',
          outdent`
            function MyApp({ Component, pageProps }) {
              return <<Component {...pageProps} />;
            }
            export default MyApp
          `,
        ],
      ])
    )
    const { browser, session } = sandbox

    if (isTurbopack) {
      await expect(browser).toDisplayRedbox(`
       {
         "description": "Parsing ecmascript source code failed",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_app.js (2:10)
       Parsing ecmascript source code failed
       > 2 |   return <<Component {...pageProps} />;
           |          ^^",
         "stack": [],
       }
      `)
    } else if (isRspack) {
      await expect({ browser, next }).toDisplayRedbox(`
       {
         "description": "  Γ— Module build failed:",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_app.js
         Γ— Module build failed:
         ╰─▢   Γ— Error:   x Expression expected
               β”‚    ,-[2:1]
               β”‚  1 | function MyApp({ Component, pageProps }) {
               β”‚  2 |   return <<Component {...pageProps} />;
               β”‚    :           ^
               β”‚  3 | }
               β”‚  4 | export default MyApp
               β”‚    \`----
               β”‚   x Expression expected
               β”‚    ,-[2:1]
               β”‚  1 | function MyApp({ Component, pageProps }) {
               β”‚  2 |   return <<Component {...pageProps} />;
               β”‚    :            ^^^^^^^^^
               β”‚  3 | }
               β”‚  4 | export default MyApp
               β”‚    \`----
               β”‚
               β”‚
               β”‚ Caused by:
               β”‚     Syntax Error",
         "stack": [],
       }
      `)
    } else {
      await expect(browser).toDisplayRedbox(`
       {
         "description": "  x Expression expected",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_app.js
       Error:   x Expression expected
          ,-[2:1]
        1 | function MyApp({ Component, pageProps }) {
        2 |   return <<Component {...pageProps} />;
          :          ^^
        3 | }
        4 | export default MyApp
          \`----
         x Expected ';', got '{'
          ,-[2:1]
        1 | function MyApp({ Component, pageProps }) {
        2 |   return <<Component {...pageProps} />;
          :                      ^
        3 | }
        4 | export default MyApp
          \`----
       Caused by:
           Syntax Error",
         "stack": [],
       }
      `)
    }

    await session.patch(
      'pages/_app.js',
      outdent`
        function MyApp({ Component, pageProps }) {
          return <Component {...pageProps} />;
        }
        export default MyApp
      `
    )
    await session.assertNoRedbox()
  })

  test('_document syntax error shows logbox', async () => {
    await using sandbox = await createSandbox(
      next,
      new Map([
        [
          'pages/_document.js',
          outdent`
            import Document, { Html, Head, Main, NextScript } from 'next/document'

            class MyDocument extends Document {{
              static async getInitialProps(ctx) {
                const initialProps = await Document.getInitialProps(ctx)
                return { ...initialProps }
              }

              render() {
                return (
                  <Html>
                    <Head />
                    <body>
                      <Main />
                      <NextScript />
                    </body>
                  </Html>
                )
              }
            }

            export default MyDocument
          `,
        ],
      ])
    )
    const { browser, session } = sandbox
    if (isTurbopack) {
      await expect(browser).toDisplayRedbox(`
       {
         "description": "Parsing ecmascript source code failed",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_document.js (3:36)
       Parsing ecmascript source code failed
       > 3 | class MyDocument extends Document {{
           |                                    ^",
         "stack": [],
       }
      `)
    } else if (isRspack) {
      await expect({ browser, next }).toDisplayRedbox(`
       {
         "description": "  Γ— Module build failed:",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_document.js
         Γ— Module build failed:
         ╰─▢   Γ— Error:   x Unexpected token \`{\`. Expected identifier, string literal, numeric literal or [ for the computed key
               β”‚    ,-[3:1]
               β”‚  1 | import Document, { Html, Head, Main, NextScript } from 'next/document'
               β”‚  2 |
               β”‚  3 | class MyDocument extends Document {{
               β”‚    :                                    ^
               β”‚  4 |   static async getInitialProps(ctx) {
               β”‚  5 |     const initialProps = await Document.getInitialProps(ctx)
               β”‚  6 |     return { ...initialProps }
               β”‚    \`----
               β”‚
               β”‚
               β”‚ Caused by:
               β”‚     Syntax Error",
         "stack": [],
       }
      `)
    } else {
      await expect(browser).toDisplayRedbox(`
       {
         "description": "  x Unexpected token \`{\`. Expected identifier, string literal, numeric literal or [ for the computed key",
         "environmentLabel": null,
         "label": "Build Error",
         "source": "./pages/_document.js
       Error:   x Unexpected token \`{\`. Expected identifier, string literal, numeric literal or [ for the computed key
          ,-[3:1]
        1 | import Document, { Html, Head, Main, NextScript } from 'next/document'
        2 |
        3 | class MyDocument extends Document {{
          :                                    ^
        4 |   static async getInitialProps(ctx) {
        5 |     const initialProps = await Document.getInitialProps(ctx)
        6 |     return { ...initialProps }
          \`----
       Caused by:
           Syntax Error",
         "stack": [],
       }
      `)
    }

    await session.patch(
      'pages/_document.js',
      outdent`
        import Document, { Html, Head, Main, NextScript } from 'next/document'

        class MyDocument extends Document {
          static async getInitialProps(ctx) {
            const initialProps = await Document.getInitialProps(ctx)
            return { ...initialProps }
          }

          render() {
            return (
              <Html>
                <Head />
                <body>
                  <Main />
                  <NextScript />
                </body>
              </Html>
            )
          }
        }

        export default MyDocument
      `
    )
    await session.assertNoRedbox()
  })
})