1334 lines
38 KiB
JavaScript
1334 lines
38 KiB
JavaScript
/**
|
|
* Copyright 2017 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.
|
|
*/
|
|
|
|
const fs = require('fs');
|
|
const EventEmitter = require('events');
|
|
const {helper, assert} = require('./helper');
|
|
const {ExecutionContext} = require('./ExecutionContext');
|
|
const {TimeoutError} = require('./Errors');
|
|
const {NetworkManager} = require('./NetworkManager');
|
|
const {CDPSession} = require('./Connection');
|
|
|
|
const readFileAsync = helper.promisify(fs.readFile);
|
|
|
|
class FrameManager extends EventEmitter {
|
|
/**
|
|
* @param {!Puppeteer.CDPSession} client
|
|
* @param {!Protocol.Page.FrameTree} frameTree
|
|
* @param {!Puppeteer.Page} page
|
|
* @param {!Puppeteer.NetworkManager} networkManager
|
|
*/
|
|
constructor(client, frameTree, page, networkManager) {
|
|
super();
|
|
this._client = client;
|
|
this._page = page;
|
|
this._networkManager = networkManager;
|
|
this._defaultNavigationTimeout = 30000;
|
|
/** @type {!Map<string, !Frame>} */
|
|
this._frames = new Map();
|
|
/** @type {!Map<number, !ExecutionContext>} */
|
|
this._contextIdToContext = new Map();
|
|
|
|
this._client.on('Page.frameAttached', event => this._onFrameAttached(event.frameId, event.parentFrameId));
|
|
this._client.on('Page.frameNavigated', event => this._onFrameNavigated(event.frame));
|
|
this._client.on('Page.navigatedWithinDocument', event => this._onFrameNavigatedWithinDocument(event.frameId, event.url));
|
|
this._client.on('Page.frameDetached', event => this._onFrameDetached(event.frameId));
|
|
this._client.on('Page.frameStoppedLoading', event => this._onFrameStoppedLoading(event.frameId));
|
|
this._client.on('Runtime.executionContextCreated', event => this._onExecutionContextCreated(event.context));
|
|
this._client.on('Runtime.executionContextDestroyed', event => this._onExecutionContextDestroyed(event.executionContextId));
|
|
this._client.on('Runtime.executionContextsCleared', event => this._onExecutionContextsCleared());
|
|
this._client.on('Page.lifecycleEvent', event => this._onLifecycleEvent(event));
|
|
|
|
this._handleFrameTree(frameTree);
|
|
}
|
|
|
|
/**
|
|
* @param {number} timeout
|
|
*/
|
|
setDefaultNavigationTimeout(timeout) {
|
|
this._defaultNavigationTimeout = timeout;
|
|
}
|
|
|
|
/**
|
|
* @param {!Puppeteer.Frame} frame
|
|
* @param {string} url
|
|
* @param {!{referer?: string, timeout?: number, waitUntil?: string|!Array<string>}=} options
|
|
* @return {!Promise<?Puppeteer.Response>}
|
|
*/
|
|
async navigateFrame(frame, url, options = {}) {
|
|
assertNoLegacyNavigationOptions(options);
|
|
const {
|
|
referer = this._networkManager.extraHTTPHeaders()['referer'],
|
|
waitUntil = ['load'],
|
|
timeout = this._defaultNavigationTimeout,
|
|
} = options;
|
|
|
|
const watcher = new LifecycleWatcher(this, frame, waitUntil, timeout);
|
|
let ensureNewDocumentNavigation = false;
|
|
let error = await Promise.race([
|
|
navigate(this._client, url, referer, frame._id),
|
|
watcher.timeoutOrTerminationPromise(),
|
|
]);
|
|
if (!error) {
|
|
error = await Promise.race([
|
|
watcher.timeoutOrTerminationPromise(),
|
|
ensureNewDocumentNavigation ? watcher.newDocumentNavigationPromise() : watcher.sameDocumentNavigationPromise(),
|
|
]);
|
|
}
|
|
watcher.dispose();
|
|
if (error)
|
|
throw error;
|
|
return watcher.navigationResponse();
|
|
|
|
/**
|
|
* @param {!Puppeteer.CDPSession} client
|
|
* @param {string} url
|
|
* @param {string} referrer
|
|
* @param {string} frameId
|
|
* @return {!Promise<?Error>}
|
|
*/
|
|
async function navigate(client, url, referrer, frameId) {
|
|
try {
|
|
const response = await client.send('Page.navigate', {url, referrer, frameId});
|
|
ensureNewDocumentNavigation = !!response.loaderId;
|
|
return response.errorText ? new Error(`${response.errorText} at ${url}`) : null;
|
|
} catch (error) {
|
|
return error;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {!Puppeteer.Frame} frame
|
|
* @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
|
|
* @return {!Promise<?Puppeteer.Response>}
|
|
*/
|
|
async waitForFrameNavigation(frame, options = {}) {
|
|
assertNoLegacyNavigationOptions(options);
|
|
const {
|
|
waitUntil = ['load'],
|
|
timeout = this._defaultNavigationTimeout,
|
|
} = options;
|
|
const watcher = new LifecycleWatcher(this, frame, waitUntil, timeout);
|
|
const error = await Promise.race([
|
|
watcher.timeoutOrTerminationPromise(),
|
|
watcher.sameDocumentNavigationPromise(),
|
|
watcher.newDocumentNavigationPromise()
|
|
]);
|
|
watcher.dispose();
|
|
if (error)
|
|
throw error;
|
|
return watcher.navigationResponse();
|
|
}
|
|
|
|
/**
|
|
* @param {!Protocol.Page.lifecycleEventPayload} event
|
|
*/
|
|
_onLifecycleEvent(event) {
|
|
const frame = this._frames.get(event.frameId);
|
|
if (!frame)
|
|
return;
|
|
frame._onLifecycleEvent(event.loaderId, event.name);
|
|
this.emit(FrameManager.Events.LifecycleEvent, frame);
|
|
}
|
|
|
|
/**
|
|
* @param {string} frameId
|
|
*/
|
|
_onFrameStoppedLoading(frameId) {
|
|
const frame = this._frames.get(frameId);
|
|
if (!frame)
|
|
return;
|
|
frame._onLoadingStopped();
|
|
this.emit(FrameManager.Events.LifecycleEvent, frame);
|
|
}
|
|
|
|
/**
|
|
* @param {!Protocol.Page.FrameTree} frameTree
|
|
*/
|
|
_handleFrameTree(frameTree) {
|
|
if (frameTree.frame.parentId)
|
|
this._onFrameAttached(frameTree.frame.id, frameTree.frame.parentId);
|
|
this._onFrameNavigated(frameTree.frame);
|
|
if (!frameTree.childFrames)
|
|
return;
|
|
|
|
for (const child of frameTree.childFrames)
|
|
this._handleFrameTree(child);
|
|
}
|
|
|
|
/**
|
|
* @return {!Puppeteer.Page}
|
|
*/
|
|
page() {
|
|
return this._page;
|
|
}
|
|
|
|
/**
|
|
* @return {!Frame}
|
|
*/
|
|
mainFrame() {
|
|
return this._mainFrame;
|
|
}
|
|
|
|
/**
|
|
* @return {!Array<!Frame>}
|
|
*/
|
|
frames() {
|
|
return Array.from(this._frames.values());
|
|
}
|
|
|
|
/**
|
|
* @param {!string} frameId
|
|
* @return {?Frame}
|
|
*/
|
|
frame(frameId) {
|
|
return this._frames.get(frameId) || null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} frameId
|
|
* @param {?string} parentFrameId
|
|
*/
|
|
_onFrameAttached(frameId, parentFrameId) {
|
|
if (this._frames.has(frameId))
|
|
return;
|
|
assert(parentFrameId);
|
|
const parentFrame = this._frames.get(parentFrameId);
|
|
const frame = new Frame(this, this._client, parentFrame, frameId);
|
|
this._frames.set(frame._id, frame);
|
|
this.emit(FrameManager.Events.FrameAttached, frame);
|
|
}
|
|
|
|
/**
|
|
* @param {!Protocol.Page.Frame} framePayload
|
|
*/
|
|
_onFrameNavigated(framePayload) {
|
|
const isMainFrame = !framePayload.parentId;
|
|
let frame = isMainFrame ? this._mainFrame : this._frames.get(framePayload.id);
|
|
assert(isMainFrame || frame, 'We either navigate top level or have old version of the navigated frame');
|
|
|
|
// Detach all child frames first.
|
|
if (frame) {
|
|
for (const child of frame.childFrames())
|
|
this._removeFramesRecursively(child);
|
|
}
|
|
|
|
// Update or create main frame.
|
|
if (isMainFrame) {
|
|
if (frame) {
|
|
// Update frame id to retain frame identity on cross-process navigation.
|
|
this._frames.delete(frame._id);
|
|
frame._id = framePayload.id;
|
|
} else {
|
|
// Initial main frame navigation.
|
|
frame = new Frame(this, this._client, null, framePayload.id);
|
|
}
|
|
this._frames.set(framePayload.id, frame);
|
|
this._mainFrame = frame;
|
|
}
|
|
|
|
// Update frame payload.
|
|
frame._navigated(framePayload);
|
|
|
|
this.emit(FrameManager.Events.FrameNavigated, frame);
|
|
}
|
|
|
|
/**
|
|
* @param {string} frameId
|
|
* @param {string} url
|
|
*/
|
|
_onFrameNavigatedWithinDocument(frameId, url) {
|
|
const frame = this._frames.get(frameId);
|
|
if (!frame)
|
|
return;
|
|
frame._navigatedWithinDocument(url);
|
|
this.emit(FrameManager.Events.FrameNavigatedWithinDocument, frame);
|
|
this.emit(FrameManager.Events.FrameNavigated, frame);
|
|
}
|
|
|
|
/**
|
|
* @param {string} frameId
|
|
*/
|
|
_onFrameDetached(frameId) {
|
|
const frame = this._frames.get(frameId);
|
|
if (frame)
|
|
this._removeFramesRecursively(frame);
|
|
}
|
|
|
|
_onExecutionContextCreated(contextPayload) {
|
|
const frameId = contextPayload.auxData ? contextPayload.auxData.frameId : null;
|
|
const frame = this._frames.get(frameId) || null;
|
|
/** @type {!ExecutionContext} */
|
|
const context = new ExecutionContext(this._client, contextPayload, frame);
|
|
this._contextIdToContext.set(contextPayload.id, context);
|
|
if (frame)
|
|
frame._addExecutionContext(context);
|
|
}
|
|
|
|
/**
|
|
* @param {number} executionContextId
|
|
*/
|
|
_onExecutionContextDestroyed(executionContextId) {
|
|
const context = this._contextIdToContext.get(executionContextId);
|
|
if (!context)
|
|
return;
|
|
this._contextIdToContext.delete(executionContextId);
|
|
if (context.frame())
|
|
context.frame()._removeExecutionContext(context);
|
|
}
|
|
|
|
_onExecutionContextsCleared() {
|
|
for (const context of this._contextIdToContext.values()) {
|
|
if (context.frame())
|
|
context.frame()._removeExecutionContext(context);
|
|
}
|
|
this._contextIdToContext.clear();
|
|
}
|
|
|
|
/**
|
|
* @param {number} contextId
|
|
* @return {!ExecutionContext}
|
|
*/
|
|
executionContextById(contextId) {
|
|
const context = this._contextIdToContext.get(contextId);
|
|
assert(context, 'INTERNAL ERROR: missing context with id = ' + contextId);
|
|
return context;
|
|
}
|
|
|
|
/**
|
|
* @param {!Frame} frame
|
|
*/
|
|
_removeFramesRecursively(frame) {
|
|
for (const child of frame.childFrames())
|
|
this._removeFramesRecursively(child);
|
|
frame._detach();
|
|
this._frames.delete(frame._id);
|
|
this.emit(FrameManager.Events.FrameDetached, frame);
|
|
}
|
|
}
|
|
|
|
/** @enum {string} */
|
|
FrameManager.Events = {
|
|
FrameAttached: 'frameattached',
|
|
FrameNavigated: 'framenavigated',
|
|
FrameDetached: 'framedetached',
|
|
LifecycleEvent: 'lifecycleevent',
|
|
FrameNavigatedWithinDocument: 'framenavigatedwithindocument',
|
|
ExecutionContextCreated: 'executioncontextcreated',
|
|
ExecutionContextDestroyed: 'executioncontextdestroyed',
|
|
};
|
|
|
|
/**
|
|
* @unrestricted
|
|
*/
|
|
class Frame {
|
|
/**
|
|
* @param {!FrameManager} frameManager
|
|
* @param {!Puppeteer.CDPSession} client
|
|
* @param {?Frame} parentFrame
|
|
* @param {string} frameId
|
|
*/
|
|
constructor(frameManager, client, parentFrame, frameId) {
|
|
this._frameManager = frameManager;
|
|
this._client = client;
|
|
this._parentFrame = parentFrame;
|
|
this._url = '';
|
|
this._id = frameId;
|
|
this._detached = false;
|
|
|
|
/** @type {?Promise<!Puppeteer.ElementHandle>} */
|
|
this._documentPromise = null;
|
|
/** @type {!Promise<!ExecutionContext>} */
|
|
this._contextPromise;
|
|
this._contextResolveCallback = null;
|
|
this._setDefaultContext(null);
|
|
|
|
|
|
/** @type {!Set<!WaitTask>} */
|
|
this._waitTasks = new Set();
|
|
this._loaderId = '';
|
|
/** @type {!Set<string>} */
|
|
this._lifecycleEvents = new Set();
|
|
|
|
/** @type {!Set<!Frame>} */
|
|
this._childFrames = new Set();
|
|
if (this._parentFrame)
|
|
this._parentFrame._childFrames.add(this);
|
|
}
|
|
|
|
/**
|
|
* @param {!ExecutionContext} context
|
|
*/
|
|
_addExecutionContext(context) {
|
|
if (context._isDefault)
|
|
this._setDefaultContext(context);
|
|
}
|
|
|
|
/**
|
|
* @param {!ExecutionContext} context
|
|
*/
|
|
_removeExecutionContext(context) {
|
|
if (context._isDefault)
|
|
this._setDefaultContext(null);
|
|
}
|
|
|
|
/**
|
|
* @param {?ExecutionContext} context
|
|
*/
|
|
_setDefaultContext(context) {
|
|
if (context) {
|
|
this._contextResolveCallback.call(null, context);
|
|
this._contextResolveCallback = null;
|
|
for (const waitTask of this._waitTasks)
|
|
waitTask.rerun();
|
|
} else {
|
|
this._documentPromise = null;
|
|
this._contextPromise = new Promise(fulfill => {
|
|
this._contextResolveCallback = fulfill;
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {string} url
|
|
* @param {!{referer?: string, timeout?: number, waitUntil?: string|!Array<string>}=} options
|
|
* @return {!Promise<?Puppeteer.Response>}
|
|
*/
|
|
async goto(url, options) {
|
|
return await this._frameManager.navigateFrame(this, url, options);
|
|
}
|
|
|
|
/**
|
|
* @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
|
|
* @return {!Promise<?Puppeteer.Response>}
|
|
*/
|
|
async waitForNavigation(options) {
|
|
return await this._frameManager.waitForFrameNavigation(this, options);
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<!ExecutionContext>}
|
|
*/
|
|
executionContext() {
|
|
return this._contextPromise;
|
|
}
|
|
|
|
/**
|
|
* @param {function()|string} pageFunction
|
|
* @param {!Array<*>} args
|
|
* @return {!Promise<!Puppeteer.JSHandle>}
|
|
*/
|
|
async evaluateHandle(pageFunction, ...args) {
|
|
const context = await this._contextPromise;
|
|
return context.evaluateHandle(pageFunction, ...args);
|
|
}
|
|
|
|
/**
|
|
* @param {Function|string} pageFunction
|
|
* @param {!Array<*>} args
|
|
* @return {!Promise<*>}
|
|
*/
|
|
async evaluate(pageFunction, ...args) {
|
|
const context = await this._contextPromise;
|
|
return context.evaluate(pageFunction, ...args);
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @return {!Promise<?Puppeteer.ElementHandle>}
|
|
*/
|
|
async $(selector) {
|
|
const document = await this._document();
|
|
const value = await document.$(selector);
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
async _document() {
|
|
if (this._documentPromise)
|
|
return this._documentPromise;
|
|
this._documentPromise = this._contextPromise.then(async context => {
|
|
const document = await context.evaluateHandle('document');
|
|
return document.asElement();
|
|
});
|
|
return this._documentPromise;
|
|
}
|
|
|
|
/**
|
|
* @param {string} expression
|
|
* @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
|
|
*/
|
|
async $x(expression) {
|
|
const document = await this._document();
|
|
const value = await document.$x(expression);
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {Function|string} pageFunction
|
|
* @param {!Array<*>} args
|
|
* @return {!Promise<(!Object|undefined)>}
|
|
*/
|
|
async $eval(selector, pageFunction, ...args) {
|
|
const document = await this._document();
|
|
return document.$eval(selector, pageFunction, ...args);
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {Function|string} pageFunction
|
|
* @param {!Array<*>} args
|
|
* @return {!Promise<(!Object|undefined)>}
|
|
*/
|
|
async $$eval(selector, pageFunction, ...args) {
|
|
const document = await this._document();
|
|
const value = await document.$$eval(selector, pageFunction, ...args);
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
|
|
*/
|
|
async $$(selector) {
|
|
const document = await this._document();
|
|
const value = await document.$$(selector);
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<String>}
|
|
*/
|
|
async content() {
|
|
return await this.evaluate(() => {
|
|
let retVal = '';
|
|
if (document.doctype)
|
|
retVal = new XMLSerializer().serializeToString(document.doctype);
|
|
if (document.documentElement)
|
|
retVal += document.documentElement.outerHTML;
|
|
return retVal;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @param {string} html
|
|
* @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
|
|
*/
|
|
async setContent(html, options = {}) {
|
|
const {
|
|
waitUntil = ['load'],
|
|
timeout = 30000,
|
|
} = options;
|
|
// We rely upon the fact that document.open() will reset frame lifecycle with "init"
|
|
// lifecycle event. @see https://crrev.com/608658
|
|
await this.evaluate(html => {
|
|
document.open();
|
|
document.write(html);
|
|
document.close();
|
|
}, html);
|
|
const watcher = new LifecycleWatcher(this._frameManager, this, waitUntil, timeout);
|
|
const error = await Promise.race([
|
|
watcher.timeoutOrTerminationPromise(),
|
|
watcher.lifecyclePromise(),
|
|
]);
|
|
watcher.dispose();
|
|
if (error)
|
|
throw error;
|
|
}
|
|
|
|
/**
|
|
* @return {string}
|
|
*/
|
|
name() {
|
|
return this._name || '';
|
|
}
|
|
|
|
/**
|
|
* @return {string}
|
|
*/
|
|
url() {
|
|
return this._url;
|
|
}
|
|
|
|
/**
|
|
* @return {?Frame}
|
|
*/
|
|
parentFrame() {
|
|
return this._parentFrame;
|
|
}
|
|
|
|
/**
|
|
* @return {!Array.<!Frame>}
|
|
*/
|
|
childFrames() {
|
|
return Array.from(this._childFrames);
|
|
}
|
|
|
|
/**
|
|
* @return {boolean}
|
|
*/
|
|
isDetached() {
|
|
return this._detached;
|
|
}
|
|
|
|
/**
|
|
* @param {!{url?: string, path?: string, content?: string, type?: string}} options
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
async addScriptTag(options) {
|
|
const {
|
|
url = null,
|
|
path = null,
|
|
content = null,
|
|
type = ''
|
|
} = options;
|
|
if (url !== null) {
|
|
try {
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addScriptUrl, url, type)).asElement();
|
|
} catch (error) {
|
|
throw new Error(`Loading script from ${url} failed`);
|
|
}
|
|
}
|
|
|
|
if (path !== null) {
|
|
let contents = await readFileAsync(path, 'utf8');
|
|
contents += '//# sourceURL=' + path.replace(/\n/g, '');
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addScriptContent, contents, type)).asElement();
|
|
}
|
|
|
|
if (content !== null) {
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addScriptContent, content, type)).asElement();
|
|
}
|
|
|
|
throw new Error('Provide an object with a `url`, `path` or `content` property');
|
|
|
|
/**
|
|
* @param {string} url
|
|
* @param {string} type
|
|
* @return {!Promise<!HTMLElement>}
|
|
*/
|
|
async function addScriptUrl(url, type) {
|
|
const script = document.createElement('script');
|
|
script.src = url;
|
|
if (type)
|
|
script.type = type;
|
|
const promise = new Promise((res, rej) => {
|
|
script.onload = res;
|
|
script.onerror = rej;
|
|
});
|
|
document.head.appendChild(script);
|
|
await promise;
|
|
return script;
|
|
}
|
|
|
|
/**
|
|
* @param {string} content
|
|
* @param {string} type
|
|
* @return {!HTMLElement}
|
|
*/
|
|
function addScriptContent(content, type = 'text/javascript') {
|
|
const script = document.createElement('script');
|
|
script.type = type;
|
|
script.text = content;
|
|
let error = null;
|
|
script.onerror = e => error = e;
|
|
document.head.appendChild(script);
|
|
if (error)
|
|
throw error;
|
|
return script;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {!{url?: string, path?: string, content?: string}} options
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
async addStyleTag(options) {
|
|
const {
|
|
url = null,
|
|
path = null,
|
|
content = null
|
|
} = options;
|
|
if (url !== null) {
|
|
try {
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addStyleUrl, url)).asElement();
|
|
} catch (error) {
|
|
throw new Error(`Loading style from ${url} failed`);
|
|
}
|
|
}
|
|
|
|
if (path !== null) {
|
|
let contents = await readFileAsync(path, 'utf8');
|
|
contents += '/*# sourceURL=' + path.replace(/\n/g, '') + '*/';
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addStyleContent, contents)).asElement();
|
|
}
|
|
|
|
if (content !== null) {
|
|
const context = await this._contextPromise;
|
|
return (await context.evaluateHandle(addStyleContent, content)).asElement();
|
|
}
|
|
|
|
throw new Error('Provide an object with a `url`, `path` or `content` property');
|
|
|
|
/**
|
|
* @param {string} url
|
|
* @return {!Promise<!HTMLElement>}
|
|
*/
|
|
async function addStyleUrl(url) {
|
|
const link = document.createElement('link');
|
|
link.rel = 'stylesheet';
|
|
link.href = url;
|
|
const promise = new Promise((res, rej) => {
|
|
link.onload = res;
|
|
link.onerror = rej;
|
|
});
|
|
document.head.appendChild(link);
|
|
await promise;
|
|
return link;
|
|
}
|
|
|
|
/**
|
|
* @param {string} content
|
|
* @return {!Promise<!HTMLElement>}
|
|
*/
|
|
async function addStyleContent(content) {
|
|
const style = document.createElement('style');
|
|
style.type = 'text/css';
|
|
style.appendChild(document.createTextNode(content));
|
|
const promise = new Promise((res, rej) => {
|
|
style.onload = res;
|
|
style.onerror = rej;
|
|
});
|
|
document.head.appendChild(style);
|
|
await promise;
|
|
return style;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {!{delay?: number, button?: "left"|"right"|"middle", clickCount?: number}=} options
|
|
*/
|
|
async click(selector, options) {
|
|
const handle = await this.$(selector);
|
|
assert(handle, 'No node found for selector: ' + selector);
|
|
await handle.click(options);
|
|
await handle.dispose();
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
*/
|
|
async focus(selector) {
|
|
const handle = await this.$(selector);
|
|
assert(handle, 'No node found for selector: ' + selector);
|
|
await handle.focus();
|
|
await handle.dispose();
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
*/
|
|
async hover(selector) {
|
|
const handle = await this.$(selector);
|
|
assert(handle, 'No node found for selector: ' + selector);
|
|
await handle.hover();
|
|
await handle.dispose();
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {!Array<string>} values
|
|
* @return {!Promise<!Array<string>>}
|
|
*/
|
|
select(selector, ...values){
|
|
for (const value of values)
|
|
assert(helper.isString(value), 'Values must be strings. Found value "' + value + '" of type "' + (typeof value) + '"');
|
|
return this.$eval(selector, (element, values) => {
|
|
if (element.nodeName.toLowerCase() !== 'select')
|
|
throw new Error('Element is not a <select> element.');
|
|
|
|
const options = Array.from(element.options);
|
|
element.value = undefined;
|
|
for (const option of options) {
|
|
option.selected = values.includes(option.value);
|
|
if (option.selected && !element.multiple)
|
|
break;
|
|
}
|
|
element.dispatchEvent(new Event('input', { 'bubbles': true }));
|
|
element.dispatchEvent(new Event('change', { 'bubbles': true }));
|
|
return options.filter(option => option.selected).map(option => option.value);
|
|
}, values);
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
*/
|
|
async tap(selector) {
|
|
const handle = await this.$(selector);
|
|
assert(handle, 'No node found for selector: ' + selector);
|
|
await handle.tap();
|
|
await handle.dispose();
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {string} text
|
|
* @param {{delay: (number|undefined)}=} options
|
|
*/
|
|
async type(selector, text, options) {
|
|
const handle = await this.$(selector);
|
|
assert(handle, 'No node found for selector: ' + selector);
|
|
await handle.type(text, options);
|
|
await handle.dispose();
|
|
}
|
|
|
|
/**
|
|
* @param {(string|number|Function)} selectorOrFunctionOrTimeout
|
|
* @param {!Object=} options
|
|
* @param {!Array<*>} args
|
|
* @return {!Promise<!Puppeteer.JSHandle>}
|
|
*/
|
|
waitFor(selectorOrFunctionOrTimeout, options = {}, ...args) {
|
|
const xPathPattern = '//';
|
|
|
|
if (helper.isString(selectorOrFunctionOrTimeout)) {
|
|
const string = /** @type {string} */ (selectorOrFunctionOrTimeout);
|
|
if (string.startsWith(xPathPattern))
|
|
return this.waitForXPath(string, options);
|
|
return this.waitForSelector(string, options);
|
|
}
|
|
if (helper.isNumber(selectorOrFunctionOrTimeout))
|
|
return new Promise(fulfill => setTimeout(fulfill, /** @type {number} */ (selectorOrFunctionOrTimeout)));
|
|
if (typeof selectorOrFunctionOrTimeout === 'function')
|
|
return this.waitForFunction(selectorOrFunctionOrTimeout, options, ...args);
|
|
return Promise.reject(new Error('Unsupported target type: ' + (typeof selectorOrFunctionOrTimeout)));
|
|
}
|
|
|
|
/**
|
|
* @param {string} selector
|
|
* @param {!{visible?: boolean, hidden?: boolean, timeout?: number}=} options
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
waitForSelector(selector, options) {
|
|
return this._waitForSelectorOrXPath(selector, false, options);
|
|
}
|
|
|
|
/**
|
|
* @param {string} xpath
|
|
* @param {!{visible?: boolean, hidden?: boolean, timeout?: number}=} options
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
waitForXPath(xpath, options) {
|
|
return this._waitForSelectorOrXPath(xpath, true, options);
|
|
}
|
|
|
|
/**
|
|
* @param {Function|string} pageFunction
|
|
* @param {!{polling?: string|number, timeout?: number}=} options
|
|
* @return {!Promise<!Puppeteer.JSHandle>}
|
|
*/
|
|
waitForFunction(pageFunction, options = {}, ...args) {
|
|
const {
|
|
polling = 'raf',
|
|
timeout = 30000
|
|
} = options;
|
|
return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<string>}
|
|
*/
|
|
async title() {
|
|
return this.evaluate(() => document.title);
|
|
}
|
|
|
|
/**
|
|
* @param {string} selectorOrXPath
|
|
* @param {boolean} isXPath
|
|
* @param {!{visible?: boolean, hidden?: boolean, timeout?: number}=} options
|
|
* @return {!Promise<!Puppeteer.ElementHandle>}
|
|
*/
|
|
_waitForSelectorOrXPath(selectorOrXPath, isXPath, options = {}) {
|
|
const {
|
|
visible: waitForVisible = false,
|
|
hidden: waitForHidden = false,
|
|
timeout = 30000,
|
|
} = options;
|
|
const polling = waitForVisible || waitForHidden ? 'raf' : 'mutation';
|
|
const title = `${isXPath ? 'XPath' : 'selector'} "${selectorOrXPath}"${waitForHidden ? ' to be hidden' : ''}`;
|
|
return new WaitTask(this, predicate, title, polling, timeout, selectorOrXPath, isXPath, waitForVisible, waitForHidden).promise;
|
|
|
|
/**
|
|
* @param {string} selectorOrXPath
|
|
* @param {boolean} isXPath
|
|
* @param {boolean} waitForVisible
|
|
* @param {boolean} waitForHidden
|
|
* @return {?Node|boolean}
|
|
*/
|
|
function predicate(selectorOrXPath, isXPath, waitForVisible, waitForHidden) {
|
|
const node = isXPath
|
|
? document.evaluate(selectorOrXPath, document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue
|
|
: document.querySelector(selectorOrXPath);
|
|
if (!node)
|
|
return waitForHidden;
|
|
if (!waitForVisible && !waitForHidden)
|
|
return node;
|
|
const element = /** @type {Element} */ (node.nodeType === Node.TEXT_NODE ? node.parentElement : node);
|
|
|
|
const style = window.getComputedStyle(element);
|
|
const isVisible = style && style.visibility !== 'hidden' && hasVisibleBoundingBox();
|
|
const success = (waitForVisible === isVisible || waitForHidden === !isVisible);
|
|
return success ? node : null;
|
|
|
|
/**
|
|
* @return {boolean}
|
|
*/
|
|
function hasVisibleBoundingBox() {
|
|
const rect = element.getBoundingClientRect();
|
|
return !!(rect.top || rect.bottom || rect.width || rect.height);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {!Protocol.Page.Frame} framePayload
|
|
*/
|
|
_navigated(framePayload) {
|
|
this._name = framePayload.name;
|
|
// TODO(lushnikov): remove this once requestInterception has loaderId exposed.
|
|
this._navigationURL = framePayload.url;
|
|
this._url = framePayload.url;
|
|
}
|
|
|
|
/**
|
|
* @param {string} url
|
|
*/
|
|
_navigatedWithinDocument(url) {
|
|
this._url = url;
|
|
}
|
|
|
|
/**
|
|
* @param {string} loaderId
|
|
* @param {string} name
|
|
*/
|
|
_onLifecycleEvent(loaderId, name) {
|
|
if (name === 'init') {
|
|
this._loaderId = loaderId;
|
|
this._lifecycleEvents.clear();
|
|
}
|
|
this._lifecycleEvents.add(name);
|
|
}
|
|
|
|
_onLoadingStopped() {
|
|
this._lifecycleEvents.add('DOMContentLoaded');
|
|
this._lifecycleEvents.add('load');
|
|
}
|
|
|
|
_detach() {
|
|
for (const waitTask of this._waitTasks)
|
|
waitTask.terminate(new Error('waitForFunction failed: frame got detached.'));
|
|
this._detached = true;
|
|
if (this._parentFrame)
|
|
this._parentFrame._childFrames.delete(this);
|
|
this._parentFrame = null;
|
|
}
|
|
}
|
|
helper.tracePublicAPI(Frame);
|
|
|
|
class WaitTask {
|
|
/**
|
|
* @param {!Frame} frame
|
|
* @param {Function|string} predicateBody
|
|
* @param {string|number} polling
|
|
* @param {number} timeout
|
|
* @param {!Array<*>} args
|
|
*/
|
|
constructor(frame, predicateBody, title, polling, timeout, ...args) {
|
|
if (helper.isString(polling))
|
|
assert(polling === 'raf' || polling === 'mutation', 'Unknown polling option: ' + polling);
|
|
else if (helper.isNumber(polling))
|
|
assert(polling > 0, 'Cannot poll with non-positive interval: ' + polling);
|
|
else
|
|
throw new Error('Unknown polling options: ' + polling);
|
|
|
|
this._frame = frame;
|
|
this._polling = polling;
|
|
this._timeout = timeout;
|
|
this._predicateBody = helper.isString(predicateBody) ? 'return (' + predicateBody + ')' : 'return (' + predicateBody + ')(...args)';
|
|
this._args = args;
|
|
this._runCount = 0;
|
|
frame._waitTasks.add(this);
|
|
this.promise = new Promise((resolve, reject) => {
|
|
this._resolve = resolve;
|
|
this._reject = reject;
|
|
});
|
|
// Since page navigation requires us to re-install the pageScript, we should track
|
|
// timeout on our end.
|
|
if (timeout) {
|
|
const timeoutError = new TimeoutError(`waiting for ${title} failed: timeout ${timeout}ms exceeded`);
|
|
this._timeoutTimer = setTimeout(() => this.terminate(timeoutError), timeout);
|
|
}
|
|
this.rerun();
|
|
}
|
|
|
|
/**
|
|
* @param {!Error} error
|
|
*/
|
|
terminate(error) {
|
|
this._terminated = true;
|
|
this._reject(error);
|
|
this._cleanup();
|
|
}
|
|
|
|
async rerun() {
|
|
const runCount = ++this._runCount;
|
|
/** @type {?Puppeteer.JSHandle} */
|
|
let success = null;
|
|
let error = null;
|
|
try {
|
|
success = await (await this._frame.executionContext()).evaluateHandle(waitForPredicatePageFunction, this._predicateBody, this._polling, this._timeout, ...this._args);
|
|
} catch (e) {
|
|
error = e;
|
|
}
|
|
|
|
if (this._terminated || runCount !== this._runCount) {
|
|
if (success)
|
|
await success.dispose();
|
|
return;
|
|
}
|
|
|
|
// Ignore timeouts in pageScript - we track timeouts ourselves.
|
|
// If the frame's execution context has already changed, `frame.evaluate` will
|
|
// throw an error - ignore this predicate run altogether.
|
|
if (!error && await this._frame.evaluate(s => !s, success).catch(e => true)) {
|
|
await success.dispose();
|
|
return;
|
|
}
|
|
|
|
// When the page is navigated, the promise is rejected.
|
|
// We will try again in the new execution context.
|
|
if (error && error.message.includes('Execution context was destroyed'))
|
|
return;
|
|
|
|
// We could have tried to evaluate in a context which was already
|
|
// destroyed.
|
|
if (error && error.message.includes('Cannot find context with specified id'))
|
|
return;
|
|
|
|
if (error)
|
|
this._reject(error);
|
|
else
|
|
this._resolve(success);
|
|
|
|
this._cleanup();
|
|
}
|
|
|
|
_cleanup() {
|
|
clearTimeout(this._timeoutTimer);
|
|
this._frame._waitTasks.delete(this);
|
|
this._runningTask = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {string} predicateBody
|
|
* @param {string} polling
|
|
* @param {number} timeout
|
|
* @return {!Promise<*>}
|
|
*/
|
|
async function waitForPredicatePageFunction(predicateBody, polling, timeout, ...args) {
|
|
const predicate = new Function('...args', predicateBody);
|
|
let timedOut = false;
|
|
if (timeout)
|
|
setTimeout(() => timedOut = true, timeout);
|
|
if (polling === 'raf')
|
|
return await pollRaf();
|
|
if (polling === 'mutation')
|
|
return await pollMutation();
|
|
if (typeof polling === 'number')
|
|
return await pollInterval(polling);
|
|
|
|
/**
|
|
* @return {!Promise<*>}
|
|
*/
|
|
function pollMutation() {
|
|
const success = predicate.apply(null, args);
|
|
if (success)
|
|
return Promise.resolve(success);
|
|
|
|
let fulfill;
|
|
const result = new Promise(x => fulfill = x);
|
|
const observer = new MutationObserver(mutations => {
|
|
if (timedOut) {
|
|
observer.disconnect();
|
|
fulfill();
|
|
}
|
|
const success = predicate.apply(null, args);
|
|
if (success) {
|
|
observer.disconnect();
|
|
fulfill(success);
|
|
}
|
|
});
|
|
observer.observe(document, {
|
|
childList: true,
|
|
subtree: true,
|
|
attributes: true
|
|
});
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<*>}
|
|
*/
|
|
function pollRaf() {
|
|
let fulfill;
|
|
const result = new Promise(x => fulfill = x);
|
|
onRaf();
|
|
return result;
|
|
|
|
function onRaf() {
|
|
if (timedOut) {
|
|
fulfill();
|
|
return;
|
|
}
|
|
const success = predicate.apply(null, args);
|
|
if (success)
|
|
fulfill(success);
|
|
else
|
|
requestAnimationFrame(onRaf);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {number} pollInterval
|
|
* @return {!Promise<*>}
|
|
*/
|
|
function pollInterval(pollInterval) {
|
|
let fulfill;
|
|
const result = new Promise(x => fulfill = x);
|
|
onTimeout();
|
|
return result;
|
|
|
|
function onTimeout() {
|
|
if (timedOut) {
|
|
fulfill();
|
|
return;
|
|
}
|
|
const success = predicate.apply(null, args);
|
|
if (success)
|
|
fulfill(success);
|
|
else
|
|
setTimeout(onTimeout, pollInterval);
|
|
}
|
|
}
|
|
}
|
|
|
|
function assertNoLegacyNavigationOptions(options) {
|
|
assert(options['networkIdleTimeout'] === undefined, 'ERROR: networkIdleTimeout option is no longer supported.');
|
|
assert(options['networkIdleInflight'] === undefined, 'ERROR: networkIdleInflight option is no longer supported.');
|
|
assert(options.waitUntil !== 'networkidle', 'ERROR: "networkidle" option is no longer supported. Use "networkidle2" instead');
|
|
}
|
|
|
|
class LifecycleWatcher {
|
|
/**
|
|
* @param {!FrameManager} frameManager
|
|
* @param {!Puppeteer.Frame} frame
|
|
* @param {string|!Array<string>} waitUntil
|
|
* @param {number} timeout
|
|
*/
|
|
constructor(frameManager, frame, waitUntil, timeout) {
|
|
if (Array.isArray(waitUntil))
|
|
waitUntil = waitUntil.slice();
|
|
else if (typeof waitUntil === 'string')
|
|
waitUntil = [waitUntil];
|
|
this._expectedLifecycle = waitUntil.map(value => {
|
|
const protocolEvent = puppeteerToProtocolLifecycle[value];
|
|
assert(protocolEvent, 'Unknown value for options.waitUntil: ' + value);
|
|
return protocolEvent;
|
|
});
|
|
|
|
this._frameManager = frameManager;
|
|
this._networkManager = frameManager._networkManager;
|
|
this._frame = frame;
|
|
this._initialLoaderId = frame._loaderId;
|
|
this._timeout = timeout;
|
|
/** @type {?Puppeteer.Request} */
|
|
this._navigationRequest = null;
|
|
this._eventListeners = [
|
|
helper.addEventListener(frameManager._client, CDPSession.Events.Disconnected, () => this._terminate(new Error('Navigation failed because browser has disconnected!'))),
|
|
helper.addEventListener(this._frameManager, FrameManager.Events.LifecycleEvent, this._checkLifecycleComplete.bind(this)),
|
|
helper.addEventListener(this._frameManager, FrameManager.Events.FrameNavigatedWithinDocument, this._navigatedWithinDocument.bind(this)),
|
|
helper.addEventListener(this._frameManager, FrameManager.Events.FrameDetached, this._onFrameDetached.bind(this)),
|
|
helper.addEventListener(this._networkManager, NetworkManager.Events.Request, this._onRequest.bind(this)),
|
|
];
|
|
|
|
this._sameDocumentNavigationPromise = new Promise(fulfill => {
|
|
this._sameDocumentNavigationCompleteCallback = fulfill;
|
|
});
|
|
|
|
this._lifecyclePromise = new Promise(fulfill => {
|
|
this._lifecycleCallback = fulfill;
|
|
});
|
|
|
|
this._newDocumentNavigationPromise = new Promise(fulfill => {
|
|
this._newDocumentNavigationCompleteCallback = fulfill;
|
|
});
|
|
|
|
this._timeoutPromise = this._createTimeoutPromise();
|
|
this._terminationPromise = new Promise(fulfill => {
|
|
this._terminationCallback = fulfill;
|
|
});
|
|
this._checkLifecycleComplete();
|
|
}
|
|
|
|
/**
|
|
* @param {!Puppeteer.Request} request
|
|
*/
|
|
_onRequest(request) {
|
|
if (request.frame() !== this._frame || !request.isNavigationRequest())
|
|
return;
|
|
this._navigationRequest = request;
|
|
}
|
|
|
|
/**
|
|
* @param {!Puppeteer.Frame} frame
|
|
*/
|
|
_onFrameDetached(frame) {
|
|
if (this._frame === frame) {
|
|
this._terminationCallback.call(null, new Error('Navigating frame was detached'));
|
|
return;
|
|
}
|
|
this._checkLifecycleComplete();
|
|
}
|
|
|
|
/**
|
|
* @return {?Puppeteer.Response}
|
|
*/
|
|
navigationResponse() {
|
|
return this._navigationRequest ? this._navigationRequest.response() : null;
|
|
}
|
|
|
|
/**
|
|
* @param {!Error} error
|
|
*/
|
|
_terminate(error) {
|
|
this._terminationCallback.call(null, error);
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<?Error>}
|
|
*/
|
|
sameDocumentNavigationPromise() {
|
|
return this._sameDocumentNavigationPromise;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<?Error>}
|
|
*/
|
|
newDocumentNavigationPromise() {
|
|
return this._newDocumentNavigationPromise;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise}
|
|
*/
|
|
lifecyclePromise() {
|
|
return this._lifecyclePromise;
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<?Error>}
|
|
*/
|
|
timeoutOrTerminationPromise() {
|
|
return Promise.race([this._timeoutPromise, this._terminationPromise]);
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<?Error>}
|
|
*/
|
|
_createTimeoutPromise() {
|
|
if (!this._timeout)
|
|
return new Promise(() => {});
|
|
const errorMessage = 'Navigation Timeout Exceeded: ' + this._timeout + 'ms exceeded';
|
|
return new Promise(fulfill => this._maximumTimer = setTimeout(fulfill, this._timeout))
|
|
.then(() => new TimeoutError(errorMessage));
|
|
}
|
|
|
|
/**
|
|
* @param {!Puppeteer.Frame} frame
|
|
*/
|
|
_navigatedWithinDocument(frame) {
|
|
if (frame !== this._frame)
|
|
return;
|
|
this._hasSameDocumentNavigation = true;
|
|
this._checkLifecycleComplete();
|
|
}
|
|
|
|
_checkLifecycleComplete() {
|
|
// We expect navigation to commit.
|
|
if (!checkLifecycle(this._frame, this._expectedLifecycle))
|
|
return;
|
|
this._lifecycleCallback();
|
|
if (this._frame._loaderId === this._initialLoaderId && !this._hasSameDocumentNavigation)
|
|
return;
|
|
if (this._hasSameDocumentNavigation)
|
|
this._sameDocumentNavigationCompleteCallback();
|
|
if (this._frame._loaderId !== this._initialLoaderId)
|
|
this._newDocumentNavigationCompleteCallback();
|
|
|
|
/**
|
|
* @param {!Puppeteer.Frame} frame
|
|
* @param {!Array<string>} expectedLifecycle
|
|
* @return {boolean}
|
|
*/
|
|
function checkLifecycle(frame, expectedLifecycle) {
|
|
for (const event of expectedLifecycle) {
|
|
if (!frame._lifecycleEvents.has(event))
|
|
return false;
|
|
}
|
|
for (const child of frame.childFrames()) {
|
|
if (!checkLifecycle(child, expectedLifecycle))
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
dispose() {
|
|
helper.removeEventListeners(this._eventListeners);
|
|
clearTimeout(this._maximumTimer);
|
|
}
|
|
}
|
|
|
|
const puppeteerToProtocolLifecycle = {
|
|
'load': 'load',
|
|
'domcontentloaded': 'DOMContentLoaded',
|
|
'networkidle0': 'networkIdle',
|
|
'networkidle2': 'networkAlmostIdle',
|
|
};
|
|
|
|
module.exports = {FrameManager, Frame};
|