/** * Copyright 2023 Google Inc. All rights reserved. * * 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 Bidi from 'chromium-bidi/lib/cjs/protocol/protocol.js'; import type {Awaitable, FlattenHandle} from '../common/types.js'; import {debugError} from '../common/util.js'; import {assert} from '../util/assert.js'; import {Deferred} from '../util/Deferred.js'; import {interpolateFunction, stringifyFunction} from '../util/Function.js'; import type {BidiConnection} from './Connection.js'; import {BidiDeserializer} from './Deserializer.js'; import type {BidiFrame} from './Frame.js'; import {BidiSerializer} from './Serializer.js'; type SendArgsChannel = (value: [id: number, args: Args]) => void; type SendResolveChannel = ( value: [id: number, resolve: (ret: FlattenHandle>) => void] ) => void; type SendRejectChannel = ( value: [id: number, reject: (error: unknown) => void] ) => void; interface RemotePromiseCallbacks { resolve: Deferred; reject: Deferred; } /** * @internal */ export class ExposeableFunction { readonly #frame; readonly name; readonly #apply; readonly #channels; readonly #callerInfos = new Map< string, Map >(); constructor( frame: BidiFrame, name: string, apply: (...args: Args) => Awaitable ) { this.#frame = frame; this.name = name; this.#apply = apply; this.#channels = { args: `__puppeteer__${this.#frame._id}_page_exposeFunction_${ this.name }_args`, resolve: `__puppeteer__${this.#frame._id}_page_exposeFunction_${ this.name }_resolve`, reject: `__puppeteer__${this.#frame._id}_page_exposeFunction_${ this.name }_reject`, }; } async expose(): Promise { const connection = this.#connection; const channelArguments = this.#channelArguments; const {name} = this; // TODO(jrandolf): Implement cleanup with removePreloadScript. connection.on( Bidi.ChromiumBidi.Script.EventNames.Message, this.#handleArgumentsMessage ); connection.on( Bidi.ChromiumBidi.Script.EventNames.Message, this.#handleResolveMessage ); connection.on( Bidi.ChromiumBidi.Script.EventNames.Message, this.#handleRejectMessage ); const functionDeclaration = stringifyFunction( interpolateFunction( ( sendArgs: SendArgsChannel, sendResolve: SendResolveChannel, sendReject: SendRejectChannel ) => { let id = 0; Object.assign(globalThis, { [PLACEHOLDER('name') as string]: function (...args: Args) { return new Promise>>( (resolve, reject) => { sendArgs([id, args]); sendResolve([id, resolve]); sendReject([id, reject]); ++id; } ); }, }); }, {name: JSON.stringify(name)} ) ); await connection.send('script.addPreloadScript', { functionDeclaration, arguments: channelArguments, }); await connection.send('script.callFunction', { functionDeclaration, arguments: channelArguments, awaitPromise: false, target: this.#frame.mainRealm().realm.target, }); } #handleArgumentsMessage = async (params: Bidi.Script.MessageParameters) => { if (params.channel !== this.#channels.args) { return; } const connection = this.#connection; const {callbacks, remoteValue} = this.#getCallbacksAndRemoteValue(params); const args = remoteValue.value?.[1]; assert(args); try { const result = await this.#apply(...BidiDeserializer.deserialize(args)); await connection.send('script.callFunction', { functionDeclaration: stringifyFunction(([_, resolve]: any, result) => { resolve(result); }), arguments: [ (await callbacks.resolve.valueOrThrow()) as Bidi.Script.LocalValue, BidiSerializer.serializeRemoteValue(result), ], awaitPromise: false, target: params.source, }); } catch (error) { try { if (error instanceof Error) { await connection.send('script.callFunction', { functionDeclaration: stringifyFunction( ( [_, reject]: any, name: string, message: string, stack?: string ) => { const error = new Error(message); error.name = name; if (stack) { error.stack = stack; } reject(error); } ), arguments: [ (await callbacks.reject.valueOrThrow()) as Bidi.Script.LocalValue, BidiSerializer.serializeRemoteValue(error.name), BidiSerializer.serializeRemoteValue(error.message), BidiSerializer.serializeRemoteValue(error.stack), ], awaitPromise: false, target: params.source, }); } else { await connection.send('script.callFunction', { functionDeclaration: stringifyFunction( ([_, reject]: any, error: unknown) => { reject(error); } ), arguments: [ (await callbacks.reject.valueOrThrow()) as Bidi.Script.LocalValue, BidiSerializer.serializeRemoteValue(error), ], awaitPromise: false, target: params.source, }); } } catch (error) { debugError(error); } } }; get #connection(): BidiConnection { return this.#frame.context().connection; } get #channelArguments() { return [ { type: 'channel' as const, value: { channel: this.#channels.args, ownership: Bidi.Script.ResultOwnership.Root, }, }, { type: 'channel' as const, value: { channel: this.#channels.resolve, ownership: Bidi.Script.ResultOwnership.Root, }, }, { type: 'channel' as const, value: { channel: this.#channels.reject, ownership: Bidi.Script.ResultOwnership.Root, }, }, ]; } #handleResolveMessage = (params: Bidi.Script.MessageParameters) => { if (params.channel !== this.#channels.resolve) { return; } const {callbacks, remoteValue} = this.#getCallbacksAndRemoteValue(params); callbacks.resolve.resolve(remoteValue); }; #handleRejectMessage = (params: Bidi.Script.MessageParameters) => { if (params.channel !== this.#channels.reject) { return; } const {callbacks, remoteValue} = this.#getCallbacksAndRemoteValue(params); callbacks.reject.resolve(remoteValue); }; #getCallbacksAndRemoteValue(params: Bidi.Script.MessageParameters) { const {data, source} = params; assert(data.type === 'array'); assert(data.value); const callerIdRemote = data.value[0]; assert(callerIdRemote); assert(callerIdRemote.type === 'number'); assert(typeof callerIdRemote.value === 'number'); let bindingMap = this.#callerInfos.get(source.realm); if (!bindingMap) { bindingMap = new Map(); this.#callerInfos.set(source.realm, bindingMap); } const callerId = callerIdRemote.value; let callbacks = bindingMap.get(callerId); if (!callbacks) { callbacks = { resolve: new Deferred(), reject: new Deferred(), }; bindingMap.set(callerId, callbacks); } return {callbacks, remoteValue: data}; } }