Files
Agent-Workbench/src/core/browser/browser-driver.mjs
T

218 lines
18 KiB
JavaScript

import fs from 'node:fs';
import path from 'node:path';
import http from 'node:http';
import { createRequire } from 'node:module';
import { randomUUID } from 'node:crypto';
import { setTimeout as pause } from 'node:timers/promises';
import { PREVIEW_MIME } from './build-snapshot.mjs';
import { BROWSER_LIMITS, browserError, browserHash } from '../../shared/contracts/browser.mjs';
const at = () => new Date().toISOString();
const identity = file => {
if (fs.lstatSync(file).isSymbolicLink() || !fs.statSync(file).isFile()) throw browserError('浏览器运行输入不能是链接或非常规文件。');
return { path: fs.realpathSync.native(file), sha256: browserHash(fs.readFileSync(file)) };
};
export function browserInstallation(appDirectory = process.cwd()) {
try {
const moduleRoot = [path.join(appDirectory, 'runtime', 'node_modules'), path.join(appDirectory, 'node_modules')]
.find(root => fs.existsSync(path.join(root, 'playwright', 'index.js')) && fs.existsSync(path.join(root, 'playwright-core', 'index.js')));
if (!moduleRoot) throw new Error('缺少随包Playwright1.64.1运行库。');
const pkg = JSON.parse(fs.readFileSync(path.join(moduleRoot, 'playwright', 'package.json'), 'utf8'));
const core = JSON.parse(fs.readFileSync(path.join(moduleRoot, 'playwright-core', 'package.json'), 'utf8'));
if (pkg.version !== '1.64.1' || core.version !== pkg.version) throw new Error('浏览器运行库版本需要固定为Playwright1.64.1。');
const executable = [process.env['ProgramFiles(x86)'], process.env.ProgramFiles, process.env.LOCALAPPDATA].filter(Boolean)
.map(root => path.join(root, 'Microsoft', 'Edge', 'Application', 'msedge.exe')).find(file => fs.existsSync(file));
if (process.platform !== 'win32' || !executable) throw new Error('未检测到本机Microsoft Edge,请安装Edge后重新准备浏览器检查。');
const inputs = ['playwright/package.json', 'playwright/index.js', 'playwright-core/package.json', 'playwright-core/index.js',
'playwright-core/lib/bootstrap.js', 'playwright-core/lib/coreBundle.js', 'playwright-core/lib/utilsBundle.js', 'playwright-core/lib/serverRegistry.js', 'playwright-core/browsers.json']
.map(file => identity(path.join(moduleRoot, file)));
return { status: 'available', engine: 'Microsoft Edge', playwrightVersion: pkg.version, modulePath: inputs[1].path,
executable: identity(executable), node: identity(process.execPath), inputs, fingerprint: browserHash(inputs) };
} catch (error) { return { status: 'missing', message: error.message, engine: 'Microsoft Edge', playwrightVersion: '1.64.1' }; }
}
export function verifyBrowserInstallation(installation) {
if (installation.status !== 'available') throw browserError(installation.message ?? '浏览器运行库不可用。');
for (const input of [...installation.inputs, installation.executable, installation.node]) {
const current = identity(input.path);
if (current.path !== input.path || current.sha256 !== input.sha256) throw browserError('浏览器或运行库在计划后变化,请重新准备浏览器检查。');
}
}
const browserEnvironment = () => Object.fromEntries(Object.entries(process.env).filter(([key]) =>
/^(PATH|SYSTEMROOT|WINDIR|TEMP|TMP|LOCALAPPDATA|PROGRAMFILES|PROGRAMFILES\(X86\)|PROGRAMW6432|USERPROFILE|COMSPEC)$/i.test(key)));
async function startPreview(snapshot, plan) {
const nonce = randomUUID(), files = new Map(plan.build.files.map(file => [file.path, file]));
const server = http.createServer((request, response) => {
try {
if (!['GET', 'HEAD'].includes(request.method) || request.headers.host !== '127.0.0.1:' + server.address().port || request.headers['x-workbench-preview'] !== nonce) {
response.writeHead(403); response.end(); return;
}
const pathname = decodeURIComponent(new URL(request.url, 'http://127.0.0.1').pathname);
if (/[\\\0]/.test(pathname) || pathname.split('/').includes('..')) { response.writeHead(400); response.end(); return; }
let name = pathname.replace(/^\/+/, '') || 'index.html';
if (name === 'favicon.ico' && !files.has(name)) { response.writeHead(204); response.end(); return; }
if (!files.has(name) && !path.extname(name) && String(request.headers.accept ?? '').includes('text/html')) name = 'index.html';
const manifest = files.get(name);
if (!manifest) { response.writeHead(404); response.end(); return; }
const target = path.resolve(snapshot.directory, name);
if (!target.startsWith(snapshot.directory + path.sep) || fs.lstatSync(target).isSymbolicLink()) { response.writeHead(403); response.end(); return; }
const bytes = fs.readFileSync(target);
if (bytes.length !== manifest.bytes || browserHash(bytes) !== manifest.sha256) { response.writeHead(409); response.end(); return; }
response.writeHead(200, { 'Content-Type': PREVIEW_MIME[path.extname(name).toLowerCase()], 'Cache-Control': 'no-store',
'X-Content-Type-Options': 'nosniff', 'Referrer-Policy': 'no-referrer',
'Content-Security-Policy': "object-src 'none'; frame-src 'none'; worker-src 'none'; base-uri 'self'; form-action 'self'" });
response.end(request.method === 'HEAD' ? undefined : bytes);
} catch { if (!response.headersSent) response.writeHead(400); response.end(); }
});
await new Promise((resolve, reject) => { server.once('error', reject); server.listen(0, '127.0.0.1', resolve); });
return { origin: 'http://127.0.0.1:' + server.address().port, nonce, server,
async close() { server.closeAllConnections(); await new Promise(resolve => server.close(resolve)); } };
}
async function observe(page) {
return page.evaluate(({ textLimit }) => {
const body = document.body, text = body?.innerText ?? '';
const controls = [...document.querySelectorAll('button,input,select,textarea,a,[role="button"],[data-testid]')];
const uniqueSelector = node => {
const unique = selector => {
if (!selector || selector.length > 300) return false;
try { const matches = document.querySelectorAll(selector); return matches.length === 1 && matches[0] === node; } catch { return false; }
};
const candidates = node.id ? ['#' + CSS.escape(node.id)] : [];
for (const attribute of ['data-testid', 'aria-label', 'name']) {
const value = node.getAttribute(attribute);
if (value) candidates.push(node.tagName.toLowerCase() + '[' + attribute + '="' + CSS.escape(value) + '"]');
}
for (const selector of candidates) if (unique(selector)) return { selector, selectorMatches: 1, selectorEvidence: 'observed-dom-query' };
let current = node, parts = [];
for (let depth = 0; current?.parentElement && depth < 12; depth++, current = current.parentElement) {
const siblings = [...current.parentElement.children].filter(value => value.tagName === current.tagName);
parts.unshift(current.tagName.toLowerCase() + ':nth-of-type(' + (siblings.indexOf(current) + 1) + ')');
const selector = parts.join(' > ');
if (unique(selector)) return { selector, selectorMatches: 1, selectorEvidence: 'observed-dom-query' };
}
return { selector: null, selectorMatches: null, selectorEvidence: 'unavailable' };
};
return { url: location.href, title: document.title.slice(0, 300), text: text.slice(0, textLimit), textCharacters: text.length,
textTruncated: text.length > textLimit, viewport: { width: innerWidth, height: innerHeight, scrollWidth: body?.scrollWidth ?? 0 },
controls: controls.slice(0, 80).map(node => ({ ...uniqueSelector(node), tag: node.tagName.toLowerCase(), id: node.id?.slice(0, 200) ?? '',
role: node.getAttribute('role'), label: node.getAttribute('aria-label')?.slice(0, 300) ?? '',
text: (node.innerText ?? '').slice(0, 300), type: node.getAttribute('type'), testId: node.getAttribute('data-testid'),
value: typeof node.value === 'string' ? node.value.slice(0, 1000) : null, disabled: !!node.disabled,
options: node.tagName === 'SELECT' ? [...node.options].slice(0, 30).map(option => ({ value: option.value.slice(0, 200), text: option.text.slice(0, 300) })) : undefined })),
controlsTruncated: controls.length > 80 };
}, { textLimit: BROWSER_LIMITS.text });
}
async function untilActual(read, matches, signal) {
const deadline = Date.now() + BROWSER_LIMITS.stepTimeoutMs; let actual;
do {
signal.throwIfAborted(); actual = await read(); if (matches(actual)) return actual;
if (Date.now() < deadline) await pause(50, undefined, { signal });
} while (Date.now() < deadline);
throw Object.assign(new Error('页面断言未满足预期,实际值:' + JSON.stringify(actual).slice(0, 600)), { actual });
}
async function perform(page, step, signal) {
const locator = page.locator(step.selector);
if (step.action === 'assert_count') return untilActual(() => locator.count(), value => value === step.count, signal);
if (step.action === 'assert_visible') return untilActual(() => locator.isVisible(), value => value === (step.visible ?? true), signal);
if (step.action === 'assert_text') return untilActual(() => locator.innerText({ timeout: BROWSER_LIMITS.stepTimeoutMs }),
value => step.contains ? value.includes(step.text) : value.trim() === step.text, signal);
if (await locator.count() !== 1) throw new Error('交互选择器必须唯一,请根据实际DOM重新定位:' + step.selector);
if (step.action === 'fill') { await locator.fill(step.value); return await locator.inputValue(); }
if (step.action === 'select') return await locator.selectOption(step.value);
await locator.click({ noWaitAfter: true }); return { clicked: true };
}
export class BrowserDriver {
async run(snapshot, plan, { signal, onConnection = () => {}, onPhase = () => {}, onStep = () => {} } = {}) {
const result = { schemaVersion: 1, kind: 'browser-execution', startedAt: at(), status: 'failed', steps: [], pages: [], console: [],
pageErrors: [], requests: [], requestFailures: [], blockedRequests: [], policyEvents: [], screenshots: [], cleanup: null, limits: { ...BROWSER_LIMITS } };
let preview, browserServer, browser, page, processExit, closePromise, launchDispatched = false; const images = [];
const append = (key, value) => {
if (result[key].length < BROWSER_LIMITS.records) result[key].push(value);
else result.outputTruncated = true;
};
const closeBrowser = async () => {
if (!browserServer) return;
return closePromise ??= browserServer.close().catch(error => { result.closeError = error.message.slice(0, 1000); });
};
const abort = () => { closeBrowser().catch(() => {}); };
const capture = async label => {
if (!page || page.isClosed() || signal.aborted) return;
const observed = await observe(page); observed.label = label; result.pages.push(observed);
const bytes = await page.screenshot({ type: 'png', fullPage: false, animations: 'disabled', scale: 'css', timeout: BROWSER_LIMITS.stepTimeoutMs });
if (bytes.length > BROWSER_LIMITS.fileBytes) throw new Error('页面截图超过8MB保存上限。');
const image = { label, bytes, sha256: browserHash(bytes), width: plan.viewport.width, height: plan.viewport.height };
images.push(image); result.screenshots.push({ label, sha256: image.sha256, bytes: bytes.length, width: image.width, height: image.height });
};
try {
signal.throwIfAborted(); verifyBrowserInstallation(plan.installation);
preview = await startPreview(snapshot, plan); result.origin = preview.origin;
onPhase('launching');
const { chromium } = createRequire(plan.installation.modulePath)(plan.installation.modulePath);
launchDispatched = true;
browserServer = await chromium.launchServer({ executablePath: plan.installation.executable.path, headless: true, timeout: 15000,
host: '127.0.0.1', port: 0, env: browserEnvironment() });
const child = browserServer.process(); result.connection = { pid: child.pid, startedAt: at(), executable: plan.installation.executable, isolatedProfile: true };
processExit = child.exitCode !== null ? Promise.resolve() : new Promise(resolve => child.once('exit', resolve)); onConnection(result.connection);
signal.addEventListener('abort', abort, { once: true }); signal.throwIfAborted();
browser = await chromium.connect(browserServer.wsEndpoint()); result.browserVersion = browser.version();
const context = await browser.newContext({ viewport: plan.viewport, deviceScaleFactor: 1, serviceWorkers: 'block', acceptDownloads: false,
extraHTTPHeaders: { 'X-Workbench-Preview': preview.nonce }, locale: 'zh-CN', reducedMotion: 'reduce' });
await context.route('**/*', route => {
const request = route.request(), url = new URL(request.url());
if (url.origin !== preview.origin || !['GET', 'HEAD'].includes(request.method())) {
append('blockedRequests', { url: request.url().slice(0, 700), method: request.method(), at: at(), reason: 'outside-owned-static-preview' });
return route.abort('blockedbyclient').catch(() => {});
}
return route.continue().catch(() => {});
});
await context.routeWebSocket('**/*', socket => { append('policyEvents', { type: 'websocket', url: socket.url().slice(0, 700), at: at() }); socket.close(); });
context.on('page', opened => { if (page && opened !== page) { append('policyEvents', { type: 'popup', at: at() }); opened.close().catch(() => {}); } });
page = await context.newPage(); page.setDefaultTimeout(BROWSER_LIMITS.stepTimeoutMs); page.setDefaultNavigationTimeout(10000);
page.on('console', message => append('console', { type: message.type(), text: message.text().slice(0, 2000), at: at() }));
page.on('pageerror', error => append('pageErrors', { message: error.message.slice(0, 2000), at: at() }));
page.on('response', response => append('requests', { url: response.url().slice(0, 700), status: response.status(), at: at() }));
page.on('requestfailed', request => append('requestFailures', { url: request.url().slice(0, 700), error: request.failure()?.errorText ?? '', at: at() }));
page.on('download', download => { append('policyEvents', { type: 'download', at: at() }); download.cancel().catch(() => {}); });
page.on('dialog', dialog => { append('policyEvents', { type: 'dialog', message: dialog.message().slice(0, 600), at: at() }); dialog.dismiss().catch(() => {}); });
onPhase('running'); await page.goto(preview.origin + plan.path, { waitUntil: 'networkidle', timeout: 10000 }); signal.throwIfAborted(); await capture('initial');
for (let index = 0; index < plan.steps.length; index++) {
signal.throwIfAborted(); const step = plan.steps[index], record = { index, ...step, startedAt: at(), status: 'failed' };
try { record.actual = await perform(page, step, signal); record.status = 'passed'; }
catch (error) { record.error = error.message.slice(0, 1200); if (error.actual !== undefined) record.actual = error.actual; }
if (typeof record.actual === 'string' && record.actual.length > 4000) { record.actualSha256 = browserHash(record.actual); record.actual = record.actual.slice(0, 4000); record.actualTruncated = true; }
record.finishedAt = at(); result.steps.push(record); await onStep(record);
if (record.status !== 'passed') throw new Error('第' + (index + 1) + '步失败:' + record.error);
}
await page.waitForLoadState('networkidle', { timeout: BROWSER_LIMITS.stepTimeoutMs }); await capture('final');
result.assertions = { total: result.steps.filter(step => step.action.startsWith('assert_')).length,
passed: result.steps.filter(step => step.action.startsWith('assert_') && step.status === 'passed').length,
failed: result.steps.filter(step => step.action.startsWith('assert_') && step.status !== 'passed').length };
const problems = result.pageErrors.length || result.console.some(item => item.type === 'error') || result.requestFailures.length
|| result.blockedRequests.length || result.requests.some(item => item.status >= 400) || result.policyEvents.length || result.outputTruncated;
result.status = problems ? 'failed' : result.assertions.total ? 'passed' : 'observed';
if (problems) result.error = '页面出现脚本、控制台、请求或执行范围错误,请查看原记录。';
} catch (error) {
result.status = signal.aborted ? signal.reason?.name === 'TimeoutError' ? 'failed' : 'interrupted' : 'failed';
result.timedOut = signal.aborted && signal.reason?.name === 'TimeoutError'; result.error = error.message.slice(0, 2000);
try { if (result.pages.length < 2) await capture('failure'); } catch (captureError) { result.captureError = captureError.message.slice(0, 600); }
} finally {
signal.removeEventListener('abort', abort);
try { onPhase('closing'); } catch (error) { result.phaseError = error.message.slice(0, 1000); }
await closeBrowser();
if (browserServer) {
const child = browserServer.process(); await Promise.race([processExit, pause(5000, undefined, { ref: false })]);
if (child.exitCode === null && child.signalCode === null) { try { child.kill(); } catch {} await Promise.race([processExit, pause(1000, undefined, { ref: false })]); }
result.cleanup = { pid: child.pid, exited: child.exitCode !== null || child.signalCode !== null, exitCode: child.exitCode, signal: child.signalCode, finishedAt: at() };
} else result.cleanup = { pid: null, exited: !launchDispatched, launched: launchDispatched ? 'unknown' : false, finishedAt: at() };
if (preview) { await preview.close(); result.cleanup.previewClosed = true; }
result.finishedAt = at();
}
result.assertions ??= { total: result.steps.filter(step => step.action.startsWith('assert_')).length,
passed: result.steps.filter(step => step.action.startsWith('assert_') && step.status === 'passed').length,
failed: result.steps.filter(step => step.action.startsWith('assert_') && step.status !== 'passed').length };
return { record: result, images };
}
}