Files
PaperClipAI/ui/storybook/support/capability-gaps/api.test.ts
T
DottaandPaperclip c8efdbfba4 test(storybook): add production examples for feature map UI gaps (#16196)
## Thinking Path

> - Paperclip manages AI agents and their work.
> - The feature map records the user-facing capabilities.
> - Storybook uses the same feature index.
> - Step 2 found 49 UI capabilities with no authored examples.
> - This pull request adds shipped-component examples with isolated
fixtures.
> - The catalog records each example's states and remaining production
checks.

## Linked Issues or Issue Description

Refs: #16167. The verification inventory is merged; this follow-up now
targets master.

## What Changed

- Add 37 suites and 257 scenarios for all 49 UI capabilities from the
step-2 inventory. Keep existing stories and IDs.
- Use shipped pages and components. Simulate API replies, sockets,
props, and callbacks at their boundaries.
- Activate story API fixtures before the application providers read
data. Block unregistered API mutations and restore owned storage/fetch
state.
- Add browser checks for rendering, declared play assertions, fixture
reset, and selected mobile/theme states. Update the catalog and
verification inventory.

## Verification

- `pnpm -r typecheck`: passed.
- `pnpm build`: passed.
- UI Vitest suite: 730 files and 8,208 tests passed. Fixture boundary
tests: 4 passed.
- Map/catalog checks, 27 generator/map tests, and token gates: passed.
- `pnpm build-storybook`: passed. All 2,248 previous built entry IDs
remain present.
- Pre-reconciliation static browser suite: 260 checks passed (257
scenarios, token fixture reset, and two mobile/theme cases). All
non-play stories assert an explicit subject state; 129 play functions
passed.
- `pnpm test:run` could not complete on this Mac. Embedded PostgreSQL
exhausted host shared-memory allocation. The run also reported
native-runner test timeouts. Only this task's verified runner was
stopped; other jobs and host settings were preserved.
- Reconciled onto merged master `252d9b5077`. The six draft stories and
new same-browser reset regression passed (7 checks); 16
draft-persistence tests and UI typecheck passed. Static merge
verification: 32 affected-subject/draft checks passed, including
same-browser reset. Rebuilt Storybook retains all 2,248 original IDs in
its 2,517-entry index. Four additional play-result checks passed:
visible onboarding reset, pending probe, filtered-empty runs, and
optimistic queued-response removal. UI typecheck and 27 catalog/map
tests also passed. Final static browser suite on
`3fab35df8d912935fa86ce0de7d32d07e2b5f4c3`: all 261 checks passed (257
scenarios plus fixture-reset and mobile checks). Latest head
`3fab35df8d912935fa86ce0de7d32d07e2b5f4c3`: all 55 CI/status checks
passed; the two optional Storybook workflow jobs were skipped. Greptile
5/5 with no unresolved threads.
- No pinned Linux visual-baseline comparison or real provider journey is
claimed.

## Risks

Fixtures can drift from production contracts. The catalog records
inspected sources and their fingerprints. Capability links provide
initial isolated UI coverage; they do not certify every recipe variant,
real permissions, persistence, or provider behavior.

The new examples expose existing UI limits. Plugin discovery failure
stays on Loading. Document and environment-list reads lack dedicated
failure feedback; Cases and Inbox fall back to empty views after errors.
Goal alignment has display views but no assignment control. These
findings remain visible in the inventory.

## Model Used

OpenAI GPT-6 via Codex. The exact runtime deployment ID and context
window are not exposed in this session. Used code generation, shell
execution, and browser verification.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-13 13:24:09 -05:00

87 lines
3.0 KiB
TypeScript

// @vitest-environment jsdom
import { afterEach, describe, expect, it, vi } from "vitest";
import {
installFixtureApi,
prepareFixtureApi,
activatePreparedFixtures,
} from "./api";
let cleanup: (() => void) | undefined;
afterEach(() => {
cleanup?.();
cleanup = undefined;
vi.restoreAllMocks();
vi.unstubAllGlobals();
localStorage.clear();
});
describe("capability story API boundary", () => {
it("activates story routes after preview defaults and restores those defaults", async () => {
const preview = vi.fn(async () => Response.json({ source: "preview" }));
const fixture = prepareFixtureApi([
{ path: "/api/subject", read: () => ({ source: "story" }) },
]);
cleanup = fixture.cleanup;
vi.stubGlobal("fetch", preview);
activatePreparedFixtures();
expect(await (await window.fetch("/api/subject")).json()).toEqual({
source: "story",
});
expect(await (await window.fetch("/api/other")).json()).toEqual({
source: "preview",
});
fixture.cleanup();
cleanup = undefined;
expect(window.fetch).toBe(preview);
});
it("blocks an unregistered mutation without calling the outer fetch", async () => {
const outer = vi
.spyOn(window, "fetch")
.mockResolvedValue(Response.json({ unexpected: true }));
cleanup = installFixtureApi([]).cleanup;
const reply = await window.fetch("/api/companies/company-storybook", {
method: "PATCH",
body: "{}",
});
expect(reply.status).toBe(501);
expect(outer).not.toHaveBeenCalled();
});
it("parses Request bodies and records the mutation before a simulated denial", async () => {
const handler = vi.fn(() => ({ saved: true }));
const fixture = installFixtureApi(
[{ path: "/api/example", method: "POST", read: handler }],
"mutation-permission",
);
cleanup = fixture.cleanup;
const result = await window.fetch(
new Request(`${location.origin}/api/example`, {
method: "POST",
body: JSON.stringify({ value: 42 }),
}),
);
expect(result.status).toBe(403);
expect(fixture.requests[0].body).toEqual({ value: 42 });
expect(handler).not.toHaveBeenCalled();
});
it("keeps prerequisite flags available during a subject error and restores fetch and company selection", async () => {
const previous = window.fetch;
localStorage.setItem("paperclip.selectedCompanyId", "original-company");
const fixture = installFixtureApi(
[
{ path: "/api/flags", state: "ready", read: () => ({ enabled: true }) },
{ path: "/api/subject", read: () => [] },
],
"failure",
);
cleanup = fixture.cleanup;
expect(await (await window.fetch("/api/flags")).json()).toEqual({
enabled: true,
});
expect((await window.fetch("/api/subject")).status).toBe(500);
fixture.cleanup();
cleanup = undefined;
expect(window.fetch).toBe(previous);
expect(localStorage.getItem("paperclip.selectedCompanyId")).toBe(
"original-company",
);
});
});