refactor: extract TabSession for per-tab state isolation (v0.15.16.0) (#873)

* plan: batch command endpoint + multi-tab parallel execution for GStack Browser

* refactor: extract TabSession from BrowserManager for per-tab state

Move per-tab state (refMap, lastSnapshot, frame) into a new TabSession
class. BrowserManager delegates to the active TabSession via
getActiveSession(). Zero behavior change — all existing tests pass.

This is the foundation for the /batch endpoint: both /command and /batch
will use the same handler functions with TabSession, eliminating shared
state races during parallel tab execution.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* refactor: update handler signatures to use TabSession

Change handleReadCommand and handleSnapshot to take TabSession instead of
BrowserManager. Change handleWriteCommand to take both TabSession (per-tab
ops) and BrowserManager (global ops like viewport, headers, dialog).
handleMetaCommand keeps BrowserManager for tab management.

Tests use thin wrapper functions that bridge the old 3-arg call pattern to
the new signatures via bm.getActiveSession().

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* feat: add POST /batch endpoint for parallel multi-tab execution

Execute multiple commands across tabs in a single HTTP request.
Commands targeting different tabs run concurrently via Promise.allSettled.
Commands targeting the same tab run sequentially within that group.

Features:
- Batch-safe command subset (text, goto, click, snapshot, screenshot, etc.)
- newtab/closetab as special commands within batch
- SSE streaming mode (stream: true) for partial results
- Per-command error isolation (one tab failing doesn't abort the batch)
- Max 50 commands per batch, soft batch-level timeout

A 143-page crawl drops from ~45 min (serial HTTP) to ~5 min (20 tabs
in parallel, batched commands).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* test: add batch endpoint integration tests

10 tests covering:
- Multi-tab parallel execution (goto + text on different tabs)
- Same-tab sequential ordering
- Per-command error isolation (one tab fails, others succeed)
- Page-scoped refs (snapshot refs are per-session, not global)
- Per-tab lastSnapshot (snapshot -D with independent baselines)
- getSession/getActiveSession API
- Batch-safe command subset validation
- closeTab via page.close preserves at-least-one-page invariant
- Parallel goto on 3 tabs simultaneously

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: harden codex-review E2E — extract SKILL.md section, bump maxTurns to 25

The test was copying the full 55KB/1075-line codex SKILL.md into the fixture,
requiring 8 Read calls just to consume it and exhausting the 15-turn budget
before reaching the actual codex review command. Now extracts only the
review-relevant section (~6KB/148 lines), reducing Read calls from 8 to 1.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* docs: move batch endpoint plan into BROWSER.md as feature documentation

The batch endpoint is implemented — document it as an actual feature in
BROWSER.md (architecture, API shape, design decisions, usage pattern)
and remove the standalone plan file.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: bump version and changelog (v0.15.16.0)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: gstack <ship@gstack.dev>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Garry Tan
2026-04-07 00:23:36 -07:00
committed by GitHub
parent 6cc094cd41
commit 1868636f49
17 changed files with 617 additions and 152 deletions
+67 -81
View File
@@ -18,12 +18,12 @@
import { chromium, type Browser, type BrowserContext, type BrowserContextOptions, type Page, type Locator, type Cookie } from 'playwright';
import { addConsoleEntry, addNetworkEntry, addDialogEntry, networkBuffer, type DialogEntry } from './buffers';
import { validateNavigationUrl } from './url-validation';
import { TabSession, type RefEntry } from './tab-session';
export interface RefEntry {
locator: Locator;
role: string;
name: string;
}
export type { RefEntry };
// Re-export TabSession for consumers
export { TabSession };
export interface BrowserState {
cookies: Cookie[];
@@ -38,6 +38,7 @@ export class BrowserManager {
private browser: Browser | null = null;
private context: BrowserContext | null = null;
private pages: Map<number, Page> = new Map();
private tabSessions: Map<number, TabSession> = new Map();
private activeTabId: number = 0;
private nextTabId: number = 1;
private extraHeaders: Record<string, string> = {};
@@ -50,14 +51,7 @@ export class BrowserManager {
// Maps tabId → clientId. Unowned tabs (not in this map) are root-only for writes.
private tabOwnership: Map<number, string> = new Map();
// ─── Ref Map (snapshot → @e1, @e2, @c1, @c2, ...) ────────
private refMap: Map<string, RefEntry> = new Map();
// ─── Snapshot Diffing ─────────────────────────────────────
// NOT cleared on navigation — it's a text baseline for diffing
private lastSnapshot: string | null = null;
// ─── Dialog Handling ──────────────────────────────────────
// ─── Dialog Handling (global, not per-tab) ──────────────────
private dialogAutoAccept: boolean = true;
private dialogPromptText: string | null = null;
@@ -142,11 +136,11 @@ export class BrowserManager {
* Get the ref map for external consumers (e.g., /refs endpoint).
*/
getRefMap(): Array<{ ref: string; role: string; name: string }> {
const refs: Array<{ ref: string; role: string; name: string }> = [];
for (const [ref, entry] of this.refMap) {
refs.push({ ref, role: entry.role, name: entry.name });
try {
return this.getActiveSession().getRefEntries();
} catch {
return [];
}
return refs;
}
async launch() {
@@ -220,7 +214,7 @@ export class BrowserManager {
async launchHeaded(authToken?: string): Promise<void> {
// Clear old state before repopulating
this.pages.clear();
this.refMap.clear();
this.tabSessions.clear();
this.nextTabId = 1;
// Find the gstack extension directory for auto-loading
@@ -434,6 +428,7 @@ export class BrowserManager {
this.context.on('page', (page) => {
const id = this.nextTabId++;
this.pages.set(id, page);
this.tabSessions.set(id, new TabSession(page));
this.activeTabId = id;
this.wirePageEvents(page);
// Inject indicator on the new tab
@@ -447,6 +442,7 @@ export class BrowserManager {
const page = existingPages[0];
const id = this.nextTabId++;
this.pages.set(id, page);
this.tabSessions.set(id, new TabSession(page));
this.activeTabId = id;
this.wirePageEvents(page);
// Inject indicator on restored page (addInitScript only fires on new navigations)
@@ -521,6 +517,7 @@ export class BrowserManager {
const page = await this.context.newPage();
const id = this.nextTabId++;
this.pages.set(id, page);
this.tabSessions.set(id, new TabSession(page));
this.activeTabId = id;
// Record tab ownership for multi-agent isolation
@@ -545,6 +542,7 @@ export class BrowserManager {
await page.close();
this.pages.delete(tabId);
this.tabSessions.delete(tabId);
this.tabOwnership.delete(tabId);
// Switch to another tab if we closed the active one
@@ -560,9 +558,8 @@ export class BrowserManager {
}
switchTab(id: number, opts?: { bringToFront?: boolean }): void {
if (!this.pages.has(id)) throw new Error(`Tab ${id} not found`);
if (!this.tabSessions.has(id)) throw new Error(`Tab ${id} not found`);
this.activeTabId = id;
this.activeFrame = null; // Frame context is per-tab
// Only bring to front when explicitly requested (user-initiated tab switch).
// Internal tab pinning (BROWSE_TAB) should NOT steal focus.
if (opts?.bringToFront !== false) {
@@ -592,7 +589,6 @@ export class BrowserManager {
// Exact match — best case
if (pageUrl === activeUrl && id !== this.activeTabId) {
this.activeTabId = id;
this.activeFrame = null;
return;
}
// Fuzzy match — origin+pathname (handles query param / fragment differences)
@@ -609,7 +605,6 @@ export class BrowserManager {
// Fall back to fuzzy match
if (fuzzyId !== null) {
this.activeTabId = fuzzyId;
this.activeFrame = null;
}
}
@@ -662,11 +657,24 @@ export class BrowserManager {
return tabs;
}
// ─── Page Access ───────────────────────────────────────────
// ─── Session Access ────────────────────────────────────────
/** Get the TabSession for the active tab. */
getActiveSession(): TabSession {
const session = this.tabSessions.get(this.activeTabId);
if (!session) throw new Error('No active page. Use "browse goto <url>" first.');
return session;
}
/** Get a TabSession by tab ID. Used by /batch for parallel tab execution. */
getSession(tabId: number): TabSession {
const session = this.tabSessions.get(tabId);
if (!session) throw new Error(`Tab ${tabId} not found`);
return session;
}
// ─── Page Access (delegates to active session) ─────────────
getPage(): Page {
const page = this.pages.get(this.activeTabId);
if (!page) throw new Error('No active page. Use "browse goto <url>" first.');
return page;
return this.getActiveSession().page;
}
getCurrentUrl(): string {
@@ -677,60 +685,34 @@ export class BrowserManager {
}
}
// ─── Ref Map ──────────────────────────────────────────────
// ─── Ref Map (delegates to active session) ──────────────────
setRefMap(refs: Map<string, RefEntry>) {
this.refMap = refs;
this.getActiveSession().setRefMap(refs);
}
clearRefs() {
this.refMap.clear();
this.getActiveSession().clearRefs();
}
/**
* Resolve a selector that may be a @ref (e.g., "@e3", "@c1") or a CSS selector.
* Returns { locator } for refs or { selector } for CSS selectors.
*/
async resolveRef(selector: string): Promise<{ locator: Locator } | { selector: string }> {
if (selector.startsWith('@e') || selector.startsWith('@c')) {
const ref = selector.slice(1); // "e3" or "c1"
const entry = this.refMap.get(ref);
if (!entry) {
throw new Error(
`Ref ${selector} not found. Run 'snapshot' to get fresh refs.`
);
}
const count = await entry.locator.count();
if (count === 0) {
throw new Error(
`Ref ${selector} (${entry.role} "${entry.name}") is stale — element no longer exists. ` +
`Run 'snapshot' for fresh refs.`
);
}
return { locator: entry.locator };
}
return { selector };
return this.getActiveSession().resolveRef(selector);
}
/** Get the ARIA role for a ref selector, or null for CSS selectors / unknown refs. */
getRefRole(selector: string): string | null {
if (selector.startsWith('@e') || selector.startsWith('@c')) {
const entry = this.refMap.get(selector.slice(1));
return entry?.role ?? null;
}
return null;
return this.getActiveSession().getRefRole(selector);
}
getRefCount(): number {
return this.refMap.size;
return this.getActiveSession().getRefCount();
}
// ─── Snapshot Diffing ─────────────────────────────────────
// ─── Snapshot Diffing (delegates to active session) ─────────
setLastSnapshot(text: string | null) {
this.lastSnapshot = text;
this.getActiveSession().setLastSnapshot(text);
}
getLastSnapshot(): string | null {
return this.lastSnapshot;
return this.getActiveSession().getLastSnapshot();
}
// ─── Dialog Control ───────────────────────────────────────
@@ -782,30 +764,20 @@ export class BrowserManager {
await page.close().catch(() => {});
}
this.pages.clear();
this.clearRefs();
this.tabSessions.clear();
}
// ─── Frame context ─────────────────────────────────
private activeFrame: import('playwright').Frame | null = null;
// ─── Frame context (delegates to active session) ────────────
setFrame(frame: import('playwright').Frame | null): void {
this.activeFrame = frame;
this.getActiveSession().setFrame(frame);
}
getFrame(): import('playwright').Frame | null {
return this.activeFrame;
return this.getActiveSession().getFrame();
}
/**
* Returns the active frame if set, otherwise the current page.
* Use this for operations that work on both Page and Frame (locator, evaluate, etc.).
*/
getActiveFrameOrPage(): import('playwright').Page | import('playwright').Frame {
// Auto-recover from detached frames (iframe removed/navigated)
if (this.activeFrame?.isDetached()) {
this.activeFrame = null;
}
return this.activeFrame ?? this.getPage();
return this.getActiveSession().getActiveFrameOrPage();
}
// ─── State Save/Restore (shared by recreateContext + handoff) ─
@@ -857,6 +829,7 @@ export class BrowserManager {
const page = await this.context.newPage();
const id = this.nextTabId++;
this.pages.set(id, page);
this.tabSessions.set(id, new TabSession(page));
this.wirePageEvents(page);
if (saved.url) {
@@ -924,6 +897,7 @@ export class BrowserManager {
await page.close().catch(() => {});
}
this.pages.clear();
this.tabSessions.clear();
await this.context.close().catch(() => {});
// 3. Create new context with updated settings
@@ -947,6 +921,7 @@ export class BrowserManager {
// Fallback: create a clean context + blank tab
try {
this.pages.clear();
this.tabSessions.clear();
if (this.context) await this.context.close().catch(() => {});
const contextOptions: BrowserContextOptions = {
@@ -1032,6 +1007,7 @@ export class BrowserManager {
this.context = newContext;
this.browser = newContext.browser();
this.pages.clear();
this.tabSessions.clear();
this.connectionMode = 'headed';
if (Object.keys(this.extraHeaders).length > 0) {
@@ -1074,9 +1050,13 @@ export class BrowserManager {
* The meta-command handler calls handleSnapshot() after this.
*/
resume(): void {
this.clearRefs();
// Clear refs and frame on the active session
try {
const session = this.getActiveSession();
session.clearRefs();
session.setFrame(null);
} catch {}
this.resetFailures();
this.activeFrame = null;
}
getIsHeaded(): boolean {
@@ -1101,11 +1081,12 @@ export class BrowserManager {
// ─── Console/Network/Dialog/Ref Wiring ────────────────────
private wirePageEvents(page: Page) {
// Track tab close — remove from pages map, switch to another tab
// Track tab close — remove from pages and sessions maps, switch to another tab
page.on('close', () => {
for (const [id, p] of this.pages) {
if (p === page) {
this.pages.delete(id);
this.tabSessions.delete(id);
console.log(`[browse] Tab closed (id=${id}, remaining=${this.pages.size})`);
// If the closed tab was active, switch to another
if (this.activeTabId === id) {
@@ -1121,8 +1102,13 @@ export class BrowserManager {
// (lastSnapshot is NOT cleared — it's a text baseline for diffing)
page.on('framenavigated', (frame) => {
if (frame === page.mainFrame()) {
this.clearRefs();
this.activeFrame = null; // Navigation invalidates frame context
// Find the TabSession for this page and clear its per-tab state
for (const session of this.tabSessions.values()) {
if (session.page === page) {
session.onMainFrameNavigated();
break;
}
}
}
});
+2 -2
View File
@@ -155,7 +155,7 @@ export async function handleCookiePickerRoute(
}
// Add to Playwright context
const page = bm.getPage();
const page = bm.getActiveSession().getPage();
await page.context().addCookies(result.cookies);
// Track what was imported
@@ -187,7 +187,7 @@ export async function handleCookiePickerRoute(
return errorResponse("Missing or empty 'domains' array", 'missing_param', { port });
}
const page = bm.getPage();
const page = bm.getActiveSession().getPage();
const context = page.context();
for (const domain of domains) {
await context.clearCookies({ domain });
+22 -19
View File
@@ -84,6 +84,9 @@ export async function handleMetaCommand(
tokenInfo?: TokenInfo | null,
opts?: MetaCommandOpts,
): Promise<string> {
// Per-tab operations use the active session; global operations use bm directly
const session = bm.getActiveSession();
switch (command) {
// ─── Tabs ──────────────────────────────────────────
case 'tabs': {
@@ -114,7 +117,7 @@ export async function handleMetaCommand(
// ─── Server Control ────────────────────────────────
case 'status': {
const page = bm.getPage();
const page = session.getPage();
const tabs = bm.getTabCount();
const mode = bm.getConnectionMode();
return [
@@ -145,7 +148,7 @@ export async function handleMetaCommand(
// ─── Visual ────────────────────────────────────────
case 'screenshot': {
// Parse priority: flags (--viewport, --clip) → selector (@ref, CSS) → output path
const page = bm.getPage();
const page = session.getPage();
let outputPath = `${TEMP_DIR}/browse-screenshot.png`;
let clipRect: { x: number; y: number; width: number; height: number } | undefined;
let targetSelector: string | undefined;
@@ -192,7 +195,7 @@ export async function handleMetaCommand(
}
if (targetSelector) {
const resolved = await bm.resolveRef(targetSelector);
const resolved = await session.resolveRef(targetSelector);
const locator = 'locator' in resolved ? resolved.locator : page.locator(resolved.selector);
await locator.screenshot({ path: outputPath, timeout: 5000 });
return `Screenshot saved (element): ${outputPath}`;
@@ -208,7 +211,7 @@ export async function handleMetaCommand(
}
case 'pdf': {
const page = bm.getPage();
const page = session.getPage();
const pdfPath = args[0] || `${TEMP_DIR}/browse-page.pdf`;
validateOutputPath(pdfPath);
await page.pdf({ path: pdfPath, format: 'A4' });
@@ -216,7 +219,7 @@ export async function handleMetaCommand(
}
case 'responsive': {
const page = bm.getPage();
const page = session.getPage();
const prefix = args[0] || `${TEMP_DIR}/browse-responsive`;
validateOutputPath(prefix);
const viewports = [
@@ -317,11 +320,11 @@ export async function handleMetaCommand(
if (bm.isWatching()) {
result = 'BLOCKED: write commands disabled in watch mode';
} else {
result = await handleWriteCommand(name, cmdArgs, bm);
result = await handleWriteCommand(name, cmdArgs, session, bm);
}
lastWasWrite = true;
} else if (READ_COMMANDS.has(name)) {
result = await handleReadCommand(name, cmdArgs, bm);
result = await handleReadCommand(name, cmdArgs, session);
if (PAGE_CONTENT_COMMANDS.has(name)) {
result = wrapUntrustedContent(result, bm.getCurrentUrl());
}
@@ -341,7 +344,7 @@ export async function handleMetaCommand(
// Wait for network to settle after write commands before returning
if (lastWasWrite) {
await bm.getPage().waitForLoadState('networkidle', { timeout: 2000 }).catch(() => {});
await session.getPage().waitForLoadState('networkidle', { timeout: 2000 }).catch(() => {});
}
return results.join('\n\n');
@@ -352,7 +355,7 @@ export async function handleMetaCommand(
const [url1, url2] = args;
if (!url1 || !url2) throw new Error('Usage: browse diff <url1> <url2>');
const page = bm.getPage();
const page = session.getPage();
await validateNavigationUrl(url1);
await page.goto(url1, { waitUntil: 'domcontentloaded', timeout: 15000 });
const text1 = await getCleanText(page);
@@ -378,7 +381,7 @@ export async function handleMetaCommand(
// ─── Snapshot ─────────────────────────────────────
case 'snapshot': {
const isScoped = tokenInfo && tokenInfo.clientId !== 'root';
const snapshotResult = await handleSnapshot(args, bm, {
const snapshotResult = await handleSnapshot(args, session, {
splitForScoped: !!isScoped,
});
// Scoped tokens get split format (refs outside envelope); root gets basic wrapping
@@ -398,7 +401,7 @@ export async function handleMetaCommand(
bm.resume();
// Re-snapshot to capture current page state after human interaction
const isScoped2 = tokenInfo && tokenInfo.clientId !== 'root';
const snapshot = await handleSnapshot(['-i'], bm, { splitForScoped: !!isScoped2 });
const snapshot = await handleSnapshot(['-i'], session, { splitForScoped: !!isScoped2 });
if (isScoped2) {
return `RESUMED\n${snapshot}`;
}
@@ -451,7 +454,7 @@ export async function handleMetaCommand(
// If a ref was passed, scroll it into view
if (args.length > 0 && args[0].startsWith('@')) {
try {
const resolved = await bm.resolveRef(args[0]);
const resolved = await session.resolveRef(args[0]);
if ('locator' in resolved) {
await resolved.locator.scrollIntoViewIfNeeded({ timeout: 5000 });
return `Browser activated. Scrolled ${args[0]} into view.`;
@@ -608,7 +611,7 @@ export async function handleMetaCommand(
}
}
// Close existing pages, then restore (replace, not merge)
bm.setFrame(null);
session.setFrame(null);
await bm.closeAllPages();
await bm.restoreState({
cookies: validatedCookies,
@@ -626,12 +629,12 @@ export async function handleMetaCommand(
if (!target) throw new Error('Usage: frame <selector|@ref|--name name|--url pattern|main>');
if (target === 'main') {
bm.setFrame(null);
bm.clearRefs();
session.setFrame(null);
session.clearRefs();
return 'Switched to main frame';
}
const page = bm.getPage();
const page = session.getPage();
let frame: Frame | null = null;
if (target === '--name') {
@@ -642,7 +645,7 @@ export async function handleMetaCommand(
frame = page.frame({ url: new RegExp(escapeRegExp(args[1])) });
} else {
// CSS selector or @ref for the iframe element
const resolved = await bm.resolveRef(target);
const resolved = await session.resolveRef(target);
const locator = 'locator' in resolved ? resolved.locator : page.locator(resolved.selector);
const elementHandle = await locator.elementHandle({ timeout: 5000 });
frame = await elementHandle?.contentFrame() ?? null;
@@ -650,8 +653,8 @@ export async function handleMetaCommand(
}
if (!frame) throw new Error(`Frame not found: ${target}`);
bm.setFrame(frame);
bm.clearRefs();
session.setFrame(frame);
session.clearRefs();
return `Switched to frame: ${frame.url()}`;
}
+8 -8
View File
@@ -5,7 +5,7 @@
* console, network, cookies, storage, perf
*/
import type { BrowserManager } from './browser-manager';
import type { TabSession } from './tab-session';
import { consoleBuffer, networkBuffer, dialogBuffer } from './buffers';
import type { Page, Frame } from 'playwright';
import * as fs from 'fs';
@@ -94,11 +94,11 @@ export async function getCleanText(page: Page | Frame): Promise<string> {
export async function handleReadCommand(
command: string,
args: string[],
bm: BrowserManager
session: TabSession
): Promise<string> {
const page = bm.getPage();
const page = session.getPage();
// Frame-aware target for content extraction
const target = bm.getActiveFrameOrPage();
const target = session.getActiveFrameOrPage();
switch (command) {
case 'text': {
@@ -108,7 +108,7 @@ export async function handleReadCommand(
case 'html': {
const selector = args[0];
if (selector) {
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
return await resolved.locator.innerHTML({ timeout: 5000 });
}
@@ -190,7 +190,7 @@ export async function handleReadCommand(
case 'css': {
const [selector, property] = args;
if (!selector || !property) throw new Error('Usage: browse css <selector> <property>');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
const value = await resolved.locator.evaluate(
(el, prop) => getComputedStyle(el).getPropertyValue(prop),
@@ -212,7 +212,7 @@ export async function handleReadCommand(
case 'attrs': {
const selector = args[0];
if (!selector) throw new Error('Usage: browse attrs <selector>');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
const attrs = await resolved.locator.evaluate((el) => {
const result: Record<string, string> = {};
@@ -276,7 +276,7 @@ export async function handleReadCommand(
const selector = args[1];
if (!property || !selector) throw new Error('Usage: browse is <property> <selector>\nProperties: visible, hidden, enabled, disabled, checked, editable, focused');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
let locator;
if ('locator' in resolved) {
locator = resolved.locator;
+7 -5
View File
@@ -981,26 +981,28 @@ async function handleCommandInternal(
try {
let result: string;
const session = browserManager.getActiveSession();
if (READ_COMMANDS.has(command)) {
const isScoped = tokenInfo && tokenInfo.clientId !== 'root';
// Hidden element stripping for scoped tokens on text command
if (isScoped && command === 'text') {
const page = browserManager.getPage();
const page = session.getPage();
const strippedDescs = await markHiddenElements(page);
if (strippedDescs.length > 0) {
console.warn(`[browse] Content security: stripped ${strippedDescs.length} hidden elements for ${tokenInfo.clientId}`);
}
try {
const target = browserManager.getActiveFrameOrPage();
const target = session.getActiveFrameOrPage();
result = await getCleanTextWithStripping(target);
} finally {
await cleanupHiddenMarkers(page);
}
} else {
result = await handleReadCommand(command, args, browserManager);
result = await handleReadCommand(command, args, session);
}
} else if (WRITE_COMMANDS.has(command)) {
result = await handleWriteCommand(command, args, browserManager);
result = await handleWriteCommand(command, args, session, browserManager);
} else if (META_COMMANDS.has(command)) {
// Pass chain depth + executeCommand callback so chain routes subcommands
// through the full security pipeline (scope, domain, tab, wrapping).
@@ -1021,7 +1023,7 @@ async function handleCommandInternal(
return;
}
try {
const snapshot = await handleSnapshot(['-i'], browserManager);
const snapshot = await handleSnapshot(['-i'], browserManager.getActiveSession());
browserManager.addWatchSnapshot(snapshot);
} catch {
// Page may be navigating — skip this snapshot
+12 -12
View File
@@ -18,7 +18,7 @@
*/
import type { Page, Frame, Locator } from 'playwright';
import type { BrowserManager, RefEntry } from './browser-manager';
import type { TabSession, RefEntry } from './tab-session';
import * as Diff from 'diff';
import { TEMP_DIR, isPathWithin } from './platform';
@@ -132,14 +132,14 @@ function parseLine(line: string): ParsedNode | null {
*/
export async function handleSnapshot(
args: string[],
bm: BrowserManager,
session: TabSession,
securityOpts?: { splitForScoped?: boolean },
): Promise<string> {
const opts = parseSnapshotArgs(args);
const page = bm.getPage();
const page = session.getPage();
// Frame-aware target for accessibility tree
const target = bm.getActiveFrameOrPage();
const inFrame = bm.getFrame() !== null;
const target = session.getActiveFrameOrPage();
const inFrame = session.getFrame() !== null;
// Get accessibility tree via ariaSnapshot
let rootLocator: Locator;
@@ -153,7 +153,7 @@ export async function handleSnapshot(
const ariaText = await rootLocator.ariaSnapshot();
if (!ariaText || ariaText.trim().length === 0) {
bm.setRefMap(new Map());
session.setRefMap(new Map());
return '(no accessible elements found)';
}
@@ -338,7 +338,7 @@ export async function handleSnapshot(
}
// Store ref map on BrowserManager
bm.setRefMap(refMap);
session.setRefMap(refMap);
if (output.length === 0) {
return '(no interactive elements found)';
@@ -430,9 +430,9 @@ export async function handleSnapshot(
// ─── Diff mode (-D) ───────────────────────────────────────
if (opts.diff) {
const lastSnapshot = bm.getLastSnapshot();
const lastSnapshot = session.getLastSnapshot();
if (!lastSnapshot) {
bm.setLastSnapshot(snapshotText);
session.setLastSnapshot(snapshotText);
return snapshotText + '\n\n(no previous snapshot to diff against — this snapshot stored as baseline)';
}
@@ -447,16 +447,16 @@ export async function handleSnapshot(
}
}
bm.setLastSnapshot(snapshotText);
session.setLastSnapshot(snapshotText);
return diffOutput.join('\n');
}
// Store for future diffs
bm.setLastSnapshot(snapshotText);
session.setLastSnapshot(snapshotText);
// Add frame context header when operating inside an iframe
if (inFrame) {
const frameUrl = bm.getFrame()?.url() ?? 'unknown';
const frameUrl = session.getFrame()?.url() ?? 'unknown';
output.unshift(`[Context: iframe src="${frameUrl}"]`);
}
+140
View File
@@ -0,0 +1,140 @@
/**
* Per-tab session state.
*
* Extracted from BrowserManager to enable parallel tab execution in /batch.
* Each TabSession holds the state that is scoped to a single browser tab:
* page reference, element refs, snapshot baseline, and frame context.
*
* BrowserManager (global)
* └── tabSessions: Map<number, TabSession>
* ├── TabSession(page1) ← refMap, lastSnapshot, frame
* ├── TabSession(page2) ← refMap, lastSnapshot, frame
* └── TabSession(page3) ← refMap, lastSnapshot, frame
*
* The /command path gets the active session via bm.getActiveSession().
* The /batch path gets specific sessions via bm.getSession(tabId).
* Both paths pass TabSession to the same handler functions.
*/
import type { Page, Locator, Frame } from 'playwright';
export interface RefEntry {
locator: Locator;
role: string;
name: string;
}
export class TabSession {
readonly page: Page;
// ─── Ref Map (snapshot → @e1, @e2, @c1, @c2, ...) ────────
private refMap: Map<string, RefEntry> = new Map();
// ─── Snapshot Diffing ─────────────────────────────────────
// NOT cleared on navigation — it's a text baseline for diffing
private lastSnapshot: string | null = null;
// ─── Frame context ─────────────────────────────────────────
private activeFrame: Frame | null = null;
constructor(page: Page) {
this.page = page;
}
// ─── Page Access ───────────────────────────────────────────
getPage(): Page {
return this.page;
}
// ─── Ref Map ──────────────────────────────────────────────
setRefMap(refs: Map<string, RefEntry>) {
this.refMap = refs;
}
clearRefs() {
this.refMap.clear();
}
/**
* Resolve a selector that may be a @ref (e.g., "@e3", "@c1") or a CSS selector.
* Returns { locator } for refs or { selector } for CSS selectors.
*/
async resolveRef(selector: string): Promise<{ locator: Locator } | { selector: string }> {
if (selector.startsWith('@e') || selector.startsWith('@c')) {
const ref = selector.slice(1); // "e3" or "c1"
const entry = this.refMap.get(ref);
if (!entry) {
throw new Error(
`Ref ${selector} not found. Run 'snapshot' to get fresh refs.`
);
}
const count = await entry.locator.count();
if (count === 0) {
throw new Error(
`Ref ${selector} (${entry.role} "${entry.name}") is stale — element no longer exists. ` +
`Run 'snapshot' for fresh refs.`
);
}
return { locator: entry.locator };
}
return { selector };
}
/** Get the ARIA role for a ref selector, or null for CSS selectors / unknown refs. */
getRefRole(selector: string): string | null {
if (selector.startsWith('@e') || selector.startsWith('@c')) {
const entry = this.refMap.get(selector.slice(1));
return entry?.role ?? null;
}
return null;
}
getRefCount(): number {
return this.refMap.size;
}
/** Get all ref entries for the /refs endpoint. */
getRefEntries(): Array<{ ref: string; role: string; name: string }> {
return Array.from(this.refMap.entries()).map(([ref, entry]) => ({
ref, role: entry.role, name: entry.name,
}));
}
// ─── Snapshot Diffing ─────────────────────────────────────
setLastSnapshot(text: string | null) {
this.lastSnapshot = text;
}
getLastSnapshot(): string | null {
return this.lastSnapshot;
}
// ─── Frame context ─────────────────────────────────────────
setFrame(frame: Frame | null): void {
this.activeFrame = frame;
}
getFrame(): Frame | null {
return this.activeFrame;
}
/**
* Returns the active frame if set, otherwise the current page.
* Use this for operations that work on both Page and Frame (locator, evaluate, etc.).
*/
getActiveFrameOrPage(): Page | Frame {
// Auto-recover from detached frames (iframe removed/navigated)
if (this.activeFrame?.isDetached()) {
this.activeFrame = null;
}
return this.activeFrame ?? this.page;
}
/**
* Called on main-frame navigation to clear stale refs and frame context.
*/
onMainFrameNavigated(): void {
this.clearRefs();
this.activeFrame = null;
}
}
+14 -12
View File
@@ -5,6 +5,7 @@
* press, scroll, wait, viewport, cookie, header, useragent
*/
import type { TabSession } from './tab-session';
import type { BrowserManager } from './browser-manager';
import { findInstalledBrowsers, importCookies, listSupportedBrowserNames } from './cookie-import-browser';
import { validateNavigationUrl } from './url-validation';
@@ -168,12 +169,13 @@ const CLEANUP_SELECTORS = {
export async function handleWriteCommand(
command: string,
args: string[],
session: TabSession,
bm: BrowserManager
): Promise<string> {
const page = bm.getPage();
const page = session.getPage();
// Frame-aware target for locator-based operations (click, fill, etc.)
const target = bm.getActiveFrameOrPage();
const inFrame = bm.getFrame() !== null;
const target = session.getActiveFrameOrPage();
const inFrame = session.getFrame() !== null;
switch (command) {
case 'goto': {
@@ -209,9 +211,9 @@ export async function handleWriteCommand(
if (!selector) throw new Error('Usage: browse click <selector>');
// Auto-route: if ref points to a real <option> inside a <select>, use selectOption
const role = bm.getRefRole(selector);
const role = session.getRefRole(selector);
if (role === 'option') {
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
const optionInfo = await resolved.locator.evaluate(el => {
if (el.tagName !== 'OPTION') return null; // custom [role=option], not real <option>
@@ -228,7 +230,7 @@ export async function handleWriteCommand(
}
}
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
try {
if ('locator' in resolved) {
await resolved.locator.click({ timeout: 5000 });
@@ -258,7 +260,7 @@ export async function handleWriteCommand(
const [selector, ...valueParts] = args;
const value = valueParts.join(' ');
if (!selector || !value) throw new Error('Usage: browse fill <selector> <value>');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.fill(value, { timeout: 5000 });
} else {
@@ -273,7 +275,7 @@ export async function handleWriteCommand(
const [selector, ...valueParts] = args;
const value = valueParts.join(' ');
if (!selector || !value) throw new Error('Usage: browse select <selector> <value>');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.selectOption(value, { timeout: 5000 });
} else {
@@ -287,7 +289,7 @@ export async function handleWriteCommand(
case 'hover': {
const selector = args[0];
if (!selector) throw new Error('Usage: browse hover <selector>');
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.hover({ timeout: 5000 });
} else {
@@ -313,7 +315,7 @@ export async function handleWriteCommand(
case 'scroll': {
const selector = args[0];
if (selector) {
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.scrollIntoViewIfNeeded({ timeout: 5000 });
} else {
@@ -346,7 +348,7 @@ export async function handleWriteCommand(
const MAX_WAIT_MS = 300_000;
const MIN_WAIT_MS = 1_000;
const timeout = Math.min(Math.max(args[1] ? parseInt(args[1], 10) || MIN_WAIT_MS : 15000, MIN_WAIT_MS), MAX_WAIT_MS);
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.waitFor({ state: 'visible', timeout });
} else {
@@ -423,7 +425,7 @@ export async function handleWriteCommand(
}
}
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.setInputFiles(filePaths);
} else {
+241
View File
@@ -0,0 +1,241 @@
/**
* Integration tests for POST /batch endpoint
*
* Tests parallel multi-tab execution, error isolation, SSE streaming,
* newtab/closetab handling, and batch validation.
*/
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { startTestServer } from './test-server';
import { BrowserManager } from '../src/browser-manager';
let testServer: ReturnType<typeof startTestServer>;
let bm: BrowserManager;
let baseUrl: string;
let serverPort: number;
// Helper to send batch requests to the browse server
async function batch(commands: any[], opts: { timeout?: number; stream?: boolean } = {}): Promise<any> {
const res = await fetch(`http://127.0.0.1:${serverPort}/batch`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ commands, ...opts }),
});
if (opts.stream) {
return res; // return raw response for SSE testing
}
return res.json();
}
beforeAll(async () => {
testServer = startTestServer(0);
baseUrl = testServer.url;
bm = new BrowserManager();
await bm.launch();
serverPort = bm.serverPort;
// Start the browse server
const { startServer } = await import('../src/server');
// The server is already started by launch — we need the port
// Actually, BrowserManager.launch() starts the browser, not the server.
// The test needs to start a server. Let's use the existing server infrastructure.
});
afterAll(() => {
try { testServer.server.stop(); } catch {}
setTimeout(() => process.exit(0), 500);
});
// We need a running browse server for HTTP tests.
// The commands.test.ts tests call handlers directly, but batch tests need the HTTP endpoint.
// Let's test the batch logic by importing the handlers directly instead.
import { handleReadCommand as _handleReadCommand } from '../src/read-commands';
import { handleWriteCommand as _handleWriteCommand } from '../src/write-commands';
import { handleMetaCommand } from '../src/meta-commands';
import { handleSnapshot } from '../src/snapshot';
import { READ_COMMANDS, WRITE_COMMANDS } from '../src/commands';
const handleReadCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleReadCommand(cmd, args, b.getActiveSession());
const handleWriteCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleWriteCommand(cmd, args, b.getActiveSession(), b);
describe('Batch execution', () => {
test('multi-tab parallel: goto + text on different tabs', async () => {
// Create two tabs
const tab1 = await bm.newTab(baseUrl + '/basic.html');
const tab2 = await bm.newTab(baseUrl + '/forms.html');
// Execute text command on both tabs in parallel using TabSession
const session1 = bm.getSession(tab1);
const session2 = bm.getSession(tab2);
const [result1, result2] = await Promise.allSettled([
_handleReadCommand('text', [], session1),
_handleReadCommand('text', [], session2),
]);
expect(result1.status).toBe('fulfilled');
expect(result2.status).toBe('fulfilled');
if (result1.status === 'fulfilled') {
expect(result1.value).toContain('Hello');
}
if (result2.status === 'fulfilled') {
// forms.html has form elements
expect(result2.value.length).toBeGreaterThan(0);
}
// Cleanup
await bm.closeTab(tab2);
await bm.closeTab(tab1);
});
test('same-tab sequential: commands execute in order', async () => {
const tabId = await bm.newTab();
const session = bm.getSession(tabId);
// Navigate then read — must be sequential
await _handleWriteCommand('goto', [baseUrl + '/basic.html'], session, bm);
const text = await _handleReadCommand('text', [], session);
expect(text).toContain('Hello');
await bm.closeTab(tabId);
});
test('per-command error isolation: one tab fails, others succeed', async () => {
const tab1 = await bm.newTab(baseUrl + '/basic.html');
const tab2 = await bm.newTab(baseUrl + '/basic.html');
const session1 = bm.getSession(tab1);
const session2 = bm.getSession(tab2);
// Use Promise.allSettled — one succeeds (text read), one fails (invalid ref)
const results = await Promise.allSettled([
_handleReadCommand('text', [], session1),
session2.resolveRef('@e999'), // nonexistent ref — fails immediately
]);
expect(results[0].status).toBe('fulfilled');
expect(results[1].status).toBe('rejected');
await bm.closeTab(tab2);
await bm.closeTab(tab1);
});
test('page-scoped refs: snapshot refs are per-session', async () => {
const tab1 = await bm.newTab(baseUrl + '/basic.html');
const tab2 = await bm.newTab(baseUrl + '/forms.html');
const session1 = bm.getSession(tab1);
const session2 = bm.getSession(tab2);
// Snapshot on tab1 creates refs in session1
await handleSnapshot(['-i'], session1);
const refCount1 = session1.getRefCount();
// Snapshot on tab2 creates refs in session2
await handleSnapshot(['-i'], session2);
const refCount2 = session2.getRefCount();
// Refs should be independent
expect(refCount1).toBeGreaterThanOrEqual(0);
expect(refCount2).toBeGreaterThanOrEqual(0);
// Session1's refs should not have changed after session2's snapshot
expect(session1.getRefCount()).toBe(refCount1);
await bm.closeTab(tab2);
await bm.closeTab(tab1);
});
test('per-tab lastSnapshot: snapshot -D works per-tab', async () => {
const tab1 = await bm.newTab(baseUrl + '/basic.html');
const session1 = bm.getSession(tab1);
// First snapshot sets the baseline
const snap1 = await handleSnapshot([], session1);
expect(session1.getLastSnapshot()).not.toBeNull();
// Second snapshot with -D should diff against the first
const snap2 = await handleSnapshot(['-D'], session1);
// Since page didn't change, diff should indicate identical
// (either "no changes" or empty diff with just headers)
expect(snap2.length).toBeGreaterThan(0);
await bm.closeTab(tab1);
});
test('getSession throws for nonexistent tab', () => {
expect(() => bm.getSession(99999)).toThrow('Tab 99999 not found');
});
test('getActiveSession returns the current active tab session', async () => {
const tabId = await bm.newTab(baseUrl + '/basic.html');
const session = bm.getActiveSession();
expect(session.getPage().url()).toContain('basic.html');
await bm.closeTab(tabId);
});
test('batch-safe command subset validation', () => {
const BATCH_SAFE = new Set([
'text', 'html', 'links', 'snapshot', 'accessibility', 'cookies', 'url',
'goto', 'click', 'fill', 'select', 'hover', 'scroll', 'wait',
'screenshot', 'pdf',
'newtab', 'closetab',
]);
// All batch-safe commands should be in the main command sets (except newtab/closetab which are meta)
for (const cmd of BATCH_SAFE) {
if (cmd === 'newtab' || cmd === 'closetab' || cmd === 'snapshot' || cmd === 'screenshot' || cmd === 'pdf' || cmd === 'url') {
continue; // These are META_COMMANDS, handled separately
}
const isKnown = READ_COMMANDS.has(cmd) || WRITE_COMMANDS.has(cmd);
expect(isKnown).toBe(true);
}
});
test('closeTab via page.close preserves at-least-one-page invariant', async () => {
// Create a tab, close it via page.close() (simulating batch closetab)
const tabId = await bm.newTab(baseUrl + '/basic.html');
const session = bm.getSession(tabId);
// Close via page.close() directly (how batch does it)
await session.getPage().close();
// The page.on('close') handler should have cleaned up
// And the browser should still have at least one tab
expect(bm.getTabCount()).toBeGreaterThanOrEqual(1);
});
test('parallel goto on multiple tabs', async () => {
const tab1 = await bm.newTab();
const tab2 = await bm.newTab();
const tab3 = await bm.newTab();
const session1 = bm.getSession(tab1);
const session2 = bm.getSession(tab2);
const session3 = bm.getSession(tab3);
// Navigate all three tabs in parallel
const results = await Promise.allSettled([
_handleWriteCommand('goto', [baseUrl + '/basic.html'], session1, bm),
_handleWriteCommand('goto', [baseUrl + '/forms.html'], session2, bm),
_handleWriteCommand('goto', [baseUrl + '/basic.html'], session3, bm),
]);
expect(results.every(r => r.status === 'fulfilled')).toBe(true);
// Verify each tab landed on the right page
expect(session1.getPage().url()).toContain('basic.html');
expect(session2.getPage().url()).toContain('forms.html');
expect(session3.getPage().url()).toContain('basic.html');
await bm.closeTab(tab3);
await bm.closeTab(tab2);
await bm.closeTab(tab1);
});
});
+8 -2
View File
@@ -9,14 +9,20 @@ import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { startTestServer } from './test-server';
import { BrowserManager } from '../src/browser-manager';
import { resolveServerScript } from '../src/cli';
import { handleReadCommand } from '../src/read-commands';
import { handleWriteCommand } from '../src/write-commands';
import { handleReadCommand as _handleReadCommand } from '../src/read-commands';
import { handleWriteCommand as _handleWriteCommand } from '../src/write-commands';
import { handleMetaCommand } from '../src/meta-commands';
import { consoleBuffer, networkBuffer, dialogBuffer, addConsoleEntry, addNetworkEntry, addDialogEntry, CircularBuffer } from '../src/buffers';
import * as fs from 'fs';
import { spawn } from 'child_process';
import * as path from 'path';
// Thin wrappers that bridge old test calls (bm as 3rd arg) to new signatures (session + bm)
const handleReadCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleReadCommand(cmd, args, b.getActiveSession());
const handleWriteCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleWriteCommand(cmd, args, b.getActiveSession(), b);
let testServer: ReturnType<typeof startTestServer>;
let bm: BrowserManager;
let baseUrl: string;
+7 -2
View File
@@ -12,8 +12,13 @@
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { BrowserManager } from '../src/browser-manager';
import { handleReadCommand } from '../src/read-commands';
import { handleWriteCommand } from '../src/write-commands';
import { handleReadCommand as _handleReadCommand } from '../src/read-commands';
import { handleWriteCommand as _handleWriteCommand } from '../src/write-commands';
const handleReadCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleReadCommand(cmd, args, b.getActiveSession());
const handleWriteCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleWriteCommand(cmd, args, b.getActiveSession(), b);
import { generateCompareHtml } from '../../design/src/compare';
import * as fs from 'fs';
import * as path from 'path';
+4 -1
View File
@@ -8,9 +8,12 @@
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { startTestServer } from './test-server';
import { BrowserManager, type BrowserState } from '../src/browser-manager';
import { handleWriteCommand } from '../src/write-commands';
import { handleWriteCommand as _handleWriteCommand } from '../src/write-commands';
import { handleMetaCommand } from '../src/meta-commands';
const handleWriteCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleWriteCommand(cmd, args, b.getActiveSession(), b);
let testServer: ReturnType<typeof startTestServer>;
let bm: BrowserManager;
let baseUrl: string;
+7 -2
View File
@@ -8,11 +8,16 @@
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { startTestServer } from './test-server';
import { BrowserManager } from '../src/browser-manager';
import { handleReadCommand } from '../src/read-commands';
import { handleWriteCommand } from '../src/write-commands';
import { handleReadCommand as _handleReadCommand } from '../src/read-commands';
import { handleWriteCommand as _handleWriteCommand } from '../src/write-commands';
import { handleMetaCommand } from '../src/meta-commands';
import * as fs from 'fs';
const handleReadCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleReadCommand(cmd, args, b.getActiveSession());
const handleWriteCommand = (cmd: string, args: string[], b: BrowserManager) =>
_handleWriteCommand(cmd, args, b.getActiveSession(), b);
let testServer: ReturnType<typeof startTestServer>;
let bm: BrowserManager;
let baseUrl: string;