/** * 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 {ServerResponse} from 'http'; import expect from 'expect'; import {Frame, TimeoutError} from 'puppeteer'; import {HTTPRequest} from 'puppeteer-core/internal/api/HTTPRequest.js'; import { getTestState, setupTestBrowserHooks, setupTestPageAndContextHooks, } from './mocha-utils.js'; import {attachFrame, isFavicon, waitEvent} from './utils.js'; describe('navigation', function () { setupTestBrowserHooks(); setupTestPageAndContextHooks(); describe('Page.goto', function () { it('should work', async () => { const {page, server} = getTestState(); await page.goto(server.EMPTY_PAGE); expect(page.url()).toBe(server.EMPTY_PAGE); }); it('should work with anchor navigation', async () => { const {page, server} = getTestState(); await page.goto(server.EMPTY_PAGE); expect(page.url()).toBe(server.EMPTY_PAGE); await page.goto(server.EMPTY_PAGE + '#foo'); expect(page.url()).toBe(server.EMPTY_PAGE + '#foo'); await page.goto(server.EMPTY_PAGE + '#bar'); expect(page.url()).toBe(server.EMPTY_PAGE + '#bar'); }); it('should work with redirects', async () => { const {page, server} = getTestState(); server.setRedirect('/redirect/1.html', '/redirect/2.html'); server.setRedirect('/redirect/2.html', '/empty.html'); await page.goto(server.PREFIX + '/redirect/1.html'); expect(page.url()).toBe(server.EMPTY_PAGE); }); it('should navigate to about:blank', async () => { const {page} = getTestState(); const response = await page.goto('about:blank'); expect(response).toBe(null); }); it('should return response when page changes its URL after load', async () => { const {page, server} = getTestState(); const response = await page.goto(server.PREFIX + '/historyapi.html'); expect(response!.status()).toBe(200); }); it('should work with subframes return 204', async () => { const {page, server} = getTestState(); server.setRoute('/frames/frame.html', (_req, res) => { res.statusCode = 204; res.end(); }); let error!: Error; await page .goto(server.PREFIX + '/frames/one-frame.html') .catch(error_ => { return (error = error_); }); expect(error).toBeUndefined(); }); it('should fail when server returns 204', async () => { const {page, server, isChrome} = getTestState(); server.setRoute('/empty.html', (_req, res) => { res.statusCode = 204; res.end(); }); let error!: Error; await page.goto(server.EMPTY_PAGE).catch(error_ => { return (error = error_); }); expect(error).not.toBe(null); if (isChrome) { expect(error.message).toContain('net::ERR_ABORTED'); } else { expect(error.message).toContain('NS_BINDING_ABORTED'); } }); it('should navigate to empty page with domcontentloaded', async () => { const {page, server} = getTestState(); const response = await page.goto(server.EMPTY_PAGE, { waitUntil: 'domcontentloaded', }); expect(response!.status()).toBe(200); }); it('should work when page calls history API in beforeunload', async () => { const {page, server} = getTestState(); await page.goto(server.EMPTY_PAGE); await page.evaluate(() => { window.addEventListener( 'beforeunload', () => { return history.replaceState(null, 'initial', window.location.href); }, false ); }); const response = await page.goto(server.PREFIX + '/grid.html'); expect(response!.status()).toBe(200); }); it('should navigate to empty page with networkidle0', async () => { const {page, server} = getTestState(); const response = await page.goto(server.EMPTY_PAGE, { waitUntil: 'networkidle0', }); expect(response!.status()).toBe(200); }); it('should navigate to empty page with networkidle2', async () => { const {page, server} = getTestState(); const response = await page.goto(server.EMPTY_PAGE, { waitUntil: 'networkidle2', }); expect(response!.status()).toBe(200); }); it('should fail when navigating to bad url', async () => { const {page} = getTestState(); let error!: Error; await page.goto('asdfasdf').catch(error_ => { return (error = error_); }); expect(error.message).atLeastOneToContain([ 'Cannot navigate to invalid URL', // Firefox WebDriver BiDi. 'invalid argument', // Others. ]); }); const EXPECTED_SSL_CERT_MESSAGE_REGEX = /net::ERR_CERT_INVALID|net::ERR_CERT_AUTHORITY_INVALID/; it('should fail when navigating to bad SSL', async () => { const {page, httpsServer, isChrome} = getTestState(); // Make sure that network events do not emit 'undefined'. // @see https://crbug.com/750469 const requests: string[] = []; page.on('request', () => { return requests.push('request'); }); page.on('requestfinished', () => { return requests.push('requestfinished'); }); page.on('requestfailed', () => { return requests.push('requestfailed'); }); let error!: Error; await page.goto(httpsServer.EMPTY_PAGE).catch(error_ => { return (error = error_); }); if (isChrome) { expect(error.message).toMatch(EXPECTED_SSL_CERT_MESSAGE_REGEX); } else { expect(error.message).toContain('SSL_ERROR_UNKNOWN'); } expect(requests).toHaveLength(2); expect(requests[0]).toBe('request'); expect(requests[1]).toBe('requestfailed'); }); it('should fail when navigating to bad SSL after redirects', async () => { const {page, server, httpsServer, isChrome} = getTestState(); server.setRedirect('/redirect/1.html', '/redirect/2.html'); server.setRedirect('/redirect/2.html', '/empty.html'); let error!: Error; await page.goto(httpsServer.PREFIX + '/redirect/1.html').catch(error_ => { return (error = error_); }); if (isChrome) { expect(error.message).toMatch(EXPECTED_SSL_CERT_MESSAGE_REGEX); } else { expect(error.message).atLeastOneToContain([ 'MOZILLA_PKIX_ERROR_SELF_SIGNED_CERT', // Firefox WebDriver BiDi. 'SSL_ERROR_UNKNOWN ', // Others. ]); } }); it('should fail when main resources failed to load', async () => { const {page, isChrome} = getTestState(); let error!: Error; await page .goto('http://localhost:44123/non-existing-url') .catch(error_ => { return (error = error_); }); if (isChrome) { expect(error.message).toContain('net::ERR_CONNECTION_REFUSED'); } else { expect(error.message).toContain('NS_ERROR_CONNECTION_REFUSED'); } }); it('should fail when exceeding maximum navigation timeout', async () => { const {page, server} = getTestState(); // Hang for request to the empty.html server.setRoute('/empty.html', () => {}); let error!: Error; await page .goto(server.PREFIX + '/empty.html', {timeout: 1}) .catch(error_ => { return (error = error_); }); expect(error.message).toContain('Navigation timeout of 1 ms exceeded'); expect(error).toBeInstanceOf(TimeoutError); }); it('should fail when exceeding default maximum navigation timeout', async () => { const {page, server} = getTestState(); // Hang for request to the empty.html server.setRoute('/empty.html', () => {}); let error!: Error; page.setDefaultNavigationTimeout(1); await page.goto(server.PREFIX + '/empty.html').catch(error_ => { return (error = error_); }); expect(error.message).toContain('Navigation timeout of 1 ms exceeded'); expect(error).toBeInstanceOf(TimeoutError); }); it('should fail when exceeding default maximum timeout', async () => { const {page, server} = getTestState(); // Hang for request to the empty.html server.setRoute('/empty.html', () => {}); let error!: Error; page.setDefaultTimeout(1); await page.goto(server.PREFIX + '/empty.html').catch(error_ => { return (error = error_); }); expect(error.message).toContain('Navigation timeout of 1 ms exceeded'); expect(error).toBeInstanceOf(TimeoutError); }); it('should prioritize default navigation timeout over default timeout', async () => { const {page, server} = getTestState(); // Hang for request to the empty.html server.setRoute('/empty.html', () => {}); let error!: Error; page.setDefaultTimeout(0); page.setDefaultNavigationTimeout(1); await page.goto(server.PREFIX + '/empty.html').catch(error_ => { return (error = error_); }); expect(error.message).toContain('Navigation timeout of 1 ms exceeded'); expect(error).toBeInstanceOf(TimeoutError); }); it('should disable timeout when its set to 0', async () => { const {page, server} = getTestState(); let error!: Error; let loaded = false; page.once('load', () => { return (loaded = true); }); await page .goto(server.PREFIX + '/grid.html', {timeout: 0, waitUntil: ['load']}) .catch(error_ => { return (error = error_); }); expect(error).toBeUndefined(); expect(loaded).toBe(true); }); it('should work when navigating to valid url', async () => { const {page, server} = getTestState(); const response = (await page.goto(server.EMPTY_PAGE))!; expect(response.ok()).toBe(true); }); it('should work when navigating to data url', async () => { const {page} = getTestState(); const response = (await page.goto('data:text/html,hello'))!; expect(response.ok()).toBe(true); }); it('should work when navigating to 404', async () => { const {page, server} = getTestState(); const response = (await page.goto(server.PREFIX + '/not-found'))!; expect(response.ok()).toBe(false); expect(response.status()).toBe(404); }); it('should not throw an error for a 404 response with an empty body', async () => { const {page, server} = getTestState(); server.setRoute('/404-error', (_, res) => { res.statusCode = 404; res.end(); }); const response = (await page.goto(server.PREFIX + '/404-error'))!; expect(response.ok()).toBe(false); expect(response.status()).toBe(404); }); it('should not throw an error for a 500 response with an empty body', async () => { const {page, server} = getTestState(); server.setRoute('/500-error', (_, res) => { res.statusCode = 500; res.end(); }); const response = (await page.goto(server.PREFIX + '/500-error'))!; expect(response.ok()).toBe(false); expect(response.status()).toBe(500); }); it('should return last response in redirect chain', async () => { const {page, server} = getTestState(); server.setRedirect('/redirect/1.html', '/redirect/2.html'); server.setRedirect('/redirect/2.html', '/redirect/3.html'); server.setRedirect('/redirect/3.html', server.EMPTY_PAGE); const response = (await page.goto(server.PREFIX + '/redirect/1.html'))!; expect(response.ok()).toBe(true); expect(response.url()).toBe(server.EMPTY_PAGE); }); it('should wait for network idle to succeed navigation', async () => { const {page, server} = getTestState(); let responses: ServerResponse[] = []; // Hold on to a bunch of requests without answering. server.setRoute('/fetch-request-a.js', (_req, res) => { return responses.push(res); }); server.setRoute('/fetch-request-b.js', (_req, res) => { return responses.push(res); }); server.setRoute('/fetch-request-c.js', (_req, res) => { return responses.push(res); }); server.setRoute('/fetch-request-d.js', (_req, res) => { return responses.push(res); }); const initialFetchResourcesRequested = Promise.all([ server.waitForRequest('/fetch-request-a.js'), server.waitForRequest('/fetch-request-b.js'), server.waitForRequest('/fetch-request-c.js'), ]).catch(() => { // Ignore Error that arise from test server during hooks }); const secondFetchResourceRequested = server .waitForRequest('/fetch-request-d.js') .catch(() => { // Ignore Error that arise from test server during hooks }); // Track when the navigation gets completed. let navigationFinished = false; let navigationError: Error | undefined; // Navigate to a page which loads immediately and then does a bunch of // requests via javascript's fetch method. const navigationPromise = page .goto(server.PREFIX + '/networkidle.html', { waitUntil: 'networkidle0', }) .then(response => { navigationFinished = true; return response; }) .catch(error => { navigationError = error; return null; }); let afterNavigationError: Error | undefined; const afterNavigationPromise = (async () => { // Wait for the page's 'load' event. await waitEvent(page, 'load'); expect(navigationFinished).toBe(false); // Wait for the initial three resources to be requested. await initialFetchResourcesRequested; // Expect navigation still to be not finished. expect(navigationFinished).toBe(false); // Respond to initial requests. for (const response of responses) { response.statusCode = 404; response.end(`File not found`); } // Reset responses array responses = []; // Wait for the second round to be requested. await secondFetchResourceRequested; // Expect navigation still to be not finished. expect(navigationFinished).toBe(false); // Respond to requests. for (const response of responses) { response.statusCode = 404; response.end(`File not found`); } })().catch(error => { afterNavigationError = error; }); await Promise.race([navigationPromise, afterNavigationPromise]); if (navigationError) { throw navigationError; } await Promise.all([navigationPromise, afterNavigationPromise]); if (afterNavigationError) { throw afterNavigationError; } // Expect navigation to succeed. expect(navigationFinished).toBeTruthy(); expect((await navigationPromise)?.ok()).toBe(true); }); it('should not leak listeners during navigation', async function () { this.timeout(25_000); const {page, server} = getTestState(); let warning = null; const warningHandler: NodeJS.WarningListener = w => { return (warning = w); }; process.on('warning', warningHandler); for (let i = 0; i < 20; ++i) { await page.goto(server.EMPTY_PAGE); } process.removeListener('warning', warningHandler); expect(warning).toBe(null); }); it('should not leak listeners during bad navigation', async function () { this.timeout(25_000); const {page} = getTestState(); let warning = null; const warningHandler: NodeJS.WarningListener = w => { return (warning = w); }; process.on('warning', warningHandler); for (let i = 0; i < 20; ++i) { await page.goto('asdf').catch(() => { /* swallow navigation error */ }); } process.removeListener('warning', warningHandler); expect(warning).toBe(null); }); it('should not leak listeners during navigation of 11 pages', async function () { this.timeout(25_000); const {context, server} = getTestState(); let warning = null; const warningHandler: NodeJS.WarningListener = w => { return (warning = w); }; process.on('warning', warningHandler); await Promise.all( [...Array(20)].map(async () => { const page = await context.newPage(); await page.goto(server.EMPTY_PAGE); await page.close(); }) ); process.removeListener('warning', warningHandler); expect(warning).toBe(null); }); it('should navigate to dataURL and fire dataURL requests', async () => { const {page} = getTestState(); const requests: HTTPRequest[] = []; page.on('request', request => { return !isFavicon(request) && requests.push(request); }); const dataURL = 'data:text/html,