/
index.test.js
616 lines (547 loc) · 16.4 KB
/
index.test.js
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/* eslint-env jest */
import fs from 'fs-extra'
import { join } from 'path'
import { launchApp, findPort, nextBuild } from 'next-test-utils'
let appDir = join(__dirname, '..')
const nextConfigPath = join(appDir, 'next.config.js')
const writeConfig = async (routes, type = 'redirects') => {
await fs.writeFile(
nextConfigPath,
`
module.exports = {
async ${type}() {
return ${JSON.stringify(routes)}
}
}
`
)
}
let getStderr
const runTests = () => {
it('should error when empty headers array is present on header item', async () => {
await writeConfig(
[
{
source: `/:path*`,
headers: [],
},
],
'headers'
)
const stderr = await getStderr()
expect(stderr).toContain(
'`headers` field cannot be empty for route {"source":"/:path*"'
)
})
it('should error when source and destination length is exceeded', async () => {
await writeConfig(
[
{
source: `/${Array(4096).join('a')}`,
destination: `/another`,
permanent: false,
},
{
source: `/`,
destination: `/${Array(4096).join('a')}`,
permanent: false,
},
],
'redirects'
)
const stderr = await getStderr()
expect(stderr).toContain(
'`source` exceeds max built length of 4096 for route {"source":"/aaaaaaaaaaaaaaaaaa'
)
expect(stderr).toContain(
'`destination` exceeds max built length of 4096 for route {"source":"/","destination":"/aaaa'
)
})
it('should error during next build for invalid redirects', async () => {
await writeConfig(
[
{
// missing destination
source: '/hello',
permanent: false,
},
{
// invalid source
source: 123,
destination: '/another',
permanent: false,
},
{
// invalid statusCode type
source: '/hello',
destination: '/another',
statusCode: '301',
},
{
// invalid statusCode
source: '/hello',
destination: '/another',
statusCode: 404,
},
{
// invalid permanent value
source: '/hello',
destination: '/another',
permanent: 'yes',
},
{
// unnamed in destination
source: '/hello/world/(.*)',
destination: '/:0',
permanent: true,
},
// invalid objects
null,
'string',
// invalid has items
{
source: '/hello',
destination: '/another',
has: [
{
type: 'cookiee',
key: 'loggedIn',
},
],
permanent: false,
},
{
source: '/hello',
destination: '/another',
permanent: false,
has: [
{
type: 'headerr',
},
{
type: 'queryr',
key: 'hello',
},
],
},
],
'redirects'
)
const stderr = await getStderr()
expect(stderr).toContain(
`\`destination\` is missing for route {"source":"/hello","permanent":false}`
)
expect(stderr).toContain(
`\`source\` is not a string for route {"source":123,"destination":"/another","permanent":false}`
)
expect(stderr).toContain(
`\`statusCode\` is not undefined or valid statusCode for route {"source":"/hello","destination":"/another","statusCode":"301"}`
)
expect(stderr).toContain(
`\`statusCode\` is not undefined or valid statusCode for route {"source":"/hello","destination":"/another","statusCode":404}`
)
expect(stderr).toContain(
`\`permanent\` is not set to \`true\` or \`false\` for route {"source":"/hello","destination":"/another","permanent":"yes"}`
)
expect(stderr).toContain(
`\`destination\` has unnamed params :0 for route {"source":"/hello/world/(.*)","destination":"/:0","permanent":true}`
)
expect(stderr).toContain(
`The route null is not a valid object with \`source\` and \`destination\``
)
expect(stderr).toContain(
`The route "string" is not a valid object with \`source\` and \`destination\``
)
expect(stderr).toContain('Invalid `has` item:')
expect(stderr).toContain(
`invalid type "cookiee" for {"type":"cookiee","key":"loggedIn"}`
)
expect(stderr).toContain(
`invalid \`has\` item found for route {"source":"/hello","destination":"/another","has":[{"type":"cookiee","key":"loggedIn"}],"permanent":false}`
)
expect(stderr).toContain('Invalid `has` items:')
expect(stderr).toContain(
`invalid type "headerr", invalid key "undefined" for {"type":"headerr"}`
)
expect(stderr).toContain(
`invalid type "queryr" for {"type":"queryr","key":"hello"}`
)
expect(stderr).toContain(
`invalid \`has\` items found for route {"source":"/hello","destination":"/another","permanent":false,"has":[{"type":"headerr"},{"type":"queryr","key":"hello"}]}`
)
expect(stderr).toContain(`Valid \`has\` object shape is {`)
expect(stderr).toContain('Invalid redirects found')
})
it('should error during next build for invalid rewrites', async () => {
await writeConfig(
[
{
// missing destination
source: '/hello',
},
{
// invalid source
source: 123,
destination: '/another',
},
{
// extra field
source: '/hello',
destination: '/another',
headers: 'not-allowed',
},
{
// missing forward slash in source
source: 'hello',
destination: '/another',
},
{
// missing forward slash in destination
source: '/hello',
destination: 'another',
},
{
source: '/feedback/(?!general)',
destination: '/feedback/general',
},
{
// unnamed in destination
source: '/hello/world/(.*)',
destination: '/:0',
},
{
// basePath with relative destination
source: '/hello',
destination: '/world',
basePath: false,
},
// invalid objects
null,
'string',
// invalid has items
{
source: '/hello',
destination: '/another',
has: [
{
type: 'cookiee',
key: 'loggedIn',
},
],
},
{
source: '/hello',
destination: '/another',
has: [
{
type: 'headerr',
},
{
type: 'queryr',
key: 'hello',
},
],
},
],
'rewrites'
)
const stderr = await getStderr()
expect(stderr).toContain(
`\`destination\` is missing for route {"source":"/hello"}`
)
expect(stderr).toContain(
`\`source\` is not a string for route {"source":123,"destination":"/another"}`
)
expect(stderr).toContain(
`invalid field: headers for route {"source":"/hello","destination":"/another","headers":"not-allowed"}`
)
expect(stderr).toContain(
`\`source\` does not start with / for route {"source":"hello","destination":"/another"}`
)
expect(stderr).toContain(
`\`destination\` does not start with \`/\`, \`http://\`, or \`https://\` for route {"source":"/hello","destination":"another"}`
)
expect(stderr).toContain(
`Error parsing \`/feedback/(?!general)\` https://nextjs.org/docs/messages/invalid-route-source`
)
expect(stderr).toContain(
`\`destination\` has unnamed params :0 for route {"source":"/hello/world/(.*)","destination":"/:0"}`
)
expect(stderr).toContain(
`The route null is not a valid object with \`source\` and \`destination\``
)
expect(stderr).toContain(
`The route "string" is not a valid object with \`source\` and \`destination\``
)
expect(stderr).toContain(`Reason: Pattern cannot start with "?" at 11`)
expect(stderr).toContain(`/feedback/(?!general)`)
expect(stderr).not.toContain(
'Valid redirect statusCode values are 301, 302, 303, 307, 308'
)
expect(stderr).toContain(
`The route /hello rewrites urls outside of the basePath. Please use a destination that starts with \`http://\` or \`https://\` https://nextjs.org/docs/messages/invalid-external-rewrite`
)
expect(stderr).toContain('Invalid `has` item:')
expect(stderr).toContain(
`invalid type "cookiee" for {"type":"cookiee","key":"loggedIn"}`
)
expect(stderr).toContain(
`invalid \`has\` item found for route {"source":"/hello","destination":"/another","has":[{"type":"cookiee","key":"loggedIn"}]}`
)
expect(stderr).toContain('Invalid `has` items:')
expect(stderr).toContain(
`invalid type "headerr", invalid key "undefined" for {"type":"headerr"}`
)
expect(stderr).toContain(
`invalid type "queryr" for {"type":"queryr","key":"hello"}`
)
expect(stderr).toContain(
`invalid \`has\` items found for route {"source":"/hello","destination":"/another","has":[{"type":"headerr"},{"type":"queryr","key":"hello"}]}`
)
expect(stderr).toContain(`Valid \`has\` object shape is {`)
expect(stderr).toContain('Invalid rewrites found')
})
it('should error during next build for invalid headers', async () => {
await writeConfig(
[
{
// missing source
headers: [
{
'x-first': 'first',
},
],
},
{
// invalid headers value
source: '/hello',
headers: {
'x-first': 'first',
},
},
{
source: '/again',
headers: [
{
// missing key
value: 'idk',
},
],
},
{
source: '/again',
headers: [
{
// missing value
key: 'idk',
},
],
},
{
// non-allowed destination
source: '/again',
destination: '/another',
headers: [
{
key: 'x-first',
value: 'idk',
},
],
},
{
// valid one
source: '/valid-header',
headers: [
{
key: 'x-first',
value: 'first',
},
{
key: 'x-another',
value: 'again',
},
],
},
// invalid objects
null,
'string',
// invalid has items
{
source: '/hello',
has: [
{
type: 'cookiee',
key: 'loggedIn',
},
],
headers: [
{
key: 'x-hello',
value: 'world',
},
],
},
{
source: '/hello',
has: [
{
type: 'headerr',
},
{
type: 'queryr',
key: 'hello',
},
],
headers: [
{
key: 'x-hello',
value: 'world',
},
],
},
],
'headers'
)
const stderr = await getStderr()
expect(stderr).toContain(
'`source` is missing, `key` in header item must be string for route {"headers":[{"x-first":"first"}]}'
)
expect(stderr).toContain(
'`headers` field must be an array for route {"source":"/hello","headers":{"x-first":"first"}}'
)
expect(stderr).toContain(
'`key` in header item must be string for route {"source":"/again","headers":[{"value":"idk"}]}'
)
expect(stderr).toContain(
'`value` in header item must be string for route {"source":"/again","headers":[{"key":"idk"}]}'
)
expect(stderr).toContain(
'invalid field: destination for route {"source":"/again","destination":"/another","headers":[{"key":"x-first","value":"idk"}]}'
)
expect(stderr).toContain(
`The route null is not a valid object with \`source\` and \`headers\``
)
expect(stderr).toContain(
`The route "string" is not a valid object with \`source\` and \`headers\``
)
expect(stderr).toContain('Invalid `has` item:')
expect(stderr).toContain(
`invalid type "cookiee" for {"type":"cookiee","key":"loggedIn"}`
)
expect(stderr).toContain(
`invalid \`has\` item found for route {"source":"/hello","has":[{"type":"cookiee","key":"loggedIn"}],"headers":[{"key":"x-hello","value":"world"}]}`
)
expect(stderr).toContain('Invalid `has` items:')
expect(stderr).toContain(
`invalid type "headerr", invalid key "undefined" for {"type":"headerr"}`
)
expect(stderr).toContain(
`invalid type "queryr" for {"type":"queryr","key":"hello"}`
)
expect(stderr).toContain(
`invalid \`has\` items found for route {"source":"/hello","has":[{"type":"headerr"},{"type":"queryr","key":"hello"}],"headers":[{"key":"x-hello","value":"world"}]}`
)
expect(stderr).toContain(`Valid \`has\` object shape is {`)
expect(stderr).not.toContain('/valid-header')
})
it('should show formatted error for redirect source parse fail', async () => {
await writeConfig(
[
{
source: '/feedback/(?!general)',
destination: '/feedback/general',
permanent: false,
},
{
source: '/learning/?',
destination: '/learning',
permanent: true,
},
],
'redirects'
)
const stderr = await getStderr()
expect(stderr).toContain(
`Error parsing \`/feedback/(?!general)\` https://nextjs.org/docs/messages/invalid-route-source`
)
expect(stderr).toContain(`Reason: Pattern cannot start with "?" at 11`)
expect(stderr).toContain(`/feedback/(?!general)`)
expect(stderr).toContain(
`Error parsing \`/learning/?\` https://nextjs.org/docs/messages/invalid-route-source`
)
expect(stderr).toContain(`Reason: Unexpected MODIFIER at 10, expected END`)
expect(stderr).toContain(`/learning/?`)
})
it('should show valid error when non-array is returned from rewrites', async () => {
await writeConfig(
{
source: '/feedback/(?!general)',
destination: '/feedback/general',
},
'rewrites'
)
const stderr = await getStderr()
expect(stderr).toContain(`rewrites must return an array, received object`)
})
it('should show valid error when non-array is returned from redirects', async () => {
await writeConfig(false, 'redirects')
const stderr = await getStderr()
expect(stderr).toContain(`redirects must return an array, received boolean`)
})
it('should show valid error when non-array is returned from headers', async () => {
await writeConfig(undefined, 'headers')
const stderr = await getStderr()
expect(stderr).toContain(`headers must return an array, received undefined`)
})
it('should show valid error when segments not in source are used in destination', async () => {
await writeConfig(
[
{
source: '/feedback/:type',
destination: '/feedback/:id',
},
],
'rewrites'
)
const stderr = await getStderr()
expect(stderr).toContain(
`\`destination\` has segments not in \`source\` or \`has\` (id) for route {"source":"/feedback/:type","destination":"/feedback/:id"}`
)
})
}
describe('Errors on invalid custom routes', () => {
afterAll(() => fs.remove(nextConfigPath))
;(process.env.TURBOPACK_BUILD ? describe.skip : describe)(
'development mode',
() => {
let stderr = ''
beforeAll(() => {
getStderr = async () => {
const port = await findPort()
await launchApp(appDir, port, {
onStderr: (msg) => {
stderr += msg
},
})
return stderr
}
})
afterEach(() => {
stderr = ''
})
runTests()
}
)
;(process.env.TURBOPACK_DEV ? describe.skip : describe)(
'production mode',
() => {
beforeAll(() => {
getStderr = async () => {
const { stderr } = await nextBuild(appDir, [], { stderr: true })
return stderr
}
})
runTests()
}
)
})