mirror of
https://github.com/Tencent/BrowserSkill.git
synced 2026-09-10 13:01:23 +08:00
feat(vom): canvas position calculation and projection
This commit is contained in:
@@ -0,0 +1,67 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { type SurfaceCaptureInput, SurfaceCaptureStore } from "../surface-capture-store";
|
||||||
|
|
||||||
|
function input(): SurfaceCaptureInput {
|
||||||
|
return {
|
||||||
|
sessionId: "aa11",
|
||||||
|
tabId: 7,
|
||||||
|
navigationIdentity: "navigation",
|
||||||
|
surface: {
|
||||||
|
ref: "e3",
|
||||||
|
frameId: "main",
|
||||||
|
backendNodeId: 99,
|
||||||
|
observationGeneration: 2,
|
||||||
|
},
|
||||||
|
topViewportRect: { x: 10, y: 20, w: 100, h: 50 },
|
||||||
|
imageWidth: 200,
|
||||||
|
imageHeight: 100,
|
||||||
|
viewportSignature: "viewport",
|
||||||
|
frameProjectionSignature: "frame",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("SurfaceCaptureStore", () => {
|
||||||
|
it("creates metadata-only, short-lived captures and consumes them once", () => {
|
||||||
|
let now = 1_000;
|
||||||
|
const store = new SurfaceCaptureStore({
|
||||||
|
now: () => now,
|
||||||
|
ttlMs: 500,
|
||||||
|
createId: () => "sc_test",
|
||||||
|
});
|
||||||
|
const capture = store.create(input());
|
||||||
|
|
||||||
|
expect(capture).toMatchObject({
|
||||||
|
id: "sc_test",
|
||||||
|
createdAt: 1_000,
|
||||||
|
expiresAt: 1_500,
|
||||||
|
consumed: false,
|
||||||
|
});
|
||||||
|
expect(capture).not.toHaveProperty("imageBase64");
|
||||||
|
expect(store.consume("sc_test")).toMatchObject({ ok: true });
|
||||||
|
expect(store.consume("sc_test")).toEqual({ ok: false, reason: "consumed" });
|
||||||
|
|
||||||
|
now = 1_600;
|
||||||
|
expect(store.size()).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects expired and unknown captures", () => {
|
||||||
|
let now = 1_000;
|
||||||
|
const store = new SurfaceCaptureStore({
|
||||||
|
now: () => now,
|
||||||
|
ttlMs: 10,
|
||||||
|
createId: () => "sc_expired",
|
||||||
|
});
|
||||||
|
store.create(input());
|
||||||
|
now = 1_010;
|
||||||
|
|
||||||
|
expect(store.consume("sc_expired")).toEqual({ ok: false, reason: "expired" });
|
||||||
|
expect(store.consume("sc_missing")).toEqual({ ok: false, reason: "not_found" });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("clears every capture on session cleanup", () => {
|
||||||
|
const store = new SurfaceCaptureStore({ createId: () => "sc_clear" });
|
||||||
|
store.create(input());
|
||||||
|
store.clear();
|
||||||
|
expect(store.size()).toBe(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
import { AGENT_WINDOW_HOME, type AgentWindowApi, chromeAgentWindowApi } from "./agent-window";
|
import { AGENT_WINDOW_HOME, type AgentWindowApi, chromeAgentWindowApi } from "./agent-window";
|
||||||
import { RefStore } from "./ref-store";
|
import { RefStore } from "./ref-store";
|
||||||
|
import { SurfaceCaptureStore } from "./surface-capture-store";
|
||||||
|
|
||||||
export interface SessionContext {
|
export interface SessionContext {
|
||||||
sessionId: string;
|
sessionId: string;
|
||||||
agentWindowId: number;
|
agentWindowId: number;
|
||||||
refStore: RefStore;
|
refStore: RefStore;
|
||||||
|
surfaceCaptures: SurfaceCaptureStore;
|
||||||
borrowedTabs: Map<number, BorrowedTab>;
|
borrowedTabs: Map<number, BorrowedTab>;
|
||||||
createdAtMs: number;
|
createdAtMs: number;
|
||||||
}
|
}
|
||||||
@@ -186,6 +188,7 @@ export class SessionManager {
|
|||||||
sessionId,
|
sessionId,
|
||||||
agentWindowId: windowId,
|
agentWindowId: windowId,
|
||||||
refStore: new RefStore(),
|
refStore: new RefStore(),
|
||||||
|
surfaceCaptures: new SurfaceCaptureStore({ now: this.now }),
|
||||||
borrowedTabs: new Map(),
|
borrowedTabs: new Map(),
|
||||||
createdAtMs: this.now(),
|
createdAtMs: this.now(),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
|
||||||
|
export const SURFACE_CAPTURE_TTL_MS = 30_000;
|
||||||
|
|
||||||
|
export interface SurfaceCapture {
|
||||||
|
id: string;
|
||||||
|
sessionId: string;
|
||||||
|
tabId: number;
|
||||||
|
navigationIdentity: string;
|
||||||
|
surface: {
|
||||||
|
ref: string;
|
||||||
|
frameId?: string;
|
||||||
|
backendNodeId: number;
|
||||||
|
observationGeneration: number;
|
||||||
|
};
|
||||||
|
topViewportRect: Rect;
|
||||||
|
imageWidth: number;
|
||||||
|
imageHeight: number;
|
||||||
|
viewportSignature: string;
|
||||||
|
frameProjectionSignature: string;
|
||||||
|
createdAt: number;
|
||||||
|
expiresAt: number;
|
||||||
|
consumed: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SurfaceCaptureInput = Omit<
|
||||||
|
SurfaceCapture,
|
||||||
|
"id" | "createdAt" | "expiresAt" | "consumed"
|
||||||
|
>;
|
||||||
|
|
||||||
|
export type SurfaceCaptureConsumeResult =
|
||||||
|
| { ok: true; capture: SurfaceCapture }
|
||||||
|
| { ok: false; reason: "not_found" | "expired" | "consumed" };
|
||||||
|
|
||||||
|
export interface SurfaceCaptureStoreOptions {
|
||||||
|
now?: () => number;
|
||||||
|
ttlMs?: number;
|
||||||
|
createId?: () => string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function randomCaptureId(): string {
|
||||||
|
const bytes = crypto.getRandomValues(new Uint8Array(12));
|
||||||
|
return `sc_${Array.from(bytes, (byte) => byte.toString(16).padStart(2, "0")).join("")}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Per-session, metadata-only store for short-lived screenshot coordinate transactions. */
|
||||||
|
export class SurfaceCaptureStore {
|
||||||
|
private readonly captures = new Map<string, SurfaceCapture>();
|
||||||
|
private readonly now: () => number;
|
||||||
|
private readonly ttlMs: number;
|
||||||
|
private readonly createId: () => string;
|
||||||
|
|
||||||
|
constructor(options: SurfaceCaptureStoreOptions = {}) {
|
||||||
|
this.now = options.now ?? Date.now;
|
||||||
|
this.ttlMs = options.ttlMs ?? SURFACE_CAPTURE_TTL_MS;
|
||||||
|
this.createId = options.createId ?? randomCaptureId;
|
||||||
|
}
|
||||||
|
|
||||||
|
create(input: SurfaceCaptureInput): SurfaceCapture {
|
||||||
|
this.purgeExpired();
|
||||||
|
const createdAt = this.now();
|
||||||
|
const capture: SurfaceCapture = {
|
||||||
|
...input,
|
||||||
|
id: this.createId(),
|
||||||
|
createdAt,
|
||||||
|
expiresAt: createdAt + this.ttlMs,
|
||||||
|
consumed: false,
|
||||||
|
};
|
||||||
|
this.captures.set(capture.id, capture);
|
||||||
|
return capture;
|
||||||
|
}
|
||||||
|
|
||||||
|
consume(id: string): SurfaceCaptureConsumeResult {
|
||||||
|
const capture = this.captures.get(id);
|
||||||
|
if (!capture) return { ok: false, reason: "not_found" };
|
||||||
|
if (capture.expiresAt <= this.now()) {
|
||||||
|
this.captures.delete(id);
|
||||||
|
return { ok: false, reason: "expired" };
|
||||||
|
}
|
||||||
|
if (capture.consumed) return { ok: false, reason: "consumed" };
|
||||||
|
capture.consumed = true;
|
||||||
|
return { ok: true, capture };
|
||||||
|
}
|
||||||
|
|
||||||
|
clear(): void {
|
||||||
|
this.captures.clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
size(): number {
|
||||||
|
this.purgeExpired();
|
||||||
|
return this.captures.size;
|
||||||
|
}
|
||||||
|
|
||||||
|
private purgeExpired(): void {
|
||||||
|
const now = this.now();
|
||||||
|
for (const [id, capture] of this.captures) {
|
||||||
|
if (capture.expiresAt <= now) this.captures.delete(id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -67,6 +67,9 @@ function makeFakeCdp(handlers: Record<string, (params?: object) => unknown>) {
|
|||||||
if (!handler && method === "Page.getLayoutMetrics") {
|
if (!handler && method === "Page.getLayoutMetrics") {
|
||||||
return { cssLayoutViewport: { clientWidth: 1280, clientHeight: 720 } };
|
return { cssLayoutViewport: { clientWidth: 1280, clientHeight: 720 } };
|
||||||
}
|
}
|
||||||
|
if (!handler && method === "Page.getFrameTree") {
|
||||||
|
return { frameTree: { frame: { id: "main", loaderId: "loader-1", url: "https://test/" } } };
|
||||||
|
}
|
||||||
if (!handler) throw new Error(`unexpected CDP call ${method}`);
|
if (!handler) throw new Error(`unexpected CDP call ${method}`);
|
||||||
return handler(params);
|
return handler(params);
|
||||||
});
|
});
|
||||||
@@ -334,6 +337,11 @@ describe("handleScreenshot", () => {
|
|||||||
};
|
};
|
||||||
expect(clip.clip).toMatchObject({ width: 4096, height: 4096 });
|
expect(clip.clip).toMatchObject({ width: 4096, height: 4096 });
|
||||||
expect(clip.clip?.scale).toBeCloseTo(Math.sqrt(4_000_000 / (4096 * 4096)));
|
expect(clip.clip?.scale).toBeCloseTo(Math.sqrt(4_000_000 / (4096 * 4096)));
|
||||||
|
expect(res.capture).toMatchObject({
|
||||||
|
surface_ref: "@e5",
|
||||||
|
coordinate_space: "capture-image-pixel",
|
||||||
|
});
|
||||||
|
expect(ctx.surfaceCaptures.size()).toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("crops a visual surface screenshot to its observation-time visible region", async () => {
|
it("crops a visual surface screenshot to its observation-time visible region", async () => {
|
||||||
@@ -368,6 +376,7 @@ describe("handleScreenshot", () => {
|
|||||||
clip?: { x: number; y: number; width: number; height: number };
|
clip?: { x: number; y: number; width: number; height: number };
|
||||||
};
|
};
|
||||||
expect(clip.clip).toMatchObject({ x: 25, y: 30, width: 50, height: 40 });
|
expect(clip.clip).toMatchObject({ x: 25, y: 30, width: 50, height: 40 });
|
||||||
|
expect(res.capture?.id).toMatch(/^sc_/);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("returns not_found for unknown ref", async () => {
|
it("returns not_found for unknown ref", async () => {
|
||||||
|
|||||||
@@ -252,12 +252,23 @@ describe("handleSessionStop with auto-return", () => {
|
|||||||
expect(aw.remove).not.toHaveBeenCalled();
|
expect(aw.remove).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("clears the RefStore before window teardown", async () => {
|
it("clears refs and Surface captures before window teardown", async () => {
|
||||||
const aw = fakeAgentWindow([100]);
|
const aw = fakeAgentWindow([100]);
|
||||||
const sm = new SessionManager({ agentWindow: aw });
|
const sm = new SessionManager({ agentWindow: aw });
|
||||||
const ctx = await sm.start("aa11");
|
const ctx = await sm.start("aa11");
|
||||||
// Insert a fake ref so we can verify clear() ran.
|
// Insert a fake ref so we can verify clear() ran.
|
||||||
ctx.refStore.set("e1", 123, { tabId: 7 });
|
ctx.refStore.set("e1", 123, { tabId: 7 });
|
||||||
|
ctx.surfaceCaptures.create({
|
||||||
|
sessionId: "aa11",
|
||||||
|
tabId: 7,
|
||||||
|
navigationIdentity: "navigation",
|
||||||
|
surface: { ref: "e1", backendNodeId: 123, observationGeneration: 0 },
|
||||||
|
topViewportRect: { x: 0, y: 0, w: 100, h: 50 },
|
||||||
|
imageWidth: 100,
|
||||||
|
imageHeight: 50,
|
||||||
|
viewportSignature: "viewport",
|
||||||
|
frameProjectionSignature: "frame",
|
||||||
|
});
|
||||||
const state: FakeState = {
|
const state: FakeState = {
|
||||||
tabs: new Map(),
|
tabs: new Map(),
|
||||||
windowsClosed: new Set(),
|
windowsClosed: new Set(),
|
||||||
@@ -266,5 +277,6 @@ describe("handleSessionStop with auto-return", () => {
|
|||||||
const { tabs, windows } = makeApis(state);
|
const { tabs, windows } = makeApis(state);
|
||||||
await handleSessionStop(sm, { session_id: "aa11" }, { tabManagement: { tabs, windows } });
|
await handleSessionStop(sm, { session_id: "aa11" }, { tabManagement: { tabs, windows } });
|
||||||
expect(ctx.refStore.isEmpty()).toBe(true);
|
expect(ctx.refStore.isEmpty()).toBe(true);
|
||||||
|
expect(ctx.surfaceCaptures.size()).toBe(0);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -26,12 +26,14 @@ describe("lookupSnapshotRef", () => {
|
|||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
kind: "dom",
|
kind: "dom",
|
||||||
capabilities: ["interact", "screenshot"],
|
capabilities: ["interact", "screenshot"],
|
||||||
|
generation: 0,
|
||||||
});
|
});
|
||||||
expect(lookupSnapshotRef(ctx, "e3", 4)).toEqual({
|
expect(lookupSnapshotRef(ctx, "e3", 4)).toEqual({
|
||||||
backendNodeId: 1234,
|
backendNodeId: 1234,
|
||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
kind: "dom",
|
kind: "dom",
|
||||||
capabilities: ["interact", "screenshot"],
|
capabilities: ["interact", "screenshot"],
|
||||||
|
generation: 0,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -68,6 +70,7 @@ describe("resolveSnapshotRef", () => {
|
|||||||
cdpSessionId: "child-session",
|
cdpSessionId: "child-session",
|
||||||
kind: "dom" as const,
|
kind: "dom" as const,
|
||||||
capabilities: ["interact", "screenshot"] as const,
|
capabilities: ["interact", "screenshot"] as const,
|
||||||
|
generation: 0,
|
||||||
};
|
};
|
||||||
expect(lookupSnapshotRef(ctx, "@e3", 4)).toEqual(expected);
|
expect(lookupSnapshotRef(ctx, "@e3", 4)).toEqual(expected);
|
||||||
expect(resolveSnapshotRef(ctx, "@e3", 4)).toEqual(expected);
|
expect(resolveSnapshotRef(ctx, "@e3", 4)).toEqual(expected);
|
||||||
@@ -115,6 +118,7 @@ describe("resolveSnapshotRef", () => {
|
|||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
kind: "dom",
|
kind: "dom",
|
||||||
capabilities: ["interact", "screenshot"],
|
capabilities: ["interact", "screenshot"],
|
||||||
|
generation: 0,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,52 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import {
|
||||||
|
mapImagePointToViewport,
|
||||||
|
pointInRegion,
|
||||||
|
sameRect,
|
||||||
|
surfaceVisibleRect,
|
||||||
|
} from "../surface-coordinate";
|
||||||
|
|
||||||
|
describe("surface coordinate mapping", () => {
|
||||||
|
it("maps capture image pixels through the actual screenshot dimensions", () => {
|
||||||
|
expect(mapImagePointToViewport({ x: 100, y: 50, w: 400, h: 200 }, 800, 400, 200, 100)).toEqual({
|
||||||
|
x: 200,
|
||||||
|
y: 100,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid image coordinates and dimensions", () => {
|
||||||
|
const rect = { x: 0, y: 0, w: 100, h: 50 };
|
||||||
|
expect(mapImagePointToViewport(rect, 100, 50, -1, 0)).toBeNull();
|
||||||
|
expect(mapImagePointToViewport(rect, 100, 50, 100, 0)).toBeNull();
|
||||||
|
expect(mapImagePointToViewport(rect, 100, 50, 0, 50)).toBeNull();
|
||||||
|
expect(mapImagePointToViewport(rect, 100, 50, Number.NaN, 0)).toBeNull();
|
||||||
|
expect(mapImagePointToViewport(rect, 100, 50, Number.POSITIVE_INFINITY, 0)).toBeNull();
|
||||||
|
expect(mapImagePointToViewport(rect, 0, 50, 0, 0)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("intersects live and observed visible regions and compares them strictly", () => {
|
||||||
|
const clipped = surfaceVisibleRect(
|
||||||
|
{ x: 0, y: 0, width: 200, height: 100 },
|
||||||
|
{ x: 25, y: 30, w: 50, h: 40 },
|
||||||
|
);
|
||||||
|
expect(clipped).toEqual({ x: 25, y: 30, w: 50, h: 40 });
|
||||||
|
expect(sameRect(clipped as NonNullable<typeof clipped>, { x: 25, y: 30, w: 50, h: 40 })).toBe(
|
||||||
|
true,
|
||||||
|
);
|
||||||
|
expect(sameRect(clipped as NonNullable<typeof clipped>, { x: 26, y: 30, w: 50, h: 40 })).toBe(
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("checks the projected visible region rather than only its bounding box", () => {
|
||||||
|
const triangle = [
|
||||||
|
[
|
||||||
|
{ x: 0, y: 0 },
|
||||||
|
{ x: 100, y: 0 },
|
||||||
|
{ x: 0, y: 100 },
|
||||||
|
],
|
||||||
|
];
|
||||||
|
expect(pointInRegion({ x: 20, y: 20 }, triangle)).toBe(true);
|
||||||
|
expect(pointInRegion({ x: 90, y: 90 }, triangle)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,313 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { SessionManager } from "@/session-manager/manager";
|
||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
import { captureSurfaceEnvironment, handleSurfacePointClick } from "../surface-point-action";
|
||||||
|
|
||||||
|
function fakeAgentWindow() {
|
||||||
|
return {
|
||||||
|
create: vi.fn(async () => 100),
|
||||||
|
remove: vi.fn(async () => {}),
|
||||||
|
ensureActiveTab: vi.fn(async () => {}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeBrowser() {
|
||||||
|
let loaderId = "loader-1";
|
||||||
|
let pageY = 0;
|
||||||
|
let quad = [10, 20, 110, 20, 110, 60, 10, 60];
|
||||||
|
let dispatchFails = false;
|
||||||
|
const sent: Array<{ method: string; params?: object }> = [];
|
||||||
|
const cdp: CdpRunner = {
|
||||||
|
send: vi.fn(async (_tabId: number, method: string, params?: object) => {
|
||||||
|
sent.push({ method, params });
|
||||||
|
if (method === "Page.getFrameTree") {
|
||||||
|
return {
|
||||||
|
frameTree: { frame: { id: "main", loaderId, url: "https://fixture.test/" } },
|
||||||
|
} as never;
|
||||||
|
}
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return {
|
||||||
|
cssLayoutViewport: { clientWidth: 800, clientHeight: 600, pageX: 0, pageY },
|
||||||
|
cssVisualViewport: {
|
||||||
|
clientWidth: 800,
|
||||||
|
clientHeight: 600,
|
||||||
|
pageX: 0,
|
||||||
|
pageY,
|
||||||
|
scale: 1,
|
||||||
|
},
|
||||||
|
} as never;
|
||||||
|
}
|
||||||
|
if (method === "DOM.getContentQuads") return { quads: [quad] } as never;
|
||||||
|
if (method === "Input.dispatchMouseEvent") {
|
||||||
|
if (dispatchFails) throw new Error("input failed");
|
||||||
|
return {} as never;
|
||||||
|
}
|
||||||
|
throw new Error(`unexpected CDP call ${method}`);
|
||||||
|
}) as CdpRunner["send"],
|
||||||
|
trackSessionTab: vi.fn(),
|
||||||
|
};
|
||||||
|
const tabsApi = {
|
||||||
|
get: vi.fn(
|
||||||
|
async (tabId: number) => ({ id: tabId, windowId: 100, active: true }) as chrome.tabs.Tab,
|
||||||
|
),
|
||||||
|
query: vi.fn(async () => [{ id: 4, windowId: 100, active: true } as chrome.tabs.Tab]),
|
||||||
|
};
|
||||||
|
return {
|
||||||
|
cdp,
|
||||||
|
tabsApi,
|
||||||
|
sent,
|
||||||
|
setLoaderId: (value: string) => {
|
||||||
|
loaderId = value;
|
||||||
|
},
|
||||||
|
setPageY: (value: number) => {
|
||||||
|
pageY = value;
|
||||||
|
},
|
||||||
|
setQuad: (value: number[]) => {
|
||||||
|
quad = value;
|
||||||
|
},
|
||||||
|
failDispatch: () => {
|
||||||
|
dispatchFails = true;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function setupCapture() {
|
||||||
|
const manager = new SessionManager({ agentWindow: fakeAgentWindow() });
|
||||||
|
const context = await manager.start("aa11");
|
||||||
|
context.refStore.set("e3", 99, {
|
||||||
|
tabId: 4,
|
||||||
|
kind: "surface",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 100, h: 40 },
|
||||||
|
});
|
||||||
|
const browser = fakeBrowser();
|
||||||
|
const environment = await captureSurfaceEnvironment(browser.cdp, 4, undefined);
|
||||||
|
if ("code" in environment) throw new Error(environment.message);
|
||||||
|
const entry = context.refStore.resolveEntry("e3");
|
||||||
|
if (!entry) throw new Error("missing ref");
|
||||||
|
const capture = context.surfaceCaptures.create({
|
||||||
|
sessionId: "aa11",
|
||||||
|
tabId: 4,
|
||||||
|
navigationIdentity: environment.navigationIdentity,
|
||||||
|
surface: {
|
||||||
|
ref: "e3",
|
||||||
|
backendNodeId: 99,
|
||||||
|
observationGeneration: entry.generation,
|
||||||
|
},
|
||||||
|
topViewportRect: { x: 10, y: 20, w: 100, h: 40 },
|
||||||
|
imageWidth: 200,
|
||||||
|
imageHeight: 80,
|
||||||
|
viewportSignature: environment.viewportSignature,
|
||||||
|
frameProjectionSignature: environment.frameProjectionSignature,
|
||||||
|
});
|
||||||
|
return { manager, context, browser, capture };
|
||||||
|
}
|
||||||
|
|
||||||
|
function pointParams(captureId: string) {
|
||||||
|
return {
|
||||||
|
session_id: "aa11",
|
||||||
|
ref: "@e3",
|
||||||
|
capture_id: captureId,
|
||||||
|
image_x: 50,
|
||||||
|
image_y: 20,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("Surface screenshot-bound point click", () => {
|
||||||
|
it("maps one fresh capture coordinate and dispatches exactly one trusted click", async () => {
|
||||||
|
const { manager, browser, capture } = await setupCapture();
|
||||||
|
const result = await handleSurfacePointClick(manager, pointParams(capture.id), browser);
|
||||||
|
|
||||||
|
if ("code" in result) throw new Error(JSON.stringify(result));
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
used_ref: "e3",
|
||||||
|
capture_id: capture.id,
|
||||||
|
image_x: 50,
|
||||||
|
image_y: 20,
|
||||||
|
x: 35,
|
||||||
|
y: 30,
|
||||||
|
});
|
||||||
|
expect(browser.sent.filter((call) => call.method === "Input.dispatchMouseEvent")).toHaveLength(
|
||||||
|
3,
|
||||||
|
);
|
||||||
|
|
||||||
|
const repeated = await handleSurfacePointClick(manager, pointParams(capture.id), browser);
|
||||||
|
expect(repeated).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
data: { reason: "surface_capture_consumed" },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a new observation generation before sending input", async () => {
|
||||||
|
const { manager, context, browser, capture } = await setupCapture();
|
||||||
|
context.refStore.replace([
|
||||||
|
[
|
||||||
|
"e3",
|
||||||
|
{
|
||||||
|
backendNodeId: 99,
|
||||||
|
tabId: 4,
|
||||||
|
kind: "surface" as const,
|
||||||
|
visibleRect: { x: 10, y: 20, w: 100, h: 40 },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
|
||||||
|
const result = await handleSurfacePointClick(manager, pointParams(capture.id), browser);
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
data: { reason: "surface_capture_stale" },
|
||||||
|
});
|
||||||
|
expect(browser.sent.some((call) => call.method === "Input.dispatchMouseEvent")).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects navigation, scroll, and visible geometry changes", async () => {
|
||||||
|
for (const mutate of [
|
||||||
|
(browser: ReturnType<typeof fakeBrowser>) => browser.setLoaderId("loader-2"),
|
||||||
|
(browser: ReturnType<typeof fakeBrowser>) => browser.setPageY(20),
|
||||||
|
(browser: ReturnType<typeof fakeBrowser>) =>
|
||||||
|
browser.setQuad([11, 20, 111, 20, 111, 60, 11, 60]),
|
||||||
|
]) {
|
||||||
|
const { manager, browser, capture } = await setupCapture();
|
||||||
|
mutate(browser);
|
||||||
|
const result = await handleSurfacePointClick(manager, pointParams(capture.id), browser);
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
data: { reason: "surface_capture_stale" },
|
||||||
|
});
|
||||||
|
expect(browser.sent.some((call) => call.method === "Input.dispatchMouseEvent")).toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("consumes the capture when coordinates or input dispatch fail", async () => {
|
||||||
|
const invalid = await setupCapture();
|
||||||
|
const outside = await handleSurfacePointClick(
|
||||||
|
invalid.manager,
|
||||||
|
{ ...pointParams(invalid.capture.id), image_x: 200 },
|
||||||
|
invalid.browser,
|
||||||
|
);
|
||||||
|
expect(outside).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
data: { reason: "surface_coordinate_invalid" },
|
||||||
|
});
|
||||||
|
expect(
|
||||||
|
await handleSurfacePointClick(
|
||||||
|
invalid.manager,
|
||||||
|
pointParams(invalid.capture.id),
|
||||||
|
invalid.browser,
|
||||||
|
),
|
||||||
|
).toMatchObject({ data: { reason: "surface_capture_consumed" } });
|
||||||
|
|
||||||
|
const failed = await setupCapture();
|
||||||
|
failed.browser.failDispatch();
|
||||||
|
expect(
|
||||||
|
await handleSurfacePointClick(failed.manager, pointParams(failed.capture.id), failed.browser),
|
||||||
|
).toMatchObject({ code: "cdp_failed" });
|
||||||
|
expect(
|
||||||
|
await handleSurfacePointClick(failed.manager, pointParams(failed.capture.id), failed.browser),
|
||||||
|
).toMatchObject({ data: { reason: "surface_capture_consumed" } });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("maps image coordinates through an OOPIF frame projection", async () => {
|
||||||
|
const manager = new SessionManager({ agentWindow: fakeAgentWindow() });
|
||||||
|
const context = await manager.start("aa11");
|
||||||
|
context.refStore.set("e3", 99, {
|
||||||
|
tabId: 4,
|
||||||
|
frameId: "child",
|
||||||
|
cdpSessionId: "child-session",
|
||||||
|
kind: "surface",
|
||||||
|
visibleRect: { x: 120, y: 110, w: 100, h: 40 },
|
||||||
|
});
|
||||||
|
const graph = {
|
||||||
|
rootFrameId: "main",
|
||||||
|
frames: [
|
||||||
|
{ frameId: "main", target: { tabId: 4 } },
|
||||||
|
{
|
||||||
|
frameId: "child",
|
||||||
|
parentFrameId: "main",
|
||||||
|
ownerBackendNodeId: 77,
|
||||||
|
target: { tabId: 4, sessionId: "child-session" },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
const sent: Array<{ method: string; params?: object }> = [];
|
||||||
|
const cdp: CdpRunner = {
|
||||||
|
send: vi.fn(async (_tabId: number, method: string, params?: object) => {
|
||||||
|
sent.push({ method, params });
|
||||||
|
if (method === "Page.getFrameTree") {
|
||||||
|
return {
|
||||||
|
frameTree: {
|
||||||
|
frame: { id: "main", loaderId: "loader-1", url: "https://fixture.test/" },
|
||||||
|
},
|
||||||
|
} as never;
|
||||||
|
}
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return {
|
||||||
|
cssLayoutViewport: { clientWidth: 800, clientHeight: 600, pageX: 0, pageY: 0 },
|
||||||
|
cssVisualViewport: {
|
||||||
|
clientWidth: 800,
|
||||||
|
clientHeight: 600,
|
||||||
|
pageX: 0,
|
||||||
|
pageY: 0,
|
||||||
|
scale: 1,
|
||||||
|
},
|
||||||
|
} as never;
|
||||||
|
}
|
||||||
|
if (method === "DOM.getBoxModel") {
|
||||||
|
return { model: { content: [100, 100, 300, 100, 300, 200, 100, 200] } } as never;
|
||||||
|
}
|
||||||
|
if (method === "Input.dispatchMouseEvent") return {} as never;
|
||||||
|
throw new Error(`unexpected root CDP call ${method}`);
|
||||||
|
}) as CdpRunner["send"],
|
||||||
|
sendToTarget: vi.fn(async (_target, method) => {
|
||||||
|
if (method === "DOM.getContentQuads") {
|
||||||
|
return { quads: [[20, 10, 120, 10, 120, 50, 20, 50]] } as never;
|
||||||
|
}
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return { cssLayoutViewport: { clientWidth: 200, clientHeight: 100 } } as never;
|
||||||
|
}
|
||||||
|
throw new Error(`unexpected child CDP call ${method}`);
|
||||||
|
}) as CdpRunner["sendToTarget"],
|
||||||
|
getFrameGraph: vi.fn(async () => graph),
|
||||||
|
trackSessionTab: vi.fn(),
|
||||||
|
};
|
||||||
|
const tabsApi = {
|
||||||
|
get: vi.fn(async () => ({ id: 4, windowId: 100, active: true }) as chrome.tabs.Tab),
|
||||||
|
query: vi.fn(async () => [{ id: 4, windowId: 100, active: true } as chrome.tabs.Tab]),
|
||||||
|
};
|
||||||
|
const environment = await captureSurfaceEnvironment(cdp, 4, "child");
|
||||||
|
if ("code" in environment) throw new Error(environment.message);
|
||||||
|
const entry = context.refStore.resolveEntry("e3");
|
||||||
|
if (!entry) throw new Error("missing ref");
|
||||||
|
const capture = context.surfaceCaptures.create({
|
||||||
|
sessionId: "aa11",
|
||||||
|
tabId: 4,
|
||||||
|
navigationIdentity: environment.navigationIdentity,
|
||||||
|
surface: {
|
||||||
|
ref: "e3",
|
||||||
|
frameId: "child",
|
||||||
|
backendNodeId: 99,
|
||||||
|
observationGeneration: entry.generation,
|
||||||
|
},
|
||||||
|
topViewportRect: { x: 120, y: 110, w: 100, h: 40 },
|
||||||
|
imageWidth: 200,
|
||||||
|
imageHeight: 80,
|
||||||
|
viewportSignature: environment.viewportSignature,
|
||||||
|
frameProjectionSignature: environment.frameProjectionSignature,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await handleSurfacePointClick(
|
||||||
|
manager,
|
||||||
|
{
|
||||||
|
session_id: "aa11",
|
||||||
|
ref: "@e3",
|
||||||
|
capture_id: capture.id,
|
||||||
|
image_x: 100,
|
||||||
|
image_y: 40,
|
||||||
|
},
|
||||||
|
{ cdp, tabsApi },
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in result) throw new Error(JSON.stringify(result));
|
||||||
|
expect(result).toMatchObject({ x: 170, y: 130 });
|
||||||
|
expect(sent.filter((call) => call.method === "Input.dispatchMouseEvent")).toHaveLength(3);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -43,6 +43,7 @@ import {
|
|||||||
resolveTargetTab,
|
resolveTargetTab,
|
||||||
} from "./shared";
|
} from "./shared";
|
||||||
import { resolveSnapshotRef } from "./snapshot-ref";
|
import { resolveSnapshotRef } from "./snapshot-ref";
|
||||||
|
import { handleSurfacePointClick } from "./surface-point-action";
|
||||||
|
|
||||||
export interface InteractionDeps {
|
export interface InteractionDeps {
|
||||||
cdp: CdpRunner;
|
cdp: CdpRunner;
|
||||||
@@ -224,6 +225,11 @@ export async function handleClick(
|
|||||||
params: ClickParams,
|
params: ClickParams,
|
||||||
deps: InteractionDeps = getDefaultDeps(),
|
deps: InteractionDeps = getDefaultDeps(),
|
||||||
): Promise<ClickResult | RpcError> {
|
): Promise<ClickResult | RpcError> {
|
||||||
|
const hasSurfacePointParams =
|
||||||
|
params.capture_id !== undefined || params.image_x !== undefined || params.image_y !== undefined;
|
||||||
|
if (hasSurfacePointParams) {
|
||||||
|
return handleSurfacePointClick(manager, params, deps);
|
||||||
|
}
|
||||||
const ctxOrErr = lookupSession(manager, params, "click");
|
const ctxOrErr = lookupSession(manager, params, "click");
|
||||||
if (isRpcError(ctxOrErr)) return ctxOrErr;
|
if (isRpcError(ctxOrErr)) return ctxOrErr;
|
||||||
const ctx = ctxOrErr;
|
const ctx = ctxOrErr;
|
||||||
|
|||||||
@@ -48,6 +48,8 @@ import {
|
|||||||
type ToolEffect,
|
type ToolEffect,
|
||||||
} from "./shared";
|
} from "./shared";
|
||||||
import { resolveSnapshotRef } from "./snapshot-ref";
|
import { resolveSnapshotRef } from "./snapshot-ref";
|
||||||
|
import { surfaceVisibleRect } from "./surface-coordinate";
|
||||||
|
import { captureSurfaceEnvironment } from "./surface-point-action";
|
||||||
import {
|
import {
|
||||||
type CapturedNode,
|
type CapturedNode,
|
||||||
type CapturedViewModel,
|
type CapturedViewModel,
|
||||||
@@ -194,7 +196,9 @@ async function captureElementScreenshot(
|
|||||||
visualSurface = false,
|
visualSurface = false,
|
||||||
observedVisibleRect?: Rect,
|
observedVisibleRect?: Rect,
|
||||||
signal?: AbortSignal,
|
signal?: AbortSignal,
|
||||||
): Promise<{ image_base64: string; width: number; height: number } | RpcError> {
|
): Promise<
|
||||||
|
{ image_base64: string; width: number; height: number; topViewportRect: Rect } | RpcError
|
||||||
|
> {
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
const geometry = await resolveNodeGeometry(
|
const geometry = await resolveNodeGeometry(
|
||||||
cdp,
|
cdp,
|
||||||
@@ -204,24 +208,19 @@ async function captureElementScreenshot(
|
|||||||
);
|
);
|
||||||
if (isRpcError(geometry)) return geometry;
|
if (isRpcError(geometry)) return geometry;
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
const liveRect = geometry.topBounds;
|
const topViewportRect = surfaceVisibleRect(
|
||||||
const rect =
|
geometry.topBounds,
|
||||||
visualSurface && observedVisibleRect
|
visualSurface ? observedVisibleRect : undefined,
|
||||||
? (() => {
|
);
|
||||||
const x = Math.max(liveRect.x, observedVisibleRect.x);
|
if (!topViewportRect) {
|
||||||
const y = Math.max(liveRect.y, observedVisibleRect.y);
|
return { code: "permission_denied", message: "surface is no longer visible" };
|
||||||
const right = Math.min(
|
}
|
||||||
liveRect.x + liveRect.width,
|
const rect = {
|
||||||
observedVisibleRect.x + observedVisibleRect.w,
|
x: topViewportRect.x,
|
||||||
);
|
y: topViewportRect.y,
|
||||||
const bottom = Math.min(
|
width: topViewportRect.w,
|
||||||
liveRect.y + liveRect.height,
|
height: topViewportRect.h,
|
||||||
observedVisibleRect.y + observedVisibleRect.h,
|
};
|
||||||
);
|
|
||||||
return right > x && bottom > y ? { x, y, width: right - x, height: bottom - y } : null;
|
|
||||||
})()
|
|
||||||
: liveRect;
|
|
||||||
if (!rect) return { code: "permission_denied", message: "surface is no longer visible" };
|
|
||||||
const scale = visualSurface
|
const scale = visualSurface
|
||||||
? Math.min(
|
? Math.min(
|
||||||
1,
|
1,
|
||||||
@@ -251,7 +250,7 @@ async function captureElementScreenshot(
|
|||||||
width: Math.round(rect.width),
|
width: Math.round(rect.width),
|
||||||
height: Math.round(rect.height),
|
height: Math.round(rect.height),
|
||||||
};
|
};
|
||||||
return { image_base64, width: dims.width, height: dims.height };
|
return { image_base64, width: dims.width, height: dims.height, topViewportRect };
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return {
|
||||||
code: "cdp_failed",
|
code: "cdp_failed",
|
||||||
@@ -374,12 +373,46 @@ export async function handleScreenshot(
|
|||||||
);
|
);
|
||||||
if (isRpcError(captured)) return captured;
|
if (isRpcError(captured)) return captured;
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
|
const capture =
|
||||||
|
node.kind === "surface"
|
||||||
|
? await (async () => {
|
||||||
|
const environment = await captureSurfaceEnvironment(cdp, target.tabId, node.frameId);
|
||||||
|
if (isRpcError(environment)) return environment;
|
||||||
|
return ctx.surfaceCaptures.create({
|
||||||
|
sessionId: ctx.sessionId,
|
||||||
|
tabId: target.tabId,
|
||||||
|
navigationIdentity: environment.navigationIdentity,
|
||||||
|
surface: {
|
||||||
|
ref: node.refKey,
|
||||||
|
...(node.frameId ? { frameId: node.frameId } : {}),
|
||||||
|
backendNodeId: node.backendNodeId,
|
||||||
|
observationGeneration: node.generation,
|
||||||
|
},
|
||||||
|
topViewportRect: captured.topViewportRect,
|
||||||
|
imageWidth: captured.width,
|
||||||
|
imageHeight: captured.height,
|
||||||
|
viewportSignature: environment.viewportSignature,
|
||||||
|
frameProjectionSignature: environment.frameProjectionSignature,
|
||||||
|
});
|
||||||
|
})()
|
||||||
|
: null;
|
||||||
|
if (capture && isRpcError(capture)) return capture;
|
||||||
return withShotDialogs({
|
return withShotDialogs({
|
||||||
image_base64: captured.image_base64,
|
image_base64: captured.image_base64,
|
||||||
width: captured.width,
|
width: captured.width,
|
||||||
height: captured.height,
|
height: captured.height,
|
||||||
format: "png",
|
format: "png",
|
||||||
tab_id: target.tabId,
|
tab_id: target.tabId,
|
||||||
|
...(capture
|
||||||
|
? {
|
||||||
|
capture: {
|
||||||
|
id: capture.id,
|
||||||
|
surface_ref: `@${capture.surface.ref}`,
|
||||||
|
coordinate_space: "capture-image-pixel" as const,
|
||||||
|
expires_at: capture.expiresAt,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -243,6 +243,7 @@ export async function handleSessionStop(
|
|||||||
|
|
||||||
// Step 2: clear the per-session RefStore (review M6/M7 parity).
|
// Step 2: clear the per-session RefStore (review M6/M7 parity).
|
||||||
ctx.refStore.clear();
|
ctx.refStore.clear();
|
||||||
|
ctx.surfaceCaptures.clear();
|
||||||
|
|
||||||
clearRecordingForSession(params.session_id);
|
clearRecordingForSession(params.session_id);
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ export interface SnapshotRefLookup {
|
|||||||
visibleRect?: Rect;
|
visibleRect?: Rect;
|
||||||
kind: RefTargetKind;
|
kind: RefTargetKind;
|
||||||
capabilities: RefCapability[];
|
capabilities: RefCapability[];
|
||||||
|
generation: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
function refEntryForTab(ctx: SessionContext, refKey: string, tabId: number) {
|
function refEntryForTab(ctx: SessionContext, refKey: string, tabId: number) {
|
||||||
@@ -44,6 +45,7 @@ export function lookupSnapshotRef(
|
|||||||
...(entry.visibleRect ? { visibleRect: entry.visibleRect } : {}),
|
...(entry.visibleRect ? { visibleRect: entry.visibleRect } : {}),
|
||||||
kind: entry.kind,
|
kind: entry.kind,
|
||||||
capabilities: entry.capabilities,
|
capabilities: entry.capabilities,
|
||||||
|
generation: entry.generation,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
import type { Point, Region, ViewportRect } from "./geometry";
|
||||||
|
|
||||||
|
const RECT_EPSILON = 0.01;
|
||||||
|
|
||||||
|
export function surfaceVisibleRect(
|
||||||
|
liveRect: ViewportRect,
|
||||||
|
observedRect: Rect | undefined,
|
||||||
|
): Rect | null {
|
||||||
|
const observed = observedRect ?? {
|
||||||
|
x: liveRect.x,
|
||||||
|
y: liveRect.y,
|
||||||
|
w: liveRect.width,
|
||||||
|
h: liveRect.height,
|
||||||
|
};
|
||||||
|
const x = Math.max(liveRect.x, observed.x);
|
||||||
|
const y = Math.max(liveRect.y, observed.y);
|
||||||
|
const right = Math.min(liveRect.x + liveRect.width, observed.x + observed.w);
|
||||||
|
const bottom = Math.min(liveRect.y + liveRect.height, observed.y + observed.h);
|
||||||
|
return right > x && bottom > y ? { x, y, w: right - x, h: bottom - y } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function sameRect(a: Rect, b: Rect): boolean {
|
||||||
|
return (
|
||||||
|
Math.abs(a.x - b.x) <= RECT_EPSILON &&
|
||||||
|
Math.abs(a.y - b.y) <= RECT_EPSILON &&
|
||||||
|
Math.abs(a.w - b.w) <= RECT_EPSILON &&
|
||||||
|
Math.abs(a.h - b.h) <= RECT_EPSILON
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function mapImagePointToViewport(
|
||||||
|
rect: Rect,
|
||||||
|
imageWidth: number,
|
||||||
|
imageHeight: number,
|
||||||
|
imageX: number,
|
||||||
|
imageY: number,
|
||||||
|
): Point | null {
|
||||||
|
if (
|
||||||
|
!Number.isFinite(imageX) ||
|
||||||
|
!Number.isFinite(imageY) ||
|
||||||
|
!Number.isSafeInteger(imageWidth) ||
|
||||||
|
!Number.isSafeInteger(imageHeight) ||
|
||||||
|
imageWidth <= 0 ||
|
||||||
|
imageHeight <= 0 ||
|
||||||
|
imageX < 0 ||
|
||||||
|
imageY < 0 ||
|
||||||
|
imageX >= imageWidth ||
|
||||||
|
imageY >= imageHeight ||
|
||||||
|
!Number.isFinite(rect.x) ||
|
||||||
|
!Number.isFinite(rect.y) ||
|
||||||
|
!Number.isFinite(rect.w) ||
|
||||||
|
!Number.isFinite(rect.h) ||
|
||||||
|
rect.w <= 0 ||
|
||||||
|
rect.h <= 0
|
||||||
|
) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
x: rect.x + (imageX / imageWidth) * rect.w,
|
||||||
|
y: rect.y + (imageY / imageHeight) * rect.h,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function pointInPolygon(point: Point, polygon: Point[]): boolean {
|
||||||
|
for (let index = 0; index < polygon.length; index += 1) {
|
||||||
|
const a = polygon[index];
|
||||||
|
const b = polygon[(index + 1) % polygon.length];
|
||||||
|
const cross = (point.x - a.x) * (b.y - a.y) - (point.y - a.y) * (b.x - a.x);
|
||||||
|
const withinX = point.x >= Math.min(a.x, b.x) - 1e-9 && point.x <= Math.max(a.x, b.x) + 1e-9;
|
||||||
|
const withinY = point.y >= Math.min(a.y, b.y) - 1e-9 && point.y <= Math.max(a.y, b.y) + 1e-9;
|
||||||
|
if (Math.abs(cross) <= 1e-9 && withinX && withinY) return true;
|
||||||
|
}
|
||||||
|
let inside = false;
|
||||||
|
for (let index = 0, previous = polygon.length - 1; index < polygon.length; previous = index++) {
|
||||||
|
const a = polygon[index];
|
||||||
|
const b = polygon[previous];
|
||||||
|
const intersects =
|
||||||
|
a.y > point.y !== b.y > point.y &&
|
||||||
|
point.x < ((b.x - a.x) * (point.y - a.y)) / (b.y - a.y) + a.x;
|
||||||
|
if (intersects) inside = !inside;
|
||||||
|
}
|
||||||
|
return inside;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function pointInRegion(point: Point, region: Region): boolean {
|
||||||
|
return region.some((polygon) => polygon.length >= 3 && pointInPolygon(point, polygon));
|
||||||
|
}
|
||||||
@@ -0,0 +1,320 @@
|
|||||||
|
import type { CdpFrameGraph } from "@/browser-driver/frame-graph";
|
||||||
|
import type { SessionManager } from "@/session-manager/manager";
|
||||||
|
import type { ClickParams, ClickResult, RpcError } from "@/transport/types";
|
||||||
|
import { attachDialogs, markDialogCursor } from "./dialogs";
|
||||||
|
import { rpcError } from "./errors";
|
||||||
|
import { resolveNodeGeometry } from "./frame-geometry";
|
||||||
|
import {
|
||||||
|
type CdpRunner,
|
||||||
|
type ChromeTabsApi,
|
||||||
|
enforceAgentWindow,
|
||||||
|
isRpcError,
|
||||||
|
lookupSession,
|
||||||
|
normaliseRef,
|
||||||
|
resolveTargetTab,
|
||||||
|
} from "./shared";
|
||||||
|
import { resolveSnapshotRef } from "./snapshot-ref";
|
||||||
|
import {
|
||||||
|
mapImagePointToViewport,
|
||||||
|
pointInRegion,
|
||||||
|
sameRect,
|
||||||
|
surfaceVisibleRect,
|
||||||
|
} from "./surface-coordinate";
|
||||||
|
|
||||||
|
export interface SurfaceCaptureEnvironment {
|
||||||
|
navigationIdentity: string;
|
||||||
|
viewportSignature: string;
|
||||||
|
frameProjectionSignature: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SurfacePointActionDeps {
|
||||||
|
cdp: CdpRunner;
|
||||||
|
tabsApi: ChromeTabsApi;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
bypassOverlay?: (tabId: number, enabled: boolean) => Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
function stale(message: string): RpcError {
|
||||||
|
return rpcError("permission_denied", "surface_capture_stale", message);
|
||||||
|
}
|
||||||
|
|
||||||
|
function finiteObject(value: unknown): unknown {
|
||||||
|
if (Array.isArray(value)) return value.map(finiteObject);
|
||||||
|
if (typeof value !== "object" || value === null) return value;
|
||||||
|
return Object.fromEntries(
|
||||||
|
Object.entries(value)
|
||||||
|
.filter(
|
||||||
|
([, entry]) => entry !== undefined && (typeof entry !== "number" || Number.isFinite(entry)),
|
||||||
|
)
|
||||||
|
.sort(([a], [b]) => a.localeCompare(b))
|
||||||
|
.map(([key, entry]) => [key, finiteObject(entry)]),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function framePathSignature(graph: CdpFrameGraph, frameId: string | undefined): string | null {
|
||||||
|
if (!frameId) return "top";
|
||||||
|
const frames = new Map(graph.frames.map((frame) => [frame.frameId, frame]));
|
||||||
|
const path: Array<{
|
||||||
|
frameId: string;
|
||||||
|
parentFrameId?: string;
|
||||||
|
ownerBackendNodeId?: number;
|
||||||
|
targetSessionId?: string;
|
||||||
|
}> = [];
|
||||||
|
const seen = new Set<string>();
|
||||||
|
let current = frames.get(frameId);
|
||||||
|
while (current) {
|
||||||
|
if (seen.has(current.frameId)) return null;
|
||||||
|
seen.add(current.frameId);
|
||||||
|
path.push({
|
||||||
|
frameId: current.frameId,
|
||||||
|
...(current.parentFrameId ? { parentFrameId: current.parentFrameId } : {}),
|
||||||
|
...(current.ownerBackendNodeId !== undefined
|
||||||
|
? { ownerBackendNodeId: current.ownerBackendNodeId }
|
||||||
|
: {}),
|
||||||
|
...(current.target.sessionId ? { targetSessionId: current.target.sessionId } : {}),
|
||||||
|
});
|
||||||
|
if (!current.parentFrameId) return JSON.stringify(path);
|
||||||
|
const parent = frames.get(current.parentFrameId);
|
||||||
|
if (!parent) return null;
|
||||||
|
current = parent;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function captureSurfaceEnvironment(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
tabId: number,
|
||||||
|
frameId: string | undefined,
|
||||||
|
): Promise<SurfaceCaptureEnvironment | RpcError> {
|
||||||
|
try {
|
||||||
|
const [tree, metrics, graph] = await Promise.all([
|
||||||
|
cdp.send<{
|
||||||
|
frameTree?: { frame?: { id?: string; loaderId?: string; url?: string } };
|
||||||
|
}>(tabId, "Page.getFrameTree", {}),
|
||||||
|
cdp.send<Record<string, unknown>>(tabId, "Page.getLayoutMetrics", {}),
|
||||||
|
frameId && cdp.getFrameGraph ? cdp.getFrameGraph(tabId) : Promise.resolve(null),
|
||||||
|
]);
|
||||||
|
const root = tree.frameTree?.frame;
|
||||||
|
if (!root?.id || !root.loaderId) {
|
||||||
|
return { code: "cdp_failed", message: "could not identify the current navigation" };
|
||||||
|
}
|
||||||
|
const frameProjectionSignature = frameId
|
||||||
|
? graph
|
||||||
|
? framePathSignature(graph, frameId)
|
||||||
|
: null
|
||||||
|
: "top";
|
||||||
|
if (!frameProjectionSignature) {
|
||||||
|
return { code: "cdp_failed", message: `could not identify frame projection for ${frameId}` };
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
navigationIdentity: JSON.stringify({ id: root.id, loaderId: root.loaderId, url: root.url }),
|
||||||
|
viewportSignature: JSON.stringify(
|
||||||
|
finiteObject({
|
||||||
|
cssLayoutViewport: metrics.cssLayoutViewport,
|
||||||
|
cssVisualViewport: metrics.cssVisualViewport,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
frameProjectionSignature,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
return { code: "cdp_failed", message: error instanceof Error ? error.message : String(error) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validatePointParams(params: ClickParams): RpcError | null {
|
||||||
|
if (!params.capture_id || typeof params.capture_id !== "string") {
|
||||||
|
return { code: "invalid_params", message: "surface point click requires capture_id" };
|
||||||
|
}
|
||||||
|
if (typeof params.image_x !== "number" || !Number.isFinite(params.image_x)) {
|
||||||
|
return { code: "invalid_params", message: "image_x must be a finite number" };
|
||||||
|
}
|
||||||
|
if (typeof params.image_y !== "number" || !Number.isFinite(params.image_y)) {
|
||||||
|
return { code: "invalid_params", message: "image_y must be a finite number" };
|
||||||
|
}
|
||||||
|
if (!params.ref || params.selector) {
|
||||||
|
return {
|
||||||
|
code: "invalid_params",
|
||||||
|
message: "surface point click requires one Surface ref and does not accept a selector",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if ((params.button ?? "left") !== "left" || (params.click_count ?? 1) !== 1) {
|
||||||
|
return {
|
||||||
|
code: "invalid_params",
|
||||||
|
message: "surface point click currently supports one left click only",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (params.modifiers && params.modifiers.length > 0) {
|
||||||
|
return { code: "invalid_params", message: "surface point click does not accept modifiers" };
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function captureConsumeError(reason: "not_found" | "expired" | "consumed"): RpcError {
|
||||||
|
const code = reason === "not_found" ? "not_found" : "permission_denied";
|
||||||
|
return rpcError(code, `surface_capture_${reason}`, `surface capture is ${reason}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
function aborted(signal: AbortSignal | undefined): RpcError | null {
|
||||||
|
return signal?.aborted ? { code: "cancelled", message: "surface point click aborted" } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function handleSurfacePointClick(
|
||||||
|
manager: SessionManager,
|
||||||
|
params: ClickParams,
|
||||||
|
deps: SurfacePointActionDeps,
|
||||||
|
): Promise<ClickResult | RpcError> {
|
||||||
|
const invalid = validatePointParams(params);
|
||||||
|
if (invalid) return invalid;
|
||||||
|
const ctxOrError = lookupSession(manager, params, "click");
|
||||||
|
if (isRpcError(ctxOrError)) return ctxOrError;
|
||||||
|
const ctx = ctxOrError;
|
||||||
|
const earlyAbort = aborted(deps.signal);
|
||||||
|
if (earlyAbort) return earlyAbort;
|
||||||
|
const target = await resolveTargetTab(manager, ctx, params.tab_id, deps.tabsApi);
|
||||||
|
if (isRpcError(target)) return target;
|
||||||
|
const denied = enforceAgentWindow(ctx, target, "click");
|
||||||
|
if (denied) return denied;
|
||||||
|
|
||||||
|
const consumed = ctx.surfaceCaptures.consume(params.capture_id as string);
|
||||||
|
if (!consumed.ok) return captureConsumeError(consumed.reason);
|
||||||
|
const capture = consumed.capture;
|
||||||
|
const postConsumeAbort = aborted(deps.signal);
|
||||||
|
if (postConsumeAbort) return postConsumeAbort;
|
||||||
|
|
||||||
|
if (capture.sessionId !== ctx.sessionId || capture.tabId !== target.tabId) {
|
||||||
|
return stale("surface capture belongs to a different session or tab");
|
||||||
|
}
|
||||||
|
if (normaliseRef(params.ref as string) !== capture.surface.ref) {
|
||||||
|
return stale("surface ref does not match the capture");
|
||||||
|
}
|
||||||
|
const node = resolveSnapshotRef(ctx, params.ref as string, target.tabId, "screenshot");
|
||||||
|
if (isRpcError(node)) return stale(node.message);
|
||||||
|
if (
|
||||||
|
node.kind !== "surface" ||
|
||||||
|
node.backendNodeId !== capture.surface.backendNodeId ||
|
||||||
|
node.frameId !== capture.surface.frameId ||
|
||||||
|
node.generation !== capture.surface.observationGeneration
|
||||||
|
) {
|
||||||
|
return stale("surface observation generation or node identity changed");
|
||||||
|
}
|
||||||
|
|
||||||
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
|
try {
|
||||||
|
await deps.cdp.ensureAttachedToUrl?.(target.tabId, target.url);
|
||||||
|
} catch (error) {
|
||||||
|
return { code: "cdp_failed", message: error instanceof Error ? error.message : String(error) };
|
||||||
|
}
|
||||||
|
const environment = await captureSurfaceEnvironment(deps.cdp, target.tabId, node.frameId);
|
||||||
|
if (isRpcError(environment)) return environment;
|
||||||
|
if (
|
||||||
|
environment.navigationIdentity !== capture.navigationIdentity ||
|
||||||
|
environment.viewportSignature !== capture.viewportSignature ||
|
||||||
|
environment.frameProjectionSignature !== capture.frameProjectionSignature
|
||||||
|
) {
|
||||||
|
return stale("navigation, viewport, zoom, scroll, or frame projection changed");
|
||||||
|
}
|
||||||
|
|
||||||
|
const geometry = await resolveNodeGeometry(
|
||||||
|
deps.cdp,
|
||||||
|
target.tabId,
|
||||||
|
{
|
||||||
|
target: {
|
||||||
|
tabId: target.tabId,
|
||||||
|
...(node.cdpSessionId ? { sessionId: node.cdpSessionId } : {}),
|
||||||
|
},
|
||||||
|
backendNodeId: node.backendNodeId,
|
||||||
|
...(node.frameId ? { frameId: node.frameId } : {}),
|
||||||
|
},
|
||||||
|
{ scrollIntoView: false },
|
||||||
|
);
|
||||||
|
if (isRpcError(geometry)) return stale(geometry.message);
|
||||||
|
const currentRect = surfaceVisibleRect(geometry.topBounds, node.visibleRect);
|
||||||
|
if (!currentRect || !sameRect(currentRect, capture.topViewportRect)) {
|
||||||
|
return stale("surface visible region changed");
|
||||||
|
}
|
||||||
|
const point = mapImagePointToViewport(
|
||||||
|
capture.topViewportRect,
|
||||||
|
capture.imageWidth,
|
||||||
|
capture.imageHeight,
|
||||||
|
params.image_x as number,
|
||||||
|
params.image_y as number,
|
||||||
|
);
|
||||||
|
if (!point || !pointInRegion(point, geometry.topVisibleRegions)) {
|
||||||
|
return rpcError(
|
||||||
|
"invalid_params",
|
||||||
|
"surface_coordinate_invalid",
|
||||||
|
"image coordinate is outside the captured Surface",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const dialogCursor = markDialogCursor(deps.cdp, target.tabId);
|
||||||
|
let bypassEnabled = false;
|
||||||
|
let pressed = false;
|
||||||
|
const release = () =>
|
||||||
|
deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mouseReleased",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
if (deps.bypassOverlay) {
|
||||||
|
await deps.bypassOverlay(target.tabId, true);
|
||||||
|
bypassEnabled = true;
|
||||||
|
}
|
||||||
|
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mouseMoved",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
modifiers: 0,
|
||||||
|
});
|
||||||
|
const beforePressAbort = aborted(deps.signal);
|
||||||
|
if (beforePressAbort) return beforePressAbort;
|
||||||
|
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mousePressed",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
});
|
||||||
|
pressed = true;
|
||||||
|
const afterPressAbort = aborted(deps.signal);
|
||||||
|
if (afterPressAbort) {
|
||||||
|
await release();
|
||||||
|
pressed = false;
|
||||||
|
return afterPressAbort;
|
||||||
|
}
|
||||||
|
await release();
|
||||||
|
pressed = false;
|
||||||
|
} catch (error) {
|
||||||
|
if (pressed) {
|
||||||
|
try {
|
||||||
|
await release();
|
||||||
|
} catch (releaseError) {
|
||||||
|
console.debug("[bsk surface-point] best-effort mouse release failed", releaseError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { code: "cdp_failed", message: error instanceof Error ? error.message : String(error) };
|
||||||
|
} finally {
|
||||||
|
if (bypassEnabled && deps.bypassOverlay) {
|
||||||
|
try {
|
||||||
|
await deps.bypassOverlay(target.tabId, false);
|
||||||
|
} catch (error) {
|
||||||
|
console.debug("[bsk surface-point] overlay bypass disable failed", error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
||||||
|
tab_id: target.tabId,
|
||||||
|
used_ref: capture.surface.ref,
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
capture_id: capture.id,
|
||||||
|
image_x: params.image_x,
|
||||||
|
image_y: params.image_y,
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -34,6 +34,11 @@ export type RpcErrorReason =
|
|||||||
| "restricted_tab_url"
|
| "restricted_tab_url"
|
||||||
| "borrow_conflict"
|
| "borrow_conflict"
|
||||||
| "screenshot_capture_failed"
|
| "screenshot_capture_failed"
|
||||||
|
| "surface_capture_not_found"
|
||||||
|
| "surface_capture_expired"
|
||||||
|
| "surface_capture_consumed"
|
||||||
|
| "surface_capture_stale"
|
||||||
|
| "surface_coordinate_invalid"
|
||||||
| "cleanup_failed";
|
| "cleanup_failed";
|
||||||
|
|
||||||
export interface RpcErrorData {
|
export interface RpcErrorData {
|
||||||
@@ -299,9 +304,17 @@ export interface ScreenshotResult {
|
|||||||
height: number;
|
height: number;
|
||||||
format: string;
|
format: string;
|
||||||
tab_id: number;
|
tab_id: number;
|
||||||
|
capture?: SurfaceCaptureInfo;
|
||||||
dialogs?: JavaScriptDialogInfo[];
|
dialogs?: JavaScriptDialogInfo[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface SurfaceCaptureInfo {
|
||||||
|
id: string;
|
||||||
|
surface_ref: string;
|
||||||
|
coordinate_space: "capture-image-pixel";
|
||||||
|
expires_at: number;
|
||||||
|
}
|
||||||
|
|
||||||
export interface SnapshotParams {
|
export interface SnapshotParams {
|
||||||
session_id: string;
|
session_id: string;
|
||||||
tab_id?: number;
|
tab_id?: number;
|
||||||
@@ -415,6 +428,9 @@ export interface ClickParams {
|
|||||||
click_count?: number;
|
click_count?: number;
|
||||||
modifiers?: KeyModifier[];
|
modifiers?: KeyModifier[];
|
||||||
timeout_ms?: number;
|
timeout_ms?: number;
|
||||||
|
capture_id?: string;
|
||||||
|
image_x?: number;
|
||||||
|
image_y?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ClickResult {
|
export interface ClickResult {
|
||||||
@@ -423,6 +439,9 @@ export interface ClickResult {
|
|||||||
used_selector?: string;
|
used_selector?: string;
|
||||||
x: number;
|
x: number;
|
||||||
y: number;
|
y: number;
|
||||||
|
capture_id?: string;
|
||||||
|
image_x?: number;
|
||||||
|
image_y?: number;
|
||||||
dialogs?: JavaScriptDialogInfo[];
|
dialogs?: JavaScriptDialogInfo[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -80,7 +80,15 @@ Prefer `@eN` refs from the latest snapshot over raw CSS selectors. Use `--ref` /
|
|||||||
|
|
||||||
When VOM renders `[hover first: …]` on an element, the listed items are not currently clickable refs. Run `bsk hover <that-ref> --session <id>`, then immediately run `bsk snapshot` or `bsk observe` again and click the newly visible menu item ref. Do not click the trigger itself unless the user explicitly wants the trigger action.
|
When VOM renders `[hover first: …]` on an element, the listed items are not currently clickable refs. Run `bsk hover <that-ref> --session <id>`, then immediately run `bsk snapshot` or `bsk observe` again and click the newly visible menu item ref. Do not click the trigger itself unless the user explicitly wants the trigger action.
|
||||||
|
|
||||||
When `bsk observe` renders `@eN surface ... [visual-only; requires=image-understanding; ...]`, the ref identifies rendered canvas content that is not represented by the text observation, not an interactable DOM control. Keep using any reliable DOM/AX text and controls that appear alongside it. If you can actually inspect image output, use `bsk screenshot --ref @eN --session <id>` to obtain the visible crop. If you lack multimodal or image-reading capability, do not take a screenshot and pretend to know its contents, and never guess coordinates; tell the user that they need to switch to a model with image-understanding capability. Do not pass a visual surface ref to click, fill, hover, or select; those commands intentionally reject screenshot-only refs.
|
When `bsk observe` renders `@eN surface ... [visual-only; requires=image-understanding; ...]`, the ref identifies rendered canvas content that is not represented by the text observation, not an interactable DOM control. Keep using any reliable DOM/AX text and controls that appear alongside it. If you lack multimodal or image-reading capability, do not take a screenshot and pretend to know its contents, and never guess coordinates; tell the user that they need to switch to a model with image-understanding capability.
|
||||||
|
|
||||||
|
If you can actually inspect image output, use `bsk screenshot --ref @eN --session <id>` to obtain the visible crop and its short-lived, single-use Surface capture id. Only when the task requires a point action and the image provides a clear target, bind that exact screenshot to the same general click command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bsk click @eN --capture <capture-id> --image-x <px> --image-y <px> --session <id>
|
||||||
|
```
|
||||||
|
|
||||||
|
Coordinates are pixels in the returned capture image, not viewport CSS coordinates. Re-observing, navigating, scrolling, resizing, zooming, changing Frame projection, expiry, or reusing the capture makes the action fail; take a new Surface screenshot instead of adjusting or retrying coordinates. A point click does not reveal Canvas semantics and must not be followed by an assumed fill/press workflow. Without all three capture arguments, visual Surface refs remain screenshot-only and click/fill/hover/select reject them.
|
||||||
|
|
||||||
## Observation priority
|
## Observation priority
|
||||||
|
|
||||||
@@ -176,7 +184,7 @@ bsk emulate --session <id> --off
|
|||||||
| `bsk snapshot` | First-choice static page understanding: accessibility tree with `@eN` element refs |
|
| `bsk snapshot` | First-choice static page understanding: accessibility tree with `@eN` element refs |
|
||||||
| `bsk observe` | Semantic VOM observation with bounded perception probes for conditional surfaces |
|
| `bsk observe` | Semantic VOM observation with bounded perception probes for conditional surfaces |
|
||||||
| `bsk get-html` | Raw HTML dump after snapshot is insufficient (high token cost) |
|
| `bsk get-html` | Raw HTML dump after snapshot is insufficient (high token cost) |
|
||||||
| `bsk screenshot` | PNG capture after snapshot is insufficient: full visible tab, or `--ref @eN` to crop to one element (`--out` path optional) |
|
| `bsk screenshot` | PNG capture after snapshot is insufficient: full visible tab, or `--ref @eN` to crop to one element (`--out` path optional); Surface crops return a short-lived capture id |
|
||||||
|
|
||||||
### Console & network debugging (read-only; require `--session`)
|
### Console & network debugging (read-only; require `--session`)
|
||||||
|
|
||||||
@@ -202,7 +210,7 @@ Both capture from the moment the tab is attached and read a bounded per-tab buff
|
|||||||
|
|
||||||
| Command | Summary |
|
| Command | Summary |
|
||||||
|---------|---------|
|
|---------|---------|
|
||||||
| `bsk click <ref-or-selector>` | Click element (`--button`, `--click-count`, `--modifiers`) |
|
| `bsk click <ref-or-selector>` | Click a DOM element (`--button`, `--click-count`, `--modifiers`), or perform one screenshot-bound Surface point click with `--capture`, `--image-x`, and `--image-y` |
|
||||||
| `bsk hover <ref-or-selector>` | Move the mouse to an element and wait for hover UI to settle (`--settle`, `--modifiers`) |
|
| `bsk hover <ref-or-selector>` | Move the mouse to an element and wait for hover UI to settle (`--settle`, `--modifiers`) |
|
||||||
| `bsk fill <ref-or-selector> --value <text>` | Clear and type into input |
|
| `bsk fill <ref-or-selector> --value <text>` | Clear and type into input |
|
||||||
| `bsk select <ref-or-selector> --value <v>` | Set `<select>` option(s) by `value` (repeat `--value` for multi-select) |
|
| `bsk select <ref-or-selector> --value <v>` | Set `<select>` option(s) by `value` (repeat `--value` for multi-select) |
|
||||||
|
|||||||
@@ -136,6 +136,18 @@ pub struct ClickArgs {
|
|||||||
|
|
||||||
#[arg(long, default_value = "30s", value_parser = parse_timeout_ms)]
|
#[arg(long, default_value = "30s", value_parser = parse_timeout_ms)]
|
||||||
pub timeout: u32,
|
pub timeout: u32,
|
||||||
|
|
||||||
|
/// Capture id returned by `bsk screenshot --ref <surface>`.
|
||||||
|
#[arg(long)]
|
||||||
|
pub capture: Option<String>,
|
||||||
|
|
||||||
|
/// X coordinate in capture-image pixels. Requires `--capture` and `--image-y`.
|
||||||
|
#[arg(long = "image-x", allow_hyphen_values = true)]
|
||||||
|
pub image_x: Option<f64>,
|
||||||
|
|
||||||
|
/// Y coordinate in capture-image pixels. Requires `--capture` and `--image-x`.
|
||||||
|
#[arg(long = "image-y", allow_hyphen_values = true)]
|
||||||
|
pub image_y: Option<f64>,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn dispatch_click(args: ClickArgs, format: Format) -> Result<(), CliError> {
|
pub fn dispatch_click(args: ClickArgs, format: Format) -> Result<(), CliError> {
|
||||||
@@ -147,6 +159,14 @@ pub fn dispatch_click(args: ClickArgs, format: Format) -> Result<(), CliError> {
|
|||||||
)?;
|
)?;
|
||||||
let modifiers = parse_modifiers(&args.modifiers)
|
let modifiers = parse_modifiers(&args.modifiers)
|
||||||
.map_err(|e| CliError::Local(anyhow::anyhow!("--modifiers: {e}")))?;
|
.map_err(|e| CliError::Local(anyhow::anyhow!("--modifiers: {e}")))?;
|
||||||
|
let point_arg_count = usize::from(args.capture.is_some())
|
||||||
|
+ usize::from(args.image_x.is_some())
|
||||||
|
+ usize::from(args.image_y.is_some());
|
||||||
|
if point_arg_count != 0 && point_arg_count != 3 {
|
||||||
|
return Err(CliError::Local(anyhow::anyhow!(
|
||||||
|
"--capture, --image-x, and --image-y must be given together"
|
||||||
|
)));
|
||||||
|
}
|
||||||
let params = ClickParams {
|
let params = ClickParams {
|
||||||
session_id: args.session.clone(),
|
session_id: args.session.clone(),
|
||||||
ref_,
|
ref_,
|
||||||
@@ -160,6 +180,9 @@ pub fn dispatch_click(args: ClickArgs, format: Format) -> Result<(), CliError> {
|
|||||||
Some(modifiers)
|
Some(modifiers)
|
||||||
},
|
},
|
||||||
timeout_ms: Some(args.timeout),
|
timeout_ms: Some(args.timeout),
|
||||||
|
capture_id: args.capture.clone(),
|
||||||
|
image_x: args.image_x,
|
||||||
|
image_y: args.image_y,
|
||||||
};
|
};
|
||||||
let reply: ClickResult = call(
|
let reply: ClickResult = call(
|
||||||
info.sock_path,
|
info.sock_path,
|
||||||
@@ -183,6 +206,14 @@ pub fn dispatch_click(args: ClickArgs, format: Format) -> Result<(), CliError> {
|
|||||||
"click ok tab={} target={target} at=({}, {})",
|
"click ok tab={} target={target} at=({}, {})",
|
||||||
reply.tab_id, reply.x, reply.y
|
reply.tab_id, reply.x, reply.y
|
||||||
);
|
);
|
||||||
|
if let Some(capture_id) = &reply.capture_id {
|
||||||
|
println!(
|
||||||
|
"capture={} image=({}, {}) coordinate_space=capture-image-pixel",
|
||||||
|
capture_id,
|
||||||
|
reply.image_x.unwrap_or_default(),
|
||||||
|
reply.image_y.unwrap_or_default()
|
||||||
|
);
|
||||||
|
}
|
||||||
print_dialog_summaries(&reply.dialogs);
|
print_dialog_summaries(&reply.dialogs);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -50,6 +50,11 @@ pub mod reason {
|
|||||||
pub const TAB_NOT_ACTIVE: &str = "tab_not_active";
|
pub const TAB_NOT_ACTIVE: &str = "tab_not_active";
|
||||||
pub const BORROW_CONFLICT: &str = "borrow_conflict";
|
pub const BORROW_CONFLICT: &str = "borrow_conflict";
|
||||||
pub const SCREENSHOT_CAPTURE_FAILED: &str = "screenshot_capture_failed";
|
pub const SCREENSHOT_CAPTURE_FAILED: &str = "screenshot_capture_failed";
|
||||||
|
pub const SURFACE_CAPTURE_NOT_FOUND: &str = "surface_capture_not_found";
|
||||||
|
pub const SURFACE_CAPTURE_EXPIRED: &str = "surface_capture_expired";
|
||||||
|
pub const SURFACE_CAPTURE_CONSUMED: &str = "surface_capture_consumed";
|
||||||
|
pub const SURFACE_CAPTURE_STALE: &str = "surface_capture_stale";
|
||||||
|
pub const SURFACE_COORDINATE_INVALID: &str = "surface_coordinate_invalid";
|
||||||
pub const SESSION_BUSY: &str = crate::rpc_reason::SESSION_BUSY;
|
pub const SESSION_BUSY: &str = crate::rpc_reason::SESSION_BUSY;
|
||||||
pub const RECORD_START_PAGE_UNREACHABLE: &str = "record_start_page_unreachable";
|
pub const RECORD_START_PAGE_UNREACHABLE: &str = "record_start_page_unreachable";
|
||||||
}
|
}
|
||||||
@@ -232,7 +237,7 @@ pub fn info_for_error(code: ErrorCode, data: Option<&serde_json::Value>) -> Rend
|
|||||||
(ErrorCode::PermissionDenied, reason::REF_CAPABILITY_DENIED) => RenderInfo {
|
(ErrorCode::PermissionDenied, reason::REF_CAPABILITY_DENIED) => RenderInfo {
|
||||||
summary: "snapshot ref does not support this operation",
|
summary: "snapshot ref does not support this operation",
|
||||||
hint: Some(
|
hint: Some(
|
||||||
"visual surface refs are screenshot-only; inspect `bsk screenshot --ref <ref> --session <id>` with image-understanding capability",
|
"visual Surface refs require image understanding; inspect `bsk screenshot --ref <ref> --session <id>`, then bind its capture id and image coordinates to `bsk click`",
|
||||||
),
|
),
|
||||||
exit_code: base.exit_code,
|
exit_code: base.exit_code,
|
||||||
},
|
},
|
||||||
@@ -278,6 +283,41 @@ pub fn info_for_error(code: ErrorCode, data: Option<&serde_json::Value>) -> Rend
|
|||||||
),
|
),
|
||||||
exit_code: base.exit_code,
|
exit_code: base.exit_code,
|
||||||
},
|
},
|
||||||
|
(ErrorCode::NotFound, reason::SURFACE_CAPTURE_NOT_FOUND) => RenderInfo {
|
||||||
|
summary: "surface capture transaction was not found",
|
||||||
|
hint: Some(
|
||||||
|
"take a fresh surface screenshot and use its capture id with coordinates from that image",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::PermissionDenied, reason::SURFACE_CAPTURE_EXPIRED) => RenderInfo {
|
||||||
|
summary: "surface capture transaction has expired",
|
||||||
|
hint: Some(
|
||||||
|
"take a fresh surface screenshot, then click promptly with that capture id and image coordinates",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::PermissionDenied, reason::SURFACE_CAPTURE_CONSUMED) => RenderInfo {
|
||||||
|
summary: "surface capture transaction was already used",
|
||||||
|
hint: Some(
|
||||||
|
"each capture id is single-use; take a fresh surface screenshot before another point action",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::PermissionDenied, reason::SURFACE_CAPTURE_STALE) => RenderInfo {
|
||||||
|
summary: "page state changed since the surface screenshot",
|
||||||
|
hint: Some(
|
||||||
|
"take a fresh surface screenshot and choose coordinates from the new image before retrying",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::InvalidParams, reason::SURFACE_COORDINATE_INVALID) => RenderInfo {
|
||||||
|
summary: "surface image coordinate is invalid",
|
||||||
|
hint: Some(
|
||||||
|
"use finite pixel coordinates inside the captured image; its top-left corner is (0, 0)",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
(
|
(
|
||||||
ErrorCode::CdpFailed | ErrorCode::Timeout | ErrorCode::InvalidParams,
|
ErrorCode::CdpFailed | ErrorCode::Timeout | ErrorCode::InvalidParams,
|
||||||
reason::RECORD_START_PAGE_UNREACHABLE,
|
reason::RECORD_START_PAGE_UNREACHABLE,
|
||||||
@@ -391,7 +431,7 @@ mod tests {
|
|||||||
let info = info_for_error(ErrorCode::PermissionDenied, Some(&data));
|
let info = info_for_error(ErrorCode::PermissionDenied, Some(&data));
|
||||||
assert_eq!(info.summary, "snapshot ref does not support this operation");
|
assert_eq!(info.summary, "snapshot ref does not support this operation");
|
||||||
assert!(
|
assert!(
|
||||||
info.hint.unwrap().contains("screenshot-only"),
|
info.hint.unwrap().contains("capture id"),
|
||||||
"expected visual-surface-specific hint"
|
"expected visual-surface-specific hint"
|
||||||
);
|
);
|
||||||
assert_eq!(info.exit_code, 1);
|
assert_eq!(info.exit_code, 1);
|
||||||
@@ -439,6 +479,25 @@ mod tests {
|
|||||||
assert_eq!(info.exit_code, 3);
|
assert_eq!(info.exit_code, 3);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn surface_capture_stale_requests_a_fresh_screenshot() {
|
||||||
|
let data = serde_json::json!({ "reason": reason::SURFACE_CAPTURE_STALE });
|
||||||
|
let info = info_for_error(ErrorCode::PermissionDenied, Some(&data));
|
||||||
|
assert_eq!(
|
||||||
|
info.summary,
|
||||||
|
"page state changed since the surface screenshot"
|
||||||
|
);
|
||||||
|
assert!(info.hint.unwrap().contains("fresh surface screenshot"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn surface_coordinate_invalid_explains_image_pixel_bounds() {
|
||||||
|
let data = serde_json::json!({ "reason": reason::SURFACE_COORDINATE_INVALID });
|
||||||
|
let info = info_for_error(ErrorCode::InvalidParams, Some(&data));
|
||||||
|
assert_eq!(info.summary, "surface image coordinate is invalid");
|
||||||
|
assert!(info.hint.unwrap().contains("top-left corner is (0, 0)"));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn ref_not_found_overrides_not_found_copy() {
|
fn ref_not_found_overrides_not_found_copy() {
|
||||||
let data = serde_json::json!({ "reason": reason::REF_NOT_FOUND });
|
let data = serde_json::json!({ "reason": reason::REF_NOT_FOUND });
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ fn run(sock: PathBuf, args: ScreenshotArgs, format: Format) -> Result<(), CliErr
|
|||||||
.map_err(CliError::Local)?;
|
.map_err(CliError::Local)?;
|
||||||
match format {
|
match format {
|
||||||
Format::Json => {
|
Format::Json => {
|
||||||
let json = serde_json::json!({
|
let mut json = serde_json::json!({
|
||||||
"tab_id": reply.tab_id,
|
"tab_id": reply.tab_id,
|
||||||
"width": reply.width,
|
"width": reply.width,
|
||||||
"height": reply.height,
|
"height": reply.height,
|
||||||
@@ -67,6 +67,10 @@ fn run(sock: PathBuf, args: ScreenshotArgs, format: Format) -> Result<(), CliErr
|
|||||||
"path": out_path.to_string_lossy(),
|
"path": out_path.to_string_lossy(),
|
||||||
"byte_size": bytes.len(),
|
"byte_size": bytes.len(),
|
||||||
});
|
});
|
||||||
|
if let Some(capture) = &reply.capture {
|
||||||
|
json["capture"] = serde_json::to_value(capture)
|
||||||
|
.map_err(|e| CliError::Local(anyhow::anyhow!(e)))?;
|
||||||
|
}
|
||||||
println!(
|
println!(
|
||||||
"{}",
|
"{}",
|
||||||
serde_json::to_string_pretty(&json)
|
serde_json::to_string_pretty(&json)
|
||||||
@@ -75,6 +79,12 @@ fn run(sock: PathBuf, args: ScreenshotArgs, format: Format) -> Result<(), CliErr
|
|||||||
}
|
}
|
||||||
Format::Human => {
|
Format::Human => {
|
||||||
println!("{}", out_path.display());
|
println!("{}", out_path.display());
|
||||||
|
if let Some(capture) = &reply.capture {
|
||||||
|
println!(
|
||||||
|
"capture={} surface={} coordinate_space={} expires_at={}",
|
||||||
|
capture.id, capture.surface_ref, capture.coordinate_space, capture.expires_at
|
||||||
|
);
|
||||||
|
}
|
||||||
print_dialog_summaries(&reply.dialogs);
|
print_dialog_summaries(&reply.dialogs);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -188,6 +188,29 @@ fn parses_click_count_alias() {
|
|||||||
assert_eq!(args.click_count, 2);
|
assert_eq!(args.click_count, 2);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_surface_capture_image_coordinates() {
|
||||||
|
let cli = parse(&[
|
||||||
|
"bsk",
|
||||||
|
"click",
|
||||||
|
"@e1",
|
||||||
|
"--session",
|
||||||
|
"s1",
|
||||||
|
"--capture",
|
||||||
|
"sc_test",
|
||||||
|
"--image-x",
|
||||||
|
"160.5",
|
||||||
|
"--image-y",
|
||||||
|
"-1",
|
||||||
|
]);
|
||||||
|
let Command::Click(args) = cli.command else {
|
||||||
|
panic!("expected click command");
|
||||||
|
};
|
||||||
|
assert_eq!(args.capture.as_deref(), Some("sc_test"));
|
||||||
|
assert_eq!(args.image_x, Some(160.5));
|
||||||
|
assert_eq!(args.image_y, Some(-1.0));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parses_hover_with_settle() {
|
fn parses_hover_with_settle() {
|
||||||
let cli = parse(&[
|
let cli = parse(&[
|
||||||
|
|||||||
@@ -238,6 +238,7 @@ async fn screenshot_returns_image_base64_with_dimensions() {
|
|||||||
height: 600,
|
height: 600,
|
||||||
format: "png".into(),
|
format: "png".into(),
|
||||||
tab_id: 7,
|
tab_id: 7,
|
||||||
|
capture: None,
|
||||||
dialogs: vec![],
|
dialogs: vec![],
|
||||||
})
|
})
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
@@ -286,6 +287,7 @@ async fn screenshot_forwards_ref_to_extension() {
|
|||||||
height: 60,
|
height: 60,
|
||||||
format: "png".into(),
|
format: "png".into(),
|
||||||
tab_id: 7,
|
tab_id: 7,
|
||||||
|
capture: None,
|
||||||
dialogs: vec![],
|
dialogs: vec![],
|
||||||
})
|
})
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
|
|||||||
@@ -354,6 +354,9 @@ async fn click_round_trips_ref_and_modifiers() {
|
|||||||
used_selector: None,
|
used_selector: None,
|
||||||
x: 12.5,
|
x: 12.5,
|
||||||
y: 34.0,
|
y: 34.0,
|
||||||
|
capture_id: None,
|
||||||
|
image_x: None,
|
||||||
|
image_y: None,
|
||||||
dialogs: vec![],
|
dialogs: vec![],
|
||||||
})
|
})
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
@@ -373,6 +376,9 @@ async fn click_round_trips_ref_and_modifiers() {
|
|||||||
click_count: Some(1),
|
click_count: Some(1),
|
||||||
modifiers: Some(vec![KeyModifier::Ctrl, KeyModifier::Shift]),
|
modifiers: Some(vec![KeyModifier::Ctrl, KeyModifier::Shift]),
|
||||||
timeout_ms: Some(5_000),
|
timeout_ms: Some(5_000),
|
||||||
|
capture_id: None,
|
||||||
|
image_x: None,
|
||||||
|
image_y: None,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
@@ -610,6 +616,9 @@ async fn m7_tools_propagate_extension_errors() {
|
|||||||
click_count: None,
|
click_count: None,
|
||||||
modifiers: None,
|
modifiers: None,
|
||||||
timeout_ms: Some(5_000),
|
timeout_ms: Some(5_000),
|
||||||
|
capture_id: None,
|
||||||
|
image_x: None,
|
||||||
|
image_y: None,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -16,6 +16,13 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"capture_id": {
|
||||||
|
"description": "Short-lived capture id returned by a visual Surface screenshot.",
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
"click_count": {
|
"click_count": {
|
||||||
"description": "Number of consecutive mouse presses (double-click = 2).",
|
"description": "Number of consecutive mouse presses (double-click = 2).",
|
||||||
"type": [
|
"type": [
|
||||||
@@ -25,6 +32,22 @@
|
|||||||
"format": "uint32",
|
"format": "uint32",
|
||||||
"minimum": 1.0
|
"minimum": 1.0
|
||||||
},
|
},
|
||||||
|
"image_x": {
|
||||||
|
"description": "X coordinate in the capture image's pixel coordinate space.",
|
||||||
|
"type": [
|
||||||
|
"number",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"format": "double"
|
||||||
|
},
|
||||||
|
"image_y": {
|
||||||
|
"description": "Y coordinate in the capture image's pixel coordinate space.",
|
||||||
|
"type": [
|
||||||
|
"number",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"format": "double"
|
||||||
|
},
|
||||||
"modifiers": {
|
"modifiers": {
|
||||||
"type": [
|
"type": [
|
||||||
"array",
|
"array",
|
||||||
|
|||||||
@@ -8,6 +8,12 @@
|
|||||||
"y"
|
"y"
|
||||||
],
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"capture_id": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
"dialogs": {
|
"dialogs": {
|
||||||
"description": "Native JS dialogs observed and auto-handled during this call.",
|
"description": "Native JS dialogs observed and auto-handled during this call.",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@@ -15,6 +21,20 @@
|
|||||||
"$ref": "#/definitions/JavaScriptDialogInfo"
|
"$ref": "#/definitions/JavaScriptDialogInfo"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"image_x": {
|
||||||
|
"type": [
|
||||||
|
"number",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"format": "double"
|
||||||
|
},
|
||||||
|
"image_y": {
|
||||||
|
"type": [
|
||||||
|
"number",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"format": "double"
|
||||||
|
},
|
||||||
"tab_id": {
|
"tab_id": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int64"
|
"format": "int64"
|
||||||
|
|||||||
@@ -8,6 +8,16 @@
|
|||||||
"tab_id"
|
"tab_id"
|
||||||
],
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"capture": {
|
||||||
|
"anyOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/SurfaceCaptureInfo"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"dialogs": {
|
"dialogs": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@@ -109,6 +119,31 @@
|
|||||||
"prompt",
|
"prompt",
|
||||||
"beforeunload"
|
"beforeunload"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"SurfaceCaptureInfo": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"coordinate_space",
|
||||||
|
"expires_at",
|
||||||
|
"id",
|
||||||
|
"surface_ref"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"coordinate_space": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"expires_at": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "uint64",
|
||||||
|
"minimum": 0.0
|
||||||
|
},
|
||||||
|
"id": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"surface_ref": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -67,6 +67,15 @@ pub struct ClickParams {
|
|||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
#[schemars(range(min = 1))]
|
#[schemars(range(min = 1))]
|
||||||
pub timeout_ms: Option<u32>,
|
pub timeout_ms: Option<u32>,
|
||||||
|
/// Short-lived capture id returned by a visual Surface screenshot.
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub capture_id: Option<String>,
|
||||||
|
/// X coordinate in the capture image's pixel coordinate space.
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub image_x: Option<f64>,
|
||||||
|
/// Y coordinate in the capture image's pixel coordinate space.
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub image_y: Option<f64>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
|
||||||
@@ -80,6 +89,12 @@ pub struct ClickResult {
|
|||||||
/// agents can correlate with a follow-up `tool.screenshot`.
|
/// agents can correlate with a follow-up `tool.screenshot`.
|
||||||
pub x: f64,
|
pub x: f64,
|
||||||
pub y: f64,
|
pub y: f64,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub capture_id: Option<String>,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub image_x: Option<f64>,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub image_y: Option<f64>,
|
||||||
/// Native JS dialogs observed and auto-handled during this call.
|
/// Native JS dialogs observed and auto-handled during this call.
|
||||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||||
pub dialogs: Vec<JavaScriptDialogInfo>,
|
pub dialogs: Vec<JavaScriptDialogInfo>,
|
||||||
@@ -288,6 +303,9 @@ mod tests {
|
|||||||
click_count: Some(1),
|
click_count: Some(1),
|
||||||
modifiers: Some(vec![KeyModifier::Ctrl]),
|
modifiers: Some(vec![KeyModifier::Ctrl]),
|
||||||
timeout_ms: Some(5_000),
|
timeout_ms: Some(5_000),
|
||||||
|
capture_id: Some("sc_test".into()),
|
||||||
|
image_x: Some(160.0),
|
||||||
|
image_y: Some(90.0),
|
||||||
};
|
};
|
||||||
let v = serde_json::to_value(&p).unwrap();
|
let v = serde_json::to_value(&p).unwrap();
|
||||||
assert_eq!(v.get("ref").and_then(|v| v.as_str()), Some("@e3"));
|
assert_eq!(v.get("ref").and_then(|v| v.as_str()), Some("@e3"));
|
||||||
|
|||||||
@@ -208,10 +208,20 @@ pub struct ScreenshotResult {
|
|||||||
/// Always `"png"` in v0.1; reserved for future JPEG / WebP support.
|
/// Always `"png"` in v0.1; reserved for future JPEG / WebP support.
|
||||||
pub format: String,
|
pub format: String,
|
||||||
pub tab_id: i64,
|
pub tab_id: i64,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub capture: Option<SurfaceCaptureInfo>,
|
||||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||||
pub dialogs: Vec<JavaScriptDialogInfo>,
|
pub dialogs: Vec<JavaScriptDialogInfo>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
|
||||||
|
pub struct SurfaceCaptureInfo {
|
||||||
|
pub id: String,
|
||||||
|
pub surface_ref: String,
|
||||||
|
pub coordinate_space: String,
|
||||||
|
pub expires_at: u64,
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@@ -293,6 +303,12 @@ mod tests {
|
|||||||
height: 600,
|
height: 600,
|
||||||
format: "png".into(),
|
format: "png".into(),
|
||||||
tab_id: 7,
|
tab_id: 7,
|
||||||
|
capture: Some(SurfaceCaptureInfo {
|
||||||
|
id: "sc_test".into(),
|
||||||
|
surface_ref: "@e3".into(),
|
||||||
|
coordinate_space: "capture-image-pixel".into(),
|
||||||
|
expires_at: 1_700_000_030_000,
|
||||||
|
}),
|
||||||
dialogs: vec![],
|
dialogs: vec![],
|
||||||
};
|
};
|
||||||
let v = serde_json::to_value(&r).unwrap();
|
let v = serde_json::to_value(&r).unwrap();
|
||||||
|
|||||||
@@ -563,7 +563,8 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
name: "interact.click",
|
name: "interact.click",
|
||||||
description:
|
description:
|
||||||
"Click an element in the session's active tab. Target is a snapshot ref (@e3) from the " +
|
"Click an element in the session's active tab. Target is a snapshot ref (@e3) from the " +
|
||||||
"last browser_inspect observation, or a CSS selector.",
|
"last browser_inspect observation, or a CSS selector. A visual Surface requires the " +
|
||||||
|
"captureId and image coordinates returned by browser_inspect action=screenshot.",
|
||||||
parameters: {
|
parameters: {
|
||||||
target: {
|
target: {
|
||||||
type: "string",
|
type: "string",
|
||||||
@@ -580,6 +581,18 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
type: "integer",
|
type: "integer",
|
||||||
description: "Number of consecutive presses (double-click = 2).",
|
description: "Number of consecutive presses (double-click = 2).",
|
||||||
},
|
},
|
||||||
|
captureId: {
|
||||||
|
type: "string",
|
||||||
|
description: "Short-lived Surface capture id returned by browser_screenshot.",
|
||||||
|
},
|
||||||
|
imageX: {
|
||||||
|
type: "number",
|
||||||
|
description: "X coordinate in capture-image pixels; requires captureId and imageY.",
|
||||||
|
},
|
||||||
|
imageY: {
|
||||||
|
type: "number",
|
||||||
|
description: "Y coordinate in capture-image pixels; requires captureId and imageX.",
|
||||||
|
},
|
||||||
},
|
},
|
||||||
output: {
|
output: {
|
||||||
schema: {
|
schema: {
|
||||||
@@ -590,6 +603,7 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
tabId: { type: "integer", required: true },
|
tabId: { type: "integer", required: true },
|
||||||
x: { type: "number", required: true },
|
x: { type: "number", required: true },
|
||||||
y: { type: "number", required: true },
|
y: { type: "number", required: true },
|
||||||
|
captureId: { type: "string" },
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
render: (_args, value) => [
|
render: (_args, value) => [
|
||||||
@@ -601,17 +615,41 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
},
|
},
|
||||||
async execute(args, exec) {
|
async execute(args, exec) {
|
||||||
if (args.target.trim().length === 0) throw new Error("target must be a non-empty string");
|
if (args.target.trim().length === 0) throw new Error("target must be a non-empty string");
|
||||||
|
const pointArgCount =
|
||||||
|
Number(args.captureId !== undefined) +
|
||||||
|
Number(args.imageX !== undefined) +
|
||||||
|
Number(args.imageY !== undefined);
|
||||||
|
if (pointArgCount !== 0 && pointArgCount !== 3) {
|
||||||
|
throw new Error("captureId, imageX, and imageY must be given together");
|
||||||
|
}
|
||||||
const sessionId = registry.resolve(args.session, "browser_interact(action=click)");
|
const sessionId = registry.resolve(args.session, "browser_interact(action=click)");
|
||||||
const cmdArgs = ["click", "--session", sessionId];
|
const cmdArgs = ["click", "--session", sessionId];
|
||||||
if (args.button !== undefined) cmdArgs.push("--button", args.button);
|
if (args.button !== undefined) cmdArgs.push("--button", args.button);
|
||||||
if (args.clickCount !== undefined) cmdArgs.push("--click-count", String(args.clickCount));
|
if (args.clickCount !== undefined) cmdArgs.push("--click-count", String(args.clickCount));
|
||||||
|
if (args.captureId !== undefined) {
|
||||||
|
cmdArgs.push(
|
||||||
|
"--capture",
|
||||||
|
args.captureId,
|
||||||
|
"--image-x",
|
||||||
|
String(args.imageX),
|
||||||
|
"--image-y",
|
||||||
|
String(args.imageY),
|
||||||
|
);
|
||||||
|
}
|
||||||
cmdArgs.push(args.target);
|
cmdArgs.push(args.target);
|
||||||
const reply = (await runBsk(deps, exec, cmdArgs, "click", sessionId)) as {
|
const reply = (await runBsk(deps, exec, cmdArgs, "click", sessionId)) as {
|
||||||
tab_id: number;
|
tab_id: number;
|
||||||
x: number;
|
x: number;
|
||||||
y: number;
|
y: number;
|
||||||
|
capture_id?: string;
|
||||||
|
};
|
||||||
|
return {
|
||||||
|
session: sessionId,
|
||||||
|
tabId: reply.tab_id,
|
||||||
|
x: reply.x,
|
||||||
|
y: reply.y,
|
||||||
|
...(reply.capture_id !== undefined ? { captureId: reply.capture_id } : {}),
|
||||||
};
|
};
|
||||||
return { session: sessionId, tabId: reply.tab_id, x: reply.x, y: reply.y };
|
|
||||||
},
|
},
|
||||||
presentCall: (args) => ({
|
presentCall: (args) => ({
|
||||||
card: "terminal",
|
card: "terminal",
|
||||||
@@ -778,6 +816,8 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
width: { type: "integer", required: true },
|
width: { type: "integer", required: true },
|
||||||
height: { type: "integer", required: true },
|
height: { type: "integer", required: true },
|
||||||
byteSize: { type: "integer", required: true },
|
byteSize: { type: "integer", required: true },
|
||||||
|
captureId: { type: "string" },
|
||||||
|
captureExpiresAt: { type: "integer" },
|
||||||
image: {
|
image: {
|
||||||
type: "object",
|
type: "object",
|
||||||
additionalProperties: false,
|
additionalProperties: false,
|
||||||
@@ -801,7 +841,11 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
value.image !== undefined
|
value.image !== undefined
|
||||||
? `[session ${value.session}] screenshot of tab ${value.tabId} (${value.width}x${value.height}px)`
|
? `[session ${value.session}] screenshot of tab ${value.tabId} (${value.width}x${value.height}px)`
|
||||||
: `[session ${value.session}] screenshot saved to ${value.path} (${value.width}x${value.height}px, ${value.byteSize} bytes) — this deployment cannot inline images; read the file to view it`;
|
: `[session ${value.session}] screenshot saved to ${value.path} (${value.width}x${value.height}px, ${value.byteSize} bytes) — this deployment cannot inline images; read the file to view it`;
|
||||||
const blocks: ContentBlock[] = [{ type: "text", text }];
|
const captureText =
|
||||||
|
value.captureId !== undefined
|
||||||
|
? ` Surface capture ${value.captureId} uses capture-image-pixel coordinates and expires at ${value.captureExpiresAt}.`
|
||||||
|
: "";
|
||||||
|
const blocks: ContentBlock[] = [{ type: "text", text: text + captureText }];
|
||||||
if (value.image !== undefined) {
|
if (value.image !== undefined) {
|
||||||
blocks.push({
|
blocks.push({
|
||||||
type: "image",
|
type: "image",
|
||||||
@@ -840,6 +884,7 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
height: number;
|
height: number;
|
||||||
path: string;
|
path: string;
|
||||||
byte_size: number;
|
byte_size: number;
|
||||||
|
capture?: { id: string; expires_at: number };
|
||||||
};
|
};
|
||||||
writtenPath = reply.path;
|
writtenPath = reply.path;
|
||||||
const data = await readFile(reply.path);
|
const data = await readFile(reply.path);
|
||||||
@@ -853,6 +898,9 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
width: reply.width,
|
width: reply.width,
|
||||||
height: reply.height,
|
height: reply.height,
|
||||||
byteSize: reply.byte_size,
|
byteSize: reply.byte_size,
|
||||||
|
...(reply.capture !== undefined
|
||||||
|
? { captureId: reply.capture.id, captureExpiresAt: reply.capture.expires_at }
|
||||||
|
: {}),
|
||||||
...(ref !== undefined
|
...(ref !== undefined
|
||||||
? {
|
? {
|
||||||
image: {
|
image: {
|
||||||
|
|||||||
@@ -499,6 +499,41 @@ describe("interaction tools", () => {
|
|||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("interact.click forwards a complete Surface capture coordinate transaction", async () => {
|
||||||
|
const { tools, calls } = setup({
|
||||||
|
...responses,
|
||||||
|
click: {
|
||||||
|
tab_id: 7,
|
||||||
|
used_ref: "e1",
|
||||||
|
x: 110,
|
||||||
|
y: 70,
|
||||||
|
capture_id: "sc_test",
|
||||||
|
image_x: 200,
|
||||||
|
image_y: 100,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await startSession(tools);
|
||||||
|
const click = tools.get("interact.click");
|
||||||
|
const value = await click?.execute(
|
||||||
|
{ target: "@e1", captureId: "sc_test", imageX: 200, imageY: 100 },
|
||||||
|
makeExec(),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(value).toMatchObject({ captureId: "sc_test", x: 110, y: 70 });
|
||||||
|
expect(calls[1].args).toEqual([
|
||||||
|
"click",
|
||||||
|
"--session",
|
||||||
|
"s1",
|
||||||
|
"--capture",
|
||||||
|
"sc_test",
|
||||||
|
"--image-x",
|
||||||
|
"200",
|
||||||
|
"--image-y",
|
||||||
|
"100",
|
||||||
|
"@e1",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
it("interact.fill passes value and --no-clear", async () => {
|
it("interact.fill passes value and --no-clear", async () => {
|
||||||
const { tools, calls } = setup(responses);
|
const { tools, calls } = setup(responses);
|
||||||
await startSession(tools);
|
await startSession(tools);
|
||||||
@@ -923,6 +958,32 @@ describe("inspect.screenshot", () => {
|
|||||||
expect(rendered?.every((block) => block.type === "text")).toBe(true);
|
expect(rendered?.every((block) => block.type === "text")).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("returns Surface capture metadata alongside the screenshot", async () => {
|
||||||
|
const path = pngFile();
|
||||||
|
const { tools } = setup({
|
||||||
|
"session start": START_REPLY("s1"),
|
||||||
|
screenshot: {
|
||||||
|
tab_id: 7,
|
||||||
|
width: 800,
|
||||||
|
height: 600,
|
||||||
|
format: "png",
|
||||||
|
path,
|
||||||
|
byte_size: 8,
|
||||||
|
capture: { id: "sc_test", expires_at: 1700000030000 },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await startSession(tools);
|
||||||
|
const screenshot = tools.get("browser_screenshot");
|
||||||
|
const value = await screenshot?.execute({ ref: "@e1" }, makeExec());
|
||||||
|
|
||||||
|
expect(value).toMatchObject({
|
||||||
|
captureId: "sc_test",
|
||||||
|
captureExpiresAt: 1700000030000,
|
||||||
|
});
|
||||||
|
const rendered = screenshot?.output.render({ session: "s1" }, value as never);
|
||||||
|
expect(rendered?.[0]).toMatchObject({ type: "text", text: expect.stringContaining("sc_test") });
|
||||||
|
});
|
||||||
|
|
||||||
it("commits the image through the attachment store on an image-capable route", async () => {
|
it("commits the image through the attachment store on an image-capable route", async () => {
|
||||||
const path = pngFile();
|
const path = pngFile();
|
||||||
const services = {
|
const services = {
|
||||||
|
|||||||
+11
-3
@@ -80,7 +80,15 @@ Prefer `@eN` refs from the latest snapshot over raw CSS selectors. Use `--ref` /
|
|||||||
|
|
||||||
When VOM renders `[hover first: …]` on an element, the listed items are not currently clickable refs. Run `bsk hover <that-ref> --session <id>`, then immediately run `bsk snapshot` or `bsk observe` again and click the newly visible menu item ref. Do not click the trigger itself unless the user explicitly wants the trigger action.
|
When VOM renders `[hover first: …]` on an element, the listed items are not currently clickable refs. Run `bsk hover <that-ref> --session <id>`, then immediately run `bsk snapshot` or `bsk observe` again and click the newly visible menu item ref. Do not click the trigger itself unless the user explicitly wants the trigger action.
|
||||||
|
|
||||||
When `bsk observe` renders `@eN surface ... [visual-only; requires=image-understanding; ...]`, the ref identifies rendered canvas content that is not represented by the text observation, not an interactable DOM control. Keep using any reliable DOM/AX text and controls that appear alongside it. If you can actually inspect image output, use `bsk screenshot --ref @eN --session <id>` to obtain the visible crop. If you lack multimodal or image-reading capability, do not take a screenshot and pretend to know its contents, and never guess coordinates; tell the user that they need to switch to a model with image-understanding capability. Do not pass a visual surface ref to click, fill, hover, or select; those commands intentionally reject screenshot-only refs.
|
When `bsk observe` renders `@eN surface ... [visual-only; requires=image-understanding; ...]`, the ref identifies rendered canvas content that is not represented by the text observation, not an interactable DOM control. Keep using any reliable DOM/AX text and controls that appear alongside it. If you lack multimodal or image-reading capability, do not take a screenshot and pretend to know its contents, and never guess coordinates; tell the user that they need to switch to a model with image-understanding capability.
|
||||||
|
|
||||||
|
If you can actually inspect image output, use `bsk screenshot --ref @eN --session <id>` to obtain the visible crop and its short-lived, single-use Surface capture id. Only when the task requires a point action and the image provides a clear target, bind that exact screenshot to the same general click command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bsk click @eN --capture <capture-id> --image-x <px> --image-y <px> --session <id>
|
||||||
|
```
|
||||||
|
|
||||||
|
Coordinates are pixels in the returned capture image, not viewport CSS coordinates. Re-observing, navigating, scrolling, resizing, zooming, changing Frame projection, expiry, or reusing the capture makes the action fail; take a new Surface screenshot instead of adjusting or retrying coordinates. A point click does not reveal Canvas semantics and must not be followed by an assumed fill/press workflow. Without all three capture arguments, visual Surface refs remain screenshot-only and click/fill/hover/select reject them.
|
||||||
|
|
||||||
## Observation priority
|
## Observation priority
|
||||||
|
|
||||||
@@ -176,7 +184,7 @@ bsk emulate --session <id> --off
|
|||||||
| `bsk snapshot` | First-choice static page understanding: accessibility tree with `@eN` element refs |
|
| `bsk snapshot` | First-choice static page understanding: accessibility tree with `@eN` element refs |
|
||||||
| `bsk observe` | Semantic VOM observation with bounded perception probes for conditional surfaces |
|
| `bsk observe` | Semantic VOM observation with bounded perception probes for conditional surfaces |
|
||||||
| `bsk get-html` | Raw HTML dump after snapshot is insufficient (high token cost) |
|
| `bsk get-html` | Raw HTML dump after snapshot is insufficient (high token cost) |
|
||||||
| `bsk screenshot` | PNG capture after snapshot is insufficient: full visible tab, or `--ref @eN` to crop to one element (`--out` path optional) |
|
| `bsk screenshot` | PNG capture after snapshot is insufficient: full visible tab, or `--ref @eN` to crop to one element (`--out` path optional); Surface crops return a short-lived capture id |
|
||||||
|
|
||||||
### Console & network debugging (read-only; require `--session`)
|
### Console & network debugging (read-only; require `--session`)
|
||||||
|
|
||||||
@@ -202,7 +210,7 @@ Both capture from the moment the tab is attached and read a bounded per-tab buff
|
|||||||
|
|
||||||
| Command | Summary |
|
| Command | Summary |
|
||||||
|---------|---------|
|
|---------|---------|
|
||||||
| `bsk click <ref-or-selector>` | Click element (`--button`, `--click-count`, `--modifiers`) |
|
| `bsk click <ref-or-selector>` | Click a DOM element (`--button`, `--click-count`, `--modifiers`), or perform one screenshot-bound Surface point click with `--capture`, `--image-x`, and `--image-y` |
|
||||||
| `bsk hover <ref-or-selector>` | Move the mouse to an element and wait for hover UI to settle (`--settle`, `--modifiers`) |
|
| `bsk hover <ref-or-selector>` | Move the mouse to an element and wait for hover UI to settle (`--settle`, `--modifiers`) |
|
||||||
| `bsk fill <ref-or-selector> --value <text>` | Clear and type into input |
|
| `bsk fill <ref-or-selector> --value <text>` | Clear and type into input |
|
||||||
| `bsk select <ref-or-selector> --value <v>` | Set `<select>` option(s) by `value` (repeat `--value` for multi-select) |
|
| `bsk select <ref-or-selector> --value <v>` | Set `<select>` option(s) by `value` (repeat `--value` for multi-select) |
|
||||||
|
|||||||
Reference in New Issue
Block a user