2019-01-16 01:21:23 +00:00
|
|
|
/**
|
|
|
|
* Copyright 2019 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.
|
|
|
|
*/
|
|
|
|
|
2022-06-22 13:25:44 +00:00
|
|
|
import {Protocol} from 'devtools-protocol';
|
2022-08-31 08:50:22 +00:00
|
|
|
import {source as injectedSource} from '../generated/injected.js';
|
2022-08-17 12:39:41 +00:00
|
|
|
import {assert} from '../util/assert.js';
|
2022-08-31 08:50:22 +00:00
|
|
|
import {createDeferredPromise} from '../util/DeferredPromise.js';
|
2022-06-22 13:25:44 +00:00
|
|
|
import {CDPSession} from './Connection.js';
|
2022-06-23 09:31:43 +00:00
|
|
|
import {ElementHandle} from './ElementHandle.js';
|
2022-06-22 13:25:44 +00:00
|
|
|
import {TimeoutError} from './Errors.js';
|
|
|
|
import {ExecutionContext} from './ExecutionContext.js';
|
2022-08-17 15:45:45 +00:00
|
|
|
import {Frame} from './Frame.js';
|
2022-08-26 10:55:30 +00:00
|
|
|
import {FrameManager} from './FrameManager.js';
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
import {MouseButton} from './Input.js';
|
2022-06-23 09:31:43 +00:00
|
|
|
import {JSHandle} from './JSHandle.js';
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
import {LifecycleWatcher, PuppeteerLifeCycleEvent} from './LifecycleWatcher.js';
|
|
|
|
import {TimeoutSettings} from './TimeoutSettings.js';
|
2022-07-06 07:05:37 +00:00
|
|
|
import {EvaluateFunc, HandleFor, NodeFor} from './types.js';
|
2022-06-14 11:16:21 +00:00
|
|
|
import {
|
2022-08-09 12:55:18 +00:00
|
|
|
createJSHandle,
|
2022-06-14 11:16:21 +00:00
|
|
|
debugError,
|
|
|
|
isNumber,
|
|
|
|
isString,
|
|
|
|
makePredicateString,
|
|
|
|
pageBindingInitString,
|
|
|
|
} from './util.js';
|
2020-04-30 11:45:52 +00:00
|
|
|
|
2020-09-21 13:47:33 +00:00
|
|
|
// predicateQueryHandler and checkWaitForOptions are declared here so that
|
|
|
|
// TypeScript knows about them when used in the predicate function below.
|
2020-07-17 05:29:42 +00:00
|
|
|
declare const predicateQueryHandler: (
|
|
|
|
element: Element | Document,
|
|
|
|
selector: string
|
2020-10-07 08:49:11 +00:00
|
|
|
) => Promise<Element | Element[] | NodeListOf<Element>>;
|
2020-09-21 13:47:33 +00:00
|
|
|
declare const checkWaitForOptions: (
|
2022-05-25 13:34:11 +00:00
|
|
|
node: Node | null,
|
2020-09-21 13:47:33 +00:00
|
|
|
waitForVisible: boolean,
|
|
|
|
waitForHidden: boolean
|
|
|
|
) => Element | null | boolean;
|
2020-04-20 10:32:08 +00:00
|
|
|
|
2020-07-02 15:13:22 +00:00
|
|
|
/**
|
|
|
|
* @public
|
|
|
|
*/
|
2020-04-29 11:28:16 +00:00
|
|
|
export interface WaitForSelectorOptions {
|
2022-08-10 21:34:29 +00:00
|
|
|
/**
|
|
|
|
* Wait for the selected element to be present in DOM and to be visible, i.e.
|
|
|
|
* to not have `display: none` or `visibility: hidden` CSS properties.
|
|
|
|
*
|
|
|
|
* @defaultValue `false`
|
|
|
|
*/
|
2020-04-28 14:35:43 +00:00
|
|
|
visible?: boolean;
|
2022-08-10 21:34:29 +00:00
|
|
|
/**
|
|
|
|
* Wait for the selected element to not be found in the DOM or to be hidden,
|
|
|
|
* i.e. have `display: none` or `visibility: hidden` CSS properties.
|
|
|
|
*
|
|
|
|
* @defaultValue `false`
|
|
|
|
*/
|
2020-04-28 14:35:43 +00:00
|
|
|
hidden?: boolean;
|
2022-08-10 21:34:29 +00:00
|
|
|
/**
|
|
|
|
* Maximum time to wait in milliseconds. Pass `0` to disable timeout.
|
|
|
|
*
|
|
|
|
* The default value can be changed by using {@link Page.setDefaultTimeout}
|
|
|
|
*
|
|
|
|
* @defaultValue `30000` (30 seconds)
|
|
|
|
*/
|
2020-04-28 14:35:43 +00:00
|
|
|
timeout?: number;
|
|
|
|
}
|
|
|
|
|
2020-11-03 10:39:31 +00:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export interface PageBinding {
|
|
|
|
name: string;
|
|
|
|
pptrFunction: Function;
|
|
|
|
}
|
|
|
|
|
2022-08-10 21:34:29 +00:00
|
|
|
/**
|
|
|
|
* A unique key for {@link IsolatedWorldChart} to denote the default world.
|
|
|
|
* Execution contexts are automatically created in the default world.
|
|
|
|
*
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export const MAIN_WORLD = Symbol('mainWorld');
|
|
|
|
/**
|
|
|
|
* A unique key for {@link IsolatedWorldChart} to denote the puppeteer world.
|
|
|
|
* This world contains all puppeteer-internal bindings/code.
|
|
|
|
*
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export const PUPPETEER_WORLD = Symbol('puppeteerWorld');
|
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export interface IsolatedWorldChart {
|
|
|
|
[key: string]: IsolatedWorld;
|
|
|
|
[MAIN_WORLD]: IsolatedWorld;
|
|
|
|
[PUPPETEER_WORLD]: IsolatedWorld;
|
|
|
|
}
|
|
|
|
|
2020-07-02 15:13:22 +00:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
2022-08-09 13:17:42 +00:00
|
|
|
export class IsolatedWorld {
|
2022-06-13 09:16:25 +00:00
|
|
|
#frame: Frame;
|
2022-08-31 08:50:22 +00:00
|
|
|
#injected: boolean;
|
2022-08-26 10:55:30 +00:00
|
|
|
#document?: ElementHandle<Document>;
|
2022-09-01 15:09:57 +00:00
|
|
|
#context = createDeferredPromise<ExecutionContext>();
|
2022-06-13 09:16:25 +00:00
|
|
|
#detached = false;
|
2020-04-28 14:35:43 +00:00
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
// Set of bindings that have been registered in the current context.
|
|
|
|
#ctxBindings = new Set<string>();
|
|
|
|
|
|
|
|
// Contains mapping from functions that should be bound to Puppeteer functions.
|
|
|
|
#boundFunctions = new Map<string, Function>();
|
|
|
|
#waitTasks = new Set<WaitTask>();
|
2020-04-28 14:35:43 +00:00
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
get _waitTasks(): Set<WaitTask> {
|
|
|
|
return this.#waitTasks;
|
|
|
|
}
|
2020-04-28 14:35:43 +00:00
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
get _boundFunctions(): Map<string, Function> {
|
|
|
|
return this.#boundFunctions;
|
|
|
|
}
|
|
|
|
|
2022-06-15 10:42:21 +00:00
|
|
|
static #bindingIdentifier = (name: string, contextId: number) => {
|
|
|
|
return `${name}_${contextId}`;
|
|
|
|
};
|
2020-10-07 08:49:11 +00:00
|
|
|
|
2022-08-31 08:50:22 +00:00
|
|
|
constructor(frame: Frame, injected = false) {
|
2021-10-28 09:25:49 +00:00
|
|
|
// Keep own reference to client because it might differ from the FrameManager's
|
|
|
|
// client for OOP iframes.
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#frame = frame;
|
2022-08-31 08:50:22 +00:00
|
|
|
this.#injected = injected;
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#client.on('Runtime.bindingCalled', this.#onBindingCalled);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-08-24 15:04:54 +00:00
|
|
|
get #client(): CDPSession {
|
|
|
|
return this.#frame._client();
|
|
|
|
}
|
|
|
|
|
|
|
|
get #frameManager(): FrameManager {
|
|
|
|
return this.#frame._frameManager;
|
|
|
|
}
|
|
|
|
|
|
|
|
get #timeoutSettings(): TimeoutSettings {
|
|
|
|
return this.#frameManager.timeoutSettings;
|
|
|
|
}
|
|
|
|
|
2020-04-29 11:28:16 +00:00
|
|
|
frame(): Frame {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#frame;
|
2019-01-22 22:55:33 +00:00
|
|
|
}
|
|
|
|
|
2022-08-09 11:29:12 +00:00
|
|
|
clearContext(): void {
|
2022-08-26 10:55:30 +00:00
|
|
|
this.#document = undefined;
|
2022-09-01 15:09:57 +00:00
|
|
|
this.#context = createDeferredPromise();
|
2022-08-09 11:29:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
setContext(context: ExecutionContext): void {
|
2022-08-31 08:50:22 +00:00
|
|
|
if (this.#injected) {
|
|
|
|
context.evaluate(injectedSource).catch(debugError);
|
|
|
|
}
|
2022-08-09 11:29:12 +00:00
|
|
|
this.#ctxBindings.clear();
|
2022-09-01 15:09:57 +00:00
|
|
|
this.#context.resolve(context);
|
2022-08-09 11:29:12 +00:00
|
|
|
for (const waitTask of this._waitTasks) {
|
|
|
|
waitTask.rerun();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-08-09 11:29:12 +00:00
|
|
|
hasContext(): boolean {
|
2022-09-01 15:09:57 +00:00
|
|
|
return this.#context.resolved();
|
2019-04-11 20:26:18 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
_detach(): void {
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#detached = true;
|
|
|
|
this.#client.off('Runtime.bindingCalled', this.#onBindingCalled);
|
2022-06-14 11:55:35 +00:00
|
|
|
for (const waitTask of this._waitTasks) {
|
2020-05-07 10:54:55 +00:00
|
|
|
waitTask.terminate(
|
|
|
|
new Error('waitForFunction failed: frame got detached.')
|
|
|
|
);
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
executionContext(): Promise<ExecutionContext> {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (this.#detached) {
|
2020-05-07 10:54:55 +00:00
|
|
|
throw new Error(
|
2022-06-13 09:16:25 +00:00
|
|
|
`Execution context is not available in detached frame "${this.#frame.url()}" (are you trying to evaluate?)`
|
2020-05-07 10:54:55 +00:00
|
|
|
);
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2022-09-01 15:09:57 +00:00
|
|
|
if (this.#context === null) {
|
2022-05-25 13:34:11 +00:00
|
|
|
throw new Error(`Execution content promise is missing`);
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2022-09-01 15:09:57 +00:00
|
|
|
return this.#context;
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
async evaluateHandle<
|
|
|
|
Params extends unknown[],
|
|
|
|
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
|
|
|
>(
|
|
|
|
pageFunction: Func | string,
|
2022-06-24 06:40:08 +00:00
|
|
|
...args: Params
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const context = await this.executionContext();
|
|
|
|
return context.evaluateHandle(pageFunction, ...args);
|
|
|
|
}
|
|
|
|
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
async evaluate<
|
|
|
|
Params extends unknown[],
|
|
|
|
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
|
|
|
>(
|
|
|
|
pageFunction: Func | string,
|
2022-06-24 06:40:08 +00:00
|
|
|
...args: Params
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
): Promise<Awaited<ReturnType<Func>>> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const context = await this.executionContext();
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
return context.evaluate(pageFunction, ...args);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-07-06 07:05:37 +00:00
|
|
|
async $<Selector extends string>(
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
selector: Selector
|
2022-07-06 07:05:37 +00:00
|
|
|
): Promise<ElementHandle<NodeFor<Selector>> | null> {
|
2022-08-10 21:34:29 +00:00
|
|
|
const document = await this.document();
|
|
|
|
return document.$(selector);
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
}
|
|
|
|
|
2022-07-06 07:05:37 +00:00
|
|
|
async $$<Selector extends string>(
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
selector: Selector
|
2022-07-06 07:05:37 +00:00
|
|
|
): Promise<Array<ElementHandle<NodeFor<Selector>>>> {
|
2022-08-10 21:34:29 +00:00
|
|
|
const document = await this.document();
|
2022-07-06 07:05:37 +00:00
|
|
|
return document.$$(selector);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-08-10 21:34:29 +00:00
|
|
|
async document(): Promise<ElementHandle<Document>> {
|
2022-08-26 10:55:30 +00:00
|
|
|
if (this.#document) {
|
|
|
|
return this.#document;
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2022-08-26 10:55:30 +00:00
|
|
|
const context = await this.executionContext();
|
|
|
|
this.#document = await context.evaluateHandle(() => {
|
|
|
|
return document;
|
2019-01-16 01:21:23 +00:00
|
|
|
});
|
2022-08-26 10:55:30 +00:00
|
|
|
return this.#document;
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-07-06 07:05:37 +00:00
|
|
|
async $x(expression: string): Promise<Array<ElementHandle<Node>>> {
|
2022-08-10 21:34:29 +00:00
|
|
|
const document = await this.document();
|
|
|
|
return document.$x(expression);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
async $eval<
|
2022-07-06 07:05:37 +00:00
|
|
|
Selector extends string,
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
Params extends unknown[],
|
|
|
|
Func extends EvaluateFunc<
|
2022-07-06 07:05:37 +00:00
|
|
|
[ElementHandle<NodeFor<Selector>>, ...Params]
|
|
|
|
> = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
>(
|
|
|
|
selector: Selector,
|
|
|
|
pageFunction: Func | string,
|
2022-06-24 06:40:08 +00:00
|
|
|
...args: Params
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
): Promise<Awaited<ReturnType<Func>>> {
|
2022-08-10 21:34:29 +00:00
|
|
|
const document = await this.document();
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
return document.$eval(selector, pageFunction, ...args);
|
|
|
|
}
|
|
|
|
|
|
|
|
async $$eval<
|
2022-07-06 07:05:37 +00:00
|
|
|
Selector extends string,
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
Params extends unknown[],
|
|
|
|
Func extends EvaluateFunc<
|
2022-07-06 07:05:37 +00:00
|
|
|
[Array<NodeFor<Selector>>, ...Params]
|
|
|
|
> = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
>(
|
|
|
|
selector: Selector,
|
|
|
|
pageFunction: Func | string,
|
2022-06-24 06:40:08 +00:00
|
|
|
...args: Params
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
): Promise<Awaited<ReturnType<Func>>> {
|
2022-08-10 21:34:29 +00:00
|
|
|
const document = await this.document();
|
|
|
|
return document.$$eval(selector, pageFunction, ...args);
|
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async content(): Promise<string> {
|
2019-01-16 01:21:23 +00:00
|
|
|
return await this.evaluate(() => {
|
|
|
|
let retVal = '';
|
2022-06-14 11:55:35 +00:00
|
|
|
if (document.doctype) {
|
2019-01-16 01:21:23 +00:00
|
|
|
retVal = new XMLSerializer().serializeToString(document.doctype);
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
|
|
|
if (document.documentElement) {
|
2019-01-16 01:21:23 +00:00
|
|
|
retVal += document.documentElement.outerHTML;
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
return retVal;
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
async setContent(
|
|
|
|
html: string,
|
|
|
|
options: {
|
|
|
|
timeout?: number;
|
|
|
|
waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
|
|
|
|
} = {}
|
|
|
|
): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const {
|
|
|
|
waitUntil = ['load'],
|
2022-06-13 09:16:25 +00:00
|
|
|
timeout = this.#timeoutSettings.navigationTimeout(),
|
2019-01-16 01:21:23 +00:00
|
|
|
} = options;
|
|
|
|
// We rely upon the fact that document.open() will reset frame lifecycle with "init"
|
|
|
|
// lifecycle event. @see https://crrev.com/608658
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
await this.evaluate(html => {
|
2019-01-16 01:21:23 +00:00
|
|
|
document.open();
|
2019-05-22 18:21:45 +00:00
|
|
|
document.write(html);
|
2019-01-16 01:21:23 +00:00
|
|
|
document.close();
|
2019-05-22 18:21:45 +00:00
|
|
|
}, html);
|
2020-05-07 10:54:55 +00:00
|
|
|
const watcher = new LifecycleWatcher(
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#frameManager,
|
|
|
|
this.#frame,
|
2020-05-07 10:54:55 +00:00
|
|
|
waitUntil,
|
|
|
|
timeout
|
|
|
|
);
|
2019-01-16 01:21:23 +00:00
|
|
|
const error = await Promise.race([
|
|
|
|
watcher.timeoutOrTerminationPromise(),
|
|
|
|
watcher.lifecyclePromise(),
|
|
|
|
]);
|
|
|
|
watcher.dispose();
|
2022-06-14 11:55:35 +00:00
|
|
|
if (error) {
|
|
|
|
throw error;
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
async click(
|
|
|
|
selector: string,
|
2022-06-22 13:25:44 +00:00
|
|
|
options: {delay?: number; button?: MouseButton; clickCount?: number}
|
2020-05-07 10:54:55 +00:00
|
|
|
): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
await handle.click(options);
|
|
|
|
await handle.dispose();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async focus(selector: string): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
await handle.focus();
|
|
|
|
await handle.dispose();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async hover(selector: string): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
await handle.hover();
|
|
|
|
await handle.dispose();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async select(selector: string, ...values: string[]): Promise<string[]> {
|
2019-09-04 22:19:34 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
const result = await handle.select(...values);
|
|
|
|
await handle.dispose();
|
2019-09-04 22:19:34 +00:00
|
|
|
return result;
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async tap(selector: string): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
await handle.tap();
|
|
|
|
await handle.dispose();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
async type(
|
|
|
|
selector: string,
|
|
|
|
text: string,
|
2022-06-22 13:25:44 +00:00
|
|
|
options?: {delay: number}
|
2020-05-07 10:54:55 +00:00
|
|
|
): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const handle = await this.$(selector);
|
2022-05-31 14:34:16 +00:00
|
|
|
assert(handle, `No element found for selector: ${selector}`);
|
|
|
|
await handle.type(text, options);
|
|
|
|
await handle.dispose();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-10-07 08:49:11 +00:00
|
|
|
// 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.
|
2022-06-13 09:16:25 +00:00
|
|
|
#settingUpBinding: Promise<void> | null = null;
|
|
|
|
|
|
|
|
async _addBindingToContext(
|
2020-11-03 10:39:31 +00:00
|
|
|
context: ExecutionContext,
|
|
|
|
name: string
|
|
|
|
): Promise<void> {
|
2020-10-07 08:49:11 +00:00
|
|
|
// Previous operation added the binding so we are done.
|
2020-11-03 10:39:31 +00:00
|
|
|
if (
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#ctxBindings.has(
|
2022-08-09 13:17:42 +00:00
|
|
|
IsolatedWorld.#bindingIdentifier(name, context._contextId)
|
2020-11-03 10:39:31 +00:00
|
|
|
)
|
|
|
|
) {
|
|
|
|
return;
|
|
|
|
}
|
2020-10-07 08:49:11 +00:00
|
|
|
// Wait for other operation to finish
|
2022-06-13 09:16:25 +00:00
|
|
|
if (this.#settingUpBinding) {
|
|
|
|
await this.#settingUpBinding;
|
|
|
|
return this._addBindingToContext(context, name);
|
2020-10-07 08:49:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const bind = async (name: string) => {
|
2022-06-14 11:16:21 +00:00
|
|
|
const expression = pageBindingInitString('internal', name);
|
2020-10-07 08:49:11 +00:00
|
|
|
try {
|
2021-01-25 12:01:59 +00:00
|
|
|
// TODO: In theory, it would be enough to call this just once
|
2020-10-07 08:49:11 +00:00
|
|
|
await context._client.send('Runtime.addBinding', {
|
|
|
|
name,
|
2021-01-25 12:01:59 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
|
|
// @ts-ignore The protocol definition is not up to date.
|
|
|
|
executionContextName: context._contextName,
|
2020-10-07 08:49:11 +00:00
|
|
|
});
|
|
|
|
await context.evaluate(expression);
|
|
|
|
} 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
|
2022-05-25 13:34:11 +00:00
|
|
|
const ctxDestroyed = (error as Error).message.includes(
|
2020-10-07 08:49:11 +00:00
|
|
|
'Execution context was destroyed'
|
|
|
|
);
|
2022-05-25 13:34:11 +00:00
|
|
|
const ctxNotFound = (error as Error).message.includes(
|
2020-10-07 08:49:11 +00:00
|
|
|
'Cannot find context with specified id'
|
|
|
|
);
|
|
|
|
if (ctxDestroyed || ctxNotFound) {
|
2020-11-03 10:39:31 +00:00
|
|
|
return;
|
2020-10-07 08:49:11 +00:00
|
|
|
} else {
|
|
|
|
debugError(error);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#ctxBindings.add(
|
2022-08-09 13:17:42 +00:00
|
|
|
IsolatedWorld.#bindingIdentifier(name, context._contextId)
|
2020-11-03 10:39:31 +00:00
|
|
|
);
|
2020-10-07 08:49:11 +00:00
|
|
|
};
|
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#settingUpBinding = bind(name);
|
|
|
|
await this.#settingUpBinding;
|
|
|
|
this.#settingUpBinding = null;
|
2020-10-07 08:49:11 +00:00
|
|
|
}
|
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
#onBindingCalled = async (
|
2020-10-07 08:49:11 +00:00
|
|
|
event: Protocol.Runtime.BindingCalledEvent
|
2022-06-13 09:16:25 +00:00
|
|
|
): Promise<void> => {
|
2022-06-22 13:25:44 +00:00
|
|
|
let payload: {type: string; name: string; seq: number; args: unknown[]};
|
2022-08-09 11:29:12 +00:00
|
|
|
if (!this.hasContext()) {
|
2022-06-14 11:55:35 +00:00
|
|
|
return;
|
|
|
|
}
|
2020-11-03 10:39:31 +00:00
|
|
|
const context = await this.executionContext();
|
2020-10-23 10:45:47 +00:00
|
|
|
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;
|
|
|
|
}
|
2022-06-22 13:25:44 +00:00
|
|
|
const {type, name, seq, args} = payload;
|
2020-11-03 10:39:31 +00:00
|
|
|
if (
|
|
|
|
type !== 'internal' ||
|
2022-06-13 09:16:25 +00:00
|
|
|
!this.#ctxBindings.has(
|
2022-08-09 13:17:42 +00:00
|
|
|
IsolatedWorld.#bindingIdentifier(name, context._contextId)
|
2020-11-03 10:39:31 +00:00
|
|
|
)
|
2022-06-14 11:55:35 +00:00
|
|
|
) {
|
2020-11-03 10:39:31 +00:00
|
|
|
return;
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
|
|
|
if (context._contextId !== event.executionContextId) {
|
|
|
|
return;
|
|
|
|
}
|
2020-10-07 08:49:11 +00:00
|
|
|
try {
|
2022-05-25 13:34:11 +00:00
|
|
|
const fn = this._boundFunctions.get(name);
|
|
|
|
if (!fn) {
|
|
|
|
throw new Error(`Bound function $name is not found`);
|
|
|
|
}
|
|
|
|
const result = await fn(...args);
|
2020-10-07 08:49:11 +00:00
|
|
|
await context.evaluate(deliverResult, name, seq, result);
|
|
|
|
} catch (error) {
|
|
|
|
// The WaitTask may already have been resolved by timing out, or the
|
|
|
|
// exection context may have been destroyed.
|
|
|
|
// In both caes, the promises above are rejected with a protocol error.
|
|
|
|
// We can safely ignores these, as the WaitTask is re-installed in
|
|
|
|
// the next execution context if needed.
|
2022-06-14 11:55:35 +00:00
|
|
|
if ((error as Error).message.includes('Protocol error')) {
|
|
|
|
return;
|
|
|
|
}
|
2020-10-07 08:49:11 +00:00
|
|
|
debugError(error);
|
|
|
|
}
|
|
|
|
function deliverResult(name: string, seq: number, result: unknown): void {
|
2022-05-25 13:34:11 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
|
|
// @ts-ignore Code is evaluated in a different context.
|
2022-06-15 10:09:22 +00:00
|
|
|
(globalThis as any)[name].callbacks.get(seq).resolve(result);
|
2022-05-25 13:34:11 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
|
|
// @ts-ignore Code is evaluated in a different context.
|
2022-06-15 10:09:22 +00:00
|
|
|
(globalThis as any)[name].callbacks.delete(seq);
|
2020-10-07 08:49:11 +00:00
|
|
|
}
|
2022-06-13 09:16:25 +00:00
|
|
|
};
|
2020-10-07 08:49:11 +00:00
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
async _waitForSelectorInPage(
|
2020-09-23 14:02:22 +00:00
|
|
|
queryOne: Function,
|
2022-08-26 10:55:30 +00:00
|
|
|
root: ElementHandle<Node> | undefined,
|
2020-09-23 14:02:22 +00:00
|
|
|
selector: string,
|
2020-11-03 10:39:31 +00:00
|
|
|
options: WaitForSelectorOptions,
|
|
|
|
binding?: PageBinding
|
2022-08-26 10:55:30 +00:00
|
|
|
): Promise<JSHandle<unknown> | null> {
|
2019-01-16 01:21:23 +00:00
|
|
|
const {
|
2020-09-21 13:47:33 +00:00
|
|
|
visible: waitForVisible = false,
|
|
|
|
hidden: waitForHidden = false,
|
2022-06-13 09:16:25 +00:00
|
|
|
timeout = this.#timeoutSettings.timeout(),
|
2019-01-16 01:21:23 +00:00
|
|
|
} = options;
|
2020-09-21 13:47:33 +00:00
|
|
|
const polling = waitForVisible || waitForHidden ? 'raf' : 'mutation';
|
|
|
|
const title = `selector \`${selector}\`${
|
|
|
|
waitForHidden ? ' to be hidden' : ''
|
|
|
|
}`;
|
2020-10-07 08:49:11 +00:00
|
|
|
async function predicate(
|
2021-12-09 11:51:14 +00:00
|
|
|
root: Element | Document,
|
2020-09-21 13:47:33 +00:00
|
|
|
selector: string,
|
|
|
|
waitForVisible: boolean,
|
|
|
|
waitForHidden: boolean
|
2020-10-07 08:49:11 +00:00
|
|
|
): Promise<Node | null | boolean> {
|
2022-08-17 12:39:41 +00:00
|
|
|
const node = (await predicateQueryHandler(root, selector)) as Element;
|
2020-09-21 13:47:33 +00:00
|
|
|
return checkWaitForOptions(node, waitForVisible, waitForHidden);
|
|
|
|
}
|
2020-11-03 10:39:31 +00:00
|
|
|
const waitTaskOptions: WaitTaskOptions = {
|
2022-08-09 13:17:42 +00:00
|
|
|
isolatedWorld: this,
|
2022-06-14 11:16:21 +00:00
|
|
|
predicateBody: makePredicateString(predicate, queryOne),
|
2021-12-15 08:40:56 +00:00
|
|
|
predicateAcceptsContextElement: true,
|
2020-09-21 13:47:33 +00:00
|
|
|
title,
|
2020-05-07 10:54:55 +00:00
|
|
|
polling,
|
|
|
|
timeout,
|
2020-11-03 10:39:31 +00:00
|
|
|
args: [selector, waitForVisible, waitForHidden],
|
|
|
|
binding,
|
2022-08-26 10:55:30 +00:00
|
|
|
root,
|
2020-11-03 10:39:31 +00:00
|
|
|
};
|
|
|
|
const waitTask = new WaitTask(waitTaskOptions);
|
2022-08-26 10:55:30 +00:00
|
|
|
return waitTask.promise;
|
2020-09-21 13:47:33 +00:00
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2020-09-21 13:47:33 +00:00
|
|
|
waitForFunction(
|
|
|
|
pageFunction: Function | string,
|
2022-06-22 13:25:44 +00:00
|
|
|
options: {polling?: string | number; timeout?: number} = {},
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
...args: unknown[]
|
2020-09-21 13:47:33 +00:00
|
|
|
): Promise<JSHandle> {
|
2022-06-22 13:25:44 +00:00
|
|
|
const {polling = 'raf', timeout = this.#timeoutSettings.timeout()} =
|
2021-05-12 14:48:30 +00:00
|
|
|
options;
|
2020-11-03 10:39:31 +00:00
|
|
|
const waitTaskOptions: WaitTaskOptions = {
|
2022-08-09 13:17:42 +00:00
|
|
|
isolatedWorld: this,
|
2020-11-03 10:39:31 +00:00
|
|
|
predicateBody: pageFunction,
|
2021-12-15 08:40:56 +00:00
|
|
|
predicateAcceptsContextElement: false,
|
2020-11-03 10:39:31 +00:00
|
|
|
title: 'function',
|
2020-09-21 13:47:33 +00:00
|
|
|
polling,
|
|
|
|
timeout,
|
2020-11-03 10:39:31 +00:00
|
|
|
args,
|
|
|
|
};
|
|
|
|
const waitTask = new WaitTask(waitTaskOptions);
|
|
|
|
return waitTask.promise;
|
2020-09-21 13:47:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
async title(): Promise<string> {
|
2022-06-15 10:42:21 +00:00
|
|
|
return this.evaluate(() => {
|
|
|
|
return document.title;
|
|
|
|
});
|
2020-09-21 13:47:33 +00:00
|
|
|
}
|
2022-08-09 12:55:18 +00:00
|
|
|
|
|
|
|
async adoptBackendNode(
|
|
|
|
backendNodeId?: Protocol.DOM.BackendNodeId
|
|
|
|
): Promise<JSHandle<Node>> {
|
|
|
|
const executionContext = await this.executionContext();
|
|
|
|
const {object} = await this.#client.send('DOM.resolveNode', {
|
|
|
|
backendNodeId: backendNodeId,
|
|
|
|
executionContextId: executionContext._contextId,
|
|
|
|
});
|
|
|
|
return createJSHandle(executionContext, object) as JSHandle<Node>;
|
|
|
|
}
|
|
|
|
|
|
|
|
async adoptHandle<T extends JSHandle<Node>>(handle: T): Promise<T> {
|
|
|
|
const executionContext = await this.executionContext();
|
|
|
|
assert(
|
|
|
|
handle.executionContext() !== executionContext,
|
|
|
|
'Cannot adopt handle that already belongs to this execution context'
|
|
|
|
);
|
|
|
|
const nodeInfo = await this.#client.send('DOM.describeNode', {
|
2022-08-11 09:45:35 +00:00
|
|
|
objectId: handle.remoteObject().objectId,
|
2022-08-09 12:55:18 +00:00
|
|
|
});
|
|
|
|
return (await this.adoptBackendNode(nodeInfo.node.backendNodeId)) as T;
|
|
|
|
}
|
2022-08-26 10:55:30 +00:00
|
|
|
|
|
|
|
async transferHandle<T extends JSHandle<Node>>(handle: T): Promise<T> {
|
|
|
|
const result = await this.adoptHandle(handle);
|
|
|
|
await handle.dispose();
|
|
|
|
return result;
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-11-03 10:39:31 +00:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export interface WaitTaskOptions {
|
2022-08-09 13:17:42 +00:00
|
|
|
isolatedWorld: IsolatedWorld;
|
2020-11-03 10:39:31 +00:00
|
|
|
predicateBody: Function | string;
|
2021-12-15 08:40:56 +00:00
|
|
|
predicateAcceptsContextElement: boolean;
|
2020-11-03 10:39:31 +00:00
|
|
|
title: string;
|
|
|
|
polling: string | number;
|
|
|
|
timeout: number;
|
|
|
|
binding?: PageBinding;
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
args: unknown[];
|
2022-07-06 07:05:37 +00:00
|
|
|
root?: ElementHandle<Node>;
|
2020-11-03 10:39:31 +00:00
|
|
|
}
|
|
|
|
|
2022-05-25 13:34:11 +00:00
|
|
|
const noop = (): void => {};
|
|
|
|
|
2020-10-07 08:49:11 +00:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
|
|
|
export class WaitTask {
|
2022-08-09 13:17:42 +00:00
|
|
|
#isolatedWorld: IsolatedWorld;
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
#polling: 'raf' | 'mutation' | number;
|
2022-06-13 09:16:25 +00:00
|
|
|
#timeout: number;
|
|
|
|
#predicateBody: string;
|
|
|
|
#predicateAcceptsContextElement: boolean;
|
feat!: type inference for evaluation types (#8547)
This PR greatly improves the types within Puppeteer:
- **Almost everything** is auto-deduced.
- Parameters don't need to be specified in the function. They are deduced from the spread.
- Return types don't need to be specified. They are deduced from the function. (More on this below)
- Selections based on tag names correctly deduce element type, similar to TypeScript's mechanism for `getElementByTagName`.
- [**BREAKING CHANGE**] We've removed the ability to declare return types in type arguments for the following reasons:
1. Setting them will indubitably break auto-deduction.
2. You can just use `as ...` in TypeScript to coerce the correct type (given it makes sense).
- [**BREAKING CHANGE**] `waitFor` is officially gone.
To migrate to these changes, there are only four things you may need to change:
- If you set a return type using the `ReturnType` type parameter, remove it and use `as ...` and `HandleFor` (if necessary).
⛔ `evaluate<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluate(a, b) => {...}, a, b)) as ReturnType`
⛔ `evaluateHandle<ReturnType>(a: number, b: number) => {...}, a, b)`
✅ `(await evaluateHandle(a, b) => {...}, a, b)) as HandleFor<ReturnType>`
- If you set any type parameters in the *parameters* of an evaluation function, remove them.
⛔ `evaluate(a: number, b: number) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
- If you set any type parameters in the method's declaration, remove them.
⛔ `evaluate<(a: number, b: number) => void>((a, b) => {...}, a, b)`
✅ `evaluate(a, b) => {...}, a, b)`
2022-06-23 09:29:46 +00:00
|
|
|
#args: unknown[];
|
2022-06-13 09:16:25 +00:00
|
|
|
#binding?: PageBinding;
|
|
|
|
#runCount = 0;
|
|
|
|
#resolve: (x: JSHandle) => void = noop;
|
|
|
|
#reject: (x: Error) => void = noop;
|
|
|
|
#timeoutTimer?: NodeJS.Timeout;
|
|
|
|
#terminated = false;
|
2022-07-06 07:05:37 +00:00
|
|
|
#root: ElementHandle<Node> | null = null;
|
2022-06-13 09:16:25 +00:00
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
promise: Promise<JSHandle>;
|
|
|
|
|
2020-11-03 10:39:31 +00:00
|
|
|
constructor(options: WaitTaskOptions) {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (isString(options.polling)) {
|
2020-05-07 10:54:55 +00:00
|
|
|
assert(
|
2020-11-03 10:39:31 +00:00
|
|
|
options.polling === 'raf' || options.polling === 'mutation',
|
|
|
|
'Unknown polling option: ' + options.polling
|
2020-05-07 10:54:55 +00:00
|
|
|
);
|
2022-06-14 11:55:35 +00:00
|
|
|
} else if (isNumber(options.polling)) {
|
2020-11-03 10:39:31 +00:00
|
|
|
assert(
|
|
|
|
options.polling > 0,
|
|
|
|
'Cannot poll with non-positive interval: ' + options.polling
|
|
|
|
);
|
2022-06-14 11:55:35 +00:00
|
|
|
} else {
|
|
|
|
throw new Error('Unknown polling options: ' + options.polling);
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2020-09-21 13:47:33 +00:00
|
|
|
function getPredicateBody(predicateBody: Function | string) {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (isString(predicateBody)) {
|
|
|
|
return `return (${predicateBody});`;
|
|
|
|
}
|
2020-04-30 11:45:52 +00:00
|
|
|
return `return (${predicateBody})(...args);`;
|
|
|
|
}
|
|
|
|
|
2022-08-09 13:17:42 +00:00
|
|
|
this.#isolatedWorld = options.isolatedWorld;
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#polling = options.polling;
|
|
|
|
this.#timeout = options.timeout;
|
|
|
|
this.#root = options.root || null;
|
|
|
|
this.#predicateBody = getPredicateBody(options.predicateBody);
|
|
|
|
this.#predicateAcceptsContextElement =
|
2021-12-15 08:40:56 +00:00
|
|
|
options.predicateAcceptsContextElement;
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#args = options.args;
|
|
|
|
this.#binding = options.binding;
|
|
|
|
this.#runCount = 0;
|
2022-08-09 13:17:42 +00:00
|
|
|
this.#isolatedWorld._waitTasks.add(this);
|
2022-06-13 09:16:25 +00:00
|
|
|
if (this.#binding) {
|
2022-08-09 13:17:42 +00:00
|
|
|
this.#isolatedWorld._boundFunctions.set(
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#binding.name,
|
|
|
|
this.#binding.pptrFunction
|
2020-11-03 10:39:31 +00:00
|
|
|
);
|
|
|
|
}
|
2020-04-28 14:35:43 +00:00
|
|
|
this.promise = new Promise<JSHandle>((resolve, reject) => {
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#resolve = resolve;
|
|
|
|
this.#reject = reject;
|
2019-01-16 01:21:23 +00:00
|
|
|
});
|
|
|
|
// Since page navigation requires us to re-install the pageScript, we should track
|
|
|
|
// timeout on our end.
|
2020-11-03 10:39:31 +00:00
|
|
|
if (options.timeout) {
|
2020-05-07 10:54:55 +00:00
|
|
|
const timeoutError = new TimeoutError(
|
2020-11-03 10:39:31 +00:00
|
|
|
`waiting for ${options.title} failed: timeout ${options.timeout}ms exceeded`
|
2020-05-07 10:54:55 +00:00
|
|
|
);
|
2022-06-15 10:42:21 +00:00
|
|
|
this.#timeoutTimer = setTimeout(() => {
|
|
|
|
return this.terminate(timeoutError);
|
|
|
|
}, options.timeout);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
this.rerun();
|
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
terminate(error: Error): void {
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#terminated = true;
|
|
|
|
this.#reject(error);
|
|
|
|
this.#cleanup();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 14:35:43 +00:00
|
|
|
async rerun(): Promise<void> {
|
2022-06-13 09:16:25 +00:00
|
|
|
const runCount = ++this.#runCount;
|
2022-05-25 13:34:11 +00:00
|
|
|
let success: JSHandle | null = null;
|
|
|
|
let error: Error | null = null;
|
2022-08-09 13:17:42 +00:00
|
|
|
const context = await this.#isolatedWorld.executionContext();
|
2022-06-14 11:55:35 +00:00
|
|
|
if (this.#terminated || runCount !== this.#runCount) {
|
|
|
|
return;
|
|
|
|
}
|
2022-06-13 09:16:25 +00:00
|
|
|
if (this.#binding) {
|
2022-08-09 13:17:42 +00:00
|
|
|
await this.#isolatedWorld._addBindingToContext(
|
|
|
|
context,
|
|
|
|
this.#binding.name
|
|
|
|
);
|
2020-11-03 10:39:31 +00:00
|
|
|
}
|
2022-06-14 11:55:35 +00:00
|
|
|
if (this.#terminated || runCount !== this.#runCount) {
|
|
|
|
return;
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
try {
|
2021-12-21 08:53:20 +00:00
|
|
|
success = await context.evaluateHandle(
|
|
|
|
waitForPredicatePageFunction,
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#root || null,
|
|
|
|
this.#predicateBody,
|
|
|
|
this.#predicateAcceptsContextElement,
|
|
|
|
this.#polling,
|
|
|
|
this.#timeout,
|
|
|
|
...this.#args
|
2021-12-21 08:53:20 +00:00
|
|
|
);
|
2020-04-28 13:16:28 +00:00
|
|
|
} catch (error_) {
|
2022-05-25 13:34:11 +00:00
|
|
|
error = error_ as Error;
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
if (this.#terminated || runCount !== this.#runCount) {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (success) {
|
|
|
|
await success.dispose();
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Ignore timeouts in pageScript - we track timeouts ourselves.
|
|
|
|
// If the frame's execution context has already changed, `frame.evaluate` will
|
|
|
|
// throw an error - ignore this predicate run altogether.
|
2020-05-07 10:54:55 +00:00
|
|
|
if (
|
|
|
|
!error &&
|
2022-08-09 13:17:42 +00:00
|
|
|
(await this.#isolatedWorld
|
2022-06-22 13:25:44 +00:00
|
|
|
.evaluate(s => {
|
2022-06-15 10:42:21 +00:00
|
|
|
return !s;
|
|
|
|
}, success)
|
|
|
|
.catch(() => {
|
|
|
|
return true;
|
|
|
|
}))
|
2020-05-07 10:54:55 +00:00
|
|
|
) {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (!success) {
|
2022-05-25 13:34:11 +00:00
|
|
|
throw new Error('Assertion: result handle is not available');
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
await success.dispose();
|
|
|
|
return;
|
|
|
|
}
|
2020-10-07 08:49:11 +00:00
|
|
|
if (error) {
|
2020-11-03 10:39:31 +00:00
|
|
|
if (error.message.includes('TypeError: binding is not a function')) {
|
|
|
|
return this.rerun();
|
|
|
|
}
|
2022-08-09 13:17:42 +00:00
|
|
|
// When frame is detached the task should have been terminated by the IsolatedWorld.
|
2020-11-03 10:39:31 +00:00
|
|
|
// This can fail if we were adding this task while the frame was detached,
|
|
|
|
// so we terminate here instead.
|
2020-10-07 08:49:11 +00:00
|
|
|
if (
|
|
|
|
error.message.includes(
|
|
|
|
'Execution context is not available in detached frame'
|
|
|
|
)
|
|
|
|
) {
|
|
|
|
this.terminate(
|
|
|
|
new Error('waitForFunction failed: frame got detached.')
|
|
|
|
);
|
|
|
|
return;
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2020-10-07 08:49:11 +00:00
|
|
|
// When the page is navigated, the promise is rejected.
|
|
|
|
// We will try again in the new execution context.
|
2022-06-14 11:55:35 +00:00
|
|
|
if (error.message.includes('Execution context was destroyed')) {
|
|
|
|
return;
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2020-10-07 08:49:11 +00:00
|
|
|
// We could have tried to evaluate in a context which was already
|
|
|
|
// destroyed.
|
2022-06-14 11:55:35 +00:00
|
|
|
if (error.message.includes('Cannot find context with specified id')) {
|
2020-10-07 08:49:11 +00:00
|
|
|
return;
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#reject(error);
|
2020-10-07 08:49:11 +00:00
|
|
|
} else {
|
2022-06-14 11:55:35 +00:00
|
|
|
if (!success) {
|
2022-05-25 13:34:11 +00:00
|
|
|
throw new Error('Assertion: result handle is not available');
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#resolve(success);
|
2020-10-07 08:49:11 +00:00
|
|
|
}
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#cleanup();
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
|
2022-06-13 09:16:25 +00:00
|
|
|
#cleanup(): void {
|
|
|
|
this.#timeoutTimer !== undefined && clearTimeout(this.#timeoutTimer);
|
2022-08-09 13:17:42 +00:00
|
|
|
this.#isolatedWorld._waitTasks.delete(this);
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
async function waitForPredicatePageFunction(
|
2022-07-06 07:05:37 +00:00
|
|
|
root: Node | null,
|
2020-05-07 10:54:55 +00:00
|
|
|
predicateBody: string,
|
2021-12-15 08:40:56 +00:00
|
|
|
predicateAcceptsContextElement: boolean,
|
2022-05-31 14:34:16 +00:00
|
|
|
polling: 'raf' | 'mutation' | number,
|
2020-05-07 10:54:55 +00:00
|
|
|
timeout: number,
|
|
|
|
...args: unknown[]
|
|
|
|
): Promise<unknown> {
|
2021-12-09 11:51:14 +00:00
|
|
|
root = root || document;
|
2019-01-16 01:21:23 +00:00
|
|
|
const predicate = new Function('...args', predicateBody);
|
|
|
|
let timedOut = false;
|
2022-06-14 11:55:35 +00:00
|
|
|
if (timeout) {
|
2022-06-15 10:42:21 +00:00
|
|
|
setTimeout(() => {
|
|
|
|
return (timedOut = true);
|
|
|
|
}, timeout);
|
2022-06-14 11:55:35 +00:00
|
|
|
}
|
2022-05-31 14:34:16 +00:00
|
|
|
switch (polling) {
|
|
|
|
case 'raf':
|
|
|
|
return await pollRaf();
|
|
|
|
case 'mutation':
|
|
|
|
return await pollMutation();
|
|
|
|
default:
|
|
|
|
return await pollInterval(polling);
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2020-05-19 07:09:31 +00:00
|
|
|
async function pollMutation(): Promise<unknown> {
|
2021-12-15 08:40:56 +00:00
|
|
|
const success = predicateAcceptsContextElement
|
|
|
|
? await predicate(root, ...args)
|
|
|
|
: await predicate(...args);
|
2022-06-14 11:55:35 +00:00
|
|
|
if (success) {
|
|
|
|
return Promise.resolve(success);
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
|
2022-05-25 13:34:11 +00:00
|
|
|
let fulfill = (_?: unknown) => {};
|
2022-06-22 13:25:44 +00:00
|
|
|
const result = new Promise(x => {
|
2022-06-15 10:42:21 +00:00
|
|
|
return (fulfill = x);
|
|
|
|
});
|
2020-05-19 07:09:31 +00:00
|
|
|
const observer = new MutationObserver(async () => {
|
2019-01-16 01:21:23 +00:00
|
|
|
if (timedOut) {
|
|
|
|
observer.disconnect();
|
|
|
|
fulfill();
|
|
|
|
}
|
2021-12-15 08:40:56 +00:00
|
|
|
const success = predicateAcceptsContextElement
|
|
|
|
? await predicate(root, ...args)
|
|
|
|
: await predicate(...args);
|
2019-01-16 01:21:23 +00:00
|
|
|
if (success) {
|
|
|
|
observer.disconnect();
|
|
|
|
fulfill(success);
|
|
|
|
}
|
|
|
|
});
|
2022-05-25 13:34:11 +00:00
|
|
|
if (!root) {
|
|
|
|
throw new Error('Root element is not found.');
|
|
|
|
}
|
2021-12-09 11:51:14 +00:00
|
|
|
observer.observe(root, {
|
2019-01-16 01:21:23 +00:00
|
|
|
childList: true,
|
|
|
|
subtree: true,
|
2020-05-07 10:54:55 +00:00
|
|
|
attributes: true,
|
2019-01-16 01:21:23 +00:00
|
|
|
});
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2020-05-19 07:09:31 +00:00
|
|
|
async function pollRaf(): Promise<unknown> {
|
2022-05-25 13:34:11 +00:00
|
|
|
let fulfill = (_?: unknown): void => {};
|
2022-06-22 13:25:44 +00:00
|
|
|
const result = new Promise(x => {
|
2022-06-15 10:42:21 +00:00
|
|
|
return (fulfill = x);
|
|
|
|
});
|
2020-05-19 07:09:31 +00:00
|
|
|
await onRaf();
|
2019-01-16 01:21:23 +00:00
|
|
|
return result;
|
|
|
|
|
2022-05-31 14:34:16 +00:00
|
|
|
async function onRaf(): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
if (timedOut) {
|
|
|
|
fulfill();
|
|
|
|
return;
|
|
|
|
}
|
2021-12-15 08:40:56 +00:00
|
|
|
const success = predicateAcceptsContextElement
|
|
|
|
? await predicate(root, ...args)
|
|
|
|
: await predicate(...args);
|
2022-06-14 11:55:35 +00:00
|
|
|
if (success) {
|
|
|
|
fulfill(success);
|
|
|
|
} else {
|
|
|
|
requestAnimationFrame(onRaf);
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-19 07:09:31 +00:00
|
|
|
async function pollInterval(pollInterval: number): Promise<unknown> {
|
2022-05-25 13:34:11 +00:00
|
|
|
let fulfill = (_?: unknown): void => {};
|
2022-06-22 13:25:44 +00:00
|
|
|
const result = new Promise(x => {
|
2022-06-15 10:42:21 +00:00
|
|
|
return (fulfill = x);
|
|
|
|
});
|
2020-05-19 07:09:31 +00:00
|
|
|
await onTimeout();
|
2019-01-16 01:21:23 +00:00
|
|
|
return result;
|
|
|
|
|
2022-05-31 14:34:16 +00:00
|
|
|
async function onTimeout(): Promise<void> {
|
2019-01-16 01:21:23 +00:00
|
|
|
if (timedOut) {
|
|
|
|
fulfill();
|
|
|
|
return;
|
|
|
|
}
|
2021-12-15 08:40:56 +00:00
|
|
|
const success = predicateAcceptsContextElement
|
|
|
|
? await predicate(root, ...args)
|
|
|
|
: await predicate(...args);
|
2022-06-14 11:55:35 +00:00
|
|
|
if (success) {
|
|
|
|
fulfill(success);
|
|
|
|
} else {
|
|
|
|
setTimeout(onTimeout, pollInterval);
|
|
|
|
}
|
2019-01-16 01:21:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|