mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
1852 lines
78 KiB
TypeScript
1852 lines
78 KiB
TypeScript
/**
|
|
* Copyright 2017 Google Inc. All rights reserved.
|
|
* Modifications 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 * as channels from '@protocol/channels';
|
|
import type { ConsoleMessage } from './console';
|
|
import * as dom from './dom';
|
|
import { helper } from './helper';
|
|
import type { RegisteredListener } from '../utils/eventsHelper';
|
|
import { eventsHelper } from '../utils/eventsHelper';
|
|
import * as js from './javascript';
|
|
import * as network from './network';
|
|
import type { Dialog } from './dialog';
|
|
import { Page } from './page';
|
|
import * as types from './types';
|
|
import { BrowserContext } from './browserContext';
|
|
import type { Progress } from './progress';
|
|
import { ProgressController } from './progress';
|
|
import { assert, constructURLBasedOnBaseURL, makeWaitForNextTask } from '../utils';
|
|
import { ManualPromise } from '../utils/manualPromise';
|
|
import { debugLogger } from '../common/debugLogger';
|
|
import type { CallMetadata } from './instrumentation';
|
|
import { serverSideCallMetadata, SdkObject } from './instrumentation';
|
|
import { type InjectedScript } from './injected/injectedScript';
|
|
import type { ElementStateWithoutStable, FrameExpectParams, InjectedScriptPoll, InjectedScriptProgress } from './injected/injectedScript';
|
|
import { isSessionClosedError } from './protocolError';
|
|
import type { ParsedSelector } from './isomorphic/selectorParser';
|
|
import { isInvalidSelectorError, splitSelectorByFrame, stringifySelector } from './isomorphic/selectorParser';
|
|
import type { SelectorInfo } from './selectors';
|
|
import type { ScreenshotOptions } from './screenshotter';
|
|
import type { InputFilesItems } from './dom';
|
|
import { asLocator } from './isomorphic/locatorGenerators';
|
|
|
|
type ContextData = {
|
|
contextPromise: ManualPromise<dom.FrameExecutionContext | Error>;
|
|
context: dom.FrameExecutionContext | null;
|
|
rerunnableTasks: Set<RerunnableTask<any>>;
|
|
};
|
|
|
|
type DocumentInfo = {
|
|
// Unfortunately, we don't have documentId when we find out about
|
|
// a pending navigation from things like frameScheduledNavigaiton.
|
|
documentId: string | undefined,
|
|
request: network.Request | undefined,
|
|
};
|
|
|
|
export type GotoResult = {
|
|
newDocumentId?: string,
|
|
};
|
|
|
|
type ConsoleTagHandler = () => void;
|
|
|
|
type RegularLifecycleEvent = Exclude<types.LifecycleEvent, 'networkidle'>;
|
|
|
|
export type FunctionWithSource = (source: { context: BrowserContext, page: Page, frame: Frame}, ...args: any) => any;
|
|
|
|
export type NavigationEvent = {
|
|
// New frame url after navigation.
|
|
url: string,
|
|
// New frame name after navigation.
|
|
name: string,
|
|
// Information about the new document for cross-document navigations.
|
|
// Undefined for same-document navigations.
|
|
newDocument?: DocumentInfo,
|
|
// Error for cross-document navigations if any. When error is present,
|
|
// the navigation did not commit.
|
|
error?: Error,
|
|
// Wether this event should be visible to the clients via the public APIs.
|
|
isPublic?: boolean;
|
|
};
|
|
|
|
export type SchedulableTask<T> = (injectedScript: js.JSHandle<InjectedScript>) => Promise<js.JSHandle<InjectedScriptPoll<T>>>;
|
|
export type DomTaskBody<T, R, E> = (progress: InjectedScriptProgress, element: E, data: T, elements: Element[]) => R | symbol;
|
|
|
|
export class NavigationAbortedError extends Error {
|
|
readonly documentId?: string;
|
|
constructor(documentId: string | undefined, message: string) {
|
|
super(message);
|
|
this.documentId = documentId;
|
|
}
|
|
}
|
|
|
|
type SelectorInFrame = {
|
|
frame: Frame;
|
|
info: SelectorInfo;
|
|
};
|
|
|
|
const kDummyFrameId = '<dummy>';
|
|
|
|
export class FrameManager {
|
|
private _page: Page;
|
|
private _frames = new Map<string, Frame>();
|
|
private _mainFrame: Frame;
|
|
readonly _consoleMessageTags = new Map<string, ConsoleTagHandler>();
|
|
readonly _signalBarriers = new Set<SignalBarrier>();
|
|
private _webSockets = new Map<string, network.WebSocket>();
|
|
_openedDialogs: Set<Dialog> = new Set();
|
|
|
|
constructor(page: Page) {
|
|
this._page = page;
|
|
this._mainFrame = undefined as any as Frame;
|
|
}
|
|
|
|
createDummyMainFrameIfNeeded() {
|
|
if (!this._mainFrame)
|
|
this.frameAttached(kDummyFrameId, null);
|
|
}
|
|
|
|
dispose() {
|
|
for (const frame of this._frames.values()) {
|
|
frame._stopNetworkIdleTimer();
|
|
frame._invalidateNonStallingEvaluations('Target crashed');
|
|
}
|
|
}
|
|
|
|
mainFrame(): Frame {
|
|
return this._mainFrame;
|
|
}
|
|
|
|
frames() {
|
|
const frames: Frame[] = [];
|
|
collect(this._mainFrame);
|
|
return frames;
|
|
|
|
function collect(frame: Frame) {
|
|
frames.push(frame);
|
|
for (const subframe of frame.childFrames())
|
|
collect(subframe);
|
|
}
|
|
}
|
|
|
|
frame(frameId: string): Frame | null {
|
|
return this._frames.get(frameId) || null;
|
|
}
|
|
|
|
frameAttached(frameId: string, parentFrameId: string | null | undefined): Frame {
|
|
const parentFrame = parentFrameId ? this._frames.get(parentFrameId)! : null;
|
|
if (!parentFrame) {
|
|
if (this._mainFrame) {
|
|
// Update frame id to retain frame identity on cross-process navigation.
|
|
this._frames.delete(this._mainFrame._id);
|
|
this._mainFrame._id = frameId;
|
|
} else {
|
|
assert(!this._frames.has(frameId));
|
|
this._mainFrame = new Frame(this._page, frameId, parentFrame);
|
|
}
|
|
this._frames.set(frameId, this._mainFrame);
|
|
return this._mainFrame;
|
|
} else {
|
|
assert(!this._frames.has(frameId));
|
|
const frame = new Frame(this._page, frameId, parentFrame);
|
|
this._frames.set(frameId, frame);
|
|
this._page.emit(Page.Events.FrameAttached, frame);
|
|
return frame;
|
|
}
|
|
}
|
|
|
|
async waitForSignalsCreatedBy<T>(progress: Progress | null, noWaitAfter: boolean | undefined, action: () => Promise<T>, source?: 'input'): Promise<T> {
|
|
if (noWaitAfter)
|
|
return action();
|
|
const barrier = new SignalBarrier(progress);
|
|
this._signalBarriers.add(barrier);
|
|
if (progress)
|
|
progress.cleanupWhenAborted(() => this._signalBarriers.delete(barrier));
|
|
const result = await action();
|
|
if (source === 'input')
|
|
await this._page._delegate.inputActionEpilogue();
|
|
await barrier.waitFor();
|
|
this._signalBarriers.delete(barrier);
|
|
// Resolve in the next task, after all waitForNavigations.
|
|
await new Promise<void>(makeWaitForNextTask());
|
|
return result;
|
|
}
|
|
|
|
frameWillPotentiallyRequestNavigation() {
|
|
for (const barrier of this._signalBarriers)
|
|
barrier.retain();
|
|
}
|
|
|
|
frameDidPotentiallyRequestNavigation() {
|
|
for (const barrier of this._signalBarriers)
|
|
barrier.release();
|
|
}
|
|
|
|
frameRequestedNavigation(frameId: string, documentId?: string) {
|
|
const frame = this._frames.get(frameId);
|
|
if (!frame)
|
|
return;
|
|
for (const barrier of this._signalBarriers)
|
|
barrier.addFrameNavigation(frame);
|
|
if (frame.pendingDocument() && frame.pendingDocument()!.documentId === documentId) {
|
|
// Do not override request with undefined.
|
|
return;
|
|
}
|
|
frame.setPendingDocument({ documentId, request: undefined });
|
|
}
|
|
|
|
frameCommittedNewDocumentNavigation(frameId: string, url: string, name: string, documentId: string, initial: boolean) {
|
|
const frame = this._frames.get(frameId)!;
|
|
this.removeChildFramesRecursively(frame);
|
|
this.clearWebSockets(frame);
|
|
frame._url = url;
|
|
frame._name = name;
|
|
|
|
let keepPending: DocumentInfo | undefined;
|
|
const pendingDocument = frame.pendingDocument();
|
|
if (pendingDocument) {
|
|
if (pendingDocument.documentId === undefined) {
|
|
// Pending with unknown documentId - assume it is the one being committed.
|
|
pendingDocument.documentId = documentId;
|
|
}
|
|
if (pendingDocument.documentId === documentId) {
|
|
// Committing a pending document.
|
|
frame._currentDocument = pendingDocument;
|
|
} else {
|
|
// Sometimes, we already have a new pending when the old one commits.
|
|
// An example would be Chromium error page followed by a new navigation request,
|
|
// where the error page commit arrives after Network.requestWillBeSent for the
|
|
// new navigation.
|
|
// We commit, but keep the pending request since it's not done yet.
|
|
keepPending = pendingDocument;
|
|
frame._currentDocument = { documentId, request: undefined };
|
|
}
|
|
frame.setPendingDocument(undefined);
|
|
} else {
|
|
// No pending - just commit a new document.
|
|
frame._currentDocument = { documentId, request: undefined };
|
|
}
|
|
|
|
frame._onClearLifecycle();
|
|
const navigationEvent: NavigationEvent = { url, name, newDocument: frame._currentDocument, isPublic: true };
|
|
this._fireInternalFrameNavigation(frame, navigationEvent);
|
|
if (!initial) {
|
|
debugLogger.log('api', ` navigated to "${url}"`);
|
|
this._page.frameNavigatedToNewDocument(frame);
|
|
}
|
|
// Restore pending if any - see comments above about keepPending.
|
|
frame.setPendingDocument(keepPending);
|
|
}
|
|
|
|
frameCommittedSameDocumentNavigation(frameId: string, url: string) {
|
|
const frame = this._frames.get(frameId);
|
|
if (!frame)
|
|
return;
|
|
frame._url = url;
|
|
const navigationEvent: NavigationEvent = { url, name: frame._name, isPublic: true };
|
|
this._fireInternalFrameNavigation(frame, navigationEvent);
|
|
debugLogger.log('api', ` navigated to "${url}"`);
|
|
}
|
|
|
|
frameAbortedNavigation(frameId: string, errorText: string, documentId?: string) {
|
|
const frame = this._frames.get(frameId);
|
|
if (!frame || !frame.pendingDocument())
|
|
return;
|
|
if (documentId !== undefined && frame.pendingDocument()!.documentId !== documentId)
|
|
return;
|
|
const navigationEvent: NavigationEvent = {
|
|
url: frame._url,
|
|
name: frame._name,
|
|
newDocument: frame.pendingDocument(),
|
|
error: new NavigationAbortedError(documentId, errorText),
|
|
isPublic: !(documentId && frame._redirectedNavigations.has(documentId)),
|
|
};
|
|
frame.setPendingDocument(undefined);
|
|
this._fireInternalFrameNavigation(frame, navigationEvent);
|
|
}
|
|
|
|
frameDetached(frameId: string) {
|
|
const frame = this._frames.get(frameId);
|
|
if (frame) {
|
|
this._removeFramesRecursively(frame);
|
|
this._page.mainFrame()._recalculateNetworkIdle();
|
|
}
|
|
}
|
|
|
|
frameLifecycleEvent(frameId: string, event: RegularLifecycleEvent) {
|
|
const frame = this._frames.get(frameId);
|
|
if (frame)
|
|
frame._onLifecycleEvent(event);
|
|
}
|
|
|
|
requestStarted(request: network.Request, route?: network.RouteDelegate) {
|
|
const frame = request.frame()!;
|
|
this._inflightRequestStarted(request);
|
|
if (request._documentId)
|
|
frame.setPendingDocument({ documentId: request._documentId, request });
|
|
if (request._isFavicon) {
|
|
if (route)
|
|
route.continue(request, {});
|
|
return;
|
|
}
|
|
this._page.emitOnContext(BrowserContext.Events.Request, request);
|
|
if (route) {
|
|
const r = new network.Route(request, route);
|
|
if (this._page._serverRequestInterceptor) {
|
|
this._page._serverRequestInterceptor(r, request);
|
|
return;
|
|
}
|
|
if (this._page._clientRequestInterceptor) {
|
|
this._page._clientRequestInterceptor(r, request);
|
|
return;
|
|
}
|
|
if (this._page._browserContext._requestInterceptor) {
|
|
this._page._browserContext._requestInterceptor(r, request);
|
|
return;
|
|
}
|
|
r.continue();
|
|
}
|
|
}
|
|
|
|
requestReceivedResponse(response: network.Response) {
|
|
if (response.request()._isFavicon)
|
|
return;
|
|
this._page.emitOnContext(BrowserContext.Events.Response, response);
|
|
}
|
|
|
|
reportRequestFinished(request: network.Request, response: network.Response | null) {
|
|
this._inflightRequestFinished(request);
|
|
if (request._isFavicon)
|
|
return;
|
|
this._page.emitOnContext(BrowserContext.Events.RequestFinished, { request, response });
|
|
}
|
|
|
|
requestFailed(request: network.Request, canceled: boolean) {
|
|
const frame = request.frame()!;
|
|
this._inflightRequestFinished(request);
|
|
if (frame.pendingDocument() && frame.pendingDocument()!.request === request) {
|
|
let errorText = request.failure()!.errorText;
|
|
if (canceled)
|
|
errorText += '; maybe frame was detached?';
|
|
this.frameAbortedNavigation(frame._id, errorText, frame.pendingDocument()!.documentId);
|
|
}
|
|
if (request._isFavicon)
|
|
return;
|
|
this._page.emitOnContext(BrowserContext.Events.RequestFailed, request);
|
|
}
|
|
|
|
dialogDidOpen(dialog: Dialog) {
|
|
// Any ongoing evaluations will be stalled until the dialog is closed.
|
|
for (const frame of this._frames.values())
|
|
frame._invalidateNonStallingEvaluations('JavaScript dialog interrupted evaluation');
|
|
this._openedDialogs.add(dialog);
|
|
}
|
|
|
|
dialogWillClose(dialog: Dialog) {
|
|
this._openedDialogs.delete(dialog);
|
|
}
|
|
|
|
async closeOpenDialogs() {
|
|
await Promise.all([...this._openedDialogs].map(dialog => dialog.dismiss())).catch(() => {});
|
|
this._openedDialogs.clear();
|
|
}
|
|
|
|
removeChildFramesRecursively(frame: Frame) {
|
|
for (const child of frame.childFrames())
|
|
this._removeFramesRecursively(child);
|
|
}
|
|
|
|
private _removeFramesRecursively(frame: Frame) {
|
|
this.removeChildFramesRecursively(frame);
|
|
frame._onDetached();
|
|
this._frames.delete(frame._id);
|
|
if (!this._page.isClosed())
|
|
this._page.emit(Page.Events.FrameDetached, frame);
|
|
}
|
|
|
|
private _inflightRequestFinished(request: network.Request) {
|
|
const frame = request.frame()!;
|
|
if (request._isFavicon)
|
|
return;
|
|
if (!frame._inflightRequests.has(request))
|
|
return;
|
|
frame._inflightRequests.delete(request);
|
|
if (frame._inflightRequests.size === 0)
|
|
frame._startNetworkIdleTimer();
|
|
}
|
|
|
|
private _inflightRequestStarted(request: network.Request) {
|
|
const frame = request.frame()!;
|
|
if (request._isFavicon)
|
|
return;
|
|
frame._inflightRequests.add(request);
|
|
if (frame._inflightRequests.size === 1)
|
|
frame._stopNetworkIdleTimer();
|
|
}
|
|
|
|
interceptConsoleMessage(message: ConsoleMessage): boolean {
|
|
if (message.type() !== 'debug')
|
|
return false;
|
|
const tag = message.text();
|
|
const handler = this._consoleMessageTags.get(tag);
|
|
if (!handler)
|
|
return false;
|
|
this._consoleMessageTags.delete(tag);
|
|
handler();
|
|
return true;
|
|
}
|
|
|
|
clearWebSockets(frame: Frame) {
|
|
// TODO: attribute sockets to frames.
|
|
if (frame.parentFrame())
|
|
return;
|
|
this._webSockets.clear();
|
|
}
|
|
|
|
onWebSocketCreated(requestId: string, url: string) {
|
|
const ws = new network.WebSocket(this._page, url);
|
|
this._webSockets.set(requestId, ws);
|
|
}
|
|
|
|
onWebSocketRequest(requestId: string) {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (ws && ws.markAsNotified())
|
|
this._page.emit(Page.Events.WebSocket, ws);
|
|
}
|
|
|
|
onWebSocketResponse(requestId: string, status: number, statusText: string) {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (status < 400)
|
|
return;
|
|
if (ws)
|
|
ws.error(`${statusText}: ${status}`);
|
|
}
|
|
|
|
onWebSocketFrameSent(requestId: string, opcode: number, data: string) {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (ws)
|
|
ws.frameSent(opcode, data);
|
|
}
|
|
|
|
webSocketFrameReceived(requestId: string, opcode: number, data: string) {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (ws)
|
|
ws.frameReceived(opcode, data);
|
|
}
|
|
|
|
webSocketClosed(requestId: string) {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (ws)
|
|
ws.closed();
|
|
this._webSockets.delete(requestId);
|
|
}
|
|
|
|
webSocketError(requestId: string, errorMessage: string): void {
|
|
const ws = this._webSockets.get(requestId);
|
|
if (ws)
|
|
ws.error(errorMessage);
|
|
}
|
|
|
|
private _fireInternalFrameNavigation(frame: Frame, event: NavigationEvent) {
|
|
frame.emit(Frame.Events.InternalNavigation, event);
|
|
}
|
|
}
|
|
|
|
export class Frame extends SdkObject {
|
|
static Events = {
|
|
InternalNavigation: 'internalnavigation',
|
|
AddLifecycle: 'addlifecycle',
|
|
RemoveLifecycle: 'removelifecycle',
|
|
};
|
|
|
|
_id: string;
|
|
_firedLifecycleEvents = new Set<types.LifecycleEvent>();
|
|
private _firedNetworkIdleSelf = false;
|
|
_currentDocument: DocumentInfo;
|
|
private _pendingDocument: DocumentInfo | undefined;
|
|
readonly _page: Page;
|
|
private _parentFrame: Frame | null;
|
|
_url = '';
|
|
private _detached = false;
|
|
private _contextData = new Map<types.World, ContextData>();
|
|
private _childFrames = new Set<Frame>();
|
|
_name = '';
|
|
_inflightRequests = new Set<network.Request>();
|
|
private _networkIdleTimer: NodeJS.Timer | undefined;
|
|
private _setContentCounter = 0;
|
|
readonly _detachedPromise: Promise<void>;
|
|
private _detachedCallback = () => {};
|
|
private _raceAgainstEvaluationStallingEventsPromises = new Set<ManualPromise<any>>();
|
|
readonly _redirectedNavigations = new Map<string, { url: string, gotoPromise: Promise<network.Response | null> }>(); // documentId -> data
|
|
|
|
constructor(page: Page, id: string, parentFrame: Frame | null) {
|
|
super(page, 'frame');
|
|
this.attribution.frame = this;
|
|
this._id = id;
|
|
this._page = page;
|
|
this._parentFrame = parentFrame;
|
|
this._currentDocument = { documentId: undefined, request: undefined };
|
|
|
|
this._detachedPromise = new Promise<void>(x => this._detachedCallback = x);
|
|
|
|
this._contextData.set('main', { contextPromise: new ManualPromise(), context: null, rerunnableTasks: new Set() });
|
|
this._contextData.set('utility', { contextPromise: new ManualPromise(), context: null, rerunnableTasks: new Set() });
|
|
this._setContext('main', null);
|
|
this._setContext('utility', null);
|
|
|
|
if (this._parentFrame)
|
|
this._parentFrame._childFrames.add(this);
|
|
|
|
this._firedLifecycleEvents.add('commit');
|
|
if (id !== kDummyFrameId)
|
|
this._startNetworkIdleTimer();
|
|
}
|
|
|
|
isDetached(): boolean {
|
|
return this._detached;
|
|
}
|
|
|
|
_onLifecycleEvent(event: RegularLifecycleEvent) {
|
|
if (this._firedLifecycleEvents.has(event))
|
|
return;
|
|
this._firedLifecycleEvents.add(event);
|
|
this.emit(Frame.Events.AddLifecycle, event);
|
|
if (this === this._page.mainFrame() && this._url !== 'about:blank')
|
|
debugLogger.log('api', ` "${event}" event fired`);
|
|
this._page.mainFrame()._recalculateNetworkIdle();
|
|
}
|
|
|
|
_onClearLifecycle() {
|
|
for (const event of this._firedLifecycleEvents)
|
|
this.emit(Frame.Events.RemoveLifecycle, event);
|
|
this._firedLifecycleEvents.clear();
|
|
// Keep the current navigation request if any.
|
|
this._inflightRequests = new Set(Array.from(this._inflightRequests).filter(request => request === this._currentDocument.request));
|
|
this._stopNetworkIdleTimer();
|
|
if (this._inflightRequests.size === 0)
|
|
this._startNetworkIdleTimer();
|
|
this._page.mainFrame()._recalculateNetworkIdle(this);
|
|
this._onLifecycleEvent('commit');
|
|
}
|
|
|
|
setPendingDocument(documentInfo: DocumentInfo | undefined) {
|
|
this._pendingDocument = documentInfo;
|
|
if (documentInfo)
|
|
this._invalidateNonStallingEvaluations('Navigation interrupted the evaluation');
|
|
}
|
|
|
|
pendingDocument(): DocumentInfo | undefined {
|
|
return this._pendingDocument;
|
|
}
|
|
|
|
_invalidateNonStallingEvaluations(message: string) {
|
|
if (!this._raceAgainstEvaluationStallingEventsPromises.size)
|
|
return;
|
|
const error = new Error(message);
|
|
for (const promise of this._raceAgainstEvaluationStallingEventsPromises)
|
|
promise.reject(error);
|
|
}
|
|
|
|
async raceAgainstEvaluationStallingEvents<T>(cb: () => Promise<T>): Promise<T> {
|
|
if (this._pendingDocument)
|
|
throw new Error('Frame is currently attempting a navigation');
|
|
if (this._page._frameManager._openedDialogs.size)
|
|
throw new Error('Open JavaScript dialog prevents evaluation');
|
|
|
|
const promise = new ManualPromise<T>();
|
|
this._raceAgainstEvaluationStallingEventsPromises.add(promise);
|
|
try {
|
|
return await Promise.race([
|
|
cb(),
|
|
promise
|
|
]);
|
|
} finally {
|
|
this._raceAgainstEvaluationStallingEventsPromises.delete(promise);
|
|
}
|
|
}
|
|
|
|
nonStallingRawEvaluateInExistingMainContext(expression: string): Promise<any> {
|
|
return this.raceAgainstEvaluationStallingEvents(() => {
|
|
const context = this._existingMainContext();
|
|
if (!context)
|
|
throw new Error('Frame does not yet have a main execution context');
|
|
return context.rawEvaluateJSON(expression);
|
|
});
|
|
}
|
|
|
|
nonStallingEvaluateInExistingContext(expression: string, isFunction: boolean|undefined, world: types.World): Promise<any> {
|
|
return this.raceAgainstEvaluationStallingEvents(() => {
|
|
const context = this._contextData.get(world)?.context;
|
|
if (!context)
|
|
throw new Error('Frame does not yet have the execution context');
|
|
return context.evaluateExpression(expression, isFunction);
|
|
});
|
|
}
|
|
|
|
_recalculateNetworkIdle(frameThatAllowsRemovingNetworkIdle?: Frame) {
|
|
let isNetworkIdle = this._firedNetworkIdleSelf;
|
|
for (const child of this._childFrames) {
|
|
child._recalculateNetworkIdle(frameThatAllowsRemovingNetworkIdle);
|
|
// We require networkidle event to be fired in the whole frame subtree, and then consider it done.
|
|
if (!child._firedLifecycleEvents.has('networkidle'))
|
|
isNetworkIdle = false;
|
|
}
|
|
if (isNetworkIdle && !this._firedLifecycleEvents.has('networkidle')) {
|
|
this._firedLifecycleEvents.add('networkidle');
|
|
this.emit(Frame.Events.AddLifecycle, 'networkidle');
|
|
if (this === this._page.mainFrame() && this._url !== 'about:blank')
|
|
debugLogger.log('api', ` "networkidle" event fired`);
|
|
}
|
|
if (frameThatAllowsRemovingNetworkIdle !== this && this._firedLifecycleEvents.has('networkidle') && !isNetworkIdle) {
|
|
// Usually, networkidle is fired once and not removed after that.
|
|
// However, when we clear them right before a new commit, this is allowed for a particular frame.
|
|
this._firedLifecycleEvents.delete('networkidle');
|
|
this.emit(Frame.Events.RemoveLifecycle, 'networkidle');
|
|
}
|
|
}
|
|
|
|
async raceNavigationAction(progress: Progress, options: types.GotoOptions, action: () => Promise<network.Response | null>): Promise<network.Response | null> {
|
|
return Promise.race([
|
|
this._page._disconnectedPromise.then(() => { throw new Error('Navigation failed because page was closed!'); }),
|
|
this._page._crashedPromise.then(() => { throw new Error('Navigation failed because page crashed!'); }),
|
|
this._detachedPromise.then(() => { throw new Error('Navigating frame was detached!'); }),
|
|
action().catch(e => {
|
|
if (e instanceof NavigationAbortedError && e.documentId) {
|
|
const data = this._redirectedNavigations.get(e.documentId);
|
|
if (data) {
|
|
progress.log(`waiting for redirected navigation to "${data.url}"`);
|
|
return data.gotoPromise;
|
|
}
|
|
}
|
|
throw e;
|
|
}),
|
|
]);
|
|
}
|
|
|
|
redirectNavigation(url: string, documentId: string, referer: string | undefined) {
|
|
const controller = new ProgressController(serverSideCallMetadata(), this);
|
|
const data = {
|
|
url,
|
|
gotoPromise: controller.run(progress => this._gotoAction(progress, url, { referer }), 0),
|
|
};
|
|
this._redirectedNavigations.set(documentId, data);
|
|
data.gotoPromise.finally(() => this._redirectedNavigations.delete(documentId));
|
|
}
|
|
|
|
async goto(metadata: CallMetadata, url: string, options: types.GotoOptions = {}): Promise<network.Response | null> {
|
|
const constructedNavigationURL = constructURLBasedOnBaseURL(this._page._browserContext._options.baseURL, url);
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(progress => this._goto(progress, constructedNavigationURL, options), this._page._timeoutSettings.navigationTimeout(options));
|
|
}
|
|
|
|
private async _goto(progress: Progress, url: string, options: types.GotoOptions): Promise<network.Response | null> {
|
|
return this.raceNavigationAction(progress, options, async () => this._gotoAction(progress, url, options));
|
|
}
|
|
|
|
private async _gotoAction(progress: Progress, url: string, options: types.GotoOptions): Promise<network.Response | null> {
|
|
const waitUntil = verifyLifecycle('waitUntil', options.waitUntil === undefined ? 'load' : options.waitUntil);
|
|
progress.log(`navigating to "${url}", waiting until "${waitUntil}"`);
|
|
const headers = this._page.extraHTTPHeaders() || [];
|
|
const refererHeader = headers.find(h => h.name.toLowerCase() === 'referer');
|
|
let referer = refererHeader ? refererHeader.value : undefined;
|
|
if (options.referer !== undefined) {
|
|
if (referer !== undefined && referer !== options.referer)
|
|
throw new Error('"referer" is already specified as extra HTTP header');
|
|
referer = options.referer;
|
|
}
|
|
url = helper.completeUserURL(url);
|
|
|
|
const sameDocument = helper.waitForEvent(progress, this, Frame.Events.InternalNavigation, (e: NavigationEvent) => !e.newDocument);
|
|
const navigateResult = await this._page._delegate.navigateFrame(this, url, referer);
|
|
|
|
let event: NavigationEvent;
|
|
if (navigateResult.newDocumentId) {
|
|
sameDocument.dispose();
|
|
event = await helper.waitForEvent(progress, this, Frame.Events.InternalNavigation, (event: NavigationEvent) => {
|
|
// We are interested either in this specific document, or any other document that
|
|
// did commit and replaced the expected document.
|
|
return event.newDocument && (event.newDocument.documentId === navigateResult.newDocumentId || !event.error);
|
|
}).promise;
|
|
|
|
if (event.newDocument!.documentId !== navigateResult.newDocumentId) {
|
|
// This is just a sanity check. In practice, new navigation should
|
|
// cancel the previous one and report "request cancelled"-like error.
|
|
throw new NavigationAbortedError(navigateResult.newDocumentId, 'Navigation interrupted by another one');
|
|
}
|
|
if (event.error)
|
|
throw event.error;
|
|
} else {
|
|
event = await sameDocument.promise;
|
|
}
|
|
|
|
if (!this._firedLifecycleEvents.has(waitUntil))
|
|
await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;
|
|
|
|
const request = event.newDocument ? event.newDocument.request : undefined;
|
|
const response = request ? request._finalRequest().response() : null;
|
|
await this._page._doSlowMo();
|
|
return response;
|
|
}
|
|
|
|
async _waitForNavigation(progress: Progress, requiresNewDocument: boolean, options: types.NavigateOptions): Promise<network.Response | null> {
|
|
const waitUntil = verifyLifecycle('waitUntil', options.waitUntil === undefined ? 'load' : options.waitUntil);
|
|
progress.log(`waiting for navigation until "${waitUntil}"`);
|
|
|
|
const navigationEvent: NavigationEvent = await helper.waitForEvent(progress, this, Frame.Events.InternalNavigation, (event: NavigationEvent) => {
|
|
// Any failed navigation results in a rejection.
|
|
if (event.error)
|
|
return true;
|
|
if (requiresNewDocument && !event.newDocument)
|
|
return false;
|
|
progress.log(` navigated to "${this._url}"`);
|
|
return true;
|
|
}).promise;
|
|
if (navigationEvent.error)
|
|
throw navigationEvent.error;
|
|
|
|
if (!this._firedLifecycleEvents.has(waitUntil))
|
|
await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;
|
|
|
|
const request = navigationEvent.newDocument ? navigationEvent.newDocument.request : undefined;
|
|
return request ? request._finalRequest().response() : null;
|
|
}
|
|
|
|
async _waitForLoadState(progress: Progress, state: types.LifecycleEvent): Promise<void> {
|
|
const waitUntil = verifyLifecycle('state', state);
|
|
if (!this._firedLifecycleEvents.has(waitUntil))
|
|
await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;
|
|
}
|
|
|
|
async frameElement(): Promise<dom.ElementHandle> {
|
|
return this._page._delegate.getFrameElement(this);
|
|
}
|
|
|
|
_context(world: types.World): Promise<dom.FrameExecutionContext> {
|
|
return this._contextData.get(world)!.contextPromise.then(contextOrError => {
|
|
if (contextOrError instanceof js.ExecutionContext)
|
|
return contextOrError;
|
|
throw contextOrError;
|
|
});
|
|
}
|
|
|
|
_mainContext(): Promise<dom.FrameExecutionContext> {
|
|
return this._context('main');
|
|
}
|
|
|
|
private _existingMainContext(): dom.FrameExecutionContext | null {
|
|
return this._contextData.get('main')?.context || null;
|
|
}
|
|
|
|
_utilityContext(): Promise<dom.FrameExecutionContext> {
|
|
return this._context('utility');
|
|
}
|
|
|
|
async evaluateExpressionHandleAndWaitForSignals(expression: string, isFunction: boolean | undefined, arg: any, world: types.World = 'main'): Promise<any> {
|
|
const context = await this._context(world);
|
|
const handle = await context.evaluateExpressionHandleAndWaitForSignals(expression, isFunction, arg);
|
|
if (world === 'main')
|
|
await this._page._doSlowMo();
|
|
return handle;
|
|
}
|
|
|
|
async evaluateExpression(expression: string, isFunction: boolean | undefined, arg: any, world: types.World = 'main'): Promise<any> {
|
|
const context = await this._context(world);
|
|
const value = await context.evaluateExpression(expression, isFunction, arg);
|
|
if (world === 'main')
|
|
await this._page._doSlowMo();
|
|
return value;
|
|
}
|
|
|
|
async evaluateExpressionAndWaitForSignals(expression: string, isFunction: boolean | undefined, arg: any, world: types.World = 'main'): Promise<any> {
|
|
const context = await this._context(world);
|
|
const value = await context.evaluateExpressionAndWaitForSignals(expression, isFunction, arg);
|
|
if (world === 'main')
|
|
await this._page._doSlowMo();
|
|
return value;
|
|
}
|
|
|
|
async querySelector(selector: string, options: types.StrictOptions): Promise<dom.ElementHandle<Element> | null> {
|
|
debugLogger.log('api', ` finding element using the selector "${selector}"`);
|
|
const result = await this.resolveFrameForSelectorNoWait(selector, options);
|
|
if (!result)
|
|
return null;
|
|
return this._page.selectors.query(result.frame, result.info);
|
|
}
|
|
|
|
async waitForSelector(metadata: CallMetadata, selector: string, options: types.WaitForElementOptions & { omitReturnValue?: boolean }, scope?: dom.ElementHandle): Promise<dom.ElementHandle<Element> | null> {
|
|
const controller = new ProgressController(metadata, this);
|
|
if ((options as any).visibility)
|
|
throw new Error('options.visibility is not supported, did you mean options.state?');
|
|
if ((options as any).waitFor && (options as any).waitFor !== 'visible')
|
|
throw new Error('options.waitFor is not supported, did you mean options.state?');
|
|
const { state = 'visible' } = options;
|
|
if (!['attached', 'detached', 'visible', 'hidden'].includes(state))
|
|
throw new Error(`state: expected one of (attached|detached|visible|hidden)`);
|
|
return controller.run(async progress => {
|
|
progress.log(`waiting for "${this._asLocator(selector)}"${state === 'attached' ? '' : ' to be ' + state}`);
|
|
return this.retryWithProgress(progress, selector, options, async (selectorInFrame, continuePolling) => {
|
|
// Be careful, |this| can be different from |frame|.
|
|
// We did not pass omitAttached, so it is non-null.
|
|
const { frame, info } = selectorInFrame!;
|
|
const actualScope = this === frame ? scope : undefined;
|
|
const task = dom.waitForSelectorTask(info, state, options.omitReturnValue, actualScope);
|
|
const result = actualScope ? await frame._runWaitForSelectorTaskOnce(progress, stringifySelector(info.parsed), info.world, task)
|
|
: await frame._scheduleRerunnableHandleTask(progress, info.world, task);
|
|
if (!result.asElement()) {
|
|
result.dispose();
|
|
return null;
|
|
}
|
|
if ((options as any).__testHookBeforeAdoptNode)
|
|
await (options as any).__testHookBeforeAdoptNode();
|
|
const handle = result.asElement() as dom.ElementHandle<Element>;
|
|
try {
|
|
return await handle._adoptTo(await frame._mainContext());
|
|
} catch (e) {
|
|
return continuePolling;
|
|
}
|
|
}, scope);
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async dispatchEvent(metadata: CallMetadata, selector: string, type: string, eventInit: Object = {}, options: types.QueryOnSelectorOptions = {}): Promise<void> {
|
|
await this._scheduleRerunnableTask(metadata, selector, (progress, element, data) => {
|
|
progress.injectedScript.dispatchEvent(element, data.type, data.eventInit);
|
|
}, { type, eventInit }, { mainWorld: true, ...options });
|
|
await this._page._doSlowMo();
|
|
}
|
|
|
|
async evalOnSelectorAndWaitForSignals(selector: string, strict: boolean, expression: string, isFunction: boolean | undefined, arg: any): Promise<any> {
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector, { strict });
|
|
const handle = pair ? await this._page.selectors.query(pair.frame, pair.info) : null;
|
|
if (!handle)
|
|
throw new Error(`Error: failed to find element matching selector "${selector}"`);
|
|
const result = await handle.evaluateExpressionAndWaitForSignals(expression, isFunction, true, arg);
|
|
handle.dispose();
|
|
return result;
|
|
}
|
|
|
|
async evalOnSelectorAllAndWaitForSignals(selector: string, expression: string, isFunction: boolean | undefined, arg: any): Promise<any> {
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector, {});
|
|
if (!pair)
|
|
throw new Error(`Error: failed to find frame for selector "${selector}"`);
|
|
const arrayHandle = await this._page.selectors._queryArrayInMainWorld(pair.frame, pair.info);
|
|
const result = await arrayHandle.evaluateExpressionAndWaitForSignals(expression, isFunction, true, arg);
|
|
arrayHandle.dispose();
|
|
return result;
|
|
}
|
|
|
|
async maskSelectors(selectors: ParsedSelector[]): Promise<void> {
|
|
const context = await this._utilityContext();
|
|
const injectedScript = await context.injectedScript();
|
|
await injectedScript.evaluate((injected, { parsed }) => {
|
|
injected.maskSelectors(parsed);
|
|
}, { parsed: selectors });
|
|
}
|
|
|
|
async querySelectorAll(selector: string): Promise<dom.ElementHandle<Element>[]> {
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector, {});
|
|
if (!pair)
|
|
return [];
|
|
return this._page.selectors._queryAll(pair.frame, pair.info, undefined, true /* adoptToMain */);
|
|
}
|
|
|
|
async queryCount(selector: string): Promise<number> {
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector);
|
|
if (!pair)
|
|
throw new Error(`Error: failed to find frame for selector "${selector}"`);
|
|
return await this._page.selectors._queryCount(pair.frame, pair.info);
|
|
}
|
|
|
|
async content(): Promise<string> {
|
|
try {
|
|
const context = await this._utilityContext();
|
|
return await context.evaluate(() => {
|
|
let retVal = '';
|
|
if (document.doctype)
|
|
retVal = new XMLSerializer().serializeToString(document.doctype);
|
|
if (document.documentElement)
|
|
retVal += document.documentElement.outerHTML;
|
|
return retVal;
|
|
});
|
|
} catch (e) {
|
|
if (js.isJavaScriptErrorInEvaluate(e) || isSessionClosedError(e))
|
|
throw e;
|
|
throw new Error(`Unable to retrieve content because the page is navigating and changing the content.`);
|
|
}
|
|
}
|
|
|
|
async setContent(metadata: CallMetadata, html: string, options: types.NavigateOptions = {}): Promise<void> {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
await this.raceNavigationAction(progress, options, async () => {
|
|
const waitUntil = options.waitUntil === undefined ? 'load' : options.waitUntil;
|
|
progress.log(`setting frame content, waiting until "${waitUntil}"`);
|
|
const tag = `--playwright--set--content--${this._id}--${++this._setContentCounter}--`;
|
|
const context = await this._utilityContext();
|
|
const lifecyclePromise = new Promise((resolve, reject) => {
|
|
this._page._frameManager._consoleMessageTags.set(tag, () => {
|
|
// Clear lifecycle right after document.open() - see 'tag' below.
|
|
this._onClearLifecycle();
|
|
this._waitForLoadState(progress, waitUntil).then(resolve).catch(reject);
|
|
});
|
|
});
|
|
const contentPromise = context.evaluate(({ html, tag }) => {
|
|
window.stop();
|
|
document.open();
|
|
console.debug(tag); // eslint-disable-line no-console
|
|
document.write(html);
|
|
document.close();
|
|
}, { html, tag });
|
|
await Promise.all([contentPromise, lifecyclePromise]);
|
|
await this._page._doSlowMo();
|
|
return null;
|
|
});
|
|
}, this._page._timeoutSettings.navigationTimeout(options));
|
|
}
|
|
|
|
name(): string {
|
|
return this._name || '';
|
|
}
|
|
|
|
url(): string {
|
|
return this._url;
|
|
}
|
|
|
|
parentFrame(): Frame | null {
|
|
return this._parentFrame;
|
|
}
|
|
|
|
childFrames(): Frame[] {
|
|
return Array.from(this._childFrames);
|
|
}
|
|
|
|
async addScriptTag(params: {
|
|
url?: string,
|
|
content?: string,
|
|
type?: string,
|
|
}): Promise<dom.ElementHandle> {
|
|
const {
|
|
url = null,
|
|
content = null,
|
|
type = ''
|
|
} = params;
|
|
if (!url && !content)
|
|
throw new Error('Provide an object with a `url`, `path` or `content` property');
|
|
|
|
const context = await this._mainContext();
|
|
return this._raceWithCSPError(async () => {
|
|
if (url !== null)
|
|
return (await context.evaluateHandle(addScriptUrl, { url, type })).asElement()!;
|
|
const result = (await context.evaluateHandle(addScriptContent, { content: content!, type })).asElement()!;
|
|
// Another round trip to the browser to ensure that we receive CSP error messages
|
|
// (if any) logged asynchronously in a separate task on the content main thread.
|
|
if (this._page._delegate.cspErrorsAsynchronousForInlineScipts)
|
|
await context.evaluate(() => true);
|
|
return result;
|
|
});
|
|
|
|
async function addScriptUrl(params: { url: string, type: string }): Promise<HTMLElement> {
|
|
const script = document.createElement('script');
|
|
script.src = params.url;
|
|
if (params.type)
|
|
script.type = params.type;
|
|
const promise = new Promise((res, rej) => {
|
|
script.onload = res;
|
|
script.onerror = e => rej(typeof e === 'string' ? new Error(e) : new Error(`Failed to load script at ${script.src}`));
|
|
});
|
|
document.head.appendChild(script);
|
|
await promise;
|
|
return script;
|
|
}
|
|
|
|
function addScriptContent(params: { content: string, type: string }): HTMLElement {
|
|
const script = document.createElement('script');
|
|
script.type = params.type || 'text/javascript';
|
|
script.text = params.content;
|
|
let error = null;
|
|
script.onerror = e => error = e;
|
|
document.head.appendChild(script);
|
|
if (error)
|
|
throw error;
|
|
return script;
|
|
}
|
|
}
|
|
|
|
async addStyleTag(params: { url?: string, content?: string }): Promise<dom.ElementHandle> {
|
|
const {
|
|
url = null,
|
|
content = null
|
|
} = params;
|
|
if (!url && !content)
|
|
throw new Error('Provide an object with a `url`, `path` or `content` property');
|
|
|
|
const context = await this._mainContext();
|
|
return this._raceWithCSPError(async () => {
|
|
if (url !== null)
|
|
return (await context.evaluateHandle(addStyleUrl, url)).asElement()!;
|
|
return (await context.evaluateHandle(addStyleContent, content!)).asElement()!;
|
|
});
|
|
|
|
async function addStyleUrl(url: string): Promise<HTMLElement> {
|
|
const link = document.createElement('link');
|
|
link.rel = 'stylesheet';
|
|
link.href = url;
|
|
const promise = new Promise((res, rej) => {
|
|
link.onload = res;
|
|
link.onerror = rej;
|
|
});
|
|
document.head.appendChild(link);
|
|
await promise;
|
|
return link;
|
|
}
|
|
|
|
async function addStyleContent(content: string): Promise<HTMLElement> {
|
|
const style = document.createElement('style');
|
|
style.type = 'text/css';
|
|
style.appendChild(document.createTextNode(content));
|
|
const promise = new Promise((res, rej) => {
|
|
style.onload = res;
|
|
style.onerror = rej;
|
|
});
|
|
document.head.appendChild(style);
|
|
await promise;
|
|
return style;
|
|
}
|
|
}
|
|
|
|
private async _raceWithCSPError(func: () => Promise<dom.ElementHandle>): Promise<dom.ElementHandle> {
|
|
const listeners: RegisteredListener[] = [];
|
|
let result: dom.ElementHandle;
|
|
let error: Error | undefined;
|
|
let cspMessage: ConsoleMessage | undefined;
|
|
const actionPromise = func().then(r => result = r).catch(e => error = e);
|
|
const errorPromise = new Promise<void>(resolve => {
|
|
listeners.push(eventsHelper.addEventListener(this._page, Page.Events.Console, (message: ConsoleMessage) => {
|
|
if (message.type() === 'error' && message.text().includes('Content Security Policy')) {
|
|
cspMessage = message;
|
|
resolve();
|
|
}
|
|
}));
|
|
});
|
|
await Promise.race([actionPromise, errorPromise]);
|
|
eventsHelper.removeEventListeners(listeners);
|
|
if (cspMessage)
|
|
throw new Error(cspMessage.text());
|
|
if (error)
|
|
throw error;
|
|
return result!;
|
|
}
|
|
|
|
async retryWithProgress<R>(
|
|
progress: Progress,
|
|
selector: string,
|
|
options: types.StrictOptions & types.TimeoutOptions & { omitAttached?: boolean },
|
|
action: (selector: SelectorInFrame | null, continuePolling: symbol) => Promise<R | symbol>,
|
|
scope?: dom.ElementHandle): Promise<R> {
|
|
const continuePolling = Symbol('continuePolling');
|
|
while (progress.isRunning()) {
|
|
let selectorInFrame: SelectorInFrame | null;
|
|
if (options.omitAttached) {
|
|
selectorInFrame = await this.resolveFrameForSelectorNoWait(selector, options, scope);
|
|
} else {
|
|
selectorInFrame = await this._resolveFrameForSelector(progress, selector, options, scope);
|
|
if (!selectorInFrame) {
|
|
// Missing content frame.
|
|
await new Promise(f => setTimeout(f, 100));
|
|
continue;
|
|
}
|
|
}
|
|
try {
|
|
const result = await action(selectorInFrame, continuePolling);
|
|
if (result === continuePolling)
|
|
continue;
|
|
return result as R;
|
|
} catch (e) {
|
|
// Always fail on JavaScript errors or when the main connection is closed.
|
|
if (js.isJavaScriptErrorInEvaluate(e) || isSessionClosedError(e))
|
|
throw e;
|
|
// Certain error opt-out of the retries, throw.
|
|
if (dom.isNonRecoverableDOMError(e))
|
|
throw e;
|
|
// If the call is made on the detached frame - throw.
|
|
if (this.isDetached())
|
|
throw e;
|
|
// If there is scope, and scope is within the frame we use to select, assume context is destroyed and
|
|
// operation is not recoverable.
|
|
if (scope && scope._context.frame === selectorInFrame?.frame)
|
|
throw e;
|
|
// Retry upon all other errors.
|
|
continue;
|
|
}
|
|
}
|
|
progress.throwIfAborted();
|
|
return undefined as any;
|
|
}
|
|
|
|
private async _retryWithProgressIfNotConnected<R>(
|
|
progress: Progress,
|
|
selector: string,
|
|
strict: boolean | undefined,
|
|
action: (handle: dom.ElementHandle<Element>) => Promise<R | 'error:notconnected'>): Promise<R> {
|
|
return this.retryWithProgress(progress, selector, { strict }, async (selectorInFrame, continuePolling) => {
|
|
// We did not pass omitAttached, so selectorInFrame is not null.
|
|
const { frame, info } = selectorInFrame!;
|
|
// Be careful, |this| can be different from |frame|.
|
|
const task = dom.waitForSelectorTask(info, 'attached');
|
|
progress.log(`waiting for "${this._asLocator(selector)}"`);
|
|
const handle = await frame._scheduleRerunnableHandleTask(progress, info.world, task);
|
|
const element = handle.asElement() as dom.ElementHandle<Element>;
|
|
try {
|
|
const result = await action(element);
|
|
if (result === 'error:notconnected') {
|
|
progress.log('element was detached from the DOM, retrying');
|
|
return continuePolling;
|
|
}
|
|
return result;
|
|
} finally {
|
|
element?.dispose();
|
|
}
|
|
});
|
|
}
|
|
|
|
async rafrafTimeoutScreenshotElementWithProgress(progress: Progress, selector: string, timeout: number, options: ScreenshotOptions): Promise<Buffer> {
|
|
return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, async handle => {
|
|
await handle._frame.rafrafTimeout(timeout);
|
|
return await this._page._screenshotter.screenshotElement(progress, handle, options);
|
|
});
|
|
}
|
|
|
|
async click(metadata: CallMetadata, selector: string, options: types.MouseClickOptions & types.PointerActionWaitOptions & types.NavigatingActionWaitOptions) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._click(progress, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async dblclick(metadata: CallMetadata, selector: string, options: types.MouseMultiClickOptions & types.PointerActionWaitOptions & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._dblclick(progress, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async dragAndDrop(metadata: CallMetadata, source: string, target: string, options: types.DragActionOptions & types.PointerActionWaitOptions & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
await controller.run(async progress => {
|
|
dom.assertDone(await this._retryWithProgressIfNotConnected(progress, source, options.strict, async handle => {
|
|
return handle._retryPointerAction(progress, 'move and down', false, async point => {
|
|
await this._page.mouse.move(point.x, point.y);
|
|
await this._page.mouse.down();
|
|
}, {
|
|
...options,
|
|
position: options.sourcePosition,
|
|
timeout: progress.timeUntilDeadline(),
|
|
});
|
|
}));
|
|
dom.assertDone(await this._retryWithProgressIfNotConnected(progress, target, options.strict, async handle => {
|
|
return handle._retryPointerAction(progress, 'move and up', false, async point => {
|
|
await this._page.mouse.move(point.x, point.y);
|
|
await this._page.mouse.up();
|
|
}, {
|
|
...options,
|
|
position: options.targetPosition,
|
|
timeout: progress.timeUntilDeadline(),
|
|
});
|
|
}));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async tap(metadata: CallMetadata, selector: string, options: types.PointerActionWaitOptions & types.NavigatingActionWaitOptions) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._tap(progress, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async fill(metadata: CallMetadata, selector: string, value: string, options: types.NavigatingActionWaitOptions & { force?: boolean }) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._fill(progress, value, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async focus(metadata: CallMetadata, selector: string, options: types.TimeoutOptions & types.StrictOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
await controller.run(async progress => {
|
|
dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._focus(progress)));
|
|
await this._page._doSlowMo();
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async blur(metadata: CallMetadata, selector: string, options: types.TimeoutOptions & types.StrictOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
await controller.run(async progress => {
|
|
dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._blur(progress)));
|
|
await this._page._doSlowMo();
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async textContent(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<string | null> {
|
|
return this._scheduleRerunnableTask(metadata, selector, (progress, element) => element.textContent, undefined, options);
|
|
}
|
|
|
|
async innerText(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<string> {
|
|
return this._scheduleRerunnableTask(metadata, selector, (progress, element) => {
|
|
if (element.namespaceURI !== 'http://www.w3.org/1999/xhtml')
|
|
throw progress.injectedScript.createStacklessError('Node is not an HTMLElement');
|
|
return (element as HTMLElement).innerText;
|
|
}, undefined, options);
|
|
}
|
|
|
|
async innerHTML(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<string> {
|
|
return this._scheduleRerunnableTask(metadata, selector, (progress, element) => element.innerHTML, undefined, options);
|
|
}
|
|
|
|
async getAttribute(metadata: CallMetadata, selector: string, name: string, options: types.QueryOnSelectorOptions = {}): Promise<string | null> {
|
|
return this._scheduleRerunnableTask(metadata, selector, (progress, element, data) => element.getAttribute(data.name), { name }, options);
|
|
}
|
|
|
|
async inputValue(metadata: CallMetadata, selector: string, options: types.TimeoutOptions & types.StrictOptions = {}): Promise<string> {
|
|
return this._scheduleRerunnableTask(metadata, selector, (progress, node) => {
|
|
const element = progress.injectedScript.retarget(node, 'follow-label');
|
|
if (!element || (element.nodeName !== 'INPUT' && element.nodeName !== 'TEXTAREA' && element.nodeName !== 'SELECT'))
|
|
throw progress.injectedScript.createStacklessError('Node is not an <input>, <textarea> or <select> element');
|
|
return (element as any).value;
|
|
}, undefined, options);
|
|
}
|
|
|
|
async highlight(selector: string) {
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector);
|
|
if (!pair)
|
|
return;
|
|
const context = await pair.frame._utilityContext();
|
|
const injectedScript = await context.injectedScript();
|
|
return await injectedScript.evaluate((injected, { parsed }) => {
|
|
return injected.highlight(parsed);
|
|
}, { parsed: pair.info.parsed });
|
|
}
|
|
|
|
async hideHighlight() {
|
|
return this.raceAgainstEvaluationStallingEvents(async () => {
|
|
const context = await this._utilityContext();
|
|
const injectedScript = await context.injectedScript();
|
|
return await injectedScript.evaluate(injected => {
|
|
return injected.hideHighlight();
|
|
});
|
|
});
|
|
}
|
|
|
|
private async _elementState(metadata: CallMetadata, selector: string, state: ElementStateWithoutStable, options: types.QueryOnSelectorOptions = {}): Promise<boolean> {
|
|
const result = await this._scheduleRerunnableTask(metadata, selector, (progress, element, data) => {
|
|
const injected = progress.injectedScript;
|
|
return injected.elementState(element, data.state);
|
|
}, { state }, options);
|
|
return dom.throwRetargetableDOMError(result);
|
|
}
|
|
|
|
async isVisible(metadata: CallMetadata, selector: string, options: types.StrictOptions = {}): Promise<boolean> {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
progress.log(` checking visibility of "${selector}"`);
|
|
const pair = await this.resolveFrameForSelectorNoWait(selector, options);
|
|
if (!pair)
|
|
return false;
|
|
const context = await pair.frame._context(pair.info.world);
|
|
const injectedScript = await context.injectedScript();
|
|
return await injectedScript.evaluate((injected, { parsed, strict }) => {
|
|
const element = injected.querySelector(parsed, document, strict);
|
|
const state = element ? injected.elementState(element, 'visible') : false;
|
|
return state === 'error:notconnected' ? false : state;
|
|
}, { parsed: pair.info.parsed, strict: pair.info.strict });
|
|
}, this._page._timeoutSettings.timeout({}));
|
|
}
|
|
|
|
async isHidden(metadata: CallMetadata, selector: string, options: types.StrictOptions = {}): Promise<boolean> {
|
|
return !(await this.isVisible(metadata, selector, options));
|
|
}
|
|
|
|
async isDisabled(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<boolean> {
|
|
return this._elementState(metadata, selector, 'disabled', options);
|
|
}
|
|
|
|
async isEnabled(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<boolean> {
|
|
return this._elementState(metadata, selector, 'enabled', options);
|
|
}
|
|
|
|
async isEditable(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<boolean> {
|
|
return this._elementState(metadata, selector, 'editable', options);
|
|
}
|
|
|
|
async isChecked(metadata: CallMetadata, selector: string, options: types.QueryOnSelectorOptions = {}): Promise<boolean> {
|
|
return this._elementState(metadata, selector, 'checked', options);
|
|
}
|
|
|
|
async hover(metadata: CallMetadata, selector: string, options: types.PointerActionOptions & types.PointerActionWaitOptions & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._hover(progress, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async selectOption(metadata: CallMetadata, selector: string, elements: dom.ElementHandle[], values: types.SelectOption[], options: types.NavigatingActionWaitOptions & types.ForceOptions = {}): Promise<string[]> {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._selectOption(progress, elements, values, options));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async setInputFiles(metadata: CallMetadata, selector: string, items: InputFilesItems, options: types.NavigatingActionWaitOptions = {}): Promise<channels.FrameSetInputFilesResult> {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._setInputFiles(progress, items, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async type(metadata: CallMetadata, selector: string, text: string, options: { delay?: number } & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._type(progress, text, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async press(metadata: CallMetadata, selector: string, key: string, options: { delay?: number } & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._press(progress, key, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async check(metadata: CallMetadata, selector: string, options: types.PointerActionWaitOptions & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._setChecked(progress, true, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async uncheck(metadata: CallMetadata, selector: string, options: types.PointerActionWaitOptions & types.NavigatingActionWaitOptions = {}) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, handle => handle._setChecked(progress, false, options)));
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async waitForTimeout(metadata: CallMetadata, timeout: number) {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async () => {
|
|
await new Promise(resolve => setTimeout(resolve, timeout));
|
|
});
|
|
}
|
|
|
|
async expect(metadata: CallMetadata, selector: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[] }> {
|
|
const controller = new ProgressController(metadata, this);
|
|
const isArray = options.expression === 'to.have.count' || options.expression.endsWith('.array');
|
|
const mainWorld = options.expression === 'to.have.property';
|
|
const timeout = this._page._timeoutSettings.timeout(options);
|
|
|
|
// List all combinations that are satisfied with the detached node(s).
|
|
let omitAttached = false;
|
|
if (!options.isNot && options.expression === 'to.be.hidden')
|
|
omitAttached = true;
|
|
else if (options.isNot && options.expression === 'to.be.visible')
|
|
omitAttached = true;
|
|
else if (!options.isNot && options.expression === 'to.have.count' && options.expectedNumber === 0)
|
|
omitAttached = true;
|
|
else if (options.isNot && options.expression === 'to.have.count' && options.expectedNumber !== 0)
|
|
omitAttached = true;
|
|
else if (!options.isNot && options.expression.endsWith('.array') && options.expectedText!.length === 0)
|
|
omitAttached = true;
|
|
else if (options.isNot && options.expression.endsWith('.array') && options.expectedText!.length > 0)
|
|
omitAttached = true;
|
|
|
|
return controller.run(async outerProgress => {
|
|
outerProgress.log(`${metadata.apiName}${timeout ? ` with timeout ${timeout}ms` : ''}`);
|
|
return await this._scheduleRerunnableTaskWithProgress(outerProgress, selector, (progress, element, options, elements) => {
|
|
let result: { matches: boolean, received?: any };
|
|
|
|
if (options.isArray) {
|
|
result = progress.injectedScript.expectArray(elements, options);
|
|
} else {
|
|
if (!element) {
|
|
// expect(locator).toBeHidden() passes when there is no element.
|
|
if (!options.isNot && options.expression === 'to.be.hidden')
|
|
return { matches: true };
|
|
// expect(locator).not.toBeVisible() passes when there is no element.
|
|
if (options.isNot && options.expression === 'to.be.visible')
|
|
return { matches: false };
|
|
// When none of the above applies, keep waiting for the element.
|
|
return progress.continuePolling;
|
|
}
|
|
result = progress.injectedScript.expectSingleElement(progress, element, options);
|
|
}
|
|
|
|
if (result.matches === options.isNot) {
|
|
// Keep waiting in these cases:
|
|
// expect(locator).conditionThatDoesNotMatch
|
|
// expect(locator).not.conditionThatDoesMatch
|
|
progress.setIntermediateResult(result.received);
|
|
if (!Array.isArray(result.received))
|
|
progress.log(` unexpected value "${result.received}"`);
|
|
return progress.continuePolling;
|
|
}
|
|
|
|
// Reached the expected state!
|
|
return result;
|
|
}, { ...options, isArray }, { strict: true, querySelectorAll: isArray, mainWorld, omitAttached, logScale: true, ...options });
|
|
}, timeout).catch(e => {
|
|
// Q: Why not throw upon isSessionClosedError(e) as in other places?
|
|
// A: We want user to receive a friendly message containing the last intermediate result.
|
|
if (js.isJavaScriptErrorInEvaluate(e) || isInvalidSelectorError(e))
|
|
throw e;
|
|
return { received: controller.lastIntermediateResult(), matches: options.isNot, log: metadata.log };
|
|
});
|
|
}
|
|
|
|
async _waitForFunctionExpression<R>(metadata: CallMetadata, expression: string, isFunction: boolean | undefined, arg: any, options: types.WaitForFunctionOptions, world: types.World = 'main'): Promise<js.SmartHandle<R>> {
|
|
const controller = new ProgressController(metadata, this);
|
|
if (typeof options.pollingInterval === 'number')
|
|
assert(options.pollingInterval > 0, 'Cannot poll with non-positive interval: ' + options.pollingInterval);
|
|
expression = js.normalizeEvaluationExpression(expression, isFunction);
|
|
const task: dom.SchedulableTask<R> = injectedScript => injectedScript.evaluateHandle((injectedScript, { expression, isFunction, polling, arg }) => {
|
|
const predicate = (arg: any): R => {
|
|
let result = self.eval(expression);
|
|
if (isFunction === true) {
|
|
result = result(arg);
|
|
} else if (isFunction === false) {
|
|
result = result;
|
|
} else {
|
|
// auto detect.
|
|
if (typeof result === 'function')
|
|
result = result(arg);
|
|
}
|
|
return result;
|
|
};
|
|
if (typeof polling !== 'number')
|
|
return injectedScript.pollRaf(progress => predicate(arg) || progress.continuePolling);
|
|
return injectedScript.pollInterval(polling, progress => predicate(arg) || progress.continuePolling);
|
|
}, { expression, isFunction, polling: options.pollingInterval, arg });
|
|
return controller.run(
|
|
progress => this._scheduleRerunnableHandleTask(progress, world, task),
|
|
this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
async waitForFunctionValueInUtility<R>(progress: Progress, pageFunction: js.Func1<any, R>) {
|
|
const expression = `() => {
|
|
const result = (${pageFunction})();
|
|
if (!result)
|
|
return result;
|
|
return JSON.stringify(result);
|
|
}`;
|
|
const handle = await this._waitForFunctionExpression(serverSideCallMetadata(), expression, true, undefined, { timeout: progress.timeUntilDeadline() }, 'utility');
|
|
return JSON.parse(handle.rawValue()) as R;
|
|
}
|
|
|
|
async title(): Promise<string> {
|
|
const context = await this._utilityContext();
|
|
return context.evaluate(() => document.title);
|
|
}
|
|
|
|
async rafrafTimeout(timeout: number): Promise<void> {
|
|
if (timeout === 0)
|
|
return;
|
|
const context = await this._utilityContext();
|
|
await Promise.all([
|
|
// wait for double raf
|
|
context.evaluate(() => new Promise(x => {
|
|
requestAnimationFrame(() => {
|
|
requestAnimationFrame(x);
|
|
});
|
|
})),
|
|
new Promise(fulfill => setTimeout(fulfill, timeout)),
|
|
]);
|
|
}
|
|
|
|
_onDetached() {
|
|
this._stopNetworkIdleTimer();
|
|
this._detached = true;
|
|
this._detachedCallback();
|
|
const error = new Error('Frame was detached');
|
|
for (const data of this._contextData.values()) {
|
|
if (data.context)
|
|
data.context.contextDestroyed(error);
|
|
data.contextPromise.resolve(error);
|
|
for (const rerunnableTask of data.rerunnableTasks)
|
|
rerunnableTask.terminate(error);
|
|
}
|
|
if (this._parentFrame)
|
|
this._parentFrame._childFrames.delete(this);
|
|
this._parentFrame = null;
|
|
}
|
|
|
|
private async _scheduleRerunnableTask<T, R>(metadata: CallMetadata, selector: string, body: DomTaskBody<T, R, Element>, taskData: T, options: types.TimeoutOptions & types.StrictOptions & { mainWorld?: boolean } = {}): Promise<R> {
|
|
const controller = new ProgressController(metadata, this);
|
|
return controller.run(async progress => {
|
|
return await this._scheduleRerunnableTaskWithProgress(progress, selector, body as DomTaskBody<T, R, Element | undefined>, taskData, options);
|
|
}, this._page._timeoutSettings.timeout(options));
|
|
}
|
|
|
|
private async _scheduleRerunnableTaskWithProgress<T, R>(
|
|
progress: Progress,
|
|
selector: string,
|
|
body: DomTaskBody<T, R, Element | undefined>,
|
|
taskData: T,
|
|
options: types.TimeoutOptions & types.StrictOptions & { mainWorld?: boolean, querySelectorAll?: boolean, logScale?: boolean, omitAttached?: boolean } = {}): Promise<R> {
|
|
|
|
const callbackText = body.toString();
|
|
return this.retryWithProgress(progress, selector, options, async selectorInFrame => {
|
|
// Be careful, |this| can be different from |frame|.
|
|
progress.log(`waiting for "${this._asLocator(selector)}"`);
|
|
const { frame, info } = selectorInFrame || { frame: this, info: { parsed: { parts: [{ name: 'internal:control', body: 'return-empty', source: 'internal:control=return-empty' }] }, world: 'utility', strict: !!options.strict } };
|
|
return await frame._scheduleRerunnableTaskInFrame(progress, info, callbackText, taskData, options);
|
|
});
|
|
}
|
|
|
|
private async _scheduleRerunnableTaskInFrame<T, R>(
|
|
progress: Progress,
|
|
info: SelectorInfo,
|
|
callbackText: string,
|
|
taskData: T,
|
|
options: types.TimeoutOptions & types.StrictOptions & { mainWorld?: boolean, querySelectorAll?: boolean, logScale?: boolean, omitAttached?: boolean }): Promise<R> {
|
|
progress.throwIfAborted();
|
|
const data = this._contextData.get(options.mainWorld ? 'main' : info!.world)!;
|
|
// This potentially runs in a sub-frame.
|
|
{
|
|
const rerunnableTask = new RerunnableTask<R>(data, progress, injectedScript => {
|
|
return injectedScript.evaluateHandle((injected, { info, taskData, callbackText, querySelectorAll, logScale, omitAttached, snapshotName }) => {
|
|
const callback = injected.eval(callbackText) as DomTaskBody<T, R, Element | undefined>;
|
|
const poller = logScale ? injected.pollLogScale.bind(injected) : injected.pollRaf.bind(injected);
|
|
let markedElements = new Set<Element>();
|
|
return poller(progress => {
|
|
let element: Element | undefined;
|
|
let elements: Element[] = [];
|
|
if (querySelectorAll) {
|
|
elements = injected.querySelectorAll(info.parsed, document);
|
|
element = elements[0];
|
|
progress.logRepeating(` selector resolved to ${elements.length} element${elements.length === 1 ? '' : 's'}`);
|
|
} else {
|
|
element = injected.querySelector(info.parsed, document, info.strict);
|
|
elements = element ? [element] : [];
|
|
if (element)
|
|
progress.logRepeating(` selector resolved to ${injected.previewNode(element)}`);
|
|
}
|
|
|
|
if (!element && !omitAttached)
|
|
return progress.continuePolling;
|
|
|
|
if (snapshotName) {
|
|
const previouslyMarkedElements = markedElements;
|
|
markedElements = new Set(elements);
|
|
for (const e of previouslyMarkedElements) {
|
|
if (!markedElements.has(e))
|
|
e.removeAttribute('__playwright_target__');
|
|
}
|
|
for (const e of markedElements) {
|
|
if (!previouslyMarkedElements.has(e))
|
|
e.setAttribute('__playwright_target__', snapshotName);
|
|
}
|
|
}
|
|
|
|
return callback(progress, element, taskData as T, elements);
|
|
});
|
|
}, { info, taskData, callbackText, querySelectorAll: options.querySelectorAll, logScale: options.logScale, omitAttached: options.omitAttached, snapshotName: progress.metadata.afterSnapshot });
|
|
}, true);
|
|
if (this._detached)
|
|
rerunnableTask.terminate(new Error('Frame got detached.'));
|
|
if (data.context)
|
|
rerunnableTask.rerun(data.context);
|
|
return await rerunnableTask.promise!;
|
|
}
|
|
}
|
|
|
|
private _scheduleRerunnableHandleTask<T>(progress: Progress, world: types.World, task: dom.SchedulableTask<T>): Promise<js.SmartHandle<T>> {
|
|
const data = this._contextData.get(world)!;
|
|
const rerunnableTask = new RerunnableTask<T>(data, progress, task, false /* returnByValue */);
|
|
if (this._detached)
|
|
rerunnableTask.terminate(new Error('waitForFunction failed: frame got detached.'));
|
|
if (data.context)
|
|
rerunnableTask.rerun(data.context);
|
|
return rerunnableTask.handlePromise!;
|
|
}
|
|
|
|
private _setContext(world: types.World, context: dom.FrameExecutionContext | null) {
|
|
const data = this._contextData.get(world)!;
|
|
data.context = context;
|
|
if (context) {
|
|
data.contextPromise.resolve(context);
|
|
for (const rerunnableTask of data.rerunnableTasks)
|
|
rerunnableTask.rerun(context);
|
|
} else {
|
|
data.contextPromise = new ManualPromise();
|
|
}
|
|
}
|
|
|
|
_contextCreated(world: types.World, context: dom.FrameExecutionContext) {
|
|
const data = this._contextData.get(world)!;
|
|
// In case of multiple sessions to the same target, there's a race between
|
|
// connections so we might end up creating multiple isolated worlds.
|
|
// We can use either.
|
|
if (data.context) {
|
|
data.context.contextDestroyed(new Error('Execution context was destroyed, most likely because of a navigation'));
|
|
this._setContext(world, null);
|
|
}
|
|
this._setContext(world, context);
|
|
}
|
|
|
|
_contextDestroyed(context: dom.FrameExecutionContext) {
|
|
// Sometimes we get this after detach, in which case we should not reset
|
|
// our already destroyed contexts to something that will never resolve.
|
|
if (this._detached)
|
|
return;
|
|
context.contextDestroyed(new Error('Execution context was destroyed, most likely because of a navigation'));
|
|
for (const [world, data] of this._contextData) {
|
|
if (data.context === context)
|
|
this._setContext(world, null);
|
|
}
|
|
}
|
|
|
|
_startNetworkIdleTimer() {
|
|
assert(!this._networkIdleTimer);
|
|
// We should not start a timer and report networkidle in detached frames.
|
|
// This happens at least in Firefox for child frames, where we may get requestFinished
|
|
// after the frame was detached - probably a race in the Firefox itself.
|
|
if (this._firedLifecycleEvents.has('networkidle') || this._detached)
|
|
return;
|
|
this._networkIdleTimer = setTimeout(() => {
|
|
this._firedNetworkIdleSelf = true;
|
|
this._page.mainFrame()._recalculateNetworkIdle();
|
|
}, 500);
|
|
}
|
|
|
|
_stopNetworkIdleTimer() {
|
|
if (this._networkIdleTimer)
|
|
clearTimeout(this._networkIdleTimer);
|
|
this._networkIdleTimer = undefined;
|
|
}
|
|
|
|
async extendInjectedScript(source: string, arg?: any): Promise<js.JSHandle> {
|
|
const context = await this._context('main');
|
|
const injectedScriptHandle = await context.injectedScript();
|
|
return injectedScriptHandle.evaluateHandle((injectedScript, { source, arg }) => {
|
|
return injectedScript.extend(source, arg);
|
|
}, { source, arg });
|
|
}
|
|
|
|
private async _resolveFrameForSelector(progress: Progress, selector: string, options: types.StrictOptions & types.TimeoutOptions, scope?: dom.ElementHandle): Promise<SelectorInFrame | null> {
|
|
const elementPath: dom.ElementHandle<Element>[] = [];
|
|
progress.cleanupWhenAborted(() => {
|
|
// Do not await here to avoid being blocked, either by stalled
|
|
// page (e.g. alert) or unresolved navigation in Chromium.
|
|
for (const element of elementPath)
|
|
element.dispose();
|
|
});
|
|
|
|
let frame: Frame | null = this;
|
|
const frameChunks = splitSelectorByFrame(selector);
|
|
|
|
for (let i = 0; i < frameChunks.length - 1 && progress.isRunning(); ++i) {
|
|
const info = this._page.parseSelector(frameChunks[i], options);
|
|
const task = dom.waitForSelectorTask(info, 'attached', false, i === 0 ? scope : undefined);
|
|
progress.log(` waiting for frame "${stringifySelector(frameChunks[i])}"`);
|
|
const handle = i === 0 && scope ? await frame._runWaitForSelectorTaskOnce(progress, stringifySelector(info.parsed), info.world, task)
|
|
: await frame._scheduleRerunnableHandleTask(progress, info.world, task);
|
|
const element = handle.asElement() as dom.ElementHandle<Element>;
|
|
const isIframe = await element.isIframeElement();
|
|
if (isIframe === 'error:notconnected')
|
|
return null; // retry
|
|
if (!isIframe)
|
|
throw new Error(`Selector "${stringifySelector(info.parsed)}" resolved to ${element.preview()}, <iframe> was expected`);
|
|
frame = await element.contentFrame();
|
|
element.dispose();
|
|
if (!frame)
|
|
return null; // retry
|
|
}
|
|
return { frame, info: this._page.parseSelector(frameChunks[frameChunks.length - 1], options) };
|
|
}
|
|
|
|
async resolveFrameForSelectorNoWait(selector: string, options: types.StrictOptions & types.TimeoutOptions = {}, scope?: dom.ElementHandle): Promise<SelectorInFrame | null> {
|
|
let frame: Frame | null = this;
|
|
const frameChunks = splitSelectorByFrame(selector);
|
|
|
|
for (let i = 0; i < frameChunks.length - 1; ++i) {
|
|
const info = this._page.parseSelector(frameChunks[i], options);
|
|
const element: dom.ElementHandle<Element> | null = await this._page.selectors.query(frame, info, i === 0 ? scope : undefined);
|
|
if (!element)
|
|
return null;
|
|
frame = await element.contentFrame();
|
|
element.dispose();
|
|
if (!frame)
|
|
throw new Error(`Selector "${stringifySelector(info.parsed)}" resolved to ${element.preview()}, <iframe> was expected`);
|
|
}
|
|
return { frame, info: this._page.parseSelector(frameChunks[frameChunks.length - 1], options) };
|
|
}
|
|
|
|
private async _runWaitForSelectorTaskOnce<T>(progress: Progress, selector: string, world: types.World, task: dom.SchedulableTask<T>): Promise<js.SmartHandle<T>> {
|
|
const context = await this._context(world);
|
|
const injected = await context.injectedScript();
|
|
try {
|
|
const pollHandler = new dom.InjectedScriptPollHandler(progress, await task(injected));
|
|
const result = await pollHandler.finishHandle();
|
|
progress.cleanupWhenAborted(() => result.dispose());
|
|
return result;
|
|
} catch (e) {
|
|
throw new Error(`Error: frame navigated while waiting for "${this._asLocator(selector)}"`);
|
|
}
|
|
}
|
|
|
|
async resetStorageForCurrentOriginBestEffort(newStorage: channels.OriginStorage | undefined) {
|
|
const context = await this._utilityContext();
|
|
await context.evaluate(async ({ ls }) => {
|
|
// Clean DOMStorage.
|
|
sessionStorage.clear();
|
|
localStorage.clear();
|
|
|
|
// Add new DOM Storage values.
|
|
for (const entry of ls || [])
|
|
localStorage[entry.name] = entry.value;
|
|
|
|
// Clean Service Workers
|
|
const registrations = navigator.serviceWorker ? await navigator.serviceWorker.getRegistrations() : [];
|
|
await Promise.all(registrations.map(r => r.unregister())).catch(() => {});
|
|
|
|
// Clean IndexedDB
|
|
for (const db of await indexedDB.databases?.() || []) {
|
|
// Do not wait for the callback - it is called on timer in Chromium (slow).
|
|
if (db.name)
|
|
indexedDB.deleteDatabase(db.name!);
|
|
}
|
|
}, { ls: newStorage?.localStorage }).catch(() => {});
|
|
}
|
|
|
|
private _asLocator(selector: string) {
|
|
return asLocator(this._page.context()._browser.options.sdkLanguage, selector);
|
|
}
|
|
}
|
|
|
|
class RerunnableTask<T> {
|
|
readonly promise: ManualPromise<T> | undefined;
|
|
readonly handlePromise: ManualPromise<js.SmartHandle<T>> | undefined;
|
|
private _task: dom.SchedulableTask<T>;
|
|
private _progress: Progress;
|
|
private _returnByValue: boolean;
|
|
private _contextData: ContextData;
|
|
|
|
constructor(data: ContextData, progress: Progress, task: dom.SchedulableTask<T>, returnByValue: boolean) {
|
|
this._task = task;
|
|
this._progress = progress;
|
|
this._returnByValue = returnByValue;
|
|
if (returnByValue)
|
|
this.promise = new ManualPromise<T>();
|
|
else
|
|
this.handlePromise = new ManualPromise<js.SmartHandle<T>>();
|
|
this._contextData = data;
|
|
this._contextData.rerunnableTasks.add(this);
|
|
}
|
|
|
|
terminate(error: Error) {
|
|
this._reject(error);
|
|
}
|
|
|
|
private _resolve(value: T | js.SmartHandle<T>) {
|
|
if (this.promise)
|
|
this.promise.resolve(value as T);
|
|
if (this.handlePromise)
|
|
this.handlePromise.resolve(value as js.SmartHandle<T>);
|
|
}
|
|
|
|
private _reject(error: Error) {
|
|
if (this.promise)
|
|
this.promise.reject(error);
|
|
if (this.handlePromise)
|
|
this.handlePromise.reject(error);
|
|
}
|
|
|
|
async rerun(context: dom.FrameExecutionContext) {
|
|
try {
|
|
const injectedScript = await context.injectedScript();
|
|
const pollHandler = new dom.InjectedScriptPollHandler(this._progress, await this._task(injectedScript));
|
|
const result = this._returnByValue ? await pollHandler.finish() : await pollHandler.finishHandle();
|
|
this._contextData.rerunnableTasks.delete(this);
|
|
this._resolve(result);
|
|
} catch (e) {
|
|
if (js.isJavaScriptErrorInEvaluate(e) || isSessionClosedError(e)) {
|
|
this._contextData.rerunnableTasks.delete(this);
|
|
this._reject(e);
|
|
}
|
|
|
|
// Unlike other places, we don't check frame for being detached since the whole scope of this
|
|
// evaluation is within the frame's execution context. So we only let JavaScript errors and
|
|
// session termination errors go through.
|
|
|
|
// We will try again in the new execution context.
|
|
}
|
|
}
|
|
}
|
|
|
|
class SignalBarrier {
|
|
private _progress: Progress | null;
|
|
private _protectCount = 0;
|
|
private _promise = new ManualPromise<void>();
|
|
|
|
constructor(progress: Progress | null) {
|
|
this._progress = progress;
|
|
this.retain();
|
|
}
|
|
|
|
waitFor(): PromiseLike<void> {
|
|
this.release();
|
|
return this._promise;
|
|
}
|
|
|
|
async addFrameNavigation(frame: Frame) {
|
|
// Auto-wait top-level navigations only.
|
|
if (frame.parentFrame())
|
|
return;
|
|
this.retain();
|
|
const waiter = helper.waitForEvent(null, frame, Frame.Events.InternalNavigation, (e: NavigationEvent) => {
|
|
if (!e.isPublic)
|
|
return false;
|
|
if (!e.error && this._progress)
|
|
this._progress.log(` navigated to "${frame._url}"`);
|
|
return true;
|
|
});
|
|
await Promise.race([
|
|
frame._page._disconnectedPromise,
|
|
frame._page._crashedPromise,
|
|
frame._detachedPromise,
|
|
waiter.promise,
|
|
]).catch(e => {});
|
|
waiter.dispose();
|
|
this.release();
|
|
}
|
|
|
|
retain() {
|
|
++this._protectCount;
|
|
}
|
|
|
|
release() {
|
|
--this._protectCount;
|
|
if (!this._protectCount)
|
|
this._promise.resolve();
|
|
}
|
|
}
|
|
|
|
function verifyLifecycle(name: string, waitUntil: types.LifecycleEvent): types.LifecycleEvent {
|
|
if (waitUntil as unknown === 'networkidle0')
|
|
waitUntil = 'networkidle';
|
|
if (!types.kLifecycleEvents.has(waitUntil))
|
|
throw new Error(`${name}: expected one of (load|domcontentloaded|networkidle|commit)`);
|
|
return waitUntil;
|
|
}
|