3.2 KiB
3.2 KiB
Frontend UI
Authority: .agents/skills/archie-web-ui (stack facts, design-system rules,
tone and accessibility). This page covers what a change must reach, not how it
should look.
Adding or changing a feature
- The feature lives in
ui/src/<feature>/. Move a helper toui/src/base/only when a second feature needs it. - Keep wire shapes, draft state and payload building in a plain
.tsmodule beside the components (ui/src/bindings/binding-draft.tsis the pattern), and test it inui/test/*.test.ts. Components stay thin. - Every mutation goes through
api.*inui/src/lib/api, which sends the CSRF and Content-Type headers the server's mutation guard requires. A barefetchis refused. - A value the server also describes (task statuses, actions, workflow inputs)
comes from the server. Keep a local default only so the first render works,
and keep it in step (
ui/src/lib/task-meta.ts). - Run
task ui,task test:uiandcd ui && npm run typecheck. Commit the regeneratedui/dist/; the Go binaries embed it. A fresh git worktree has no ignoredui/node_modules: runcd ui && npm cibefore these commands. - One long-lived browser connection:
ui/src/lib/api.tshas the onlynew EventSource, owned bystores/live-updates.ts. Feature stores consume topics withlive.subscribe(topic, callback); do not open a page-owned SSE stream. Logs alone opt in while mounted, replacing that same EventSource with?topics=logs&since=<last cursor>; a browser'sLast-Event-IDonly survives its own automatic reconnect, not a newly constructed EventSource. Task and log topics resume by cursor; control-plane, identity and apply-status topics replay the latest snapshot. Test a fetch and same-origin navigation after visiting Settings and Logs: the UI process serves HTTP/1.1 and six persistent streams can starve every later browser request.
Adding an API route
- The handler goes in the
internal/webui/api_<concern>.gofile for its concern. Check the request fully on the server; the UI's checks are only a convenience. - A mutation calls
authorizeTaskMutationfirst. - A route whose store is not configured answers 503, and
internal/app/archieui/degraded_routes_test.gopins what each route returns without its contract. Add the route there. - The dashboard runs in its own process (
archie-ui) and must not link the daemon or the workflow engine (cmd/archie-ui/architecture_test.go). Reach stored data throughstorecontractinterfaces wired ininternal/app/archieui/compose.go. - Settings that live in a control-plane resource need no new route: the Advanced settings page edits every resource from its generated schema.
- For a new live topic, add one process-wide producer to
internal/webui'sRunLiveand fan it through the/api/streamhub;internal/app/archieui/run.gostarts the producers with the process context. Never create an upstream watch or poller in an HTTP handler. A slow client must reconnect for cursor and snapshot repair rather than silently lose an update. Prove the producer with several browser clients against the real peer, not just a scripted stream;live_hub_test.gois the example.