CalvinBackup/gstack
1
0
Fork 0
mirror of https://github.com/garrytan/gstack.git synced 2026-05-02 03:35:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor: update handler signatures to use TabSession

Browse Source 
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>
This commit is contained in:
Garry Tan
2026-04-06 16:51:49 -07:00
parent 9f45acb074
commit c3785e09cc
10 changed files with 89 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
browse/src/cookie-picker-routes.ts
+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 });
browse/src/meta-commands.ts
+22 -19
View File
@@ -50,6 +50,9 @@ export async function handleMetaCommand(
bm: BrowserManager,
shutdown: () => Promise<void> | void
): Promise<string> {
// Per-tab operations use the active session; global operations use bm directly
const session = bm.getActiveSession();
switch (command) {
// ─── Tabs ──────────────────────────────────────────
case 'tabs': {
@@ -80,7 +83,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 [
@@ -111,7 +114,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;
@@ -158,7 +161,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}`;
@@ -174,7 +177,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' });
@@ -182,7 +185,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 = [
@@ -238,10 +241,10 @@ export async function handleMetaCommand(
try {
let result: string;
if (WRITE_COMMANDS.has(name)) {
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());
}
@@ -260,7 +263,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');
@@ -271,7 +274,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);
@@ -296,7 +299,7 @@ export async function handleMetaCommand(
// ─── Snapshot ─────────────────────────────────────
case 'snapshot': {
const snapshotResult = await handleSnapshot(args, bm);
const snapshotResult = await handleSnapshot(args, session);
return wrapUntrustedContent(snapshotResult, bm.getCurrentUrl());
}
@@ -309,7 +312,7 @@ export async function handleMetaCommand(
case 'resume': {
bm.resume();
// Re-snapshot to capture current page state after human interaction
const snapshot = await handleSnapshot(['-i'], bm);
const snapshot = await handleSnapshot(['-i'], session);
return `RESUMED\n${wrapUntrustedContent(snapshot, bm.getCurrentUrl())}`;
}
@@ -359,7 +362,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.`;
@@ -504,7 +507,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: data.cookies,
@@ -522,12 +525,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') {
@@ -538,7 +541,7 @@ export async function handleMetaCommand(
frame = page.frame({ url: new RegExp(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;
@@ -546,8 +549,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()}`;
}
browse/src/read-commands.ts
+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';
@@ -90,11 +90,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': {
@@ -104,7 +104,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 });
}
@@ -186,7 +186,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),
@@ -208,7 +208,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> = {};
@@ -272,7 +272,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;
browse/src/server.ts
+5 -3
View File
@@ -823,13 +823,15 @@ async function handleCommand(body: any): Promise<Response> {
try {
let result: string;
const session = browserManager.getActiveSession();
if (READ_COMMANDS.has(command)) {
result = await handleReadCommand(command, args, browserManager);
result = await handleReadCommand(command, args, session);
if (PAGE_CONTENT_COMMANDS.has(command)) {
result = wrapUntrustedContent(result, browserManager.getCurrentUrl());
}
} 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)) {
result = await handleMetaCommand(command, args, browserManager, shutdown);
// Start periodic snapshot interval when watch mode begins
@@ -840,7 +842,7 @@ async function handleCommand(body: any): Promise<Response> {
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
browse/src/snapshot.ts
+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,13 +132,13 @@ function parseLine(line: string): ParsedNode | null {
*/
export async function handleSnapshot(
args: string[],
bm: BrowserManager
session: TabSession
): 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;
@@ -152,7 +152,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)';
}
@@ -337,7 +337,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)';
@@ -408,9 +408,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)';
}
@@ -425,16 +425,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}"]`);
}
browse/src/write-commands.ts
+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';
@@ -165,12 +166,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': {
@@ -206,9 +208,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>
@@ -225,7 +227,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 });
@@ -255,7 +257,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 {
@@ -270,7 +272,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 {
@@ -284,7 +286,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 {
@@ -310,7 +312,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 {
@@ -339,7 +341,7 @@ export async function handleWriteCommand(
return 'DOM content loaded';
}
const timeout = args[1] ? parseInt(args[1], 10) : 15000;
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.waitFor({ state: 'visible', timeout });
} else {
@@ -404,7 +406,7 @@ export async function handleWriteCommand(
if (!fs.existsSync(fp)) throw new Error(`File not found: ${fp}`);
}
const resolved = await bm.resolveRef(selector);
const resolved = await session.resolveRef(selector);
if ('locator' in resolved) {
await resolved.locator.setInputFiles(filePaths);
} else {
browse/test/commands.test.ts
+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;
browse/test/compare-board.test.ts
+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';
browse/test/handoff.test.ts
+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;
browse/test/snapshot.test.ts
+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;