/** * 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 {ElementHandle} from '../api/ElementHandle.js'; import type PuppeteerUtil from '../injected/injected.js'; import {assert} from '../util/assert.js'; import {isErrorLike} from '../util/ErrorLike.js'; import {interpolateFunction, stringifyFunction} from '../util/Function.js'; import type {Frame} from './Frame.js'; import {transposeIterableHandle} from './HandleIterator.js'; import type {WaitForSelectorOptions} from './IsolatedWorld.js'; import {MAIN_WORLD, PUPPETEER_WORLD} from './IsolatedWorlds.js'; import {LazyArg} from './LazyArg.js'; import type {Awaitable, AwaitableIterable} from './types.js'; /** * @internal */ export type QuerySelectorAll = ( node: Node, selector: string, PuppeteerUtil: PuppeteerUtil ) => AwaitableIterable; /** * @internal */ export type QuerySelector = ( node: Node, selector: string, PuppeteerUtil: PuppeteerUtil ) => Awaitable; /** * @internal */ export class QueryHandler { // Either one of these may be implemented, but at least one must be. static querySelectorAll?: QuerySelectorAll; static querySelector?: QuerySelector; static get _querySelector(): QuerySelector { if (this.querySelector) { return this.querySelector; } if (!this.querySelectorAll) { throw new Error('Cannot create default `querySelector`.'); } return (this.querySelector = interpolateFunction( async (node, selector, PuppeteerUtil) => { const querySelectorAll: QuerySelectorAll = PLACEHOLDER('querySelectorAll'); const results = querySelectorAll(node, selector, PuppeteerUtil); for await (const result of results) { return result; } return null; }, { querySelectorAll: stringifyFunction(this.querySelectorAll), } )); } static get _querySelectorAll(): QuerySelectorAll { if (this.querySelectorAll) { return this.querySelectorAll; } if (!this.querySelector) { throw new Error('Cannot create default `querySelectorAll`.'); } return (this.querySelectorAll = interpolateFunction( async function* (node, selector, PuppeteerUtil) { const querySelector: QuerySelector = PLACEHOLDER('querySelector'); const result = await querySelector(node, selector, PuppeteerUtil); if (result) { yield result; } }, { querySelector: stringifyFunction(this.querySelector), } )); } /** * Queries for multiple nodes given a selector and {@link ElementHandle}. * * Akin to {@link Document.prototype.querySelectorAll}. */ static async *queryAll( element: ElementHandle, selector: string ): AwaitableIterable> { const world = element.executionContext()._world; assert(world); const handle = await element.evaluateHandle( this._querySelectorAll, selector, LazyArg.create(context => { return context.puppeteerUtil; }) ); yield* transposeIterableHandle(handle); } /** * Queries for a single node given a selector and {@link ElementHandle}. * * Akin to {@link Document.prototype.querySelector}. */ static async queryOne( element: ElementHandle, selector: string ): Promise | null> { const world = element.executionContext()._world; assert(world); const result = await element.evaluateHandle( this._querySelector, selector, LazyArg.create(context => { return context.puppeteerUtil; }) ); if (!(result instanceof ElementHandle)) { await result.dispose(); return null; } return result; } /** * Waits until a single node appears for a given selector and * {@link ElementHandle}. * * This will always query the handle in the Puppeteer world and migrate the * result to the main world. */ static async waitFor( elementOrFrame: ElementHandle | Frame, selector: string, options: WaitForSelectorOptions ): Promise | null> { let frame: Frame; let element: ElementHandle | undefined; if (!(elementOrFrame instanceof ElementHandle)) { frame = elementOrFrame; } else { frame = elementOrFrame.frame; element = await frame.worlds[PUPPETEER_WORLD].adoptHandle(elementOrFrame); } const {visible = false, hidden = false, timeout} = options; try { const handle = await frame.worlds[PUPPETEER_WORLD].waitForFunction( async (PuppeteerUtil, query, selector, root, visible) => { const querySelector = PuppeteerUtil.createFunction( query ) as QuerySelector; const node = await querySelector( root ?? document, selector, PuppeteerUtil ); return PuppeteerUtil.checkVisibility(node, visible); }, { polling: visible || hidden ? 'raf' : 'mutation', root: element, timeout, }, LazyArg.create(context => { return context.puppeteerUtil; }), stringifyFunction(this._querySelector), selector, element, visible ? true : hidden ? false : undefined ); if (!(handle instanceof ElementHandle)) { await handle.dispose(); return null; } return frame.worlds[MAIN_WORLD].transferHandle(handle); } catch (error) { if (!isErrorLike(error)) { throw error; } error.message = `Waiting for selector \`${selector}\` failed: ${error.message}`; throw error; } finally { if (element) { await element.dispose(); } } } }