Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
/**
* 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 { Artifact } from './artifact';
import { apiCall } from './channelOwner';
import { DisposableStub } from './disposable';
import { kNoTimeout } from './timeoutSettings';
import type * as api from '../../types/types';
import type { ApiCallOptions } from './channelOwner';
import type { Page } from './page';
export class Screencast implements api.Screencast {
private _page: Page;
private _started = false;
private _savePath: string | undefined;
private _onFrame: ((frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>) | null = null;
private _artifact: Artifact | undefined;
constructor(page: Page) {
this._page = page;
this._page._channel.on('screencastFrame', async ({ frameId, data, timestamp, viewportWidth, viewportHeight }) => {
try {
await this._onFrame?.({ data, timestamp, viewportWidth, viewportHeight });
} finally {
await this._page._channel.screencastFrameAck({ frameId }, kNoTimeout).catch(() => {});
}
});
}
async _wrapApiCall<R>(func: () => Promise<R>, options?: ApiCallOptions): Promise<R> {
return await this._page._wrapApiCall(func, options);
}
async start(options: { onFrame?: (frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>|any, path?: string, size?: { width: number, height: number }, quality?: number, fps?: number } = {}): Promise<DisposableStub> {
if (this._started)
throw new Error('Screencast is already started');
this._started = true;
if (options.onFrame)
this._onFrame = options.onFrame;
const result = await this._page._channel.screencastStart({
size: options.size,
quality: options.quality,
fps: options.fps,
sendFrames: !!options.onFrame,
record: !!options.path,
}, kNoTimeout);
if (result.artifact) {
this._artifact = Artifact.from(result.artifact);
this._savePath = options.path;
}
return new DisposableStub(() => this.stop());
}
@apiCall()
async stop(): Promise<void> {
this._started = false;
this._onFrame = null;
await this._page._channel.screencastStop({}, kNoTimeout);
if (this._savePath)
await this._artifact?.saveAs(this._savePath);
this._artifact = undefined;
this._savePath = undefined;
}
async showActions(options?: { duration?: number, position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right', fontSize?: number, cursor?: 'none' | 'pointer', style?: { point?: string, highlight?: string, title?: string } }): Promise<DisposableStub> {
await this._page._channel.screencastShowActions({ duration: options?.duration, position: options?.position, fontSize: options?.fontSize, cursor: options?.cursor, style: options?.style }, kNoTimeout);
return new DisposableStub(() => this._page._channel.screencastHideActions({}, kNoTimeout));
}
async hideActions(): Promise<void> {
await this._page._channel.screencastHideActions({}, kNoTimeout);
}
async showOverlay(html: string, options?: { duration?: number }): Promise<DisposableStub> {
const { id } = await this._page._channel.screencastShowOverlay({ html, duration: options?.duration }, kNoTimeout);
return new DisposableStub(() => this._page._channel.screencastRemoveOverlay({ id }, kNoTimeout));
}
async showChapter(title: string, options?: { description?: string, duration?: number }): Promise<void> {
await this._page._channel.screencastChapter({ title, ...options }, kNoTimeout);
}
async showOverlays(): Promise<void> {
await this._page._channel.screencastSetOverlayVisible({ visible: true }, kNoTimeout);
}
async hideOverlays(): Promise<void> {
await this._page._channel.screencastSetOverlayVisible({ visible: false }, kNoTimeout);
}
}