268 lines
14 KiB
TypeScript
268 lines
14 KiB
TypeScript
/**
|
|
* 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 { NavigationEvent } from '../frames';
|
|
import { Frame } from '../frames';
|
|
import type * as channels from '@protocol/channels';
|
|
import { Dispatcher, existingDispatcher } from './dispatcher';
|
|
import { ElementHandleDispatcher } from './elementHandlerDispatcher';
|
|
import { parseArgument, serializeResult } from './jsHandleDispatcher';
|
|
import { ResponseDispatcher } from './networkDispatchers';
|
|
import { RequestDispatcher } from './networkDispatchers';
|
|
import type { CallMetadata } from '../instrumentation';
|
|
import type { BrowserContextDispatcher } from './browserContextDispatcher';
|
|
import type { PageDispatcher } from './pageDispatcher';
|
|
import { debugAssert } from '../../utils';
|
|
|
|
export class FrameDispatcher extends Dispatcher<Frame, channels.FrameChannel, BrowserContextDispatcher | PageDispatcher> implements channels.FrameChannel {
|
|
_type_Frame = true;
|
|
private _frame: Frame;
|
|
private _browserContextDispatcher: BrowserContextDispatcher;
|
|
|
|
static from(scope: BrowserContextDispatcher, frame: Frame): FrameDispatcher {
|
|
const result = existingDispatcher<FrameDispatcher>(frame);
|
|
return result || new FrameDispatcher(scope, frame);
|
|
}
|
|
|
|
static fromNullable(scope: BrowserContextDispatcher, frame: Frame | null): FrameDispatcher | undefined {
|
|
if (!frame)
|
|
return;
|
|
return FrameDispatcher.from(scope, frame);
|
|
}
|
|
|
|
private constructor(scope: BrowserContextDispatcher, frame: Frame) {
|
|
// Main frames are gc'ed separately from any other frames, so that
|
|
// methods on Page that redirect to the main frame remain operational.
|
|
// Note: we cannot check parentFrame() here because it may be null after the frame has been detached.
|
|
debugAssert(frame._page.mainFrame(), 'Cannot determine whether the frame is a main frame');
|
|
const gcBucket = frame._page.mainFrame() === frame ? 'MainFrame' : 'Frame';
|
|
const pageDispatcher = existingDispatcher<PageDispatcher>(frame._page);
|
|
super(pageDispatcher || scope, frame, 'Frame', {
|
|
url: frame.url(),
|
|
name: frame.name(),
|
|
parentFrame: FrameDispatcher.fromNullable(scope, frame.parentFrame()),
|
|
loadStates: Array.from(frame._firedLifecycleEvents),
|
|
}, gcBucket);
|
|
this._browserContextDispatcher = scope;
|
|
this._frame = frame;
|
|
this.addObjectListener(Frame.Events.AddLifecycle, lifecycleEvent => {
|
|
this._dispatchEvent('loadstate', { add: lifecycleEvent });
|
|
});
|
|
this.addObjectListener(Frame.Events.RemoveLifecycle, lifecycleEvent => {
|
|
this._dispatchEvent('loadstate', { remove: lifecycleEvent });
|
|
});
|
|
this.addObjectListener(Frame.Events.InternalNavigation, (event: NavigationEvent) => {
|
|
if (!event.isPublic)
|
|
return;
|
|
const params = { url: event.url, name: event.name, error: event.error ? event.error.message : undefined };
|
|
if (event.newDocument)
|
|
(params as any).newDocument = { request: RequestDispatcher.fromNullable(this._browserContextDispatcher, event.newDocument.request || null) };
|
|
this._dispatchEvent('navigated', params);
|
|
});
|
|
}
|
|
|
|
async goto(params: channels.FrameGotoParams, metadata: CallMetadata): Promise<channels.FrameGotoResult> {
|
|
return { response: ResponseDispatcher.fromNullable(this._browserContextDispatcher, await this._frame.goto(metadata, params.url, params)) };
|
|
}
|
|
|
|
async frameElement(): Promise<channels.FrameFrameElementResult> {
|
|
return { element: ElementHandleDispatcher.from(this, await this._frame.frameElement()) };
|
|
}
|
|
|
|
async evaluateExpression(params: channels.FrameEvaluateExpressionParams, metadata: CallMetadata): Promise<channels.FrameEvaluateExpressionResult> {
|
|
return { value: serializeResult(await this._frame.evaluateExpression(params.expression, { isFunction: params.isFunction }, parseArgument(params.arg))) };
|
|
}
|
|
|
|
async evaluateExpressionHandle(params: channels.FrameEvaluateExpressionHandleParams, metadata: CallMetadata): Promise<channels.FrameEvaluateExpressionHandleResult> {
|
|
return { handle: ElementHandleDispatcher.fromJSHandle(this, await this._frame.evaluateExpressionHandle(params.expression, { isFunction: params.isFunction }, parseArgument(params.arg))) };
|
|
}
|
|
|
|
async waitForSelector(params: channels.FrameWaitForSelectorParams, metadata: CallMetadata): Promise<channels.FrameWaitForSelectorResult> {
|
|
return { element: ElementHandleDispatcher.fromNullable(this, await this._frame.waitForSelector(metadata, params.selector, params)) };
|
|
}
|
|
|
|
async dispatchEvent(params: channels.FrameDispatchEventParams, metadata: CallMetadata): Promise<void> {
|
|
return this._frame.dispatchEvent(metadata, params.selector, params.type, parseArgument(params.eventInit), params);
|
|
}
|
|
|
|
async evalOnSelector(params: channels.FrameEvalOnSelectorParams, metadata: CallMetadata): Promise<channels.FrameEvalOnSelectorResult> {
|
|
return { value: serializeResult(await this._frame.evalOnSelector(params.selector, !!params.strict, params.expression, params.isFunction, parseArgument(params.arg))) };
|
|
}
|
|
|
|
async evalOnSelectorAll(params: channels.FrameEvalOnSelectorAllParams, metadata: CallMetadata): Promise<channels.FrameEvalOnSelectorAllResult> {
|
|
return { value: serializeResult(await this._frame.evalOnSelectorAll(params.selector, params.expression, params.isFunction, parseArgument(params.arg))) };
|
|
}
|
|
|
|
async querySelector(params: channels.FrameQuerySelectorParams, metadata: CallMetadata): Promise<channels.FrameQuerySelectorResult> {
|
|
return { element: ElementHandleDispatcher.fromNullable(this, await this._frame.querySelector(params.selector, params)) };
|
|
}
|
|
|
|
async querySelectorAll(params: channels.FrameQuerySelectorAllParams, metadata: CallMetadata): Promise<channels.FrameQuerySelectorAllResult> {
|
|
const elements = await this._frame.querySelectorAll(params.selector);
|
|
return { elements: elements.map(e => ElementHandleDispatcher.from(this, e)) };
|
|
}
|
|
|
|
async queryCount(params: channels.FrameQueryCountParams): Promise<channels.FrameQueryCountResult> {
|
|
return { value: await this._frame.queryCount(params.selector) };
|
|
}
|
|
|
|
async content(): Promise<channels.FrameContentResult> {
|
|
return { value: await this._frame.content() };
|
|
}
|
|
|
|
async setContent(params: channels.FrameSetContentParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.setContent(metadata, params.html, params);
|
|
}
|
|
|
|
async addScriptTag(params: channels.FrameAddScriptTagParams, metadata: CallMetadata): Promise<channels.FrameAddScriptTagResult> {
|
|
return { element: ElementHandleDispatcher.from(this, await this._frame.addScriptTag(params)) };
|
|
}
|
|
|
|
async addStyleTag(params: channels.FrameAddStyleTagParams, metadata: CallMetadata): Promise<channels.FrameAddStyleTagResult> {
|
|
return { element: ElementHandleDispatcher.from(this, await this._frame.addStyleTag(params)) };
|
|
}
|
|
|
|
async click(params: channels.FrameClickParams, metadata: CallMetadata): Promise<void> {
|
|
metadata.potentiallyClosesScope = true;
|
|
return await this._frame.click(metadata, params.selector, params);
|
|
}
|
|
|
|
async dblclick(params: channels.FrameDblclickParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.dblclick(metadata, params.selector, params);
|
|
}
|
|
|
|
async dragAndDrop(params: channels.FrameDragAndDropParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.dragAndDrop(metadata, params.source, params.target, params);
|
|
}
|
|
|
|
async tap(params: channels.FrameTapParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.tap(metadata, params.selector, params);
|
|
}
|
|
|
|
async fill(params: channels.FrameFillParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.fill(metadata, params.selector, params.value, params);
|
|
}
|
|
|
|
async focus(params: channels.FrameFocusParams, metadata: CallMetadata): Promise<void> {
|
|
await this._frame.focus(metadata, params.selector, params);
|
|
}
|
|
|
|
async blur(params: channels.FrameBlurParams, metadata: CallMetadata): Promise<void> {
|
|
await this._frame.blur(metadata, params.selector, params);
|
|
}
|
|
|
|
async textContent(params: channels.FrameTextContentParams, metadata: CallMetadata): Promise<channels.FrameTextContentResult> {
|
|
const value = await this._frame.textContent(metadata, params.selector, params);
|
|
return { value: value === null ? undefined : value };
|
|
}
|
|
|
|
async innerText(params: channels.FrameInnerTextParams, metadata: CallMetadata): Promise<channels.FrameInnerTextResult> {
|
|
return { value: await this._frame.innerText(metadata, params.selector, params) };
|
|
}
|
|
|
|
async innerHTML(params: channels.FrameInnerHTMLParams, metadata: CallMetadata): Promise<channels.FrameInnerHTMLResult> {
|
|
return { value: await this._frame.innerHTML(metadata, params.selector, params) };
|
|
}
|
|
|
|
async getAttribute(params: channels.FrameGetAttributeParams, metadata: CallMetadata): Promise<channels.FrameGetAttributeResult> {
|
|
const value = await this._frame.getAttribute(metadata, params.selector, params.name, params);
|
|
return { value: value === null ? undefined : value };
|
|
}
|
|
|
|
async inputValue(params: channels.FrameInputValueParams, metadata: CallMetadata): Promise<channels.FrameInputValueResult> {
|
|
const value = await this._frame.inputValue(metadata, params.selector, params);
|
|
return { value };
|
|
}
|
|
|
|
async isChecked(params: channels.FrameIsCheckedParams, metadata: CallMetadata): Promise<channels.FrameIsCheckedResult> {
|
|
return { value: await this._frame.isChecked(metadata, params.selector, params) };
|
|
}
|
|
|
|
async isDisabled(params: channels.FrameIsDisabledParams, metadata: CallMetadata): Promise<channels.FrameIsDisabledResult> {
|
|
return { value: await this._frame.isDisabled(metadata, params.selector, params) };
|
|
}
|
|
|
|
async isEditable(params: channels.FrameIsEditableParams, metadata: CallMetadata): Promise<channels.FrameIsEditableResult> {
|
|
return { value: await this._frame.isEditable(metadata, params.selector, params) };
|
|
}
|
|
|
|
async isEnabled(params: channels.FrameIsEnabledParams, metadata: CallMetadata): Promise<channels.FrameIsEnabledResult> {
|
|
return { value: await this._frame.isEnabled(metadata, params.selector, params) };
|
|
}
|
|
|
|
async isHidden(params: channels.FrameIsHiddenParams, metadata: CallMetadata): Promise<channels.FrameIsHiddenResult> {
|
|
return { value: await this._frame.isHidden(metadata, params.selector, params) };
|
|
}
|
|
|
|
async isVisible(params: channels.FrameIsVisibleParams, metadata: CallMetadata): Promise<channels.FrameIsVisibleResult> {
|
|
return { value: await this._frame.isVisible(metadata, params.selector, params) };
|
|
}
|
|
|
|
async hover(params: channels.FrameHoverParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.hover(metadata, params.selector, params);
|
|
}
|
|
|
|
async selectOption(params: channels.FrameSelectOptionParams, metadata: CallMetadata): Promise<channels.FrameSelectOptionResult> {
|
|
const elements = (params.elements || []).map(e => (e as ElementHandleDispatcher)._elementHandle);
|
|
return { values: await this._frame.selectOption(metadata, params.selector, elements, params.options || [], params) };
|
|
}
|
|
|
|
async setInputFiles(params: channels.FrameSetInputFilesParams, metadata: CallMetadata): Promise<channels.FrameSetInputFilesResult> {
|
|
return await this._frame.setInputFiles(metadata, params.selector, params);
|
|
}
|
|
|
|
async type(params: channels.FrameTypeParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.type(metadata, params.selector, params.text, params);
|
|
}
|
|
|
|
async press(params: channels.FramePressParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.press(metadata, params.selector, params.key, params);
|
|
}
|
|
|
|
async check(params: channels.FrameCheckParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.check(metadata, params.selector, params);
|
|
}
|
|
|
|
async uncheck(params: channels.FrameUncheckParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.uncheck(metadata, params.selector, params);
|
|
}
|
|
|
|
async waitForTimeout(params: channels.FrameWaitForTimeoutParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.waitForTimeout(metadata, params.timeout);
|
|
}
|
|
|
|
async waitForFunction(params: channels.FrameWaitForFunctionParams, metadata: CallMetadata): Promise<channels.FrameWaitForFunctionResult> {
|
|
return { handle: ElementHandleDispatcher.fromJSHandle(this, await this._frame._waitForFunctionExpression(metadata, params.expression, params.isFunction, parseArgument(params.arg), params)) };
|
|
}
|
|
|
|
async title(params: channels.FrameTitleParams, metadata: CallMetadata): Promise<channels.FrameTitleResult> {
|
|
return { value: await this._frame.title() };
|
|
}
|
|
|
|
async highlight(params: channels.FrameHighlightParams, metadata: CallMetadata): Promise<void> {
|
|
return await this._frame.highlight(params.selector);
|
|
}
|
|
|
|
async expect(params: channels.FrameExpectParams, metadata: CallMetadata): Promise<channels.FrameExpectResult> {
|
|
metadata.potentiallyClosesScope = true;
|
|
const expectedValue = params.expectedValue ? parseArgument(params.expectedValue) : undefined;
|
|
const result = await this._frame.expect(metadata, params.selector, { ...params, expectedValue });
|
|
if (result.received !== undefined)
|
|
result.received = serializeResult(result.received);
|
|
return result;
|
|
}
|
|
}
|