forked from vercel/next.js
/
index.test.js
373 lines (329 loc) · 12.8 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
/* eslint-env jest */
import fs from 'fs-extra'
import { join } from 'path'
import isAnimated from 'next/dist/compiled/is-animated'
import {
killApp,
findPort,
launchApp,
fetchViaHTTP,
nextBuild,
nextStart,
File,
} from 'next-test-utils'
jest.setTimeout(1000 * 60 * 2)
const appDir = join(__dirname, '../')
const imagesDir = join(appDir, '.next', 'cache', 'images')
const nextConfig = new File(join(appDir, 'next.config.js'))
let appPort
let app
async function fsToJson(dir, output = {}) {
const files = await fs.readdir(dir)
for (let file of files) {
const fsPath = join(dir, file)
const stat = await fs.stat(fsPath)
if (stat.isDirectory()) {
output[file] = {}
await fsToJson(fsPath, output[file])
} else {
output[file] = 'file'
}
}
return output
}
function runTests({ w, isDev }) {
it('should return home page', async () => {
const res = await fetchViaHTTP(appPort, '/', null, {})
expect(await res.text()).toMatch(/Image Optimizer Home/m)
})
it('should maintain animated gif', async () => {
const query = { w, q: 90, url: '/animated.gif' }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(200)
expect(res.headers.get('content-type')).toContain('image/gif')
expect(isAnimated(await res.buffer())).toBe(true)
})
it('should maintain animated png', async () => {
const query = { w, q: 90, url: '/animated.png' }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(200)
expect(res.headers.get('content-type')).toContain('image/png')
expect(isAnimated(await res.buffer())).toBe(true)
})
it('should maintain animated webp', async () => {
const query = { w, q: 90, url: '/animated.webp' }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(200)
expect(res.headers.get('content-type')).toContain('image/webp')
expect(isAnimated(await res.buffer())).toBe(true)
})
it('should fail when url is missing', async () => {
const query = { w, q: 100 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"url" parameter is required`)
})
it('should fail when w is missing', async () => {
const query = { url: '/test.png', q: 100 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"w" parameter (width) is required`)
})
it('should fail when q is missing', async () => {
const query = { url: '/test.png', w }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"q" parameter (quality) is required`)
})
it('should fail when q is greater than 100', async () => {
const query = { url: '/test.png', w, q: 101 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"q" parameter (quality) must be a number between 1 and 100`
)
})
it('should fail when q is less than 1', async () => {
const query = { url: '/test.png', w, q: 0 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"q" parameter (quality) must be a number between 1 and 100`
)
})
it('should fail when w is 0 or less', async () => {
const query = { url: '/test.png', w: 0, q: 100 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"w" parameter (width) must be a number greater than 0`
)
})
it('should fail when w is not a number', async () => {
const query = { url: '/test.png', w: 'foo', q: 100 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"w" parameter (width) must be a number greater than 0`
)
})
it('should fail when q is not a number', async () => {
const query = { url: '/test.png', w, q: 'foo' }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"q" parameter (quality) must be a number between 1 and 100`
)
})
if (!isDev) {
it('should fail when domain is not defined in next.config.js', async () => {
const url = `http://vercel.com/button`
const query = { url, w, q: 100 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"url" parameter is not allowed`)
})
}
it('should fail when width is not in next.config.js', async () => {
const query = { url: '/test.png', w: 1000, q: 100 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(400)
expect(await res.text()).toBe(
`"w" parameter (width) of 1000 is not allowed`
)
})
it('should resize relative url and webp accept header', async () => {
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/webp')
})
it('should resize relative url and jpeg accept header', async () => {
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/jpeg' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/jpeg')
})
it('should resize relative url and png accept header', async () => {
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/png' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/png')
})
it('should resize relative url with invalid accept header as png', async () => {
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/invalid' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/png')
})
it('should resize relative url with invalid accept header as gif', async () => {
const query = { url: '/test.gif', w, q: 80 }
const opts = { headers: { accept: 'image/invalid' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/gif')
})
it('should resize relative url with invalid accept header as svg', async () => {
const query = { url: '/test.svg', w, q: 80 }
const opts = { headers: { accept: 'image/invalid' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/svg+xml')
})
it('should resize relative url with invalid accept header as tiff', async () => {
const query = { url: '/test.tiff', w, q: 80 }
const opts = { headers: { accept: 'image/invalid' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/tiff')
})
it('should resize relative url and wildcard accept header as webp', async () => {
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/*' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/webp')
})
it('should resize absolute url from localhost', async () => {
const url = `http://localhost:${appPort}/test.png`
const query = { url, w, q: 80 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/webp')
})
it('should fail when url has file protocol', async () => {
const url = `file://localhost:${appPort}/test.png`
const query = { url, w, q: 80 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"url" parameter is invalid`)
})
it('should fail when url has ftp protocol', async () => {
const url = `ftp://localhost:${appPort}/test.png`
const query = { url, w, q: 80 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"url" parameter is invalid`)
})
it('should fail when url fails to load an image', async () => {
const url = `http://localhost:${appPort}/not-an-image`
const query = { w, url, q: 100 }
const res = await fetchViaHTTP(appPort, '/_next/image', query, {})
expect(res.status).toBe(404)
expect(await res.text()).toBe(
`"url" parameter is valid but upstream response is invalid`
)
})
it('should use cached image file when parameters are the same', async () => {
await fs.remove(imagesDir)
const query = { url: '/test.png', w, q: 80 }
const opts = { headers: { accept: 'image/webp' } }
const res1 = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res1.status).toBe(200)
expect(res1.headers.get('Content-Type')).toBe('image/webp')
const json1 = await fsToJson(imagesDir)
expect(Object.keys(json1).length).toBe(1)
const res2 = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res2.status).toBe(200)
expect(res2.headers.get('Content-Type')).toBe('image/webp')
const json2 = await fsToJson(imagesDir)
expect(json2).toStrictEqual(json1)
})
it('should proxy-pass unsupported image types and should not cache file', async () => {
const json1 = await fsToJson(imagesDir)
expect(json1).toBeTruthy()
const query = { url: '/test.bmp', w, q: 80 }
const opts = { headers: { accept: 'image/invalid' } }
const res = await fetchViaHTTP(appPort, '/_next/image', query, opts)
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/bmp')
const json2 = await fsToJson(imagesDir)
expect(json2).toStrictEqual(json1)
})
}
describe('Image Optimizer', () => {
describe('dev support w/o next.config.js', () => {
const size = 768 // defaults defined in server/config.ts
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort)
})
afterAll(async () => {
await killApp(app)
await fs.remove(imagesDir)
})
runTests({ w: size, isDev: true })
})
describe('dev support with next.config.js', () => {
const size = 64
beforeAll(async () => {
const json = JSON.stringify({
images: {
sizes: [size],
domains: ['localhost', 'example.com'],
},
})
nextConfig.replace('{ /* replaceme */ }', json)
appPort = await findPort()
app = await launchApp(appDir, appPort)
})
afterAll(async () => {
await killApp(app)
nextConfig.restore()
await fs.remove(imagesDir)
})
runTests({ w: size, isDev: true })
})
describe('Server support with next.config.js', () => {
const size = 128
beforeAll(async () => {
const json = JSON.stringify({
images: {
sizes: [128],
domains: ['localhost', 'example.com'],
},
})
nextConfig.replace('{ /* replaceme */ }', json)
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
})
afterAll(async () => {
await killApp(app)
nextConfig.restore()
await fs.remove(imagesDir)
})
runTests({ w: size, isDev: false })
})
describe('Serverless support with next.config.js', () => {
const size = 256
beforeAll(async () => {
const json = JSON.stringify({
target: 'experimental-serverless-trace',
images: {
sizes: [size],
domains: ['localhost', 'example.com'],
},
})
nextConfig.replace('{ /* replaceme */ }', json)
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
})
afterAll(async () => {
await killApp(app)
nextConfig.restore()
await fs.remove(imagesDir)
})
runTests({ w: size, isDev: false })
})
})