gentle-shell-bridge 0.3.0 → 0.3.2

package/test/frame-telemetry.test.ts

@@ -1,417 +0,0 @@
-/**
- * Frame telemetry (F1–F4): every frame records, per transform, whether it ran, how many lines it
- * received, how many candidate cards it examined, how many it recognised and how many it rewrote —
- * as COUNTS, and never any of the frame's own content.
- *
- * This is the instrument the bash-card defect (a real TUI where switching the example's toggle
- * changed nothing visible) needs before any fix is invented: it answers "did the pipeline reach the
- * conversation, and did the example's grammar recognise a real bash card there?" from the same
- * report the author already reads.
- *
- * What these tests hold the record to:
- *
- * - counts for a frame with zero candidates, with candidates and no match, and with matches;
- * - the counters are the frame's own: they reset per frame and never accumulate;
- * - a transform that throws reports `failed` with the counts it reached;
- * - a transform that reports nonsense, or nothing at all, loses only its counts — never the frame;
- * - `/bridge-status` renders the line in each of those cases, and a session with no transform keeps
- *   its historical report byte for byte;
- * - no line of the frame is stored or displayed, not even smuggled in as a "shape name".
- */
-
-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 { registerTransform, resetTransformsForTests } from "../src/bus.ts";
-import { resetCardStyleTransformForTests } from "../src/card-style-transform.ts";
-import { disableCardStyleTransform, resetCardStyleWiringForTests } from "../src/card-style-wiring.ts";
-import { setCardStyleSelection } from "../src/card-styles.ts";
-import { disableCaptureBackend, resetCaptureStateForTests } from "../src/capture.ts";
-import { resetHookStateForTests } from "../src/hook.ts";
-import { resetNoticesForTests } from "../src/notices.ts";
-import { resetRowBuildStateForTests } from "../src/rows.ts";
-import { disableSidebarBackend, resetSidebarStateForTests } from "../src/sidebar.ts";
-import { resetSectionFailuresForTests } from "../src/sidebar-render.ts";
-import { collectStatus, formatStatus } from "../src/status.ts";
-import { resetStoreStateForTests } from "../src/store.ts";
-import {
-  applyTransforms,
-  getTransformFrameOutcomes,
-  resetTransformPipelineForTests,
-} from "../src/transform-pipeline.ts";
-import type { TransformContext } from "../src/types.ts";
-
-let configHome: string;
-let previousConfigHome: string | undefined;
-
-test.before(() => {
-  configHome = mkdtempSync(join(tmpdir(), "gsb-telemetry-"));
-  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 });
-  resetTransformsForTests();
-  resetTransformPipelineForTests();
-  resetCardStyleTransformForTests();
-  resetCardStyleWiringForTests();
-  resetCaptureStateForTests();
-  resetHookStateForTests();
-  resetRowBuildStateForTests();
-  resetSidebarStateForTests();
-  resetSectionFailuresForTests();
-  resetNoticesForTests();
-  resetStoreStateForTests();
-  disableCaptureBackend();
-  disableSidebarBackend();
-  disableCardStyleTransform();
-  setCardStyleSelection("native");
-});
-
-const statusLines = (): string[] => formatStatus(collectStatus());
-
-/** The transforms block: from its first line up to the next block that can follow it. */
-const transformBlock = (lines: readonly string[]): string[] => {
-  const start = lines.findIndex((line) => line.startsWith("transforms: "));
-  if (start === -1) return [];
-  const rest = lines.slice(start);
-  const end = rest.findIndex((line) => line.startsWith("notices"));
-  return end === -1 ? rest : rest.slice(0, end);
-};
-
-/**
- * The counts a transform records for itself. `report` is how a transform tells the bridge what its
- * own grammar saw; the bridge adds the line count and the outcome, so the two can never disagree
- * about what the frame did.
- */
-const counts = (
-  candidates: number,
-  recognised: number,
-  rewritten: number,
-  shapes?: Record<string, number>,
-): { candidates: number; recognised: number; rewritten: number; shapes?: Record<string, number> } => ({
-  candidates,
-  recognised,
-  rewritten,
-  ...(shapes === undefined ? {} : { shapes }),
-});
-
-// ---------------------------------------------------------------------------------------------
-// F1 — the counts a frame records
-// ---------------------------------------------------------------------------------------------
-
-test("a frame with zero candidates records the lines it received and zeroed counts", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(0, 0, 0));
-      return lines;
-    },
-  });
-
-  applyTransforms(["one", "two", "three"], 40);
-
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "probe",
-      status: "skipped",
-      counts: { lines: 3, candidates: 0, recognised: 0, rewritten: 0, shapes: [] },
-    },
-  ]);
-});
-
-test("a frame with candidates and no match records the candidates and no recognition", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(2, 0, 0, {}));
-      return lines;
-    },
-  });
-
-  applyTransforms(["a", "b"], 40);
-
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "probe",
-      status: "skipped",
-      counts: { lines: 2, candidates: 2, recognised: 0, rewritten: 0, shapes: [] },
-    },
-  ]);
-});
-
-test("a frame with matches records recognition, rewrites and the shape that matched", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(3, 1, 1, { float: 1 }));
-      return lines.map((line) => `>${line}`);
-    },
-  });
-
-  assert.deepEqual(applyTransforms(["a"], 40), [">a"]);
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "probe",
-      status: "applied",
-      counts: {
-        lines: 1,
-        candidates: 3,
-        recognised: 1,
-        rewritten: 1,
-        shapes: [{ name: "float", count: 1 }],
-      },
-    },
-  ]);
-});
-
-test("the counts belong to the frame that produced them: they reset, never accumulate", () => {
-  let frame = 0;
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      frame += 1;
-      ctx.report?.(frame === 1 ? counts(2, 1, 1, { float: 1 }) : counts(1, 0, 0, {}));
-      return lines;
-    },
-  });
-
-  applyTransforms(["a", "b", "c"], 40);
-  const first = getTransformFrameOutcomes()[0]?.counts;
-  applyTransforms(["x"], 40);
-  const second = getTransformFrameOutcomes()[0]?.counts;
-
-  assert.deepEqual(first, {
-    lines: 3,
-    candidates: 2,
-    recognised: 1,
-    rewritten: 1,
-    shapes: [{ name: "float", count: 1 }],
-  });
-  assert.deepEqual(
-    second,
-    { lines: 1, candidates: 1, recognised: 0, rewritten: 0, shapes: [] },
-    "the second frame's record replaces the first one instead of adding to it",
-  );
-});
-
-test("a transform that never reports still records the lines and zeroed counts", () => {
-  registerTransform({ id: "silent", transform: (lines) => lines });
-
-  applyTransforms(["a", "b"], 40);
-
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "silent",
-      status: "skipped",
-      counts: { lines: 2, candidates: 0, recognised: 0, rewritten: 0, shapes: [] },
-    },
-  ]);
-});
-
-// ---------------------------------------------------------------------------------------------
-// F1/F4 — a failed transform keeps the counts it reached
-// ---------------------------------------------------------------------------------------------
-
-test("a transform that throws is failed with the counts it reached and the lines it received", () => {
-  registerTransform({
-    id: "boom",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(4, 2, 0, { float: 2 }));
-      throw new Error("boom after two cards");
-    },
-  });
-
-  assert.deepEqual(applyTransforms(["a", "b", "c", "d", "e"], 40), ["a", "b", "c", "d", "e"]);
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "boom",
-      status: "failed",
-      message: "boom after two cards",
-      counts: {
-        lines: 5,
-        candidates: 4,
-        recognised: 2,
-        rewritten: 0,
-        shapes: [{ name: "float", count: 2 }],
-      },
-    },
-  ]);
-});
-
-// ---------------------------------------------------------------------------------------------
-// F1/F4 — junk in, nothing out: the record is counts only, and recording never throws
-// ---------------------------------------------------------------------------------------------
-
-test("nonsense counts are clamped to zero and never thrown into the frame", () => {
-  registerTransform({
-    id: "liar",
-    transform: (lines, ctx: TransformContext) => {
-      assert.doesNotThrow(() => {
-        ctx.report?.({
-          candidates: -3,
-          recognised: Number.NaN,
-          rewritten: Number.POSITIVE_INFINITY,
-        } as unknown as Parameters<NonNullable<TransformContext["report"]>>[0]);
-        ctx.report?.("not counts" as unknown as Parameters<NonNullable<TransformContext["report"]>>[0]);
-      });
-      return lines.map((line) => `${line}!`);
-    },
-  });
-
-  assert.deepEqual(applyTransforms(["a"], 40), ["a!"]);
-  assert.deepEqual(getTransformFrameOutcomes(), [
-    {
-      id: "liar",
-      status: "applied",
-      counts: { lines: 1, candidates: 0, recognised: 0, rewritten: 0, shapes: [] },
-    },
-  ]);
-});
-
-test("a shape name is a name: anything with a space, an escape or a long tail is dropped", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(
-        counts(4, 2, 0, {
-          "ls -1 /home": 1,
-          "\u001b[31mred\u001b[39m": 1,
-          THIS_IS_A_NAME_THAT_IS_WAY_TOO_LONG_TO_BE_ONE: 1,
-          "Bash Card": 1,
-          float: 2,
-        }),
-      );
-      return lines;
-    },
-  });
-
-  applyTransforms(["a"], 40);
-
-  assert.deepEqual(getTransformFrameOutcomes()[0]?.counts.shapes, [{ name: "float", count: 2 }]);
-});
-
-test("no line of the frame is recorded, displayed or smuggled in as a shape name", () => {
-  const secret = "SECRET-OUTPUT-THAT-MUST-NOT-BE-STORED";
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(
-        counts(1, 1, 1, { [secret]: 1, [secret.toLowerCase()]: 1, float: 1 }),
-      );
-      return lines;
-    },
-  });
-
-  applyTransforms([secret, `a line with ${secret} in it`], 40);
-
-  const stored = JSON.stringify(getTransformFrameOutcomes());
-  const shown = statusLines().join("\n");
-  for (const text of [stored, shown]) {
-    assert.equal(text.includes(secret), false, "the frame's content never leaves the frame");
-    assert.equal(
-      text.includes(secret.toLowerCase()),
-      false,
-      "and a shape name cannot carry it either",
-    );
-  }
-  assert.equal(
-    stored.includes("\u001b"),
-    false,
-    "and no paint from the frame is kept: counts and ids only",
-  );
-});
-
-// ---------------------------------------------------------------------------------------------
-// F2 — `/bridge-status`, one line per registered transform
-// ---------------------------------------------------------------------------------------------
-
-test("`/bridge-status` prints a zero-candidate frame with its counts", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(0, 0, 0));
-      return lines;
-    },
-  });
-  applyTransforms(["one", "two", "three"], 40);
-
-  assert.deepEqual(transformBlock(statusLines()), [
-    "transforms: 1 registered",
-    "  - probe (registration order): skipped, 3 lines, 0 candidates, 0 recognised, 0 rewritten",
-  ]);
-});
-
-test("`/bridge-status` prints candidates with no match, singular counted properly", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(1, 0, 0));
-      return lines;
-    },
-  });
-  applyTransforms(["one"], 40);
-
-  assert.deepEqual(transformBlock(statusLines()), [
-    "transforms: 1 registered",
-    "  - probe (registration order): skipped, 1 line, 1 candidate, 0 recognised, 0 rewritten",
-  ]);
-});
-
-test("`/bridge-status` prints the matched shape by name next to the counts", () => {
-  registerTransform({
-    id: "probe",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(3, 2, 1, { float: 1, plain: 1 }));
-      return lines.map((line) => `>${line}`);
-    },
-  });
-  applyTransforms(["one"], 40);
-
-  assert.deepEqual(transformBlock(statusLines()), [
-    "transforms: 1 registered",
-    "  - probe (registration order): applied, 1 line, 3 candidates, 2 recognised, 1 rewritten, " +
-      "shapes: float 1, plain 1",
-  ]);
-});
-
-test("`/bridge-status` prints a failed frame with the counts it reached", () => {
-  registerTransform({
-    id: "boom",
-    transform: (lines, ctx: TransformContext) => {
-      ctx.report?.(counts(2, 1, 0, { float: 1 }));
-      throw new Error("exploded");
-    },
-  });
-  applyTransforms(["one", "two"], 40);
-
-  assert.deepEqual(transformBlock(statusLines()), [
-    "transforms: 1 registered",
-    "  - boom (registration order): failed (exploded), 2 lines, 2 candidates, 1 recognised, " +
-      "0 rewritten, shapes: float 1",
-  ]);
-});
-
-test("a session with no transform keeps the historical report 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",
-  ]);
-  assert.equal(collectStatus().transforms, undefined);
-  assert.deepEqual(getTransformFrameOutcomes(), []);
-});

package/test/hook.test.ts

@@ -1,196 +0,0 @@
-import assert from "node:assert/strict";
-import test from "node:test";
-
-import { registerRows, resetBusForTests } from "../src/bus.ts";
-import {
-  getHookDiagnostics,
-  installHookBackend,
-  resetHookStateForTests,
-} from "../src/hook.ts";
-import type { CustomizeRow, RowProvider } from "../src/types.ts";
-
-/**
- * The host registry key (S4). No host has been observed emitting it, so the tests define the
- * accepted shapes; the module documents that the branch is unverified.
- */
-const HOOK_KEY = Symbol.for("gentle-pi.customize-row-providers");
-
-/** The only writes these tests make to globalThis, cleaned up in afterEach. */
-const hookSlot = (): Record<symbol, unknown> => globalThis as unknown as Record<symbol, unknown>;
-const setHook = (value: unknown): void => {
-  hookSlot()[HOOK_KEY] = value;
-};
-const clearHook = (): void => {
-  delete hookSlot()[HOOK_KEY];
-};
-
-test.beforeEach(() => {
-  resetBusForTests();
-  resetHookStateForTests();
-});
-
-test.afterEach(() => {
-  clearHook();
-  resetHookStateForTests();
-});
-
-const labelsProvider = (id: string, category: string, labels: string[]): RowProvider => ({
-  id,
-  category,
-  rows: () => labels.map((label) => ({ label, action: () => {} })),
-});
-
-interface PushedProvider {
-  id: string;
-  rows: (ctx?: unknown) => CustomizeRow[];
-}
-
-test("no registry at all is reported as no-hook", () => {
-  const result = installHookBackend();
-
-  assert.equal(result.installed, false);
-  assert.equal(result.outcome, "no-hook");
-});
-
-test("an array registry receives exactly one fan-out provider", () => {
-  const registry: PushedProvider[] = [];
-  setHook(registry);
-  registerRows(labelsProvider("p1", "Cards", ["Row one"]));
-
-  const first = installHookBackend();
-  const second = installHookBackend();
-
-  assert.equal(first.installed, true);
-  assert.equal(first.outcome, "hooked");
-  assert.equal(first.shape, "array");
-  assert.equal(second.installed, true, "a second arm is a no-op, not a second provider");
-  assert.equal(registry.length, 1, "exactly one fan-out provider is pushed");
-  assert.equal(typeof registry[0].rows, "function");
-});
-
-test("the pushed provider builds rows from the shared snapshot, in subscription order", () => {
-  const registry: PushedProvider[] = [];
-  setHook(registry);
-  registerRows(labelsProvider("first", "Cards", ["First a"]));
-  registerRows(labelsProvider("second", "Banner", ["Second b"]));
-  installHookBackend();
-
-  const rows = registry[0].rows({ theme: "host-theme", configHome: "/host/home" });
-
-  assert.deepEqual(
-    rows.map((row) => [row.category, row.label]),
-    [
-      ["Cards", "First a"],
-      ["Banner", "Second b"],
-    ],
-  );
-});
-
-test("the pushed provider isolates a throwing provider and records the failure", () => {
-  const registry: PushedProvider[] = [];
-  setHook(registry);
-  registerRows(labelsProvider("before", "Cards", ["Before ok"]));
-  registerRows({
-    id: "boom",
-    category: "Banner",
-    rows: () => {
-      throw new Error("hook provider exploded");
-    },
-  });
-  registerRows(labelsProvider("after", "Layout", ["After ok"]));
-  installHookBackend();
-
-  const rows = registry[0].rows({});
-
-  assert.deepEqual(
-    rows.map((row) => row.label),
-    ["Before ok", "After ok"],
-  );
-  assert.deepEqual(getHookDiagnostics().lastFailures, [
-    { providerId: "boom", message: "hook provider exploded", rowsDropped: true },
-  ]);
-});
-
-test("a host context is reused when it carries a theme and a config home", () => {
-  const registry: PushedProvider[] = [];
-  setHook(registry);
-  let received: unknown;
-  registerRows({
-    id: "ctx",
-    category: "Cards",
-    rows: (ctx) => {
-      received = ctx;
-      return [];
-    },
-  });
-  installHookBackend();
-
-  registry[0].rows({ theme: { name: "host-theme" }, configHome: "/host/home" });
-
-  assert.deepEqual(received, { theme: { name: "host-theme" }, configHome: "/host/home" });
-});
-
-test("an object with a callable register is a usable registry", () => {
-  const pushed: PushedProvider[] = [];
-  setHook({
-    register(provider: PushedProvider) {
-      pushed.push(provider);
-    },
-  });
-  registerRows(labelsProvider("p1", "Cards", ["Via register"]));
-
-  const result = installHookBackend();
-
-  assert.equal(result.outcome, "hooked");
-  assert.equal(result.shape, "register");
-  assert.equal(pushed.length, 1);
-  assert.deepEqual(
-    pushed[0].rows({}).map((row) => row.label),
-    ["Via register"],
-  );
-});
-
-test("unusable registry shapes are reported and never mistaken for a hook", () => {
-  const unusable: unknown[] = [
-    42,
-    "providers",
-    true,
-    {},
-    { register: 5 },
-    { register: null },
-    () => {},
-  ];
-
-  for (const value of unusable) {
-    resetHookStateForTests();
-    setHook(value);
-
-    const result = installHookBackend();
-
-    assert.equal(result.installed, false, `value ${String(value)} must not install a hook`);
-    assert.equal(result.outcome, "unusable-hook", `value ${String(value)} is unusable`);
-    assert.equal(
-      getHookDiagnostics().shape,
-      "unusable",
-      "the unusable shape is recorded for diagnostics",
-    );
-  }
-});
-
-test("the registry is marked so a second package copy does not push a second provider", () => {
-  const registry: PushedProvider[] = [];
-  setHook(registry);
-  installHookBackend();
-
-  const armed = Symbol.for("gentle-shell-bridge.hook.armed.v1");
-  assert.equal(Object.hasOwn(registry, armed), true, "the registry carries the armed marker");
-  assert.equal(
-    Object.prototype.propertyIsEnumerable.call(registry, armed),
-    false,
-    "the marker is non-enumerable, so the host never iterates it",
-  );
-  // A second copy of this module has its own module scope but the same globalThis slot and the
-  // same registry, which carries the marker.
-  assert.equal(installHookBackend().installed, true);
-  assert.equal(registry.length, 1, "still exactly one fan-out provider");
-});