/** * Copyright 2018 Google Inc. All rights reserved. * * 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 fs from 'fs'; import path from 'path'; import utils from './utils.js'; import expect from 'expect'; import { getTestState, setupTestBrowserHooks, setupTestPageAndContextHooks, describeFailsFirefox, } from './mocha-utils'; // eslint-disable-line import/extensions describe('request interception', function () { setupTestBrowserHooks(); setupTestPageAndContextHooks(); describeFailsFirefox('Page.setRequestInterception', function () { it('should intercept', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { if (utils.isFavicon(request)) { request.continue(); return; } expect(request.url()).toContain('empty.html'); expect(request.headers()['user-agent']).toBeTruthy(); expect(request.method()).toBe('GET'); expect(request.postData()).toBe(undefined); expect(request.isNavigationRequest()).toBe(true); expect(request.resourceType()).toBe('document'); expect(request.frame() === page.mainFrame()).toBe(true); expect(request.frame().url()).toBe('about:blank'); request.continue(); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.ok()).toBe(true); expect(response.remoteAddress().port).toBe(server.PORT); }); it('should work when POST is redirected with 302', async () => { const { page, server } = getTestState(); server.setRedirect('/rredirect', '/empty.html'); await page.goto(server.EMPTY_PAGE); await page.setRequestInterception(true); page.on('request', (request) => request.continue()); await page.setContent(`
`); await Promise.all([ page.$eval('form', (form: HTMLFormElement) => form.submit()), page.waitForNavigation(), ]); }); // @see https://github.com/puppeteer/puppeteer/issues/3973 it('should work when header manipulation headers with redirect', async () => { const { page, server } = getTestState(); server.setRedirect('/rrredirect', '/empty.html'); await page.setRequestInterception(true); page.on('request', (request) => { const headers = Object.assign({}, request.headers(), { foo: 'bar', }); request.continue({ headers }); }); await page.goto(server.PREFIX + '/rrredirect'); }); // @see https://github.com/puppeteer/puppeteer/issues/4743 it('should be able to remove headers', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { const headers = Object.assign({}, request.headers(), { foo: 'bar', origin: undefined, // remove "origin" header }); request.continue({ headers }); }); const [serverRequest] = await Promise.all([ server.waitForRequest('/empty.html'), page.goto(server.PREFIX + '/empty.html'), ]); expect(serverRequest.headers.origin).toBe(undefined); }); it('should contain referer header', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { if (!utils.isFavicon(request)) requests.push(request); request.continue(); }); await page.goto(server.PREFIX + '/one-style.html'); expect(requests[1].url()).toContain('/one-style.css'); expect(requests[1].headers().referer).toContain('/one-style.html'); }); it('should properly return navigation response when URL has cookies', async () => { const { page, server } = getTestState(); // Setup cookie. await page.goto(server.EMPTY_PAGE); await page.setCookie({ name: 'foo', value: 'bar' }); // Setup request interception. await page.setRequestInterception(true); page.on('request', (request) => request.continue()); const response = await page.reload(); expect(response.status()).toBe(200); }); it('should stop intercepting', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.once('request', (request) => request.continue()); await page.goto(server.EMPTY_PAGE); await page.setRequestInterception(false); await page.goto(server.EMPTY_PAGE); }); it('should show custom HTTP headers', async () => { const { page, server } = getTestState(); await page.setExtraHTTPHeaders({ foo: 'bar', }); await page.setRequestInterception(true); page.on('request', (request) => { expect(request.headers()['foo']).toBe('bar'); request.continue(); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.ok()).toBe(true); }); // @see https://github.com/puppeteer/puppeteer/issues/4337 it('should work with redirect inside sync XHR', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); server.setRedirect('/logo.png', '/pptr.png'); await page.setRequestInterception(true); page.on('request', (request) => request.continue()); const status = await page.evaluate(async () => { const request = new XMLHttpRequest(); request.open('GET', '/logo.png', false); // `false` makes the request synchronous request.send(null); return request.status; }); expect(status).toBe(200); }); it('should work with custom referer headers', async () => { const { page, server } = getTestState(); await page.setExtraHTTPHeaders({ referer: server.EMPTY_PAGE }); await page.setRequestInterception(true); page.on('request', (request) => { expect(request.headers()['referer']).toBe(server.EMPTY_PAGE); request.continue(); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.ok()).toBe(true); }); it('should be abortable', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { if (request.url().endsWith('.css')) request.abort(); else request.continue(); }); let failedRequests = 0; page.on('requestfailed', () => ++failedRequests); const response = await page.goto(server.PREFIX + '/one-style.html'); expect(response.ok()).toBe(true); expect(response.request().failure()).toBe(null); expect(failedRequests).toBe(1); }); it('should be abortable with custom error codes', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { request.abort('internetdisconnected'); }); let failedRequest = null; page.on('requestfailed', (request) => (failedRequest = request)); await page.goto(server.EMPTY_PAGE).catch(() => {}); expect(failedRequest).toBeTruthy(); expect(failedRequest.failure().errorText).toBe( 'net::ERR_INTERNET_DISCONNECTED' ); }); it('should send referer', async () => { const { page, server } = getTestState(); await page.setExtraHTTPHeaders({ referer: 'http://google.com/', }); await page.setRequestInterception(true); page.on('request', (request) => request.continue()); const [request] = await Promise.all([ server.waitForRequest('/grid.html'), page.goto(server.PREFIX + '/grid.html'), ]); expect(request.headers['referer']).toBe('http://google.com/'); }); it('should fail navigation when aborting main resource', async () => { const { page, server, isChrome } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => request.abort()); let error = null; await page.goto(server.EMPTY_PAGE).catch((error_) => (error = error_)); expect(error).toBeTruthy(); if (isChrome) expect(error.message).toContain('net::ERR_FAILED'); else expect(error.message).toContain('NS_ERROR_FAILURE'); }); it('should work with redirects', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { request.continue(); requests.push(request); }); server.setRedirect( '/non-existing-page.html', '/non-existing-page-2.html' ); server.setRedirect( '/non-existing-page-2.html', '/non-existing-page-3.html' ); server.setRedirect( '/non-existing-page-3.html', '/non-existing-page-4.html' ); server.setRedirect('/non-existing-page-4.html', '/empty.html'); const response = await page.goto( server.PREFIX + '/non-existing-page.html' ); expect(response.status()).toBe(200); expect(response.url()).toContain('empty.html'); expect(requests.length).toBe(5); expect(requests[2].resourceType()).toBe('document'); // Check redirect chain const redirectChain = response.request().redirectChain(); expect(redirectChain.length).toBe(4); expect(redirectChain[0].url()).toContain('/non-existing-page.html'); expect(redirectChain[2].url()).toContain('/non-existing-page-3.html'); for (let i = 0; i < redirectChain.length; ++i) { const request = redirectChain[i]; expect(request.isNavigationRequest()).toBe(true); expect(request.redirectChain().indexOf(request)).toBe(i); } }); it('should work with redirects for subresources', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { request.continue(); if (!utils.isFavicon(request)) requests.push(request); }); server.setRedirect('/one-style.css', '/two-style.css'); server.setRedirect('/two-style.css', '/three-style.css'); server.setRedirect('/three-style.css', '/four-style.css'); server.setRoute('/four-style.css', (req, res) => res.end('body {box-sizing: border-box; }') ); const response = await page.goto(server.PREFIX + '/one-style.html'); expect(response.status()).toBe(200); expect(response.url()).toContain('one-style.html'); expect(requests.length).toBe(5); expect(requests[0].resourceType()).toBe('document'); expect(requests[1].resourceType()).toBe('stylesheet'); // Check redirect chain const redirectChain = requests[1].redirectChain(); expect(redirectChain.length).toBe(3); expect(redirectChain[0].url()).toContain('/one-style.css'); expect(redirectChain[2].url()).toContain('/three-style.css'); }); it('should be able to abort redirects', async () => { const { page, server, isChrome } = getTestState(); await page.setRequestInterception(true); server.setRedirect('/non-existing.json', '/non-existing-2.json'); server.setRedirect('/non-existing-2.json', '/simple.html'); page.on('request', (request) => { if (request.url().includes('non-existing-2')) request.abort(); else request.continue(); }); await page.goto(server.EMPTY_PAGE); const result = await page.evaluate(async () => { try { await fetch('/non-existing.json'); } catch (error) { return error.message; } }); if (isChrome) expect(result).toContain('Failed to fetch'); else expect(result).toContain('NetworkError'); }); it('should work with equal requests', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); let responseCount = 1; server.setRoute('/zzz', (req, res) => res.end(responseCount++ * 11 + '')); await page.setRequestInterception(true); let spinner = false; // Cancel 2nd request. page.on('request', (request) => { if (utils.isFavicon(request)) { request.continue(); return; } spinner ? request.abort() : request.continue(); spinner = !spinner; }); const results = await page.evaluate(() => Promise.all([ fetch('/zzz') .then((response) => response.text()) .catch(() => 'FAILED'), fetch('/zzz') .then((response) => response.text()) .catch(() => 'FAILED'), fetch('/zzz') .then((response) => response.text()) .catch(() => 'FAILED'), ]) ); expect(results).toEqual(['11', 'FAILED', '22']); }); it('should navigate to dataURL and fire dataURL requests', async () => { const { page } = getTestState(); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { requests.push(request); request.continue(); }); const dataURL = 'data:text/html,
yo
'; const response = await page.goto(dataURL); expect(response.status()).toBe(200); expect(requests.length).toBe(1); expect(requests[0].url()).toBe(dataURL); }); it('should be able to fetch dataURL and fire dataURL requests', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { requests.push(request); request.continue(); }); const dataURL = 'data:text/html,
yo
'; const text = await page.evaluate( (url: string) => fetch(url).then((r) => r.text()), dataURL ); expect(text).toBe('
yo
'); expect(requests.length).toBe(1); expect(requests[0].url()).toBe(dataURL); }); it('should navigate to URL with hash and fire requests without hash', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { requests.push(request); request.continue(); }); const response = await page.goto(server.EMPTY_PAGE + '#hash'); expect(response.status()).toBe(200); expect(response.url()).toBe(server.EMPTY_PAGE); expect(requests.length).toBe(1); expect(requests[0].url()).toBe(server.EMPTY_PAGE); }); it('should work with encoded server', async () => { const { page, server } = getTestState(); // The requestWillBeSent will report encoded URL, whereas interception will // report URL as-is. @see crbug.com/759388 await page.setRequestInterception(true); page.on('request', (request) => request.continue()); const response = await page.goto( server.PREFIX + '/some nonexisting page' ); expect(response.status()).toBe(404); }); it('should work with badly encoded server', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); server.setRoute('/malformed?rnd=%911', (req, res) => res.end()); page.on('request', (request) => request.continue()); const response = await page.goto(server.PREFIX + '/malformed?rnd=%911'); expect(response.status()).toBe(200); }); it('should work with encoded server - 2', async () => { const { page, server } = getTestState(); // The requestWillBeSent will report URL as-is, whereas interception will // report encoded URL for stylesheet. @see crbug.com/759388 await page.setRequestInterception(true); const requests = []; page.on('request', (request) => { request.continue(); requests.push(request); }); const response = await page.goto( `data:text/html,` ); expect(response.status()).toBe(200); expect(requests.length).toBe(2); expect(requests[1].response().status()).toBe(404); }); it('should not throw "Invalid Interception Id" if the request was cancelled', async () => { const { page, server } = getTestState(); await page.setContent(''); await page.setRequestInterception(true); let request = null; page.on('request', async (r) => (request = r)); page.$eval( 'iframe', (frame: HTMLIFrameElement, url: string) => (frame.src = url), server.EMPTY_PAGE ), // Wait for request interception. await utils.waitEvent(page, 'request'); // Delete frame to cause request to be canceled. await page.$eval('iframe', (frame) => frame.remove()); let error = null; await request.continue().catch((error_) => (error = error_)); expect(error).toBe(null); }); it('should throw if interception is not enabled', async () => { const { page, server } = getTestState(); let error = null; page.on('request', async (request) => { try { await request.continue(); } catch (error_) { error = error_; } }); await page.goto(server.EMPTY_PAGE); expect(error.message).toContain('Request Interception is not enabled'); }); it('should work with file URLs', async () => { const { page } = getTestState(); await page.setRequestInterception(true); const urls = new Set(); page.on('request', (request) => { urls.add(request.url().split('/').pop()); request.continue(); }); await page.goto( pathToFileURL(path.join(__dirname, 'assets', 'one-style.html')) ); expect(urls.size).toBe(2); expect(urls.has('one-style.html')).toBe(true); expect(urls.has('one-style.css')).toBe(true); }); it('should not cache if not cache-safe', async () => { const { page, server } = getTestState(); // Load and re-load to make sure it's cached. await page.goto(server.PREFIX + '/cached/one-style.html'); await page.setRequestInterception(true, false); page.on('request', (request) => request.continue()); const cached = []; page.on('requestservedfromcache', (r) => cached.push(r)); await page.reload(); expect(cached.length).toBe(0); }); it('should cache if cache-safe', async () => { const { page, server } = getTestState(); // Load and re-load to make sure it's cached. await page.goto(server.PREFIX + '/cached/one-style.html'); await page.setRequestInterception(true, true); page.on('request', (request) => request.continue()); const cached = []; page.on('requestservedfromcache', (r) => cached.push(r)); await page.reload(); expect(cached.length).toBe(1); }); }); describeFailsFirefox('Request.continue', function () { it('should work', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => request.continue()); await page.goto(server.EMPTY_PAGE); }); it('should amend HTTP headers', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { const headers = Object.assign({}, request.headers()); headers['FOO'] = 'bar'; request.continue({ headers }); }); await page.goto(server.EMPTY_PAGE); const [request] = await Promise.all([ server.waitForRequest('/sleep.zzz'), page.evaluate(() => fetch('/sleep.zzz')), ]); expect(request.headers['foo']).toBe('bar'); }); it('should redirect in a way non-observable to page', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { const redirectURL = request.url().includes('/empty.html') ? server.PREFIX + '/consolelog.html' : undefined; request.continue({ url: redirectURL }); }); let consoleMessage = null; page.on('console', (msg) => (consoleMessage = msg)); await page.goto(server.EMPTY_PAGE); expect(page.url()).toBe(server.EMPTY_PAGE); expect(consoleMessage.text()).toBe('yellow'); }); it('should amend method', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); await page.setRequestInterception(true); page.on('request', (request) => { request.continue({ method: 'POST' }); }); const [request] = await Promise.all([ server.waitForRequest('/sleep.zzz'), page.evaluate(() => fetch('/sleep.zzz')), ]); expect(request.method).toBe('POST'); }); it('should amend post data', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); await page.setRequestInterception(true); page.on('request', (request) => { request.continue({ postData: 'doggo' }); }); const [serverRequest] = await Promise.all([ server.waitForRequest('/sleep.zzz'), page.evaluate(() => fetch('/sleep.zzz', { method: 'POST', body: 'birdy' }) ), ]); expect(await serverRequest.postBody).toBe('doggo'); }); it('should amend both post data and method on navigation', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { request.continue({ method: 'POST', postData: 'doggo' }); }); const [serverRequest] = await Promise.all([ server.waitForRequest('/empty.html'), page.goto(server.EMPTY_PAGE), ]); expect(serverRequest.method).toBe('POST'); expect(await serverRequest.postBody).toBe('doggo'); }); }); describeFailsFirefox('Request.respond', function () { it('should work', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { request.respond({ status: 201, headers: { foo: 'bar', }, body: 'Yo, page!', }); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.status()).toBe(201); expect(response.headers().foo).toBe('bar'); expect(await page.evaluate(() => document.body.textContent)).toBe( 'Yo, page!' ); }); it('should work with status code 422', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { request.respond({ status: 422, body: 'Yo, page!', }); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.status()).toBe(422); expect(response.statusText()).toBe('Unprocessable Entity'); expect(await page.evaluate(() => document.body.textContent)).toBe( 'Yo, page!' ); }); it('should redirect', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { if (!request.url().includes('rrredirect')) { request.continue(); return; } request.respond({ status: 302, headers: { location: server.EMPTY_PAGE, }, }); }); const response = await page.goto(server.PREFIX + '/rrredirect'); expect(response.request().redirectChain().length).toBe(1); expect(response.request().redirectChain()[0].url()).toBe( server.PREFIX + '/rrredirect' ); expect(response.url()).toBe(server.EMPTY_PAGE); }); it('should allow mocking binary responses', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { const imageBuffer = fs.readFileSync( path.join(__dirname, 'assets', 'pptr.png') ); request.respond({ contentType: 'image/png', body: imageBuffer, }); }); await page.evaluate((PREFIX) => { const img = document.createElement('img'); img.src = PREFIX + '/does-not-exist.png'; document.body.appendChild(img); return new Promise((fulfill) => (img.onload = fulfill)); }, server.PREFIX); const img = await page.$('img'); expect(await img.screenshot()).toBeGolden('mock-binary-response.png'); }); it('should stringify intercepted request response headers', async () => { const { page, server } = getTestState(); await page.setRequestInterception(true); page.on('request', (request) => { request.respond({ status: 200, headers: { foo: true, }, body: 'Yo, page!', }); }); const response = await page.goto(server.EMPTY_PAGE); expect(response.status()).toBe(200); const headers = response.headers(); expect(headers.foo).toBe('true'); expect(await page.evaluate(() => document.body.textContent)).toBe( 'Yo, page!' ); }); }); }); /** * @param {string} path * @returns {string} */ function pathToFileURL(path) { let pathName = path.replace(/\\/g, '/'); // Windows drive letter must be prefixed with a slash. if (!pathName.startsWith('/')) pathName = '/' + pathName; return 'file://' + pathName; }