/** * 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 * as types from './types'; import * as dom from './dom'; import { helper } from './helper'; import * as utilityScriptSource from './generated/utilityScriptSource'; import { InnerLogger } from './logger'; import * as debugSupport from './debug/debugSupport'; export interface ExecutionContextDelegate { evaluate(context: ExecutionContext, returnByValue: boolean, pageFunction: string | Function, ...args: any[]): Promise; rawEvaluate(pageFunction: string): Promise; getProperties(handle: JSHandle): Promise>; releaseHandle(handle: JSHandle): Promise; handleToString(handle: JSHandle, includeType: boolean): string; handleJSONValue(handle: JSHandle): Promise; } export class ExecutionContext { readonly _delegate: ExecutionContextDelegate; readonly _logger: InnerLogger; private _utilityScriptPromise: Promise | undefined; constructor(delegate: ExecutionContextDelegate, logger: InnerLogger) { this._delegate = delegate; this._logger = logger; } doEvaluateInternal(returnByValue: boolean, waitForNavigations: boolean, pageFunction: string | Function, ...args: any[]): Promise { return this._delegate.evaluate(this, returnByValue, pageFunction, ...args); } adoptIfNeeded(handle: JSHandle): Promise | null { return null; } async evaluateInternal(pageFunction: types.Func0): Promise; async evaluateInternal(pageFunction: types.Func1, arg: Arg): Promise; async evaluateInternal(pageFunction: never, ...args: never[]): Promise { return this.doEvaluateInternal(true /* returnByValue */, true /* waitForNavigations */, pageFunction, ...args); } async evaluateHandleInternal(pageFunction: types.Func0): Promise>; async evaluateHandleInternal(pageFunction: types.Func1, arg: Arg): Promise>; async evaluateHandleInternal(pageFunction: never, ...args: never[]): Promise { return this.doEvaluateInternal(false /* returnByValue */, true /* waitForNavigations */, pageFunction, ...args); } utilityScript(): Promise { if (!this._utilityScriptPromise) { const source = `new (${utilityScriptSource.source})()`; this._utilityScriptPromise = this._delegate.rawEvaluate(source).then(object => this.createHandle(object)); } return this._utilityScriptPromise; } createHandle(remoteObject: any): JSHandle { return new JSHandle(this, remoteObject); } } export type RemoteObject = { type?: string, subtype?: string, objectId?: string, value?: any }; export class JSHandle { readonly _context: ExecutionContext; readonly _remoteObject: RemoteObject; _disposed = false; constructor(context: ExecutionContext, remoteObject: RemoteObject) { this._context = context; this._remoteObject = remoteObject; } async evaluate(pageFunction: types.FuncOn, arg: Arg): Promise; async evaluate(pageFunction: types.FuncOn, arg?: any): Promise; async evaluate(pageFunction: types.FuncOn, arg: Arg): Promise { return this._context.doEvaluateInternal(true /* returnByValue */, true /* waitForNavigations */, pageFunction, this, arg); } async evaluateHandle(pageFunction: types.FuncOn, arg: Arg): Promise>; async evaluateHandle(pageFunction: types.FuncOn, arg?: any): Promise>; async evaluateHandle(pageFunction: types.FuncOn, arg: Arg): Promise> { return this._context.doEvaluateInternal(false /* returnByValue */, true /* waitForNavigations */, pageFunction, this, arg); } async getProperty(propertyName: string): Promise { const objectHandle = await this.evaluateHandle((object: any, propertyName) => { const result: any = {__proto__: null}; result[propertyName] = object[propertyName]; return result; }, propertyName); const properties = await objectHandle.getProperties(); const result = properties.get(propertyName)!; objectHandle.dispose(); return result; } getProperties(): Promise> { return this._context._delegate.getProperties(this); } jsonValue(): Promise { return this._context._delegate.handleJSONValue(this); } asElement(): dom.ElementHandle | null { return null; } async dispose() { if (this._disposed) return; this._disposed = true; await this._context._delegate.releaseHandle(this); } toString(): string { return this._context._delegate.handleToString(this, true /* includeType */); } } export async function prepareFunctionCall( pageFunction: Function, context: ExecutionContext, args: any[], toCallArgumentIfNeeded: (value: any) => { handle?: T, value?: any }): Promise<{ functionText: string, values: any[], handles: T[], dispose: () => void }> { const originalText = pageFunction.toString(); let functionText = originalText; try { new Function('(' + functionText + ')'); } catch (e1) { // This means we might have a function shorthand. Try another // time prefixing 'function '. if (functionText.startsWith('async ')) functionText = 'async function ' + functionText.substring('async '.length); else functionText = 'function ' + functionText; try { new Function('(' + functionText + ')'); } catch (e2) { // We tried hard to serialize, but there's a weird beast here. throw new Error('Passed function is not well-serializable!'); } } const guids: string[] = []; const handles: (Promise)[] = []; const toDispose: Promise[] = []; const pushHandle = (handle: Promise): string => { const guid = helper.guid(); guids.push(guid); handles.push(handle); return guid; }; const visited = new Set(); let error: string | undefined; const visit = (arg: any, depth: number): any => { if (!depth) { error = 'Argument nesting is too deep'; return; } if (visited.has(arg)) { error = 'Argument is a circular structure'; return; } if (Array.isArray(arg)) { visited.add(arg); const result = []; for (let i = 0; i < arg.length; ++i) result.push(visit(arg[i], depth - 1)); visited.delete(arg); return result; } if (arg && (typeof arg === 'object') && !(arg instanceof JSHandle)) { visited.add(arg); const result: any = {}; for (const name of Object.keys(arg)) result[name] = visit(arg[name], depth - 1); visited.delete(arg); return result; } if (arg && (arg instanceof JSHandle)) { if (arg._disposed) throw new Error('JSHandle is disposed!'); const adopted = context.adoptIfNeeded(arg); if (adopted === null) return pushHandle(Promise.resolve(arg)); toDispose.push(adopted); return pushHandle(adopted); } const { handle, value } = toCallArgumentIfNeeded(arg); if (handle) return pushHandle(Promise.resolve(handle)); return value; }; args = args.map(arg => visit(arg, 100)); if (error) throw new Error(error); const resolved = await Promise.all(handles); const resultHandles: T[] = []; for (let i = 0; i < resolved.length; i++) { const handle = resolved[i]; if (handle instanceof JSHandle) { if (handle._context !== context) throw new Error('JSHandles can be evaluated only in the context they were created!'); resultHandles.push(toCallArgumentIfNeeded(handle).handle!); } else { resultHandles.push(handle); } } const dispose = () => { toDispose.map(handlePromise => handlePromise.then(handle => handle.dispose())); }; functionText += await debugSupport.generateSourceMapUrl(originalText, functionText); return { functionText, values: [ args.length, ...args, guids.length, ...guids ], handles: resultHandles, dispose }; }