/
page-request-intercept.spec.ts
380 lines (344 loc) · 13.8 KB
/
page-request-intercept.spec.ts
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
/**
* Copyright 2018 Google Inc. All rights reserved.
* Modifications copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { fail } from 'assert';
import os from 'os';
import type { Route } from '../../index';
import { expect, test as it } from './pageTest';
it('should fulfill intercepted response', async ({page, server, browserName}) => {
await page.route('**/*', async route => {
// @ts-expect-error
await route._continueToResponse({});
await route.fulfill({
status: 201,
headers: {
foo: 'bar'
},
contentType: 'text/plain',
body: 'Yo, page!'
});
});
const response = await page.goto(server.PREFIX + '/empty.html');
expect(response.status()).toBe(201);
expect(response.headers().foo).toBe('bar');
expect(response.headers()['content-type']).toBe('text/plain');
expect(await page.evaluate(() => document.body.textContent)).toBe('Yo, page!');
});
it('should fulfill response with empty body', async ({page, server, browserName, browserMajorVersion}) => {
it.skip(browserName === 'chromium' && browserMajorVersion <= 91, 'Fails in Electron that uses old Chromium');
await page.route('**/*', async route => {
// @ts-expect-error
const response = await route._continueToResponse({});
await route.fulfill({
// @ts-expect-error
response,
status: 201,
body: ''
});
});
const response = await page.goto(server.PREFIX + '/title.html');
expect(response.status()).toBe(201);
expect(await response.text()).toBe('');
});
it('should override with defaults when intercepted response not provided', async ({page, server, browserName, browserMajorVersion}) => {
it.skip(browserName === 'chromium' && browserMajorVersion <= 91, 'Fails in Electron that uses old Chromium');
server.setRoute('/empty.html', (req, res) => {
res.setHeader('foo', 'bar');
res.end('my content');
});
await page.route('**/*', async route => {
// @ts-expect-error
await route._continueToResponse({});
await route.fulfill({
status: 201,
});
});
const response = await page.goto(server.EMPTY_PAGE);
expect(response.status()).toBe(201);
expect(await response.text()).toBe('');
if (browserName === 'webkit')
expect(response.headers()).toEqual({'content-type': 'text/plain'});
else
expect(response.headers()).toEqual({ });
});
it('should fulfill with any response', async ({page, server, browserName, browserMajorVersion, isLinux}) => {
it.skip(browserName === 'chromium' && browserMajorVersion <= 91, 'Fails in Electron that uses old Chromium');
server.setRoute('/sample', (req, res) => {
res.setHeader('foo', 'bar');
res.end('Woo-hoo');
});
const page2 = await page.context().newPage();
const sampleResponse = await page2.goto(`${server.PREFIX}/sample`);
await page.route('**/*', async route => {
// @ts-expect-error
await route._continueToResponse({});
await route.fulfill({
// @ts-expect-error
response: sampleResponse,
status: 201,
contentType: 'text/plain'
});
});
const response = await page.goto(server.EMPTY_PAGE);
expect(response.status()).toBe(201);
expect(await response.text()).toBe('Woo-hoo');
expect(response.headers()['foo']).toBe('bar');
});
it('should throw on continue after intercept', async ({page, server, browserName}) => {
let routeCallback;
const routePromise = new Promise<Route>(f => routeCallback = f);
await page.route('**', routeCallback);
page.goto(server.EMPTY_PAGE).catch(e => {});
const route = await routePromise;
// @ts-expect-error
await route._continueToResponse();
try {
await route.continue();
fail('did not throw');
} catch (e) {
expect(e.message).toContain('Cannot call continue after response interception!');
}
});
it('should support fulfill after intercept', async ({page, server}) => {
const requestPromise = server.waitForRequest('/title.html');
await page.route('**', async route => {
// @ts-expect-error
const response = await route._continueToResponse();
// @ts-expect-error
await route.fulfill({ response });
});
const response = await page.goto(server.PREFIX + '/title.html');
const request = await requestPromise;
expect(request.url).toBe('/title.html');
expect(await response.text()).toBe('<title>Woof-Woof</title>' + os.EOL);
});
it('should intercept failures', async ({page, browserName, browserMajorVersion, server}) => {
it.skip(browserName === 'chromium' && browserMajorVersion <= 91, 'Fails in Electron that uses old Chromium');
server.setRoute('/title.html', (req, res) => {
req.destroy();
});
const requestPromise = server.waitForRequest('/title.html');
let error;
await page.route('**', async route => {
try {
// @ts-expect-error
const response = await route._continueToResponse();
// @ts-expect-error
await route.fulfill({ response });
} catch (e) {
error = e;
}
});
const [request] = await Promise.all([
requestPromise,
page.goto(server.PREFIX + '/title.html').catch(e => {})
]);
expect(error).toBeTruthy();
expect(error.message).toContain('Request failed');
expect(request.url).toBe('/title.html');
});
it('should support request overrides', async ({page, server, browserName, browserMajorVersion}) => {
it.skip(browserName === 'chromium' && browserMajorVersion <= 91, 'Fails in Electron that uses old Chromium');
const requestPromise = server.waitForRequest('/empty.html');
await page.route('**/foo', async route => {
// @ts-expect-error
const response = await route._continueToResponse({
url: server.EMPTY_PAGE,
method: 'POST',
headers: {'foo': 'bar'},
postData: 'my data',
});
// @ts-expect-error
await route.fulfill({ response });
});
await page.goto(server.PREFIX + '/foo');
const request = await requestPromise;
expect(request.method).toBe('POST');
expect(request.url).toBe('/empty.html');
expect(request.headers['foo']).toBe('bar');
expect((await request.postBody).toString('utf8')).toBe('my data');
});
it('should give access to the intercepted response', async ({page, server}) => {
await page.goto(server.EMPTY_PAGE);
let routeCallback;
const routePromise = new Promise<Route>(f => routeCallback = f);
await page.route('**/title.html', routeCallback);
const evalPromise = page.evaluate(url => fetch(url), server.PREFIX + '/title.html');
const route = await routePromise;
// @ts-expect-error
const response = await route._continueToResponse();
expect(response.status()).toBe(200);
expect(response.ok()).toBeTruthy();
expect(response.url()).toBe(server.PREFIX + '/title.html');
expect(response.headers()['content-type']).toBe('text/html; charset=utf-8');
// @ts-expect-error
await Promise.all([route.fulfill({ response }), evalPromise]);
});
it('should give access to the intercepted response status text', async ({page, server, browserName}) => {
it.fail(browserName === 'chromium', 'Status line is not reported for intercepted responses');
await page.goto(server.EMPTY_PAGE);
server.setRoute('/title.html', (req, res) => {
res.statusCode = 200;
res.statusMessage = 'You are awesome';
res.setHeader('Content-Type', 'text/plain');
res.end();
});
let routeCallback;
const routePromise = new Promise<Route>(f => routeCallback = f);
await page.route('**/title.html', routeCallback);
const evalPromise = page.evaluate(url => fetch(url), server.PREFIX + '/title.html');
const route = await routePromise;
// @ts-expect-error
const response = await route._continueToResponse();
expect(response.statusText()).toBe('You are awesome');
expect(response.url()).toBe(server.PREFIX + '/title.html');
// @ts-expect-error
await Promise.all([route.fulfill({ response }), evalPromise]);
});
it('should give access to the intercepted response body', async ({page, server}) => {
await page.goto(server.EMPTY_PAGE);
let routeCallback;
const routePromise = new Promise<Route>(f => routeCallback = f);
await page.route('**/simple.json', routeCallback);
const evalPromise = page.evaluate(url => fetch(url), server.PREFIX + '/simple.json').catch(console.log);
const route = await routePromise;
// @ts-expect-error
const response = await route._continueToResponse();
expect((await response.text())).toBe('{"foo": "bar"}\n');
// @ts-expect-error
await Promise.all([route.fulfill({ response }), evalPromise]);
});
it('should be abortable after interception', async ({page, server, browserName}) => {
await page.route(/\.css$/, async route => {
// @ts-expect-error
await route._continueToResponse();
await route.abort();
});
let failed = false;
page.on('requestfailed', request => {
if (request.url().includes('.css'))
failed = true;
});
const response = await page.goto(server.PREFIX + '/one-style.html');
expect(response.ok()).toBe(true);
expect(response.request().failure()).toBe(null);
expect(failed).toBe(true);
});
it('should fulfill after redirects', async ({page, server, browserName}) => {
server.setRedirect('/redirect/1.html', '/redirect/2.html');
server.setRedirect('/redirect/2.html', '/empty.html');
const expectedUrls = ['/redirect/1.html', '/redirect/2.html', '/empty.html'].map(s => server.PREFIX + s);
const requestUrls = [];
const responseUrls = [];
const requestFinishedUrls = [];
page.on('request', request => requestUrls.push(request.url()));
page.on('response', response => responseUrls.push(response.url()));
page.on('requestfinished', request => requestFinishedUrls.push(request.url()));
let routeCalls = 0;
await page.route('**/*', async route => {
++routeCalls;
// @ts-expect-error
await route._continueToResponse({});
await route.fulfill({
status: 201,
headers: {
foo: 'bar'
},
contentType: 'text/plain',
body: 'Yo, page!'
});
});
const response = await page.goto(server.PREFIX + '/redirect/1.html');
expect(requestUrls).toEqual(expectedUrls);
expect(responseUrls).toEqual(expectedUrls);
await response.finished();
expect(requestFinishedUrls).toEqual(expectedUrls);
expect(routeCalls).toBe(1);
const redirectChain = [];
for (let req = response.request(); req; req = req.redirectedFrom())
redirectChain.unshift(req.url());
expect(redirectChain).toEqual(expectedUrls);
expect(response.status()).toBe(201);
expect(response.headers().foo).toBe('bar');
expect(response.headers()['content-type']).toBe('text/plain');
expect(await response.text()).toBe('Yo, page!');
});
it('should fulfill original response after redirects', async ({page, browserName, server}) => {
server.setRedirect('/redirect/1.html', '/redirect/2.html');
server.setRedirect('/redirect/2.html', '/title.html');
const expectedUrls = ['/redirect/1.html', '/redirect/2.html', '/title.html'].map(s => server.PREFIX + s);
const requestUrls = [];
const responseUrls = [];
const requestFinishedUrls = [];
page.on('request', request => requestUrls.push(request.url()));
page.on('response', response => responseUrls.push(response.url()));
page.on('requestfinished', request => requestFinishedUrls.push(request.url()));
let routeCalls = 0;
await page.route('**/*', async route => {
++routeCalls;
// @ts-expect-error
const response = await route._continueToResponse({});
// @ts-expect-error
await route.fulfill({ response });
});
const response = await page.goto(server.PREFIX + '/redirect/1.html');
expect(requestUrls).toEqual(expectedUrls);
expect(responseUrls).toEqual(expectedUrls);
await response.finished();
expect(requestFinishedUrls).toEqual(expectedUrls);
expect(routeCalls).toBe(1);
const redirectChain = [];
for (let req = response.request(); req; req = req.redirectedFrom())
redirectChain.unshift(req.url());
expect(redirectChain).toEqual(expectedUrls);
expect(response.status()).toBe(200);
expect(await response.text()).toBe('<title>Woof-Woof</title>' + os.EOL);
});
it('should abort after redirects', async ({page, browserName, server}) => {
server.setRedirect('/redirect/1.html', '/redirect/2.html');
server.setRedirect('/redirect/2.html', '/title.html');
const expectedUrls = ['/redirect/1.html', '/redirect/2.html', '/title.html'].map(s => server.PREFIX + s);
const requestUrls = [];
const responseUrls = [];
const requestFinishedUrls = [];
const requestFailedUrls = [];
page.on('request', request => requestUrls.push(request.url()));
page.on('response', response => responseUrls.push(response.url()));
page.on('requestfinished', request => requestFinishedUrls.push(request.url()));
page.on('requestfailed', request => requestFailedUrls.push(request.url()));
let routeCalls = 0;
await page.route('**/*', async route => {
++routeCalls;
// @ts-expect-error
await route._continueToResponse({});
await route.abort('connectionreset');
});
try {
await page.goto(server.PREFIX + '/redirect/1.html');
} catch (e) {
if (browserName === 'webkit')
expect(e.message).toContain('Request intercepted');
else if (browserName === 'chromium')
expect(e.message).toContain('ERR_CONNECTION_RESET');
else
expect(e.message).toContain('NS_ERROR_NET_RESET');
}
expect(requestUrls).toEqual(expectedUrls);
expect(responseUrls).toEqual(expectedUrls.slice(0, -1));
expect(requestFinishedUrls).toEqual(expectedUrls.slice(0, -1));
expect(requestFailedUrls).toEqual(expectedUrls.slice(-1));
expect(routeCalls).toBe(1);
});