gentle-shell-bridge 0.3.0 → 0.3.1

package/test/status-sections.test.ts

@@ -1,243 +0,0 @@
-/**
- * `/bridge-status` for the sidebar surface (S8, S12).
- *
- * The command must answer "why did my section not appear": the registered sections, their persisted
- * visibility, the failures of the most recent sidebar frame, and whether the rail was intercepted at
- * all. It must do so WITHOUT running a section's `lines()`/`meta()` — diagnostics never build UI.
- *
- * The pre-existing fields (providers, backend, last capture, failures, store problems, duplicate
- * settings) keep their exact output for a run that has no sections: that is why every new block is
- * emitted only when it has something to say.
- */
-
-import assert from "node:assert/strict";
-import { mkdtempSync, rmSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import test from "node:test";
-
-import { registerRows, registerSection, resetBusForTests, resetSectionsForTests } from "../src/bus.ts";
-import {
-  disableSidebarBackend,
-  installSidebarBackend,
-  resetSidebarStateForTests,
-} from "../src/sidebar.ts";
-import {
-  installSectionRail,
-  resetSectionFailuresForTests,
-} from "../src/sidebar-render.ts";
-import { collectStatus, formatStatus } from "../src/status.ts";
-import { resetStoreStateForTests } from "../src/store.ts";
-import type { RowProvider, SidebarSection } from "../src/types.ts";
-import { setSectionVisible } from "../src/visibility.ts";
-import {
-  fakeTui,
-  registerNativeFooter,
-  registerNativeRail,
-  renderSidebar,
-  resetSidebar,
-} from "./fake-sidebar.ts";
-
-let configHome: string;
-let previousConfigHome: string | undefined;
-
-test.before(() => {
-  configHome = mkdtempSync(join(tmpdir(), "gsb-status-"));
-  previousConfigHome = process.env.GENTLE_PI_CONFIG_HOME;
-  process.env.GENTLE_PI_CONFIG_HOME = configHome;
-});
-
-test.after(() => {
-  if (previousConfigHome === undefined) delete process.env.GENTLE_PI_CONFIG_HOME;
-  else process.env.GENTLE_PI_CONFIG_HOME = previousConfigHome;
-  rmSync(configHome, { recursive: true, force: true });
-});
-
-test.beforeEach(() => {
-  rmSync(join(configHome, "gentle-shell-bridge"), { recursive: true, force: true });
-  resetBusForTests();
-  resetSectionsForTests();
-  resetSidebar();
-  resetSidebarStateForTests();
-  resetSectionFailuresForTests();
-  resetStoreStateForTests();
-  disableSidebarBackend();
-});
-
-const section = (id: string, extra: Partial<SidebarSection> = {}): SidebarSection => ({
-  id,
-  title: id.toUpperCase(),
-  lines: () => [`body ${id}`],
-  ...extra,
-});
-
-const statusLines = (): string[] => formatStatus(collectStatus());
-
-test("the sections table reports id, title, visibility and where the order comes from", () => {
-  registerSection(section("late", { title: "LATE", order: 5 }));
-  registerSection(section("plain", { title: "PLAIN" }));
-  registerSection(section("first", { title: "FIRST", order: 1 }));
-
-  const snapshot = collectStatus();
-
-  assert.deepEqual(snapshot.sections, [
-    { id: "first", title: "FIRST", visible: true, order: 1, rowLabel: "first" },
-    { id: "late", title: "LATE", visible: true, order: 5, rowLabel: "late" },
-    { id: "plain", title: "PLAIN", visible: true, order: "registration", rowLabel: "plain" },
-  ]);
-  assert.deepEqual(statusLines().filter((line) => line.includes("FIRST") || line.includes("PLAIN")), [
-    '  - first "FIRST": visible, order 1, row "first"',
-    '  - plain "PLAIN": visible, registration order, row "plain"',
-  ]);
-  assert.ok(statusLines().includes("sections: 3"));
-});
-
-test("the table shows the persisted visibility, not a guess", () => {
-  registerSection(section("music", { title: "MUSIC" }));
-  registerSection(section("quiet", { title: "QUIET", defaultVisible: false }));
-
-  setSectionVisible("music", false);
-
-  assert.deepEqual(
-    collectStatus().sections?.map((entry) => [entry.id, entry.visible]),
-    [
-      ["music", false],
-      ["quiet", false],
-    ],
-  );
-
-  setSectionVisible("quiet", true);
-  assert.equal(collectStatus().sections?.find((entry) => entry.id === "quiet")?.visible, true);
-});
-
-test("section failures from the last frame are reported with their id and phase", () => {
-  registerNativeFooter();
-  installSidebarBackend(() => fakeTui());
-  installSectionRail();
-  registerSection(
-    section("broken", {
-      title: "BROKEN",
-      lines: () => {
-        throw new Error("lines exploded");
-      },
-    }),
-  );
-  registerSection(section("fine", { title: "FINE" }));
-
-  renderSidebar(40);
-
-  const snapshot = collectStatus();
-  assert.deepEqual(snapshot.sectionFailures, [
-    { sectionId: "broken", phase: "lines", message: "lines exploded" },
-  ]);
-  const lines = statusLines();
-  const failuresAt = lines.indexOf("section failures: 1");
-  assert.ok(failuresAt !== -1, "the failure block is emitted");
-  assert.deepEqual(lines.slice(failuresAt, failuresAt + 2), [
-    "section failures: 1",
-    "  - broken (lines): lines exploded",
-  ]);
-});
-
-test("diagnostics never execute a section's lines() or meta()", () => {
-  let linesCalls = 0;
-  let metaCalls = 0;
-  registerSection(
-    section("costly", {
-      title: "COSTLY",
-      meta: () => {
-        metaCalls += 1;
-        return "m";
-      },
-      lines: () => {
-        linesCalls += 1;
-        return ["never built for a status report"];
-      },
-    }),
-  );
-
-  collectStatus();
-  formatStatus(collectStatus());
-
-  assert.equal(linesCalls, 0, "a status report must not build section content");
-  assert.equal(metaCalls, 0);
-});
-
-test("the sidebar state answers the missing-section question", () => {
-  // Registered but never armed: the report says so instead of staying silent.
-  registerSection(section("music", { title: "MUSIC" }));
-  assert.equal(collectStatus().sidebar, undefined);
-  assert.ok(statusLines().includes("sidebar: not armed"));
-
-  // Intercepted with the part present.
-  registerNativeRail("todo", { render: () => ["▾ TODO"] });
-  registerNativeFooter();
-  assert.equal(installSidebarBackend(() => fakeTui()).outcome, "intercepted");
-  assert.deepEqual(collectStatus().sidebar, { state: "intercepted", rail: "wrapped" });
-  assert.ok(statusLines().includes("sidebar: intercepted (rail wrapped)"));
-
-  // Intercepted, but the host has not registered the part we append to yet.
-  resetSidebar();
-  resetSidebarStateForTests();
-  registerNativeRail("todo", { render: () => ["▾ TODO"] });
-  assert.deepEqual(installSidebarBackend(() => fakeTui()).rail, "pending");
-  assert.deepEqual(collectStatus().sidebar, { state: "intercepted", rail: "pending" });
-
-  // A tui without rail state: reported, never invented.
-  resetSidebar();
-  resetSidebarStateForTests();
-  installSidebarBackend(() => undefined);
-  assert.deepEqual(collectStatus().sidebar, { state: "no-sidebar-state" });
-  assert.ok(statusLines().includes("sidebar: no-sidebar-state"));
-
-  // A resolver that throws keeps its reason.
-  resetSidebarStateForTests();
-  installSidebarBackend(() => {
-    throw new Error("no tui yet");
-  });
-  assert.deepEqual(collectStatus().sidebar, {
-    state: "no-sidebar-state",
-    reason: "no tui yet",
-  });
-
-  // Disabled after a successful arm: unarmed again, and the report says so.
-  resetSidebar();
-  resetSidebarStateForTests();
-  registerNativeFooter();
-  installSidebarBackend(() => fakeTui());
-  disableSidebarBackend();
-  assert.deepEqual(collectStatus().sidebar, { state: "unarmed" });
-});
-
-test("the pre-existing fields are still reported alongside the new ones", () => {
-  const provider: RowProvider = { id: "p", category: "Cards", rows: () => [] };
-  registerRows(provider);
-  registerSection(section("music", { title: "MUSIC" }));
-
-  const snapshot = collectStatus();
-
-  assert.deepEqual(snapshot.providers, [{ id: "p", category: "Cards" }]);
-  assert.equal(snapshot.backend, "none");
-  assert.deepEqual(snapshot.failures, []);
-  assert.deepEqual(snapshot.storeProblems, []);
-
-  const lines = statusLines();
-  assert.ok(lines.includes("providers: 1"));
-  assert.ok(lines.includes("backend: none"));
-  assert.ok(lines.includes("last capture: none"));
-  assert.ok(lines.includes("last failures: none"));
-  assert.ok(lines.includes("duplicate settings: no build yet"));
-  assert.ok(lines.includes("sections: 1"));
-});
-
-test("a run with no sections keeps the historical output byte for byte", () => {
-  assert.deepEqual(statusLines(), [
-    "gentle-shell-bridge status",
-    "providers: none",
-    "backend: none",
-    "last capture: none",
-    "last failures: none",
-    "store problems: none",
-    "duplicate settings: no build yet",
-  ]);
-});

package/test/status.test.ts

@@ -1,209 +0,0 @@
-import assert from "node:assert/strict";
-import test from "node:test";
-
-import { resetBusForTests, registerRows } from "../src/bus.ts";
-import {
-  getCaptureDiagnostics,
-  installCaptureBackend,
-  resetCaptureStateForTests,
-} from "../src/capture.ts";
-import { resetHookStateForTests, installHookBackend } from "../src/hook.ts";
-import { resetRowBuildStateForTests } from "../src/rows.ts";
-import { createRowContext } from "../src/rows.ts";
-import {
-  collectStatus,
-  findDuplicateSettings,
-  formatStatus,
-  type StatusSnapshot,
-} from "../src/status.ts";
-import { resetStoreStateForTests } from "../src/store.ts";
-import type { CustomizeRow, RowProvider } from "../src/types.ts";
-
-const HOOK_KEY = Symbol.for("gentle-pi.customize-row-providers");
-const hookSlot = (): Record<symbol, unknown> => globalThis as unknown as Record<symbol, unknown>;
-
-test.beforeEach(() => {
-  resetBusForTests();
-  resetCaptureStateForTests();
-  resetRowBuildStateForTests();
-  resetHookStateForTests();
-  resetStoreStateForTests();
-});
-
-test.afterEach(() => {
-  delete hookSlot()[HOOK_KEY];
-  resetHookStateForTests();
-});
-
-// No row-level category: `findDuplicateSettings` must fall back to the provider's category, which
-// is what distinguishes the two providers in the cross-category case below.
-const choiceRow = (setting: string, value: string): CustomizeRow => ({
-  label: setting,
-  choice: { setting, value, current: () => false },
-  action: () => {},
-});
-
-const settingProvider = (id: string, category: string, setting: string): RowProvider => ({
-  id,
-  category,
-  rows: () => [choiceRow(setting, "a"), choiceRow(setting, "b")],
-});
-
-test("an empty state formats every field as none", () => {
-  const snapshot = collectStatus();
-
-  assert.deepEqual(snapshot, {
-    providers: [],
-    backend: "none",
-    failures: [],
-    storeProblems: [],
-  });
-  assert.equal(snapshot.duplicates, undefined, "no build has happened, so duplicates are unknown");
-  assert.deepEqual(formatStatus(snapshot), [
-    "gentle-shell-bridge status",
-    "providers: none",
-    "backend: none",
-    "last capture: none",
-    "last failures: none",
-    "store problems: none",
-    "duplicate settings: no build yet",
-  ]);
-});
-
-test("a populated state formats providers, backend, capture, failures, store and duplicates", () => {
-  const snapshot: StatusSnapshot = {
-    providers: [
-      { id: "loon.banner-source", category: "Banner" },
-      { id: "other.card", category: "Cards" },
-    ],
-    backend: "capture",
-    lastCapture: { kind: "injected", injectedRows: 2 },
-    failures: [{ providerId: "boom", message: "provider exploded", rowsDropped: true }],
-    storeProblems: [
-      {
-        pluginId: "loon",
-        path: "/tmp/x/gentle-shell-bridge/loon.json",
-        kind: "invalid-json",
-        message: "Unexpected token",
-      },
-    ],
-    duplicates: [
-      { category: "Banner", setting: "Loon → Banner source", providerIds: ["loon.banner-source", "other.card"] },
-    ],
-  };
-
-  assert.deepEqual(formatStatus(snapshot), [
-    "gentle-shell-bridge status",
-    "providers: 2",
-    "  - loon.banner-source (Banner)",
-    "  - other.card (Cards)",
-    "backend: capture",
-    "last capture: injected 2 rows",
-    "last failures: 1",
-    "  - boom: provider exploded (rows dropped)",
-    "store problems: 1",
-    "  - loon (/tmp/x/gentle-shell-bridge/loon.json): invalid-json: Unexpected token (reads fall back to defaults; the file is left as is)",
-    "duplicate settings: 1",
-    '  - Banner / "Loon → Banner source": loon.banner-source, other.card',
-  ]);
-});
-
-test("an uncaptured outcome with a reason is reported, not hidden", () => {
-  const snapshot: StatusSnapshot = {
-    providers: [],
-    backend: "capture",
-    lastCapture: { kind: "uncaptured", injectedRows: 0, reason: "no-capture" },
-    failures: [],
-    storeProblems: [],
-    duplicates: [],
-  };
-
-  assert.ok(formatStatus(snapshot).includes("last capture: uncaptured (no-capture)"));
-});
-
-test("collectStatus reports the capture backend and its last outcome and failures", () => {
-  const providers: RowProvider[] = [
-    { id: "ok", category: "Cards", rows: () => [{ label: "fine", action: () => {} }] },
-    {
-      id: "boom",
-      category: "Banner",
-      rows: () => {
-        throw new Error("provider exploded");
-      },
-    },
-  ];
-  for (const provider of providers) registerRows(provider);
-
-  const host = {
-    custom(factory: (ui: unknown, theme: unknown) => unknown) {
-      return factory(undefined, undefined);
-    },
-  };
-  installCaptureBackend(host);
-  const rows: CustomizeRow[] = [
-    { category: "Cards", label: "one", action: () => {} },
-    { category: "Cards", label: "two", action: () => {} },
-    { category: "Cards", label: "three", action: () => {} },
-  ];
-  host.custom(() => {
-    rows.map((row) => row.category);
-    return { invalidate: () => {}, render: () => [], handleInput: () => {}, dispose: () => {} };
-  });
-
-  const snapshot = collectStatus();
-
-  assert.equal(snapshot.backend, "capture");
-  assert.deepEqual(snapshot.lastCapture, { kind: "injected", injectedRows: 1 });
-  assert.deepEqual(snapshot.failures, [
-    { providerId: "boom", message: "provider exploded", rowsDropped: true },
-  ]);
-  assert.equal(getCaptureDiagnostics().armedTargets, 1);
-});
-
-test("collectStatus reports the hook backend when the registry is in use", () => {
-  hookSlot()[HOOK_KEY] = [];
-  installHookBackend();
-
-  assert.equal(collectStatus().backend, "hook");
-});
-
-test("duplicate category + setting across two providers is detected", () => {
-  const providers = [
-    settingProvider("loon.banner-source", "Banner", "Loon → Banner source"),
-    settingProvider("other.banner", "Banner", "Loon → Banner source"),
-  ];
-
-  assert.deepEqual(findDuplicateSettings(providers, createRowContext(undefined)), [
-    { category: "Banner", setting: "Loon → Banner source", providerIds: ["loon.banner-source", "other.banner"] },
-  ]);
-});
-
-test("one provider's own toggle rows are not a duplicate", () => {
-  const providers = [settingProvider("loon.banner-source", "Banner", "Loon → Banner source")];
-
-  assert.deepEqual(findDuplicateSettings(providers, createRowContext(undefined)), []);
-});
-
-test("the same setting in different categories is not a duplicate", () => {
-  const providers = [
-    settingProvider("a", "Banner", "Loon → Banner source"),
-    settingProvider("b", "Cards", "Loon → Banner source"),
-  ];
-
-  assert.deepEqual(findDuplicateSettings(providers, createRowContext(undefined)), []);
-});
-
-test("a throwing provider is skipped by the duplicate scan instead of breaking it", () => {
-  const providers: RowProvider[] = [
-    {
-      id: "boom",
-      category: "Banner",
-      rows: () => {
-        throw new Error("duplicate scan exploded");
-      },
-    },
-    settingProvider("a", "Banner", "Shared setting"),
-  ];
-
-  assert.deepEqual(findDuplicateSettings(providers, createRowContext(undefined)), []);
-});

package/test/store.test.ts

@@ -1,192 +0,0 @@
-import assert from "node:assert/strict";
-import {
-  existsSync,
-  mkdirSync,
-  mkdtempSync,
-  readFileSync,
-  readdirSync,
-  rmSync,
-  writeFileSync,
-} from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import test from "node:test";
-
-import {
-  createStore,
-  getStoreDiagnostics,
-  resetStoreStateForTests,
-  STORE_SCHEMA_VERSION,
-} from "../src/store.ts";
-
-let configHome: string;
-let previousConfigHome: string | undefined;
-
-const bridgeDir = (): string => join(configHome, "gentle-shell-bridge");
-const storePath = (pluginId: string): string => join(bridgeDir(), `${pluginId}.json`);
-
-test.beforeEach(() => {
-  configHome = mkdtempSync(join(tmpdir(), "gsb-store-"));
-  previousConfigHome = process.env.GENTLE_PI_CONFIG_HOME;
-  process.env.GENTLE_PI_CONFIG_HOME = configHome;
-  resetStoreStateForTests();
-});
-
-test.afterEach(() => {
-  if (previousConfigHome === undefined) delete process.env.GENTLE_PI_CONFIG_HOME;
-  else process.env.GENTLE_PI_CONFIG_HOME = previousConfigHome;
-  rmSync(configHome, { recursive: true, force: true });
-});
-
-test("round-trips a value through a namespaced file", () => {
-  const store = createStore("loon");
-
-  assert.equal(store.get("bannerSource", "activity"), "activity");
-  assert.equal(store.path, storePath("loon"));
-
-  store.set("bannerSource", "output");
-
-  assert.equal(store.get("bannerSource", "activity"), "output");
-  const document = JSON.parse(readFileSync(storePath("loon"), "utf8"));
-  assert.equal(document.schemaVersion, STORE_SCHEMA_VERSION);
-  assert.equal(document.schemaVersion, 1);
-  assert.deepEqual(document.values, { bannerSource: "output" });
-});
-
-test("a second store instance reads what the first wrote", () => {
-  createStore("loon").set("bannerSource", "output");
-
-  assert.equal(createStore("loon").get("bannerSource", "activity"), "output");
-});
-
-test("a missing file reads the caller's default and creates nothing", () => {
-  const store = createStore("loon");
-
-  assert.equal(store.get("bannerSource", "activity"), "activity");
-  assert.deepEqual(getStoreDiagnostics(), [], "a missing file is not a problem to report");
-  assert.equal(existsSync(bridgeDir()), false, "reading must not create the bridge directory");
-});
-
-test("malformed JSON reads the default, is reported, and is left untouched", () => {
-  mkdirSync(bridgeDir(), { recursive: true });
-  writeFileSync(storePath("loon"), "{ not json", "utf8");
-
-  const store = createStore("loon");
-
-  assert.equal(store.get("bannerSource", "activity"), "activity");
-  const problems = getStoreDiagnostics();
-  assert.equal(problems.length, 1);
-  assert.equal(problems[0].pluginId, "loon");
-  assert.equal(problems[0].kind, "invalid-json");
-  assert.equal(problems[0].path, storePath("loon"));
-  assert.equal(
-    readFileSync(storePath("loon"), "utf8"),
-    "{ not json",
-    "the malformed file is neither repaired nor deleted",
-  );
-});
-
-test("a later set after a malformed file writes a valid document", () => {
-  mkdirSync(bridgeDir(), { recursive: true });
-  writeFileSync(storePath("loon"), "{ not json", "utf8");
-  const store = createStore("loon");
-
-  store.set("bannerSource", "output");
-
-  const document = JSON.parse(readFileSync(storePath("loon"), "utf8"));
-  assert.equal(document.schemaVersion, 1);
-  assert.deepEqual(document.values, { bannerSource: "output" });
-  assert.equal(store.get("bannerSource", "activity"), "output");
-  assert.deepEqual(getStoreDiagnostics(), [], "a valid write clears that plugin's problem");
-});
-
-test("a document that is not an object reads the default and is reported", () => {
-  mkdirSync(bridgeDir(), { recursive: true });
-  writeFileSync(storePath("loon"), "[1,2,3]", "utf8");
-
-  const store = createStore("loon");
-
-  assert.equal(store.get("bannerSource", "activity"), "activity");
-  assert.equal(getStoreDiagnostics()[0]?.kind, "not-an-object");
-});
-
-test("an unknown schemaVersion reads the default and is reported", () => {
-  mkdirSync(bridgeDir(), { recursive: true });
-  writeFileSync(
-    storePath("loon"),
-    JSON.stringify({ schemaVersion: 99, values: { keep: "me" }, extraTopLevel: true }),
-    "utf8",
-  );
-
-  const store = createStore("loon");
-
-  assert.equal(store.get("bannerSource", "activity"), "activity");
-  assert.equal(getStoreDiagnostics()[0]?.kind, "unsupported-schema-version");
-});
-
-test("a later set after an unknown schemaVersion writes only the caller's keys and reports the discarded payload", () => {
-  mkdirSync(bridgeDir(), { recursive: true });
-  writeFileSync(
-    storePath("loon"),
-    JSON.stringify({ schemaVersion: 99, values: { keep: "me" }, extraTopLevel: true }),
-    "utf8",
-  );
-  const store = createStore("loon");
-
-  store.set("added", 1);
-
-  const document = JSON.parse(readFileSync(storePath("loon"), "utf8"));
-  assert.equal(document.schemaVersion, 1);
-  assert.deepEqual(
-    document.values,
-    { added: 1 },
-    "a future schema's payload is never re-labelled as schema 1",
-  );
-  assert.equal(
-    "extraTopLevel" in document,
-    false,
-    "keys the bridge does not understand are not carried into the valid document",
-  );
-  const problem = getStoreDiagnostics()[0];
-  assert.equal(problem?.kind, "unsupported-schema-version");
-  assert.match(problem?.message ?? "", /discarded/);
-});
-
-test("writes are atomic: the temp file is gone and the target parses completely", () => {
-  const store = createStore("loon");
-
-  for (let index = 0; index < 5; index += 1) {
-    store.set("counter", index);
-    assert.deepEqual(readdirSync(bridgeDir()), ["loon.json"], `no temp file after write ${index}`);
-    assert.equal(JSON.parse(readFileSync(storePath("loon"), "utf8")).values.counter, index);
-  }
-});
-
-test("two plugin ids never touch each other's file", () => {
-  const loon = createStore("loon");
-  const card = createStore("cards");
-
-  loon.set("bannerSource", "output");
-  card.set("style", "rounded");
-
-  assert.deepEqual(readdirSync(bridgeDir()).sort(), ["cards.json", "loon.json"]);
-  assert.equal(loon.get("style", "none"), "none");
-  assert.equal(card.get("bannerSource", "none"), "none");
-  assert.equal(loon.get("bannerSource", "activity"), "output");
-  assert.equal(card.get("style", "plain"), "rounded");
-});
-
-test("invalid plugin ids are rejected before any filesystem access", () => {
-  const invalidIds = ["", ".", "..", "../escape", "a/b", "a\\b", "nested/../escape", "loon..v2"];
-
-  for (const pluginId of invalidIds) {
-    assert.throws(
-      () => createStore(pluginId),
-      /invalid plugin id/,
-      `plugin id ${JSON.stringify(pluginId)} must be rejected`,
-    );
-  }
-
-  assert.equal(existsSync(bridgeDir()), false, "rejection happens before the directory is created");
-  assert.equal(existsSync(join(configHome, "escape.json")), false, "nothing escaped the bridge dir");
-});