-
Notifications
You must be signed in to change notification settings - Fork 26.8k
/
index.test.js
283 lines (228 loc) · 7.75 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
/* eslint-env jest */
import { join } from 'path'
import {
renderViaHTTP,
nextServer,
startApp,
stopApp,
nextBuild,
waitFor,
} from 'next-test-utils'
import webdriver from 'next-webdriver'
import cheerio from 'cheerio'
let appDir = join(__dirname, '../base')
let appWithPartytownMissingDir = join(__dirname, '../partytown-missing')
let server
let appPort
async function bootApp(dir) {
await nextBuild(dir)
const app = nextServer({
dir,
dev: false,
quiet: true,
})
server = await startApp(app)
appPort = server.address().port
}
describe('Next.js Script - Primary Strategies', () => {
beforeAll(async () => {
await bootApp(appDir)
})
afterAll(() => {
stopApp(server)
})
it('priority afterInteractive', async () => {
let browser
try {
browser = await webdriver(appPort, '/')
await waitFor(1000)
async function test(id) {
const script = await browser.elementById(id)
const dataAttr = await script.getAttribute('data-nscript')
const endScripts = await browser.elementsByCss(
`#__NEXT_DATA__ ~ #${id}`
)
// Renders script tag
expect(script).toBeDefined()
expect(dataAttr).toBeDefined()
// Script is inserted at the end
expect(endScripts.length).toBe(1)
}
// afterInteractive script in page
await test('scriptAfterInteractive')
// afterInteractive script in _document
await test('documentAfterInteractive')
} finally {
if (browser) await browser.close()
}
})
it('priority lazyOnload', async () => {
let browser
try {
browser = await webdriver(appPort, '/page3')
await browser.waitForElementByCss('#onload-div')
await waitFor(1000)
const logs = await browser.log('browser')
const filteredLogs = logs.filter(
(log) =>
!log.message.includes('Failed to load resource') &&
!log.message === 'error' &&
!log.message === 'Event'
)
expect(filteredLogs.length).toBe(0)
async function test(id) {
const script = await browser.elementById(id)
const dataAttr = await script.getAttribute('data-nscript')
const endScripts = await browser.elementsByCss(
`#__NEXT_DATA__ ~ #${id}`
)
// Renders script tag
expect(script).toBeDefined()
expect(dataAttr).toBeDefined()
// Script is inserted at the end
expect(endScripts.length).toBe(1)
}
// lazyOnload script in page
await test('scriptLazyOnload')
// lazyOnload script in _document
await test('documentLazyOnload')
} finally {
if (browser) await browser.close()
}
})
it('priority beforeInteractive', async () => {
const html = await renderViaHTTP(appPort, '/page1')
const $ = cheerio.load(html)
function test(id) {
const script = $(`#${id}`)
// Renders script tag
expect(script.length).toBe(1)
expect(script.attr('data-nscript')).toBeDefined()
// Script is inserted before NextScripts
expect(
$(`#${id} ~ script[src^="/_next/static/chunks/main"]`).length
).toBeGreaterThan(0)
}
test('scriptBeforeInteractive')
})
// Warning - Will be removed in the next major release
it('priority beforeInteractive - older version', async () => {
const html = await renderViaHTTP(appPort, '/page6')
const $ = cheerio.load(html)
function test(id) {
const script = $(`#${id}`)
// Renders script tag
expect(script.length).toBe(1)
expect(script.attr('data-nscript')).toBeDefined()
// Script is inserted before NextScripts
expect(
$(`#${id} ~ script[src^="/_next/static/chunks/main"]`).length
).toBeGreaterThan(0)
}
test('scriptBeforePageRenderOld')
})
it('priority beforeInteractive on navigate', async () => {
let browser
try {
browser = await webdriver(appPort, '/')
// beforeInteractive scripts should load once
let documentBIScripts = await browser.elementsByCss(
'[src$="scriptBeforeInteractive"]'
)
expect(documentBIScripts.length).toBe(2)
await browser.waitForElementByCss('[href="/page1"]')
await browser.click('[href="/page1"]')
await browser.waitForElementByCss('.container')
// Ensure beforeInteractive script isn't duplicated on navigation
documentBIScripts = await browser.elementsByCss(
'[src$="scriptBeforeInteractive"]'
)
expect(documentBIScripts.length).toBe(2)
} finally {
if (browser) await browser.close()
}
})
it('onload fires correctly', async () => {
let browser
try {
browser = await webdriver(appPort, '/page4')
await waitFor(3000)
const text = await browser.elementById('text').text()
expect(text).toBe('aaabbbccc')
} finally {
if (browser) await browser.close()
}
})
it('onReady fires after load event and then on every subsequent re-mount', async () => {
let browser
try {
browser = await webdriver(appPort, '/page8')
const text = await browser.elementById('text').text()
expect(text).toBe('aaa')
// Navigate to different page and back
await browser.waitForElementByCss('[href="/page9"]')
await browser.click('[href="/page9"]')
await browser.waitForElementByCss('[href="/page8"]')
await browser.click('[href="/page8"]')
await browser.waitForElementByCss('.container')
const sameText = await browser.elementById('text').text()
expect(sameText).toBe('aaa') // onReady should fire again
} finally {
if (browser) await browser.close()
}
})
it('priority beforeInteractive with inline script', async () => {
const html = await renderViaHTTP(appPort, '/page5')
const $ = cheerio.load(html)
const script = $('#inline-before')
expect(script.length).toBe(1)
// Script is inserted before CSS
expect(
$(`#inline-before ~ link[href^="/_next/static/css"]`).length
).toBeGreaterThan(0)
})
it('priority beforeInteractive with inline script should execute', async () => {
let browser
try {
browser = await webdriver(appPort, '/page7')
await waitFor(1000)
const logs = await browser.log()
expect(
logs.some((log) =>
log.message.includes('beforeInteractive inline script run')
)
).toBe(true)
} finally {
if (browser) await browser.close()
}
})
it('Does not duplicate inline scripts', async () => {
let browser
try {
browser = await webdriver(appPort, '/')
// Navigate away and back to page
await browser.waitForElementByCss('[href="/page5"]')
await browser.click('[href="/page5"]')
await browser.waitForElementByCss('[href="/"]')
await browser.click('[href="/"]')
await browser.waitForElementByCss('[href="/page5"]')
await browser.click('[href="/page5"]')
await browser.waitForElementByCss('.container')
await waitFor(1000)
const text = await browser.elementById('text').text()
expect(text).toBe('abc')
} finally {
if (browser) await browser.close()
}
})
it('Error message is shown if Partytown is not installed locally', async () => {
const { stdout, stderr } = await nextBuild(appWithPartytownMissingDir, [], {
stdout: true,
stderr: true,
})
const output = stdout + stderr
expect(output.replace(/\n|\r/g, '')).toMatch(
/It looks like you're trying to use Partytown with next\/script but do not have the required package\(s\) installed.Please install Partytown by running:.*?(npm|pnpm|yarn) (install|add) (--save-dev|--dev) @builder.io\/partytownIf you are not trying to use Partytown, please disable the experimental "nextScriptWorkers" flag in next.config.js./
)
})
})