/** * Copyright (c) Microsoft Corporation. * * 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 type { ElementHandle } from '../dom'; import type { Frame } from '../frames'; import type * as js from '../javascript'; import type * as channels from '../../protocol/channels'; import type { DispatcherScope } from './dispatcher'; import { existingDispatcher, lookupNullableDispatcher } from './dispatcher'; import { JSHandleDispatcher, serializeResult, parseArgument } from './jsHandleDispatcher'; import type { FrameDispatcher } from './frameDispatcher'; import type { CallMetadata } from '../instrumentation'; import type { WritableStreamDispatcher } from './writableStreamDispatcher'; import { assert } from '../../utils'; import path from 'path'; export class ElementHandleDispatcher extends JSHandleDispatcher implements channels.ElementHandleChannel { _type_ElementHandle = true; readonly _elementHandle: ElementHandle; static from(scope: DispatcherScope, handle: ElementHandle): ElementHandleDispatcher { return existingDispatcher(handle) || new ElementHandleDispatcher(scope, handle); } static fromNullable(scope: DispatcherScope, handle: ElementHandle | null): ElementHandleDispatcher | undefined { if (!handle) return undefined; return existingDispatcher(handle) || new ElementHandleDispatcher(scope, handle); } static fromJSHandle(scope: DispatcherScope, handle: js.JSHandle): JSHandleDispatcher { const result = existingDispatcher(handle); if (result) return result; return handle.asElement() ? new ElementHandleDispatcher(scope, handle.asElement()!) : new JSHandleDispatcher(scope, handle); } private constructor(scope: DispatcherScope, elementHandle: ElementHandle) { super(scope, elementHandle); this._elementHandle = elementHandle; } async ownerFrame(params: channels.ElementHandleOwnerFrameParams, metadata: CallMetadata): Promise { return { frame: lookupNullableDispatcher(await this._elementHandle.ownerFrame()) }; } async contentFrame(params: channels.ElementHandleContentFrameParams, metadata: CallMetadata): Promise { return { frame: lookupNullableDispatcher(await this._elementHandle.contentFrame()) }; } async getAttribute(params: channels.ElementHandleGetAttributeParams, metadata: CallMetadata): Promise { const value = await this._elementHandle.getAttribute(params.name); return { value: value === null ? undefined : value }; } async inputValue(params: channels.ElementHandleInputValueParams, metadata: CallMetadata): Promise { const value = await this._elementHandle.inputValue(); return { value }; } async textContent(params: channels.ElementHandleTextContentParams, metadata: CallMetadata): Promise { const value = await this._elementHandle.textContent(); return { value: value === null ? undefined : value }; } async innerText(params: channels.ElementHandleInnerTextParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.innerText() }; } async innerHTML(params: channels.ElementHandleInnerHTMLParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.innerHTML() }; } async isChecked(params: channels.ElementHandleIsCheckedParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isChecked() }; } async isDisabled(params: channels.ElementHandleIsDisabledParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isDisabled() }; } async isEditable(params: channels.ElementHandleIsEditableParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isEditable() }; } async isEnabled(params: channels.ElementHandleIsEnabledParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isEnabled() }; } async isHidden(params: channels.ElementHandleIsHiddenParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isHidden() }; } async isVisible(params: channels.ElementHandleIsVisibleParams, metadata: CallMetadata): Promise { return { value: await this._elementHandle.isVisible() }; } async dispatchEvent(params: channels.ElementHandleDispatchEventParams, metadata: CallMetadata): Promise { await this._elementHandle.dispatchEvent(params.type, parseArgument(params.eventInit)); } async scrollIntoViewIfNeeded(params: channels.ElementHandleScrollIntoViewIfNeededParams, metadata: CallMetadata): Promise { await this._elementHandle.scrollIntoViewIfNeeded(metadata, params); } async hover(params: channels.ElementHandleHoverParams, metadata: CallMetadata): Promise { return await this._elementHandle.hover(metadata, params); } async click(params: channels.ElementHandleClickParams, metadata: CallMetadata): Promise { return await this._elementHandle.click(metadata, params); } async dblclick(params: channels.ElementHandleDblclickParams, metadata: CallMetadata): Promise { return await this._elementHandle.dblclick(metadata, params); } async tap(params: channels.ElementHandleTapParams, metadata: CallMetadata): Promise { return await this._elementHandle.tap(metadata, params); } async selectOption(params: channels.ElementHandleSelectOptionParams, metadata: CallMetadata): Promise { const elements = (params.elements || []).map(e => (e as ElementHandleDispatcher)._elementHandle); return { values: await this._elementHandle.selectOption(metadata, elements, params.options || [], params) }; } async fill(params: channels.ElementHandleFillParams, metadata: CallMetadata): Promise { return await this._elementHandle.fill(metadata, params.value, params); } async selectText(params: channels.ElementHandleSelectTextParams, metadata: CallMetadata): Promise { await this._elementHandle.selectText(metadata, params); } async setInputFiles(params: channels.ElementHandleSetInputFilesParams, metadata: CallMetadata): Promise { return await this._elementHandle.setInputFiles(metadata, { files: params.files }, params); } async setInputFilePaths(params: channels.ElementHandleSetInputFilePathsParams, metadata: CallMetadata): Promise { let { localPaths } = params; if (!localPaths) { if (!params.streams) throw new Error('Neither localPaths nor streams is specified'); localPaths = params.streams.map(c => (c as WritableStreamDispatcher).path()); } for (const p of localPaths) assert(path.isAbsolute(p) && path.resolve(p) === p, 'Paths provided to localPaths must be absolute and fully resolved.'); return await this._elementHandle.setInputFiles(metadata, { localPaths }, params); } async focus(params: channels.ElementHandleFocusParams, metadata: CallMetadata): Promise { await this._elementHandle.focus(metadata); } async type(params: channels.ElementHandleTypeParams, metadata: CallMetadata): Promise { return await this._elementHandle.type(metadata, params.text, params); } async press(params: channels.ElementHandlePressParams, metadata: CallMetadata): Promise { return await this._elementHandle.press(metadata, params.key, params); } async check(params: channels.ElementHandleCheckParams, metadata: CallMetadata): Promise { return await this._elementHandle.check(metadata, params); } async uncheck(params: channels.ElementHandleUncheckParams, metadata: CallMetadata): Promise { return await this._elementHandle.uncheck(metadata, params); } async boundingBox(params: channels.ElementHandleBoundingBoxParams, metadata: CallMetadata): Promise { const value = await this._elementHandle.boundingBox(); return { value: value || undefined }; } async screenshot(params: channels.ElementHandleScreenshotParams, metadata: CallMetadata): Promise { const mask: { frame: Frame, selector: string }[] = (params.mask || []).map(({ frame, selector }) => ({ frame: (frame as FrameDispatcher)._object, selector, })); return { binary: await this._elementHandle.screenshot(metadata, { ...params, mask }) }; } async querySelector(params: channels.ElementHandleQuerySelectorParams, metadata: CallMetadata): Promise { const handle = await this._elementHandle.querySelector(params.selector, params); return { element: ElementHandleDispatcher.fromNullable(this._scope, handle) }; } async querySelectorAll(params: channels.ElementHandleQuerySelectorAllParams, metadata: CallMetadata): Promise { const elements = await this._elementHandle.querySelectorAll(params.selector); return { elements: elements.map(e => ElementHandleDispatcher.from(this._scope, e)) }; } async evalOnSelector(params: channels.ElementHandleEvalOnSelectorParams, metadata: CallMetadata): Promise { return { value: serializeResult(await this._elementHandle.evalOnSelectorAndWaitForSignals(params.selector, !!params.strict, params.expression, params.isFunction, parseArgument(params.arg))) }; } async evalOnSelectorAll(params: channels.ElementHandleEvalOnSelectorAllParams, metadata: CallMetadata): Promise { return { value: serializeResult(await this._elementHandle.evalOnSelectorAllAndWaitForSignals(params.selector, params.expression, params.isFunction, parseArgument(params.arg))) }; } async waitForElementState(params: channels.ElementHandleWaitForElementStateParams, metadata: CallMetadata): Promise { await this._elementHandle.waitForElementState(metadata, params.state, params); } async waitForSelector(params: channels.ElementHandleWaitForSelectorParams, metadata: CallMetadata): Promise { return { element: ElementHandleDispatcher.fromNullable(this._scope, await this._elementHandle.waitForSelector(metadata, params.selector, params)) }; } }