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 * as z from 'zod';
import { defineTool } from './tool';
const videoStart = defineTool({
capability: 'devtools',
schema: {
name: 'browser_start_video',
title: 'Start video',
description: 'Start video recording',
inputSchema: z.object({
filename: z.string().optional().describe('File name to save the video to. Relative file names are resolved against the workspace root. If not specified, the video is saved into the output directory as `video-{timestamp}.webm`.'),
size: z.object({
width: z.number().describe('Video width'),
height: z.number().describe('Video height'),
}).optional().describe('Video size'),
fps: z.number().optional().describe('Video frame rate in frames per second, defaults to 25'),
cursor: z.boolean().optional().describe('Render an animated mouse cursor that travels to each action point. Paces actions by 800ms so that the cursor has time to travel.'),
}),
type: 'readOnly',
},
handle: async (context, params, response) => {
const resolvedFile = await response.resolveClientOutputFile({ prefix: 'video', ext: 'webm', suggestedFilename: params.filename }, 'Video');
await context.startVideoRecording(resolvedFile.fileName, { size: params.size, fps: params.fps, cursor: params.cursor });
response.addTextResult('Video recording started.');
},
});
const videoStop = defineTool({
capability: 'devtools',
schema: {
name: 'browser_stop_video',
title: 'Stop video',
description: 'Stop video recording',
inputSchema: z.object({}),
type: 'readOnly',
},
handle: async (context, params, response) => {
const fileNames = await context.stopVideoRecording();
if (!fileNames.length) {
response.addTextResult('No videos were recorded.');
return;
}
for (const fileName of fileNames) {
const resolvedFile = await response.resolveClientOutputFile({
prefix: 'video',
ext: 'webm',
suggestedFilename: fileName
}, 'Video');
await response.addFileResult(resolvedFile, null);
}
},
});
const videoChapter = defineTool({
capability: 'devtools',
schema: {
name: 'browser_video_chapter',
title: 'Video chapter',
description: 'Add a chapter marker to the video recording. Shows a full-screen chapter card with blurred backdrop.',
inputSchema: z.object({
title: z.string().describe('Chapter title'),
description: z.string().optional().describe('Chapter description'),
duration: z.number().optional().describe('Duration in milliseconds to show the chapter card'),
}),
type: 'readOnly',
},
handle: async (context, params, response) => {
const tab = context.currentTabOrDie();
await tab.page.screencast.showChapter(params.title, {
description: params.description,
duration: params.duration,
});
response.addTextResult(`Chapter '${params.title}' added.`);
},
});
const actionPosition = z.enum(['top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right']);
const actionCursor = z.enum(['none', 'pointer']);
const videoShowActions = defineTool({
capability: 'devtools',
schema: {
name: 'browser_video_show_actions',
title: 'Show action overlays',
description: 'Annotate subsequent actions performed on the page with a callout that names the action and, when styled, marks the action point and highlights the target element. Useful while video recording or screencasting.',
inputSchema: z.object({
duration: z.number().optional().describe('How long each action annotation stays on screen, in milliseconds. Defaults to 500.'),
position: actionPosition.optional().describe('Where to place the action title relative to the page. Defaults to top-right.'),
cursor: actionCursor.optional().describe('Cursor decoration for pointer actions. "pointer" (default) animates a mouse pointer from the previous action point to the next one; "none" disables the cursor decoration.'),
style: z.object({
point: z.string().optional().describe('CSS declarations for the zero-sized marker centered on the action point, e.g. "width: 20px; height: 20px; border-radius: 50%; background: red". Not shown when omitted.'),
highlight: z.string().optional().describe('CSS declarations for the box that covers the target element, e.g. "outline: 2px solid #333". Not shown when omitted.'),
title: z.string().optional().describe('CSS declarations for the action title, e.g. "font-size: 16px".'),
}).optional().describe('Styles of the action decorations.'),
}),
type: 'readOnly',
},
handle: async (context, params, response) => {
const tab = context.currentTabOrDie();
await tab.page.screencast.showActions({
duration: params.duration,
position: params.position,
cursor: params.cursor,
style: params.style,
});
response.addTextResult('Action annotations enabled.');
},
});
const videoHideActions = defineTool({
capability: 'devtools',
schema: {
name: 'browser_video_hide_actions',
title: 'Hide action overlays',
description: 'Stop annotating actions performed on the page.',
inputSchema: z.object({}),
type: 'readOnly',
},
handle: async (context, params, response) => {
const tab = context.currentTabOrDie();
await tab.page.screencast.hideActions();
response.addTextResult('Action annotations disabled.');
},
});
export default [
videoStart,
videoStop,
videoChapter,
videoShowActions,
videoHideActions,
];