From c64e02e7c2d99d18f0fa0d6abf711df6c1d4e70c Mon Sep 17 00:00:00 2001 From: Andrey Lushnikov Date: Fri, 8 Feb 2019 18:54:11 -0800 Subject: [PATCH] refactor(firefox): introduce FrameManager (#3964) Split out frame management from Page into FrameManager. FrameManager will keep track of page's frames and DOMWorlds. --- experimental/puppeteer-firefox/lib/Events.js | 7 + .../puppeteer-firefox/lib/FrameManager.js | 732 +++++++++++++++++ .../puppeteer-firefox/lib/JSHandle.js | 2 +- experimental/puppeteer-firefox/lib/Page.js | 774 +----------------- experimental/puppeteer-firefox/lib/api.js | 2 +- 5 files changed, 783 insertions(+), 734 deletions(-) create mode 100644 experimental/puppeteer-firefox/lib/FrameManager.js diff --git a/experimental/puppeteer-firefox/lib/Events.js b/experimental/puppeteer-firefox/lib/Events.js index 3158d8de..f00c9032 100644 --- a/experimental/puppeteer-firefox/lib/Events.js +++ b/experimental/puppeteer-firefox/lib/Events.js @@ -24,6 +24,13 @@ const Events = { Connection: { Disconnected: Symbol('Events.Connection.Disconnected'), }, + + FrameManager: { + Load: Symbol('Events.FrameManager.Load'), + DOMContentLoaded: Symbol('Events.FrameManager.DOMContentLoaded'), + FrameAttached: Symbol('Events.FrameManager.FrameAttached'), + FrameDetached: Symbol('Events.FrameManager.FrameDetached'), + } }; module.exports = {Events}; diff --git a/experimental/puppeteer-firefox/lib/FrameManager.js b/experimental/puppeteer-firefox/lib/FrameManager.js new file mode 100644 index 00000000..f9d872ca --- /dev/null +++ b/experimental/puppeteer-firefox/lib/FrameManager.js @@ -0,0 +1,732 @@ +const {helper, assert} = require('./helper'); +const {TimeoutError} = require('./Errors'); +const fs = require('fs'); +const util = require('util'); +const EventEmitter = require('events'); +const {Events} = require('./Events'); +const {ExecutionContext} = require('./ExecutionContext'); + +const readFileAsync = util.promisify(fs.readFile); + +class FrameManager extends EventEmitter { + /** + * @param {PageSession} session + * @param {Page} page + */ + constructor(session, page) { + super(); + this._session = session; + this._page = page; + this._mainFrame = null; + this._frames = new Map(); + this._eventListeners = [ + helper.addEventListener(this._session, 'Page.eventFired', this._onEventFired.bind(this)), + helper.addEventListener(this._session, 'Page.frameAttached', this._onFrameAttached.bind(this)), + helper.addEventListener(this._session, 'Page.frameDetached', this._onFrameDetached.bind(this)), + ]; + } + + frame(frameId) { + return this._frames.get(frameId); + } + + mainFrame() { + return this._mainFrame; + } + + frames() { + /** @type {!Array} */ + let frames = []; + collect(this._mainFrame); + return frames; + + function collect(frame) { + frames.push(frame); + for (const subframe of frame._children) + collect(subframe); + } + } + + _onFrameAttached(params) { + const frame = new Frame(this._session, this, this._page, params.frameId); + const parentFrame = this._frames.get(params.parentFrameId) || null; + if (parentFrame) { + frame._parentFrame = parentFrame; + parentFrame._children.add(frame); + } else { + assert(!this._mainFrame, 'INTERNAL ERROR: re-attaching main frame!'); + this._mainFrame = frame; + } + this._frames.set(params.frameId, frame); + this.emit(Events.FrameManager.FrameAttached, frame); + } + + _onFrameDetached(params) { + const frame = this._frames.get(params.frameId); + this._frames.delete(params.frameId); + frame._detach(); + this.emit(Events.FrameManager.FrameDetached, frame); + } + + _onEventFired({frameId, name}) { + const frame = this._frames.get(frameId); + frame._firedEvents.add(name.toLowerCase()); + if (frame === this._mainFrame) { + if (name === 'load') + this.emit(Events.FrameManager.Load); + else if (name === 'DOMContentLoaded') + this.emit(Events.FrameManager.DOMContentLoaded); + } + } + + dispose() { + helper.removeEventListeners(this._eventListeners); + } +} + +class Frame { + /** + * @param {*} session + * @param {!Page} page + * @param {string} frameId + */ + constructor(session, frameManager, page, frameId) { + this._session = session; + this._frameManager = frameManager; + this._page = page; + this._frameId = frameId; + /** @type {?Frame} */ + this._parentFrame = null; + this._url = ''; + this._name = ''; + /** @type {!Set} */ + this._children = new Set(); + this._isDetached = false; + + this._firedEvents = new Set(); + + /** @type {!Set} */ + this._waitTasks = new Set(); + this._documentPromise = null; + + this._executionContext = new ExecutionContext(this._session, this, this._frameId); + } + + async executionContext() { + return this._executionContext; + } + + /** + * @param {string} selector + * @param {!{delay?: number, button?: string, 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 + * @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} 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(); + } + + _detach() { + this._parentFrame._children.delete(this); + this._parentFrame = null; + this._isDetached = true; + for (const waitTask of this._waitTasks) + waitTask.terminate(new Error('waitForFunction failed: frame got detached.')); + } + + _navigated(url, name, navigationId) { + this._url = url; + this._name = name; + this._lastCommittedNavigationId = navigationId; + this._documentPromise = null; + this._firedEvents.clear(); + } + + /** + * @param {string} selector + * @param {!Array} values + * @return {!Promise>} + */ + 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 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|number|Function)} selectorOrFunctionOrTimeout - * @param {!{polling?: string|number, timeout?: number, visible?: boolean, hidden?: boolean}=} options - * @param {!Array<*>} args - * @return {!Promise} - */ - 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 {Function|string} pageFunction - * @param {!{polling?: string|number, timeout?: number}=} options - * @return {!Promise} - */ - waitForFunction(pageFunction, options = {}, ...args) { - const { - polling = 'raf', - timeout = 30000 - } = options; - return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise; - } - - /** - * @param {string} selector - * @param {!{timeout?: number, visible?: boolean, hidden?: boolean}=} options - * @return {!Promise} - */ - waitForSelector(selector, options) { - return this._waitForSelectorOrXPath(selector, false, options); - } - - /** - * @param {string} xpath - * @param {!{timeout?: number, visible?: boolean, hidden?: boolean}=} options - * @return {!Promise} - */ - waitForXPath(xpath, options) { - return this._waitForSelectorOrXPath(xpath, true, options); - } - - /** - * @param {string} selectorOrXPath - * @param {boolean} isXPath - * @param {!{timeout?: number, visible?: boolean, hidden?: boolean}=} options - * @return {!Promise} - */ - _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); - } - } - } - - /** - * @return {!Promise} - */ - 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 - */ - async setContent(html) { - await this.evaluate(html => { - document.open(); - document.write(html); - document.close(); - }, html); - } - - async evaluate(pageFunction, ...args) { - return this._executionContext.evaluate(pageFunction, ...args); - } - - _document() { - if (!this._documentPromise) - this._documentPromise = this.evaluateHandle('document').then(handle => handle.asElement()); - return this._documentPromise; - } - - /** - * @param {string} selector - * @return {!Promise} - */ - async $(selector) { - const document = await this._document(); - return document.$(selector); - } - - /** - * @param {string} selector - * @return {!Promise>} - */ - async $$(selector) { - const document = await this._document(); - return document.$$(selector); - } - - /** - * @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(); - return document.$$eval(selector, pageFunction, ...args); - } - - /** - * @param {string} expression - * @return {!Promise>} - */ - async $x(expression) { - const document = await this._document(); - return document.$x(expression); - } - - async evaluateHandle(pageFunction, ...args) { - return this._executionContext.evaluateHandle(pageFunction, ...args); - } - - /** - * @param {!{content?: string, path?: string, type?: string, url?: string}} options - * @return {!Promise} - */ - async addScriptTag(options) { - if (typeof options.url === 'string') { - const url = options.url; - try { - return (await this.evaluateHandle(addScriptUrl, url, options.type)).asElement(); - } catch (error) { - throw new Error(`Loading script from ${url} failed`); - } - } - - if (typeof options.path === 'string') { - let contents = await readFileAsync(options.path, 'utf8'); - contents += '//# sourceURL=' + options.path.replace(/\n/g, ''); - return (await this.evaluateHandle(addScriptContent, contents, options.type)).asElement(); - } - - if (typeof options.content === 'string') { - return (await this.evaluateHandle(addScriptContent, options.content, options.type)).asElement(); - } - - throw new Error('Provide an object with a `url`, `path` or `content` property'); - - /** - * @param {string} url - * @param {string} type - * @return {!Promise} - */ - 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 {!{content?: string, path?: string, url?: string}} options - * @return {!Promise} - */ - async addStyleTag(options) { - if (typeof options.url === 'string') { - const url = options.url; - try { - return (await this.evaluateHandle(addStyleUrl, url)).asElement(); - } catch (error) { - throw new Error(`Loading style from ${url} failed`); - } - } - - if (typeof options.path === 'string') { - let contents = await readFileAsync(options.path, 'utf8'); - contents += '/*# sourceURL=' + options.path.replace(/\n/g, '') + '*/'; - return (await this.evaluateHandle(addStyleContent, contents)).asElement(); - } - - if (typeof options.content === 'string') { - return (await this.evaluateHandle(addStyleContent, options.content)).asElement(); - } - - throw new Error('Provide an object with a `url`, `path` or `content` property'); - - /** - * @param {string} url - * @return {!Promise} - */ - 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} - */ - 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; - } - } - - /** - * @return {!Promise} - */ - async title() { - return this.evaluate(() => document.title); - } - - name() { - return this._name; - } - - isDetached() { - return this._isDetached; - } - - childFrames() { - return Array.from(this._children); - } - - url() { - return this._url; - } - - parentFrame() { - return this._parentFrame; - } -} - -/** - * @internal - */ -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 {?JSHandle} */ - let success = null; - let error = null; - try { - success = await this._frame.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. - // Try again right away. - if (error && error.message.includes('Execution context was destroyed')) { - this.rerun(); - 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); - } - } -} - /** * @internal */ @@ -1410,4 +720,4 @@ class NavigationWatchdog { } } -module.exports = {Page, Frame, ConsoleMessage}; +module.exports = {Page, ConsoleMessage}; diff --git a/experimental/puppeteer-firefox/lib/api.js b/experimental/puppeteer-firefox/lib/api.js index 5f140373..c29c62da 100644 --- a/experimental/puppeteer-firefox/lib/api.js +++ b/experimental/puppeteer-firefox/lib/api.js @@ -6,7 +6,7 @@ module.exports = { Dialog: require('./Dialog').Dialog, ElementHandle: require('./JSHandle').ElementHandle, ExecutionContext: require('./ExecutionContext').ExecutionContext, - Frame: require('./Page').Frame, + Frame: require('./FrameManager').Frame, JSHandle: require('./JSHandle').JSHandle, Keyboard: require('./Input').Keyboard, Mouse: require('./Input').Mouse,