mirror of
https://github.com/Tencent/BrowserSkill.git
synced 2026-09-10 13:01:23 +08:00
Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
86415440e3 | ||
|
|
8e428f4660 | ||
|
|
000b374d0c | ||
|
|
aeece8d7e4 | ||
|
|
905ba6a8a6 | ||
|
|
672b17cea8 | ||
|
|
320c610c76 | ||
|
|
ff1216526d |
@@ -38,7 +38,7 @@ jobs:
|
|||||||
run: cargo test --workspace --locked
|
run: cargo test --workspace --locked
|
||||||
|
|
||||||
windows-daemon:
|
windows-daemon:
|
||||||
name: Windows daemon, installer and cancellation regression tests
|
name: Windows daemon and update regression tests
|
||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
@@ -55,16 +55,8 @@ jobs:
|
|||||||
- name: Run Windows update tests
|
- name: Run Windows update tests
|
||||||
run: cargo test -p bsk --lib --locked cli::update::tests
|
run: cargo test -p bsk --lib --locked cli::update::tests
|
||||||
|
|
||||||
- name: Run Windows update and cancellation process tests
|
- name: Run Windows update process tests
|
||||||
run: cargo test -p bsk --test windows_update --test windows_parent_cancel --locked
|
run: cargo test -p bsk --test windows_update --locked
|
||||||
|
|
||||||
- name: Run installer tests (Windows PowerShell 5.1)
|
|
||||||
shell: powershell
|
|
||||||
run: ./scripts/install-windows.test.ps1
|
|
||||||
|
|
||||||
- name: Run installer tests (PowerShell 7)
|
|
||||||
shell: pwsh
|
|
||||||
run: ./scripts/install-windows.test.ps1
|
|
||||||
|
|
||||||
frontend:
|
frontend:
|
||||||
name: Frontend lint, typecheck, tests, build
|
name: Frontend lint, typecheck, tests, build
|
||||||
|
|||||||
+1
-18
@@ -5,24 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
|
|||||||
|
|
||||||
Starting from 0.2.0, CLI / Extension / DSH Plugin share the same version number.
|
Starting from 0.2.0, CLI / Extension / DSH Plugin share the same version number.
|
||||||
|
|
||||||
## [0.2.1] - 2026-09-09
|
## [Unreleased]
|
||||||
|
|
||||||
### Changed
|
|
||||||
- DSH Plugin: clarified installation, configuration, profile restart, and upgrade instructions
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
- CLI: reliable Windows self-updates, including executable replacement and daemon restart
|
|
||||||
- CLI: Windows named-pipe connection continuity and stale daemon process detection
|
|
||||||
- Windows installer: PowerShell 5.1 compatibility, path quoting, and staged executable replacement
|
|
||||||
- CLI / DSH Plugin: cancellation propagation and upload/download cleanup when the parent process exits
|
|
||||||
- Extension: tab ownership and session cleanup when agent tabs fail to open or borrowed tabs are returned or closed
|
|
||||||
- Extension: navigation recovery when other extensions restrict Chrome DevTools Protocol access
|
|
||||||
- Extension: background input filling, automatic append behavior, and verification of field values before reporting success
|
|
||||||
- Extension: match observed form state to the correct element after page changes
|
|
||||||
- Extension: UUID generation fallback for recording and overlays on insecure origins
|
|
||||||
- Browser locale matching for regional language variants
|
|
||||||
- DSH Plugin: observation state synchronization, thumbnail capture lifecycle, and stale preview cleanup
|
|
||||||
- DSH Plugin: removed the obsolete client runtime host dependency
|
|
||||||
|
|
||||||
## [0.2.0] - 2026-09-02
|
## [0.2.0] - 2026-09-02
|
||||||
|
|
||||||
|
|||||||
Generated
+2
-2
@@ -134,7 +134,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bsk"
|
name = "bsk"
|
||||||
version = "0.2.1"
|
version = "0.2.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"base64",
|
"base64",
|
||||||
@@ -169,7 +169,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bsk-protocol"
|
name = "bsk-protocol"
|
||||||
version = "0.2.1"
|
version = "0.2.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"schemars",
|
"schemars",
|
||||||
"semver",
|
"semver",
|
||||||
|
|||||||
+2
-2
@@ -7,7 +7,7 @@ members = [
|
|||||||
default-members = ["crates/bsk-cli"]
|
default-members = ["crates/bsk-cli"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "0.2.1"
|
version = "0.2.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
rust-version = "1.85"
|
rust-version = "1.85"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
@@ -43,7 +43,7 @@ rand = "0.8"
|
|||||||
uuid = { version = "1", features = ["v4", "serde"] }
|
uuid = { version = "1", features = ["v4", "serde"] }
|
||||||
|
|
||||||
# Workspace crates (version required for `cargo publish` of dependents)
|
# Workspace crates (version required for `cargo publish` of dependents)
|
||||||
bsk-protocol = { version = "0.2.1", path = "crates/bsk-protocol" }
|
bsk-protocol = { version = "0.2.0", path = "crates/bsk-protocol" }
|
||||||
|
|
||||||
[profile.release]
|
[profile.release]
|
||||||
strip = "symbols"
|
strip = "symbols"
|
||||||
|
|||||||
@@ -147,26 +147,20 @@ Start a new Agent session and write a prompt that needs the browser, for example
|
|||||||
Using [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (`dsh`)?
|
Using [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (`dsh`)?
|
||||||
BrowserSkill ships a first-class dsh plugin on npm as
|
BrowserSkill ships a first-class dsh plugin on npm as
|
||||||
[`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin).
|
[`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin).
|
||||||
It gives the agent native `browser_*` tools and a live view of its browser sessions
|
It injects native `browser_*` tools (no shelling out to `bsk`) and a live Web UI
|
||||||
in the Web UI. The plugin runs `bsk` on the agent's behalf.
|
overlay of each Agent Window.
|
||||||
|
|
||||||
Install the `bsk` CLI and connect the browser extension first. Then add the plugin
|
Add it to a dsh profile, then start that profile:
|
||||||
to a dsh profile and start it (replace `web` with your profile name):
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin
|
dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin
|
||||||
dsh --profile web
|
dsh --profile web
|
||||||
```
|
```
|
||||||
|
|
||||||
The plugin includes the `browser-skill` skill, so `bsk install-skill` is not needed
|
The plugin carries its own copy of the skill, so `bsk install-skill` is not needed
|
||||||
for dsh. Installed plugins do not update automatically. To upgrade this plugin:
|
for dsh — but the `bsk` CLI and the browser extension are still prerequisites. See
|
||||||
|
the [plugin README](packages/dsh-plugin-browserskill/README.md) for the tool list,
|
||||||
```sh
|
configuration, and the observation overlay.
|
||||||
dsh plugin --profile web update @wxg-prc-cpg/browser-skill-dsh-plugin --latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Restart the profile after upgrading. See the
|
|
||||||
[plugin README](packages/dsh-plugin-browserskill/README.md) for usage and configuration.
|
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
|
|||||||
+3
-9
@@ -125,22 +125,16 @@ bsk install-skill
|
|||||||
|
|
||||||
## DeepSeek Harness 插件
|
## DeepSeek Harness 插件
|
||||||
|
|
||||||
在用 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(`dsh`)?BrowserSkill 提供了官方 dsh 插件,已发布到 npm:[`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)。它为 Agent 提供原生 `browser_*` 工具,由插件代为调用 `bsk`,并在 Web UI 中实时展示浏览器会话。
|
在用 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(`dsh`)?BrowserSkill 提供了官方 dsh 插件,已发布到 npm:[`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)。它会注入原生 `browser_*` 工具(无需再通过 Shell 调用 `bsk`),并在 Web UI 中实时观察每个 Agent Window。
|
||||||
|
|
||||||
先安装 `bsk` CLI 并连接浏览器扩展,再将插件装进 dsh profile 并启动(将 `web` 替换为你的 profile 名称):
|
把它装进某个 dsh profile,然后启动该 profile:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin
|
dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin
|
||||||
dsh --profile web
|
dsh --profile web
|
||||||
```
|
```
|
||||||
|
|
||||||
插件自带 `browser-skill` skill,所以在 dsh 下无需执行 `bsk install-skill`。已安装的插件不会自动更新;升级此插件请运行:
|
插件自带 skill,所以在 dsh 下无需执行 `bsk install-skill`;但 `bsk` CLI 和浏览器扩展仍是前置条件。工具清单、配置项与观察浮层见[插件 README](packages/dsh-plugin-browserskill/README.md)。
|
||||||
|
|
||||||
```sh
|
|
||||||
dsh plugin --profile web update @wxg-prc-cpg/browser-skill-dsh-plugin --latest
|
|
||||||
```
|
|
||||||
|
|
||||||
升级后重启该 profile。用法与配置见[插件 README](packages/dsh-plugin-browserskill/README.md)。
|
|
||||||
|
|
||||||
## 工作原理
|
## 工作原理
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@browser-skill/extension",
|
"name": "@browser-skill/extension",
|
||||||
"version": "0.2.1",
|
"version": "0.2.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
@@ -13,6 +13,8 @@ describe("RefStore", () => {
|
|||||||
backendNodeId: 42,
|
backendNodeId: 42,
|
||||||
tabId: 7,
|
tabId: 7,
|
||||||
generation: 0,
|
generation: 0,
|
||||||
|
kind: "dom",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
});
|
});
|
||||||
expect(s.size()).toBe(1);
|
expect(s.size()).toBe(1);
|
||||||
expect(s.isEmpty()).toBe(false);
|
expect(s.isEmpty()).toBe(false);
|
||||||
@@ -48,4 +50,31 @@ describe("RefStore", () => {
|
|||||||
cdpSessionId: "child-session",
|
cdpSessionId: "child-session",
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("preserves explicit capabilities for visual surface refs", () => {
|
||||||
|
const s = new RefStore();
|
||||||
|
s.set("e1", 42, {
|
||||||
|
tabId: 7,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(s.resolveEntry("e1")).toMatchObject({
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("never grants ordinary interaction to a surface through defaults or caller input", () => {
|
||||||
|
const s = new RefStore();
|
||||||
|
s.set("e1", 42, { tabId: 7, kind: "surface" });
|
||||||
|
s.set("e2", 43, {
|
||||||
|
tabId: 7,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(s.resolveEntry("e1")?.capabilities).toEqual(["screenshot"]);
|
||||||
|
expect(s.resolveEntry("e2")?.capabilities).toEqual(["screenshot"]);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -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>;
|
||||||
/**
|
/**
|
||||||
* Tabs explicitly claimed by the agent because it created them. This
|
* Tabs explicitly claimed by the agent because it created them. This
|
||||||
@@ -210,6 +212,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(),
|
||||||
// The home tab is the session's first explicit claim. Every other
|
// The home tab is the session's first explicit claim. Every other
|
||||||
// tab remains free until `tab_create` or `tab_borrow` identifies it
|
// tab remains free until `tab_create` or `tab_borrow` identifies it
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Per-session map from `@e<N>` snapshot refs to a CDP node address.
|
* Per-session map from `@e<N>` snapshot refs to a CDP node address.
|
||||||
*
|
*
|
||||||
@@ -12,12 +14,17 @@
|
|||||||
* inside the `SessionContext`.
|
* inside the `SessionContext`.
|
||||||
*/
|
*/
|
||||||
export type BackendNodeId = number;
|
export type BackendNodeId = number;
|
||||||
|
export type RefCapability = "interact" | "screenshot";
|
||||||
|
export type RefTargetKind = "dom" | "surface";
|
||||||
|
|
||||||
export interface RefEntry {
|
export interface RefEntry {
|
||||||
backendNodeId: BackendNodeId;
|
backendNodeId: BackendNodeId;
|
||||||
tabId: number | null;
|
tabId: number | null;
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
cdpSessionId?: string;
|
cdpSessionId?: string;
|
||||||
|
visibleRect?: Rect;
|
||||||
|
kind: RefTargetKind;
|
||||||
|
capabilities: RefCapability[];
|
||||||
generation: number;
|
generation: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -28,8 +35,19 @@ export type RefInput =
|
|||||||
tabId: number;
|
tabId: number;
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
cdpSessionId?: string;
|
cdpSessionId?: string;
|
||||||
|
visibleRect?: Rect;
|
||||||
|
kind?: RefTargetKind;
|
||||||
|
capabilities?: RefCapability[];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
function capabilitiesFor(
|
||||||
|
kind: RefTargetKind,
|
||||||
|
capabilities: RefCapability[] | undefined,
|
||||||
|
): RefCapability[] {
|
||||||
|
if (kind === "surface") return ["screenshot"];
|
||||||
|
return capabilities ?? ["interact", "screenshot"];
|
||||||
|
}
|
||||||
|
|
||||||
export class RefStore {
|
export class RefStore {
|
||||||
private readonly map = new Map<string, RefEntry>();
|
private readonly map = new Map<string, RefEntry>();
|
||||||
private generation = 0;
|
private generation = 0;
|
||||||
@@ -70,13 +88,20 @@ export class RefStore {
|
|||||||
tabId?: number;
|
tabId?: number;
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
cdpSessionId?: string;
|
cdpSessionId?: string;
|
||||||
|
visibleRect?: Rect;
|
||||||
|
kind?: RefTargetKind;
|
||||||
|
capabilities?: RefCapability[];
|
||||||
} = {},
|
} = {},
|
||||||
): void {
|
): void {
|
||||||
|
const kind = opts.kind ?? "dom";
|
||||||
this.map.set(normaliseRef(ref), {
|
this.map.set(normaliseRef(ref), {
|
||||||
backendNodeId: id,
|
backendNodeId: id,
|
||||||
tabId: opts.tabId ?? null,
|
tabId: opts.tabId ?? null,
|
||||||
...(opts.frameId ? { frameId: opts.frameId } : {}),
|
...(opts.frameId ? { frameId: opts.frameId } : {}),
|
||||||
...(opts.cdpSessionId ? { cdpSessionId: opts.cdpSessionId } : {}),
|
...(opts.cdpSessionId ? { cdpSessionId: opts.cdpSessionId } : {}),
|
||||||
|
...(opts.visibleRect ? { visibleRect: opts.visibleRect } : {}),
|
||||||
|
kind,
|
||||||
|
capabilities: capabilitiesFor(kind, opts.capabilities),
|
||||||
generation: this.generation,
|
generation: this.generation,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -94,14 +119,20 @@ export class RefStore {
|
|||||||
return {
|
return {
|
||||||
backendNodeId: input,
|
backendNodeId: input,
|
||||||
tabId: null,
|
tabId: null,
|
||||||
|
kind: "dom",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
generation: this.generation,
|
generation: this.generation,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
const kind = input.kind ?? "dom";
|
||||||
return {
|
return {
|
||||||
backendNodeId: input.backendNodeId,
|
backendNodeId: input.backendNodeId,
|
||||||
tabId: input.tabId,
|
tabId: input.tabId,
|
||||||
...(input.frameId ? { frameId: input.frameId } : {}),
|
...(input.frameId ? { frameId: input.frameId } : {}),
|
||||||
...(input.cdpSessionId ? { cdpSessionId: input.cdpSessionId } : {}),
|
...(input.cdpSessionId ? { cdpSessionId: input.cdpSessionId } : {}),
|
||||||
|
...(input.visibleRect ? { visibleRect: input.visibleRect } : {}),
|
||||||
|
kind,
|
||||||
|
capabilities: capabilitiesFor(kind, input.capabilities),
|
||||||
generation: this.generation,
|
generation: this.generation,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import { resolveNodeGeometry } from "../frame-geometry";
|
import { resolveFrameProjection, resolveNodeGeometry } from "../frame-geometry";
|
||||||
import {
|
import {
|
||||||
clipPolygon,
|
clipPolygon,
|
||||||
polygonArea,
|
polygonArea,
|
||||||
@@ -10,7 +10,6 @@ import {
|
|||||||
rectPolygon,
|
rectPolygon,
|
||||||
regionBounds,
|
regionBounds,
|
||||||
} from "../geometry";
|
} from "../geometry";
|
||||||
import { GeometryContext } from "../geometry/frame-context";
|
|
||||||
import type { CdpRunner } from "../shared";
|
import type { CdpRunner } from "../shared";
|
||||||
|
|
||||||
describe("frame geometry projection", () => {
|
describe("frame geometry projection", () => {
|
||||||
@@ -83,24 +82,28 @@ describe("frame geometry projection", () => {
|
|||||||
throw new Error(`unexpected child command ${method}`);
|
throw new Error(`unexpected child command ${method}`);
|
||||||
}) as CdpRunner["sendToTarget"],
|
}) as CdpRunner["sendToTarget"],
|
||||||
};
|
};
|
||||||
const projection = await new GeometryContext(cdp, 4, {
|
const projection = await resolveFrameProjection(
|
||||||
rootFrameId: "main",
|
cdp,
|
||||||
frames: [
|
{
|
||||||
{ frameId: "main", target: { tabId: 4 } },
|
rootFrameId: "main",
|
||||||
{
|
frames: [
|
||||||
frameId: "same-process-parent",
|
{ frameId: "main", target: { tabId: 4 } },
|
||||||
parentFrameId: "main",
|
{
|
||||||
ownerBackendNodeId: 10,
|
frameId: "same-process-parent",
|
||||||
target: { tabId: 4 },
|
parentFrameId: "main",
|
||||||
},
|
ownerBackendNodeId: 10,
|
||||||
{
|
target: { tabId: 4 },
|
||||||
frameId: "oopif",
|
},
|
||||||
parentFrameId: "same-process-parent",
|
{
|
||||||
ownerBackendNodeId: 20,
|
frameId: "oopif",
|
||||||
target: { tabId: 4, sessionId: "oopif-session" },
|
parentFrameId: "same-process-parent",
|
||||||
},
|
ownerBackendNodeId: 20,
|
||||||
],
|
target: { tabId: 4, sessionId: "oopif-session" },
|
||||||
}).targetProjection("oopif");
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
"oopif",
|
||||||
|
);
|
||||||
|
|
||||||
expect(projection?.edges).toEqual([
|
expect(projection?.edges).toEqual([
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,380 +0,0 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
|
||||||
import type { CdpFrameGraph } from "@/browser-driver/frame-graph";
|
|
||||||
import { resolveNodeGeometry } from "../frame-geometry";
|
|
||||||
import { rectPolygon } from "../geometry";
|
|
||||||
import {
|
|
||||||
projectSnapshotRect,
|
|
||||||
screenshotPageRect,
|
|
||||||
snapshotViewportRect,
|
|
||||||
} from "../geometry/coordinate-types";
|
|
||||||
import { GeometryContext } from "../geometry/frame-context";
|
|
||||||
import type { CdpRunner } from "../shared";
|
|
||||||
|
|
||||||
const target = { tabId: 4 };
|
|
||||||
const graph: CdpFrameGraph = {
|
|
||||||
rootFrameId: "main",
|
|
||||||
frames: [
|
|
||||||
{ frameId: "main", target },
|
|
||||||
{ frameId: "child", parentFrameId: "main", ownerBackendNodeId: 10, target },
|
|
||||||
],
|
|
||||||
};
|
|
||||||
|
|
||||||
function driver() {
|
|
||||||
const send = vi.fn(async (_tab: number, method: string): Promise<object> => {
|
|
||||||
if (method === "Page.getLayoutMetrics")
|
|
||||||
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 1000 } };
|
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return { model: { content: [52.5, 612.5, 427.5, 612.5, 427.5, 862.5, 52.5, 862.5] } };
|
|
||||||
if (method === "DOM.resolveNode") return { object: { objectId: "owner" } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return { result: { value: { width: 300, height: 200 } } };
|
|
||||||
if (method === "Runtime.releaseObject") return {};
|
|
||||||
throw new Error(method);
|
|
||||||
});
|
|
||||||
return { send: send as CdpRunner["send"], getFrameGraph: vi.fn(async () => graph), calls: send };
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("measurement geometry context", () => {
|
|
||||||
it("shares in-flight frame measurements, but never shares them with the next context", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const context = new GeometryContext(cdp, 4);
|
|
||||||
const results = await Promise.all(
|
|
||||||
Array.from({ length: 20 }, () => context.targetProjection("child")),
|
|
||||||
);
|
|
||||||
expect(results.every((value) => value === results[0])).toBe(true);
|
|
||||||
expect(cdp.getFrameGraph).toHaveBeenCalledTimes(1);
|
|
||||||
expect(cdp.calls.mock.calls.map(([, method]) => method)).toEqual([
|
|
||||||
"Page.getLayoutMetrics",
|
|
||||||
"DOM.getBoxModel",
|
|
||||||
]);
|
|
||||||
await new GeometryContext(cdp, 4).targetProjection("child");
|
|
||||||
expect(cdp.getFrameGraph).toHaveBeenCalledTimes(2);
|
|
||||||
expect(cdp.calls.mock.calls).toHaveLength(4);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("projects frame-local snapshot CSS bounds through the scaled owner content quad", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const context = new GeometryContext(cdp, 4);
|
|
||||||
const source = { target, frameId: "child" };
|
|
||||||
const projection = await context.snapshotProjection(source, 10, [], {
|
|
||||||
width: 1000,
|
|
||||||
height: 1000,
|
|
||||||
});
|
|
||||||
if (projection.status !== "available") throw new Error("expected available projection");
|
|
||||||
const input = snapshotViewportRect([17, 23, 120, 40], source, { x: 0, y: 0 });
|
|
||||||
expect(projectSnapshotRect(input!, projection.projection)).toEqual({
|
|
||||||
x: 73.75,
|
|
||||||
y: 641.25,
|
|
||||||
width: 150,
|
|
||||||
height: 50,
|
|
||||||
});
|
|
||||||
const scrolled = snapshotViewportRect([17, 23, 120, 40], source, { x: 0, y: 10 });
|
|
||||||
expect(projectSnapshotRect(scrolled!, projection.projection)?.y).toBe(628.75);
|
|
||||||
await context.snapshotProjection(source, 10, [], { width: 1000, height: 1000 });
|
|
||||||
expect(cdp.calls.mock.calls.filter(([, method]) => method === "DOM.resolveNode")).toHaveLength(
|
|
||||||
1,
|
|
||||||
);
|
|
||||||
expect(
|
|
||||||
cdp.calls.mock.calls.filter(([, method]) => method === "Runtime.releaseObject"),
|
|
||||||
).toHaveLength(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("falls back only for missing or invalid batch entries and does not reuse sizes across contexts", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const original = cdp.send;
|
|
||||||
const calls: string[] = [];
|
|
||||||
cdp.send = async (tabId, method, params) => {
|
|
||||||
calls.push(method);
|
|
||||||
if (method === "Runtime.evaluate")
|
|
||||||
return {
|
|
||||||
result: {
|
|
||||||
deepSerializedValue: {
|
|
||||||
type: "array",
|
|
||||||
value: [
|
|
||||||
{
|
|
||||||
type: "array",
|
|
||||||
value: [
|
|
||||||
{ type: "node", value: { backendNodeId: 10 } },
|
|
||||||
{ type: "string", value: '{"width":300,"height":200}' },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: "array",
|
|
||||||
value: [
|
|
||||||
{ type: "node", value: { backendNodeId: 11 } },
|
|
||||||
{ type: "string", value: '{"width":0,"height":200}' },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
} as never;
|
|
||||||
if (method === "Runtime.releaseObjectGroup") return {} as never;
|
|
||||||
return original(tabId, method, params);
|
|
||||||
};
|
|
||||||
const context = new GeometryContext(cdp, 4);
|
|
||||||
context.registerSnapshotOwners(target, new Set([10, 11]));
|
|
||||||
const values = await Promise.all(
|
|
||||||
[10, 11].map((id) =>
|
|
||||||
context.snapshotProjection({ target, frameId: String(id) }, id, [], {
|
|
||||||
width: 1000,
|
|
||||||
height: 1000,
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
expect(values.every((value) => value.status === "available")).toBe(true);
|
|
||||||
expect(calls.filter((method) => method === "DOM.resolveNode")).toHaveLength(1);
|
|
||||||
expect(calls.filter((method) => method === "Runtime.evaluate")).toHaveLength(1);
|
|
||||||
await new GeometryContext(cdp, 4).snapshotProjection({ target, frameId: "child" }, 10, [], {
|
|
||||||
width: 1000,
|
|
||||||
height: 1000,
|
|
||||||
});
|
|
||||||
expect(calls.filter((method) => method === "DOM.resolveNode")).toHaveLength(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("waits for batch object cleanup and propagates cancellation", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const original = cdp.send;
|
|
||||||
const controller = new AbortController();
|
|
||||||
let release!: () => void;
|
|
||||||
let cleanup!: () => void;
|
|
||||||
const started = new Promise<void>((resolve) => {
|
|
||||||
cleanup = resolve;
|
|
||||||
});
|
|
||||||
cdp.send = async (tabId, method, params) => {
|
|
||||||
if (method === "Runtime.evaluate") return {} as never;
|
|
||||||
if (method === "Runtime.releaseObjectGroup") {
|
|
||||||
cleanup();
|
|
||||||
await new Promise<void>((resolve) => {
|
|
||||||
release = resolve;
|
|
||||||
});
|
|
||||||
return {} as never;
|
|
||||||
}
|
|
||||||
return original(tabId, method, params);
|
|
||||||
};
|
|
||||||
const context = new GeometryContext(cdp, 4, undefined, controller.signal);
|
|
||||||
context.registerSnapshotOwners(target, new Set([10, 11]));
|
|
||||||
let settled = false;
|
|
||||||
const operation = context
|
|
||||||
.snapshotProjection({ target, frameId: "child" }, 10, [], { width: 1000, height: 1000 })
|
|
||||||
.finally(() => {
|
|
||||||
settled = true;
|
|
||||||
});
|
|
||||||
const rejected = expect(operation).rejects.toMatchObject({ name: "AbortError" });
|
|
||||||
await started;
|
|
||||||
controller.abort();
|
|
||||||
expect(settled).toBe(false);
|
|
||||||
release();
|
|
||||||
await rejected;
|
|
||||||
expect(cdp.calls.mock.calls.some(([, method]) => method === "DOM.resolveNode")).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects owner mismatches and invalid numeric bounds", () => {
|
|
||||||
const input = snapshotViewportRect(
|
|
||||||
[30, 50, 120, 40],
|
|
||||||
{ target, frameId: "main" },
|
|
||||||
{ x: 10, y: 20 },
|
|
||||||
)!;
|
|
||||||
const projection = {
|
|
||||||
source: { target, frameId: "main" },
|
|
||||||
geometry: { sourceClips: [], edges: [], topViewport: { width: 800, height: 600 } },
|
|
||||||
};
|
|
||||||
expect(projectSnapshotRect(input, projection)).toEqual({
|
|
||||||
x: 20,
|
|
||||||
y: 30,
|
|
||||||
width: 120,
|
|
||||||
height: 40,
|
|
||||||
});
|
|
||||||
expect(
|
|
||||||
projectSnapshotRect(input, { ...projection, source: { target, frameId: "other" } }),
|
|
||||||
).toBeNull();
|
|
||||||
expect(
|
|
||||||
projectSnapshotRect(input, {
|
|
||||||
...projection,
|
|
||||||
source: { target: { tabId: 5 }, frameId: "main" },
|
|
||||||
}),
|
|
||||||
).toBeNull();
|
|
||||||
expect(snapshotViewportRect([0, 0, NaN, 40], { target }, { x: 0, y: 0 })).toBeNull();
|
|
||||||
expect(snapshotViewportRect([0, 0, 10, 40], { target }, { x: Infinity, y: 0 })).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not turn a border quad or a failed owner read into a content projection", async () => {
|
|
||||||
const cdp: CdpRunner = {
|
|
||||||
send: vi.fn(async () => ({
|
|
||||||
model: { border: [0, 0, 100, 0, 100, 100, 0, 100] },
|
|
||||||
})) as CdpRunner["send"],
|
|
||||||
};
|
|
||||||
expect(
|
|
||||||
await new GeometryContext(cdp, 4).snapshotProjection({ target, frameId: "child" }, 10, [], {
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
}),
|
|
||||||
).toEqual({
|
|
||||||
status: "unavailable",
|
|
||||||
source: { target, frameId: "child" },
|
|
||||||
ownerBackendNodeId: 10,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("keeps ancestor clips in target coordinates instead of applying nested offsets twice", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const projection = await new GeometryContext(cdp, 4).snapshotProjection(
|
|
||||||
{ target, frameId: "nested" },
|
|
||||||
10,
|
|
||||||
[rectPolygon({ x: 60, y: 620, w: 100, h: 100 })],
|
|
||||||
{ width: 1000, height: 1000 },
|
|
||||||
);
|
|
||||||
if (projection.status !== "available") throw new Error("expected available projection");
|
|
||||||
const input = snapshotViewportRect(
|
|
||||||
[0, 0, 300, 200],
|
|
||||||
{ target, frameId: "nested" },
|
|
||||||
{ x: 0, y: 0 },
|
|
||||||
);
|
|
||||||
expect(projectSnapshotRect(input!, projection.projection)).toEqual({
|
|
||||||
x: 60,
|
|
||||||
y: 620,
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects malformed frame ancestry without looping", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const cycle: CdpFrameGraph = {
|
|
||||||
rootFrameId: "a",
|
|
||||||
frames: [
|
|
||||||
{ frameId: "a", parentFrameId: "b", target },
|
|
||||||
{ frameId: "b", parentFrameId: "a", target },
|
|
||||||
],
|
|
||||||
};
|
|
||||||
expect(await new GeometryContext(cdp, 4, cycle).targetProjection("a")).toBeNull();
|
|
||||||
expect(cdp.calls).not.toHaveBeenCalled();
|
|
||||||
const orphan: CdpFrameGraph = {
|
|
||||||
rootFrameId: "a",
|
|
||||||
frames: [{ frameId: "a", parentFrameId: "missing", target }],
|
|
||||||
};
|
|
||||||
expect(await new GeometryContext(cdp, 4, orphan).targetProjection("a")).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects a live node whose frame belongs to another target before any DOM input", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
expect(
|
|
||||||
await resolveNodeGeometry(
|
|
||||||
cdp,
|
|
||||||
4,
|
|
||||||
{ target: { tabId: 4, sessionId: "wrong" }, frameId: "child", backendNodeId: 20 },
|
|
||||||
{ scrollIntoView: true },
|
|
||||||
),
|
|
||||||
).toMatchObject({ code: "cdp_failed" });
|
|
||||||
expect(cdp.calls).not.toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("bounds concurrent measurements and does not dispatch queued reads after cancellation", async () => {
|
|
||||||
let active = 0;
|
|
||||||
let peak = 0;
|
|
||||||
const release: Array<() => void> = [];
|
|
||||||
const send = vi.fn(async () => {
|
|
||||||
active++;
|
|
||||||
peak = Math.max(peak, active);
|
|
||||||
await new Promise<void>((resolve) => release.push(resolve));
|
|
||||||
active--;
|
|
||||||
return { cssLayoutViewport: { clientWidth: 100, clientHeight: 100 } };
|
|
||||||
});
|
|
||||||
const controller = new AbortController();
|
|
||||||
const context = new GeometryContext(
|
|
||||||
{ send: send as CdpRunner["send"] },
|
|
||||||
4,
|
|
||||||
undefined,
|
|
||||||
controller.signal,
|
|
||||||
);
|
|
||||||
const tasks = Array.from({ length: 8 }, (_, index) =>
|
|
||||||
context.viewport({ tabId: 4, sessionId: String(index) }),
|
|
||||||
);
|
|
||||||
const settled = Promise.allSettled(tasks);
|
|
||||||
expect(send).toHaveBeenCalledTimes(4);
|
|
||||||
controller.abort();
|
|
||||||
for (const done of release) done();
|
|
||||||
const results = await settled;
|
|
||||||
expect(peak).toBe(4);
|
|
||||||
expect(send).toHaveBeenCalledTimes(4);
|
|
||||||
expect(results.filter((item) => item.status === "rejected")).toHaveLength(4);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("releases an owner object even when cancellation arrives before its viewport read", async () => {
|
|
||||||
const controller = new AbortController();
|
|
||||||
const cdp = driver();
|
|
||||||
const original = cdp.calls.getMockImplementation()!;
|
|
||||||
cdp.calls.mockImplementation(async (tab, method) => {
|
|
||||||
const result = await original(tab, method);
|
|
||||||
if (method === "DOM.resolveNode") controller.abort();
|
|
||||||
return result;
|
|
||||||
});
|
|
||||||
const context = new GeometryContext(cdp, 4, undefined, controller.signal);
|
|
||||||
await expect(
|
|
||||||
context.snapshotProjection({ target, frameId: "child" }, 10, [], {
|
|
||||||
width: 1000,
|
|
||||||
height: 1000,
|
|
||||||
}),
|
|
||||||
).rejects.toMatchObject({ name: "AbortError" });
|
|
||||||
expect(cdp.calls.mock.calls.map(([, method]) => method)).toEqual([
|
|
||||||
"DOM.getBoxModel",
|
|
||||||
"DOM.resolveNode",
|
|
||||||
"Runtime.releaseObject",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("reads live owner geometry only after scrolling", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
const original = cdp.calls.getMockImplementation()!;
|
|
||||||
let scrolled = false;
|
|
||||||
cdp.calls.mockImplementation(async (tab, method) => {
|
|
||||||
if (method === "DOM.scrollIntoViewIfNeeded") {
|
|
||||||
scrolled = true;
|
|
||||||
return {};
|
|
||||||
}
|
|
||||||
if (method === "DOM.getContentQuads") {
|
|
||||||
expect(scrolled).toBe(true);
|
|
||||||
return { quads: [[60, 620, 100, 620, 100, 640, 60, 640]] };
|
|
||||||
}
|
|
||||||
if (method === "DOM.getBoxModel") expect(scrolled).toBe(true);
|
|
||||||
return original(tab, method);
|
|
||||||
});
|
|
||||||
expect(
|
|
||||||
await resolveNodeGeometry(
|
|
||||||
cdp,
|
|
||||||
4,
|
|
||||||
{ target, frameId: "child", backendNodeId: 20 },
|
|
||||||
{ scrollIntoView: true },
|
|
||||||
),
|
|
||||||
).toMatchObject({ topBounds: { x: 60, y: 620, width: 40, height: 20 } });
|
|
||||||
expect(cdp.getFrameGraph).toHaveBeenCalledTimes(1);
|
|
||||||
expect(cdp.calls.mock.calls.filter(([, method]) => method === "DOM.getBoxModel")).toHaveLength(
|
|
||||||
1,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("adapts viewport CSS bounds to page DIP with scroll and browser zoom, never raster DPR", () => {
|
|
||||||
const viewport = { width: 1600, height: 1000, scrollX: 10, scrollY: 100, cssToDip: 0.9 };
|
|
||||||
const clip = screenshotPageRect({ x: 20, y: 30, width: 120, height: 40 }, viewport);
|
|
||||||
expect(clip).toEqual({ space: "page-dip", rect: { x: 27, y: 117, width: 108, height: 36 } });
|
|
||||||
expect(
|
|
||||||
screenshotPageRect({ x: 20, y: 30, width: 120, height: 40 }, { ...viewport, cssToDip: NaN }),
|
|
||||||
).toBeNull();
|
|
||||||
expect(
|
|
||||||
screenshotPageRect({ x: 20, y: 30, width: 120, height: 40 }, { ...viewport, cssToDip: 0 }),
|
|
||||||
).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("retries a rejected measurement only in a new operation", async () => {
|
|
||||||
const cdp = driver();
|
|
||||||
cdp.calls.mockRejectedValueOnce(new Error("unavailable"));
|
|
||||||
const context = new GeometryContext(cdp, 4);
|
|
||||||
await expect(context.viewport(target)).rejects.toThrow("unavailable");
|
|
||||||
await expect(context.viewport(target)).rejects.toThrow("unavailable");
|
|
||||||
expect(cdp.calls).toHaveBeenCalledTimes(1);
|
|
||||||
expect(await new GeometryContext(cdp, 4).viewport(target)).toEqual({
|
|
||||||
width: 1000,
|
|
||||||
height: 1000,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -11,6 +11,7 @@ import {
|
|||||||
parseKeySpec,
|
parseKeySpec,
|
||||||
resolveKeyDescriptor,
|
resolveKeyDescriptor,
|
||||||
} from "../interaction";
|
} from "../interaction";
|
||||||
|
import { captureSurfaceEnvironment } from "../surface-target";
|
||||||
|
|
||||||
function fakeAgentWindow(ids: number[]) {
|
function fakeAgentWindow(ids: number[]) {
|
||||||
let i = 0;
|
let i = 0;
|
||||||
@@ -54,6 +55,61 @@ function makeFakeCdp(handlers: Record<string, (params: unknown) => unknown>) {
|
|||||||
return { cdp, tabsApi, sent };
|
return { cdp, tabsApi, sent };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function makeSurfaceClickFixture(onMouse?: (params: Record<string, unknown>) => void) {
|
||||||
|
const manager = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
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 fake = makeFakeCdp({
|
||||||
|
"Page.getFrameTree": () => ({
|
||||||
|
frameTree: {
|
||||||
|
frame: { id: "main", loaderId: "loader-1", url: "https://fixture.test/" },
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
"Page.getLayoutMetrics": () => ({
|
||||||
|
cssLayoutViewport: { clientWidth: 800, clientHeight: 600, pageX: 0, pageY: 0 },
|
||||||
|
cssVisualViewport: {
|
||||||
|
clientWidth: 800,
|
||||||
|
clientHeight: 600,
|
||||||
|
pageX: 0,
|
||||||
|
pageY: 0,
|
||||||
|
scale: 1,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
"DOM.getContentQuads": () => ({ quads: [[10, 20, 110, 20, 110, 60, 10, 60]] }),
|
||||||
|
"Runtime.evaluate": () => ({
|
||||||
|
result: { value: { overlayHostPresent: false, overlayHostConnected: false } },
|
||||||
|
}),
|
||||||
|
"Input.dispatchMouseEvent": (params) => {
|
||||||
|
onMouse?.(params as Record<string, unknown>);
|
||||||
|
return {};
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const environment = await captureSurfaceEnvironment(fake.cdp, 4, undefined);
|
||||||
|
if ("code" in environment) throw new Error(environment.message);
|
||||||
|
const entry = context.refStore.resolveEntry("e3");
|
||||||
|
if (!entry) throw new Error("missing Surface 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, fake, capture };
|
||||||
|
}
|
||||||
|
|
||||||
describe("modifiersBitfield", () => {
|
describe("modifiersBitfield", () => {
|
||||||
it("matches CDP's expected bit layout", () => {
|
it("matches CDP's expected bit layout", () => {
|
||||||
expect(modifiersBitfield([])).toBe(0);
|
expect(modifiersBitfield([])).toBe(0);
|
||||||
@@ -123,6 +179,29 @@ describe("handleClick", () => {
|
|||||||
expect(fake.cdp.send).not.toHaveBeenCalled();
|
expect(fake.cdp.send).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("rejects screenshot-only visual surface refs before issuing CDP calls", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e3", 1234, {
|
||||||
|
tabId: 4,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
const fake = makeFakeCdp({});
|
||||||
|
|
||||||
|
const res = await handleClick(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11", ref: "@e3" },
|
||||||
|
{ cdp: fake.cdp, tabsApi: fake.tabsApi },
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(res).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
data: { reason: "ref_capability_denied", required_capability: "interact" },
|
||||||
|
});
|
||||||
|
expect(fake.cdp.send).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
it("clicks by ref, computes the quad centre, dispatches three mouse events", async () => {
|
it("clicks by ref, computes the quad centre, dispatches three mouse events", async () => {
|
||||||
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
const ctx = await sm.start("aa11");
|
const ctx = await sm.start("aa11");
|
||||||
@@ -167,6 +246,74 @@ describe("handleClick", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"left",
|
||||||
|
"middle",
|
||||||
|
"right",
|
||||||
|
] as const)("uses the common click executor for a %s-button Surface click", async (button) => {
|
||||||
|
const { manager, fake, capture } = await makeSurfaceClickFixture();
|
||||||
|
const result = await handleClick(
|
||||||
|
manager,
|
||||||
|
{
|
||||||
|
session_id: "aa11",
|
||||||
|
ref: "@e3",
|
||||||
|
capture_id: capture.id,
|
||||||
|
image_x: 50,
|
||||||
|
image_y: 20,
|
||||||
|
button,
|
||||||
|
click_count: 2,
|
||||||
|
modifiers: ["ctrl", "shift"],
|
||||||
|
},
|
||||||
|
{ cdp: fake.cdp, tabsApi: fake.tabsApi },
|
||||||
|
);
|
||||||
|
|
||||||
|
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,
|
||||||
|
});
|
||||||
|
const mouse = fake.sent.filter((call) => call.method === "Input.dispatchMouseEvent");
|
||||||
|
expect(mouse).toHaveLength(3);
|
||||||
|
expect(mouse[1].params).toMatchObject({
|
||||||
|
type: "mousePressed",
|
||||||
|
button,
|
||||||
|
clickCount: 2,
|
||||||
|
modifiers: 2 | 8,
|
||||||
|
});
|
||||||
|
expect(mouse[2].params).toMatchObject({
|
||||||
|
type: "mouseReleased",
|
||||||
|
button,
|
||||||
|
clickCount: 2,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("consumes a Surface capture when the common click executor fails", async () => {
|
||||||
|
let mouseCalls = 0;
|
||||||
|
const { manager, fake, capture } = await makeSurfaceClickFixture((params) => {
|
||||||
|
mouseCalls += 1;
|
||||||
|
if (params.type === "mousePressed") throw new Error("input failed");
|
||||||
|
});
|
||||||
|
const params = {
|
||||||
|
session_id: "aa11",
|
||||||
|
ref: "@e3",
|
||||||
|
capture_id: capture.id,
|
||||||
|
image_x: 50,
|
||||||
|
image_y: 20,
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(
|
||||||
|
await handleClick(manager, params, { cdp: fake.cdp, tabsApi: fake.tabsApi }),
|
||||||
|
).toMatchObject({ code: "cdp_failed" });
|
||||||
|
expect(mouseCalls).toBe(2);
|
||||||
|
expect(
|
||||||
|
await handleClick(manager, params, { cdp: fake.cdp, tabsApi: fake.tabsApi }),
|
||||||
|
).toMatchObject({ data: { reason: "surface_capture_consumed" } });
|
||||||
|
});
|
||||||
|
|
||||||
it("resolves frame refs in their CDP session and dispatches input in top coordinates", async () => {
|
it("resolves frame refs in their CDP session and dispatches input in top coordinates", async () => {
|
||||||
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
const ctx = await sm.start("aa11");
|
const ctx = await sm.start("aa11");
|
||||||
|
|||||||
@@ -0,0 +1,119 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { dispatchMouseClick } from "../mouse-input";
|
||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
|
||||||
|
function fakeCdp(onSend?: (method: string, params: Record<string, unknown>) => void): {
|
||||||
|
cdp: CdpRunner;
|
||||||
|
events: Record<string, unknown>[];
|
||||||
|
} {
|
||||||
|
const events: Record<string, unknown>[] = [];
|
||||||
|
return {
|
||||||
|
events,
|
||||||
|
cdp: {
|
||||||
|
send: vi.fn(async (_tabId, method, params) => {
|
||||||
|
const event = params as Record<string, unknown>;
|
||||||
|
events.push(event);
|
||||||
|
onSend?.(method, event);
|
||||||
|
return {} as never;
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("dispatchMouseClick", () => {
|
||||||
|
it("emits one move, press, and release sequence", async () => {
|
||||||
|
const { cdp, events } = fakeCdp();
|
||||||
|
|
||||||
|
expect(
|
||||||
|
await dispatchMouseClick(
|
||||||
|
cdp,
|
||||||
|
4,
|
||||||
|
{ x: 12, y: 34 },
|
||||||
|
{
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
moveSettleMs: 0,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
).toBe("completed");
|
||||||
|
|
||||||
|
expect(events).toEqual([
|
||||||
|
{
|
||||||
|
type: "mouseMoved",
|
||||||
|
x: 12,
|
||||||
|
y: 34,
|
||||||
|
modifiers: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "mousePressed",
|
||||||
|
x: 12,
|
||||||
|
y: 34,
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "mouseReleased",
|
||||||
|
x: 12,
|
||||||
|
y: 34,
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("releases a pressed button when cancellation arrives", async () => {
|
||||||
|
const controller = new AbortController();
|
||||||
|
const { cdp, events } = fakeCdp((_method, event) => {
|
||||||
|
if (event.type === "mousePressed") controller.abort();
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(
|
||||||
|
await dispatchMouseClick(
|
||||||
|
cdp,
|
||||||
|
4,
|
||||||
|
{ x: 1, y: 2 },
|
||||||
|
{
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
signal: controller.signal,
|
||||||
|
moveSettleMs: 0,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
).toBe("cancelled");
|
||||||
|
expect(events.at(-1)).toMatchObject({ type: "mouseReleased" });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("settles pointer-move hit testing before pressing", async () => {
|
||||||
|
vi.useFakeTimers();
|
||||||
|
try {
|
||||||
|
const { cdp, events } = fakeCdp();
|
||||||
|
const click = dispatchMouseClick(
|
||||||
|
cdp,
|
||||||
|
4,
|
||||||
|
{ x: 1, y: 2 },
|
||||||
|
{
|
||||||
|
button: "left",
|
||||||
|
clickCount: 1,
|
||||||
|
modifiers: 0,
|
||||||
|
moveSettleMs: 32,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
await vi.advanceTimersByTimeAsync(31);
|
||||||
|
expect(events.map((event) => event.type)).toEqual(["mouseMoved"]);
|
||||||
|
await vi.advanceTimersByTimeAsync(1);
|
||||||
|
await click;
|
||||||
|
expect(events.map((event) => event.type)).toEqual([
|
||||||
|
"mouseMoved",
|
||||||
|
"mousePressed",
|
||||||
|
"mouseReleased",
|
||||||
|
]);
|
||||||
|
} finally {
|
||||||
|
vi.useRealTimers();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -36,6 +36,14 @@ function fakeAgentWindow(ids: number[]) {
|
|||||||
const TINY_PNG =
|
const TINY_PNG =
|
||||||
"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGNgYGBgAAAABQABh6FO1AAAAABJRU5ErkJggg==";
|
"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGNgYGBgAAAABQABh6FO1AAAAABJRU5ErkJggg==";
|
||||||
|
|
||||||
|
function pngWithIhdrDimensions(width: number, height: number): string {
|
||||||
|
const bytes = Uint8Array.from(atob(TINY_PNG), (character) => character.charCodeAt(0));
|
||||||
|
const view = new DataView(bytes.buffer);
|
||||||
|
view.setUint32(16, width);
|
||||||
|
view.setUint32(20, height);
|
||||||
|
return btoa(String.fromCharCode(...bytes));
|
||||||
|
}
|
||||||
|
|
||||||
function makeScreenshotDeps(
|
function makeScreenshotDeps(
|
||||||
opts: {
|
opts: {
|
||||||
cdp?: CdpRunner;
|
cdp?: CdpRunner;
|
||||||
@@ -67,6 +75,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);
|
||||||
});
|
});
|
||||||
@@ -86,6 +97,7 @@ describe("stripDataUrlPrefix", () => {
|
|||||||
describe("parsePngDimensions", () => {
|
describe("parsePngDimensions", () => {
|
||||||
it("parses width/height from the IHDR chunk", () => {
|
it("parses width/height from the IHDR chunk", () => {
|
||||||
expect(parsePngDimensions(TINY_PNG)).toEqual({ width: 1, height: 1 });
|
expect(parsePngDimensions(TINY_PNG)).toEqual({ width: 1, height: 1 });
|
||||||
|
expect(parsePngDimensions(pngWithIhdrDimensions(100, 80))).toEqual({ width: 100, height: 80 });
|
||||||
});
|
});
|
||||||
it("returns null on non-PNG input", () => {
|
it("returns null on non-PNG input", () => {
|
||||||
expect(parsePngDimensions("not-a-png-payload-just-random-base64-text-zzzzzzzzz")).toBeNull();
|
expect(parsePngDimensions("not-a-png-payload-just-random-base64-text-zzzzzzzzz")).toBeNull();
|
||||||
@@ -120,6 +132,20 @@ describe("handleScreenshot", () => {
|
|||||||
expect(get).not.toHaveBeenCalled();
|
expect(get).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("fails closed when a full-tab capture is not a valid PNG", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
await sm.start("aa11");
|
||||||
|
const res = await handleScreenshot(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11" },
|
||||||
|
makeScreenshotDeps({
|
||||||
|
captureVisibleTab: vi.fn(async () => "data:image/png;base64,bm90LWEtcG5n"),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(res).toMatchObject({ code: "cdp_failed", message: /invalid PNG data/ });
|
||||||
|
});
|
||||||
|
|
||||||
it("returns not_found when Agent Window has no active tab", async () => {
|
it("returns not_found when Agent Window has no active tab", async () => {
|
||||||
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
await sm.start("aa11");
|
await sm.start("aa11");
|
||||||
@@ -266,15 +292,7 @@ describe("handleScreenshot", () => {
|
|||||||
expect(sent.find((c) => c.method === "Page.captureScreenshot")).toBeUndefined();
|
expect(sent.find((c) => c.method === "Page.captureScreenshot")).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it("captures a clipped PNG when ref is given", async () => {
|
||||||
{ zoom: 1, scroll: 0, expected: { x: 10, y: 20, width: 100, height: 40 } },
|
|
||||||
{ zoom: 0.9, scroll: 100, expected: { x: 9, y: 108, width: 90, height: 36 } },
|
|
||||||
{ zoom: 1.25, scroll: 100, expected: { x: 12.5, y: 150, width: 125, height: 50 } },
|
|
||||||
])("captures a ref in page DIP at zoom $zoom and scroll $scroll", async ({
|
|
||||||
zoom,
|
|
||||||
scroll,
|
|
||||||
expected,
|
|
||||||
}) => {
|
|
||||||
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
const ctx = await sm.start("aa11");
|
const ctx = await sm.start("aa11");
|
||||||
ctx.refStore.set("e5", 999, { tabId: 7 });
|
ctx.refStore.set("e5", 999, { tabId: 7 });
|
||||||
@@ -282,10 +300,6 @@ describe("handleScreenshot", () => {
|
|||||||
"DOM.scrollIntoViewIfNeeded": () => ({}),
|
"DOM.scrollIntoViewIfNeeded": () => ({}),
|
||||||
"DOM.getContentQuads": () => ({ quads: [[10, 20, 110, 20, 110, 60, 10, 60]] }),
|
"DOM.getContentQuads": () => ({ quads: [[10, 20, 110, 20, 110, 60, 10, 60]] }),
|
||||||
"Page.captureScreenshot": () => ({ data: TINY_PNG }),
|
"Page.captureScreenshot": () => ({ data: TINY_PNG }),
|
||||||
"Page.getLayoutMetrics": () => ({
|
|
||||||
cssLayoutViewport: { clientWidth: 1280, clientHeight: 720, pageX: 0, pageY: scroll },
|
|
||||||
cssVisualViewport: { zoom },
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
const captureVisibleTab = vi.fn();
|
const captureVisibleTab = vi.fn();
|
||||||
const res = await handleScreenshot(
|
const res = await handleScreenshot(
|
||||||
@@ -309,8 +323,172 @@ describe("handleScreenshot", () => {
|
|||||||
clip?: { x: number; y: number; width: number; height: number };
|
clip?: { x: number; y: number; width: number; height: number };
|
||||||
}
|
}
|
||||||
)?.clip;
|
)?.clip;
|
||||||
expect(clip).toMatchObject(expected);
|
expect(clip).toMatchObject({ x: 10, y: 20, width: 100, height: 40 });
|
||||||
expect(sent.filter((c) => c.method === "Page.getLayoutMetrics")).toHaveLength(1);
|
});
|
||||||
|
|
||||||
|
it("captures a bounded visible crop for a visual surface without scrolling it", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e5", 999, {
|
||||||
|
tabId: 7,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
const { cdp, sent } = makeFakeCdp({
|
||||||
|
"Page.getLayoutMetrics": () => ({
|
||||||
|
cssLayoutViewport: { clientWidth: 4096, clientHeight: 4096 },
|
||||||
|
}),
|
||||||
|
"DOM.getContentQuads": () => ({ quads: [[0, 0, 4096, 0, 4096, 4096, 0, 4096]] }),
|
||||||
|
"Page.captureScreenshot": () => ({ data: TINY_PNG }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await handleScreenshot(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11", ref: "@e5", tab_id: 7 },
|
||||||
|
makeScreenshotDeps({
|
||||||
|
cdp,
|
||||||
|
get: vi.fn(async () => ({ id: 7, windowId: 100, active: false }) as chrome.tabs.Tab),
|
||||||
|
query: vi.fn(),
|
||||||
|
captureVisibleTab: vi.fn(),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in res) throw new Error(`unexpected error: ${JSON.stringify(res)}`);
|
||||||
|
expect(sent.some((call) => call.method === "DOM.scrollIntoViewIfNeeded")).toBe(false);
|
||||||
|
const clip = sent.find((call) => call.method === "Page.captureScreenshot")?.params as {
|
||||||
|
clip?: { width: number; height: number; scale: number };
|
||||||
|
};
|
||||||
|
expect(clip.clip).toMatchObject({ width: 4096, height: 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 () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e5", 999, {
|
||||||
|
tabId: 7,
|
||||||
|
kind: "surface",
|
||||||
|
visibleRect: { x: 25, y: 30, w: 50, h: 40 },
|
||||||
|
});
|
||||||
|
const { cdp, sent } = makeFakeCdp({
|
||||||
|
"Page.getLayoutMetrics": () => ({
|
||||||
|
cssLayoutViewport: { clientWidth: 800, clientHeight: 600 },
|
||||||
|
}),
|
||||||
|
"DOM.getContentQuads": () => ({ quads: [[0, 0, 200, 0, 200, 100, 0, 100]] }),
|
||||||
|
"Page.captureScreenshot": () => ({ data: pngWithIhdrDimensions(100, 80) }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await handleScreenshot(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11", ref: "@e5", tab_id: 7 },
|
||||||
|
makeScreenshotDeps({
|
||||||
|
cdp,
|
||||||
|
get: vi.fn(async () => ({ id: 7, windowId: 100, active: false }) as chrome.tabs.Tab),
|
||||||
|
query: vi.fn(),
|
||||||
|
captureVisibleTab: vi.fn(),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in res) throw new Error(`unexpected error: ${JSON.stringify(res)}`);
|
||||||
|
const clip = sent.find((call) => call.method === "Page.captureScreenshot")?.params as {
|
||||||
|
clip?: { x: number; y: number; width: number; height: number };
|
||||||
|
};
|
||||||
|
expect(clip.clip).toMatchObject({ x: 25, y: 30, width: 50, height: 40 });
|
||||||
|
expect(res).toMatchObject({ width: 100, height: 80 });
|
||||||
|
expect(res.capture?.id).toMatch(/^sc_/);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("routes OOPIF surface geometry through its child session and captures top coordinates", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e5", 999, {
|
||||||
|
tabId: 7,
|
||||||
|
frameId: "child-frame",
|
||||||
|
cdpSessionId: "child-session",
|
||||||
|
kind: "surface",
|
||||||
|
visibleRect: { x: 224, y: 346, w: 200, h: 80 },
|
||||||
|
});
|
||||||
|
const { cdp, sent } = makeFakeCdp({
|
||||||
|
"DOM.getBoxModel": () => ({
|
||||||
|
model: { content: [204, 306, 604, 306, 604, 506, 204, 506] },
|
||||||
|
}),
|
||||||
|
"Page.getLayoutMetrics": () => ({
|
||||||
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800 },
|
||||||
|
}),
|
||||||
|
"Page.captureScreenshot": () => ({ data: TINY_PNG }),
|
||||||
|
});
|
||||||
|
cdp.getFrameGraph = vi.fn(async () => ({
|
||||||
|
rootFrameId: "main",
|
||||||
|
frames: [
|
||||||
|
{ frameId: "main", target: { tabId: 7 } },
|
||||||
|
{
|
||||||
|
frameId: "child-frame",
|
||||||
|
parentFrameId: "main",
|
||||||
|
ownerBackendNodeId: 99,
|
||||||
|
target: { tabId: 7, sessionId: "child-session" },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}));
|
||||||
|
const targetCalls: Array<{ sessionId?: string; method: string }> = [];
|
||||||
|
cdp.sendToTarget = vi.fn(async (target, method) => {
|
||||||
|
targetCalls.push({ sessionId: target.sessionId, method });
|
||||||
|
if (method === "DOM.getContentQuads") {
|
||||||
|
return { quads: [[10, 20, 110, 20, 110, 60, 10, 60]] };
|
||||||
|
}
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return { cssLayoutViewport: { clientWidth: 200, clientHeight: 100 } };
|
||||||
|
}
|
||||||
|
throw new Error(`unexpected child CDP call ${method}`);
|
||||||
|
}) as CdpRunner["sendToTarget"];
|
||||||
|
|
||||||
|
const res = await handleScreenshot(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11", ref: "@e5", tab_id: 7 },
|
||||||
|
makeScreenshotDeps({
|
||||||
|
cdp,
|
||||||
|
get: vi.fn(async () => ({ id: 7, windowId: 100, active: false }) as chrome.tabs.Tab),
|
||||||
|
query: vi.fn(),
|
||||||
|
captureVisibleTab: vi.fn(),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in res) throw new Error(`unexpected error: ${JSON.stringify(res)}`);
|
||||||
|
expect(targetCalls).toEqual([
|
||||||
|
{ sessionId: "child-session", method: "DOM.getContentQuads" },
|
||||||
|
{ sessionId: "child-session", method: "Page.getLayoutMetrics" },
|
||||||
|
]);
|
||||||
|
const clip = sent.find((call) => call.method === "Page.captureScreenshot")?.params as {
|
||||||
|
clip?: { x: number; y: number; width: number; height: number };
|
||||||
|
};
|
||||||
|
expect(clip.clip).toMatchObject({ x: 224, y: 346, width: 200, height: 80 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fails closed when a ref capture is not a valid PNG", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e5", 999, { tabId: 7, kind: "surface" });
|
||||||
|
const { cdp } = makeFakeCdp({
|
||||||
|
"DOM.getContentQuads": () => ({ quads: [[0, 0, 50, 0, 50, 50, 0, 50]] }),
|
||||||
|
"Page.captureScreenshot": () => ({ data: "bm90LWEtcG5n" }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await handleScreenshot(
|
||||||
|
sm,
|
||||||
|
{ session_id: "aa11", ref: "@e5", tab_id: 7 },
|
||||||
|
makeScreenshotDeps({
|
||||||
|
cdp,
|
||||||
|
get: vi.fn(async () => ({ id: 7, windowId: 100, active: false }) as chrome.tabs.Tab),
|
||||||
|
query: vi.fn(),
|
||||||
|
captureVisibleTab: vi.fn(),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(res).toMatchObject({ code: "cdp_failed", message: /invalid PNG data/ });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("returns not_found for unknown ref", async () => {
|
it("returns not_found for unknown ref", async () => {
|
||||||
@@ -2846,6 +3024,85 @@ describe("handleSnapshot", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("discovers rendered canvases only in observe and stores a screenshot-only ref", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
const root: CdpAxNode = {
|
||||||
|
nodeId: "1",
|
||||||
|
role: { type: "role", value: "RootWebArea" },
|
||||||
|
name: { type: "computedString", value: "Canvas app" },
|
||||||
|
backendDOMNodeId: 100,
|
||||||
|
};
|
||||||
|
const strings = ["body", "canvas", "static", "auto"];
|
||||||
|
const i = (value: string) => strings.indexOf(value);
|
||||||
|
const send = vi.fn(async (_tabId: number, method: string) => {
|
||||||
|
if (method === "Accessibility.enable" || method === "DOMSnapshot.enable") return {};
|
||||||
|
if (method === "Accessibility.getFullAXTree") return { nodes: [root] };
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 } };
|
||||||
|
}
|
||||||
|
if (method === "DOMSnapshot.captureSnapshot") {
|
||||||
|
return {
|
||||||
|
strings,
|
||||||
|
documents: [
|
||||||
|
{
|
||||||
|
nodes: {
|
||||||
|
parentIndex: [-1, 0],
|
||||||
|
nodeName: [i("body"), i("canvas")],
|
||||||
|
backendNodeId: [100, 200],
|
||||||
|
attributes: [[], []],
|
||||||
|
},
|
||||||
|
layout: {
|
||||||
|
nodeIndex: [0, 1],
|
||||||
|
styles: [
|
||||||
|
[i("static"), i("auto"), i("auto")],
|
||||||
|
[i("static"), i("auto"), i("auto")],
|
||||||
|
],
|
||||||
|
bounds: [
|
||||||
|
[0, 0, 1000, 800],
|
||||||
|
[20, 30, 800, 500],
|
||||||
|
],
|
||||||
|
paintOrders: [0, 1],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
throw new Error(`unexpected CDP method ${method}`);
|
||||||
|
});
|
||||||
|
const deps = {
|
||||||
|
cdp: {
|
||||||
|
send: send as unknown as <T = unknown>(
|
||||||
|
tabId: number,
|
||||||
|
method: string,
|
||||||
|
params?: object,
|
||||||
|
) => Promise<T>,
|
||||||
|
trackSessionTab: vi.fn(),
|
||||||
|
},
|
||||||
|
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]),
|
||||||
|
},
|
||||||
|
conditionalSurfaceProbe: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
const observed = await handleObserve(sm, { session_id: "aa11" }, deps);
|
||||||
|
if ("code" in observed) throw new Error(`unexpected error: ${JSON.stringify(observed)}`);
|
||||||
|
expect(observed.text).toContain('@e1 surface "canvas visual surface"');
|
||||||
|
expect(ctx.refStore.resolveEntry("e1")).toMatchObject({
|
||||||
|
backendNodeId: 200,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
|
||||||
|
const snapshot = await handleSnapshot(sm, { session_id: "aa11" }, deps);
|
||||||
|
if ("code" in snapshot) throw new Error(`unexpected error: ${JSON.stringify(snapshot)}`);
|
||||||
|
expect(snapshot.text).not.toContain("visual surface");
|
||||||
|
expect(snapshot.ref_count).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
it("allows passive snapshots of explicit user-window tabs", async () => {
|
it("allows passive snapshots of explicit user-window tabs", async () => {
|
||||||
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
await sm.start("aa11");
|
await sm.start("aa11");
|
||||||
@@ -3147,9 +3404,7 @@ describe("handleSnapshot", () => {
|
|||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
|
|
||||||
function makeFrameAwareDeps(
|
function makeFrameAwareDeps() {
|
||||||
ownerGeometry: "unavailable" | "available" | "clipped" = "unavailable",
|
|
||||||
) {
|
|
||||||
const strings = ["html", "body", "iframe", "button", "title", "Remote", "static", "auto"];
|
const strings = ["html", "body", "iframe", "button", "title", "Remote", "static", "auto"];
|
||||||
const i = (value: string) => strings.indexOf(value);
|
const i = (value: string) => strings.indexOf(value);
|
||||||
const styles = [i("static"), i("auto"), i("auto")];
|
const styles = [i("static"), i("auto"), i("auto")];
|
||||||
@@ -3229,16 +3484,6 @@ describe("handleSnapshot", () => {
|
|||||||
];
|
];
|
||||||
const send = vi.fn(async (_tabId: number, method: string) => {
|
const send = vi.fn(async (_tabId: number, method: string) => {
|
||||||
if (method === "Page.getLayoutMetrics") return VP_METRICS;
|
if (method === "Page.getLayoutMetrics") return VP_METRICS;
|
||||||
if (ownerGeometry !== "unavailable") {
|
|
||||||
if (method === "DOM.getBoxModel") {
|
|
||||||
const x = ownerGeometry === "clipped" ? 10000 : 100;
|
|
||||||
return { model: { content: [x, 100, x + 400, 100, x + 400, 400, x, 400] } };
|
|
||||||
}
|
|
||||||
if (method === "DOM.resolveNode") return { object: { objectId: "owner" } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return { result: { value: { width: 400, height: 300 } } };
|
|
||||||
if (method === "Runtime.releaseObject") return {};
|
|
||||||
}
|
|
||||||
if (method === "DOMSnapshot.enable" || method === "Accessibility.enable") return {};
|
if (method === "DOMSnapshot.enable" || method === "Accessibility.enable") return {};
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Accessibility.getFullAXTree") return { nodes: mainAx };
|
if (method === "Accessibility.getFullAXTree") return { nodes: mainAx };
|
||||||
@@ -3479,43 +3724,6 @@ describe("handleSnapshot", () => {
|
|||||||
expect(result.text).toContain("•••");
|
expect(result.text).toContain("•••");
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
|
||||||
undefined,
|
|
||||||
100,
|
|
||||||
0,
|
|
||||||
])("reports unavailable iframe geometry within the observation budget %s", async (maxTokens) => {
|
|
||||||
const result = await captureVomObservation(makeFrameAwareDeps().cdp, 4, "https://example.com", {
|
|
||||||
maxTokens,
|
|
||||||
});
|
|
||||||
expect(result.text.match(/@warning/g)).toHaveLength(1);
|
|
||||||
expect(result.text).toContain("iframe geometry incomplete");
|
|
||||||
expect(result.text.startsWith("@vom 1\n")).toBe(true);
|
|
||||||
if (maxTokens === undefined) {
|
|
||||||
expect(result.truncated).toBe(false);
|
|
||||||
expect(result.text).toContain("Frame action");
|
|
||||||
expect(result.matchNodes.find((node) => node.backendNodeId === 22)).toMatchObject({
|
|
||||||
rect: null,
|
|
||||||
localRect: { x: 20, y: 30, w: 120, h: 40 },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (maxTokens === 100) expect(Math.ceil(result.text.length / 4)).toBeLessThanOrEqual(maxTokens);
|
|
||||||
});
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
"available",
|
|
||||||
"clipped",
|
|
||||||
] as const)("does not report successful %s geometry as an observation failure", async (ownerGeometry) => {
|
|
||||||
const result = await captureVomObservation(
|
|
||||||
makeFrameAwareDeps(ownerGeometry).cdp,
|
|
||||||
4,
|
|
||||||
"https://example.com",
|
|
||||||
);
|
|
||||||
expect(result.text).not.toContain("@warning");
|
|
||||||
const node = result.matchNodes.find((item) => item.backendNodeId === 22);
|
|
||||||
if (ownerGeometry === "clipped") expect(node?.rect).toBeNull();
|
|
||||||
else expect(node?.rect).toEqual({ x: 120, y: 130, w: 120, h: 40 });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("keeps frames and rendered refs on the same frame identity", async () => {
|
it("keeps frames and rendered refs on the same frame identity", async () => {
|
||||||
const deps = makeFrameAwareDeps();
|
const deps = makeFrameAwareDeps();
|
||||||
|
|
||||||
|
|||||||
@@ -278,12 +278,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(),
|
||||||
@@ -292,6 +303,7 @@ 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);
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
|
|||||||
@@ -24,10 +24,16 @@ describe("lookupSnapshotRef", () => {
|
|||||||
expect(lookupSnapshotRef(ctx, "@e3", 4)).toEqual({
|
expect(lookupSnapshotRef(ctx, "@e3", 4)).toEqual({
|
||||||
backendNodeId: 1234,
|
backendNodeId: 1234,
|
||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
|
kind: "dom",
|
||||||
|
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",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
|
generation: 0,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -53,6 +59,8 @@ describe("resolveSnapshotRef", () => {
|
|||||||
tabId: 4,
|
tabId: 4,
|
||||||
frameId: "child-frame",
|
frameId: "child-frame",
|
||||||
cdpSessionId: "child-session",
|
cdpSessionId: "child-session",
|
||||||
|
kind: "dom",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
});
|
});
|
||||||
|
|
||||||
const expected = {
|
const expected = {
|
||||||
@@ -60,6 +68,9 @@ describe("resolveSnapshotRef", () => {
|
|||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
frameId: "child-frame",
|
frameId: "child-frame",
|
||||||
cdpSessionId: "child-session",
|
cdpSessionId: "child-session",
|
||||||
|
kind: "dom" 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);
|
||||||
@@ -105,6 +116,29 @@ describe("resolveSnapshotRef", () => {
|
|||||||
expect(resolveSnapshotRef(ctx, "@e3", 4)).toEqual({
|
expect(resolveSnapshotRef(ctx, "@e3", 4)).toEqual({
|
||||||
backendNodeId: 1234,
|
backendNodeId: 1234,
|
||||||
refKey: "e3",
|
refKey: "e3",
|
||||||
|
kind: "dom",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
|
generation: 0,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects an operation outside the ref's declared capabilities", async () => {
|
||||||
|
const sm = new SessionManager({ agentWindow: fakeAgentWindow([100]) });
|
||||||
|
const ctx = await sm.start("aa11");
|
||||||
|
ctx.refStore.set("e3", 1234, {
|
||||||
|
tabId: 4,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(resolveSnapshotRef(ctx, "@e3", 4, "interact")).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
message: "ref @e3 does not support interact",
|
||||||
|
data: {
|
||||||
|
reason: "ref_capability_denied",
|
||||||
|
required_capability: "interact",
|
||||||
|
kind: "surface",
|
||||||
|
},
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -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,306 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { SessionManager } from "@/session-manager/manager";
|
||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
import {
|
||||||
|
captureSurfaceEnvironment,
|
||||||
|
resolveSurfacePointerTarget,
|
||||||
|
SURFACE_POINTER_MOVE_SETTLE_MS,
|
||||||
|
} from "../surface-target";
|
||||||
|
|
||||||
|
function fakeAgentWindow() {
|
||||||
|
return {
|
||||||
|
create: vi.fn(async () => 100),
|
||||||
|
remove: vi.fn(async () => {}),
|
||||||
|
ensureActiveTab: vi.fn(async () => 1),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeBrowser() {
|
||||||
|
let loaderId = "loader-1";
|
||||||
|
let pageY = 0;
|
||||||
|
let quad = [10, 20, 110, 20, 110, 60, 10, 60];
|
||||||
|
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;
|
||||||
|
throw new Error(`unexpected CDP call ${method}`);
|
||||||
|
}) as CdpRunner["send"],
|
||||||
|
trackSessionTab: vi.fn(),
|
||||||
|
};
|
||||||
|
return {
|
||||||
|
cdp,
|
||||||
|
sent,
|
||||||
|
setLoaderId: (value: string) => {
|
||||||
|
loaderId = value;
|
||||||
|
},
|
||||||
|
setPageY: (value: number) => {
|
||||||
|
pageY = value;
|
||||||
|
},
|
||||||
|
setQuad: (value: number[]) => {
|
||||||
|
quad = value;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
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 {
|
||||||
|
ref: "@e3",
|
||||||
|
captureId,
|
||||||
|
imageX: 50,
|
||||||
|
imageY: 20,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("Surface screenshot-bound pointer target", () => {
|
||||||
|
it("maps one fresh capture coordinate without executing an action", async () => {
|
||||||
|
const { context, browser, capture } = await setupCapture();
|
||||||
|
const result = await resolveSurfacePointerTarget(
|
||||||
|
context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
pointParams(capture.id),
|
||||||
|
{ cdp: browser.cdp },
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in result) throw new Error(JSON.stringify(result));
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
usedRef: "e3",
|
||||||
|
point: { x: 35, y: 30 },
|
||||||
|
moveSettleMs: SURFACE_POINTER_MOVE_SETTLE_MS,
|
||||||
|
capture: { id: capture.id, imageX: 50, imageY: 20 },
|
||||||
|
});
|
||||||
|
expect(browser.sent.some((call) => call.method === "Input.dispatchMouseEvent")).toBe(false);
|
||||||
|
|
||||||
|
const repeated = await resolveSurfacePointerTarget(
|
||||||
|
context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
pointParams(capture.id),
|
||||||
|
{ cdp: browser.cdp },
|
||||||
|
);
|
||||||
|
expect(repeated).toMatchObject({
|
||||||
|
code: "permission_denied",
|
||||||
|
data: { reason: "surface_capture_consumed" },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a new observation generation before sending input", async () => {
|
||||||
|
const { 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 resolveSurfacePointerTarget(
|
||||||
|
context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
pointParams(capture.id),
|
||||||
|
{ cdp: browser.cdp },
|
||||||
|
);
|
||||||
|
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 { context, browser, capture } = await setupCapture();
|
||||||
|
mutate(browser);
|
||||||
|
const result = await resolveSurfacePointerTarget(
|
||||||
|
context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
pointParams(capture.id),
|
||||||
|
{ cdp: browser.cdp },
|
||||||
|
);
|
||||||
|
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 coordinate validation fails", async () => {
|
||||||
|
const invalid = await setupCapture();
|
||||||
|
const outside = await resolveSurfacePointerTarget(
|
||||||
|
invalid.context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
{ ...pointParams(invalid.capture.id), imageX: 200 },
|
||||||
|
{ cdp: invalid.browser.cdp },
|
||||||
|
);
|
||||||
|
expect(outside).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
data: { reason: "surface_coordinate_invalid" },
|
||||||
|
});
|
||||||
|
expect(
|
||||||
|
await resolveSurfacePointerTarget(
|
||||||
|
invalid.context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
pointParams(invalid.capture.id),
|
||||||
|
{ cdp: invalid.browser.cdp },
|
||||||
|
),
|
||||||
|
).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 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 resolveSurfacePointerTarget(
|
||||||
|
context,
|
||||||
|
{ tabId: 4 },
|
||||||
|
{
|
||||||
|
ref: "@e3",
|
||||||
|
captureId: capture.id,
|
||||||
|
imageX: 100,
|
||||||
|
imageY: 40,
|
||||||
|
},
|
||||||
|
{ cdp },
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("code" in result) throw new Error(JSON.stringify(result));
|
||||||
|
expect(result).toMatchObject({ point: { x: 170, y: 130 } });
|
||||||
|
expect(sent.some((call) => call.method === "Input.dispatchMouseEvent")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,21 +1,24 @@
|
|||||||
import { type CdpTarget, cdpTargetKey } from "@/browser-driver/frame-graph";
|
import { type CdpFrame, type CdpFrameGraph, type CdpTarget } from "@/browser-driver/frame-graph";
|
||||||
import type { RpcError } from "@/transport/types";
|
import type { RpcError } from "@/transport/types";
|
||||||
import { nodeContentRegion, scrollNodeIntoView } from "./element-geometry";
|
import { nodeContentRegion, scrollNodeIntoView } from "./element-geometry";
|
||||||
import {
|
import {
|
||||||
clipPolygon,
|
clipPolygon,
|
||||||
|
type GeometryProjection,
|
||||||
type Point,
|
type Point,
|
||||||
type Polygon,
|
type Polygon,
|
||||||
|
type ProjectiveEdge,
|
||||||
|
parseCdpQuad,
|
||||||
polygonArea,
|
polygonArea,
|
||||||
polygonCentroid,
|
polygonCentroid,
|
||||||
projectRegionToViewport,
|
projectRegionToViewport,
|
||||||
|
type Quad,
|
||||||
type Region,
|
type Region,
|
||||||
rectPolygon,
|
rectPolygon,
|
||||||
regionBounds,
|
regionBounds,
|
||||||
|
type Size,
|
||||||
type ViewportRect,
|
type ViewportRect,
|
||||||
} from "./geometry";
|
} from "./geometry";
|
||||||
import type { CssViewport } from "./geometry/coordinate-types";
|
import { type CdpRunner, cdpRunnerForTarget, isRpcError, sendToCdpTarget } from "./shared";
|
||||||
import { cssViewport, GeometryContext } from "./geometry/frame-context";
|
|
||||||
import { type CdpRunner, cdpRunnerForTarget, isRpcError } from "./shared";
|
|
||||||
|
|
||||||
export interface NodeAddress {
|
export interface NodeAddress {
|
||||||
target: CdpTarget;
|
target: CdpTarget;
|
||||||
@@ -24,8 +27,6 @@ export interface NodeAddress {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface ResolvedNodeGeometry {
|
export interface ResolvedNodeGeometry {
|
||||||
/** The same top-level measurement used by projection, for screenshot coordinate adaptation. */
|
|
||||||
topViewport: CssViewport;
|
|
||||||
topVisibleRegions: Region;
|
topVisibleRegions: Region;
|
||||||
topBounds: ViewportRect;
|
topBounds: ViewportRect;
|
||||||
/** Point in the top-level tab viewport, used by root-target input events. */
|
/** Point in the top-level tab viewport, used by root-target input events. */
|
||||||
@@ -38,16 +39,145 @@ function geometryError(message: string): RpcError {
|
|||||||
return { code: "cdp_failed", message };
|
return { code: "cdp_failed", message };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function frameMap(graph: CdpFrameGraph): Map<string, CdpFrame> {
|
||||||
|
return new Map(graph.frames.map((frame) => [frame.frameId, frame]));
|
||||||
|
}
|
||||||
|
|
||||||
|
function targetRootFrame(byId: Map<string, CdpFrame>, frame: CdpFrame): CdpFrame | null {
|
||||||
|
const seen = new Set<string>();
|
||||||
|
let current = frame;
|
||||||
|
while (current.parentFrameId) {
|
||||||
|
if (seen.has(current.frameId)) return null;
|
||||||
|
seen.add(current.frameId);
|
||||||
|
const parent = byId.get(current.parentFrameId);
|
||||||
|
if (!parent || parent.target.sessionId !== current.target.sessionId) break;
|
||||||
|
current = parent;
|
||||||
|
}
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
|
||||||
|
function frameAncestry(graph: CdpFrameGraph, frameId: string): CdpFrame[] | null {
|
||||||
|
const byId = frameMap(graph);
|
||||||
|
const path: CdpFrame[] = [];
|
||||||
|
const seen = new Set<string>();
|
||||||
|
let current = byId.get(frameId);
|
||||||
|
if (!current) return null;
|
||||||
|
while (current.parentFrameId) {
|
||||||
|
if (seen.has(current.frameId)) return null;
|
||||||
|
seen.add(current.frameId);
|
||||||
|
path.push(current);
|
||||||
|
const parent = byId.get(current.parentFrameId);
|
||||||
|
if (!parent) return null;
|
||||||
|
current = parent;
|
||||||
|
}
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function targetViewport(cdp: CdpRunner, target: CdpTarget): Promise<Size | null> {
|
||||||
|
const metrics = await sendToCdpTarget<{
|
||||||
|
cssLayoutViewport?: { clientWidth?: number; clientHeight?: number };
|
||||||
|
layoutViewport?: { clientWidth?: number; clientHeight?: number };
|
||||||
|
}>(cdp, target, "Page.getLayoutMetrics", {});
|
||||||
|
const viewport = metrics.cssLayoutViewport ?? metrics.layoutViewport ?? {};
|
||||||
|
const width = viewport.clientWidth ?? 0;
|
||||||
|
const height = viewport.clientHeight ?? 0;
|
||||||
|
return width > 0 && height > 0 ? { width, height } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ownerContentQuad(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
parent: CdpFrame,
|
||||||
|
ownerBackendNodeId: number,
|
||||||
|
): Promise<Quad | null> {
|
||||||
|
const result = await sendToCdpTarget<{ model?: { content?: number[] } }>(
|
||||||
|
cdp,
|
||||||
|
parent.target,
|
||||||
|
"DOM.getBoxModel",
|
||||||
|
{ backendNodeId: ownerBackendNodeId },
|
||||||
|
);
|
||||||
|
return parseCdpQuad(result.model?.content);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function sameTargetFrameClips(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
byId: Map<string, CdpFrame>,
|
||||||
|
frame: CdpFrame,
|
||||||
|
targetRoot: CdpFrame,
|
||||||
|
): Promise<Polygon[] | null> {
|
||||||
|
const clips: Polygon[] = [];
|
||||||
|
let current = frame;
|
||||||
|
const seen = new Set<string>();
|
||||||
|
while (current.frameId !== targetRoot.frameId) {
|
||||||
|
if (seen.has(current.frameId) || !current.parentFrameId) return null;
|
||||||
|
seen.add(current.frameId);
|
||||||
|
const parent = byId.get(current.parentFrameId);
|
||||||
|
if (!parent || current.ownerBackendNodeId === undefined) return null;
|
||||||
|
const clip = await ownerContentQuad(cdp, parent, current.ownerBackendNodeId);
|
||||||
|
if (!clip) return null;
|
||||||
|
clips.push(clip);
|
||||||
|
current = parent;
|
||||||
|
}
|
||||||
|
return clips;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function resolveFrameProjection(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
graph: CdpFrameGraph,
|
||||||
|
frameId: string,
|
||||||
|
): Promise<GeometryProjection | null> {
|
||||||
|
const byId = frameMap(graph);
|
||||||
|
const frame = byId.get(frameId);
|
||||||
|
if (!frame) return null;
|
||||||
|
let targetRoot = targetRootFrame(byId, frame);
|
||||||
|
if (!targetRoot) return null;
|
||||||
|
const sourceViewport = await targetViewport(cdp, targetRoot.target);
|
||||||
|
if (!sourceViewport) return null;
|
||||||
|
const sourceClips = await sameTargetFrameClips(cdp, byId, frame, targetRoot);
|
||||||
|
if (!sourceClips) return null;
|
||||||
|
|
||||||
|
const edges: ProjectiveEdge[] = [];
|
||||||
|
while (targetRoot.parentFrameId) {
|
||||||
|
const parent = byId.get(targetRoot.parentFrameId);
|
||||||
|
if (!parent || targetRoot.ownerBackendNodeId === undefined) return null;
|
||||||
|
const destinationQuad = await ownerContentQuad(cdp, parent, targetRoot.ownerBackendNodeId);
|
||||||
|
if (!destinationQuad) return null;
|
||||||
|
const source =
|
||||||
|
edges.length === 0 ? sourceViewport : await targetViewport(cdp, targetRoot.target);
|
||||||
|
if (!source) return null;
|
||||||
|
const parentTargetRoot = targetRootFrame(byId, parent);
|
||||||
|
if (!parentTargetRoot) return null;
|
||||||
|
const destinationClips = await sameTargetFrameClips(cdp, byId, parent, parentTargetRoot);
|
||||||
|
if (!destinationClips) return null;
|
||||||
|
edges.push({ sourceViewport: source, destinationQuad, destinationClips });
|
||||||
|
targetRoot = parentTargetRoot;
|
||||||
|
}
|
||||||
|
|
||||||
|
const topViewport =
|
||||||
|
edges.length === 0 ? sourceViewport : await targetViewport(cdp, targetRoot.target);
|
||||||
|
return topViewport ? { sourceClips, edges, topViewport } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function loadFrameGraph(cdp: CdpRunner, tabId: number): Promise<CdpFrameGraph | null> {
|
||||||
|
if (!cdp.getFrameGraph) return null;
|
||||||
|
try {
|
||||||
|
return await cdp.getFrameGraph(tabId);
|
||||||
|
} catch (error) {
|
||||||
|
console.debug("[bsk frame-geometry] frame graph resolution failed", error);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function scrollFrameOwners(
|
async function scrollFrameOwners(
|
||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
context: GeometryContext,
|
graph: CdpFrameGraph,
|
||||||
frameId: string,
|
frameId: string,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
const ancestry = await context.ancestry(frameId);
|
const byId = frameMap(graph);
|
||||||
|
const ancestry = frameAncestry(graph, frameId);
|
||||||
if (!ancestry) return geometryError(`could not resolve frame ancestry for ${frameId}`);
|
if (!ancestry) return geometryError(`could not resolve frame ancestry for ${frameId}`);
|
||||||
for (const child of [...ancestry].reverse()) {
|
for (const child of [...ancestry].reverse()) {
|
||||||
const parent = child.parentFrameId ? await context.frame(child.parentFrameId) : undefined;
|
const parent = child.parentFrameId ? byId.get(child.parentFrameId) : undefined;
|
||||||
if (!parent || child.ownerBackendNodeId === undefined) {
|
if (!parent || child.ownerBackendNodeId === undefined) {
|
||||||
return geometryError(`could not resolve frame owner for ${child.frameId}`);
|
return geometryError(`could not resolve frame owner for ${child.frameId}`);
|
||||||
}
|
}
|
||||||
@@ -61,20 +191,17 @@ async function scrollFrameOwners(
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function scrollElementWithContext(
|
async function scrollElementWithFrameGraph(
|
||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
target: CdpTarget,
|
target: CdpTarget,
|
||||||
backendNodeId: number,
|
backendNodeId: number,
|
||||||
frameId: string | undefined,
|
frameId: string | undefined,
|
||||||
context: GeometryContext,
|
graph: CdpFrameGraph | null,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
if (frameId) {
|
if (frameId) {
|
||||||
const frame = await context.frame(frameId);
|
if (!graph) return geometryError(`could not resolve frame graph for ${frameId}`);
|
||||||
if (!frame || cdpTargetKey(frame.target) !== cdpTargetKey(target)) {
|
const error = await scrollFrameOwners(cdp, tabId, graph, frameId);
|
||||||
return geometryError("node frame does not belong to its target");
|
|
||||||
}
|
|
||||||
const error = await scrollFrameOwners(cdp, tabId, context, frameId);
|
|
||||||
if (error) return error;
|
if (error) return error;
|
||||||
} else if (target.sessionId) {
|
} else if (target.sessionId) {
|
||||||
return geometryError("an OOPIF node address requires frameId");
|
return geometryError("an OOPIF node address requires frameId");
|
||||||
@@ -89,15 +216,8 @@ export async function scrollElementAndFramesIntoView(
|
|||||||
backendNodeId: number,
|
backendNodeId: number,
|
||||||
frameId?: string,
|
frameId?: string,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
if (target.tabId !== tabId) return geometryError("node target belongs to another tab");
|
const graph = frameId ? await loadFrameGraph(cdp, tabId) : null;
|
||||||
return scrollElementWithContext(
|
return scrollElementWithFrameGraph(cdp, tabId, target, backendNodeId, frameId, graph);
|
||||||
cdp,
|
|
||||||
tabId,
|
|
||||||
target,
|
|
||||||
backendNodeId,
|
|
||||||
frameId,
|
|
||||||
new GeometryContext(cdp, tabId),
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function largestRegion(regions: Region): Polygon | null {
|
function largestRegion(regions: Region): Polygon | null {
|
||||||
@@ -120,32 +240,23 @@ export async function resolveNodeGeometry(
|
|||||||
if (address.target.sessionId && !address.frameId) {
|
if (address.target.sessionId && !address.frameId) {
|
||||||
return geometryError("an OOPIF node address requires frameId");
|
return geometryError("an OOPIF node address requires frameId");
|
||||||
}
|
}
|
||||||
if (address.target.tabId !== tabId) return geometryError("node target belongs to another tab");
|
const graph = address.frameId ? await loadFrameGraph(cdp, tabId) : null;
|
||||||
const context = new GeometryContext(cdp, tabId);
|
|
||||||
const graph = address.frameId ? await context.graph() : null;
|
|
||||||
if (address.frameId && graph) {
|
|
||||||
const frame = await context.frame(address.frameId);
|
|
||||||
if (!frame || cdpTargetKey(frame.target) !== cdpTargetKey(address.target)) {
|
|
||||||
return geometryError("node frame does not belong to its target");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (address.frameId && !graph) {
|
if (address.frameId && !graph) {
|
||||||
return geometryError(`could not resolve frame graph for ${address.frameId}`);
|
return geometryError(`could not resolve frame graph for ${address.frameId}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (options.scrollIntoView) {
|
if (options.scrollIntoView) {
|
||||||
const scrollError = await scrollElementWithContext(
|
const scrollError = await scrollElementWithFrameGraph(
|
||||||
cdp,
|
cdp,
|
||||||
tabId,
|
tabId,
|
||||||
address.target,
|
address.target,
|
||||||
address.backendNodeId,
|
address.backendNodeId,
|
||||||
address.frameId,
|
address.frameId,
|
||||||
context,
|
graph,
|
||||||
);
|
);
|
||||||
if (scrollError) return scrollError;
|
if (scrollError) return scrollError;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Only topology was read above. Begin live measurements after scrolling.
|
|
||||||
const localRegion = await nodeContentRegion(
|
const localRegion = await nodeContentRegion(
|
||||||
cdpRunnerForTarget(cdp, address.target),
|
cdpRunnerForTarget(cdp, address.target),
|
||||||
tabId,
|
tabId,
|
||||||
@@ -156,7 +267,7 @@ export async function resolveNodeGeometry(
|
|||||||
let topVisibleRegions: Region;
|
let topVisibleRegions: Region;
|
||||||
let targetActionPoint: Point | null = null;
|
let targetActionPoint: Point | null = null;
|
||||||
if (address.frameId && graph) {
|
if (address.frameId && graph) {
|
||||||
const projection = await context.targetProjection(address.frameId);
|
const projection = await resolveFrameProjection(cdp, graph, address.frameId);
|
||||||
if (!projection)
|
if (!projection)
|
||||||
return geometryError(`could not resolve frame geometry for ${address.frameId}`);
|
return geometryError(`could not resolve frame geometry for ${address.frameId}`);
|
||||||
topVisibleRegions = projectRegionToViewport(localRegion, projection);
|
topVisibleRegions = projectRegionToViewport(localRegion, projection);
|
||||||
@@ -179,7 +290,7 @@ export async function resolveNodeGeometry(
|
|||||||
targetActionPoint = localActionRegion ? polygonCentroid(localActionRegion) : null;
|
targetActionPoint = localActionRegion ? polygonCentroid(localActionRegion) : null;
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
const viewport = await context.viewport(address.target);
|
const viewport = await targetViewport(cdp, address.target);
|
||||||
if (!viewport) return geometryError("could not resolve top viewport geometry");
|
if (!viewport) return geometryError("could not resolve top viewport geometry");
|
||||||
topVisibleRegions = localRegion
|
topVisibleRegions = localRegion
|
||||||
.map((polygon) =>
|
.map((polygon) =>
|
||||||
@@ -198,13 +309,7 @@ export async function resolveNodeGeometry(
|
|||||||
return { code: "permission_denied", message: "element not visible in its target" };
|
return { code: "permission_denied", message: "element not visible in its target" };
|
||||||
}
|
}
|
||||||
targetActionPoint ??= actionPoint;
|
targetActionPoint ??= actionPoint;
|
||||||
return {
|
return { topVisibleRegions, topBounds, actionPoint, targetActionPoint };
|
||||||
topVisibleRegions,
|
|
||||||
topBounds,
|
|
||||||
actionPoint,
|
|
||||||
targetActionPoint,
|
|
||||||
topViewport: cssViewport(await context.layoutMetrics({ tabId })),
|
|
||||||
};
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
return geometryError(error instanceof Error ? error.message : String(error));
|
return geometryError(error instanceof Error ? error.message : String(error));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -245,3 +245,22 @@ export function projectRectToViewport(
|
|||||||
if (!rect) return null;
|
if (!rect) return null;
|
||||||
return regionBounds(projectRegionToViewport([rectPolygon(rect)], projection));
|
return regionBounds(projectRegionToViewport([rectPolygon(rect)], projection));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function childFrameProjection(
|
||||||
|
parent: GeometryProjection,
|
||||||
|
ownerRectInParent: { x: number; y: number; w: number; h: number },
|
||||||
|
): GeometryProjection {
|
||||||
|
const destinationQuad = rectPolygon(ownerRectInParent);
|
||||||
|
return {
|
||||||
|
sourceClips: [],
|
||||||
|
edges: [
|
||||||
|
{
|
||||||
|
sourceViewport: { width: ownerRectInParent.w, height: ownerRectInParent.h },
|
||||||
|
destinationQuad,
|
||||||
|
destinationClips: parent.sourceClips,
|
||||||
|
},
|
||||||
|
...parent.edges,
|
||||||
|
],
|
||||||
|
topViewport: parent.topViewport,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,102 +0,0 @@
|
|||||||
import { type CdpTarget, cdpTargetKey } from "@/browser-driver/frame-graph";
|
|
||||||
import type { GeometryProjection, ViewportRect } from "../geometry";
|
|
||||||
import { projectRectToViewport } from "../geometry";
|
|
||||||
|
|
||||||
export interface CoordinateOwner {
|
|
||||||
target: CdpTarget;
|
|
||||||
frameId?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface FrameViewportRect {
|
|
||||||
space: "frame-viewport-css";
|
|
||||||
owner: CoordinateOwner;
|
|
||||||
rect: ViewportRect;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface SnapshotProjection {
|
|
||||||
source: CoordinateOwner;
|
|
||||||
geometry: GeometryProjection;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A failed owner read is different from a successfully projected, clipped-out rect. */
|
|
||||||
export interface UnavailableFrameProjection {
|
|
||||||
status: "unavailable";
|
|
||||||
source: CoordinateOwner;
|
|
||||||
ownerBackendNodeId: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type SnapshotProjectionResult =
|
|
||||||
| { status: "available"; projection: SnapshotProjection }
|
|
||||||
| UnavailableFrameProjection;
|
|
||||||
|
|
||||||
/** Descendants inherit the failed boundary without attempting another owner read. */
|
|
||||||
export type FrameProjectionIssue =
|
|
||||||
| UnavailableFrameProjection
|
|
||||||
| { status: "blocked"; source: CoordinateOwner; cause: UnavailableFrameProjection };
|
|
||||||
|
|
||||||
export type FrameProjectionState = SnapshotProjectionResult | FrameProjectionIssue;
|
|
||||||
|
|
||||||
/** DOMSnapshot bounds are document-relative CSS pixels, independent of raster DPR. */
|
|
||||||
export function snapshotViewportRect(
|
|
||||||
bounds: number[],
|
|
||||||
owner: CoordinateOwner,
|
|
||||||
scroll: { x: number; y: number },
|
|
||||||
): FrameViewportRect | null {
|
|
||||||
if (bounds.length < 4 || !bounds.slice(0, 4).every(Number.isFinite)) return null;
|
|
||||||
const [x, y, width, height] = bounds;
|
|
||||||
if (width <= 0 || height <= 0 || !Number.isFinite(scroll.x) || !Number.isFinite(scroll.y)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
space: "frame-viewport-css",
|
|
||||||
owner,
|
|
||||||
rect: { x: x - scroll.x, y: y - scroll.y, width, height },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function projectSnapshotRect(
|
|
||||||
input: FrameViewportRect,
|
|
||||||
projection: SnapshotProjection,
|
|
||||||
): ViewportRect | null {
|
|
||||||
if (
|
|
||||||
input.owner.frameId !== projection.source.frameId ||
|
|
||||||
cdpTargetKey(input.owner.target) !== cdpTargetKey(projection.source.target)
|
|
||||||
) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
const { x, y, width: w, height: h } = input.rect;
|
|
||||||
return projectRectToViewport({ x, y, w, h }, projection.geometry);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** CSS viewport metadata; browser zoom is distinct from raster devicePixelRatio. */
|
|
||||||
export interface CssViewport {
|
|
||||||
width: number;
|
|
||||||
height: number;
|
|
||||||
scrollX: number;
|
|
||||||
scrollY: number;
|
|
||||||
cssToDip: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Page.captureScreenshot takes page-relative DIP, not viewport-relative CSS pixels. */
|
|
||||||
export function screenshotPageRect(
|
|
||||||
rect: ViewportRect,
|
|
||||||
viewport: CssViewport,
|
|
||||||
): { space: "page-dip"; rect: ViewportRect } | null {
|
|
||||||
const { cssToDip, scrollX, scrollY } = viewport;
|
|
||||||
if (
|
|
||||||
![rect.x, rect.y, rect.width, rect.height, cssToDip, scrollX, scrollY].every(Number.isFinite) ||
|
|
||||||
cssToDip <= 0 ||
|
|
||||||
rect.width <= 0 ||
|
|
||||||
rect.height <= 0
|
|
||||||
)
|
|
||||||
return null;
|
|
||||||
return {
|
|
||||||
space: "page-dip",
|
|
||||||
rect: {
|
|
||||||
x: (rect.x + scrollX) * cssToDip,
|
|
||||||
y: (rect.y + scrollY) * cssToDip,
|
|
||||||
width: rect.width * cssToDip,
|
|
||||||
height: rect.height * cssToDip,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,333 +0,0 @@
|
|||||||
import {
|
|
||||||
type CdpFrame,
|
|
||||||
type CdpFrameGraph,
|
|
||||||
type CdpTarget,
|
|
||||||
cdpTargetKey,
|
|
||||||
} from "@/browser-driver/frame-graph";
|
|
||||||
import {
|
|
||||||
type GeometryProjection,
|
|
||||||
type Polygon,
|
|
||||||
type ProjectiveEdge,
|
|
||||||
parseCdpQuad,
|
|
||||||
type Quad,
|
|
||||||
type Size,
|
|
||||||
} from "../geometry";
|
|
||||||
import { type CdpRunner, sendToCdpTarget } from "../shared";
|
|
||||||
import type { CoordinateOwner, CssViewport, SnapshotProjectionResult } from "./coordinate-types";
|
|
||||||
|
|
||||||
import { readSnapshotOwnerSizes } from "./snapshot-owner-sizes";
|
|
||||||
|
|
||||||
export interface LayoutMetrics {
|
|
||||||
cssVisualViewport?: { zoom?: number };
|
|
||||||
visualViewport?: { zoom?: number };
|
|
||||||
cssLayoutViewport?: {
|
|
||||||
clientWidth?: number;
|
|
||||||
clientHeight?: number;
|
|
||||||
pageX?: number;
|
|
||||||
pageY?: number;
|
|
||||||
};
|
|
||||||
layoutViewport?: { clientWidth?: number; clientHeight?: number; pageX?: number; pageY?: number };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The legacy field is a compatibility fallback, never a source of raster DPR. */
|
|
||||||
export function cssViewport(metrics: LayoutMetrics): CssViewport {
|
|
||||||
const value = metrics.cssLayoutViewport ?? metrics.layoutViewport;
|
|
||||||
return {
|
|
||||||
width: value?.clientWidth ?? 0,
|
|
||||||
height: value?.clientHeight ?? 0,
|
|
||||||
scrollX: value?.pageX ?? 0,
|
|
||||||
scrollY: value?.pageY ?? 0,
|
|
||||||
cssToDip: metrics.cssVisualViewport?.zoom ?? metrics.visualViewport?.zoom ?? 1,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/** One read-only measurement phase. Discard after scrolling or any later operation. */
|
|
||||||
export class GeometryContext {
|
|
||||||
private readonly metrics = new Map<string, Promise<LayoutMetrics>>();
|
|
||||||
private readonly owners = new Map<string, Promise<Quad | null>>();
|
|
||||||
private readonly projections = new Map<string, Promise<GeometryProjection | null>>();
|
|
||||||
private readonly snapshotOwners = new Map<string, Promise<{ quad: Quad; size: Size } | null>>();
|
|
||||||
private readonly sizeBatches = new Map<string, () => Promise<Map<number, Size>>>();
|
|
||||||
private active = 0;
|
|
||||||
private readonly waiting: Array<() => void> = [];
|
|
||||||
private graphPromise?: Promise<CdpFrameGraph | null>;
|
|
||||||
private framesPromise?: Promise<Map<string, CdpFrame>>;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private readonly cdp: CdpRunner,
|
|
||||||
private readonly tabId: number,
|
|
||||||
graph?: CdpFrameGraph,
|
|
||||||
private readonly signal?: AbortSignal,
|
|
||||||
) {
|
|
||||||
if (graph) this.graphPromise = Promise.resolve(graph);
|
|
||||||
}
|
|
||||||
|
|
||||||
private async request<T>(
|
|
||||||
target: CdpTarget,
|
|
||||||
method: string,
|
|
||||||
params: object,
|
|
||||||
cleanup = false,
|
|
||||||
): Promise<T> {
|
|
||||||
if (!cleanup && this.signal?.aborted) throw new DOMException("geometry aborted", "AbortError");
|
|
||||||
if (this.active >= 4) await new Promise<void>((resolve) => this.waiting.push(resolve));
|
|
||||||
else this.active++;
|
|
||||||
try {
|
|
||||||
if (!cleanup && this.signal?.aborted)
|
|
||||||
throw new DOMException("geometry aborted", "AbortError");
|
|
||||||
return await sendToCdpTarget<T>(this.cdp, target, method, params);
|
|
||||||
} finally {
|
|
||||||
const next = this.waiting.shift();
|
|
||||||
if (next) next();
|
|
||||||
else this.active--;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
graph(): Promise<CdpFrameGraph | null> {
|
|
||||||
this.graphPromise ??=
|
|
||||||
this.cdp.getFrameGraph?.(this.tabId).catch(() => null) ?? Promise.resolve(null);
|
|
||||||
return this.graphPromise;
|
|
||||||
}
|
|
||||||
|
|
||||||
private frames(): Promise<Map<string, CdpFrame>> {
|
|
||||||
this.framesPromise ??= this.graph().then(
|
|
||||||
(graph) => new Map(graph?.frames.map((frame) => [frame.frameId, frame]) ?? []),
|
|
||||||
);
|
|
||||||
return this.framesPromise;
|
|
||||||
}
|
|
||||||
|
|
||||||
async frame(frameId: string): Promise<CdpFrame | undefined> {
|
|
||||||
return (await this.frames()).get(frameId);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Topology only: safe to resolve before the caller scrolls frame owners. */
|
|
||||||
async ancestry(frameId: string): Promise<CdpFrame[] | null> {
|
|
||||||
const frames = await this.frames();
|
|
||||||
const path: CdpFrame[] = [];
|
|
||||||
const seen = new Set<string>();
|
|
||||||
let current = frames.get(frameId);
|
|
||||||
if (!current) return null;
|
|
||||||
while (current.parentFrameId) {
|
|
||||||
if (seen.has(current.frameId)) return null;
|
|
||||||
seen.add(current.frameId);
|
|
||||||
path.push(current);
|
|
||||||
const parent = frames.get(current.parentFrameId);
|
|
||||||
if (!parent) return null;
|
|
||||||
current = parent;
|
|
||||||
}
|
|
||||||
return path;
|
|
||||||
}
|
|
||||||
|
|
||||||
layoutMetrics(target: CdpTarget): Promise<LayoutMetrics> {
|
|
||||||
const key = cdpTargetKey(target);
|
|
||||||
let promise = this.metrics.get(key);
|
|
||||||
if (!promise) {
|
|
||||||
promise = this.request<LayoutMetrics>(target, "Page.getLayoutMetrics", {});
|
|
||||||
this.metrics.set(key, promise);
|
|
||||||
}
|
|
||||||
return promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
async viewport(target: CdpTarget): Promise<Size | null> {
|
|
||||||
const { width, height } = cssViewport(await this.layoutMetrics(target));
|
|
||||||
return Number.isFinite(width) && Number.isFinite(height) && width > 0 && height > 0
|
|
||||||
? { width, height }
|
|
||||||
: null;
|
|
||||||
}
|
|
||||||
|
|
||||||
ownerContent(target: CdpTarget, backendNodeId: number): Promise<Quad | null> {
|
|
||||||
const key = `${cdpTargetKey(target)}:${backendNodeId}`;
|
|
||||||
let promise = this.owners.get(key);
|
|
||||||
if (!promise) {
|
|
||||||
promise = this.request<{ model?: { content?: number[] } }>(target, "DOM.getBoxModel", {
|
|
||||||
backendNodeId,
|
|
||||||
}).then((reply) => parseCdpQuad(reply.model?.content));
|
|
||||||
this.owners.set(key, promise);
|
|
||||||
}
|
|
||||||
return promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Same-target owner quads are already target-relative, including nested owners. */
|
|
||||||
async snapshotProjection(
|
|
||||||
source: CoordinateOwner,
|
|
||||||
ownerBackendNodeId: number,
|
|
||||||
ancestorClips: Polygon[],
|
|
||||||
viewport: Size,
|
|
||||||
): Promise<SnapshotProjectionResult> {
|
|
||||||
const key = `${cdpTargetKey(source.target)}:${ownerBackendNodeId}`;
|
|
||||||
let promise = this.snapshotOwners.get(key);
|
|
||||||
if (!promise) {
|
|
||||||
promise = this.snapshotOwner(source.target, ownerBackendNodeId);
|
|
||||||
this.snapshotOwners.set(key, promise);
|
|
||||||
}
|
|
||||||
let owner: { quad: Quad; size: Size } | null;
|
|
||||||
try {
|
|
||||||
owner = await promise;
|
|
||||||
} catch (error) {
|
|
||||||
if (error && typeof error === "object" && "name" in error && error.name === "AbortError")
|
|
||||||
throw error;
|
|
||||||
console.debug("[bsk geometry] frame owner unavailable", error);
|
|
||||||
owner = null;
|
|
||||||
}
|
|
||||||
return owner
|
|
||||||
? {
|
|
||||||
status: "available",
|
|
||||||
projection: {
|
|
||||||
source,
|
|
||||||
geometry: {
|
|
||||||
sourceClips: [],
|
|
||||||
edges: [
|
|
||||||
{
|
|
||||||
sourceViewport: owner.size,
|
|
||||||
destinationQuad: owner.quad,
|
|
||||||
destinationClips: ancestorClips,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
topViewport: viewport,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
: { status: "unavailable", source, ownerBackendNodeId };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Register one target's snapshot owners; the batch starts only when a
|
|
||||||
* projection actually needs a size. Single owners keep the cheaper old path. */
|
|
||||||
registerSnapshotOwners(target: CdpTarget, owners: ReadonlySet<number>): void {
|
|
||||||
const key = cdpTargetKey(target);
|
|
||||||
if (owners.size < 2 || this.sizeBatches.has(key)) return;
|
|
||||||
let pending: Promise<Map<number, Size>> | undefined;
|
|
||||||
this.sizeBatches.set(key, () => {
|
|
||||||
pending ??= readSnapshotOwnerSizes(
|
|
||||||
(method, params, cleanup) => this.request(target, method, params, cleanup),
|
|
||||||
owners,
|
|
||||||
).catch((error) => {
|
|
||||||
if (error && typeof error === "object" && "name" in error && error.name === "AbortError")
|
|
||||||
throw error;
|
|
||||||
return new Map<number, Size>();
|
|
||||||
});
|
|
||||||
return pending;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
private async snapshotOwner(
|
|
||||||
target: CdpTarget,
|
|
||||||
backendNodeId: number,
|
|
||||||
): Promise<{ quad: Quad; size: Size } | null> {
|
|
||||||
const quad = await this.ownerContent(target, backendNodeId);
|
|
||||||
if (!quad) return null;
|
|
||||||
const batchSize = (await this.sizeBatches.get(cdpTargetKey(target))?.())?.get(backendNodeId);
|
|
||||||
if (this.signal?.aborted) throw new DOMException("geometry aborted", "AbortError");
|
|
||||||
if (batchSize) return { quad, size: batchSize };
|
|
||||||
const resolved = await this.request<{ object?: { objectId?: string } }>(
|
|
||||||
target,
|
|
||||||
"DOM.resolveNode",
|
|
||||||
{ backendNodeId },
|
|
||||||
);
|
|
||||||
const objectId = resolved.object?.objectId;
|
|
||||||
if (!objectId) return null;
|
|
||||||
try {
|
|
||||||
const reply = await this.request<{ result?: { value?: Size }; exceptionDetails?: unknown }>(
|
|
||||||
target,
|
|
||||||
"Runtime.callFunctionOn",
|
|
||||||
{
|
|
||||||
objectId,
|
|
||||||
functionDeclaration: `function() {
|
|
||||||
if (!this.isConnected) return null;
|
|
||||||
const style = getComputedStyle(this);
|
|
||||||
return {
|
|
||||||
width: this.clientWidth - parseFloat(style.paddingLeft) - parseFloat(style.paddingRight),
|
|
||||||
height: this.clientHeight - parseFloat(style.paddingTop) - parseFloat(style.paddingBottom)
|
|
||||||
};
|
|
||||||
}`,
|
|
||||||
returnByValue: true,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
const size = reply.result?.value;
|
|
||||||
return !reply.exceptionDetails &&
|
|
||||||
size &&
|
|
||||||
Number.isFinite(size.width) &&
|
|
||||||
Number.isFinite(size.height) &&
|
|
||||||
size.width > 0 &&
|
|
||||||
size.height > 0
|
|
||||||
? { quad, size }
|
|
||||||
: null;
|
|
||||||
} finally {
|
|
||||||
// Cleanup must still run if cancellation arrived after resolving the object.
|
|
||||||
await this.request(target, "Runtime.releaseObject", { objectId }, true).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private targetRoot(frames: Map<string, CdpFrame>, frame: CdpFrame): CdpFrame | null {
|
|
||||||
const seen = new Set<string>();
|
|
||||||
let current = frame;
|
|
||||||
while (current.parentFrameId) {
|
|
||||||
if (seen.has(current.frameId)) return null;
|
|
||||||
seen.add(current.frameId);
|
|
||||||
const parent = frames.get(current.parentFrameId);
|
|
||||||
if (!parent) return null;
|
|
||||||
if (cdpTargetKey(parent.target) !== cdpTargetKey(current.target)) break;
|
|
||||||
current = parent;
|
|
||||||
}
|
|
||||||
return current;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async clips(
|
|
||||||
frames: Map<string, CdpFrame>,
|
|
||||||
frame: CdpFrame,
|
|
||||||
root: CdpFrame,
|
|
||||||
): Promise<Polygon[] | null> {
|
|
||||||
const clips: Polygon[] = [];
|
|
||||||
let current = frame;
|
|
||||||
const seen = new Set<string>();
|
|
||||||
while (current.frameId !== root.frameId) {
|
|
||||||
if (seen.has(current.frameId) || !current.parentFrameId) return null;
|
|
||||||
seen.add(current.frameId);
|
|
||||||
const parent = frames.get(current.parentFrameId);
|
|
||||||
if (!parent || current.ownerBackendNodeId === undefined) return null;
|
|
||||||
const quad = await this.ownerContent(parent.target, current.ownerBackendNodeId);
|
|
||||||
if (!quad) return null;
|
|
||||||
clips.push(quad);
|
|
||||||
current = parent;
|
|
||||||
}
|
|
||||||
return clips;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Input is already in the frame's CDP target viewport, not its local viewport. */
|
|
||||||
targetProjection(frameId: string): Promise<GeometryProjection | null> {
|
|
||||||
let promise = this.projections.get(frameId);
|
|
||||||
if (!promise) {
|
|
||||||
promise = this.buildTargetProjection(frameId);
|
|
||||||
this.projections.set(frameId, promise);
|
|
||||||
}
|
|
||||||
return promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async buildTargetProjection(frameId: string): Promise<GeometryProjection | null> {
|
|
||||||
const frames = await this.frames();
|
|
||||||
const frame = frames.get(frameId);
|
|
||||||
if (!frame) return null;
|
|
||||||
let root = this.targetRoot(frames, frame);
|
|
||||||
if (!root) return null;
|
|
||||||
const sourceViewport = await this.viewport(root.target);
|
|
||||||
if (!sourceViewport) return null;
|
|
||||||
const sourceClips = await this.clips(frames, frame, root);
|
|
||||||
if (!sourceClips) return null;
|
|
||||||
const edges: ProjectiveEdge[] = [];
|
|
||||||
const seen = new Set<string>();
|
|
||||||
while (root.parentFrameId) {
|
|
||||||
if (seen.has(root.frameId)) return null;
|
|
||||||
seen.add(root.frameId);
|
|
||||||
const parent = frames.get(root.parentFrameId);
|
|
||||||
if (!parent || root.ownerBackendNodeId === undefined) return null;
|
|
||||||
const destinationQuad = await this.ownerContent(parent.target, root.ownerBackendNodeId);
|
|
||||||
const source = await this.viewport(root.target);
|
|
||||||
const parentRoot = this.targetRoot(frames, parent);
|
|
||||||
if (!destinationQuad || !source || !parentRoot) return null;
|
|
||||||
const destinationClips = await this.clips(frames, parent, parentRoot);
|
|
||||||
if (!destinationClips) return null;
|
|
||||||
edges.push({ sourceViewport: source, destinationQuad, destinationClips });
|
|
||||||
root = parentRoot;
|
|
||||||
}
|
|
||||||
const topViewport = await this.viewport(root.target);
|
|
||||||
return topViewport ? { sourceClips, edges, topViewport } : null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
import type { Size } from "../geometry";
|
|
||||||
|
|
||||||
interface SerializedValue {
|
|
||||||
type: string;
|
|
||||||
value?: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
type Send = <T>(method: string, params: object, cleanup?: boolean) => Promise<T>;
|
|
||||||
|
|
||||||
/** Batch only accessible frame owners. Missing/shadow/cross-origin owners keep
|
|
||||||
* the existing node-scoped read; no page-wide style columns are requested. */
|
|
||||||
export async function readSnapshotOwnerSizes(
|
|
||||||
send: Send,
|
|
||||||
owners: ReadonlySet<number>,
|
|
||||||
): Promise<Map<number, Size>> {
|
|
||||||
const sizes = new Map<number, Size>();
|
|
||||||
const objectGroup = `bsk-frame-sizes-${crypto.randomUUID()}`;
|
|
||||||
try {
|
|
||||||
const reply = await send<{ result?: { deepSerializedValue?: SerializedValue } }>(
|
|
||||||
"Runtime.evaluate",
|
|
||||||
{
|
|
||||||
expression: `(() => {
|
|
||||||
const result = [];
|
|
||||||
const documents = [document];
|
|
||||||
for (let i = 0; i < documents.length && result.length < ${owners.size}; i++) {
|
|
||||||
for (const owner of documents[i].querySelectorAll('iframe,frame')) {
|
|
||||||
if (result.length >= ${owners.size}) break;
|
|
||||||
if (!owner.isConnected) continue;
|
|
||||||
const style = getComputedStyle(owner);
|
|
||||||
result.push([owner, JSON.stringify({
|
|
||||||
width: owner.clientWidth - parseFloat(style.paddingLeft) - parseFloat(style.paddingRight),
|
|
||||||
height: owner.clientHeight - parseFloat(style.paddingTop) - parseFloat(style.paddingBottom)
|
|
||||||
})]);
|
|
||||||
try { if (owner.contentDocument) documents.push(owner.contentDocument); } catch {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
})()`,
|
|
||||||
objectGroup,
|
|
||||||
serializationOptions: {
|
|
||||||
serialization: "deep",
|
|
||||||
maxDepth: 3,
|
|
||||||
additionalParameters: { maxNodeDepth: 0, includeShadowTree: "none" },
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
const result = reply.result?.deepSerializedValue;
|
|
||||||
if (result?.type !== "array" || !Array.isArray(result.value)) return sizes;
|
|
||||||
for (const entry of result.value as SerializedValue[]) {
|
|
||||||
if (entry.type !== "array" || !Array.isArray(entry.value)) continue;
|
|
||||||
const [node, data] = entry.value as SerializedValue[];
|
|
||||||
if (node?.type !== "node" || data?.type !== "string" || typeof data.value !== "string")
|
|
||||||
continue;
|
|
||||||
const id = (node.value as { backendNodeId?: number } | undefined)?.backendNodeId;
|
|
||||||
if (id === undefined || !owners.has(id)) continue;
|
|
||||||
try {
|
|
||||||
const size = JSON.parse(data.value) as Size;
|
|
||||||
if (
|
|
||||||
size &&
|
|
||||||
Number.isFinite(size.width) &&
|
|
||||||
Number.isFinite(size.height) &&
|
|
||||||
size.width > 0 &&
|
|
||||||
size.height > 0
|
|
||||||
)
|
|
||||||
sizes.set(id, size);
|
|
||||||
} catch {
|
|
||||||
/* An invalid entry uses the existing individual read. */
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
await send("Runtime.releaseObjectGroup", { objectGroup }, true).catch(() => {});
|
|
||||||
}
|
|
||||||
return sizes;
|
|
||||||
}
|
|
||||||
@@ -32,6 +32,7 @@ import { attachDialogs, markDialogCursor } from "./dialogs";
|
|||||||
import { backendNodeToObject } from "./element-geometry";
|
import { backendNodeToObject } from "./element-geometry";
|
||||||
import { rpcError } from "./errors";
|
import { rpcError } from "./errors";
|
||||||
import { resolveNodeGeometry, scrollElementAndFramesIntoView } from "./frame-geometry";
|
import { resolveNodeGeometry, scrollElementAndFramesIntoView } from "./frame-geometry";
|
||||||
|
import { dispatchMouseClick } from "./mouse-input";
|
||||||
import {
|
import {
|
||||||
type CdpRunner,
|
type CdpRunner,
|
||||||
type ChromeTabsApi,
|
type ChromeTabsApi,
|
||||||
@@ -44,6 +45,7 @@ import {
|
|||||||
resolveTargetTab,
|
resolveTargetTab,
|
||||||
} from "./shared";
|
} from "./shared";
|
||||||
import { resolveSnapshotRef } from "./snapshot-ref";
|
import { resolveSnapshotRef } from "./snapshot-ref";
|
||||||
|
import { resolveSurfacePointerTarget } from "./surface-target";
|
||||||
|
|
||||||
export interface InteractionDeps {
|
export interface InteractionDeps {
|
||||||
cdp: CdpRunner;
|
cdp: CdpRunner;
|
||||||
@@ -169,7 +171,7 @@ export async function resolveBackendNode(
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
if (hasRef) {
|
if (hasRef) {
|
||||||
const resolved = resolveSnapshotRef(ctx, params.ref as string, target.tabId);
|
const resolved = resolveSnapshotRef(ctx, params.ref as string, target.tabId, "interact");
|
||||||
if (isRpcError(resolved)) return resolved;
|
if (isRpcError(resolved)) return resolved;
|
||||||
return {
|
return {
|
||||||
backendNodeId: resolved.backendNodeId,
|
backendNodeId: resolved.backendNodeId,
|
||||||
@@ -242,11 +244,25 @@ export async function resolveActionTarget(
|
|||||||
// tool.click
|
// tool.click
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
interface ResolvedClickPointerTarget {
|
||||||
|
point: { x: number; y: number };
|
||||||
|
usedRef?: string;
|
||||||
|
usedSelector?: string;
|
||||||
|
moveSettleMs: number;
|
||||||
|
capture?: {
|
||||||
|
id: string;
|
||||||
|
imageX: number;
|
||||||
|
imageY: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
export async function handleClick(
|
export async function handleClick(
|
||||||
manager: SessionManager,
|
manager: SessionManager,
|
||||||
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;
|
||||||
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;
|
||||||
@@ -256,6 +272,23 @@ export async function handleClick(
|
|||||||
if (isRpcError(target)) return target;
|
if (isRpcError(target)) return target;
|
||||||
const denied = enforceAgentWindow(ctx, target, "click");
|
const denied = enforceAgentWindow(ctx, target, "click");
|
||||||
if (denied) return denied;
|
if (denied) return denied;
|
||||||
|
if (hasSurfacePointParams) {
|
||||||
|
const dialogCursor = markDialogCursor(deps.cdp, target.tabId);
|
||||||
|
const pointerTarget = await resolveSurfacePointerTarget(
|
||||||
|
ctx,
|
||||||
|
target,
|
||||||
|
{
|
||||||
|
ref: params.ref,
|
||||||
|
selector: params.selector,
|
||||||
|
captureId: params.capture_id,
|
||||||
|
imageX: params.image_x,
|
||||||
|
imageY: params.image_y,
|
||||||
|
},
|
||||||
|
{ cdp: deps.cdp, signal: deps.signal },
|
||||||
|
);
|
||||||
|
if (isRpcError(pointerTarget)) return pointerTarget;
|
||||||
|
return executeResolvedClick(ctx, target, pointerTarget, params, deps, dialogCursor);
|
||||||
|
}
|
||||||
const resolved = await resolveActionTarget(deps.cdp, ctx, target, params, "click");
|
const resolved = await resolveActionTarget(deps.cdp, ctx, target, params, "click");
|
||||||
if (isRpcError(resolved)) return resolved;
|
if (isRpcError(resolved)) return resolved;
|
||||||
return clickResolvedTarget(ctx, resolved, params, deps);
|
return clickResolvedTarget(ctx, resolved, params, deps);
|
||||||
@@ -269,11 +302,6 @@ export async function clickResolvedTarget(
|
|||||||
): Promise<ClickResult | RpcError> {
|
): Promise<ClickResult | RpcError> {
|
||||||
const { tab: target } = resolved;
|
const { tab: target } = resolved;
|
||||||
const dialogCursor = markDialogCursor(deps.cdp, target.tabId);
|
const dialogCursor = markDialogCursor(deps.cdp, target.tabId);
|
||||||
|
|
||||||
if (throwIfAborted(deps.signal)) {
|
|
||||||
return { code: "cancelled", message: "click aborted" };
|
|
||||||
}
|
|
||||||
|
|
||||||
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
const geometry = await resolveNodeGeometry(
|
const geometry = await resolveNodeGeometry(
|
||||||
deps.cdp,
|
deps.cdp,
|
||||||
@@ -286,20 +314,47 @@ export async function clickResolvedTarget(
|
|||||||
{ scrollIntoView: true },
|
{ scrollIntoView: true },
|
||||||
);
|
);
|
||||||
if (isRpcError(geometry)) return geometry;
|
if (isRpcError(geometry)) return geometry;
|
||||||
const centre = geometry.actionPoint;
|
return executeResolvedClick(
|
||||||
|
ctx,
|
||||||
|
target,
|
||||||
|
{
|
||||||
|
point: geometry.actionPoint,
|
||||||
|
usedRef: resolved.usedRef,
|
||||||
|
usedSelector: resolved.usedSelector,
|
||||||
|
moveSettleMs: 0,
|
||||||
|
},
|
||||||
|
params,
|
||||||
|
deps,
|
||||||
|
dialogCursor,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function executeResolvedClick(
|
||||||
|
ctx: SessionContext,
|
||||||
|
target: ResolvedTargetTab,
|
||||||
|
pointerTarget: ResolvedClickPointerTarget,
|
||||||
|
params: Pick<ClickParams, "button" | "click_count" | "modifiers">,
|
||||||
|
deps: InteractionDeps,
|
||||||
|
dialogCursor: number,
|
||||||
|
): Promise<ClickResult | RpcError> {
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
return { code: "cancelled", message: "click aborted" };
|
return { code: "cancelled", message: "click aborted" };
|
||||||
}
|
}
|
||||||
|
|
||||||
const button: MouseButton = params.button ?? "left";
|
const button: MouseButton = params.button ?? "left";
|
||||||
const clickCount = params.click_count ?? 1;
|
const clickCount = params.click_count ?? 1;
|
||||||
if (clickCount < 1) {
|
if (!Number.isSafeInteger(clickCount) || clickCount < 1) {
|
||||||
return { code: "invalid_params", message: "click_count must be greater than zero" };
|
return { code: "invalid_params", message: "click_count must be a positive integer" };
|
||||||
}
|
}
|
||||||
const modifiers = modifiersBitfield(params.modifiers);
|
const modifiers = modifiersBitfield(params.modifiers);
|
||||||
|
|
||||||
const overlayBlocking = await checkOverlayAtPoint(deps.cdp, target.tabId, centre.x, centre.y);
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
|
const overlayBlocking = await checkOverlayAtPoint(
|
||||||
|
deps.cdp,
|
||||||
|
target.tabId,
|
||||||
|
pointerTarget.point.x,
|
||||||
|
pointerTarget.point.y,
|
||||||
|
);
|
||||||
let automationBypassEnabled = false;
|
let automationBypassEnabled = false;
|
||||||
if (overlayBlocking && deps.bypassOverlay) {
|
if (overlayBlocking && deps.bypassOverlay) {
|
||||||
try {
|
try {
|
||||||
@@ -311,47 +366,16 @@ export async function clickResolvedTarget(
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// Move first so hover state activates, then press → release.
|
const dispatch = await dispatchMouseClick(deps.cdp, target.tabId, pointerTarget.point, {
|
||||||
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
|
||||||
type: "mouseMoved",
|
|
||||||
x: centre.x,
|
|
||||||
y: centre.y,
|
|
||||||
modifiers,
|
|
||||||
});
|
|
||||||
if (throwIfAborted(deps.signal)) {
|
|
||||||
return { code: "cancelled", message: "click aborted" };
|
|
||||||
}
|
|
||||||
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
|
||||||
type: "mousePressed",
|
|
||||||
x: centre.x,
|
|
||||||
y: centre.y,
|
|
||||||
button,
|
button,
|
||||||
clickCount,
|
clickCount,
|
||||||
modifiers,
|
modifiers,
|
||||||
|
signal: deps.signal,
|
||||||
|
moveSettleMs: pointerTarget.moveSettleMs,
|
||||||
});
|
});
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (dispatch === "cancelled") {
|
||||||
try {
|
|
||||||
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
|
||||||
type: "mouseReleased",
|
|
||||||
x: centre.x,
|
|
||||||
y: centre.y,
|
|
||||||
button,
|
|
||||||
clickCount,
|
|
||||||
modifiers,
|
|
||||||
});
|
|
||||||
} catch (err) {
|
|
||||||
console.debug("[bsk interaction] best-effort mouseReleased after abort failed", err);
|
|
||||||
}
|
|
||||||
return { code: "cancelled", message: "click aborted" };
|
return { code: "cancelled", message: "click aborted" };
|
||||||
}
|
}
|
||||||
await deps.cdp.send(target.tabId, "Input.dispatchMouseEvent", {
|
|
||||||
type: "mouseReleased",
|
|
||||||
x: centre.x,
|
|
||||||
y: centre.y,
|
|
||||||
button,
|
|
||||||
clickCount,
|
|
||||||
modifiers,
|
|
||||||
});
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return {
|
||||||
code: "cdp_failed",
|
code: "cdp_failed",
|
||||||
@@ -369,10 +393,17 @@ export async function clickResolvedTarget(
|
|||||||
|
|
||||||
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
||||||
tab_id: target.tabId,
|
tab_id: target.tabId,
|
||||||
used_ref: resolved.usedRef,
|
used_ref: pointerTarget.usedRef,
|
||||||
used_selector: resolved.usedSelector,
|
used_selector: pointerTarget.usedSelector,
|
||||||
x: centre.x,
|
x: pointerTarget.point.x,
|
||||||
y: centre.y,
|
y: pointerTarget.point.y,
|
||||||
|
...(pointerTarget.capture
|
||||||
|
? {
|
||||||
|
capture_id: pointerTarget.capture.id,
|
||||||
|
image_x: pointerTarget.capture.imageX,
|
||||||
|
image_y: pointerTarget.capture.imageY,
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,96 @@
|
|||||||
|
import type { MouseButton } from "@/transport/types";
|
||||||
|
import type { Point } from "./geometry";
|
||||||
|
import type { CdpRunner } from "./shared";
|
||||||
|
|
||||||
|
interface MouseClickDispatchOptions {
|
||||||
|
button: MouseButton;
|
||||||
|
clickCount: number;
|
||||||
|
modifiers: number;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
moveSettleMs?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
type MouseClickDispatchResult = "completed" | "cancelled";
|
||||||
|
|
||||||
|
function waitForSettle(ms: number, signal: AbortSignal | undefined): Promise<boolean> {
|
||||||
|
if (ms <= 0) return Promise.resolve(signal?.aborted !== true);
|
||||||
|
if (signal?.aborted) return Promise.resolve(false);
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
let settled = false;
|
||||||
|
const finish = (completed: boolean) => {
|
||||||
|
if (settled) return;
|
||||||
|
settled = true;
|
||||||
|
clearTimeout(timer);
|
||||||
|
signal?.removeEventListener("abort", onAbort);
|
||||||
|
resolve(completed);
|
||||||
|
};
|
||||||
|
const timer = setTimeout(() => finish(true), ms);
|
||||||
|
const onAbort = () => finish(false);
|
||||||
|
signal?.addEventListener("abort", onAbort, { once: true });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dispatch one coherent CDP mouse click in top-viewport CSS coordinates.
|
||||||
|
*
|
||||||
|
* Keeping the sequence here prevents DOM and Surface interaction paths from
|
||||||
|
* duplicating cancellation and best-effort release behavior. Callers that
|
||||||
|
* target asynchronously hit-tested content may request a settle interval.
|
||||||
|
*/
|
||||||
|
export async function dispatchMouseClick(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
tabId: number,
|
||||||
|
point: Point,
|
||||||
|
options: MouseClickDispatchOptions,
|
||||||
|
): Promise<MouseClickDispatchResult> {
|
||||||
|
const { button, clickCount, modifiers, signal, moveSettleMs = 0 } = options;
|
||||||
|
let pressed = false;
|
||||||
|
const release = () =>
|
||||||
|
cdp.send(tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mouseReleased",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
button,
|
||||||
|
clickCount,
|
||||||
|
modifiers,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await cdp.send(tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mouseMoved",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
modifiers,
|
||||||
|
});
|
||||||
|
if (!(await waitForSettle(moveSettleMs, signal))) return "cancelled";
|
||||||
|
|
||||||
|
await cdp.send(tabId, "Input.dispatchMouseEvent", {
|
||||||
|
type: "mousePressed",
|
||||||
|
x: point.x,
|
||||||
|
y: point.y,
|
||||||
|
button,
|
||||||
|
clickCount,
|
||||||
|
modifiers,
|
||||||
|
});
|
||||||
|
pressed = true;
|
||||||
|
|
||||||
|
if (signal?.aborted) {
|
||||||
|
await release();
|
||||||
|
pressed = false;
|
||||||
|
return "cancelled";
|
||||||
|
}
|
||||||
|
|
||||||
|
await release();
|
||||||
|
pressed = false;
|
||||||
|
return "completed";
|
||||||
|
} catch (error) {
|
||||||
|
if (pressed) {
|
||||||
|
try {
|
||||||
|
await release();
|
||||||
|
} catch (releaseError) {
|
||||||
|
console.debug("[bsk mouse-input] best-effort mouse release failed", releaseError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,6 +8,7 @@ import {
|
|||||||
applyVomInteractionRecovery,
|
applyVomInteractionRecovery,
|
||||||
type CondSurface,
|
type CondSurface,
|
||||||
isVomReferenceNode,
|
isVomReferenceNode,
|
||||||
|
type Rect,
|
||||||
renderVom,
|
renderVom,
|
||||||
type VomNode,
|
type VomNode,
|
||||||
type VomOptions,
|
type VomOptions,
|
||||||
@@ -34,8 +35,6 @@ import type {
|
|||||||
import { attachDialogs, markDialogCursor } from "./dialogs";
|
import { attachDialogs, markDialogCursor } from "./dialogs";
|
||||||
import { rpcError } from "./errors";
|
import { rpcError } from "./errors";
|
||||||
import { resolveNodeGeometry } from "./frame-geometry";
|
import { resolveNodeGeometry } from "./frame-geometry";
|
||||||
import { screenshotPageRect } from "./geometry/coordinate-types";
|
|
||||||
import { cssViewport, GeometryContext } from "./geometry/frame-context";
|
|
||||||
import {
|
import {
|
||||||
type ChromeTabsApi,
|
type ChromeTabsApi,
|
||||||
enforceToolTargetScope,
|
enforceToolTargetScope,
|
||||||
@@ -49,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-target";
|
||||||
import {
|
import {
|
||||||
type CapturedNode,
|
type CapturedNode,
|
||||||
type CapturedSurfaceProbe,
|
type CapturedSurfaceProbe,
|
||||||
@@ -64,6 +65,11 @@ import {
|
|||||||
type CaptureVomObservationResult,
|
type CaptureVomObservationResult,
|
||||||
projectRecordSafeObservation,
|
projectRecordSafeObservation,
|
||||||
} from "./vom/record-safe-observation";
|
} from "./vom/record-safe-observation";
|
||||||
|
import {
|
||||||
|
clusterRenderedSurfaces,
|
||||||
|
discoverRenderedSurfaces,
|
||||||
|
projectRenderedSurfaces,
|
||||||
|
} from "./vom/rendered-surfaces";
|
||||||
import {
|
import {
|
||||||
buildSemanticGraph,
|
buildSemanticGraph,
|
||||||
buildSemanticVomScene,
|
buildSemanticVomScene,
|
||||||
@@ -95,6 +101,9 @@ export const normaliseRef = sharedNormaliseRef;
|
|||||||
// screenshot — `tool.screenshot`
|
// screenshot — `tool.screenshot`
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
const VISUAL_SURFACE_SCREENSHOT_MAX_EDGE = 2_048;
|
||||||
|
const VISUAL_SURFACE_SCREENSHOT_MAX_PIXELS = 4_000_000;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Strip the `data:image/...;base64,` prefix from a Chrome
|
* Strip the `data:image/...;base64,` prefix from a Chrome
|
||||||
* `captureVisibleTab` dataURL and return the raw base64 payload.
|
* `captureVisibleTab` dataURL and return the raw base64 payload.
|
||||||
@@ -109,8 +118,8 @@ export function stripDataUrlPrefix(dataUrl: string): string {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse a PNG's IHDR chunk and return `(width, height)`. Returns
|
* Parse a PNG's IHDR chunk and return `(width, height)`. Returns
|
||||||
* `null` on any malformed input so callers fall back to `0/0` instead
|
* `null` on malformed input so callers can reject dimensions that are
|
||||||
* of throwing.
|
* not authoritative instead of guessing from a CSS-space rectangle.
|
||||||
*
|
*
|
||||||
* PNG layout: 8-byte signature, then a 4-byte length, 4-byte type
|
* PNG layout: 8-byte signature, then a 4-byte length, 4-byte type
|
||||||
* ("IHDR"), then the chunk data — width is bytes 16-19 BE, height is
|
* ("IHDR"), then the chunk data — width is bytes 16-19 BE, height is
|
||||||
@@ -122,9 +131,9 @@ export function parsePngDimensions(base64: string): { width: number; height: num
|
|||||||
const head = base64.length > 64 ? base64.slice(0, 64) : base64;
|
const head = base64.length > 64 ? base64.slice(0, 64) : base64;
|
||||||
const bin = atob(head);
|
const bin = atob(head);
|
||||||
if (bin.length < 24) return null;
|
if (bin.length < 24) return null;
|
||||||
if (bin.charCodeAt(0) !== 0x89 || bin.charCodeAt(1) !== 0x50 || bin.charCodeAt(2) !== 0x4e) {
|
const expectedSignature = [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a];
|
||||||
return null;
|
if (expectedSignature.some((byte, index) => bin.charCodeAt(index) !== byte)) return null;
|
||||||
}
|
if (bin.slice(12, 16) !== "IHDR") return null;
|
||||||
const u32 = (off: number) =>
|
const u32 = (off: number) =>
|
||||||
(bin.charCodeAt(off) << 24) |
|
(bin.charCodeAt(off) << 24) |
|
||||||
(bin.charCodeAt(off + 1) << 16) |
|
(bin.charCodeAt(off + 1) << 16) |
|
||||||
@@ -187,27 +196,52 @@ async function captureElementScreenshot(
|
|||||||
target: CdpTarget,
|
target: CdpTarget,
|
||||||
backendNodeId: number,
|
backendNodeId: number,
|
||||||
frameId?: string,
|
frameId?: string,
|
||||||
|
visualSurface = false,
|
||||||
|
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,
|
||||||
tabId,
|
tabId,
|
||||||
{ target, backendNodeId, ...(frameId ? { frameId } : {}) },
|
{ target, backendNodeId, ...(frameId ? { frameId } : {}) },
|
||||||
{ scrollIntoView: true },
|
{ scrollIntoView: !visualSurface },
|
||||||
);
|
);
|
||||||
if (isRpcError(geometry)) return geometry;
|
if (isRpcError(geometry)) return geometry;
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
const rect = geometry.topBounds;
|
const topViewportRect = surfaceVisibleRect(
|
||||||
const clip = screenshotPageRect(rect, geometry.topViewport);
|
geometry.topBounds,
|
||||||
if (!clip) return { code: "cdp_failed", message: "invalid screenshot coordinate space" };
|
visualSurface ? observedVisibleRect : undefined,
|
||||||
|
);
|
||||||
|
if (!topViewportRect) {
|
||||||
|
return { code: "permission_denied", message: "surface is no longer visible" };
|
||||||
|
}
|
||||||
|
const rect = {
|
||||||
|
x: topViewportRect.x,
|
||||||
|
y: topViewportRect.y,
|
||||||
|
width: topViewportRect.w,
|
||||||
|
height: topViewportRect.h,
|
||||||
|
};
|
||||||
|
const scale = visualSurface
|
||||||
|
? Math.min(
|
||||||
|
1,
|
||||||
|
VISUAL_SURFACE_SCREENSHOT_MAX_EDGE / rect.width,
|
||||||
|
VISUAL_SURFACE_SCREENSHOT_MAX_EDGE / rect.height,
|
||||||
|
Math.sqrt(VISUAL_SURFACE_SCREENSHOT_MAX_PIXELS / (rect.width * rect.height)),
|
||||||
|
)
|
||||||
|
: 1;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const shot = await cdp.send<{ data?: string }>(tabId, "Page.captureScreenshot", {
|
const shot = await cdp.send<{ data?: string }>(tabId, "Page.captureScreenshot", {
|
||||||
format: "png",
|
format: "png",
|
||||||
clip: {
|
clip: {
|
||||||
...clip.rect,
|
x: rect.x,
|
||||||
scale: 1,
|
y: rect.y,
|
||||||
|
width: rect.width,
|
||||||
|
height: rect.height,
|
||||||
|
scale,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
@@ -215,11 +249,11 @@ async function captureElementScreenshot(
|
|||||||
if (!image_base64) {
|
if (!image_base64) {
|
||||||
return { code: "cdp_failed", message: "Page.captureScreenshot returned no data" };
|
return { code: "cdp_failed", message: "Page.captureScreenshot returned no data" };
|
||||||
}
|
}
|
||||||
const dims = parsePngDimensions(image_base64) ?? {
|
const dims = parsePngDimensions(image_base64);
|
||||||
width: Math.round(rect.width),
|
if (!dims) {
|
||||||
height: Math.round(rect.height),
|
return { code: "cdp_failed", message: "Page.captureScreenshot returned invalid PNG data" };
|
||||||
};
|
}
|
||||||
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",
|
||||||
@@ -314,7 +348,7 @@ export async function handleScreenshot(
|
|||||||
if (!deps.cdp) {
|
if (!deps.cdp) {
|
||||||
return { code: "cdp_failed", message: "screenshot ref capture requires CDP" };
|
return { code: "cdp_failed", message: "screenshot ref capture requires CDP" };
|
||||||
}
|
}
|
||||||
const node = resolveSnapshotRef(ctx, ref, target.tabId);
|
const node = resolveSnapshotRef(ctx, ref, target.tabId, "screenshot");
|
||||||
if (isRpcError(node)) return node;
|
if (isRpcError(node)) return node;
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
@@ -334,18 +368,54 @@ export async function handleScreenshot(
|
|||||||
nodeTarget,
|
nodeTarget,
|
||||||
node.backendNodeId,
|
node.backendNodeId,
|
||||||
node.frameId,
|
node.frameId,
|
||||||
|
node.kind === "surface",
|
||||||
|
node.visibleRect,
|
||||||
signal,
|
signal,
|
||||||
),
|
),
|
||||||
deps.sendToTab,
|
deps.sendToTab,
|
||||||
);
|
);
|
||||||
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,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -365,7 +435,10 @@ 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 image_base64 = captured;
|
const image_base64 = captured;
|
||||||
const dims = parsePngDimensions(image_base64) ?? { width: 0, height: 0 };
|
const dims = parsePngDimensions(image_base64);
|
||||||
|
if (!dims) {
|
||||||
|
return { code: "cdp_failed", message: "screenshot capture returned invalid PNG data" };
|
||||||
|
}
|
||||||
return withShotDialogs({
|
return withShotDialogs({
|
||||||
image_base64,
|
image_base64,
|
||||||
width: dims.width,
|
width: dims.width,
|
||||||
@@ -985,19 +1058,26 @@ function emptyCapturedViewModel(viewport = { width: 0, height: 0 }): CapturedVie
|
|||||||
return { viewport, nodes: [], iframeNodes: new Map(), excludedBackendNodeIds: new Set() };
|
return { viewport, nodes: [], iframeNodes: new Map(), excludedBackendNodeIds: new Set() };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface LayoutMetricsViewportReply {
|
||||||
|
cssLayoutViewport?: { clientWidth?: number; clientHeight?: number };
|
||||||
|
layoutViewport?: { clientWidth?: number; clientHeight?: number };
|
||||||
|
}
|
||||||
|
|
||||||
async function fallbackCapturedViewModel(
|
async function fallbackCapturedViewModel(
|
||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
geometry: GeometryContext,
|
|
||||||
signal?: AbortSignal,
|
signal?: AbortSignal,
|
||||||
): Promise<CapturedViewModel> {
|
): Promise<CapturedViewModel> {
|
||||||
throwIfAborted(signal, "observation");
|
throwIfAborted(signal, "observation");
|
||||||
let viewport = { width: 0, height: 0 };
|
let viewport = { width: 0, height: 0 };
|
||||||
try {
|
try {
|
||||||
const metrics = await geometry.layoutMetrics({ tabId });
|
const metrics = await cdp.send<LayoutMetricsViewportReply>(tabId, "Page.getLayoutMetrics", {});
|
||||||
throwIfAborted(signal, "observation");
|
throwIfAborted(signal, "observation");
|
||||||
const source = cssViewport(metrics);
|
const source = metrics.cssLayoutViewport ?? metrics.layoutViewport ?? {};
|
||||||
viewport = { width: source.width, height: source.height };
|
viewport = {
|
||||||
|
width: source.clientWidth ?? 0,
|
||||||
|
height: source.clientHeight ?? 0,
|
||||||
|
};
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (isAbortError(error)) throw error;
|
if (isAbortError(error)) throw error;
|
||||||
}
|
}
|
||||||
@@ -1010,13 +1090,12 @@ async function captureForVom(
|
|||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
options: CaptureVomObservationOptions,
|
options: CaptureVomObservationOptions,
|
||||||
geometry: GeometryContext,
|
|
||||||
): Promise<CapturedViewModel> {
|
): Promise<CapturedViewModel> {
|
||||||
try {
|
try {
|
||||||
return await captureViewModel(cdp, tabId, { signal: options.signal, geometry });
|
return await captureViewModel(cdp, tabId, { signal: options.signal });
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (isAbortError(error)) throw error;
|
if (isAbortError(error)) throw error;
|
||||||
return fallbackCapturedViewModel(cdp, tabId, geometry, options.signal);
|
return fallbackCapturedViewModel(cdp, tabId, options.signal);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1078,6 +1157,7 @@ async function runHoverProbes(
|
|||||||
|
|
||||||
export interface CaptureVomObservationOptions extends VomOptions {
|
export interface CaptureVomObservationOptions extends VomOptions {
|
||||||
conditionalSurfaceProbe?: boolean;
|
conditionalSurfaceProbe?: boolean;
|
||||||
|
renderedSurfaceDiscovery?: boolean;
|
||||||
hoverProbeBypassOverlay?: (tabId: number, enabled: boolean) => Promise<void>;
|
hoverProbeBypassOverlay?: (tabId: number, enabled: boolean) => Promise<void>;
|
||||||
signal?: AbortSignal;
|
signal?: AbortSignal;
|
||||||
}
|
}
|
||||||
@@ -1091,16 +1171,9 @@ export async function captureVomObservation(
|
|||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
await cdp.ensureAttachedToUrl?.(tabId, url);
|
await cdp.ensureAttachedToUrl?.(tabId, url);
|
||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
const geometry = new GeometryContext(cdp, tabId, undefined, options.signal);
|
const captured = await captureForVom(cdp, tabId, options);
|
||||||
const captured = await captureForVom(cdp, tabId, options, geometry);
|
|
||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
const documents = await captureFrameData<CdpAxNode>(
|
const documents = await captureFrameData<CdpAxNode>(cdp, tabId, captured, options.signal);
|
||||||
cdp,
|
|
||||||
tabId,
|
|
||||||
captured,
|
|
||||||
options.signal,
|
|
||||||
geometry,
|
|
||||||
);
|
|
||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
const normalizedDocuments =
|
const normalizedDocuments =
|
||||||
documents.length === 1 && captured.iframeNodes.size > 0
|
documents.length === 1 && captured.iframeNodes.size > 0
|
||||||
@@ -1133,21 +1206,25 @@ export async function captureVomObservation(
|
|||||||
captured,
|
captured,
|
||||||
hoverProbes.surfaceProbes,
|
hoverProbes.surfaceProbes,
|
||||||
);
|
);
|
||||||
// Reserve space using the renderer's character-based token estimate. Like VOM
|
const observedScene = options.renderedSurfaceDiscovery
|
||||||
// headers, this integrity notice remains visible even under a tiny token budget.
|
? projectRenderedSurfaces(
|
||||||
const geometryNotice = captured.frameGeometryIssues?.length
|
decoratedScene,
|
||||||
? "@warning iframe geometry incomplete: some frame content has no top-level coordinates.\n"
|
normalizedDocuments,
|
||||||
: "";
|
clusterRenderedSurfaces(
|
||||||
const rendered = renderVom(decoratedScene, {
|
discoverRenderedSurfaces(
|
||||||
|
normalizedDocuments,
|
||||||
|
captured.viewport,
|
||||||
|
captured.excludedBackendNodeIds,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
: decoratedScene;
|
||||||
|
const rendered = renderVom(observedScene, {
|
||||||
maxDepth: options.maxDepth,
|
maxDepth: options.maxDepth,
|
||||||
maxTokens:
|
maxTokens: options.maxTokens,
|
||||||
!geometryNotice || options.maxTokens === undefined
|
|
||||||
? options.maxTokens
|
|
||||||
: Math.max(0, options.maxTokens - Math.ceil(geometryNotice.length / 4)),
|
|
||||||
redactValues: options.redactValues,
|
redactValues: options.redactValues,
|
||||||
activeRegionPolicy: options.activeRegionPolicy,
|
activeRegionPolicy: options.activeRegionPolicy,
|
||||||
});
|
});
|
||||||
if (geometryNotice) rendered.text += `\n${geometryNotice.trimEnd()}`;
|
|
||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
return projectRecordSafeObservation({
|
return projectRecordSafeObservation({
|
||||||
rootFrameId: captured.rootFrameId ?? normalizedDocuments[0]?.frameId ?? "root",
|
rootFrameId: captured.rootFrameId ?? normalizedDocuments[0]?.frameId ?? "root",
|
||||||
@@ -1197,6 +1274,7 @@ async function handleVomObservation(
|
|||||||
maxTokens: params.max_tokens,
|
maxTokens: params.max_tokens,
|
||||||
activeRegionPolicy: true,
|
activeRegionPolicy: true,
|
||||||
conditionalSurfaceProbe: effectiveConditionalSurfaceProbe,
|
conditionalSurfaceProbe: effectiveConditionalSurfaceProbe,
|
||||||
|
renderedSurfaceDiscovery: toolName === "observe",
|
||||||
hoverProbeBypassOverlay: deps.hoverProbeBypassOverlay,
|
hoverProbeBypassOverlay: deps.hoverProbeBypassOverlay,
|
||||||
signal,
|
signal,
|
||||||
});
|
});
|
||||||
@@ -1214,6 +1292,9 @@ async function handleVomObservation(
|
|||||||
tabId: target.tabId,
|
tabId: target.tabId,
|
||||||
...(ref.frameId ? { frameId: ref.frameId } : {}),
|
...(ref.frameId ? { frameId: ref.frameId } : {}),
|
||||||
...(refTarget?.sessionId ? { cdpSessionId: refTarget.sessionId } : {}),
|
...(refTarget?.sessionId ? { cdpSessionId: refTarget.sessionId } : {}),
|
||||||
|
...(ref.visibleRect ? { visibleRect: ref.visibleRect } : {}),
|
||||||
|
...(ref.kind ? { kind: ref.kind } : {}),
|
||||||
|
...(ref.capabilities ? { capabilities: ref.capabilities } : {}),
|
||||||
},
|
},
|
||||||
] as const;
|
] as const;
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -271,6 +271,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);
|
||||||
|
|
||||||
|
|||||||
@@ -2,8 +2,9 @@
|
|||||||
// compound CDP node identity via the session RefStore, and build stable
|
// compound CDP node identity via the session RefStore, and build stable
|
||||||
// `ref_not_found` errors for hard-failure tool paths.
|
// `ref_not_found` errors for hard-failure tool paths.
|
||||||
|
|
||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
import type { SessionContext } from "@/session-manager/manager";
|
import type { SessionContext } from "@/session-manager/manager";
|
||||||
import { normaliseRef } from "@/session-manager/ref-store";
|
import { normaliseRef, type RefCapability, type RefTargetKind } from "@/session-manager/ref-store";
|
||||||
import type { RpcError } from "@/transport/types";
|
import type { RpcError } from "@/transport/types";
|
||||||
import { rpcError } from "./errors";
|
import { rpcError } from "./errors";
|
||||||
|
|
||||||
@@ -12,6 +13,10 @@ export interface SnapshotRefLookup {
|
|||||||
refKey: string;
|
refKey: string;
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
cdpSessionId?: string;
|
cdpSessionId?: string;
|
||||||
|
visibleRect?: Rect;
|
||||||
|
kind: RefTargetKind;
|
||||||
|
capabilities: RefCapability[];
|
||||||
|
generation: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
function refEntryForTab(ctx: SessionContext, refKey: string, tabId: number) {
|
function refEntryForTab(ctx: SessionContext, refKey: string, tabId: number) {
|
||||||
@@ -37,6 +42,10 @@ export function lookupSnapshotRef(
|
|||||||
refKey,
|
refKey,
|
||||||
...(entry.frameId ? { frameId: entry.frameId } : {}),
|
...(entry.frameId ? { frameId: entry.frameId } : {}),
|
||||||
...(entry.cdpSessionId ? { cdpSessionId: entry.cdpSessionId } : {}),
|
...(entry.cdpSessionId ? { cdpSessionId: entry.cdpSessionId } : {}),
|
||||||
|
...(entry.visibleRect ? { visibleRect: entry.visibleRect } : {}),
|
||||||
|
kind: entry.kind,
|
||||||
|
capabilities: entry.capabilities,
|
||||||
|
generation: entry.generation,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -49,6 +58,7 @@ export function resolveSnapshotRef(
|
|||||||
ctx: SessionContext,
|
ctx: SessionContext,
|
||||||
ref: string,
|
ref: string,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
|
requiredCapability?: RefCapability,
|
||||||
): SnapshotRefLookup | RpcError {
|
): SnapshotRefLookup | RpcError {
|
||||||
const looked = lookupSnapshotRef(ctx, ref, tabId);
|
const looked = lookupSnapshotRef(ctx, ref, tabId);
|
||||||
if (looked === null) {
|
if (looked === null) {
|
||||||
@@ -58,5 +68,13 @@ export function resolveSnapshotRef(
|
|||||||
`ref ${ref} unknown for tab ${tabId} in session ${ctx.sessionId}`,
|
`ref ${ref} unknown for tab ${tabId} in session ${ctx.sessionId}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
if (requiredCapability && !looked.capabilities.includes(requiredCapability)) {
|
||||||
|
return rpcError(
|
||||||
|
"permission_denied",
|
||||||
|
"ref_capability_denied",
|
||||||
|
`ref ${ref} does not support ${requiredCapability}`,
|
||||||
|
{ ref: looked.refKey, required_capability: requiredCapability, kind: looked.kind },
|
||||||
|
);
|
||||||
|
}
|
||||||
return looked;
|
return looked;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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,260 @@
|
|||||||
|
import type { CdpFrameGraph } from "@/browser-driver/frame-graph";
|
||||||
|
import type { SessionContext } from "@/session-manager/manager";
|
||||||
|
import type { RpcError } from "@/transport/types";
|
||||||
|
import { rpcError } from "./errors";
|
||||||
|
import { resolveNodeGeometry } from "./frame-geometry";
|
||||||
|
import { type CdpRunner, isRpcError, normaliseRef } 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 SurfaceTargetResolverDeps {
|
||||||
|
cdp: CdpRunner;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SurfacePointerTargetInput {
|
||||||
|
ref?: string;
|
||||||
|
selector?: string;
|
||||||
|
captureId?: string;
|
||||||
|
imageX?: number;
|
||||||
|
imageY?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ResolvedSurfacePointerTarget {
|
||||||
|
point: { x: number; y: number };
|
||||||
|
usedRef: string;
|
||||||
|
moveSettleMs: number;
|
||||||
|
capture: {
|
||||||
|
id: string;
|
||||||
|
imageX: number;
|
||||||
|
imageY: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Canvas-style controls commonly update their pointer hit-test on the next
|
||||||
|
// animation frame. Leave a scheduling boundary after moving and before pressing.
|
||||||
|
export const SURFACE_POINTER_MOVE_SETTLE_MS = 32;
|
||||||
|
|
||||||
|
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(input: SurfacePointerTargetInput): RpcError | null {
|
||||||
|
if (!input.captureId || typeof input.captureId !== "string") {
|
||||||
|
return { code: "invalid_params", message: "surface point click requires capture_id" };
|
||||||
|
}
|
||||||
|
if (typeof input.imageX !== "number" || !Number.isFinite(input.imageX)) {
|
||||||
|
return { code: "invalid_params", message: "image_x must be a finite number" };
|
||||||
|
}
|
||||||
|
if (typeof input.imageY !== "number" || !Number.isFinite(input.imageY)) {
|
||||||
|
return { code: "invalid_params", message: "image_y must be a finite number" };
|
||||||
|
}
|
||||||
|
if (!input.ref || input.selector) {
|
||||||
|
return {
|
||||||
|
code: "invalid_params",
|
||||||
|
message: "surface point click requires one Surface ref and does not accept a selector",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
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 target resolution aborted" }
|
||||||
|
: null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Resolve one fresh Surface capture coordinate into a validated top-viewport pointer target. */
|
||||||
|
export async function resolveSurfacePointerTarget(
|
||||||
|
ctx: SessionContext,
|
||||||
|
target: { tabId: number; url?: string },
|
||||||
|
input: SurfacePointerTargetInput,
|
||||||
|
deps: SurfaceTargetResolverDeps,
|
||||||
|
): Promise<ResolvedSurfacePointerTarget | RpcError> {
|
||||||
|
const invalid = validatePointParams(input);
|
||||||
|
if (invalid) return invalid;
|
||||||
|
const earlyAbort = aborted(deps.signal);
|
||||||
|
if (earlyAbort) return earlyAbort;
|
||||||
|
|
||||||
|
const consumed = ctx.surfaceCaptures.consume(input.captureId 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(input.ref as string) !== capture.surface.ref) {
|
||||||
|
return stale("surface ref does not match the capture");
|
||||||
|
}
|
||||||
|
const node = resolveSnapshotRef(ctx, input.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,
|
||||||
|
input.imageX as number,
|
||||||
|
input.imageY as number,
|
||||||
|
);
|
||||||
|
if (!point || !pointInRegion(point, geometry.topVisibleRegions)) {
|
||||||
|
return rpcError(
|
||||||
|
"invalid_params",
|
||||||
|
"surface_coordinate_invalid",
|
||||||
|
"image coordinate is outside the captured Surface",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
point,
|
||||||
|
usedRef: capture.surface.ref,
|
||||||
|
moveSettleMs: SURFACE_POINTER_MOVE_SETTLE_MS,
|
||||||
|
capture: {
|
||||||
|
id: capture.id,
|
||||||
|
imageX: input.imageX as number,
|
||||||
|
imageY: input.imageY as number,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import { OVERLAY_HOST_MARKER_ATTR, OVERLAY_HOST_NAME } from "../../../lib/overlay-bridge";
|
import { OVERLAY_HOST_MARKER_ATTR, OVERLAY_HOST_NAME } from "../../../lib/overlay-bridge";
|
||||||
import type { CdpRunner } from "../../shared";
|
|
||||||
import { captureViewModel, collectOverlayExcludedBackendIds, probeHoverSurfaces } from "../capture";
|
import { captureViewModel, collectOverlayExcludedBackendIds, probeHoverSurfaces } from "../capture";
|
||||||
|
import { discoverRenderedSurfaces } from "../rendered-surfaces";
|
||||||
|
|
||||||
// Minimal but format-accurate captureSnapshot reply: a body with one
|
// Minimal but format-accurate captureSnapshot reply: a body with one
|
||||||
// fixed full-screen overlay div carrying a password input.
|
// fixed full-screen overlay div carrying a password input.
|
||||||
@@ -736,6 +736,44 @@ describe("captureViewModel", () => {
|
|||||||
expect(nodes.find((node) => node.backendNodeId === 14)?.rendered).toBe(false);
|
expect(nodes.find((node) => node.backendNodeId === 14)?.rendered).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("propagates fully transparent ancestor suppression to painted descendants", async () => {
|
||||||
|
const S = ["html", "body", "div", "canvas", "static", "auto", "visible", "1", "0"];
|
||||||
|
const i = (value: string) => S.indexOf(value);
|
||||||
|
const snapshot = {
|
||||||
|
strings: S,
|
||||||
|
documents: [
|
||||||
|
{
|
||||||
|
nodes: {
|
||||||
|
parentIndex: [-1, 0, 1, 2],
|
||||||
|
nodeName: [i("html"), i("body"), i("div"), i("canvas")],
|
||||||
|
backendNodeId: [10, 11, 12, 13],
|
||||||
|
attributes: [[], [], [], []],
|
||||||
|
},
|
||||||
|
layout: {
|
||||||
|
nodeIndex: [1, 2, 3],
|
||||||
|
styles: [
|
||||||
|
[i("static"), i("auto"), i("auto"), i("visible"), i("1")],
|
||||||
|
[i("static"), i("auto"), i("auto"), i("visible"), i("0")],
|
||||||
|
[i("static"), i("auto"), i("auto"), i("visible"), i("1")],
|
||||||
|
],
|
||||||
|
bounds: [
|
||||||
|
[0, 0, 1000, 800],
|
||||||
|
[10, 10, 200, 100],
|
||||||
|
[10, 10, 200, 100],
|
||||||
|
],
|
||||||
|
paintOrders: [0, 1, 2],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
const { nodes } = await captureViewModel(makeCdp(snapshot), 4);
|
||||||
|
const canvas = nodes.find((node) => node.backendNodeId === 13);
|
||||||
|
|
||||||
|
expect(canvas?.rendered).toBe(true);
|
||||||
|
expect(canvas?.visuallySuppressed).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
it("subtracts scroll offset to make rects viewport-relative", async () => {
|
it("subtracts scroll offset to make rects viewport-relative", async () => {
|
||||||
const cdp = {
|
const cdp = {
|
||||||
send: vi.fn(async (_t: number, method: string) => {
|
send: vi.fn(async (_t: number, method: string) => {
|
||||||
@@ -755,7 +793,7 @@ describe("captureViewModel", () => {
|
|||||||
expect(div?.rect).toMatchObject({ y: 0, h: 600 });
|
expect(div?.rect).toMatchObject({ y: 0, h: 600 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("keeps CSS snapshot bounds independent of legacy metrics ratio", async () => {
|
it("normalizes device-pixel bounds by devicePixelRatio", async () => {
|
||||||
const S = ["html", "body", "div", "position", "fixed", "static", "pointer-events", "auto"];
|
const S = ["html", "body", "div", "position", "fixed", "static", "pointer-events", "auto"];
|
||||||
const i = (s: string) => S.indexOf(s);
|
const i = (s: string) => S.indexOf(s);
|
||||||
const snapshot = {
|
const snapshot = {
|
||||||
@@ -803,12 +841,6 @@ describe("captureViewModel", () => {
|
|||||||
w: 1000,
|
w: 1000,
|
||||||
h: 800,
|
h: 800,
|
||||||
});
|
});
|
||||||
expect(nodes.find((n) => n.backendNodeId === 12)?.localRect).toEqual({
|
|
||||||
x: 0,
|
|
||||||
y: 0,
|
|
||||||
w: 2000,
|
|
||||||
h: 1600,
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("extracts textContent from #text child nodes via nodeValue", async () => {
|
it("extracts textContent from #text child nodes via nodeValue", async () => {
|
||||||
@@ -957,12 +989,6 @@ describe("captureViewModel", () => {
|
|||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return { model: { content: [100, 300, 900, 300, 900, 700, 100, 700] } };
|
|
||||||
if (method === "DOM.resolveNode") return { object: { objectId: "owner" } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return { result: { value: { width: 800, height: 400 } } };
|
|
||||||
if (method === "Runtime.releaseObject") return {};
|
|
||||||
throw new Error(method);
|
throw new Error(method);
|
||||||
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
||||||
};
|
};
|
||||||
@@ -992,7 +1018,7 @@ describe("captureViewModel", () => {
|
|||||||
expect(frameParentIds?.get("child-frame")).toBe("main-frame");
|
expect(frameParentIds?.get("child-frame")).toBe("main-frame");
|
||||||
});
|
});
|
||||||
|
|
||||||
it("projects iframe documents independently of owner snapshot geometry", async () => {
|
it("captures iframe documents without requiring owner-frame geometry", async () => {
|
||||||
const S = [
|
const S = [
|
||||||
"html",
|
"html",
|
||||||
"body",
|
"body",
|
||||||
@@ -1053,12 +1079,6 @@ describe("captureViewModel", () => {
|
|||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return { model: { content: [100, 300, 900, 300, 900, 700, 100, 700] } };
|
|
||||||
if (method === "DOM.resolveNode") return { object: { objectId: "owner" } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return { result: { value: { width: 800, height: 400 } } };
|
|
||||||
if (method === "Runtime.releaseObject") return {};
|
|
||||||
throw new Error(method);
|
throw new Error(method);
|
||||||
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
||||||
};
|
};
|
||||||
@@ -1067,7 +1087,7 @@ describe("captureViewModel", () => {
|
|||||||
const input = iframeNodes.get(13)?.find((n) => n.backendNodeId === 101);
|
const input = iframeNodes.get(13)?.find((n) => n.backendNodeId === 101);
|
||||||
|
|
||||||
expect(input?.localRect).toEqual({ x: 20, y: 20, w: 120, h: 60 });
|
expect(input?.localRect).toEqual({ x: 20, y: 20, w: 120, h: 60 });
|
||||||
expect(input?.rect).toEqual({ x: 120, y: 320, w: 120, h: 60 });
|
expect(input?.rect).toBeNull();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("recursively normalizes nested iframe sub-documents", async () => {
|
it("recursively normalizes nested iframe sub-documents", async () => {
|
||||||
@@ -1146,43 +1166,16 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
const cdp = {
|
const cdp = {
|
||||||
send: vi.fn(
|
send: vi.fn(async (_t: number, method: string) => {
|
||||||
async (
|
if (method === "DOMSnapshot.enable") return {};
|
||||||
_t: number,
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
method: string,
|
if (method === "Page.getLayoutMetrics") {
|
||||||
params?: { backendNodeId?: number; objectId?: string },
|
return {
|
||||||
) => {
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
if (method === "DOMSnapshot.enable") return {};
|
};
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
}
|
||||||
if (method === "Page.getLayoutMetrics") {
|
throw new Error(method);
|
||||||
return {
|
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return {
|
|
||||||
model: {
|
|
||||||
content:
|
|
||||||
params?.backendNodeId === 13
|
|
||||||
? [10, 20, 310, 20, 310, 220, 10, 220]
|
|
||||||
: [15, 26, 115, 26, 115, 106, 15, 106],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
if (method === "DOM.resolveNode")
|
|
||||||
return { object: { objectId: String(params?.backendNodeId) } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return {
|
|
||||||
result: {
|
|
||||||
value:
|
|
||||||
params?.objectId === "13"
|
|
||||||
? { width: 300, height: 200 }
|
|
||||||
: { width: 100, height: 80 },
|
|
||||||
},
|
|
||||||
};
|
|
||||||
if (method === "Runtime.releaseObject") return {};
|
|
||||||
throw new Error(method);
|
|
||||||
},
|
|
||||||
) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
const { iframeNodes } = await captureViewModel(cdp, 4);
|
const { iframeNodes } = await captureViewModel(cdp, 4);
|
||||||
@@ -1196,7 +1189,98 @@ describe("captureViewModel", () => {
|
|||||||
expect(input?.rect).toEqual({ x: 16, y: 28, w: 40, h: 20 });
|
expect(input?.rect).toEqual({ x: 16, y: 28, w: 40, h: 20 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("subtracts CSS scroll once without dividing snapshot bounds by a metrics ratio", async () => {
|
it("keeps same-origin iframe canvas discovery in top-level CSS coordinates at dpr 1 and 2", async () => {
|
||||||
|
const captureAtDpr = async (dpr: number) => {
|
||||||
|
const S = ["html", "body", "iframe", "canvas", "static", "auto"];
|
||||||
|
const i = (s: string) => S.indexOf(s);
|
||||||
|
const scale = (values: number[]) => values.map((value) => value * dpr);
|
||||||
|
const snapshot = {
|
||||||
|
strings: S,
|
||||||
|
documents: [
|
||||||
|
{
|
||||||
|
frameId: "main",
|
||||||
|
nodes: {
|
||||||
|
parentIndex: [-1, 0, 1],
|
||||||
|
nodeName: [i("html"), i("body"), i("iframe")],
|
||||||
|
backendNodeId: [10, 11, 13],
|
||||||
|
attributes: [[], [], []],
|
||||||
|
contentDocumentIndex: { index: [2], value: [1] },
|
||||||
|
},
|
||||||
|
layout: {
|
||||||
|
nodeIndex: [1, 2],
|
||||||
|
styles: [
|
||||||
|
[i("static"), i("auto")],
|
||||||
|
[i("static"), i("auto")],
|
||||||
|
],
|
||||||
|
bounds: [scale([0, 0, 1000, 800]), scale([100, 150, 300, 200])],
|
||||||
|
paintOrders: [0, 1],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
frameId: "child",
|
||||||
|
nodes: {
|
||||||
|
parentIndex: [-1, 0],
|
||||||
|
nodeName: [i("body"), i("canvas")],
|
||||||
|
backendNodeId: [20, 21],
|
||||||
|
attributes: [[], []],
|
||||||
|
},
|
||||||
|
layout: {
|
||||||
|
nodeIndex: [0, 1],
|
||||||
|
styles: [
|
||||||
|
[i("static"), i("auto")],
|
||||||
|
[i("static"), i("auto")],
|
||||||
|
],
|
||||||
|
bounds: [scale([0, 0, 300, 200]), scale([20, 30, 120, 60])],
|
||||||
|
paintOrders: [0, 1],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
const cdp = {
|
||||||
|
send: vi.fn(async (_tabId: number, method: string) => {
|
||||||
|
if (method === "DOMSnapshot.enable") return {};
|
||||||
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
|
if (method === "Page.getLayoutMetrics") {
|
||||||
|
return {
|
||||||
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
|
layoutViewport: { clientWidth: 1000 * dpr, clientHeight: 800 * dpr },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
throw new Error(method);
|
||||||
|
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
||||||
|
};
|
||||||
|
const captured = await captureViewModel(cdp, 4);
|
||||||
|
const childNodes = captured.frameNodes?.get("child") ?? [];
|
||||||
|
return discoverRenderedSurfaces(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
frameId: "child",
|
||||||
|
contextScopeId: "child",
|
||||||
|
parentFrameId: "main",
|
||||||
|
ownerBackendNodeId: 13,
|
||||||
|
target: { tabId: 4 },
|
||||||
|
domNodes: childNodes,
|
||||||
|
axNodes: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
captured.viewport,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const atDpr1 = await captureAtDpr(1);
|
||||||
|
const atDpr2 = await captureAtDpr(2);
|
||||||
|
|
||||||
|
expect(atDpr1).toEqual([
|
||||||
|
expect.objectContaining({
|
||||||
|
backendNodeId: 21,
|
||||||
|
frameId: "child",
|
||||||
|
visibleRect: { x: 120, y: 180, w: 120, h: 60 },
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
expect(atDpr2).toEqual(atDpr1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("normalizes bounds then subtracts CSS scroll at dpr>1", async () => {
|
||||||
const S = ["html", "body", "div", "position", "fixed", "static", "pointer-events", "auto"];
|
const S = ["html", "body", "div", "position", "fixed", "static", "pointer-events", "auto"];
|
||||||
const i = (s: string) => S.indexOf(s);
|
const i = (s: string) => S.indexOf(s);
|
||||||
const snapshot = {
|
const snapshot = {
|
||||||
@@ -1238,7 +1322,7 @@ describe("captureViewModel", () => {
|
|||||||
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(cdp, 4);
|
const { nodes } = await captureViewModel(cdp, 4);
|
||||||
expect(nodes.find((n) => n.backendNodeId === 12)?.rect?.y).toBe(400 - 100);
|
expect(nodes.find((n) => n.backendNodeId === 12)?.rect?.y).toBe(400 / 2 - 100);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("collectOverlayExcludedBackendIds walks the pierced overlay host subtree", async () => {
|
it("collectOverlayExcludedBackendIds walks the pierced overlay host subtree", async () => {
|
||||||
@@ -1263,194 +1347,3 @@ describe("captureViewModel", () => {
|
|||||||
expect(excluded).toEqual(new Set([200, 201, 202]));
|
expect(excluded).toEqual(new Set([200, 201, 202]));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// Six sibling frames and one nested frame exercise scheduling through the real capture entry.
|
|
||||||
function siblingCaptureFixture(
|
|
||||||
beforeReply: (method: string, params: Record<string, unknown>) => Promise<void> = async () => {},
|
|
||||||
) {
|
|
||||||
const document = (id: number, owners: number[], childIndexes: number[]) => ({
|
|
||||||
frameId: `frame-${id}`,
|
|
||||||
nodes: {
|
|
||||||
parentIndex: [-1, ...owners.map(() => 0)],
|
|
||||||
nodeName: [0, ...owners.map(() => 1)],
|
|
||||||
backendNodeId: [1000 + id, ...owners],
|
|
||||||
attributes: [[], ...owners.map(() => [])],
|
|
||||||
contentDocumentIndex: { index: owners.map((_, i) => i + 1), value: childIndexes },
|
|
||||||
},
|
|
||||||
layout: {
|
|
||||||
nodeIndex: [0, ...owners.map((_, i) => i + 1)],
|
|
||||||
bounds: [[0, 0, 200, 100], ...owners.map(() => [0, 0, 200, 100])],
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const snapshot = {
|
|
||||||
strings: ["body", "iframe"],
|
|
||||||
documents: [
|
|
||||||
document(0, [100, 101, 102, 103, 104, 105], [1, 2, 3, 4, 5, 6]),
|
|
||||||
document(1, [200], [7]),
|
|
||||||
...Array.from({ length: 6 }, (_, i) => document(i + 2, [], [])),
|
|
||||||
],
|
|
||||||
};
|
|
||||||
let active = 0;
|
|
||||||
let peak = 0;
|
|
||||||
const send = vi.fn(async (_tabId: number, method: string, params: object = {}) => {
|
|
||||||
const args = params as Record<string, unknown>;
|
|
||||||
active++;
|
|
||||||
peak = Math.max(peak, active);
|
|
||||||
try {
|
|
||||||
await beforeReply(method, args);
|
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
|
||||||
if (method === "Page.getLayoutMetrics")
|
|
||||||
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 800 } };
|
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return { model: { content: [0, 0, 200, 0, 200, 100, 0, 100] } };
|
|
||||||
if (method === "DOM.resolveNode") return { object: { objectId: String(args.backendNodeId) } };
|
|
||||||
if (method === "Runtime.callFunctionOn")
|
|
||||||
return { result: { value: { width: 200, height: 100 } } };
|
|
||||||
return {};
|
|
||||||
} finally {
|
|
||||||
active--;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return {
|
|
||||||
cdp: { send: send as CdpRunner["send"] },
|
|
||||||
send,
|
|
||||||
peak: () => peak,
|
|
||||||
active: () => active,
|
|
||||||
measured: () =>
|
|
||||||
send.mock.calls
|
|
||||||
.filter(([, method]) => method === "DOM.getBoxModel")
|
|
||||||
.map(([, , params]) => (params as { backendNodeId: number }).backendNodeId),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("sibling frame measurement scheduling", () => {
|
|
||||||
it("batches same-target owner sizes without changing projected results", async () => {
|
|
||||||
const fixture = siblingCaptureFixture();
|
|
||||||
const original = fixture.cdp.send;
|
|
||||||
const methods: string[] = [];
|
|
||||||
fixture.cdp.send = async (tabId, method, params) => {
|
|
||||||
methods.push(method);
|
|
||||||
if (method === "Runtime.evaluate")
|
|
||||||
return {
|
|
||||||
result: {
|
|
||||||
deepSerializedValue: {
|
|
||||||
type: "array",
|
|
||||||
value: [100, 101, 102, 103, 104, 105, 200].map((backendNodeId) => ({
|
|
||||||
type: "array",
|
|
||||||
value: [
|
|
||||||
{ type: "node", value: { backendNodeId } },
|
|
||||||
{ type: "string", value: JSON.stringify({ width: 200, height: 100 }) },
|
|
||||||
],
|
|
||||||
})),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
} as never;
|
|
||||||
return original(tabId, method, params);
|
|
||||||
};
|
|
||||||
const captured = await captureViewModel(fixture.cdp, 4);
|
|
||||||
expect(captured.frameGeometryIssues).toEqual([]);
|
|
||||||
expect([...captured.iframeNodes.keys()]).toEqual([100, 200, 101, 102, 103, 104, 105]);
|
|
||||||
expect(captured.iframeNodes.get(200)?.[0].rect).toEqual({ x: 0, y: 0, w: 200, h: 100 });
|
|
||||||
expect(methods.filter((method) => method === "DOM.getBoxModel")).toHaveLength(7);
|
|
||||||
expect(methods.filter((method) => method === "Runtime.evaluate")).toHaveLength(1);
|
|
||||||
expect(methods.filter((method) => method === "Runtime.releaseObjectGroup")).toHaveLength(1);
|
|
||||||
expect(methods).not.toContain("DOM.resolveNode");
|
|
||||||
expect(methods).not.toContain("Runtime.callFunctionOn");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("bounds concurrent reads, fills free slots and preserves depth-first output despite reordered replies", async () => {
|
|
||||||
const pending = new Map<number, () => void>();
|
|
||||||
const fixture = siblingCaptureFixture(async (method, params) => {
|
|
||||||
if (method === "DOM.getBoxModel" && Number(params.backendNodeId) < 200)
|
|
||||||
await new Promise<void>((resolve) => pending.set(Number(params.backendNodeId), resolve));
|
|
||||||
});
|
|
||||||
const capture = captureViewModel(fixture.cdp, 4);
|
|
||||||
await vi.waitFor(() => expect(pending.size).toBe(4));
|
|
||||||
expect(fixture.measured()).toEqual([100, 101, 102, 103]);
|
|
||||||
pending.get(103)!();
|
|
||||||
await vi.waitFor(() => expect(pending.has(104)).toBe(true));
|
|
||||||
pending.get(104)!();
|
|
||||||
await vi.waitFor(() => expect(pending.has(105)).toBe(true));
|
|
||||||
expect(fixture.measured()).not.toContain(200);
|
|
||||||
for (const id of [105, 102, 101, 100]) pending.get(id)!();
|
|
||||||
const captured = await capture;
|
|
||||||
expect(captured.frameGeometryIssues).toEqual([]);
|
|
||||||
expect(fixture.peak()).toBe(4);
|
|
||||||
expect(fixture.active()).toBe(0);
|
|
||||||
expect(fixture.measured()).toEqual([100, 101, 102, 103, 104, 105, 200]);
|
|
||||||
expect([...captured.iframeNodes.keys()]).toEqual([100, 200, 101, 102, 103, 104, 105]);
|
|
||||||
expect(captured.iframeNodes.get(200)?.[0].rect).toEqual({ x: 0, y: 0, w: 200, h: 100 });
|
|
||||||
for (const method of [
|
|
||||||
"DOM.getBoxModel",
|
|
||||||
"DOM.resolveNode",
|
|
||||||
"Runtime.callFunctionOn",
|
|
||||||
"Runtime.releaseObject",
|
|
||||||
])
|
|
||||||
expect(fixture.send.mock.calls.filter(([, name]) => name === method)).toHaveLength(7);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not measure descendants of a failed owner and retains sibling geometry and local nodes", async () => {
|
|
||||||
const fixture = siblingCaptureFixture(async (method, params) => {
|
|
||||||
if (method === "DOM.resolveNode" && params.backendNodeId === 100)
|
|
||||||
throw new Error("owner replaced");
|
|
||||||
});
|
|
||||||
const captured = await captureViewModel(fixture.cdp, 4);
|
|
||||||
expect(captured.frameGeometryIssues).toEqual([
|
|
||||||
{
|
|
||||||
status: "unavailable",
|
|
||||||
source: { target: { tabId: 4 }, frameId: "frame-1" },
|
|
||||||
ownerBackendNodeId: 100,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
status: "blocked",
|
|
||||||
source: { target: { tabId: 4 }, frameId: "frame-7" },
|
|
||||||
cause: captured.frameGeometryIssues?.[0],
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
expect(fixture.measured()).not.toContain(200);
|
|
||||||
expect(captured.iframeNodes.get(200)?.[0]).toMatchObject({
|
|
||||||
tag: "body",
|
|
||||||
rect: null,
|
|
||||||
localRect: { x: 0, y: 0, w: 200, h: 100 },
|
|
||||||
});
|
|
||||||
expect(captured.iframeNodes.get(101)?.[0].rect).toEqual({ x: 0, y: 0, w: 200, h: 100 });
|
|
||||||
expect([...captured.iframeNodes.keys()]).toEqual([100, 200, 101, 102, 103, 104, 105]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("stops scheduling on cancellation and waits for resolved objects to be released", async () => {
|
|
||||||
const controller = new AbortController();
|
|
||||||
const resolutions = new Map<string, () => void>();
|
|
||||||
const releases = new Map<string, () => void>();
|
|
||||||
const fixture = siblingCaptureFixture(async (method, params) => {
|
|
||||||
if (method === "DOM.resolveNode")
|
|
||||||
await new Promise<void>((resolve) =>
|
|
||||||
resolutions.set(String(params.backendNodeId), resolve),
|
|
||||||
);
|
|
||||||
if (method === "Runtime.releaseObject")
|
|
||||||
await new Promise<void>((resolve) => releases.set(String(params.objectId), resolve));
|
|
||||||
});
|
|
||||||
let settled = false;
|
|
||||||
const capture = captureViewModel(fixture.cdp, 4, { signal: controller.signal });
|
|
||||||
const rejected = expect(capture).rejects.toMatchObject({ name: "AbortError" });
|
|
||||||
void capture.then(
|
|
||||||
() => {
|
|
||||||
settled = true;
|
|
||||||
},
|
|
||||||
() => {
|
|
||||||
settled = true;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
await vi.waitFor(() => expect(resolutions.size).toBe(4));
|
|
||||||
controller.abort();
|
|
||||||
for (const resolve of resolutions.values()) resolve();
|
|
||||||
await vi.waitFor(() => expect(releases.size).toBe(4));
|
|
||||||
expect(settled).toBe(false);
|
|
||||||
expect(fixture.measured()).toEqual([100, 101, 102, 103]);
|
|
||||||
for (const release of releases.values()) release();
|
|
||||||
await rejected;
|
|
||||||
expect(fixture.active()).toBe(0);
|
|
||||||
expect(fixture.send.mock.calls.some(([, method]) => method === "Runtime.callFunctionOn")).toBe(
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|||||||
@@ -50,68 +50,6 @@ function childSnapshot(frameId: string, backendNodeId: number) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
describe("captureFrameData", () => {
|
describe("captureFrameData", () => {
|
||||||
it("retains nested owner failures when merging a captured OOPIF", async () => {
|
|
||||||
const owner = ownerNode(10, 50);
|
|
||||||
const captured: CapturedViewModel = {
|
|
||||||
nodes: [owner],
|
|
||||||
viewport: { width: 1000, height: 800 },
|
|
||||||
iframeNodes: new Map(),
|
|
||||||
frameNodes: new Map([["main", [owner]]]),
|
|
||||||
rootFrameId: "main",
|
|
||||||
excludedBackendNodeIds: new Set(),
|
|
||||||
};
|
|
||||||
const child = childSnapshot("child", 101);
|
|
||||||
const nested = childSnapshot("nested", 201);
|
|
||||||
const document = child.documents[0];
|
|
||||||
const snapshot = {
|
|
||||||
strings: child.strings,
|
|
||||||
documents: [
|
|
||||||
{
|
|
||||||
...document,
|
|
||||||
nodes: { ...document.nodes, contentDocumentIndex: { index: [1], value: [1] } },
|
|
||||||
},
|
|
||||||
nested.documents[0],
|
|
||||||
],
|
|
||||||
};
|
|
||||||
const reply = async (_target: unknown, method: string) => {
|
|
||||||
if (method === "Page.getLayoutMetrics")
|
|
||||||
return { cssLayoutViewport: { clientWidth: 300, clientHeight: 200 } };
|
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
|
||||||
if (method === "DOM.getBoxModel")
|
|
||||||
return { model: { content: [50, 100, 350, 100, 350, 300, 50, 300] } };
|
|
||||||
if (method === "DOM.resolveNode") throw new Error("nested owner replaced");
|
|
||||||
return {};
|
|
||||||
};
|
|
||||||
const cdp: CdpRunner = {
|
|
||||||
send: vi.fn(reply) as CdpRunner["send"],
|
|
||||||
sendToTarget: vi.fn(reply) as NonNullable<CdpRunner["sendToTarget"]>,
|
|
||||||
getFrameGraph: vi.fn(async () => ({
|
|
||||||
rootFrameId: "main",
|
|
||||||
frames: [
|
|
||||||
{ frameId: "main", target: { tabId: 4 } },
|
|
||||||
{
|
|
||||||
frameId: "child",
|
|
||||||
parentFrameId: "main",
|
|
||||||
ownerBackendNodeId: 10,
|
|
||||||
target: { tabId: 4, sessionId: "child-session" },
|
|
||||||
},
|
|
||||||
],
|
|
||||||
})),
|
|
||||||
};
|
|
||||||
await captureFrameData(cdp, 4, captured);
|
|
||||||
expect(captured.frameGeometryIssues).toEqual([
|
|
||||||
{
|
|
||||||
status: "unavailable",
|
|
||||||
source: { target: { tabId: 4, sessionId: "child-session" }, frameId: "nested" },
|
|
||||||
ownerBackendNodeId: 101,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
expect(captured.frameNodes?.get("nested")?.[1]).toMatchObject({
|
|
||||||
rect: null,
|
|
||||||
localRect: { x: 10, y: 20, w: 100, h: 40 },
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("captures and positions multiple OOPIF documents missing from the root snapshot", async () => {
|
it("captures and positions multiple OOPIF documents missing from the root snapshot", async () => {
|
||||||
const leftOwner = ownerNode(10, 50);
|
const leftOwner = ownerNode(10, 50);
|
||||||
const rightOwner = ownerNode(20, 500);
|
const rightOwner = ownerNode(20, 500);
|
||||||
|
|||||||
@@ -0,0 +1,256 @@
|
|||||||
|
import type { VomScene } from "@browser-skill/vom";
|
||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import type { CapturedNode } from "../capture";
|
||||||
|
import type { CapturedFrameDocument } from "../frame-capture";
|
||||||
|
import {
|
||||||
|
clusterRenderedSurfaces,
|
||||||
|
discoverRenderedSurfaces,
|
||||||
|
projectRenderedSurfaces,
|
||||||
|
} from "../rendered-surfaces";
|
||||||
|
import type { SemanticAxNode } from "../semantic-graph";
|
||||||
|
|
||||||
|
function domNode(backendNodeId: number, overrides: Partial<CapturedNode> = {}): CapturedNode {
|
||||||
|
return {
|
||||||
|
backendNodeId,
|
||||||
|
parentBackendNodeId: null,
|
||||||
|
frameId: "main",
|
||||||
|
ownerFrameBackendNodeId: null,
|
||||||
|
tag: "canvas",
|
||||||
|
attrs: {},
|
||||||
|
rect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
localRect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
paintOrder: 1,
|
||||||
|
position: "static",
|
||||||
|
pointerEvents: "auto",
|
||||||
|
rendered: true,
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function document(
|
||||||
|
domNodes: CapturedNode[],
|
||||||
|
axNodes: SemanticAxNode[] = [],
|
||||||
|
): CapturedFrameDocument<SemanticAxNode> {
|
||||||
|
return {
|
||||||
|
frameId: domNodes[0]?.frameId ?? "main",
|
||||||
|
contextScopeId: domNodes[0]?.frameId ?? "main",
|
||||||
|
target: { tabId: 4 },
|
||||||
|
domNodes,
|
||||||
|
axNodes,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("rendered surface discovery", () => {
|
||||||
|
it("finds prominent rendered canvases and excludes hidden descendants", () => {
|
||||||
|
const visible = domNode(2, { parentBackendNodeId: 1 });
|
||||||
|
const hidden = domNode(3, { parentBackendNodeId: 4 });
|
||||||
|
const surfaces = discoverRenderedSurfaces(
|
||||||
|
[
|
||||||
|
document([
|
||||||
|
domNode(1, { tag: "main", rect: null, localRect: null }),
|
||||||
|
visible,
|
||||||
|
domNode(4, { tag: "section", attrs: { "aria-hidden": "true" }, rect: null }),
|
||||||
|
hidden,
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(surfaces).toHaveLength(1);
|
||||||
|
expect(surfaces[0]).toMatchObject({ backendNodeId: 2 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps tiny canvases as individually addressable exact discoveries", () => {
|
||||||
|
const surfaces = discoverRenderedSurfaces(
|
||||||
|
[document([domNode(2, { rect: { x: 1, y: 1, w: 8, h: 8 } })])],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
);
|
||||||
|
expect(surfaces).toEqual([expect.objectContaining({ backendNodeId: 2 })]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps a surface when the canvas only has partial native accessibility content", () => {
|
||||||
|
const axNodes = [
|
||||||
|
{
|
||||||
|
nodeId: "canvas",
|
||||||
|
backendDOMNodeId: 2,
|
||||||
|
role: { type: "role", value: "presentation" },
|
||||||
|
childIds: ["button"],
|
||||||
|
frameId: "main",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
nodeId: "button",
|
||||||
|
backendDOMNodeId: 3,
|
||||||
|
role: { type: "role", value: "button" },
|
||||||
|
frameId: "main",
|
||||||
|
},
|
||||||
|
] as SemanticAxNode[];
|
||||||
|
expect(
|
||||||
|
discoverRenderedSurfaces([document([domNode(2)], axNodes)], { width: 1280, height: 720 }),
|
||||||
|
).toEqual([expect.objectContaining({ backendNodeId: 2 })]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("discovers unnamed canvases without guessing labels from engineering attributes", () => {
|
||||||
|
const canvas = domNode(2, {
|
||||||
|
attrs: {
|
||||||
|
id: "must-not-be-a-label",
|
||||||
|
class: "must-not-be-a-label",
|
||||||
|
"data-testid": "must-not-be-a-label",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(discoverRenderedSurfaces([document([canvas])], { width: 1280, height: 720 })).toEqual([
|
||||||
|
expect.not.objectContaining({
|
||||||
|
label: expect.anything(),
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("treats blank explicit Canvas names as unnamed", () => {
|
||||||
|
expect(
|
||||||
|
discoverRenderedSurfaces(
|
||||||
|
[document([domNode(2, { attrs: { "aria-label": " ", title: "\n\t" } })])],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
),
|
||||||
|
).toEqual([expect.not.objectContaining({ label: expect.anything() })]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("excludes canvases inside BrowserSkill-owned DOM subtrees", () => {
|
||||||
|
const owner = domNode(1, { tag: "div", rect: null, localRect: null });
|
||||||
|
const canvas = domNode(2, { parentBackendNodeId: 1 });
|
||||||
|
|
||||||
|
expect(
|
||||||
|
discoverRenderedSurfaces(
|
||||||
|
[document([owner, canvas])],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
new Set([1]),
|
||||||
|
),
|
||||||
|
).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("excludes canvases suppressed by a fully transparent ancestor", () => {
|
||||||
|
const owner = domNode(1, {
|
||||||
|
tag: "div",
|
||||||
|
rect: { x: 0, y: 0, w: 900, h: 600 },
|
||||||
|
visuallySuppressed: true,
|
||||||
|
});
|
||||||
|
const canvas = domNode(2, { parentBackendNodeId: 1 });
|
||||||
|
|
||||||
|
expect(
|
||||||
|
discoverRenderedSurfaces([document([owner, canvas])], { width: 1280, height: 720 }),
|
||||||
|
).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("clips canvases to overflow ancestors and drops fully clipped canvases", () => {
|
||||||
|
const owner = domNode(1, {
|
||||||
|
tag: "div",
|
||||||
|
rect: { x: 10, y: 20, w: 100, h: 70 },
|
||||||
|
overflowX: "hidden",
|
||||||
|
overflowY: "hidden",
|
||||||
|
});
|
||||||
|
const partial = domNode(2, {
|
||||||
|
parentBackendNodeId: 1,
|
||||||
|
rect: { x: 55, y: 30, w: 140, h: 60 },
|
||||||
|
});
|
||||||
|
const fullyClipped = domNode(3, {
|
||||||
|
parentBackendNodeId: 1,
|
||||||
|
rect: { x: 140, y: 30, w: 80, h: 50 },
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(
|
||||||
|
discoverRenderedSurfaces([document([owner, partial, fullyClipped])], {
|
||||||
|
width: 1280,
|
||||||
|
height: 720,
|
||||||
|
}),
|
||||||
|
).toEqual([
|
||||||
|
expect.objectContaining({
|
||||||
|
backendNodeId: 2,
|
||||||
|
visibleRect: { x: 55, y: 30, w: 55, h: 60 },
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("rendered surface clustering and projection", () => {
|
||||||
|
it("collapses overlapping canvas layers and attaches them to the nearest retained parent", () => {
|
||||||
|
const body = domNode(1, { tag: "body", rect: null, localRect: null });
|
||||||
|
const surfaces = discoverRenderedSurfaces(
|
||||||
|
[
|
||||||
|
document([
|
||||||
|
body,
|
||||||
|
domNode(2, { parentBackendNodeId: 1, paintOrder: 1 }),
|
||||||
|
domNode(3, { parentBackendNodeId: 1, paintOrder: 2 }),
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
);
|
||||||
|
const groups = clusterRenderedSurfaces(surfaces);
|
||||||
|
const scene: VomScene = {
|
||||||
|
viewport: { width: 1280, height: 720 },
|
||||||
|
nodes: [
|
||||||
|
{
|
||||||
|
id: 10,
|
||||||
|
parentId: null,
|
||||||
|
backendNodeId: 1,
|
||||||
|
frameId: "main",
|
||||||
|
tag: "body",
|
||||||
|
role: "RootWebArea",
|
||||||
|
rect: null,
|
||||||
|
paintOrder: 0,
|
||||||
|
position: "static",
|
||||||
|
pointerEvents: "auto",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(groups).toHaveLength(1);
|
||||||
|
expect(groups[0]?.members).toHaveLength(2);
|
||||||
|
expect(groups[0]?.label).toBeUndefined();
|
||||||
|
expect(
|
||||||
|
projectRenderedSurfaces(
|
||||||
|
scene,
|
||||||
|
[document([body, ...surfaces.map((s) => domNode(s.backendNodeId))])],
|
||||||
|
groups,
|
||||||
|
),
|
||||||
|
).toMatchObject({
|
||||||
|
visualSurfaces: [expect.objectContaining({ parentId: 10, backendNodeId: 3, memberCount: 2 })],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not merge a contained canvas with a larger independent canvas", () => {
|
||||||
|
const groups = clusterRenderedSurfaces([
|
||||||
|
...discoverRenderedSurfaces(
|
||||||
|
[
|
||||||
|
document([
|
||||||
|
domNode(1, { tag: "main", rect: null, localRect: null }),
|
||||||
|
domNode(2, { parentBackendNodeId: 1 }),
|
||||||
|
domNode(3, {
|
||||||
|
parentBackendNodeId: 1,
|
||||||
|
rect: { x: 30, y: 40, w: 200, h: 100 },
|
||||||
|
}),
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
),
|
||||||
|
]);
|
||||||
|
|
||||||
|
expect(groups).toHaveLength(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not merge coincident canvases owned by different containers", () => {
|
||||||
|
const groups = clusterRenderedSurfaces(
|
||||||
|
discoverRenderedSurfaces(
|
||||||
|
[
|
||||||
|
document([
|
||||||
|
domNode(1, { tag: "section", rect: null, localRect: null }),
|
||||||
|
domNode(2, { tag: "section", rect: null, localRect: null }),
|
||||||
|
domNode(3, { parentBackendNodeId: 1 }),
|
||||||
|
domNode(4, { parentBackendNodeId: 2 }),
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
{ width: 1280, height: 720 },
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(groups).toHaveLength(2);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -5,20 +5,21 @@
|
|||||||
// STYLE_COL so capture and visibility policy share one explicit contract.
|
// STYLE_COL so capture and visibility policy share one explicit contract.
|
||||||
|
|
||||||
import type { Rect, Viewport } from "@browser-skill/vom";
|
import type { Rect, Viewport } from "@browser-skill/vom";
|
||||||
import type { CdpTarget } from "@/browser-driver/frame-graph";
|
|
||||||
import { evaluateHoverTrigger } from "@/lib/hover-trigger-policy";
|
import { evaluateHoverTrigger } from "@/lib/hover-trigger-policy";
|
||||||
import { isOverlayHostNode, OVERLAY_HOST_SELECTOR } from "../../lib/overlay-bridge";
|
import { isOverlayHostNode, OVERLAY_HOST_SELECTOR } from "../../lib/overlay-bridge";
|
||||||
import {
|
import { childFrameProjection, type GeometryProjection, projectRectToViewport } from "../geometry";
|
||||||
type FrameProjectionIssue,
|
|
||||||
type FrameProjectionState,
|
|
||||||
projectSnapshotRect,
|
|
||||||
snapshotViewportRect,
|
|
||||||
} from "../geometry/coordinate-types";
|
|
||||||
import { cssViewport, GeometryContext, type LayoutMetrics } from "../geometry/frame-context";
|
|
||||||
import type { CdpRunner } from "../shared";
|
import type { CdpRunner } from "../shared";
|
||||||
import { clearHover, ProbeBudget, waitForHover } from "./hover-perception";
|
import { clearHover, ProbeBudget, waitForHover } from "./hover-perception";
|
||||||
|
|
||||||
const REQUESTED_STYLES = ["position", "pointer-events", "cursor", "visibility", "opacity"] as const;
|
const REQUESTED_STYLES = [
|
||||||
|
"position",
|
||||||
|
"pointer-events",
|
||||||
|
"cursor",
|
||||||
|
"visibility",
|
||||||
|
"opacity",
|
||||||
|
"overflow-x",
|
||||||
|
"overflow-y",
|
||||||
|
] as const;
|
||||||
const STYLE_COL = Object.fromEntries(
|
const STYLE_COL = Object.fromEntries(
|
||||||
REQUESTED_STYLES.map((name, index) => [name, index]),
|
REQUESTED_STYLES.map((name, index) => [name, index]),
|
||||||
) as Record<(typeof REQUESTED_STYLES)[number], number>;
|
) as Record<(typeof REQUESTED_STYLES)[number], number>;
|
||||||
@@ -46,6 +47,10 @@ export interface CapturedNode {
|
|||||||
* `textContent`: the live parser always sets it, hand-built fixtures may not.
|
* `textContent`: the live parser always sets it, hand-built fixtures may not.
|
||||||
*/
|
*/
|
||||||
cursor?: string;
|
cursor?: string;
|
||||||
|
overflowX?: string;
|
||||||
|
overflowY?: string;
|
||||||
|
/** True when this node or one of its DOM ancestors makes the subtree fully transparent/hidden. */
|
||||||
|
visuallySuppressed?: boolean;
|
||||||
/**
|
/**
|
||||||
* Whether the live DOM snapshot provides a painted, non-hidden box for this
|
* Whether the live DOM snapshot provides a painted, non-hidden box for this
|
||||||
* node. Semantic resolution uses this only for DOM fallback nodes; AX-backed
|
* node. Semantic resolution uses this only for DOM fallback nodes; AX-backed
|
||||||
@@ -78,16 +83,12 @@ export interface CapturedViewModel {
|
|||||||
/** Explicit DOMSnapshot frame ancestry; never inferred from backend node ids. */
|
/** Explicit DOMSnapshot frame ancestry; never inferred from backend node ids. */
|
||||||
frameParentIds?: Map<string, string>;
|
frameParentIds?: Map<string, string>;
|
||||||
rootFrameId?: string;
|
rootFrameId?: string;
|
||||||
/** Failed boundaries and descendants blocked by them; clipping is not a failure. */
|
|
||||||
frameGeometryIssues?: FrameProjectionIssue[];
|
|
||||||
/** Backend node ids belonging to the agent overlay host + its shadow subtree. */
|
/** Backend node ids belonging to the agent overlay host + its shadow subtree. */
|
||||||
excludedBackendNodeIds: Set<number>;
|
excludedBackendNodeIds: Set<number>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CaptureViewModelOptions {
|
export interface CaptureViewModelOptions {
|
||||||
signal?: AbortSignal;
|
signal?: AbortSignal;
|
||||||
geometry?: GeometryContext;
|
|
||||||
target?: CdpTarget;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function captureAbortError(): Error {
|
function captureAbortError(): Error {
|
||||||
@@ -158,6 +159,16 @@ interface SnapshotReply {
|
|||||||
documents?: SnapshotDocument[];
|
documents?: SnapshotDocument[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface LayoutMetricsReply {
|
||||||
|
cssLayoutViewport?: {
|
||||||
|
clientWidth?: number;
|
||||||
|
clientHeight?: number;
|
||||||
|
pageX?: number;
|
||||||
|
pageY?: number;
|
||||||
|
};
|
||||||
|
layoutViewport?: { clientWidth?: number; clientHeight?: number; pageX?: number; pageY?: number };
|
||||||
|
}
|
||||||
|
|
||||||
function isFormControlTag(tag: string): boolean {
|
function isFormControlTag(tag: string): boolean {
|
||||||
return tag === "input" || tag === "textarea" || tag === "select";
|
return tag === "input" || tag === "textarea" || tag === "select";
|
||||||
}
|
}
|
||||||
@@ -354,8 +365,7 @@ interface ParseDocumentResult {
|
|||||||
interface FrameContext {
|
interface FrameContext {
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
ownerFrameBackendNodeId: number | null;
|
ownerFrameBackendNodeId: number | null;
|
||||||
projection: FrameProjectionState;
|
projection: GeometryProjection | null;
|
||||||
target: CdpTarget;
|
|
||||||
scrollX: number;
|
scrollX: number;
|
||||||
scrollY: number;
|
scrollY: number;
|
||||||
}
|
}
|
||||||
@@ -365,6 +375,15 @@ function str(strings: string[], idx: number | undefined): string {
|
|||||||
return strings[idx] ?? "";
|
return strings[idx] ?? "";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function devicePixelRatio(metrics: LayoutMetricsReply): number {
|
||||||
|
const layoutW = metrics.layoutViewport?.clientWidth ?? 0;
|
||||||
|
const cssW = metrics.cssLayoutViewport?.clientWidth ?? 0;
|
||||||
|
if (!layoutW || !cssW) return 1;
|
||||||
|
const dpr = layoutW / cssW;
|
||||||
|
if (!Number.isFinite(dpr) || dpr <= 0) return 1;
|
||||||
|
return dpr >= 1 ? dpr : 1;
|
||||||
|
}
|
||||||
|
|
||||||
function sparseIndexMap(sparse: SparseArray | undefined): Map<number, number> {
|
function sparseIndexMap(sparse: SparseArray | undefined): Map<number, number> {
|
||||||
const out = new Map<number, number>();
|
const out = new Map<number, number>();
|
||||||
if (!sparse?.index || !sparse.value) return out;
|
if (!sparse?.index || !sparse.value) return out;
|
||||||
@@ -790,11 +809,13 @@ export async function collectOverlayExcludedBackendIds(
|
|||||||
*
|
*
|
||||||
* @param doc - the raw DOMSnapshot document object
|
* @param doc - the raw DOMSnapshot document object
|
||||||
* @param strings - the shared string table for the whole snapshot
|
* @param strings - the shared string table for the whole snapshot
|
||||||
|
* @param dpr - device-pixel-ratio from Page.getLayoutMetrics
|
||||||
* @param context - frame coordinate context; output rects are top viewport-relative
|
* @param context - frame coordinate context; output rects are top viewport-relative
|
||||||
*/
|
*/
|
||||||
function parseDocumentNodes(
|
function parseDocumentNodes(
|
||||||
doc: SnapshotDocument,
|
doc: SnapshotDocument,
|
||||||
strings: string[],
|
strings: string[],
|
||||||
|
dpr: number,
|
||||||
context: FrameContext,
|
context: FrameContext,
|
||||||
): ParseDocumentResult {
|
): ParseDocumentResult {
|
||||||
const dn = doc.nodes;
|
const dn = doc.nodes;
|
||||||
@@ -840,6 +861,8 @@ function parseDocumentNodes(
|
|||||||
const cursorCol = STYLE_COL.cursor;
|
const cursorCol = STYLE_COL.cursor;
|
||||||
const visibilityCol = STYLE_COL.visibility;
|
const visibilityCol = STYLE_COL.visibility;
|
||||||
const opacityCol = STYLE_COL.opacity;
|
const opacityCol = STYLE_COL.opacity;
|
||||||
|
const overflowXCol = STYLE_COL["overflow-x"];
|
||||||
|
const overflowYCol = STYLE_COL["overflow-y"];
|
||||||
const inputValues = sparseIndexMap(dn.inputValue);
|
const inputValues = sparseIndexMap(dn.inputValue);
|
||||||
const textValues = sparseIndexMap(dn.textValue);
|
const textValues = sparseIndexMap(dn.textValue);
|
||||||
const checkedInputs = new Set(dn.inputChecked?.index ?? []);
|
const checkedInputs = new Set(dn.inputChecked?.index ?? []);
|
||||||
@@ -865,6 +888,7 @@ function parseDocumentNodes(
|
|||||||
|
|
||||||
// Build CapturedNodes.
|
// Build CapturedNodes.
|
||||||
const nodes: CapturedNode[] = [];
|
const nodes: CapturedNode[] = [];
|
||||||
|
const visuallySuppressedByNodeIndex = new Array<boolean>(count).fill(false);
|
||||||
for (let n = 0; n < count; n++) {
|
for (let n = 0; n < count; n++) {
|
||||||
if (excluded[n]) continue;
|
if (excluded[n]) continue;
|
||||||
const backendNodeId = dn.backendNodeId[n];
|
const backendNodeId = dn.backendNodeId[n];
|
||||||
@@ -884,24 +908,24 @@ function parseDocumentNodes(
|
|||||||
let position = "static";
|
let position = "static";
|
||||||
let pointerEvents = "auto";
|
let pointerEvents = "auto";
|
||||||
let cursor = "auto";
|
let cursor = "auto";
|
||||||
|
let overflowX = "visible";
|
||||||
|
let overflowY = "visible";
|
||||||
let rendered = false;
|
let rendered = false;
|
||||||
|
let visuallySuppressed =
|
||||||
|
parentIdx >= 0 ? visuallySuppressedByNodeIndex[parentIdx] === true : false;
|
||||||
const li = layoutByNode.get(n);
|
const li = layoutByNode.get(n);
|
||||||
if (li !== undefined) {
|
if (li !== undefined) {
|
||||||
const b = dl?.bounds?.[li];
|
const b = dl?.bounds?.[li];
|
||||||
if (b && b.length >= 4 && b[2] > 0 && b[3] > 0) {
|
if (b && b.length >= 4 && b[2] > 0 && b[3] > 0) {
|
||||||
const input = snapshotViewportRect(
|
localRect = {
|
||||||
b,
|
x: b[0] / dpr - context.scrollX,
|
||||||
{ target: context.target, frameId: context.frameId },
|
y: b[1] / dpr - context.scrollY,
|
||||||
{ x: context.scrollX, y: context.scrollY },
|
w: b[2] / dpr,
|
||||||
);
|
h: b[3] / dpr,
|
||||||
if (input) {
|
};
|
||||||
const { x, y, width: w, height: h } = input.rect;
|
const bounds = context.projection
|
||||||
localRect = { x, y, w, h };
|
? projectRectToViewport(localRect, context.projection)
|
||||||
}
|
: null;
|
||||||
const bounds =
|
|
||||||
input && context.projection.status === "available"
|
|
||||||
? projectSnapshotRect(input, context.projection.projection)
|
|
||||||
: null;
|
|
||||||
rect = bounds ? { x: bounds.x, y: bounds.y, w: bounds.width, h: bounds.height } : null;
|
rect = bounds ? { x: bounds.x, y: bounds.y, w: bounds.width, h: bounds.height } : null;
|
||||||
}
|
}
|
||||||
paintOrder = dl?.paintOrders?.[li] ?? 0;
|
paintOrder = dl?.paintOrders?.[li] ?? 0;
|
||||||
@@ -911,12 +935,19 @@ function parseDocumentNodes(
|
|||||||
cursor = str(strings, styleRow[cursorCol]) || "auto";
|
cursor = str(strings, styleRow[cursorCol]) || "auto";
|
||||||
const visibility = str(strings, styleRow[visibilityCol]) || "visible";
|
const visibility = str(strings, styleRow[visibilityCol]) || "visible";
|
||||||
const opacity = str(strings, styleRow[opacityCol]) || "1";
|
const opacity = str(strings, styleRow[opacityCol]) || "1";
|
||||||
|
overflowX = str(strings, styleRow[overflowXCol]) || "visible";
|
||||||
|
overflowY = str(strings, styleRow[overflowYCol]) || "visible";
|
||||||
|
visuallySuppressed ||=
|
||||||
|
visibility === "hidden" ||
|
||||||
|
visibility === "collapse" ||
|
||||||
|
(Number.parseFloat(opacity) || 0) <= 0;
|
||||||
rendered =
|
rendered =
|
||||||
localRect !== null &&
|
localRect !== null &&
|
||||||
visibility !== "hidden" &&
|
visibility !== "hidden" &&
|
||||||
visibility !== "collapse" &&
|
visibility !== "collapse" &&
|
||||||
(Number.parseFloat(opacity) || 0) > 0;
|
(Number.parseFloat(opacity) || 0) > 0;
|
||||||
}
|
}
|
||||||
|
visuallySuppressedByNodeIndex[n] = visuallySuppressed;
|
||||||
|
|
||||||
// Skip non-element nodes (#text, #cdata-section, etc.) — they carry no
|
// Skip non-element nodes (#text, #cdata-section, etc.) — they carry no
|
||||||
// geometry and are never queried by callers.
|
// geometry and are never queried by callers.
|
||||||
@@ -951,6 +982,9 @@ function parseDocumentNodes(
|
|||||||
position,
|
position,
|
||||||
pointerEvents,
|
pointerEvents,
|
||||||
cursor,
|
cursor,
|
||||||
|
overflowX,
|
||||||
|
overflowY,
|
||||||
|
visuallySuppressed,
|
||||||
rendered,
|
rendered,
|
||||||
textContent,
|
textContent,
|
||||||
...(formValue !== undefined ? { formValue } : {}),
|
...(formValue !== undefined ? { formValue } : {}),
|
||||||
@@ -969,23 +1003,21 @@ function parseDocumentNodes(
|
|||||||
}
|
}
|
||||||
|
|
||||||
interface ParseFrameDocumentsResult {
|
interface ParseFrameDocumentsResult {
|
||||||
frameGeometryIssues: FrameProjectionIssue[];
|
|
||||||
iframeNodes: CapturedIframeNodes;
|
iframeNodes: CapturedIframeNodes;
|
||||||
frameOwnerBackendNodeIds: Map<string, number>;
|
frameOwnerBackendNodeIds: Map<string, number>;
|
||||||
frameParentIds: Map<string, string>;
|
frameParentIds: Map<string, string>;
|
||||||
excludedBackendNodeIds: Set<number>;
|
excludedBackendNodeIds: Set<number>;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function parseChildFrameDocuments(
|
function parseChildFrameDocuments(
|
||||||
documents: SnapshotDocument[],
|
documents: SnapshotDocument[],
|
||||||
strings: string[],
|
strings: string[],
|
||||||
|
dpr: number,
|
||||||
parentDocIndex: number,
|
parentDocIndex: number,
|
||||||
|
parentNodes: CapturedNode[],
|
||||||
parentContext: FrameContext,
|
parentContext: FrameContext,
|
||||||
geometry: GeometryContext,
|
|
||||||
signal?: AbortSignal,
|
|
||||||
visited = new Set<number>(),
|
visited = new Set<number>(),
|
||||||
): Promise<ParseFrameDocumentsResult> {
|
): ParseFrameDocumentsResult {
|
||||||
const frameGeometryIssues: FrameProjectionIssue[] = [];
|
|
||||||
const iframeNodes: CapturedIframeNodes = new Map();
|
const iframeNodes: CapturedIframeNodes = new Map();
|
||||||
const frameOwnerBackendNodeIds = new Map<string, number>();
|
const frameOwnerBackendNodeIds = new Map<string, number>();
|
||||||
const frameParentIds = new Map<string, string>();
|
const frameParentIds = new Map<string, string>();
|
||||||
@@ -993,80 +1025,26 @@ async function parseChildFrameDocuments(
|
|||||||
const parentDoc = documents[parentDocIndex];
|
const parentDoc = documents[parentDocIndex];
|
||||||
const cdi = sparseIndexMap(parentDoc?.nodes?.contentDocumentIndex);
|
const cdi = sparseIndexMap(parentDoc?.nodes?.contentDocumentIndex);
|
||||||
if (cdi.size === 0) {
|
if (cdi.size === 0) {
|
||||||
return {
|
return { iframeNodes, frameOwnerBackendNodeIds, frameParentIds, excludedBackendNodeIds };
|
||||||
iframeNodes,
|
|
||||||
frameOwnerBackendNodeIds,
|
|
||||||
frameParentIds,
|
|
||||||
excludedBackendNodeIds,
|
|
||||||
frameGeometryIssues,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const parentBackendIds = parentDoc?.nodes?.backendNodeId ?? [];
|
const parentBackendIds = parentDoc?.nodes?.backendNodeId ?? [];
|
||||||
|
const parentNodeByBackendId = new Map(parentNodes.map((node) => [node.backendNodeId, node]));
|
||||||
|
|
||||||
const children = [...cdi].flatMap(([nodeArrayIdx, childDocIndex]) => {
|
for (const [nodeArrayIdx, childDocIndex] of cdi) {
|
||||||
|
if (visited.has(childDocIndex)) continue;
|
||||||
const childDoc = documents[childDocIndex];
|
const childDoc = documents[childDocIndex];
|
||||||
|
if (!childDoc) continue;
|
||||||
const iframeBackendId = parentBackendIds[nodeArrayIdx];
|
const iframeBackendId = parentBackendIds[nodeArrayIdx];
|
||||||
if (visited.has(childDocIndex) || !childDoc || iframeBackendId === undefined) return [];
|
if (iframeBackendId === undefined) continue;
|
||||||
const source = { target: parentContext.target, frameId: snapshotFrameId(childDoc, strings) };
|
const iframeNode = parentNodeByBackendId.get(iframeBackendId);
|
||||||
const parent = parentContext.projection;
|
const projection =
|
||||||
const projection: FrameProjectionState =
|
parentContext.projection && iframeNode?.localRect
|
||||||
parent.status === "available"
|
? childFrameProjection(parentContext.projection, iframeNode.localRect)
|
||||||
? { status: "unavailable", source, ownerBackendNodeId: iframeBackendId }
|
: null;
|
||||||
: { status: "blocked", source, cause: parent.status === "blocked" ? parent.cause : parent };
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
childDocIndex,
|
|
||||||
childDoc,
|
|
||||||
iframeBackendId,
|
|
||||||
source,
|
|
||||||
projection: projection as FrameProjectionState,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
});
|
|
||||||
const parentProjection =
|
|
||||||
parentContext.projection.status === "available"
|
|
||||||
? parentContext.projection.projection.geometry
|
|
||||||
: null;
|
|
||||||
if (parentProjection) {
|
|
||||||
// Measure only direct siblings. Recursion starts after these workers finish,
|
|
||||||
// so descendants never hold or recursively acquire a measurement slot.
|
|
||||||
const edge = parentProjection.edges[0];
|
|
||||||
const clips = edge
|
|
||||||
? [edge.destinationQuad, ...(edge.destinationClips ?? [])]
|
|
||||||
: parentProjection.sourceClips;
|
|
||||||
let cursor = 0;
|
|
||||||
let failure: unknown;
|
|
||||||
await Promise.all(
|
|
||||||
Array.from({ length: Math.min(4, children.length) }, async () => {
|
|
||||||
while (cursor < children.length && !signal?.aborted && !failure) {
|
|
||||||
const child = children[cursor++];
|
|
||||||
try {
|
|
||||||
// Owner quads are target-relative; do not apply the parent transform twice.
|
|
||||||
child.projection = await geometry.snapshotProjection(
|
|
||||||
child.source,
|
|
||||||
child.iframeBackendId,
|
|
||||||
clips,
|
|
||||||
parentProjection.topViewport,
|
|
||||||
);
|
|
||||||
} catch (error) {
|
|
||||||
failure ??= error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
// Join all active reads, including object cleanup, before propagating abort.
|
|
||||||
if (failure) throw failure;
|
|
||||||
}
|
|
||||||
throwIfAborted(signal);
|
|
||||||
|
|
||||||
// Completion order must not change document traversal or result insertion order.
|
|
||||||
for (const { childDocIndex, childDoc, iframeBackendId, source, projection } of children) {
|
|
||||||
throwIfAborted(signal);
|
|
||||||
if (projection.status !== "available") frameGeometryIssues.push(projection);
|
|
||||||
const childContext: FrameContext = {
|
const childContext: FrameContext = {
|
||||||
frameId: source.frameId,
|
frameId: snapshotFrameId(childDoc, strings),
|
||||||
target: source.target,
|
|
||||||
ownerFrameBackendNodeId: iframeBackendId,
|
ownerFrameBackendNodeId: iframeBackendId,
|
||||||
projection,
|
projection,
|
||||||
scrollX: childDoc.scrollOffsetX ?? 0,
|
scrollX: childDoc.scrollOffsetX ?? 0,
|
||||||
@@ -1074,7 +1052,7 @@ async function parseChildFrameDocuments(
|
|||||||
};
|
};
|
||||||
const nextVisited = new Set(visited);
|
const nextVisited = new Set(visited);
|
||||||
nextVisited.add(childDocIndex);
|
nextVisited.add(childDocIndex);
|
||||||
const parsed = parseDocumentNodes(childDoc, strings, childContext);
|
const parsed = parseDocumentNodes(childDoc, strings, dpr, childContext);
|
||||||
iframeNodes.set(iframeBackendId, parsed.nodes);
|
iframeNodes.set(iframeBackendId, parsed.nodes);
|
||||||
if (childContext.frameId) {
|
if (childContext.frameId) {
|
||||||
frameOwnerBackendNodeIds.set(childContext.frameId, iframeBackendId);
|
frameOwnerBackendNodeIds.set(childContext.frameId, iframeBackendId);
|
||||||
@@ -1082,16 +1060,15 @@ async function parseChildFrameDocuments(
|
|||||||
}
|
}
|
||||||
for (const id of parsed.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
for (const id of parsed.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
||||||
|
|
||||||
const nested = await parseChildFrameDocuments(
|
const nested = parseChildFrameDocuments(
|
||||||
documents,
|
documents,
|
||||||
strings,
|
strings,
|
||||||
|
dpr,
|
||||||
childDocIndex,
|
childDocIndex,
|
||||||
|
parsed.nodes,
|
||||||
childContext,
|
childContext,
|
||||||
geometry,
|
|
||||||
signal,
|
|
||||||
nextVisited,
|
nextVisited,
|
||||||
);
|
);
|
||||||
frameGeometryIssues.push(...nested.frameGeometryIssues);
|
|
||||||
for (const [nestedFrameId, nestedNodes] of nested.iframeNodes) {
|
for (const [nestedFrameId, nestedNodes] of nested.iframeNodes) {
|
||||||
iframeNodes.set(nestedFrameId, nestedNodes);
|
iframeNodes.set(nestedFrameId, nestedNodes);
|
||||||
}
|
}
|
||||||
@@ -1104,13 +1081,7 @@ async function parseChildFrameDocuments(
|
|||||||
for (const id of nested.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
for (const id of nested.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return { iframeNodes, frameOwnerBackendNodeIds, frameParentIds, excludedBackendNodeIds };
|
||||||
iframeNodes,
|
|
||||||
frameOwnerBackendNodeIds,
|
|
||||||
frameParentIds,
|
|
||||||
excludedBackendNodeIds,
|
|
||||||
frameGeometryIssues,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function captureViewModel(
|
export async function captureViewModel(
|
||||||
@@ -1119,20 +1090,22 @@ export async function captureViewModel(
|
|||||||
options: CaptureViewModelOptions = {},
|
options: CaptureViewModelOptions = {},
|
||||||
): Promise<CapturedViewModel> {
|
): Promise<CapturedViewModel> {
|
||||||
throwIfAborted(options.signal);
|
throwIfAborted(options.signal);
|
||||||
const target = options.target ?? { tabId };
|
let metrics: LayoutMetricsReply = {};
|
||||||
const geometry = options.geometry ?? new GeometryContext(cdp, tabId, undefined, options.signal);
|
|
||||||
let metrics: LayoutMetrics = {};
|
|
||||||
try {
|
try {
|
||||||
metrics = await geometry.layoutMetrics(target);
|
metrics = await cdp.send<LayoutMetricsReply>(tabId, "Page.getLayoutMetrics", {});
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (isAbortError(error)) throw error;
|
if (isAbortError(error)) throw error;
|
||||||
console.debug("[bsk capture] layout metrics unavailable", error);
|
console.debug("[bsk capture] layout metrics unavailable", error);
|
||||||
}
|
}
|
||||||
throwIfAborted(options.signal);
|
throwIfAborted(options.signal);
|
||||||
const measured = cssViewport(metrics);
|
const dpr = devicePixelRatio(metrics);
|
||||||
const viewport: Viewport = { width: measured.width, height: measured.height };
|
const vpSrc = metrics.cssLayoutViewport ?? metrics.layoutViewport ?? {};
|
||||||
const scrollX = measured.scrollX;
|
const viewport: Viewport = {
|
||||||
const scrollY = measured.scrollY;
|
width: vpSrc.clientWidth ?? 0,
|
||||||
|
height: vpSrc.clientHeight ?? 0,
|
||||||
|
};
|
||||||
|
const scrollX = vpSrc.pageX ?? 0;
|
||||||
|
const scrollY = vpSrc.pageY ?? 0;
|
||||||
|
|
||||||
await cdp.send(tabId, "DOMSnapshot.enable", {});
|
await cdp.send(tabId, "DOMSnapshot.enable", {});
|
||||||
throwIfAborted(options.signal);
|
throwIfAborted(options.signal);
|
||||||
@@ -1158,37 +1131,19 @@ export async function captureViewModel(
|
|||||||
const topContext: FrameContext = {
|
const topContext: FrameContext = {
|
||||||
frameId: snapshotFrameId(doc0, strings),
|
frameId: snapshotFrameId(doc0, strings),
|
||||||
ownerFrameBackendNodeId: null,
|
ownerFrameBackendNodeId: null,
|
||||||
target,
|
|
||||||
projection: {
|
projection: {
|
||||||
status: "available",
|
sourceClips: [],
|
||||||
projection: {
|
edges: [],
|
||||||
source: { target, frameId: snapshotFrameId(doc0, strings) },
|
topViewport: viewport,
|
||||||
geometry: { sourceClips: [], edges: [], topViewport: viewport },
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
scrollX,
|
scrollX,
|
||||||
scrollY,
|
scrollY,
|
||||||
};
|
};
|
||||||
const mainParsed = parseDocumentNodes(doc0, strings, topContext);
|
const mainParsed = parseDocumentNodes(doc0, strings, dpr, topContext);
|
||||||
const nodes = mainParsed.nodes;
|
const nodes = mainParsed.nodes;
|
||||||
const excludedBackendNodeIds = new Set(mainParsed.excludedBackendNodeIds);
|
const excludedBackendNodeIds = new Set(mainParsed.excludedBackendNodeIds);
|
||||||
|
|
||||||
const ownerIds = new Set<number>();
|
const frameParsed = parseChildFrameDocuments(documents, strings, dpr, 0, nodes, topContext);
|
||||||
for (const document of documents) {
|
|
||||||
for (const index of document.nodes?.contentDocumentIndex?.index ?? []) {
|
|
||||||
const id = document.nodes?.backendNodeId?.[index];
|
|
||||||
if (id !== undefined) ownerIds.add(id);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
geometry.registerSnapshotOwners(target, ownerIds);
|
|
||||||
const frameParsed = await parseChildFrameDocuments(
|
|
||||||
documents,
|
|
||||||
strings,
|
|
||||||
0,
|
|
||||||
topContext,
|
|
||||||
geometry,
|
|
||||||
options.signal,
|
|
||||||
);
|
|
||||||
const iframeNodes = frameParsed.iframeNodes;
|
const iframeNodes = frameParsed.iframeNodes;
|
||||||
for (const id of frameParsed.excludedBackendNodeIds) {
|
for (const id of frameParsed.excludedBackendNodeIds) {
|
||||||
excludedBackendNodeIds.add(id);
|
excludedBackendNodeIds.add(id);
|
||||||
@@ -1214,7 +1169,6 @@ export async function captureViewModel(
|
|||||||
viewport,
|
viewport,
|
||||||
iframeNodes,
|
iframeNodes,
|
||||||
frameNodes,
|
frameNodes,
|
||||||
frameGeometryIssues: frameParsed.frameGeometryIssues,
|
|
||||||
frameOwnerBackendNodeIds: frameParsed.frameOwnerBackendNodeIds,
|
frameOwnerBackendNodeIds: frameParsed.frameOwnerBackendNodeIds,
|
||||||
frameParentIds: frameParsed.frameParentIds,
|
frameParentIds: frameParsed.frameParentIds,
|
||||||
...(topContext.frameId ? { rootFrameId: topContext.frameId } : {}),
|
...(topContext.frameId ? { rootFrameId: topContext.frameId } : {}),
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import type { CdpFrame, CdpFrameGraph } from "@/browser-driver/frame-graph";
|
import type { CdpFrame, CdpFrameGraph } from "@/browser-driver/frame-graph";
|
||||||
|
import { resolveFrameProjection } from "../frame-geometry";
|
||||||
import { type GeometryProjection, projectRectToViewport } from "../geometry";
|
import { type GeometryProjection, projectRectToViewport } from "../geometry";
|
||||||
import { GeometryContext } from "../geometry/frame-context";
|
|
||||||
import { type CdpRunner, cdpRunnerForTarget, sendToCdpTarget } from "../shared";
|
import { type CdpRunner, cdpRunnerForTarget, sendToCdpTarget } from "../shared";
|
||||||
import { type CapturedNode, type CapturedViewModel, captureViewModel } from "./capture";
|
import { type CapturedNode, type CapturedViewModel, captureViewModel } from "./capture";
|
||||||
import {
|
import {
|
||||||
@@ -21,6 +21,16 @@ function isAbortError(err: unknown): boolean {
|
|||||||
return err instanceof Error && err.name === "AbortError";
|
return err instanceof Error && err.name === "AbortError";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function discoverFrameGraph(cdp: CdpRunner, tabId: number): Promise<CdpFrameGraph | null> {
|
||||||
|
if (!cdp.getFrameGraph) return null;
|
||||||
|
try {
|
||||||
|
return await cdp.getFrameGraph(tabId);
|
||||||
|
} catch (err) {
|
||||||
|
console.debug("[bsk observation] frame graph capture failed", err);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function transformFrameNodes(
|
function transformFrameNodes(
|
||||||
nodes: CapturedNode[],
|
nodes: CapturedNode[],
|
||||||
projection: GeometryProjection | null,
|
projection: GeometryProjection | null,
|
||||||
@@ -41,7 +51,6 @@ async function captureMissingFrameDocuments(
|
|||||||
tabId: number,
|
tabId: number,
|
||||||
graph: CdpFrameGraph,
|
graph: CdpFrameGraph,
|
||||||
captured: CapturedViewModel,
|
captured: CapturedViewModel,
|
||||||
geometry: GeometryContext,
|
|
||||||
signal?: AbortSignal,
|
signal?: AbortSignal,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (!captured.frameNodes) captured.frameNodes = new Map();
|
if (!captured.frameNodes) captured.frameNodes = new Map();
|
||||||
@@ -53,15 +62,10 @@ async function captureMissingFrameDocuments(
|
|||||||
try {
|
try {
|
||||||
const child = await captureViewModel(cdpRunnerForTarget(cdp, frame.target), tabId, {
|
const child = await captureViewModel(cdpRunnerForTarget(cdp, frame.target), tabId, {
|
||||||
signal,
|
signal,
|
||||||
geometry,
|
|
||||||
target: frame.target,
|
|
||||||
});
|
});
|
||||||
if (child.frameGeometryIssues?.length) {
|
|
||||||
(captured.frameGeometryIssues ??= []).push(...child.frameGeometryIssues);
|
|
||||||
}
|
|
||||||
let projection: GeometryProjection | null = null;
|
let projection: GeometryProjection | null = null;
|
||||||
try {
|
try {
|
||||||
projection = await geometry.targetProjection(frame.frameId);
|
projection = await resolveFrameProjection(cdp, graph, frame.frameId);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
if (isAbortError(err)) throw err;
|
if (isAbortError(err)) throw err;
|
||||||
console.debug("[bsk observation] child frame geometry projection failed", {
|
console.debug("[bsk observation] child frame geometry projection failed", {
|
||||||
@@ -167,11 +171,10 @@ export async function captureFrameData<T extends FrameAxNode>(
|
|||||||
tabId: number,
|
tabId: number,
|
||||||
captured: CapturedViewModel,
|
captured: CapturedViewModel,
|
||||||
signal?: AbortSignal,
|
signal?: AbortSignal,
|
||||||
geometry = new GeometryContext(cdp, tabId, undefined, signal),
|
|
||||||
): Promise<CapturedFrameDocument<T>[]> {
|
): Promise<CapturedFrameDocument<T>[]> {
|
||||||
const graph = await geometry.graph();
|
const graph = await discoverFrameGraph(cdp, tabId);
|
||||||
const frames = graph?.frames ?? [];
|
const frames = graph?.frames ?? [];
|
||||||
if (graph) await captureMissingFrameDocuments(cdp, tabId, graph, captured, geometry, signal);
|
if (graph) await captureMissingFrameDocuments(cdp, tabId, graph, captured, signal);
|
||||||
throwIfAborted(signal);
|
throwIfAborted(signal);
|
||||||
const batches = await captureAxTrees<T>(cdp, tabId, frames, captured, signal);
|
const batches = await captureAxTrees<T>(cdp, tabId, frames, captured, signal);
|
||||||
return buildFrameDocuments(graph, batches, captured);
|
return buildFrameDocuments(graph, batches, captured);
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
import type { RenderedSurface, RenderedSurfaceGroup } from "./types";
|
||||||
|
|
||||||
|
const STACK_IOU_RATIO = 0.9;
|
||||||
|
const STACK_SIZE_RATIO = 0.9;
|
||||||
|
|
||||||
|
function area(rect: Rect): number {
|
||||||
|
return Math.max(0, rect.w) * Math.max(0, rect.h);
|
||||||
|
}
|
||||||
|
|
||||||
|
function intersectionArea(a: Rect, b: Rect): number {
|
||||||
|
const width = Math.max(0, Math.min(a.x + a.w, b.x + b.w) - Math.max(a.x, b.x));
|
||||||
|
const height = Math.max(0, Math.min(a.y + a.h, b.y + b.h) - Math.max(a.y, b.y));
|
||||||
|
return width * height;
|
||||||
|
}
|
||||||
|
|
||||||
|
function sameVisualStack(a: RenderedSurface, b: RenderedSurface): boolean {
|
||||||
|
if (a.frameId !== b.frameId) return false;
|
||||||
|
if (a.parentBackendNodeId !== b.parentBackendNodeId) return false;
|
||||||
|
const aArea = area(a.visibleRect);
|
||||||
|
const bArea = area(b.visibleRect);
|
||||||
|
const intersection = intersectionArea(a.visibleRect, b.visibleRect);
|
||||||
|
const union = aArea + bArea - intersection;
|
||||||
|
const widthRatio =
|
||||||
|
Math.min(a.visibleRect.w, b.visibleRect.w) / Math.max(a.visibleRect.w, b.visibleRect.w);
|
||||||
|
const heightRatio =
|
||||||
|
Math.min(a.visibleRect.h, b.visibleRect.h) / Math.max(a.visibleRect.h, b.visibleRect.h);
|
||||||
|
return (
|
||||||
|
union > 0 &&
|
||||||
|
intersection / union >= STACK_IOU_RATIO &&
|
||||||
|
widthRatio >= STACK_SIZE_RATIO &&
|
||||||
|
heightRatio >= STACK_SIZE_RATIO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function toGroup(members: RenderedSurface[]): RenderedSurfaceGroup {
|
||||||
|
const representative = [...members].sort(
|
||||||
|
(a, b) => area(b.visibleRect) - area(a.visibleRect) || b.paintOrder - a.paintOrder,
|
||||||
|
)[0];
|
||||||
|
return {
|
||||||
|
frameId: representative.frameId,
|
||||||
|
members,
|
||||||
|
representative,
|
||||||
|
label: members.map((surface) => surface.label).find((label) => label !== undefined),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function clusterRenderedSurfaces(surfaces: RenderedSurface[]): RenderedSurfaceGroup[] {
|
||||||
|
const groups: RenderedSurface[][] = [];
|
||||||
|
for (const surface of surfaces) {
|
||||||
|
const matching = groups.find((group) =>
|
||||||
|
group.some((member) => sameVisualStack(member, surface)),
|
||||||
|
);
|
||||||
|
if (matching) matching.push(surface);
|
||||||
|
else groups.push([surface]);
|
||||||
|
}
|
||||||
|
return groups
|
||||||
|
.map(toGroup)
|
||||||
|
.sort(
|
||||||
|
(a, b) =>
|
||||||
|
a.frameId.localeCompare(b.frameId) ||
|
||||||
|
a.representative.visibleRect.y - b.representative.visibleRect.y ||
|
||||||
|
a.representative.visibleRect.x - b.representative.visibleRect.x,
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
import type { Rect, Viewport } from "@browser-skill/vom";
|
||||||
|
import type { CapturedNode } from "../capture";
|
||||||
|
import type { CapturedFrameDocument } from "../frame-capture";
|
||||||
|
import type { SemanticAxNode } from "../semantic-graph";
|
||||||
|
import type { RenderedSurface } from "./types";
|
||||||
|
|
||||||
|
function clean(value: string | undefined): string | undefined {
|
||||||
|
const normalized = value?.replace(/\s+/g, " ").trim();
|
||||||
|
return normalized || undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
function intersectViewport(rect: Rect, viewport: Viewport): Rect | null {
|
||||||
|
return intersectRect(rect, { x: 0, y: 0, w: viewport.width, h: viewport.height });
|
||||||
|
}
|
||||||
|
|
||||||
|
function intersectRect(a: Rect, b: Rect): Rect | null {
|
||||||
|
const x = Math.max(a.x, b.x);
|
||||||
|
const y = Math.max(a.y, b.y);
|
||||||
|
const right = Math.min(a.x + a.w, b.x + b.w);
|
||||||
|
const bottom = Math.min(a.y + a.h, b.y + b.h);
|
||||||
|
if (right <= x || bottom <= y) return null;
|
||||||
|
return { x, y, w: right - x, h: bottom - y };
|
||||||
|
}
|
||||||
|
|
||||||
|
const CLIPPING_OVERFLOW = new Set(["auto", "clip", "hidden", "scroll"]);
|
||||||
|
|
||||||
|
function clipToOverflowAncestors(
|
||||||
|
node: CapturedNode,
|
||||||
|
rect: Rect,
|
||||||
|
nodesByBackend: ReadonlyMap<number, CapturedNode>,
|
||||||
|
): Rect | null {
|
||||||
|
let clipped: Rect | null = rect;
|
||||||
|
let parentBackendNodeId = node.parentBackendNodeId;
|
||||||
|
let guard = 0;
|
||||||
|
while (clipped && parentBackendNodeId !== null && guard <= nodesByBackend.size) {
|
||||||
|
const parent = nodesByBackend.get(parentBackendNodeId);
|
||||||
|
if (!parent) break;
|
||||||
|
if (parent.rect) {
|
||||||
|
const clipX = CLIPPING_OVERFLOW.has(parent.overflowX ?? "visible");
|
||||||
|
const clipY = CLIPPING_OVERFLOW.has(parent.overflowY ?? "visible");
|
||||||
|
if (clipX || clipY) {
|
||||||
|
const clipRect = {
|
||||||
|
x: clipX ? parent.rect.x : clipped.x,
|
||||||
|
y: clipY ? parent.rect.y : clipped.y,
|
||||||
|
w: clipX ? parent.rect.w : clipped.w,
|
||||||
|
h: clipY ? parent.rect.h : clipped.h,
|
||||||
|
};
|
||||||
|
clipped = intersectRect(clipped, clipRect);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
parentBackendNodeId = parent.parentBackendNodeId;
|
||||||
|
guard += 1;
|
||||||
|
}
|
||||||
|
return clipped;
|
||||||
|
}
|
||||||
|
|
||||||
|
function excludedByDomPolicy(
|
||||||
|
node: CapturedNode,
|
||||||
|
nodesByBackend: Map<number, CapturedNode>,
|
||||||
|
excludedBackendNodeIds: ReadonlySet<number>,
|
||||||
|
): boolean {
|
||||||
|
let current: CapturedNode | undefined = node;
|
||||||
|
let guard = 0;
|
||||||
|
while (current && guard <= nodesByBackend.size) {
|
||||||
|
if (excludedBackendNodeIds.has(current.backendNodeId)) return true;
|
||||||
|
if (current.visuallySuppressed === true) return true;
|
||||||
|
const attrs = current.attrs;
|
||||||
|
if (
|
||||||
|
Object.prototype.hasOwnProperty.call(attrs, "hidden") ||
|
||||||
|
Object.prototype.hasOwnProperty.call(attrs, "inert") ||
|
||||||
|
(attrs["aria-hidden"] ?? "").toLowerCase() === "true"
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
current =
|
||||||
|
current.parentBackendNodeId === null
|
||||||
|
? undefined
|
||||||
|
: nodesByBackend.get(current.parentBackendNodeId);
|
||||||
|
guard += 1;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function discoverRenderedSurfaces(
|
||||||
|
documents: CapturedFrameDocument<SemanticAxNode>[],
|
||||||
|
viewport: Viewport,
|
||||||
|
excludedBackendNodeIds: ReadonlySet<number> = new Set(),
|
||||||
|
): RenderedSurface[] {
|
||||||
|
const surfaces: RenderedSurface[] = [];
|
||||||
|
for (const document of documents) {
|
||||||
|
const nodesByBackend = new Map(document.domNodes.map((node) => [node.backendNodeId, node]));
|
||||||
|
for (const node of document.domNodes) {
|
||||||
|
if (node.tag.toLowerCase() !== "canvas" || node.rendered !== true || !node.rect) continue;
|
||||||
|
if (excludedByDomPolicy(node, nodesByBackend, excludedBackendNodeIds)) continue;
|
||||||
|
const viewportRect = intersectViewport(node.rect, viewport);
|
||||||
|
const visibleRect = viewportRect
|
||||||
|
? clipToOverflowAncestors(node, viewportRect, nodesByBackend)
|
||||||
|
: null;
|
||||||
|
if (!visibleRect) continue;
|
||||||
|
const label = clean(node.attrs["aria-label"] ?? node.attrs.title);
|
||||||
|
surfaces.push({
|
||||||
|
renderingKind: "canvas",
|
||||||
|
frameId: document.frameId,
|
||||||
|
backendNodeId: node.backendNodeId,
|
||||||
|
parentBackendNodeId: node.parentBackendNodeId,
|
||||||
|
visibleRect,
|
||||||
|
paintOrder: node.paintOrder,
|
||||||
|
...(label ? { label } : {}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return surfaces;
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
export { clusterRenderedSurfaces } from "./cluster";
|
||||||
|
export { discoverRenderedSurfaces } from "./discovery";
|
||||||
|
export { projectRenderedSurfaces } from "./project";
|
||||||
|
export type { RenderedSurface, RenderedSurfaceGroup } from "./types";
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
import type { VomScene, VomVisualSurface } from "@browser-skill/vom";
|
||||||
|
import type { CapturedFrameDocument } from "../frame-capture";
|
||||||
|
import type { SemanticAxNode } from "../semantic-graph";
|
||||||
|
import type { RenderedSurfaceGroup } from "./types";
|
||||||
|
|
||||||
|
function frameBackendKey(frameId: string, backendNodeId: number): string {
|
||||||
|
return `${frameId}\u0000${backendNodeId}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ProjectionIndex {
|
||||||
|
sceneByBackend: ReadonlyMap<string, number>;
|
||||||
|
documentByFrame: ReadonlyMap<string, CapturedFrameDocument<SemanticAxNode>>;
|
||||||
|
domByFrame: ReadonlyMap<
|
||||||
|
string,
|
||||||
|
ReadonlyMap<number, CapturedFrameDocument<SemanticAxNode>["domNodes"][number]>
|
||||||
|
>;
|
||||||
|
rootSceneIdByFrame: ReadonlyMap<string, number>;
|
||||||
|
}
|
||||||
|
|
||||||
|
function nearestSceneParent(index: ProjectionIndex, group: RenderedSurfaceGroup): number | null {
|
||||||
|
const document = index.documentByFrame.get(group.frameId);
|
||||||
|
const domByBackend = index.domByFrame.get(group.frameId) ?? new Map();
|
||||||
|
let parentBackendNodeId = group.representative.parentBackendNodeId;
|
||||||
|
let guard = 0;
|
||||||
|
while (parentBackendNodeId !== null && guard <= domByBackend.size) {
|
||||||
|
const sceneId = index.sceneByBackend.get(frameBackendKey(group.frameId, parentBackendNodeId));
|
||||||
|
if (sceneId !== undefined) return sceneId;
|
||||||
|
parentBackendNodeId = domByBackend.get(parentBackendNodeId)?.parentBackendNodeId ?? null;
|
||||||
|
guard += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document?.parentFrameId && document.ownerBackendNodeId !== undefined) {
|
||||||
|
const owner = index.sceneByBackend.get(
|
||||||
|
frameBackendKey(document.parentFrameId, document.ownerBackendNodeId),
|
||||||
|
);
|
||||||
|
if (owner !== undefined) return owner;
|
||||||
|
}
|
||||||
|
|
||||||
|
return index.rootSceneIdByFrame.get(group.frameId) ?? null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildProjectionIndex(
|
||||||
|
scene: VomScene,
|
||||||
|
documents: CapturedFrameDocument<SemanticAxNode>[],
|
||||||
|
): ProjectionIndex {
|
||||||
|
const rootSceneIdByFrame = new Map<string, number>();
|
||||||
|
for (const node of scene.nodes) {
|
||||||
|
if (
|
||||||
|
node.frameId &&
|
||||||
|
!rootSceneIdByFrame.has(node.frameId) &&
|
||||||
|
["rootwebarea", "webarea"].includes(node.role?.toLowerCase() ?? "")
|
||||||
|
) {
|
||||||
|
rootSceneIdByFrame.set(node.frameId, node.id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
sceneByBackend: new Map(
|
||||||
|
scene.nodes.flatMap((node) =>
|
||||||
|
node.backendNodeId === undefined
|
||||||
|
? []
|
||||||
|
: [[frameBackendKey(node.frameId ?? "", node.backendNodeId), node.id] as const],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
documentByFrame: new Map(documents.map((document) => [document.frameId, document])),
|
||||||
|
domByFrame: new Map(
|
||||||
|
documents.map((document) => [
|
||||||
|
document.frameId,
|
||||||
|
new Map(document.domNodes.map((node) => [node.backendNodeId, node])),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
rootSceneIdByFrame,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function projectRenderedSurfaces(
|
||||||
|
scene: VomScene,
|
||||||
|
documents: CapturedFrameDocument<SemanticAxNode>[],
|
||||||
|
groups: RenderedSurfaceGroup[],
|
||||||
|
): VomScene {
|
||||||
|
const index = buildProjectionIndex(scene, documents);
|
||||||
|
const visualSurfaces: VomVisualSurface[] = [];
|
||||||
|
|
||||||
|
for (const group of groups) {
|
||||||
|
const parentId = nearestSceneParent(index, group);
|
||||||
|
visualSurfaces.push({
|
||||||
|
parentId,
|
||||||
|
backendNodeId: group.representative.backendNodeId,
|
||||||
|
frameId: group.frameId,
|
||||||
|
renderingKind: "canvas",
|
||||||
|
visibleRect: group.representative.visibleRect,
|
||||||
|
...(group.label ? { label: group.label } : {}),
|
||||||
|
memberCount: group.members.length,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
...scene,
|
||||||
|
...(visualSurfaces.length > 0 ? { visualSurfaces } : {}),
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
|
||||||
|
export interface RenderedSurface {
|
||||||
|
renderingKind: "canvas";
|
||||||
|
frameId: string;
|
||||||
|
backendNodeId: number;
|
||||||
|
parentBackendNodeId: number | null;
|
||||||
|
visibleRect: Rect;
|
||||||
|
paintOrder: number;
|
||||||
|
label?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RenderedSurfaceGroup {
|
||||||
|
frameId: string;
|
||||||
|
members: RenderedSurface[];
|
||||||
|
representative: RenderedSurface;
|
||||||
|
label?: string;
|
||||||
|
}
|
||||||
@@ -23,6 +23,7 @@ export type ErrorCode =
|
|||||||
export type RpcErrorReason =
|
export type RpcErrorReason =
|
||||||
| "agent_window_scope"
|
| "agent_window_scope"
|
||||||
| "element_not_visible"
|
| "element_not_visible"
|
||||||
|
| "ref_capability_denied"
|
||||||
| "ref_not_found"
|
| "ref_not_found"
|
||||||
| "selector_not_found"
|
| "selector_not_found"
|
||||||
| "target_not_fillable"
|
| "target_not_fillable"
|
||||||
@@ -48,6 +49,11 @@ export type RpcErrorReason =
|
|||||||
| "download_capture_failed"
|
| "download_capture_failed"
|
||||||
| "transfer_outcome_unknown"
|
| "transfer_outcome_unknown"
|
||||||
| "transfer_timeout"
|
| "transfer_timeout"
|
||||||
|
| "surface_capture_not_found"
|
||||||
|
| "surface_capture_expired"
|
||||||
|
| "surface_capture_consumed"
|
||||||
|
| "surface_capture_stale"
|
||||||
|
| "surface_coordinate_invalid"
|
||||||
| "cleanup_failed";
|
| "cleanup_failed";
|
||||||
|
|
||||||
export type TransferEffectState = "none" | "committed" | "unknown";
|
export type TransferEffectState = "none" | "committed" | "unknown";
|
||||||
@@ -319,9 +325,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;
|
||||||
@@ -440,6 +454,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 {
|
||||||
@@ -448,6 +465,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[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,113 @@
|
|||||||
|
# Rendered Surface browser fixtures
|
||||||
|
|
||||||
|
These pages exercise Canvas discovery through a real browser DOMSnapshot and AX tree. They are deliberately framework- and site-independent.
|
||||||
|
|
||||||
|
## Serve
|
||||||
|
|
||||||
|
From the repository root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 -m http.server 4173 --bind 127.0.0.1 \
|
||||||
|
--directory apps/extension/test-fixtures/rendered-surfaces
|
||||||
|
```
|
||||||
|
|
||||||
|
Use an Agent Window large enough to keep the primary matrix visible:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bsk session start --width 1440 --height 1100
|
||||||
|
bsk navigate http://127.0.0.1:4173/index.html --session <id>
|
||||||
|
bsk observe --session <id>
|
||||||
|
```
|
||||||
|
|
||||||
|
Always stop the session after the run.
|
||||||
|
|
||||||
|
## Pages
|
||||||
|
|
||||||
|
### `index.html`
|
||||||
|
|
||||||
|
Expected individual Surface labels:
|
||||||
|
|
||||||
|
- `fixture-basic-large`
|
||||||
|
- `fixture-tiny-8px`
|
||||||
|
- `fixture-pointer-events-none`
|
||||||
|
- `fixture-partial-ax`
|
||||||
|
- `fixture-contained-outer`
|
||||||
|
- `fixture-contained-inner`
|
||||||
|
- `fixture-different-parent-a`
|
||||||
|
- `fixture-different-parent-b`
|
||||||
|
|
||||||
|
Expected one grouped Surface:
|
||||||
|
|
||||||
|
- `fixture-layered-group`, with `layers=2`
|
||||||
|
|
||||||
|
Expected absent:
|
||||||
|
|
||||||
|
- `fixture-display-none`
|
||||||
|
- `fixture-visibility-hidden`
|
||||||
|
- `fixture-opacity-zero`
|
||||||
|
- `fixture-parent-opacity-zero`
|
||||||
|
- `fixture-hidden-attribute`
|
||||||
|
- `fixture-inert-parent`
|
||||||
|
- `fixture-aria-hidden-parent`
|
||||||
|
- `fixture-zero-size`
|
||||||
|
- `fixture-offscreen-right`
|
||||||
|
- `fixture-fully-overflow-clipped`
|
||||||
|
|
||||||
|
`fixture-partially-overflow-clipped` must remain present because part of it is visible. Its screenshot must contain only the browser's final composited view.
|
||||||
|
|
||||||
|
### `unlabeled.html`
|
||||||
|
|
||||||
|
This page contains eight Canvas elements but must render seven generic Surface markers because
|
||||||
|
the two coincident layers form one group.
|
||||||
|
|
||||||
|
- Every marker uses the stable fallback label `canvas visual surface`.
|
||||||
|
- Exactly one marker has `layers=2`.
|
||||||
|
- The two contained canvases remain separate markers.
|
||||||
|
- `id`, `class`, `data-testid`, nearby prose, and fallback AX content never become a Surface label.
|
||||||
|
- Blank `aria-label` and `title` values behave as no label.
|
||||||
|
- Fallback AX content does not suppress the corresponding Surface.
|
||||||
|
|
||||||
|
### `frames.html`
|
||||||
|
|
||||||
|
Expected Surface labels:
|
||||||
|
|
||||||
|
- `fixture-same-origin-frame`
|
||||||
|
- `fixture-cross-origin-frame`
|
||||||
|
- `fixture-nested-frame`
|
||||||
|
|
||||||
|
The cross-origin frame uses `http://localhost:4173` while the parent uses `http://127.0.0.1:4173`. With Chromium site isolation this exercises the OOPIF path without an external service.
|
||||||
|
|
||||||
|
Each frame Canvas also exposes a `pointer status` live region. A successful
|
||||||
|
screenshot-bound point click must report
|
||||||
|
`down button=0 buttons=1 hoverReady=true; click received` and turn the Canvas
|
||||||
|
yellow. The hover flag is set on the animation frame after `pointermove`, so the
|
||||||
|
fixture verifies both child-document delivery and the scheduling boundary
|
||||||
|
required before `pointerdown`, rather than merely validating projected
|
||||||
|
coordinates or a successful CDP response.
|
||||||
|
|
||||||
|
### `viewport.html`
|
||||||
|
|
||||||
|
Run with a `900x700` Agent Window.
|
||||||
|
|
||||||
|
- `fixture-partial-viewport` is partly visible and must be represented.
|
||||||
|
- `fixture-below-fold` is absent initially.
|
||||||
|
- After scrolling it into view and observing again, `fixture-below-fold` must be represented with a fresh ref.
|
||||||
|
|
||||||
|
### `dynamic.html`
|
||||||
|
|
||||||
|
Use the normal DOM buttons and re-observe after each action:
|
||||||
|
|
||||||
|
- Initial state: `fixture-dynamic` absent.
|
||||||
|
- After **Insert canvas**: present.
|
||||||
|
- After **Resize to zero**: absent.
|
||||||
|
- After **Restore size**: present with a fresh ref.
|
||||||
|
- After **Remove canvas**: absent.
|
||||||
|
|
||||||
|
## Invariants
|
||||||
|
|
||||||
|
- `snapshot` must not emit any of these Surface markers.
|
||||||
|
- `observe` must emit only currently visible Canvas surfaces.
|
||||||
|
- Existing DOM/AX controls remain readable alongside Surface markers.
|
||||||
|
- Missing labels never prevent discovery; naming and discovery are independent.
|
||||||
|
- A Surface ref allows `screenshot --ref` and rejects ordinary click/fill/hover/select.
|
||||||
|
- No fixture URL, id, label, or layout constant may appear in production discovery code.
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<title>Rendered Surface dynamic matrix</title>
|
||||||
|
<style>
|
||||||
|
html, body { margin: 0; font: 14px system-ui, sans-serif; }
|
||||||
|
body { padding: 16px; }
|
||||||
|
.controls { display: flex; gap: 8px; margin-bottom: 16px; }
|
||||||
|
button { padding: 8px 12px; }
|
||||||
|
canvas { display: block; width: 260px; height: 120px; background: #e8daef; border: 2px solid #7d3c98; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Dynamic Canvas lifecycle</h1>
|
||||||
|
<div class="controls">
|
||||||
|
<button id="insert" type="button">Insert canvas</button>
|
||||||
|
<button id="zero" type="button">Resize to zero</button>
|
||||||
|
<button id="restore" type="button">Restore size</button>
|
||||||
|
<button id="remove" type="button">Remove canvas</button>
|
||||||
|
</div>
|
||||||
|
<div id="mount"></div>
|
||||||
|
<script>
|
||||||
|
const mount = document.querySelector("#mount");
|
||||||
|
const getCanvas = () => mount.querySelector("canvas");
|
||||||
|
document.querySelector("#insert").addEventListener("click", () => {
|
||||||
|
if (getCanvas()) return;
|
||||||
|
const canvas = document.createElement("canvas");
|
||||||
|
canvas.width = 260;
|
||||||
|
canvas.height = 120;
|
||||||
|
canvas.setAttribute("aria-label", "fixture-dynamic");
|
||||||
|
mount.append(canvas);
|
||||||
|
});
|
||||||
|
document.querySelector("#zero").addEventListener("click", () => {
|
||||||
|
const canvas = getCanvas();
|
||||||
|
if (canvas) canvas.style.cssText = "width:0;height:0;border:0";
|
||||||
|
});
|
||||||
|
document.querySelector("#restore").addEventListener("click", () => {
|
||||||
|
const canvas = getCanvas();
|
||||||
|
if (canvas) canvas.removeAttribute("style");
|
||||||
|
});
|
||||||
|
document.querySelector("#remove").addEventListener("click", () => getCanvas()?.remove());
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<style>
|
||||||
|
html, body { margin: 0; font: 14px system-ui, sans-serif; }
|
||||||
|
body { padding: 12px; background: #fdfefe; }
|
||||||
|
canvas { display: block; width: 220px; height: 90px; background: #d5f5e3; border: 2px solid #1e8449; }
|
||||||
|
iframe { width: 280px; height: 150px; margin-top: 10px; border: 2px solid #85929e; }
|
||||||
|
#pointer-status { margin: 8px 0 0; min-height: 20px; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<canvas id="frame-canvas" width="220" height="90"></canvas>
|
||||||
|
<script>
|
||||||
|
const params = new URLSearchParams(location.search);
|
||||||
|
const canvas = document.querySelector("#frame-canvas");
|
||||||
|
if (params.get("canvas") === "0") canvas.remove();
|
||||||
|
else {
|
||||||
|
canvas.setAttribute("aria-label", params.get("label") || "fixture-frame-default");
|
||||||
|
if (params.get("interactive") === "1") {
|
||||||
|
const status = document.createElement("p");
|
||||||
|
status.id = "pointer-status";
|
||||||
|
status.setAttribute("aria-live", "polite");
|
||||||
|
status.textContent = "pointer status: idle";
|
||||||
|
canvas.insertAdjacentElement("afterend", status);
|
||||||
|
let hoverReady = false;
|
||||||
|
canvas.addEventListener("pointermove", () => {
|
||||||
|
hoverReady = false;
|
||||||
|
requestAnimationFrame(() => {
|
||||||
|
hoverReady = true;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
canvas.addEventListener("pointerdown", (event) => {
|
||||||
|
status.textContent = `pointer status: down button=${event.button} buttons=${event.buttons} hoverReady=${hoverReady}`;
|
||||||
|
if (event.buttons === 1 && hoverReady) canvas.style.background = "#f9e79f";
|
||||||
|
});
|
||||||
|
canvas.addEventListener("click", () => {
|
||||||
|
status.textContent += "; click received";
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (params.get("nested") === "1") {
|
||||||
|
const iframe = document.createElement("iframe");
|
||||||
|
iframe.title = "nested fixture frame";
|
||||||
|
iframe.src = "frame.html?label=fixture-nested-frame&interactive=1";
|
||||||
|
document.body.append(iframe);
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<title>Rendered Surface frame matrix</title>
|
||||||
|
<style>
|
||||||
|
html, body { margin: 0; font: 14px system-ui, sans-serif; }
|
||||||
|
body { padding: 16px; }
|
||||||
|
.frames { display: grid; grid-template-columns: repeat(3, 320px); gap: 16px; }
|
||||||
|
iframe { width: 300px; height: 300px; border: 2px solid #5d6d7e; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Frame matrix</h1>
|
||||||
|
<div class="frames">
|
||||||
|
<iframe title="same-origin fixture" src="frame.html?label=fixture-same-origin-frame&interactive=1"></iframe>
|
||||||
|
<iframe title="cross-origin fixture" src="http://localhost:4173/frame.html?label=fixture-cross-origin-frame&interactive=1"></iframe>
|
||||||
|
<iframe title="nested fixture" src="frame.html?canvas=0&nested=1"></iframe>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<title>Rendered Surface discovery matrix</title>
|
||||||
|
<style>
|
||||||
|
* { box-sizing: border-box; }
|
||||||
|
html, body { margin: 0; min-height: 100%; font: 14px/1.4 system-ui, sans-serif; }
|
||||||
|
body { padding: 16px; background: #f4f6f8; color: #17202a; }
|
||||||
|
h1 { margin: 0 0 12px; font-size: 20px; }
|
||||||
|
.matrix { display: grid; grid-template-columns: repeat(4, minmax(220px, 1fr)); gap: 12px; }
|
||||||
|
.case { min-height: 150px; padding: 10px; overflow: hidden; border: 1px solid #aeb6bf; border-radius: 6px; background: white; }
|
||||||
|
.case h2 { margin: 0 0 8px; font-size: 13px; }
|
||||||
|
canvas { display: block; background: #d6eaf8; border: 2px solid #2874a6; }
|
||||||
|
.stack { position: relative; width: 180px; height: 90px; }
|
||||||
|
.stack canvas { position: absolute; inset: 0; width: 180px; height: 90px; }
|
||||||
|
.stack canvas + canvas { background: rgb(244 208 63 / 45%); border-color: #b7950b; }
|
||||||
|
.contained { position: relative; width: 190px; height: 100px; }
|
||||||
|
.contained > canvas:first-child { width: 190px; height: 100px; }
|
||||||
|
.contained > canvas:last-child { position: absolute; left: 55px; top: 30px; width: 70px; height: 40px; background: #fadbd8; border-color: #c0392b; }
|
||||||
|
.same-place { position: relative; width: 180px; height: 90px; }
|
||||||
|
.same-place > div { position: absolute; inset: 0; }
|
||||||
|
.same-place canvas { width: 180px; height: 90px; }
|
||||||
|
.same-place > div:last-child canvas { border-color: #7d3c98; background: rgb(210 180 222 / 35%); }
|
||||||
|
.clip-box { width: 100px; height: 70px; overflow: hidden; border: 2px dashed #566573; }
|
||||||
|
.partially-clipped { width: 140px; height: 60px; transform: translateX(45px); }
|
||||||
|
.fully-clipped { width: 80px; height: 50px; transform: translateX(130px); }
|
||||||
|
.tiny { width: 8px; height: 8px; border-width: 1px; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Rendered Surface discovery matrix</h1>
|
||||||
|
<main class="matrix">
|
||||||
|
<section class="case">
|
||||||
|
<h2>Visible named canvas</h2>
|
||||||
|
<canvas aria-label="fixture-basic-large" width="200" height="90"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Tiny canvas remains addressable</h2>
|
||||||
|
<canvas class="tiny" aria-label="fixture-tiny-8px" width="8" height="8"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Visible but pointer-events none</h2>
|
||||||
|
<canvas aria-label="fixture-pointer-events-none" width="180" height="80" style="pointer-events: none"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Partial AX/fallback content</h2>
|
||||||
|
<canvas aria-label="fixture-partial-ax" width="180" height="80">
|
||||||
|
<button type="button">Fallback button must not suppress the surface</button>
|
||||||
|
</canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Two real rendering layers</h2>
|
||||||
|
<div class="stack">
|
||||||
|
<canvas aria-label="fixture-layered-group" width="180" height="90"></canvas>
|
||||||
|
<canvas width="180" height="90"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Contained canvases are independent</h2>
|
||||||
|
<div class="contained">
|
||||||
|
<canvas aria-label="fixture-contained-outer" width="190" height="100"></canvas>
|
||||||
|
<canvas aria-label="fixture-contained-inner" width="70" height="40"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Same geometry, different parents</h2>
|
||||||
|
<div class="same-place">
|
||||||
|
<div><canvas aria-label="fixture-different-parent-a" width="180" height="90"></canvas></div>
|
||||||
|
<div><canvas aria-label="fixture-different-parent-b" width="180" height="90"></canvas></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Partially overflow-clipped</h2>
|
||||||
|
<div class="clip-box">
|
||||||
|
<canvas class="partially-clipped" aria-label="fixture-partially-overflow-clipped" width="140" height="60"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Fully overflow-clipped</h2>
|
||||||
|
<div class="clip-box">
|
||||||
|
<canvas class="fully-clipped" aria-label="fixture-fully-overflow-clipped" width="80" height="50"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>CSS-hidden variants</h2>
|
||||||
|
<canvas aria-label="fixture-display-none" width="80" height="40" style="display: none"></canvas>
|
||||||
|
<canvas aria-label="fixture-visibility-hidden" width="80" height="40" style="visibility: hidden"></canvas>
|
||||||
|
<canvas aria-label="fixture-opacity-zero" width="80" height="40" style="opacity: 0"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Hidden ancestor variants</h2>
|
||||||
|
<div style="opacity: 0"><canvas aria-label="fixture-parent-opacity-zero" width="80" height="40"></canvas></div>
|
||||||
|
<div hidden><canvas aria-label="fixture-hidden-attribute" width="80" height="40"></canvas></div>
|
||||||
|
<div inert><canvas aria-label="fixture-inert-parent" width="80" height="40"></canvas></div>
|
||||||
|
<div aria-hidden="true"><canvas aria-label="fixture-aria-hidden-parent" width="80" height="40"></canvas></div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Zero-size and offscreen</h2>
|
||||||
|
<canvas aria-label="fixture-zero-size" width="80" height="40" style="width: 0; height: 0; border: 0"></canvas>
|
||||||
|
<canvas aria-label="fixture-offscreen-right" width="80" height="40" style="position: fixed; left: 5000px; top: 0"></canvas>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<title>Unlabeled Rendered Surface matrix</title>
|
||||||
|
<style>
|
||||||
|
* { box-sizing: border-box; }
|
||||||
|
html, body { margin: 0; min-height: 100%; font: 14px/1.4 system-ui, sans-serif; }
|
||||||
|
body { padding: 16px; background: #f4f6f8; color: #17202a; }
|
||||||
|
h1 { margin: 0 0 12px; font-size: 20px; }
|
||||||
|
.matrix { display: grid; grid-template-columns: repeat(3, minmax(240px, 1fr)); gap: 12px; }
|
||||||
|
.case { min-height: 150px; padding: 10px; overflow: hidden; border: 1px solid #aeb6bf; border-radius: 6px; background: white; }
|
||||||
|
.case h2 { margin: 0 0 8px; font-size: 13px; }
|
||||||
|
.case p { margin: 0 0 8px; }
|
||||||
|
canvas { display: block; background: #d6eaf8; border: 2px solid #2874a6; }
|
||||||
|
.stack { position: relative; width: 180px; height: 90px; }
|
||||||
|
.stack canvas { position: absolute; inset: 0; width: 180px; height: 90px; }
|
||||||
|
.stack canvas + canvas { background: rgb(244 208 63 / 45%); border-color: #b7950b; }
|
||||||
|
.contained { position: relative; width: 190px; height: 100px; }
|
||||||
|
.contained > canvas:first-child { width: 190px; height: 100px; }
|
||||||
|
.contained > canvas:last-child { position: absolute; left: 55px; top: 30px; width: 70px; height: 40px; background: #fadbd8; border-color: #c0392b; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Unlabeled Rendered Surface matrix</h1>
|
||||||
|
<main class="matrix">
|
||||||
|
<section class="case">
|
||||||
|
<h2>Only engineering attributes</h2>
|
||||||
|
<canvas id="must-not-be-a-label" class="must-not-be-a-label" data-testid="must-not-be-a-label" width="200" height="90"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Blank explicit names</h2>
|
||||||
|
<canvas aria-label=" " title=" " width="180" height="80"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Nearby prose is not a Canvas name</h2>
|
||||||
|
<p>must-not-be-inferred-as-a-surface-label</p>
|
||||||
|
<canvas width="180" height="80"></canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Fallback AX content does not name or suppress the Canvas</h2>
|
||||||
|
<canvas width="180" height="80">
|
||||||
|
<button type="button">Fallback control remains separate</button>
|
||||||
|
</canvas>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Unnamed rendering layers still cluster</h2>
|
||||||
|
<div class="stack">
|
||||||
|
<canvas width="180" height="90"></canvas>
|
||||||
|
<canvas width="180" height="90"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="case">
|
||||||
|
<h2>Unnamed contained canvases stay independent</h2>
|
||||||
|
<div class="contained">
|
||||||
|
<canvas width="190" height="100"></canvas>
|
||||||
|
<canvas width="70" height="40"></canvas>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<title>Rendered Surface viewport matrix</title>
|
||||||
|
<style>
|
||||||
|
html, body { margin: 0; font: 14px system-ui, sans-serif; }
|
||||||
|
body { min-height: 1800px; padding: 16px; }
|
||||||
|
canvas { display: block; background: #fdebd0; border: 2px solid #ca6f1e; }
|
||||||
|
#partial { position: fixed; left: -70px; top: 120px; width: 180px; height: 100px; }
|
||||||
|
#below { position: absolute; left: 40px; top: 1350px; width: 240px; height: 120px; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Viewport matrix</h1>
|
||||||
|
<p>The orange canvas on the left is intentionally clipped by the viewport.</p>
|
||||||
|
<canvas id="partial" aria-label="fixture-partial-viewport" width="180" height="100"></canvas>
|
||||||
|
<canvas id="below" aria-label="fixture-below-fold" width="240" height="120"></canvas>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
@@ -73,6 +73,28 @@ CSS-only hover menu looks like from here. It hovers a bounded set of likely trig
|
|||||||
few seconds and touches the live page; once you know which element hides the menu, `bsk hover <ref>`
|
few seconds and touches the live page; once you know which element hides the menu, `bsk hover <ref>`
|
||||||
is cheaper and more precise.
|
is cheaper and more precise.
|
||||||
|
|
||||||
|
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 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.
|
||||||
|
|
||||||
Escalate page reading only as needed:
|
Escalate page reading only as needed:
|
||||||
|
|
||||||
1. `bsk observe` for normal semantic understanding, text, controls, and refs.
|
1. `bsk observe` for normal semantic understanding, text, controls, and refs.
|
||||||
@@ -125,6 +147,7 @@ Required flags that are easy to get wrong:
|
|||||||
bsk fill <ref> --value <text> bsk select <ref> --value <option-value>
|
bsk fill <ref> --value <text> bsk select <ref> --value <option-value>
|
||||||
bsk screenshot --out <path> bsk emulate --device <preset-id>
|
bsk screenshot --out <path> bsk emulate --device <preset-id>
|
||||||
bsk upload <ref> --file <path> bsk download <ref> --out <path>
|
bsk upload <ref> --file <path> bsk download <ref> --out <path>
|
||||||
|
bsk click <surface-ref> --capture <id> --image-x <px> --image-y <px>
|
||||||
```
|
```
|
||||||
|
|
||||||
`select` matches an option's `value` attribute, not its visible label. Device preset ids are
|
`select` matches an option's `value` attribute, not its visible label. Device preset ids are
|
||||||
|
|||||||
@@ -73,14 +73,6 @@ where
|
|||||||
P: Serialize + Send + 'static,
|
P: Serialize + Send + 'static,
|
||||||
R: DeserializeOwned + Send + 'static,
|
R: DeserializeOwned + Send + 'static,
|
||||||
{
|
{
|
||||||
let parent_cancel = stdin_cancellation();
|
|
||||||
if parent_cancel.as_ref().is_some_and(|rx| *rx.borrow()) {
|
|
||||||
return Err(CliError::from_rpc(RpcError {
|
|
||||||
code: ErrorCode::Cancelled,
|
|
||||||
message: "parent closed the cancellation pipe".into(),
|
|
||||||
data: Some(serde_json::json!({"reason": "cancelled_before_dispatch"})),
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
let rpc_id: RpcId = format!("{}-{}", rpc_id_prefix, random_short_id());
|
let rpc_id: RpcId = format!("{}-{}", rpc_id_prefix, random_short_id());
|
||||||
let mut client = IpcClient::connect(sock.clone()).await?;
|
let mut client = IpcClient::connect(sock.clone()).await?;
|
||||||
let rpc_id_for_call = rpc_id.clone();
|
let rpc_id_for_call = rpc_id.clone();
|
||||||
@@ -96,16 +88,16 @@ where
|
|||||||
let outcome = tokio::select! {
|
let outcome = tokio::select! {
|
||||||
biased;
|
biased;
|
||||||
res = &mut main_fut => res?,
|
res = &mut main_fut => res?,
|
||||||
sig = wait_for_cancel(parent_cancel) => {
|
sig = wait_for_sigint() => {
|
||||||
sig.context("wait for cancellation").map_err(CliError::Local)?;
|
sig.context("install SIGINT handler").map_err(CliError::Local)?;
|
||||||
debug!(rpc_id = %rpc_id_for_cancel, "forwarding cancel to daemon");
|
debug!(rpc_id = %rpc_id_for_cancel, "SIGINT: forwarding cancel to daemon");
|
||||||
let _ = send_cancel(&sock, &rpc_id_for_cancel).await;
|
let _ = send_cancel(&sock, &rpc_id_for_cancel).await;
|
||||||
match tokio::time::timeout(CANCEL_RESPONSE_GRACE, &mut main_fut).await {
|
match tokio::time::timeout(CANCEL_RESPONSE_GRACE, &mut main_fut).await {
|
||||||
Ok(res) => res?,
|
Ok(res) => res?,
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
debug!(
|
debug!(
|
||||||
rpc_id = %rpc_id_for_cancel,
|
rpc_id = %rpc_id_for_cancel,
|
||||||
"cancel grace elapsed; synthesising cancelled error"
|
"SIGINT: cancel grace elapsed; synthesising cancelled error"
|
||||||
);
|
);
|
||||||
return Err(CliError::from_rpc(RpcError {
|
return Err(CliError::from_rpc(RpcError {
|
||||||
code: ErrorCode::Cancelled,
|
code: ErrorCode::Cancelled,
|
||||||
@@ -120,46 +112,6 @@ where
|
|||||||
outcome.map_err(CliError::from_rpc)
|
outcome.map_err(CliError::from_rpc)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Release caller-owned staging even after cancellation. This deliberately
|
|
||||||
/// exposes only transfer.release, not a general bypass for business RPCs.
|
|
||||||
/// The entire batch, including connection setup, shares one bounded budget.
|
|
||||||
pub fn release_transfers<'a>(
|
|
||||||
sock: &Path,
|
|
||||||
transfer_ids: impl IntoIterator<Item = &'a str>,
|
|
||||||
) -> Result<(), CliError> {
|
|
||||||
use bsk_protocol::tools::{TransferIdParams, TransferReleaseResult};
|
|
||||||
const CLEANUP_TIMEOUT: Duration = Duration::from_secs(5);
|
|
||||||
let ids: Vec<_> = transfer_ids.into_iter().collect();
|
|
||||||
if ids.is_empty() {
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all()
|
|
||||||
.build()
|
|
||||||
.context("build runtime for transfer cleanup")?;
|
|
||||||
rt.block_on(async {
|
|
||||||
tokio::time::timeout(CLEANUP_TIMEOUT, async {
|
|
||||||
let mut client = IpcClient::connect(sock).await?;
|
|
||||||
for id in ids {
|
|
||||||
client
|
|
||||||
.call::<_, TransferReleaseResult>(
|
|
||||||
"transfer-release",
|
|
||||||
Method::TransferRelease,
|
|
||||||
Some(TransferIdParams {
|
|
||||||
transfer_id: id.to_string(),
|
|
||||||
}),
|
|
||||||
CLEANUP_TIMEOUT,
|
|
||||||
)
|
|
||||||
.await?
|
|
||||||
.map_err(CliError::from_rpc)?;
|
|
||||||
}
|
|
||||||
Ok::<_, CliError>(())
|
|
||||||
})
|
|
||||||
.await
|
|
||||||
.context("transfer cleanup exceeded its total time budget")?
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Send a `cancel { rpc_id }` frame over a fresh connection so it
|
/// Send a `cancel { rpc_id }` frame over a fresh connection so it
|
||||||
/// lands on the daemon while the original call is still parked.
|
/// lands on the daemon while the original call is still parked.
|
||||||
///
|
///
|
||||||
@@ -194,57 +146,8 @@ fn random_short_id() -> String {
|
|||||||
bytes.iter().map(|b| format!("{b:02x}")).collect()
|
bytes.iter().map(|b| format!("{b:02x}")).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opt-in control pipe for parent processes that cannot send Ctrl-C (Node on
|
/// Wait for either Ctrl-C or process SIGTERM. Returning here means
|
||||||
/// Windows). One reader survives the short-lived runtimes used by multi-RPC
|
/// the user has asked us to stop.
|
||||||
/// commands such as upload. Ordinary CLI stdin and terminal Ctrl-C are unchanged.
|
|
||||||
fn stdin_cancellation() -> Option<tokio::sync::watch::Receiver<bool>> {
|
|
||||||
if std::env::var("BSK_CANCEL_ON_STDIN_CLOSE").as_deref() != Ok("1") {
|
|
||||||
return None;
|
|
||||||
}
|
|
||||||
static CANCEL: std::sync::OnceLock<tokio::sync::watch::Receiver<bool>> =
|
|
||||||
std::sync::OnceLock::new();
|
|
||||||
Some(
|
|
||||||
CANCEL
|
|
||||||
.get_or_init(|| {
|
|
||||||
let (tx, rx) = tokio::sync::watch::channel(false);
|
|
||||||
std::thread::spawn(move || {
|
|
||||||
use std::io::Read;
|
|
||||||
let mut stdin = std::io::stdin().lock();
|
|
||||||
let mut buf = [0; 64];
|
|
||||||
loop {
|
|
||||||
match stdin.read(&mut buf) {
|
|
||||||
Ok(0) => break,
|
|
||||||
Ok(_) => {}
|
|
||||||
Err(err) if err.kind() == std::io::ErrorKind::Interrupted => continue,
|
|
||||||
Err(_) => break,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
let _ = tx.send(true);
|
|
||||||
});
|
|
||||||
rx
|
|
||||||
})
|
|
||||||
.clone(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn wait_for_cancel(
|
|
||||||
parent_cancel: Option<tokio::sync::watch::Receiver<bool>>,
|
|
||||||
) -> anyhow::Result<()> {
|
|
||||||
let parent_closed = async move {
|
|
||||||
match parent_cancel {
|
|
||||||
Some(mut rx) => {
|
|
||||||
let _ = rx.wait_for(|closed| *closed).await;
|
|
||||||
}
|
|
||||||
None => std::future::pending::<()>().await,
|
|
||||||
}
|
|
||||||
};
|
|
||||||
tokio::select! {
|
|
||||||
result = wait_for_sigint() => result,
|
|
||||||
_ = parent_closed => Ok(()),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Wait for terminal Ctrl-C.
|
|
||||||
async fn wait_for_sigint() -> anyhow::Result<()> {
|
async fn wait_for_sigint() -> anyhow::Result<()> {
|
||||||
tokio::signal::ctrl_c().await.context("listen for SIGINT")?;
|
tokio::signal::ctrl_c().await.context("listen for SIGINT")?;
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ use anyhow::Context;
|
|||||||
use base64::Engine;
|
use base64::Engine;
|
||||||
use bsk_protocol::Method;
|
use bsk_protocol::Method;
|
||||||
use bsk_protocol::tools::{
|
use bsk_protocol::tools::{
|
||||||
DownloadParams, DownloadResult, TransferChunkParams, TransferChunkResult,
|
DownloadParams, DownloadResult, TransferChunkParams, TransferChunkResult, TransferIdParams,
|
||||||
|
TransferReleaseResult,
|
||||||
};
|
};
|
||||||
use clap::Args;
|
use clap::Args;
|
||||||
use uuid::Uuid;
|
use uuid::Uuid;
|
||||||
@@ -69,7 +70,13 @@ pub fn dispatch(args: DownloadArgs, format: Format) -> Result<(), CliError> {
|
|||||||
CliError::Local(anyhow::anyhow!("daemon returned no download transfer id"))
|
CliError::Local(anyhow::anyhow!("daemon returned no download transfer id"))
|
||||||
})?;
|
})?;
|
||||||
let write_result = write_transfer(&info.sock_path, &transfer_id, &args.out, args.overwrite);
|
let write_result = write_transfer(&info.sock_path, &transfer_id, &args.out, args.overwrite);
|
||||||
let _ = crate::cli::business_rpc::release_transfers(&info.sock_path, [transfer_id.as_str()]);
|
let _: Result<TransferReleaseResult, CliError> = crate::cli::business_rpc::call(
|
||||||
|
info.sock_path,
|
||||||
|
"transfer-release",
|
||||||
|
Method::TransferRelease,
|
||||||
|
Some(TransferIdParams { transfer_id }),
|
||||||
|
Duration::from_secs(5),
|
||||||
|
);
|
||||||
write_result?;
|
write_result?;
|
||||||
match format {
|
match format {
|
||||||
Format::Json => {
|
Format::Json => {
|
||||||
|
|||||||
@@ -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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ use bsk_protocol::ErrorCode;
|
|||||||
pub mod reason {
|
pub mod reason {
|
||||||
pub const AGENT_WINDOW_SCOPE: &str = "agent_window_scope";
|
pub const AGENT_WINDOW_SCOPE: &str = "agent_window_scope";
|
||||||
pub const ELEMENT_NOT_VISIBLE: &str = "element_not_visible";
|
pub const ELEMENT_NOT_VISIBLE: &str = "element_not_visible";
|
||||||
|
pub const REF_CAPABILITY_DENIED: &str = "ref_capability_denied";
|
||||||
pub const REF_NOT_FOUND: &str = "ref_not_found";
|
pub const REF_NOT_FOUND: &str = "ref_not_found";
|
||||||
pub const SELECTOR_NOT_FOUND: &str = "selector_not_found";
|
pub const SELECTOR_NOT_FOUND: &str = "selector_not_found";
|
||||||
pub const TARGET_NOT_FILLABLE: &str = "target_not_fillable";
|
pub const TARGET_NOT_FILLABLE: &str = "target_not_fillable";
|
||||||
@@ -64,6 +65,11 @@ pub mod reason {
|
|||||||
pub const DOWNLOAD_CAPTURE_FAILED: &str = "download_capture_failed";
|
pub const DOWNLOAD_CAPTURE_FAILED: &str = "download_capture_failed";
|
||||||
pub const TRANSFER_OUTCOME_UNKNOWN: &str = "transfer_outcome_unknown";
|
pub const TRANSFER_OUTCOME_UNKNOWN: &str = "transfer_outcome_unknown";
|
||||||
pub const TRANSFER_TIMEOUT: &str = "transfer_timeout";
|
pub const TRANSFER_TIMEOUT: &str = "transfer_timeout";
|
||||||
|
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";
|
||||||
}
|
}
|
||||||
@@ -299,6 +305,13 @@ pub fn info_for_error(code: ErrorCode, data: Option<&serde_json::Value>) -> Rend
|
|||||||
),
|
),
|
||||||
exit_code: base.exit_code,
|
exit_code: base.exit_code,
|
||||||
},
|
},
|
||||||
|
(ErrorCode::PermissionDenied, reason::REF_CAPABILITY_DENIED) => RenderInfo {
|
||||||
|
summary: "snapshot ref does not support this operation",
|
||||||
|
hint: Some(
|
||||||
|
"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,
|
||||||
|
},
|
||||||
(ErrorCode::InvalidParams, reason::TARGET_NOT_SELECT) => RenderInfo {
|
(ErrorCode::InvalidParams, reason::TARGET_NOT_SELECT) => RenderInfo {
|
||||||
summary: "target element is not a <select>",
|
summary: "target element is not a <select>",
|
||||||
hint: Some(
|
hint: Some(
|
||||||
@@ -341,6 +354,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,
|
||||||
@@ -564,6 +612,18 @@ mod tests {
|
|||||||
assert_eq!(info.exit_code, 3);
|
assert_eq!(info.exit_code, 3);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ref_capability_denied_explains_visual_surface_refs() {
|
||||||
|
let data = serde_json::json!({ "reason": reason::REF_CAPABILITY_DENIED });
|
||||||
|
let info = info_for_error(ErrorCode::PermissionDenied, Some(&data));
|
||||||
|
assert_eq!(info.summary, "snapshot ref does not support this operation");
|
||||||
|
assert!(
|
||||||
|
info.hint.unwrap().contains("capture id"),
|
||||||
|
"expected visual-surface-specific hint"
|
||||||
|
);
|
||||||
|
assert_eq!(info.exit_code, 1);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn session_busy_overrides_timeout_copy() {
|
fn session_busy_overrides_timeout_copy() {
|
||||||
let data = serde_json::json!({ "reason": reason::SESSION_BUSY });
|
let data = serde_json::json!({ "reason": reason::SESSION_BUSY });
|
||||||
@@ -664,6 +724,25 @@ mod tests {
|
|||||||
assert!(info.summary.contains("timed out after browser dispatch"));
|
assert!(info.summary.contains("timed out after browser dispatch"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,7 +10,8 @@ use base64::Engine;
|
|||||||
use bsk_protocol::Method;
|
use bsk_protocol::Method;
|
||||||
use bsk_protocol::tools::{
|
use bsk_protocol::tools::{
|
||||||
TransferBeginParams, TransferBeginResult, TransferChunkParams, TransferChunkResult,
|
TransferBeginParams, TransferBeginResult, TransferChunkParams, TransferChunkResult,
|
||||||
TransferIdParams, TransferReadyResult, UploadFile, UploadMode, UploadParams, UploadResult,
|
TransferIdParams, TransferReadyResult, TransferReleaseResult, UploadFile, UploadMode,
|
||||||
|
UploadParams, UploadResult,
|
||||||
};
|
};
|
||||||
use clap::{Args, ValueEnum};
|
use clap::{Args, ValueEnum};
|
||||||
|
|
||||||
@@ -68,12 +69,14 @@ pub fn dispatch(args: UploadArgs, format: Format) -> Result<(), CliError> {
|
|||||||
let (ref_, selector) = split_target(args.target, args.ref_, args.selector)?;
|
let (ref_, selector) = split_target(args.target, args.ref_, args.selector)?;
|
||||||
let mut staged = Vec::new();
|
let mut staged = Vec::new();
|
||||||
for path in &args.files {
|
for path in &args.files {
|
||||||
if let Err(err) = stage_file(&info.sock_path, &args.session, path, &mut staged) {
|
match stage_file(&info.sock_path, &args.session, path) {
|
||||||
let _ = crate::cli::business_rpc::release_transfers(
|
Ok(file) => staged.push(file),
|
||||||
&info.sock_path,
|
Err(err) => {
|
||||||
staged.iter().map(|(id, _)| id.as_str()),
|
for (id, _) in &staged {
|
||||||
);
|
let _ = release(&info.sock_path, id);
|
||||||
return Err(err);
|
}
|
||||||
|
return Err(err);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let params = UploadParams {
|
let params = UploadParams {
|
||||||
@@ -99,17 +102,6 @@ pub fn dispatch(args: UploadArgs, format: Format) -> Result<(), CliError> {
|
|||||||
Some(params),
|
Some(params),
|
||||||
ipc_timeout(args.timeout),
|
ipc_timeout(args.timeout),
|
||||||
);
|
);
|
||||||
// The helper can reject cancellation before handing any request to the
|
|
||||||
// daemon. In that case staging still belongs to this CLI.
|
|
||||||
if result.as_ref().is_err_and(|err| {
|
|
||||||
err.data()
|
|
||||||
.is_some_and(|data| data["reason"] == "cancelled_before_dispatch")
|
|
||||||
}) {
|
|
||||||
let _ = crate::cli::business_rpc::release_transfers(
|
|
||||||
&info.sock_path,
|
|
||||||
staged.iter().map(|(id, _)| id.as_str()),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// Once tool.upload is dispatched, staging ownership belongs to the
|
// Once tool.upload is dispatched, staging ownership belongs to the
|
||||||
// session. A transport timeout cannot prove that Chrome did not attach
|
// session. A transport timeout cannot prove that Chrome did not attach
|
||||||
// the file, so releasing here could invalidate a late successful attach.
|
// the file, so releasing here could invalidate a late successful attach.
|
||||||
@@ -126,12 +118,7 @@ pub fn dispatch(args: UploadArgs, format: Format) -> Result<(), CliError> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stage_file(
|
fn stage_file(sock: &Path, session: &str, path: &PathBuf) -> Result<(String, String), CliError> {
|
||||||
sock: &Path,
|
|
||||||
session: &str,
|
|
||||||
path: &PathBuf,
|
|
||||||
staged: &mut Vec<(String, String)>,
|
|
||||||
) -> Result<(), CliError> {
|
|
||||||
let mut file = File::open(path)
|
let mut file = File::open(path)
|
||||||
.with_context(|| format!("open upload file {}", path.display()))
|
.with_context(|| format!("open upload file {}", path.display()))
|
||||||
.map_err(CliError::Local)?;
|
.map_err(CliError::Local)?;
|
||||||
@@ -162,39 +149,55 @@ fn stage_file(
|
|||||||
}),
|
}),
|
||||||
Duration::from_secs(10),
|
Duration::from_secs(10),
|
||||||
)?;
|
)?;
|
||||||
// Record ownership immediately so one error path releases both completed
|
let staged = (|| {
|
||||||
// files and the current partially staged file.
|
let mut offset = 0u64;
|
||||||
staged.push((begin.transfer_id.clone(), name));
|
let mut buf = vec![0u8; begin.chunk_size as usize];
|
||||||
let mut offset = 0u64;
|
loop {
|
||||||
let mut buf = vec![0u8; begin.chunk_size as usize];
|
let n = file.read(&mut buf).map_err(|e| CliError::Local(e.into()))?;
|
||||||
loop {
|
if n == 0 {
|
||||||
let n = file.read(&mut buf).map_err(|e| CliError::Local(e.into()))?;
|
break;
|
||||||
if n == 0 {
|
}
|
||||||
break;
|
let reply: TransferChunkResult = crate::cli::business_rpc::call(
|
||||||
|
sock.to_path_buf(),
|
||||||
|
"transfer-chunk",
|
||||||
|
Method::TransferChunk,
|
||||||
|
Some(TransferChunkParams {
|
||||||
|
transfer_id: begin.transfer_id.clone(),
|
||||||
|
offset,
|
||||||
|
data_base64: base64::engine::general_purpose::STANDARD.encode(&buf[..n]),
|
||||||
|
}),
|
||||||
|
Duration::from_secs(30),
|
||||||
|
)?;
|
||||||
|
offset = reply.next_offset;
|
||||||
}
|
}
|
||||||
let reply: TransferChunkResult = crate::cli::business_rpc::call(
|
let _: TransferReadyResult = crate::cli::business_rpc::call(
|
||||||
sock.to_path_buf(),
|
sock.to_path_buf(),
|
||||||
"transfer-chunk",
|
"transfer-finish",
|
||||||
Method::TransferChunk,
|
Method::TransferFinish,
|
||||||
Some(TransferChunkParams {
|
Some(TransferIdParams {
|
||||||
transfer_id: begin.transfer_id.clone(),
|
transfer_id: begin.transfer_id.clone(),
|
||||||
offset,
|
|
||||||
data_base64: base64::engine::general_purpose::STANDARD.encode(&buf[..n]),
|
|
||||||
}),
|
}),
|
||||||
Duration::from_secs(30),
|
Duration::from_secs(10),
|
||||||
)?;
|
)?;
|
||||||
offset = reply.next_offset;
|
Ok::<_, CliError>(())
|
||||||
|
})();
|
||||||
|
if let Err(err) = staged {
|
||||||
|
let _ = release(sock, &begin.transfer_id);
|
||||||
|
return Err(err);
|
||||||
}
|
}
|
||||||
let _: TransferReadyResult = crate::cli::business_rpc::call(
|
Ok((begin.transfer_id, name))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn release(sock: &Path, id: &str) -> Result<TransferReleaseResult, CliError> {
|
||||||
|
crate::cli::business_rpc::call(
|
||||||
sock.to_path_buf(),
|
sock.to_path_buf(),
|
||||||
"transfer-finish",
|
"transfer-release",
|
||||||
Method::TransferFinish,
|
Method::TransferRelease,
|
||||||
Some(TransferIdParams {
|
Some(TransferIdParams {
|
||||||
transfer_id: begin.transfer_id.clone(),
|
transfer_id: id.to_string(),
|
||||||
}),
|
}),
|
||||||
Duration::from_secs(10),
|
Duration::from_secs(5),
|
||||||
)?;
|
)
|
||||||
Ok(())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn ipc_timeout(timeout_ms: u32) -> Duration {
|
fn ipc_timeout(timeout_ms: u32) -> Duration {
|
||||||
|
|||||||
@@ -237,6 +237,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
|
||||||
|
|||||||
@@ -1,342 +0,0 @@
|
|||||||
//! Real Windows CLI cancellation, including caller-owned transfer cleanup.
|
|
||||||
#![cfg(windows)]
|
|
||||||
|
|
||||||
use std::path::Path;
|
|
||||||
use std::sync::{Arc, Mutex};
|
|
||||||
use std::time::{Duration, Instant};
|
|
||||||
|
|
||||||
use bsk::daemon::{file_transfer::TransferRegistry, info::DaemonInfo};
|
|
||||||
use bsk_protocol::tools::{TransferBeginParams, TransferIdParams};
|
|
||||||
use bsk_protocol::{ErrorCode, Frame, Method, ResponseBody, ResponseFrame, RpcError};
|
|
||||||
use serde_json::json;
|
|
||||||
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
|
|
||||||
use tokio::net::windows::named_pipe::ServerOptions;
|
|
||||||
use tokio::process::Command;
|
|
||||||
use tokio::sync::{Notify, watch};
|
|
||||||
|
|
||||||
fn response<T: serde::Serialize>(result: Result<T, RpcError>) -> ResponseBody {
|
|
||||||
match result {
|
|
||||||
Ok(value) => ResponseBody::Ok(serde_json::to_value(value).unwrap()),
|
|
||||||
Err(err) => ResponseBody::Err(err),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn stdin_close_cancels_business_but_releases_resources_with_a_bounded_budget() {
|
|
||||||
// Resolve the production registry's root before starting any runtime threads.
|
|
||||||
let registry_home = tempfile::tempdir().unwrap();
|
|
||||||
let original_home = std::env::var_os("BSK_HOME");
|
|
||||||
unsafe {
|
|
||||||
std::env::set_var("BSK_HOME", registry_home.path());
|
|
||||||
}
|
|
||||||
let transfers = Arc::new(TransferRegistry::new().unwrap());
|
|
||||||
unsafe {
|
|
||||||
match original_home {
|
|
||||||
Some(value) => std::env::set_var("BSK_HOME", value),
|
|
||||||
None => std::env::remove_var("BSK_HOME"),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
transfers.initialize().unwrap();
|
|
||||||
tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all()
|
|
||||||
.build()
|
|
||||||
.unwrap()
|
|
||||||
.block_on(exercise(
|
|
||||||
transfers,
|
|
||||||
®istry_home.path().join("run/transfers"),
|
|
||||||
));
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn exercise(transfers: Arc<TransferRegistry>, staging_root: &Path) {
|
|
||||||
for mode in [
|
|
||||||
"wait",
|
|
||||||
"upload",
|
|
||||||
"upload-multi",
|
|
||||||
"upload-before-dispatch",
|
|
||||||
"download",
|
|
||||||
"upload-multi-stall",
|
|
||||||
"ordinary",
|
|
||||||
] {
|
|
||||||
let home = tempfile::tempdir().unwrap();
|
|
||||||
let pipe_name = format!(r"\\.\pipe\bsk-parent-cancel-{}", uuid::Uuid::new_v4());
|
|
||||||
let info = DaemonInfo::now(std::process::id(), (&pipe_name).into(), 0, "0.2.0");
|
|
||||||
std::fs::write(
|
|
||||||
home.path().join("daemon.json"),
|
|
||||||
serde_json::to_vec(&info).unwrap(),
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
let mut pipe = ServerOptions::new()
|
|
||||||
.first_pipe_instance(true)
|
|
||||||
.create(&pipe_name)
|
|
||||||
.unwrap();
|
|
||||||
let registered = Arc::new(Notify::new());
|
|
||||||
let pending = Arc::new(Mutex::new(None::<String>));
|
|
||||||
let ids = Arc::new(Mutex::new(Vec::<String>::new()));
|
|
||||||
let released = Arc::new(Mutex::new(Vec::<String>::new()));
|
|
||||||
let received = Arc::new(Mutex::new(Vec::<Method>::new()));
|
|
||||||
let download_id = if mode == "download" {
|
|
||||||
let staging = transfers.begin_download("fixture").unwrap();
|
|
||||||
let browser_dir = home.path().join("BrowserSkill").join(&staging.transfer_id);
|
|
||||||
std::fs::create_dir_all(&browser_dir).unwrap();
|
|
||||||
let file = browser_dir.join("download.txt");
|
|
||||||
std::fs::write(&file, b"download fixture").unwrap();
|
|
||||||
transfers
|
|
||||||
.import_download(&staging.transfer_id, &file)
|
|
||||||
.unwrap();
|
|
||||||
ids.lock().unwrap().push(staging.transfer_id.clone());
|
|
||||||
Some(staging.transfer_id)
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
};
|
|
||||||
let (cancel, cancelled) = watch::channel(false);
|
|
||||||
let ready = Arc::clone(®istered);
|
|
||||||
let name = pipe_name.clone();
|
|
||||||
let registry = Arc::clone(&transfers);
|
|
||||||
let server_ids = Arc::clone(&ids);
|
|
||||||
let server_released = Arc::clone(&released);
|
|
||||||
let server_received = Arc::clone(&received);
|
|
||||||
let server = tokio::spawn(async move {
|
|
||||||
let mut connections = tokio::task::JoinSet::new();
|
|
||||||
loop {
|
|
||||||
pipe.connect().await.unwrap();
|
|
||||||
let next = ServerOptions::new().create(&name).unwrap();
|
|
||||||
let connection = std::mem::replace(&mut pipe, next);
|
|
||||||
let ready = Arc::clone(&ready);
|
|
||||||
let pending = Arc::clone(&pending);
|
|
||||||
let cancel = cancel.clone();
|
|
||||||
let mut cancelled = cancelled.clone();
|
|
||||||
let name = name.clone();
|
|
||||||
let registry = Arc::clone(®istry);
|
|
||||||
let ids = Arc::clone(&server_ids);
|
|
||||||
let released = Arc::clone(&server_released);
|
|
||||||
let received = Arc::clone(&server_received);
|
|
||||||
let download_id = download_id.clone();
|
|
||||||
connections.spawn(async move {
|
|
||||||
let (read, mut write) = tokio::io::split(connection);
|
|
||||||
let mut reader = BufReader::new(read);
|
|
||||||
let mut line = String::new();
|
|
||||||
while reader.read_line(&mut line).await.unwrap_or(0) > 0 {
|
|
||||||
let Frame::Request(req) = serde_json::from_str::<Frame>(&line).unwrap()
|
|
||||||
else {
|
|
||||||
panic!("expected request");
|
|
||||||
};
|
|
||||||
line.clear();
|
|
||||||
received.lock().unwrap().push(req.method.clone());
|
|
||||||
let params = req.params.clone().unwrap_or_default();
|
|
||||||
let body = match req.method {
|
|
||||||
Method::SystemStatus => ResponseBody::Ok(json!({
|
|
||||||
"daemon_version": "0.2.0", "protocol_version": "1.1",
|
|
||||||
"pid": std::process::id(), "uptime_secs": 0,
|
|
||||||
"ws_port": 0, "sock_path": name,
|
|
||||||
"browsers": [], "sessions": [], "version_skew_browsers": []
|
|
||||||
})),
|
|
||||||
Method::TransferBegin => {
|
|
||||||
let begin = registry
|
|
||||||
.begin_upload(serde_json::from_value(params).unwrap())
|
|
||||||
.unwrap();
|
|
||||||
ids.lock().unwrap().push(begin.transfer_id.clone());
|
|
||||||
response(Ok(begin))
|
|
||||||
}
|
|
||||||
Method::ToolDownload => ResponseBody::Ok(json!({
|
|
||||||
"tab_id": 1, "suggested_filename": "download.txt",
|
|
||||||
"byte_size": 16, "transfer_id": download_id,
|
|
||||||
})),
|
|
||||||
Method::ToolWaitMs if mode == "ordinary" => {
|
|
||||||
ResponseBody::Ok(json!({"waited_ms": 1}))
|
|
||||||
}
|
|
||||||
Method::TransferChunk
|
|
||||||
if mode == "upload-before-dispatch"
|
|
||||||
|| (mode.contains("multi")
|
|
||||||
&& ids.lock().unwrap().len() == 1) =>
|
|
||||||
{
|
|
||||||
response(
|
|
||||||
registry.write_chunk(serde_json::from_value(params).unwrap()),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
Method::TransferFinish if mode != "upload-before-dispatch" => response(
|
|
||||||
registry.finish_upload(serde_json::from_value(params).unwrap()),
|
|
||||||
),
|
|
||||||
Method::ToolWaitMs
|
|
||||||
| Method::TransferChunk
|
|
||||||
| Method::TransferRead
|
|
||||||
| Method::TransferFinish => {
|
|
||||||
*pending.lock().unwrap() = Some(req.id.clone());
|
|
||||||
ready.notify_one();
|
|
||||||
cancelled.wait_for(|value| *value).await.unwrap();
|
|
||||||
if mode == "upload-before-dispatch" {
|
|
||||||
// Finish won the race with cancellation, but tool.upload must
|
|
||||||
// not be dispatched and the CLI still owns the staging.
|
|
||||||
response(
|
|
||||||
registry
|
|
||||||
.finish_upload(serde_json::from_value(params).unwrap()),
|
|
||||||
)
|
|
||||||
} else {
|
|
||||||
ResponseBody::Err(RpcError {
|
|
||||||
code: ErrorCode::Cancelled,
|
|
||||||
message: "parent cancellation reached daemon".into(),
|
|
||||||
data: None,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Method::Cancel => {
|
|
||||||
let target = params["rpc_id"].as_str().unwrap();
|
|
||||||
assert_eq!(pending.lock().unwrap().as_deref(), Some(target));
|
|
||||||
cancel.send(true).unwrap();
|
|
||||||
ResponseBody::Ok(json!({"cancelled": true}))
|
|
||||||
}
|
|
||||||
Method::TransferRelease => {
|
|
||||||
let params: TransferIdParams =
|
|
||||||
serde_json::from_value(params).unwrap();
|
|
||||||
released.lock().unwrap().push(params.transfer_id.clone());
|
|
||||||
if mode.contains("stall") {
|
|
||||||
std::future::pending::<()>().await;
|
|
||||||
}
|
|
||||||
response(Ok(registry.release(params)))
|
|
||||||
}
|
|
||||||
other => panic!("unexpected request after cancellation: {other:?}"),
|
|
||||||
};
|
|
||||||
let response = Frame::Response(ResponseFrame { id: req.id, body });
|
|
||||||
let mut bytes = serde_json::to_vec(&response).unwrap();
|
|
||||||
bytes.push(b'\n');
|
|
||||||
if write.write_all(&bytes).await.is_err() {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
let mut cmd = Command::new(env!("CARGO_BIN_EXE_bsk"));
|
|
||||||
cmd.env("BSK_HOME", home.path())
|
|
||||||
.env("BSK_AUTO_UPDATE", "off")
|
|
||||||
.env_remove("BSK_CANCEL_ON_STDIN_CLOSE")
|
|
||||||
.stdout(std::process::Stdio::piped())
|
|
||||||
.stderr(std::process::Stdio::piped())
|
|
||||||
.creation_flags(0x0800_0000)
|
|
||||||
.kill_on_drop(true);
|
|
||||||
if mode.starts_with("upload") {
|
|
||||||
let source = home.path().join("upload.txt");
|
|
||||||
// Declare 300 MiB without allocating or transferring that much data.
|
|
||||||
std::fs::File::create(&source)
|
|
||||||
.unwrap()
|
|
||||||
.set_len(if mode == "upload-before-dispatch" {
|
|
||||||
16
|
|
||||||
} else {
|
|
||||||
300 * 1024 * 1024
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
cmd.args(["upload", "--session", "fixture", "--selector", "input"]);
|
|
||||||
if mode.contains("multi") {
|
|
||||||
let first = home.path().join("first.txt");
|
|
||||||
std::fs::write(&first, b"first file").unwrap();
|
|
||||||
cmd.arg("--file").arg(first);
|
|
||||||
}
|
|
||||||
cmd.arg("--file").arg(source);
|
|
||||||
} else if mode == "download" {
|
|
||||||
let out = home.path().join("out.txt");
|
|
||||||
std::fs::write(&out, b"existing output").unwrap();
|
|
||||||
cmd.args([
|
|
||||||
"download",
|
|
||||||
"--session",
|
|
||||||
"fixture",
|
|
||||||
"--selector",
|
|
||||||
"a",
|
|
||||||
"--overwrite",
|
|
||||||
"--out",
|
|
||||||
])
|
|
||||||
.arg(out);
|
|
||||||
} else {
|
|
||||||
cmd.args(["wait-ms", if mode == "ordinary" { "1ms" } else { "60s" }]);
|
|
||||||
}
|
|
||||||
cmd.arg("--json");
|
|
||||||
if mode == "ordinary" {
|
|
||||||
cmd.stdin(std::process::Stdio::null());
|
|
||||||
} else {
|
|
||||||
cmd.env("BSK_CANCEL_ON_STDIN_CLOSE", "1")
|
|
||||||
.stdin(std::process::Stdio::piped());
|
|
||||||
}
|
|
||||||
let mut child = cmd.spawn().unwrap();
|
|
||||||
if mode != "ordinary" {
|
|
||||||
tokio::time::timeout(Duration::from_secs(10), registered.notified())
|
|
||||||
.await
|
|
||||||
.expect("CLI registered business RPC");
|
|
||||||
child
|
|
||||||
.stdin
|
|
||||||
.as_mut()
|
|
||||||
.unwrap()
|
|
||||||
.write_all(b"still connected")
|
|
||||||
.await
|
|
||||||
.unwrap();
|
|
||||||
drop(child.stdin.take());
|
|
||||||
}
|
|
||||||
let start = Instant::now();
|
|
||||||
let output = tokio::time::timeout(Duration::from_secs(8), child.wait_with_output())
|
|
||||||
.await
|
|
||||||
.expect("CLI must settle promptly, including cleanup")
|
|
||||||
.unwrap();
|
|
||||||
server.abort();
|
|
||||||
let _ = server.await;
|
|
||||||
assert_eq!(
|
|
||||||
output.status.code(),
|
|
||||||
Some(if mode == "ordinary" { 0 } else { 2 }),
|
|
||||||
"{mode}: stdout={} stderr={}",
|
|
||||||
String::from_utf8_lossy(&output.stdout),
|
|
||||||
String::from_utf8_lossy(&output.stderr)
|
|
||||||
);
|
|
||||||
if mode != "ordinary" {
|
|
||||||
let body: serde_json::Value = serde_json::from_slice(&output.stdout).unwrap();
|
|
||||||
assert_eq!(body["code"], "cancelled");
|
|
||||||
if mode != "upload-before-dispatch" {
|
|
||||||
assert_eq!(body["message"], "parent cancellation reached daemon");
|
|
||||||
}
|
|
||||||
let received = received.lock().unwrap();
|
|
||||||
let cancel = received.iter().position(|m| *m == Method::Cancel).unwrap();
|
|
||||||
assert!(
|
|
||||||
received[cancel + 1..]
|
|
||||||
.iter()
|
|
||||||
.all(|m| *m == Method::TransferRelease),
|
|
||||||
"only cleanup may follow cancellation: {received:?}"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
let ids = ids.lock().unwrap();
|
|
||||||
if mode.contains("stall") {
|
|
||||||
assert_eq!(released.lock().unwrap().len(), 1);
|
|
||||||
assert!(start.elapsed() >= Duration::from_secs(4));
|
|
||||||
// The CLI cannot force an unresponsive daemon to clean up.
|
|
||||||
transfers.release_session("fixture");
|
|
||||||
} else {
|
|
||||||
assert_eq!(
|
|
||||||
*released.lock().unwrap(),
|
|
||||||
*ids,
|
|
||||||
"{mode}: every allocation must be released"
|
|
||||||
);
|
|
||||||
for id in ids.iter() {
|
|
||||||
assert!(!staging_root.join(id).exists(), "staging leaked: {id}");
|
|
||||||
}
|
|
||||||
if mode.starts_with("upload") {
|
|
||||||
let retry = transfers
|
|
||||||
.begin_upload(TransferBeginParams {
|
|
||||||
session_id: "fixture".into(),
|
|
||||||
name: "retry.txt".into(),
|
|
||||||
byte_size: 300 * 1024 * 1024,
|
|
||||||
})
|
|
||||||
.expect("same session must have room for another 300 MiB upload");
|
|
||||||
transfers.release(TransferIdParams {
|
|
||||||
transfer_id: retry.transfer_id,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if mode == "download" {
|
|
||||||
assert_eq!(
|
|
||||||
std::fs::read(home.path().join("out.txt")).unwrap(),
|
|
||||||
b"existing output"
|
|
||||||
);
|
|
||||||
assert!(
|
|
||||||
!std::fs::read_dir(home.path())
|
|
||||||
.unwrap()
|
|
||||||
.flatten()
|
|
||||||
.any(|entry| entry.file_name().to_string_lossy().ends_with(".part"))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -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"));
|
||||||
|
|||||||
@@ -233,10 +233,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::*;
|
||||||
@@ -318,6 +328,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();
|
||||||
|
|||||||
+15
-41
@@ -21,7 +21,6 @@ $ErrorActionPreference = "Stop"
|
|||||||
|
|
||||||
$Repo = if ($env:BSK_REPO) { $env:BSK_REPO } else { "Tencent/BrowserSkill" }
|
$Repo = if ($env:BSK_REPO) { $env:BSK_REPO } else { "Tencent/BrowserSkill" }
|
||||||
$InstallDir = if ($env:BSK_INSTALL_DIR) { $env:BSK_INSTALL_DIR } else { Join-Path $HOME ".local\bin" }
|
$InstallDir = if ($env:BSK_INSTALL_DIR) { $env:BSK_INSTALL_DIR } else { Join-Path $HOME ".local\bin" }
|
||||||
$InstallDir = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($InstallDir)
|
|
||||||
$GitHub = "https://github.com/${Repo}"
|
$GitHub = "https://github.com/${Repo}"
|
||||||
|
|
||||||
function Write-Log {
|
function Write-Log {
|
||||||
@@ -65,7 +64,7 @@ function Get-PlatformTriple {
|
|||||||
function Add-ToUserPath {
|
function Add-ToUserPath {
|
||||||
param([string]$Dir)
|
param([string]$Dir)
|
||||||
|
|
||||||
$currentUserPath = @([Environment]::GetEnvironmentVariable("PATH", "User") -split ";" | Where-Object { $_ })
|
$currentUserPath = [Environment]::GetEnvironmentVariable("PATH", "User") -split ";" | Where-Object { $_ }
|
||||||
|
|
||||||
if ($currentUserPath -contains $Dir) {
|
if ($currentUserPath -contains $Dir) {
|
||||||
Write-Log "$Dir is already in your user PATH"
|
Write-Log "$Dir is already in your user PATH"
|
||||||
@@ -91,59 +90,30 @@ function Add-ToSessionPath {
|
|||||||
# ── Git Bash (bash environment) PATH helper ──────────────────────────────────
|
# ── Git Bash (bash environment) PATH helper ──────────────────────────────────
|
||||||
|
|
||||||
function Add-ToBashProfile {
|
function Add-ToBashProfile {
|
||||||
param([string]$Dir, [string]$BashRc = (Join-Path $HOME ".bashrc"))
|
param([string]$Dir)
|
||||||
|
|
||||||
# Convert Windows path (e.g. C:\Users\foo\.local\bin) to Git-Bash Unix-style (/c/Users/foo/.local/bin)
|
# Convert Windows path (e.g. C:\Users\foo\.local\bin) to Git-Bash Unix-style (/c/Users/foo/.local/bin)
|
||||||
$unixPath = $Dir -replace '\\', '/'
|
$unixPath = $Dir -replace '\\', '/'
|
||||||
if ($unixPath -match '^([A-Z]):(.*)$') {
|
if ($unixPath -match '^([A-Z]):(.*)$') {
|
||||||
$unixPath = '/' + $matches[1].ToLower() + $matches[2]
|
$unixPath = '/' + $matches[1].ToLower() + $matches[2]
|
||||||
}
|
}
|
||||||
# Single-quote the literal directory; only the existing PATH is expanded.
|
$bashRc = Join-Path $HOME ".bashrc"
|
||||||
$shellQuote = "'" + [char]34 + "'" + [char]34 + "'"
|
$exportLine = "export PATH=""${unixPath}:`$PATH"" # bsk CLI"
|
||||||
$quotedPath = "'" + $unixPath.Replace("'", $shellQuote) + "'"
|
|
||||||
$exportLine = "export PATH=${quotedPath}:`"`$PATH`" # bsk CLI"
|
|
||||||
|
|
||||||
if (Test-Path -LiteralPath $BashRc) {
|
if (Test-Path $bashRc) {
|
||||||
$content = [System.IO.File]::ReadAllText($BashRc)
|
$content = Get-Content $bashRc -Raw -ErrorAction SilentlyContinue
|
||||||
if ($content.Contains($exportLine)) {
|
if ($content -match [regex]::Escape($unixPath)) {
|
||||||
Write-Log "$unixPath is already in ~/.bashrc"
|
Write-Log "$unixPath is already in ~/.bashrc"
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
# Explicit BOM-less UTF-8 also works in Windows PowerShell 5.1.
|
Add-Content $bashRc "`n$exportLine" -Encoding ASCII
|
||||||
[System.IO.File]::AppendAllText($BashRc, "`n$exportLine`n", (New-Object System.Text.UTF8Encoding($false)))
|
|
||||||
Write-Log "added ${unixPath} to ~/.bashrc"
|
Write-Log "added ${unixPath} to ~/.bashrc"
|
||||||
}
|
}
|
||||||
|
|
||||||
# ── Main ──────────────────────────────────────────────────────────────────────
|
# ── Main ──────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
# Stage on the destination volume before stopping the daemon. Never truncate
|
|
||||||
# the installed executable: failed replacement must leave it usable.
|
|
||||||
function Install-Binary {
|
|
||||||
param([string]$Source, [string]$Target)
|
|
||||||
|
|
||||||
$staged = "$Target.install-$([Guid]::NewGuid().ToString('N'))"
|
|
||||||
try {
|
|
||||||
[System.IO.File]::Copy($Source, $staged)
|
|
||||||
if ([System.IO.File]::Exists($Target)) {
|
|
||||||
# Use the downloaded CLI: older versions have broken Windows
|
|
||||||
# liveness checks. Stop verifies daemon identity before terminating it.
|
|
||||||
& $Source daemon stop
|
|
||||||
if ($LASTEXITCODE -ne 0) { throw "could not stop bsk daemon; existing installation was not replaced" }
|
|
||||||
# PowerShell 5.1 converts $null to an empty path for string parameters.
|
|
||||||
[System.IO.File]::Replace($staged, $Target, [NullString]::Value)
|
|
||||||
Write-Log "daemon will restart automatically on the next browser command"
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
[System.IO.File]::Move($staged, $Target)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
finally {
|
|
||||||
if ([System.IO.File]::Exists($staged)) { [System.IO.File]::Delete($staged) }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function Main {
|
function Main {
|
||||||
$platform = Get-PlatformTriple
|
$platform = Get-PlatformTriple
|
||||||
|
|
||||||
@@ -214,7 +184,7 @@ function Main {
|
|||||||
New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
|
New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
|
||||||
}
|
}
|
||||||
|
|
||||||
Install-Binary -Source (Join-Path $tempDir "bsk.exe") -Target (Join-Path $InstallDir "bsk.exe")
|
Copy-Item -Path (Join-Path $tempDir "bsk.exe") -Destination (Join-Path $InstallDir "bsk.exe") -Force
|
||||||
|
|
||||||
Write-Log "installed bsk to $InstallDir\bsk.exe"
|
Write-Log "installed bsk to $InstallDir\bsk.exe"
|
||||||
|
|
||||||
@@ -229,8 +199,12 @@ function Main {
|
|||||||
|
|
||||||
# Verify
|
# Verify
|
||||||
$bskPath = Join-Path $InstallDir "bsk.exe"
|
$bskPath = Join-Path $InstallDir "bsk.exe"
|
||||||
& $bskPath --version
|
if (Get-Command bsk -ErrorAction SilentlyContinue) {
|
||||||
if ($LASTEXITCODE -ne 0) { throw "installed bsk failed verification" }
|
& bsk --version
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Write-Log "verify install: & ""$bskPath"" --version"
|
||||||
|
}
|
||||||
|
|
||||||
Write-Log "done"
|
Write-Log "done"
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
|
|||||||
@@ -1,51 +1,13 @@
|
|||||||
# BrowserSkill for DeepSeek Harness
|
# dsh-plugin-browserskill
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)
|
npm: [`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)
|
||||||
|
|
||||||
Use [BrowserSkill](https://github.com/Tencent/BrowserSkill) in
|
A [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (dsh) tool plugin that exposes
|
||||||
[DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (`dsh`) to browse
|
[BrowserSkill](https://github.com/Tencent/BrowserSkill) (`bsk`) browser automation to the model.
|
||||||
websites, fill forms, and capture screenshots through native `browser_*` tools.
|
|
||||||
Browser tasks run in Agent Windows, with a live view in the dsh Web UI.
|
|
||||||
|
|
||||||
## Installation
|
Each action maps to one `bsk <cmd> --json` invocation: the plugin spawns the bsk CLI, parses its
|
||||||
|
structured JSON output, and returns a canonical typed value. The bsk daemon, browser, and browser
|
||||||
Before installing the plugin:
|
extension keep owning the actual browser control — this package is a thin, well-typed bridge.
|
||||||
|
|
||||||
- Install [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) and
|
|
||||||
[pnpm](https://pnpm.io/installation), which dsh uses to manage plugins.
|
|
||||||
- Install the `bsk` CLI and connect the BrowserSkill extension in Chrome or Edge.
|
|
||||||
Follow the [BrowserSkill setup guide](https://github.com/Tencent/BrowserSkill#quick-start).
|
|
||||||
- Make sure `bsk` is on the `PATH` used to start dsh, or set `bskPath` in the plugin configuration.
|
|
||||||
|
|
||||||
Install the plugin into the `web` profile, then start it:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin
|
|
||||||
dsh --profile web
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `web` with your profile name if you use a different profile. The plugin
|
|
||||||
includes the `browser-skill` skill; no separate `bsk install-skill` step is needed.
|
|
||||||
|
|
||||||
In a conversation, try:
|
|
||||||
|
|
||||||
```text
|
|
||||||
/browser-skill open example.com and summarize the page.
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, the browser tools become available when the skill is invoked.
|
|
||||||
|
|
||||||
## Updating
|
|
||||||
|
|
||||||
Installed plugins do not update automatically. To upgrade this plugin to npm's
|
|
||||||
`latest` version, including versions outside the profile's saved dependency range:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dsh plugin --profile web update @wxg-prc-cpg/browser-skill-dsh-plugin --latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Restart that dsh profile after upgrading. This command updates the plugin; update
|
|
||||||
the `bsk` CLI and browser extension separately when a release requires it.
|
|
||||||
|
|
||||||
## Tools
|
## Tools
|
||||||
|
|
||||||
@@ -58,7 +20,23 @@ the `bsk` CLI and browser extension separately when a release requires it.
|
|||||||
| `browser_tabs` | `list`, `create`, `select`, `close`, `borrow`, `return` | Manage Agent Window tabs and temporarily borrow user tabs. |
|
| `browser_tabs` | `list`, `create`, `select`, `close`, `borrow`, `return` | Manage Agent Window tabs and temporarily borrow user tabs. |
|
||||||
| `browser_assist` | `resize`, `emulate`, `request-help` | Resize or emulate the browser and pause for human-only steps. |
|
| `browser_assist` | `resize`, `emulate`, `request-help` | Resize or emulate the browser and pause for human-only steps. |
|
||||||
|
|
||||||
Arbitrary page-script evaluation and interaction recording are not supported.
|
`bsk evaluate` and `bsk record` are intentionally not exposed by this plugin: arbitrary page
|
||||||
|
evaluation is a higher-risk capability, while recording is long-running and needs a dedicated
|
||||||
|
DeepSeek Harness lifecycle before it can be added safely.
|
||||||
|
|
||||||
|
## Agent skill (progressive disclosure)
|
||||||
|
|
||||||
|
Beyond the tools, the plugin publishes the **`browser-skill` agent skill** through the harness's
|
||||||
|
official skill seam (`ctx.skills.register`): the catalog entry (name + routing description) is
|
||||||
|
resident in `<available_skills>`, and the body is loaded only when the model invokes the `skill`
|
||||||
|
tool. Its single source is the DSH-specific `skill/SKILL.md`, which documents only structured
|
||||||
|
`browser_*` calls and their plugin semantics. The repository-root CLI skill is intentionally not
|
||||||
|
concatenated: its command examples belong to a different execution interface and would bypass
|
||||||
|
the plugin's ownership, live observation UI, cancellation, and cleanup path if followed directly.
|
||||||
|
The build rejects internal CLI-name leakage, command-line code blocks, unknown browser tools, and
|
||||||
|
missing supported browser tools before embedding the Markdown. Registration and every pre-step
|
||||||
|
catalog snapshot are pure in-memory reads (no disk/process/daemon); compositions without the skill
|
||||||
|
seam degrade silently.
|
||||||
|
|
||||||
## Multi-session model
|
## Multi-session model
|
||||||
|
|
||||||
@@ -77,73 +55,136 @@ an explicit `session` argument naming a foreign or unknown id is rejected, the `
|
|||||||
`browser_session` shows plugin-created sessions only (no daemon-wide view), and stop/unload cleanup
|
`browser_session` shows plugin-created sessions only (no daemon-wide view), and stop/unload cleanup
|
||||||
can never touch a session owned by another program.
|
can never touch a session owned by another program.
|
||||||
|
|
||||||
## Configuration
|
## Installation
|
||||||
|
|
||||||
After installing the plugin, edit your profile's `cordis.patch.yml`. For the `web`
|
The plugin follows the standard dsh bundle layout (`dsh.bundle` manifest + `cordis.patch.yml`):
|
||||||
profile, the default location is `~/.dsh/profiles/web/cordis.patch.yml`. If you set
|
|
||||||
`DSH_HOME`, use `$DSH_HOME/profiles/web/cordis.patch.yml` instead. Replace `web` with
|
|
||||||
your profile name as needed.
|
|
||||||
|
|
||||||
If the file contains only comments and `[]`, keep the comments and replace `[]`
|
```sh
|
||||||
with the YAML below. If it already contains patch entries, add this entry to the
|
dsh plugin --profile <name> add @wxg-prc-cpg/browser-skill-dsh-plugin
|
||||||
existing list or edit its existing `id: browserskill` entry. Keep a single
|
dsh --profile <name>
|
||||||
top-level YAML list. This overrides the plugin registered by the installed bundle:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- id: browserskill
|
|
||||||
config:
|
|
||||||
bskPath: bsk
|
|
||||||
defaultTimeoutMs: 120000
|
|
||||||
maxSessions: 5
|
|
||||||
observationEnabled: true
|
|
||||||
thumbnailIntervalMs: 1500
|
|
||||||
idleIntervalMs: 8000
|
|
||||||
lazyTools: true
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Change `bskPath` to the full path of your CLI binary if it is not on dsh's `PATH`.
|
Prerequisite: the `bsk` CLI must be installed and on `PATH`, and the BrowserSkill browser extension
|
||||||
A patch replaces the entry's entire `config` object, so keep all overrides you need
|
(Chrome or Edge) must be connected — see the
|
||||||
together in that object.
|
[BrowserSkill README](https://github.com/Tencent/BrowserSkill). When bsk is missing, tool calls fail
|
||||||
|
with install guidance instead of a bare spawn error.
|
||||||
|
|
||||||
Configuration changes follow `dsh.profile.patchReload` in the profile's
|
## Configuration
|
||||||
`package.json`: `live` (the default for `web`) applies changes when you save the
|
|
||||||
patch file; `startup` requires restarting the profile. Restart after upgrading
|
|
||||||
the plugin in either case.
|
|
||||||
|
|
||||||
All fields are optional; omitted fields use the defaults below:
|
All fields are optional and validated through the plugin's Schemastery `Config`:
|
||||||
|
|
||||||
| Option | Default | Purpose |
|
```yaml
|
||||||
| --- | --- | --- |
|
# cordis.patch.yml override example
|
||||||
| `bskPath` | `bsk` | Path to the CLI binary. |
|
- insert:
|
||||||
| `defaultTimeoutMs` | `120000` | Default command timeout in milliseconds. |
|
- id: browserskill
|
||||||
| `maxSessions` | `5` | Maximum concurrent sessions started by this plugin. |
|
name: "@wxg-prc-cpg/browser-skill-dsh-plugin"
|
||||||
| `observationEnabled` | `true` | Enable live browser observation. |
|
config:
|
||||||
| `thumbnailIntervalMs` | `1500` | Screenshot interval for active sessions, in milliseconds. |
|
bskPath: bsk # path to the bsk binary (default: resolve from PATH)
|
||||||
| `idleIntervalMs` | `8000` | Screenshot interval for idle sessions and the recent-activity window, in milliseconds. |
|
defaultTimeoutMs: 120000
|
||||||
| `lazyTools` | `true` | Reveal the browser tools when the skill is invoked. Set `false` to register them at startup. |
|
maxSessions: 5
|
||||||
|
# observationEnabled: true # live PiP/overlay observation (below)
|
||||||
|
# thumbnailIntervalMs: 1500 # frame cadence while a session is active
|
||||||
|
# idleIntervalMs: 8000 # idle cadence / recent-activity window
|
||||||
|
# lazyTools: true # reveal browser_* tools only after the skill is invoked
|
||||||
|
```
|
||||||
|
|
||||||
With `lazyTools: true`, only the skill's catalog entry is initially advertised to
|
- **`lazyTools` (default `true`)** — the final progressive-disclosure stage: the six
|
||||||
the model. The six `browser_*` tool schemas are added to the system prompt after
|
`browser_*` tool schemas stay OUT of the system prompt (zero schema tokens) until the
|
||||||
the `browser-skill` skill is successfully invoked, either by the model or through
|
`browser-skill` skill is actually invoked — the skill catalog entry is the only
|
||||||
`/browser-skill`. Set `lazyTools: false` to make the tools available immediately.
|
advertisement. One successful invocation (model tool call, or a `/browser-skill` user
|
||||||
|
gesture) registers the whole suite for the rest of the process; repeated invocations are
|
||||||
|
no-ops, and sessions resumed with a past invocation in their durable log reveal the suite
|
||||||
|
on entry. Set `false` for the legacy always-on registration.
|
||||||
|
|
||||||
## Live browser view
|
## Observation overlay (PiP mini-window)
|
||||||
|
|
||||||
The dsh Web UI shows the plugin's browser sessions in a floating panel. If your
|
When the plugin runs inside the dsh Web UI, an **observation overlay** floats over the app
|
||||||
profile provides the `dsh-better-sidebar` integration, the view appears in a
|
(registered into the `shell.overlay` seat): a breathing thumbnail per owned session plus its
|
||||||
**Browser Skill** sidebar tab instead.
|
current action and elapsed time. The card docks at the top-right of the content area (clear of
|
||||||
|
the composer and the shell's header controls) and wears the **BrowserSkill product family's own
|
||||||
|
look**: the overlay reuses `@browser-skill/ui` components (`Button`, `cn`) and its oklch design
|
||||||
|
tokens (`--card`, `--primary`, `--destructive`, `--ring`, …), status dots spec'd after the
|
||||||
|
extension popup's connection indicator, and Remix icons. The BSK utility sheet is compiled
|
||||||
|
scoped under the `.bsk-obs` root class (`scripts/build-client-css.mjs`), so the overlay looks
|
||||||
|
like the BrowserSkill extension without leaking a single selector into the host shell — and the
|
||||||
|
shell's theme cannot bleed back in.
|
||||||
|
|
||||||
- See the current action, elapsed time, and recent screenshot for each session.
|
- **Lifecycle**: hidden while the plugin owns no sessions; appears on the first
|
||||||
- Select a session to focus on it. The sidebar view follows the current conversation.
|
`browser_session` start action; disappears when all sessions stop (or the plugin unloads).
|
||||||
- Use **Interrupt** to cancel the current browser command. The agent may continue
|
- **Focus view**: status row (green/idle/red dot + session + action + mm:ss), the latest page
|
||||||
with another action afterward.
|
frame (while viewed, refreshes every ~1.5s while active, ~8s when idle; the last good frame stays on
|
||||||
- Drag or resize the floating panel, or use **Pop out** to open a Picture-in-Picture
|
stage while the next one loads, and is kept on errors so the card does not flash),
|
||||||
window in browsers that support it.
|
and a compact icon toolbar (Interrupt + Pop out, hover for the label).
|
||||||
- Periodic screenshots are requested while a browser observation view is visible.
|
- **Interrupt**: one click kills the in-flight bsk command of the focus session (same semantics
|
||||||
Configure the active and idle intervals with the options above.
|
as the chat Stop button — the current action fails, the agent run may continue). Strip items
|
||||||
|
carry their own hover interrupt button.
|
||||||
|
- **Multi-session strip**: every session gets a tile (mini frame + id + status dot); focus
|
||||||
|
auto-follows the most recently active session; clicking a tile pins focus (pin badge, click
|
||||||
|
again to release); errored sessions get a red edge without stealing focus; sessions the daemon
|
||||||
|
lost are greyed out; prolonged daemon/browser outage shows "browser unavailable" and greys
|
||||||
|
the interrupt button until captures recover.
|
||||||
|
- **Drag & resize**: drag the header to move the card; drag any of the four
|
||||||
|
corners to resize (min 240×180, max 80% of the viewport; no visible grip).
|
||||||
|
Both are remembered for the page lifetime.
|
||||||
|
- **Pop out (PiP)**: upgrades the card into a native Document PiP window (requires a user
|
||||||
|
gesture, per browser rules), sized from the current card; closing the PiP falls back to the
|
||||||
|
in-page card with state intact. Browsers without Document PiP simply hide the button.
|
||||||
|
- **Screenshot demand**: the client requests periodic screenshots while an observation view is
|
||||||
|
visible, using the PiP document's visibility when popped out. Hidden or collapsed views can
|
||||||
|
keep subscribing to state without requesting screenshots. The first screenshot subscriber
|
||||||
|
starts capture scheduling; the last one's departure cancels timers and skips queued captures.
|
||||||
|
An already running capture may finish. Demand applies to the service's owned sessions, not just
|
||||||
|
the selected session.
|
||||||
|
- **Wire**: `GET /bsk-observation/events` is the live synchronization channel (SSE). Every connection,
|
||||||
|
including reconnects, starts with `{ type: "snapshot", sessions, available }`, followed by
|
||||||
|
`upsert`, `remove`, `reset`, and `availability` events on the same stream. Replace local state
|
||||||
|
with each snapshot before applying subsequent events. Use `?thumbnails=0` for state-only
|
||||||
|
subscriptions or `?thumbnails=1` to request screenshots; omitting the parameter defaults to
|
||||||
|
requesting screenshots for compatibility. Closing the stream releases its screenshot demand.
|
||||||
|
`GET /bsk-observation/state` remains a one-time `{ sessions, available }` read and does not
|
||||||
|
request screenshots. It has no ordering guarantee relative to a separate SSE connection;
|
||||||
|
live clients should initialize and resynchronize from the stream's snapshot instead.
|
||||||
|
The host also serves `POST /bsk-observation/interrupt`, `POST /bsk-observation/stop`, and
|
||||||
|
`GET /bsk-observation/thumbnail/<attachmentId>` through the dsh `webServer` route seam
|
||||||
|
(dsh 0.1's Typert Remote pipeline is closed to out-of-tree packages). All commands for one
|
||||||
|
session — tool calls and frame captures alike — run through a per-session FIFO, because the
|
||||||
|
daemon accepts only one unfinished command per session.
|
||||||
|
- **Programmatic subscription**: `ObservationService.subscribe(listener, { thumbnails: false })`
|
||||||
|
subscribes to state without requesting screenshots. On an active service, the listener receives
|
||||||
|
the initial `snapshot` synchronously, before `subscribe` returns, then receives subsequent
|
||||||
|
changes. `thumbnails` defaults to `true`, so callers should choose it explicitly. The returned
|
||||||
|
unsubscribe function is safe to call repeatedly and releases this subscription's screenshot
|
||||||
|
demand. Subscribing after service disposal is a no-op.
|
||||||
|
- **Trust model**: these routes expose live screenshots (and an interrupt write), so they
|
||||||
|
replicate the browser-trust fence dsh applies to its own `/api` routes: the request Host
|
||||||
|
must be a loopback authority (`localhost`, `127.0.0.0/8`, `[::1]`), a present Origin must
|
||||||
|
match the Host, `sec-fetch-site: cross-site` is refused, and POST requires an
|
||||||
|
`application/json` body (cross-site simple requests can never satisfy that). The channel is
|
||||||
|
therefore built for **loopback-only serving** — binding the dsh web server to `0.0.0.0` and
|
||||||
|
reaching it through a LAN address will (deliberately) fail the fence; do not put these
|
||||||
|
routes behind a non-loopback reverse proxy without adding your own authentication.
|
||||||
|
- Configure with `observationEnabled` / `thumbnailIntervalMs` / `idleIntervalMs`.
|
||||||
|
|
||||||
The observation endpoints require a loopback address such as `localhost` or
|
## Behavior notes
|
||||||
`127.0.0.1`. Access through a LAN hostname or non-loopback reverse proxy is not supported.
|
|
||||||
|
- **Cancellation**: aborting a tool call (`exec.signal`) kills the underlying bsk child process,
|
||||||
|
matching BrowserSkill's cooperative tool-cancellation model.
|
||||||
|
- **UI cards**: calls render as terminal cards (command line as title, output as the completed
|
||||||
|
card). Screenshots additionally attach the image itself when the host mounts an attachment store
|
||||||
|
and the active model route declares image input; otherwise the PNG path is returned.
|
||||||
|
- **Web UI toolview (browser half)**: the package is dual-face. `dsh.client` (platform `web`) ships
|
||||||
|
`lib/client.cjs`, which registers a keyed `tool.call.toolview` view for `browser_inspect`. The
|
||||||
|
custom view keeps a terminal block for every inspect action and, when a screenshot result carries
|
||||||
|
an image block, resolves the durable attachment through the client session's authorized
|
||||||
|
`readAttachment` RPC and renders it with the shared `MessageImage` thumbnail/lightbox atoms.
|
||||||
|
The other five tools keep the stock terminal card. The bundle follows the dsh client
|
||||||
|
contract: a CJS closure factory handed to `window.__ModuleLoader__.load`, platform modules
|
||||||
|
(`react`, `dsh-client-ui-*`) external, everything else inlined, CSS Modules compiled by
|
||||||
|
lightningcss.
|
||||||
|
- **Errors**: non-zero bsk exits surface the CLI's JSON error envelope (`code`, `message`, `hint`)
|
||||||
|
so the model gets the daemon's actionable guidance.
|
||||||
|
- **Long-running work** (e.g. `bsk record`) is not backgrounded via `ctx.jobs` yet — tracked as a
|
||||||
|
follow-up.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -154,47 +195,22 @@ pnpm --filter @wxg-prc-cpg/browser-skill-dsh-plugin test # unit tests mock b
|
|||||||
pnpm --filter @wxg-prc-cpg/browser-skill-dsh-plugin build # tsdown -> lib/
|
pnpm --filter @wxg-prc-cpg/browser-skill-dsh-plugin build # tsdown -> lib/
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [development notes](https://github.com/Tencent/BrowserSkill/blob/main/packages/dsh-plugin-browserskill/docs/development.md)
|
|
||||||
for skill registration, tool results, and observation APIs in the current source.
|
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
||||||
The [Release dsh plugin workflow](https://github.com/Tencent/BrowserSkill/blob/main/.github/workflows/release-dsh-plugin.yml)
|
The GitHub Actions workflow **Release dsh plugin** publishes this package to npm
|
||||||
publishes the package and this README to npm. Pushing a `dsh-plugin-vX.Y.Z` tag
|
as `@wxg-prc-cpg/browser-skill-dsh-plugin`. The Cordis plugin id, client
|
||||||
triggers it; ordinary commits to `main` do not.
|
bundle registration, and `cordis.patch.yml` name are the same specifier so
|
||||||
|
dsh can import and materialize the plugin without a ModuleLoader id mismatch.
|
||||||
|
|
||||||
1. Commit this README and any other changes intended for the release.
|
Trigger it by pushing a tag that matches `package.json`'s `version`:
|
||||||
2. From the repository root, run the
|
|
||||||
[release script](https://github.com/Tencent/BrowserSkill/blob/main/scripts/release.mjs)
|
|
||||||
with a new stable version, replacing `<version>` below. The script updates the
|
|
||||||
CLI, extension, and DSH plugin versions, commits the version changes, and creates
|
|
||||||
their release tags:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
node scripts/release.mjs <version>
|
git tag dsh-plugin-v0.1.2
|
||||||
```
|
git push origin dsh-plugin-v0.1.2
|
||||||
|
```
|
||||||
|
|
||||||
3. Push the version commit to the release branch, then push the DSH plugin tag
|
Or run the workflow from the Actions tab (`workflow_dispatch`). The job reads the
|
||||||
created by the script, using the same `<version>`:
|
`NPM_TOKEN` secret from the `npm-publish` GitHub Environment.
|
||||||
|
|
||||||
```sh
|
|
||||||
git push origin HEAD
|
|
||||||
git push origin dsh-plugin-v<version>
|
|
||||||
```
|
|
||||||
|
|
||||||
This publishes the DSH plugin. Push the CLI and extension tags separately when
|
|
||||||
those components are ready for release.
|
|
||||||
|
|
||||||
The workflow checks the version, runs typechecks and tests, builds the package,
|
|
||||||
and publishes it to npm.
|
|
||||||
|
|
||||||
You can also run the workflow manually from GitHub Actions on the intended release
|
|
||||||
ref. Both triggers require an unpublished version and the `NPM_TOKEN` secret in the
|
|
||||||
`npm-publish` GitHub Environment.
|
|
||||||
|
|
||||||
npm updates the package README only when a new version is published, including
|
|
||||||
for documentation-only changes. Published versions cannot be overwritten. See
|
|
||||||
[npm's README update rules](https://docs.npmjs.com/about-package-readme-files/).
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -1,90 +0,0 @@
|
|||||||
# DSH plugin development notes
|
|
||||||
|
|
||||||
For installation, usage, and configuration, see the [plugin README](../README.md).
|
|
||||||
These notes describe the current source on this branch; a published npm version may
|
|
||||||
not include later changes.
|
|
||||||
|
|
||||||
## Tool execution
|
|
||||||
|
|
||||||
The plugin runs the `bsk` CLI and parses its JSON output. The daemon and browser
|
|
||||||
extension perform the browser operations. The published package name is also the
|
|
||||||
Cordis plugin id, client bundle registration id, and `cordis.patch.yml` plugin name.
|
|
||||||
Keep these identifiers aligned so dsh can load both halves of the plugin.
|
|
||||||
|
|
||||||
## Agent skill
|
|
||||||
|
|
||||||
Beyond the tools, the plugin publishes the **`browser-skill` agent skill** through the harness's
|
|
||||||
official skill seam (`ctx.skills.register`): the catalog entry (name + routing description) is
|
|
||||||
resident in `<available_skills>`, and the body is loaded only when the model invokes the `skill`
|
|
||||||
tool. Its single source is the DSH-specific `skill/SKILL.md`, which documents only structured
|
|
||||||
`browser_*` calls and their plugin semantics. The repository-root CLI skill is intentionally not
|
|
||||||
concatenated: its command examples belong to a different execution interface and would bypass
|
|
||||||
the plugin's ownership, live observation UI, cancellation, and cleanup path if followed directly.
|
|
||||||
The build rejects internal CLI-name leakage, command-line code blocks, unknown browser tools, and
|
|
||||||
missing supported browser tools before embedding the Markdown. Registration and every pre-step
|
|
||||||
catalog snapshot are pure in-memory reads (no disk/process/daemon); compositions without the skill
|
|
||||||
seam degrade silently.
|
|
||||||
|
|
||||||
With `lazyTools: true`, the six tool schemas stay out of the system prompt until
|
|
||||||
the skill is successfully invoked. Registration happens once and lasts until the
|
|
||||||
plugin is unloaded. Repeated invocations do not register duplicate tools. Entering
|
|
||||||
a resumed conversation whose history contains a successful skill invocation also
|
|
||||||
registers the tools. Setting `lazyTools: false` registers them at plugin startup.
|
|
||||||
|
|
||||||
## Observation subscriptions and routes
|
|
||||||
|
|
||||||
- **Screenshot demand**: the client requests periodic screenshots while an observation view is
|
|
||||||
visible, using the PiP document's visibility when popped out. Hidden or collapsed views can
|
|
||||||
keep subscribing to state without requesting screenshots. The first screenshot subscriber
|
|
||||||
starts capture scheduling; the last one's departure cancels timers and skips queued captures.
|
|
||||||
An already running capture may finish. Demand applies to the service's owned sessions, not just
|
|
||||||
the selected session.
|
|
||||||
- **Wire**: `GET /bsk-observation/events` is the live synchronization channel (SSE). Every connection,
|
|
||||||
including reconnects, starts with `{ type: "snapshot", sessions, available }`, followed by
|
|
||||||
`upsert`, `remove`, `reset`, and `availability` events on the same stream. Replace local state
|
|
||||||
with each snapshot before applying subsequent events. Use `?thumbnails=0` for state-only
|
|
||||||
subscriptions or `?thumbnails=1` to request screenshots; omitting the parameter defaults to
|
|
||||||
requesting screenshots for compatibility. Closing the stream releases its screenshot demand.
|
|
||||||
`GET /bsk-observation/state` remains a one-time `{ sessions, available }` read and does not
|
|
||||||
request screenshots. It has no ordering guarantee relative to a separate SSE connection;
|
|
||||||
live clients should initialize and resynchronize from the stream's snapshot instead.
|
|
||||||
The host also serves `POST /bsk-observation/interrupt`, `POST /bsk-observation/stop`, and
|
|
||||||
`GET /bsk-observation/thumbnail/<attachmentId>` through the dsh `webServer` route seam
|
|
||||||
(dsh 0.1's Typert Remote pipeline is closed to out-of-tree packages). All commands for one
|
|
||||||
session — tool calls and frame captures alike — run through a per-session FIFO, because the
|
|
||||||
daemon accepts only one unfinished command per session.
|
|
||||||
- **Programmatic subscription**: `ObservationService.subscribe(listener, { thumbnails: false })`
|
|
||||||
subscribes to state without requesting screenshots. On an active service, the listener receives
|
|
||||||
the initial `snapshot` synchronously, before `subscribe` returns, then receives subsequent
|
|
||||||
changes. `thumbnails` defaults to `true`, so callers should choose it explicitly. The returned
|
|
||||||
unsubscribe function is safe to call repeatedly and releases this subscription's screenshot
|
|
||||||
demand. Subscribing after service disposal is a no-op.
|
|
||||||
- **Trust model**: these routes expose live screenshots (and an interrupt write), so they
|
|
||||||
replicate the browser-trust fence dsh applies to its own `/api` routes: the request Host
|
|
||||||
must be a loopback authority (`localhost`, `127.0.0.0/8`, `[::1]`), a present Origin must
|
|
||||||
match the Host, `sec-fetch-site: cross-site` is refused, and POST requires an
|
|
||||||
`application/json` body (cross-site simple requests can never satisfy that). The channel is
|
|
||||||
therefore built for **loopback-only serving** — binding the dsh web server to `0.0.0.0` and
|
|
||||||
reaching it through a LAN address will (deliberately) fail the fence; do not put these
|
|
||||||
routes behind a non-loopback reverse proxy without adding your own authentication.
|
|
||||||
|
|
||||||
## Tool results and cancellation
|
|
||||||
|
|
||||||
- **Cancellation**: aborting a tool call (`exec.signal`) kills the underlying bsk child process,
|
|
||||||
matching BrowserSkill's cooperative tool-cancellation model.
|
|
||||||
- **UI cards**: calls render as terminal cards (command line as title, output as the completed
|
|
||||||
card). Screenshots additionally attach the image itself when the host mounts an attachment store
|
|
||||||
and the active model route declares image input; otherwise the PNG path is returned.
|
|
||||||
- **Web UI toolview (browser half)**: the package is dual-face. `dsh.client` (platform `web`) ships
|
|
||||||
`lib/client.cjs`, which registers a keyed `tool.call.toolview` view for `browser_inspect`. The
|
|
||||||
custom view keeps a terminal block for every inspect action and, when a screenshot result carries
|
|
||||||
an image block, resolves the durable attachment through the client session's authorized
|
|
||||||
`readAttachment` RPC and renders it with the shared `MessageImage` thumbnail/lightbox atoms.
|
|
||||||
The other five tools keep the stock terminal card. The bundle follows the dsh client
|
|
||||||
contract: a CJS closure factory handed to `window.__ModuleLoader__.load`, platform modules
|
|
||||||
(`react`, `dsh-client-ui-*`) external, everything else inlined, CSS Modules compiled by
|
|
||||||
lightningcss.
|
|
||||||
- **Errors**: non-zero bsk exits surface the CLI's JSON error envelope (`code`, `message`, `hint`)
|
|
||||||
so the model gets the daemon's actionable guidance.
|
|
||||||
- **Long-running work** (e.g. `bsk record`) is not backgrounded via `ctx.jobs` yet — tracked as a
|
|
||||||
follow-up.
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@wxg-prc-cpg/browser-skill-dsh-plugin",
|
"name": "@wxg-prc-cpg/browser-skill-dsh-plugin",
|
||||||
"description": "DeepSeek Harness tool plugin that exposes BrowserSkill browser automation (browser_* tools) to the model",
|
"description": "DeepSeek Harness tool plugin that exposes BrowserSkill browser automation (browser_* tools) to the model",
|
||||||
"version": "0.2.1",
|
"version": "0.2.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
@@ -47,6 +47,7 @@
|
|||||||
"client": {
|
"client": {
|
||||||
"platform": "web",
|
"platform": "web",
|
||||||
"inject": [
|
"inject": [
|
||||||
|
"@deepseek-ai/dsh-client-runtime",
|
||||||
"@deepseek-ai/dsh-client-ui-tool",
|
"@deepseek-ai/dsh-client-ui-tool",
|
||||||
"@deepseek-ai/dsh-client-ui-layout"
|
"@deepseek-ai/dsh-client-ui-layout"
|
||||||
],
|
],
|
||||||
@@ -68,6 +69,7 @@
|
|||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@deepseek-ai/cordis": "^4.0.1",
|
"@deepseek-ai/cordis": "^4.0.1",
|
||||||
"@deepseek-ai/dsh-attachment": "^0.1.0-rc.6",
|
"@deepseek-ai/dsh-attachment": "^0.1.0-rc.6",
|
||||||
|
"@deepseek-ai/dsh-client-runtime": "^0.1.0-rc.6",
|
||||||
"@deepseek-ai/dsh-client-ui-attachment": "^0.1.0-rc.6",
|
"@deepseek-ai/dsh-client-ui-attachment": "^0.1.0-rc.6",
|
||||||
"@deepseek-ai/dsh-client-ui-primitives": "^0.1.0-rc.6",
|
"@deepseek-ai/dsh-client-ui-primitives": "^0.1.0-rc.6",
|
||||||
"@deepseek-ai/dsh-client-ui-tool": "^0.1.0-rc.6",
|
"@deepseek-ai/dsh-client-ui-tool": "^0.1.0-rc.6",
|
||||||
@@ -80,6 +82,9 @@
|
|||||||
"@deepseek-ai/dsh-attachment": {
|
"@deepseek-ai/dsh-attachment": {
|
||||||
"optional": true
|
"optional": true
|
||||||
},
|
},
|
||||||
|
"@deepseek-ai/dsh-client-runtime": {
|
||||||
|
"optional": true
|
||||||
|
},
|
||||||
"@deepseek-ai/dsh-client-ui-attachment": {
|
"@deepseek-ai/dsh-client-ui-attachment": {
|
||||||
"optional": true
|
"optional": true
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -7,7 +7,6 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import type { ImageAttachmentRef } from "@deepseek-ai/dsh-attachment";
|
import type { ImageAttachmentRef } from "@deepseek-ai/dsh-attachment";
|
||||||
// Development-only types for the injected services; newer hosts no longer ship this package.
|
|
||||||
import type { ClientContext, ISessions, SessionId } from "@deepseek-ai/dsh-client-runtime/client";
|
import type { ClientContext, ISessions, SessionId } from "@deepseek-ai/dsh-client-runtime/client";
|
||||||
// Type-only: pulls the 'shell.overlay' SlotMap merge into scope.
|
// Type-only: pulls the 'shell.overlay' SlotMap merge into scope.
|
||||||
import type {} from "@deepseek-ai/dsh-client-ui-layout/client";
|
import type {} from "@deepseek-ai/dsh-client-ui-layout/client";
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
* map the CLI's JSON error envelope onto a thrown `BskError`.
|
* map the CLI's JSON error envelope onto a thrown `BskError`.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { type ChildProcess, type SpawnOptionsWithoutStdio, spawn } from "node:child_process";
|
import { type ChildProcess, spawn } from "node:child_process";
|
||||||
|
|
||||||
/** Shape of the JSON error envelope `bsk --json` prints on failure. */
|
/** Shape of the JSON error envelope `bsk --json` prints on failure. */
|
||||||
export interface BskErrorBody {
|
export interface BskErrorBody {
|
||||||
@@ -53,11 +53,7 @@ export interface BskRunOptions {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Minimal spawn signature so tests can substitute a fake child process. */
|
/** Minimal spawn signature so tests can substitute a fake child process. */
|
||||||
export type SpawnImpl = (
|
export type SpawnImpl = (command: string, args: string[]) => ChildProcess;
|
||||||
command: string,
|
|
||||||
args: string[],
|
|
||||||
options?: SpawnOptionsWithoutStdio,
|
|
||||||
) => ChildProcess;
|
|
||||||
|
|
||||||
export interface BskRunner {
|
export interface BskRunner {
|
||||||
/** Run `bsk <args...> --json` and collect its output. */
|
/** Run `bsk <args...> --json` and collect its output. */
|
||||||
@@ -68,66 +64,29 @@ export interface BskRunner {
|
|||||||
killFor(tag: string): number;
|
killFor(tag: string): number;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Business RPCs translate Ctrl-C / opt-in stdin EOF into cancel(rpc_id).
|
// Business RPCs translate SIGINT into the daemon's cancel(rpc_id) protocol.
|
||||||
// Allow reconciliation before hard-killing an old or unresponsive CLI.
|
// Give that bounded reconciliation path time to settle before the hard kill.
|
||||||
const KILL_GRACE_MS = 3000;
|
const KILL_GRACE_MS = 3000;
|
||||||
// Windows IPC may spend 5s connecting, 2s cancelling, 2s settling,
|
|
||||||
// and up to 5s releasing the entire batch of caller-owned transfers.
|
|
||||||
const WINDOWS_KILL_GRACE_MS = 15_000;
|
|
||||||
const SESSION_BUSY_RETRY_DELAY_MS = 100;
|
const SESSION_BUSY_RETRY_DELAY_MS = 100;
|
||||||
|
|
||||||
export function createBskRunner(bskPath: string, spawnImpl: SpawnImpl = spawn): BskRunner {
|
export function createBskRunner(bskPath: string, spawnImpl: SpawnImpl = spawn): BskRunner {
|
||||||
const live = new Map<ChildProcess, string | undefined>();
|
const live = new Map<ChildProcess, string | undefined>();
|
||||||
const windows = process.platform === "win32";
|
|
||||||
const cancelling = new Set<ChildProcess>();
|
|
||||||
|
|
||||||
function killChild(child: ChildProcess): void {
|
function killChild(child: ChildProcess): void {
|
||||||
if (child.exitCode !== null || child.signalCode !== null || cancelling.has(child)) return;
|
if (child.exitCode !== null || child.signalCode !== null) return;
|
||||||
cancelling.add(child);
|
child.kill("SIGINT");
|
||||||
// Node kills Windows children outright for SIGINT. EOF asks the CLI to
|
const force = setTimeout(() => {
|
||||||
// send its existing cancel RPC and wait for browser reconciliation.
|
if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");
|
||||||
if (windows && child.stdin) child.stdin.end();
|
}, KILL_GRACE_MS);
|
||||||
else child.kill("SIGINT");
|
|
||||||
const force = setTimeout(
|
|
||||||
() => {
|
|
||||||
if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");
|
|
||||||
},
|
|
||||||
windows ? WINDOWS_KILL_GRACE_MS : KILL_GRACE_MS,
|
|
||||||
);
|
|
||||||
force.unref();
|
force.unref();
|
||||||
child.once("close", () => {
|
|
||||||
clearTimeout(force);
|
|
||||||
cancelling.delete(child);
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
run(args, options = {}) {
|
run(args, options = {}) {
|
||||||
if (options.signal?.aborted) {
|
|
||||||
return Promise.resolve({
|
|
||||||
code: null,
|
|
||||||
stdout: "",
|
|
||||||
stderr: "",
|
|
||||||
timedOut: false,
|
|
||||||
aborted: true,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return new Promise<BskRunResult>((resolve, reject) => {
|
return new Promise<BskRunResult>((resolve, reject) => {
|
||||||
let child: ChildProcess;
|
let child: ChildProcess;
|
||||||
try {
|
try {
|
||||||
child = spawnImpl(
|
child = spawnImpl(bskPath, [...args, "--json"]);
|
||||||
bskPath,
|
|
||||||
[...args, "--json"],
|
|
||||||
windows
|
|
||||||
? {
|
|
||||||
windowsHide: true,
|
|
||||||
env: { ...process.env, BSK_CANCEL_ON_STDIN_CLOSE: "1" },
|
|
||||||
}
|
|
||||||
: undefined,
|
|
||||||
);
|
|
||||||
// A child exiting while cancellation closes stdin may report EPIPE.
|
|
||||||
// Its close/error event remains the authority for the run result.
|
|
||||||
child.stdin?.on("error", () => {});
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
reject(error);
|
reject(error);
|
||||||
return;
|
return;
|
||||||
|
|||||||
@@ -489,7 +489,9 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
? "Capture an indented aria-tree snapshot of the session's active tab. Interactive elements " +
|
? "Capture an indented aria-tree snapshot of the session's active tab. Interactive elements " +
|
||||||
"carry @eN refs for browser_interact actions. Prefer browser_inspect action=observe for a richer semantic view."
|
"carry @eN refs for browser_interact actions. Prefer browser_inspect action=observe for a richer semantic view."
|
||||||
: "Produce a semantic VOM observation of the session's active tab (roles, states, perception " +
|
: "Produce a semantic VOM observation of the session's active tab (roles, states, perception " +
|
||||||
"probes) with @eN refs for browser_interact actions. Read-only: never submits input.";
|
"probes) with @eN refs for browser_interact actions. Visual-only surfaces require image " +
|
||||||
|
"understanding and their refs are screenshot-only; keep using any DOM/AX semantics rendered " +
|
||||||
|
"alongside them. Read-only: never submits input.";
|
||||||
register(
|
register(
|
||||||
defineTool({
|
defineTool({
|
||||||
name,
|
name,
|
||||||
@@ -561,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",
|
||||||
@@ -578,6 +581,24 @@ 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).",
|
||||||
},
|
},
|
||||||
|
modifiers: {
|
||||||
|
type: "array",
|
||||||
|
items: { type: "string", enum: ["alt", "ctrl", "meta", "shift"] },
|
||||||
|
description: "Keyboard modifiers held during the click.",
|
||||||
|
},
|
||||||
|
captureId: {
|
||||||
|
type: "string",
|
||||||
|
description:
|
||||||
|
"Short-lived Surface capture id returned by browser_inspect action=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: {
|
||||||
@@ -588,6 +609,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) => [
|
||||||
@@ -599,17 +621,44 @@ 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.modifiers !== undefined && args.modifiers.length > 0) {
|
||||||
|
cmdArgs.push("--modifiers", args.modifiers.join(","));
|
||||||
|
}
|
||||||
|
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",
|
||||||
@@ -754,12 +803,17 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
name: "inspect.screenshot",
|
name: "inspect.screenshot",
|
||||||
description:
|
description:
|
||||||
"Capture a PNG screenshot of the session's active tab, or crop to a snapshot ref element. " +
|
"Capture a PNG screenshot of the session's active tab, or crop to a snapshot ref element. " +
|
||||||
|
"This is the supported operation for visual surface refs emitted by inspect.observe. Only use " +
|
||||||
|
"it to interpret a visual-only surface when you can inspect image output. If you lack multimodal " +
|
||||||
|
"or image-reading capability, tell the user to switch to a model with image understanding; do " +
|
||||||
|
"not guess content or coordinates. " +
|
||||||
"Returns the image itself when the deployment supports image input, otherwise a file path.",
|
"Returns the image itself when the deployment supports image input, otherwise a file path.",
|
||||||
parameters: {
|
parameters: {
|
||||||
session: SESSION_PARAM,
|
session: SESSION_PARAM,
|
||||||
ref: {
|
ref: {
|
||||||
type: "string",
|
type: "string",
|
||||||
description: "Snapshot ref (@e3) from the last snapshot/observe; crops to that element.",
|
description:
|
||||||
|
"Ref (@e3) from the last snapshot/observe; crops to that DOM element or visual surface.",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
output: {
|
output: {
|
||||||
@@ -773,6 +827,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,
|
||||||
@@ -796,7 +852,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",
|
||||||
@@ -835,6 +895,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);
|
||||||
@@ -848,6 +909,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: {
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import type { ChildProcess } from "node:child_process";
|
import type { ChildProcess } from "node:child_process";
|
||||||
import { EventEmitter } from "node:events";
|
import { EventEmitter } from "node:events";
|
||||||
import { PassThrough } from "node:stream";
|
import { describe, expect, it } from "vitest";
|
||||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
||||||
import {
|
import {
|
||||||
type BskRunResult,
|
type BskRunResult,
|
||||||
createBskRunner,
|
createBskRunner,
|
||||||
@@ -93,77 +92,6 @@ describe("createBskRunner", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Windows parent cancellation", () => {
|
|
||||||
const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform")!;
|
|
||||||
beforeEach(() => Object.defineProperty(process, "platform", { value: "win32" }));
|
|
||||||
afterEach(() => {
|
|
||||||
Object.defineProperty(process, "platform", originalPlatform);
|
|
||||||
vi.useRealTimers();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("opts in to stdin cancellation and waits for CLI reconciliation", async () => {
|
|
||||||
const child = Object.assign(new FakeChild(), { stdin: new PassThrough() });
|
|
||||||
const spawn = vi.fn(() => child as unknown as ChildProcess);
|
|
||||||
const runner = createBskRunner("bsk", spawn);
|
|
||||||
const abort = new AbortController();
|
|
||||||
const result = runner.run(["snapshot"], { signal: abort.signal });
|
|
||||||
expect(spawn.mock.calls[0]).toEqual([
|
|
||||||
"bsk",
|
|
||||||
["snapshot", "--json"],
|
|
||||||
{
|
|
||||||
windowsHide: true,
|
|
||||||
env: { ...process.env, BSK_CANCEL_ON_STDIN_CLOSE: "1" },
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
abort.abort();
|
|
||||||
expect(child.stdin.writableEnded).toBe(true);
|
|
||||||
expect(child.killedWith).toEqual([]);
|
|
||||||
// Closing an already-exited child's pipe must not crash the host.
|
|
||||||
child.stdin.emit("error", Object.assign(new Error("closed"), { code: "EPIPE" }));
|
|
||||||
child.finish(2, '{"code":"cancelled"}');
|
|
||||||
expect(await result).toMatchObject({ code: 2, aborted: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("bounds cancellation of an old or unresponsive CLI", async () => {
|
|
||||||
vi.useFakeTimers();
|
|
||||||
const child = Object.assign(new FakeChild(), { stdin: new PassThrough() });
|
|
||||||
const runner = createBskRunner("bsk", fakeSpawn([child]));
|
|
||||||
const result = runner.run(["snapshot"], { timeoutMs: 5 });
|
|
||||||
await vi.advanceTimersByTimeAsync(5);
|
|
||||||
expect(child.stdin.writableEnded).toBe(true);
|
|
||||||
expect(child.killedWith).toEqual([]);
|
|
||||||
await vi.advanceTimersByTimeAsync(10_000);
|
|
||||||
expect(child.killedWith).toEqual([]);
|
|
||||||
await vi.advanceTimersByTimeAsync(5_000);
|
|
||||||
expect(child.killedWith).toEqual(["SIGKILL"]);
|
|
||||||
expect(await result).toMatchObject({ timedOut: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("cancels only the requested tag and clears the fallback after exit", async () => {
|
|
||||||
vi.useFakeTimers();
|
|
||||||
const a = Object.assign(new FakeChild(), { stdin: new PassThrough() });
|
|
||||||
const b = Object.assign(new FakeChild(), { stdin: new PassThrough() });
|
|
||||||
const runner = createBskRunner("bsk", fakeSpawn([a, b]));
|
|
||||||
const first = runner.run(["snapshot"], { tag: "a" });
|
|
||||||
const second = runner.run(["snapshot"], { tag: "b" });
|
|
||||||
expect(runner.killFor("a")).toBe(1);
|
|
||||||
expect(a.stdin.writableEnded).toBe(true);
|
|
||||||
expect(b.stdin.writableEnded).toBe(false);
|
|
||||||
a.finish(2);
|
|
||||||
b.finish(0);
|
|
||||||
await Promise.all([first, second]);
|
|
||||||
expect(vi.getTimerCount()).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not start work for an already-aborted call", async () => {
|
|
||||||
const spawn = vi.fn();
|
|
||||||
const runner = createBskRunner("bsk", spawn);
|
|
||||||
const signal = AbortSignal.abort();
|
|
||||||
expect(await runner.run(["snapshot"], { signal })).toMatchObject({ aborted: true });
|
|
||||||
expect(spawn).not.toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("parseBskJson", () => {
|
describe("parseBskJson", () => {
|
||||||
const base: BskRunResult = { code: 0, stdout: "", stderr: "", timedOut: false, aborted: false };
|
const base: BskRunResult = { code: 0, stdout: "", stderr: "", timedOut: false, aborted: false };
|
||||||
|
|
||||||
|
|||||||
@@ -478,12 +478,12 @@ describe("interaction tools", () => {
|
|||||||
emulate: { tab_id: 7, cleared: false },
|
emulate: { tab_id: 7, cleared: false },
|
||||||
};
|
};
|
||||||
|
|
||||||
it("interact.click maps target, button, and click count", async () => {
|
it("interact.click maps target, button, click count, and modifiers", async () => {
|
||||||
const { tools, calls } = setup(responses);
|
const { tools, calls } = setup(responses);
|
||||||
await startSession(tools);
|
await startSession(tools);
|
||||||
const click = tools.get("interact.click");
|
const click = tools.get("interact.click");
|
||||||
const value = (await click?.execute(
|
const value = (await click?.execute(
|
||||||
{ target: "@e1", button: "right", clickCount: 2 },
|
{ target: "@e1", button: "right", clickCount: 2, modifiers: ["ctrl", "shift"] },
|
||||||
makeExec(),
|
makeExec(),
|
||||||
)) as { session: string; x: number; y: number };
|
)) as { session: string; x: number; y: number };
|
||||||
expect(value).toMatchObject({ session: "s1", x: 10, y: 20 });
|
expect(value).toMatchObject({ session: "s1", x: 10, y: 20 });
|
||||||
@@ -495,6 +495,43 @@ describe("interaction tools", () => {
|
|||||||
"right",
|
"right",
|
||||||
"--click-count",
|
"--click-count",
|
||||||
"2",
|
"2",
|
||||||
|
"--modifiers",
|
||||||
|
"ctrl,shift",
|
||||||
|
"@e1",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
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",
|
"@e1",
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
@@ -923,6 +960,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("inspect.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 = {
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ const CLIENT_EXTERNALS: readonly string[] = [
|
|||||||
"@deepseek-ai/dsh-client-ui-primitives",
|
"@deepseek-ai/dsh-client-ui-primitives",
|
||||||
"@deepseek-ai/dsh-client-ui-attachment",
|
"@deepseek-ai/dsh-client-ui-attachment",
|
||||||
"@deepseek-ai/dsh-client-schema-form",
|
"@deepseek-ai/dsh-client-schema-form",
|
||||||
|
"@deepseek-ai/dsh-client-runtime/client",
|
||||||
];
|
];
|
||||||
|
|
||||||
/** Wire/type layers with no shared runtime identity: safe to inline. */
|
/** Wire/type layers with no shared runtime identity: safe to inline. */
|
||||||
|
|||||||
@@ -29,6 +29,139 @@ function coreRefs(refs: ReturnType<typeof renderVom>["refs"]) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
describe("renderVom single-layer page", () => {
|
describe("renderVom single-layer page", () => {
|
||||||
|
it("renders visual surfaces as screenshot-only refs", () => {
|
||||||
|
const input = scene([
|
||||||
|
node({ id: 1, role: "RootWebArea", frameId: "main" }),
|
||||||
|
node({ id: 2, parentId: 1, role: "Iframe", frameId: "main", backendNodeId: 20 }),
|
||||||
|
]);
|
||||||
|
input.visualSurfaces = [
|
||||||
|
{
|
||||||
|
parentId: 2,
|
||||||
|
backendNodeId: 99,
|
||||||
|
frameId: "child",
|
||||||
|
renderingKind: "canvas",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
label: "Data grid",
|
||||||
|
memberCount: 2,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
const out = renderVom(input);
|
||||||
|
|
||||||
|
expect(out.text).toContain("[visual surfaces]");
|
||||||
|
expect(out.text).toContain(
|
||||||
|
'@e1 surface "Data grid" [bounds=10,20,800,500; rendering=canvas; layers=2; visual-only; requires=image-understanding; use: bsk screenshot --ref @e1]',
|
||||||
|
);
|
||||||
|
expect(out.refs).toContainEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
ref: "e1",
|
||||||
|
backendNodeId: 99,
|
||||||
|
kind: "surface",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("renders an unnamed visual surface with a stable generic label", () => {
|
||||||
|
const input = scene([node({ id: 1, role: "RootWebArea", frameId: "main" })]);
|
||||||
|
input.visualSurfaces = [
|
||||||
|
{
|
||||||
|
parentId: 1,
|
||||||
|
backendNodeId: 99,
|
||||||
|
frameId: "main",
|
||||||
|
renderingKind: "canvas",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
memberCount: 1,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const out = renderVom(input);
|
||||||
|
|
||||||
|
expect(out.text).toContain(
|
||||||
|
'@e1 surface "canvas visual surface" [bounds=10,20,800,500; rendering=canvas; visual-only; requires=image-understanding; use: bsk screenshot --ref @e1]',
|
||||||
|
);
|
||||||
|
expect(out.refs).toContainEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
ref: "e1",
|
||||||
|
name: "canvas visual surface",
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("appends visual refs after DOM refs so canvas density cannot renumber controls", () => {
|
||||||
|
const input = scene([
|
||||||
|
node({ id: 1, role: "RootWebArea", frameId: "main" }),
|
||||||
|
node({ id: 2, parentId: 1, role: "button", name: "Submit", tag: "button" }),
|
||||||
|
]);
|
||||||
|
input.visualSurfaces = [
|
||||||
|
{
|
||||||
|
parentId: 1,
|
||||||
|
backendNodeId: 99,
|
||||||
|
frameId: "main",
|
||||||
|
renderingKind: "canvas",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 80, h: 50 },
|
||||||
|
memberCount: 1,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const withoutVisuals = renderVom({ ...input, visualSurfaces: [] });
|
||||||
|
const withVisuals = renderVom(input);
|
||||||
|
|
||||||
|
expect(withoutVisuals.refs[0]).toMatchObject({ ref: "e1", backendNodeId: 2, kind: "dom" });
|
||||||
|
expect(withVisuals.refs[0]).toMatchObject({ ref: "e1", backendNodeId: 2, kind: "dom" });
|
||||||
|
expect(withVisuals.refs[1]).toMatchObject({ ref: "e2", backendNodeId: 99, kind: "surface" });
|
||||||
|
expect(withVisuals.text.indexOf('@e1 button "Submit"')).toBeLessThan(
|
||||||
|
withVisuals.text.indexOf("[visual surfaces]"),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("bounds visual output and prefers explicitly labeled surfaces", () => {
|
||||||
|
const input = scene([node({ id: 1, role: "RootWebArea", frameId: "main" })]);
|
||||||
|
input.visualSurfaces = Array.from({ length: 12 }, (_, index) => ({
|
||||||
|
parentId: 1,
|
||||||
|
backendNodeId: 100 + index,
|
||||||
|
frameId: "main",
|
||||||
|
renderingKind: "canvas" as const,
|
||||||
|
visibleRect: { x: index * 10, y: 20, w: 8, h: 8 },
|
||||||
|
...(index === 11 ? { label: "Important status" } : {}),
|
||||||
|
memberCount: 1,
|
||||||
|
}));
|
||||||
|
|
||||||
|
const out = renderVom(input);
|
||||||
|
const surfaceRefs = out.refs.filter((ref) => ref.kind === "surface");
|
||||||
|
|
||||||
|
expect(surfaceRefs).toHaveLength(8);
|
||||||
|
expect(surfaceRefs[0]).toMatchObject({ backendNodeId: 111, name: "Important status" });
|
||||||
|
expect(out.text).toContain("… 4 additional visual surfaces omitted");
|
||||||
|
expect(out.truncated).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not let a visual surface exhaust the budget before later DOM content", () => {
|
||||||
|
const input = scene([
|
||||||
|
node({ id: 1, role: "RootWebArea", name: "Doc", frameId: "main" }),
|
||||||
|
node({ id: 2, parentId: 1, role: "button", name: "First", tag: "button" }),
|
||||||
|
node({ id: 3, parentId: 1, role: "button", name: "Later", tag: "button" }),
|
||||||
|
]);
|
||||||
|
input.visualSurfaces = [
|
||||||
|
{
|
||||||
|
parentId: 1,
|
||||||
|
backendNodeId: 99,
|
||||||
|
frameId: "main",
|
||||||
|
renderingKind: "canvas",
|
||||||
|
visibleRect: { x: 10, y: 20, w: 800, h: 500 },
|
||||||
|
memberCount: 1,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const out = renderVom(input, { maxTokens: 30 });
|
||||||
|
|
||||||
|
expect(out.text).toContain('@e2 button "Later"');
|
||||||
|
expect(out.refs.filter((ref) => ref.kind === "surface")).toHaveLength(0);
|
||||||
|
expect(out.truncated).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
it("does not derive handle context across frame scopes", () => {
|
it("does not derive handle context across frame scopes", () => {
|
||||||
const out = renderVom(
|
const out = renderVom(
|
||||||
scene([
|
scene([
|
||||||
|
|||||||
@@ -15,6 +15,8 @@ export type {
|
|||||||
VomNode,
|
VomNode,
|
||||||
VomOptions,
|
VomOptions,
|
||||||
VomRef,
|
VomRef,
|
||||||
|
VomRefCapability,
|
||||||
VomResult,
|
VomResult,
|
||||||
VomScene,
|
VomScene,
|
||||||
|
VomVisualSurface,
|
||||||
} from "./types";
|
} from "./types";
|
||||||
|
|||||||
+124
-2
@@ -9,6 +9,7 @@ import type {
|
|||||||
VomOptions,
|
VomOptions,
|
||||||
VomResult,
|
VomResult,
|
||||||
VomScene,
|
VomScene,
|
||||||
|
VomVisualSurface,
|
||||||
} from "./types";
|
} from "./types";
|
||||||
|
|
||||||
const SKIP_ROLES = new Set(["generic", "none", "presentation", "inlinetextbox"]);
|
const SKIP_ROLES = new Set(["generic", "none", "presentation", "inlinetextbox"]);
|
||||||
@@ -87,6 +88,7 @@ const MAX_CUSTOM_RECOVERY_AREA = 180_000;
|
|||||||
const MAX_RECOVERABLE_SINGLE_INTENT_AREA = 360_000;
|
const MAX_RECOVERABLE_SINGLE_INTENT_AREA = 360_000;
|
||||||
const MAX_HANDLE_CONTEXT_ITEMS = 3;
|
const MAX_HANDLE_CONTEXT_ITEMS = 3;
|
||||||
const MAX_SURFACE_ITEMS = 12;
|
const MAX_SURFACE_ITEMS = 12;
|
||||||
|
const MAX_VISUAL_SURFACES = 8;
|
||||||
const MAX_SCOPE_LINES = 40;
|
const MAX_SCOPE_LINES = 40;
|
||||||
const RECOVERY_HANDLER_ATTRS = ["onclick", "onmousedown", "onkeydown", "onkeyup", "onkeypress"];
|
const RECOVERY_HANDLER_ATTRS = ["onclick", "onmousedown", "onkeydown", "onkeyup", "onkeypress"];
|
||||||
const NATIVE_TAGS = new Set(["button", "input", "select", "textarea"]);
|
const NATIVE_TAGS = new Set(["button", "input", "select", "textarea"]);
|
||||||
@@ -793,6 +795,108 @@ interface RenderState {
|
|||||||
duplicateRefNames: Set<string>;
|
duplicateRefNames: Set<string>;
|
||||||
surfaceMap: Map<number, CondSurface>;
|
surfaceMap: Map<number, CondSurface>;
|
||||||
scopeMap: Map<number, ActiveScopeBlock>;
|
scopeMap: Map<number, ActiveScopeBlock>;
|
||||||
|
visualSurfaces: VomVisualSurface[];
|
||||||
|
}
|
||||||
|
|
||||||
|
function visualSurfaceArea(surface: VomVisualSurface): number {
|
||||||
|
return Math.max(0, surface.visibleRect.w) * Math.max(0, surface.visibleRect.h);
|
||||||
|
}
|
||||||
|
|
||||||
|
function compareVisualSurfaces(a: VomVisualSurface, b: VomVisualSurface): number {
|
||||||
|
const aLabeled = cleaned(a.label) !== undefined;
|
||||||
|
const bLabeled = cleaned(b.label) !== undefined;
|
||||||
|
return (
|
||||||
|
Number(bLabeled) - Number(aLabeled) ||
|
||||||
|
visualSurfaceArea(b) - visualSurfaceArea(a) ||
|
||||||
|
a.frameId.localeCompare(b.frameId) ||
|
||||||
|
a.visibleRect.y - b.visibleRect.y ||
|
||||||
|
a.visibleRect.x - b.visibleRect.x ||
|
||||||
|
a.backendNodeId - b.backendNodeId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function visualSurfaceLine(surface: VomVisualSurface, ref: string): string {
|
||||||
|
const label = cleaned(surface.label) ?? `${surface.renderingKind} visual surface`;
|
||||||
|
const layers = surface.memberCount > 1 ? `; layers=${surface.memberCount}` : "";
|
||||||
|
const { x, y, w, h } = surface.visibleRect;
|
||||||
|
const bounds = [x, y, w, h].map(Math.round).join(",");
|
||||||
|
return ` @${ref} surface ${JSON.stringify(label)} [bounds=${bounds}; rendering=${surface.renderingKind}${layers}; visual-only; requires=image-understanding; use: bsk screenshot --ref @${ref}]`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function selectVisualSurfaces(
|
||||||
|
surfaces: readonly VomVisualSurface[],
|
||||||
|
nodesById: ReadonlyMap<number, VomNode>,
|
||||||
|
): { selected: VomVisualSurface[]; eligibleCount: number } {
|
||||||
|
const selected: VomVisualSurface[] = [];
|
||||||
|
let eligibleCount = 0;
|
||||||
|
|
||||||
|
for (const surface of surfaces) {
|
||||||
|
if (surface.parentId !== null && !nodesById.has(surface.parentId)) continue;
|
||||||
|
eligibleCount += 1;
|
||||||
|
|
||||||
|
const insertionIndex = selected.findIndex(
|
||||||
|
(candidate) => compareVisualSurfaces(surface, candidate) < 0,
|
||||||
|
);
|
||||||
|
if (insertionIndex < 0) {
|
||||||
|
if (selected.length < MAX_VISUAL_SURFACES) selected.push(surface);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
selected.splice(insertionIndex, 0, surface);
|
||||||
|
if (selected.length > MAX_VISUAL_SURFACES) selected.pop();
|
||||||
|
}
|
||||||
|
|
||||||
|
return { selected, eligibleCount };
|
||||||
|
}
|
||||||
|
|
||||||
|
function emitVisualAppendix(state: RenderState): void {
|
||||||
|
if (state.stopped) return;
|
||||||
|
const { selected, eligibleCount } = selectVisualSurfaces(state.visualSurfaces, state.nodesById);
|
||||||
|
if (eligibleCount === 0) return;
|
||||||
|
|
||||||
|
const header = "[visual surfaces]";
|
||||||
|
let headerEmitted = false;
|
||||||
|
let emitted = 0;
|
||||||
|
for (const surface of selected) {
|
||||||
|
const ref = `e${state.nextRef}`;
|
||||||
|
const line = visualSurfaceLine(surface, ref);
|
||||||
|
const nextTokens =
|
||||||
|
state.tokens + estimateTokens(line) + (headerEmitted ? 0 : estimateTokens(header));
|
||||||
|
if (nextTokens > state.maxTokens) break;
|
||||||
|
if (!headerEmitted) {
|
||||||
|
state.lines.push(header);
|
||||||
|
state.tokens += estimateTokens(header);
|
||||||
|
headerEmitted = true;
|
||||||
|
}
|
||||||
|
state.lines.push(line);
|
||||||
|
state.tokens += estimateTokens(line);
|
||||||
|
const label = cleaned(surface.label) ?? `${surface.renderingKind} visual surface`;
|
||||||
|
state.refs.push({
|
||||||
|
ref,
|
||||||
|
backendNodeId: surface.backendNodeId,
|
||||||
|
frameId: surface.frameId,
|
||||||
|
visibleRect: surface.visibleRect,
|
||||||
|
role: "surface",
|
||||||
|
name: label,
|
||||||
|
kind: "surface",
|
||||||
|
capabilities: ["screenshot"],
|
||||||
|
line: state.lines.length - 1,
|
||||||
|
});
|
||||||
|
state.nextRef += 1;
|
||||||
|
emitted += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
const omitted = eligibleCount - emitted;
|
||||||
|
if (omitted > 0) {
|
||||||
|
state.truncated = true;
|
||||||
|
if (headerEmitted) {
|
||||||
|
const summary = ` … ${omitted} additional visual surfaces omitted`;
|
||||||
|
const nextTokens = state.tokens + estimateTokens(summary);
|
||||||
|
if (nextTokens <= state.maxTokens) {
|
||||||
|
state.lines.push(summary);
|
||||||
|
state.tokens = nextTokens;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function emitActiveScopeBlock(scope: ActiveScopeBlock, depth: number, state: RenderState): void {
|
function emitActiveScopeBlock(scope: ActiveScopeBlock, depth: number, state: RenderState): void {
|
||||||
@@ -873,6 +977,8 @@ function renderTree(children: Map<number | null, VomNode[]>, state: RenderState)
|
|||||||
...(node.role ? { role: node.role } : {}),
|
...(node.role ? { role: node.role } : {}),
|
||||||
...(name ? { name } : {}),
|
...(name ? { name } : {}),
|
||||||
...(context.length > 0 ? { ctx: context.join(" > ") } : {}),
|
...(context.length > 0 ? { ctx: context.join(" > ") } : {}),
|
||||||
|
kind: "dom",
|
||||||
|
capabilities: ["interact", "screenshot"],
|
||||||
line: state.lines.length - 1,
|
line: state.lines.length - 1,
|
||||||
});
|
});
|
||||||
state.nextRef += 1;
|
state.nextRef += 1;
|
||||||
@@ -894,6 +1000,7 @@ function renderNodes(
|
|||||||
initialLines: string[],
|
initialLines: string[],
|
||||||
surfaces: CondSurface[] = [],
|
surfaces: CondSurface[] = [],
|
||||||
activeScopeBlocks: ActiveScopeBlock[] = [],
|
activeScopeBlocks: ActiveScopeBlock[] = [],
|
||||||
|
visualSurfaces: VomVisualSurface[] = [],
|
||||||
): RenderState {
|
): RenderState {
|
||||||
const children = buildChildren(nodes);
|
const children = buildChildren(nodes);
|
||||||
const state: RenderState = {
|
const state: RenderState = {
|
||||||
@@ -913,6 +1020,7 @@ function renderNodes(
|
|||||||
duplicateRefNames: duplicateReferenceNames(nodes),
|
duplicateRefNames: duplicateReferenceNames(nodes),
|
||||||
surfaceMap: new Map(surfaces.map((surface) => [surface.triggerId, surface])),
|
surfaceMap: new Map(surfaces.map((surface) => [surface.triggerId, surface])),
|
||||||
scopeMap: new Map(activeScopeBlocks.map((scope) => [scope.triggerId, scope])),
|
scopeMap: new Map(activeScopeBlocks.map((scope) => [scope.triggerId, scope])),
|
||||||
|
visualSurfaces,
|
||||||
};
|
};
|
||||||
|
|
||||||
renderTree(children, state);
|
renderTree(children, state);
|
||||||
@@ -1124,8 +1232,20 @@ function renderDoubleLayer(scene: VomScene, layer: BlockingLayer, options: VomOp
|
|||||||
"@layers 2 focus=L1",
|
"@layers 2 focus=L1",
|
||||||
`L1 ${layer.kind} cover=${Math.round(layer.coverage * 100)}%`,
|
`L1 ${layer.kind} cover=${Math.round(layer.coverage * 100)}%`,
|
||||||
];
|
];
|
||||||
const state = renderNodes(visibleNodes, options, header, scene.surfaces, scene.activeScopeBlocks);
|
const visibleSurface = (parentId: number | null): boolean =>
|
||||||
state.lines.push(renderPageOcclusionLine(hiddenCount));
|
parentId === null || included.has(parentId);
|
||||||
|
const state = renderNodes(
|
||||||
|
visibleNodes,
|
||||||
|
options,
|
||||||
|
header,
|
||||||
|
scene.surfaces,
|
||||||
|
scene.activeScopeBlocks,
|
||||||
|
scene.visualSurfaces?.filter((surface) => visibleSurface(surface.parentId)),
|
||||||
|
);
|
||||||
|
const occlusionLine = renderPageOcclusionLine(hiddenCount);
|
||||||
|
state.lines.push(occlusionLine);
|
||||||
|
state.tokens += estimateTokens(occlusionLine);
|
||||||
|
emitVisualAppendix(state);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
text: state.lines.join("\n"),
|
text: state.lines.join("\n"),
|
||||||
@@ -1152,7 +1272,9 @@ export function renderVom(scene: VomScene, options: VomOptions = {}): VomResult
|
|||||||
],
|
],
|
||||||
scene.surfaces,
|
scene.surfaces,
|
||||||
scene.activeScopeBlocks,
|
scene.activeScopeBlocks,
|
||||||
|
scene.visualSurfaces,
|
||||||
);
|
);
|
||||||
|
emitVisualAppendix(state);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
text: state.lines.join("\n"),
|
text: state.lines.join("\n"),
|
||||||
|
|||||||
@@ -61,6 +61,8 @@ export interface VomScene {
|
|||||||
rootFrameId?: string;
|
rootFrameId?: string;
|
||||||
surfaces?: CondSurface[];
|
surfaces?: CondSurface[];
|
||||||
activeScopeBlocks?: ActiveScopeBlock[];
|
activeScopeBlocks?: ActiveScopeBlock[];
|
||||||
|
/** Non-semantic rendered regions discovered alongside the AX/DOM tree. */
|
||||||
|
visualSurfaces?: VomVisualSurface[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface VomOptions {
|
export interface VomOptions {
|
||||||
@@ -94,6 +96,22 @@ export interface VomRef {
|
|||||||
ref: string;
|
ref: string;
|
||||||
backendNodeId: number;
|
backendNodeId: number;
|
||||||
frameId?: string;
|
frameId?: string;
|
||||||
|
/** Observation-time top-viewport crop for screenshot-only surfaces. */
|
||||||
|
visibleRect?: Rect;
|
||||||
|
kind?: "dom" | "surface";
|
||||||
|
capabilities?: VomRefCapability[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export type VomRefCapability = "interact" | "screenshot";
|
||||||
|
|
||||||
|
export interface VomVisualSurface {
|
||||||
|
parentId: number | null;
|
||||||
|
backendNodeId: number;
|
||||||
|
frameId: string;
|
||||||
|
renderingKind: "canvas";
|
||||||
|
visibleRect: Rect;
|
||||||
|
label?: string;
|
||||||
|
memberCount: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RenderedRef extends VomRef {
|
export interface RenderedRef extends VomRef {
|
||||||
|
|||||||
@@ -1,135 +0,0 @@
|
|||||||
#Requires -Version 5.1
|
|
||||||
param([string]$BskPath = (Join-Path $PSScriptRoot "../target/debug/bsk.exe"))
|
|
||||||
$ErrorActionPreference = "Stop"
|
|
||||||
|
|
||||||
# Load definitions, never Main: no downloads or changes to the real user PATH.
|
|
||||||
$installer = Join-Path $PSScriptRoot "../install.ps1"
|
|
||||||
$tokens = $null
|
|
||||||
$errors = $null
|
|
||||||
$ast = [System.Management.Automation.Language.Parser]::ParseFile($installer, [ref]$tokens, [ref]$errors)
|
|
||||||
if ($errors.Count) { throw ($errors | Out-String) }
|
|
||||||
foreach ($statement in $ast.EndBlock.Statements) {
|
|
||||||
if ($statement -is [System.Management.Automation.Language.FunctionDefinitionAst]) {
|
|
||||||
$definition = $statement.Extent.Text
|
|
||||||
if ($statement.Name -eq "Add-ToUserPath") {
|
|
||||||
$definition = $definition.Replace('[Environment]::GetEnvironmentVariable("PATH", "User")', '$script:UserPath')
|
|
||||||
$definition = $definition.Replace('[Environment]::SetEnvironmentVariable("PATH", $newUserPath, "User")', '$script:UserPath = $newUserPath')
|
|
||||||
}
|
|
||||||
Invoke-Expression $definition
|
|
||||||
}
|
|
||||||
}
|
|
||||||
function Assert-Equal($Actual, $Expected) {
|
|
||||||
if ($Actual -cne $Expected) { throw "expected [$Expected], got [$Actual]" }
|
|
||||||
}
|
|
||||||
function Assert-Fails([scriptblock]$Action) {
|
|
||||||
$failed = $false
|
|
||||||
try { & $Action } catch { $failed = $true }
|
|
||||||
if (-not $failed) { throw "expected failure" }
|
|
||||||
}
|
|
||||||
|
|
||||||
$dir = 'C:\Users\Alice\.local\bin'
|
|
||||||
foreach ($existing in @('', 'C:\WindowsApps', 'C:\A;C:\B')) {
|
|
||||||
$script:UserPath = $existing
|
|
||||||
Add-ToUserPath $dir
|
|
||||||
$expected = if ($existing) { "$existing;$dir" } else { $dir }
|
|
||||||
Assert-Equal $script:UserPath $expected
|
|
||||||
Add-ToUserPath $dir
|
|
||||||
Assert-Equal $script:UserPath $expected
|
|
||||||
}
|
|
||||||
|
|
||||||
$root = Join-Path ([IO.Path]::GetTempPath()) ("bsk-install-test-" + [Guid]::NewGuid().ToString('N'))
|
|
||||||
[IO.Directory]::CreateDirectory($root) | Out-Null
|
|
||||||
$oldBskHome = $env:BSK_HOME
|
|
||||||
$oldAutoUpdate = $env:BSK_AUTO_UPDATE
|
|
||||||
$daemon = $null
|
|
||||||
try {
|
|
||||||
$utf8 = New-Object System.Text.UTF8Encoding($false)
|
|
||||||
$bashRc = Join-Path $root ".bashrc"
|
|
||||||
$existing = "# existing 中文 configuration" + [char]10
|
|
||||||
[IO.File]::WriteAllText($bashRc, $existing, $utf8)
|
|
||||||
$special = 'C:\Users\张三 space $HOME $(echo unsafe) ! & [x] O''Brien\.local\bin'
|
|
||||||
Add-ToBashProfile $special $bashRc
|
|
||||||
$first = [IO.File]::ReadAllText($bashRc)
|
|
||||||
if (-not $first.StartsWith($existing)) { throw "existing bashrc content changed" }
|
|
||||||
if (-not $first.Contains('张三')) { throw "Unicode path was lost" }
|
|
||||||
Add-ToBashProfile $special $bashRc
|
|
||||||
Assert-Equal ([IO.File]::ReadAllText($bashRc)) $first
|
|
||||||
$bytes = [IO.File]::ReadAllBytes($bashRc)
|
|
||||||
if ($bytes[0] -eq 0xEF) { throw "unexpected UTF-8 BOM" }
|
|
||||||
|
|
||||||
$bash = [IO.Path]::GetFullPath((Join-Path (Split-Path (Get-Command git).Source -Parent) "../bin/bash.exe"))
|
|
||||||
if (-not (Test-Path -LiteralPath $bash)) { throw "Git Bash is required for quoting regression" }
|
|
||||||
$env:BSK_TEST_RC = $bashRc
|
|
||||||
$probe = Join-Path $root 'probe.sh'
|
|
||||||
[IO.File]::WriteAllText($probe, 'source "$BSK_TEST_RC"; printf "%s\n" "${PATH%%:*}"', $utf8)
|
|
||||||
$actual = & $bash --noprofile --norc $probe
|
|
||||||
if ($LASTEXITCODE -ne 0) { throw "Git Bash failed" }
|
|
||||||
Assert-Equal $actual ('/c' + $special.Substring(2).Replace('\', '/'))
|
|
||||||
|
|
||||||
$env:BSK_HOME = Join-Path $root "home"
|
|
||||||
$env:BSK_AUTO_UPDATE = "off"
|
|
||||||
[IO.Directory]::CreateDirectory($env:BSK_HOME) | Out-Null
|
|
||||||
$sourceDir = Join-Path $root "download"
|
|
||||||
[IO.Directory]::CreateDirectory($sourceDir) | Out-Null
|
|
||||||
$source = Join-Path $sourceDir "bsk.exe"
|
|
||||||
[IO.File]::Copy((Resolve-Path -LiteralPath $BskPath).Path, $source)
|
|
||||||
$targetDir = Join-Path $root "中文 space [x] & install"
|
|
||||||
[IO.Directory]::CreateDirectory($targetDir) | Out-Null
|
|
||||||
$target = Join-Path $targetDir "bsk.exe"
|
|
||||||
Install-Binary $source $target
|
|
||||||
Assert-Equal (Get-FileHash -LiteralPath $target).Hash (Get-FileHash -LiteralPath $source).Hash
|
|
||||||
|
|
||||||
$daemon = Start-Process -FilePath $target -ArgumentList @('daemon', 'start', '--foreground', '--port', '0') -WindowStyle Hidden -PassThru
|
|
||||||
$infoPath = Join-Path $env:BSK_HOME "daemon.json"
|
|
||||||
$deadline = [DateTime]::UtcNow.AddSeconds(15)
|
|
||||||
while (-not [IO.File]::Exists($infoPath)) {
|
|
||||||
if ($daemon.HasExited -or [DateTime]::UtcNow -gt $deadline) { throw "daemon failed to start" }
|
|
||||||
Start-Sleep -Milliseconds 50
|
|
||||||
}
|
|
||||||
# PE overlays distinguish old/new executables without another build.
|
|
||||||
$stream = [IO.File]::OpenWrite($source)
|
|
||||||
try {
|
|
||||||
$stream.Seek(0, [IO.SeekOrigin]::End) | Out-Null
|
|
||||||
$marker = $utf8.GetBytes("installer replacement regression")
|
|
||||||
$stream.Write($marker, 0, $marker.Length)
|
|
||||||
} finally { $stream.Dispose() }
|
|
||||||
Install-Binary $source $target
|
|
||||||
if (-not $daemon.WaitForExit(5000)) { throw "old daemon still running" }
|
|
||||||
Assert-Equal (Get-FileHash -LiteralPath $target).Hash (Get-FileHash -LiteralPath $source).Hash
|
|
||||||
& $target --version
|
|
||||||
if ($LASTEXITCODE -ne 0) { throw "replacement is not executable" }
|
|
||||||
|
|
||||||
# Refuse replacement when daemon identity cannot be verified.
|
|
||||||
[IO.File]::WriteAllText($infoPath, 'invalid daemon metadata')
|
|
||||||
$before = (Get-FileHash -LiteralPath $target).Hash
|
|
||||||
Assert-Fails { Install-Binary $source $target }
|
|
||||||
Assert-Equal (Get-FileHash -LiteralPath $target).Hash $before
|
|
||||||
[IO.File]::Delete($infoPath)
|
|
||||||
|
|
||||||
# A remaining lock must fail without truncation or staging debris.
|
|
||||||
$lock = [IO.File]::Open($target, [IO.FileMode]::Open, [IO.FileAccess]::Read, [IO.FileShare]::None)
|
|
||||||
try { Assert-Fails { Install-Binary $source $target } } finally { $lock.Dispose() }
|
|
||||||
Assert-Equal (Get-FileHash -LiteralPath $target).Hash $before
|
|
||||||
if (@(Get-ChildItem -LiteralPath $targetDir -Filter "*.install-*").Count) { throw "staging files leaked" }
|
|
||||||
Write-Host "Windows installer regressions passed ($($PSVersionTable.PSVersion))"
|
|
||||||
}
|
|
||||||
catch {
|
|
||||||
Write-Host ($_ | Out-String)
|
|
||||||
Write-Host $_.ScriptStackTrace
|
|
||||||
throw
|
|
||||||
}
|
|
||||||
finally {
|
|
||||||
if ($daemon -and -not $daemon.HasExited) {
|
|
||||||
Stop-Process -Id $daemon.Id -Force
|
|
||||||
$daemon.WaitForExit(5000) | Out-Null
|
|
||||||
}
|
|
||||||
$env:BSK_HOME = $oldBskHome
|
|
||||||
$env:BSK_AUTO_UPDATE = $oldAutoUpdate
|
|
||||||
Remove-Item Env:BSK_TEST_RC -ErrorAction SilentlyContinue
|
|
||||||
# Resolve and verify before recursive cleanup; only this fixture is removed.
|
|
||||||
$resolvedRoot = [IO.Path]::GetFullPath($root)
|
|
||||||
$tempRoot = [IO.Path]::GetFullPath([IO.Path]::GetTempPath()).TrimEnd('\') + '\'
|
|
||||||
if (-not $resolvedRoot.StartsWith($tempRoot, [StringComparison]::OrdinalIgnoreCase) -or
|
|
||||||
-not ([IO.Path]::GetFileName($resolvedRoot)).StartsWith('bsk-install-test-')) { throw "invalid cleanup path" }
|
|
||||||
Remove-Item -LiteralPath $resolvedRoot -Recurse -Force
|
|
||||||
}
|
|
||||||
+3
-9
@@ -174,22 +174,16 @@ function updateChangelog(version) {
|
|||||||
|
|
||||||
const today = new Date().toISOString().slice(0, 10);
|
const today = new Date().toISOString().slice(0, 10);
|
||||||
const escapedVer = version.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
const escapedVer = version.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
const versionHeading = new RegExp(`^## \\[${escapedVer}\\](?:\\s|$)`, "m");
|
|
||||||
|
|
||||||
// First: fill in any date-placeholder line for this version (e.g. "## [0.2.0] - 2026-09-XX")
|
// First: fill in any date-placeholder line for this version (e.g. "## [0.2.0] - 2026-09-XX")
|
||||||
const versionPlaceholder = new RegExp(`^## \\[${escapedVer}\\]\\s*-\\s*\\d{4}-\\d{2}-XX`, "m");
|
const versionPlaceholder = new RegExp(`^## \\[${escapedVer}\\]\\s*-\\s*\\d{4}-\\d{2}-XX`, "m");
|
||||||
if (versionPlaceholder.test(content)) {
|
if (versionPlaceholder.test(content)) {
|
||||||
content = content.replace(versionPlaceholder, `## [${version}] - ${today}`);
|
content = content.replace(versionPlaceholder, `## [${version}] - ${today}`);
|
||||||
} else if (!versionHeading.test(content)) {
|
} else {
|
||||||
// Preserve prepared release entries; new versions go before the release history.
|
// Otherwise: insert a new section after [Unreleased]
|
||||||
const heading = `## [${version}] - ${today}`;
|
|
||||||
const unreleased = /^## \[Unreleased\]/m;
|
const unreleased = /^## \[Unreleased\]/m;
|
||||||
if (unreleased.test(content)) {
|
if (unreleased.test(content)) {
|
||||||
content = content.replace(unreleased, `## [Unreleased]\n\n${heading}`);
|
content = content.replace(unreleased, `## [Unreleased]\n\n## [${version}] - ${today}`);
|
||||||
} else if (/^## /m.test(content)) {
|
|
||||||
content = content.replace(/^## /m, `${heading}\n\n## `);
|
|
||||||
} else {
|
|
||||||
content = `${content.trimEnd()}\n\n${heading}\n`;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -73,6 +73,28 @@ CSS-only hover menu looks like from here. It hovers a bounded set of likely trig
|
|||||||
few seconds and touches the live page; once you know which element hides the menu, `bsk hover <ref>`
|
few seconds and touches the live page; once you know which element hides the menu, `bsk hover <ref>`
|
||||||
is cheaper and more precise.
|
is cheaper and more precise.
|
||||||
|
|
||||||
|
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 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.
|
||||||
|
|
||||||
Escalate page reading only as needed:
|
Escalate page reading only as needed:
|
||||||
|
|
||||||
1. `bsk observe` for normal semantic understanding, text, controls, and refs.
|
1. `bsk observe` for normal semantic understanding, text, controls, and refs.
|
||||||
@@ -125,6 +147,7 @@ Required flags that are easy to get wrong:
|
|||||||
bsk fill <ref> --value <text> bsk select <ref> --value <option-value>
|
bsk fill <ref> --value <text> bsk select <ref> --value <option-value>
|
||||||
bsk screenshot --out <path> bsk emulate --device <preset-id>
|
bsk screenshot --out <path> bsk emulate --device <preset-id>
|
||||||
bsk upload <ref> --file <path> bsk download <ref> --out <path>
|
bsk upload <ref> --file <path> bsk download <ref> --out <path>
|
||||||
|
bsk click <surface-ref> --capture <id> --image-x <px> --image-y <px>
|
||||||
```
|
```
|
||||||
|
|
||||||
`select` matches an option's `value` attribute, not its visible label. Device preset ids are
|
`select` matches an option's `value` attribute, not its visible label. Device preset ids are
|
||||||
|
|||||||
Reference in New Issue
Block a user