/** * Copyright 2018 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 { Protocol } from 'devtools-protocol'; import { CDPSession } from './Connection.js'; import { ConsoleMessageType } from './ConsoleMessage.js'; import { EvaluateHandleFn, SerializableOrJSHandle } from './EvalTypes.js'; import { EventEmitter } from './EventEmitter.js'; import { ExecutionContext } from './ExecutionContext.js'; import { debugError } from './util.js'; import { JSHandle } from './JSHandle.js'; /** * @internal */ export type ConsoleAPICalledCallback = ( eventType: ConsoleMessageType, handles: JSHandle[], trace: Protocol.Runtime.StackTrace ) => void; /** * @internal */ export type ExceptionThrownCallback = ( details: Protocol.Runtime.ExceptionDetails ) => void; type JSHandleFactory = (obj: Protocol.Runtime.RemoteObject) => JSHandle; /** * The WebWorker class represents a * {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API | WebWorker}. * * @remarks * The events `workercreated` and `workerdestroyed` are emitted on the page * object to signal the worker lifecycle. * * @example * ```js * page.on('workercreated', worker => console.log('Worker created: ' + worker.url())); * page.on('workerdestroyed', worker => console.log('Worker destroyed: ' + worker.url())); * * console.log('Current workers:'); * for (const worker of page.workers()) { * console.log(' ' + worker.url()); * } * ``` * * @public */ export class WebWorker extends EventEmitter { #client: CDPSession; #url: string; #executionContextPromise: Promise; #executionContextCallback!: (value: ExecutionContext) => void; /** * * @internal */ constructor( client: CDPSession, url: string, consoleAPICalled: ConsoleAPICalledCallback, exceptionThrown: ExceptionThrownCallback ) { super(); this.#client = client; this.#url = url; this.#executionContextPromise = new Promise((x) => { return (this.#executionContextCallback = x); }); let jsHandleFactory: JSHandleFactory; this.#client.once('Runtime.executionContextCreated', async (event) => { // eslint-disable-next-line @typescript-eslint/explicit-function-return-type jsHandleFactory = (remoteObject) => { return new JSHandle(executionContext, client, remoteObject); }; const executionContext = new ExecutionContext(client, event.context); this.#executionContextCallback(executionContext); }); // This might fail if the target is closed before we receive all execution contexts. this.#client.send('Runtime.enable').catch(debugError); this.#client.on('Runtime.consoleAPICalled', (event) => { return consoleAPICalled( event.type, event.args.map(jsHandleFactory), event.stackTrace ); }); this.#client.on('Runtime.exceptionThrown', (exception) => { return exceptionThrown(exception.exceptionDetails); }); } /** * @returns The URL of this web worker. */ url(): string { return this.#url; } /** * Returns the ExecutionContext the WebWorker runs in * @returns The ExecutionContext the web worker runs in. */ async executionContext(): Promise { return this.#executionContextPromise; } /** * If the function passed to the `worker.evaluate` returns a Promise, then * `worker.evaluate` would wait for the promise to resolve and return its * value. If the function passed to the `worker.evaluate` returns a * non-serializable value, then `worker.evaluate` resolves to `undefined`. * DevTools Protocol also supports transferring some additional values that * are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and * bigint literals. * Shortcut for `await worker.executionContext()).evaluate(pageFunction, ...args)`. * * @param pageFunction - Function to be evaluated in the worker context. * @param args - Arguments to pass to `pageFunction`. * @returns Promise which resolves to the return value of `pageFunction`. */ async evaluate( pageFunction: Function | string, ...args: any[] ): Promise { return (await this.#executionContextPromise).evaluate( pageFunction, ...args ); } /** * The only difference between `worker.evaluate` and `worker.evaluateHandle` * is that `worker.evaluateHandle` returns in-page object (JSHandle). If the * function passed to the `worker.evaluateHandle` returns a `Promise`, then * `worker.evaluateHandle` would wait for the promise to resolve and return * its value. Shortcut for * `await worker.executionContext()).evaluateHandle(pageFunction, ...args)` * * @param pageFunction - Function to be evaluated in the page context. * @param args - Arguments to pass to `pageFunction`. * @returns Promise which resolves to the return value of `pageFunction`. */ async evaluateHandle( pageFunction: EvaluateHandleFn, ...args: SerializableOrJSHandle[] ): Promise { return (await this.#executionContextPromise).evaluateHandle( pageFunction, ...args ); } }