/** * 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 playwright from 'playwright'; import type { ToolResult } from './tool'; import type { Context } from '../context'; async function waitForCompletion(page: playwright.Page, callback: () => Promise): Promise { const requests = new Set(); let frameNavigated = false; let waitCallback: () => void = () => {}; const waitBarrier = new Promise(f => { waitCallback = f; }); const requestListener = (request: playwright.Request) => requests.add(request); const requestFinishedListener = (request: playwright.Request) => { requests.delete(request); if (!requests.size) waitCallback(); }; const frameNavigateListener = (frame: playwright.Frame) => { if (frame.parentFrame()) return; frameNavigated = true; dispose(); clearTimeout(timeout); void frame.waitForLoadState('load').then(() => { waitCallback(); }); }; const onTimeout = () => { dispose(); waitCallback(); }; page.on('request', requestListener); page.on('requestfinished', requestFinishedListener); page.on('framenavigated', frameNavigateListener); const timeout = setTimeout(onTimeout, 10000); const dispose = () => { page.off('request', requestListener); page.off('requestfinished', requestFinishedListener); page.off('framenavigated', frameNavigateListener); clearTimeout(timeout); }; try { const result = await callback(); if (!requests.size && !frameNavigated) waitCallback(); await waitBarrier; await page.evaluate(() => new Promise(f => setTimeout(f, 1000))); return result; } finally { dispose(); } } export async function runAndWait(context: Context, status: string, callback: (page: playwright.Page) => Promise, snapshot: boolean = false): Promise { const page = context.existingPage(); const dismissFileChooser = context.hasFileChooser(); await waitForCompletion(page, () => callback(page)); if (dismissFileChooser) context.clearFileChooser(); const result: ToolResult = snapshot ? await captureAriaSnapshot(context, status) : { content: [{ type: 'text', text: status }], }; return result; } export async function captureAriaSnapshot(context: Context, status: string = ''): Promise { const page = context.existingPage(); const lines = []; if (status) lines.push(`${status}`); lines.push( '', `- Page URL: ${page.url()}`, `- Page Title: ${await page.title()}` ); if (context.hasFileChooser()) lines.push(`- There is a file chooser visible that requires browser_choose_file to be called`); lines.push( `- Page Snapshot`, '```yaml', await context.allFramesSnapshot(), '```', '' ); return { content: [{ type: 'text', text: lines.join('\n') }], }; } export function sanitizeForFilePath(s: string) { return s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-'); }