/** * 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 { CRSession } from './crConnection'; import { helper } from '../helper'; import { getExceptionMessage, releaseObject } from './crProtocolHelper'; import { Protocol } from './protocol'; import * as js from '../javascript'; import * as debugSupport from '../debug/debugSupport'; import { rewriteErrorMessage } from '../debug/stackTrace'; import { parseEvaluationResultValue } from '../utilityScriptSerializers'; export class CRExecutionContext implements js.ExecutionContextDelegate { _client: CRSession; _contextId: number; constructor(client: CRSession, contextPayload: Protocol.Runtime.ExecutionContextDescription) { this._client = client; this._contextId = contextPayload.id; } async rawEvaluate(expression: string): Promise { const { exceptionDetails, result: remoteObject } = await this._client.send('Runtime.evaluate', { expression: debugSupport.ensureSourceUrl(expression), contextId: this._contextId, }).catch(rewriteError); if (exceptionDetails) throw new Error('Evaluation failed: ' + getExceptionMessage(exceptionDetails)); return remoteObject.objectId!; } async evaluate(context: js.ExecutionContext, returnByValue: boolean, pageFunction: Function | string, ...args: any[]): Promise { if (helper.isString(pageFunction)) { return this._callOnUtilityScript(context, `evaluate`, [ { value: debugSupport.ensureSourceUrl(pageFunction) }, ], returnByValue, () => { }); } if (typeof pageFunction !== 'function') throw new Error(`Expected to get |string| or |function| as the first argument, but got "${pageFunction}" instead.`); const { functionText, values, handles, dispose } = await js.prepareFunctionCall(pageFunction, context, args); return this._callOnUtilityScript(context, 'callFunction', [ { value: functionText }, ...values.map(value => ({ value })), ...handles, ], returnByValue, dispose); } private async _callOnUtilityScript(context: js.ExecutionContext, method: string, args: Protocol.Runtime.CallArgument[], returnByValue: boolean, dispose: () => void) { try { const utilityScript = await context.utilityScript(); const { exceptionDetails, result: remoteObject } = await this._client.send('Runtime.callFunctionOn', { functionDeclaration: `function (...args) { return this.${method}(...args) }` + debugSupport.generateSourceUrl(), objectId: utilityScript._objectId, arguments: [ { value: returnByValue }, ...args ], returnByValue, awaitPromise: true, userGesture: true }).catch(rewriteError); if (exceptionDetails) throw new Error('Evaluation failed: ' + getExceptionMessage(exceptionDetails)); return returnByValue ? parseEvaluationResultValue(remoteObject.value) : context.createHandle(remoteObject); } finally { dispose(); } } async getProperties(handle: js.JSHandle): Promise> { const objectId = handle._objectId; if (!objectId) return new Map(); const response = await this._client.send('Runtime.getProperties', { objectId, ownProperties: true }); const result = new Map(); for (const property of response.result) { if (!property.enumerable || !property.value) continue; result.set(property.name, handle._context.createHandle(property.value)); } return result; } createHandle(context: js.ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject): js.JSHandle { return new js.JSHandle(context, remoteObject.subtype || remoteObject.type, remoteObject.objectId, potentiallyUnserializableValue(remoteObject)); } async releaseHandle(handle: js.JSHandle): Promise { if (!handle._objectId) return; await releaseObject(this._client, handle._objectId); } async handleJSONValue(handle: js.JSHandle): Promise { if (handle._objectId) { return this._callOnUtilityScript(handle._context, `jsonValue`, [ { objectId: handle._objectId }, ], true, () => {}); } return handle._value; } } function rewriteError(error: Error): Protocol.Runtime.evaluateReturnValue { if (error.message.includes('Object reference chain is too long')) return {result: {type: 'undefined'}}; if (error.message.includes('Object couldn\'t be returned by value')) return {result: {type: 'undefined'}}; if (error.message.endsWith('Cannot find context with specified id') || error.message.endsWith('Inspected target navigated or closed') || error.message.endsWith('Execution context was destroyed.')) throw new Error('Execution context was destroyed, most likely because of a navigation.'); if (error instanceof TypeError && error.message.startsWith('Converting circular structure to JSON')) rewriteErrorMessage(error, error.message + ' Are you passing a nested JSHandle?'); throw error; } function potentiallyUnserializableValue(remoteObject: Protocol.Runtime.RemoteObject): any { const value = remoteObject.value; const unserializableValue = remoteObject.unserializableValue; return unserializableValue ? js.parseUnserializableValue(unserializableValue) : value; }