mirror of
https://github.com/Tencent/BrowserSkill.git
synced 2026-09-10 13:01:23 +08:00
Compare commits
44
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
282e6f5623 | ||
|
|
bd68c293b6 | ||
|
|
35a20582ad | ||
|
|
4e3365450a | ||
|
|
df5ed1a495 | ||
|
|
eefbe03258 | ||
|
|
1d275f047c | ||
|
|
388b3ae2d5 | ||
|
|
36d0d91419 | ||
|
|
bcb9beb4f8 | ||
|
|
34ccb96fd6 | ||
|
|
8dfa097e55 | ||
|
|
383e3128eb | ||
|
|
2d2636030d | ||
|
|
a28b9d55e7 | ||
|
|
c39874591f | ||
|
|
1485addfd5 | ||
|
|
90b0ff301b | ||
|
|
e74f354e90 | ||
|
|
05c036518a | ||
|
|
020fb3212e | ||
|
|
0822c53c65 | ||
|
|
4450fbe28c | ||
|
|
a3bb81bfab | ||
|
|
caea98cd52 | ||
|
|
187b088013 | ||
|
|
5046b5ab44 | ||
|
|
e8137b42cc | ||
|
|
cb5dc148d5 | ||
|
|
3c5f838c56 | ||
|
|
9337bd557b | ||
|
|
162a31ae92 | ||
|
|
2f84234a31 | ||
|
|
72c10aab75 | ||
|
|
1eeb55af02 | ||
|
|
4992a54864 | ||
|
|
8b195eb0df | ||
|
|
eae4db1729 | ||
|
|
e961395be9 | ||
|
|
a6d1d02acc | ||
|
|
5ebe609c40 | ||
|
|
321494d93f | ||
|
|
f2184e74c5 | ||
|
|
fd3ce202a1 |
@@ -37,6 +37,35 @@ jobs:
|
|||||||
- name: Run Rust tests
|
- name: Run Rust tests
|
||||||
run: cargo test --workspace --locked
|
run: cargo test --workspace --locked
|
||||||
|
|
||||||
|
windows-daemon:
|
||||||
|
name: Windows daemon, installer and cancellation regression tests
|
||||||
|
runs-on: windows-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
|
|
||||||
|
- name: Run Windows named-pipe tests
|
||||||
|
run: cargo test -p bsk --lib --locked daemon::ipc::windows::tests
|
||||||
|
|
||||||
|
- name: Run Windows process liveness tests
|
||||||
|
run: cargo test -p bsk --lib --locked daemon::lockfile::tests
|
||||||
|
|
||||||
|
- name: Run Windows update tests
|
||||||
|
run: cargo test -p bsk --lib --locked cli::update::tests
|
||||||
|
|
||||||
|
- name: Run Windows update and cancellation process tests
|
||||||
|
run: cargo test -p bsk --test windows_update --test windows_parent_cancel --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
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|||||||
+18
-1
@@ -5,7 +5,24 @@ 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.
|
||||||
|
|
||||||
## [Unreleased]
|
## [0.2.1] - 2026-09-09
|
||||||
|
|
||||||
|
### 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.0"
|
version = "0.2.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"base64",
|
"base64",
|
||||||
@@ -169,7 +169,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bsk-protocol"
|
name = "bsk-protocol"
|
||||||
version = "0.2.0"
|
version = "0.2.1"
|
||||||
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.0"
|
version = "0.2.1"
|
||||||
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.0", path = "crates/bsk-protocol" }
|
bsk-protocol = { version = "0.2.1", path = "crates/bsk-protocol" }
|
||||||
|
|
||||||
[profile.release]
|
[profile.release]
|
||||||
strip = "symbols"
|
strip = "symbols"
|
||||||
|
|||||||
@@ -147,20 +147,26 @@ 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 injects native `browser_*` tools (no shelling out to `bsk`) and a live Web UI
|
It gives the agent native `browser_*` tools and a live view of its browser sessions
|
||||||
overlay of each Agent Window.
|
in the Web UI. The plugin runs `bsk` on the agent's behalf.
|
||||||
|
|
||||||
Add it to a dsh profile, then start that profile:
|
Install the `bsk` CLI and connect the browser extension first. Then add the plugin
|
||||||
|
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 carries its own copy of the skill, so `bsk install-skill` is not needed
|
The plugin includes the `browser-skill` skill, so `bsk install-skill` is not needed
|
||||||
for dsh — but the `bsk` CLI and the browser extension are still prerequisites. See
|
for dsh. Installed plugins do not update automatically. To upgrade this plugin:
|
||||||
the [plugin README](packages/dsh-plugin-browserskill/README.md) for the tool list,
|
|
||||||
configuration, and the observation overlay.
|
```sh
|
||||||
|
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
|
||||||
|
|
||||||
|
|||||||
+9
-3
@@ -125,16 +125,22 @@ 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)。它会注入原生 `browser_*` 工具(无需再通过 Shell 调用 `bsk`),并在 Web UI 中实时观察每个 Agent Window。
|
在用 [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 中实时展示浏览器会话。
|
||||||
|
|
||||||
把它装进某个 dsh profile,然后启动该 profile:
|
先安装 `bsk` CLI 并连接浏览器扩展,再将插件装进 dsh profile 并启动(将 `web` 替换为你的 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
|
||||||
```
|
```
|
||||||
|
|
||||||
插件自带 skill,所以在 dsh 下无需执行 `bsk install-skill`;但 `bsk` CLI 和浏览器扩展仍是前置条件。工具清单、配置项与观察浮层见[插件 README](packages/dsh-plugin-browserskill/README.md)。
|
插件自带 `browser-skill` skill,所以在 dsh 下无需执行 `bsk install-skill`。已安装的插件不会自动更新;升级此插件请运行:
|
||||||
|
|
||||||
|
```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.0",
|
"version": "0.2.1",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
@@ -49,6 +49,47 @@ describe("ToolDispatcher", () => {
|
|||||||
vi.unstubAllGlobals();
|
vi.unstubAllGlobals();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"tool.snapshot",
|
||||||
|
"tool.evaluate",
|
||||||
|
"tool.get_html",
|
||||||
|
"tool.console",
|
||||||
|
])("annotates Chrome extension-access failures from %s", async (method) => {
|
||||||
|
const tab = { id: 7, windowId: 4242, active: true, url: "https://example.test" };
|
||||||
|
vi.stubGlobal("chrome", {
|
||||||
|
tabs: {
|
||||||
|
get: vi.fn(async () => tab),
|
||||||
|
query: vi.fn(async () => [tab]),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const { transport, sent, deliver } = fakeTransport();
|
||||||
|
const sessions = new SessionManager({
|
||||||
|
agentWindow: {
|
||||||
|
create: vi.fn(async () => 4242),
|
||||||
|
remove: vi.fn(),
|
||||||
|
ensureActiveTab: vi.fn(),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await sessions.start("test");
|
||||||
|
const error = new Error("Cannot access a chrome-extension:// URL of different extension");
|
||||||
|
const cdp = {
|
||||||
|
send: vi.fn().mockRejectedValue(error),
|
||||||
|
ensureConsoleCapture: vi.fn().mockRejectedValue(error),
|
||||||
|
consoleEntriesSince: vi.fn(),
|
||||||
|
} as unknown as TestDispatcherCdp;
|
||||||
|
const dispatcher = new ToolDispatcher({ transport, sessions, cdp });
|
||||||
|
dispatcher.start();
|
||||||
|
deliver(makeRequest(method, { session_id: "test", expression: "document.title" }));
|
||||||
|
await vi.waitFor(() => expect(sent).toHaveLength(1));
|
||||||
|
expect(sent[0]).toMatchObject({
|
||||||
|
error: {
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "cdp_extension_access_denied" },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
dispatcher.stop();
|
||||||
|
});
|
||||||
|
|
||||||
it("uses the configured recording runtime for start and stop", async () => {
|
it("uses the configured recording runtime for start and stop", async () => {
|
||||||
const { transport, sent, deliver } = fakeTransport();
|
const { transport, sent, deliver } = fakeTransport();
|
||||||
const sessions = new SessionManager({
|
const sessions = new SessionManager({
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import type { RpcError } from "@/transport/types";
|
||||||
|
import { cdpError, classifyCdpError } from "../errors";
|
||||||
|
|
||||||
|
const denied = "Cannot access a chrome-extension:// URL of different extension";
|
||||||
|
|
||||||
|
describe("CDP extension access errors", () => {
|
||||||
|
it("classifies both Chrome Error instances and string failures", () => {
|
||||||
|
for (const error of [new Error(denied), denied]) {
|
||||||
|
expect(cdpError(error)).toEqual({
|
||||||
|
code: "cdp_failed",
|
||||||
|
message: denied,
|
||||||
|
data: { reason: "cdp_extension_access_denied" },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("preserves transfer outcome and cleanup instructions when CDP was denied", () => {
|
||||||
|
const error: RpcError = {
|
||||||
|
code: "cdp_failed",
|
||||||
|
message: denied,
|
||||||
|
data: {
|
||||||
|
reason: "transfer_outcome_unknown",
|
||||||
|
effect_state: "unknown",
|
||||||
|
cleanup_state: "failed",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
expect(classifyCdpError(error)).toBe(error);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("leaves other error codes and unrelated debugger failures unchanged", () => {
|
||||||
|
for (const error of [
|
||||||
|
{ code: "permission_denied", message: denied },
|
||||||
|
{ code: "cdp_failed", message: "Another debugger is already attached" },
|
||||||
|
] satisfies RpcError[]) {
|
||||||
|
expect(classifyCdpError(error)).toBe(error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -11,7 +11,6 @@ interface ScriptParams {
|
|||||||
async function setup(markup = '<input value="old">') {
|
async function setup(markup = '<input value="old">') {
|
||||||
document.body.innerHTML = markup;
|
document.body.innerHTML = markup;
|
||||||
const element = document.body.firstElementChild as HTMLInputElement;
|
const element = document.body.firstElementChild as HTMLInputElement;
|
||||||
vi.spyOn(document, "hasFocus").mockReturnValue(true);
|
|
||||||
const manager = new SessionManager({
|
const manager = new SessionManager({
|
||||||
agentWindow: {
|
agentWindow: {
|
||||||
create: async () => 100,
|
create: async () => 100,
|
||||||
@@ -36,13 +35,24 @@ async function setup(markup = '<input value="old">') {
|
|||||||
return { exceptionDetails: { text: "test page script failed" } };
|
return { exceptionDetails: { text: "test page script failed" } };
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
// Number/email controls have a browser caret even though their selection
|
||||||
|
// getters return null. Model that caret instead of assuming it is at the end.
|
||||||
|
const hiddenCaret = { start: 0, end: 0 };
|
||||||
|
const moveToEnd = vi.fn(async () => {
|
||||||
|
if (typeof element.selectionStart === "number") {
|
||||||
|
element.setSelectionRange(element.value.length, element.value.length);
|
||||||
|
} else {
|
||||||
|
hiddenCaret.start = hiddenCaret.end = element.value.length;
|
||||||
|
}
|
||||||
|
});
|
||||||
const insert = vi.fn(async (text: string) => {
|
const insert = vi.fn(async (text: string) => {
|
||||||
const focused = document.activeElement as HTMLInputElement;
|
const focused = document.activeElement as HTMLInputElement;
|
||||||
if (focused.readOnly || focused.disabled) return;
|
if (focused.readOnly || focused.disabled) return;
|
||||||
const start = focused.selectionStart ?? focused.value.length;
|
const start = focused.selectionStart ?? hiddenCaret.start;
|
||||||
const end = focused.selectionEnd ?? start;
|
const end = focused.selectionEnd ?? hiddenCaret.end;
|
||||||
const value = focused.value.slice(0, start) + text + focused.value.slice(end);
|
const value = focused.value.slice(0, start) + text + focused.value.slice(end);
|
||||||
focused.value = focused.maxLength >= 0 ? value.slice(0, focused.maxLength) : value;
|
focused.value = focused.maxLength >= 0 ? value.slice(0, focused.maxLength) : value;
|
||||||
|
hiddenCaret.start = hiddenCaret.end = Math.min(start + text.length, focused.value.length);
|
||||||
focused.dispatchEvent(new Event("input", { bubbles: true }));
|
focused.dispatchEvent(new Event("input", { bubbles: true }));
|
||||||
});
|
});
|
||||||
const release = vi.fn(async () => ({}));
|
const release = vi.fn(async () => ({}));
|
||||||
@@ -67,6 +77,11 @@ async function setup(markup = '<input value="old">') {
|
|||||||
case "Input.insertText":
|
case "Input.insertText":
|
||||||
await insert((params as { text: string }).text);
|
await insert((params as { text: string }).text);
|
||||||
return {};
|
return {};
|
||||||
|
case "Input.dispatchKeyEvent":
|
||||||
|
if ((params as { commands?: string[] }).commands?.includes("moveToEndOfDocument")) {
|
||||||
|
await moveToEnd();
|
||||||
|
}
|
||||||
|
return {};
|
||||||
case "Runtime.releaseObject":
|
case "Runtime.releaseObject":
|
||||||
return release();
|
return release();
|
||||||
default:
|
default:
|
||||||
@@ -75,6 +90,8 @@ async function setup(markup = '<input value="old">') {
|
|||||||
});
|
});
|
||||||
return {
|
return {
|
||||||
element,
|
element,
|
||||||
|
hiddenCaret,
|
||||||
|
moveToEnd,
|
||||||
script,
|
script,
|
||||||
insert,
|
insert,
|
||||||
release,
|
release,
|
||||||
@@ -106,7 +123,10 @@ describe("fill result verification", () => {
|
|||||||
"disabled",
|
"disabled",
|
||||||
])("preserves a %s field before rejecting it", async (attribute) => {
|
])("preserves a %s field before rejecting it", async (attribute) => {
|
||||||
const h = await setup(`<input ${attribute} value="old">`);
|
const h = await setup(`<input ${attribute} value="old">`);
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /not editable/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
data: { reason: "target_not_fillable" },
|
||||||
|
});
|
||||||
expect(h.element.value).toBe("old");
|
expect(h.element.value).toBe("old");
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
expect(h.release).toHaveBeenCalledOnce();
|
expect(h.release).toHaveBeenCalledOnce();
|
||||||
@@ -121,26 +141,87 @@ describe("fill result verification", () => {
|
|||||||
])("rejects an unsupported %s input before clearing", async (type) => {
|
])("rejects an unsupported %s input before clearing", async (type) => {
|
||||||
const h = await setup(`<input type="${type}">`);
|
const h = await setup(`<input type="${type}">`);
|
||||||
const before = h.element.value;
|
const before = h.element.value;
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /input type/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
data: { reason: "target_not_fillable" },
|
||||||
|
});
|
||||||
expect(h.element.value).toBe(before);
|
expect(h.element.value).toBe(before);
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("rejects an overlong value before clearing", async () => {
|
it("rejects an overlong value before clearing", async () => {
|
||||||
const h = await setup('<input maxlength="3" value="old">');
|
const h = await setup('<input maxlength="3" value="old">');
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /maxlength/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
message: /maxlength/,
|
||||||
|
data: { reason: "fill_value_invalid" },
|
||||||
|
});
|
||||||
expect(h.element.value).toBe("old");
|
expect(h.element.value).toBe("old");
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("does not type into a field that gained focus during clearing", async () => {
|
it.each([
|
||||||
|
true,
|
||||||
|
false,
|
||||||
|
])("classifies a DOM.focus rejection on a disabled=%s target", async (disabled) => {
|
||||||
|
const h = await setup(`<input ${disabled ? "disabled" : ""} value="old">`);
|
||||||
|
const send = h.send.getMockImplementation()!;
|
||||||
|
h.send.mockImplementation(async (tabId, method, params) => {
|
||||||
|
if (method === "DOM.focus") throw new Error("Element is not focusable");
|
||||||
|
return send(tabId, method, params);
|
||||||
|
});
|
||||||
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: disabled ? "invalid_params" : "cdp_failed",
|
||||||
|
data: { reason: disabled ? "target_not_fillable" : "fill_failed" },
|
||||||
|
});
|
||||||
|
expect(h.element.value).toBe("old");
|
||||||
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
|
expect(h.release).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fills a background document without requiring foreground browser focus", async () => {
|
||||||
|
const h = await setup();
|
||||||
|
vi.spyOn(document, "hasFocus").mockReturnValue(false);
|
||||||
|
expect(await h.fill()).toMatchObject({ value_length: 5 });
|
||||||
|
expect(h.element.value).toBe("hello");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("restores focus once after clearing without typing into another field", async () => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
const other = document.createElement("input");
|
const other = document.createElement("input");
|
||||||
document.body.append(other);
|
document.body.append(other);
|
||||||
h.element.addEventListener("input", () => other.focus());
|
h.element.addEventListener("input", () => other.focus());
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /lost focus/ });
|
expect(await h.fill()).toMatchObject({ value_length: 5 });
|
||||||
|
expect(h.element.value).toBe("hello");
|
||||||
|
expect(other.value).toBe("");
|
||||||
|
expect(h.send.mock.calls.filter(([, method]) => method === "DOM.focus")).toHaveLength(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"focus",
|
||||||
|
"value",
|
||||||
|
])("rechecks %s after restoring focus, without retrying again", async (action) => {
|
||||||
|
const h = await setup();
|
||||||
|
const other = document.createElement("input");
|
||||||
|
document.body.append(other);
|
||||||
|
h.element.addEventListener(
|
||||||
|
"input",
|
||||||
|
() => {
|
||||||
|
other.focus();
|
||||||
|
h.element.addEventListener("focus", () => {
|
||||||
|
if (action === "focus") queueMicrotask(() => other.focus());
|
||||||
|
else h.element.value = "changed";
|
||||||
|
});
|
||||||
|
},
|
||||||
|
{ once: true },
|
||||||
|
);
|
||||||
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: action === "focus" ? "fill_focus_lost" : "fill_target_changed" },
|
||||||
|
});
|
||||||
expect(other.value).toBe("");
|
expect(other.value).toBe("");
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
|
expect(h.send.mock.calls.filter(([, method]) => method === "DOM.focus")).toHaveLength(2);
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
@@ -159,14 +240,20 @@ describe("fill result verification", () => {
|
|||||||
h.element.value = "restored";
|
h.element.value = "restored";
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed" });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_target_changed" },
|
||||||
|
});
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("fails when insertText is acknowledged without changing the value", async () => {
|
it("fails when insertText is acknowledged without changing the value", async () => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
h.insert.mockImplementation(async () => {});
|
h.insert.mockImplementation(async () => {});
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /expected value/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_value_mismatch" },
|
||||||
|
});
|
||||||
expect(h.release).toHaveBeenCalledOnce();
|
expect(h.release).toHaveBeenCalledOnce();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -179,7 +266,10 @@ describe("fill result verification", () => {
|
|||||||
},
|
},
|
||||||
{ once: true },
|
{ once: true },
|
||||||
);
|
);
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /expected value/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_value_mismatch" },
|
||||||
|
});
|
||||||
expect(h.element.value).toBe("hel");
|
expect(h.element.value).toBe("hel");
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -212,34 +302,39 @@ describe("fill result verification", () => {
|
|||||||
it("does not report success for a target replaced by a change handler", async () => {
|
it("does not report success for a target replaced by a change handler", async () => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
h.element.addEventListener("change", () => h.element.replaceWith(h.element.cloneNode()));
|
h.element.addEventListener("change", () => h.element.replaceWith(h.element.cloneNode()));
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed", message: /expected value/ });
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_target_changed" },
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
1, 2, 3, 4,
|
1, 2, 3, 4, 5,
|
||||||
])("rejects script exceptions at phase %s and releases the target", async (phase) => {
|
])("rejects script exceptions at phase %s and releases the target", async (phase) => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
|
vi.spyOn(document, "hasFocus").mockReturnValue(false);
|
||||||
const run = h.script.getMockImplementation()!;
|
const run = h.script.getMockImplementation()!;
|
||||||
let count = 0;
|
let count = 0;
|
||||||
h.script.mockImplementation(async (params) =>
|
h.script.mockImplementation(async (params) =>
|
||||||
++count === phase ? { exceptionDetails: { text: "page secret" } } : run(params),
|
++count === phase ? { exceptionDetails: { text: "page secret" } } : run(params),
|
||||||
);
|
);
|
||||||
const result = await h.fill();
|
const result = await h.fill();
|
||||||
expect(result).toMatchObject({ code: "cdp_failed" });
|
expect(result).toMatchObject({ code: "cdp_failed", data: { reason: "fill_failed" } });
|
||||||
expect(JSON.stringify(result)).not.toContain("page secret");
|
expect(JSON.stringify(result)).not.toContain("page secret");
|
||||||
if (phase <= 2) expect(h.insert).not.toHaveBeenCalled();
|
if (phase <= 3) expect(h.insert).not.toHaveBeenCalled();
|
||||||
expect(h.release).toHaveBeenCalledOnce();
|
expect(h.release).toHaveBeenCalledOnce();
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([1, 2, 4])("rejects missing results at phase %s", async (phase) => {
|
it.each([1, 2, 3, 5])("rejects missing results at phase %s", async (phase) => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
|
vi.spyOn(document, "hasFocus").mockReturnValue(false);
|
||||||
const run = h.script.getMockImplementation()!;
|
const run = h.script.getMockImplementation()!;
|
||||||
let count = 0;
|
let count = 0;
|
||||||
h.script.mockImplementation(async (params) =>
|
h.script.mockImplementation(async (params) =>
|
||||||
++count === phase ? { result: { type: "undefined" } } : run(params),
|
++count === phase ? { result: { type: "undefined" } } : run(params),
|
||||||
);
|
);
|
||||||
expect(await h.fill()).toMatchObject({ code: "cdp_failed" });
|
expect(await h.fill()).toMatchObject({ code: "cdp_failed" });
|
||||||
if (phase <= 2) expect(h.insert).not.toHaveBeenCalled();
|
if (phase <= 3) expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each(["input", "change"])("checks state after nested microtasks from %s", async (event) => {
|
it.each(["input", "change"])("checks state after nested microtasks from %s", async (event) => {
|
||||||
@@ -270,7 +365,7 @@ describe("fill result verification", () => {
|
|||||||
const h = await setup();
|
const h = await setup();
|
||||||
h.element.focus();
|
h.element.focus();
|
||||||
h.element.setSelectionRange(3, 3);
|
h.element.setSelectionRange(3, 3);
|
||||||
expect(await h.fill("!", false)).toMatchObject({ value_length: 1 });
|
expect(await h.fill("!", false)).toMatchObject({ value_length: 4 });
|
||||||
expect(h.element.value).toBe("old!");
|
expect(h.element.value).toBe("old!");
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -314,18 +409,126 @@ describe("fill result verification", () => {
|
|||||||
expect(await h.fill("one\n")).toMatchObject({ value_length: 4 });
|
expect(await h.fill("one\n")).toMatchObject({ value_length: 4 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("rejects a non-append selection before typing", async () => {
|
it.each([
|
||||||
|
[0, 0],
|
||||||
|
[1, 1],
|
||||||
|
[0, 3],
|
||||||
|
])("appends after moving selection %s:%s to the end", async (start, end) => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
h.element.focus();
|
h.element.focus();
|
||||||
h.element.setSelectionRange(1, 1);
|
h.element.setSelectionRange(start, end);
|
||||||
expect(await h.fill("!", false)).toMatchObject({ code: "cdp_failed" });
|
expect(await h.fill("🙂", false)).toMatchObject({ value_length: 5 });
|
||||||
expect(h.element.value).toBe("old");
|
expect(h.element.value).toBe("old🙂");
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(
|
||||||
|
["number", "email"].flatMap((type) =>
|
||||||
|
[
|
||||||
|
[0, 0],
|
||||||
|
[1, 1],
|
||||||
|
[0, 2],
|
||||||
|
].map(([start, end]) => ({ type, start, end })),
|
||||||
|
),
|
||||||
|
)("appends to $type from selection $start:$end without using its unsupported API", async ({
|
||||||
|
type,
|
||||||
|
start,
|
||||||
|
end,
|
||||||
|
}) => {
|
||||||
|
const h = await setup(`<input type="${type}" value="12">`);
|
||||||
|
Object.assign(h.hiddenCaret, { start, end });
|
||||||
|
vi.spyOn(h.element, "selectionStart", "get").mockReturnValue(null);
|
||||||
|
vi.spyOn(h.element, "selectionEnd", "get").mockReturnValue(null);
|
||||||
|
const selection = vi.spyOn(h.element, "setSelectionRange").mockImplementation(() => {
|
||||||
|
throw new DOMException("unsupported", "InvalidStateError");
|
||||||
|
});
|
||||||
|
expect(await h.fill("3", false)).toMatchObject({ value_length: 3 });
|
||||||
|
expect(h.element.value).toBe("123");
|
||||||
|
expect(selection).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"number",
|
||||||
|
"email",
|
||||||
|
])("does not report successful %s append when the caret command is ignored", async (type) => {
|
||||||
|
const h = await setup(`<input type="${type}" value="12">`);
|
||||||
|
vi.spyOn(h.element, "selectionStart", "get").mockReturnValue(null);
|
||||||
|
vi.spyOn(h.element, "selectionEnd", "get").mockReturnValue(null);
|
||||||
|
h.moveToEnd.mockResolvedValueOnce(undefined);
|
||||||
|
expect(await h.fill("3", false)).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_value_mismatch" },
|
||||||
|
});
|
||||||
|
expect(h.element.value).toBe("312");
|
||||||
|
expect(h.insert).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid number text before clearing", async () => {
|
||||||
|
const h = await setup('<input type="number" value="12">');
|
||||||
|
expect(await h.fill("abc")).toMatchObject({
|
||||||
|
code: "invalid_params",
|
||||||
|
data: { reason: "fill_value_invalid" },
|
||||||
|
});
|
||||||
|
expect(h.element.value).toBe("12");
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("reports page formatting as unconfirmed without retrying the write", async () => {
|
||||||
|
const h = await setup();
|
||||||
|
h.element.addEventListener("change", () => {
|
||||||
|
h.element.value = h.element.value.toUpperCase();
|
||||||
|
});
|
||||||
|
expect(await h.fill()).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "fill_value_mismatch" },
|
||||||
|
});
|
||||||
|
expect(h.element.value).toBe("HELLO");
|
||||||
|
expect(h.insert).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
["focus", false],
|
||||||
|
["focus", true],
|
||||||
|
["value", false],
|
||||||
|
["value", true],
|
||||||
|
["cancel", false],
|
||||||
|
["cancel", true],
|
||||||
|
["throw", false],
|
||||||
|
["throw", true],
|
||||||
|
] as const)("stops when positioning triggers %s (clear=%s) and releases the key", async (action, clearBefore) => {
|
||||||
|
const h = await setup();
|
||||||
|
vi.spyOn(document, "hasFocus").mockReturnValue(false);
|
||||||
|
const controller = new AbortController();
|
||||||
|
const other = document.createElement("input");
|
||||||
|
document.body.append(other);
|
||||||
|
const send = h.send.getMockImplementation()!;
|
||||||
|
h.send.mockImplementation(async (tabId, method, params) => {
|
||||||
|
const reply = await send(tabId, method, params);
|
||||||
|
if (
|
||||||
|
method === "Input.dispatchKeyEvent" &&
|
||||||
|
(params as { type: string }).type === "rawKeyDown"
|
||||||
|
) {
|
||||||
|
if (action === "focus") other.focus();
|
||||||
|
if (action === "value") h.element.value = "changed";
|
||||||
|
if (action === "cancel") controller.abort();
|
||||||
|
if (action === "throw") throw new Error("dispatch failed");
|
||||||
|
}
|
||||||
|
return reply;
|
||||||
|
});
|
||||||
|
const result = await h.fill("!", clearBefore, controller.signal);
|
||||||
|
expect(result).toMatchObject({ code: action === "cancel" ? "cancelled" : "cdp_failed" });
|
||||||
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
|
expect(other.value).toBe("");
|
||||||
|
expect(h.send).toHaveBeenCalledWith(
|
||||||
|
4,
|
||||||
|
"Input.dispatchKeyEvent",
|
||||||
|
expect.objectContaining({ type: "keyUp" }),
|
||||||
|
);
|
||||||
|
expect(h.release).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
it.each([true, false])("verifies an empty request with clear_before=%s", async (clearBefore) => {
|
it.each([true, false])("verifies an empty request with clear_before=%s", async (clearBefore) => {
|
||||||
const h = await setup();
|
const h = await setup();
|
||||||
expect(await h.fill("", clearBefore)).toMatchObject({ value_length: 0 });
|
expect(await h.fill("", clearBefore)).toMatchObject({ value_length: clearBefore ? 0 : 3 });
|
||||||
expect(h.element.value).toBe(clearBefore ? "" : "old");
|
expect(h.element.value).toBe(clearBefore ? "" : "old");
|
||||||
expect(h.insert).not.toHaveBeenCalled();
|
expect(h.insert).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import { resolveFrameProjection, resolveNodeGeometry } from "../frame-geometry";
|
import { resolveNodeGeometry } from "../frame-geometry";
|
||||||
import {
|
import {
|
||||||
clipPolygon,
|
clipPolygon,
|
||||||
polygonArea,
|
polygonArea,
|
||||||
@@ -10,6 +10,7 @@ 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", () => {
|
||||||
@@ -82,28 +83,24 @@ 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 resolveFrameProjection(
|
const projection = await new GeometryContext(cdp, 4, {
|
||||||
cdp,
|
rootFrameId: "main",
|
||||||
{
|
frames: [
|
||||||
rootFrameId: "main",
|
{ frameId: "main", target: { tabId: 4 } },
|
||||||
frames: [
|
{
|
||||||
{ frameId: "main", target: { tabId: 4 } },
|
frameId: "same-process-parent",
|
||||||
{
|
parentFrameId: "main",
|
||||||
frameId: "same-process-parent",
|
ownerBackendNodeId: 10,
|
||||||
parentFrameId: "main",
|
target: { tabId: 4 },
|
||||||
ownerBackendNodeId: 10,
|
},
|
||||||
target: { tabId: 4 },
|
{
|
||||||
},
|
frameId: "oopif",
|
||||||
{
|
parentFrameId: "same-process-parent",
|
||||||
frameId: "oopif",
|
ownerBackendNodeId: 20,
|
||||||
parentFrameId: "same-process-parent",
|
target: { tabId: 4, sessionId: "oopif-session" },
|
||||||
ownerBackendNodeId: 20,
|
},
|
||||||
target: { tabId: 4, sessionId: "oopif-session" },
|
],
|
||||||
},
|
}).targetProjection("oopif");
|
||||||
],
|
|
||||||
},
|
|
||||||
"oopif",
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(projection?.edges).toEqual([
|
expect(projection?.edges).toEqual([
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -0,0 +1,464 @@
|
|||||||
|
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,
|
||||||
|
snapshotCoordinates,
|
||||||
|
snapshotViewportRect,
|
||||||
|
} from "../geometry/coordinate-types";
|
||||||
|
import { GeometryContext, snapshotLayoutScale } 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 {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
|
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.each([0.8, 1, 1.25, 2])("normalizes snapshot layout units at scale %s", (scale) => {
|
||||||
|
const measured = snapshotLayoutScale({
|
||||||
|
visualViewport: { clientWidth: 997.25, zoom: 1.1 },
|
||||||
|
cssVisualViewport: { clientWidth: 997.25 / scale, zoom: 1.1 },
|
||||||
|
// Rounded layout dimensions must not supply the scale.
|
||||||
|
layoutViewport: { clientWidth: 997 },
|
||||||
|
cssLayoutViewport: { clientWidth: Math.floor(997.25 / scale) },
|
||||||
|
});
|
||||||
|
expect(measured).toBeCloseTo(scale, 12);
|
||||||
|
const coordinates = snapshotCoordinates(
|
||||||
|
{ scrollOffsetX: 80 * scale, scrollOffsetY: 200 * scale },
|
||||||
|
measured,
|
||||||
|
{ x: 999, y: 999 },
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
snapshotViewportRect(
|
||||||
|
[160 * scale, 320 * scale, 120 * scale, 40 * scale],
|
||||||
|
{ target },
|
||||||
|
coordinates,
|
||||||
|
)?.rect,
|
||||||
|
).toEqual({ x: 80, y: 120, width: 120, height: 40 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("uses CSS root scroll only for missing snapshot offsets, without scaling it twice", () => {
|
||||||
|
const coordinates = snapshotCoordinates({ scrollOffsetX: 80 }, 2, { x: 999, y: 100 });
|
||||||
|
expect(snapshotViewportRect([200, 800, 240, 80], { target }, coordinates)?.rect).toEqual({
|
||||||
|
x: 60,
|
||||||
|
y: 300,
|
||||||
|
width: 120,
|
||||||
|
height: 40,
|
||||||
|
});
|
||||||
|
expect(snapshotCoordinates({ scrollOffsetX: 0 }, 2)).toBeNull();
|
||||||
|
expect(
|
||||||
|
snapshotCoordinates({ scrollOffsetX: NaN, scrollOffsetY: 0 }, 2, { x: 0, y: 0 }),
|
||||||
|
).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not infer snapshot units from missing, invalid, or CSS-only metrics", () => {
|
||||||
|
expect(snapshotLayoutScale({ cssLayoutViewport: { clientWidth: 800 } })).toBeNull();
|
||||||
|
for (const raw of [0, -1, NaN, Infinity]) {
|
||||||
|
expect(
|
||||||
|
snapshotLayoutScale({
|
||||||
|
visualViewport: { clientWidth: raw },
|
||||||
|
cssVisualViewport: { clientWidth: 800 },
|
||||||
|
}),
|
||||||
|
).toBeNull();
|
||||||
|
}
|
||||||
|
expect(
|
||||||
|
snapshotLayoutScale({
|
||||||
|
visualViewport: { clientWidth: 0, clientHeight: 600 },
|
||||||
|
cssVisualViewport: { clientWidth: 0, clientHeight: 300 },
|
||||||
|
}),
|
||||||
|
).toBe(2);
|
||||||
|
expect(snapshotCoordinates({ scrollOffsetX: 0, scrollOffsetY: 0 }, null)).toBeNull();
|
||||||
|
expect(snapshotViewportRect([10, 20, 120, 40], { target }, null)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
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, {
|
||||||
|
layoutUnitsPerCssPixel: 1,
|
||||||
|
scrollCss: { 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, {
|
||||||
|
layoutUnitsPerCssPixel: 1,
|
||||||
|
scrollCss: { 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" },
|
||||||
|
{ layoutUnitsPerCssPixel: 1, scrollCss: { 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 },
|
||||||
|
{ layoutUnitsPerCssPixel: 1, scrollCss: { x: 0, y: 0 } },
|
||||||
|
),
|
||||||
|
).toBeNull();
|
||||||
|
expect(
|
||||||
|
snapshotViewportRect(
|
||||||
|
[0, 0, 10, 40],
|
||||||
|
{ target },
|
||||||
|
{ layoutUnitsPerCssPixel: 1, scrollCss: { 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" },
|
||||||
|
{ layoutUnitsPerCssPixel: 1, scrollCss: { 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 {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
|
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,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -541,13 +541,16 @@ describe("handleHover", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
function successfulFillScript(params: unknown) {
|
function successfulFillScript(params: unknown) {
|
||||||
const args = (params as { arguments?: Array<{ value: unknown }> }).arguments ?? [];
|
const script = params as { arguments?: Array<{ value: unknown }>; functionDeclaration: string };
|
||||||
|
const args = script.arguments ?? [];
|
||||||
return {
|
return {
|
||||||
result: {
|
result: {
|
||||||
value:
|
value:
|
||||||
args.length === 2
|
args.length === 2
|
||||||
? { before: "", expected: args[0].value, valueLength: String(args[0].value).length }
|
? { before: "", expected: args[0].value }
|
||||||
: true,
|
: script.functionDeclaration.startsWith("function(expected)")
|
||||||
|
? { connected: true, matches: true, valueLength: String(args[0].value).length }
|
||||||
|
: "ready",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -613,7 +616,7 @@ describe("handleFill", () => {
|
|||||||
expect(res.used_ref).toBe("e1");
|
expect(res.used_ref).toBe("e1");
|
||||||
const insert = fake.sent.find((c) => c.method === "Input.insertText");
|
const insert = fake.sent.find((c) => c.method === "Input.insertText");
|
||||||
expect(insert?.params).toEqual({ text: "hello" });
|
expect(insert?.params).toEqual({ text: "hello" });
|
||||||
// Preparation, readiness, notifications, and final verification.
|
// Foreground replacement needs no extra caret-positioning round trip.
|
||||||
const callFns = fake.sent.filter((c) => c.method === "Runtime.callFunctionOn");
|
const callFns = fake.sent.filter((c) => c.method === "Runtime.callFunctionOn");
|
||||||
expect(callFns).toHaveLength(4);
|
expect(callFns).toHaveLength(4);
|
||||||
});
|
});
|
||||||
@@ -634,6 +637,7 @@ describe("handleFill", () => {
|
|||||||
if (args.length === 2) expect(args[1].value).toBe(false);
|
if (args.length === 2) expect(args[1].value).toBe(false);
|
||||||
return successfulFillScript(p);
|
return successfulFillScript(p);
|
||||||
},
|
},
|
||||||
|
"Input.dispatchKeyEvent": () => ({}),
|
||||||
"Runtime.releaseObject": () => ({}),
|
"Runtime.releaseObject": () => ({}),
|
||||||
"Input.insertText": () => ({}),
|
"Input.insertText": () => ({}),
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,266 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { SessionManager } from "@/session-manager/manager";
|
||||||
|
import type { BrowserNavigationApi } from "../browser-navigation";
|
||||||
|
import { handleNavigate, handleReload } from "../navigation";
|
||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
|
||||||
|
const denied = "Cannot access a chrome-extension:// URL of different extension";
|
||||||
|
const url = "https://example.test/recovered";
|
||||||
|
|
||||||
|
function event<T extends (...args: never[]) => void>() {
|
||||||
|
const listeners = new Set<T>();
|
||||||
|
return {
|
||||||
|
listeners,
|
||||||
|
addListener: (listener: T) => listeners.add(listener),
|
||||||
|
removeListener: (listener: T) => listeners.delete(listener),
|
||||||
|
fire: (...args: Parameters<T>) => {
|
||||||
|
for (const listener of [...listeners]) listener(...args);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function fixture() {
|
||||||
|
const manager = new SessionManager({
|
||||||
|
agentWindow: {
|
||||||
|
create: vi.fn(async () => 100),
|
||||||
|
remove: vi.fn(async () => {}),
|
||||||
|
ensureActiveTab: vi.fn(async () => 4),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await manager.start("test");
|
||||||
|
type Listener = Parameters<BrowserNavigationApi["onCommitted"]["addListener"]>[0];
|
||||||
|
const events = {
|
||||||
|
onCommitted: event<Listener>(),
|
||||||
|
onDOMContentLoaded: event<Listener>(),
|
||||||
|
onCompleted: event<Listener>(),
|
||||||
|
onErrorOccurred: event<Listener>(),
|
||||||
|
};
|
||||||
|
const cdpEvents = event<Parameters<NonNullable<CdpRunner["onEvent"]>>[0]>();
|
||||||
|
const state = { blocked: true, destinationBlocked: false, emitIdle: true };
|
||||||
|
const send = vi.fn(async (_tabId: number, method: string) => {
|
||||||
|
if (state.blocked) throw new Error(denied);
|
||||||
|
if (method === "Page.getFrameTree") {
|
||||||
|
return { frameTree: { frame: { id: "main", loaderId: "new-loader" } } };
|
||||||
|
}
|
||||||
|
if (method === "Runtime.evaluate") return { result: { value: "complete" } };
|
||||||
|
if (method === "Page.setLifecycleEventsEnabled" && state.emitIdle) {
|
||||||
|
cdpEvents.fire({ tabId: 4 }, "Page.lifecycleEvent", {
|
||||||
|
frameId: "main",
|
||||||
|
loaderId: "new-loader",
|
||||||
|
name: "networkIdle",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (method === "Page.navigate") return { frameId: "main", loaderId: "new-loader" };
|
||||||
|
return {};
|
||||||
|
});
|
||||||
|
const cdp: CdpRunner = {
|
||||||
|
send: send as CdpRunner["send"],
|
||||||
|
onEvent: (listener) => {
|
||||||
|
cdpEvents.addListener(listener);
|
||||||
|
return { dispose: () => cdpEvents.removeListener(listener) };
|
||||||
|
},
|
||||||
|
};
|
||||||
|
const main = { tabId: 4, frameId: 0, documentId: "new-document" };
|
||||||
|
const navigate = async () => {
|
||||||
|
state.blocked = state.destinationBlocked;
|
||||||
|
events.onCommitted.fire(main);
|
||||||
|
events.onDOMContentLoaded.fire(main);
|
||||||
|
events.onCompleted.fire(main);
|
||||||
|
};
|
||||||
|
const browserNavigation = { ...events, update: vi.fn(navigate), reload: vi.fn(navigate) };
|
||||||
|
const tab = { id: 4, windowId: 100, active: true, url } as chrome.tabs.Tab;
|
||||||
|
const tabsApi = { get: vi.fn(async () => tab), query: vi.fn(async () => [tab]) };
|
||||||
|
const deps = { cdp, tabsApi, browserNavigation, defaultTimeoutMs: 1000 };
|
||||||
|
const expectCleanedUp = () => {
|
||||||
|
for (const entry of Object.values(events)) expect(entry.listeners.size).toBe(0);
|
||||||
|
expect(cdpEvents.listeners.size).toBe(0);
|
||||||
|
};
|
||||||
|
return { manager, deps, state, send, events, main, cdpEvents, expectCleanedUp };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("navigation after Chrome denies extension-frame access", () => {
|
||||||
|
it.each([
|
||||||
|
"load",
|
||||||
|
"commit",
|
||||||
|
"domcontentloaded",
|
||||||
|
"networkidle",
|
||||||
|
] as const)("recovers the same tab with the requested %s checkpoint", async (waitUntil) => {
|
||||||
|
const f = await fixture();
|
||||||
|
const result = await handleNavigate(
|
||||||
|
f.manager,
|
||||||
|
{
|
||||||
|
session_id: "test",
|
||||||
|
url,
|
||||||
|
wait_until: waitUntil,
|
||||||
|
},
|
||||||
|
f.deps,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(result).toMatchObject({ tab_id: 4, final_url: url, reached: waitUntil });
|
||||||
|
expect(f.deps.browserNavigation.update).toHaveBeenCalledExactlyOnceWith(4, { url });
|
||||||
|
expect(f.send.mock.calls.some(([, method]) => method === "Page.navigate")).toBe(false);
|
||||||
|
expect(f.send).toHaveBeenCalledWith(4, "Page.enable", {});
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("recovers reload through tabs.reload and preserves hard reload", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
const result = await handleReload(f.manager, { session_id: "test", hard: true }, f.deps);
|
||||||
|
expect(result).toMatchObject({ tab_id: 4, reached: "load" });
|
||||||
|
expect(f.deps.browserNavigation.reload).toHaveBeenCalledExactlyOnceWith(4, {
|
||||||
|
bypassCache: true,
|
||||||
|
});
|
||||||
|
expect(f.deps.browserNavigation.update).not.toHaveBeenCalled();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("reports the restriction when reload leaves the conflicting frame present", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.state.destinationBlocked = true;
|
||||||
|
const result = await handleReload(f.manager, { session_id: "test" }, f.deps);
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "cdp_extension_access_denied" },
|
||||||
|
});
|
||||||
|
expect(f.deps.browserNavigation.reload).toHaveBeenCalledOnce();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not fall back for unrelated debugger failures", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.send.mockRejectedValue(new Error("Another debugger is already attached"));
|
||||||
|
const result = await handleNavigate(f.manager, { session_id: "test", url }, f.deps);
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
message: "Another debugger is already attached",
|
||||||
|
});
|
||||||
|
expect(f.deps.browserNavigation.update).not.toHaveBeenCalled();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not replay navigation when a dispatched CDP command fails", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.state.blocked = false;
|
||||||
|
const send = f.send.getMockImplementation()!;
|
||||||
|
f.send.mockImplementation(async (tabId, method) => {
|
||||||
|
if (method === "Page.navigate") throw new Error(denied);
|
||||||
|
return send(tabId, method);
|
||||||
|
});
|
||||||
|
const result = await handleNavigate(f.manager, { session_id: "test", url }, f.deps);
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
code: "cdp_failed",
|
||||||
|
data: { reason: "cdp_extension_access_denied" },
|
||||||
|
});
|
||||||
|
expect(f.deps.browserNavigation.update).not.toHaveBeenCalled();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps the Agent Window guard in front of the recovery", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.deps.tabsApi.get.mockResolvedValue({
|
||||||
|
id: 4,
|
||||||
|
windowId: 200,
|
||||||
|
active: true,
|
||||||
|
url,
|
||||||
|
} as chrome.tabs.Tab);
|
||||||
|
const result = await handleNavigate(f.manager, { session_id: "test", tab_id: 4, url }, f.deps);
|
||||||
|
expect(result).toMatchObject({ code: "permission_denied" });
|
||||||
|
expect(f.send).not.toHaveBeenCalled();
|
||||||
|
expect(f.deps.browserNavigation.update).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("ignores old-document, subframe, and other-tab completion events", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.deps.browserNavigation.update.mockImplementation(async () => {});
|
||||||
|
let settled = false;
|
||||||
|
const work = handleNavigate(f.manager, { session_id: "test", url }, f.deps).then((result) => {
|
||||||
|
settled = true;
|
||||||
|
return result;
|
||||||
|
});
|
||||||
|
await vi.waitFor(() => expect(f.deps.browserNavigation.update).toHaveBeenCalledOnce());
|
||||||
|
f.events.onCompleted.fire(f.main);
|
||||||
|
f.events.onCommitted.fire({ ...f.main, tabId: 9 });
|
||||||
|
f.events.onCommitted.fire({ ...f.main, frameId: 1 });
|
||||||
|
f.events.onCompleted.fire(f.main);
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(settled).toBe(false);
|
||||||
|
f.events.onCommitted.fire(f.main);
|
||||||
|
f.events.onCompleted.fire({ ...f.main, documentId: "old-document" });
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(settled).toBe(false);
|
||||||
|
f.state.blocked = false;
|
||||||
|
f.events.onCompleted.fire(f.main);
|
||||||
|
expect(await work).toMatchObject({ reached: "load" });
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not infer network idle from a browser load event", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.state.emitIdle = false;
|
||||||
|
const result = await handleNavigate(
|
||||||
|
f.manager,
|
||||||
|
{
|
||||||
|
session_id: "test",
|
||||||
|
url,
|
||||||
|
wait_until: "networkidle",
|
||||||
|
timeout_ms: 10,
|
||||||
|
},
|
||||||
|
f.deps,
|
||||||
|
);
|
||||||
|
expect(result).toMatchObject({ reached: "timeout" });
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("cleans up browser listeners on timeout", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.deps.browserNavigation.update.mockImplementation(async () => {});
|
||||||
|
const result = await handleNavigate(
|
||||||
|
f.manager,
|
||||||
|
{ session_id: "test", url, timeout_ms: 10 },
|
||||||
|
f.deps,
|
||||||
|
);
|
||||||
|
expect(result).toMatchObject({ reached: "timeout" });
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not navigate an already-cancelled request", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
const result = await handleNavigate(
|
||||||
|
f.manager,
|
||||||
|
{ session_id: "test", url },
|
||||||
|
{
|
||||||
|
...f.deps,
|
||||||
|
signal: AbortSignal.abort(),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(result).toMatchObject({ code: "cancelled" });
|
||||||
|
expect(f.deps.browserNavigation.update).not.toHaveBeenCalled();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("cleans up browser listeners when cancelled after dispatch", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
const ac = new AbortController();
|
||||||
|
f.deps.browserNavigation.update.mockImplementation(async () => {
|
||||||
|
ac.abort();
|
||||||
|
});
|
||||||
|
const result = await handleNavigate(
|
||||||
|
f.manager,
|
||||||
|
{ session_id: "test", url },
|
||||||
|
{ ...f.deps, signal: ac.signal },
|
||||||
|
);
|
||||||
|
expect(result).toMatchObject({ code: "cancelled" });
|
||||||
|
expect(f.deps.browserNavigation.update).toHaveBeenCalledOnce();
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("reports browser navigation errors and releases listeners", async () => {
|
||||||
|
const f = await fixture();
|
||||||
|
f.deps.browserNavigation.update.mockImplementation(async () => {
|
||||||
|
f.events.onErrorOccurred.fire({ ...f.main, error: "net::ERR_NAME_NOT_RESOLVED" });
|
||||||
|
});
|
||||||
|
const result = await handleNavigate(f.manager, { session_id: "test", url }, f.deps);
|
||||||
|
expect(result).toMatchObject({ code: "cdp_failed", message: "net::ERR_NAME_NOT_RESOLVED" });
|
||||||
|
f.expectCleanedUp();
|
||||||
|
});
|
||||||
|
});
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,233 @@
|
|||||||
|
// @vitest-environment node
|
||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import type { CdpFrame, CdpFrameGraph, CdpTarget } from "@/browser-driver/frame-graph";
|
||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
import { captureObservationFacts } from "../vom/capture-coordinator";
|
||||||
|
|
||||||
|
type Send = <T = Record<string, unknown>>(
|
||||||
|
method: string,
|
||||||
|
params?: object,
|
||||||
|
sessionId?: string,
|
||||||
|
) => Promise<T>;
|
||||||
|
type Tree = { frame: { id: string; parentId?: string; name?: string }; childFrames?: Tree[] };
|
||||||
|
type Rect = { x: number; y: number; w: number; h: number };
|
||||||
|
type Oracle = { probe: Rect; owners: Record<string, { x: number; y: number; scale: number }> };
|
||||||
|
|
||||||
|
// The independent oracle uses DOM border boxes and this fixture's axis-aligned
|
||||||
|
// iframe transforms. No production snapshot conversion/projection builds expectations.
|
||||||
|
const oracleExpression = `(() => {
|
||||||
|
const box = document.querySelector('#probe').getBoundingClientRect();
|
||||||
|
const owners = {};
|
||||||
|
for (const frame of document.querySelectorAll('iframe')) {
|
||||||
|
const rect = frame.getBoundingClientRect();
|
||||||
|
const style = getComputedStyle(frame);
|
||||||
|
const scale = rect.width / frame.offsetWidth;
|
||||||
|
owners[frame.name] = {
|
||||||
|
x: rect.x + (frame.clientLeft + parseFloat(style.paddingLeft)) * scale,
|
||||||
|
y: rect.y + (frame.clientTop + parseFloat(style.paddingTop)) * scale,
|
||||||
|
scale,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return { probe: { x: box.x, y: box.y, w: box.width, h: box.height }, owners };
|
||||||
|
})()`;
|
||||||
|
|
||||||
|
describe.skipIf(!process.env.BSK_GEOMETRY_CHROME)("real DOMSnapshot coordinate contract", () => {
|
||||||
|
it.each([
|
||||||
|
{ deviceScale: 1, zoom: 1 },
|
||||||
|
{ deviceScale: 0.8, zoom: 1 },
|
||||||
|
{ deviceScale: 1, zoom: 1.25 },
|
||||||
|
{ deviceScale: 2, zoom: 1 },
|
||||||
|
{ deviceScale: 2, zoom: 0.8 },
|
||||||
|
])("matches DOM geometry at device scale $deviceScale and zoom $zoom", async (configuration) => {
|
||||||
|
const evalRoot = new URL("../../../../../evals/browser/", import.meta.url);
|
||||||
|
const { createEvalServer } = await import(new URL("lib/server.mjs", evalRoot).href);
|
||||||
|
const { withChrome } = await import(
|
||||||
|
new URL("cases/regression/snapshot-coordinates/chrome.mjs", evalRoot).href
|
||||||
|
);
|
||||||
|
const server = createEvalServer();
|
||||||
|
const { baseUrl } = await server.start();
|
||||||
|
try {
|
||||||
|
await withChrome(
|
||||||
|
{ executable: process.env.BSK_GEOMETRY_CHROME, ...configuration },
|
||||||
|
async (send: Send) => {
|
||||||
|
const { targetId } = await send<{ targetId: string }>("Target.createTarget", {
|
||||||
|
url: "about:blank",
|
||||||
|
});
|
||||||
|
const { sessionId: rootSession } = await send<{ sessionId: string }>(
|
||||||
|
"Target.attachToTarget",
|
||||||
|
{ targetId, flatten: true },
|
||||||
|
);
|
||||||
|
await send(
|
||||||
|
"Page.navigate",
|
||||||
|
{ url: `${baseUrl}/snapshot-coordinates?run=coordinates` },
|
||||||
|
rootSession,
|
||||||
|
);
|
||||||
|
await expect
|
||||||
|
.poll(
|
||||||
|
() =>
|
||||||
|
server
|
||||||
|
.snapshot("coordinates")
|
||||||
|
.events.some(
|
||||||
|
(event: { type: string; data: { root?: boolean } }) =>
|
||||||
|
event.type === "geometry.ready" && event.data.root,
|
||||||
|
),
|
||||||
|
{ timeout: 10_000 },
|
||||||
|
)
|
||||||
|
.toBe(true);
|
||||||
|
|
||||||
|
const targets = await send<{ targetInfos: { targetId: string; type: string }[] }>(
|
||||||
|
"Target.getTargets",
|
||||||
|
);
|
||||||
|
const sessions = [rootSession];
|
||||||
|
for (const target of targets.targetInfos.filter((target) => target.type === "iframe")) {
|
||||||
|
const { sessionId } = await send<{ sessionId: string }>("Target.attachToTarget", {
|
||||||
|
targetId: target.targetId,
|
||||||
|
flatten: true,
|
||||||
|
});
|
||||||
|
sessions.push(sessionId);
|
||||||
|
}
|
||||||
|
expect(sessions.length).toBe(2); // The cross-site fixture must actually be an OOPIF.
|
||||||
|
const frames: CdpFrame[] = [];
|
||||||
|
const names = new Map<string, string>();
|
||||||
|
const sessionFor = (target: CdpTarget) => target.sessionId ?? rootSession;
|
||||||
|
for (const sessionId of sessions) {
|
||||||
|
const { frameTree } = await send<{ frameTree: Tree }>(
|
||||||
|
"Page.getFrameTree",
|
||||||
|
{},
|
||||||
|
sessionId,
|
||||||
|
);
|
||||||
|
const target: CdpTarget = {
|
||||||
|
tabId: 1,
|
||||||
|
...(sessionId === rootSession ? {} : { sessionId }),
|
||||||
|
};
|
||||||
|
const visit = (tree: Tree, parentFrameId = tree.frame.parentId) => {
|
||||||
|
frames.push({ frameId: tree.frame.id, parentFrameId, target });
|
||||||
|
names.set(tree.frame.id, tree.frame.name ?? "");
|
||||||
|
for (const child of tree.childFrames ?? []) visit(child, tree.frame.id);
|
||||||
|
};
|
||||||
|
visit(frameTree);
|
||||||
|
}
|
||||||
|
expect(frames).toHaveLength(5);
|
||||||
|
for (const frame of frames) {
|
||||||
|
if (!frame.parentFrameId) continue;
|
||||||
|
const parent = frames.find((item) => item.frameId === frame.parentFrameId)!;
|
||||||
|
const owner = await send<{ backendNodeId: number }>(
|
||||||
|
"DOM.getFrameOwner",
|
||||||
|
{ frameId: frame.frameId },
|
||||||
|
sessionFor(parent.target),
|
||||||
|
);
|
||||||
|
frame.ownerBackendNodeId = owner.backendNodeId;
|
||||||
|
}
|
||||||
|
const graph: CdpFrameGraph = { rootFrameId: frames[0].frameId, frames };
|
||||||
|
const calls: string[] = [];
|
||||||
|
const cdp: CdpRunner = {
|
||||||
|
send: (tabId, method, params) => {
|
||||||
|
calls.push(`${tabId}:${method}`);
|
||||||
|
return send(method, params, rootSession);
|
||||||
|
},
|
||||||
|
sendToTarget: (target, method, params) => {
|
||||||
|
calls.push(`${target.sessionId ?? target.tabId}:${method}`);
|
||||||
|
return send(method, params, sessionFor(target));
|
||||||
|
},
|
||||||
|
getFrameGraph: async () => graph,
|
||||||
|
};
|
||||||
|
const oracles = new Map<string, Oracle>();
|
||||||
|
for (const frame of frames) {
|
||||||
|
const session = sessionFor(frame.target);
|
||||||
|
const { executionContextId } = await send<{ executionContextId: number }>(
|
||||||
|
"Page.createIsolatedWorld",
|
||||||
|
{ frameId: frame.frameId, worldName: "coordinate-oracle" },
|
||||||
|
session,
|
||||||
|
);
|
||||||
|
await expect
|
||||||
|
.poll(
|
||||||
|
async () => {
|
||||||
|
const ready = await send<{ result: { value: boolean } }>(
|
||||||
|
"Runtime.evaluate",
|
||||||
|
{
|
||||||
|
expression: 'document.documentElement.dataset.geometryReady === "true"',
|
||||||
|
contextId: executionContextId,
|
||||||
|
returnByValue: true,
|
||||||
|
},
|
||||||
|
session,
|
||||||
|
);
|
||||||
|
return ready.result.value;
|
||||||
|
},
|
||||||
|
{ timeout: 5_000 },
|
||||||
|
)
|
||||||
|
.toBe(true);
|
||||||
|
// Establish scroll after cross-process target creation/layout settles.
|
||||||
|
const scroll = frame.parentFrameId
|
||||||
|
? names.get(frame.frameId) === "nested"
|
||||||
|
? [10, 20]
|
||||||
|
: [40, 100]
|
||||||
|
: [80, 240];
|
||||||
|
await send(
|
||||||
|
"Runtime.evaluate",
|
||||||
|
{
|
||||||
|
expression: `(async () => { scrollTo(${scroll.join(",")}); await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve))); })()`,
|
||||||
|
contextId: executionContextId,
|
||||||
|
awaitPromise: true,
|
||||||
|
},
|
||||||
|
session,
|
||||||
|
);
|
||||||
|
const reply = await send<{ result: { value: Oracle } }>(
|
||||||
|
"Runtime.evaluate",
|
||||||
|
{ expression: oracleExpression, contextId: executionContextId, returnByValue: true },
|
||||||
|
session,
|
||||||
|
);
|
||||||
|
oracles.set(frame.frameId, reply.result.value);
|
||||||
|
}
|
||||||
|
const facts = await captureObservationFacts(cdp, 1);
|
||||||
|
expect(facts.issues).toEqual([]);
|
||||||
|
for (const frame of frames) {
|
||||||
|
const node = facts.documents
|
||||||
|
.find((doc) => doc.frame.frameId === frame.frameId)
|
||||||
|
?.domNodes.find((node) => node.attrs.id === "probe");
|
||||||
|
expect(node, `missing probe in ${names.get(frame.frameId) || "root"}`).toBeDefined();
|
||||||
|
const local = oracles.get(frame.frameId)!.probe;
|
||||||
|
const top = { ...local };
|
||||||
|
let current = frame;
|
||||||
|
while (current.parentFrameId) {
|
||||||
|
const owner = oracles.get(current.parentFrameId)!.owners[names.get(current.frameId)!];
|
||||||
|
top.x = owner.x + top.x * owner.scale;
|
||||||
|
top.y = owner.y + top.y * owner.scale;
|
||||||
|
top.w *= owner.scale;
|
||||||
|
top.h *= owner.scale;
|
||||||
|
current = frames.find((item) => item.frameId === current.parentFrameId)!;
|
||||||
|
}
|
||||||
|
expect(
|
||||||
|
node!.rect,
|
||||||
|
JSON.stringify({
|
||||||
|
frame: names.get(frame.frameId),
|
||||||
|
local,
|
||||||
|
top,
|
||||||
|
viewport: facts.viewport,
|
||||||
|
}),
|
||||||
|
).not.toBeNull();
|
||||||
|
for (const key of ["x", "y", "w", "h"] as const) {
|
||||||
|
expect(
|
||||||
|
Math.abs(node!.localRect![key] - local[key]),
|
||||||
|
`${names.get(frame.frameId)} local ${key}`,
|
||||||
|
).toBeLessThan(2);
|
||||||
|
expect(
|
||||||
|
Math.abs(node!.rect![key] - top[key]),
|
||||||
|
`${names.get(frame.frameId)} top ${key}`,
|
||||||
|
).toBeLessThan(2);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
expect(calls.filter((call) => call.endsWith(":Page.getLayoutMetrics"))).toHaveLength(
|
||||||
|
sessions.length,
|
||||||
|
);
|
||||||
|
const metrics = await send<{
|
||||||
|
cssVisualViewport: { zoom: number };
|
||||||
|
visualViewport: { clientWidth: number };
|
||||||
|
}>("Page.getLayoutMetrics", {}, rootSession);
|
||||||
|
expect(metrics.cssVisualViewport.zoom).toBeCloseTo(configuration.zoom, 4);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await server.stop();
|
||||||
|
}
|
||||||
|
}, 30_000);
|
||||||
|
});
|
||||||
@@ -0,0 +1,110 @@
|
|||||||
|
import type { RpcError, WaitUntil } from "@/transport/types";
|
||||||
|
import { cdpError } from "./errors";
|
||||||
|
|
||||||
|
interface NavigationEvent {
|
||||||
|
tabId: number;
|
||||||
|
frameId: number;
|
||||||
|
documentId?: string;
|
||||||
|
error?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface NavigationEvents {
|
||||||
|
addListener(listener: (details: NavigationEvent) => void): void;
|
||||||
|
removeListener(listener: (details: NavigationEvent) => void): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Normal browser navigation remains available when chrome.debugger is denied. */
|
||||||
|
export interface BrowserNavigationApi {
|
||||||
|
update(tabId: number, props: { url: string }): Promise<unknown>;
|
||||||
|
reload(tabId: number, props: { bypassCache: boolean }): Promise<void>;
|
||||||
|
onCommitted: NavigationEvents;
|
||||||
|
onDOMContentLoaded: NavigationEvents;
|
||||||
|
onCompleted: NavigationEvents;
|
||||||
|
onErrorOccurred: NavigationEvents;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const chromeBrowserNavigationApi: BrowserNavigationApi = {
|
||||||
|
update: (tabId, props) => chrome.tabs.update(tabId, props),
|
||||||
|
reload: (tabId, props) => chrome.tabs.reload(tabId, props),
|
||||||
|
get onCommitted() {
|
||||||
|
return chrome.webNavigation.onCommitted;
|
||||||
|
},
|
||||||
|
get onDOMContentLoaded() {
|
||||||
|
return chrome.webNavigation.onDOMContentLoaded;
|
||||||
|
},
|
||||||
|
get onCompleted() {
|
||||||
|
return chrome.webNavigation.onCompleted;
|
||||||
|
},
|
||||||
|
get onErrorOccurred() {
|
||||||
|
return chrome.webNavigation.onErrorOccurred;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export type NavigationOutcome =
|
||||||
|
| { reached: "match" | "timeout" | "cancelled"; lastLifecycle?: string }
|
||||||
|
| { reached: "failed"; error: RpcError };
|
||||||
|
|
||||||
|
/** Subscribe before dispatch and ignore the departing document's load events. */
|
||||||
|
export async function navigateWithBrowserApi(
|
||||||
|
api: BrowserNavigationApi,
|
||||||
|
tabId: number,
|
||||||
|
action: () => Promise<unknown>,
|
||||||
|
waitUntil: Exclude<WaitUntil, "networkidle">,
|
||||||
|
timeoutMs: number,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<NavigationOutcome> {
|
||||||
|
if (signal?.aborted) return { reached: "cancelled" };
|
||||||
|
if (timeoutMs <= 0) return { reached: "timeout" };
|
||||||
|
let committed = false;
|
||||||
|
let documentId: string | undefined;
|
||||||
|
let lastLifecycle: string | undefined;
|
||||||
|
let finish!: (outcome: NavigationOutcome) => void;
|
||||||
|
const outcome = new Promise<NavigationOutcome>((resolve) => {
|
||||||
|
finish = resolve;
|
||||||
|
});
|
||||||
|
const isMainFrame = (details: NavigationEvent) =>
|
||||||
|
details.tabId === tabId && details.frameId === 0;
|
||||||
|
const onCommitted = (details: NavigationEvent) => {
|
||||||
|
if (!isMainFrame(details)) return;
|
||||||
|
committed = true;
|
||||||
|
documentId = details.documentId;
|
||||||
|
lastLifecycle = "commit";
|
||||||
|
if (waitUntil === "commit") finish({ reached: "match", lastLifecycle });
|
||||||
|
};
|
||||||
|
const onDOMContentLoaded = (details: NavigationEvent) => {
|
||||||
|
if (!isMainFrame(details) || !committed || (documentId && details.documentId !== documentId))
|
||||||
|
return;
|
||||||
|
lastLifecycle = "DOMContentLoaded";
|
||||||
|
if (waitUntil === "domcontentloaded") finish({ reached: "match", lastLifecycle });
|
||||||
|
};
|
||||||
|
const onCompleted = (details: NavigationEvent) => {
|
||||||
|
if (!isMainFrame(details) || !committed || (documentId && details.documentId !== documentId))
|
||||||
|
return;
|
||||||
|
finish({ reached: "match", lastLifecycle: "load" });
|
||||||
|
};
|
||||||
|
const onError = (details: NavigationEvent) => {
|
||||||
|
if (!isMainFrame(details)) return;
|
||||||
|
finish({ reached: "failed", error: cdpError(details.error ?? "browser navigation failed") });
|
||||||
|
};
|
||||||
|
const onAbort = () => finish({ reached: "cancelled", lastLifecycle });
|
||||||
|
const subscriptions = [
|
||||||
|
[api.onCommitted, onCommitted],
|
||||||
|
[api.onDOMContentLoaded, onDOMContentLoaded],
|
||||||
|
[api.onCompleted, onCompleted],
|
||||||
|
[api.onErrorOccurred, onError],
|
||||||
|
] as const;
|
||||||
|
for (const [event, listener] of subscriptions) event.addListener(listener);
|
||||||
|
signal?.addEventListener("abort", onAbort, { once: true });
|
||||||
|
const timer = setTimeout(() => finish({ reached: "timeout", lastLifecycle }), timeoutMs);
|
||||||
|
try {
|
||||||
|
if (signal?.aborted) return { reached: "cancelled" };
|
||||||
|
await action();
|
||||||
|
return await outcome;
|
||||||
|
} catch (error) {
|
||||||
|
return { reached: "failed", error: cdpError(error) };
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timer);
|
||||||
|
signal?.removeEventListener("abort", onAbort);
|
||||||
|
for (const [event, listener] of subscriptions) event.removeListener(listener);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -36,6 +36,7 @@ import { isRequestFrame } from "@/transport/types";
|
|||||||
import { handleConsole } from "./console";
|
import { handleConsole } from "./console";
|
||||||
import { handleDownload } from "./download";
|
import { handleDownload } from "./download";
|
||||||
import { type EmulateCdpRunner, handleEmulate } from "./emulate";
|
import { type EmulateCdpRunner, handleEmulate } from "./emulate";
|
||||||
|
import { classifyCdpError } from "./errors";
|
||||||
import { handleEvaluate } from "./evaluate";
|
import { handleEvaluate } from "./evaluate";
|
||||||
import { handleRequestHelp } from "./human-loop";
|
import { handleRequestHelp } from "./human-loop";
|
||||||
import { handleClick, handleFill, handleHover, handlePress, handleSelect } from "./interaction";
|
import { handleClick, handleFill, handleHover, handlePress, handleSelect } from "./interaction";
|
||||||
@@ -239,7 +240,7 @@ export class ToolDispatcher {
|
|||||||
if (sessionId) this.onBrowserControlResumed?.(sessionId);
|
if (sessionId) this.onBrowserControlResumed?.(sessionId);
|
||||||
const result = await this.invoke(req, ac.signal);
|
const result = await this.invoke(req, ac.signal);
|
||||||
if (isRpcError(result)) {
|
if (isRpcError(result)) {
|
||||||
body = { id: req.id, error: result };
|
body = { id: req.id, error: classifyCdpError(result) };
|
||||||
} else {
|
} else {
|
||||||
body = { id: req.id, result };
|
body = { id: req.id, result };
|
||||||
if (req.method === "tool.session_start") {
|
if (req.method === "tool.session_start") {
|
||||||
|
|||||||
@@ -13,6 +13,34 @@ import type {
|
|||||||
|
|
||||||
export type { RpcErrorData, RpcErrorReason };
|
export type { RpcErrorData, RpcErrorReason };
|
||||||
|
|
||||||
|
/** Chrome checks the whole tab's frame tree, including other extensions' frames. */
|
||||||
|
export function isCdpExtensionAccessDenied(error: unknown): boolean {
|
||||||
|
const message = error instanceof Error ? error.message : String(error);
|
||||||
|
return message.includes("Cannot access a chrome-extension:// URL of different extension");
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Preserve more specific reasons, especially file-transfer outcome/cleanup details. */
|
||||||
|
export function classifyCdpError(error: RpcError): RpcError {
|
||||||
|
if (
|
||||||
|
error.code !== "cdp_failed" ||
|
||||||
|
error.data?.reason ||
|
||||||
|
!isCdpExtensionAccessDenied(error.message)
|
||||||
|
) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
...error,
|
||||||
|
data: { ...error.data, reason: "cdp_extension_access_denied" },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function cdpError(error: unknown): RpcError {
|
||||||
|
return classifyCdpError({
|
||||||
|
code: "cdp_failed",
|
||||||
|
message: error instanceof Error ? error.message : String(error),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
export interface TransferErrorOptions {
|
export interface TransferErrorOptions {
|
||||||
effectState: TransferEffectState;
|
effectState: TransferEffectState;
|
||||||
phase: string;
|
phase: string;
|
||||||
|
|||||||
@@ -1,24 +1,21 @@
|
|||||||
import { type CdpFrame, type CdpFrameGraph, type CdpTarget } from "@/browser-driver/frame-graph";
|
import { type CdpTarget, cdpTargetKey } 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 CdpRunner, cdpRunnerForTarget, isRpcError, sendToCdpTarget } from "./shared";
|
import type { CssViewport } from "./geometry/coordinate-types";
|
||||||
|
import { cssViewport, GeometryContext } from "./geometry/frame-context";
|
||||||
|
import { type CdpRunner, cdpRunnerForTarget, isRpcError } from "./shared";
|
||||||
|
|
||||||
export interface NodeAddress {
|
export interface NodeAddress {
|
||||||
target: CdpTarget;
|
target: CdpTarget;
|
||||||
@@ -27,6 +24,8 @@ 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. */
|
||||||
@@ -39,145 +38,16 @@ 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,
|
||||||
graph: CdpFrameGraph,
|
context: GeometryContext,
|
||||||
frameId: string,
|
frameId: string,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
const byId = frameMap(graph);
|
const ancestry = await context.ancestry(frameId);
|
||||||
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 ? byId.get(child.parentFrameId) : undefined;
|
const parent = child.parentFrameId ? await context.frame(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}`);
|
||||||
}
|
}
|
||||||
@@ -191,17 +61,20 @@ async function scrollFrameOwners(
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function scrollElementWithFrameGraph(
|
async function scrollElementWithContext(
|
||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
target: CdpTarget,
|
target: CdpTarget,
|
||||||
backendNodeId: number,
|
backendNodeId: number,
|
||||||
frameId: string | undefined,
|
frameId: string | undefined,
|
||||||
graph: CdpFrameGraph | null,
|
context: GeometryContext,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
if (frameId) {
|
if (frameId) {
|
||||||
if (!graph) return geometryError(`could not resolve frame graph for ${frameId}`);
|
const frame = await context.frame(frameId);
|
||||||
const error = await scrollFrameOwners(cdp, tabId, graph, frameId);
|
if (!frame || cdpTargetKey(frame.target) !== cdpTargetKey(target)) {
|
||||||
|
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");
|
||||||
@@ -216,8 +89,15 @@ export async function scrollElementAndFramesIntoView(
|
|||||||
backendNodeId: number,
|
backendNodeId: number,
|
||||||
frameId?: string,
|
frameId?: string,
|
||||||
): Promise<RpcError | null> {
|
): Promise<RpcError | null> {
|
||||||
const graph = frameId ? await loadFrameGraph(cdp, tabId) : null;
|
if (target.tabId !== tabId) return geometryError("node target belongs to another tab");
|
||||||
return scrollElementWithFrameGraph(cdp, tabId, target, backendNodeId, frameId, graph);
|
return scrollElementWithContext(
|
||||||
|
cdp,
|
||||||
|
tabId,
|
||||||
|
target,
|
||||||
|
backendNodeId,
|
||||||
|
frameId,
|
||||||
|
new GeometryContext(cdp, tabId),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function largestRegion(regions: Region): Polygon | null {
|
function largestRegion(regions: Region): Polygon | null {
|
||||||
@@ -240,23 +120,32 @@ 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");
|
||||||
}
|
}
|
||||||
const graph = address.frameId ? await loadFrameGraph(cdp, tabId) : null;
|
if (address.target.tabId !== tabId) return geometryError("node target belongs to another tab");
|
||||||
|
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 scrollElementWithFrameGraph(
|
const scrollError = await scrollElementWithContext(
|
||||||
cdp,
|
cdp,
|
||||||
tabId,
|
tabId,
|
||||||
address.target,
|
address.target,
|
||||||
address.backendNodeId,
|
address.backendNodeId,
|
||||||
address.frameId,
|
address.frameId,
|
||||||
graph,
|
context,
|
||||||
);
|
);
|
||||||
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,
|
||||||
@@ -267,7 +156,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 resolveFrameProjection(cdp, graph, address.frameId);
|
const projection = await context.targetProjection(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);
|
||||||
@@ -290,7 +179,7 @@ export async function resolveNodeGeometry(
|
|||||||
targetActionPoint = localActionRegion ? polygonCentroid(localActionRegion) : null;
|
targetActionPoint = localActionRegion ? polygonCentroid(localActionRegion) : null;
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
const viewport = await targetViewport(cdp, address.target);
|
const viewport = await context.viewport(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) =>
|
||||||
@@ -309,7 +198,13 @@ 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 { topVisibleRegions, topBounds, actionPoint, targetActionPoint };
|
return {
|
||||||
|
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,22 +245,3 @@ 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,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,157 @@
|
|||||||
|
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 interface UnavailableSnapshotCoordinates {
|
||||||
|
status: "unavailable";
|
||||||
|
source: CoordinateOwner;
|
||||||
|
reason: "snapshot-coordinates-unavailable";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SnapshotProjectionResult =
|
||||||
|
| { status: "available"; projection: SnapshotProjection }
|
||||||
|
| UnavailableFrameProjection;
|
||||||
|
|
||||||
|
/** Descendants inherit the failed boundary without attempting another owner read. */
|
||||||
|
export type FrameProjectionIssue =
|
||||||
|
| UnavailableFrameProjection
|
||||||
|
| UnavailableSnapshotCoordinates
|
||||||
|
| {
|
||||||
|
status: "blocked";
|
||||||
|
source: CoordinateOwner;
|
||||||
|
cause: UnavailableFrameProjection | UnavailableSnapshotCoordinates;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type FrameProjectionState = SnapshotProjectionResult | FrameProjectionIssue;
|
||||||
|
|
||||||
|
export interface SnapshotCoordinates {
|
||||||
|
layoutUnitsPerCssPixel: number;
|
||||||
|
scrollCss: { x: number; y: number };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Snapshot scroll offsets share the raw layout units of its bounds. Only a
|
||||||
|
* target's root document may fall back to that target's CSS layout viewport. */
|
||||||
|
export function snapshotCoordinates(
|
||||||
|
document: { scrollOffsetX?: number; scrollOffsetY?: number },
|
||||||
|
layoutUnitsPerCssPixel: number | null,
|
||||||
|
rootScrollCss?: { x?: number; y?: number },
|
||||||
|
): SnapshotCoordinates | null {
|
||||||
|
if (
|
||||||
|
layoutUnitsPerCssPixel === null ||
|
||||||
|
!Number.isFinite(layoutUnitsPerCssPixel) ||
|
||||||
|
layoutUnitsPerCssPixel <= 0
|
||||||
|
)
|
||||||
|
return null;
|
||||||
|
const x =
|
||||||
|
document.scrollOffsetX === undefined
|
||||||
|
? rootScrollCss?.x
|
||||||
|
: document.scrollOffsetX / layoutUnitsPerCssPixel;
|
||||||
|
const y =
|
||||||
|
document.scrollOffsetY === undefined
|
||||||
|
? rootScrollCss?.y
|
||||||
|
: document.scrollOffsetY / layoutUnitsPerCssPixel;
|
||||||
|
if (x === undefined || y === undefined || !Number.isFinite(x) || !Number.isFinite(y)) return null;
|
||||||
|
return { layoutUnitsPerCssPixel, scrollCss: { x, y } };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Convert raw document-relative Blink layout units exactly once, before any
|
||||||
|
* CSS viewport clipping or frame projection. This scale is not screenshot zoom. */
|
||||||
|
export function snapshotViewportRect(
|
||||||
|
bounds: number[],
|
||||||
|
owner: CoordinateOwner,
|
||||||
|
coordinates: SnapshotCoordinates | null,
|
||||||
|
): FrameViewportRect | null {
|
||||||
|
if (!coordinates || bounds.length < 4 || !bounds.slice(0, 4).every(Number.isFinite)) return null;
|
||||||
|
const { layoutUnitsPerCssPixel: scale, scrollCss: scroll } = coordinates;
|
||||||
|
const [x, y, width, height] = bounds;
|
||||||
|
if (
|
||||||
|
!Number.isFinite(scale) ||
|
||||||
|
scale <= 0 ||
|
||||||
|
width <= 0 ||
|
||||||
|
height <= 0 ||
|
||||||
|
!Number.isFinite(scroll.x) ||
|
||||||
|
!Number.isFinite(scroll.y)
|
||||||
|
) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
space: "frame-viewport-css",
|
||||||
|
owner,
|
||||||
|
rect: {
|
||||||
|
x: x / scale - scroll.x,
|
||||||
|
y: y / scale - scroll.y,
|
||||||
|
width: width / scale,
|
||||||
|
height: height / scale,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
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,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,356 @@
|
|||||||
|
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; clientWidth?: number; clientHeight?: number };
|
||||||
|
visualViewport?: { zoom?: number; clientWidth?: number; clientHeight?: number };
|
||||||
|
cssLayoutViewport?: {
|
||||||
|
clientWidth?: number;
|
||||||
|
clientHeight?: number;
|
||||||
|
pageX?: number;
|
||||||
|
pageY?: number;
|
||||||
|
};
|
||||||
|
layoutViewport?: { clientWidth?: number; clientHeight?: number; pageX?: number; pageY?: number };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Chromium emits these paired floating-point dimensions before/after dividing
|
||||||
|
* by LayoutZoomFactor. Integer layout viewport dimensions lose precision at
|
||||||
|
* fractional zoom. Neither visualViewport.scale nor .zoom is this conversion.
|
||||||
|
* See InspectorPageAgent::getLayoutMetrics in Chromium. */
|
||||||
|
export function snapshotLayoutScale(metrics: LayoutMetrics): number | null {
|
||||||
|
for (const dimension of ["clientWidth", "clientHeight"] as const) {
|
||||||
|
const raw = metrics.visualViewport?.[dimension];
|
||||||
|
const css = metrics.cssVisualViewport?.[dimension];
|
||||||
|
if (
|
||||||
|
raw !== undefined &&
|
||||||
|
css !== undefined &&
|
||||||
|
Number.isFinite(raw) &&
|
||||||
|
Number.isFinite(css) &&
|
||||||
|
raw > 0 &&
|
||||||
|
css > 0
|
||||||
|
) {
|
||||||
|
const scale = raw / css;
|
||||||
|
if (Number.isFinite(scale) && scale > 0) return scale;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
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;
|
||||||
|
}
|
||||||
@@ -609,11 +609,28 @@ type SelectMutationResult =
|
|||||||
// tool.fill
|
// tool.fill
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
interface FillPreparation {
|
type FillFailureReason =
|
||||||
before?: string;
|
| "target_not_fillable"
|
||||||
expected?: string;
|
| "fill_value_invalid"
|
||||||
valueLength?: number;
|
| "fill_target_changed"
|
||||||
error?: string;
|
| "fill_focus_lost"
|
||||||
|
| "fill_value_mismatch"
|
||||||
|
| "fill_failed";
|
||||||
|
|
||||||
|
type FillPreparation =
|
||||||
|
| { before: string; expected: string }
|
||||||
|
| { reason: FillFailureReason; error: string };
|
||||||
|
|
||||||
|
type FillReadiness = "ready" | "background" | "fill_target_changed" | "fill_focus_lost";
|
||||||
|
|
||||||
|
function fillError(reason: FillFailureReason, message: string): RpcError {
|
||||||
|
return rpcError(
|
||||||
|
reason === "target_not_fillable" || reason === "fill_value_invalid"
|
||||||
|
? "invalid_params"
|
||||||
|
: "cdp_failed",
|
||||||
|
reason,
|
||||||
|
message,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
interface FillScriptReply<T> {
|
interface FillScriptReply<T> {
|
||||||
@@ -690,12 +707,8 @@ export async function handleFill(
|
|||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
await nodeCdp.send(target.tabId, "DOM.focus", { backendNodeId: node.backendNodeId });
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return fillError("fill_failed", err instanceof Error ? err.message : String(err));
|
||||||
code: "cdp_failed",
|
|
||||||
message: err instanceof Error ? err.message : String(err),
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
@@ -708,6 +721,31 @@ export async function handleFill(
|
|||||||
const clearBefore = params.clear_before ?? true;
|
const clearBefore = params.clear_before ?? true;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
await nodeCdp.send(target.tabId, "DOM.focus", { backendNodeId: node.backendNodeId });
|
||||||
|
} catch (error) {
|
||||||
|
// Chrome rejects DOM.focus for disabled controls, including inherited
|
||||||
|
// fieldset state. Classify the live target before treating this as a
|
||||||
|
// browser failure; the normal path needs no extra round trip.
|
||||||
|
const editable = await nodeCdp.send<FillScriptReply<boolean>>(
|
||||||
|
target.tabId,
|
||||||
|
"Runtime.callFunctionOn",
|
||||||
|
{ objectId, functionDeclaration: FILL_EDITABLE_FUNCTION, returnByValue: true },
|
||||||
|
);
|
||||||
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
if (!editable.exceptionDetails && editable.result?.value === false) {
|
||||||
|
return fillError(
|
||||||
|
"target_not_fillable",
|
||||||
|
"fill target is not editable or its input type is unsupported",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
@@ -721,14 +759,9 @@ export async function handleFill(
|
|||||||
functionDeclaration: `function(value, clearBefore) {
|
functionDeclaration: `function(value, clearBefore) {
|
||||||
const tag = this.tagName.toLowerCase();
|
const tag = this.tagName.toLowerCase();
|
||||||
const native = tag === 'input' || tag === 'textarea';
|
const native = tag === 'input' || tag === 'textarea';
|
||||||
if (!(${FILL_EDITABLE_FUNCTION}).call(this)) return { error: 'fill target is not editable or its input type is unsupported' };
|
if (!(${FILL_EDITABLE_FUNCTION}).call(this)) return { reason: 'target_not_fillable', error: 'fill target is not editable or its input type is unsupported' };
|
||||||
const focused = () => this.getRootNode().activeElement === this && this.ownerDocument.hasFocus();
|
if (this.getRootNode().activeElement !== this) return { reason: 'fill_focus_lost', error: 'fill target does not have focus' };
|
||||||
if (!focused()) return { error: 'fill target does not have focus' };
|
|
||||||
const before = clearBefore ? '' : (${FILL_VALUE_FUNCTION}).call(this);
|
const before = clearBefore ? '' : (${FILL_VALUE_FUNCTION}).call(this);
|
||||||
if (!clearBefore && value !== '' && native && typeof this.selectionStart === 'number' &&
|
|
||||||
(this.selectionStart !== before.length || this.selectionEnd !== before.length)) {
|
|
||||||
return { error: 'fill append requires the caret at the end of the field' };
|
|
||||||
}
|
|
||||||
let expected = before + value;
|
let expected = before + value;
|
||||||
if (native) {
|
if (native) {
|
||||||
// Use the browser's own value sanitization (e.g. textarea
|
// Use the browser's own value sanitization (e.g. textarea
|
||||||
@@ -742,11 +775,11 @@ export async function handleFill(
|
|||||||
if (tag === 'input') expected = expected.replace(/\\r\\n|\\r|\\n/g, ' ');
|
if (tag === 'input') expected = expected.replace(/\\r\\n|\\r|\\n/g, ' ');
|
||||||
normalizer.value = expected;
|
normalizer.value = expected;
|
||||||
if (expected !== '' && normalizer.value === '' && this.type === 'number') {
|
if (expected !== '' && normalizer.value === '' && this.type === 'number') {
|
||||||
return { error: 'fill value is not valid for a number input' };
|
return { reason: 'fill_value_invalid', error: 'fill value is not valid for a number input' };
|
||||||
}
|
}
|
||||||
expected = normalizer.value;
|
expected = normalizer.value;
|
||||||
if (this.type !== 'number' && this.maxLength >= 0 && expected.length > this.maxLength) {
|
if (this.type !== 'number' && this.maxLength >= 0 && expected.length > this.maxLength) {
|
||||||
return { error: 'fill value exceeds the target maxlength' };
|
return { reason: 'fill_value_invalid', error: 'fill value exceeds the target maxlength' };
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
expected = expected.replace(/\\r\\n?/g, '\\n');
|
expected = expected.replace(/\\r\\n?/g, '\\n');
|
||||||
@@ -760,7 +793,7 @@ export async function handleFill(
|
|||||||
}
|
}
|
||||||
this.dispatchEvent(new Event('input', { bubbles: true }));
|
this.dispatchEvent(new Event('input', { bubbles: true }));
|
||||||
}
|
}
|
||||||
return { before, expected, valueLength: Math.max(0, expected.length - before.length) };
|
return { before, expected };
|
||||||
}`,
|
}`,
|
||||||
arguments: [{ value: params.value }, { value: clearBefore }],
|
arguments: [{ value: params.value }, { value: clearBefore }],
|
||||||
returnByValue: true,
|
returnByValue: true,
|
||||||
@@ -770,44 +803,95 @@ export async function handleFill(
|
|||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
if (prepared.exceptionDetails) {
|
if (prepared.exceptionDetails) {
|
||||||
return { code: "cdp_failed", message: "fill preparation script failed" };
|
return fillError("fill_failed", "fill preparation script failed");
|
||||||
}
|
}
|
||||||
const preparation = prepared.result?.value;
|
const preparation = prepared.result?.value;
|
||||||
if (
|
if (preparation && "error" in preparation) {
|
||||||
preparation?.error ||
|
return fillError(preparation.reason, preparation.error);
|
||||||
typeof preparation?.before !== "string" ||
|
}
|
||||||
typeof preparation?.expected !== "string" ||
|
if (typeof preparation?.before !== "string" || typeof preparation?.expected !== "string") {
|
||||||
typeof preparation.valueLength !== "number"
|
return fillError("fill_failed", "fill preparation returned an unexpected result");
|
||||||
) {
|
|
||||||
return {
|
|
||||||
code: "cdp_failed",
|
|
||||||
message: preparation?.error ?? "fill preparation returned an unexpected result",
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
// A separate call runs after the clearing event's microtasks drain.
|
// A separate call runs after the clearing event's microtasks drain.
|
||||||
// Confirm the target before sending input to the focused element.
|
// DOM focus works in background tabs. Use document.hasFocus() only to
|
||||||
const ready = await nodeCdp.send<FillScriptReply<boolean>>(
|
// detect deferred focus events, never to reject background input.
|
||||||
target.tabId,
|
const checkReady = async (): Promise<FillReadiness | RpcError> => {
|
||||||
"Runtime.callFunctionOn",
|
const reply = await nodeCdp.send<FillScriptReply<FillReadiness>>(
|
||||||
{
|
target.tabId,
|
||||||
objectId,
|
"Runtime.callFunctionOn",
|
||||||
functionDeclaration: `function(before) {
|
{
|
||||||
return (${FILL_EDITABLE_FUNCTION}).call(this) &&
|
objectId,
|
||||||
this.getRootNode().activeElement === this && this.ownerDocument.hasFocus() &&
|
functionDeclaration: `function(before) {
|
||||||
(${FILL_VALUE_FUNCTION}).call(this) === before;
|
if (!(${FILL_EDITABLE_FUNCTION}).call(this) ||
|
||||||
}`,
|
(${FILL_VALUE_FUNCTION}).call(this) !== before) return 'fill_target_changed';
|
||||||
arguments: [{ value: preparation.before }],
|
if (this.getRootNode().activeElement !== this) return 'fill_focus_lost';
|
||||||
returnByValue: true,
|
return this.ownerDocument.hasFocus() ? 'ready' : 'background';
|
||||||
},
|
}`,
|
||||||
);
|
arguments: [{ value: preparation.before }],
|
||||||
|
returnByValue: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const state = reply.result?.value;
|
||||||
|
if (
|
||||||
|
reply.exceptionDetails ||
|
||||||
|
(state !== "ready" &&
|
||||||
|
state !== "background" &&
|
||||||
|
state !== "fill_target_changed" &&
|
||||||
|
state !== "fill_focus_lost")
|
||||||
|
) {
|
||||||
|
return fillError(
|
||||||
|
"fill_failed",
|
||||||
|
"fill readiness script failed or returned an unexpected result",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
let ready = await checkReady();
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
if (ready.exceptionDetails || ready.result?.value !== true) {
|
// Restore focus once only if clearing left this same target editable
|
||||||
return {
|
// and unchanged. Recheck after focus handlers have run.
|
||||||
code: "cdp_failed",
|
if (clearBefore && ready === "fill_focus_lost") {
|
||||||
message: "fill target changed, lost focus, or could not be checked before typing",
|
await nodeCdp.send(target.tabId, "DOM.focus", { backendNodeId: node.backendNodeId });
|
||||||
};
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
ready = await checkReady();
|
||||||
|
}
|
||||||
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
if (typeof ready !== "string") return ready;
|
||||||
|
if (ready !== "ready" && ready !== "background") {
|
||||||
|
return fillError(ready, "fill target changed or lost focus before typing");
|
||||||
|
}
|
||||||
|
if (params.value !== "" && (!clearBefore || ready === "background")) {
|
||||||
|
// Native editing commands also support number/email inputs, whose
|
||||||
|
// selection APIs cannot set a caret, and multiline contenteditables.
|
||||||
|
// Also do this for background replacement: CDP input focuses the
|
||||||
|
// renderer, delivering deferred focus events before it inserts text.
|
||||||
|
// Use a command-only event so this does not invoke an End shortcut.
|
||||||
|
try {
|
||||||
|
await deps.cdp.send(target.tabId, "Input.dispatchKeyEvent", {
|
||||||
|
type: "rawKeyDown",
|
||||||
|
commands: ["moveToEndOfDocument"],
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
await deps.cdp.send(target.tabId, "Input.dispatchKeyEvent", { type: "keyUp" });
|
||||||
|
}
|
||||||
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
// Focus and key handlers can change the target or move focus too.
|
||||||
|
ready = await checkReady();
|
||||||
|
if (throwIfAborted(deps.signal)) {
|
||||||
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
|
}
|
||||||
|
if (typeof ready !== "string") return ready;
|
||||||
|
if (ready !== "ready" && ready !== "background") {
|
||||||
|
return fillError(ready, "fill target changed or lost focus while positioning the caret");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// CDP `Input.insertText` handles IME / multi-byte input out of the
|
// CDP `Input.insertText` handles IME / multi-byte input out of the
|
||||||
// box, much more reliably than per-key `dispatchKeyEvent`.
|
// box, much more reliably than per-key `dispatchKeyEvent`.
|
||||||
@@ -835,42 +919,51 @@ export async function handleFill(
|
|||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
if (notified.exceptionDetails) {
|
if (notified.exceptionDetails) {
|
||||||
return { code: "cdp_failed", message: "fill notification script failed" };
|
return fillError("fill_failed", "fill notification script failed");
|
||||||
}
|
}
|
||||||
const verified = await nodeCdp.send<FillScriptReply<boolean>>(
|
const verified = await nodeCdp.send<
|
||||||
target.tabId,
|
FillScriptReply<{ connected: boolean; matches: boolean; valueLength: number }>
|
||||||
"Runtime.callFunctionOn",
|
>(target.tabId, "Runtime.callFunctionOn", {
|
||||||
{
|
objectId,
|
||||||
objectId,
|
functionDeclaration: `function(expected) {
|
||||||
functionDeclaration: `function(expected) {
|
const value = (${FILL_VALUE_FUNCTION}).call(this);
|
||||||
return this.isConnected && (${FILL_VALUE_FUNCTION}).call(this) === expected;
|
return { connected: this.isConnected, matches: value === expected, valueLength: value.length };
|
||||||
}`,
|
}`,
|
||||||
arguments: [{ value: preparation.expected }],
|
arguments: [{ value: preparation.expected }],
|
||||||
returnByValue: true,
|
returnByValue: true,
|
||||||
},
|
});
|
||||||
);
|
|
||||||
if (throwIfAborted(deps.signal)) {
|
if (throwIfAborted(deps.signal)) {
|
||||||
return { code: "cancelled", message: "fill aborted" };
|
return { code: "cancelled", message: "fill aborted" };
|
||||||
}
|
}
|
||||||
if (verified.exceptionDetails || verified.result?.value !== true) {
|
const verification = verified.result?.value;
|
||||||
return {
|
if (
|
||||||
code: "cdp_failed",
|
verified.exceptionDetails ||
|
||||||
message: verified.exceptionDetails
|
typeof verification?.connected !== "boolean" ||
|
||||||
? "fill verification script failed"
|
typeof verification?.matches !== "boolean" ||
|
||||||
: "fill could not verify the expected value; observe the page before retrying",
|
typeof verification?.valueLength !== "number"
|
||||||
};
|
) {
|
||||||
|
return fillError(
|
||||||
|
"fill_failed",
|
||||||
|
"fill verification script failed or returned an unexpected result",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!verification.connected) {
|
||||||
|
return fillError("fill_target_changed", "fill target was removed or replaced during input");
|
||||||
|
}
|
||||||
|
if (!verification.matches) {
|
||||||
|
return fillError(
|
||||||
|
"fill_value_mismatch",
|
||||||
|
"fill could not verify the expected value; observe the page before deciding whether to retry",
|
||||||
|
);
|
||||||
}
|
}
|
||||||
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
||||||
tab_id: target.tabId,
|
tab_id: target.tabId,
|
||||||
used_ref: node.usedRef,
|
used_ref: node.usedRef,
|
||||||
used_selector: node.usedSelector,
|
used_selector: node.usedSelector,
|
||||||
value_length: preparation.valueLength,
|
value_length: verification.valueLength,
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return fillError("fill_failed", err instanceof Error ? err.message : String(err));
|
||||||
code: "cdp_failed",
|
|
||||||
message: err instanceof Error ? err.message : String(err),
|
|
||||||
};
|
|
||||||
} finally {
|
} finally {
|
||||||
await nodeCdp.send(target.tabId, "Runtime.releaseObject", { objectId }).catch(() => undefined);
|
await nodeCdp.send(target.tabId, "Runtime.releaseObject", { objectId }).catch(() => undefined);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,7 +28,13 @@ import type {
|
|||||||
RpcError,
|
RpcError,
|
||||||
WaitUntil,
|
WaitUntil,
|
||||||
} from "@/transport/types";
|
} from "@/transport/types";
|
||||||
|
import {
|
||||||
|
type BrowserNavigationApi,
|
||||||
|
chromeBrowserNavigationApi,
|
||||||
|
navigateWithBrowserApi,
|
||||||
|
} from "./browser-navigation";
|
||||||
import { attachDialogs, markDialogCursor } from "./dialogs";
|
import { attachDialogs, markDialogCursor } from "./dialogs";
|
||||||
|
import { cdpError, isCdpExtensionAccessDenied } from "./errors";
|
||||||
import {
|
import {
|
||||||
type CdpRunner,
|
type CdpRunner,
|
||||||
type ChromeTabsApi,
|
type ChromeTabsApi,
|
||||||
@@ -42,6 +48,7 @@ import {
|
|||||||
export interface NavigationDeps {
|
export interface NavigationDeps {
|
||||||
cdp: CdpRunner;
|
cdp: CdpRunner;
|
||||||
tabsApi: ChromeTabsApi;
|
tabsApi: ChromeTabsApi;
|
||||||
|
browserNavigation?: BrowserNavigationApi;
|
||||||
/** Optional AbortSignal — M7 abort hook (M10.2 will wire the full chain). */
|
/** Optional AbortSignal — M7 abort hook (M10.2 will wire the full chain). */
|
||||||
signal?: AbortSignal;
|
signal?: AbortSignal;
|
||||||
/** Override default timeout when the caller omits `timeout_ms`. */
|
/** Override default timeout when the caller omits `timeout_ms`. */
|
||||||
@@ -479,6 +486,81 @@ async function readTabUrl(api: ChromeTabsApi, tabId: number): Promise<string | u
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Recover only a failed preflight; never replay an already-dispatched navigation. */
|
||||||
|
async function recoverBrowserNavigation(
|
||||||
|
deps: NavigationDeps,
|
||||||
|
tabId: number,
|
||||||
|
action: (api: BrowserNavigationApi) => Promise<unknown>,
|
||||||
|
waitUntil: WaitUntil,
|
||||||
|
timeoutMs: number,
|
||||||
|
): Promise<ReloadResult | RpcError> {
|
||||||
|
const abort = linkedAbortSignal(deps.signal);
|
||||||
|
const deadline = Date.now() + timeoutMs;
|
||||||
|
const api = deps.browserNavigation ?? chromeBrowserNavigationApi;
|
||||||
|
try {
|
||||||
|
let outcome = await navigateWithBrowserApi(
|
||||||
|
api,
|
||||||
|
tabId,
|
||||||
|
() => action(api),
|
||||||
|
waitUntil === "networkidle" ? "commit" : waitUntil,
|
||||||
|
timeoutMs,
|
||||||
|
abort.signal,
|
||||||
|
);
|
||||||
|
if (outcome.reached === "failed") return outcome.error;
|
||||||
|
if (outcome.reached === "cancelled" || abort.signal.aborted) {
|
||||||
|
return { code: "cancelled", message: "navigation recovery aborted" };
|
||||||
|
}
|
||||||
|
if (outcome.reached === "match") {
|
||||||
|
// A completed reload is not a recovery if the restricted frame remains.
|
||||||
|
await deps.cdp.send(tabId, "Page.enable", {});
|
||||||
|
if (abort.signal.aborted)
|
||||||
|
return { code: "cancelled", message: "navigation recovery aborted" };
|
||||||
|
if (waitUntil === "networkidle") {
|
||||||
|
// webNavigation cannot prove network idle. Subscribe on the new
|
||||||
|
// document before enabling CDP lifecycle events after its commit.
|
||||||
|
const frame = await readMainFrameInfo(deps.cdp, tabId);
|
||||||
|
if (!frame.frameId) return cdpError("no main frame after navigation");
|
||||||
|
const remaining = deadline - Date.now();
|
||||||
|
if (remaining <= 0) {
|
||||||
|
outcome = { reached: "timeout", lastLifecycle: "commit" };
|
||||||
|
} else {
|
||||||
|
const wait = startLifecycleWait(
|
||||||
|
deps.cdp,
|
||||||
|
tabId,
|
||||||
|
frame.frameId,
|
||||||
|
"networkIdle",
|
||||||
|
remaining,
|
||||||
|
abort.signal,
|
||||||
|
{ loaderId: frame.loaderId ?? undefined },
|
||||||
|
);
|
||||||
|
await deps.cdp.send(tabId, "Page.setLifecycleEventsEnabled", { enabled: true });
|
||||||
|
outcome = await wait.promise;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (outcome.reached === "cancelled" || abort.signal.aborted) {
|
||||||
|
return { code: "cancelled", message: "navigation recovery aborted" };
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
tab_id: tabId,
|
||||||
|
final_url: await readTabUrl(deps.tabsApi, tabId),
|
||||||
|
reached: outcome.reached === "match" ? waitUntil : "timeout",
|
||||||
|
...(outcome.reached === "timeout"
|
||||||
|
? {
|
||||||
|
error_text: `timed out waiting for ${waitUntil} during navigation recovery after ${timeoutMs}ms`,
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
return abort.signal.aborted
|
||||||
|
? { code: "cancelled", message: "navigation recovery aborted" }
|
||||||
|
: cdpError(error);
|
||||||
|
} finally {
|
||||||
|
abort.abort();
|
||||||
|
abort.cleanup();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// tool.navigate
|
// tool.navigate
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -505,7 +587,20 @@ export async function handleNavigate(
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
await ensureCdpReady(deps.cdp, target.tabId);
|
try {
|
||||||
|
await ensureCdpReady(deps.cdp, target.tabId);
|
||||||
|
} catch (error) {
|
||||||
|
if (!isCdpExtensionAccessDenied(error)) throw error;
|
||||||
|
const recovered = await recoverBrowserNavigation(
|
||||||
|
deps,
|
||||||
|
target.tabId,
|
||||||
|
(api) => api.update(target.tabId, { url: params.url }),
|
||||||
|
waitUntil,
|
||||||
|
timeoutMs,
|
||||||
|
);
|
||||||
|
if (isRpcError(recovered)) return recovered;
|
||||||
|
return attachDialogs(deps.cdp, target.tabId, dialogCursor, { ...recovered, url: params.url });
|
||||||
|
}
|
||||||
const expected = cdpLifecycleName(waitUntil);
|
const expected = cdpLifecycleName(waitUntil);
|
||||||
const beforeReadyState = await probeMainFrameReadyState(deps.cdp, target.tabId);
|
const beforeReadyState = await probeMainFrameReadyState(deps.cdp, target.tabId);
|
||||||
const beforeFrame = await readMainFrameInfo(deps.cdp, target.tabId);
|
const beforeFrame = await readMainFrameInfo(deps.cdp, target.tabId);
|
||||||
@@ -574,10 +669,7 @@ export async function handleNavigate(
|
|||||||
}`,
|
}`,
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return cdpError(err);
|
||||||
code: "cdp_failed",
|
|
||||||
message: err instanceof Error ? err.message : String(err),
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -727,7 +819,24 @@ export async function handleReload(
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
deps.cdp.trackSessionTab?.(ctx.sessionId, target.tabId);
|
||||||
await ensureCdpReady(deps.cdp, target.tabId);
|
try {
|
||||||
|
await ensureCdpReady(deps.cdp, target.tabId);
|
||||||
|
} catch (error) {
|
||||||
|
if (!isCdpExtensionAccessDenied(error)) throw error;
|
||||||
|
const previousUrl = await readTabUrl(deps.tabsApi, target.tabId);
|
||||||
|
const recovered = await recoverBrowserNavigation(
|
||||||
|
deps,
|
||||||
|
target.tabId,
|
||||||
|
(api) => api.reload(target.tabId, { bypassCache: ignoreCache }),
|
||||||
|
waitUntil,
|
||||||
|
timeoutMs,
|
||||||
|
);
|
||||||
|
if (isRpcError(recovered)) return recovered;
|
||||||
|
return attachDialogs(deps.cdp, target.tabId, dialogCursor, {
|
||||||
|
...recovered,
|
||||||
|
previous_url: previousUrl,
|
||||||
|
});
|
||||||
|
}
|
||||||
const previousUrl = await readTabUrl(deps.tabsApi, target.tabId);
|
const previousUrl = await readTabUrl(deps.tabsApi, target.tabId);
|
||||||
const beforeFrame = await readMainFrameInfo(deps.cdp, target.tabId);
|
const beforeFrame = await readMainFrameInfo(deps.cdp, target.tabId);
|
||||||
const expected = cdpLifecycleName(waitUntil);
|
const expected = cdpLifecycleName(waitUntil);
|
||||||
@@ -776,10 +885,7 @@ export async function handleReload(
|
|||||||
}`,
|
}`,
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return {
|
return cdpError(err);
|
||||||
code: "cdp_failed",
|
|
||||||
message: err instanceof Error ? err.message : String(err),
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import type { CapturedSceneInput } from "./vom/facts";
|
||||||
// Observation handlers — `tool.snapshot`, `tool.get_html`, `tool.screenshot`,
|
// Observation handlers — `tool.snapshot`, `tool.get_html`, `tool.screenshot`,
|
||||||
// and semantic `tool.observe` (design §7). Each handler resolves the target
|
// and semantic `tool.observe` (design §7). Each handler resolves the target
|
||||||
// tab (defaulting to the Agent Window's active tab when omitted) and
|
// tab (defaulting to the Agent Window's active tab when omitted) and
|
||||||
@@ -34,6 +35,7 @@ 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 {
|
import {
|
||||||
type ChromeTabsApi,
|
type ChromeTabsApi,
|
||||||
enforceToolTargetScope,
|
enforceToolTargetScope,
|
||||||
@@ -47,15 +49,9 @@ import {
|
|||||||
type ToolEffect,
|
type ToolEffect,
|
||||||
} from "./shared";
|
} from "./shared";
|
||||||
import { resolveSnapshotRef } from "./snapshot-ref";
|
import { resolveSnapshotRef } from "./snapshot-ref";
|
||||||
import {
|
import { type CapturedNode, type CapturedSurfaceProbe, probeHoverSurfaces } from "./vom/capture";
|
||||||
type CapturedNode,
|
import { captureObservationFacts, semanticCapture } from "./vom/capture-coordinator";
|
||||||
type CapturedSurfaceProbe,
|
import type { FrameDocument as CapturedFrameDocument } from "./vom/frame-document";
|
||||||
type CapturedViewModel,
|
|
||||||
captureViewModel,
|
|
||||||
collectOverlayExcludedBackendIds,
|
|
||||||
probeHoverSurfaces,
|
|
||||||
} from "./vom/capture";
|
|
||||||
import { type CapturedFrameDocument, captureFrameData } from "./vom/frame-capture";
|
|
||||||
import { withOverlayBypass } from "./vom/hover-perception";
|
import { withOverlayBypass } from "./vom/hover-perception";
|
||||||
import { probeTooltipNames } from "./vom/name-enrichment";
|
import { probeTooltipNames } from "./vom/name-enrichment";
|
||||||
import {
|
import {
|
||||||
@@ -197,15 +193,14 @@ async function captureElementScreenshot(
|
|||||||
if (isRpcError(geometry)) return geometry;
|
if (isRpcError(geometry)) return geometry;
|
||||||
if (signal?.aborted) return cancelled("screenshot");
|
if (signal?.aborted) return cancelled("screenshot");
|
||||||
const rect = geometry.topBounds;
|
const rect = geometry.topBounds;
|
||||||
|
const clip = screenshotPageRect(rect, geometry.topViewport);
|
||||||
|
if (!clip) return { code: "cdp_failed", message: "invalid screenshot coordinate space" };
|
||||||
|
|
||||||
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: {
|
||||||
x: rect.x,
|
...clip.rect,
|
||||||
y: rect.y,
|
|
||||||
width: rect.width,
|
|
||||||
height: rect.height,
|
|
||||||
scale: 1,
|
scale: 1,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -530,7 +525,7 @@ function buildActiveScopeBlocks(nodes: VomNode[], signals: VomNodeDomSignals): A
|
|||||||
|
|
||||||
function buildConditionalSurfaces(
|
function buildConditionalSurfaces(
|
||||||
nodes: VomNode[],
|
nodes: VomNode[],
|
||||||
captured: CapturedViewModel,
|
captured: CapturedSceneInput,
|
||||||
probes: CapturedSurfaceProbe[],
|
probes: CapturedSurfaceProbe[],
|
||||||
): CondSurface[] {
|
): CondSurface[] {
|
||||||
if (probes.length === 0) return [];
|
if (probes.length === 0) return [];
|
||||||
@@ -660,161 +655,9 @@ export interface BuildVomSceneOptions {
|
|||||||
|
|
||||||
export type VomFrameDocument = CapturedFrameDocument<CdpAxNode>;
|
export type VomFrameDocument = CapturedFrameDocument<CdpAxNode>;
|
||||||
|
|
||||||
function legacyFrameDocuments(
|
|
||||||
axNodes: CdpAxNode[],
|
|
||||||
captured: CapturedViewModel,
|
|
||||||
pageUrl?: string,
|
|
||||||
rootTarget: VomFrameDocument["target"] = { tabId: 0 },
|
|
||||||
): VomFrameDocument[] {
|
|
||||||
const rootFrameId = captured.rootFrameId ?? "root";
|
|
||||||
const documents: VomFrameDocument[] = [
|
|
||||||
{
|
|
||||||
frameId: rootFrameId,
|
|
||||||
contextScopeId: rootFrameId,
|
|
||||||
target: rootTarget,
|
|
||||||
...(pageUrl ? { url: pageUrl } : {}),
|
|
||||||
axNodes: [],
|
|
||||||
domNodes: captured.nodes.map((node) => ({ ...node, frameId: node.frameId ?? rootFrameId })),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
const pending = [...captured.iframeNodes.entries()];
|
|
||||||
let progress = true;
|
|
||||||
let nextSyntheticFrame = 1;
|
|
||||||
while (pending.length > 0 && progress) {
|
|
||||||
progress = false;
|
|
||||||
for (let index = pending.length - 1; index >= 0; index -= 1) {
|
|
||||||
const [ownerBackendNodeId, domNodes] = pending[index];
|
|
||||||
const parent = documents.find((document) =>
|
|
||||||
document.domNodes.some((node) => node.backendNodeId === ownerBackendNodeId),
|
|
||||||
);
|
|
||||||
if (!parent) continue;
|
|
||||||
const frameId =
|
|
||||||
domNodes.find((node) => node.frameId)?.frameId ?? `legacy-frame-${nextSyntheticFrame++}`;
|
|
||||||
documents.push({
|
|
||||||
frameId,
|
|
||||||
parentFrameId: parent.frameId,
|
|
||||||
ownerBackendNodeId,
|
|
||||||
contextScopeId: frameId,
|
|
||||||
target: parent.target,
|
|
||||||
axNodes: [],
|
|
||||||
domNodes: domNodes.map((node) => ({ ...node, frameId: node.frameId ?? frameId })),
|
|
||||||
});
|
|
||||||
pending.splice(index, 1);
|
|
||||||
progress = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const documentByFrameId = new Map(documents.map((document) => [document.frameId, document]));
|
|
||||||
const backendFrame = new Map<number, string>();
|
|
||||||
const childFrameByOwner = new Map<number, string>();
|
|
||||||
for (const document of documents) {
|
|
||||||
if (document.ownerBackendNodeId !== undefined) {
|
|
||||||
childFrameByOwner.set(document.ownerBackendNodeId, document.frameId);
|
|
||||||
}
|
|
||||||
for (const node of document.domNodes) backendFrame.set(node.backendNodeId, document.frameId);
|
|
||||||
}
|
|
||||||
const axById = new Map(axNodes.map((node) => [node.nodeId, node]));
|
|
||||||
const ownership = new Map<string, string>();
|
|
||||||
const resolving = new Set<string>();
|
|
||||||
const frameForAx = (node: CdpAxNode): string => {
|
|
||||||
const cached = ownership.get(node.nodeId);
|
|
||||||
if (cached) return cached;
|
|
||||||
let frameId: string | undefined;
|
|
||||||
if (node.frameId && documentByFrameId.has(node.frameId)) frameId = node.frameId;
|
|
||||||
if (!frameId && typeof node.backendDOMNodeId === "number") {
|
|
||||||
frameId = backendFrame.get(node.backendDOMNodeId);
|
|
||||||
}
|
|
||||||
if (!frameId && node.parentId && !resolving.has(node.nodeId)) {
|
|
||||||
const parent = axById.get(node.parentId);
|
|
||||||
if (parent) {
|
|
||||||
frameId =
|
|
||||||
typeof parent.backendDOMNodeId === "number"
|
|
||||||
? childFrameByOwner.get(parent.backendDOMNodeId)
|
|
||||||
: undefined;
|
|
||||||
if (!frameId) {
|
|
||||||
resolving.add(node.nodeId);
|
|
||||||
frameId = frameForAx(parent);
|
|
||||||
resolving.delete(node.nodeId);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
frameId ??= rootFrameId;
|
|
||||||
ownership.set(node.nodeId, frameId);
|
|
||||||
return frameId;
|
|
||||||
};
|
|
||||||
for (const node of axNodes) frameForAx(node);
|
|
||||||
for (const node of axNodes) {
|
|
||||||
const frameId = ownership.get(node.nodeId) ?? rootFrameId;
|
|
||||||
const document = documentByFrameId.get(frameId) ?? documents[0];
|
|
||||||
document.axNodes.push({
|
|
||||||
...node,
|
|
||||||
frameId,
|
|
||||||
...(node.parentId && ownership.get(node.parentId) === frameId
|
|
||||||
? { parentId: node.parentId }
|
|
||||||
: { parentId: undefined }),
|
|
||||||
...(node.childIds
|
|
||||||
? { childIds: node.childIds.filter((childId) => ownership.get(childId) === frameId) }
|
|
||||||
: {}),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return documents;
|
|
||||||
}
|
|
||||||
|
|
||||||
function withLegacyBackendIds(scene: VomScene): VomScene {
|
|
||||||
const used = new Set<number>();
|
|
||||||
const idMap = new Map<number, number>();
|
|
||||||
let nextVirtualId = -1;
|
|
||||||
for (const node of scene.nodes) {
|
|
||||||
const preferred = node.backendNodeId;
|
|
||||||
const id = preferred !== undefined && !used.has(preferred) ? preferred : nextVirtualId--;
|
|
||||||
used.add(id);
|
|
||||||
idMap.set(node.id, id);
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
...scene,
|
|
||||||
nodes: scene.nodes.map((node) => ({
|
|
||||||
...node,
|
|
||||||
id: idMap.get(node.id) as number,
|
|
||||||
parentId: node.parentId === null ? null : (idMap.get(node.parentId) ?? null),
|
|
||||||
...(node.domParentId !== undefined
|
|
||||||
? { domParentId: node.domParentId === null ? null : (idMap.get(node.domParentId) ?? null) }
|
|
||||||
: {}),
|
|
||||||
...(node.domAncestorIds
|
|
||||||
? { domAncestorIds: node.domAncestorIds.flatMap((id) => idMap.get(id) ?? []) }
|
|
||||||
: {}),
|
|
||||||
})),
|
|
||||||
...(scene.surfaces
|
|
||||||
? {
|
|
||||||
surfaces: scene.surfaces.map((surface) => ({
|
|
||||||
...surface,
|
|
||||||
triggerId: idMap.get(surface.triggerId) ?? surface.triggerId,
|
|
||||||
})),
|
|
||||||
}
|
|
||||||
: {}),
|
|
||||||
...(scene.activeScopeBlocks
|
|
||||||
? {
|
|
||||||
activeScopeBlocks: scene.activeScopeBlocks.map((block) => ({
|
|
||||||
...block,
|
|
||||||
triggerId: idMap.get(block.triggerId) ?? block.triggerId,
|
|
||||||
})),
|
|
||||||
}
|
|
||||||
: {}),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function buildVomScene(
|
|
||||||
axNodes: CdpAxNode[],
|
|
||||||
captured: CapturedViewModel,
|
|
||||||
options: BuildVomSceneOptions = {},
|
|
||||||
): VomScene {
|
|
||||||
return withLegacyBackendIds(
|
|
||||||
buildFrameVomScene(legacyFrameDocuments(axNodes, captured, options.pageUrl), captured, options),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function buildFrameVomScene(
|
export function buildFrameVomScene(
|
||||||
documents: VomFrameDocument[],
|
documents: VomFrameDocument[],
|
||||||
captured: CapturedViewModel,
|
captured: CapturedSceneInput,
|
||||||
options: BuildVomSceneOptions = {},
|
options: BuildVomSceneOptions = {},
|
||||||
): VomScene {
|
): VomScene {
|
||||||
const scene = buildSemanticVomScene({
|
const scene = buildSemanticVomScene({
|
||||||
@@ -830,7 +673,7 @@ export function buildFrameVomScene(
|
|||||||
function attachCapturedSceneAnnotations(
|
function attachCapturedSceneAnnotations(
|
||||||
scene: VomScene,
|
scene: VomScene,
|
||||||
documents: VomFrameDocument[],
|
documents: VomFrameDocument[],
|
||||||
captured: CapturedViewModel,
|
captured: CapturedSceneInput,
|
||||||
surfaceProbes: CapturedSurfaceProbe[],
|
surfaceProbes: CapturedSurfaceProbe[],
|
||||||
): VomScene {
|
): VomScene {
|
||||||
const rootDocument = documents.find((document) => document.frameId === scene.rootFrameId);
|
const rootDocument = documents.find((document) => document.frameId === scene.rootFrameId);
|
||||||
@@ -980,51 +823,6 @@ export async function handleGetHtml(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function emptyCapturedViewModel(viewport = { width: 0, height: 0 }): CapturedViewModel {
|
|
||||||
return { viewport, nodes: [], iframeNodes: new Map(), excludedBackendNodeIds: new Set() };
|
|
||||||
}
|
|
||||||
|
|
||||||
interface LayoutMetricsViewportReply {
|
|
||||||
cssLayoutViewport?: { clientWidth?: number; clientHeight?: number };
|
|
||||||
layoutViewport?: { clientWidth?: number; clientHeight?: number };
|
|
||||||
}
|
|
||||||
|
|
||||||
async function fallbackCapturedViewModel(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
signal?: AbortSignal,
|
|
||||||
): Promise<CapturedViewModel> {
|
|
||||||
throwIfAborted(signal, "observation");
|
|
||||||
let viewport = { width: 0, height: 0 };
|
|
||||||
try {
|
|
||||||
const metrics = await cdp.send<LayoutMetricsViewportReply>(tabId, "Page.getLayoutMetrics", {});
|
|
||||||
throwIfAborted(signal, "observation");
|
|
||||||
const source = metrics.cssLayoutViewport ?? metrics.layoutViewport ?? {};
|
|
||||||
viewport = {
|
|
||||||
width: source.clientWidth ?? 0,
|
|
||||||
height: source.clientHeight ?? 0,
|
|
||||||
};
|
|
||||||
} catch (error) {
|
|
||||||
if (isAbortError(error)) throw error;
|
|
||||||
}
|
|
||||||
const excludedBackendNodeIds = await collectOverlayExcludedBackendIds(cdp, tabId, signal);
|
|
||||||
throwIfAborted(signal, "observation");
|
|
||||||
return { ...emptyCapturedViewModel(viewport), excludedBackendNodeIds };
|
|
||||||
}
|
|
||||||
|
|
||||||
async function captureForVom(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
options: CaptureVomObservationOptions,
|
|
||||||
): Promise<CapturedViewModel> {
|
|
||||||
try {
|
|
||||||
return await captureViewModel(cdp, tabId, { signal: options.signal });
|
|
||||||
} catch (error) {
|
|
||||||
if (isAbortError(error)) throw error;
|
|
||||||
return fallbackCapturedViewModel(cdp, tabId, options.signal);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface HoverProbeOutcome {
|
export interface HoverProbeOutcome {
|
||||||
/** Whether any active hover was dispatched during this observation. */
|
/** Whether any active hover was dispatched during this observation. */
|
||||||
performed: boolean;
|
performed: boolean;
|
||||||
@@ -1057,7 +855,7 @@ const NO_HOVER_PROBES: HoverProbeOutcome = {
|
|||||||
async function runHoverProbes(
|
async function runHoverProbes(
|
||||||
cdp: CdpRunner,
|
cdp: CdpRunner,
|
||||||
tabId: number,
|
tabId: number,
|
||||||
captured: CapturedViewModel,
|
captured: CapturedSceneInput,
|
||||||
documents: VomFrameDocument[],
|
documents: VomFrameDocument[],
|
||||||
staticSemantics: ReturnType<typeof resolveSemanticGraph>,
|
staticSemantics: ReturnType<typeof resolveSemanticGraph>,
|
||||||
options: CaptureVomObservationOptions,
|
options: CaptureVomObservationOptions,
|
||||||
@@ -1096,14 +894,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 captured = await captureForVom(cdp, tabId, options);
|
const facts = await captureObservationFacts<CdpAxNode>(cdp, tabId, options.signal, url);
|
||||||
|
const { captured, documents: normalizedDocuments } = semanticCapture(facts);
|
||||||
throwIfAborted(options.signal, "observation");
|
throwIfAborted(options.signal, "observation");
|
||||||
const documents = await captureFrameData<CdpAxNode>(cdp, tabId, captured, options.signal);
|
|
||||||
throwIfAborted(options.signal, "observation");
|
|
||||||
const normalizedDocuments =
|
|
||||||
documents.length === 1 && captured.iframeNodes.size > 0
|
|
||||||
? legacyFrameDocuments(documents[0].axNodes, captured, url, documents[0].target)
|
|
||||||
: documents;
|
|
||||||
const semanticGraph = buildSemanticGraph({
|
const semanticGraph = buildSemanticGraph({
|
||||||
documents: normalizedDocuments,
|
documents: normalizedDocuments,
|
||||||
viewport: captured.viewport,
|
viewport: captured.viewport,
|
||||||
@@ -1131,12 +924,31 @@ export async function captureVomObservation(
|
|||||||
captured,
|
captured,
|
||||||
hoverProbes.surfaceProbes,
|
hoverProbes.surfaceProbes,
|
||||||
);
|
);
|
||||||
|
// Reserve space using the renderer's character-based token estimate. Like VOM
|
||||||
|
// headers, this integrity notice remains visible even under a tiny token budget.
|
||||||
|
const notices: string[] = [];
|
||||||
|
if (facts.issues.some((issue) => issue.stage === "geometry"))
|
||||||
|
notices.push(
|
||||||
|
"@warning geometry incomplete: some page or frame content has no top-level coordinates.",
|
||||||
|
);
|
||||||
|
const incompleteStages = ["dom", "ax", "forms", "ownership"].filter((stage) =>
|
||||||
|
facts.issues.some((issue) => issue.stage === stage),
|
||||||
|
);
|
||||||
|
if (incompleteStages.length)
|
||||||
|
notices.push(
|
||||||
|
`@warning observation incomplete: some ${incompleteStages.join(", ")} data is unavailable or omitted.`,
|
||||||
|
);
|
||||||
|
const captureNotice = notices.join("\n");
|
||||||
const rendered = renderVom(decoratedScene, {
|
const rendered = renderVom(decoratedScene, {
|
||||||
maxDepth: options.maxDepth,
|
maxDepth: options.maxDepth,
|
||||||
maxTokens: options.maxTokens,
|
maxTokens:
|
||||||
|
!captureNotice || options.maxTokens === undefined
|
||||||
|
? options.maxTokens
|
||||||
|
: Math.max(0, options.maxTokens - Math.ceil((captureNotice.length + 1) / 4)),
|
||||||
redactValues: options.redactValues,
|
redactValues: options.redactValues,
|
||||||
activeRegionPolicy: options.activeRegionPolicy,
|
activeRegionPolicy: options.activeRegionPolicy,
|
||||||
});
|
});
|
||||||
|
if (captureNotice) rendered.text += `\n${captureNotice}`;
|
||||||
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",
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,6 +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 { captureViewModel, collectOverlayExcludedBackendIds, probeHoverSurfaces } from "../capture";
|
import { collectOverlayExcludedBackendIds, probeHoverSurfaces } from "../capture";
|
||||||
|
import { captureObservationFacts, semanticCapture } from "../capture-coordinator";
|
||||||
|
|
||||||
// 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.
|
||||||
@@ -26,6 +27,7 @@ function fakeSnapshotReply() {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 2],
|
parentIndex: [-1, 0, 1, 2],
|
||||||
nodeType: [1, 1, 1, 1],
|
nodeType: [1, 1, 1, 1],
|
||||||
@@ -73,6 +75,7 @@ function hoverTriggerSnapshotReply() {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeType: [1, 1, 1],
|
nodeType: [1, 1, 1],
|
||||||
@@ -117,6 +120,7 @@ function twoHoverTriggerSnapshotReply() {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 1],
|
parentIndex: [-1, 0, 1, 1],
|
||||||
nodeType: [1, 1, 1, 1],
|
nodeType: [1, 1, 1, 1],
|
||||||
@@ -170,6 +174,7 @@ function nestedHoverTriggerSnapshotReply() {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 2, 3],
|
parentIndex: [-1, 0, 1, 2, 3],
|
||||||
nodeType: [1, 1, 1, 1, 1],
|
nodeType: [1, 1, 1, 1, 1],
|
||||||
@@ -210,7 +215,11 @@ function makeCdp(snapshot: unknown) {
|
|||||||
if (method === "DOMSnapshot.enable") return {};
|
if (method === "DOMSnapshot.enable") return {};
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 } };
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
|
};
|
||||||
}
|
}
|
||||||
if (method === "Runtime.evaluate") {
|
if (method === "Runtime.evaluate") {
|
||||||
return {
|
return {
|
||||||
@@ -243,13 +252,11 @@ function makeCdp(snapshot: unknown) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("captureViewModel", () => {
|
describe("snapshot capture and hover", () => {
|
||||||
it("parses nodes, attrs, rects, paint order and styles", async () => {
|
it("parses nodes, attrs, rects, paint order and styles", async () => {
|
||||||
const { nodes, viewport, iframeNodes } = await captureViewModel(
|
const { nodes, viewport } = semanticCapture(
|
||||||
makeCdp(fakeSnapshotReply()),
|
await captureObservationFacts(makeCdp(fakeSnapshotReply()), 4),
|
||||||
4,
|
).captured;
|
||||||
);
|
|
||||||
expect(iframeNodes.size).toBe(0);
|
|
||||||
expect(viewport).toEqual({ width: 1000, height: 800 });
|
expect(viewport).toEqual({ width: 1000, height: 800 });
|
||||||
const div = nodes.find((n) => n.backendNodeId === 12);
|
const div = nodes.find((n) => n.backendNodeId === 12);
|
||||||
expect(div).toMatchObject({ tag: "div", position: "fixed", parentBackendNodeId: 11 });
|
expect(div).toMatchObject({ tag: "div", position: "fixed", parentBackendNodeId: 11 });
|
||||||
@@ -261,35 +268,11 @@ describe("captureViewModel", () => {
|
|||||||
|
|
||||||
it("never hovers the page while capturing", async () => {
|
it("never hovers the page while capturing", async () => {
|
||||||
const cdp = makeCdp(fakeSnapshotReply());
|
const cdp = makeCdp(fakeSnapshotReply());
|
||||||
await captureViewModel(cdp, 4);
|
semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
|
|
||||||
expect(cdp.send).not.toHaveBeenCalledWith(4, "Input.dispatchMouseEvent", expect.anything());
|
expect(cdp.send).not.toHaveBeenCalledWith(4, "Input.dispatchMouseEvent", expect.anything());
|
||||||
});
|
});
|
||||||
|
|
||||||
it("batch-enriches form controls without per-node object resolution", async () => {
|
|
||||||
const cdp = makeCdp(fakeSnapshotReply());
|
|
||||||
const result = await captureViewModel(cdp, 4);
|
|
||||||
const input = result.nodes.find((node) => node.backendNodeId === 13);
|
|
||||||
|
|
||||||
expect(input).toMatchObject({
|
|
||||||
formState: "filled",
|
|
||||||
formPlaceholder: "secret",
|
|
||||||
attrs: { type: "password" },
|
|
||||||
});
|
|
||||||
expect(input?.formValue).toBeUndefined();
|
|
||||||
expect(input?.formDefaultValue).toBeUndefined();
|
|
||||||
expect(cdp.send).toHaveBeenCalledWith(
|
|
||||||
4,
|
|
||||||
"Runtime.evaluate",
|
|
||||||
expect.objectContaining({
|
|
||||||
serializationOptions: expect.objectContaining({ serialization: "deep" }),
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
expect(cdp.send).toHaveBeenCalledWith(4, "Runtime.releaseObjectGroup", expect.anything());
|
|
||||||
expect(cdp.send).not.toHaveBeenCalledWith(4, "DOM.resolveNode", expect.anything());
|
|
||||||
expect(cdp.send).not.toHaveBeenCalledWith(4, "Runtime.callFunctionOn", expect.anything());
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs hover surface probes when explicitly enabled", async () => {
|
it("runs hover surface probes when explicitly enabled", async () => {
|
||||||
let hoverStateCalls = 0;
|
let hoverStateCalls = 0;
|
||||||
const cdp = {
|
const cdp = {
|
||||||
@@ -298,6 +281,8 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return hoverTriggerSnapshotReply();
|
if (method === "DOMSnapshot.captureSnapshot") return hoverTriggerSnapshotReply();
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -329,7 +314,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 captured = await captureViewModel(cdp, 4);
|
const captured = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
const surfaceProbes = await probeHoverSurfaces(cdp, 4, captured.nodes);
|
const surfaceProbes = await probeHoverSurfaces(cdp, 4, captured.nodes);
|
||||||
|
|
||||||
expect(surfaceProbes).toEqual([
|
expect(surfaceProbes).toEqual([
|
||||||
@@ -361,6 +346,8 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return twoHoverTriggerSnapshotReply();
|
if (method === "DOMSnapshot.captureSnapshot") return twoHoverTriggerSnapshotReply();
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -389,7 +376,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 captured = await captureViewModel(cdp, 4);
|
const captured = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
const surfaceProbes = await probeHoverSurfaces(cdp, 4, captured.nodes);
|
const surfaceProbes = await probeHoverSurfaces(cdp, 4, captured.nodes);
|
||||||
|
|
||||||
expect(surfaceProbes).toEqual([
|
expect(surfaceProbes).toEqual([
|
||||||
@@ -409,6 +396,8 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return nestedHoverTriggerSnapshotReply();
|
if (method === "DOMSnapshot.captureSnapshot") return nestedHoverTriggerSnapshotReply();
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -434,7 +423,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 captured = await captureViewModel(cdp, 4);
|
const captured = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
await probeHoverSurfaces(cdp, 4, captured.nodes);
|
await probeHoverSurfaces(cdp, 4, captured.nodes);
|
||||||
|
|
||||||
expect(hoverMoves).toBe(1);
|
expect(hoverMoves).toBe(1);
|
||||||
@@ -466,6 +455,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 0, 3, 4],
|
parentIndex: [-1, 0, 1, 0, 3, 4],
|
||||||
nodeName: [i("html"), i("body"), i("div"), i(OVERLAY_HOST_NAME), i("div"), i("button")],
|
nodeName: [i("html"), i("body"), i("div"), i(OVERLAY_HOST_NAME), i("div"), i("button")],
|
||||||
@@ -496,7 +486,7 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
const { nodes } = await captureViewModel(makeCdp(snapshot), 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(makeCdp(snapshot), 4)).captured;
|
||||||
const ids = nodes.map((n) => n.backendNodeId);
|
const ids = nodes.map((n) => n.backendNodeId);
|
||||||
// Real page nodes survive.
|
// Real page nodes survive.
|
||||||
expect(ids).toContain(12);
|
expect(ids).toContain(12);
|
||||||
@@ -527,6 +517,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 0, 3, 4],
|
parentIndex: [-1, 0, 1, 0, 3, 4],
|
||||||
nodeName: [i("html"), i("body"), i("div"), i(OVERLAY_HOST_NAME), i("div"), i("button")],
|
nodeName: [i("html"), i("body"), i("div"), i(OVERLAY_HOST_NAME), i("div"), i("button")],
|
||||||
@@ -557,7 +548,9 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
const { excludedBackendNodeIds } = await captureViewModel(makeCdp(snapshot), 4);
|
const { excludedBackendNodeIds } = semanticCapture(
|
||||||
|
await captureObservationFacts(makeCdp(snapshot), 4),
|
||||||
|
).captured;
|
||||||
expect(excludedBackendNodeIds).toEqual(new Set([13, 14, 15]));
|
expect(excludedBackendNodeIds).toEqual(new Set([13, 14, 15]));
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -578,6 +571,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i(OVERLAY_HOST_NAME)],
|
nodeName: [i("html"), i("body"), i(OVERLAY_HOST_NAME)],
|
||||||
@@ -600,7 +594,9 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
const { nodes, excludedBackendNodeIds } = await captureViewModel(makeCdp(snapshot), 4);
|
const { nodes, excludedBackendNodeIds } = semanticCapture(
|
||||||
|
await captureObservationFacts(makeCdp(snapshot), 4),
|
||||||
|
).captured;
|
||||||
expect(nodes.map((n) => n.backendNodeId)).not.toContain(13);
|
expect(nodes.map((n) => n.backendNodeId)).not.toContain(13);
|
||||||
expect(excludedBackendNodeIds).toEqual(new Set([13]));
|
expect(excludedBackendNodeIds).toEqual(new Set([13]));
|
||||||
});
|
});
|
||||||
@@ -623,6 +619,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("div")],
|
nodeName: [i("html"), i("body"), i("div")],
|
||||||
@@ -645,7 +642,9 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
const { nodes, excludedBackendNodeIds } = await captureViewModel(makeCdp(snapshot), 4);
|
const { nodes, excludedBackendNodeIds } = semanticCapture(
|
||||||
|
await captureObservationFacts(makeCdp(snapshot), 4),
|
||||||
|
).captured;
|
||||||
expect(nodes.map((n) => n.backendNodeId)).not.toContain(13);
|
expect(nodes.map((n) => n.backendNodeId)).not.toContain(13);
|
||||||
expect(excludedBackendNodeIds).toEqual(new Set([13]));
|
expect(excludedBackendNodeIds).toEqual(new Set([13]));
|
||||||
});
|
});
|
||||||
@@ -668,6 +667,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("div")],
|
nodeName: [i("html"), i("body"), i("div")],
|
||||||
@@ -690,7 +690,7 @@ describe("captureViewModel", () => {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(makeCdp(snapshot), 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(makeCdp(snapshot), 4)).captured;
|
||||||
expect(nodes.find((n) => n.backendNodeId === 12)?.cursor).toBe("pointer");
|
expect(nodes.find((n) => n.backendNodeId === 12)?.cursor).toBe("pointer");
|
||||||
expect(nodes.find((n) => n.backendNodeId === 11)?.cursor).toBe("auto");
|
expect(nodes.find((n) => n.backendNodeId === 11)?.cursor).toBe("auto");
|
||||||
});
|
});
|
||||||
@@ -702,6 +702,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1, 1, 1],
|
parentIndex: [-1, 0, 1, 1, 1],
|
||||||
nodeName: [i("html"), i("body"), i("button"), i("button"), i("button")],
|
nodeName: [i("html"), i("body"), i("button"), i("button"), i("button")],
|
||||||
@@ -728,7 +729,7 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
const { nodes } = await captureViewModel(makeCdp(snapshot), 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(makeCdp(snapshot), 4)).captured;
|
||||||
|
|
||||||
expect(nodes.find((node) => node.backendNodeId === 12)?.rendered).toBe(true);
|
expect(nodes.find((node) => node.backendNodeId === 12)?.rendered).toBe(true);
|
||||||
expect(nodes.find((node) => node.backendNodeId === 13)?.rendered).toBe(false);
|
expect(nodes.find((node) => node.backendNodeId === 13)?.rendered).toBe(false);
|
||||||
@@ -742,25 +743,28 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return fakeSnapshotReply();
|
if (method === "DOMSnapshot.captureSnapshot") return fakeSnapshotReply();
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 200 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 200 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
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>,
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(cdp, 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
const div = nodes.find((n) => n.backendNodeId === 12);
|
const div = nodes.find((n) => n.backendNodeId === 12);
|
||||||
expect(div?.localRect?.y).toBe(-200);
|
expect(div?.localRect?.y).toBe(-200);
|
||||||
expect(div?.rect).toMatchObject({ y: 0, h: 600 });
|
expect(div?.rect).toMatchObject({ y: 0, h: 600 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("normalizes device-pixel bounds by devicePixelRatio", async () => {
|
it("normalizes raw snapshot bounds before viewport clipping", 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 = {
|
||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("div")],
|
nodeName: [i("html"), i("body"), i("div")],
|
||||||
@@ -788,6 +792,8 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 2000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
layoutViewport: { clientWidth: 2000, clientHeight: 1600 },
|
layoutViewport: { clientWidth: 2000, clientHeight: 1600 },
|
||||||
};
|
};
|
||||||
@@ -795,13 +801,19 @@ describe("captureViewModel", () => {
|
|||||||
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>,
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(cdp, 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
expect(nodes.find((n) => n.backendNodeId === 12)?.rect).toEqual({
|
expect(nodes.find((n) => n.backendNodeId === 12)?.rect).toEqual({
|
||||||
x: 0,
|
x: 0,
|
||||||
y: 0,
|
y: 0,
|
||||||
w: 1000,
|
w: 1000,
|
||||||
h: 800,
|
h: 800,
|
||||||
});
|
});
|
||||||
|
expect(nodes.find((n) => n.backendNodeId === 12)?.localRect).toEqual({
|
||||||
|
x: 0,
|
||||||
|
y: 0,
|
||||||
|
w: 1000,
|
||||||
|
h: 800,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("extracts textContent from #text child nodes via nodeValue", async () => {
|
it("extracts textContent from #text child nodes via nodeValue", async () => {
|
||||||
@@ -825,6 +837,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
scrollOffsetX: 0,
|
scrollOffsetX: 0,
|
||||||
scrollOffsetY: 0,
|
scrollOffsetY: 0,
|
||||||
nodes: {
|
nodes: {
|
||||||
@@ -857,13 +870,15 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
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>,
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(cdp, 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
const btn = nodes.find((n) => n.backendNodeId === 12);
|
const btn = nodes.find((n) => n.backendNodeId === 12);
|
||||||
expect(btn?.textContent).toBe("登录");
|
expect(btn?.textContent).toBe("登录");
|
||||||
const link = nodes.find((n) => n.backendNodeId === 14);
|
const link = nodes.find((n) => n.backendNodeId === 14);
|
||||||
@@ -873,7 +888,7 @@ describe("captureViewModel", () => {
|
|||||||
expect(body?.textContent).toBeUndefined();
|
expect(body?.textContent).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("parses iframe sub-documents and returns iframeNodes keyed by iframe backendNodeId", async () => {
|
it("retains explicit iframe document ownership and projected nodes", async () => {
|
||||||
const S = [
|
const S = [
|
||||||
"html",
|
"html",
|
||||||
"body",
|
"body",
|
||||||
@@ -947,39 +962,38 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
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>,
|
||||||
};
|
};
|
||||||
const {
|
const facts = await captureObservationFacts(cdp, 4);
|
||||||
nodes,
|
const root = facts.documents.find((doc) => doc.frame.frameId === "main-frame")!;
|
||||||
iframeNodes,
|
const child = facts.documents.find((doc) => doc.frame.frameId === "child-frame")!;
|
||||||
frameNodes,
|
expect(facts.documents).toHaveLength(2);
|
||||||
frameOwnerBackendNodeIds,
|
expect(root.domNodes.find((n) => n.backendNodeId === 13)?.tag).toBe("iframe");
|
||||||
frameParentIds,
|
const subNodes = child.domNodes;
|
||||||
rootFrameId,
|
|
||||||
} = await captureViewModel(cdp, 4);
|
|
||||||
// Main frame has 4 nodes; iframe is included
|
|
||||||
expect(nodes.find((n) => n.backendNodeId === 13)?.tag).toBe("iframe");
|
|
||||||
// iframeNodes keyed by the <iframe> element's backendNodeId=13
|
|
||||||
expect(iframeNodes.size).toBe(1);
|
|
||||||
expect(iframeNodes.has(13)).toBe(true);
|
|
||||||
const subNodes = iframeNodes.get(13)!;
|
|
||||||
const input = subNodes.find((n) => n.backendNodeId === 101);
|
const input = subNodes.find((n) => n.backendNodeId === 101);
|
||||||
expect(input?.tag).toBe("input");
|
expect(input?.tag).toBe("input");
|
||||||
expect(input?.attrs.type).toBe("text");
|
expect(input?.attrs.type).toBe("text");
|
||||||
expect(input?.ownerFrameBackendNodeId).toBe(13);
|
expect(input?.ownerFrameBackendNodeId).toBe(13);
|
||||||
expect(input?.localRect).toEqual({ x: 0, y: 0, w: 200, h: 40 });
|
expect(input?.localRect).toEqual({ x: 0, y: 0, w: 200, h: 40 });
|
||||||
expect(input?.rect).toEqual({ x: 100, y: 300, w: 200, h: 40 });
|
expect(input?.rect).toEqual({ x: 100, y: 300, w: 200, h: 40 });
|
||||||
expect(rootFrameId).toBe("main-frame");
|
expect(facts.rootFrameId).toBe("main-frame");
|
||||||
expect(frameNodes?.get("child-frame")).toBe(subNodes);
|
expect(child.frame.ownerBackendNodeId).toBe(13);
|
||||||
expect(frameOwnerBackendNodeIds?.get("child-frame")).toBe(13);
|
expect(child.frame.parentFrameId).toBe("main-frame");
|
||||||
expect(frameParentIds?.get("child-frame")).toBe("main-frame");
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("captures iframe documents without requiring owner-frame geometry", async () => {
|
it("projects iframe documents independently of owner snapshot geometry", async () => {
|
||||||
const S = [
|
const S = [
|
||||||
"html",
|
"html",
|
||||||
"body",
|
"body",
|
||||||
@@ -997,6 +1011,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
scrollOffsetX: 0,
|
scrollOffsetX: 0,
|
||||||
scrollOffsetY: 0,
|
scrollOffsetY: 0,
|
||||||
nodes: {
|
nodes: {
|
||||||
@@ -1014,6 +1029,7 @@ describe("captureViewModel", () => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
frameId: "child",
|
||||||
scrollOffsetX: 0,
|
scrollOffsetX: 0,
|
||||||
scrollOffsetY: 0,
|
scrollOffsetY: 0,
|
||||||
nodes: {
|
nodes: {
|
||||||
@@ -1037,18 +1053,28 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
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>,
|
||||||
};
|
};
|
||||||
|
|
||||||
const { iframeNodes } = await captureViewModel(cdp, 4);
|
const { documents } = await captureObservationFacts(cdp, 4);
|
||||||
const input = iframeNodes.get(13)?.find((n) => n.backendNodeId === 101);
|
const input = documents
|
||||||
|
.find((doc) => doc.frame.frameId === "child")
|
||||||
|
?.domNodes?.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).toBeNull();
|
expect(input?.rect).toEqual({ x: 120, y: 320, w: 120, h: 60 });
|
||||||
});
|
});
|
||||||
|
|
||||||
it("recursively normalizes nested iframe sub-documents", async () => {
|
it("recursively normalizes nested iframe sub-documents", async () => {
|
||||||
@@ -1069,6 +1095,7 @@ describe("captureViewModel", () => {
|
|||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("iframe")],
|
nodeName: [i("html"), i("body"), i("iframe")],
|
||||||
@@ -1090,6 +1117,9 @@ describe("captureViewModel", () => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
scrollOffsetX: 0,
|
||||||
|
scrollOffsetY: 0,
|
||||||
|
frameId: "child",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("iframe")],
|
nodeName: [i("html"), i("body"), i("iframe")],
|
||||||
@@ -1111,6 +1141,9 @@ describe("captureViewModel", () => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
scrollOffsetX: 0,
|
||||||
|
scrollOffsetY: 0,
|
||||||
|
frameId: "nested",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0],
|
parentIndex: [-1, 0],
|
||||||
nodeName: [i("body"), i("input")],
|
nodeName: [i("body"), i("input")],
|
||||||
@@ -1127,21 +1160,54 @@ describe("captureViewModel", () => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
const cdp = {
|
const cdp = {
|
||||||
send: vi.fn(async (_t: number, method: string) => {
|
send: vi.fn(
|
||||||
if (method === "DOMSnapshot.enable") return {};
|
async (
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
_t: number,
|
||||||
if (method === "Page.getLayoutMetrics") {
|
method: string,
|
||||||
return {
|
params?: { backendNodeId?: number; objectId?: string },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 0 },
|
) => {
|
||||||
};
|
if (method === "DOMSnapshot.enable") return {};
|
||||||
}
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
throw new Error(method);
|
if (method === "Page.getLayoutMetrics") {
|
||||||
}) as unknown as <T>(tabId: number, method: string, params?: object) => Promise<T>,
|
return {
|
||||||
|
visualViewport: { clientWidth: 1000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
|
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 { documents } = await captureObservationFacts(cdp, 4);
|
||||||
const nestedIframe = iframeNodes.get(13)?.find((n) => n.backendNodeId === 23);
|
const nestedIframe = documents
|
||||||
const input = iframeNodes.get(23)?.find((n) => n.backendNodeId === 31);
|
.find((doc) => doc.frame.frameId === "child")
|
||||||
|
?.domNodes?.find((n) => n.backendNodeId === 23);
|
||||||
|
const input = documents
|
||||||
|
.find((doc) => doc.frame.frameId === "nested")
|
||||||
|
?.domNodes?.find((n) => n.backendNodeId === 31);
|
||||||
|
|
||||||
expect(nestedIframe?.localRect).toEqual({ x: 5, y: 6, w: 100, h: 80 });
|
expect(nestedIframe?.localRect).toEqual({ x: 5, y: 6, w: 100, h: 80 });
|
||||||
expect(nestedIframe?.rect).toEqual({ x: 15, y: 26, w: 100, h: 80 });
|
expect(nestedIframe?.rect).toEqual({ x: 15, y: 26, w: 100, h: 80 });
|
||||||
@@ -1150,13 +1216,14 @@ 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("normalizes bounds then subtracts CSS scroll at dpr>1", async () => {
|
it("subtracts CSS scroll once without dividing snapshot bounds by a metrics ratio", 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 = {
|
||||||
strings: S,
|
strings: S,
|
||||||
documents: [
|
documents: [
|
||||||
{
|
{
|
||||||
|
frameId: "root",
|
||||||
nodes: {
|
nodes: {
|
||||||
parentIndex: [-1, 0, 1],
|
parentIndex: [-1, 0, 1],
|
||||||
nodeName: [i("html"), i("body"), i("div")],
|
nodeName: [i("html"), i("body"), i("div")],
|
||||||
@@ -1184,6 +1251,8 @@ describe("captureViewModel", () => {
|
|||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
if (method === "DOMSnapshot.captureSnapshot") return snapshot;
|
||||||
if (method === "Page.getLayoutMetrics") {
|
if (method === "Page.getLayoutMetrics") {
|
||||||
return {
|
return {
|
||||||
|
visualViewport: { clientWidth: 2000 },
|
||||||
|
cssVisualViewport: { clientWidth: 1000 },
|
||||||
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 100 },
|
cssLayoutViewport: { clientWidth: 1000, clientHeight: 800, pageX: 0, pageY: 100 },
|
||||||
layoutViewport: { clientWidth: 2000, clientHeight: 1600 },
|
layoutViewport: { clientWidth: 2000, clientHeight: 1600 },
|
||||||
};
|
};
|
||||||
@@ -1191,7 +1260,7 @@ describe("captureViewModel", () => {
|
|||||||
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>,
|
||||||
};
|
};
|
||||||
const { nodes } = await captureViewModel(cdp, 4);
|
const { nodes } = semanticCapture(await captureObservationFacts(cdp, 4)).captured;
|
||||||
expect(nodes.find((n) => n.backendNodeId === 12)?.rect?.y).toBe(400 / 2 - 100);
|
expect(nodes.find((n) => n.backendNodeId === 12)?.rect?.y).toBe(400 / 2 - 100);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,127 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { OVERLAY_HOST_MARKER_ATTR } from "@/lib/overlay-bridge";
|
||||||
|
import { createCaptureCheckpoint } from "../capture-abort";
|
||||||
|
import { buildDocumentIndex, type DecodedNode } from "../facts";
|
||||||
|
import { decodeDocument, REQUESTED_STYLES } from "../snapshot";
|
||||||
|
|
||||||
|
function node(id: number, parent: number | null): DecodedNode {
|
||||||
|
return {
|
||||||
|
backendNodeId: id,
|
||||||
|
parentBackendNodeId: parent,
|
||||||
|
tag: "div",
|
||||||
|
attrs: {},
|
||||||
|
paintOrder: 0,
|
||||||
|
position: "static",
|
||||||
|
pointerEvents: "auto",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("document facts", () => {
|
||||||
|
it.each([
|
||||||
|
1_000, 10_000, 100_000,
|
||||||
|
])("indexes deep and wide inputs of %i without copying ancestors", async (count) => {
|
||||||
|
for (const wide of [false, true]) {
|
||||||
|
let reads = 0;
|
||||||
|
const input = Array.from({ length: count }, (_, i) => {
|
||||||
|
const item = node(i, i ? (wide ? 0 : i - 1) : null);
|
||||||
|
if (i === 0) item.attrs[OVERLAY_HOST_MARKER_ATTR] = "";
|
||||||
|
Object.defineProperty(item, "parentBackendNodeId", {
|
||||||
|
get: () => {
|
||||||
|
reads++;
|
||||||
|
return i ? (wide ? 0 : i - 1) : null;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return item;
|
||||||
|
}).reverse(); // parent need not precede child
|
||||||
|
const index = await buildDocumentIndex(input);
|
||||||
|
expect(index.nodes.size).toBe(count);
|
||||||
|
expect(index.excludedBackendNodeIds.size).toBe(count);
|
||||||
|
expect(reads).toBeLessThanOrEqual(count * 8);
|
||||||
|
expect(index.nodes.get(count - 1)).toBe(input[0]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("handles cycles and orphans and propagates overlay through shadow roots", async () => {
|
||||||
|
const host = { ...node(1, null), attrs: { [OVERLAY_HOST_MARKER_ATTR]: "" } };
|
||||||
|
const input = [
|
||||||
|
node(3, 2),
|
||||||
|
{ ...node(2, 1), tag: "#document-fragment" },
|
||||||
|
host,
|
||||||
|
node(4, 99),
|
||||||
|
node(5, 6),
|
||||||
|
node(6, 5),
|
||||||
|
node(7, 6),
|
||||||
|
];
|
||||||
|
const index = await buildDocumentIndex(input);
|
||||||
|
expect([...index.excludedBackendNodeIds].sort()).toEqual([1, 2, 3]);
|
||||||
|
expect(index.nodes.size).toBe(input.length);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not propagate a descendant overlay backwards into a cycle", async () => {
|
||||||
|
const overlay = { ...node(3, 1), attrs: { [OVERLAY_HOST_MARKER_ATTR]: "" } };
|
||||||
|
const index = await buildDocumentIndex([overlay, node(1, 2), node(2, 1)]);
|
||||||
|
expect([...index.excludedBackendNodeIds]).toEqual([3]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("decodes current observation bounds, styles and attributes without projecting coordinates", async () => {
|
||||||
|
const strings = ["div", "aria-hidden", "true", "inert", "", "visible", "0", "static", "auto"];
|
||||||
|
const styles = REQUESTED_STYLES.map((style) =>
|
||||||
|
style === "visibility" ? 5 : style === "opacity" ? 6 : style === "position" ? 7 : 8,
|
||||||
|
);
|
||||||
|
const { nodes } = await decodeDocument(
|
||||||
|
{
|
||||||
|
nodes: { backendNodeId: [1], parentIndex: [-1], nodeName: [0], attributes: [[1, 2, 3, 4]] },
|
||||||
|
layout: { nodeIndex: [0], bounds: [[10, 20, 120, 40]], styles: [styles] },
|
||||||
|
},
|
||||||
|
strings,
|
||||||
|
);
|
||||||
|
expect(nodes[0].attrs).toEqual({ "aria-hidden": "true", inert: "" });
|
||||||
|
expect(nodes[0].layout).toEqual({
|
||||||
|
boundsSpace: "snapshot-document-layout",
|
||||||
|
bounds: [10, 20, 120, 40],
|
||||||
|
styles: {
|
||||||
|
position: "static",
|
||||||
|
"pointer-events": "auto",
|
||||||
|
cursor: "auto",
|
||||||
|
visibility: "visible",
|
||||||
|
opacity: "0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(nodes[0]).not.toHaveProperty("rect");
|
||||||
|
expect(nodes[0]).not.toHaveProperty("excluded");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps short blocks synchronous and checks cancellation after yielding", async () => {
|
||||||
|
const clock = vi.spyOn(performance, "now").mockReturnValue(0);
|
||||||
|
try {
|
||||||
|
const controller = new AbortController();
|
||||||
|
const checkpoint = createCaptureCheckpoint(controller.signal);
|
||||||
|
for (let i = 0; i < 20; i++) expect(checkpoint()).toBeUndefined();
|
||||||
|
clock.mockReturnValue(9);
|
||||||
|
const pending = checkpoint();
|
||||||
|
expect(pending).toBeInstanceOf(Promise);
|
||||||
|
controller.abort();
|
||||||
|
await expect(pending).rejects.toMatchObject({ name: "AbortError" });
|
||||||
|
} finally {
|
||||||
|
clock.mockRestore();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("checks cancellation at bounded indexing blocks", async () => {
|
||||||
|
const controller = new AbortController();
|
||||||
|
const input = Array.from({ length: 100_000 }, (_, i) => node(i, i ? i - 1 : null));
|
||||||
|
let reads = 0;
|
||||||
|
for (const item of input)
|
||||||
|
Object.defineProperty(item, "attrs", {
|
||||||
|
get: () => {
|
||||||
|
reads++;
|
||||||
|
if (reads === 100) controller.abort();
|
||||||
|
return {};
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await expect(buildDocumentIndex(input, controller.signal)).rejects.toMatchObject({
|
||||||
|
name: "AbortError",
|
||||||
|
});
|
||||||
|
expect(reads).toBeLessThanOrEqual(356);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import { type CdpRunner, cdpRunnerForTarget } from "../../shared";
|
import { type CdpRunner, cdpRunnerForTarget } from "../../shared";
|
||||||
import { captureViewModel } from "../capture";
|
import { enrichFormControlStates } from "../form-capture";
|
||||||
|
import { decodeDocument } from "../snapshot";
|
||||||
|
|
||||||
interface Control {
|
interface Control {
|
||||||
id: number;
|
id: number;
|
||||||
@@ -77,21 +78,32 @@ function reply(entries: Array<[number, unknown]>) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function fakeCdp(groups: Control[][], evaluate: (params: Record<string, unknown>) => unknown) {
|
async function fakeCdp(
|
||||||
|
groups: Control[][],
|
||||||
|
evaluate: (params: Record<string, unknown>) => unknown,
|
||||||
|
) {
|
||||||
const snap = snapshot(groups);
|
const snap = snapshot(groups);
|
||||||
const send = vi.fn(async (_tabId: number, method: string, params?: object) => {
|
const send = vi.fn(async (_tabId: number, method: string, params?: object) => {
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snap;
|
|
||||||
if (method === "Runtime.evaluate") return evaluate(params as Record<string, unknown>);
|
if (method === "Runtime.evaluate") return evaluate(params as Record<string, unknown>);
|
||||||
return {};
|
return {};
|
||||||
});
|
});
|
||||||
return { send, cdp: { send: send as CdpRunner["send"] } };
|
const nodes = await decodeControls(snap);
|
||||||
|
return { send, cdp: { send: send as CdpRunner["send"] }, nodes };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function decodeControls(snap: ReturnType<typeof snapshot>) {
|
||||||
|
return Promise.all(
|
||||||
|
snap.documents.map(async (doc) =>
|
||||||
|
(await decodeDocument(doc, snap.strings)).nodes.map((node) => ({ ...node, rect: null })),
|
||||||
|
),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("form state identity", () => {
|
describe("form state identity", () => {
|
||||||
it("matches reordered controls by identity and preserves controls missing from the batch", async () => {
|
it("matches reordered controls by identity and preserves controls missing from the batch", async () => {
|
||||||
// The snapshot includes a shadow input. The runtime query skips it,
|
// The snapshot includes a shadow input. The runtime query skips it,
|
||||||
// encounters a new input, and sees the remaining inputs in a new order.
|
// encounters a new input, and sees the remaining inputs in a new order.
|
||||||
const { cdp } = fakeCdp(
|
const { cdp, nodes } = await fakeCdp(
|
||||||
[
|
[
|
||||||
[
|
[
|
||||||
{ id: 10, value: "" },
|
{ id: 10, value: "" },
|
||||||
@@ -106,21 +118,21 @@ describe("form state identity", () => {
|
|||||||
[11, state("alice@example.com")],
|
[11, state("alice@example.com")],
|
||||||
]),
|
]),
|
||||||
);
|
);
|
||||||
const captured = await captureViewModel(cdp, 7);
|
await enrichFormControlStates(cdp, 7, nodes);
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 10)).toMatchObject({
|
expect(nodes[0].find((n) => n.backendNodeId === 10)).toMatchObject({
|
||||||
formValue: "",
|
formValue: "",
|
||||||
formState: "empty",
|
formState: "empty",
|
||||||
formPlaceholder: "snapshot placeholder",
|
formPlaceholder: "snapshot placeholder",
|
||||||
});
|
});
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 11)).toMatchObject({
|
expect(nodes[0].find((n) => n.backendNodeId === 11)).toMatchObject({
|
||||||
formValue: "alice@example.com",
|
formValue: "alice@example.com",
|
||||||
});
|
});
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 12)).toMatchObject({ formValue: "上海" });
|
expect(nodes[0].find((n) => n.backendNodeId === 12)).toMatchObject({ formValue: "上海" });
|
||||||
expect(captured.nodes.some((n) => n.backendNodeId === 99)).toBe(false);
|
expect(nodes[0].some((n) => n.backendNodeId === 99)).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("does not shift state between frames when one frame is absent from the runtime batch", async () => {
|
it("does not shift state between frames when one frame is absent from the runtime batch", async () => {
|
||||||
const { cdp } = fakeCdp(
|
const { cdp, nodes } = await fakeCdp(
|
||||||
[
|
[
|
||||||
[],
|
[],
|
||||||
[{ id: 11, value: "inaccessible frame" }],
|
[{ id: 11, value: "inaccessible frame" }],
|
||||||
@@ -133,8 +145,8 @@ describe("form state identity", () => {
|
|||||||
[21, state("second frame")],
|
[21, state("second frame")],
|
||||||
]),
|
]),
|
||||||
);
|
);
|
||||||
const captured = await captureViewModel(cdp, 7);
|
await enrichFormControlStates(cdp, 7, nodes);
|
||||||
const controls = [...captured.iframeNodes.values()].flat();
|
const controls = nodes.slice(1).flat();
|
||||||
expect(controls.find((n) => n.backendNodeId === 11)?.formValue).toBe("inaccessible frame");
|
expect(controls.find((n) => n.backendNodeId === 11)?.formValue).toBe("inaccessible frame");
|
||||||
expect(controls.find((n) => n.backendNodeId === 21)?.formValue).toBe("second frame");
|
expect(controls.find((n) => n.backendNodeId === 21)?.formValue).toBe("second frame");
|
||||||
expect(controls.find((n) => n.backendNodeId === 31)?.formValue).toBe("third frame");
|
expect(controls.find((n) => n.backendNodeId === 31)?.formValue).toBe("third frame");
|
||||||
@@ -142,7 +154,6 @@ describe("form state identity", () => {
|
|||||||
|
|
||||||
it("keeps identical backend ids in different OOPIF targets separate", async () => {
|
it("keeps identical backend ids in different OOPIF targets separate", async () => {
|
||||||
const sendToTarget = vi.fn(async (target, method) => {
|
const sendToTarget = vi.fn(async (target, method) => {
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return snapshot([[{ id: 11, value: "old" }]]);
|
|
||||||
if (method === "Runtime.evaluate") return reply([[11, state(target.sessionId)]]);
|
if (method === "Runtime.evaluate") return reply([[11, state(target.sessionId)]]);
|
||||||
return {};
|
return {};
|
||||||
});
|
});
|
||||||
@@ -151,8 +162,9 @@ describe("form state identity", () => {
|
|||||||
});
|
});
|
||||||
const cdp = { send, sendToTarget } as unknown as CdpRunner;
|
const cdp = { send, sendToTarget } as unknown as CdpRunner;
|
||||||
for (const sessionId of ["left-frame", "right-frame"]) {
|
for (const sessionId of ["left-frame", "right-frame"]) {
|
||||||
const captured = await captureViewModel(cdpRunnerForTarget(cdp, { tabId: 7, sessionId }), 7);
|
const nodes = await decodeControls(snapshot([[{ id: 11, value: "old" }]]));
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 11)?.formValue).toBe(sessionId);
|
await enrichFormControlStates(cdpRunnerForTarget(cdp, { tabId: 7, sessionId }), 7, nodes);
|
||||||
|
expect(nodes[0].find((n) => n.backendNodeId === 11)?.formValue).toBe(sessionId);
|
||||||
expect(sendToTarget).toHaveBeenCalledWith(
|
expect(sendToTarget).toHaveBeenCalledWith(
|
||||||
{ tabId: 7, sessionId },
|
{ tabId: 7, sessionId },
|
||||||
"Runtime.releaseObjectGroup",
|
"Runtime.releaseObjectGroup",
|
||||||
@@ -168,7 +180,7 @@ describe("form state identity", () => {
|
|||||||
"malformed",
|
"malformed",
|
||||||
"invalid-state",
|
"invalid-state",
|
||||||
])("preserves snapshot data when enrichment is %s", async (mode) => {
|
])("preserves snapshot data when enrichment is %s", async (mode) => {
|
||||||
const { cdp, send } = fakeCdp([[{ id: 11, value: "snapshot value" }]], () => {
|
const { cdp, send, nodes } = await fakeCdp([[{ id: 11, value: "snapshot value" }]], () => {
|
||||||
if (mode === "unsupported") throw new Error("serialization unsupported");
|
if (mode === "unsupported") throw new Error("serialization unsupported");
|
||||||
if (mode === "legacy") return { result: { value: { controls: [state("wrong value")] } } };
|
if (mode === "legacy") return { result: { value: { controls: [state("wrong value")] } } };
|
||||||
const result = reply([
|
const result = reply([
|
||||||
@@ -178,8 +190,8 @@ describe("form state identity", () => {
|
|||||||
result.result.deepSerializedValue.value[0].value[1].value = "not json";
|
result.result.deepSerializedValue.value[0].value[1].value = "not json";
|
||||||
return result;
|
return result;
|
||||||
});
|
});
|
||||||
const captured = await captureViewModel(cdp, 7);
|
expect(await enrichFormControlStates(cdp, 7, nodes)).toBe(mode !== "unsupported");
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 11)).toMatchObject({
|
expect(nodes[0].find((n) => n.backendNodeId === 11)).toMatchObject({
|
||||||
formValue: "snapshot value",
|
formValue: "snapshot value",
|
||||||
formPlaceholder: "snapshot placeholder",
|
formPlaceholder: "snapshot placeholder",
|
||||||
});
|
});
|
||||||
@@ -188,18 +200,34 @@ describe("form state identity", () => {
|
|||||||
|
|
||||||
it("releases the batch's remote objects when capture is cancelled", async () => {
|
it("releases the batch's remote objects when capture is cancelled", async () => {
|
||||||
const controller = new AbortController();
|
const controller = new AbortController();
|
||||||
const { cdp, send } = fakeCdp([[{ id: 11, value: "old" }]], () => {
|
const { cdp, send, nodes } = await fakeCdp([[{ id: 11, value: "old" }]], () => {
|
||||||
controller.abort();
|
controller.abort();
|
||||||
return reply([[11, state("new")]]);
|
return reply([[11, state("new")]]);
|
||||||
});
|
});
|
||||||
await expect(captureViewModel(cdp, 7, { signal: controller.signal })).rejects.toMatchObject({
|
await expect(enrichFormControlStates(cdp, 7, nodes, controller.signal)).rejects.toMatchObject({
|
||||||
name: "AbortError",
|
name: "AbortError",
|
||||||
});
|
});
|
||||||
expect(send).toHaveBeenCalledWith(7, "Runtime.releaseObjectGroup", expect.anything());
|
expect(send).toHaveBeenCalledWith(7, "Runtime.releaseObjectGroup", expect.anything());
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("does not report success when cancelled during object cleanup", async () => {
|
||||||
|
const controller = new AbortController();
|
||||||
|
const nodes = await decodeControls(snapshot([[{ id: 11, value: "old" }]]));
|
||||||
|
const cdp: CdpRunner = {
|
||||||
|
send: vi.fn(async (_tabId, method) => {
|
||||||
|
if (method === "Runtime.evaluate") return reply([[11, state("new")]]);
|
||||||
|
if (method === "Runtime.releaseObjectGroup") controller.abort();
|
||||||
|
return {};
|
||||||
|
}) as CdpRunner["send"],
|
||||||
|
};
|
||||||
|
await expect(enrichFormControlStates(cdp, 7, nodes, controller.signal)).rejects.toMatchObject({
|
||||||
|
name: "AbortError",
|
||||||
|
});
|
||||||
|
expect(cdp.send).toHaveBeenCalledWith(7, "Runtime.releaseObjectGroup", expect.anything());
|
||||||
|
});
|
||||||
|
|
||||||
it("skips entries without node identity while still applying valid entries", async () => {
|
it("skips entries without node identity while still applying valid entries", async () => {
|
||||||
const { cdp } = fakeCdp(
|
const { cdp, nodes } = await fakeCdp(
|
||||||
[
|
[
|
||||||
[
|
[
|
||||||
{ id: 11, value: "snapshot value" },
|
{ id: 11, value: "snapshot value" },
|
||||||
@@ -216,20 +244,20 @@ describe("form state identity", () => {
|
|||||||
return result;
|
return result;
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
const captured = await captureViewModel(cdp, 7);
|
await enrichFormControlStates(cdp, 7, nodes);
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 11)?.formValue).toBe("snapshot value");
|
expect(nodes[0].find((n) => n.backendNodeId === 11)?.formValue).toBe("snapshot value");
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 12)?.formValue).toBe("live value");
|
expect(nodes[0].find((n) => n.backendNodeId === 12)?.formValue).toBe("live value");
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
"password",
|
"password",
|
||||||
"text",
|
"text",
|
||||||
])("redacts a sensitive %s control after identity matching", async (type) => {
|
])("redacts a sensitive %s control after identity matching", async (type) => {
|
||||||
const { cdp } = fakeCdp([[{ id: 11, value: "secret", type }]], () =>
|
const { cdp, nodes } = await fakeCdp([[{ id: 11, value: "secret", type }]], () =>
|
||||||
reply([[11, { ...state("secret"), sensitive: true }]]),
|
reply([[11, { ...state("secret"), sensitive: true }]]),
|
||||||
);
|
);
|
||||||
const captured = await captureViewModel(cdp, 7);
|
await enrichFormControlStates(cdp, 7, nodes);
|
||||||
const control = captured.nodes.find((n) => n.backendNodeId === 11);
|
const control = nodes[0].find((n) => n.backendNodeId === 11);
|
||||||
expect(control?.formState).toBe("filled");
|
expect(control?.formState).toBe("filled");
|
||||||
expect(control?.formValue).toBeUndefined();
|
expect(control?.formValue).toBeUndefined();
|
||||||
expect(control?.formDefaultValue).toBeUndefined();
|
expect(control?.formDefaultValue).toBeUndefined();
|
||||||
@@ -246,7 +274,7 @@ describe("form state identity", () => {
|
|||||||
defaultValue: "",
|
defaultValue: "",
|
||||||
placeholder: "",
|
placeholder: "",
|
||||||
}));
|
}));
|
||||||
const { cdp, send } = fakeCdp([controls], (params) => {
|
const { cdp, send, nodes } = await fakeCdp([controls], (params) => {
|
||||||
const doc = {
|
const doc = {
|
||||||
querySelectorAll: (selector: string) =>
|
querySelectorAll: (selector: string) =>
|
||||||
selector === "input,textarea,select" ? elements : [],
|
selector === "input,textarea,select" ? elements : [],
|
||||||
@@ -257,9 +285,9 @@ describe("form state identity", () => {
|
|||||||
expect(entries).toHaveLength(250);
|
expect(entries).toHaveLength(250);
|
||||||
return reply(entries.map(([element, json]) => [element.backendNodeId, JSON.parse(json)]));
|
return reply(entries.map(([element, json]) => [element.backendNodeId, JSON.parse(json)]));
|
||||||
});
|
});
|
||||||
const captured = await captureViewModel(cdp, 7);
|
await enrichFormControlStates(cdp, 7, nodes);
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 250)?.formValue).toBe("live 250");
|
expect(nodes[0].find((n) => n.backendNodeId === 250)?.formValue).toBe("live 250");
|
||||||
expect(captured.nodes.find((n) => n.backendNodeId === 251)?.formValue).toBe("old");
|
expect(nodes[0].find((n) => n.backendNodeId === 251)?.formValue).toBe("old");
|
||||||
expect(send.mock.calls.filter(([, method]) => method === "Runtime.evaluate")).toHaveLength(1);
|
expect(send.mock.calls.filter(([, method]) => method === "Runtime.evaluate")).toHaveLength(1);
|
||||||
expect(
|
expect(
|
||||||
send.mock.calls.filter(([, method]) => method === "Runtime.releaseObjectGroup"),
|
send.mock.calls.filter(([, method]) => method === "Runtime.releaseObjectGroup"),
|
||||||
|
|||||||
@@ -1,198 +0,0 @@
|
|||||||
import { describe, expect, it, vi } from "vitest";
|
|
||||||
import type { CdpRunner } from "../../shared";
|
|
||||||
import type { CapturedNode, CapturedViewModel } from "../capture";
|
|
||||||
import { captureFrameData } from "../frame-capture";
|
|
||||||
|
|
||||||
function ownerNode(backendNodeId: number, x: number): CapturedNode {
|
|
||||||
return {
|
|
||||||
backendNodeId,
|
|
||||||
parentBackendNodeId: 1,
|
|
||||||
frameId: "main",
|
|
||||||
ownerFrameBackendNodeId: null,
|
|
||||||
tag: "iframe",
|
|
||||||
attrs: {},
|
|
||||||
rect: { x, y: 100, w: 300, h: 200 },
|
|
||||||
localRect: { x, y: 100, w: 300, h: 200 },
|
|
||||||
paintOrder: 1,
|
|
||||||
position: "static",
|
|
||||||
pointerEvents: "auto",
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function childSnapshot(frameId: string, backendNodeId: number) {
|
|
||||||
const strings = [frameId, "body", "button", "static", "auto", "pointer"];
|
|
||||||
return {
|
|
||||||
strings,
|
|
||||||
documents: [
|
|
||||||
{
|
|
||||||
frameId,
|
|
||||||
nodes: {
|
|
||||||
parentIndex: [-1, 0],
|
|
||||||
nodeName: [1, 2],
|
|
||||||
backendNodeId: [backendNodeId - 1, backendNodeId],
|
|
||||||
attributes: [[], []],
|
|
||||||
},
|
|
||||||
layout: {
|
|
||||||
nodeIndex: [0, 1],
|
|
||||||
styles: [
|
|
||||||
[3, 4, 4],
|
|
||||||
[3, 4, 5],
|
|
||||||
],
|
|
||||||
bounds: [
|
|
||||||
[0, 0, 300, 200],
|
|
||||||
[10, 20, 100, 40],
|
|
||||||
],
|
|
||||||
paintOrders: [0, 1],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("captureFrameData", () => {
|
|
||||||
it("captures and positions multiple OOPIF documents missing from the root snapshot", async () => {
|
|
||||||
const leftOwner = ownerNode(10, 50);
|
|
||||||
const rightOwner = ownerNode(20, 500);
|
|
||||||
const captured: CapturedViewModel = {
|
|
||||||
nodes: [leftOwner, rightOwner],
|
|
||||||
viewport: { width: 1000, height: 800 },
|
|
||||||
iframeNodes: new Map(),
|
|
||||||
frameNodes: new Map([["main", [leftOwner, rightOwner]]]),
|
|
||||||
frameOwnerBackendNodeIds: new Map(),
|
|
||||||
rootFrameId: "main",
|
|
||||||
excludedBackendNodeIds: new Set(),
|
|
||||||
};
|
|
||||||
const sendToTarget = vi.fn(async (target, method) => {
|
|
||||||
if (method === "Page.getLayoutMetrics") {
|
|
||||||
return { cssLayoutViewport: { clientWidth: 300, clientHeight: 200, pageX: 0, pageY: 0 } };
|
|
||||||
}
|
|
||||||
if (method === "DOMSnapshot.enable" || method === "Accessibility.enable") return {};
|
|
||||||
if (method === "DOMSnapshot.captureSnapshot") {
|
|
||||||
return target.sessionId === "left-session"
|
|
||||||
? childSnapshot("left", 101)
|
|
||||||
: childSnapshot("right", 201);
|
|
||||||
}
|
|
||||||
if (method === "Accessibility.getFullAXTree") return { nodes: [] };
|
|
||||||
throw new Error(`unexpected ${method}`);
|
|
||||||
});
|
|
||||||
const cdp: CdpRunner = {
|
|
||||||
send: vi.fn(async (_tabId, method, params) => {
|
|
||||||
if (method === "Accessibility.enable") return {};
|
|
||||||
if (method === "Accessibility.getFullAXTree") return { nodes: [] };
|
|
||||||
if (method === "DOM.getBoxModel") {
|
|
||||||
const backendNodeId = (params as { backendNodeId?: number })?.backendNodeId;
|
|
||||||
const x = backendNodeId === 10 ? 50 : 500;
|
|
||||||
return { model: { content: [x, 100, x + 300, 100, x + 300, 300, x, 300] } };
|
|
||||||
}
|
|
||||||
if (method === "Page.getLayoutMetrics") {
|
|
||||||
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 800 } };
|
|
||||||
}
|
|
||||||
throw new Error(`unexpected root ${method}`);
|
|
||||||
}) as CdpRunner["send"],
|
|
||||||
sendToTarget: sendToTarget as unknown as NonNullable<CdpRunner["sendToTarget"]>,
|
|
||||||
getFrameGraph: vi.fn(async () => ({
|
|
||||||
rootFrameId: "main",
|
|
||||||
frames: [
|
|
||||||
{ frameId: "main", target: { tabId: 4 } },
|
|
||||||
{
|
|
||||||
frameId: "left",
|
|
||||||
parentFrameId: "main",
|
|
||||||
ownerBackendNodeId: 10,
|
|
||||||
target: { tabId: 4, sessionId: "left-session" },
|
|
||||||
},
|
|
||||||
{
|
|
||||||
frameId: "right",
|
|
||||||
parentFrameId: "main",
|
|
||||||
ownerBackendNodeId: 20,
|
|
||||||
target: { tabId: 4, sessionId: "right-session" },
|
|
||||||
},
|
|
||||||
],
|
|
||||||
})),
|
|
||||||
};
|
|
||||||
|
|
||||||
const trees = await captureFrameData(cdp, 4, captured);
|
|
||||||
|
|
||||||
expect(trees.map((tree) => tree.frameId)).toEqual(["main", "left", "right"]);
|
|
||||||
expect(
|
|
||||||
captured.frameNodes?.get("left")?.find((node) => node.backendNodeId === 101)?.rect,
|
|
||||||
).toEqual({ x: 60, y: 120, w: 100, h: 40 });
|
|
||||||
expect(
|
|
||||||
captured.frameNodes?.get("right")?.find((node) => node.backendNodeId === 201)?.rect,
|
|
||||||
).toEqual({ x: 510, y: 120, w: 100, h: 40 });
|
|
||||||
expect(captured.frameOwnerBackendNodeIds).toEqual(
|
|
||||||
new Map([
|
|
||||||
["left", 10],
|
|
||||||
["right", 20],
|
|
||||||
]),
|
|
||||||
);
|
|
||||||
expect(captured.frameParentIds).toEqual(
|
|
||||||
new Map([
|
|
||||||
["left", "main"],
|
|
||||||
["right", "main"],
|
|
||||||
]),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("keeps OOPIF semantics when viewport projection is unavailable", async () => {
|
|
||||||
const owner = { ...ownerNode(10, 50), rect: null, localRect: null };
|
|
||||||
const captured: CapturedViewModel = {
|
|
||||||
nodes: [owner],
|
|
||||||
viewport: { width: 1000, height: 800 },
|
|
||||||
iframeNodes: new Map(),
|
|
||||||
frameNodes: new Map([["main", [owner]]]),
|
|
||||||
rootFrameId: "main",
|
|
||||||
excludedBackendNodeIds: new Set(),
|
|
||||||
};
|
|
||||||
const cdp: CdpRunner = {
|
|
||||||
send: vi.fn(async (_tabId, method) => {
|
|
||||||
if (method === "Accessibility.enable") return {};
|
|
||||||
if (method === "Accessibility.getFullAXTree") return { nodes: [] };
|
|
||||||
if (method === "DOM.getBoxModel") throw new Error("owner geometry unavailable");
|
|
||||||
if (method === "Page.getLayoutMetrics") {
|
|
||||||
return { cssLayoutViewport: { clientWidth: 1000, clientHeight: 800 } };
|
|
||||||
}
|
|
||||||
throw new Error(`unexpected root ${method}`);
|
|
||||||
}) as CdpRunner["send"],
|
|
||||||
sendToTarget: vi.fn(async (_target, method) => {
|
|
||||||
if (method === "Page.getLayoutMetrics") throw new Error("viewport unavailable");
|
|
||||||
if (method === "DOMSnapshot.enable" || method === "Accessibility.enable") return {};
|
|
||||||
if (method === "DOMSnapshot.captureSnapshot") return childSnapshot("child", 101);
|
|
||||||
if (method === "Accessibility.getFullAXTree") {
|
|
||||||
return {
|
|
||||||
nodes: [
|
|
||||||
{
|
|
||||||
nodeId: "button",
|
|
||||||
backendDOMNodeId: 101,
|
|
||||||
role: { type: "role", value: "button" },
|
|
||||||
name: { type: "computedString", value: "Continue" },
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
throw new Error(`unexpected ${method}`);
|
|
||||||
}) as unknown 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" },
|
|
||||||
},
|
|
||||||
],
|
|
||||||
})),
|
|
||||||
};
|
|
||||||
|
|
||||||
const documents = await captureFrameData(cdp, 4, captured);
|
|
||||||
const childDocument = documents.find((document) => document.frameId === "child");
|
|
||||||
|
|
||||||
expect(childDocument?.axNodes).toEqual([
|
|
||||||
expect.objectContaining({ backendDOMNodeId: 101, frameId: "child" }),
|
|
||||||
]);
|
|
||||||
expect(childDocument?.domNodes.find((node) => node.backendNodeId === 101)).toEqual(
|
|
||||||
expect.objectContaining({ rect: null, localRect: { x: 10, y: 20, w: 100, h: 40 } }),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,7 +1,12 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import type { CdpFrameGraph } from "@/browser-driver/frame-graph";
|
import type { CdpFrameGraph } from "@/browser-driver/frame-graph";
|
||||||
import type { CapturedNode, CapturedViewModel } from "../capture";
|
import type { CapturedNode } from "../capture";
|
||||||
import { buildFrameDocuments, type FrameAxBatch, type FrameOwnedAxNode } from "../frame-document";
|
import {
|
||||||
|
buildFrameDocuments,
|
||||||
|
type FrameAxBatch,
|
||||||
|
type FrameDomInput,
|
||||||
|
type FrameOwnedAxNode,
|
||||||
|
} from "../frame-document";
|
||||||
|
|
||||||
function domNode(frameId: string, backendNodeId: number): CapturedNode {
|
function domNode(frameId: string, backendNodeId: number): CapturedNode {
|
||||||
return {
|
return {
|
||||||
@@ -17,19 +22,16 @@ function domNode(frameId: string, backendNodeId: number): CapturedNode {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function captured(frameNodes: Map<string, CapturedNode[]>): CapturedViewModel {
|
function captured(frameNodes: Map<string, CapturedNode[]>): FrameDomInput {
|
||||||
return {
|
return {
|
||||||
nodes: frameNodes.get("main") ?? [],
|
nodes: frameNodes.get("main") ?? [],
|
||||||
viewport: { width: 800, height: 600 },
|
|
||||||
iframeNodes: new Map(),
|
|
||||||
frameNodes,
|
frameNodes,
|
||||||
rootFrameId: "main",
|
rootFrameId: "main",
|
||||||
excludedBackendNodeIds: new Set(),
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("buildFrameDocuments", () => {
|
describe("buildFrameDocuments", () => {
|
||||||
it("partitions mixed AX results by node ownership and cuts cross-frame parent edges", () => {
|
it("partitions mixed AX results by node ownership and cuts cross-frame parent edges", async () => {
|
||||||
const graph: CdpFrameGraph = {
|
const graph: CdpFrameGraph = {
|
||||||
rootFrameId: "main",
|
rootFrameId: "main",
|
||||||
frames: [
|
frames: [
|
||||||
@@ -54,7 +56,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
const documents = buildFrameDocuments(
|
const documents = await buildFrameDocuments(
|
||||||
graph,
|
graph,
|
||||||
batches,
|
batches,
|
||||||
captured(
|
captured(
|
||||||
@@ -72,7 +74,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
expect(childNodes.find((node) => node.nodeId === "virtual")?.frameId).toBe("child");
|
expect(childNodes.find((node) => node.nodeId === "virtual")?.frameId).toBe("child");
|
||||||
});
|
});
|
||||||
|
|
||||||
it("deduplicates overlapping same-target AX results using the strongest ownership", () => {
|
it("deduplicates overlapping same-target AX results using the strongest ownership", async () => {
|
||||||
const graph: CdpFrameGraph = {
|
const graph: CdpFrameGraph = {
|
||||||
rootFrameId: "main",
|
rootFrameId: "main",
|
||||||
frames: [
|
frames: [
|
||||||
@@ -92,7 +94,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
const documents = buildFrameDocuments(
|
const documents = await buildFrameDocuments(
|
||||||
graph,
|
graph,
|
||||||
batches,
|
batches,
|
||||||
captured(
|
captured(
|
||||||
@@ -107,7 +109,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
expect(documents.find((document) => document.frameId === "child")?.axNodes).toHaveLength(1);
|
expect(documents.find((document) => document.frameId === "child")?.axNodes).toHaveLength(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("uses target-scoped backend ownership when OOPIF backend ids collide", () => {
|
it("uses target-scoped backend ownership when OOPIF backend ids collide", async () => {
|
||||||
const graph: CdpFrameGraph = {
|
const graph: CdpFrameGraph = {
|
||||||
rootFrameId: "main",
|
rootFrameId: "main",
|
||||||
frames: [
|
frames: [
|
||||||
@@ -129,7 +131,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
nodes: [{ nodeId: `${frame.frameId}-node`, backendDOMNodeId: 7 }],
|
nodes: [{ nodeId: `${frame.frameId}-node`, backendDOMNodeId: 7 }],
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const documents = buildFrameDocuments(
|
const documents = await buildFrameDocuments(
|
||||||
graph,
|
graph,
|
||||||
batches,
|
batches,
|
||||||
captured(
|
captured(
|
||||||
@@ -149,7 +151,7 @@ describe("buildFrameDocuments", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("uses captured frame parent identity instead of guessing from backend ids", () => {
|
it("uses captured frame parent identity instead of guessing from backend ids", async () => {
|
||||||
const frameNodes = new Map([
|
const frameNodes = new Map([
|
||||||
["main", [domNode("main", 1)]],
|
["main", [domNode("main", 1)]],
|
||||||
["left", [domNode("left", 7)]],
|
["left", [domNode("left", 7)]],
|
||||||
@@ -157,18 +159,51 @@ describe("buildFrameDocuments", () => {
|
|||||||
["child", [domNode("child", 9)]],
|
["child", [domNode("child", 9)]],
|
||||||
]);
|
]);
|
||||||
const capture = captured(frameNodes);
|
const capture = captured(frameNodes);
|
||||||
capture.frameOwnerBackendNodeIds = new Map([["child", 7]]);
|
|
||||||
capture.frameParentIds = new Map([["child", "left"]]);
|
|
||||||
const frames = ["main", "left", "right", "child"].map((frameId) => ({
|
const frames = ["main", "left", "right", "child"].map((frameId) => ({
|
||||||
frame: { frameId, target: { tabId: 4 } },
|
frame: {
|
||||||
|
frameId,
|
||||||
|
target: { tabId: 4 },
|
||||||
|
...(frameId === "child" ? { parentFrameId: "left", ownerBackendNodeId: 7 } : {}),
|
||||||
|
},
|
||||||
nodes: [],
|
nodes: [],
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const documents = buildFrameDocuments(null, frames, capture);
|
const documents = await buildFrameDocuments(null, frames, capture);
|
||||||
|
|
||||||
expect(documents.find((document) => document.frameId === "child")).toMatchObject({
|
expect(documents.find((document) => document.frameId === "child")).toMatchObject({
|
||||||
parentFrameId: "left",
|
parentFrameId: "left",
|
||||||
ownerBackendNodeId: 7,
|
ownerBackendNodeId: 7,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
it("rejects explicit AX frame ownership in a different target", async () => {
|
||||||
|
const frames = [
|
||||||
|
{ frameId: "main", target: { tabId: 4 } },
|
||||||
|
{ frameId: "remote", target: { tabId: 4, sessionId: "remote" } },
|
||||||
|
];
|
||||||
|
const unresolved = vi.fn();
|
||||||
|
const documents = await buildFrameDocuments(
|
||||||
|
{ rootFrameId: "main", frames },
|
||||||
|
[{ frame: frames[0], nodes: [{ nodeId: "wrong", frameId: "remote" }] }],
|
||||||
|
captured(new Map()),
|
||||||
|
undefined,
|
||||||
|
unresolved,
|
||||||
|
);
|
||||||
|
expect(documents.every((doc) => doc.axNodes.length === 0)).toBe(true);
|
||||||
|
expect(unresolved).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("resolves a reverse-ordered deep AX parent chain without recursion", async () => {
|
||||||
|
const frame = { frameId: "main", target: { tabId: 4 } };
|
||||||
|
const nodes: FrameOwnedAxNode[] = Array.from({ length: 10000 }, (_, i) => ({
|
||||||
|
nodeId: String(i),
|
||||||
|
...(i ? { parentId: String(i - 1) } : { frameId: "main" }),
|
||||||
|
})).reverse();
|
||||||
|
const documents = await buildFrameDocuments(
|
||||||
|
{ rootFrameId: "main", frames: [frame] },
|
||||||
|
[{ frame, nodes }],
|
||||||
|
captured(new Map()),
|
||||||
|
);
|
||||||
|
expect(documents[0].axNodes).toHaveLength(10000);
|
||||||
|
expect(documents[0].axNodes[0].frameId).toBe("main");
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
function captureAbortError(): Error {
|
||||||
|
const error = new Error("observation aborted");
|
||||||
|
error.name = "AbortError";
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function isAbortError(error: unknown): boolean {
|
||||||
|
return (
|
||||||
|
typeof error === "object" &&
|
||||||
|
error !== null &&
|
||||||
|
(error as { name?: string }).name === "AbortError"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function throwIfAborted(signal: AbortSignal | undefined): void {
|
||||||
|
if (signal?.aborted) throw captureAbortError();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Check at bounded work blocks; yield only after a processing slice is spent.
|
||||||
|
* Each caller owns its deadline, so unrelated captures do not share state. */
|
||||||
|
export function createCaptureCheckpoint(signal?: AbortSignal): () => Promise<void> | undefined {
|
||||||
|
throwIfAborted(signal);
|
||||||
|
let deadline = performance.now() + 8;
|
||||||
|
return () => {
|
||||||
|
throwIfAborted(signal);
|
||||||
|
if (performance.now() < deadline) return;
|
||||||
|
return new Promise<void>((resolve) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
channel.port1.onmessage = () => {
|
||||||
|
channel.port1.close();
|
||||||
|
channel.port2.close();
|
||||||
|
resolve();
|
||||||
|
};
|
||||||
|
channel.port2.postMessage(null);
|
||||||
|
}).then(() => {
|
||||||
|
throwIfAborted(signal);
|
||||||
|
deadline = performance.now() + 8;
|
||||||
|
});
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,357 @@
|
|||||||
|
import {
|
||||||
|
type CdpFrame,
|
||||||
|
type CdpFrameGraph,
|
||||||
|
type CdpTarget,
|
||||||
|
cdpTargetKey,
|
||||||
|
} from "@/browser-driver/frame-graph";
|
||||||
|
import { cssViewport, GeometryContext } from "../geometry/frame-context";
|
||||||
|
import { type CdpRunner, cdpRunnerForTarget } from "../shared";
|
||||||
|
import { collectOverlayExcludedBackendIds } from "./capture";
|
||||||
|
import {
|
||||||
|
isAbortError as isCaptureAbort,
|
||||||
|
throwIfAborted as throwCaptureAborted,
|
||||||
|
} from "./capture-abort";
|
||||||
|
import type { CapturedSceneInput } from "./facts";
|
||||||
|
import { buildDocumentIndex, type CaptureIssue, type ObservationFacts } from "./facts";
|
||||||
|
import { enrichFormControlStates } from "./form-capture";
|
||||||
|
import {
|
||||||
|
buildFrameDocuments,
|
||||||
|
type FrameAxBatch,
|
||||||
|
type FrameDocument,
|
||||||
|
type FrameOwnedAxNode,
|
||||||
|
} from "./frame-document";
|
||||||
|
import { type NormalizedFrameDocument, normalizeSnapshot } from "./normalize";
|
||||||
|
import { describeSnapshotFrames, REQUESTED_STYLES, type SnapshotReply } from "./snapshot";
|
||||||
|
|
||||||
|
interface TargetBatch<T extends FrameOwnedAxNode> {
|
||||||
|
target: CdpTarget;
|
||||||
|
frames: CdpFrame[];
|
||||||
|
documents: NormalizedFrameDocument[];
|
||||||
|
ax: FrameAxBatch<T>[];
|
||||||
|
fallbackExcluded: Set<number>;
|
||||||
|
snapshotFrameIds?: Set<string>;
|
||||||
|
rootFrameId?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A fixed worker pool scoped to one capture; each worker issues at most one
|
||||||
|
* collection request at a time. Geometry has its own measurement-phase bound. */
|
||||||
|
async function collectTasks<T>(
|
||||||
|
items: readonly T[],
|
||||||
|
collect: (item: T) => Promise<void>,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<void> {
|
||||||
|
let cursor = 0;
|
||||||
|
let failed = false;
|
||||||
|
let failure: unknown;
|
||||||
|
await Promise.all(
|
||||||
|
Array.from({ length: Math.min(4, items.length) }, async () => {
|
||||||
|
try {
|
||||||
|
while (cursor < items.length && !failed && !signal?.aborted) {
|
||||||
|
const item = items[cursor++];
|
||||||
|
await collect(item);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
if (!failed) failure = error;
|
||||||
|
failed = true;
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
// A worker's rejection must not let the capture outlive its own task scope.
|
||||||
|
// In-flight reads and their finally blocks settle before cancellation/failure.
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (failed) throw failure;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function captureObservationFacts<T extends FrameOwnedAxNode>(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
tabId: number,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
pageUrl?: string,
|
||||||
|
): Promise<ObservationFacts<T>> {
|
||||||
|
const startedAt = Date.now();
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
let graph: CdpFrameGraph | undefined;
|
||||||
|
try {
|
||||||
|
graph = await cdp.getFrameGraph?.(tabId);
|
||||||
|
} catch (error) {
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
}
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
const geometry = new GeometryContext(cdp, tabId, graph, signal);
|
||||||
|
const issues: CaptureIssue[] = [];
|
||||||
|
const graphFrames = new Map(graph?.frames.map((frame) => [frame.frameId, frame]) ?? []);
|
||||||
|
const groups = new Map<string, TargetBatch<T>>();
|
||||||
|
for (const frame of graph?.frames ?? []) {
|
||||||
|
const key = cdpTargetKey(frame.target);
|
||||||
|
let group = groups.get(key);
|
||||||
|
if (!group) {
|
||||||
|
group = {
|
||||||
|
target: frame.target,
|
||||||
|
frames: [],
|
||||||
|
documents: [],
|
||||||
|
ax: [],
|
||||||
|
fallbackExcluded: new Set(),
|
||||||
|
};
|
||||||
|
groups.set(key, group);
|
||||||
|
}
|
||||||
|
group.frames.push(
|
||||||
|
!frame.target.sessionId && frame.frameId === graph?.rootFrameId && !frame.url && pageUrl
|
||||||
|
? { ...frame, url: pageUrl }
|
||||||
|
: frame,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!groups.has(cdpTargetKey({ tabId })))
|
||||||
|
groups.set(cdpTargetKey({ tabId }), {
|
||||||
|
target: { tabId },
|
||||||
|
frames: [],
|
||||||
|
documents: [],
|
||||||
|
ax: [],
|
||||||
|
fallbackExcluded: new Set(),
|
||||||
|
});
|
||||||
|
const batches = [...groups.values()];
|
||||||
|
const unavailable = (batch: TargetBatch<T>, stage: CaptureIssue["stage"], frameId?: string) =>
|
||||||
|
issues.push({ target: batch.target, frameId, stage, reason: "capture-unavailable" });
|
||||||
|
let firstFailure: unknown;
|
||||||
|
const axReady = new Set<TargetBatch<T>>();
|
||||||
|
await collectTasks(
|
||||||
|
batches,
|
||||||
|
async (batch) => {
|
||||||
|
const scoped = cdpRunnerForTarget(cdp, batch.target);
|
||||||
|
try {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
await scoped.send(tabId, "DOMSnapshot.enable", {});
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
const snapshot = await scoped.send<SnapshotReply>(tabId, "DOMSnapshot.captureSnapshot", {
|
||||||
|
computedStyles: REQUESTED_STYLES,
|
||||||
|
includePaintOrder: true,
|
||||||
|
includeDOMRects: true,
|
||||||
|
});
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
const observed = describeSnapshotFrames(snapshot, batch.target, graphFrames, pageUrl);
|
||||||
|
batch.snapshotFrameIds = observed.ids;
|
||||||
|
batch.rootFrameId = observed.rootFrameId;
|
||||||
|
// Keep graph-only frames for AX fallback, never in preference to observed membership.
|
||||||
|
batch.frames = [
|
||||||
|
...observed.frames,
|
||||||
|
...batch.frames.filter((frame) => !observed.ids.has(frame.frameId)),
|
||||||
|
];
|
||||||
|
batch.documents = await normalizeSnapshot(
|
||||||
|
snapshot,
|
||||||
|
batch.target,
|
||||||
|
batch.frames.filter((frame) => observed.ids.has(frame.frameId)),
|
||||||
|
geometry,
|
||||||
|
issues,
|
||||||
|
signal,
|
||||||
|
observed.rootFrameId,
|
||||||
|
);
|
||||||
|
const formsAvailable = await enrichFormControlStates(
|
||||||
|
scoped,
|
||||||
|
tabId,
|
||||||
|
batch.documents.map((doc) => doc.nodes),
|
||||||
|
signal,
|
||||||
|
);
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (!formsAvailable) unavailable(batch, "forms");
|
||||||
|
const present = new Set(batch.documents.map((doc) => doc.frame.frameId));
|
||||||
|
for (const frame of batch.frames)
|
||||||
|
if (!present.has(frame.frameId)) unavailable(batch, "dom", frame.frameId);
|
||||||
|
} catch (error) {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
firstFailure ??= error;
|
||||||
|
unavailable(batch, "dom");
|
||||||
|
batch.fallbackExcluded = await collectOverlayExcludedBackendIds(scoped, tabId, signal);
|
||||||
|
}
|
||||||
|
if (!batch.frames.length && !graph)
|
||||||
|
batch.frames = [
|
||||||
|
{
|
||||||
|
frameId: "root",
|
||||||
|
target: batch.target,
|
||||||
|
...(!batch.target.sessionId && pageUrl ? { url: pageUrl } : {}),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
try {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
await scoped.send(tabId, "Accessibility.enable", {});
|
||||||
|
} catch (error) {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
firstFailure ??= error;
|
||||||
|
unavailable(batch, "ax");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
axReady.add(batch);
|
||||||
|
},
|
||||||
|
signal,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Schedule AX by frame across all ready targets, rather than nesting pools.
|
||||||
|
// Keep result slots in source order even when CDP replies arrive out of order.
|
||||||
|
const axTasks: { batch: TargetBatch<T>; frame: CdpFrame; result?: FrameAxBatch<T> }[] =
|
||||||
|
batches.flatMap((batch) =>
|
||||||
|
axReady.has(batch) ? batch.frames.map((frame) => ({ batch, frame })) : [],
|
||||||
|
);
|
||||||
|
await collectTasks(
|
||||||
|
axTasks,
|
||||||
|
async (task) => {
|
||||||
|
const { batch, frame } = task;
|
||||||
|
try {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
const result = await cdpRunnerForTarget(cdp, batch.target).send<{ nodes?: T[] }>(
|
||||||
|
tabId,
|
||||||
|
"Accessibility.getFullAXTree",
|
||||||
|
frame.frameId === "root" ? {} : { frameId: frame.frameId },
|
||||||
|
);
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
task.result = { frame, nodes: result.nodes ?? [] };
|
||||||
|
} catch (error) {
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
firstFailure ??= error;
|
||||||
|
unavailable(batch, "ax", frame.frameId);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
signal,
|
||||||
|
);
|
||||||
|
for (const task of axTasks) if (task.result) task.batch.ax.push(task.result);
|
||||||
|
|
||||||
|
let viewport = { width: 0, height: 0 };
|
||||||
|
try {
|
||||||
|
const measured = cssViewport(await geometry.layoutMetrics({ tabId }));
|
||||||
|
viewport = { width: measured.width, height: measured.height };
|
||||||
|
} catch (error) {
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A snapshot claim outranks an old graph hint. Conflicting actual claims
|
||||||
|
// cannot be resolved by completion order or by overwriting a frameId map.
|
||||||
|
const claims = new Map<string, string>();
|
||||||
|
const invalid = new Set<string>();
|
||||||
|
for (const batch of batches) {
|
||||||
|
const targetKey = cdpTargetKey(batch.target);
|
||||||
|
for (const id of batch.snapshotFrameIds ?? []) {
|
||||||
|
const previous = claims.get(id);
|
||||||
|
if (previous !== undefined && previous !== targetKey) invalid.add(id);
|
||||||
|
claims.set(id, targetKey);
|
||||||
|
}
|
||||||
|
const accepted = new Set(batch.frames.map((frame) => frame.frameId));
|
||||||
|
for (const id of batch.snapshotFrameIds ?? []) if (!accepted.has(id)) invalid.add(id);
|
||||||
|
}
|
||||||
|
const currentFrames = batches.flatMap((batch) =>
|
||||||
|
batch.frames.filter(
|
||||||
|
(frame) =>
|
||||||
|
!claims.has(frame.frameId) || claims.get(frame.frameId) === cdpTargetKey(batch.target),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const rootBatch = batches.find((batch) => !batch.target.sessionId);
|
||||||
|
const rootFrameId =
|
||||||
|
rootBatch?.rootFrameId ?? graph?.rootFrameId ?? rootBatch?.frames[0]?.frameId ?? "root";
|
||||||
|
const children = new Map<string, string[]>();
|
||||||
|
for (const frame of currentFrames) {
|
||||||
|
if (!frame.parentFrameId) continue;
|
||||||
|
const siblings = children.get(frame.parentFrameId);
|
||||||
|
if (siblings) siblings.push(frame.frameId);
|
||||||
|
else children.set(frame.parentFrameId, [frame.frameId]);
|
||||||
|
}
|
||||||
|
const blocked = [...invalid];
|
||||||
|
for (let i = 0; i < blocked.length; i++) {
|
||||||
|
for (const child of children.get(blocked[i]) ?? []) {
|
||||||
|
if (!invalid.has(child)) {
|
||||||
|
invalid.add(child);
|
||||||
|
blocked.push(child);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (const frame of currentFrames) {
|
||||||
|
if (invalid.has(frame.frameId))
|
||||||
|
issues.push({
|
||||||
|
target: frame.target,
|
||||||
|
frameId: frame.frameId,
|
||||||
|
stage: "ownership",
|
||||||
|
reason: "frame-ownership-unresolved",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (invalid.has(rootFrameId)) throw new Error("observation root document ownership is ambiguous");
|
||||||
|
const frames = currentFrames.filter((frame) => !invalid.has(frame.frameId));
|
||||||
|
const frameById = new Map(frames.map((frame) => [frame.frameId, frame]));
|
||||||
|
const belongs = (frame: CdpFrame) => {
|
||||||
|
const current = frameById.get(frame.frameId);
|
||||||
|
return current && cdpTargetKey(current.target) === cdpTargetKey(frame.target);
|
||||||
|
};
|
||||||
|
const decoded = new Map(
|
||||||
|
batches
|
||||||
|
.flatMap((batch) => batch.documents)
|
||||||
|
.filter((doc) => belongs(doc.frame))
|
||||||
|
.map((doc) => [doc.frame.frameId, doc]),
|
||||||
|
);
|
||||||
|
const ax = batches.flatMap((batch) => batch.ax).filter((batch) => belongs(batch.frame));
|
||||||
|
const documents = await buildFrameDocuments(
|
||||||
|
{ rootFrameId, frames },
|
||||||
|
ax,
|
||||||
|
{
|
||||||
|
nodes: [],
|
||||||
|
rootFrameId,
|
||||||
|
frameNodes: new Map([...decoded].map(([id, doc]) => [id, doc.nodes])),
|
||||||
|
frameExcludedBackendNodeIds: new Map(
|
||||||
|
[...decoded].map(([id, doc]) => [id, doc.index.excludedBackendNodeIds]),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
signal,
|
||||||
|
(frame) =>
|
||||||
|
issues.push({
|
||||||
|
target: frame.target,
|
||||||
|
frameId: frame.frameId,
|
||||||
|
stage: "ownership",
|
||||||
|
reason: "frame-ownership-unresolved",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const facts: ObservationFacts<T>["documents"][number][] = [];
|
||||||
|
for (const document of documents) {
|
||||||
|
const doc = decoded.get(document.frameId);
|
||||||
|
const index = doc?.index ?? (await buildDocumentIndex([], signal));
|
||||||
|
const fallback = groups.get(cdpTargetKey(document.target))?.fallbackExcluded;
|
||||||
|
const {
|
||||||
|
domNodes,
|
||||||
|
axNodes,
|
||||||
|
contextScopeId: _scope,
|
||||||
|
excludedBackendNodeIds: _excluded,
|
||||||
|
...frame
|
||||||
|
} = document;
|
||||||
|
facts.push({
|
||||||
|
frame,
|
||||||
|
index: fallback?.size ? { ...index, excludedBackendNodeIds: fallback } : index,
|
||||||
|
domNodes,
|
||||||
|
axNodes,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
if (firstFailure && facts.every((doc) => !doc.domNodes.length && !doc.axNodes.length))
|
||||||
|
throw firstFailure;
|
||||||
|
return { rootFrameId, viewport, documents: facts, issues, startedAt, finishedAt: Date.now() };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Existing semantic consumers get a narrow view; no raw snapshot
|
||||||
|
* data can leak through recording's allowlisted output DTO. */
|
||||||
|
export function semanticCapture<T extends FrameOwnedAxNode>(
|
||||||
|
facts: ObservationFacts<T>,
|
||||||
|
): { captured: CapturedSceneInput; documents: FrameDocument<T>[] } {
|
||||||
|
const documents = facts.documents.map((doc) => ({
|
||||||
|
...doc.frame,
|
||||||
|
contextScopeId: doc.frame.frameId,
|
||||||
|
domNodes: doc.domNodes.filter(
|
||||||
|
(node) => !doc.index.excludedBackendNodeIds.has(node.backendNodeId),
|
||||||
|
),
|
||||||
|
axNodes: doc.axNodes,
|
||||||
|
excludedBackendNodeIds: doc.index.excludedBackendNodeIds,
|
||||||
|
}));
|
||||||
|
const root = documents.find((doc) => doc.frameId === facts.rootFrameId);
|
||||||
|
return {
|
||||||
|
documents,
|
||||||
|
captured: {
|
||||||
|
nodes: root?.domNodes ?? [],
|
||||||
|
viewport: facts.viewport,
|
||||||
|
rootFrameId: facts.rootFrameId,
|
||||||
|
excludedBackendNodeIds: root?.excludedBackendNodeIds ?? new Set(),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import type { Rect } from "@browser-skill/vom";
|
||||||
|
|
||||||
|
export interface CapturedNode {
|
||||||
|
backendNodeId: number;
|
||||||
|
parentBackendNodeId: number | null;
|
||||||
|
frameId?: string;
|
||||||
|
/** Owning iframe backend node id; `null` for the top-level document. */
|
||||||
|
ownerFrameBackendNodeId?: number | null;
|
||||||
|
tag: string;
|
||||||
|
attrs: Record<string, string>;
|
||||||
|
/** Top-level viewport-relative CSS px, clipped to the owning frame viewport. */
|
||||||
|
rect: Rect | null;
|
||||||
|
/** Frame-local viewport-relative CSS px before top-level projection. */
|
||||||
|
localRect?: Rect | null;
|
||||||
|
paintOrder: number;
|
||||||
|
position: string;
|
||||||
|
pointerEvents: string;
|
||||||
|
/**
|
||||||
|
* computed `cursor`. `cursor: pointer` is the strongest CDP-free signal
|
||||||
|
* that a non-semantic element (a `<div>`/`<span>` with a click handler)
|
||||||
|
* is actually an interactive control — used by the adapter to surface
|
||||||
|
* custom buttons/checkboxes the AX tree drops as `generic`. Optional like
|
||||||
|
* `textContent`: the live parser always sets it, hand-built fixtures may not.
|
||||||
|
*/
|
||||||
|
cursor?: string;
|
||||||
|
/**
|
||||||
|
* 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
|
||||||
|
* nodes remain authoritative even when they are outside the viewport.
|
||||||
|
*/
|
||||||
|
rendered?: boolean;
|
||||||
|
textContent?: string;
|
||||||
|
formState?: "empty" | "filled" | "default";
|
||||||
|
formValue?: string;
|
||||||
|
formDefaultValue?: string;
|
||||||
|
formPlaceholder?: string;
|
||||||
|
}
|
||||||
@@ -1,332 +1,22 @@
|
|||||||
// CDP capture adapter: DOMSnapshot.captureSnapshot + Page.getLayoutMetrics
|
// Browser-side hover probes and overlay exclusion fallback. Static collection
|
||||||
// → CapturedNode[] + Viewport. This is the ONLY VOM module that touches
|
// lives in capture-coordinator; snapshot decoding has no browser dependency.
|
||||||
// raw CDP. The captureSnapshot reply is columnar (parallel arrays + a
|
|
||||||
// shared string table); requested computed styles are decoded through
|
|
||||||
// STYLE_COL so capture and visibility policy share one explicit contract.
|
|
||||||
|
|
||||||
import type { Rect, Viewport } from "@browser-skill/vom";
|
|
||||||
import { evaluateHoverTrigger } from "@/lib/hover-trigger-policy";
|
import { evaluateHoverTrigger } from "@/lib/hover-trigger-policy";
|
||||||
import { isOverlayHostNode, OVERLAY_HOST_SELECTOR } from "../../lib/overlay-bridge";
|
import { OVERLAY_HOST_SELECTOR } from "../../lib/overlay-bridge";
|
||||||
import { childFrameProjection, type GeometryProjection, projectRectToViewport } from "../geometry";
|
|
||||||
import type { CdpRunner } from "../shared";
|
import type { CdpRunner } from "../shared";
|
||||||
|
import type { CapturedNode } from "./capture-types";
|
||||||
|
import type { CapturedSurfaceProbe } from "./facts";
|
||||||
|
|
||||||
|
export type {
|
||||||
|
CapturedNode,
|
||||||
|
CapturedSurfaceProbe,
|
||||||
|
} from "./facts";
|
||||||
|
|
||||||
|
import { isAbortError, throwIfAborted } from "./capture-abort";
|
||||||
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 STYLE_COL = Object.fromEntries(
|
|
||||||
REQUESTED_STYLES.map((name, index) => [name, index]),
|
|
||||||
) as Record<(typeof REQUESTED_STYLES)[number], number>;
|
|
||||||
|
|
||||||
export interface CapturedNode {
|
|
||||||
backendNodeId: number;
|
|
||||||
parentBackendNodeId: number | null;
|
|
||||||
frameId?: string;
|
|
||||||
/** Owning iframe backend node id; `null` for the top-level document. */
|
|
||||||
ownerFrameBackendNodeId?: number | null;
|
|
||||||
tag: string;
|
|
||||||
attrs: Record<string, string>;
|
|
||||||
/** Top-level viewport-relative CSS px, clipped to the owning frame viewport. */
|
|
||||||
rect: Rect | null;
|
|
||||||
/** Frame-local viewport-relative CSS px before top-level projection. */
|
|
||||||
localRect?: Rect | null;
|
|
||||||
paintOrder: number;
|
|
||||||
position: string;
|
|
||||||
pointerEvents: string;
|
|
||||||
/**
|
|
||||||
* computed `cursor`. `cursor: pointer` is the strongest CDP-free signal
|
|
||||||
* that a non-semantic element (a `<div>`/`<span>` with a click handler)
|
|
||||||
* is actually an interactive control — used by the adapter to surface
|
|
||||||
* custom buttons/checkboxes the AX tree drops as `generic`. Optional like
|
|
||||||
* `textContent`: the live parser always sets it, hand-built fixtures may not.
|
|
||||||
*/
|
|
||||||
cursor?: string;
|
|
||||||
/**
|
|
||||||
* 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
|
|
||||||
* nodes remain authoritative even when they are outside the viewport.
|
|
||||||
*/
|
|
||||||
rendered?: boolean;
|
|
||||||
textContent?: string;
|
|
||||||
formState?: "empty" | "filled" | "default";
|
|
||||||
formValue?: string;
|
|
||||||
formDefaultValue?: string;
|
|
||||||
formPlaceholder?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type CapturedIframeNodes = Map<number, CapturedNode[]>;
|
|
||||||
|
|
||||||
export interface CapturedSurfaceProbe {
|
|
||||||
triggerBackendNodeId: number;
|
|
||||||
triggerPoint?: { x: number; y: number };
|
|
||||||
triggerAction: "hover" | "focus" | string;
|
|
||||||
subItems: string[];
|
|
||||||
confidence?: "high" | "medium" | "low";
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CapturedViewModel {
|
|
||||||
nodes: CapturedNode[];
|
|
||||||
viewport: Viewport;
|
|
||||||
iframeNodes: CapturedIframeNodes;
|
|
||||||
frameNodes?: Map<string, CapturedNode[]>;
|
|
||||||
frameOwnerBackendNodeIds?: Map<string, number>;
|
|
||||||
/** Explicit DOMSnapshot frame ancestry; never inferred from backend node ids. */
|
|
||||||
frameParentIds?: Map<string, string>;
|
|
||||||
rootFrameId?: string;
|
|
||||||
/** Backend node ids belonging to the agent overlay host + its shadow subtree. */
|
|
||||||
excludedBackendNodeIds: Set<number>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CaptureViewModelOptions {
|
|
||||||
signal?: AbortSignal;
|
|
||||||
}
|
|
||||||
|
|
||||||
function captureAbortError(): Error {
|
|
||||||
const error = new Error("observation aborted");
|
|
||||||
error.name = "AbortError";
|
|
||||||
return error;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAbortError(error: unknown): boolean {
|
|
||||||
return (
|
|
||||||
typeof error === "object" &&
|
|
||||||
error !== null &&
|
|
||||||
(error as { name?: string }).name === "AbortError"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function throwIfAborted(signal: AbortSignal | undefined): void {
|
|
||||||
if (signal?.aborted) throw captureAbortError();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Sparse array format Chrome uses for infrequently-set per-node fields. */
|
|
||||||
interface SparseArray {
|
|
||||||
index: number[];
|
|
||||||
value: number[];
|
|
||||||
}
|
|
||||||
|
|
||||||
interface RareBooleanData {
|
|
||||||
index: number[];
|
|
||||||
}
|
|
||||||
|
|
||||||
interface SnapshotDocument {
|
|
||||||
frameId?: string | number;
|
|
||||||
scrollOffsetX?: number;
|
|
||||||
scrollOffsetY?: number;
|
|
||||||
nodes?: {
|
|
||||||
parentIndex?: number[];
|
|
||||||
nodeName?: number[];
|
|
||||||
backendNodeId?: number[];
|
|
||||||
attributes?: number[][];
|
|
||||||
/**
|
|
||||||
* Per-node text value (index into strings), set for `#text` / CDATA nodes.
|
|
||||||
* Element nodes carry -1. Same length as `backendNodeId`.
|
|
||||||
*/
|
|
||||||
nodeValue?: number[];
|
|
||||||
/** Maps node array index → index into `documents[]` for frame content. */
|
|
||||||
contentDocumentIndex?: SparseArray;
|
|
||||||
inputValue?: SparseArray;
|
|
||||||
textValue?: SparseArray;
|
|
||||||
inputChecked?: RareBooleanData;
|
|
||||||
optionSelected?: RareBooleanData;
|
|
||||||
};
|
|
||||||
layout?: {
|
|
||||||
nodeIndex?: number[];
|
|
||||||
styles?: number[][];
|
|
||||||
bounds?: number[][];
|
|
||||||
paintOrders?: number[];
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function snapshotFrameId(document: SnapshotDocument, strings: string[]): string | undefined {
|
|
||||||
if (typeof document.frameId === "string") return document.frameId || undefined;
|
|
||||||
if (typeof document.frameId === "number") return str(strings, document.frameId) || undefined;
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface SnapshotReply {
|
|
||||||
strings?: string[];
|
|
||||||
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 {
|
|
||||||
return tag === "input" || tag === "textarea" || tag === "select";
|
|
||||||
}
|
|
||||||
|
|
||||||
function isSensitiveFormControl(node: Pick<CapturedNode, "tag" | "attrs">): boolean {
|
|
||||||
return node.tag === "input" && (node.attrs.type ?? "").toLowerCase() === "password";
|
|
||||||
}
|
|
||||||
|
|
||||||
function snapshotFormState(
|
|
||||||
value: string | undefined,
|
|
||||||
defaultValue: string,
|
|
||||||
hasDefaultValue: boolean,
|
|
||||||
sensitive: boolean,
|
|
||||||
): CapturedNode["formState"] {
|
|
||||||
if (sensitive) {
|
|
||||||
if (value === undefined && !hasDefaultValue) return undefined;
|
|
||||||
return (value ?? defaultValue) === "" ? "empty" : "filled";
|
|
||||||
}
|
|
||||||
if (value === undefined) return undefined;
|
|
||||||
if (value === "") return "empty";
|
|
||||||
return value === defaultValue ? "default" : "filled";
|
|
||||||
}
|
|
||||||
|
|
||||||
const MAX_FORM_ENRICH_CONTROLS = 250;
|
|
||||||
|
|
||||||
interface CapturedFormState {
|
|
||||||
value?: string;
|
|
||||||
defaultValue?: string;
|
|
||||||
placeholder?: string;
|
|
||||||
state?: "empty" | "filled" | "default";
|
|
||||||
sensitive?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface DeepSerializedValue {
|
|
||||||
type: string;
|
|
||||||
value?: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
function formStateBatchExpression(maxControls: number): string {
|
|
||||||
return `(() => {
|
|
||||||
const maxControls = ${JSON.stringify(maxControls)};
|
|
||||||
let remaining = maxControls;
|
|
||||||
const controlSelector = "input,textarea,select";
|
|
||||||
const controlState = (el) => {
|
|
||||||
const tag = el.tagName.toLowerCase();
|
|
||||||
const type = tag === "input" ? String(el.type || "text").toLowerCase() : tag;
|
|
||||||
const sensitive = type === "password" || type === "credit-card";
|
|
||||||
const rawValue = typeof el.value === "string" ? el.value : "";
|
|
||||||
const defaultValue = typeof el.defaultValue === "string" ? el.defaultValue : "";
|
|
||||||
const placeholder = typeof el.placeholder === "string" ? el.placeholder : "";
|
|
||||||
const state = rawValue === "" ? "empty" : rawValue === defaultValue ? "default" : "filled";
|
|
||||||
return {
|
|
||||||
state,
|
|
||||||
sensitive,
|
|
||||||
placeholder,
|
|
||||||
...(sensitive ? {} : { value: rawValue, defaultValue }),
|
|
||||||
};
|
|
||||||
};
|
|
||||||
const controls = [];
|
|
||||||
const collect = (doc) => {
|
|
||||||
for (const el of Array.from(doc.querySelectorAll(controlSelector))) {
|
|
||||||
if (remaining <= 0) break;
|
|
||||||
// Deep serialization supplies the node's backend id. Keep the
|
|
||||||
// state as JSON so decoding needs no general-purpose V8 deserializer.
|
|
||||||
controls.push([el, JSON.stringify(controlState(el))]);
|
|
||||||
remaining -= 1;
|
|
||||||
}
|
|
||||||
for (const frame of Array.from(doc.querySelectorAll("iframe"))) {
|
|
||||||
if (remaining <= 0) break;
|
|
||||||
let childDoc = null;
|
|
||||||
try { childDoc = frame.contentDocument; } catch { childDoc = null; }
|
|
||||||
if (childDoc) collect(childDoc);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
collect(document);
|
|
||||||
return controls;
|
|
||||||
})()`;
|
|
||||||
}
|
|
||||||
|
|
||||||
function formStatesByBackendId(result: RuntimeEvaluateReply): Map<number, CapturedFormState> {
|
|
||||||
const states = new Map<number, CapturedFormState>();
|
|
||||||
const serialized = result.result?.deepSerializedValue;
|
|
||||||
if (serialized?.type !== "array" || !Array.isArray(serialized.value)) return states;
|
|
||||||
for (const entry of serialized.value as DeepSerializedValue[]) {
|
|
||||||
if (entry?.type !== "array" || !Array.isArray(entry.value)) continue;
|
|
||||||
const [element, json] = entry.value as DeepSerializedValue[];
|
|
||||||
if (element?.type !== "node" || json?.type !== "string" || typeof json.value !== "string") {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
const backendNodeId = (element.value as { backendNodeId?: number } | undefined)?.backendNodeId;
|
|
||||||
if (typeof backendNodeId !== "number" || !Number.isSafeInteger(backendNodeId)) continue;
|
|
||||||
try {
|
|
||||||
const state = JSON.parse(json.value) as CapturedFormState | null;
|
|
||||||
if (
|
|
||||||
!state ||
|
|
||||||
!["empty", "filled", "default"].includes(state.state ?? "") ||
|
|
||||||
typeof state.sensitive !== "boolean" ||
|
|
||||||
typeof state.placeholder !== "string" ||
|
|
||||||
(!state.sensitive &&
|
|
||||||
(typeof state.value !== "string" || typeof state.defaultValue !== "string"))
|
|
||||||
) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
states.set(backendNodeId, state);
|
|
||||||
} catch {
|
|
||||||
// A malformed entry must not overwrite the snapshot's own state.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return states;
|
|
||||||
}
|
|
||||||
|
|
||||||
function applyFormStates(nodes: CapturedNode[], states: Map<number, CapturedFormState>): void {
|
|
||||||
for (const node of nodes) {
|
|
||||||
if (!isFormControlTag(node.tag)) continue;
|
|
||||||
const state = states.get(node.backendNodeId);
|
|
||||||
if (!state) continue;
|
|
||||||
node.formState = state.state;
|
|
||||||
node.formPlaceholder = state.placeholder ?? "";
|
|
||||||
if (state.sensitive || isSensitiveFormControl(node)) {
|
|
||||||
delete node.formValue;
|
|
||||||
delete node.formDefaultValue;
|
|
||||||
delete node.attrs.value;
|
|
||||||
} else {
|
|
||||||
node.formDefaultValue = state.defaultValue ?? "";
|
|
||||||
if (state.value !== undefined) node.formValue = state.value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function enrichFormControlStates(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
frameNodeGroups: CapturedNode[][],
|
|
||||||
signal?: AbortSignal,
|
|
||||||
): Promise<void> {
|
|
||||||
const hasControls = frameNodeGroups.some((nodes) =>
|
|
||||||
nodes.some((node) => isFormControlTag(node.tag)),
|
|
||||||
);
|
|
||||||
if (!hasControls) return;
|
|
||||||
const objectGroup = `bsk-vom-forms-${crypto.randomUUID()}`;
|
|
||||||
try {
|
|
||||||
throwIfAborted(signal);
|
|
||||||
const result = await cdp.send<RuntimeEvaluateReply>(tabId, "Runtime.evaluate", {
|
|
||||||
expression: formStateBatchExpression(MAX_FORM_ENRICH_CONTROLS),
|
|
||||||
objectGroup,
|
|
||||||
serializationOptions: {
|
|
||||||
serialization: "deep",
|
|
||||||
maxDepth: 3,
|
|
||||||
additionalParameters: { maxNodeDepth: 0, includeShadowTree: "none" },
|
|
||||||
},
|
|
||||||
});
|
|
||||||
throwIfAborted(signal);
|
|
||||||
// Backend ids are scoped to this capture's CDP target. OOPIF targets
|
|
||||||
// use their own captureViewModel call and never share this lookup.
|
|
||||||
const states = formStatesByBackendId(result);
|
|
||||||
for (const nodes of frameNodeGroups) {
|
|
||||||
applyFormStates(nodes, states);
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
if (isAbortError(error)) throw error;
|
|
||||||
// Best-effort enrichment. DOMSnapshot/AX data still carries the nodes.
|
|
||||||
} finally {
|
|
||||||
await cdp.send(tabId, "Runtime.releaseObjectGroup", { objectGroup }).catch(() => undefined);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
interface RuntimeEvaluateReply {
|
interface RuntimeEvaluateReply {
|
||||||
result?: {
|
result?: {
|
||||||
value?: unknown;
|
value?: unknown;
|
||||||
deepSerializedValue?: DeepSerializedValue;
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -345,44 +35,6 @@ interface CdpDomNode {
|
|||||||
shadowRoots?: CdpDomNode[];
|
shadowRoots?: CdpDomNode[];
|
||||||
}
|
}
|
||||||
|
|
||||||
interface ParseDocumentResult {
|
|
||||||
nodes: CapturedNode[];
|
|
||||||
excludedBackendNodeIds: Set<number>;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface FrameContext {
|
|
||||||
frameId?: string;
|
|
||||||
ownerFrameBackendNodeId: number | null;
|
|
||||||
projection: GeometryProjection | null;
|
|
||||||
scrollX: number;
|
|
||||||
scrollY: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
function str(strings: string[], idx: number | undefined): string {
|
|
||||||
if (idx === undefined || idx < 0) return "";
|
|
||||||
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> {
|
|
||||||
const out = new Map<number, number>();
|
|
||||||
if (!sparse?.index || !sparse.value) return out;
|
|
||||||
for (let i = 0; i < sparse.index.length; i++) {
|
|
||||||
const nodeIndex = sparse.index[i];
|
|
||||||
const docIndex = sparse.value[i];
|
|
||||||
if (nodeIndex !== undefined && docIndex !== undefined) out.set(nodeIndex, docIndex);
|
|
||||||
}
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
function collectBackendIdsFromDomNode(node: CdpDomNode | undefined, out: Set<number>): void {
|
function collectBackendIdsFromDomNode(node: CdpDomNode | undefined, out: Set<number>): void {
|
||||||
if (!node) return;
|
if (!node) return;
|
||||||
if (typeof node.backendNodeId === "number") {
|
if (typeof node.backendNodeId === "number") {
|
||||||
@@ -791,358 +443,3 @@ export async function collectOverlayExcludedBackendIds(
|
|||||||
}
|
}
|
||||||
return excluded;
|
return excluded;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Parse one DOMSnapshot document into CapturedNode[].
|
|
||||||
*
|
|
||||||
* @param doc - the raw DOMSnapshot document object
|
|
||||||
* @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
|
|
||||||
*/
|
|
||||||
function parseDocumentNodes(
|
|
||||||
doc: SnapshotDocument,
|
|
||||||
strings: string[],
|
|
||||||
dpr: number,
|
|
||||||
context: FrameContext,
|
|
||||||
): ParseDocumentResult {
|
|
||||||
const dn = doc.nodes;
|
|
||||||
const dl = doc.layout;
|
|
||||||
if (!dn?.backendNodeId) {
|
|
||||||
return { nodes: [], excludedBackendNodeIds: new Set() };
|
|
||||||
}
|
|
||||||
|
|
||||||
const count = dn.backendNodeId.length;
|
|
||||||
const layoutByNode = new Map<number, number>();
|
|
||||||
(dl?.nodeIndex ?? []).forEach((nodeIdx, layoutIdx) => layoutByNode.set(nodeIdx, layoutIdx));
|
|
||||||
|
|
||||||
// The agent's own overlay (WXT shadow host, marked with OVERLAY_HOST_MARKER_ATTR)
|
|
||||||
// is injected into the page and its open shadow root
|
|
||||||
// is inlined by DOMSnapshot as descendants of the host. Its fixed
|
|
||||||
// full-viewport click-blocker would otherwise dominate occlusion detection
|
|
||||||
// and hide the real page, so mark the host + its whole subtree excluded.
|
|
||||||
// parentIndex always references an earlier node, so one forward pass suffices.
|
|
||||||
const excluded = new Array<boolean>(count).fill(false);
|
|
||||||
const excludedBackendNodeIds = new Set<number>();
|
|
||||||
for (let n = 0; n < count; n++) {
|
|
||||||
const parentIdx = dn.parentIndex?.[n] ?? -1;
|
|
||||||
const inherited = parentIdx >= 0 && excluded[parentIdx];
|
|
||||||
let isOverlayHost = inherited;
|
|
||||||
if (!isOverlayHost) {
|
|
||||||
const pairs = dn.attributes?.[n] ?? [];
|
|
||||||
const attrNames: string[] = [];
|
|
||||||
for (let a = 0; a + 1 < pairs.length; a += 2) {
|
|
||||||
attrNames.push(str(strings, pairs[a]));
|
|
||||||
}
|
|
||||||
isOverlayHost = isOverlayHostNode(str(strings, dn.nodeName?.[n]), attrNames);
|
|
||||||
}
|
|
||||||
if (!isOverlayHost) continue;
|
|
||||||
excluded[n] = true;
|
|
||||||
const backendNodeId = dn.backendNodeId[n];
|
|
||||||
if (backendNodeId !== undefined) {
|
|
||||||
excludedBackendNodeIds.add(backendNodeId);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const posCol = STYLE_COL.position;
|
|
||||||
const peCol = STYLE_COL["pointer-events"];
|
|
||||||
const cursorCol = STYLE_COL.cursor;
|
|
||||||
const visibilityCol = STYLE_COL.visibility;
|
|
||||||
const opacityCol = STYLE_COL.opacity;
|
|
||||||
const inputValues = sparseIndexMap(dn.inputValue);
|
|
||||||
const textValues = sparseIndexMap(dn.textValue);
|
|
||||||
const checkedInputs = new Set(dn.inputChecked?.index ?? []);
|
|
||||||
const selectedOptions = new Set(dn.optionSelected?.index ?? []);
|
|
||||||
|
|
||||||
// Collect visible text from #text child nodes so element CapturedNodes
|
|
||||||
// carry a textContent value usable as a button/link label fallback.
|
|
||||||
// nodeValue is a parallel array: string index for text nodes, -1 otherwise.
|
|
||||||
const nodeTextContent = new Map<number, string>();
|
|
||||||
if (dn.nodeValue) {
|
|
||||||
for (let n = 0; n < count; n++) {
|
|
||||||
const nvIdx = dn.nodeValue[n] ?? -1;
|
|
||||||
if (nvIdx < 0) continue;
|
|
||||||
const text = str(strings, nvIdx).trim();
|
|
||||||
if (!text) continue;
|
|
||||||
const parentIdx = dn.parentIndex?.[n] ?? -1;
|
|
||||||
if (parentIdx >= 0) {
|
|
||||||
const existing = nodeTextContent.get(parentIdx);
|
|
||||||
nodeTextContent.set(parentIdx, existing ? `${existing} ${text}` : text);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build CapturedNodes.
|
|
||||||
const nodes: CapturedNode[] = [];
|
|
||||||
for (let n = 0; n < count; n++) {
|
|
||||||
if (excluded[n]) continue;
|
|
||||||
const backendNodeId = dn.backendNodeId[n];
|
|
||||||
const parentIdx = dn.parentIndex?.[n] ?? -1;
|
|
||||||
const parentBackendNodeId = parentIdx >= 0 ? (dn.backendNodeId[parentIdx] ?? null) : null;
|
|
||||||
const tag = str(strings, dn.nodeName?.[n]).toLowerCase();
|
|
||||||
|
|
||||||
const attrs: Record<string, string> = {};
|
|
||||||
const pairs = dn.attributes?.[n] ?? [];
|
|
||||||
for (let a = 0; a + 1 < pairs.length; a += 2) {
|
|
||||||
attrs[str(strings, pairs[a]).toLowerCase()] = str(strings, pairs[a + 1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
let rect: Rect | null = null;
|
|
||||||
let localRect: Rect | null = null;
|
|
||||||
let paintOrder = 0;
|
|
||||||
let position = "static";
|
|
||||||
let pointerEvents = "auto";
|
|
||||||
let cursor = "auto";
|
|
||||||
let rendered = false;
|
|
||||||
const li = layoutByNode.get(n);
|
|
||||||
if (li !== undefined) {
|
|
||||||
const b = dl?.bounds?.[li];
|
|
||||||
if (b && b.length >= 4 && b[2] > 0 && b[3] > 0) {
|
|
||||||
localRect = {
|
|
||||||
x: b[0] / dpr - context.scrollX,
|
|
||||||
y: b[1] / dpr - context.scrollY,
|
|
||||||
w: b[2] / dpr,
|
|
||||||
h: b[3] / dpr,
|
|
||||||
};
|
|
||||||
const bounds = context.projection
|
|
||||||
? projectRectToViewport(localRect, context.projection)
|
|
||||||
: null;
|
|
||||||
rect = bounds ? { x: bounds.x, y: bounds.y, w: bounds.width, h: bounds.height } : null;
|
|
||||||
}
|
|
||||||
paintOrder = dl?.paintOrders?.[li] ?? 0;
|
|
||||||
const styleRow = dl?.styles?.[li] ?? [];
|
|
||||||
position = str(strings, styleRow[posCol]) || "static";
|
|
||||||
pointerEvents = str(strings, styleRow[peCol]) || "auto";
|
|
||||||
cursor = str(strings, styleRow[cursorCol]) || "auto";
|
|
||||||
const visibility = str(strings, styleRow[visibilityCol]) || "visible";
|
|
||||||
const opacity = str(strings, styleRow[opacityCol]) || "1";
|
|
||||||
rendered =
|
|
||||||
localRect !== null &&
|
|
||||||
visibility !== "hidden" &&
|
|
||||||
visibility !== "collapse" &&
|
|
||||||
(Number.parseFloat(opacity) || 0) > 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Skip non-element nodes (#text, #cdata-section, etc.) — they carry no
|
|
||||||
// geometry and are never queried by callers.
|
|
||||||
if (tag.startsWith("#")) continue;
|
|
||||||
|
|
||||||
const textContent = nodeTextContent.get(n);
|
|
||||||
|
|
||||||
const rawFormValueIndex = tag === "textarea" ? textValues.get(n) : inputValues.get(n);
|
|
||||||
const rawFormValue =
|
|
||||||
rawFormValueIndex !== undefined ? str(strings, rawFormValueIndex) : undefined;
|
|
||||||
const sensitive = isSensitiveFormControl({ tag, attrs });
|
|
||||||
const formDefaultValue = attrs.value ?? "";
|
|
||||||
const formValue = sensitive ? undefined : rawFormValue;
|
|
||||||
const formState = snapshotFormState(
|
|
||||||
rawFormValue,
|
|
||||||
formDefaultValue,
|
|
||||||
Object.prototype.hasOwnProperty.call(attrs, "value"),
|
|
||||||
sensitive,
|
|
||||||
);
|
|
||||||
if (sensitive) delete attrs.value;
|
|
||||||
|
|
||||||
nodes.push({
|
|
||||||
backendNodeId,
|
|
||||||
parentBackendNodeId,
|
|
||||||
...(context.frameId ? { frameId: context.frameId } : {}),
|
|
||||||
ownerFrameBackendNodeId: context.ownerFrameBackendNodeId,
|
|
||||||
tag,
|
|
||||||
attrs,
|
|
||||||
rect,
|
|
||||||
localRect,
|
|
||||||
paintOrder,
|
|
||||||
position,
|
|
||||||
pointerEvents,
|
|
||||||
cursor,
|
|
||||||
rendered,
|
|
||||||
textContent,
|
|
||||||
...(formValue !== undefined ? { formValue } : {}),
|
|
||||||
...(tag === "input" || tag === "textarea"
|
|
||||||
? {
|
|
||||||
formPlaceholder: attrs.placeholder ?? "",
|
|
||||||
...(!sensitive ? { formDefaultValue } : {}),
|
|
||||||
...(formState ? { formState } : {}),
|
|
||||||
}
|
|
||||||
: {}),
|
|
||||||
...(checkedInputs.has(n) ? { formValue: "true", formState: "filled" } : {}),
|
|
||||||
...(selectedOptions.has(n) ? { formValue: attrs.value ?? textContent ?? "" } : {}),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return { nodes, excludedBackendNodeIds };
|
|
||||||
}
|
|
||||||
|
|
||||||
interface ParseFrameDocumentsResult {
|
|
||||||
iframeNodes: CapturedIframeNodes;
|
|
||||||
frameOwnerBackendNodeIds: Map<string, number>;
|
|
||||||
frameParentIds: Map<string, string>;
|
|
||||||
excludedBackendNodeIds: Set<number>;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseChildFrameDocuments(
|
|
||||||
documents: SnapshotDocument[],
|
|
||||||
strings: string[],
|
|
||||||
dpr: number,
|
|
||||||
parentDocIndex: number,
|
|
||||||
parentNodes: CapturedNode[],
|
|
||||||
parentContext: FrameContext,
|
|
||||||
visited = new Set<number>(),
|
|
||||||
): ParseFrameDocumentsResult {
|
|
||||||
const iframeNodes: CapturedIframeNodes = new Map();
|
|
||||||
const frameOwnerBackendNodeIds = new Map<string, number>();
|
|
||||||
const frameParentIds = new Map<string, string>();
|
|
||||||
const excludedBackendNodeIds = new Set<number>();
|
|
||||||
const parentDoc = documents[parentDocIndex];
|
|
||||||
const cdi = sparseIndexMap(parentDoc?.nodes?.contentDocumentIndex);
|
|
||||||
if (cdi.size === 0) {
|
|
||||||
return { iframeNodes, frameOwnerBackendNodeIds, frameParentIds, excludedBackendNodeIds };
|
|
||||||
}
|
|
||||||
|
|
||||||
const parentBackendIds = parentDoc?.nodes?.backendNodeId ?? [];
|
|
||||||
const parentNodeByBackendId = new Map(parentNodes.map((node) => [node.backendNodeId, node]));
|
|
||||||
|
|
||||||
for (const [nodeArrayIdx, childDocIndex] of cdi) {
|
|
||||||
if (visited.has(childDocIndex)) continue;
|
|
||||||
const childDoc = documents[childDocIndex];
|
|
||||||
if (!childDoc) continue;
|
|
||||||
const iframeBackendId = parentBackendIds[nodeArrayIdx];
|
|
||||||
if (iframeBackendId === undefined) continue;
|
|
||||||
const iframeNode = parentNodeByBackendId.get(iframeBackendId);
|
|
||||||
const projection =
|
|
||||||
parentContext.projection && iframeNode?.localRect
|
|
||||||
? childFrameProjection(parentContext.projection, iframeNode.localRect)
|
|
||||||
: null;
|
|
||||||
|
|
||||||
const childContext: FrameContext = {
|
|
||||||
frameId: snapshotFrameId(childDoc, strings),
|
|
||||||
ownerFrameBackendNodeId: iframeBackendId,
|
|
||||||
projection,
|
|
||||||
scrollX: childDoc.scrollOffsetX ?? 0,
|
|
||||||
scrollY: childDoc.scrollOffsetY ?? 0,
|
|
||||||
};
|
|
||||||
const nextVisited = new Set(visited);
|
|
||||||
nextVisited.add(childDocIndex);
|
|
||||||
const parsed = parseDocumentNodes(childDoc, strings, dpr, childContext);
|
|
||||||
iframeNodes.set(iframeBackendId, parsed.nodes);
|
|
||||||
if (childContext.frameId) {
|
|
||||||
frameOwnerBackendNodeIds.set(childContext.frameId, iframeBackendId);
|
|
||||||
if (parentContext.frameId) frameParentIds.set(childContext.frameId, parentContext.frameId);
|
|
||||||
}
|
|
||||||
for (const id of parsed.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
|
||||||
|
|
||||||
const nested = parseChildFrameDocuments(
|
|
||||||
documents,
|
|
||||||
strings,
|
|
||||||
dpr,
|
|
||||||
childDocIndex,
|
|
||||||
parsed.nodes,
|
|
||||||
childContext,
|
|
||||||
nextVisited,
|
|
||||||
);
|
|
||||||
for (const [nestedFrameId, nestedNodes] of nested.iframeNodes) {
|
|
||||||
iframeNodes.set(nestedFrameId, nestedNodes);
|
|
||||||
}
|
|
||||||
for (const [frameId, ownerBackendNodeId] of nested.frameOwnerBackendNodeIds) {
|
|
||||||
frameOwnerBackendNodeIds.set(frameId, ownerBackendNodeId);
|
|
||||||
}
|
|
||||||
for (const [frameId, parentFrameId] of nested.frameParentIds) {
|
|
||||||
frameParentIds.set(frameId, parentFrameId);
|
|
||||||
}
|
|
||||||
for (const id of nested.excludedBackendNodeIds) excludedBackendNodeIds.add(id);
|
|
||||||
}
|
|
||||||
|
|
||||||
return { iframeNodes, frameOwnerBackendNodeIds, frameParentIds, excludedBackendNodeIds };
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function captureViewModel(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
options: CaptureViewModelOptions = {},
|
|
||||||
): Promise<CapturedViewModel> {
|
|
||||||
throwIfAborted(options.signal);
|
|
||||||
let metrics: LayoutMetricsReply = {};
|
|
||||||
try {
|
|
||||||
metrics = await cdp.send<LayoutMetricsReply>(tabId, "Page.getLayoutMetrics", {});
|
|
||||||
} catch (error) {
|
|
||||||
if (isAbortError(error)) throw error;
|
|
||||||
console.debug("[bsk capture] layout metrics unavailable", error);
|
|
||||||
}
|
|
||||||
throwIfAborted(options.signal);
|
|
||||||
const dpr = devicePixelRatio(metrics);
|
|
||||||
const vpSrc = metrics.cssLayoutViewport ?? metrics.layoutViewport ?? {};
|
|
||||||
const viewport: Viewport = {
|
|
||||||
width: vpSrc.clientWidth ?? 0,
|
|
||||||
height: vpSrc.clientHeight ?? 0,
|
|
||||||
};
|
|
||||||
const scrollX = vpSrc.pageX ?? 0;
|
|
||||||
const scrollY = vpSrc.pageY ?? 0;
|
|
||||||
|
|
||||||
await cdp.send(tabId, "DOMSnapshot.enable", {});
|
|
||||||
throwIfAborted(options.signal);
|
|
||||||
const snap = await cdp.send<SnapshotReply>(tabId, "DOMSnapshot.captureSnapshot", {
|
|
||||||
computedStyles: REQUESTED_STYLES,
|
|
||||||
includePaintOrder: true,
|
|
||||||
includeDOMRects: true,
|
|
||||||
});
|
|
||||||
throwIfAborted(options.signal);
|
|
||||||
|
|
||||||
const strings = snap.strings ?? [];
|
|
||||||
const documents = snap.documents ?? [];
|
|
||||||
const doc0 = documents[0];
|
|
||||||
if (!doc0?.nodes?.backendNodeId) {
|
|
||||||
return {
|
|
||||||
nodes: [],
|
|
||||||
viewport,
|
|
||||||
iframeNodes: new Map(),
|
|
||||||
excludedBackendNodeIds: new Set(),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const topContext: FrameContext = {
|
|
||||||
frameId: snapshotFrameId(doc0, strings),
|
|
||||||
ownerFrameBackendNodeId: null,
|
|
||||||
projection: {
|
|
||||||
sourceClips: [],
|
|
||||||
edges: [],
|
|
||||||
topViewport: viewport,
|
|
||||||
},
|
|
||||||
scrollX,
|
|
||||||
scrollY,
|
|
||||||
};
|
|
||||||
const mainParsed = parseDocumentNodes(doc0, strings, dpr, topContext);
|
|
||||||
const nodes = mainParsed.nodes;
|
|
||||||
const excludedBackendNodeIds = new Set(mainParsed.excludedBackendNodeIds);
|
|
||||||
|
|
||||||
const frameParsed = parseChildFrameDocuments(documents, strings, dpr, 0, nodes, topContext);
|
|
||||||
const iframeNodes = frameParsed.iframeNodes;
|
|
||||||
for (const id of frameParsed.excludedBackendNodeIds) {
|
|
||||||
excludedBackendNodeIds.add(id);
|
|
||||||
}
|
|
||||||
|
|
||||||
await enrichFormControlStates(cdp, tabId, [nodes, ...iframeNodes.values()], options.signal);
|
|
||||||
throwIfAborted(options.signal);
|
|
||||||
|
|
||||||
const frameNodes = new Map<string, CapturedNode[]>();
|
|
||||||
if (topContext.frameId) frameNodes.set(topContext.frameId, nodes);
|
|
||||||
for (const iframeFrameNodes of iframeNodes.values()) {
|
|
||||||
const frameId = iframeFrameNodes.find((node) => node.frameId)?.frameId;
|
|
||||||
if (frameId) frameNodes.set(frameId, iframeFrameNodes);
|
|
||||||
}
|
|
||||||
for (const [frameId, ownerBackendNodeId] of frameParsed.frameOwnerBackendNodeIds) {
|
|
||||||
if (!frameNodes.has(frameId)) {
|
|
||||||
frameNodes.set(frameId, iframeNodes.get(ownerBackendNodeId) ?? []);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
nodes,
|
|
||||||
viewport,
|
|
||||||
iframeNodes,
|
|
||||||
frameNodes,
|
|
||||||
frameOwnerBackendNodeIds: frameParsed.frameOwnerBackendNodeIds,
|
|
||||||
frameParentIds: frameParsed.frameParentIds,
|
|
||||||
...(topContext.frameId ? { rootFrameId: topContext.frameId } : {}),
|
|
||||||
excludedBackendNodeIds,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,141 @@
|
|||||||
|
import type { Viewport } from "@browser-skill/vom";
|
||||||
|
import type { CdpFrame, CdpTarget } from "@/browser-driver/frame-graph";
|
||||||
|
import { isOverlayHostNode } from "@/lib/overlay-bridge";
|
||||||
|
import type { FrameProjectionIssue } from "../geometry/coordinate-types";
|
||||||
|
import { createCaptureCheckpoint } from "./capture-abort";
|
||||||
|
import type { CapturedNode } from "./capture-types";
|
||||||
|
import type { FrameOwnedAxNode } from "./frame-document";
|
||||||
|
|
||||||
|
/** Bounds retain their raw snapshot document layout units until normalization. */
|
||||||
|
export interface SnapshotLayout {
|
||||||
|
readonly boundsSpace: "snapshot-document-layout";
|
||||||
|
bounds?: number[];
|
||||||
|
styles: Readonly<Record<string, string>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DecodedNode extends Omit<CapturedNode, "rect" | "localRect" | "rendered"> {
|
||||||
|
nodeType?: number;
|
||||||
|
layout?: SnapshotLayout;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NodeFacts extends CapturedNode {
|
||||||
|
nodeType?: number;
|
||||||
|
layout?: SnapshotLayout;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DocumentIndex<T extends DecodedNode = NodeFacts> {
|
||||||
|
readonly nodes: ReadonlyMap<number, T>;
|
||||||
|
readonly excludedBackendNodeIds: ReadonlySet<number>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DecodedDocument {
|
||||||
|
nodes: DecodedNode[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** All snapshot nodes participate, including document and shadow roots. This
|
||||||
|
* preserves overlay propagation when the semantic adapter omits those nodes. */
|
||||||
|
export async function buildDocumentIndex<T extends DecodedNode>(
|
||||||
|
input: readonly T[],
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<DocumentIndex<T>> {
|
||||||
|
const checkpoint = createCaptureCheckpoint(signal);
|
||||||
|
const nodes = new Map<number, T>();
|
||||||
|
const overlayByNode = new Map<number, boolean>();
|
||||||
|
const excludedBackendNodeIds = new Set<number>();
|
||||||
|
for (let i = 0; i < input.length; i++) {
|
||||||
|
if (i % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const node = input[i];
|
||||||
|
nodes.set(node.backendNodeId, node);
|
||||||
|
}
|
||||||
|
let work = 0;
|
||||||
|
for (const node of input) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
if (overlayByNode.has(node.backendNodeId)) continue;
|
||||||
|
const path: DecodedNode[] = [];
|
||||||
|
const visiting = new Set<number>();
|
||||||
|
let current: DecodedNode | undefined = node;
|
||||||
|
let overlay = false;
|
||||||
|
while (current && !overlayByNode.has(current.backendNodeId)) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
if (visiting.has(current.backendNodeId)) {
|
||||||
|
// Only an overlay inside the cycle may mark the cycle and its descendants.
|
||||||
|
overlay = path
|
||||||
|
.slice(path.findIndex((item) => item.backendNodeId === current!.backendNodeId))
|
||||||
|
.some((item) => isOverlayHostNode(item.tag, Object.keys(item.attrs)));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
visiting.add(current.backendNodeId);
|
||||||
|
path.push(current);
|
||||||
|
if (current.parentBackendNodeId === null) {
|
||||||
|
current = undefined;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
current = nodes.get(current.parentBackendNodeId);
|
||||||
|
}
|
||||||
|
if (current && overlayByNode.has(current.backendNodeId))
|
||||||
|
overlay = overlayByNode.get(current.backendNodeId)!;
|
||||||
|
for (let i = path.length - 1; i >= 0; i--) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const item = path[i];
|
||||||
|
overlay = overlay || isOverlayHostNode(item.tag, Object.keys(item.attrs));
|
||||||
|
overlayByNode.set(item.backendNodeId, overlay);
|
||||||
|
if (overlay) excludedBackendNodeIds.add(item.backendNodeId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { nodes, excludedBackendNodeIds };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Narrow input shared by the existing semantic scene/hover consumers. */
|
||||||
|
export interface CapturedSceneInput {
|
||||||
|
nodes: CapturedNode[];
|
||||||
|
viewport: Viewport;
|
||||||
|
rootFrameId?: string;
|
||||||
|
excludedBackendNodeIds: ReadonlySet<number>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CaptureIssue {
|
||||||
|
/** Owner failure or inherited blockage; absent for other geometry failures. */
|
||||||
|
projectionIssue?: FrameProjectionIssue;
|
||||||
|
target: CdpTarget;
|
||||||
|
frameId?: string;
|
||||||
|
stage: "dom" | "ax" | "ownership" | "geometry" | "forms";
|
||||||
|
reason: "capture-unavailable" | "frame-ownership-unresolved" | "geometry-unavailable";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DocumentFacts<T extends FrameOwnedAxNode> {
|
||||||
|
readonly frame: CdpFrame;
|
||||||
|
readonly index: DocumentIndex;
|
||||||
|
readonly domNodes: CapturedNode[];
|
||||||
|
readonly axNodes: T[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ObservationFacts<T extends FrameOwnedAxNode> {
|
||||||
|
readonly rootFrameId: string;
|
||||||
|
readonly viewport: Viewport;
|
||||||
|
readonly documents: readonly DocumentFacts<T>[];
|
||||||
|
readonly issues: readonly CaptureIssue[];
|
||||||
|
readonly startedAt: number;
|
||||||
|
readonly finishedAt: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CapturedSurfaceProbe {
|
||||||
|
triggerBackendNodeId: number;
|
||||||
|
triggerPoint?: { x: number; y: number };
|
||||||
|
triggerAction: "hover" | "focus" | string;
|
||||||
|
subItems: string[];
|
||||||
|
confidence?: "high" | "medium" | "low";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type { CapturedNode } from "./capture-types";
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
import type { CdpRunner } from "../shared";
|
||||||
|
import { isAbortError, throwIfAborted } from "./capture-abort";
|
||||||
|
import type { CapturedNode } from "./capture-types";
|
||||||
|
|
||||||
|
interface RuntimeEvaluateReply {
|
||||||
|
result?: { deepSerializedValue?: DeepSerializedValue };
|
||||||
|
}
|
||||||
|
const MAX_FORM_ENRICH_CONTROLS = 250;
|
||||||
|
|
||||||
|
interface CapturedFormState {
|
||||||
|
value?: string;
|
||||||
|
defaultValue?: string;
|
||||||
|
placeholder?: string;
|
||||||
|
state?: "empty" | "filled" | "default";
|
||||||
|
sensitive?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeepSerializedValue {
|
||||||
|
type: string;
|
||||||
|
value?: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
function formStateBatchExpression(maxControls: number): string {
|
||||||
|
return `(() => {
|
||||||
|
const maxControls = ${JSON.stringify(maxControls)};
|
||||||
|
let remaining = maxControls;
|
||||||
|
const controlSelector = "input,textarea,select";
|
||||||
|
const controlState = (el) => {
|
||||||
|
const tag = el.tagName.toLowerCase();
|
||||||
|
const type = tag === "input" ? String(el.type || "text").toLowerCase() : tag;
|
||||||
|
const sensitive = type === "password" || type === "credit-card";
|
||||||
|
const rawValue = typeof el.value === "string" ? el.value : "";
|
||||||
|
const defaultValue = typeof el.defaultValue === "string" ? el.defaultValue : "";
|
||||||
|
const placeholder = typeof el.placeholder === "string" ? el.placeholder : "";
|
||||||
|
const state = rawValue === "" ? "empty" : rawValue === defaultValue ? "default" : "filled";
|
||||||
|
return {
|
||||||
|
state,
|
||||||
|
sensitive,
|
||||||
|
placeholder,
|
||||||
|
...(sensitive ? {} : { value: rawValue, defaultValue }),
|
||||||
|
};
|
||||||
|
};
|
||||||
|
const controls = [];
|
||||||
|
const collect = (doc) => {
|
||||||
|
for (const el of Array.from(doc.querySelectorAll(controlSelector))) {
|
||||||
|
if (remaining <= 0) break;
|
||||||
|
// Deep serialization supplies the node's backend id. Keep the
|
||||||
|
// state as JSON so decoding needs no general-purpose V8 deserializer.
|
||||||
|
controls.push([el, JSON.stringify(controlState(el))]);
|
||||||
|
remaining -= 1;
|
||||||
|
}
|
||||||
|
for (const frame of Array.from(doc.querySelectorAll("iframe"))) {
|
||||||
|
if (remaining <= 0) break;
|
||||||
|
let childDoc = null;
|
||||||
|
try { childDoc = frame.contentDocument; } catch { childDoc = null; }
|
||||||
|
if (childDoc) collect(childDoc);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
collect(document);
|
||||||
|
return controls;
|
||||||
|
})()`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function formStatesByBackendId(result: RuntimeEvaluateReply): Map<number, CapturedFormState> {
|
||||||
|
const states = new Map<number, CapturedFormState>();
|
||||||
|
const serialized = result.result?.deepSerializedValue;
|
||||||
|
if (serialized?.type !== "array" || !Array.isArray(serialized.value)) return states;
|
||||||
|
for (const entry of serialized.value as DeepSerializedValue[]) {
|
||||||
|
if (entry?.type !== "array" || !Array.isArray(entry.value)) continue;
|
||||||
|
const [element, json] = entry.value as DeepSerializedValue[];
|
||||||
|
if (element?.type !== "node" || json?.type !== "string" || typeof json.value !== "string") {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const backendNodeId = (element.value as { backendNodeId?: number } | undefined)?.backendNodeId;
|
||||||
|
if (typeof backendNodeId !== "number" || !Number.isSafeInteger(backendNodeId)) continue;
|
||||||
|
try {
|
||||||
|
const state = JSON.parse(json.value) as CapturedFormState | null;
|
||||||
|
if (
|
||||||
|
!state ||
|
||||||
|
!["empty", "filled", "default"].includes(state.state ?? "") ||
|
||||||
|
typeof state.sensitive !== "boolean" ||
|
||||||
|
typeof state.placeholder !== "string" ||
|
||||||
|
(!state.sensitive &&
|
||||||
|
(typeof state.value !== "string" || typeof state.defaultValue !== "string"))
|
||||||
|
) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
states.set(backendNodeId, state);
|
||||||
|
} catch {
|
||||||
|
// A malformed entry must not overwrite the snapshot's own state.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return states;
|
||||||
|
}
|
||||||
|
|
||||||
|
function applyFormStates(nodes: CapturedNode[], states: Map<number, CapturedFormState>): void {
|
||||||
|
for (const node of nodes) {
|
||||||
|
if (!["input", "textarea", "select"].includes(node.tag)) continue;
|
||||||
|
const state = states.get(node.backendNodeId);
|
||||||
|
if (!state) continue;
|
||||||
|
node.formState = state.state;
|
||||||
|
node.formPlaceholder = state.placeholder ?? "";
|
||||||
|
if (
|
||||||
|
state.sensitive ||
|
||||||
|
(node.tag === "input" && (node.attrs.type ?? "").toLowerCase() === "password")
|
||||||
|
) {
|
||||||
|
delete node.formValue;
|
||||||
|
delete node.formDefaultValue;
|
||||||
|
delete node.attrs.value;
|
||||||
|
} else {
|
||||||
|
node.formDefaultValue = state.defaultValue ?? "";
|
||||||
|
if (state.value !== undefined) node.formValue = state.value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function enrichFormControlStates(
|
||||||
|
cdp: CdpRunner,
|
||||||
|
tabId: number,
|
||||||
|
frameNodeGroups: CapturedNode[][],
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<boolean> {
|
||||||
|
const hasControls = frameNodeGroups.some((nodes) =>
|
||||||
|
nodes.some((node) => ["input", "textarea", "select"].includes(node.tag)),
|
||||||
|
);
|
||||||
|
if (!hasControls) return true;
|
||||||
|
const objectGroup = `bsk-vom-forms-${crypto.randomUUID()}`;
|
||||||
|
try {
|
||||||
|
throwIfAborted(signal);
|
||||||
|
const result = await cdp.send<RuntimeEvaluateReply>(tabId, "Runtime.evaluate", {
|
||||||
|
expression: formStateBatchExpression(MAX_FORM_ENRICH_CONTROLS),
|
||||||
|
objectGroup,
|
||||||
|
serializationOptions: {
|
||||||
|
serialization: "deep",
|
||||||
|
maxDepth: 3,
|
||||||
|
additionalParameters: { maxNodeDepth: 0, includeShadowTree: "none" },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
throwIfAborted(signal);
|
||||||
|
// Backend ids are scoped to this capture's CDP target. OOPIF targets
|
||||||
|
// have separate enrichment calls and never share this lookup.
|
||||||
|
const states = formStatesByBackendId(result);
|
||||||
|
for (const nodes of frameNodeGroups) {
|
||||||
|
applyFormStates(nodes, states);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
} catch (error) {
|
||||||
|
if (isAbortError(error)) throw error;
|
||||||
|
// Best-effort enrichment. DOMSnapshot/AX data still carries the nodes.
|
||||||
|
return false;
|
||||||
|
} finally {
|
||||||
|
await cdp.send(tabId, "Runtime.releaseObjectGroup", { objectGroup }).catch(() => undefined);
|
||||||
|
throwIfAborted(signal);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,181 +0,0 @@
|
|||||||
import type { CdpFrame, CdpFrameGraph } from "@/browser-driver/frame-graph";
|
|
||||||
import { resolveFrameProjection } from "../frame-geometry";
|
|
||||||
import { type GeometryProjection, projectRectToViewport } from "../geometry";
|
|
||||||
import { type CdpRunner, cdpRunnerForTarget, sendToCdpTarget } from "../shared";
|
|
||||||
import { type CapturedNode, type CapturedViewModel, captureViewModel } from "./capture";
|
|
||||||
import {
|
|
||||||
buildFrameDocuments,
|
|
||||||
type FrameAxBatch,
|
|
||||||
type FrameDocument,
|
|
||||||
type FrameOwnedAxNode,
|
|
||||||
} from "./frame-document";
|
|
||||||
|
|
||||||
export type FrameAxNode = FrameOwnedAxNode;
|
|
||||||
export type CapturedFrameDocument<T extends FrameAxNode> = FrameDocument<T>;
|
|
||||||
|
|
||||||
function throwIfAborted(signal?: AbortSignal): void {
|
|
||||||
if (signal?.aborted) throw new DOMException("observation aborted", "AbortError");
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAbortError(err: unknown): boolean {
|
|
||||||
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(
|
|
||||||
nodes: CapturedNode[],
|
|
||||||
projection: GeometryProjection | null,
|
|
||||||
): CapturedNode[] {
|
|
||||||
return nodes.map((node) => ({
|
|
||||||
...node,
|
|
||||||
rect: projection
|
|
||||||
? (() => {
|
|
||||||
const bounds = projectRectToViewport(node.rect, projection);
|
|
||||||
return bounds ? { x: bounds.x, y: bounds.y, w: bounds.width, h: bounds.height } : null;
|
|
||||||
})()
|
|
||||||
: null,
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
async function captureMissingFrameDocuments(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
graph: CdpFrameGraph,
|
|
||||||
captured: CapturedViewModel,
|
|
||||||
signal?: AbortSignal,
|
|
||||||
): Promise<void> {
|
|
||||||
if (!captured.frameNodes) captured.frameNodes = new Map();
|
|
||||||
if (!captured.frameOwnerBackendNodeIds) captured.frameOwnerBackendNodeIds = new Map();
|
|
||||||
if (!captured.frameParentIds) captured.frameParentIds = new Map();
|
|
||||||
|
|
||||||
for (const frame of graph.frames) {
|
|
||||||
if (!frame.target.sessionId || captured.frameNodes.has(frame.frameId)) continue;
|
|
||||||
try {
|
|
||||||
const child = await captureViewModel(cdpRunnerForTarget(cdp, frame.target), tabId, {
|
|
||||||
signal,
|
|
||||||
});
|
|
||||||
let projection: GeometryProjection | null = null;
|
|
||||||
try {
|
|
||||||
projection = await resolveFrameProjection(cdp, graph, frame.frameId);
|
|
||||||
} catch (err) {
|
|
||||||
if (isAbortError(err)) throw err;
|
|
||||||
console.debug("[bsk observation] child frame geometry projection failed", {
|
|
||||||
frameId: frame.frameId,
|
|
||||||
err,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
const rootFrameId = child.rootFrameId ?? frame.frameId;
|
|
||||||
const childFrames = child.frameNodes ?? new Map<string, CapturedNode[]>();
|
|
||||||
if (!childFrames.has(rootFrameId)) childFrames.set(rootFrameId, child.nodes);
|
|
||||||
if (rootFrameId !== frame.frameId && !childFrames.has(frame.frameId)) {
|
|
||||||
childFrames.set(
|
|
||||||
frame.frameId,
|
|
||||||
child.nodes.map((node) => ({ ...node, frameId: frame.frameId })),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
for (const [childFrameId, nodes] of childFrames) {
|
|
||||||
captured.frameNodes.set(childFrameId, transformFrameNodes(nodes, projection));
|
|
||||||
}
|
|
||||||
if (frame.ownerBackendNodeId !== undefined) {
|
|
||||||
captured.iframeNodes.set(
|
|
||||||
frame.ownerBackendNodeId,
|
|
||||||
captured.frameNodes.get(frame.frameId) ?? [],
|
|
||||||
);
|
|
||||||
captured.frameOwnerBackendNodeIds.set(frame.frameId, frame.ownerBackendNodeId);
|
|
||||||
}
|
|
||||||
if (frame.parentFrameId) captured.frameParentIds.set(frame.frameId, frame.parentFrameId);
|
|
||||||
for (const [childFrameId, ownerBackendNodeId] of child.frameOwnerBackendNodeIds ?? []) {
|
|
||||||
captured.frameOwnerBackendNodeIds.set(childFrameId, ownerBackendNodeId);
|
|
||||||
}
|
|
||||||
for (const [childFrameId, parentFrameId] of child.frameParentIds ?? []) {
|
|
||||||
captured.frameParentIds.set(childFrameId, parentFrameId);
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
if (isAbortError(err)) throw err;
|
|
||||||
console.debug("[bsk observation] child frame DOM capture failed", {
|
|
||||||
frameId: frame.frameId,
|
|
||||||
err,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function captureAxTrees<T extends FrameAxNode>(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
discoveredFrames: CdpFrame[],
|
|
||||||
captured: CapturedViewModel,
|
|
||||||
signal?: AbortSignal,
|
|
||||||
): Promise<FrameAxBatch<T>[]> {
|
|
||||||
let frames = [...discoveredFrames];
|
|
||||||
const capturedFrameIds = [...(captured.frameNodes?.keys() ?? [])];
|
|
||||||
if (frames.length === 0) {
|
|
||||||
const rootFrameId = captured.rootFrameId ?? capturedFrameIds[0] ?? "root";
|
|
||||||
frames = [{ frameId: rootFrameId, target: { tabId } }];
|
|
||||||
}
|
|
||||||
for (const frameId of capturedFrameIds) {
|
|
||||||
if (!frames.some((frame) => frame.frameId === frameId)) {
|
|
||||||
frames.push({ frameId, target: { tabId } });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let firstFailure: unknown;
|
|
||||||
const trees = await Promise.all(
|
|
||||||
frames.map(async (frame): Promise<FrameAxBatch<T>> => {
|
|
||||||
try {
|
|
||||||
throwIfAborted(signal);
|
|
||||||
await sendToCdpTarget(cdp, frame.target, "Accessibility.enable", {});
|
|
||||||
const result = await sendToCdpTarget<{ nodes?: T[] }>(
|
|
||||||
cdp,
|
|
||||||
frame.target,
|
|
||||||
"Accessibility.getFullAXTree",
|
|
||||||
frame.frameId === "root" ? {} : { frameId: frame.frameId },
|
|
||||||
);
|
|
||||||
throwIfAborted(signal);
|
|
||||||
return {
|
|
||||||
frame,
|
|
||||||
nodes: result.nodes ?? [],
|
|
||||||
};
|
|
||||||
} catch (err) {
|
|
||||||
if (isAbortError(err)) throw err;
|
|
||||||
firstFailure ??= err;
|
|
||||||
console.debug("[bsk observation] frame AX capture failed", {
|
|
||||||
frameId: frame.frameId,
|
|
||||||
err,
|
|
||||||
});
|
|
||||||
return { frame, nodes: [] };
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
const capturedNodeCount = [...captured.iframeNodes.values()].reduce(
|
|
||||||
(count, nodes) => count + nodes.length,
|
|
||||||
captured.nodes.length,
|
|
||||||
);
|
|
||||||
if (firstFailure && capturedNodeCount === 0 && trees.every((tree) => tree.nodes.length === 0)) {
|
|
||||||
throw firstFailure;
|
|
||||||
}
|
|
||||||
return trees;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function captureFrameData<T extends FrameAxNode>(
|
|
||||||
cdp: CdpRunner,
|
|
||||||
tabId: number,
|
|
||||||
captured: CapturedViewModel,
|
|
||||||
signal?: AbortSignal,
|
|
||||||
): Promise<CapturedFrameDocument<T>[]> {
|
|
||||||
const graph = await discoverFrameGraph(cdp, tabId);
|
|
||||||
const frames = graph?.frames ?? [];
|
|
||||||
if (graph) await captureMissingFrameDocuments(cdp, tabId, graph, captured, signal);
|
|
||||||
throwIfAborted(signal);
|
|
||||||
const batches = await captureAxTrees<T>(cdp, tabId, frames, captured, signal);
|
|
||||||
return buildFrameDocuments(graph, batches, captured);
|
|
||||||
}
|
|
||||||
@@ -4,7 +4,8 @@ import {
|
|||||||
type CdpTarget,
|
type CdpTarget,
|
||||||
cdpTargetKey,
|
cdpTargetKey,
|
||||||
} from "@/browser-driver/frame-graph";
|
} from "@/browser-driver/frame-graph";
|
||||||
import type { CapturedNode, CapturedViewModel } from "./capture";
|
import { createCaptureCheckpoint } from "./capture-abort";
|
||||||
|
import type { CapturedNode } from "./capture-types";
|
||||||
|
|
||||||
export interface FrameOwnedAxNode {
|
export interface FrameOwnedAxNode {
|
||||||
nodeId: string;
|
nodeId: string;
|
||||||
@@ -23,6 +24,15 @@ export interface FrameDocument<T extends FrameOwnedAxNode> extends CdpFrame {
|
|||||||
contextScopeId: string;
|
contextScopeId: string;
|
||||||
axNodes: T[];
|
axNodes: T[];
|
||||||
domNodes: CapturedNode[];
|
domNodes: CapturedNode[];
|
||||||
|
excludedBackendNodeIds?: ReadonlySet<number>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Explicit snapshot document data used to join DOM and AX ownership. */
|
||||||
|
export interface FrameDomInput {
|
||||||
|
nodes: CapturedNode[];
|
||||||
|
rootFrameId?: string;
|
||||||
|
frameNodes?: ReadonlyMap<string, CapturedNode[]>;
|
||||||
|
frameExcludedBackendNodeIds?: ReadonlyMap<string, ReadonlySet<number>>;
|
||||||
}
|
}
|
||||||
|
|
||||||
interface Ownership {
|
interface Ownership {
|
||||||
@@ -47,35 +57,25 @@ function targetBackendKey(target: CdpTarget, backendNodeId: number): string {
|
|||||||
function frameList<T extends FrameOwnedAxNode>(
|
function frameList<T extends FrameOwnedAxNode>(
|
||||||
graph: CdpFrameGraph | null,
|
graph: CdpFrameGraph | null,
|
||||||
batches: FrameAxBatch<T>[],
|
batches: FrameAxBatch<T>[],
|
||||||
captured: CapturedViewModel,
|
|
||||||
): CdpFrame[] {
|
): CdpFrame[] {
|
||||||
const frames = new Map<string, CdpFrame>();
|
const frames = new Map<string, CdpFrame>();
|
||||||
for (const frame of graph?.frames ?? []) frames.set(frame.frameId, frame);
|
for (const frame of graph?.frames ?? []) frames.set(frame.frameId, frame);
|
||||||
for (const batch of batches) {
|
for (const batch of batches) {
|
||||||
if (!frames.has(batch.frame.frameId)) frames.set(batch.frame.frameId, batch.frame);
|
if (!frames.has(batch.frame.frameId)) frames.set(batch.frame.frameId, batch.frame);
|
||||||
}
|
}
|
||||||
for (const frameId of captured.frameNodes?.keys() ?? []) {
|
return [...frames.values()];
|
||||||
if (!frames.has(frameId))
|
|
||||||
frames.set(frameId, { frameId, target: { tabId: batches[0]?.frame.target.tabId ?? 0 } });
|
|
||||||
}
|
|
||||||
return [...frames.values()].map((frame) => {
|
|
||||||
const ownerBackendNodeId =
|
|
||||||
frame.ownerBackendNodeId ?? captured.frameOwnerBackendNodeIds?.get(frame.frameId);
|
|
||||||
const parentFrameId = frame.parentFrameId ?? captured.frameParentIds?.get(frame.frameId);
|
|
||||||
return {
|
|
||||||
...frame,
|
|
||||||
...(ownerBackendNodeId !== undefined ? { ownerBackendNodeId } : {}),
|
|
||||||
...(parentFrameId ? { parentFrameId } : {}),
|
|
||||||
};
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function buildFrameDocuments<T extends FrameOwnedAxNode>(
|
export async function buildFrameDocuments<T extends FrameOwnedAxNode>(
|
||||||
graph: CdpFrameGraph | null,
|
graph: CdpFrameGraph | null,
|
||||||
batches: FrameAxBatch<T>[],
|
batches: FrameAxBatch<T>[],
|
||||||
captured: CapturedViewModel,
|
captured: FrameDomInput,
|
||||||
): FrameDocument<T>[] {
|
signal?: AbortSignal,
|
||||||
const frames = frameList(graph, batches, captured);
|
unresolved?: (frame: CdpFrame) => void,
|
||||||
|
): Promise<FrameDocument<T>[]> {
|
||||||
|
const checkpoint = createCaptureCheckpoint(signal);
|
||||||
|
let work = 0;
|
||||||
|
const frames = frameList(graph, batches);
|
||||||
const frameById = new Map(frames.map((frame) => [frame.frameId, frame]));
|
const frameById = new Map(frames.map((frame) => [frame.frameId, frame]));
|
||||||
const rootFrameId = graph?.rootFrameId ?? captured.rootFrameId ?? frames[0]?.frameId;
|
const rootFrameId = graph?.rootFrameId ?? captured.rootFrameId ?? frames[0]?.frameId;
|
||||||
const domNodesForFrame = (frameId: string): CapturedNode[] =>
|
const domNodesForFrame = (frameId: string): CapturedNode[] =>
|
||||||
@@ -83,54 +83,80 @@ export function buildFrameDocuments<T extends FrameOwnedAxNode>(
|
|||||||
const backendOwner = new Map<string, string>();
|
const backendOwner = new Map<string, string>();
|
||||||
for (const frame of frames) {
|
for (const frame of frames) {
|
||||||
for (const node of domNodesForFrame(frame.frameId)) {
|
for (const node of domNodesForFrame(frame.frameId)) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
backendOwner.set(targetBackendKey(frame.target, node.backendNodeId), frame.frameId);
|
backendOwner.set(targetBackendKey(frame.target, node.backendNodeId), frame.frameId);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const candidates = new Map<string, OwnedCandidate<T>>();
|
const candidates = new Map<string, OwnedCandidate<T>>();
|
||||||
for (const batch of batches) {
|
for (const batch of batches) {
|
||||||
const nodeById = new Map(batch.nodes.map((node) => [node.nodeId, node]));
|
const nodeById = new Map<string, T>();
|
||||||
const ownershipByNodeId = new Map<string, Ownership>();
|
|
||||||
const resolving = new Set<string>();
|
|
||||||
const resolveOwnership = (node: T): Ownership => {
|
|
||||||
const cached = ownershipByNodeId.get(node.nodeId);
|
|
||||||
if (cached) return cached;
|
|
||||||
if (node.frameId && frameById.has(node.frameId)) {
|
|
||||||
const ownership = { frameId: node.frameId, strength: 4 };
|
|
||||||
ownershipByNodeId.set(node.nodeId, ownership);
|
|
||||||
return ownership;
|
|
||||||
}
|
|
||||||
if (typeof node.backendDOMNodeId === "number") {
|
|
||||||
const frameId = backendOwner.get(
|
|
||||||
targetBackendKey(batch.frame.target, node.backendDOMNodeId),
|
|
||||||
);
|
|
||||||
if (frameId) {
|
|
||||||
const ownership = { frameId, strength: 3 };
|
|
||||||
ownershipByNodeId.set(node.nodeId, ownership);
|
|
||||||
return ownership;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (node.parentId && !resolving.has(node.nodeId)) {
|
|
||||||
const parent = nodeById.get(node.parentId);
|
|
||||||
if (parent) {
|
|
||||||
resolving.add(node.nodeId);
|
|
||||||
const inherited = resolveOwnership(parent);
|
|
||||||
resolving.delete(node.nodeId);
|
|
||||||
const ownership = {
|
|
||||||
frameId: inherited.frameId,
|
|
||||||
strength: Math.min(2, inherited.strength),
|
|
||||||
};
|
|
||||||
ownershipByNodeId.set(node.nodeId, ownership);
|
|
||||||
return ownership;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const ownership = { frameId: batch.frame.frameId, strength: 1 };
|
|
||||||
ownershipByNodeId.set(node.nodeId, ownership);
|
|
||||||
return ownership;
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const node of batch.nodes) {
|
for (const node of batch.nodes) {
|
||||||
const ownership = resolveOwnership(node);
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
nodeById.set(node.nodeId, node);
|
||||||
|
}
|
||||||
|
let reported = false;
|
||||||
|
const ownershipByNodeId = new Map<string, Ownership>();
|
||||||
|
for (const node of batch.nodes) {
|
||||||
|
const path: T[] = [];
|
||||||
|
const visiting = new Set<string>();
|
||||||
|
let current: T | undefined = node;
|
||||||
|
let ownership: Ownership = { frameId: batch.frame.frameId, strength: 1 };
|
||||||
|
while (current) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const cached = ownershipByNodeId.get(current.nodeId);
|
||||||
|
if (cached) {
|
||||||
|
ownership = cached;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if (visiting.has(current.nodeId)) break;
|
||||||
|
visiting.add(current.nodeId);
|
||||||
|
if (current.frameId) {
|
||||||
|
const frame = frameById.get(current.frameId);
|
||||||
|
// An explicit contradiction must not fall through to a guessed owner.
|
||||||
|
if (!frame || cdpTargetKey(frame.target) !== cdpTargetKey(batch.frame.target)) {
|
||||||
|
if (!reported) {
|
||||||
|
unresolved?.(batch.frame);
|
||||||
|
reported = true;
|
||||||
|
}
|
||||||
|
ownership = { frameId: "", strength: 0 };
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
ownership = { frameId: frame.frameId, strength: 4 };
|
||||||
|
ownershipByNodeId.set(current.nodeId, ownership);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
const frameId =
|
||||||
|
typeof current.backendDOMNodeId === "number"
|
||||||
|
? backendOwner.get(targetBackendKey(batch.frame.target, current.backendDOMNodeId))
|
||||||
|
: undefined;
|
||||||
|
if (frameId) {
|
||||||
|
ownership = { frameId, strength: 3 };
|
||||||
|
ownershipByNodeId.set(current.nodeId, ownership);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
path.push(current);
|
||||||
|
current = current.parentId ? nodeById.get(current.parentId) : undefined;
|
||||||
|
}
|
||||||
|
for (let i = path.length - 1; i >= 0; i--) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
ownership = { frameId: ownership.frameId, strength: Math.min(2, ownership.strength) };
|
||||||
|
ownershipByNodeId.set(path[i].nodeId, ownership);
|
||||||
|
}
|
||||||
|
if (!ownershipByNodeId.has(node.nodeId)) ownershipByNodeId.set(node.nodeId, ownership);
|
||||||
|
if (!ownership.frameId) continue;
|
||||||
const key = targetNodeKey(batch.frame.target, node.nodeId);
|
const key = targetNodeKey(batch.frame.target, node.nodeId);
|
||||||
const existing = candidates.get(key);
|
const existing = candidates.get(key);
|
||||||
if (!existing || ownership.strength > existing.ownership.strength) {
|
if (!existing || ownership.strength > existing.ownership.strength) {
|
||||||
@@ -144,6 +170,10 @@ export function buildFrameDocuments<T extends FrameOwnedAxNode>(
|
|||||||
);
|
);
|
||||||
const axNodesByFrame = new Map<string, T[]>();
|
const axNodesByFrame = new Map<string, T[]>();
|
||||||
for (const candidate of candidates.values()) {
|
for (const candidate of candidates.values()) {
|
||||||
|
if (work++ % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
const { node, target, ownership } = candidate;
|
const { node, target, ownership } = candidate;
|
||||||
const parentFrameId = node.parentId
|
const parentFrameId = node.parentId
|
||||||
? ownershipByTargetNode.get(targetNodeKey(target, node.parentId))
|
? ownershipByTargetNode.get(targetNodeKey(target, node.parentId))
|
||||||
@@ -169,5 +199,6 @@ export function buildFrameDocuments<T extends FrameOwnedAxNode>(
|
|||||||
contextScopeId: frame.frameId,
|
contextScopeId: frame.frameId,
|
||||||
axNodes: axNodesByFrame.get(frame.frameId) ?? [],
|
axNodes: axNodesByFrame.get(frame.frameId) ?? [],
|
||||||
domNodes: domNodesForFrame(frame.frameId),
|
domNodes: domNodesForFrame(frame.frameId),
|
||||||
|
excludedBackendNodeIds: captured.frameExcludedBackendNodeIds?.get(frame.frameId),
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,318 @@
|
|||||||
|
import type { Viewport } from "@browser-skill/vom";
|
||||||
|
import { type CdpFrame, type CdpTarget, cdpTargetKey } from "@/browser-driver/frame-graph";
|
||||||
|
import { type GeometryProjection, projectRectToViewport } from "../geometry";
|
||||||
|
import {
|
||||||
|
type FrameProjectionState,
|
||||||
|
projectSnapshotRect,
|
||||||
|
type SnapshotCoordinates,
|
||||||
|
snapshotCoordinates,
|
||||||
|
snapshotViewportRect,
|
||||||
|
} from "../geometry/coordinate-types";
|
||||||
|
import {
|
||||||
|
GeometryContext,
|
||||||
|
type LayoutMetrics,
|
||||||
|
snapshotLayoutScale,
|
||||||
|
} from "../geometry/frame-context";
|
||||||
|
import {
|
||||||
|
createCaptureCheckpoint,
|
||||||
|
isAbortError as isCaptureAbort,
|
||||||
|
throwIfAborted as throwCaptureAborted,
|
||||||
|
} from "./capture-abort";
|
||||||
|
import { buildDocumentIndex, type CaptureIssue, type DocumentIndex, type NodeFacts } from "./facts";
|
||||||
|
import {
|
||||||
|
decodeDocument,
|
||||||
|
type SnapshotDocument,
|
||||||
|
type SnapshotReply,
|
||||||
|
snapshotFrameId,
|
||||||
|
} from "./snapshot";
|
||||||
|
|
||||||
|
export interface FrameContext {
|
||||||
|
frameId?: string;
|
||||||
|
ownerFrameBackendNodeId: number | null;
|
||||||
|
projection: FrameProjectionState | null;
|
||||||
|
targetProjection?: GeometryProjection | null;
|
||||||
|
target: CdpTarget;
|
||||||
|
coordinates: SnapshotCoordinates | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NormalizedDocument {
|
||||||
|
nodes: NodeFacts[];
|
||||||
|
index: DocumentIndex;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Interpret one document using a supplied projection. No live reads or frame scheduling. */
|
||||||
|
export async function normalizeDocument(
|
||||||
|
doc: SnapshotDocument,
|
||||||
|
strings: string[],
|
||||||
|
context: FrameContext,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<NormalizedDocument> {
|
||||||
|
const decoded = await decodeDocument(doc, strings, signal);
|
||||||
|
const checkpoint = createCaptureCheckpoint(signal);
|
||||||
|
const nodes: NodeFacts[] = [];
|
||||||
|
for (let i = 0; i < decoded.nodes.length; i++) {
|
||||||
|
if (i % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const node = decoded.nodes[i];
|
||||||
|
const bounds = node.layout?.bounds ?? [];
|
||||||
|
const input = snapshotViewportRect(
|
||||||
|
bounds,
|
||||||
|
{ target: context.target, frameId: context.frameId },
|
||||||
|
context.coordinates,
|
||||||
|
);
|
||||||
|
const local = input?.rect;
|
||||||
|
let rect =
|
||||||
|
input && context.projection?.status === "available"
|
||||||
|
? projectSnapshotRect(input, context.projection.projection)
|
||||||
|
: null;
|
||||||
|
if (rect && context.targetProjection !== undefined)
|
||||||
|
rect = context.targetProjection
|
||||||
|
? projectRectToViewport(
|
||||||
|
{ x: rect.x, y: rect.y, w: rect.width, h: rect.height },
|
||||||
|
context.targetProjection,
|
||||||
|
)
|
||||||
|
: null;
|
||||||
|
const visibility = node.layout?.styles.visibility || "visible";
|
||||||
|
const opacity = node.layout?.styles.opacity || "1";
|
||||||
|
nodes.push({
|
||||||
|
...node,
|
||||||
|
...(context.frameId ? { frameId: context.frameId } : {}),
|
||||||
|
ownerFrameBackendNodeId: context.ownerFrameBackendNodeId,
|
||||||
|
localRect: local ? { x: local.x, y: local.y, w: local.width, h: local.height } : null,
|
||||||
|
rect: rect ? { x: rect.x, y: rect.y, w: rect.width, h: rect.height } : null,
|
||||||
|
rendered:
|
||||||
|
bounds.length >= 4 &&
|
||||||
|
bounds.slice(0, 4).every(Number.isFinite) &&
|
||||||
|
bounds[2] > 0 &&
|
||||||
|
bounds[3] > 0 &&
|
||||||
|
visibility !== "hidden" &&
|
||||||
|
visibility !== "collapse" &&
|
||||||
|
(Number.parseFloat(opacity) || 0) > 0,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
const index = await buildDocumentIndex(nodes, signal);
|
||||||
|
return {
|
||||||
|
nodes: nodes.filter(
|
||||||
|
(node) => !node.tag.startsWith("#") && !index.excludedBackendNodeIds.has(node.backendNodeId),
|
||||||
|
),
|
||||||
|
index,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NormalizedFrameDocument extends NormalizedDocument {
|
||||||
|
frame: CdpFrame;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** One target's snapshot. Source ownership is checked before interpreting any
|
||||||
|
* coordinates. Snapshot and live quad coordinates are deliberately not conflated. */
|
||||||
|
export async function normalizeSnapshot(
|
||||||
|
snapshot: SnapshotReply,
|
||||||
|
target: CdpTarget,
|
||||||
|
frames: readonly CdpFrame[],
|
||||||
|
geometry: GeometryContext,
|
||||||
|
issues: CaptureIssue[],
|
||||||
|
signal?: AbortSignal,
|
||||||
|
rootFrameId?: string,
|
||||||
|
): Promise<NormalizedFrameDocument[]> {
|
||||||
|
const strings = snapshot.strings ?? [];
|
||||||
|
const raw = snapshot.documents ?? [];
|
||||||
|
const ownerIds = new Set<number>();
|
||||||
|
for (const document of raw) {
|
||||||
|
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 frameById = new Map(frames.map((frame) => [frame.frameId, frame]));
|
||||||
|
const sources = new Map<string, SnapshotDocument>();
|
||||||
|
for (const doc of raw) {
|
||||||
|
const id = snapshotFrameId(doc, strings);
|
||||||
|
if (!id || !frameById.has(id) || sources.has(id)) {
|
||||||
|
issues.push({
|
||||||
|
target,
|
||||||
|
frameId: id,
|
||||||
|
stage: "ownership",
|
||||||
|
reason: "frame-ownership-unresolved",
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
sources.set(id, doc);
|
||||||
|
}
|
||||||
|
let metrics: LayoutMetrics = {};
|
||||||
|
try {
|
||||||
|
metrics = await geometry.layoutMetrics(target);
|
||||||
|
} catch (error) {
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
}
|
||||||
|
const viewport: Viewport = {
|
||||||
|
width: metrics.cssLayoutViewport?.clientWidth ?? 0,
|
||||||
|
height: metrics.cssLayoutViewport?.clientHeight ?? 0,
|
||||||
|
};
|
||||||
|
const layoutUnitsPerCssPixel = snapshotLayoutScale(metrics);
|
||||||
|
const viewportAvailable = [viewport.width, viewport.height].every(
|
||||||
|
(size) => Number.isFinite(size) && size > 0,
|
||||||
|
);
|
||||||
|
|
||||||
|
const children = new Map<string, CdpFrame[]>();
|
||||||
|
const pending: CdpFrame[] = [];
|
||||||
|
for (const frame of frames) {
|
||||||
|
if (!frame.parentFrameId || !frameById.has(frame.parentFrameId)) pending.push(frame);
|
||||||
|
else {
|
||||||
|
const siblings = children.get(frame.parentFrameId);
|
||||||
|
if (siblings) siblings.push(frame);
|
||||||
|
else children.set(frame.parentFrameId, [frame]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const projections = new Map<string, FrameProjectionState | null>();
|
||||||
|
const result: NormalizedFrameDocument[] = [];
|
||||||
|
let targetProjection: GeometryProjection | null = null;
|
||||||
|
const targetRoot = rootFrameId ? frameById.get(rootFrameId) : undefined;
|
||||||
|
if (target.sessionId && targetRoot) {
|
||||||
|
try {
|
||||||
|
const known = await geometry.frame(targetRoot.frameId);
|
||||||
|
if (known && cdpTargetKey(known.target) === cdpTargetKey(target))
|
||||||
|
targetProjection = await geometry.targetProjection(targetRoot.frameId);
|
||||||
|
} catch (error) {
|
||||||
|
if (isCaptureAbort(error)) throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const checkpoint = createCaptureCheckpoint(signal);
|
||||||
|
const visited = new Set<string>();
|
||||||
|
const remaining = frames[Symbol.iterator]();
|
||||||
|
for (let cursor = 0; visited.size < frames.length; cursor++) {
|
||||||
|
if (cursor >= pending.length) {
|
||||||
|
let next = remaining.next();
|
||||||
|
while (!next.done && visited.has(next.value.frameId)) next = remaining.next();
|
||||||
|
if (next.done) break;
|
||||||
|
pending.push(next.value);
|
||||||
|
}
|
||||||
|
if (cursor % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const frame = pending[cursor];
|
||||||
|
if (visited.has(frame.frameId)) continue;
|
||||||
|
visited.add(frame.frameId);
|
||||||
|
for (const child of children.get(frame.frameId) ?? []) pending.push(child);
|
||||||
|
const doc = sources.get(frame.frameId);
|
||||||
|
if (!doc) continue;
|
||||||
|
const source = { target, frameId: frame.frameId };
|
||||||
|
const coordinates = snapshotCoordinates(
|
||||||
|
doc,
|
||||||
|
layoutUnitsPerCssPixel,
|
||||||
|
frame.frameId === rootFrameId
|
||||||
|
? { x: metrics.cssLayoutViewport?.pageX, y: metrics.cssLayoutViewport?.pageY }
|
||||||
|
: undefined,
|
||||||
|
);
|
||||||
|
let state: FrameProjectionState | null =
|
||||||
|
frame.frameId === rootFrameId
|
||||||
|
? viewportAvailable && coordinates
|
||||||
|
? {
|
||||||
|
status: "available",
|
||||||
|
projection: {
|
||||||
|
source,
|
||||||
|
geometry: { sourceClips: [], edges: [], topViewport: viewport },
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: { status: "unavailable", source, reason: "snapshot-coordinates-unavailable" }
|
||||||
|
: (projections.get(frame.frameId) ?? null);
|
||||||
|
if (!state && frame.frameId !== rootFrameId)
|
||||||
|
issues.push({
|
||||||
|
target,
|
||||||
|
frameId: frame.frameId,
|
||||||
|
stage: "ownership",
|
||||||
|
reason: "frame-ownership-unresolved",
|
||||||
|
});
|
||||||
|
if (!coordinates && (!state || state.status === "available"))
|
||||||
|
state = { status: "unavailable", source, reason: "snapshot-coordinates-unavailable" };
|
||||||
|
projections.set(frame.frameId, state);
|
||||||
|
const projection = state?.status === "available" ? state.projection : null;
|
||||||
|
if (!projection || (target.sessionId && !targetProjection))
|
||||||
|
issues.push({
|
||||||
|
target,
|
||||||
|
frameId: frame.frameId,
|
||||||
|
stage: "geometry",
|
||||||
|
reason: "geometry-unavailable",
|
||||||
|
...(state && state.status !== "available" ? { projectionIssue: state } : {}),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Only direct siblings share this pool. Keep normalization in its existing
|
||||||
|
// breadth-first order, independent of owner read completion order.
|
||||||
|
const siblings = (children.get(frame.frameId) ?? []).filter((child) =>
|
||||||
|
sources.has(child.frameId),
|
||||||
|
);
|
||||||
|
const edge = projection?.geometry.edges[0];
|
||||||
|
const clips = edge
|
||||||
|
? [edge.destinationQuad, ...(edge.destinationClips ?? [])]
|
||||||
|
: (projection?.geometry.sourceClips ?? []);
|
||||||
|
let next = 0;
|
||||||
|
let failure: unknown;
|
||||||
|
await Promise.all(
|
||||||
|
Array.from({ length: Math.min(4, siblings.length) }, async () => {
|
||||||
|
while (next < siblings.length && !signal?.aborted && !failure) {
|
||||||
|
const child = siblings[next++];
|
||||||
|
const childSource = { target, frameId: child.frameId };
|
||||||
|
if (!projection) {
|
||||||
|
projections.set(
|
||||||
|
child.frameId,
|
||||||
|
state && state.status !== "available"
|
||||||
|
? {
|
||||||
|
status: "blocked",
|
||||||
|
source: childSource,
|
||||||
|
cause: state.status === "blocked" ? state.cause : state,
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (child.ownerBackendNodeId === undefined) {
|
||||||
|
projections.set(child.frameId, null);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!snapshotCoordinates(sources.get(child.frameId)!, layoutUnitsPerCssPixel)) {
|
||||||
|
projections.set(child.frameId, {
|
||||||
|
status: "unavailable",
|
||||||
|
source: childSource,
|
||||||
|
reason: "snapshot-coordinates-unavailable",
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
projections.set(
|
||||||
|
child.frameId,
|
||||||
|
await geometry.snapshotProjection(
|
||||||
|
childSource,
|
||||||
|
child.ownerBackendNodeId,
|
||||||
|
clips,
|
||||||
|
viewport,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
} catch (error) {
|
||||||
|
failure ??= error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
// Join active reads and their cleanup before returning cancellation.
|
||||||
|
if (failure) throw failure;
|
||||||
|
throwCaptureAborted(signal);
|
||||||
|
const normalized = await normalizeDocument(
|
||||||
|
doc,
|
||||||
|
strings,
|
||||||
|
{
|
||||||
|
frameId: frame.frameId,
|
||||||
|
ownerFrameBackendNodeId: frame.ownerBackendNodeId ?? null,
|
||||||
|
projection: state,
|
||||||
|
target,
|
||||||
|
...(target.sessionId ? { targetProjection } : {}),
|
||||||
|
coordinates,
|
||||||
|
},
|
||||||
|
signal,
|
||||||
|
);
|
||||||
|
result.push({ ...normalized, frame });
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
@@ -2,7 +2,10 @@ import type { Rect, RenderedRef, VomResult } from "@browser-skill/vom";
|
|||||||
import type { CdpTarget } from "@/browser-driver/frame-graph";
|
import type { CdpTarget } from "@/browser-driver/frame-graph";
|
||||||
import { readRecordingDocumentIdentity } from "@/shared/recording-document-identity";
|
import { readRecordingDocumentIdentity } from "@/shared/recording-document-identity";
|
||||||
import type { CapturedSurfaceProbe } from "./capture";
|
import type { CapturedSurfaceProbe } from "./capture";
|
||||||
import type { CapturedFrameDocument, FrameAxNode } from "./frame-capture";
|
import type {
|
||||||
|
FrameDocument as CapturedFrameDocument,
|
||||||
|
FrameOwnedAxNode as FrameAxNode,
|
||||||
|
} from "./frame-document";
|
||||||
|
|
||||||
/** Frame identity needed to resolve an `@eN` that lives in an iframe. */
|
/** Frame identity needed to resolve an `@eN` that lives in an iframe. */
|
||||||
export interface CaptureVomFrame {
|
export interface CaptureVomFrame {
|
||||||
|
|||||||
@@ -61,8 +61,9 @@ export function buildSemanticGraph(input: BuildSemanticGraphInput): SemanticGrap
|
|||||||
dom,
|
dom,
|
||||||
sourceOrder: index,
|
sourceOrder: index,
|
||||||
excluded:
|
excluded:
|
||||||
document.frameId === rootFrameId &&
|
document.excludedBackendNodeIds?.has(dom.backendNodeId) === true ||
|
||||||
input.excludedBackendNodeIds?.has(dom.backendNodeId) === true,
|
(document.frameId === rootFrameId &&
|
||||||
|
input.excludedBackendNodeIds?.has(dom.backendNodeId) === true),
|
||||||
};
|
};
|
||||||
nodes.set(id, node);
|
nodes.set(id, node);
|
||||||
frameNodeIds.push(id);
|
frameNodeIds.push(id);
|
||||||
@@ -90,9 +91,10 @@ export function buildSemanticGraph(input: BuildSemanticGraphInput): SemanticGrap
|
|||||||
ax,
|
ax,
|
||||||
sourceOrder: document.domNodes.length + index,
|
sourceOrder: document.domNodes.length + index,
|
||||||
excluded:
|
excluded:
|
||||||
document.frameId === rootFrameId &&
|
|
||||||
typeof ax.backendDOMNodeId === "number" &&
|
typeof ax.backendDOMNodeId === "number" &&
|
||||||
input.excludedBackendNodeIds?.has(ax.backendDOMNodeId) === true,
|
(document.excludedBackendNodeIds?.has(ax.backendDOMNodeId) === true ||
|
||||||
|
(document.frameId === rootFrameId &&
|
||||||
|
input.excludedBackendNodeIds?.has(ax.backendDOMNodeId) === true)),
|
||||||
});
|
});
|
||||||
frameNodeIds.push(id);
|
frameNodeIds.push(id);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,291 @@
|
|||||||
|
import { type CdpFrame, type CdpTarget, cdpTargetKey } from "@/browser-driver/frame-graph";
|
||||||
|
import { createCaptureCheckpoint } from "./capture-abort";
|
||||||
|
import type { CapturedNode } from "./capture-types";
|
||||||
|
import type { DecodedDocument, DecodedNode } from "./facts";
|
||||||
|
export const REQUESTED_STYLES = [
|
||||||
|
"position",
|
||||||
|
"pointer-events",
|
||||||
|
"cursor",
|
||||||
|
"visibility",
|
||||||
|
"opacity",
|
||||||
|
] as const;
|
||||||
|
const STYLE_COL = Object.fromEntries(
|
||||||
|
REQUESTED_STYLES.map((name, index) => [name, index]),
|
||||||
|
) as Record<(typeof REQUESTED_STYLES)[number], number>;
|
||||||
|
/** Sparse array format Chrome uses for infrequently-set per-node fields. */
|
||||||
|
interface SparseArray {
|
||||||
|
index: number[];
|
||||||
|
value: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RareBooleanData {
|
||||||
|
index: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SnapshotDocument {
|
||||||
|
frameId?: string | number;
|
||||||
|
documentURL?: number;
|
||||||
|
scrollOffsetX?: number;
|
||||||
|
scrollOffsetY?: number;
|
||||||
|
nodes?: {
|
||||||
|
parentIndex?: number[];
|
||||||
|
nodeName?: number[];
|
||||||
|
nodeType?: number[];
|
||||||
|
backendNodeId?: number[];
|
||||||
|
attributes?: number[][];
|
||||||
|
/**
|
||||||
|
* Per-node text value (index into strings), set for `#text` / CDATA nodes.
|
||||||
|
* Element nodes carry -1. Same length as `backendNodeId`.
|
||||||
|
*/
|
||||||
|
nodeValue?: number[];
|
||||||
|
/** Maps node array index → index into `documents[]` for frame content. */
|
||||||
|
contentDocumentIndex?: SparseArray;
|
||||||
|
inputValue?: SparseArray;
|
||||||
|
textValue?: SparseArray;
|
||||||
|
inputChecked?: RareBooleanData;
|
||||||
|
optionSelected?: RareBooleanData;
|
||||||
|
};
|
||||||
|
layout?: {
|
||||||
|
nodeIndex?: number[];
|
||||||
|
styles?: number[][];
|
||||||
|
bounds?: number[][];
|
||||||
|
paintOrders?: number[];
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function snapshotFrameId(document: SnapshotDocument, strings: string[]): string | undefined {
|
||||||
|
if (typeof document.frameId === "string") return document.frameId || undefined;
|
||||||
|
if (typeof document.frameId === "number") return str(strings, document.frameId) || undefined;
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SnapshotReply {
|
||||||
|
strings?: string[];
|
||||||
|
documents?: SnapshotDocument[];
|
||||||
|
}
|
||||||
|
|
||||||
|
function isSensitiveFormControl(node: Pick<CapturedNode, "tag" | "attrs">): boolean {
|
||||||
|
return node.tag === "input" && (node.attrs.type ?? "").toLowerCase() === "password";
|
||||||
|
}
|
||||||
|
|
||||||
|
function snapshotFormState(
|
||||||
|
value: string | undefined,
|
||||||
|
defaultValue: string,
|
||||||
|
hasDefaultValue: boolean,
|
||||||
|
sensitive: boolean,
|
||||||
|
): CapturedNode["formState"] {
|
||||||
|
if (sensitive) {
|
||||||
|
if (value === undefined && !hasDefaultValue) return undefined;
|
||||||
|
return (value ?? defaultValue) === "" ? "empty" : "filled";
|
||||||
|
}
|
||||||
|
if (value === undefined) return undefined;
|
||||||
|
if (value === "") return "empty";
|
||||||
|
return value === defaultValue ? "default" : "filled";
|
||||||
|
}
|
||||||
|
|
||||||
|
function str(strings: string[], idx: number | undefined): string {
|
||||||
|
if (idx === undefined || idx < 0) return "";
|
||||||
|
return strings[idx] ?? "";
|
||||||
|
}
|
||||||
|
|
||||||
|
export function sparseIndexMap(sparse: SparseArray | undefined): Map<number, number> {
|
||||||
|
const out = new Map<number, number>();
|
||||||
|
if (!sparse?.index || !sparse.value) return out;
|
||||||
|
for (let i = 0; i < sparse.index.length; i++) {
|
||||||
|
const nodeIndex = sparse.index[i];
|
||||||
|
const docIndex = sparse.value[i];
|
||||||
|
if (nodeIndex !== undefined && docIndex !== undefined) out.set(nodeIndex, docIndex);
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function decodeDocument(
|
||||||
|
doc: SnapshotDocument,
|
||||||
|
strings: string[],
|
||||||
|
signal?: AbortSignal,
|
||||||
|
): Promise<DecodedDocument> {
|
||||||
|
const checkpoint = createCaptureCheckpoint(signal);
|
||||||
|
const dn = doc.nodes;
|
||||||
|
const dl = doc.layout;
|
||||||
|
if (!dn?.backendNodeId) {
|
||||||
|
return { nodes: [] };
|
||||||
|
}
|
||||||
|
|
||||||
|
const count = dn.backendNodeId.length;
|
||||||
|
const layoutByNode = new Map<number, number>();
|
||||||
|
for (let i = 0; i < (dl?.nodeIndex?.length ?? 0); i++) {
|
||||||
|
if (i % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
layoutByNode.set(dl!.nodeIndex![i], i);
|
||||||
|
}
|
||||||
|
|
||||||
|
const inputValues = sparseIndexMap(dn.inputValue);
|
||||||
|
const textValues = sparseIndexMap(dn.textValue);
|
||||||
|
const checkedInputs = new Set(dn.inputChecked?.index ?? []);
|
||||||
|
const selectedOptions = new Set(dn.optionSelected?.index ?? []);
|
||||||
|
|
||||||
|
// Collect visible text from #text child nodes so element CapturedNodes
|
||||||
|
// carry a textContent value usable as a button/link label fallback.
|
||||||
|
// nodeValue is a parallel array: string index for text nodes, -1 otherwise.
|
||||||
|
const nodeTextContent = new Map<number, string[]>();
|
||||||
|
if (dn.nodeValue) {
|
||||||
|
for (let n = 0; n < count; n++) {
|
||||||
|
if (n % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const nvIdx = dn.nodeValue[n] ?? -1;
|
||||||
|
if (nvIdx < 0) continue;
|
||||||
|
const text = str(strings, nvIdx).trim();
|
||||||
|
if (!text) continue;
|
||||||
|
const parentIdx = dn.parentIndex?.[n] ?? -1;
|
||||||
|
if (parentIdx >= 0) {
|
||||||
|
const existing = nodeTextContent.get(parentIdx);
|
||||||
|
if (existing) existing.push(text);
|
||||||
|
else nodeTextContent.set(parentIdx, [text]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decode fields without assigning a coordinate projection or semantic policy.
|
||||||
|
const nodes: DecodedNode[] = [];
|
||||||
|
for (let n = 0; n < count; n++) {
|
||||||
|
if (n % 256 === 0) {
|
||||||
|
const pending = checkpoint();
|
||||||
|
if (pending) await pending;
|
||||||
|
}
|
||||||
|
const backendNodeId = dn.backendNodeId[n];
|
||||||
|
const parentIdx = dn.parentIndex?.[n] ?? -1;
|
||||||
|
const parentBackendNodeId = parentIdx >= 0 ? (dn.backendNodeId[parentIdx] ?? null) : null;
|
||||||
|
const tag = str(strings, dn.nodeName?.[n]).toLowerCase();
|
||||||
|
|
||||||
|
const attrs: Record<string, string> = {};
|
||||||
|
const pairs = dn.attributes?.[n] ?? [];
|
||||||
|
for (let a = 0; a + 1 < pairs.length; a += 2) {
|
||||||
|
attrs[str(strings, pairs[a]).toLowerCase()] = str(strings, pairs[a + 1]);
|
||||||
|
}
|
||||||
|
|
||||||
|
const li = layoutByNode.get(n);
|
||||||
|
const styleRow = li === undefined ? [] : (dl?.styles?.[li] ?? []);
|
||||||
|
const styles: Record<string, string> = {};
|
||||||
|
for (const name of REQUESTED_STYLES) styles[name] = str(strings, styleRow[STYLE_COL[name]]);
|
||||||
|
const layout =
|
||||||
|
li === undefined
|
||||||
|
? undefined
|
||||||
|
: {
|
||||||
|
boundsSpace: "snapshot-document-layout" as const,
|
||||||
|
bounds: dl?.bounds?.[li],
|
||||||
|
styles,
|
||||||
|
};
|
||||||
|
|
||||||
|
const textContent = nodeTextContent.get(n)?.join(" ");
|
||||||
|
|
||||||
|
const rawFormValueIndex = tag === "textarea" ? textValues.get(n) : inputValues.get(n);
|
||||||
|
const rawFormValue =
|
||||||
|
rawFormValueIndex !== undefined ? str(strings, rawFormValueIndex) : undefined;
|
||||||
|
const sensitive = isSensitiveFormControl({ tag, attrs });
|
||||||
|
const formDefaultValue = attrs.value ?? "";
|
||||||
|
const formValue = sensitive ? undefined : rawFormValue;
|
||||||
|
const formState = snapshotFormState(
|
||||||
|
rawFormValue,
|
||||||
|
formDefaultValue,
|
||||||
|
Object.prototype.hasOwnProperty.call(attrs, "value"),
|
||||||
|
sensitive,
|
||||||
|
);
|
||||||
|
if (sensitive) delete attrs.value;
|
||||||
|
|
||||||
|
nodes.push({
|
||||||
|
backendNodeId,
|
||||||
|
nodeType: dn.nodeType?.[n],
|
||||||
|
parentBackendNodeId,
|
||||||
|
|
||||||
|
tag,
|
||||||
|
attrs,
|
||||||
|
layout,
|
||||||
|
paintOrder: li === undefined ? 0 : (dl?.paintOrders?.[li] ?? 0),
|
||||||
|
position: styles.position || "static",
|
||||||
|
pointerEvents: styles["pointer-events"] || "auto",
|
||||||
|
cursor: styles.cursor || "auto",
|
||||||
|
|
||||||
|
textContent,
|
||||||
|
...(formValue !== undefined ? { formValue } : {}),
|
||||||
|
...(tag === "input" || tag === "textarea"
|
||||||
|
? {
|
||||||
|
formPlaceholder: attrs.placeholder ?? "",
|
||||||
|
...(!sensitive ? { formDefaultValue } : {}),
|
||||||
|
...(formState ? { formState } : {}),
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
...(checkedInputs.has(n) ? { formValue: "true", formState: "filled" } : {}),
|
||||||
|
...(selectedOptions.has(n) ? { formValue: attrs.value ?? textContent ?? "" } : {}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return { nodes };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Snapshot membership and same-target edges are current response evidence.
|
||||||
|
* The earlier graph only supplies compatible metadata and cross-target edges. */
|
||||||
|
export function describeSnapshotFrames(
|
||||||
|
snapshot: SnapshotReply,
|
||||||
|
target: CdpTarget,
|
||||||
|
hintById: ReadonlyMap<string, CdpFrame>,
|
||||||
|
pageUrl?: string,
|
||||||
|
): { frames: CdpFrame[]; ids: Set<string>; rootFrameId?: string } {
|
||||||
|
const raw = snapshot.documents ?? [];
|
||||||
|
const strings = snapshot.strings ?? [];
|
||||||
|
const ids = new Set<string>();
|
||||||
|
const invalid = new Set<string>();
|
||||||
|
const frames = raw.map((doc) => {
|
||||||
|
const frameId = snapshotFrameId(doc, strings);
|
||||||
|
if (!frameId) return undefined;
|
||||||
|
if (ids.has(frameId)) invalid.add(frameId);
|
||||||
|
ids.add(frameId);
|
||||||
|
const hint = hintById.get(frameId);
|
||||||
|
const compatible =
|
||||||
|
hint && cdpTargetKey(hint.target) === cdpTargetKey(target) ? hint : undefined;
|
||||||
|
const url =
|
||||||
|
(doc.documentURL === undefined ? undefined : strings[doc.documentURL]) || compatible?.url;
|
||||||
|
return { frameId, target, ...(url ? { url } : {}) } as CdpFrame;
|
||||||
|
});
|
||||||
|
const root = frames[0];
|
||||||
|
if (root) {
|
||||||
|
const hint = hintById.get(root.frameId);
|
||||||
|
const parent = hint?.parentFrameId ? hintById.get(hint.parentFrameId) : undefined;
|
||||||
|
if (
|
||||||
|
target.sessionId &&
|
||||||
|
hint &&
|
||||||
|
cdpTargetKey(hint.target) === cdpTargetKey(target) &&
|
||||||
|
parent &&
|
||||||
|
cdpTargetKey(parent.target) !== cdpTargetKey(target)
|
||||||
|
) {
|
||||||
|
root.parentFrameId = parent.frameId;
|
||||||
|
root.ownerBackendNodeId = hint.ownerBackendNodeId;
|
||||||
|
}
|
||||||
|
if (!target.sessionId && !root.url && pageUrl) root.url = pageUrl;
|
||||||
|
}
|
||||||
|
const owned = new Set<string>();
|
||||||
|
for (let i = 0; i < raw.length; i++) {
|
||||||
|
const edges = raw[i].nodes?.contentDocumentIndex;
|
||||||
|
const parent = frames[i];
|
||||||
|
if (!parent || !edges) continue;
|
||||||
|
for (let e = 0; e < edges.index.length; e++) {
|
||||||
|
const child = frames[edges.value[e]];
|
||||||
|
const owner = raw[i].nodes?.backendNodeId?.[edges.index[e]];
|
||||||
|
if (!child || owner === undefined) continue;
|
||||||
|
if (child === root || child === parent || owned.has(child.frameId)) {
|
||||||
|
invalid.add(child.frameId);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
owned.add(child.frameId);
|
||||||
|
child.parentFrameId = parent.frameId;
|
||||||
|
child.ownerBackendNodeId = owner;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
frames: frames.filter((frame): frame is CdpFrame => !!frame && !invalid.has(frame.frameId)),
|
||||||
|
ids,
|
||||||
|
rootFrameId: root?.frameId,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -26,11 +26,17 @@ export type RpcErrorReason =
|
|||||||
| "ref_not_found"
|
| "ref_not_found"
|
||||||
| "selector_not_found"
|
| "selector_not_found"
|
||||||
| "target_not_fillable"
|
| "target_not_fillable"
|
||||||
|
| "fill_value_invalid"
|
||||||
|
| "fill_target_changed"
|
||||||
|
| "fill_focus_lost"
|
||||||
|
| "fill_value_mismatch"
|
||||||
|
| "fill_failed"
|
||||||
| "target_not_select"
|
| "target_not_select"
|
||||||
| "option_not_found"
|
| "option_not_found"
|
||||||
| "single_select_value_count"
|
| "single_select_value_count"
|
||||||
| "tab_not_active"
|
| "tab_not_active"
|
||||||
| "restricted_tab_url"
|
| "restricted_tab_url"
|
||||||
|
| "cdp_extension_access_denied"
|
||||||
| "borrow_conflict"
|
| "borrow_conflict"
|
||||||
| "screenshot_capture_failed"
|
| "screenshot_capture_failed"
|
||||||
| "file_input_probe_failed"
|
| "file_input_probe_failed"
|
||||||
|
|||||||
@@ -172,6 +172,10 @@ intended. Read `bsk upload --help` and `bsk download --help` for all flags and e
|
|||||||
- Stale ref: observe again and retry the intended action once.
|
- Stale ref: observe again and retry the intended action once.
|
||||||
- Unknown tab or session: list current tabs/sessions; never guess identifiers.
|
- Unknown tab or session: list current tabs/sessions; never guess identifiers.
|
||||||
- Timeout: inspect current page state before deciding whether one longer purposeful wait is useful.
|
- Timeout: inspect current page state before deciding whether one longer purposeful wait is useful.
|
||||||
|
- Fill result unconfirmed (`fill_value_mismatch`): observe the field first; the page may have
|
||||||
|
formatted the value. Continue if the visible result satisfies the user's intent. Otherwise correct
|
||||||
|
the remaining difference; do not blindly repeat fill or immediately request human help. For other
|
||||||
|
fill errors, follow the returned hint and inspect current state before retrying.
|
||||||
- Unsupported command: continue with available capabilities; suggest updating only when the missing
|
- Unsupported command: continue with available capabilities; suggest updating only when the missing
|
||||||
command is necessary.
|
command is necessary.
|
||||||
- Unrecoverable failure: report the blocker and stop the session in a finally-style path.
|
- Unrecoverable failure: report the blocker and stop the session in a finally-style path.
|
||||||
|
|||||||
@@ -73,6 +73,14 @@ 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();
|
||||||
@@ -88,16 +96,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_sigint() => {
|
sig = wait_for_cancel(parent_cancel) => {
|
||||||
sig.context("install SIGINT handler").map_err(CliError::Local)?;
|
sig.context("wait for cancellation").map_err(CliError::Local)?;
|
||||||
debug!(rpc_id = %rpc_id_for_cancel, "SIGINT: forwarding cancel to daemon");
|
debug!(rpc_id = %rpc_id_for_cancel, "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,
|
||||||
"SIGINT: cancel grace elapsed; synthesising cancelled error"
|
"cancel grace elapsed; synthesising cancelled error"
|
||||||
);
|
);
|
||||||
return Err(CliError::from_rpc(RpcError {
|
return Err(CliError::from_rpc(RpcError {
|
||||||
code: ErrorCode::Cancelled,
|
code: ErrorCode::Cancelled,
|
||||||
@@ -112,6 +120,46 @@ 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.
|
||||||
///
|
///
|
||||||
@@ -146,8 +194,57 @@ fn random_short_id() -> String {
|
|||||||
bytes.iter().map(|b| format!("{b:02x}")).collect()
|
bytes.iter().map(|b| format!("{b:02x}")).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Wait for either Ctrl-C or process SIGTERM. Returning here means
|
/// Opt-in control pipe for parent processes that cannot send Ctrl-C (Node on
|
||||||
/// the user has asked us to stop.
|
/// Windows). One reader survives the short-lived runtimes used by multi-RPC
|
||||||
|
/// 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,8 +9,7 @@ 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, TransferIdParams,
|
DownloadParams, DownloadResult, TransferChunkParams, TransferChunkResult,
|
||||||
TransferReleaseResult,
|
|
||||||
};
|
};
|
||||||
use clap::Args;
|
use clap::Args;
|
||||||
use uuid::Uuid;
|
use uuid::Uuid;
|
||||||
@@ -70,13 +69,7 @@ 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 _: Result<TransferReleaseResult, CliError> = crate::cli::business_rpc::call(
|
let _ = crate::cli::business_rpc::release_transfers(&info.sock_path, [transfer_id.as_str()]);
|
||||||
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 => {
|
||||||
|
|||||||
@@ -43,10 +43,16 @@ pub mod reason {
|
|||||||
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";
|
||||||
|
pub const FILL_VALUE_INVALID: &str = "fill_value_invalid";
|
||||||
|
pub const FILL_TARGET_CHANGED: &str = "fill_target_changed";
|
||||||
|
pub const FILL_FOCUS_LOST: &str = "fill_focus_lost";
|
||||||
|
pub const FILL_VALUE_MISMATCH: &str = "fill_value_mismatch";
|
||||||
|
pub const FILL_FAILED: &str = "fill_failed";
|
||||||
pub const TARGET_NOT_SELECT: &str = "target_not_select";
|
pub const TARGET_NOT_SELECT: &str = "target_not_select";
|
||||||
pub const OPTION_NOT_FOUND: &str = "option_not_found";
|
pub const OPTION_NOT_FOUND: &str = "option_not_found";
|
||||||
pub const SINGLE_SELECT_VALUE_COUNT: &str = "single_select_value_count";
|
pub const SINGLE_SELECT_VALUE_COUNT: &str = "single_select_value_count";
|
||||||
pub const TAB_NOT_ACTIVE: &str = "tab_not_active";
|
pub const TAB_NOT_ACTIVE: &str = "tab_not_active";
|
||||||
|
pub const CDP_EXTENSION_ACCESS_DENIED: &str = "cdp_extension_access_denied";
|
||||||
pub const BORROW_CONFLICT: &str = "borrow_conflict";
|
pub const BORROW_CONFLICT: &str = "borrow_conflict";
|
||||||
pub const SCREENSHOT_CAPTURE_FAILED: &str = "screenshot_capture_failed";
|
pub const SCREENSHOT_CAPTURE_FAILED: &str = "screenshot_capture_failed";
|
||||||
pub const FILE_INPUT_PROBE_FAILED: &str = "file_input_probe_failed";
|
pub const FILE_INPUT_PROBE_FAILED: &str = "file_input_probe_failed";
|
||||||
@@ -206,6 +212,13 @@ pub fn info_for_error(code: ErrorCode, data: Option<&serde_json::Value>) -> Rend
|
|||||||
return base;
|
return base;
|
||||||
};
|
};
|
||||||
match (code, reason) {
|
match (code, reason) {
|
||||||
|
(ErrorCode::CdpFailed, reason::CDP_EXTENSION_ACCESS_DENIED) => RenderInfo {
|
||||||
|
summary: "Chrome blocked CDP access to another extension's content in this tab",
|
||||||
|
hint: Some(
|
||||||
|
"a web page can contain a restricted extension frame; disable the conflicting extension and reload, or use `bsk navigate <url>` to leave this page; reconnecting BrowserSkill alone does not remove the restriction",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
(_, reason::TRANSFER_OUTCOME_UNKNOWN) => RenderInfo {
|
(_, reason::TRANSFER_OUTCOME_UNKNOWN) => RenderInfo {
|
||||||
summary: "the file transfer outcome could not be confirmed",
|
summary: "the file transfer outcome could not be confirmed",
|
||||||
hint: Some(
|
hint: Some(
|
||||||
@@ -247,7 +260,42 @@ pub fn info_for_error(code: ErrorCode, data: Option<&serde_json::Value>) -> Rend
|
|||||||
(ErrorCode::InvalidParams, reason::TARGET_NOT_FILLABLE) => RenderInfo {
|
(ErrorCode::InvalidParams, reason::TARGET_NOT_FILLABLE) => RenderInfo {
|
||||||
summary: "target element is not fillable",
|
summary: "target element is not fillable",
|
||||||
hint: Some(
|
hint: Some(
|
||||||
"choose an input, textarea, or contenteditable element from the latest snapshot",
|
"observe the page and choose an enabled, editable text input, textarea, or contenteditable; use the appropriate interaction for other control types",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::InvalidParams, reason::FILL_VALUE_INVALID) => RenderInfo {
|
||||||
|
summary: "the requested text does not fit the field constraints",
|
||||||
|
hint: Some(
|
||||||
|
"check the field's input type and maxlength; use a compatible value without silently truncating or changing the user's intended data",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::CdpFailed, reason::FILL_TARGET_CHANGED) => RenderInfo {
|
||||||
|
summary: "the fill target changed during the action",
|
||||||
|
hint: Some(
|
||||||
|
"observe the current page and field value; if the intended result is missing, use a fresh editable target before retrying",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::CdpFailed, reason::FILL_FOCUS_LOST) => RenderInfo {
|
||||||
|
summary: "the page moved focus away from the fill target",
|
||||||
|
hint: Some(
|
||||||
|
"observe the page for a dialog or rerender and resolve it before retrying; fill manages field focus and does not require bringing the browser to the foreground",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::CdpFailed, reason::FILL_VALUE_MISMATCH) => RenderInfo {
|
||||||
|
summary: "the fill result could not be confirmed",
|
||||||
|
hint: Some(
|
||||||
|
"observe the field before retrying; the page may have formatted the value. Continue if the visible result satisfies the user's intent; otherwise correct the remaining difference. Do not blindly repeat fill or immediately request human help",
|
||||||
|
),
|
||||||
|
exit_code: base.exit_code,
|
||||||
|
},
|
||||||
|
(ErrorCode::CdpFailed, reason::FILL_FAILED) => RenderInfo {
|
||||||
|
summary: "fill encountered a browser or page-script error",
|
||||||
|
hint: Some(
|
||||||
|
"observe the page before retrying because the field may already have changed; retry only if the intended result is missing and the target is still available",
|
||||||
),
|
),
|
||||||
exit_code: base.exit_code,
|
exit_code: base.exit_code,
|
||||||
},
|
},
|
||||||
@@ -442,6 +490,56 @@ mod tests {
|
|||||||
ErrorCode::NoBrowserConnected,
|
ErrorCode::NoBrowserConnected,
|
||||||
];
|
];
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn fill_reasons_provide_recovery_without_changing_exit_codes() {
|
||||||
|
for (code, reason, hint_fragment) in [
|
||||||
|
(
|
||||||
|
ErrorCode::InvalidParams,
|
||||||
|
reason::TARGET_NOT_FILLABLE,
|
||||||
|
"enabled, editable",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ErrorCode::InvalidParams,
|
||||||
|
reason::FILL_VALUE_INVALID,
|
||||||
|
"maxlength",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ErrorCode::CdpFailed,
|
||||||
|
reason::FILL_TARGET_CHANGED,
|
||||||
|
"fresh editable target",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ErrorCode::CdpFailed,
|
||||||
|
reason::FILL_FOCUS_LOST,
|
||||||
|
"does not require bringing the browser",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ErrorCode::CdpFailed,
|
||||||
|
reason::FILL_VALUE_MISMATCH,
|
||||||
|
"Continue if the visible result satisfies",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ErrorCode::CdpFailed,
|
||||||
|
reason::FILL_FAILED,
|
||||||
|
"may already have changed",
|
||||||
|
),
|
||||||
|
] {
|
||||||
|
let data = serde_json::json!({ "reason": reason });
|
||||||
|
let info = info_for_error(code, Some(&data));
|
||||||
|
assert!(info.hint.unwrap().contains(hint_fragment), "{reason}");
|
||||||
|
assert_eq!(info.exit_code, info_for(code).exit_code);
|
||||||
|
}
|
||||||
|
let mismatch = serde_json::json!({ "reason": reason::FILL_VALUE_MISMATCH });
|
||||||
|
let info = info_for_error(ErrorCode::CdpFailed, Some(&mismatch));
|
||||||
|
assert_eq!(info.summary, "the fill result could not be confirmed");
|
||||||
|
assert!(info.hint.unwrap().contains("Do not blindly repeat fill"));
|
||||||
|
let unknown = serde_json::json!({ "reason": "future_fill_reason" });
|
||||||
|
assert_eq!(
|
||||||
|
info_for_error(ErrorCode::CdpFailed, Some(&unknown)),
|
||||||
|
info_for(ErrorCode::CdpFailed)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn element_not_visible_overrides_permission_denied_copy() {
|
fn element_not_visible_overrides_permission_denied_copy() {
|
||||||
let data = serde_json::json!({ "reason": reason::ELEMENT_NOT_VISIBLE });
|
let data = serde_json::json!({ "reason": reason::ELEMENT_NOT_VISIBLE });
|
||||||
@@ -454,6 +552,18 @@ mod tests {
|
|||||||
assert!(!info.summary.contains("sandbox"));
|
assert!(!info.summary.contains("sandbox"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn extension_access_denied_explains_the_frame_restriction_and_navigation_recovery() {
|
||||||
|
let data = serde_json::json!({ "reason": reason::CDP_EXTENSION_ACCESS_DENIED });
|
||||||
|
let info = info_for_error(ErrorCode::CdpFailed, Some(&data));
|
||||||
|
assert!(info.summary.contains("another extension"));
|
||||||
|
let hint = info.hint.unwrap();
|
||||||
|
assert!(hint.contains("restricted extension frame"));
|
||||||
|
assert!(hint.contains("bsk navigate <url>"));
|
||||||
|
assert!(hint.contains("disable the conflicting extension"));
|
||||||
|
assert_eq!(info.exit_code, 3);
|
||||||
|
}
|
||||||
|
|
||||||
#[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 });
|
||||||
|
|||||||
@@ -6,9 +6,7 @@ use std::path::{Path, PathBuf};
|
|||||||
use std::time::{Duration, SystemTime};
|
use std::time::{Duration, SystemTime};
|
||||||
|
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
use std::os::windows::process::CommandExt;
|
mod windows;
|
||||||
#[cfg(windows)]
|
|
||||||
use std::process::{Command, Stdio};
|
|
||||||
|
|
||||||
use anyhow::{Context, Result, bail};
|
use anyhow::{Context, Result, bail};
|
||||||
use clap::Args;
|
use clap::Args;
|
||||||
@@ -363,7 +361,8 @@ fn install_candidate_with_client(
|
|||||||
crate::daemon::start::run_stop().context("stop bsk daemon before update")?;
|
crate::daemon::start::run_stop().context("stop bsk daemon before update")?;
|
||||||
}
|
}
|
||||||
|
|
||||||
let action = replace_binary_for_update(&target, &binary, daemon_was_running)?;
|
let restart_args = daemon_was_running.then(StartArgs::default);
|
||||||
|
let action = replace_binary_for_update(&target, &binary, restart_args.as_ref())?;
|
||||||
|
|
||||||
if daemon_was_running && matches!(action, InstallAction::Replaced) {
|
if daemon_was_running && matches!(action, InstallAction::Replaced) {
|
||||||
crate::daemon::start::run_start(StartArgs::default())
|
crate::daemon::start::run_start(StartArgs::default())
|
||||||
@@ -394,8 +393,8 @@ pub(crate) fn download_candidate_binary(
|
|||||||
|
|
||||||
/// Daemon-side install: download, verify, and replace the executable at
|
/// Daemon-side install: download, verify, and replace the executable at
|
||||||
/// `target` (on Windows: stage the replacement next to it). Unlike the
|
/// `target` (on Windows: stage the replacement next to it). Unlike the
|
||||||
/// CLI path this never stops or starts the daemon — the daemon drives
|
/// CLI path this never stops the daemon. On Windows the helper starts
|
||||||
/// its own restart once the binary is replaced.
|
/// its replacement after exit; elsewhere the daemon drives its own restart.
|
||||||
///
|
///
|
||||||
/// `target` must be captured *before* any replacement happens: on Linux
|
/// `target` must be captured *before* any replacement happens: on Linux
|
||||||
/// `std::env::current_exe` starts returning a ` (deleted)`-suffixed
|
/// `std::env::current_exe` starts returning a ` (deleted)`-suffixed
|
||||||
@@ -403,10 +402,11 @@ pub(crate) fn download_candidate_binary(
|
|||||||
pub(crate) fn self_install_candidate(
|
pub(crate) fn self_install_candidate(
|
||||||
candidate: &UpdateCandidate,
|
candidate: &UpdateCandidate,
|
||||||
target: &Path,
|
target: &Path,
|
||||||
|
restart_args: &StartArgs,
|
||||||
) -> Result<InstallAction> {
|
) -> Result<InstallAction> {
|
||||||
let client = update_http_client(ARCHIVE_FETCH_TIMEOUT)?;
|
let client = update_http_client(ARCHIVE_FETCH_TIMEOUT)?;
|
||||||
let binary = download_candidate_binary(candidate, &client)?;
|
let binary = download_candidate_binary(candidate, &client)?;
|
||||||
replace_binary_at_path(target, &binary)
|
replace_binary_for_update(target, &binary, Some(restart_args))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Outcome of one daemon auto-update step (see [`auto_update_step`]).
|
/// Outcome of one daemon auto-update step (see [`auto_update_step`]).
|
||||||
@@ -423,8 +423,8 @@ pub(crate) enum AutoUpdateOutcome {
|
|||||||
/// The new binary replaced the old one; the daemon should now
|
/// The new binary replaced the old one; the daemon should now
|
||||||
/// restart into it.
|
/// restart into it.
|
||||||
Replaced { latest: String },
|
Replaced { latest: String },
|
||||||
/// Windows staged the replacement next to the running binary; a
|
/// Windows started a helper that will replace the executable and
|
||||||
/// daemon/terminal restart finishes it.
|
/// restart the daemon once the current process exits.
|
||||||
Staged { latest: String },
|
Staged { latest: String },
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -668,6 +668,7 @@ fn render_report(format: Format, report: &UpdateReport) -> Result<()> {
|
|||||||
}
|
}
|
||||||
if matches!(report.install_action, Some("staged")) {
|
if matches!(report.install_action, Some("staged")) {
|
||||||
println!("the detached update helper will apply the replacement after exit");
|
println!("the detached update helper will apply the replacement after exit");
|
||||||
|
println!("if it fails, see the *.update-*.log file next to the executable");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Format::Json => {
|
Format::Json => {
|
||||||
@@ -688,22 +689,22 @@ pub fn extract_bsk_binary(archive_bytes: &[u8], kind: ArchiveKind) -> Result<Vec
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn replace_binary_at_path(target: &Path, binary: &[u8]) -> Result<InstallAction> {
|
pub fn replace_binary_at_path(target: &Path, binary: &[u8]) -> Result<InstallAction> {
|
||||||
replace_binary_for_update(target, binary, false)
|
replace_binary_for_update(target, binary, None)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn replace_binary_for_update(
|
fn replace_binary_for_update(
|
||||||
target: &Path,
|
target: &Path,
|
||||||
binary: &[u8],
|
binary: &[u8],
|
||||||
restart_daemon: bool,
|
restart_args: Option<&StartArgs>,
|
||||||
) -> Result<InstallAction> {
|
) -> Result<InstallAction> {
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
{
|
{
|
||||||
stage_windows_replacement(target, binary, restart_daemon)
|
stage_windows_replacement(target, binary, restart_args)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(not(windows))]
|
#[cfg(not(windows))]
|
||||||
{
|
{
|
||||||
let _ = restart_daemon;
|
let _ = restart_args;
|
||||||
replace_binary_atomically(target, binary)
|
replace_binary_atomically(target, binary)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -749,34 +750,69 @@ fn replace_binary_atomically(target: &Path, binary: &[u8]) -> Result<InstallActi
|
|||||||
fn stage_windows_replacement(
|
fn stage_windows_replacement(
|
||||||
target: &Path,
|
target: &Path,
|
||||||
binary: &[u8],
|
binary: &[u8],
|
||||||
restart_daemon: bool,
|
restart_args: Option<&StartArgs>,
|
||||||
) -> Result<InstallAction> {
|
) -> Result<InstallAction> {
|
||||||
let paths = staged_replacement_paths(target, std::process::id())?;
|
// The helper owns replacement/restart after this process exits. Do not
|
||||||
std::fs::write(&paths.binary_path, binary)
|
// report Staged until it has actually begun executing the script.
|
||||||
.with_context(|| format!("write {}", paths.binary_path.display()))?;
|
let _child = spawn_windows_replacement(target, binary, restart_args, 120)?;
|
||||||
std::fs::write(
|
Ok(InstallAction::Staged)
|
||||||
&paths.script_path,
|
}
|
||||||
windows_replacement_script(target, &paths.binary_path, restart_daemon),
|
|
||||||
)
|
|
||||||
.with_context(|| format!("write {}", paths.script_path.display()))?;
|
|
||||||
|
|
||||||
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
|
#[cfg(windows)]
|
||||||
const CREATE_NEW_PROCESS_GROUP: u32 = 0x0000_0200;
|
fn spawn_windows_replacement(
|
||||||
let command = format!("\"{}\"", paths.script_path.display());
|
target: &Path,
|
||||||
if let Err(err) = Command::new("cmd.exe")
|
binary: &[u8],
|
||||||
.args(["/D", "/S", "/C"])
|
restart_args: Option<&StartArgs>,
|
||||||
.arg(command)
|
attempts: u32,
|
||||||
.stdin(Stdio::null())
|
) -> Result<windows::Helper> {
|
||||||
.stdout(Stdio::null())
|
let paths = staged_replacement_paths(target, std::process::id())?;
|
||||||
.stderr(Stdio::null())
|
let ready_path = paths.script_path.with_extension("ready");
|
||||||
.creation_flags(CREATE_NO_WINDOW | CREATE_NEW_PROCESS_GROUP)
|
let log_path = paths.script_path.with_extension("log");
|
||||||
.spawn()
|
let result = (|| {
|
||||||
{
|
// A previous failed attempt by this process must not acknowledge a
|
||||||
|
// new helper. All paths are private to this target and process id.
|
||||||
|
match std::fs::remove_file(&ready_path) {
|
||||||
|
Ok(()) => {}
|
||||||
|
Err(err) if err.kind() == std::io::ErrorKind::NotFound => {}
|
||||||
|
Err(err) => return Err(err.into()),
|
||||||
|
}
|
||||||
|
std::fs::write(&paths.binary_path, binary)
|
||||||
|
.with_context(|| format!("write {}", paths.binary_path.display()))?;
|
||||||
|
std::fs::write(
|
||||||
|
&paths.script_path,
|
||||||
|
windows_replacement_script(restart_args, attempts),
|
||||||
|
)
|
||||||
|
.with_context(|| format!("write {}", paths.script_path.display()))?;
|
||||||
|
let mut child = windows::spawn(
|
||||||
|
&paths.script_path,
|
||||||
|
&paths.binary_path,
|
||||||
|
target,
|
||||||
|
&ready_path,
|
||||||
|
&log_path,
|
||||||
|
)
|
||||||
|
.context("launch detached Windows update helper")?;
|
||||||
|
let deadline = std::time::Instant::now() + Duration::from_secs(5);
|
||||||
|
loop {
|
||||||
|
if std::fs::remove_file(&ready_path).is_ok() {
|
||||||
|
return Ok(child);
|
||||||
|
}
|
||||||
|
if let Some(status) = child.try_wait()? {
|
||||||
|
bail!("Windows update helper exited before becoming ready: {status}");
|
||||||
|
}
|
||||||
|
if std::time::Instant::now() >= deadline {
|
||||||
|
let _ = child.kill();
|
||||||
|
let _ = child.wait();
|
||||||
|
bail!("Windows update helper did not become ready within 5 seconds");
|
||||||
|
}
|
||||||
|
std::thread::sleep(Duration::from_millis(20));
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
if result.is_err() {
|
||||||
let _ = std::fs::remove_file(&paths.binary_path);
|
let _ = std::fs::remove_file(&paths.binary_path);
|
||||||
let _ = std::fs::remove_file(&paths.script_path);
|
let _ = std::fs::remove_file(&paths.script_path);
|
||||||
return Err(err).context("launch detached Windows update helper");
|
let _ = std::fs::remove_file(&ready_path);
|
||||||
}
|
}
|
||||||
Ok(InstallAction::Staged)
|
result.with_context(|| format!("Windows update helper failed; see {}", log_path.display()))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn staged_replacement_paths(target: &Path, pid: u32) -> Result<StagedReplacementPaths> {
|
pub fn staged_replacement_paths(target: &Path, pid: u32) -> Result<StagedReplacementPaths> {
|
||||||
@@ -793,25 +829,43 @@ pub fn staged_replacement_paths(target: &Path, pid: u32) -> Result<StagedReplace
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(any(windows, test))]
|
#[cfg(any(windows, test))]
|
||||||
fn windows_replacement_script(target: &Path, staged_binary: &Path, restart_daemon: bool) -> String {
|
fn windows_replacement_script(restart_args: Option<&StartArgs>, attempts: u32) -> String {
|
||||||
let target = target.display().to_string().replace('%', "%%");
|
// Only fixed switches and numeric values go into the ASCII script. Paths
|
||||||
let staged_binary = staged_binary.display().to_string().replace('%', "%%");
|
// stay in Unicode environment variables, including %, ! and shell symbols.
|
||||||
let restart = if restart_daemon {
|
let restart = restart_args.map_or_else(String::new, |args| {
|
||||||
format!("start \"\" /B \"{target}\" daemon start >nul 2>nul\r\n")
|
format!(
|
||||||
} else {
|
"\"%BSK_UPDATE_TARGET%\" daemon start --port {} --session-idle {}ms --daemon-idle {}ms\r\nif errorlevel 1 goto failed_restart\r\n",
|
||||||
String::new()
|
args.resolved_port(),
|
||||||
};
|
args.resolved_session_idle().as_millis(),
|
||||||
|
args.resolved_daemon_idle().as_millis(),
|
||||||
|
)
|
||||||
|
});
|
||||||
format!(
|
format!(
|
||||||
"@echo off\r\n\
|
"@echo off\r\n\
|
||||||
setlocal\r\n\
|
setlocal DisableDelayedExpansion\r\n\
|
||||||
|
> \"%BSK_UPDATE_READY%\" echo ready\r\n\
|
||||||
|
if errorlevel 1 exit /b 1\r\n\
|
||||||
|
set /a attempts=0\r\n\
|
||||||
:retry\r\n\
|
:retry\r\n\
|
||||||
move /Y \"{staged_binary}\" \"{target}\" >nul 2>nul\r\n\
|
move /Y \"%BSK_UPDATE_SOURCE%\" \"%BSK_UPDATE_TARGET%\" >nul\r\n\
|
||||||
if errorlevel 1 (\r\n\
|
if not errorlevel 1 goto replaced\r\n\
|
||||||
ping -n 2 127.0.0.1 >nul\r\n\
|
set /a attempts+=1\r\n\
|
||||||
goto retry\r\n\
|
if %attempts% geq {attempts} goto failed_replace\r\n\
|
||||||
)\r\n\
|
if not exist \"%BSK_UPDATE_SOURCE%\" goto failed_replace\r\n\
|
||||||
|
ping -n 2 127.0.0.1 >nul\r\n\
|
||||||
|
goto retry\r\n\
|
||||||
|
:failed_replace\r\n\
|
||||||
|
echo Failed to replace the executable after %attempts% attempts.\r\n\
|
||||||
|
goto failed\r\n\
|
||||||
|
:replaced\r\n\
|
||||||
{restart}\
|
{restart}\
|
||||||
del /F /Q \"%~f0\" >nul 2>nul\r\n"
|
del /F /Q \"%BSK_UPDATE_LOG%\" >nul 2>nul\r\n\
|
||||||
|
(del /F /Q \"%BSK_UPDATE_SCRIPT%\" >nul 2>nul & exit 0)\r\n\
|
||||||
|
:failed_restart\r\n\
|
||||||
|
echo Replaced the executable but failed to restart the daemon.\r\n\
|
||||||
|
:failed\r\n\
|
||||||
|
del /F /Q \"%BSK_UPDATE_SOURCE%\" >nul 2>nul\r\n\
|
||||||
|
(del /F /Q \"%BSK_UPDATE_SCRIPT%\" >nul 2>nul & exit 1)\r\n"
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -965,6 +1019,7 @@ mod tests {
|
|||||||
assert_eq!(extracted, b"windows binary");
|
assert_eq!(extracted, b"windows binary");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(not(windows))]
|
||||||
#[test]
|
#[test]
|
||||||
fn replaces_binary_at_path() {
|
fn replaces_binary_at_path() {
|
||||||
let tmp = tempfile::TempDir::new().unwrap();
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
@@ -999,31 +1054,139 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn windows_replacement_script_retries_restarts_and_cleans_itself() {
|
fn windows_replacement_script_preserves_restart_config() {
|
||||||
let script = windows_replacement_script(
|
let args = StartArgs {
|
||||||
Path::new(r"C:\Program Files\bsk.exe"),
|
port: Some(54321),
|
||||||
Path::new(r"C:\Program Files\bsk.exe.update-42"),
|
session_idle: Some(Duration::from_millis(1234)),
|
||||||
true,
|
daemon_idle: Some(Duration::from_secs(75)),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let script = windows_replacement_script(Some(&args), 120);
|
||||||
|
assert!(script.is_ascii());
|
||||||
|
assert!(
|
||||||
|
script
|
||||||
|
.contains("daemon start --port 54321 --session-idle 1234ms --daemon-idle 75000ms")
|
||||||
);
|
);
|
||||||
|
assert!(!windows_replacement_script(None, 120).contains("daemon start"));
|
||||||
assert!(script.contains(":retry"));
|
|
||||||
assert!(script.contains("move /Y"));
|
|
||||||
assert!(script.contains("ping -n 2 127.0.0.1"));
|
|
||||||
assert!(!script.contains("timeout"));
|
|
||||||
assert!(script.contains(r#"start "" /B "C:\Program Files\bsk.exe" daemon start"#));
|
|
||||||
assert!(script.contains(r#"del /F /Q "%~f0""#));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[cfg(windows)]
|
||||||
fn windows_replacement_script_omits_restart_when_daemon_was_not_running() {
|
fn wait_for_helper(mut child: windows::Helper) -> std::process::ExitStatus {
|
||||||
let script = windows_replacement_script(
|
let deadline = std::time::Instant::now() + Duration::from_secs(10);
|
||||||
Path::new(r"C:\bsk.exe"),
|
loop {
|
||||||
Path::new(r"C:\bsk.exe.update-42"),
|
if let Some(status) = child.try_wait().unwrap() {
|
||||||
false,
|
return status;
|
||||||
);
|
}
|
||||||
|
if std::time::Instant::now() >= deadline {
|
||||||
|
let _ = child.kill();
|
||||||
|
let _ = child.wait();
|
||||||
|
panic!("Windows update helper did not exit");
|
||||||
|
}
|
||||||
|
std::thread::sleep(Duration::from_millis(20));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
assert!(!script.contains("daemon start"));
|
#[cfg(windows)]
|
||||||
assert!(script.contains(r#"del /F /Q "%~f0""#));
|
#[test]
|
||||||
|
fn windows_helper_replaces_in_unicode_spaces_and_shell_symbol_paths() {
|
||||||
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
|
for name in [
|
||||||
|
"ascii",
|
||||||
|
"with space",
|
||||||
|
"中文目录",
|
||||||
|
"literal %PATH% ! & (folder)",
|
||||||
|
] {
|
||||||
|
let dir = tmp.path().join(name);
|
||||||
|
std::fs::create_dir(&dir).unwrap();
|
||||||
|
let target = dir.join("bsk.exe");
|
||||||
|
std::fs::write(&target, b"old binary").unwrap();
|
||||||
|
let child = spawn_windows_replacement(&target, b"new binary", None, 5).unwrap();
|
||||||
|
let paths = staged_replacement_paths(&target, std::process::id()).unwrap();
|
||||||
|
let status = wait_for_helper(child);
|
||||||
|
assert!(
|
||||||
|
status.success(),
|
||||||
|
"{name}: {:?}",
|
||||||
|
std::fs::read_to_string(paths.script_path.with_extension("log"))
|
||||||
|
);
|
||||||
|
assert_eq!(std::fs::read(&target).unwrap(), b"new binary", "{name}");
|
||||||
|
// Successful updates leave no helper, staged binary, ready file or log.
|
||||||
|
assert_eq!(std::fs::read_dir(&dir).unwrap().count(), 1, "{name}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
#[test]
|
||||||
|
fn windows_helper_waits_for_unlock_then_replaces() {
|
||||||
|
use std::os::windows::fs::OpenOptionsExt;
|
||||||
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
|
let target = tmp.path().join("bsk.exe");
|
||||||
|
std::fs::write(&target, b"old binary").unwrap();
|
||||||
|
// Deny delete sharing, like a running Windows executable.
|
||||||
|
let lock = std::fs::OpenOptions::new()
|
||||||
|
.read(true)
|
||||||
|
.share_mode(1)
|
||||||
|
.open(&target)
|
||||||
|
.unwrap();
|
||||||
|
let mut child = spawn_windows_replacement(&target, b"new binary", None, 5).unwrap();
|
||||||
|
std::thread::sleep(Duration::from_millis(150));
|
||||||
|
assert!(child.try_wait().unwrap().is_none());
|
||||||
|
assert_eq!(std::fs::read(&target).unwrap(), b"old binary");
|
||||||
|
drop(lock);
|
||||||
|
assert!(wait_for_helper(child).success());
|
||||||
|
assert_eq!(std::fs::read(&target).unwrap(), b"new binary");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
#[test]
|
||||||
|
fn windows_helper_bounds_retries_and_preserves_old_binary_on_failure() {
|
||||||
|
use std::os::windows::fs::OpenOptionsExt;
|
||||||
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
|
let target = tmp.path().join("bsk.exe");
|
||||||
|
std::fs::write(&target, b"old binary").unwrap();
|
||||||
|
let _lock = std::fs::OpenOptions::new()
|
||||||
|
.read(true)
|
||||||
|
.share_mode(1)
|
||||||
|
.open(&target)
|
||||||
|
.unwrap();
|
||||||
|
let child = spawn_windows_replacement(&target, b"new binary", None, 2).unwrap();
|
||||||
|
assert!(!wait_for_helper(child).success());
|
||||||
|
let paths = staged_replacement_paths(&target, std::process::id()).unwrap();
|
||||||
|
assert_eq!(std::fs::read(&target).unwrap(), b"old binary");
|
||||||
|
assert!(!paths.binary_path.exists());
|
||||||
|
assert!(!paths.script_path.exists());
|
||||||
|
let log_bytes = std::fs::read(paths.script_path.with_extension("log")).unwrap();
|
||||||
|
let log = String::from_utf8_lossy(&log_bytes);
|
||||||
|
assert!(
|
||||||
|
log.contains("Failed to replace the executable after 2 attempts."),
|
||||||
|
"{log}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
#[test]
|
||||||
|
fn windows_helper_reports_restart_failure_without_losing_replacement() {
|
||||||
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
|
let target = tmp.path().join("bsk.exe");
|
||||||
|
std::fs::write(&target, b"old binary").unwrap();
|
||||||
|
// Not a valid PE executable: replacement succeeds but restart fails.
|
||||||
|
let child = spawn_windows_replacement(
|
||||||
|
&target,
|
||||||
|
b"invalid executable",
|
||||||
|
Some(&StartArgs::default()),
|
||||||
|
2,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(!wait_for_helper(child).success());
|
||||||
|
let paths = staged_replacement_paths(&target, std::process::id()).unwrap();
|
||||||
|
let bytes = std::fs::read(paths.script_path.with_extension("log")).unwrap();
|
||||||
|
let log = String::from_utf8_lossy(&bytes);
|
||||||
|
assert!(
|
||||||
|
log.contains("Replaced the executable but failed to restart the daemon."),
|
||||||
|
"{log}"
|
||||||
|
);
|
||||||
|
assert_eq!(std::fs::read(&target).unwrap(), b"invalid executable");
|
||||||
|
assert!(!paths.script_path.exists());
|
||||||
|
assert!(!paths.binary_path.exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -1282,10 +1445,9 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn auto_update_step_staged_outcome_requests_no_restart() {
|
fn auto_update_step_reports_staged_handoff() {
|
||||||
// The Windows shape: the replacement is staged next to the
|
// The helper, rather than this process, starts the new executable.
|
||||||
// running binary, so the outcome must not ask for the immediate
|
// The daemon must exit to let that staged handoff finish.
|
||||||
// self-restart that `Replaced` triggers.
|
|
||||||
let candidate = test_candidate();
|
let candidate = test_candidate();
|
||||||
let outcome =
|
let outcome =
|
||||||
auto_update_step(Some(&candidate), true, 0, |_| Ok(InstallAction::Staged)).unwrap();
|
auto_update_step(Some(&candidate), true, 0, |_| Ok(InstallAction::Staged)).unwrap();
|
||||||
|
|||||||
@@ -0,0 +1,203 @@
|
|||||||
|
//! Launch the update helper with only its stdio handles inherited.
|
||||||
|
//!
|
||||||
|
//! std::process::Command on Windows also inherits other inheritable handles.
|
||||||
|
//! A daemon's listening socket must not survive in the helper: it would keep
|
||||||
|
//! the port occupied after the daemon exits and prevent its replacement starting.
|
||||||
|
|
||||||
|
use std::ffi::OsStr;
|
||||||
|
use std::fs::File;
|
||||||
|
use std::io;
|
||||||
|
use std::os::windows::ffi::OsStrExt;
|
||||||
|
use std::os::windows::io::{AsRawHandle, FromRawHandle, OwnedHandle};
|
||||||
|
use std::os::windows::process::ExitStatusExt;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::process::ExitStatus;
|
||||||
|
|
||||||
|
use windows_sys::Win32::Foundation::{
|
||||||
|
HANDLE, HANDLE_FLAG_INHERIT, SetHandleInformation, WAIT_OBJECT_0, WAIT_TIMEOUT,
|
||||||
|
};
|
||||||
|
use windows_sys::Win32::System::Threading::{
|
||||||
|
CREATE_NEW_PROCESS_GROUP, CREATE_NO_WINDOW, CREATE_UNICODE_ENVIRONMENT, CreateProcessW,
|
||||||
|
DeleteProcThreadAttributeList, EXTENDED_STARTUPINFO_PRESENT, GetExitCodeProcess,
|
||||||
|
InitializeProcThreadAttributeList, PROC_THREAD_ATTRIBUTE_HANDLE_LIST, PROCESS_INFORMATION,
|
||||||
|
STARTF_USESTDHANDLES, STARTUPINFOEXW, TerminateProcess, UpdateProcThreadAttribute,
|
||||||
|
WaitForSingleObject,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub(super) struct Helper(OwnedHandle);
|
||||||
|
|
||||||
|
impl Helper {
|
||||||
|
pub(super) fn try_wait(&mut self) -> io::Result<Option<ExitStatus>> {
|
||||||
|
// SAFETY: the owned process handle remains valid for both calls.
|
||||||
|
match unsafe { WaitForSingleObject(self.0.as_raw_handle(), 0) } {
|
||||||
|
WAIT_OBJECT_0 => {
|
||||||
|
let mut code = 0;
|
||||||
|
if unsafe { GetExitCodeProcess(self.0.as_raw_handle(), &mut code) } == 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
Ok(Some(ExitStatus::from_raw(code)))
|
||||||
|
}
|
||||||
|
WAIT_TIMEOUT => Ok(None),
|
||||||
|
_ => Err(io::Error::last_os_error()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(super) fn kill(&mut self) -> io::Result<()> {
|
||||||
|
// SAFETY: this handle belongs to the helper we created.
|
||||||
|
if unsafe { TerminateProcess(self.0.as_raw_handle(), 1) } == 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(super) fn wait(&mut self) -> io::Result<()> {
|
||||||
|
// Only used after kill(); do not leave a live helper on startup failure.
|
||||||
|
if unsafe { WaitForSingleObject(self.0.as_raw_handle(), 5000) } != WAIT_OBJECT_0 {
|
||||||
|
return Err(io::Error::new(
|
||||||
|
io::ErrorKind::TimedOut,
|
||||||
|
"update helper did not exit",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The opaque attribute list needs pointer-aligned storage and explicit teardown.
|
||||||
|
struct AttributeList(Vec<usize>);
|
||||||
|
|
||||||
|
impl Drop for AttributeList {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// SAFETY: this wrapper is constructed only after successful initialization.
|
||||||
|
unsafe { DeleteProcThreadAttributeList(self.0.as_mut_ptr().cast()) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(super) fn spawn(
|
||||||
|
script: &Path,
|
||||||
|
source: &Path,
|
||||||
|
target: &Path,
|
||||||
|
ready: &Path,
|
||||||
|
log_path: &Path,
|
||||||
|
) -> io::Result<Helper> {
|
||||||
|
let root = std::env::var_os("SystemRoot")
|
||||||
|
.ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "SystemRoot is not set"))?;
|
||||||
|
let application = wide(Path::new(&root).join("System32/cmd.exe").as_os_str());
|
||||||
|
// /S /C strips one outer pair of quotes. Environment expansion keeps paths
|
||||||
|
// Unicode and avoids CRT escaping, batch-file encoding, and CALL expansion.
|
||||||
|
let mut command = wide(OsStr::new(
|
||||||
|
"cmd.exe /D /V:OFF /S /C \"\"%BSK_UPDATE_SCRIPT%\"\"",
|
||||||
|
));
|
||||||
|
let overrides = [
|
||||||
|
("BSK_UPDATE_SCRIPT", script.as_os_str()),
|
||||||
|
("BSK_UPDATE_SOURCE", source.as_os_str()),
|
||||||
|
("BSK_UPDATE_TARGET", target.as_os_str()),
|
||||||
|
("BSK_UPDATE_READY", ready.as_os_str()),
|
||||||
|
("BSK_UPDATE_LOG", log_path.as_os_str()),
|
||||||
|
];
|
||||||
|
let mut env: Vec<_> = std::env::vars_os()
|
||||||
|
.filter(|(key, _)| {
|
||||||
|
let key = key.to_string_lossy();
|
||||||
|
!overrides
|
||||||
|
.iter()
|
||||||
|
.any(|(name, _)| key.eq_ignore_ascii_case(name))
|
||||||
|
&& !key.eq_ignore_ascii_case(crate::daemon::start::DAEMONIZED_ENV)
|
||||||
|
&& !key.eq_ignore_ascii_case(crate::daemon::start::DAEMON_REPLACEMENT_WAIT_ENV)
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
env.extend(
|
||||||
|
overrides
|
||||||
|
.into_iter()
|
||||||
|
.map(|(key, value)| (key.into(), value.to_owned())),
|
||||||
|
);
|
||||||
|
env.sort_by_key(|(key, _)| key.to_string_lossy().to_uppercase());
|
||||||
|
let mut environment = Vec::new();
|
||||||
|
for (key, value) in env {
|
||||||
|
environment.extend(key.encode_wide());
|
||||||
|
environment.push(b'=' as u16);
|
||||||
|
environment.extend(value.encode_wide());
|
||||||
|
environment.push(0);
|
||||||
|
}
|
||||||
|
environment.push(0);
|
||||||
|
|
||||||
|
let input = File::open("NUL")?;
|
||||||
|
let log = File::create(log_path)?;
|
||||||
|
let handles: [HANDLE; 2] = [input.as_raw_handle(), log.as_raw_handle()];
|
||||||
|
for &handle in &handles {
|
||||||
|
// SAFETY: these are dedicated helper stdio handles, held until spawn
|
||||||
|
// finishes. The explicit handle list excludes every other parent handle.
|
||||||
|
if unsafe { SetHandleInformation(handle, HANDLE_FLAG_INHERIT, HANDLE_FLAG_INHERIT) } == 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut size = 0;
|
||||||
|
// SAFETY: the first call queries the allocation size, as required by Win32.
|
||||||
|
unsafe { InitializeProcThreadAttributeList(std::ptr::null_mut(), 1, 0, &mut size) };
|
||||||
|
if size == 0 {
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
let mut storage = vec![0usize; size.div_ceil(std::mem::size_of::<usize>())];
|
||||||
|
// SAFETY: storage has the requested size and pointer alignment.
|
||||||
|
if unsafe { InitializeProcThreadAttributeList(storage.as_mut_ptr().cast(), 1, 0, &mut size) }
|
||||||
|
== 0
|
||||||
|
{
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
let mut attributes = AttributeList(storage);
|
||||||
|
// SAFETY: the handle array and attribute storage outlive CreateProcessW.
|
||||||
|
if unsafe {
|
||||||
|
UpdateProcThreadAttribute(
|
||||||
|
attributes.0.as_mut_ptr().cast(),
|
||||||
|
0,
|
||||||
|
PROC_THREAD_ATTRIBUTE_HANDLE_LIST as usize,
|
||||||
|
handles.as_ptr().cast(),
|
||||||
|
std::mem::size_of_val(&handles),
|
||||||
|
std::ptr::null_mut(),
|
||||||
|
std::ptr::null(),
|
||||||
|
)
|
||||||
|
} == 0
|
||||||
|
{
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
// SAFETY: these Win32 structs permit zero initialization; required fields
|
||||||
|
// are populated below before the process is created.
|
||||||
|
let mut startup: STARTUPINFOEXW = unsafe { std::mem::zeroed() };
|
||||||
|
startup.StartupInfo.cb = std::mem::size_of::<STARTUPINFOEXW>() as u32;
|
||||||
|
startup.StartupInfo.dwFlags = STARTF_USESTDHANDLES;
|
||||||
|
startup.StartupInfo.hStdInput = handles[0];
|
||||||
|
startup.StartupInfo.hStdOutput = handles[1];
|
||||||
|
startup.StartupInfo.hStdError = handles[1];
|
||||||
|
startup.lpAttributeList = attributes.0.as_mut_ptr().cast();
|
||||||
|
let mut process: PROCESS_INFORMATION = unsafe { std::mem::zeroed() };
|
||||||
|
// SAFETY: strings are NUL-terminated UTF-16, the environment is double-NUL
|
||||||
|
// terminated, and all buffers/handles remain alive for the duration of spawn.
|
||||||
|
if unsafe {
|
||||||
|
CreateProcessW(
|
||||||
|
application.as_ptr(),
|
||||||
|
command.as_mut_ptr(),
|
||||||
|
std::ptr::null(),
|
||||||
|
std::ptr::null(),
|
||||||
|
1,
|
||||||
|
CREATE_NO_WINDOW
|
||||||
|
| CREATE_NEW_PROCESS_GROUP
|
||||||
|
| CREATE_UNICODE_ENVIRONMENT
|
||||||
|
| EXTENDED_STARTUPINFO_PRESENT,
|
||||||
|
environment.as_ptr().cast(),
|
||||||
|
std::ptr::null(),
|
||||||
|
&startup.StartupInfo,
|
||||||
|
&mut process,
|
||||||
|
)
|
||||||
|
} == 0
|
||||||
|
{
|
||||||
|
return Err(io::Error::last_os_error());
|
||||||
|
}
|
||||||
|
// SAFETY: successful CreateProcessW transfers these two handles to us.
|
||||||
|
let _thread = unsafe { OwnedHandle::from_raw_handle(process.hThread) };
|
||||||
|
Ok(Helper(unsafe {
|
||||||
|
OwnedHandle::from_raw_handle(process.hProcess)
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn wide(value: &OsStr) -> Vec<u16> {
|
||||||
|
value.encode_wide().chain(Some(0)).collect()
|
||||||
|
}
|
||||||
@@ -10,8 +10,7 @@ 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, TransferReleaseResult, UploadFile, UploadMode,
|
TransferIdParams, TransferReadyResult, UploadFile, UploadMode, UploadParams, UploadResult,
|
||||||
UploadParams, UploadResult,
|
|
||||||
};
|
};
|
||||||
use clap::{Args, ValueEnum};
|
use clap::{Args, ValueEnum};
|
||||||
|
|
||||||
@@ -69,14 +68,12 @@ 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 {
|
||||||
match stage_file(&info.sock_path, &args.session, path) {
|
if let Err(err) = stage_file(&info.sock_path, &args.session, path, &mut staged) {
|
||||||
Ok(file) => staged.push(file),
|
let _ = crate::cli::business_rpc::release_transfers(
|
||||||
Err(err) => {
|
&info.sock_path,
|
||||||
for (id, _) in &staged {
|
staged.iter().map(|(id, _)| id.as_str()),
|
||||||
let _ = release(&info.sock_path, id);
|
);
|
||||||
}
|
return Err(err);
|
||||||
return Err(err);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let params = UploadParams {
|
let params = UploadParams {
|
||||||
@@ -102,6 +99,17 @@ 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.
|
||||||
@@ -118,7 +126,12 @@ pub fn dispatch(args: UploadArgs, format: Format) -> Result<(), CliError> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stage_file(sock: &Path, session: &str, path: &PathBuf) -> Result<(String, String), CliError> {
|
fn stage_file(
|
||||||
|
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)?;
|
||||||
@@ -149,55 +162,39 @@ fn stage_file(sock: &Path, session: &str, path: &PathBuf) -> Result<(String, Str
|
|||||||
}),
|
}),
|
||||||
Duration::from_secs(10),
|
Duration::from_secs(10),
|
||||||
)?;
|
)?;
|
||||||
let staged = (|| {
|
// Record ownership immediately so one error path releases both completed
|
||||||
let mut offset = 0u64;
|
// files and the current partially staged file.
|
||||||
let mut buf = vec![0u8; begin.chunk_size as usize];
|
staged.push((begin.transfer_id.clone(), name));
|
||||||
loop {
|
let mut offset = 0u64;
|
||||||
let n = file.read(&mut buf).map_err(|e| CliError::Local(e.into()))?;
|
let mut buf = vec![0u8; begin.chunk_size as usize];
|
||||||
if n == 0 {
|
loop {
|
||||||
break;
|
let n = file.read(&mut buf).map_err(|e| CliError::Local(e.into()))?;
|
||||||
}
|
if n == 0 {
|
||||||
let reply: TransferChunkResult = crate::cli::business_rpc::call(
|
break;
|
||||||
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 _: TransferReadyResult = crate::cli::business_rpc::call(
|
let reply: TransferChunkResult = crate::cli::business_rpc::call(
|
||||||
sock.to_path_buf(),
|
sock.to_path_buf(),
|
||||||
"transfer-finish",
|
"transfer-chunk",
|
||||||
Method::TransferFinish,
|
Method::TransferChunk,
|
||||||
Some(TransferIdParams {
|
Some(TransferChunkParams {
|
||||||
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(10),
|
Duration::from_secs(30),
|
||||||
)?;
|
)?;
|
||||||
Ok::<_, CliError>(())
|
offset = reply.next_offset;
|
||||||
})();
|
|
||||||
if let Err(err) = staged {
|
|
||||||
let _ = release(sock, &begin.transfer_id);
|
|
||||||
return Err(err);
|
|
||||||
}
|
}
|
||||||
Ok((begin.transfer_id, name))
|
let _: TransferReadyResult = crate::cli::business_rpc::call(
|
||||||
}
|
|
||||||
|
|
||||||
fn release(sock: &Path, id: &str) -> Result<TransferReleaseResult, CliError> {
|
|
||||||
crate::cli::business_rpc::call(
|
|
||||||
sock.to_path_buf(),
|
sock.to_path_buf(),
|
||||||
"transfer-release",
|
"transfer-finish",
|
||||||
Method::TransferRelease,
|
Method::TransferFinish,
|
||||||
Some(TransferIdParams {
|
Some(TransferIdParams {
|
||||||
transfer_id: id.to_string(),
|
transfer_id: begin.transfer_id.clone(),
|
||||||
}),
|
}),
|
||||||
Duration::from_secs(5),
|
Duration::from_secs(10),
|
||||||
)
|
)?;
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn ipc_timeout(timeout_ms: u32) -> Duration {
|
fn ipc_timeout(timeout_ms: u32) -> Duration {
|
||||||
|
|||||||
@@ -1399,6 +1399,28 @@ mod windows {
|
|||||||
connected = pipe.connect() => {
|
connected = pipe.connect() => {
|
||||||
match connected {
|
match connected {
|
||||||
Ok(()) => {
|
Ok(()) => {
|
||||||
|
// Keep the connected instance alive until its replacement
|
||||||
|
// exists. Otherwise a fast handler can close the last
|
||||||
|
// instance and make new clients fail with NotFound.
|
||||||
|
loop {
|
||||||
|
match ServerOptions::new()
|
||||||
|
.access_inbound(true)
|
||||||
|
.access_outbound(true)
|
||||||
|
.create(&listener.pipe_name)
|
||||||
|
{
|
||||||
|
Ok(next) => {
|
||||||
|
listener.first = Some(next);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
Err(err) => {
|
||||||
|
warn!(?err, "create next named-pipe instance failed");
|
||||||
|
tokio::select! {
|
||||||
|
_ = &mut shutdown => return,
|
||||||
|
_ = tokio::time::sleep(std::time::Duration::from_millis(50)) => {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
on_open();
|
on_open();
|
||||||
let handler = handler.clone();
|
let handler = handler.clone();
|
||||||
let on_act = on_activity.clone();
|
let on_act = on_activity.clone();
|
||||||
@@ -1467,6 +1489,118 @@ mod windows {
|
|||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use std::sync::Mutex;
|
||||||
|
use std::time::Duration;
|
||||||
|
use tokio::net::windows::named_pipe::ClientOptions;
|
||||||
|
use tokio::sync::oneshot;
|
||||||
|
|
||||||
|
fn isolated_listener() -> NamedPipeListener {
|
||||||
|
let pipe_name = format!(r"\\.\pipe\bsk-test-{}", uuid::Uuid::new_v4());
|
||||||
|
let first = ServerOptions::new()
|
||||||
|
.first_pipe_instance(true)
|
||||||
|
.create(&pipe_name)
|
||||||
|
.unwrap();
|
||||||
|
NamedPipeListener {
|
||||||
|
pipe_name,
|
||||||
|
first: Some(first),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn next_instance_exists_before_connection_is_handed_off() {
|
||||||
|
let listener = isolated_listener();
|
||||||
|
let name = listener.pipe_name.clone();
|
||||||
|
let probe_name = name.clone();
|
||||||
|
let (probe_tx, probe_rx) = oneshot::channel();
|
||||||
|
let probe_tx = Mutex::new(Some(probe_tx));
|
||||||
|
let (stop_tx, stop_rx) = oneshot::channel();
|
||||||
|
let server = tokio::spawn(serve(
|
||||||
|
listener,
|
||||||
|
crate::daemon::ipc::default_ping_handler(),
|
||||||
|
move || {
|
||||||
|
if let Some(tx) = probe_tx.lock().unwrap().take() {
|
||||||
|
// This callback runs before the connection task can finish.
|
||||||
|
// A second client must already have an instance to open.
|
||||||
|
let result = ClientOptions::new().open(&probe_name).map(drop);
|
||||||
|
let _ = tx.send(result);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|| {},
|
||||||
|
|| {},
|
||||||
|
async {
|
||||||
|
let _ = stop_rx.await;
|
||||||
|
},
|
||||||
|
));
|
||||||
|
let client = ClientOptions::new().open(&name).unwrap();
|
||||||
|
let result = tokio::time::timeout(Duration::from_secs(5), probe_rx).await;
|
||||||
|
drop(client);
|
||||||
|
let _ = stop_tx.send(());
|
||||||
|
server.await.unwrap();
|
||||||
|
result
|
||||||
|
.expect("accept callback ran")
|
||||||
|
.unwrap()
|
||||||
|
.expect("next pipe instance is ready");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||||
|
async fn rapid_disconnects_and_concurrent_rpc_connections() {
|
||||||
|
let listener = isolated_listener();
|
||||||
|
let name = listener.pipe_name.clone();
|
||||||
|
let (stop_tx, stop_rx) = oneshot::channel();
|
||||||
|
let server = tokio::spawn(serve(
|
||||||
|
listener,
|
||||||
|
crate::daemon::ipc::default_ping_handler(),
|
||||||
|
|| {},
|
||||||
|
|| {},
|
||||||
|
|| {},
|
||||||
|
async {
|
||||||
|
let _ = stop_rx.await;
|
||||||
|
},
|
||||||
|
));
|
||||||
|
let exercise = async {
|
||||||
|
// Include clients that close without sending any request.
|
||||||
|
for _ in 0..64 {
|
||||||
|
drop(
|
||||||
|
crate::ipc_client::Client::connect_path(name.clone().into())
|
||||||
|
.await
|
||||||
|
.unwrap(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
let mut clients = tokio::task::JoinSet::new();
|
||||||
|
for _ in 0..8 {
|
||||||
|
let name = name.clone();
|
||||||
|
clients.spawn(async move {
|
||||||
|
for _ in 0..32 {
|
||||||
|
let mut client =
|
||||||
|
crate::ipc_client::Client::connect_path(name.clone().into())
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
let reply: bsk_protocol::PingResult = client
|
||||||
|
.call(
|
||||||
|
bsk_protocol::Method::SystemPing,
|
||||||
|
&serde_json::json!({}),
|
||||||
|
Duration::from_secs(5),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.unwrap();
|
||||||
|
assert!(reply.pong);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
while let Some(result) = clients.join_next().await {
|
||||||
|
result.unwrap();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let result = tokio::time::timeout(Duration::from_secs(30), exercise).await;
|
||||||
|
let _ = stop_tx.send(());
|
||||||
|
server.await.unwrap();
|
||||||
|
result.expect("connection exercise completed");
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
|
|||||||
@@ -90,17 +90,21 @@ pub fn pid_alive(pid: u32) -> bool {
|
|||||||
|
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
{
|
{
|
||||||
use windows_sys::Win32::Foundation::CloseHandle;
|
use windows_sys::Win32::Foundation::{CloseHandle, WAIT_TIMEOUT};
|
||||||
use windows_sys::Win32::System::Threading::{
|
use windows_sys::Win32::System::Threading::{
|
||||||
OpenProcess, PROCESS_QUERY_LIMITED_INFORMATION,
|
OpenProcess, PROCESS_SYNCHRONIZE, WaitForSingleObject,
|
||||||
};
|
};
|
||||||
unsafe {
|
unsafe {
|
||||||
let handle = OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, 0, pid);
|
let handle = OpenProcess(PROCESS_SYNCHRONIZE, 0, pid);
|
||||||
if handle.is_null() {
|
if handle.is_null() {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
// An exited process can still be opened while another handle
|
||||||
|
// keeps its kernel object alive. Poll its termination signal;
|
||||||
|
// unlike checking STILL_ACTIVE, this also handles exit code 259.
|
||||||
|
let alive = WaitForSingleObject(handle, 0) == WAIT_TIMEOUT;
|
||||||
CloseHandle(handle);
|
CloseHandle(handle);
|
||||||
true
|
alive
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -110,3 +114,39 @@ pub fn pid_alive(pid: u32) -> bool {
|
|||||||
false
|
false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(all(test, windows))]
|
||||||
|
mod tests {
|
||||||
|
use super::pid_alive;
|
||||||
|
use std::os::windows::process::CommandExt;
|
||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn current_process_is_alive() {
|
||||||
|
assert!(pid_alive(std::process::id()));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn invalid_process_is_not_alive() {
|
||||||
|
assert!(!pid_alive(0));
|
||||||
|
assert!(!pid_alive(u32::MAX));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn exited_process_with_retained_handle_is_not_alive() {
|
||||||
|
for exit_code in [0, 259] {
|
||||||
|
let mut child = Command::new("cmd.exe")
|
||||||
|
.args(["/D", "/C", &format!("exit {exit_code}")])
|
||||||
|
.creation_flags(0x0800_0000) // CREATE_NO_WINDOW
|
||||||
|
.spawn()
|
||||||
|
.expect("spawn short-lived process");
|
||||||
|
assert_eq!(child.wait().unwrap().code(), Some(exit_code));
|
||||||
|
// Keep Child (and its process handle) alive during the probe.
|
||||||
|
assert!(
|
||||||
|
!pid_alive(child.id()),
|
||||||
|
"exited process with code {exit_code}"
|
||||||
|
);
|
||||||
|
drop(child);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -232,8 +232,8 @@ pub fn run_foreground(cfg: DaemonConfig) -> Result<()> {
|
|||||||
let session_idle_task = spawn_session_idle_reaper(Arc::clone(&state));
|
let session_idle_task = spawn_session_idle_reaper(Arc::clone(&state));
|
||||||
let browser_liveness_task = spawn_browser_liveness_reaper(Arc::clone(&state));
|
let browser_liveness_task = spawn_browser_liveness_reaper(Arc::clone(&state));
|
||||||
// Fired by the update check task after a successful auto-update:
|
// Fired by the update check task after a successful auto-update:
|
||||||
// the replacement daemon has already been spawned, so this
|
// the replacement daemon (or Windows update helper) is ready, so
|
||||||
// process should shut down and let it take over.
|
// this process should shut down and let it take over.
|
||||||
let restart_notify = Arc::new(tokio::sync::Notify::new());
|
let restart_notify = Arc::new(tokio::sync::Notify::new());
|
||||||
let update_check_task =
|
let update_check_task =
|
||||||
spawn_update_check_task(Arc::clone(&state), Arc::clone(&restart_notify));
|
spawn_update_check_task(Arc::clone(&state), Arc::clone(&restart_notify));
|
||||||
@@ -539,8 +539,8 @@ pub(crate) fn spawn_session_idle_reaper(state: Arc<DaemonState>) -> tokio::task:
|
|||||||
/// task spawns the replacement daemon (see
|
/// task spawns the replacement daemon (see
|
||||||
/// [`DAEMON_REPLACEMENT_WAIT_ENV`]) and fires `restart` so this process
|
/// [`DAEMON_REPLACEMENT_WAIT_ENV`]) and fires `restart` so this process
|
||||||
/// shuts down and the new version takes over; on Windows the
|
/// shuts down and the new version takes over; on Windows the
|
||||||
/// replacement can only be staged, so it just logs that a restart is
|
/// helper waits for this process to exit, replaces the binary, and starts
|
||||||
/// needed.
|
/// the new daemon with the same configuration.
|
||||||
pub(crate) fn spawn_update_check_task(
|
pub(crate) fn spawn_update_check_task(
|
||||||
state: Arc<DaemonState>,
|
state: Arc<DaemonState>,
|
||||||
restart: Arc<tokio::sync::Notify>,
|
restart: Arc<tokio::sync::Notify>,
|
||||||
@@ -605,7 +605,11 @@ pub(crate) fn spawn_update_check_task(
|
|||||||
|candidate| {
|
|candidate| {
|
||||||
let target =
|
let target =
|
||||||
exe_path.as_deref().context("current executable unknown")?;
|
exe_path.as_deref().context("current executable unknown")?;
|
||||||
update::self_install_candidate(candidate, target)
|
update::self_install_candidate(
|
||||||
|
candidate,
|
||||||
|
target,
|
||||||
|
&restart_start_args(&state.config),
|
||||||
|
)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
@@ -635,10 +639,11 @@ pub(crate) fn spawn_update_check_task(
|
|||||||
sessions,
|
sessions,
|
||||||
"auto-update postponed: agent session(s) active; will retry on the next tick"
|
"auto-update postponed: agent session(s) active; will retry on the next tick"
|
||||||
),
|
),
|
||||||
update::AutoUpdateOutcome::Staged { latest } => warn!(
|
update::AutoUpdateOutcome::Staged { latest } => {
|
||||||
%latest,
|
info!(%latest, "update helper ready; exiting so it can replace and restart the daemon");
|
||||||
"auto-update staged the new binary but cannot replace the running daemon in place; restart the daemon (or terminal) to finish the upgrade"
|
restart.notify_one();
|
||||||
),
|
return;
|
||||||
|
}
|
||||||
update::AutoUpdateOutcome::Replaced { latest } => {
|
update::AutoUpdateOutcome::Replaced { latest } => {
|
||||||
info!(
|
info!(
|
||||||
current = env!("CARGO_PKG_VERSION"),
|
current = env!("CARGO_PKG_VERSION"),
|
||||||
|
|||||||
@@ -0,0 +1,342 @@
|
|||||||
|
//! 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"))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,343 @@
|
|||||||
|
//! Exercise self-update with a real executable and a local release server.
|
||||||
|
#![cfg(windows)]
|
||||||
|
|
||||||
|
use std::fs;
|
||||||
|
use std::io::{Cursor, Read, Write};
|
||||||
|
use std::net::{TcpListener, TcpStream};
|
||||||
|
use std::os::windows::process::CommandExt;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
use std::process::{Child, Command, Stdio};
|
||||||
|
use std::sync::Arc;
|
||||||
|
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
|
||||||
|
use std::thread;
|
||||||
|
use std::time::{Duration, Instant};
|
||||||
|
|
||||||
|
use bsk::daemon::info::DaemonInfo;
|
||||||
|
use sha2::{Digest, Sha256};
|
||||||
|
|
||||||
|
const MARKER: &[u8] = b"windows-update-regression-fixture";
|
||||||
|
|
||||||
|
struct ReleaseServer {
|
||||||
|
url: String,
|
||||||
|
requests: Arc<AtomicUsize>,
|
||||||
|
stop: Arc<AtomicBool>,
|
||||||
|
worker: Option<thread::JoinHandle<()>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ReleaseServer {
|
||||||
|
fn new(binary: &[u8]) -> Self {
|
||||||
|
let mut archive = zip::ZipWriter::new(Cursor::new(Vec::new()));
|
||||||
|
archive
|
||||||
|
.start_file(
|
||||||
|
"bsk.exe",
|
||||||
|
zip::write::SimpleFileOptions::default()
|
||||||
|
.compression_method(zip::CompressionMethod::Stored),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
archive.write_all(binary).unwrap();
|
||||||
|
let archive = archive.finish().unwrap().into_inner();
|
||||||
|
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||||
|
listener.set_nonblocking(true).unwrap();
|
||||||
|
let url = format!("http://{}", listener.local_addr().unwrap());
|
||||||
|
let manifest = serde_json::to_vec(&serde_json::json!({
|
||||||
|
"version": "999.0.0",
|
||||||
|
"assets": {"windows-x64": {
|
||||||
|
"url": format!("{url}/bsk.zip"),
|
||||||
|
"sha256": Sha256::digest(&archive).iter().map(|byte| format!("{byte:02x}")).collect::<String>(),
|
||||||
|
}},
|
||||||
|
}))
|
||||||
|
.unwrap();
|
||||||
|
let stop = Arc::new(AtomicBool::new(false));
|
||||||
|
let worker_stop = Arc::clone(&stop);
|
||||||
|
let requests = Arc::new(AtomicUsize::new(0));
|
||||||
|
let worker_requests = Arc::clone(&requests);
|
||||||
|
let worker = thread::spawn(move || {
|
||||||
|
while !worker_stop.load(Ordering::SeqCst) {
|
||||||
|
let (mut stream, _) = match listener.accept() {
|
||||||
|
Ok(connection) => connection,
|
||||||
|
Err(err) if err.kind() == std::io::ErrorKind::WouldBlock => {
|
||||||
|
thread::sleep(Duration::from_millis(10));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
Err(err) => panic!("accept release request: {err}"),
|
||||||
|
};
|
||||||
|
// Windows accept() inherits the listener's nonblocking mode.
|
||||||
|
// Keep accept polling for shutdown, but read/write each request
|
||||||
|
// in blocking mode with the bounded timeouts below.
|
||||||
|
stream.set_nonblocking(false).unwrap();
|
||||||
|
stream
|
||||||
|
.set_read_timeout(Some(Duration::from_secs(5)))
|
||||||
|
.unwrap();
|
||||||
|
stream
|
||||||
|
.set_write_timeout(Some(Duration::from_secs(5)))
|
||||||
|
.unwrap();
|
||||||
|
let mut request = Vec::new();
|
||||||
|
let mut chunk = [0; 1024];
|
||||||
|
while !request.windows(4).any(|window| window == b"\r\n\r\n") {
|
||||||
|
let len = stream.read(&mut chunk).unwrap();
|
||||||
|
if len == 0 {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
request.extend_from_slice(&chunk[..len]);
|
||||||
|
}
|
||||||
|
let body = if request.starts_with(b"GET /bsk.zip ") {
|
||||||
|
worker_requests.fetch_add(1, Ordering::SeqCst);
|
||||||
|
&archive
|
||||||
|
} else {
|
||||||
|
&manifest
|
||||||
|
};
|
||||||
|
write!(
|
||||||
|
stream,
|
||||||
|
"HTTP/1.1 200 OK\r\nContent-Length: {}\r\nConnection: close\r\n\r\n",
|
||||||
|
body.len()
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
stream.write_all(body).unwrap();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
Self {
|
||||||
|
url: format!("{url}/version.json"),
|
||||||
|
requests,
|
||||||
|
stop,
|
||||||
|
worker: Some(worker),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for ReleaseServer {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop.store(true, Ordering::SeqCst);
|
||||||
|
let _ = self.worker.take().unwrap().join();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn release_server_waits_for_delayed_and_fragmented_request_headers() {
|
||||||
|
let server = ReleaseServer::new(b"test binary");
|
||||||
|
let address = server
|
||||||
|
.url
|
||||||
|
.strip_prefix("http://")
|
||||||
|
.unwrap()
|
||||||
|
.strip_suffix("/version.json")
|
||||||
|
.unwrap();
|
||||||
|
let mut stream = TcpStream::connect(address).unwrap();
|
||||||
|
stream
|
||||||
|
.set_read_timeout(Some(Duration::from_secs(5)))
|
||||||
|
.unwrap();
|
||||||
|
stream
|
||||||
|
.set_write_timeout(Some(Duration::from_secs(5)))
|
||||||
|
.unwrap();
|
||||||
|
// Give accept() time to run before any bytes arrive, then split the
|
||||||
|
// headers across writes. Both reads must wait rather than return WouldBlock.
|
||||||
|
thread::sleep(Duration::from_millis(100));
|
||||||
|
stream.write_all(b"GET /version.json HTTP/1.1\r\n").unwrap();
|
||||||
|
thread::sleep(Duration::from_millis(100));
|
||||||
|
stream.write_all(b"Host: localhost\r\n\r\n").unwrap();
|
||||||
|
let mut response = String::new();
|
||||||
|
stream.read_to_string(&mut response).unwrap();
|
||||||
|
assert!(response.starts_with("HTTP/1.1 200 OK\r\n"), "{response}");
|
||||||
|
let (_, body) = response.split_once("\r\n\r\n").unwrap();
|
||||||
|
let manifest: serde_json::Value = serde_json::from_str(body).unwrap();
|
||||||
|
assert_eq!(manifest["version"], "999.0.0");
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Fixture {
|
||||||
|
_tmp: tempfile::TempDir,
|
||||||
|
exe: PathBuf,
|
||||||
|
home: PathBuf,
|
||||||
|
binary: Vec<u8>,
|
||||||
|
server: ReleaseServer,
|
||||||
|
daemon: Option<Child>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Fixture {
|
||||||
|
fn new() -> Self {
|
||||||
|
let tmp = tempfile::TempDir::new().unwrap();
|
||||||
|
let dir = tmp.path().join("中文 space %PATH% ! & (update)");
|
||||||
|
fs::create_dir(&dir).unwrap();
|
||||||
|
let exe = dir.join("bsk.exe");
|
||||||
|
let home = tmp.path().join("home");
|
||||||
|
fs::create_dir(&home).unwrap();
|
||||||
|
fs::copy(env!("CARGO_BIN_EXE_bsk"), &exe).unwrap();
|
||||||
|
// A PE overlay distinguishes the replacement without requiring a
|
||||||
|
// second build or changing the executable's behavior/version.
|
||||||
|
let mut binary = fs::read(&exe).unwrap();
|
||||||
|
binary.extend_from_slice(MARKER);
|
||||||
|
let server = ReleaseServer::new(&binary);
|
||||||
|
Self {
|
||||||
|
_tmp: tmp,
|
||||||
|
exe,
|
||||||
|
home,
|
||||||
|
binary,
|
||||||
|
server,
|
||||||
|
daemon: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn command(&self) -> Command {
|
||||||
|
let mut cmd = Command::new(&self.exe);
|
||||||
|
cmd.env("BSK_HOME", &self.home)
|
||||||
|
.env("BSK_UPDATE_MANIFEST_URL", &self.server.url)
|
||||||
|
.env("BSK_AUTO_UPDATE", "off")
|
||||||
|
.env("RUST_LOG", "info")
|
||||||
|
.env("NO_PROXY", "127.0.0.1,localhost")
|
||||||
|
.env_remove("BSK_DAEMONIZED")
|
||||||
|
.env_remove("BSK_DAEMON_REPLACES_PID")
|
||||||
|
.stdin(Stdio::null())
|
||||||
|
.creation_flags(0x0800_0000);
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
fn wait_for(&self, description: &str, mut check: impl FnMut() -> bool) {
|
||||||
|
let deadline = Instant::now() + Duration::from_secs(30);
|
||||||
|
while Instant::now() < deadline {
|
||||||
|
if check() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
thread::sleep(Duration::from_millis(50));
|
||||||
|
}
|
||||||
|
let diagnostics: Vec<_> = fs::read_dir(self.exe.parent().unwrap())
|
||||||
|
.unwrap()
|
||||||
|
.flatten()
|
||||||
|
.filter(|entry| entry.path().extension().is_some_and(|ext| ext == "log"))
|
||||||
|
.map(|entry| {
|
||||||
|
(
|
||||||
|
entry.path(),
|
||||||
|
String::from_utf8_lossy(&fs::read(entry.path()).unwrap_or_default())
|
||||||
|
.into_owned(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let home_logs: Vec<_> = fs::read_dir(&self.home)
|
||||||
|
.unwrap()
|
||||||
|
.flatten()
|
||||||
|
.filter(|entry| entry.file_name().to_string_lossy().contains("log"))
|
||||||
|
.map(|entry| {
|
||||||
|
(
|
||||||
|
entry.path(),
|
||||||
|
String::from_utf8_lossy(&fs::read(entry.path()).unwrap_or_default())
|
||||||
|
.into_owned(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
panic!(
|
||||||
|
"timed out waiting for {description}; helper logs: {diagnostics:?}; daemon logs: {home_logs:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn info(&self) -> Option<DaemonInfo> {
|
||||||
|
serde_json::from_slice(&fs::read(self.home.join("daemon.json")).ok()?).ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn updated(&self) -> bool {
|
||||||
|
// A locked executable may briefly reject reads during replacement.
|
||||||
|
fs::read(&self.exe).is_ok_and(|binary| binary == self.binary)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for Fixture {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// Stop only the daemon belonging to this isolated BSK_HOME. Also reap
|
||||||
|
// the foreground process on assertion failures to avoid leaking locks.
|
||||||
|
let _ = self.command().args(["daemon", "stop"]).output();
|
||||||
|
if let Some(child) = self.daemon.as_mut() {
|
||||||
|
let _ = child.kill();
|
||||||
|
let _ = child.wait();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn manual_update_replaces_the_running_executable_after_cli_exit() {
|
||||||
|
let fixture = Fixture::new();
|
||||||
|
let out = fixture
|
||||||
|
.command()
|
||||||
|
.args(["--json", "update", "--yes"])
|
||||||
|
.output()
|
||||||
|
.unwrap();
|
||||||
|
assert!(
|
||||||
|
out.status.success(),
|
||||||
|
"{}",
|
||||||
|
String::from_utf8_lossy(&out.stderr)
|
||||||
|
);
|
||||||
|
let report: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap();
|
||||||
|
assert_eq!(report["status"], "staged");
|
||||||
|
fixture.wait_for("CLI replacement and helper cleanup", || {
|
||||||
|
fixture.updated() && fs::read_dir(fixture.exe.parent().unwrap()).unwrap().count() == 1
|
||||||
|
});
|
||||||
|
assert!(
|
||||||
|
fixture.info().is_none(),
|
||||||
|
"an update must not start a previously absent daemon"
|
||||||
|
);
|
||||||
|
assert_eq!(fixture.server.requests.load(Ordering::SeqCst), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn automatic_update_exits_old_daemon_and_restarts_on_the_same_port() {
|
||||||
|
let mut fixture = Fixture::new();
|
||||||
|
let port = unused_port();
|
||||||
|
let log = fs::File::create(fixture.home.join("foreground.log")).unwrap();
|
||||||
|
let child = fixture
|
||||||
|
.command()
|
||||||
|
.env("BSK_AUTO_UPDATE", "on")
|
||||||
|
// Exercise the environment inherited by a normally detached daemon.
|
||||||
|
.env("BSK_DAEMONIZED", "1")
|
||||||
|
.args([
|
||||||
|
"daemon",
|
||||||
|
"start",
|
||||||
|
"--port",
|
||||||
|
&port.to_string(),
|
||||||
|
"--session-idle",
|
||||||
|
"1234ms",
|
||||||
|
"--daemon-idle",
|
||||||
|
"30s",
|
||||||
|
])
|
||||||
|
.stdout(Stdio::from(log.try_clone().unwrap()))
|
||||||
|
.stderr(Stdio::from(log))
|
||||||
|
.spawn()
|
||||||
|
.unwrap();
|
||||||
|
let old_pid = child.id();
|
||||||
|
fixture.daemon = Some(child);
|
||||||
|
fixture.wait_for("replacement daemon", || {
|
||||||
|
fixture.updated()
|
||||||
|
&& fixture
|
||||||
|
.info()
|
||||||
|
.is_some_and(|info| info.pid != old_pid && info.ws_port == port)
|
||||||
|
});
|
||||||
|
assert!(
|
||||||
|
fixture
|
||||||
|
.daemon
|
||||||
|
.as_mut()
|
||||||
|
.unwrap()
|
||||||
|
.try_wait()
|
||||||
|
.unwrap()
|
||||||
|
.is_some(),
|
||||||
|
"old daemon must exit"
|
||||||
|
);
|
||||||
|
fixture.wait_for("helper cleanup", || {
|
||||||
|
fs::read_dir(fixture.exe.parent().unwrap()).unwrap().count() == 1
|
||||||
|
});
|
||||||
|
let status = fixture
|
||||||
|
.command()
|
||||||
|
.args(["--json", "status"])
|
||||||
|
.output()
|
||||||
|
.unwrap();
|
||||||
|
assert!(
|
||||||
|
status.status.success(),
|
||||||
|
"{}",
|
||||||
|
String::from_utf8_lossy(&status.stderr)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
fixture.server.requests.load(Ordering::SeqCst),
|
||||||
|
1,
|
||||||
|
"the replacement must not stage another update immediately"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn unused_port() -> u16 {
|
||||||
|
TcpListener::bind("127.0.0.1:0")
|
||||||
|
.unwrap()
|
||||||
|
.local_addr()
|
||||||
|
.unwrap()
|
||||||
|
.port()
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
# DOMSnapshot layout-unit regression (#195)
|
||||||
|
|
||||||
|
Source: https://github.com/Tencent/BrowserSkill/pull/195
|
||||||
|
|
||||||
|
DOMSnapshot bounds and document scroll offsets retain Blink layout units. Treating them as CSS
|
||||||
|
pixels changes both positions and sizes under device scaling/browser zoom, before iframe
|
||||||
|
projection or viewport clipping even starts.
|
||||||
|
|
||||||
|
The fixture contains a scrolled root, a scrolled same-process iframe, an OOPIF served from the
|
||||||
|
other loopback hostname, and a nested iframe in each. Owners have borders, padding and CSS
|
||||||
|
transforms. The geometry test compares the production capture's local and top-level rectangles
|
||||||
|
against independent DOM border boxes, with at most 2 CSS pixels of layout rounding. It also
|
||||||
|
checks that each target reads layout metrics only once. No credentials or personal tabs are used.
|
||||||
|
|
||||||
|
Run the geometric assertions with Node 22+ and a local Chrome executable:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
BSK_GEOMETRY_CHROME=/path/to/chrome pnpm --filter @browser-skill/extension exec vitest run \
|
||||||
|
src/tools/__tests__/snapshot-coordinates.browser.test.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
The test launches and cleans up its own headless Chrome profiles. It explicitly verifies the
|
||||||
|
requested browser zoom and OOPIF topology, so unsupported setups fail rather than silently
|
||||||
|
testing a different configuration. It is skipped in ordinary unit runs unless the executable
|
||||||
|
is specified. No browser download or new package dependency is required.
|
||||||
|
|
||||||
|
The corpus smoke case checks fixture readiness and observable semantics through the real CLI:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
BSK_AUTO_UPDATE=off pnpm eval:browser smoke --case snapshot-coordinates --bsk ./target/debug/bsk
|
||||||
|
```
|
||||||
|
|
||||||
|
Smoke alone does **not** certify coordinate accuracy; CLI observations do not expose raw boxes.
|
||||||
|
Use the geometric test above for the regression's numeric assertions.
|
||||||
|
|
||||||
|
## Separate existing boundary
|
||||||
|
|
||||||
|
The OOPIF root uses non-occupying scrollbars in the unit-conversion regression. Root and
|
||||||
|
same-process frames retain normal scrollbars. Append `&classic-scrollbars` to the fixture URL
|
||||||
|
to reproduce the separate existing OOPIF projection issue: `targetProjection()` maps the CSS
|
||||||
|
layout viewport (which excludes occupying scrollbars) onto the entire owner content quad.
|
||||||
|
This inflates the projected coordinates when scrollbars occupy space. Main already has that
|
||||||
|
mapping; fixing it also changes shared live geometry and is outside this snapshot-unit fix.
|
||||||
|
The test does not relax its numeric tolerance to absorb that error.
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
import { spawn } from "node:child_process";
|
||||||
|
import { once } from "node:events";
|
||||||
|
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
|
||||||
|
import { tmpdir } from "node:os";
|
||||||
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
// This regression owns its browser/profile. It never attaches to a user's Chrome.
|
||||||
|
export async function withChrome({ executable, deviceScale, zoom }, run) {
|
||||||
|
const profile = await mkdtemp(join(tmpdir(), "bsk-snapshot-coordinates-"));
|
||||||
|
let chrome;
|
||||||
|
let socket;
|
||||||
|
const pending = new Map();
|
||||||
|
try {
|
||||||
|
await mkdir(join(profile, "Default"));
|
||||||
|
await writeFile(
|
||||||
|
join(profile, "Default", "Preferences"),
|
||||||
|
JSON.stringify({
|
||||||
|
partition: { default_zoom_level: { x: Math.log(zoom) / Math.log(1.2) } },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
chrome = spawn(
|
||||||
|
executable,
|
||||||
|
[
|
||||||
|
"--headless=new",
|
||||||
|
"--no-first-run",
|
||||||
|
"--no-default-browser-check",
|
||||||
|
"--disable-extensions",
|
||||||
|
"--site-per-process",
|
||||||
|
"--remote-debugging-port=0",
|
||||||
|
"--window-size=1600,1200",
|
||||||
|
`--force-device-scale-factor=${deviceScale}`,
|
||||||
|
`--user-data-dir=${profile}`,
|
||||||
|
"about:blank",
|
||||||
|
],
|
||||||
|
{ stdio: ["ignore", "ignore", "pipe"] },
|
||||||
|
);
|
||||||
|
const endpoint = await new Promise((resolve, reject) => {
|
||||||
|
let output = "";
|
||||||
|
const timeout = setTimeout(
|
||||||
|
() => reject(new Error(`Chrome startup timed out: ${output}`)),
|
||||||
|
15_000,
|
||||||
|
);
|
||||||
|
const fail = (error) => {
|
||||||
|
clearTimeout(timeout);
|
||||||
|
reject(error);
|
||||||
|
};
|
||||||
|
chrome.once("error", fail);
|
||||||
|
chrome.once("exit", (code) => fail(new Error(`Chrome exited (${code}): ${output}`)));
|
||||||
|
chrome.stderr.on("data", (chunk) => {
|
||||||
|
output += chunk;
|
||||||
|
const match = output.match(/DevTools listening on (ws:\/\/\S+)/);
|
||||||
|
if (match) {
|
||||||
|
clearTimeout(timeout);
|
||||||
|
resolve(match[1]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
socket = new WebSocket(endpoint);
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
socket.addEventListener("open", resolve, { once: true });
|
||||||
|
socket.addEventListener("error", reject, { once: true });
|
||||||
|
});
|
||||||
|
socket.addEventListener("message", ({ data }) => {
|
||||||
|
const reply = JSON.parse(data);
|
||||||
|
const request = pending.get(reply.id);
|
||||||
|
if (!request) return;
|
||||||
|
clearTimeout(request.timeout);
|
||||||
|
pending.delete(reply.id);
|
||||||
|
if (reply.error) request.reject(new Error(JSON.stringify(reply.error)));
|
||||||
|
else request.resolve(reply.result);
|
||||||
|
});
|
||||||
|
let sequence = 0;
|
||||||
|
const send = (method, params = {}, sessionId) =>
|
||||||
|
new Promise((resolve, reject) => {
|
||||||
|
const id = ++sequence;
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
pending.delete(id);
|
||||||
|
reject(new Error(`CDP timed out: ${method}`));
|
||||||
|
}, 10_000);
|
||||||
|
pending.set(id, { resolve, reject, timeout });
|
||||||
|
socket.send(JSON.stringify({ id, method, params, sessionId }));
|
||||||
|
});
|
||||||
|
await run(send);
|
||||||
|
} finally {
|
||||||
|
for (const request of pending.values()) {
|
||||||
|
clearTimeout(request.timeout);
|
||||||
|
request.reject(new Error("regression browser closed"));
|
||||||
|
}
|
||||||
|
socket?.close();
|
||||||
|
if (chrome && chrome.exitCode === null && chrome.signalCode === null) {
|
||||||
|
const exited = once(chrome, "exit");
|
||||||
|
const timeout = setTimeout(() => chrome.kill("SIGKILL"), 5_000);
|
||||||
|
chrome.kill();
|
||||||
|
await exited;
|
||||||
|
clearTimeout(timeout);
|
||||||
|
}
|
||||||
|
await rm(profile, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../../../schemas/case.schema.json",
|
||||||
|
"schemaVersion": 1,
|
||||||
|
"id": "snapshot-coordinates",
|
||||||
|
"title": "Scrolled and nested frame coordinate fixture",
|
||||||
|
"suite": "regression",
|
||||||
|
"tags": ["geometry", "iframe", "scroll"],
|
||||||
|
"fixture": { "startPath": "/snapshot-coordinates" },
|
||||||
|
"prompts": {
|
||||||
|
"en": "Open {url}, observe the page and its frames, report the GEOMETRY marker, then close the session.",
|
||||||
|
"zh-CN": "打开 {url},观察页面及其 iframe,报告 GEOMETRY 标记,然后关闭会话。"
|
||||||
|
},
|
||||||
|
"coverage": ["session.start", "session.stop", "page.navigate", "inspect.observe"],
|
||||||
|
"assertions": {
|
||||||
|
"site": [
|
||||||
|
{
|
||||||
|
"label": "root fixture scrolled and settled",
|
||||||
|
"type": "geometry.ready",
|
||||||
|
"where": { "data.root": true },
|
||||||
|
"minCount": 1
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"response": [{ "label": "observed the fixture marker", "includes": "GEOMETRY-195" }],
|
||||||
|
"adapter": [{ "label": "browser session was closed", "key": "sessionStopped" }]
|
||||||
|
},
|
||||||
|
"smoke": {
|
||||||
|
"steps": [
|
||||||
|
{ "action": "navigate" },
|
||||||
|
{ "action": "wait-site-event", "type": "geometry.ready", "where": { "root": true } },
|
||||||
|
{ "action": "observe" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
import { page, withRun } from "../../../lib/fixtures.mjs";
|
||||||
|
|
||||||
|
export default {
|
||||||
|
id: "snapshot-coordinates",
|
||||||
|
routes: ["/snapshot-coordinates", "/snapshot-coordinates/frame", "/snapshot-coordinates/nested"],
|
||||||
|
render({ pathname, runId, query }) {
|
||||||
|
const root = pathname === "/snapshot-coordinates";
|
||||||
|
const nested = pathname.endsWith("/nested");
|
||||||
|
return page({
|
||||||
|
title: "Snapshot coordinate regression",
|
||||||
|
body: `
|
||||||
|
<style>
|
||||||
|
main { margin: 0; width: auto; }
|
||||||
|
body { width: 2000px; height: 2400px; }
|
||||||
|
html { overflow-anchor: none; }
|
||||||
|
${query.get("scrollbars") === "none" ? "html { scrollbar-width: none; }" : ""}
|
||||||
|
button { position: absolute; box-sizing: border-box; padding: 0; border: 2px solid black; border-radius: 0; }
|
||||||
|
#probe { left: ${root ? 180 : 100}px; top: ${root ? 360 : 160}px; width: 120px; height: 40px; }
|
||||||
|
iframe { position: absolute; box-sizing: content-box; width: 320px; height: 220px;
|
||||||
|
border: 6px solid black; padding: 8px; transform: scale(1.25); transform-origin: 0 0; }
|
||||||
|
#same { left: 340px; top: 400px; }
|
||||||
|
#cross { left: 820px; top: 400px; }
|
||||||
|
#nested { left: 150px; top: 210px; width: 130px; height: 70px; border-width: 2px; padding: 4px; transform: scale(0.8); }
|
||||||
|
${nested ? "#probe { left: 30px; top: 40px; width: 60px; height: 20px; }" : ""}
|
||||||
|
</style>
|
||||||
|
<button id="probe" data-geometry-probe>GEOMETRY-195</button>
|
||||||
|
${root ? `<iframe id="same" name="same" title="same-process frame" src="${withRun("/snapshot-coordinates/frame", runId)}"></iframe><iframe id="cross" name="cross" title="cross-site frame"></iframe>` : ""}
|
||||||
|
${!root && !nested ? `<iframe id="nested" name="nested" title="nested frame" src="${withRun("/snapshot-coordinates/nested", runId)}"></iframe>` : ""}
|
||||||
|
`,
|
||||||
|
script: `
|
||||||
|
history.scrollRestoration = "manual";
|
||||||
|
const cross = document.querySelector("#cross");
|
||||||
|
if (cross) {
|
||||||
|
const url = new URL(${JSON.stringify(withRun("/snapshot-coordinates/frame", runId))}, location.href);
|
||||||
|
url.hostname = location.hostname === "127.0.0.1" ? "localhost" : "127.0.0.1";
|
||||||
|
// Isolate unit conversion from the pre-existing OOPIF scrollbar-width
|
||||||
|
// projection issue. ?classic-scrollbars retains that separate reproduction.
|
||||||
|
if (!new URLSearchParams(location.search).has("classic-scrollbars")) url.searchParams.set("scrollbars", "none");
|
||||||
|
cross.src = url.href;
|
||||||
|
}
|
||||||
|
window.addEventListener("load", () => {
|
||||||
|
scrollTo(${root ? "80, 240" : nested ? "10, 20" : "40, 100"});
|
||||||
|
requestAnimationFrame(() => requestAnimationFrame(() => {
|
||||||
|
window.geometryReady = true;
|
||||||
|
document.documentElement.dataset.geometryReady = "true";
|
||||||
|
browserEval.send("geometry.ready", { root: ${root} });
|
||||||
|
}));
|
||||||
|
});
|
||||||
|
`,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -41,17 +41,22 @@ test("case manifests are discovered, ordered, and grouped into suites", () => {
|
|||||||
"diagnostics",
|
"diagnostics",
|
||||||
"mobile-emulation",
|
"mobile-emulation",
|
||||||
"generated-form",
|
"generated-form",
|
||||||
|
"snapshot-coordinates",
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
assert.deepEqual(repositorySummary(cases, fixtureRegistry).suites, { core: 6, matrix: 1 });
|
assert.deepEqual(repositorySummary(cases, fixtureRegistry).suites, {
|
||||||
|
core: 6,
|
||||||
|
matrix: 1,
|
||||||
|
regression: 1,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test("repository validation links every case to a fixture and valid workflow evidence", () => {
|
test("repository validation links every case to a fixture and valid workflow evidence", () => {
|
||||||
assert.deepEqual(validateRepositoryCases(cases, fixtureRegistry), []);
|
assert.deepEqual(validateRepositoryCases(cases, fixtureRegistry), []);
|
||||||
const summary = repositorySummary(cases, fixtureRegistry);
|
const summary = repositorySummary(cases, fixtureRegistry);
|
||||||
assert.equal(summary.cases, 7);
|
assert.equal(summary.cases, 8);
|
||||||
assert.equal(summary.fixtureModules, 8);
|
assert.equal(summary.fixtureModules, 9);
|
||||||
assert.equal(summary.fixtureRoutes, 12);
|
assert.equal(summary.fixtureRoutes, 15);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("manifest validation rejects unknown operations and incomplete workflow steps", () => {
|
test("manifest validation rejects unknown operations and incomplete workflow steps", () => {
|
||||||
|
|||||||
+41
-15
@@ -21,6 +21,7 @@ $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 {
|
||||||
@@ -64,7 +65,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"
|
||||||
@@ -90,30 +91,59 @@ function Add-ToSessionPath {
|
|||||||
# ── Git Bash (bash environment) PATH helper ──────────────────────────────────
|
# ── Git Bash (bash environment) PATH helper ──────────────────────────────────
|
||||||
|
|
||||||
function Add-ToBashProfile {
|
function Add-ToBashProfile {
|
||||||
param([string]$Dir)
|
param([string]$Dir, [string]$BashRc = (Join-Path $HOME ".bashrc"))
|
||||||
|
|
||||||
# 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]
|
||||||
}
|
}
|
||||||
$bashRc = Join-Path $HOME ".bashrc"
|
# Single-quote the literal directory; only the existing PATH is expanded.
|
||||||
$exportLine = "export PATH=""${unixPath}:`$PATH"" # bsk CLI"
|
$shellQuote = "'" + [char]34 + "'" + [char]34 + "'"
|
||||||
|
$quotedPath = "'" + $unixPath.Replace("'", $shellQuote) + "'"
|
||||||
|
$exportLine = "export PATH=${quotedPath}:`"`$PATH`" # bsk CLI"
|
||||||
|
|
||||||
if (Test-Path $bashRc) {
|
if (Test-Path -LiteralPath $BashRc) {
|
||||||
$content = Get-Content $bashRc -Raw -ErrorAction SilentlyContinue
|
$content = [System.IO.File]::ReadAllText($BashRc)
|
||||||
if ($content -match [regex]::Escape($unixPath)) {
|
if ($content.Contains($exportLine)) {
|
||||||
Write-Log "$unixPath is already in ~/.bashrc"
|
Write-Log "$unixPath is already in ~/.bashrc"
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Add-Content $bashRc "`n$exportLine" -Encoding ASCII
|
# Explicit BOM-less UTF-8 also works in Windows PowerShell 5.1.
|
||||||
|
[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
|
||||||
|
|
||||||
@@ -184,7 +214,7 @@ function Main {
|
|||||||
New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
|
New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
|
||||||
}
|
}
|
||||||
|
|
||||||
Copy-Item -Path (Join-Path $tempDir "bsk.exe") -Destination (Join-Path $InstallDir "bsk.exe") -Force
|
Install-Binary -Source (Join-Path $tempDir "bsk.exe") -Target (Join-Path $InstallDir "bsk.exe")
|
||||||
|
|
||||||
Write-Log "installed bsk to $InstallDir\bsk.exe"
|
Write-Log "installed bsk to $InstallDir\bsk.exe"
|
||||||
|
|
||||||
@@ -199,12 +229,8 @@ function Main {
|
|||||||
|
|
||||||
# Verify
|
# Verify
|
||||||
$bskPath = Join-Path $InstallDir "bsk.exe"
|
$bskPath = Join-Path $InstallDir "bsk.exe"
|
||||||
if (Get-Command bsk -ErrorAction SilentlyContinue) {
|
& $bskPath --version
|
||||||
& bsk --version
|
if ($LASTEXITCODE -ne 0) { throw "installed bsk failed verification" }
|
||||||
}
|
|
||||||
else {
|
|
||||||
Write-Log "verify install: & ""$bskPath"" --version"
|
|
||||||
}
|
|
||||||
|
|
||||||
Write-Log "done"
|
Write-Log "done"
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
|
|||||||
@@ -1,13 +1,51 @@
|
|||||||
# dsh-plugin-browserskill
|
# BrowserSkill for DeepSeek Harness
|
||||||
|
|
||||||
npm: [`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)
|
[](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)
|
||||||
|
|
||||||
A [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (dsh) tool plugin that exposes
|
Use [BrowserSkill](https://github.com/Tencent/BrowserSkill) in
|
||||||
[BrowserSkill](https://github.com/Tencent/BrowserSkill) (`bsk`) browser automation to the model.
|
[DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (`dsh`) to browse
|
||||||
|
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.
|
||||||
|
|
||||||
Each action maps to one `bsk <cmd> --json` invocation: the plugin spawns the bsk CLI, parses its
|
## Installation
|
||||||
structured JSON output, and returns a canonical typed value. The bsk daemon, browser, and browser
|
|
||||||
extension keep owning the actual browser control — this package is a thin, well-typed bridge.
|
Before installing the plugin:
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
@@ -20,23 +58,7 @@ extension keep owning the actual browser control — this package is a thin, wel
|
|||||||
| `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. |
|
||||||
|
|
||||||
`bsk evaluate` and `bsk record` are intentionally not exposed by this plugin: arbitrary page
|
Arbitrary page-script evaluation and interaction recording are not supported.
|
||||||
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
|
||||||
|
|
||||||
@@ -55,115 +77,73 @@ 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.
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
The plugin follows the standard dsh bundle layout (`dsh.bundle` manifest + `cordis.patch.yml`):
|
|
||||||
|
|
||||||
```sh
|
|
||||||
dsh plugin --profile <name> add @wxg-prc-cpg/browser-skill-dsh-plugin
|
|
||||||
dsh --profile <name>
|
|
||||||
```
|
|
||||||
|
|
||||||
Prerequisite: the `bsk` CLI must be installed and on `PATH`, and the BrowserSkill browser extension
|
|
||||||
(Chrome or Edge) must be connected — see the
|
|
||||||
[BrowserSkill README](https://github.com/Tencent/BrowserSkill). When bsk is missing, tool calls fail
|
|
||||||
with install guidance instead of a bare spawn error.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
All fields are optional and validated through the plugin's Schemastery `Config`:
|
After installing the plugin, edit your profile's `cordis.patch.yml`. For the `web`
|
||||||
|
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 `[]`
|
||||||
|
with the YAML below. If it already contains patch entries, add this entry to the
|
||||||
|
existing list or edit its existing `id: browserskill` entry. Keep a single
|
||||||
|
top-level YAML list. This overrides the plugin registered by the installed bundle:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# cordis.patch.yml override example
|
- id: browserskill
|
||||||
- insert:
|
config:
|
||||||
- id: browserskill
|
bskPath: bsk
|
||||||
name: "@wxg-prc-cpg/browser-skill-dsh-plugin"
|
defaultTimeoutMs: 120000
|
||||||
config:
|
maxSessions: 5
|
||||||
bskPath: bsk # path to the bsk binary (default: resolve from PATH)
|
observationEnabled: true
|
||||||
defaultTimeoutMs: 120000
|
thumbnailIntervalMs: 1500
|
||||||
maxSessions: 5
|
idleIntervalMs: 8000
|
||||||
# observationEnabled: true # live PiP/overlay observation (below)
|
lazyTools: true
|
||||||
# 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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- **`lazyTools` (default `true`)** — the final progressive-disclosure stage: the six
|
Change `bskPath` to the full path of your CLI binary if it is not on dsh's `PATH`.
|
||||||
`browser_*` tool schemas stay OUT of the system prompt (zero schema tokens) until the
|
A patch replaces the entry's entire `config` object, so keep all overrides you need
|
||||||
`browser-skill` skill is actually invoked — the skill catalog entry is the only
|
together in that object.
|
||||||
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.
|
|
||||||
|
|
||||||
## Observation overlay (PiP mini-window)
|
Configuration changes follow `dsh.profile.patchReload` in the profile's
|
||||||
|
`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.
|
||||||
|
|
||||||
When the plugin runs inside the dsh Web UI, an **observation overlay** floats over the app
|
All fields are optional; omitted fields use the defaults below:
|
||||||
(registered into the `shell.overlay` seat): a breathing thumbnail per owned session plus its
|
|
||||||
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.
|
|
||||||
|
|
||||||
- **Lifecycle**: hidden while the plugin owns no sessions; appears on the first
|
| Option | Default | Purpose |
|
||||||
`browser_session` start action; disappears when all sessions stop (or the plugin unloads).
|
| --- | --- | --- |
|
||||||
- **Focus view**: status row (green/idle/red dot + session + action + mm:ss), the latest page
|
| `bskPath` | `bsk` | Path to the CLI binary. |
|
||||||
frame (refreshes every ~1.5s while active, ~8s when idle; the last good frame stays on
|
| `defaultTimeoutMs` | `120000` | Default command timeout in milliseconds. |
|
||||||
stage while the next one loads, and is kept on errors so the card does not flash),
|
| `maxSessions` | `5` | Maximum concurrent sessions started by this plugin. |
|
||||||
and a compact icon toolbar (Interrupt + Pop out, hover for the label).
|
| `observationEnabled` | `true` | Enable live browser observation. |
|
||||||
- **Interrupt**: one click kills the in-flight bsk command of the focus session (same semantics
|
| `thumbnailIntervalMs` | `1500` | Screenshot interval for active sessions, in milliseconds. |
|
||||||
as the chat Stop button — the current action fails, the agent run may continue). Strip items
|
| `idleIntervalMs` | `8000` | Screenshot interval for idle sessions and the recent-activity window, in milliseconds. |
|
||||||
carry their own hover interrupt button.
|
| `lazyTools` | `true` | Reveal the browser tools when the skill is invoked. Set `false` to register them at startup. |
|
||||||
- **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.
|
|
||||||
- **Wire**: the host serves `GET /bsk-observation/state`, `GET /bsk-observation/events` (SSE),
|
|
||||||
`POST /bsk-observation/interrupt`, and `GET /bsk-observation/thumbnail/<attachmentId>` over
|
|
||||||
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.
|
|
||||||
- **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`.
|
|
||||||
|
|
||||||
## Behavior notes
|
With `lazyTools: true`, only the skill's catalog entry is initially advertised to
|
||||||
|
the model. The six `browser_*` tool schemas are added to the system prompt after
|
||||||
|
the `browser-skill` skill is successfully invoked, either by the model or through
|
||||||
|
`/browser-skill`. Set `lazyTools: false` to make the tools available immediately.
|
||||||
|
|
||||||
- **Cancellation**: aborting a tool call (`exec.signal`) kills the underlying bsk child process,
|
## Live browser view
|
||||||
matching BrowserSkill's cooperative tool-cancellation model.
|
|
||||||
- **UI cards**: calls render as terminal cards (command line as title, output as the completed
|
The dsh Web UI shows the plugin's browser sessions in a floating panel. If your
|
||||||
card). Screenshots additionally attach the image itself when the host mounts an attachment store
|
profile provides the `dsh-better-sidebar` integration, the view appears in a
|
||||||
and the active model route declares image input; otherwise the PNG path is returned.
|
**Browser Skill** sidebar tab instead.
|
||||||
- **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
|
- See the current action, elapsed time, and recent screenshot for each session.
|
||||||
custom view keeps a terminal block for every inspect action and, when a screenshot result carries
|
- Select a session to focus on it. The sidebar view follows the current conversation.
|
||||||
an image block, resolves the durable attachment through the client session's authorized
|
- Use **Interrupt** to cancel the current browser command. The agent may continue
|
||||||
`readAttachment` RPC and renders it with the shared `MessageImage` thumbnail/lightbox atoms.
|
with another action afterward.
|
||||||
The other five tools keep the stock terminal card. The bundle follows the dsh client
|
- Drag or resize the floating panel, or use **Pop out** to open a Picture-in-Picture
|
||||||
contract: a CJS closure factory handed to `window.__ModuleLoader__.load`, platform modules
|
window in browsers that support it.
|
||||||
(`react`, `dsh-client-ui-*`) external, everything else inlined, CSS Modules compiled by
|
- Periodic screenshots are requested while a browser observation view is visible.
|
||||||
lightningcss.
|
Configure the active and idle intervals with the options above.
|
||||||
- **Errors**: non-zero bsk exits surface the CLI's JSON error envelope (`code`, `message`, `hint`)
|
|
||||||
so the model gets the daemon's actionable guidance.
|
The observation endpoints require a loopback address such as `localhost` or
|
||||||
- **Long-running work** (e.g. `bsk record`) is not backgrounded via `ctx.jobs` yet — tracked as a
|
`127.0.0.1`. Access through a LAN hostname or non-loopback reverse proxy is not supported.
|
||||||
follow-up.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -174,22 +154,47 @@ 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 GitHub Actions workflow **Release dsh plugin** publishes this package to npm
|
The [Release dsh plugin workflow](https://github.com/Tencent/BrowserSkill/blob/main/.github/workflows/release-dsh-plugin.yml)
|
||||||
as `@wxg-prc-cpg/browser-skill-dsh-plugin`. The Cordis plugin id, client
|
publishes the package and this README to npm. Pushing a `dsh-plugin-vX.Y.Z` tag
|
||||||
bundle registration, and `cordis.patch.yml` name are the same specifier so
|
triggers it; ordinary commits to `main` do not.
|
||||||
dsh can import and materialize the plugin without a ModuleLoader id mismatch.
|
|
||||||
|
|
||||||
Trigger it by pushing a tag that matches `package.json`'s `version`:
|
1. Commit this README and any other changes intended for the release.
|
||||||
|
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
|
||||||
git tag dsh-plugin-v0.1.2
|
node scripts/release.mjs <version>
|
||||||
git push origin dsh-plugin-v0.1.2
|
```
|
||||||
```
|
|
||||||
|
|
||||||
Or run the workflow from the Actions tab (`workflow_dispatch`). The job reads the
|
3. Push the version commit to the release branch, then push the DSH plugin tag
|
||||||
`NPM_TOKEN` secret from the `npm-publish` GitHub Environment.
|
created by the script, using the same `<version>`:
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
# 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.0",
|
"version": "0.2.1",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
@@ -47,7 +47,6 @@
|
|||||||
"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"
|
||||||
],
|
],
|
||||||
@@ -69,7 +68,6 @@
|
|||||||
"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",
|
||||||
@@ -82,9 +80,6 @@
|
|||||||
"@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
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -97,6 +97,10 @@ Continue from returned sequence cursors instead of rereading the same buffer.
|
|||||||
- Unknown tab: list tabs instead of guessing.
|
- Unknown tab: list tabs instead of guessing.
|
||||||
- Unknown session: list owned sessions or start one; never try foreign ids.
|
- Unknown session: list owned sessions or start one; never try foreign ids.
|
||||||
- Timeout: inspect current state before deciding whether one longer purposeful wait is useful.
|
- Timeout: inspect current state before deciding whether one longer purposeful wait is useful.
|
||||||
|
- Fill result unconfirmed: observe the field first; the page may have formatted the value. Continue
|
||||||
|
if the visible result satisfies the user's intent. Otherwise correct the remaining difference;
|
||||||
|
do not blindly repeat fill or immediately request human help. For other fill errors, follow the
|
||||||
|
returned hint and inspect current state before retrying.
|
||||||
- Unrecoverable failure: report the blocker and stop the owned session.
|
- Unrecoverable failure: report the blocker and stop the owned session.
|
||||||
|
|
||||||
Arbitrary page-script evaluation and interaction recording are intentionally unsupported. Do not
|
Arbitrary page-script evaluation and interaction recording are intentionally unsupported. Do not
|
||||||
|
|||||||
@@ -142,6 +142,8 @@
|
|||||||
right: 6px;
|
right: 6px;
|
||||||
width: 16px;
|
width: 16px;
|
||||||
height: 16px;
|
height: 16px;
|
||||||
|
padding: 0;
|
||||||
|
cursor: pointer;
|
||||||
border-radius: 50%;
|
border-radius: 50%;
|
||||||
display: inline-flex;
|
display: inline-flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
|||||||
@@ -48,7 +48,13 @@ import { createPortal } from "react-dom";
|
|||||||
import type { SessionObservation } from "../observation";
|
import type { SessionObservation } from "../observation";
|
||||||
import css from "./ObservationOverlay.module.css";
|
import css from "./ObservationOverlay.module.css";
|
||||||
import type { ObservationClientStore } from "./observation-store";
|
import type { ObservationClientStore } from "./observation-store";
|
||||||
import { focusOf, statusOf, useObservationView, usePip } from "./observation-view";
|
import {
|
||||||
|
focusOf,
|
||||||
|
statusOf,
|
||||||
|
useObservationView,
|
||||||
|
usePip,
|
||||||
|
useThumbnailObservation,
|
||||||
|
} from "./observation-view";
|
||||||
import { getSidebarMode, subscribeSidebarMode } from "./sidebar-mode";
|
import { getSidebarMode, subscribeSidebarMode } from "./sidebar-mode";
|
||||||
|
|
||||||
// The pure view helpers live in observation-view (shared with the sidebar
|
// The pure view helpers live in observation-view (shared with the sidebar
|
||||||
@@ -341,6 +347,7 @@ export function OverlayBody(props: {
|
|||||||
onHeaderPointerDown,
|
onHeaderPointerDown,
|
||||||
} = props;
|
} = props;
|
||||||
const [interrupting, setInterrupting] = useState(false);
|
const [interrupting, setInterrupting] = useState(false);
|
||||||
|
const viewRef = useThumbnailObservation(store, sessions.length > 0);
|
||||||
|
|
||||||
const thumbId = focus?.thumbnailAttachmentId;
|
const thumbId = focus?.thumbnailAttachmentId;
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -373,7 +380,12 @@ export function OverlayBody(props: {
|
|||||||
const state = !available ? "error" : focus !== undefined ? statusOf(focus) : "idle";
|
const state = !available ? "error" : focus !== undefined ? statusOf(focus) : "idle";
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={cn(css.body, "bsk-obs")} data-state={state} data-in-pip={inPip || undefined}>
|
<div
|
||||||
|
ref={viewRef}
|
||||||
|
className={cn(css.body, "bsk-obs")}
|
||||||
|
data-state={state}
|
||||||
|
data-in-pip={inPip || undefined}
|
||||||
|
>
|
||||||
<div
|
<div
|
||||||
className={css.header}
|
className={css.header}
|
||||||
data-testid="obs-header"
|
data-testid="obs-header"
|
||||||
@@ -421,9 +433,15 @@ export function OverlayBody(props: {
|
|||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
{thumb?.status === "error" ? (
|
{thumb?.status === "error" ? (
|
||||||
<span className={css.badge} aria-label="thumbnail failed">
|
<button
|
||||||
|
type="button"
|
||||||
|
className={css.badge}
|
||||||
|
aria-label="Retry thumbnail"
|
||||||
|
title="Frame unavailable — retry"
|
||||||
|
onClick={() => store.retryThumbnail(thumbId)}
|
||||||
|
>
|
||||||
<IconWarn size={12} />
|
<IconWarn size={12} />
|
||||||
</span>
|
</button>
|
||||||
) : null}
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
{sessions.length >= 2 ? (
|
{sessions.length >= 2 ? (
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
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";
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
/**
|
/**
|
||||||
* Client-side data layer for the observation overlay: initial state fetch,
|
* Client-side data layer for the observation overlay: an ordered SSE snapshot
|
||||||
* SSE increment stream (with a state refetch on every (re)open — events that
|
* and increment stream (each reconnect starts with a fresh snapshot), on-demand
|
||||||
* fired while the stream was down are otherwise lost forever), on-demand
|
* thumbnail blob loading through the host's ephemeral-frame route,
|
||||||
* thumbnail blob loading through the session-authorized readAttachment path,
|
|
||||||
* and the interrupt call. The last ready blob per session is held until its
|
* and the interrupt call. The last ready blob per session is held until its
|
||||||
* replacement decodes so the overlay can swap frames in place. All I/O is
|
* replacement loads so the overlay can swap frames in place. All I/O is
|
||||||
* injected so tests never touch a network.
|
* injected so tests never touch a network.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -12,8 +11,6 @@ import type { ObservationEvent, SessionObservation } from "../observation";
|
|||||||
|
|
||||||
export interface EventSourceLike {
|
export interface EventSourceLike {
|
||||||
onmessage: ((event: { data: string }) => void) | null;
|
onmessage: ((event: { data: string }) => void) | null;
|
||||||
/** Fires on the initial connect AND on every automatic reconnect. */
|
|
||||||
onopen?: (() => void) | null;
|
|
||||||
close(): void;
|
close(): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -50,10 +47,10 @@ export interface OverlaySnapshot {
|
|||||||
readonly available: boolean;
|
readonly available: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
const STATE_URL = "/bsk-observation/state";
|
|
||||||
const EVENTS_URL = "/bsk-observation/events";
|
const EVENTS_URL = "/bsk-observation/events";
|
||||||
const INTERRUPT_URL = "/bsk-observation/interrupt";
|
const INTERRUPT_URL = "/bsk-observation/interrupt";
|
||||||
const STOP_URL = "/bsk-observation/stop";
|
const STOP_URL = "/bsk-observation/stop";
|
||||||
|
const THUMBNAIL_RETRY_DELAYS_MS = [1000, 3000];
|
||||||
|
|
||||||
function revoke(url: string | undefined): void {
|
function revoke(url: string | undefined): void {
|
||||||
if (url !== undefined && typeof URL.revokeObjectURL === "function") {
|
if (url !== undefined && typeof URL.revokeObjectURL === "function") {
|
||||||
@@ -66,8 +63,10 @@ export class ObservationClientStore {
|
|||||||
private thumbs = new Map<string, ThumbnailState>();
|
private thumbs = new Map<string, ThumbnailState>();
|
||||||
/** sessionId → the attachment id currently advertised for it. */
|
/** sessionId → the attachment id currently advertised for it. */
|
||||||
private readonly thumbBySession = new Map<string, string>();
|
private readonly thumbBySession = new Map<string, string>();
|
||||||
/** sessionId → last successfully decoded frame (held across the next load). */
|
/** sessionId → last successfully loaded frame (held across the next load). */
|
||||||
private readonly lastReady = new Map<string, { attachmentId: string; url: string }>();
|
private readonly lastReady = new Map<string, { attachmentId: string; url: string }>();
|
||||||
|
private readonly retryTimers = new Map<string, ReturnType<typeof setTimeout>>();
|
||||||
|
private readonly retryCounts = new Map<string, number>();
|
||||||
private listeners = new Set<() => void>();
|
private listeners = new Set<() => void>();
|
||||||
private events: EventSourceLike | undefined;
|
private events: EventSourceLike | undefined;
|
||||||
private snapshot: OverlaySnapshot = {
|
private snapshot: OverlaySnapshot = {
|
||||||
@@ -81,6 +80,7 @@ export class ObservationClientStore {
|
|||||||
private started = false;
|
private started = false;
|
||||||
/** Refcount of mounted consumers (overlay card, sidebar tab, sidebar fiber). */
|
/** Refcount of mounted consumers (overlay card, sidebar tab, sidebar fiber). */
|
||||||
private consumers = 0;
|
private consumers = 0;
|
||||||
|
private thumbnailConsumers = 0;
|
||||||
|
|
||||||
constructor(private readonly deps: ObservationClientDeps) {}
|
constructor(private readonly deps: ObservationClientDeps) {}
|
||||||
|
|
||||||
@@ -133,37 +133,16 @@ export class ObservationClientStore {
|
|||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** (Re)pull the full state: initial load and every SSE (re)open. */
|
private connectEvents(): void {
|
||||||
private refreshState(): void {
|
const previous = this.events;
|
||||||
void this.deps
|
this.events = undefined;
|
||||||
.fetchFn(STATE_URL)
|
previous?.close();
|
||||||
.then(async (res) => {
|
const events = this.deps.eventSourceFactory(
|
||||||
if (!res.ok) return;
|
`${EVENTS_URL}?thumbnails=${this.thumbnailConsumers > 0 ? "1" : "0"}`,
|
||||||
const body = (await res.json()) as {
|
);
|
||||||
sessions?: SessionObservation[];
|
this.events = events;
|
||||||
available?: boolean;
|
|
||||||
};
|
|
||||||
const sessions = body.sessions ?? [];
|
|
||||||
this.sessions = new Map(sessions.map((s) => [s.sessionId, s]));
|
|
||||||
// Prune thumbnails of sessions that vanished while we were away.
|
|
||||||
const alive = new Set(sessions.map((s) => s.sessionId));
|
|
||||||
for (const sessionId of [...this.thumbBySession.keys()]) {
|
|
||||||
if (!alive.has(sessionId)) this.dropThumb(sessionId);
|
|
||||||
}
|
|
||||||
for (const s of sessions) this.trackThumb(s.sessionId, s.thumbnailAttachmentId);
|
|
||||||
if (typeof body.available === "boolean") this.available = body.available;
|
|
||||||
this.publish();
|
|
||||||
})
|
|
||||||
.catch(() => {});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Initial fetch + SSE subscription. Idempotent. */
|
|
||||||
start(): void {
|
|
||||||
if (this.started) return;
|
|
||||||
this.started = true;
|
|
||||||
this.refreshState();
|
|
||||||
const events = this.deps.eventSourceFactory(EVENTS_URL);
|
|
||||||
events.onmessage = (message) => {
|
events.onmessage = (message) => {
|
||||||
|
if (!this.started || this.events !== events) return;
|
||||||
let event: ObservationEvent;
|
let event: ObservationEvent;
|
||||||
try {
|
try {
|
||||||
event = JSON.parse(message.data) as ObservationEvent;
|
event = JSON.parse(message.data) as ObservationEvent;
|
||||||
@@ -172,23 +151,24 @@ export class ObservationClientStore {
|
|||||||
}
|
}
|
||||||
this.apply(event);
|
this.apply(event);
|
||||||
};
|
};
|
||||||
events.onopen = () => {
|
}
|
||||||
// Reconnects lose every event fired during the outage — resync.
|
|
||||||
if (this.events === events) this.refreshState();
|
/** Every initial connection and reconnect starts with the server's snapshot. */
|
||||||
};
|
start(): void {
|
||||||
this.events = events;
|
if (this.started) return;
|
||||||
|
this.started = true;
|
||||||
|
this.connectEvents();
|
||||||
this.publish();
|
this.publish();
|
||||||
}
|
}
|
||||||
|
|
||||||
stop(): void {
|
stop(): void {
|
||||||
this.events?.close();
|
const previous = this.events;
|
||||||
this.events = undefined;
|
this.events = undefined;
|
||||||
this.started = false;
|
this.started = false;
|
||||||
for (const thumb of this.thumbs.values()) revoke(thumb.url);
|
previous?.close();
|
||||||
this.thumbs.clear();
|
this.clearThumbnails();
|
||||||
this.thumbBySession.clear();
|
|
||||||
this.lastReady.clear();
|
|
||||||
this.sessions.clear();
|
this.sessions.clear();
|
||||||
|
this.available = true;
|
||||||
this.publish();
|
this.publish();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,6 +189,33 @@ export class ObservationClientStore {
|
|||||||
if (this.consumers === 0) this.stop();
|
if (this.consumers === 0) this.stop();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Only visible image surfaces request screenshots; metadata watchers do not. */
|
||||||
|
watchThumbnails(): () => void {
|
||||||
|
this.thumbnailConsumers += 1;
|
||||||
|
if (this.thumbnailConsumers === 1 && this.started) this.connectEvents();
|
||||||
|
let released = false;
|
||||||
|
return () => {
|
||||||
|
if (released) return;
|
||||||
|
released = true;
|
||||||
|
this.thumbnailConsumers -= 1;
|
||||||
|
if (this.thumbnailConsumers === 0 && this.started) this.connectEvents();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private forgetThumbnail(attachmentId: string): void {
|
||||||
|
clearTimeout(this.retryTimers.get(attachmentId));
|
||||||
|
this.retryTimers.delete(attachmentId);
|
||||||
|
this.retryCounts.delete(attachmentId);
|
||||||
|
revoke(this.thumbs.get(attachmentId)?.url);
|
||||||
|
this.thumbs.delete(attachmentId);
|
||||||
|
}
|
||||||
|
|
||||||
|
private clearThumbnails(): void {
|
||||||
|
for (const attachmentId of this.thumbs.keys()) this.forgetThumbnail(attachmentId);
|
||||||
|
this.thumbBySession.clear();
|
||||||
|
this.lastReady.clear();
|
||||||
|
}
|
||||||
|
|
||||||
/** Forget one session's tracked + held frames, revoking their blob URLs. */
|
/** Forget one session's tracked + held frames, revoking their blob URLs. */
|
||||||
private dropThumb(sessionId: string): void {
|
private dropThumb(sessionId: string): void {
|
||||||
const attachmentId = this.thumbBySession.get(sessionId);
|
const attachmentId = this.thumbBySession.get(sessionId);
|
||||||
@@ -216,39 +223,45 @@ export class ObservationClientStore {
|
|||||||
this.thumbBySession.delete(sessionId);
|
this.thumbBySession.delete(sessionId);
|
||||||
this.lastReady.delete(sessionId);
|
this.lastReady.delete(sessionId);
|
||||||
if (attachmentId !== undefined) {
|
if (attachmentId !== undefined) {
|
||||||
revoke(this.thumbs.get(attachmentId)?.url);
|
this.forgetThumbnail(attachmentId);
|
||||||
this.thumbs.delete(attachmentId);
|
|
||||||
}
|
}
|
||||||
if (held !== undefined && held.attachmentId !== attachmentId) {
|
if (held !== undefined && held.attachmentId !== attachmentId) {
|
||||||
revoke(held.url);
|
this.forgetThumbnail(held.attachmentId);
|
||||||
this.thumbs.delete(held.attachmentId);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Track the frame a session currently advertises. The last *ready* blob is
|
* Track the frame a session currently advertises. The last *ready* blob is
|
||||||
* kept until the replacement decodes — dropping it on the upsert is what
|
* kept until the replacement loads — dropping it on the upsert is what
|
||||||
* made the overlay flash a placeholder between breaths.
|
* made the overlay flash a placeholder between breaths.
|
||||||
*/
|
*/
|
||||||
private trackThumb(sessionId: string, attachmentId: string | undefined): void {
|
private trackThumb(sessionId: string, attachmentId: string | undefined): void {
|
||||||
|
if (attachmentId === undefined) {
|
||||||
|
this.dropThumb(sessionId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
const previous = this.thumbBySession.get(sessionId);
|
const previous = this.thumbBySession.get(sessionId);
|
||||||
if (previous === attachmentId) return;
|
if (previous === attachmentId) return;
|
||||||
if (attachmentId !== undefined) this.thumbBySession.set(sessionId, attachmentId);
|
this.thumbBySession.set(sessionId, attachmentId);
|
||||||
else this.thumbBySession.delete(sessionId);
|
|
||||||
const heldId = this.lastReady.get(sessionId)?.attachmentId;
|
const heldId = this.lastReady.get(sessionId)?.attachmentId;
|
||||||
if (previous !== undefined && previous !== heldId) {
|
if (previous !== undefined && previous !== heldId) {
|
||||||
revoke(this.thumbs.get(previous)?.url);
|
this.forgetThumbnail(previous);
|
||||||
this.thumbs.delete(previous);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private apply(event: ObservationEvent): void {
|
private apply(event: ObservationEvent): void {
|
||||||
if (event.type === "reset") {
|
if (event.type === "snapshot") {
|
||||||
|
this.sessions = new Map(event.sessions.map((session) => [session.sessionId, session]));
|
||||||
|
for (const sessionId of this.thumbBySession.keys()) {
|
||||||
|
if (!this.sessions.has(sessionId)) this.dropThumb(sessionId);
|
||||||
|
}
|
||||||
|
for (const session of event.sessions) {
|
||||||
|
this.trackThumb(session.sessionId, session.thumbnailAttachmentId);
|
||||||
|
}
|
||||||
|
this.available = event.available;
|
||||||
|
} else if (event.type === "reset") {
|
||||||
this.sessions.clear();
|
this.sessions.clear();
|
||||||
for (const thumb of this.thumbs.values()) revoke(thumb.url);
|
this.clearThumbnails();
|
||||||
this.thumbs.clear();
|
|
||||||
this.thumbBySession.clear();
|
|
||||||
this.lastReady.clear();
|
|
||||||
} else if (event.type === "remove" && event.session !== undefined) {
|
} else if (event.type === "remove" && event.session !== undefined) {
|
||||||
this.sessions.delete(event.session.sessionId);
|
this.sessions.delete(event.session.sessionId);
|
||||||
this.dropThumb(event.session.sessionId);
|
this.dropThumb(event.session.sessionId);
|
||||||
@@ -259,44 +272,77 @@ export class ObservationClientStore {
|
|||||||
this.available = event.available;
|
this.available = event.available;
|
||||||
}
|
}
|
||||||
this.publish();
|
this.publish();
|
||||||
|
if (event.type === "snapshot") {
|
||||||
|
for (const session of event.sessions) this.retryThumbnail(session.thumbnailAttachmentId);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ensure a thumbnail load is in flight for one attachment reference. New
|
* Ensure a thumbnail load is in flight for one attachment reference. New
|
||||||
* frames replace the old URL only after they decode; failures keep the last
|
* frames replace the old URL only after they load; failures keep the last
|
||||||
* good frame (the caller renders `status: 'error'` as a small badge over
|
* good frame (the caller renders `status: 'error'` as a small badge over
|
||||||
* the old image).
|
* the old image).
|
||||||
*/
|
*/
|
||||||
ensureThumbnail(attachmentId: string | undefined): void {
|
ensureThumbnail(attachmentId: string | undefined): void {
|
||||||
if (attachmentId === undefined || this.thumbs.has(attachmentId)) return;
|
if (
|
||||||
this.thumbs.set(attachmentId, { status: "loading" });
|
!this.started ||
|
||||||
|
attachmentId === undefined ||
|
||||||
|
this.sessionOf(attachmentId) === undefined ||
|
||||||
|
this.thumbs.has(attachmentId)
|
||||||
|
)
|
||||||
|
return;
|
||||||
|
const loading: ThumbnailState = { status: "loading" };
|
||||||
|
this.thumbs.set(attachmentId, loading);
|
||||||
this.publish();
|
this.publish();
|
||||||
this.deps.loadImage(attachmentId).then(
|
this.deps.loadImage(attachmentId).then(
|
||||||
(url) => {
|
(url) => {
|
||||||
if (!this.thumbs.has(attachmentId)) {
|
if (this.thumbs.get(attachmentId) !== loading) {
|
||||||
// Replaced or removed while loading: never resurrect (or leak) it.
|
// Replaced or removed while loading: never resurrect (or leak) it.
|
||||||
revoke(url);
|
revoke(url);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
this.retryCounts.delete(attachmentId);
|
||||||
this.thumbs.set(attachmentId, { status: "ready", url });
|
this.thumbs.set(attachmentId, { status: "ready", url });
|
||||||
const sessionId = this.sessionOf(attachmentId);
|
const sessionId = this.sessionOf(attachmentId);
|
||||||
if (sessionId !== undefined) {
|
if (sessionId !== undefined) {
|
||||||
const previous = this.lastReady.get(sessionId);
|
const previous = this.lastReady.get(sessionId);
|
||||||
if (previous !== undefined && previous.attachmentId !== attachmentId) {
|
if (previous !== undefined && previous.attachmentId !== attachmentId) {
|
||||||
revoke(previous.url);
|
this.forgetThumbnail(previous.attachmentId);
|
||||||
this.thumbs.delete(previous.attachmentId);
|
|
||||||
}
|
}
|
||||||
this.lastReady.set(sessionId, { attachmentId, url });
|
this.lastReady.set(sessionId, { attachmentId, url });
|
||||||
}
|
}
|
||||||
this.publish();
|
this.publish();
|
||||||
},
|
},
|
||||||
() => {
|
() => {
|
||||||
this.thumbs.set(attachmentId, { status: "error" });
|
if (this.thumbs.get(attachmentId) !== loading) return;
|
||||||
|
const failed: ThumbnailState = { status: "error" };
|
||||||
|
this.thumbs.set(attachmentId, failed);
|
||||||
|
const attempts = this.retryCounts.get(attachmentId) ?? 0;
|
||||||
|
const delay = THUMBNAIL_RETRY_DELAYS_MS[attempts];
|
||||||
|
if (delay !== undefined) {
|
||||||
|
this.retryCounts.set(attachmentId, attempts + 1);
|
||||||
|
this.retryTimers.set(
|
||||||
|
attachmentId,
|
||||||
|
setTimeout(() => {
|
||||||
|
this.retryTimers.delete(attachmentId);
|
||||||
|
if (this.thumbs.get(attachmentId) !== failed) return;
|
||||||
|
this.thumbs.delete(attachmentId);
|
||||||
|
this.ensureThumbnail(attachmentId);
|
||||||
|
}, delay),
|
||||||
|
);
|
||||||
|
}
|
||||||
this.publish();
|
this.publish();
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Explicit retry (also used on a fresh connection after an outage). */
|
||||||
|
retryThumbnail(attachmentId: string | undefined): void {
|
||||||
|
if (attachmentId === undefined || this.thumbs.get(attachmentId)?.status !== "error") return;
|
||||||
|
this.forgetThumbnail(attachmentId);
|
||||||
|
this.ensureThumbnail(attachmentId);
|
||||||
|
}
|
||||||
|
|
||||||
/** Interrupt the current or named session's in-flight call. */
|
/** Interrupt the current or named session's in-flight call. */
|
||||||
async interrupt(sessionId?: string): Promise<boolean> {
|
async interrupt(sessionId?: string): Promise<boolean> {
|
||||||
try {
|
try {
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
* without duplicating hooks.
|
* without duplicating hooks.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { useCallback, useEffect, useState, useSyncExternalStore } from "react";
|
import { useCallback, useEffect, useRef, useState, useSyncExternalStore } from "react";
|
||||||
import type { SessionObservation } from "../observation";
|
import type { SessionObservation } from "../observation";
|
||||||
import type { ObservationClientStore, OverlaySnapshot } from "./observation-store";
|
import type { ObservationClientStore, OverlaySnapshot } from "./observation-store";
|
||||||
|
|
||||||
@@ -114,6 +114,49 @@ export function useObservationView(
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** A mounted metadata watcher is not necessarily a visible screenshot viewer. */
|
||||||
|
export function useThumbnailObservation(store: ObservationClientStore, enabled: boolean) {
|
||||||
|
const ref = useRef<HTMLDivElement>(null);
|
||||||
|
useEffect(() => {
|
||||||
|
const element = ref.current;
|
||||||
|
if (!enabled || element === null) return;
|
||||||
|
// A portal uses its PiP document's visibility, independently of the main tab.
|
||||||
|
const doc = element.ownerDocument;
|
||||||
|
const Observer = doc.defaultView?.IntersectionObserver;
|
||||||
|
let active = true;
|
||||||
|
let intersecting = Observer === undefined;
|
||||||
|
let release: (() => void) | undefined;
|
||||||
|
const update = () => {
|
||||||
|
if (!active) return;
|
||||||
|
const visible = intersecting && doc.visibilityState !== "hidden";
|
||||||
|
if (visible && release === undefined) release = store.watchThumbnails();
|
||||||
|
else if (!visible && release !== undefined) {
|
||||||
|
release();
|
||||||
|
release = undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const observer =
|
||||||
|
Observer === undefined
|
||||||
|
? undefined
|
||||||
|
: new Observer((entries) => {
|
||||||
|
intersecting = entries.some(
|
||||||
|
(entry) => entry.target === element && entry.isIntersecting,
|
||||||
|
);
|
||||||
|
update();
|
||||||
|
});
|
||||||
|
observer?.observe(element);
|
||||||
|
doc.addEventListener("visibilitychange", update);
|
||||||
|
update();
|
||||||
|
return () => {
|
||||||
|
active = false;
|
||||||
|
observer?.disconnect();
|
||||||
|
doc.removeEventListener("visibilitychange", update);
|
||||||
|
release?.();
|
||||||
|
};
|
||||||
|
}, [store, enabled]);
|
||||||
|
return ref;
|
||||||
|
}
|
||||||
|
|
||||||
export interface PipHandle {
|
export interface PipHandle {
|
||||||
/** The open PiP window, or null while the content renders in its carrier. */
|
/** The open PiP window, or null while the content renders in its carrier. */
|
||||||
readonly pipWindow: Window | null;
|
readonly pipWindow: Window | null;
|
||||||
|
|||||||
@@ -5,12 +5,19 @@
|
|||||||
* the event allowlist lives in dsh-api-remotes), so the plugin serves its
|
* the event allowlist lives in dsh-api-remotes), so the plugin serves its
|
||||||
* observation channel through the documented `webServer` route seam instead:
|
* observation channel through the documented `webServer` route seam instead:
|
||||||
*
|
*
|
||||||
* GET /bsk-observation/state → { sessions, available }
|
* GET /bsk-observation/state → one-time { sessions, available } read
|
||||||
* GET /bsk-observation/events → SSE stream of ObservationEvent
|
* GET /bsk-observation/events → SSE snapshot, then ObservationEvent increments
|
||||||
|
* (on every connection, including reconnects)
|
||||||
|
* ?thumbnails=0: state only; =1: request screenshots
|
||||||
|
* Omitted parameter defaults to screenshots.
|
||||||
* POST /bsk-observation/interrupt → body {sessionId?} → {interrupted: boolean}
|
* POST /bsk-observation/interrupt → body {sessionId?} → {interrupted: boolean}
|
||||||
* POST /bsk-observation/stop → body {sessionId} → {stopped: boolean}
|
* POST /bsk-observation/stop → body {sessionId} → {stopped: boolean}
|
||||||
* GET /bsk-observation/thumbnail/<attachmentId> → image bytes
|
* GET /bsk-observation/thumbnail/<attachmentId> → image bytes
|
||||||
*
|
*
|
||||||
|
* Live clients initialize/resynchronize from the SSE snapshot; a separate
|
||||||
|
* /state read has no ordering guarantee relative to the stream and does not
|
||||||
|
* request screenshots. Closing an SSE connection releases its screenshot demand.
|
||||||
|
*
|
||||||
* Routes exist only when a webServer service is mounted (web composition);
|
* Routes exist only when a webServer service is mounted (web composition);
|
||||||
* headless deployments skip registration entirely.
|
* headless deployments skip registration entirely.
|
||||||
*/
|
*/
|
||||||
@@ -99,6 +106,7 @@ export function registerObservationRoutes(
|
|||||||
if (webServer === undefined) {
|
if (webServer === undefined) {
|
||||||
return () => {};
|
return () => {};
|
||||||
}
|
}
|
||||||
|
const streams = new Set<() => void>();
|
||||||
const disposers = [
|
const disposers = [
|
||||||
webServer.register({
|
webServer.register({
|
||||||
kind: "exact",
|
kind: "exact",
|
||||||
@@ -129,14 +137,42 @@ export function registerObservationRoutes(
|
|||||||
"cache-control": "no-cache",
|
"cache-control": "no-cache",
|
||||||
connection: "keep-alive",
|
connection: "keep-alive",
|
||||||
});
|
});
|
||||||
const unsubscribe = observation.subscribe((event) => {
|
const thumbnails =
|
||||||
res.write(`data: ${JSON.stringify(event)}\n\n`);
|
new URL(req.url ?? "/", "http://localhost").searchParams.get("thumbnails") !== "0";
|
||||||
});
|
let unsubscribe: (() => void) | undefined;
|
||||||
const heartbeat = setInterval(() => res.write(": heartbeat\n\n"), SSE_HEARTBEAT_MS);
|
let heartbeat: ReturnType<typeof setInterval> | undefined;
|
||||||
res.on("close", () => {
|
let closed = false;
|
||||||
|
const close = () => {
|
||||||
|
if (closed) return;
|
||||||
|
closed = true;
|
||||||
clearInterval(heartbeat);
|
clearInterval(heartbeat);
|
||||||
unsubscribe();
|
unsubscribe?.();
|
||||||
});
|
streams.delete(close);
|
||||||
|
res.end();
|
||||||
|
};
|
||||||
|
const write = (data: string) => {
|
||||||
|
if (closed) return;
|
||||||
|
try {
|
||||||
|
res.write(data);
|
||||||
|
} catch {
|
||||||
|
close();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
streams.add(close);
|
||||||
|
res.on("close", close);
|
||||||
|
res.on("error", close);
|
||||||
|
try {
|
||||||
|
unsubscribe = observation.subscribe(
|
||||||
|
(event) => {
|
||||||
|
write(`data: ${JSON.stringify(event)}\n\n`);
|
||||||
|
},
|
||||||
|
{ thumbnails },
|
||||||
|
);
|
||||||
|
if (closed) unsubscribe();
|
||||||
|
else heartbeat = setInterval(() => write(": heartbeat\n\n"), SSE_HEARTBEAT_MS);
|
||||||
|
} catch {
|
||||||
|
close();
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
webServer.register({
|
webServer.register({
|
||||||
@@ -228,6 +264,7 @@ export function registerObservationRoutes(
|
|||||||
}),
|
}),
|
||||||
];
|
];
|
||||||
return () => {
|
return () => {
|
||||||
|
for (const close of streams) close();
|
||||||
for (const dispose of disposers) dispose();
|
for (const dispose of disposers) dispose();
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,8 +49,9 @@ export interface SessionObservation {
|
|||||||
dshSessionIds?: string[];
|
dshSessionIds?: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Incremental event carried to subscribers (SSE on the wire). */
|
/** Initial snapshot or incremental change carried to subscribers (SSE on the wire). */
|
||||||
export type ObservationEvent =
|
export type ObservationEvent =
|
||||||
|
| { type: "snapshot"; sessions: SessionObservation[]; available: boolean }
|
||||||
| { type: "upsert" | "remove" | "reset"; session?: SessionObservation }
|
| { type: "upsert" | "remove" | "reset"; session?: SessionObservation }
|
||||||
| { type: "availability"; available: boolean };
|
| { type: "availability"; available: boolean };
|
||||||
|
|
||||||
@@ -89,6 +90,7 @@ export class ObservationService {
|
|||||||
private readonly scratchNamespace = randomUUID();
|
private readonly scratchNamespace = randomUUID();
|
||||||
private readonly observations = new Map<string, SessionObservation>();
|
private readonly observations = new Map<string, SessionObservation>();
|
||||||
private readonly listeners = new Set<(event: ObservationEvent) => void>();
|
private readonly listeners = new Set<(event: ObservationEvent) => void>();
|
||||||
|
private thumbnailViewers = 0;
|
||||||
private readonly captureTimers = new Map<string, unknown>();
|
private readonly captureTimers = new Map<string, unknown>();
|
||||||
private readonly captureInFlight = new Set<string>();
|
private readonly captureInFlight = new Set<string>();
|
||||||
/** Captures intentionally cancelled to make way for foreground work. */
|
/** Captures intentionally cancelled to make way for foreground work. */
|
||||||
@@ -125,7 +127,7 @@ export class ObservationService {
|
|||||||
return this.deps.scheduler ?? DEFAULT_SCHEDULER;
|
return this.deps.scheduler ?? DEFAULT_SCHEDULER;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** All current entries (client initial/resync snapshot). */
|
/** One-time state read; use subscribe for an ordered snapshot and subsequent changes. */
|
||||||
getState(): SessionObservation[] {
|
getState(): SessionObservation[] {
|
||||||
return [...this.observations.values()].map((entry) => ({ ...entry }));
|
return [...this.observations.values()].map((entry) => ({ ...entry }));
|
||||||
}
|
}
|
||||||
@@ -141,10 +143,42 @@ export class ObservationService {
|
|||||||
this.emit({ type: "availability", available });
|
this.emit({ type: "availability", available });
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Subscribe to incremental changes; returns an unsubscribe function. */
|
/**
|
||||||
subscribe(listener: (event: ObservationEvent) => void): () => void {
|
* Subscribe to an ordered initial snapshot and subsequent changes. On an
|
||||||
this.listeners.add(listener);
|
* active service, listener receives the snapshot synchronously before this
|
||||||
return () => this.listeners.delete(listener);
|
* method returns. Subscribing after disposal is a no-op.
|
||||||
|
*
|
||||||
|
* `thumbnails` defaults to true for compatibility: this subscription counts
|
||||||
|
* as a screenshot viewer for the service's owned sessions. Pass false for
|
||||||
|
* state-only observation. The first viewer starts capture scheduling.
|
||||||
|
*
|
||||||
|
* @returns An idempotent unsubscribe function releasing this subscription's
|
||||||
|
* screenshot demand. When the last viewer leaves, scheduled/queued captures
|
||||||
|
* are cancelled/skipped; an already running capture may finish.
|
||||||
|
*/
|
||||||
|
subscribe(
|
||||||
|
listener: (event: ObservationEvent) => void,
|
||||||
|
{ thumbnails = true }: { thumbnails?: boolean } = {},
|
||||||
|
): () => void {
|
||||||
|
if (this.disposed) return () => {};
|
||||||
|
// Each subscription owns its lease, even if a caller reuses a callback.
|
||||||
|
const receive = (event: ObservationEvent) => listener(event);
|
||||||
|
this.listeners.add(receive);
|
||||||
|
try {
|
||||||
|
listener({ type: "snapshot", sessions: this.getState(), available: this.available });
|
||||||
|
} catch (error) {
|
||||||
|
this.listeners.delete(receive);
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
if (thumbnails && ++this.thumbnailViewers === 1) {
|
||||||
|
for (const sessionId of this.observations.keys()) this.scheduleCapture(sessionId, 0);
|
||||||
|
}
|
||||||
|
return () => {
|
||||||
|
if (!this.listeners.delete(receive)) return;
|
||||||
|
if (thumbnails && --this.thumbnailViewers === 0) {
|
||||||
|
for (const sessionId of this.captureTimers.keys()) this.cancelCapture(sessionId);
|
||||||
|
}
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
private emit(event: ObservationEvent): void {
|
private emit(event: ObservationEvent): void {
|
||||||
@@ -355,6 +389,7 @@ export class ObservationService {
|
|||||||
this.observations.clear();
|
this.observations.clear();
|
||||||
this.emit({ type: "reset" });
|
this.emit({ type: "reset" });
|
||||||
this.listeners.clear();
|
this.listeners.clear();
|
||||||
|
this.thumbnailViewers = 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
// ------------------------------------------------------------------
|
// ------------------------------------------------------------------
|
||||||
@@ -369,12 +404,21 @@ export class ObservationService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private canCapture(sessionId: string): boolean {
|
||||||
|
const entry = this.observations.get(sessionId);
|
||||||
|
return (
|
||||||
|
this.deps.options.enabled &&
|
||||||
|
!this.disposed &&
|
||||||
|
this.thumbnailViewers > 0 &&
|
||||||
|
!this.foregroundDepth.has(sessionId) &&
|
||||||
|
entry !== undefined &&
|
||||||
|
entry.dead !== true
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/** Schedule the next capture for a session; `delayMs` 0 means "as soon as the event loop allows". */
|
/** Schedule the next capture for a session; `delayMs` 0 means "as soon as the event loop allows". */
|
||||||
private scheduleCapture(sessionId: string, delayMs?: number): void {
|
private scheduleCapture(sessionId: string, delayMs?: number): void {
|
||||||
if (!this.deps.options.enabled || this.disposed) return;
|
if (!this.canCapture(sessionId)) return;
|
||||||
if (this.foregroundDepth.has(sessionId)) return;
|
|
||||||
const entry = this.observations.get(sessionId);
|
|
||||||
if (entry === undefined || entry.dead === true) return;
|
|
||||||
this.cancelCapture(sessionId);
|
this.cancelCapture(sessionId);
|
||||||
const now = this.scheduler.now();
|
const now = this.scheduler.now();
|
||||||
const lastSeen = this.lastActivity.get(sessionId) ?? 0;
|
const lastSeen = this.lastActivity.get(sessionId) ?? 0;
|
||||||
@@ -399,9 +443,7 @@ export class ObservationService {
|
|||||||
* Failures keep the previous frame and back off silently.
|
* Failures keep the previous frame and back off silently.
|
||||||
*/
|
*/
|
||||||
private async capture(sessionId: string): Promise<void> {
|
private async capture(sessionId: string): Promise<void> {
|
||||||
if (this.disposed) return;
|
if (!this.canCapture(sessionId)) return;
|
||||||
const current = this.observations.get(sessionId);
|
|
||||||
if (current === undefined || current.dead === true) return;
|
|
||||||
if (this.captureInFlight.has(sessionId)) return;
|
if (this.captureInFlight.has(sessionId)) return;
|
||||||
this.captureInFlight.add(sessionId);
|
this.captureInFlight.add(sessionId);
|
||||||
// Stable within this service, isolated from captures owned by other instances.
|
// Stable within this service, isolated from captures owned by other instances.
|
||||||
@@ -410,8 +452,8 @@ export class ObservationService {
|
|||||||
let writtenPath = outPath;
|
let writtenPath = outPath;
|
||||||
try {
|
try {
|
||||||
const result = await this.deps.queue.run(sessionId, () => {
|
const result = await this.deps.queue.run(sessionId, () => {
|
||||||
// A foreground lease may have arrived while this capture was queued.
|
// The last viewer may have left, or foreground work arrived, while queued.
|
||||||
if (this.foregroundDepth.has(sessionId)) return Promise.resolve(undefined);
|
if (!this.canCapture(sessionId)) return Promise.resolve(undefined);
|
||||||
return this.deps.runner.run(["screenshot", "--session", sessionId, "--out", outPath], {
|
return this.deps.runner.run(["screenshot", "--session", sessionId, "--out", outPath], {
|
||||||
timeoutMs: 15_000,
|
timeoutMs: 15_000,
|
||||||
tag: `observation:${sessionId}`,
|
tag: `observation:${sessionId}`,
|
||||||
@@ -445,6 +487,7 @@ export class ObservationService {
|
|||||||
this.setAvailable(true);
|
this.setAvailable(true);
|
||||||
this.publishFrame(sessionId, entry, data);
|
this.publishFrame(sessionId, entry, data);
|
||||||
} catch {
|
} catch {
|
||||||
|
if (this.disposed || !this.observations.has(sessionId)) return;
|
||||||
// Foreground preemption is healthy scheduling, not browser/daemon
|
// Foreground preemption is healthy scheduling, not browser/daemon
|
||||||
// unavailability; do not let normal tool traffic trip capture backoff.
|
// unavailability; do not let normal tool traffic trip capture backoff.
|
||||||
if (!this.capturePreempted.delete(sessionId)) {
|
if (!this.capturePreempted.delete(sessionId)) {
|
||||||
|
|||||||
@@ -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, spawn } from "node:child_process";
|
import { type ChildProcess, type SpawnOptionsWithoutStdio, 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,7 +53,11 @@ 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 = (command: string, args: string[]) => ChildProcess;
|
export type SpawnImpl = (
|
||||||
|
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. */
|
||||||
@@ -64,29 +68,66 @@ export interface BskRunner {
|
|||||||
killFor(tag: string): number;
|
killFor(tag: string): number;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Business RPCs translate SIGINT into the daemon's cancel(rpc_id) protocol.
|
// Business RPCs translate Ctrl-C / opt-in stdin EOF into cancel(rpc_id).
|
||||||
// Give that bounded reconciliation path time to settle before the hard kill.
|
// Allow reconciliation before hard-killing an old or unresponsive CLI.
|
||||||
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) return;
|
if (child.exitCode !== null || child.signalCode !== null || cancelling.has(child)) return;
|
||||||
child.kill("SIGINT");
|
cancelling.add(child);
|
||||||
const force = setTimeout(() => {
|
// Node kills Windows children outright for SIGINT. EOF asks the CLI to
|
||||||
if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");
|
// send its existing cancel RPC and wait for browser reconciliation.
|
||||||
}, KILL_GRACE_MS);
|
if (windows && child.stdin) child.stdin.end();
|
||||||
|
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(bskPath, [...args, "--json"]);
|
child = spawnImpl(
|
||||||
|
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;
|
||||||
|
|||||||
@@ -636,7 +636,9 @@ function defineBrowserOperations(deps: ToolDeps, register: DefinitionRegistrar):
|
|||||||
session: SESSION_PARAM,
|
session: SESSION_PARAM,
|
||||||
noClear: {
|
noClear: {
|
||||||
type: "boolean",
|
type: "boolean",
|
||||||
description: "Skip the default wipe-the-field-first pass (append instead).",
|
description:
|
||||||
|
"Append to the end of the existing value instead of clearing it. " +
|
||||||
|
"The tool moves the caret automatically; no prior click or selection is needed.",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
output: {
|
output: {
|
||||||
|
|||||||
@@ -19,10 +19,12 @@ interface Harness {
|
|||||||
emitRaw: (event: unknown) => void;
|
emitRaw: (event: unknown) => void;
|
||||||
fetches: { url: string; init?: { body?: string } }[];
|
fetches: { url: string; init?: { body?: string } }[];
|
||||||
loadImage: ReturnType<typeof vi.fn>;
|
loadImage: ReturnType<typeof vi.fn>;
|
||||||
|
eventUrls: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
function makeHarness(initial: SessionObservation[]): Harness {
|
function makeHarness(initial: SessionObservation[]): Harness {
|
||||||
const fetches: Harness["fetches"] = [];
|
const fetches: Harness["fetches"] = [];
|
||||||
|
const eventUrls: string[] = [];
|
||||||
let es: EventSourceLike | undefined;
|
let es: EventSourceLike | undefined;
|
||||||
let current = initial;
|
let current = initial;
|
||||||
const loadImage = vi.fn(async (id: string) => `blob:${id}`);
|
const loadImage = vi.fn(async (id: string) => `blob:${id}`);
|
||||||
@@ -34,9 +36,16 @@ function makeHarness(initial: SessionObservation[]): Harness {
|
|||||||
}
|
}
|
||||||
return { ok: true, json: async () => ({ interrupted: true }) };
|
return { ok: true, json: async () => ({ interrupted: true }) };
|
||||||
},
|
},
|
||||||
eventSourceFactory: () => {
|
eventSourceFactory: (url) => {
|
||||||
es = { onmessage: null, close: vi.fn() };
|
eventUrls.push(url);
|
||||||
return es;
|
const connection = { onmessage: null, close: vi.fn() } as EventSourceLike;
|
||||||
|
es = connection;
|
||||||
|
queueMicrotask(() =>
|
||||||
|
connection.onmessage?.({
|
||||||
|
data: JSON.stringify({ type: "snapshot", sessions: current, available: true }),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
return connection;
|
||||||
},
|
},
|
||||||
loadImage,
|
loadImage,
|
||||||
});
|
});
|
||||||
@@ -58,10 +67,120 @@ function makeHarness(initial: SessionObservation[]): Harness {
|
|||||||
},
|
},
|
||||||
fetches,
|
fetches,
|
||||||
loadImage,
|
loadImage,
|
||||||
|
eventUrls,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
afterEach(cleanup);
|
afterEach(() => {
|
||||||
|
cleanup();
|
||||||
|
vi.restoreAllMocks();
|
||||||
|
vi.unstubAllGlobals();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("visible thumbnail demand", () => {
|
||||||
|
function intersections() {
|
||||||
|
const observers: Array<{
|
||||||
|
notify: (visible: boolean) => void;
|
||||||
|
disconnect: ReturnType<typeof vi.fn>;
|
||||||
|
}> = [];
|
||||||
|
vi.stubGlobal(
|
||||||
|
"IntersectionObserver",
|
||||||
|
class {
|
||||||
|
private target?: Element;
|
||||||
|
disconnect = vi.fn();
|
||||||
|
constructor(private callback: IntersectionObserverCallback) {
|
||||||
|
observers.push(this);
|
||||||
|
}
|
||||||
|
observe(target: Element) {
|
||||||
|
this.target = target;
|
||||||
|
}
|
||||||
|
notify(visible: boolean) {
|
||||||
|
this.callback(
|
||||||
|
[{ target: this.target, isIntersecting: visible } as IntersectionObserverEntry],
|
||||||
|
this as unknown as IntersectionObserver,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
return observers;
|
||||||
|
}
|
||||||
|
|
||||||
|
it("pauses screenshots on collapse while keeping the metadata feed", async () => {
|
||||||
|
const observers = intersections();
|
||||||
|
const h = makeHarness([BUSY]);
|
||||||
|
const { unmount } = render(<ObservationOverlay store={h.store} />);
|
||||||
|
await screen.findByTestId("obs-card");
|
||||||
|
expect(h.eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=0");
|
||||||
|
act(() => observers[0].notify(true));
|
||||||
|
expect(h.eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=1");
|
||||||
|
fireEvent.click(screen.getByRole("button", { name: "Collapse" }));
|
||||||
|
expect(h.eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=0");
|
||||||
|
expect(h.es().close).not.toHaveBeenCalled();
|
||||||
|
expect(observers[0].disconnect).toHaveBeenCalledOnce();
|
||||||
|
// A callback queued before disconnect must not reclaim screenshot demand.
|
||||||
|
act(() => observers[0].notify(true));
|
||||||
|
expect(h.eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=0");
|
||||||
|
fireEvent.click(screen.getByRole("button", { name: /Expand browser observation/ }));
|
||||||
|
act(() => observers[1].notify(true));
|
||||||
|
expect(h.eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=1");
|
||||||
|
unmount();
|
||||||
|
expect(h.es().close).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("ignores an initial visibility notification delivered after collapse", async () => {
|
||||||
|
const observers = intersections();
|
||||||
|
const h = makeHarness([BUSY]);
|
||||||
|
render(<ObservationOverlay store={h.store} />);
|
||||||
|
await screen.findByTestId("obs-card");
|
||||||
|
fireEvent.click(screen.getByRole("button", { name: "Collapse" }));
|
||||||
|
act(() => observers[0].notify(true));
|
||||||
|
expect(h.eventUrls).toEqual(["/bsk-observation/events?thumbnails=0"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("pauses for a hidden document or hidden panel and resumes when visible", async () => {
|
||||||
|
const observers = intersections();
|
||||||
|
let visibility: DocumentVisibilityState = "visible";
|
||||||
|
vi.spyOn(document, "visibilityState", "get").mockImplementation(() => visibility);
|
||||||
|
const h = makeHarness([BUSY]);
|
||||||
|
render(<ObservationOverlay store={h.store} />);
|
||||||
|
await screen.findByTestId("obs-card");
|
||||||
|
act(() => observers[0].notify(true));
|
||||||
|
expect(h.eventUrls.at(-1)).toContain("thumbnails=1");
|
||||||
|
act(() => {
|
||||||
|
visibility = "hidden";
|
||||||
|
document.dispatchEvent(new Event("visibilitychange"));
|
||||||
|
});
|
||||||
|
expect(h.eventUrls.at(-1)).toContain("thumbnails=0");
|
||||||
|
act(() => {
|
||||||
|
visibility = "visible";
|
||||||
|
document.dispatchEvent(new Event("visibilitychange"));
|
||||||
|
});
|
||||||
|
expect(h.eventUrls.at(-1)).toContain("thumbnails=1");
|
||||||
|
act(() => observers[0].notify(false));
|
||||||
|
expect(h.eventUrls.at(-1)).toContain("thumbnails=0");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps a visible PiP watching when the main document is hidden", async () => {
|
||||||
|
// The detached PiP test document has no window/IntersectionObserver.
|
||||||
|
vi.stubGlobal("IntersectionObserver", undefined);
|
||||||
|
let visibility: DocumentVisibilityState = "visible";
|
||||||
|
vi.spyOn(document, "visibilityState", "get").mockImplementation(() => visibility);
|
||||||
|
const pipDoc = document.implementation.createHTMLDocument("pip");
|
||||||
|
Object.defineProperty(pipDoc, "visibilityState", { value: "visible" });
|
||||||
|
(window as unknown as Record<string, unknown>).documentPictureInPicture = {
|
||||||
|
requestWindow: async () => ({ document: pipDoc, addEventListener: () => {}, close: vi.fn() }),
|
||||||
|
};
|
||||||
|
const h = makeHarness([BUSY]);
|
||||||
|
render(<ObservationOverlay store={h.store} />);
|
||||||
|
fireEvent.click(await screen.findByRole("button", { name: /Pop out/ }));
|
||||||
|
await waitFor(() => expect(pipDoc.body.textContent).toContain("s1"));
|
||||||
|
act(() => {
|
||||||
|
visibility = "hidden";
|
||||||
|
document.dispatchEvent(new Event("visibilitychange"));
|
||||||
|
});
|
||||||
|
expect(h.eventUrls.at(-1)).toContain("thumbnails=1");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("ObservationOverlay", () => {
|
describe("ObservationOverlay", () => {
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
@@ -92,6 +211,16 @@ describe("ObservationOverlay", () => {
|
|||||||
await screen.findByRole("img", { name: "session s1 view" });
|
await screen.findByRole("img", { name: "session s1 view" });
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("offers a retry after a thumbnail fails without requiring a new frame id", async () => {
|
||||||
|
const h = makeHarness([{ ...BUSY, thumbnailAttachmentId: "att-9" }]);
|
||||||
|
h.loadImage.mockRejectedValueOnce(new Error("temporary failure"));
|
||||||
|
render(<ObservationOverlay store={h.store} />);
|
||||||
|
fireEvent.click(await screen.findByRole("button", { name: "Retry thumbnail" }));
|
||||||
|
await screen.findByRole("img", { name: "session s1 view" });
|
||||||
|
expect(h.loadImage).toHaveBeenCalledTimes(2);
|
||||||
|
expect(screen.queryByRole("button", { name: "Retry thumbnail" })).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
it("keeps the current frame on stage while the next thumbnail loads", async () => {
|
it("keeps the current frame on stage while the next thumbnail loads", async () => {
|
||||||
let resolveNext: ((url: string) => void) | undefined;
|
let resolveNext: ((url: string) => void) | undefined;
|
||||||
const h = makeHarness([{ ...BUSY, thumbnailAttachmentId: "att-1" }]);
|
const h = makeHarness([{ ...BUSY, thumbnailAttachmentId: "att-1" }]);
|
||||||
|
|||||||
@@ -53,8 +53,14 @@ function makeHarness(initial: SessionObservation[]): Harness {
|
|||||||
return { ok: true, json: async () => ({ interrupted: true }) };
|
return { ok: true, json: async () => ({ interrupted: true }) };
|
||||||
},
|
},
|
||||||
eventSourceFactory: () => {
|
eventSourceFactory: () => {
|
||||||
es = { onmessage: null, close: vi.fn() };
|
const connection = { onmessage: null, close: vi.fn() } as EventSourceLike;
|
||||||
return es;
|
es = connection;
|
||||||
|
queueMicrotask(() =>
|
||||||
|
connection.onmessage?.({
|
||||||
|
data: JSON.stringify({ type: "snapshot", sessions: current, available: true }),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
return connection;
|
||||||
},
|
},
|
||||||
loadImage: async (id: string) => `blob:${id}`,
|
loadImage: async (id: string) => `blob:${id}`,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,12 +1,19 @@
|
|||||||
// ObservationClientStore: initial fetch + SSE application, thumbnail loading
|
// ObservationClientStore: ordered SSE snapshots/increments, thumbnail loading
|
||||||
// lifecycle, interrupt wire shape. All I/O faked.
|
// lifecycle, interrupt wire shape. All I/O faked.
|
||||||
|
|
||||||
import { describe, expect, it, vi } from "vitest";
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||||
import { type EventSourceLike, ObservationClientStore } from "../../src/client/observation-store";
|
import { type EventSourceLike, ObservationClientStore } from "../../src/client/observation-store";
|
||||||
import type { ObservationEvent, SessionObservation } from "../../src/observation";
|
import type { ObservationEvent, SessionObservation } from "../../src/observation";
|
||||||
|
|
||||||
const OBS_IDLE: SessionObservation = { sessionId: "s1", action: "idle", since: 1000 };
|
const OBS_IDLE: SessionObservation = { sessionId: "s1", action: "idle", since: 1000 };
|
||||||
const OBS_BUSY: SessionObservation = { sessionId: "s1", action: "clicking", since: 2000 };
|
const OBS_BUSY: SessionObservation = { sessionId: "s1", action: "clicking", since: 2000 };
|
||||||
|
const stores: ObservationClientStore[] = [];
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
for (const store of stores.splice(0)) store.stop();
|
||||||
|
vi.restoreAllMocks();
|
||||||
|
vi.useRealTimers();
|
||||||
|
});
|
||||||
|
|
||||||
function harness(state: SessionObservation[] = []) {
|
function harness(state: SessionObservation[] = []) {
|
||||||
const fetches: {
|
const fetches: {
|
||||||
@@ -14,6 +21,7 @@ function harness(state: SessionObservation[] = []) {
|
|||||||
init?: { method?: string; body?: string; headers?: Record<string, string> };
|
init?: { method?: string; body?: string; headers?: Record<string, string> };
|
||||||
}[] = [];
|
}[] = [];
|
||||||
const esInstances: EventSourceLike[] = [];
|
const esInstances: EventSourceLike[] = [];
|
||||||
|
const eventUrls: string[] = [];
|
||||||
const fetchFn = vi.fn(
|
const fetchFn = vi.fn(
|
||||||
async (
|
async (
|
||||||
url: string,
|
url: string,
|
||||||
@@ -29,11 +37,14 @@ function harness(state: SessionObservation[] = []) {
|
|||||||
const eventSourceFactory = (url: string) => {
|
const eventSourceFactory = (url: string) => {
|
||||||
const es: EventSourceLike = { onmessage: null, close: vi.fn() };
|
const es: EventSourceLike = { onmessage: null, close: vi.fn() };
|
||||||
esInstances.push(es);
|
esInstances.push(es);
|
||||||
|
eventUrls.push(url);
|
||||||
|
queueMicrotask(() => emit(es, { type: "snapshot", sessions: state, available: true }));
|
||||||
return es;
|
return es;
|
||||||
};
|
};
|
||||||
const loadImage = vi.fn(async (id: string) => `blob:url-${id}`);
|
const loadImage = vi.fn(async (id: string) => `blob:url-${id}`);
|
||||||
const store = new ObservationClientStore({ fetchFn, eventSourceFactory, loadImage });
|
const store = new ObservationClientStore({ fetchFn, eventSourceFactory, loadImage });
|
||||||
return { store, fetches, esInstances, loadImage };
|
stores.push(store);
|
||||||
|
return { store, fetches, esInstances, eventUrls, loadImage };
|
||||||
}
|
}
|
||||||
|
|
||||||
function emit(es: EventSourceLike, event: ObservationEvent): void {
|
function emit(es: EventSourceLike, event: ObservationEvent): void {
|
||||||
@@ -73,7 +84,9 @@ describe("ObservationClientStore", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it("loads each thumbnail once and reports ready", async () => {
|
it("loads each thumbnail once and reports ready", async () => {
|
||||||
const { store, loadImage } = harness();
|
const { store, loadImage } = harness([{ ...OBS_IDLE, thumbnailAttachmentId: "att-1" }]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
store.ensureThumbnail("att-1");
|
store.ensureThumbnail("att-1");
|
||||||
store.ensureThumbnail("att-1");
|
store.ensureThumbnail("att-1");
|
||||||
expect(loadImage).toHaveBeenCalledTimes(1);
|
expect(loadImage).toHaveBeenCalledTimes(1);
|
||||||
@@ -86,7 +99,9 @@ describe("ObservationClientStore", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it("marks failed thumbnail loads as error", async () => {
|
it("marks failed thumbnail loads as error", async () => {
|
||||||
const { store, loadImage } = harness();
|
const { store, loadImage } = harness([{ ...OBS_IDLE, thumbnailAttachmentId: "att-bad" }]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
loadImage.mockRejectedValueOnce(new Error("nope"));
|
loadImage.mockRejectedValueOnce(new Error("nope"));
|
||||||
store.ensureThumbnail("att-bad");
|
store.ensureThumbnail("att-bad");
|
||||||
await vi.waitFor(() => expect(store.getSnapshot().thumbnails["att-bad"].status).toBe("error"));
|
await vi.waitFor(() => expect(store.getSnapshot().thumbnails["att-bad"].status).toBe("error"));
|
||||||
@@ -124,9 +139,7 @@ describe("ObservationClientStore", () => {
|
|||||||
|
|
||||||
describe("thumbnail blob URL lifecycle", () => {
|
describe("thumbnail blob URL lifecycle", () => {
|
||||||
function withRevokeSpy() {
|
function withRevokeSpy() {
|
||||||
const revoke = vi.fn();
|
return vi.spyOn(URL, "revokeObjectURL").mockImplementation(() => {});
|
||||||
(URL as unknown as { revokeObjectURL: unknown }).revokeObjectURL = revoke;
|
|
||||||
return revoke;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
it("holds the last ready frame until the replacement decodes", async () => {
|
it("holds the last ready frame until the replacement decodes", async () => {
|
||||||
@@ -231,16 +244,216 @@ describe("thumbnail blob URL lifecycle", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("SSE (re)open resync", () => {
|
describe("SSE snapshot ordering", () => {
|
||||||
it("refetches the full state when the stream (re)opens", async () => {
|
it("ignores events from a stopped connection after a restart", async () => {
|
||||||
|
const { store, esInstances } = harness([OBS_IDLE]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
const old = esInstances[0];
|
||||||
|
store.stop();
|
||||||
|
emit(old, { type: "upsert", session: OBS_BUSY });
|
||||||
|
expect(store.getSnapshot().sessions).toEqual([]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
emit(esInstances[1], { type: "upsert", session: OBS_BUSY });
|
||||||
|
emit(old, { type: "snapshot", sessions: [], available: false });
|
||||||
|
emit(old, { type: "remove", session: OBS_BUSY });
|
||||||
|
expect(store.getSnapshot()).toMatchObject({ sessions: [OBS_BUSY], available: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not apply a queued initial snapshot after stop", async () => {
|
||||||
|
const { store } = harness([OBS_BUSY]);
|
||||||
|
store.start();
|
||||||
|
store.stop();
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot()).toMatchObject({ sessions: [], thumbnails: {}, subscribed: false });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("replaces state on reconnect before applying subsequent events, without a competing fetch", async () => {
|
||||||
const { store, fetches, esInstances } = harness([OBS_IDLE]);
|
const { store, fetches, esInstances } = harness([OBS_IDLE]);
|
||||||
store.start();
|
store.start();
|
||||||
await vi.waitFor(() => expect(store.getSnapshot().sessions).toHaveLength(1));
|
await vi.waitFor(() => expect(store.getSnapshot().sessions).toHaveLength(1));
|
||||||
const before = fetches.filter((f) => f.url === "/bsk-observation/state").length;
|
emit(esInstances[0], { type: "snapshot", sessions: [], available: false });
|
||||||
esInstances[0].onopen?.();
|
expect(store.getSnapshot()).toMatchObject({ sessions: [], available: false });
|
||||||
await vi.waitFor(() =>
|
emit(esInstances[0], { type: "upsert", session: OBS_BUSY });
|
||||||
expect(fetches.filter((f) => f.url === "/bsk-observation/state").length).toBe(before + 1),
|
await Promise.resolve();
|
||||||
);
|
expect(store.getSnapshot().sessions).toEqual([OBS_BUSY]);
|
||||||
|
expect(fetches).toEqual([]);
|
||||||
store.stop();
|
store.stop();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("thumbnail recovery and stale loads", () => {
|
||||||
|
function deferred<T>() {
|
||||||
|
let resolve!: (value: T) => void;
|
||||||
|
let reject!: (reason: Error) => void;
|
||||||
|
const promise = new Promise<T>((yes, no) => {
|
||||||
|
resolve = yes;
|
||||||
|
reject = no;
|
||||||
|
});
|
||||||
|
return { promise, resolve, reject };
|
||||||
|
}
|
||||||
|
|
||||||
|
it("retries a transient failure without needing a different frame id", async () => {
|
||||||
|
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout"] });
|
||||||
|
const { store, loadImage } = harness([{ ...OBS_IDLE, thumbnailAttachmentId: "a1" }]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
loadImage.mockRejectedValueOnce(new Error("temporary"));
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot().thumbnails.a1.status).toBe("error");
|
||||||
|
await vi.advanceTimersByTimeAsync(1000);
|
||||||
|
expect(loadImage).toHaveBeenCalledTimes(2);
|
||||||
|
expect(store.getSnapshot().displayFrames.s1).toEqual({ status: "ready", url: "blob:url-a1" });
|
||||||
|
expect(vi.getTimerCount()).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("bounds automatic retries and allows an explicit recovery", async () => {
|
||||||
|
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout"] });
|
||||||
|
const { store, loadImage } = harness([{ ...OBS_IDLE, thumbnailAttachmentId: "a1" }]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
loadImage.mockRejectedValue(new Error("offline"));
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
await vi.advanceTimersByTimeAsync(60_000);
|
||||||
|
expect(loadImage).toHaveBeenCalledTimes(3);
|
||||||
|
expect(vi.getTimerCount()).toBe(0);
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
expect(loadImage).toHaveBeenCalledTimes(3);
|
||||||
|
loadImage.mockResolvedValue("blob:recovered");
|
||||||
|
store.retryThumbnail("a1");
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot().displayFrames.s1.url).toBe("blob:recovered");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("cancels backoff when a reconnect retries the current frame", async () => {
|
||||||
|
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout"] });
|
||||||
|
const session = { ...OBS_IDLE, thumbnailAttachmentId: "a1" };
|
||||||
|
const { store, esInstances, loadImage } = harness([session]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
loadImage.mockRejectedValueOnce(new Error("offline"));
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
await Promise.resolve();
|
||||||
|
emit(esInstances[0], { type: "snapshot", sessions: [session], available: true });
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot().thumbnails.a1.status).toBe("ready");
|
||||||
|
await vi.advanceTimersByTimeAsync(60_000);
|
||||||
|
expect(loadImage).toHaveBeenCalledTimes(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"remove",
|
||||||
|
"reset",
|
||||||
|
"stop",
|
||||||
|
"missing-thumbnail",
|
||||||
|
"snapshot-removal",
|
||||||
|
])("cleans frames and cancels retries on %s", async (action) => {
|
||||||
|
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout"] });
|
||||||
|
const revoke = vi.spyOn(URL, "revokeObjectURL").mockImplementation(() => {});
|
||||||
|
const { store, esInstances, loadImage } = harness([
|
||||||
|
{ ...OBS_IDLE, thumbnailAttachmentId: "a1" },
|
||||||
|
]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
await Promise.resolve();
|
||||||
|
emit(esInstances[0], { type: "upsert", session: { ...OBS_IDLE, thumbnailAttachmentId: "a2" } });
|
||||||
|
loadImage.mockRejectedValueOnce(new Error("no frame"));
|
||||||
|
store.ensureThumbnail("a2");
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot().displayFrames.s1).toEqual({ status: "error", url: "blob:url-a1" });
|
||||||
|
if (action === "stop") store.stop();
|
||||||
|
else if (action === "remove") emit(esInstances[0], { type: "remove", session: OBS_IDLE });
|
||||||
|
else if (action === "reset") emit(esInstances[0], { type: "reset" });
|
||||||
|
else if (action === "missing-thumbnail")
|
||||||
|
emit(esInstances[0], { type: "upsert", session: OBS_IDLE });
|
||||||
|
else emit(esInstances[0], { type: "snapshot", sessions: [], available: true });
|
||||||
|
expect(store.getSnapshot().thumbnails).toEqual({});
|
||||||
|
expect(store.getSnapshot().displayFrames).toEqual({});
|
||||||
|
expect(revoke).toHaveBeenCalledExactlyOnceWith("blob:url-a1");
|
||||||
|
expect(vi.getTimerCount()).toBe(0);
|
||||||
|
await vi.advanceTimersByTimeAsync(60_000);
|
||||||
|
expect(loadImage).toHaveBeenCalledTimes(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
"resolve",
|
||||||
|
"reject",
|
||||||
|
])("ignores a stale load's %s even when the same id is loaded again", async (outcome) => {
|
||||||
|
const revoke = vi.spyOn(URL, "revokeObjectURL").mockImplementation(() => {});
|
||||||
|
const { store, esInstances, loadImage } = harness([
|
||||||
|
{ ...OBS_IDLE, thumbnailAttachmentId: "a1" },
|
||||||
|
]);
|
||||||
|
const old = deferred<string>();
|
||||||
|
loadImage.mockReturnValueOnce(old.promise);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
emit(esInstances[0], { type: "upsert", session: { ...OBS_IDLE, thumbnailAttachmentId: "a2" } });
|
||||||
|
emit(esInstances[0], { type: "upsert", session: { ...OBS_IDLE, thumbnailAttachmentId: "a1" } });
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
await Promise.resolve();
|
||||||
|
if (outcome === "resolve") old.resolve("blob:stale");
|
||||||
|
else old.reject(new Error("stale error"));
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot().displayFrames.s1).toEqual({ status: "ready", url: "blob:url-a1" });
|
||||||
|
expect(revoke).not.toHaveBeenCalledWith("blob:url-a1");
|
||||||
|
if (outcome === "resolve") expect(revoke).toHaveBeenCalledWith("blob:stale");
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(["resolve", "reject"])("ignores an in-flight load's %s after stop", async (outcome) => {
|
||||||
|
const revoke = vi.spyOn(URL, "revokeObjectURL").mockImplementation(() => {});
|
||||||
|
const { store, loadImage } = harness([{ ...OBS_IDLE, thumbnailAttachmentId: "a1" }]);
|
||||||
|
const pending = deferred<string>();
|
||||||
|
loadImage.mockReturnValueOnce(pending.promise);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
store.ensureThumbnail("a1");
|
||||||
|
store.stop();
|
||||||
|
if (outcome === "resolve") pending.resolve("blob:late");
|
||||||
|
else pending.reject(new Error("late error"));
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(store.getSnapshot()).toMatchObject({ sessions: [], thumbnails: {}, displayFrames: {} });
|
||||||
|
if (outcome === "resolve") expect(revoke).toHaveBeenCalledWith("blob:late");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("thumbnail viewer leases", () => {
|
||||||
|
it("keeps metadata subscribed while the last screenshot viewer leaves", async () => {
|
||||||
|
const { store, eventUrls, esInstances } = harness([OBS_IDLE]);
|
||||||
|
store.acquire();
|
||||||
|
await Promise.resolve();
|
||||||
|
expect(eventUrls).toEqual(["/bsk-observation/events?thumbnails=0"]);
|
||||||
|
const first = store.watchThumbnails();
|
||||||
|
expect(eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=1");
|
||||||
|
const second = store.watchThumbnails();
|
||||||
|
expect(eventUrls).toHaveLength(2);
|
||||||
|
first();
|
||||||
|
first();
|
||||||
|
expect(eventUrls).toHaveLength(2);
|
||||||
|
second();
|
||||||
|
expect(eventUrls.at(-1)).toBe("/bsk-observation/events?thumbnails=0");
|
||||||
|
expect(store.getSnapshot().subscribed).toBe(true);
|
||||||
|
store.release();
|
||||||
|
expect(esInstances.at(-1)?.close).toHaveBeenCalledOnce();
|
||||||
|
expect(store.getSnapshot().subscribed).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("ignores delayed snapshots from a replaced stream without clearing the displayed state", async () => {
|
||||||
|
const { store, esInstances } = harness([OBS_IDLE]);
|
||||||
|
store.start();
|
||||||
|
await Promise.resolve();
|
||||||
|
emit(esInstances[0], { type: "upsert", session: OBS_BUSY });
|
||||||
|
const release = store.watchThumbnails();
|
||||||
|
expect(store.getSnapshot().sessions).toEqual([OBS_BUSY]);
|
||||||
|
await Promise.resolve();
|
||||||
|
emit(esInstances[1], { type: "upsert", session: OBS_BUSY });
|
||||||
|
emit(esInstances[0], { type: "snapshot", sessions: [], available: false });
|
||||||
|
expect(store.getSnapshot()).toMatchObject({ sessions: [OBS_BUSY], available: true });
|
||||||
|
store.stop();
|
||||||
|
release();
|
||||||
|
expect(esInstances).toHaveLength(2);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import { existsSync, mkdtempSync, writeFileSync } from "node:fs";
|
|||||||
import type { IncomingMessage, ServerResponse } from "node:http";
|
import type { IncomingMessage, ServerResponse } from "node:http";
|
||||||
import { tmpdir } from "node:os";
|
import { tmpdir } from "node:os";
|
||||||
import { basename, dirname } from "node:path";
|
import { basename, dirname } from "node:path";
|
||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it, vi } from "vitest";
|
||||||
import {
|
import {
|
||||||
actionForLabel,
|
actionForLabel,
|
||||||
type ObservationEvent,
|
type ObservationEvent,
|
||||||
@@ -138,6 +138,8 @@ function setup(opts: {
|
|||||||
runner?: FakeRunner;
|
runner?: FakeRunner;
|
||||||
registry?: SessionRegistry;
|
registry?: SessionRegistry;
|
||||||
scheduler?: ReturnType<typeof fakeScheduler>;
|
scheduler?: ReturnType<typeof fakeScheduler>;
|
||||||
|
thumbnails?: boolean;
|
||||||
|
queue?: KeyedExecutor;
|
||||||
}) {
|
}) {
|
||||||
const registry = opts.registry ?? new SessionRegistry(5);
|
const registry = opts.registry ?? new SessionRegistry(5);
|
||||||
const runner = opts.runner ?? fakeRunner();
|
const runner = opts.runner ?? fakeRunner();
|
||||||
@@ -146,13 +148,18 @@ function setup(opts: {
|
|||||||
ctx: fakeCtx(),
|
ctx: fakeCtx(),
|
||||||
runner,
|
runner,
|
||||||
registry,
|
registry,
|
||||||
queue: new KeyedExecutor(),
|
queue: opts.queue ?? new KeyedExecutor(),
|
||||||
options: OPTIONS,
|
options: OPTIONS,
|
||||||
scheduler,
|
scheduler,
|
||||||
});
|
});
|
||||||
const events: ObservationEvent[] = [];
|
const events: ObservationEvent[] = [];
|
||||||
service.subscribe((event) => events.push(event));
|
const unsubscribe = service.subscribe(
|
||||||
return { service, registry, runner, scheduler, events };
|
(event) => {
|
||||||
|
if (event.type !== "snapshot") events.push(event);
|
||||||
|
},
|
||||||
|
{ thumbnails: opts.thumbnails ?? true },
|
||||||
|
);
|
||||||
|
return { service, registry, runner, scheduler, events, unsubscribe };
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Drive the registry through a real start so the session is owned. */
|
/** Drive the registry through a real start so the session is owned. */
|
||||||
@@ -224,6 +231,111 @@ describe("state machine", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe("thumbnail cadence", () => {
|
describe("thumbnail cadence", () => {
|
||||||
|
it("keeps metadata current without screenshots and resumes when a viewer arrives", async () => {
|
||||||
|
const { service, scheduler, runner, events } = setup({ thumbnails: false });
|
||||||
|
service.addSession("s1");
|
||||||
|
service.beginAction("s1", "clicking");
|
||||||
|
service.endAction("s1");
|
||||||
|
const releaseForeground = service.acquireForeground("s1");
|
||||||
|
releaseForeground();
|
||||||
|
expect(service.getState()[0].action).toBe("idle");
|
||||||
|
expect(events).toHaveLength(3);
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
expect(runner.calls).toEqual([]);
|
||||||
|
const snapshots: ObservationEvent[] = [];
|
||||||
|
const leave = service.subscribe((event) => snapshots.push(event));
|
||||||
|
expect(snapshots[0]).toEqual({
|
||||||
|
type: "snapshot",
|
||||||
|
sessions: service.getState(),
|
||||||
|
available: true,
|
||||||
|
});
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
scheduler.runNext();
|
||||||
|
await waitFor(() => scheduler.pending().length === 1);
|
||||||
|
expect(runner.calls).toHaveLength(1);
|
||||||
|
leave();
|
||||||
|
leave();
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
service.endAction("s1");
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
const resume = service.subscribe(() => {});
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
resume();
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not capture in a headless service with no subscribers", () => {
|
||||||
|
const { service, scheduler, unsubscribe } = setup({});
|
||||||
|
unsubscribe();
|
||||||
|
service.addSession("s1");
|
||||||
|
service.endAction("s1");
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
expect(service.getState()).toHaveLength(1);
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps capturing until the last viewer leaves, including reused callbacks", () => {
|
||||||
|
const { service, scheduler } = setup({ thumbnails: false });
|
||||||
|
service.addSession("s1");
|
||||||
|
const listener = () => {};
|
||||||
|
const first = service.subscribe(listener);
|
||||||
|
const second = service.subscribe(listener);
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
first();
|
||||||
|
first();
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
second();
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("skips a queued screenshot if its last viewer leaves before execution", async () => {
|
||||||
|
const queue = new KeyedExecutor();
|
||||||
|
let unblock!: () => void;
|
||||||
|
const gate = new Promise<void>((resolve) => {
|
||||||
|
unblock = resolve;
|
||||||
|
});
|
||||||
|
const busy = queue.run("s1", () => gate);
|
||||||
|
const { service, scheduler, runner, unsubscribe } = setup({ queue });
|
||||||
|
service.addSession("s1");
|
||||||
|
scheduler.runNext();
|
||||||
|
unsubscribe();
|
||||||
|
unblock();
|
||||||
|
await busy;
|
||||||
|
await queue.run("s1", async () => {});
|
||||||
|
expect(runner.calls).toEqual([]);
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("lets an already running capture finish without restarting the loop after the last viewer leaves", async () => {
|
||||||
|
const runner = fakeRunner();
|
||||||
|
const run = runner.run.bind(runner);
|
||||||
|
let finish!: () => void;
|
||||||
|
let started = false;
|
||||||
|
runner.run = async (args, options) => {
|
||||||
|
started = true;
|
||||||
|
await new Promise<void>((resolve) => {
|
||||||
|
finish = resolve;
|
||||||
|
});
|
||||||
|
return run(args, options);
|
||||||
|
};
|
||||||
|
const { service, scheduler, unsubscribe } = setup({ runner });
|
||||||
|
service.addSession("s1");
|
||||||
|
scheduler.runNext();
|
||||||
|
await waitFor(() => started);
|
||||||
|
unsubscribe();
|
||||||
|
finish();
|
||||||
|
await waitFor(() => service.getState()[0]?.thumbnailAttachmentId !== undefined);
|
||||||
|
const args = runner.calls[0].args;
|
||||||
|
await waitFor(() => !existsSync(args[args.indexOf("--out") + 1]));
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
const leave = service.subscribe(() => {});
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
leave();
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
it("gives foreground work priority and resumes with one fresh capture", async () => {
|
it("gives foreground work priority and resumes with one fresh capture", async () => {
|
||||||
const scheduler = fakeScheduler();
|
const scheduler = fakeScheduler();
|
||||||
let finishCapture: ((result: BskRunResult) => void) | undefined;
|
let finishCapture: ((result: BskRunResult) => void) | undefined;
|
||||||
@@ -540,6 +652,12 @@ describe("HTTP/SSE interface", () => {
|
|||||||
const eventsRes = fakeRes();
|
const eventsRes = fakeRes();
|
||||||
await eventsRoute?.handler(fakeReq(), eventsRes.res as never);
|
await eventsRoute?.handler(fakeReq(), eventsRes.res as never);
|
||||||
service.beginAction("s1", "clicking");
|
service.beginAction("s1", "clicking");
|
||||||
|
const streamed = eventsRes.chunks.map((chunk) => JSON.parse(chunk.slice(6)));
|
||||||
|
expect(streamed.map((event) => event.type)).toEqual(["snapshot", "upsert"]);
|
||||||
|
expect(streamed[0]).toMatchObject({
|
||||||
|
sessions: [{ sessionId: "s1", action: "idle" }],
|
||||||
|
available: true,
|
||||||
|
});
|
||||||
expect(eventsRes.res.body()).toContain('"action":"clicking"');
|
expect(eventsRes.res.body()).toContain('"action":"clicking"');
|
||||||
eventsRes.res.close();
|
eventsRes.res.close();
|
||||||
|
|
||||||
@@ -566,6 +684,47 @@ describe("HTTP/SSE interface", () => {
|
|||||||
service.dispose();
|
service.dispose();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("state-only SSE does not capture, and route disposal releases every active viewer", async () => {
|
||||||
|
const { service, scheduler } = setup({ thumbnails: false });
|
||||||
|
service.addSession("s1");
|
||||||
|
const { routes, webServer } = routeHarness();
|
||||||
|
const dispose = registerObservationRoutes({ get: () => webServer } as never, service);
|
||||||
|
const route = routes.get("/bsk-observation/events")!;
|
||||||
|
const metadata = fakeRes();
|
||||||
|
await route.handler(fakeReq({ url: "/bsk-observation/events?thumbnails=0" }), metadata.res);
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
const viewing = fakeRes();
|
||||||
|
await route.handler(fakeReq({ url: "/bsk-observation/events?thumbnails=1" }), viewing.res);
|
||||||
|
expect(scheduler.pending()).toEqual([0]);
|
||||||
|
const endMetadata = vi.spyOn(metadata.res, "end");
|
||||||
|
const endViewing = vi.spyOn(viewing.res, "end");
|
||||||
|
dispose();
|
||||||
|
expect(endMetadata).toHaveBeenCalledOnce();
|
||||||
|
expect(endViewing).toHaveBeenCalledOnce();
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
viewing.res.close();
|
||||||
|
metadata.res.close();
|
||||||
|
expect(endViewing).toHaveBeenCalledOnce();
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("releases a viewer when writing its initial snapshot fails", async () => {
|
||||||
|
const { service, scheduler } = setup({ thumbnails: false });
|
||||||
|
service.addSession("s1");
|
||||||
|
const { routes, webServer } = routeHarness();
|
||||||
|
const dispose = registerObservationRoutes({ get: () => webServer } as never, service);
|
||||||
|
const response = fakeRes();
|
||||||
|
vi.spyOn(response.res, "write").mockImplementation(() => {
|
||||||
|
throw new Error("closed socket");
|
||||||
|
});
|
||||||
|
const end = vi.spyOn(response.res, "end");
|
||||||
|
await routes.get("/bsk-observation/events")!.handler(fakeReq(), response.res);
|
||||||
|
expect(end).toHaveBeenCalledOnce();
|
||||||
|
expect(scheduler.pending()).toEqual([]);
|
||||||
|
dispose();
|
||||||
|
service.dispose();
|
||||||
|
});
|
||||||
|
|
||||||
it("refuses a stop without a sessionId", async () => {
|
it("refuses a stop without a sessionId", async () => {
|
||||||
const registry = new SessionRegistry(5);
|
const registry = new SessionRegistry(5);
|
||||||
own(registry, "s1");
|
own(registry, "s1");
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
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 { describe, expect, it } from "vitest";
|
import { PassThrough } from "node:stream";
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||||
import {
|
import {
|
||||||
type BskRunResult,
|
type BskRunResult,
|
||||||
createBskRunner,
|
createBskRunner,
|
||||||
@@ -92,6 +93,77 @@ 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 };
|
||||||
|
|
||||||
@@ -124,6 +196,28 @@ describe("parseBskJson", () => {
|
|||||||
expect(() => parseBskJson({ ...base, code: 1, stderr: "boom" }, "x")).toThrow(/boom/);
|
expect(() => parseBskJson({ ...base, code: 1, stderr: "boom" }, "x")).toThrow(/boom/);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("surfaces fill recovery guidance to the model without retrying", async () => {
|
||||||
|
const hint =
|
||||||
|
"observe the field before retrying; the page may have formatted the value. Continue if the visible result satisfies the user's intent";
|
||||||
|
const reply = {
|
||||||
|
...base,
|
||||||
|
code: 3,
|
||||||
|
stdout: JSON.stringify({
|
||||||
|
code: "cdp_failed",
|
||||||
|
message: "fill could not verify the expected value",
|
||||||
|
data: { reason: "fill_value_mismatch" },
|
||||||
|
hint,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
let calls = 0;
|
||||||
|
const result = await runWithSessionBusyRetry(async () => {
|
||||||
|
calls++;
|
||||||
|
return reply;
|
||||||
|
});
|
||||||
|
expect(calls).toBe(1);
|
||||||
|
expect(() => parseBskJson(result, "fill")).toThrow(hint);
|
||||||
|
});
|
||||||
|
|
||||||
it("reports killed-by-interrupt children (null exit code) as interrupted", () => {
|
it("reports killed-by-interrupt children (null exit code) as interrupted", () => {
|
||||||
expect(() => parseBskJson({ ...base, code: null }, "navigate")).toThrow(/interrupted/);
|
expect(() => parseBskJson({ ...base, code: null }, "navigate")).toThrow(/interrupted/);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -25,7 +25,6 @@ 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. */
|
||||||
|
|||||||
@@ -0,0 +1,135 @@
|
|||||||
|
#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
|
||||||
|
}
|
||||||
+9
-3
@@ -174,16 +174,22 @@ 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 {
|
} else if (!versionHeading.test(content)) {
|
||||||
// Otherwise: insert a new section after [Unreleased]
|
// Preserve prepared release entries; new versions go before the release history.
|
||||||
|
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## [${version}] - ${today}`);
|
content = content.replace(unreleased, `## [Unreleased]\n\n${heading}`);
|
||||||
|
} else if (/^## /m.test(content)) {
|
||||||
|
content = content.replace(/^## /m, `${heading}\n\n## `);
|
||||||
|
} else {
|
||||||
|
content = `${content.trimEnd()}\n\n${heading}\n`;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -172,6 +172,10 @@ intended. Read `bsk upload --help` and `bsk download --help` for all flags and e
|
|||||||
- Stale ref: observe again and retry the intended action once.
|
- Stale ref: observe again and retry the intended action once.
|
||||||
- Unknown tab or session: list current tabs/sessions; never guess identifiers.
|
- Unknown tab or session: list current tabs/sessions; never guess identifiers.
|
||||||
- Timeout: inspect current page state before deciding whether one longer purposeful wait is useful.
|
- Timeout: inspect current page state before deciding whether one longer purposeful wait is useful.
|
||||||
|
- Fill result unconfirmed (`fill_value_mismatch`): observe the field first; the page may have
|
||||||
|
formatted the value. Continue if the visible result satisfies the user's intent. Otherwise correct
|
||||||
|
the remaining difference; do not blindly repeat fill or immediately request human help. For other
|
||||||
|
fill errors, follow the returned hint and inspect current state before retrying.
|
||||||
- Unsupported command: continue with available capabilities; suggest updating only when the missing
|
- Unsupported command: continue with available capabilities; suggest updating only when the missing
|
||||||
command is necessary.
|
command is necessary.
|
||||||
- Unrecoverable failure: report the blocker and stop the session in a finally-style path.
|
- Unrecoverable failure: report the blocker and stop the session in a finally-style path.
|
||||||
|
|||||||
Reference in New Issue
Block a user