/** * Copyright 2017 Google Inc. All rights reserved. * Modifications copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { EventEmitter } from 'events'; import * as dom from './dom'; import * as frames from './frames'; import { assert, debugError, helper } from './helper'; import * as input from './input'; import * as js from './javascript'; import * as network from './network'; import { Screenshotter } from './screenshotter'; import { TimeoutSettings } from './timeoutSettings'; import * as types from './types'; import { Events } from './events'; import { BrowserContext } from './browserContext'; import { ConsoleMessage, ConsoleMessageLocation } from './console'; import Injected from './injected/injected'; import * as accessibility from './accessibility'; export interface PageDelegate { readonly rawMouse: input.RawMouse; readonly rawKeyboard: input.RawKeyboard; reload(): Promise; goBack(): Promise; goForward(): Promise; exposeBinding(name: string, bindingFunction: string): Promise; evaluateOnNewDocument(source: string): Promise; closePage(runBeforeUnload: boolean): Promise; navigateFrame(frame: frames.Frame, url: string, referrer: string | undefined): Promise; needsLifecycleResetOnSetContent(): boolean; setExtraHTTPHeaders(extraHTTPHeaders: network.Headers): Promise; setViewport(viewport: types.Viewport): Promise; setEmulateMedia(mediaType: types.MediaType | null, colorScheme: types.ColorScheme | null): Promise; setCacheEnabled(enabled: boolean): Promise; setRequestInterception(enabled: boolean): Promise; setOfflineMode(enabled: boolean): Promise; authenticate(credentials: types.Credentials | null): Promise; getBoundingBoxForScreenshot(handle: dom.ElementHandle): Promise; canScreenshotOutsideViewport(): boolean; setBackgroundColor(color?: { r: number; g: number; b: number; a: number; }): Promise; takeScreenshot(format: string, options: types.ScreenshotOptions, viewport: types.Viewport): Promise; resetViewport(oldSize: types.Size): Promise; isElementHandle(remoteObject: any): boolean; adoptElementHandle(handle: dom.ElementHandle, to: dom.FrameExecutionContext): Promise>; getContentFrame(handle: dom.ElementHandle): Promise; // Only called for frame owner elements. getOwnerFrame(handle: dom.ElementHandle): Promise; getContentQuads(handle: dom.ElementHandle): Promise; layoutViewport(): Promise<{ width: number, height: number }>; setInputFiles(handle: dom.ElementHandle, files: types.FilePayload[]): Promise; getBoundingBox(handle: dom.ElementHandle): Promise; getAccessibilityTree(): Promise; } type PageState = { viewport: types.Viewport | null; mediaType: types.MediaType | null; colorScheme: types.ColorScheme | null; extraHTTPHeaders: network.Headers | null; cacheEnabled: boolean | null; interceptNetwork: boolean | null; offlineMode: boolean | null; credentials: types.Credentials | null; }; export type FileChooser = { element: dom.ElementHandle, multiple: boolean }; export class Page extends EventEmitter { private _closed = false; private _closedCallback: () => void; private _closedPromise: Promise; private _disconnected = false; private _disconnectedCallback: (e: Error) => void; readonly _disconnectedPromise: Promise; private _browserContext: BrowserContext; readonly keyboard: input.Keyboard; readonly mouse: input.Mouse; readonly _timeoutSettings: TimeoutSettings; readonly _delegate: PageDelegate; readonly _state: PageState; private _pageBindings = new Map(); readonly _screenshotter: Screenshotter; readonly _frameManager: frames.FrameManager; readonly accessibility: accessibility.Accessibility; constructor(delegate: PageDelegate, browserContext: BrowserContext) { super(); this._delegate = delegate; this._closedPromise = new Promise(f => this._closedCallback = f); this._disconnectedPromise = new Promise(f => this._disconnectedCallback = f); this._browserContext = browserContext; this._state = { viewport: browserContext._options.viewport || null, mediaType: null, colorScheme: null, extraHTTPHeaders: null, cacheEnabled: null, interceptNetwork: null, offlineMode: null, credentials: null }; this.accessibility = new accessibility.Accessibility(delegate.getAccessibilityTree.bind(delegate)); this.keyboard = new input.Keyboard(delegate.rawKeyboard); this.mouse = new input.Mouse(delegate.rawMouse, this.keyboard); this._timeoutSettings = new TimeoutSettings(); this._screenshotter = new Screenshotter(this); this._frameManager = new frames.FrameManager(this); } _didClose() { assert(!this._closed, 'Page closed twice'); this._closed = true; this.emit(Events.Page.Close); this._closedCallback(); } _didCrash() { const error = new Error('Page crashed!'); error.stack = ''; this.emit('error', error); } _didDisconnect() { assert(!this._disconnected, 'Page disconnected twice'); this._disconnected = true; this._disconnectedCallback(new Error('Target closed')); } async _onFileChooserOpened(handle: dom.ElementHandle) { const multiple = await handle.evaluate((element: HTMLInputElement) => !!element.multiple); if (!this.listenerCount(Events.Page.FileChooser)) { await handle.dispose(); return; } const fileChooser: FileChooser = { element: handle, multiple }; this.emit(Events.Page.FileChooser, fileChooser); } browserContext(): BrowserContext { return this._browserContext; } mainFrame(): frames.Frame { return this._frameManager.mainFrame(); } frames(): frames.Frame[] { return this._frameManager.frames(); } setDefaultNavigationTimeout(timeout: number) { this._timeoutSettings.setDefaultNavigationTimeout(timeout); } setDefaultTimeout(timeout: number) { this._timeoutSettings.setDefaultTimeout(timeout); } async $(selector: string): Promise | null> { return this.mainFrame().$(selector); } async waitForSelector(selector: string, options?: types.TimeoutOptions & { visibility?: types.Visibility }): Promise | null> { return this.mainFrame().waitForSelector(selector, options); } async _createSelector(name: string, handle: dom.ElementHandle): Promise { const mainContext = await this.mainFrame()._mainContext(); return mainContext.evaluate((injected: Injected, target: Element, name: string) => { return injected.engines.get(name).create(document.documentElement, target); }, await mainContext._injected(), handle, name); } evaluateHandle: types.EvaluateHandle = async (pageFunction, ...args) => { return this.mainFrame().evaluateHandle(pageFunction, ...args as any); } $eval: types.$Eval = async (selector, pageFunction, ...args) => { return this.mainFrame().$eval(selector, pageFunction, ...args as any); } $$eval: types.$$Eval = async (selector, pageFunction, ...args) => { return this.mainFrame().$$eval(selector, pageFunction, ...args as any); } async $$(selector: string): Promise[]> { return this.mainFrame().$$(selector); } async $x(expression: string): Promise[]> { return this.mainFrame().$x(expression); } async addScriptTag(options: { url?: string; path?: string; content?: string; type?: string; }): Promise { return this.mainFrame().addScriptTag(options); } async addStyleTag(options: { url?: string; path?: string; content?: string; }): Promise { return this.mainFrame().addStyleTag(options); } async exposeFunction(name: string, playwrightFunction: Function) { if (this._pageBindings.has(name)) throw new Error(`Failed to add page binding with name ${name}: window['${name}'] already exists!`); this._pageBindings.set(name, playwrightFunction); await this._delegate.exposeBinding(name, helper.evaluationString(addPageBinding, name)); function addPageBinding(bindingName: string) { const binding = (window as any)[bindingName]; (window as any)[bindingName] = (...args: any[]) => { const me = (window as any)[bindingName]; let callbacks = me['callbacks']; if (!callbacks) { callbacks = new Map(); me['callbacks'] = callbacks; } const seq = (me['lastSeq'] || 0) + 1; me['lastSeq'] = seq; const promise = new Promise((resolve, reject) => callbacks.set(seq, {resolve, reject})); binding(JSON.stringify({name: bindingName, seq, args})); return promise; }; } } setExtraHTTPHeaders(headers: network.Headers) { this._state.extraHTTPHeaders = {}; for (const key of Object.keys(headers)) { const value = headers[key]; assert(helper.isString(value), `Expected value of header "${key}" to be String, but "${typeof value}" is found.`); this._state.extraHTTPHeaders[key.toLowerCase()] = value; } return this._delegate.setExtraHTTPHeaders(headers); } async _onBindingCalled(payload: string, context: js.ExecutionContext) { const {name, seq, args} = JSON.parse(payload); let expression = null; try { const result = await this._pageBindings.get(name)(...args); expression = helper.evaluationString(deliverResult, name, seq, result); } catch (error) { if (error instanceof Error) expression = helper.evaluationString(deliverError, name, seq, error.message, error.stack); else expression = helper.evaluationString(deliverErrorValue, name, seq, error); } context.evaluate(expression).catch(debugError); function deliverResult(name: string, seq: number, result: any) { (window as any)[name]['callbacks'].get(seq).resolve(result); (window as any)[name]['callbacks'].delete(seq); } function deliverError(name: string, seq: number, message: string, stack: string) { const error = new Error(message); error.stack = stack; (window as any)[name]['callbacks'].get(seq).reject(error); (window as any)[name]['callbacks'].delete(seq); } function deliverErrorValue(name: string, seq: number, value: any) { (window as any)[name]['callbacks'].get(seq).reject(value); (window as any)[name]['callbacks'].delete(seq); } } _addConsoleMessage(type: string, args: js.JSHandle[], location: ConsoleMessageLocation, text?: string) { if (!this.listenerCount(Events.Page.Console)) { args.forEach(arg => arg.dispose()); return; } this.emit(Events.Page.Console, new ConsoleMessage(type, text, args, location)); } url(): string { return this.mainFrame().url(); } async content(): Promise { return this.mainFrame().content(); } async setContent(html: string, options?: frames.NavigateOptions): Promise { return this.mainFrame().setContent(html, options); } async goto(url: string, options?: frames.GotoOptions): Promise { return this.mainFrame().goto(url, options); } async reload(options?: frames.NavigateOptions): Promise { const waitPromise = this.waitForNavigation(options); await this._delegate.reload(); return waitPromise; } async waitForNavigation(options?: frames.WaitForNavigationOptions): Promise { return this.mainFrame().waitForNavigation(options); } async waitForLoadState(options?: frames.NavigateOptions): Promise { return this.mainFrame().waitForLoadState(options); } async waitForEvent(event: string, optionsOrPredicate: Function | (types.TimeoutOptions & { predicate?: Function }) = {}): Promise { if (typeof optionsOrPredicate === 'function') optionsOrPredicate = { predicate: optionsOrPredicate }; const { timeout = this._timeoutSettings.timeout(), predicate = () => true } = optionsOrPredicate; return helper.waitForEvent(this, event, (...args: any[]) => !!predicate(...args), timeout, this._disconnectedPromise); } async waitForRequest(urlOrPredicate: string | RegExp | ((r: network.Request) => boolean), options: types.TimeoutOptions = {}): Promise { const { timeout = this._timeoutSettings.timeout() } = options; return helper.waitForEvent(this, Events.Page.Request, (request: network.Request) => { if (helper.isString(urlOrPredicate) || urlOrPredicate instanceof RegExp) return helper.urlMatches(request.url(), urlOrPredicate); return urlOrPredicate(request); }, timeout, this._disconnectedPromise); } async waitForResponse(urlOrPredicate: string | RegExp | ((r: network.Response) => boolean), options: types.TimeoutOptions = {}): Promise { const { timeout = this._timeoutSettings.timeout() } = options; return helper.waitForEvent(this, Events.Page.Response, (response: network.Response) => { if (helper.isString(urlOrPredicate) || urlOrPredicate instanceof RegExp) return helper.urlMatches(response.url(), urlOrPredicate); return urlOrPredicate(response); }, timeout, this._disconnectedPromise); } async goBack(options?: frames.NavigateOptions): Promise { const waitPromise = this.waitForNavigation(options); const result = await this._delegate.goBack(); if (!result) { waitPromise.catch(() => {}); return null; } return waitPromise; } async goForward(options?: frames.NavigateOptions): Promise { const waitPromise = this.waitForNavigation(options); const result = await this._delegate.goForward(); if (!result) { waitPromise.catch(() => {}); return null; } return waitPromise; } async emulateMedia(options: { media?: types.MediaType, colorScheme?: types.ColorScheme }) { assert(!options.media || types.mediaTypes.has(options.media), 'Unsupported media: ' + options.media); assert(!options.colorScheme || types.colorSchemes.has(options.colorScheme), 'Unsupported color scheme: ' + options.colorScheme); if (options.media !== undefined) this._state.mediaType = options.media; if (options.colorScheme !== undefined) this._state.colorScheme = options.colorScheme; await this._delegate.setEmulateMedia(this._state.mediaType, this._state.colorScheme); } async setViewport(viewport: types.Viewport) { const oldIsMobile = this._state.viewport ? !!this._state.viewport.isMobile : false; const oldHasTouch = this._state.viewport ? !!this._state.viewport.hasTouch : false; const newIsMobile = !!viewport.isMobile; const newHasTouch = !!viewport.hasTouch; this._state.viewport = { ...viewport }; await this._delegate.setViewport(viewport); if (oldIsMobile !== newIsMobile || oldHasTouch !== newHasTouch) await this.reload(); } viewport(): types.Viewport | null { return this._state.viewport; } evaluate: types.Evaluate = async (pageFunction, ...args) => { return this.mainFrame().evaluate(pageFunction, ...args as any); } async evaluateOnNewDocument(pageFunction: Function | string, ...args: any[]) { const source = helper.evaluationString(pageFunction, ...args); await this._delegate.evaluateOnNewDocument(source); } async setCacheEnabled(enabled: boolean = true) { if (this._state.cacheEnabled === enabled) return; this._state.cacheEnabled = enabled; await this._delegate.setCacheEnabled(enabled); } async setRequestInterception(enabled: boolean) { if (this._state.interceptNetwork === enabled) return; this._state.interceptNetwork = enabled; await this._delegate.setRequestInterception(enabled); } async setOfflineMode(enabled: boolean) { if (this._state.offlineMode === enabled) return; this._state.offlineMode = enabled; await this._delegate.setOfflineMode(enabled); } async authenticate(credentials: types.Credentials | null) { this._state.credentials = credentials; await this._delegate.authenticate(credentials); } async screenshot(options?: types.ScreenshotOptions): Promise { return this._screenshotter.screenshotPage(options); } async title(): Promise { return this.mainFrame().title(); } async close(options: { runBeforeUnload: (boolean | undefined); } = {runBeforeUnload: undefined}) { if (this._closed) return; assert(!this._disconnected, 'Protocol error: Connection closed. Most likely the page has been closed.'); const runBeforeUnload = !!options.runBeforeUnload; await this._delegate.closePage(runBeforeUnload); if (!runBeforeUnload) await this._closedPromise; } isClosed(): boolean { return this._closed; } async click(selector: string, options?: frames.WaitForOptions & input.ClickOptions) { return this.mainFrame().click(selector, options); } async dblclick(selector: string, options?: frames.WaitForOptions & input.MultiClickOptions) { return this.mainFrame().dblclick(selector, options); } async tripleclick(selector: string, options?: frames.WaitForOptions & input.MultiClickOptions) { return this.mainFrame().tripleclick(selector, options); } async fill(selector: string, value: string, options?: frames.WaitForOptions) { return this.mainFrame().fill(selector, value, options); } async focus(selector: string, options?: frames.WaitForOptions) { return this.mainFrame().focus(selector, options); } async hover(selector: string, options?: frames.WaitForOptions & input.PointerActionOptions) { return this.mainFrame().hover(selector, options); } async select(selector: string, value: string | dom.ElementHandle | types.SelectOption | string[] | dom.ElementHandle[] | types.SelectOption[] | undefined, options?: frames.WaitForOptions): Promise { return this.mainFrame().select(selector, value, options); } async type(selector: string, text: string, options?: frames.WaitForOptions & { delay?: number }) { return this.mainFrame().type(selector, text, options); } async waitFor(selectorOrFunctionOrTimeout: (string | number | Function), options?: types.WaitForFunctionOptions & { visibility?: types.Visibility }, ...args: any[]): Promise { return this.mainFrame().waitFor(selectorOrFunctionOrTimeout, options, ...args); } async waitForFunction(pageFunction: Function | string, options?: types.WaitForFunctionOptions, ...args: any[]): Promise { return this.mainFrame().waitForFunction(pageFunction, options, ...args); } async $wait(selector: string, pageFunction: Function | string, options?: types.WaitForFunctionOptions, ...args: any[]): Promise { return this.mainFrame().$wait(selector, pageFunction, options, ...args); } }