aboutsummaryrefslogtreecommitdiff
path: root/test-suite
diff options
context:
space:
mode:
authorTJ Dong <122852285+tj-dong@users.noreply.github.com>2026-06-22 16:55:20 -0700
committerGitHub <noreply@github.com>2026-06-22 19:55:20 -0400
commitb8165967408be47e93b6a566270988177f8f6866 (patch)
tree58cb4999702566a24a0384a35c0b9aab1db3c121 /test-suite
parentdce772f330db12a73e85297918882c0c4f28f030 (diff)
0.15.39: dedicated pi-chrome automation tab/window isolation (#6)
Stop pi-chrome from hijacking the user's active tab. Page/navigation actions with no explicit target now route to a dedicated automation window owned by the calling Pi session (falling back to a dedicated tab if a window can't be made), instead of overwriting whatever the user has open. - Session-scoped ownership: Map<sessionKey, target> in the service worker, keyed by a sessionKey forwarded from index.ts, so concurrent sessions (one shared extension) never fight over a window or close each other's tabs. - Persistence: ownership mirrored to chrome.storage.session so a service-worker restart re-hydrates and reuses the window instead of orphaning it. Cleared on full browser restart; restored windows are then left alone (never reclaimed). - getTabByParams default branch resolves the owned target; tab.activate/close/ group/ungroup pass createOwnedTarget:false so management never auto-creates a throwaway tab or falls back to the user's active tab. - Session-group integration: the dedicated-window tab still joins this session's tab group, in its own window; grouping stays best-effort. - Lifecycle: cleanup on /chrome revoke and real session end (not /reload); fire-and-forget so it never blocks /quit, /reload, or shutdown. - Tests: new test-suite/unit/automation-target.test.mjs (isolation, reuse, concurrency, restart/reconnect re-hydration, guarded tab.*, group integration, window->tab fallback, robust cleanup). Docs + CHANGELOG updated.
Diffstat (limited to 'test-suite')
-rw-r--r--test-suite/unit/automation-target.test.mjs344
1 files changed, 344 insertions, 0 deletions
diff --git a/test-suite/unit/automation-target.test.mjs b/test-suite/unit/automation-target.test.mjs
new file mode 100644
index 0000000..541e08a
--- /dev/null
+++ b/test-suite/unit/automation-target.test.mjs
@@ -0,0 +1,344 @@
+// Unit harness for pi-chrome's dedicated automation tab/window isolation in service_worker.js.
+//
+// Feature under test: pi-chrome must never navigate or replace the user's active tab. Page and
+// navigation actions without an explicit target are routed to a dedicated automation target that
+// the *calling Pi session* created and owns. Ownership is session-scoped (one extension brokers
+// every session) and mirrored to chrome.storage.session so a service-worker restart re-hydrates
+// it instead of orphaning the window. Cleanup closes only the calling session's owned target.
+//
+// Like csp-eval.test.mjs we load the *real* worker into a vm sandbox with a stateful chrome.*
+// mock, then exercise the real helpers and the real dispatch() paths. Chrome state (tabs/windows/
+// storage.session) can be shared across two sandbox loads to simulate a service-worker restart.
+
+import vm from "node:vm";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const workerPath = path.resolve(__dirname, "../../extensions/chrome-profile-bridge/browser-extension/service_worker.js");
+const src = fs.readFileSync(workerPath, "utf8");
+
+let failures = 0;
+let passes = 0;
+function ok(cond, msg) {
+ if (cond) { passes++; }
+ else { failures++; console.error(` ✗ ${msg}`); }
+}
+async function throwsWith(fn, re, msg) {
+ try { await fn(); ok(false, `${msg} (expected throw)`); }
+ catch (e) { ok(re.test(String(e.message || e)), `${msg} (got: ${e.message})`); }
+}
+
+// ---- stateful Chrome mock. `state` (tabs/windows/storage) can be shared to simulate a
+// service-worker restart: the browser keeps its tabs/windows/session-storage, the worker memory
+// is wiped (a fresh sandbox).
+function makeChromeState() {
+ const tabs = new Map(); // id -> { id, windowId, url, active, groupId }
+ const windows = new Map(); // id -> { id }
+ const groups = new Map(); // groupId -> { id, title, color, collapsed, windowId }
+ const storage = {}; // chrome.storage.session backing
+ let nextTabId = 1;
+ let nextWindowId = 1;
+ let nextGroupId = 1;
+ const alloc = { tab: () => nextTabId++, window: () => nextWindowId++, group: () => nextGroupId++ };
+
+ // Seed a user window with two real user tabs (Gmail + a research article, the active one).
+ const userWindowId = alloc.window();
+ windows.set(userWindowId, { id: userWindowId });
+ const userGmail = { id: alloc.tab(), windowId: userWindowId, url: "https://mail.google.com/", active: false, groupId: -1 };
+ const userArticle = { id: alloc.tab(), windowId: userWindowId, url: "https://example.com/research-article", active: true, groupId: -1 };
+ tabs.set(userGmail.id, userGmail);
+ tabs.set(userArticle.id, userArticle);
+
+ return { tabs, windows, groups, storage, alloc, userWindowId, userGmail, userArticle };
+}
+
+function makeChrome(state, { withWindows = true, withStorage = true, withTabGroups = false } = {}) {
+ const { tabs, windows, groups, storage, alloc, userWindowId } = state;
+ const noop = () => {};
+ const listener = { addListener: noop, removeListener: noop };
+
+ const chrome = {
+ runtime: { id: "unittestextension", getManifest: () => ({ version: "0.0.0" }), onInstalled: listener, onStartup: listener, lastError: null },
+ alarms: { onAlarm: listener, create: noop, clear: noop, clearAll: noop },
+ action: { onClicked: listener },
+ debugger: { sendCommand: noop, attach: async () => {}, detach: async () => {}, getTargets: (cb) => cb([]), onDetach: listener },
+ scripting: { executeScript: async () => [{ result: undefined }], registerContentScripts: async () => {}, unregisterContentScripts: async () => {} },
+ webNavigation: { onCommitted: listener },
+ tabs: {
+ onUpdated: listener,
+ query: async (q = {}) => {
+ let list = [...tabs.values()];
+ if (q.active === true) list = list.filter((t) => t.active);
+ if (typeof q.windowId === "number") list = list.filter((t) => t.windowId === q.windowId);
+ return list.map((t) => ({ ...t }));
+ },
+ get: async (id) => { const t = tabs.get(id); if (!t) throw new Error(`No tab with id ${id}`); return { ...t }; },
+ create: async ({ url = "about:blank", active = false } = {}) => {
+ const tab = { id: alloc.tab(), windowId: userWindowId, url, active, groupId: -1 };
+ tabs.set(tab.id, tab);
+ return { ...tab };
+ },
+ update: async (id, props = {}) => { const t = tabs.get(id); if (!t) throw new Error(`No tab with id ${id}`); Object.assign(t, props); return { ...t }; },
+ remove: async (id) => { tabs.delete(id); },
+ group: async ({ groupId, tabIds = [] } = {}) => {
+ let gid = groupId;
+ if (typeof gid !== "number") {
+ gid = alloc.group();
+ const firstTab = tabs.get(tabIds[0]);
+ groups.set(gid, { id: gid, title: "", color: "grey", collapsed: false, windowId: firstTab ? firstTab.windowId : userWindowId });
+ }
+ for (const tid of tabIds) { const t = tabs.get(tid); if (t) t.groupId = gid; }
+ return gid;
+ },
+ ungroup: async (id) => { const ids = Array.isArray(id) ? id : [id]; for (const tid of ids) { const t = tabs.get(tid); if (t) t.groupId = -1; } },
+ },
+ storage: withStorage ? {
+ session: {
+ get: async (key) => (key in storage ? { [key]: storage[key] } : {}),
+ set: async (obj) => { Object.assign(storage, obj); },
+ },
+ } : undefined,
+ };
+
+ if (withTabGroups) {
+ chrome.tabGroups = {
+ query: async ({ windowId } = {}) => [...groups.values()].filter((g) => windowId === undefined || g.windowId === windowId).map((g) => ({ ...g })),
+ get: async (id) => { const g = groups.get(id); if (!g) throw new Error(`No group ${id}`); return { ...g }; },
+ update: async (id, props = {}) => { const g = groups.get(id); if (!g) throw new Error(`No group ${id}`); Object.assign(g, props); return { ...g }; },
+ };
+ }
+
+ if (withWindows) {
+ chrome.windows = {
+ create: async ({ url = "about:blank", focused = false } = {}) => {
+ const id = alloc.window();
+ windows.set(id, { id });
+ const tab = { id: alloc.tab(), windowId: id, url, active: true, groupId: -1 };
+ tabs.set(tab.id, tab);
+ return { id, focused, tabs: [{ ...tab }] };
+ },
+ get: async (id) => { const w = windows.get(id); if (!w) throw new Error(`No window with id ${id}`); return { ...w }; },
+ remove: async (id) => { windows.delete(id); for (const [tid, t] of [...tabs]) if (t.windowId === id) tabs.delete(tid); },
+ update: async () => {},
+ };
+ } else {
+ chrome.windows = { update: async () => {} }; // no create/get/remove -> tab fallback path
+ }
+
+ return chrome;
+}
+
+function loadWorker(chrome) {
+ const noop = () => {};
+ const sandbox = {
+ console, JSON, Date, Math, Promise, Array, Object, String, Number, Boolean,
+ Error, TypeError, Map, Set, BigInt, Symbol, structuredClone,
+ setTimeout, clearTimeout, setInterval: () => 0, clearInterval: noop,
+ fetch: async () => { throw new Error("no network in unit test"); },
+ navigator: { userAgent: "unit-test" },
+ WebSocket: function () {},
+ chrome,
+ };
+ sandbox.globalThis = sandbox;
+ sandbox.self = sandbox;
+ vm.createContext(sandbox);
+ vm.runInContext(src, sandbox);
+ return sandbox;
+}
+
+const SK = "session:alpha"; // a representative sessionKey
+
+async function run() {
+ // ===== Isolation: navigation does not touch the user's active/other tabs. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state));
+ const userActiveUrl = state.userArticle.url;
+
+ const nav = await w.dispatch("page.navigate", { url: "https://pi.test/task", waitUntilLoad: false, sessionKey: SK });
+ ok(state.userArticle.url === userActiveUrl, "navigate: active user tab (research article) is not overwritten");
+ ok(state.userGmail.url === "https://mail.google.com/", "navigate: other user tab (Gmail) untouched");
+ ok(nav.url === "https://pi.test/task", "navigate: automation target navigated to requested URL");
+ ok(nav.id !== state.userArticle.id && nav.id !== state.userGmail.id, "navigate: did not reuse any user tab");
+ ok(nav.windowId !== state.userWindowId, "navigate: automation target lives in a dedicated window");
+
+ const status = await w.dispatch("automation.status", { sessionKey: SK });
+ ok(status.tabId === nav.id && status.windowId === nav.windowId, "ownership: target ids tracked for the session");
+ ok(w.isPiChromeOwnedTarget(nav.id, SK) === true, "ownership: isPiChromeOwnedTarget(owned, session) === true");
+ ok(w.isPiChromeOwnedTarget(state.userArticle.id) === false, "ownership: user tab is never owned (any session)");
+
+ // Reuse: a later navigation reuses the same owned target.
+ const nav2 = await w.dispatch("page.navigate", { url: "https://pi.test/step-2", waitUntilLoad: false, sessionKey: SK });
+ ok(nav2.id === nav.id && nav2.windowId === nav.windowId, "reuse: second navigation reuses the same automation window/tab");
+ ok(state.userArticle.url === userActiveUrl, "reuse: user tab still untouched after second navigation");
+
+ // Cleanup closes only the owned window; user tabs/windows survive.
+ const cleanup = await w.dispatch("automation.cleanup", { sessionKey: SK });
+ ok(cleanup.closedWindowId === nav.windowId, "cleanup: closed the owned window");
+ ok(state.tabs.has(state.userArticle.id) && state.tabs.has(state.userGmail.id), "cleanup: user tabs never closed");
+ ok(state.windows.has(state.userWindowId), "cleanup: user window never closed");
+ ok(!state.tabs.has(nav.id), "cleanup: the owned automation tab is gone");
+ const status2 = await w.dispatch("automation.status", { sessionKey: SK });
+ ok(status2.tabId === null && status2.windowId === null, "cleanup: ownership cleared");
+ }
+
+ // ===== Session-group integration: the dedicated-window tab joins this session's group. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state, { withTabGroups: true }));
+ // index.ts tags page.* actions with joinSessionGroup + sessionGroupTitle; replicate that here.
+ const groupTitle = "Pi Session: alpha";
+ const nav = await w.dispatch("page.navigate", {
+ url: "https://pi.test/grouped", waitUntilLoad: false,
+ sessionKey: SK, joinSessionGroup: true, sessionGroupTitle: groupTitle,
+ });
+ const navTab = state.tabs.get(nav.id);
+ ok(navTab.windowId !== state.userWindowId, "group: automation tab is in its dedicated window");
+ ok(typeof navTab.groupId === "number" && navTab.groupId >= 0, "group: automation tab joined a tab group");
+ const grp = state.groups.get(navTab.groupId);
+ ok(grp && grp.title === groupTitle, "group: the group is titled with this session's title");
+ ok(grp.windowId === navTab.windowId, "group: the session group lives inside the dedicated automation window (not the user window)");
+
+ // A second page action reuses the same tab and does not spawn a second group.
+ const groupsBefore = state.groups.size;
+ await w.dispatch("page.navigate", { url: "https://pi.test/grouped-2", waitUntilLoad: false, sessionKey: SK, joinSessionGroup: true, sessionGroupTitle: groupTitle });
+ ok(state.groups.size === groupsBefore, "group: reusing the automation tab does not create a second group");
+ }
+
+ // ===== Grouping is best-effort: a tabGroups failure must not break navigation. =====
+ {
+ const state = makeChromeState();
+ const chrome = makeChrome(state, { withTabGroups: true });
+ chrome.tabs.group = async () => { throw new Error("group blew up"); };
+ const w = loadWorker(chrome);
+ const nav = await w.dispatch("page.navigate", { url: "https://pi.test/group-fail", waitUntilLoad: false, sessionKey: SK, joinSessionGroup: true, sessionGroupTitle: "Pi Session: alpha" });
+ ok(nav.url === "https://pi.test/group-fail", "group-fail: navigation still succeeds when grouping throws");
+ ok(state.tabs.get(nav.id).windowId !== state.userWindowId, "group-fail: still used the dedicated automation window");
+ }
+
+ // ===== Concurrency: two sessions get separate windows; cleanup is per-session. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state));
+ const a = await w.dispatch("page.navigate", { url: "https://pi.test/a", waitUntilLoad: false, sessionKey: "session:A" });
+ const b = await w.dispatch("page.navigate", { url: "https://pi.test/b", waitUntilLoad: false, sessionKey: "session:B" });
+ ok(a.id !== b.id && a.windowId !== b.windowId, "concurrency: each session gets its own dedicated window/tab");
+ ok(w.isPiChromeOwnedTarget(a.id, "session:A") && !w.isPiChromeOwnedTarget(a.id, "session:B"), "concurrency: ownership is scoped to the creating session");
+
+ // Cleaning up session A must not touch session B's target.
+ await w.dispatch("automation.cleanup", { sessionKey: "session:A" });
+ ok(!state.tabs.has(a.id), "concurrency: cleanup closed session A's tab");
+ ok(state.tabs.has(b.id), "concurrency: cleanup left session B's tab open");
+ const bStatus = await w.dispatch("automation.status", { sessionKey: "session:B" });
+ ok(bStatus.tabId === b.id, "concurrency: session B still owns its target after A cleanup");
+ }
+
+ // ===== Service-worker restart / reconnect: persisted ownership re-hydrates from storage. =====
+ {
+ const state = makeChromeState();
+ const w1 = loadWorker(makeChrome(state));
+ const nav = await w1.dispatch("page.navigate", { url: "https://pi.test/persist", waitUntilLoad: false, sessionKey: SK });
+ ok(typeof state.storage.piChromeAutomationTargets === "object", "restart: ownership was persisted to storage.session");
+
+ // Simulate the MV3 service worker being suspended and restarted: fresh sandbox (memory wiped),
+ // same browser tabs/windows + same session storage.
+ const w2 = loadWorker(makeChrome(state));
+ const statusAfterRestart = await w2.dispatch("automation.status", { sessionKey: SK });
+ ok(statusAfterRestart.tabId === nav.id && statusAfterRestart.windowId === nav.windowId, "restart: re-hydrated the owned target from storage");
+
+ // A navigation after restart must REUSE the existing window, not orphan it with a new one.
+ const windowsBefore = state.windows.size;
+ const nav2 = await w2.dispatch("page.navigate", { url: "https://pi.test/persist-2", waitUntilLoad: false, sessionKey: SK });
+ ok(nav2.id === nav.id && nav2.windowId === nav.windowId, "restart: navigation after restart reuses the persisted window (no orphan)");
+ ok(state.windows.size === windowsBefore, "restart: no new window created after restart");
+
+ // Cleanup after restart works and clears persisted state.
+ await w2.dispatch("automation.cleanup", { sessionKey: SK });
+ const persisted = state.storage.piChromeAutomationTargets || {};
+ ok(!(SK in persisted), "restart: cleanup removed the session from persisted storage");
+ }
+
+ // ===== Restart after the user manually closed the window: no orphan, fresh target. =====
+ {
+ const state = makeChromeState();
+ const w1 = loadWorker(makeChrome(state));
+ const nav = await w1.dispatch("page.navigate", { url: "https://pi.test/closed", waitUntilLoad: false, sessionKey: SK });
+ await state.windows.delete(nav.windowId); // user closed pi-chrome's window
+ for (const [tid, t] of [...state.tabs]) if (t.windowId === nav.windowId) state.tabs.delete(tid);
+
+ const w2 = loadWorker(makeChrome(state)); // SW restart
+ const nav2 = await w2.dispatch("page.navigate", { url: "https://pi.test/reopened", waitUntilLoad: false, sessionKey: SK });
+ ok(nav2.id !== nav.id, "restart-after-close: a fresh automation target is created when the persisted one is gone");
+ ok(state.tabs.has(nav2.id), "restart-after-close: new target exists");
+ }
+
+ // ===== tab.* management never auto-creates / never falls back to the user's active tab. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state));
+ const windowsBefore = state.windows.size;
+ const tabsBefore = state.tabs.size;
+
+ await throwsWith(
+ () => w.dispatch("tab.close", { sessionKey: SK }),
+ /no automation tab yet|Pass targetId/,
+ "tab.close: with no target and no owned target, errors instead of closing the user's active tab",
+ );
+ ok(state.tabs.has(state.userArticle.id), "tab.close: user's active tab was NOT closed");
+ ok(state.windows.size === windowsBefore && state.tabs.size === tabsBefore, "tab.close: did not spawn a throwaway tab/window");
+
+ await throwsWith(() => w.dispatch("tab.activate", { sessionKey: SK }), /no automation tab yet|Pass targetId/, "tab.activate: errors with no target/owned target");
+
+ // Once an automation target exists, management actions operate on it (not on the user tab).
+ const nav = await w.dispatch("page.navigate", { url: "https://pi.test/manage", waitUntilLoad: false, sessionKey: SK });
+ const closed = await w.dispatch("tab.close", { sessionKey: SK });
+ ok(closed.closed === nav.id, "tab.close: with an owned target, closes that target");
+ ok(state.tabs.has(state.userArticle.id), "tab.close: user tab still safe after closing the owned target");
+ }
+
+ // ===== Explicit targeting still works on any existing tab (no regression). =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state));
+ const nav = await w.dispatch("page.navigate", { url: "https://pi.test/explicit", targetId: String(state.userGmail.id), waitUntilLoad: false, sessionKey: SK });
+ ok(nav.id === state.userGmail.id, "explicit: targetId routes to the requested existing tab");
+ ok(state.userGmail.url === "https://pi.test/explicit", "explicit: explicitly targeted tab is navigated");
+ const status = await w.dispatch("automation.status", { sessionKey: SK });
+ ok(status.tabId === null, "explicit: explicit targeting does not create/claim an automation target");
+ }
+
+ // ===== Window-unavailable fallback: a dedicated TAB is used, and the user's window is safe. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state, { withWindows: false }));
+ const target = await w.getOrCreateAutomationTarget(SK);
+ ok(target.id !== state.userArticle.id && target.id !== state.userGmail.id, "fallback: created a dedicated tab, not a user tab");
+ ok(w.isPiChromeOwnedTarget(target.id, SK) === true, "fallback: dedicated tab is owned");
+ const cleanup = await w.cleanupAutomationTarget(SK);
+ ok(cleanup.closedTabId === target.id && cleanup.closedWindowId === null, "fallback: cleanup closes only the owned tab (never the shared window)");
+ ok(state.windows.has(state.userWindowId), "fallback: cleanup never closes the user/shared window");
+ ok(state.tabs.has(state.userArticle.id) && state.tabs.has(state.userGmail.id), "fallback: cleanup leaves user tabs intact");
+ }
+
+ // ===== Robust cleanup: no-op when nothing created, and when target already closed manually. =====
+ {
+ const state = makeChromeState();
+ const w = loadWorker(makeChrome(state));
+ const empty = await w.cleanupAutomationTarget(SK);
+ ok(empty.closedWindowId === null && empty.closedTabId === null, "cleanup: no-op when nothing was ever created");
+
+ const t = await w.getOrCreateAutomationTarget(SK);
+ // User closed pi-chrome's window manually (Chrome closes its tabs too).
+ state.windows.delete(t.windowId);
+ for (const [tid, tab] of [...state.tabs]) if (tab.windowId === t.windowId) state.tabs.delete(tid);
+ const stale = await w.cleanupAutomationTarget(SK);
+ ok(stale.closedWindowId === null && stale.closedTabId === null, "cleanup: robust when owned window was already closed");
+ }
+
+ console.log(`\n${passes} passed, ${failures} failed`);
+ if (failures) process.exit(1);
+}
+
+run().catch((e) => { console.error(e); process.exit(1); });