/** * @license * Copyright 2019 Google Inc. * SPDX-License-Identifier: Apache-2.0 */ import type {Protocol} from 'devtools-protocol'; import type {CDPSession} from '../api/CDPSession.js'; import type {JSHandle} from '../api/JSHandle.js'; import {Realm} from '../api/Realm.js'; import type {TimeoutSettings} from '../common/TimeoutSettings.js'; import type {BindingPayload, EvaluateFunc, HandleFor} from '../common/types.js'; import {debugError, withSourcePuppeteerURLIfNone} from '../common/util.js'; import {Deferred} from '../util/Deferred.js'; import {disposeSymbol} from '../util/disposable.js'; import {Mutex} from '../util/Mutex.js'; import type {Binding} from './Binding.js'; import {ExecutionContext, createCdpHandle} from './ExecutionContext.js'; import type {CdpFrame} from './Frame.js'; import type {MAIN_WORLD, PUPPETEER_WORLD} from './IsolatedWorlds.js'; import {addPageBinding} from './utils.js'; import type {CdpWebWorker} from './WebWorker.js'; /** * @internal */ export interface PageBinding { name: string; pptrFunction: Function; } /** * @internal */ export interface IsolatedWorldChart { [key: string]: IsolatedWorld; [MAIN_WORLD]: IsolatedWorld; [PUPPETEER_WORLD]: IsolatedWorld; } /** * @internal */ export class IsolatedWorld extends Realm { #context = Deferred.create(); // Set of bindings that have been registered in the current context. #contextBindings = new Set(); // Contains mapping from functions that should be bound to Puppeteer functions. #bindings = new Map(); get _bindings(): Map { return this.#bindings; } readonly #frameOrWorker: CdpFrame | CdpWebWorker; constructor( frameOrWorker: CdpFrame | CdpWebWorker, timeoutSettings: TimeoutSettings ) { super(timeoutSettings); this.#frameOrWorker = frameOrWorker; this.frameUpdated(); } get environment(): CdpFrame | CdpWebWorker { return this.#frameOrWorker; } frameUpdated(): void { this.client.on('Runtime.bindingCalled', this.#onBindingCalled); } get client(): CDPSession { return this.#frameOrWorker.client; } clearContext(): void { // The message has to match the CDP message expected by the WaitTask class. this.#context?.reject(new Error('Execution context was destroyed')); this.#context = Deferred.create(); if ('clearDocumentHandle' in this.#frameOrWorker) { this.#frameOrWorker.clearDocumentHandle(); } } setContext(context: ExecutionContext): void { this.#contextBindings.clear(); this.#context.resolve(context); void this.taskManager.rerunAll(); } hasContext(): boolean { return this.#context.resolved(); } #executionContext(): Promise { if (this.disposed) { throw new Error( `Execution context is not available in detached frame "${this.environment.url()}" (are you trying to evaluate?)` ); } if (this.#context === null) { throw new Error(`Execution content promise is missing`); } return this.#context.valueOrThrow(); } async evaluateHandle< Params extends unknown[], Func extends EvaluateFunc = EvaluateFunc, >( pageFunction: Func | string, ...args: Params ): Promise>>> { pageFunction = withSourcePuppeteerURLIfNone( this.evaluateHandle.name, pageFunction ); const context = await this.#executionContext(); return await context.evaluateHandle(pageFunction, ...args); } async evaluate< Params extends unknown[], Func extends EvaluateFunc = EvaluateFunc, >( pageFunction: Func | string, ...args: Params ): Promise>> { pageFunction = withSourcePuppeteerURLIfNone( this.evaluate.name, pageFunction ); let context = this.#context.value(); if (!context || !(context instanceof ExecutionContext)) { context = await this.#executionContext(); } return await context.evaluate(pageFunction, ...args); } // If multiple waitFor are set up asynchronously, we need to wait for the // first one to set up the binding in the page before running the others. #mutex = new Mutex(); async _addBindingToContext( context: ExecutionContext, name: string ): Promise { if (this.#contextBindings.has(name)) { return; } using _ = await this.#mutex.acquire(); try { await context._client.send( 'Runtime.addBinding', context._contextName ? { name, executionContextName: context._contextName, } : { name, executionContextId: context._contextId, } ); await context.evaluate(addPageBinding, 'internal', name); this.#contextBindings.add(name); } catch (error) { // We could have tried to evaluate in a context which was already // destroyed. This happens, for example, if the page is navigated while // we are trying to add the binding if (error instanceof Error) { // Destroyed context. if (error.message.includes('Execution context was destroyed')) { return; } // Missing context. if (error.message.includes('Cannot find context with specified id')) { return; } } debugError(error); } } #onBindingCalled = async ( event: Protocol.Runtime.BindingCalledEvent ): Promise => { let payload: BindingPayload; try { payload = JSON.parse(event.payload); } catch { // The binding was either called by something in the page or it was // called before our wrapper was initialized. return; } const {type, name, seq, args, isTrivial} = payload; if (type !== 'internal') { return; } if (!this.#contextBindings.has(name)) { return; } try { const context = await this.#context.valueOrThrow(); if (event.executionContextId !== context._contextId) { return; } const binding = this._bindings.get(name); await binding?.run(context, seq, args, isTrivial); } catch (err) { debugError(err); } }; override async adoptBackendNode( backendNodeId?: Protocol.DOM.BackendNodeId ): Promise> { const executionContext = await this.#executionContext(); const {object} = await this.client.send('DOM.resolveNode', { backendNodeId: backendNodeId, executionContextId: executionContext._contextId, }); return createCdpHandle(this, object) as JSHandle; } async adoptHandle>(handle: T): Promise { if (handle.realm === this) { // If the context has already adopted this handle, clone it so downstream // disposal doesn't become an issue. return (await handle.evaluateHandle(value => { return value; })) as unknown as T; } const nodeInfo = await this.client.send('DOM.describeNode', { objectId: handle.id, }); return (await this.adoptBackendNode(nodeInfo.node.backendNodeId)) as T; } async transferHandle>(handle: T): Promise { if (handle.realm === this) { return handle; } // Implies it's a primitive value, probably. if (handle.remoteObject().objectId === undefined) { return handle; } const info = await this.client.send('DOM.describeNode', { objectId: handle.remoteObject().objectId, }); const newHandle = (await this.adoptBackendNode( info.node.backendNodeId )) as T; await handle.dispose(); return newHandle; } [disposeSymbol](): void { super[disposeSymbol](); this.client.off('Runtime.bindingCalled', this.#onBindingCalled); } }