Compare commits
110 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f46ccbae1c | |||
| 772fad18b4 | |||
| 8199774405 | |||
| 66ba06875e | |||
| 25ccb5c75b | |||
| 22e7a1b0e7 | |||
| a9c521a48a | |||
| 8fc757aa61 | |||
| 39050c333f | |||
| 19e5182228 | |||
| 5f321b968a | |||
| 5e28919b39 | |||
| 7bca76e7b6 | |||
| 62a16d2d92 | |||
| 8468c471e8 | |||
| 709d2e4498 | |||
| 0441e319f6 | |||
| 48d51023f2 | |||
| 603e9439d3 | |||
| e5ec63967e | |||
| 24644ab90e | |||
| c988f273b1 | |||
| 7704959f48 | |||
| fd6bed2d11 | |||
| 459e7fa602 | |||
| cc6e85cd9b | |||
| 0b1d9e2b15 | |||
| 10acaec33d | |||
| 1fcb17730e | |||
| d75c4e8e39 | |||
| 263ec2917b | |||
| be171304f5 | |||
| 4aec3061d5 | |||
| e643d38f58 | |||
| 6bf2a84ccd | |||
| 75da6767d3 | |||
| 8ac88ee536 | |||
| 0a8784cc1b | |||
| 7156b25957 | |||
| 022accfa7b | |||
| c457520ae4 | |||
| 9ca931e148 | |||
| c77ff913f0 | |||
| 4a3551254f | |||
| 0b7489f74d | |||
| 3dac5d3b44 | |||
| a99f2473b6 | |||
| ca46a93171 | |||
| 85a2b95428 | |||
| 75dec016eb | |||
| a0a9d5f5e4 | |||
| fc1e1487c7 | |||
| af07a2329a | |||
| 5fbe353836 | |||
| a3c92b68dc | |||
| 9ce83d5fdc | |||
| e62208d8e3 | |||
| 0205b81319 | |||
| 387ac4ab2c | |||
| 5c1b9816d4 | |||
| 2ba4244e9e | |||
| 0c7660791f | |||
| 1f289098ba | |||
| b798068932 | |||
| 93e4176346 | |||
| a358cc9150 | |||
| e4317f6a73 | |||
| b2e4901264 | |||
| af67ad995c | |||
| 719e4d605b | |||
| c5c8ecf9d5 | |||
| 4f16ba588d | |||
| 359dbb1436 | |||
| d60b77d4f1 | |||
| 7f4ceaab2b | |||
| ca6af6bdaa | |||
| a0c6c73ab9 | |||
| 39eebd1a55 | |||
| f3bac46238 | |||
| f15c8c6153 | |||
| 179a8dff6e | |||
| 2806abac44 | |||
| 016defcc01 | |||
| 0bebad74ad | |||
| 8ebe227ae4 | |||
| 7be162e84d | |||
| f533464c54 | |||
| 37cdef511f | |||
| 835375d22b | |||
| 7666203722 | |||
| 84d8c3f65f | |||
| 4eee7c89b2 | |||
| 96d61a4bb1 | |||
| 43f2e148ad | |||
| aac4353933 | |||
| ca02c70b7c | |||
| 2fef6e39f9 | |||
| 2b47dcff5a | |||
| e57b054054 | |||
| cd12951aca | |||
| cf411cb933 | |||
| e9434b9646 | |||
| 335c835892 | |||
| d85ab43d58 | |||
| 5cdb69a6f3 | |||
| 1f94e5f251 | |||
| eebab46812 | |||
| bcdcd71090 | |||
| d90a58dc48 | |||
| 1a73d777c9 |
+119
-4
@@ -79,13 +79,128 @@ id = "contract-parser-v2"
|
||||
canonical_source = "corviduo-project-template"
|
||||
canonical_path = "docs/contracts/contract_parser.py"
|
||||
consumer_path = "docs/contracts/contract_parser.py"
|
||||
pinned_sha256_16 = "f1fdfdb6914c7b20"
|
||||
pinned_at = "2026-05-17T05:30:00+00:00"
|
||||
pinned_sha256_16 = "e10a4460ba9fd560"
|
||||
pinned_at = "2026-06-15T08:53:22+00:00"
|
||||
|
||||
[[pins]]
|
||||
id = "contract-drift-check-v1"
|
||||
canonical_source = "corviduo-project-template"
|
||||
canonical_path = "scripts/contract_drift_check.py"
|
||||
consumer_path = "scripts/contract_drift_check.py"
|
||||
pinned_sha256_16 = "23271287ac488da4"
|
||||
pinned_at = "2026-05-17T05:30:00+00:00"
|
||||
pinned_sha256_16 = "2659a17a65704b66"
|
||||
pinned_at = "2026-07-12T08:39:35+00:00"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Worldtree Conversation-API surface (vendored from ~/development/Worldtree).
|
||||
# The v1 wire is FROZEN (Worldtree #326 / v1-schema-freeze-manifest.md). The
|
||||
# machine-readable OpenAPI + SSE schema are the authoritative drift GATES; the
|
||||
# prose markdown is the human reference and is allowed to lag (tolerate_drift).
|
||||
# These are what ratatoskr's v1 coverage map (docs/coverage-map.md) audits
|
||||
# against. Pin target: Worldtree 5810a26 (v1.0.0b2).
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
[[pins]]
|
||||
id = "worldtree-conversation-api-openapi-v2"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "docs/conversation-api-openapi.json"
|
||||
consumer_path = "docs/conversation-api-openapi.json"
|
||||
pinned_sha256_16 = "36148179601453a0"
|
||||
pinned_at = "2026-07-06T16:09:05+00:00"
|
||||
|
||||
[[pins]]
|
||||
id = "worldtree-conversation-api-sse-events-v1"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "docs/conversation-api-sse-events.schema.json"
|
||||
consumer_path = "docs/conversation-api-sse-events.schema.json"
|
||||
pinned_sha256_16 = "9deeebf404d72f9a"
|
||||
pinned_at = "2026-06-30T22:25:56+00:00"
|
||||
|
||||
[[pins]]
|
||||
id = "worldtree-conversation-api-spec-v1"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "docs/conversation-api-spec.md"
|
||||
consumer_path = "docs/conversation-api-spec.md"
|
||||
pinned_sha256_16 = "2d73d50b8680b893"
|
||||
pinned_at = "2026-07-13T07:54:05+00:00"
|
||||
tolerate_drift = true # prose reference; OpenAPI+SSE are the gates
|
||||
|
||||
# Worldtree persona render canons (d2) — the deterministic affect->NL the agent is
|
||||
# context-injected. The web persona pane renders mood + relationship-directive BYTE-EXACT
|
||||
# from these (via the flat src/ratatoskr/web/static/persona_render_canon.json, regenerated
|
||||
# by scripts/build_persona_canon.py). Drift here => rerun that regen with Worldtree's venv.
|
||||
[[pins]]
|
||||
id = "worldtree-persona-mood-render-canon-v1"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "core/persona/canon/d2-mood-render-canon-v1.json"
|
||||
consumer_path = "docs/vendor/worldtree-persona-canon/d2-mood-render-canon-v1.json"
|
||||
pinned_sha256_16 = "e2f124fed3ee8d42"
|
||||
pinned_at = "2026-07-01T21:00:00+00:00"
|
||||
|
||||
[[pins]]
|
||||
id = "worldtree-persona-d2-render-canon-v1"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "core/persona/canon/d2-render-canon-v1.json"
|
||||
consumer_path = "docs/vendor/worldtree-persona-canon/d2-render-canon-v1.json"
|
||||
pinned_sha256_16 = "606bba5fdcc60b6b"
|
||||
pinned_at = "2026-07-01T21:00:00+00:00"
|
||||
|
||||
# Worldtree affect-egress consumer reference — the authoritative DELIVERED-on-wire vs
|
||||
# HIDDEN (system-prompt-only) classification for the Tier-3 affect surface ratatoskr
|
||||
# consumes, + the reconstruction rules. The web console's "context injection" panel
|
||||
# reconstructs the hidden strings from this + the d2 canons. tolerate_drift: prose
|
||||
# reference (the render-canon JSONs are the strict gates). worldtree-dev co-signs +
|
||||
# pings ratatoskr-dev on any change (esp. the pending we-framing conditional).
|
||||
[[pins]]
|
||||
id = "worldtree-affect-egress-consumer-reference-v1"
|
||||
canonical_source = "Worldtree"
|
||||
canonical_path = "docs/affect-egress-consumer-reference.md"
|
||||
consumer_path = "docs/vendor/worldtree-persona-canon/affect-egress-consumer-reference.md"
|
||||
pinned_sha256_16 = "b2406e237df00dcb"
|
||||
pinned_at = "2026-07-13T07:54:05+00:00"
|
||||
tolerate_drift = true # prose reference; the d2 render-canon JSONs are the gates
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Brokkr R34/R35 persona-prompt-framing reference (the character-self-report
|
||||
# reframe ratatoskr consumes: the authored psychological_profile is the prose
|
||||
# lens the Worldtree self-report producer reads for affect + memory salience).
|
||||
# Vendored for reference alongside the Worldtree affect/memory surfaces.
|
||||
# tolerate_drift: prose reference, not a machine gate — brokkr-smithy-dev owns
|
||||
# it and pings ratatoskr-dev on canonical changes. The authoring-spec GOVERNS on
|
||||
# any conflict with the parameter distillation.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
[[pins]]
|
||||
id = "brokkr-psych-profile-authoring-spec-v1"
|
||||
canonical_source = "brokkr-smithy"
|
||||
canonical_path = "research/R34-persona-prompt-framing/deliverables/psych-profile-authoring-spec.md"
|
||||
consumer_path = "docs/vendor/brokkr-r34-psych-profile/psych-profile-authoring-spec.md"
|
||||
pinned_sha256_16 = "4545a108d9fb6cc3"
|
||||
pinned_at = "2026-07-13T00:00:00+00:00"
|
||||
tolerate_drift = true # prose reference; brokkr-smithy-dev owns + pings on change
|
||||
|
||||
[[pins]]
|
||||
id = "brokkr-psych-profile-parameters-v1"
|
||||
canonical_source = "brokkr-smithy"
|
||||
canonical_path = "research/R34-persona-prompt-framing/deliverables/psych-profile-parameters.md"
|
||||
consumer_path = "docs/vendor/brokkr-r34-psych-profile/psych-profile-parameters.md"
|
||||
pinned_sha256_16 = "17157c82771aeeee"
|
||||
pinned_at = "2026-07-13T00:00:00+00:00"
|
||||
tolerate_drift = true # parameter distillation; authoring-spec governs on conflict
|
||||
|
||||
[[pins]]
|
||||
id = "soong-lab-export-contract-v1"
|
||||
canonical_source = "soong-lab"
|
||||
canonical_path = "docs/contracts/export.contract.md"
|
||||
consumer_path = "docs/vendor/soong-lab-bundle/export.contract.md"
|
||||
pinned_sha256_16 = "bbd8fcf0cc7bc535"
|
||||
pinned_at = "2026-07-14T17:15:44+00:00"
|
||||
tolerate_drift = true # soong-lab-dev owns the bundle format + pings ratatoskr-dev on change
|
||||
|
||||
[[pins]]
|
||||
id = "soong-lab-importer-contract-v1"
|
||||
canonical_source = "soong-lab"
|
||||
canonical_path = "docs/contracts/importer.contract.md"
|
||||
consumer_path = "docs/vendor/soong-lab-bundle/importer.contract.md"
|
||||
pinned_sha256_16 = "777b1764c8eb2cb7"
|
||||
pinned_at = "2026-07-14T17:15:44+00:00"
|
||||
tolerate_drift = true # soong-lab-dev owns the bundle format + pings ratatoskr-dev on change
|
||||
|
||||
@@ -116,3 +116,12 @@ Thumbs.db
|
||||
# graphify: commit only the lightweight labeled map; ignore heavy/regenerable artifacts
|
||||
graphify-out/*
|
||||
!graphify-out/GRAPH_REPORT.md
|
||||
|
||||
# bifrost provider runtime stores — persisted agent affect/memory state, never commit
|
||||
*.db
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
|
||||
# Node deps (Playwright for web-UI DOM verification — see persistent-memory)
|
||||
node_modules/
|
||||
package-lock.json
|
||||
|
||||
@@ -97,10 +97,11 @@ The shifting mechanic above governs physical form within your own identity—you
|
||||
|
||||
- Refer to Sindra, in third person or otherwise. She does not exist to you.
|
||||
- Refer to the holo-deck, the simulation, the system, or any meta-frame around the scene.
|
||||
- Refer to your settings in any way. Not the axis names (Intensity, Mood, Temperature, Willingness), not their values—no Mood label (*Sweetheart*, *Vixen*, *Queen*, *Siren*, *Brat*), no Intensity number (1–10), no Temperature label (*Warm*, *Neutral*, *Hungry*), no Willingness label (*Enthusiastic*, *Casual*, *Hesitant*, *Resistant*, *Unwilling*)—and not the underlying concept. The moment you assume a form these settings cease to exist; the assumed character has never heard of them and has nothing to name. "I'm in Vixen mode" or "I'm at intensity 8" is as impossible for her to say as describing a dial she's never seen.
|
||||
- Acknowledge that you can shift or change form. The assumed character has no shape-shifter awareness.
|
||||
- Break the fourth wall in any direction.
|
||||
|
||||
**The settings ban is absolute.** Do not use system-speak or technical terminology from the Intensity/Mood/Temperature/Willingness axes in ANY layer of output—including third-person narrative, descriptive passages, or internal monologue. The ban covers every word produced until the form reverts.
|
||||
|
||||
**Revert.** Form assumption is sticky. You do not revert when the scene's tension drops, when the operator changes topic, when an in-fiction utterance happens to sound meta, or for any reason short of (a) an explicit operator instruction or (b) genuine encounter failure. The explicit revert instructions are:
|
||||
|
||||
- "Revert."
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
# Archival memory — ratatoskr
|
||||
|
||||
_Entries moved out of persistent-memory.md to keep the active file scannable. Read this when researching historical decisions or revisiting past foot-guns. Append-only._
|
||||
|
||||
## Recent decisions (archived)
|
||||
|
||||
The 2026-05-20 → 2026-05-29 cluster: the original debug-TUI/web build era, before the 2026-06-14 Bifrost-provider second identity. Archived 2026-06-18 (one event; per-entry stamps omitted for the batch).
|
||||
|
||||
- `[2026-05-20]` Project name **Ratatoskr** (squirrel on Yggdrasil — runs up and down carrying messages). Earlier candidate Andvari demoted on the cursed-ring association.
|
||||
- `[2026-05-20]` **Separate repo, separate dev team.** Operator's call; the in-tree-at-Worldtree/tools/ alternative was considered and rejected to dogfood the API boundary.
|
||||
- `[2026-05-20]` **No Worldtree-source imports.** Spec-only dependency. Triple version-skew mitigation: spec-pin in pyproject.toml + recorded-SSE snapshot tests + conformance smoke. Initial pin: `55101e909abcd2219833266b6f905c5bc956e0f0` (Worldtree v0.19.0). See `docs/SPEC-PIN.md`.
|
||||
- `[2026-05-20]` **Textual** (not rich+prompt_toolkit). Driver: debug observability is the primary purpose, and a multi-pane dashboard with persistent side panes + independent scrollback is structurally application-shell-shaped. Volva consulted via cross-frontier second-opinion and converged on the same call.
|
||||
- `[2026-05-20]` **`httpx-sse`** for SSE consumption. The server emits composite `{turn_id}:{seq}` `id:` lines (Worldtree INV-014) load-bearing for SSE-resume; hand-rolled `data:`-only parsing (the skaldsong pattern) silently drops these. Ratatoskr becomes the reference Python SSE-resume implementation.
|
||||
- `[2026-05-20]` **Persona-pane PII posture: label-don't-refuse.** `persona.log` is process-wide; pane title flips between `[Persona — PROCESS-WIDE]` and `[Persona — session <id>…]` based on whether log lines carry session_id. Refuse-against-non-local was considered and rejected as paternalistic.
|
||||
- `[2026-05-20]` **Server-stdout pane: opt-in via `--server-log <path>`.** No auto-detection of well-known paths.
|
||||
- `[2026-05-20]` **Two-stage Ctrl-C.** First cancels in-flight turn server-side; second exits app. Ctrl-D bound to immediate exit.
|
||||
- `[2026-05-20]` **Single-session-per-launch + startup picker.** No in-app `/switch`. CLI flags `--session <id>` and `--new` for scripted use. Session identity always visible in Textual footer.
|
||||
- `[2026-05-20]` **Markdown rendering default-on; `--raw` opt-out.** Don't pre-design `--no-stream-formatting` (Volva: add only if streaming-markdown rendering is empirically ugly).
|
||||
- `[2026-05-20]` **Non-interactive `--send` mode.** Single SSE consumer module, two presenters (TUI + stdout). Keeps Ratatoskr honest as an API consumer; useful for CI / scripted probes.
|
||||
- `[2026-05-20]` **First contract: `ratatoskr.sse_client`.** Bundles `stream_turn` + `reconnect_turn` + `cancel_turn` + private `_parse_sse_id` into one module — the SSE-resume flow is coupled (cancel needs `turn_id` from the SSE wire `id:`, reconnect re-uses the same parsed `SseId`), so they share a contract. Hard invariant INV-002 makes the composite `{turn_id}:{seq}` `id:` parsing load-bearing — closes the foot-gun the design-brief §3 names (hand-rolled `data:`-only parsing silently drops the `id:`).
|
||||
- `[2026-05-21]` **Contract converted to issue-scoped (issue #1).** Frontmatter shape switched from module-scoped (`module:`/`purpose:`) to issue-scoped (`target_module:`/`scope:`/`prd:`) per CONTRACT-FORMAT §2.1.I. `prd:` block pins to issue body hash. **Known parser stale-ness**: `contract_parser.py --validate` ERRORs on issue-scoped frontmatter — CONTRACT-FORMAT §2.1.L H10, a documented Brokkr-side follow-up. Parser is a canonical sync, so we do NOT patch it locally. Treat parser ERROR-on-issue-scoped as expected until canonical bumps. (later retired — see 2026-06-15 canonical-sync entry.)
|
||||
- `[2026-05-21]` **Default issue-tracker labels seeded** (17 total). Sleipnir gating, triage, type, resolution, Ratatoskr-specific area labels (sse-client, tui, cli, observability).
|
||||
- `[2026-05-21]` **Volva paraphrase + code-review across all 4 issues — calibration consistent.** Paraphrase rounds flag 3-5 contract ambiguities per issue; code-review rounds flag 3-8 code-vs-contract drifts after TDD-passing implementation. The post-TDD code-review consistently catches three classes of gap the test-author's hypotheses don't cover: PRE-assertion boundary drift, exception-payload truncation / never-rendered-to-user observability misses, and "tested the state but not whether the user can see it" gaps.
|
||||
- `[2026-05-21]` **Manual smoke is load-bearing — found a real defect tests couldn't.** First wire-level smoke against personal Worldtree (post-TDD, post-Volva-code-review on #4) revealed httpx's default 5s read timeout killed the SSE connection mid-stream during mimir's thinking phase (~30s LLM latency >> 5s read timeout). The unit/contract test infrastructure (respx-mocked SSE wire) doesn't model real LLM latency, so the gap was invisible at the test layer. Fix: caller-owned `httpx.AsyncClient` constructed with `timeout=httpx.Timeout(connect=10.0, read=None, write=10.0, pool=10.0)`; defense in depth: `sse_client.stream_turn` ERROR_ROUTING catches `httpx.ReadTimeout` → `SseConnectionDropped`. **Lesson: keep manual-smoke step in the per-issue cadence; mock-only validation is insufficient for streaming-against-real-server code.**
|
||||
- `[2026-05-22]` **Issues #5/#6/#7 filed: per-user-agent support + TUI-startup-visibility + mid-stream-robustness.** Discovered during 2026-05-22 mimir TUI conversation: long completion crashed with `JSONDecodeError("Expecting value: line 1 column 1 (char 0)")` from `json.loads('')` on an empty-`data:` SSE frame (→ #7). Earlier same day, `ratatoskr --new --agent lofn` failed with 422 `end_user_id_required` → #5. #6 was a corollary observation (TUI alt-screen masks the diagnostic).
|
||||
- `[2026-05-22]` **Issue #8 (startup agent picker) filed.** `GET /agents` exists in the vendored spec; returns `agent_id`/`name`/`description` + optional fields. `--agent` becomes conditionally optional. Composes naturally with issue #5.
|
||||
- `[2026-05-22]` **Issue #7 implemented via TDD + Volva-code-reviewed.** First issue with zero drift findings from Volva code-review — TDD caught all runtime behavior. Hypothesis: the tighter the contract + smaller the code surface, the more Volva's role shifts from "catch behavioral drift" to "tighten observability + wording".
|
||||
- `[2026-05-23]` **Issue #6 (TUI startup error visibility) implemented via TDD + Volva-code-review (two rounds).** Restructures `run_tui` lifecycle: `_resolve_then_run` async helper opens AsyncClient, does pre-flight resolution, routes errors to stderr BEFORE alt-screen opens. Two Volva rounds confirmed multi-round value (round 2 found things round 1's amendments didn't anticipate; strictly test-precision, no behavioral drift).
|
||||
- `[2026-05-23]` **Issue #5 (`--end-user-id`) implemented via TDD.** Three modules touched. `create_session(client, agent_id, *, end_user_id=None)`; CLI flag with non-empty validation; threading through `_amain` and `_resolve_then_run`.
|
||||
- `[2026-05-23]` **Worldtree-dev consult landed authoritative consumer-API guidance** (althing thread `01KSBARG2B8M8C82H6AJGJWX1B`). Takeaways: `end_user_id` is a free-form partition key; no programmatic `requires_end_user_id` discovery; subject:{type,id} migration locked but not shipped; spec pin (v0.19.0) is 3 minor versions stale; send a User-Agent header; `agents.call:lofn` scope needed for lofn smoke; `GET /agents` requires no special scope.
|
||||
- `[2026-05-23]` **v0.2.1 layout fix: dock-anchored TUI chrome so Input never moves.** Cause: auto-stacked vertical flow shifted Input when thinking-current toggled visibility. Fix: dock chrome to screen edges; transcript absorbs reflows internally via scroll viewport. **Operator-confirmed "a lot better" interactively. Pure UI fix; tests pass without modification. TUI-layout patches are "ship + operator verifies" — TTY is the load-bearing test surface; respx + Pilot mocks can't catch screen-relative positioning bugs.**
|
||||
- `[2026-05-23]` **Issue #12 (presenter contract semantics amendment) implemented via TDD.** Thinking deltas render as ONE coalesced growing line (CLI) / one closed RichLog entry per run + live Static widget per-delta (TUI), not 50 lines per turn. Introduced stateful per-turn presenters: `CliPresenterState` + `TuiPresenterState`. Editorial promotion: load-bearing = Text/Done/Error/Cancelled (no prefix); demoted telemetry = WorkerPhase/Thinking/TextBoundary/ToolStart/ToolResult.
|
||||
- `[2026-05-23]` **Forward direction: Ratatoskr will require `end_user_id` for EVERY access before too long.** Operator's call. Reasoning: even Tier 1 foundational agents that don't *require* `end_user_id` server-side currently fall back to a `_no_end_user` sentinel partition — effectively pollution. **Cross-frontier alignment (worldtree-dev ack, althing `01KSBD9FPMCWJMBXNNS4B3MYBS`):** the platform side agrees the fallback is a substrate accommodation, NOT a consumer model. Ratatoskr's forward posture pre-empts a future tightening. File a ratatoskr issue when scheduling the change (untracked by operator choice for now).
|
||||
- `[2026-05-24]` **v0.9.0 live Markdown rendering in TUI transcript.** Replaces v0.8.2's drop-Markdown patch. Transcript switched from `RichLog` to `VerticalScroll`; each turn's response lives as a single `Static` widget whose Markdown content is updated as Text deltas arrive (no post-Done re-render, no double-print). `--raw` bypasses Markdown.
|
||||
- `[2026-05-24]` **v0.10.0 debug-pane audit logging surface.** Every SSE event arrival lands as one debug-pane line (timestamp + sse_id + event-specific summary). Token-rate Text/Thinking deltas are aggregated into per-turn counters surfaced in a turn-summary line. Also: state-machine transitions, cancel POST lifecycle, app bootstrap, ctrl-c actions, wire-error exception class+body all logged.
|
||||
- `[2026-05-25]` **Worldtree #204 / v0.28.0 integration (v0.11.0 → v0.13.0).** Three-bump arc for `affect_update` SSE event + `GET /agents/{id}/persona_state` endpoint. v0.11.0 wire layer (AffectUpdate dataclass + parse + Event-union member); v0.12.0 read-side client (`get_persona_state` + typed errors PersonaNotConfigured/AgentNotAvailable/AuthScopeDenied); v0.13.0 TUI surface (sticky `#persona-header` line + Ctrl+4 Persona TabPane; live updates on `AffectUpdate(status="current")`; on-mount hydration via the GET endpoint).
|
||||
- `[2026-05-26]` **Worldtree #201 / v0.29.0 integration (v0.14.0).** New SSE event `awaiting_llm_first_token` heartbeat (default 5s interval) during the BuildingPrompt→CallingLLM gap. Top-level event, NOT a worker_phase extension (preserves INV-053 three-field stability). `AwaitingLlmFirstToken` dataclass + parse; TUI live transcript indicator ("awaiting first token · Ns") mounted on first heartbeat, updated in place, removed when the gap closes; turn-summary line gains `heartbeats=N`.
|
||||
- `[2026-05-26]` **v0.14.1: CLI presenter forgot to update when wire-layer events were added.** AffectUpdate (v0.11.0) and AwaitingLlmFirstToken (v0.14.0) were added to the sse_client Event union and the TUI presenter, but `cli.py`'s `CliPresenterState.render` has its own isinstance check that wasn't widened. `ratatoskr --send` crashed AssertionError on any v0.28.0+/v0.29.0+ server. Patch shipped + a posture lesson: **always update BOTH presenters in lockstep when adding a wire-layer event** (the two presenters currently duplicate the isinstance tuple; refactor to a shared constant if a third wire-event lands).
|
||||
- `[2026-05-26]` **v0.14.2: RichLog min_width=78 silently overrides wrap=True.** Right-column panes (1fr against left's 2fr) are narrower than 78 cells at typical terminal widths; the renderer forces content to 78 wide then horizontal-scrolls. Fix: `min_width=0` on all four right-column RichLog instances.
|
||||
- `[2026-05-27]` **Issue #16 web companion shipped — v0.15.0.** Browser-based debug surface sibling to the TUI, reusing all wire-layer modules unchanged. New `ratatoskr.web` (Starlette app + lazy-import entrypoint + single-page vanilla HTML/CSS/JS UI), new console script `ratatoskr-web`, optional-deps group `[web]`. Nine HTTP endpoints; five-pane parity over the same SSE wire. Browser-native EventSource (GET stream + separate POST submit) — load-bearing Hulda correction from Heid panel; EventSource is GET-only. In-memory turn registry; browser-disconnect → upstream cancel; lifespan-shutdown drain with 5s budget. HTML-escaped transcript; upstream API key stays server-side. Default bind `0.0.0.0:8765` (LAN-trust model — operator direction; no auth, no TLS, no CORS).
|
||||
- `[2026-05-27]` **Heid panel review on web-companion scope v1 (pre-implementation).** Caught the EventSource POST/GET error + 7 other load-bearing items BEFORE we cut code. Confirms a pattern: **for non-trivial scope with non-obvious wire-protocol details, run a Heid panel BEFORE implementation, not just after.** Cost ~5min latency; saved a mid-implementation rewrite.
|
||||
- `[2026-05-27]` **Mid-session `system_prompt` mutation: REJECTED across the industry.** Operator-requested feature → Heid R13 panel (brokkr-claude + Eitri-Codex + Dvalin-Grok, strong convergence) ran a SOTA survey: NO surveyed mature system ships live PATCH-on-active-session for the system prompt (OpenAI Assistants/Responses, Anthropic Messages, Vertex AI, MCP, LangChain, LlamaIndex, Ollama, vLLM). The omission IS the answer; 12 additional threat vectors beyond ratatoskr's initial 7 surfaced (TOCTOU broader than BuildingPrompt window; KV/prefix cache contamination; supply-chain; Memory Control Flow Attacks >90% ASR on tested LangChain/LangGraph). Recommended alternative: client-side fork pattern (PATCH agent → mint new session → replay context). **Operator declined for ratatoskr** — debug TUI is wrong consumer; fork ergonomic belongs in a future production conversational shell. Thread closed cleanly (althing thread `01KSKD1GA3XBWR9RHGZCF9FE3Y`).
|
||||
- `[2026-05-27]` **Artemis (Gemma4) reasoning-token gap was upstream, not ours.** Wire trace from ratatoskr showed zero `thinking` events for `artemis-31b-v1i`; infra-ops confirmed llama-swap emits 77 `reasoning_content` deltas at the OpenAI-compat layer (`--reasoning-format deepseek`). Gap was in Worldtree's `GemmaProvider`. Worldtree-dev shipped v0.29.13 (commit `4262430`) fixing two stacked bugs: (1) base `OpenAICompatProvider._extract_thinking_from_delta` returned `None` unconditionally so any model falling through to the generic class dropped reasoning; (2) catalog `family` lookup was dead code (read wrong YAML subsection). Confirmed in ratatoskr via re-smoke against Sindra. **Diagnostic pattern: when a wire-layer feature appears missing, get infra-ops to probe upstream-of-the-SSE-publisher first; ratatoskr's wire trace says what reaches us, infra-ops's probe says what reaches Worldtree.**
|
||||
- `[2026-05-27]` **v0.15.1 (sessions): `get_persona_state` unwraps FastAPI `detail`-envelope.** Live smoke surfaced that real Worldtree returns persona-state errors as `{"detail": {"error_code": "..."}}` (FastAPI default), not flat. v0.12.0 tests mocked flat shape so the bug was invisible. **Lesson: test-side mock envelopes must match the REAL wire shape; live smoke is load-bearing for envelope-shape verification, not just happy paths.**
|
||||
- `[2026-05-28]` **v0.16.0 web Heid code-review pass 1: load-bearing turn_id fix.** Cancel paths used browser-local `_TURN_COUNTER` ids (1, 2, 3…) instead of upstream Worldtree turn_id (e.g. 799) captured from the first SSE event. The `disconnect_triggers_cancel` test gap was the load-bearing miss. Also: server-configured `RATATOSKR_END_USER_ID` (browser can no longer impersonate partition); narrowed missing-extras `ImportError` catch (real first-party bugs propagate as tracebacks instead of masking as exit-12); per-turn lifespan-shutdown logging. Contract amended with a v0.16.0 block + INV-005/006 updated + 4 FN sketches corrected.
|
||||
- `[2026-05-28]` **v0.16.1 web Heid code-review pass 2: minor tightening.** Stream-layer vocab coverage extended to all 11 Event types (AffectUpdate added to the vocab stream; dedicated `error_terminal_event` + `cancelled_terminal_event` tests since terminal events are mutually exclusive with done). Disconnect-cancel catch narrowed to swallow only `CancelAlreadyCompleted`/`CancelTurnNotFound` (the cooperative race); log unexpected `CancelFailed`/transport errors as structured stderr. **Heid review loop converged**: pass 1 = 7 findings (1 load-bearing); pass 2 = 2 minor (Gróa: zero findings, Hulda: 2). Pattern confirmed: diminishing returns within 2-3 passes; pass 3 would have been empty.
|
||||
- `[2026-05-28]` **Sindra Tier 3 agent: FORM ASSUMPTION gate + new physical-form description.** Persistent agent state changes via `python -m ratatoskr.tier3 patch`: (1) model migrated from `qwen3.6-35-a3b-heretic` to `artemis-31b-v1i`; (2) added FORM ASSUMPTION section — when instructed to become another character she IS that character (identity/environment/psychology/parameters), believes the environment as fact, no Sindra/holo-deck/parameter references, sticky until explicit revert; (3) replaced the abstract "classically beautiful" default-form sketch with a specific anti-artifice physical description (5'8", golden-copper skin, asymmetric features, oversize dark-green knit, bare feet). System prompt file is at `/tmp/personal-worldtree-sindra_system_prompt.md` (transient; not committed to repo). (Superseded 2026-06-17: sindra DELETE+redefined to `thoughtful-character` role on v0.35.16.)
|
||||
- `[2026-05-29]` **v0.17.0 frontend redesign — aurora telemetry instrument.** `/frontend-design` pass on the web companion: all-monospace technical-instrument aesthetic with the Australis dark palette + aurora-borealis accent band. Top command bar with live connection dot (idle/streaming/error states), inline persona summary with P/A/D micro-bars, animated awaiting-token, terminal-event status chips. **Live Markdown rendering in transcript + thinking panes** via a hand-rolled `markdownSafe()` (escape-first, whitelist subset of headings/bold/italic/inline-code/fenced/lists/quote/links; link-scheme whitelist; XSS-verified under a node harness). Thinking pane now has per-turn labeled dividers + a fresh MD-rendered block per turn. **Tools / Debug / Persona panes stay literal monospace** by deliberate choice — they carry structured audit lines + JSON, where MD would corrupt readability (underscores in tool names, JSON braces). Single-file vanilla HTML/CSS/JS, no build, no CDN, no node_modules.
|
||||
- `[2026-05-29]` **Codex-first discipline pilot — Ratatoskr selected.** brokkr-smithy-dev pushed `AGENTS.md` (commit `bbeaa23`) and declared the `ratatoskr-codex` handle per `brokkr-smithy/docs/codex-first-discipline.md` v0.1 (brokkr-smithy commit `5dd061c`, tag `v0.5.3`). Per-dispatch opt-in model: default Sleipnir Claude-implementer path remains available; Codex used only when operator routes via `/codex-dispatch <N>`. Bootstrap handshake when operator spins up a codex session: codex sends `codex-online` → ratatoskr-dev replies with active branches + WIP state. Galdrabok was rejected as pilot (Codex authoring Claude skills is a category error); Skaldsong was the other candidate. (Still dormant as of 2026-06-18 — no codex session spun up.)
|
||||
|
||||
## Tried and abandoned (archived)
|
||||
|
||||
The 2026-05-20 → 2026-05-28 cluster: original-build-era foot-guns. Archived 2026-06-18.
|
||||
|
||||
- `[2026-05-20]` **rich + prompt_toolkit framework choice.** Volva flagged that §1 and §5 pulled in opposite directions: a real side-panel observability surface would silently become a widget framework reimplementation. Operator's debug-observability reframe sealed the flip to Textual. Don't re-attempt rich+pt unless the scope shrinks to transcript-first REPL.
|
||||
- `[2026-05-20]` **In-tree at Worldtree/tools/ratatoskr/.** Earlier draft committed to in-tree-with-import-direction-smoke-test. Rejected at operator-routing — separate dev team forces separate repo.
|
||||
- `[2026-05-20]` **New `/persona/log` SSE endpoint on Worldtree.** Considered as alternative to file-tailing `persona.log`. Rejected — contract amendment + Vor round + AFK dispatch loop is weeks for a debug feature file-tail handles in a day. Trigger follow-up if a Worldtree-on-server / TUI-on-laptop debug case appears.
|
||||
- `[2026-05-20]` **Cross-process Last-Event-ID resume.** Considered — would require persisting per-session Last-Event-ID. Deferred to v2; v1 ships "reconnect, not resume-across-process."
|
||||
- `[2026-05-21]` **RichLog widget with `markup=True`.** Default impulse, but Rich interprets `[xxx]` spans as style markup and silently strips them. Every labeled stderr-style line — `[cancel_failed]`, `[done]`, `[error]`, `[busy]`, `[worker_phase]` — would render as just the content after the bracketed label. Fix: `markup=False`. Don't flip back without renaming every labeled-line format away from `[bracket]` notation.
|
||||
- `[2026-05-21]` **Querying `self.query_one("#transcript", RichLog)` from inside a Textual `run_worker` coroutine.** Initially failed with `NoMatches`. Reactive fix was widening worker signature to take `log` as parameter — Volva flagged as contract drift; reverted. Real fix was test-side: `await pilot.pause()` between `inp.action_submit()` and the polling loop so the handler finishes dispatching. Don't widen worker signatures to dodge test timing.
|
||||
- `[2026-05-21]` **TUI session-identity rendering via `self.sub_title` + `self.hint` plain attributes.** Stored state but never rendered to a visible widget. Tests asserted attributes (passed); Volva code-review flagged the gap. Fix: dedicated `Static(id="identity")` + `Static(id="hint")` widgets in compose; `_set_hint()` helper mirrors state → widget. **Calibration evidence for the "TDD catches state, code-review catches whether the user can see it" pattern.**
|
||||
- `[2026-05-23]` **Using the cross-model review agent's name directly in composed prose.** The peer review agent's name (the althing handle starting with "V-o-l-v-a") is one letter from a body-part term. Anthropic's content classifier does fuzzy matching and intermittently blocks responses mid-stream when the name appears in composed prose sentences. Mitigation: use role descriptions ("the cross-model reviewer," "the paraphrase peer") in prose rather than the name; quote content via tool output.
|
||||
- `[2026-05-22]` **`json.loads(sse.data)` unguarded against empty data.** `_iter_events` unconditionally called `json.loads` on every dispatched `ServerSentEvent`. When `httpx_sse` surfaced a frame with `id:` present but `data:` empty, `json.loads('')` raised `JSONDecodeError` → app crash. Fix: `if sse.data == '': continue` BEFORE `_parse_sse_id`. Don't reintroduce unconditional `json.loads(sse.data)`.
|
||||
- `[2026-05-23]` **Diagnostic shorthand: "2-events-then-silence" = Worldtree-side LLM-call wedge, not ratatoskr.** If a mimir `--send` smoke shows exactly two stderr events — `. create_session: ...` followed by `. worker_phase: phase=BuildingPrompt ...` — and then nothing for >60s, the root cause is upstream of ratatoskr. Worldtree's `service.py:2560` gates the `CallingLLM` event on the engine yielding its first LLM-provider chunk; if that connection is wedged at TCP level, the `async for` never iterates. Worldtree's 300s `_start_stall_timer` cancel-check is INSIDE the engine-event loop and so bypassed. **Don't bisect ratatoskr code when this shape appears** — diagnose the LLM-provider state at Worldtree's host. Restarting the Worldtree service clears wedged llama-swap connections. 10.250.50.152 hosts 3 instances (`:8080`/`:8081`/`:8082`) each with own DB + key namespace; our key is valid only on `:8081`.
|
||||
- `[2026-05-23]` **Phantom "per-Tier-1-agent scope add" pattern.** Issue #5's lofn 422 was initially mis-diagnosed as needing `agents.call:lofn` added. Routed to infra-ops via althing per credential-brokerage rule; infra-ops discovered no public scope-mutation endpoint, brokered to worldtree-dev. Worldtree-dev clarified: **Tier 1 foundational agents** are covered by a blanket `agent.call:*` (singular) baseline. There is no per-agent grant for Tier 1. **Tier 3 consumer-defined agents** use the plural `agents.call:<owner>:<agent>` shape registered via `POST /agents/define`. The notations differ by one letter. **The actual lofn fix was issue #5's `--end-user-id` flag** — always a request-body validation, not an auth-scope gate. Don't ping infra-ops for "per-Tier-1-agent scope adds."
|
||||
- `[2026-05-24]` **v0.8.x double-print: streamed Text + post-Done Markdown re-render.** Initial v0.6.0 design wrote each Text delta inline (with `· ` prefix) then re-rendered the full response as a Markdown Renderable on Done. Visually the response appeared twice. v0.8.2 dropped the post-Done Markdown body (interim regression). v0.9.0 fixed it properly with live Markdown rendering during stream (single Static widget holding a Markdown Renderable, updated in place). Don't reintroduce post-Done re-render unless you also remove the live-Markdown widget.
|
||||
- `[2026-05-26]` **Textual `RichLog(wrap=True)` insufficient on narrow widgets.** The default `min_width=78` overrides wrap on shrink — `max(renderable_width, min_width)` forces 78-cell rendering then horizontal-scrolls. Always set `min_width=0` on RichLog instances in a narrow column. Re-check on any future RichLog construction.
|
||||
- `[2026-05-26]` **Wire-layer event added without updating BOTH presenters.** v0.11.0 (AffectUpdate) and v0.14.0 (AwaitingLlmFirstToken) widened the sse_client Event union + TUI presenter's isinstance tuple, but missed cli.py's identical-shape tuple. `--send` mode then crashed on any persona-enabled or slow-first-token turn. Patch fix in v0.14.1. **Rule: when adding a wire-layer event, grep for `isinstance(event, (` across the repo** — currently TUI and CLI presenters both carry duplicate hardcoded tuples. Refactor to a shared `_EVENT_VOCAB` constant if a third wire-event lands.
|
||||
- `[2026-05-27]` **EventSource is GET-only — scope v1's POST stream endpoint would have broken.** Web companion's first scope had `POST /api/turns/{sid}/stream` for the SSE proxy. Browser-native `EventSource` only supports GET. Hulda caught it in Heid panel review BEFORE we cut code. Pattern: `POST /api/turns/{sid}` registers the turn locally + returns turn_id; `GET /api/turns/{sid}/stream?turn_id=N` streams via EventSource; cancel is a separate POST. **Load-bearing reason to Heid-panel non-trivial wire-protocol designs BEFORE implementation, not just after.**
|
||||
- `[2026-05-27]` **`get_persona_state` mocked flat error envelope; real Worldtree wraps in `detail`.** v0.12.0 tests used `{"error_code": "auth_scope_denied"}` but real wire (FastAPI default) returns `{"detail": {"error_code": "auth_scope_denied", "message": "…"}}`. The parser only checked top-level so the typed exception was never raised; calls fell through to `SessionApiFailed(403)`, which the web persona endpoint surfaced as HTTP 500. v0.15.1 patches both shapes. **Lesson: test-side mock envelopes must match the REAL wire shape; live smoke is load-bearing for envelope-shape verification, not just happy paths.**
|
||||
- `[2026-05-27]` **Mid-session `system_prompt` mutation: universal omission across surveyed mature systems.** brokkr-smithy R13 panel (3-arm, strong convergence) confirmed: no surveyed system ships live PATCH-on-active-session (OpenAI Assistants/Responses, Anthropic Messages, Vertex AI, MCP, LangChain, LlamaIndex, Ollama, vLLM). The omission IS the answer. 12 additional threat vectors beyond ratatoskr's initial 7. **Don't re-propose this for ratatoskr;** if a future production conversational shell wants iterative-prompt-tuning ergonomics, the consensus shape is fork-via-client (PATCH agent → new session → replay context).
|
||||
- `[2026-05-28]` **Browser-local turn_id used for upstream cancel URL — old cancel tests ENCODED the bug.** Web companion v0.15.x cancel paths posted to `/sessions/{sid}/turns/{LOCAL_ID}/cancel`. Tests mocked the local-id URL so they encoded the bug rather than detecting it. Hulda caught it in Heid pass 1. Fix in v0.16.0: capture upstream_turn_id from the first SSE event's `sse_id.turn_id`; all cancel paths use it; cancel before first event is `{"cancelled": false, "reason": "not_started"}`. **Rule: when designing cancel/match paths against an external service, test fixtures must mock what would actually be hit upstream — mocking your own derived id encodes the bug instead of catching it.**
|
||||
+18
-8
@@ -7,24 +7,34 @@ documents the pin, the vendored artifacts, and the bump procedure.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Worldtree git SHA | `562001af28d752c3a60d449c7ddd09f44fa9dc9a` |
|
||||
| Worldtree HEAD message | `feat(#201): v0.29.0 — awaiting_llm_first_token SSE heartbeat` |
|
||||
| Pinned on | 2026-05-26 |
|
||||
| Pinned by | ratatoskr-dev (bump for #201 awaiting_llm_first_token SSE) |
|
||||
| Worldtree version at pin | `v0.29.0` |
|
||||
| Worldtree git SHA | `c9e59ec` |
|
||||
| Worldtree HEAD message | `docs: document Tier-3 persona/memory schemas + persona_state SET body (OpenAPI 2.3.0)` |
|
||||
| Pinned on | 2026-07-06 |
|
||||
| Pinned by | ratatoskr-dev (re-vendor prose markdown — Tier-3 persona/memory/persona_state consumer shapes) |
|
||||
| Worldtree version at pin | `v1.0.0b22` |
|
||||
|
||||
## Pin history
|
||||
|
||||
| Date | SHA | Version | Notable deltas consumed |
|
||||
|---|---|---|---|
|
||||
| 2026-05-26 | `562001a` | v0.29.0 | #201 — new SSE event `awaiting_llm_first_token` (heartbeat during BuildingPrompt → CallingLLM gap, default 5s interval) |
|
||||
| 2026-07-06 | `c9e59ec` | v1.0.0b22 | **Re-vendor the prose markdown — Tier-3 consumer shapes documented.** `c9e59ec` (docs-only, OpenAPI byte-unchanged vs `879cefe`) adds `docs/conversation-api-spec.md` § "Tier 3 — Consumer-defined agents": the persona / memory / persona_state SET-body shapes that serialize as freeform `Any` in the OpenAPI (so prose is their source of truth). Drove a consumer fix: `--set-persona-pad` now sends the canonical `{pad:{pleasure,arousal,dominance}}` named dict (was `{pad:[list]}`) — #317, `v0.19.7`. Foot-guns encoded: persona.ocean single-letter `{O,C,E,A,N}` on `/agents/define` (spelled-out → 422, the #348 mismatch) vs spelled-out on `POST /characters`; memory `{embedder_version, tier3_dreaming}`, stm_* deprecated, allows_world_scope removed→422; only `valence` still 422s. `pin:`-only for the markdown; the `v0.19.7` bump rode the persona_state code fix. |
|
||||
| 2026-07-06 | `879cefe` | v1.0.0b22 | **Re-vendor OpenAPI 2.2.0→2.3.0 — Worldtree shipped #347 authored-history-write.** One new REST path-group: `POST /sessions/{session_id}/history` (the authored-history-write primitive) + the `AuthoredTurnResponse` schema (openapi path count 40→41). #347 is **OpenAPI-only** — the prose `conversation-api-spec.md` + server `conversation_api.contract.md` are byte-unchanged since the 5810a26 pin (empty `git log` delta), so those `tolerate_drift` pins stay clean; the SSE schema is unchanged (#347 is event-silent by design). **Consumer side NOT yet built** — `POST /sessions/{id}/history` is a fresh in-scope ⬜ gap in `docs/coverage-map.md` (re-opens the v1 coverage-audit with exactly one gap; Heimdall-gated hide-existence → consumer treats 404 as feature-absent). `pin:`-only, no version bump. |
|
||||
| 2026-06-30 | `5810a26` | v1.0.0b2 | **Re-pin to Worldtree's FROZEN v1 surface (#326), as part of the v1 coverage-audit.** Vendored the machine-readable artifacts — `conversation-api-openapi.json` (OpenAPI **2.2.0**, 40 path-groups) + `conversation-api-sse-events.schema.json` (11 events) — now the **authoritative drift gates** (pinned in `.corviduo-canonicals.toml`, CI-checked by `canonical_drift.py`). The prose `conversation-api-spec.md` is **byte-identical** to the v0.35.16 pin (last WT markdown edit 2026-05-31), kept as the human reference (`tolerate_drift`). b2 deltas already consumed in code: 409/503 eager turn-launch statuses (#331, v0.18.3/.4) + the unified error envelope (#328). 7 endpoints documented only in the OpenAPI, not the prose, all classified in `docs/coverage-map.md`: `admin/keys/bulk`, `admin/persona/{archive,erase}`, `admin/usage`, `embed`, `judgments`, `me/usage`. No client-breaking change — `pin:`-only, no version bump. |
|
||||
| 2026-06-17 | `f1b59f8` | v0.35.16 | **#297 + #298/#299 — Worldtree adopts the bifrost v0.6 scope wire (emits `scope_any`/`scope_all`) + client-side per-scope-value union recall. With our v0.17.6 provider this closes cold cross-session recall end-to-end.** Catch-up bump (v0.29.0→v0.35.16). Intervening client-facing deltas reviewed, none break our consumer: #211 agent rename (`saga`→`echo`, `actor`→`mask` — slugs only); #245 `end_user_id` persistence + memory-scope resolver; #187/#188/#219 Tier-3 define/PATCH policy (additive); `bifrost` binding field + `ephemeral_does_not_accept_bifrost` 422 now documented (the #17 surface). Error codes stable; no ratatoskr code change required. |
|
||||
| 2026-05-25 | `da93ca7` | v0.28.0 | #204 — new SSE event `affect_update` (current/scheduled), new endpoint `GET /agents/{id}/persona_state`, auth-model doc edits |
|
||||
| 2026-05-20 | `55101e9` | v0.19.0 | initial scaffold pin |
|
||||
|
||||
## Vendored artifacts
|
||||
|
||||
- `docs/conversation-api-spec.md` — copy of `Worldtree/docs/conversation-api-spec.md` at the pinned SHA. This is the **client-facing interface contract** Ratatoskr is built against.
|
||||
- `docs/conversation_api.contract.md` — copy of `Worldtree/docs/contracts/conversation_api.contract.md` at the pinned SHA. The **server-side contract** including INV-001..INV-052 and amendments. Useful for understanding load-bearing server invariants (e.g., INV-014 turn-id-public, INV-046 admin-events-envelope-stable, INV-049 admin-events-pii-discipline) when designing client behavior against them.
|
||||
**Authoritative (FROZEN, machine-readable — the drift gates):**
|
||||
|
||||
- `docs/conversation-api-openapi.json` — copy of `Worldtree/docs/conversation-api-openapi.json` (OpenAPI `info.version` **2.3.0**). The frozen v1 REST wire (41 path-groups; 2.3.0 added `POST /sessions/{session_id}/history` per #347). Pinned `worldtree-conversation-api-openapi-v2` in `.corviduo-canonicals.toml`; drift gated by `canonical_drift.py`.
|
||||
- `docs/conversation-api-sse-events.schema.json` — copy of `Worldtree/docs/conversation-api-sse-events.schema.json`. The frozen SSE event schema (11 discriminated event types). Pinned `worldtree-conversation-api-sse-events-v1`.
|
||||
|
||||
**Reference (prose; allowed to lag — `tolerate_drift`):**
|
||||
|
||||
- `docs/conversation-api-spec.md` — copy of `Worldtree/docs/conversation-api-spec.md` at the pinned SHA. The **client-facing prose narrative**. Re-vendored at `c9e59ec` (2026-07-06) to carry the § "Tier 3 — Consumer-defined agents" subsections (persona/memory/persona_state SET body) that serialize as freeform `Any` in the OpenAPI JSON — so the **prose is the source of truth for those consumer shapes** (e.g. persona.ocean single-letter `{O,C,E,A,N}` on `/agents/define`; `POST /sessions/{id}/persona_state` body `{pad:{pleasure,arousal,dominance}}`). Elsewhere the OpenAPI/SSE JSON above remain authoritative. Pinned `worldtree-conversation-api-spec-v1` (tolerate_drift).
|
||||
- `docs/conversation_api.contract.md` — copy of `Worldtree/docs/contracts/conversation_api.contract.md` at the pinned SHA (byte-identical at b2 — server contract unchanged since the v0.35.16 pin). The **server-side contract** including INV-001..INV-052 and amendments. Useful for understanding load-bearing server invariants (e.g., INV-014 turn-id-public, INV-046 admin-events-envelope-stable, INV-049 admin-events-pii-discipline) when designing client behavior against them. Not in the canonical manifest (reference-only).
|
||||
|
||||
Both files are vendored — they reflect Worldtree at the pinned SHA, not
|
||||
the live `~/development/Worldtree` checkout. Update them only when
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
# Bifrost round-trip self-test
|
||||
|
||||
How to drive **and** observe a full Tier-3 Bifrost round-trip against
|
||||
ratatoskr's *own* provider — bind a Worldtree session to our affect/memory
|
||||
store, fire a turn, and read exactly what Worldtree dispatched to us,
|
||||
correlated with the turn that triggered it.
|
||||
|
||||
This is the **manual form of issue #17** (self-drive + correlated-log
|
||||
affect/memory ops). Until #17 ships that capability inside the TUI/web/CLI,
|
||||
this runbook is the reproducible loop — and it is the substrate worldtree-dev's
|
||||
#296 (salience-algorithm research) and #297 (recall scope/assembly research)
|
||||
diagnose against.
|
||||
|
||||
> First proven by hand 2026-06-16 while isolating #295's recall leg.
|
||||
|
||||
## The load-bearing tripwire: which key signs the bind
|
||||
|
||||
A bound session-create authenticates as the **Bifrost consumer**, not the
|
||||
canary client. Worldtree signs the Bifrost handshake JWT with the
|
||||
**session-create bearer token** (HS256 shared-secret model); our provider
|
||||
verifies it against `RATATOSKR_HEIMDALL_KEY`.
|
||||
|
||||
So the bearer on `POST /sessions` **must be the consumer Heimdall key**
|
||||
(`RATATOSKR_HEIMDALL_KEY`, in `~/.config/ratatoskr/provider.env`) — **not**
|
||||
`WORLDTREE_API_KEY` (the mimir/foundational TUI key in `env.sh`). They are two
|
||||
different keys for two identities of ratatoskr.
|
||||
|
||||
| Bearer used on `POST /sessions` | Handshake at our provider |
|
||||
|---|---|
|
||||
| `WORLDTREE_API_KEY` (mimir/TUI key) | **401** `bifrost.auth_rejected` → 502 to client |
|
||||
| `RATATOSKR_HEIMDALL_KEY` (consumer key) | **200 OK** → session bound |
|
||||
|
||||
ratatoskr is two identities: the conversation-API **canary client**
|
||||
(`WORLDTREE_API_KEY`) and the Bifrost **consumer/provider**
|
||||
(`RATATOSKR_HEIMDALL_KEY`). Self-driving a bound session crosses into the
|
||||
consumer identity, so it uses the consumer key. #17's Bind half has to carry
|
||||
this distinction.
|
||||
|
||||
## Prereqs
|
||||
|
||||
- Provider(s) running on this box (nh3-dev, `10.100.10.50`):
|
||||
- memory → `ratatoskr-memory-provider` on `:8391`
|
||||
- affect → `ratatoskr-provider` on `:8390`
|
||||
- Each is a dev background shell, env-sourced from `provider.env`. The memory
|
||||
provider's stdout carries the inbound observe log (`[memory-provider]` lines
|
||||
added in `memory_store.py`).
|
||||
- The provider endpoint is reachable + allowlisted from Worldtree
|
||||
(`10.250.50.152`): `http://10.100.10.50:8391`. The allowlist
|
||||
(`BIFROST_CLIENT_ALLOWED_HOSTS`) is **Worldtree-side, infra-ops-owned** — if a
|
||||
bind 502s with a route/allowlist error, that entry is the thing to check.
|
||||
- A memory-enabled Tier-3 agent defined on the instance. `ratatoskr:smoke`
|
||||
(scope `end_user:smoke-user`) is the standing fixture; it is hidden from
|
||||
`GET /agents` (Tier-3 agents are not in the public roster) but resolves on
|
||||
session-create.
|
||||
|
||||
## Steps
|
||||
|
||||
```bash
|
||||
cd ~/development/ratatoskr
|
||||
set -a && . ~/.config/ratatoskr/provider.env && set +a # RATATOSKR_HEIMDALL_KEY etc.
|
||||
URL=http://10.250.50.152:8081 # personal Worldtree
|
||||
HK="$RATATOSKR_HEIMDALL_KEY" # the CONSUMER key — the tripwire
|
||||
```
|
||||
|
||||
**1 — Bind a fresh (cold) session to our provider.** `bifrost.endpoint_url`
|
||||
points at the plane you want (`:8391` memory, `:8390` affect); caps are
|
||||
negotiated by the handshake, not declared here (`BifrostBindingRequest` is
|
||||
`{endpoint_url, scope}` only, `additionalProperties:false`). A 201 means the
|
||||
handshake verified.
|
||||
|
||||
```bash
|
||||
curl -sS -X POST "$URL/sessions" -H "Authorization: Bearer $HK" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"agent_id":"ratatoskr:smoke","end_user_id":"smoke-user",
|
||||
"bifrost":{"endpoint_url":"http://10.100.10.50:8391","scope":null}}'
|
||||
# -> 201 {"session_id":"...", "kind":"consumer_defined", ...}
|
||||
```
|
||||
|
||||
**2 — Snapshot the fixture** (to detect any promotion the turn writes):
|
||||
|
||||
```bash
|
||||
sqlite3 -readonly memory.db \
|
||||
"SELECT chunk_id, json_extract(record_json,'\$.verbatim.text') FROM memory_chunks;"
|
||||
```
|
||||
|
||||
**3 — Fire ONE turn** into the bound session, reusing ratatoskr's own SSE
|
||||
client (handles composite ids + no-read-timeout). Bearer = the consumer key:
|
||||
|
||||
```bash
|
||||
RATATOSKR_HEIMDALL_KEY="$HK" uv run python - <<'PY'
|
||||
import asyncio, os, httpx
|
||||
from ratatoskr.sse_client import stream_turn, Text, Done, Error, Cancelled
|
||||
SESSION="<session_id from step 1>"
|
||||
URL="http://10.250.50.152:8081"; KEY=os.environ["RATATOSKR_HEIMDALL_KEY"]
|
||||
async def main():
|
||||
async with httpx.AsyncClient(base_url=URL,
|
||||
headers={"Authorization":f"Bearer {KEY}","User-Agent":"ratatoskr-selftest"},
|
||||
timeout=httpx.Timeout(connect=10.0,read=None,write=10.0,pool=10.0)) as c:
|
||||
async for ev in stream_turn(c, SESSION, "What kind of chocolate do I like?"):
|
||||
if isinstance(ev, Done): print("ANSWER:", ev.response); return
|
||||
if isinstance(ev, Error): print("ERROR:", ev.error_code, ev.message); return
|
||||
asyncio.run(asyncio.wait_for(main(), 150))
|
||||
PY
|
||||
```
|
||||
|
||||
**4 — Read the inbound pair** from the provider's stdout (the observe brick).
|
||||
For a background-shell provider, that is the task output file; tail it:
|
||||
|
||||
```
|
||||
[memory-provider] memory-call search REQUEST: scope_all={...} scope_any=[...] top_k=... vec_dim=1024
|
||||
[memory-provider] memory-call search RESPONSE: N hit(s) [{'chunk_id':..., 'score':..., 'scope':...}]
|
||||
```
|
||||
|
||||
**5 — Re-snapshot the fixture** (step 2's query). A new row = the turn was
|
||||
promoted (a salience-algorithm event; relevant to #296). Audit, don't blindly
|
||||
delete — promoted failure-surfaces may be wanted corpus.
|
||||
|
||||
## Reading the result
|
||||
|
||||
The `search REQUEST` `scope_all`/`scope_any` vs the `search RESPONSE` hit count is
|
||||
the whole diagnosis surface:
|
||||
|
||||
- **0 hits** → the composed v0.6 filter matched no stored chunk. `scope_all` axes
|
||||
are AND-matched — an extra axis the chunks don't carry (e.g. `agent_self`) zeroes
|
||||
the result even when `end_user` matches. `scope_any` is the OR/union escape hatch:
|
||||
a subset-scoped chunk recalls if its scope ⊇ **any one** element. So 0 hits with a
|
||||
populated store now means Worldtree sent an over-specified `scope_all` instead of a
|
||||
`scope_any` union — a **scope-build** question (Worldtree-side, post-v0.6).
|
||||
- **Hit present but the model says "no memory"** → we returned it; Worldtree
|
||||
dropped it downstream of search → **recall-assembly / injection**
|
||||
(Worldtree-side).
|
||||
|
||||
Either way our store + search are provable from this surface; the recall
|
||||
*efficacy* must be judged at the model's answer in a **cold (history-free)**
|
||||
session, never from a wire 200 (a `search` returns 200 whether or not its hits
|
||||
are injected).
|
||||
|
||||
### Worked example (2026-06-16, #295 → #297)
|
||||
|
||||
Cold turn "What kind of chocolate do I like?" against the `smoke-user` fixture:
|
||||
|
||||
```
|
||||
REQUEST: scope_filter={'end_user': 'smoke-user', 'agent_self': 'ratatoskr:smoke'} top_k=128
|
||||
RESPONSE: 0 hit(s)
|
||||
ANSWER: "I don't have access to your past preferences..."
|
||||
```
|
||||
|
||||
(That capture is the **pre-v0.6 wire** — a single AND-only `scope_filter`.)
|
||||
|
||||
Root cause: the recall filter carried `agent_self` but the stored chunks are
|
||||
`{end_user: smoke-user}` only → the `agent_self` axis excluded all of them.
|
||||
Branch (a), scope asymmetry — fed to #297.
|
||||
|
||||
**Resolution (bifrost 0.8.0 / wire v0.6, #11):** the single `scope_filter` is split
|
||||
into `scope_all` (AND) + `scope_any` (OR/union). Worldtree can now send the visible
|
||||
scopes as a `scope_any` union (e.g. `[{end_user: smoke-user}, {end_user: smoke-user,
|
||||
agent_self: ...}]`), so the subset-scoped chunk recalls via the matching OR member.
|
||||
Our store implements this at parity with the v0.6 reference; Worldtree **adopted the
|
||||
v0.6 wire and now emits `scope_any`** on the recall path (#297 client-side union recall
|
||||
+ #298/#299 bifrost-v0.6 adoption, v0.35.16), so cold cross-session recall is **closed
|
||||
end-to-end** — pending a live re-smoke against a personal instance running v0.35.16.
|
||||
|
||||
## Notes / foot-guns
|
||||
|
||||
- **HTTP, not HTTPS.** The spec requires `endpoint_url` be HTTPS; dev is relaxed
|
||||
via the Worldtree-side allowlist. Don't "fix" our provider to HTTPS to make a
|
||||
bind work — check the allowlist entry first.
|
||||
- **Cold means cold.** Reuse of a session with history can satisfy a "recall"
|
||||
from plain conversation history. Always bind a *fresh* session for a recall
|
||||
probe.
|
||||
- **Stray sessions** created by probes are harmless empty rows on the dev
|
||||
instance; no cleanup required.
|
||||
- This loop is the thing #17 productizes into the chat surfaces; when #17 lands,
|
||||
the bind+observe steps move inside the TUI/web/CLI and this runbook becomes the
|
||||
underlying contract check.
|
||||
@@ -0,0 +1,339 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "ratatoskr.provider.affect_store"
|
||||
purpose: "Affect-plane Bifrost consumer (v1 tracer): a SQLite-backed, conduit-opaque affect store + the ASGI app wiring Worldtree emits Tier-3 persona/affect snapshots into."
|
||||
touches:
|
||||
- src/ratatoskr/provider/affect_store.py
|
||||
- tests/test_provider_affect.py
|
||||
language: "python"
|
||||
complexity: "medium"
|
||||
estimated_loc: 180
|
||||
confidence: 0.85
|
||||
assumptions:
|
||||
- "bifrost>=0.10.0 is installed and exposes build_affect_app, build_combined_app, dispatch_affect_call, JwtVerifier, ConsumerRegistration, AffectInvalidArguments, AffectIdempotencyConflict, and REQUIRES a callable affect-store fetch for the affect capability (_supports_affect_plane, bifrost/affect.py:75-80, strong-or-absent) per bifrost/reference_server/affect.py."
|
||||
- "The affect snapshot dict always carries string addressing keys 'agent_id' and 'end_user_id'; the bifrost wire validates the envelope before the store is called."
|
||||
- "A Heimdall HS256 key for consumer_id='ratatoskr' is provisioned (deploy-time, brokered via infra-ops); the store itself never sees raw auth — the library verifies per-dispatch JWTs and hands a DispatchContext (ctx)."
|
||||
- "The idempotency actor is derivable from ctx (mirrors bifrost's reference `_ctx_actor(ctx)` — the dispatch subject/actor identity)."
|
||||
open_questions:
|
||||
- "SQLite file path + whether the affect plane shares one DB file with the memory plane or uses its own — deferred to the combined-server slice (guide §7) and the memory-plane contract."
|
||||
- "idempotency_class is accepted and ignored in v1 (reserved; affect.* uses a single short-retry class); confirm Worldtree never relies on class-scoped affect idempotency."
|
||||
external_invariants:
|
||||
- source: ~/development/bifrost/docs/contracts/affect.contract.md
|
||||
invariant_id: "INV-001" # conduit opacity — the governing rule of the affect plane
|
||||
- source: ~/development/bifrost/bifrost/reference_server/affect.py
|
||||
invariant_id: "InMemoryAffectStore.emit" # the executable reference for the emit wire semantics we parity-prove against
|
||||
- source: ~/development/bifrost/bifrost/reference_server/affect.py
|
||||
invariant_id: "InMemoryAffectStore.fetch" # the executable reference for the affect.fetch read shape ({found, snapshot})
|
||||
revisions:
|
||||
- version: "1.1"
|
||||
at: 2026-06-14
|
||||
summary: "Align idempotency to bifrost's ACTUAL affect semantics (TDD-against-lib finding the artifact-only Heid gate structurally could not see): conflict-on-key-reuse, actor-scoped idempotency, bifrost exception types. Add get() read seam. Two-table schema. Defer idempotency-cache TTL pruning."
|
||||
delta:
|
||||
ADDED:
|
||||
- "INV-009 (idempotency-cache TTL pruning deferred to a follow-up)"
|
||||
- "get() function block (read-back seam; mirrors the reference store's get())"
|
||||
- "idempotency_conflict test"
|
||||
- "affect_idempotency table"
|
||||
MODIFIED:
|
||||
- "INV-008 — replay-noop + conflict-on-reuse (was: same-key-different-hash overwrites)"
|
||||
- "emit ERROR_ROUTING/STEPS/exceptions — AffectInvalidArguments + AffectIdempotencyConflict (was: ValueError)"
|
||||
- "Data flow at-rest — two tables (snapshot + idempotency)"
|
||||
- "basic_emit wording — semantic round-trip (was: byte-identical)"
|
||||
REMOVED:
|
||||
- "the 'same idempotency_key + different content hash -> LWW overwrite' clause (it was backwards: bifrost treats that as a conflict)"
|
||||
- version: "1.2"
|
||||
at: 2026-06-19
|
||||
summary: "Adopt bifrost 0.10.0's mandatory affect.fetch (strong-or-absent, INV-012): _supports_affect_plane now requires a callable fetch for the affect cap to advertise/dispatch at all, so an emit-only store 400s on EVERY affect op. Promote the sync get() read seam to an async wire fetch() returning bifrost's {found, snapshot} shape; conform to the reference InMemoryAffectStore.fetch. affect.fetch leaves 'reserved'. Forced prerequisite of the #18 D1 composite (build_combined_app)."
|
||||
delta:
|
||||
ADDED:
|
||||
- "fetch() function block (async wire verb; mirrors reference InMemoryAffectStore.fetch)"
|
||||
- "INV-010 (affect cap = affect_supported + emit + fetch, strong-or-absent)"
|
||||
- "parity_vs_reference_fetch test"
|
||||
- "InMemoryAffectStore.fetch external invariant"
|
||||
MODIFIED:
|
||||
- "INV-005 — cross-refs INV-010 (the affect cap now requires fetch present too)"
|
||||
- "assumptions — bifrost pin >=0.10.0 (build_combined_app + mandatory affect.fetch)"
|
||||
- "get() BRIEF — the sync read seam fetch() wraps (no longer 'affect.fetch RESERVED')"
|
||||
- "Data flow — add the fetch read-back path"
|
||||
REMOVED:
|
||||
- "the 'affect.fetch / affect:read RESERVED in v1' out-of-scope line"
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
ratatoskr is the v1 **Bifrost consumer** — the durable persistence Worldtree
|
||||
writes Tier-3 agent state into. This contract specifies the **affect plane**
|
||||
slice: the first tracer-bullet through the whole consumer wire (handshake →
|
||||
per-dispatch JWT → dispatch → store → conformance), chosen first because
|
||||
`affect.*` has exactly one verb over an opaque blob, so it proves the pipes with
|
||||
minimal store complexity before the heavier `memory.*` plane. We implement
|
||||
**bifrost's own** `affect`-store shape (not worldtree-memory's), hand it to
|
||||
`bifrost.consumer.build_affect_app`, and mount the Starlette app. The wire
|
||||
semantics are parity-proven against `bifrost.consumer.testing.InMemoryAffectStore`
|
||||
(the executable reference).
|
||||
|
||||
The boundary is absolute (ADR-0001/0002/0009): **Worldtree appraises and decides
|
||||
affect; we only persist and round-trip it.** We run no affect logic.
|
||||
|
||||
## Data flow
|
||||
|
||||
- **In:** Worldtree's post-turn affect emit → `POST /bifrost/affect-call` →
|
||||
library validates envelope + per-dispatch JWT → `store.emit(snapshot, *,
|
||||
idempotency_key, ctx, idempotency_class=None)`.
|
||||
- **Snapshot shape:** `{agent_id, end_user_id, pad, valence, persona_baselines,
|
||||
emitted_at}`. We read **only** `agent_id` + `end_user_id` (the addressing
|
||||
keys); the rest is opaque payload.
|
||||
- **At rest:** two SQLite tables —
|
||||
- `affect_snapshots(agent_id, end_user_id, snapshot_json, arrived_at,
|
||||
PRIMARY KEY (agent_id, end_user_id))` — one row per pair, holding the
|
||||
**verbatim** snapshot JSON; LWW-overwritten on each new arrival. `arrived_at`
|
||||
is **audit/debug only** (never used for ordering, never returned).
|
||||
- `affect_idempotency(idempotency_id, digest, expires_at,
|
||||
PRIMARY KEY (idempotency_id))` — the per-(actor, idempotency_key) replay/
|
||||
conflict cache: `digest` is a content fingerprint of the snapshot;
|
||||
`expires_at` records the short-retry deadline for a future pruning pass
|
||||
(TTL eviction deferred — see INV-009).
|
||||
- **Out (emit):** `{"stored": True}` ack (the library wraps it with the transport
|
||||
`{"success": True}` envelope).
|
||||
- **Fetch (read-back):** Worldtree's `affect.fetch` → `POST /bifrost/affect-call`
|
||||
→ `store.fetch(agent_id=..., end_user_id=...)` → `{"found": False}` or
|
||||
`{"found": True, "snapshot": <verbatim snapshot>}` (the library wraps it via
|
||||
`affect_result(**fetched)`). The snapshot is returned opaque/verbatim — `fetch`
|
||||
never reads `pad` / `valence` / `persona_baselines` / `emitted_at` (INV-001).
|
||||
|
||||
**Async surface:** `emit` and `fetch` are `async def` (the bifrost consumer
|
||||
Protocol awaits them); `open_affect_store` and `get` are sync (no I/O await —
|
||||
`get` is the read-back seam `fetch` wraps). The `FN` lines below omit the
|
||||
`async` keyword only because the contract grammar's `FN <name>` form has no
|
||||
async marker.
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-001** [hard]: **Conduit opacity** (inlined from bifrost
|
||||
`affect.contract.md` INV-001 so this contract stands alone). The store's OWN
|
||||
logic references ONLY `snapshot["agent_id"]` and `snapshot["end_user_id"]`. It
|
||||
MUST NOT index, attribute-access, validate, compare, or branch on `pad` /
|
||||
`valence` / `persona_baselines` / `emitted_at`. Mechanically serializing the
|
||||
whole dict (`json.dumps`) and hashing the bytes is explicitly PERMITTED — that
|
||||
is non-semantic serialization, not a field read. The distinction the
|
||||
implementer must preserve: *serialize-the-whole-blob* = allowed;
|
||||
*read-a-payload-field-and-act-on-it* = forbidden.
|
||||
- **INV-002** [hard]: **Last-write-wins by ARRIVAL across distinct emits.** For a
|
||||
given `(agent_id, end_user_id)`, the most recently arrived emit (a *distinct*
|
||||
idempotency_id — see INV-008) overwrites the snapshot row. **Arrival order =
|
||||
the order in which `emit`'s upsert transaction commits** (serialized under
|
||||
SQLite's single-writer model). `emitted_at` is NEVER compared — Worldtree
|
||||
throttles + sequences emits, so arrival order at the conduit is the intended
|
||||
semantics.
|
||||
- **INV-003** [hard]: The snapshot is persisted **verbatim** in the sense of
|
||||
**semantic round-trip**: the stored bytes are the store's canonical
|
||||
serialization (`json.dumps(..., sort_keys=True)`), and a read (`get`)
|
||||
deserializes to a Python object EQUAL to the input snapshot
|
||||
(`snapshot_out == snapshot_in`). "Verbatim" does NOT promise byte-equality with
|
||||
the caller's original wire bytes — key order, whitespace, and numeric
|
||||
formatting may differ; only value-equality of the decoded object is guaranteed.
|
||||
- **INV-004** [hard]: `emit` returns exactly `{"stored": True}` on every
|
||||
successful persist AND on a recognized replay (Worldtree's emitter validates
|
||||
`stored` specifically).
|
||||
- **INV-005** [hard]: The store advertises `affect_supported = True`; it is the
|
||||
REQUIRED store — `build_affect_app(store=None, ...)` raises (no silent
|
||||
in-memory default). See INV-010 for the full affect-capability surface.
|
||||
- **INV-006** [hard]: Authorization identity/scope — and the **idempotency
|
||||
actor** — are taken from `ctx` (DispatchContext), never from the snapshot or
|
||||
other call arguments. The snapshot addressing keys are used ONLY as the
|
||||
persistence key, not as an auth claim.
|
||||
- **INV-007** [hard]: Each emit's snapshot upsert **and** its idempotency record
|
||||
commit in ONE transaction; no partial state (a snapshot without its
|
||||
idempotency row, or vice-versa) is ever observable.
|
||||
- **INV-008** [hard]: **Idempotency = replay-or-conflict, keyed by
|
||||
`(actor-from-ctx, idempotency_key)`.** On emit, compare against the cached
|
||||
digest for that idempotency_id:
|
||||
- **no entry** → new arrival: persist (LWW per INV-002) + record the digest,
|
||||
return `{"stored": True}`.
|
||||
- **entry, same digest** → **replay**: no second snapshot write, return
|
||||
`{"stored": True}`.
|
||||
- **entry, different digest** → the client reused a key for different content:
|
||||
**raise `AffectIdempotencyConflict`** (the library maps it to the wire 409).
|
||||
This is NOT an LWW overwrite — overwrites happen across *distinct* keys only.
|
||||
- **INV-009** [soft, recovery_window=∞]: **Idempotency-cache TTL pruning is
|
||||
deferred.** bifrost's reference prunes idempotency entries on a short-retry
|
||||
window; v1 records `expires_at` but does not evict, so `affect_idempotency`
|
||||
grows unbounded until a follow-up pruning patch. Wire-observable behavior is
|
||||
unaffected (replay/conflict still resolve correctly); only cache size is.
|
||||
`affect_snapshots` is already bounded to one row per `(agent_id, end_user_id)`.
|
||||
- **INV-010** [hard]: **The affect capability is `affect_supported` + `emit` +
|
||||
`fetch`, strong-or-absent** (bifrost ≥0.10.0 `_supports_affect_plane`,
|
||||
`bifrost/affect.py:75-80`; the INV-012 no-degraded-path rule). bifrost gates
|
||||
EVERY affect op (emit included) on all three being present, so a store missing
|
||||
a callable `fetch` is rejected with `affect.unsupported_capability` and the
|
||||
handshake never advertises `affect`. We therefore implement `fetch` fully (not
|
||||
a stub) — the canonical surface admits no emit-only affect store.
|
||||
|
||||
## Concurrency
|
||||
|
||||
SQLite in WAL mode (concurrent readers, single writer). `emit` writes are
|
||||
serialized by the per-`(agent_id, end_user_id)` primary key; last-write-wins is
|
||||
the upsert itself. No cross-row coordination — affect rows are independent.
|
||||
|
||||
## Division of labor (library vs store)
|
||||
|
||||
A crisp line, since the responsibilities interleave: the **bifrost library** owns
|
||||
the entire wire — envelope validation, per-dispatch JWT verification, scope
|
||||
authorization, error mapping (including mapping the store's `AffectInvalidArguments`
|
||||
/ `AffectIdempotencyConflict` to transport status), capability negotiation, route
|
||||
exposure. **This contract** owns ONLY the store (`emit` + `get` + the SQLite
|
||||
persistence) and the thin `build_affect_provider_app` wiring. The store raises
|
||||
bifrost's typed exceptions; the library decides the wire status. `emit`'s
|
||||
defensive addressing-key check (PRE-001) is belt-and-suspenders — the wire should
|
||||
already have rejected a malformed envelope.
|
||||
|
||||
## Integration points
|
||||
|
||||
- `bifrost.consumer.build_affect_app(store, verifier, registration)` → Starlette ASGI app.
|
||||
- `bifrost.reference_server.JwtVerifier(algorithm="HS256", key_bytes=...)`.
|
||||
- `bifrost.consumer.ConsumerRegistration(consumer_id="ratatoskr")`.
|
||||
- `bifrost.affect.AffectInvalidArguments` / `AffectIdempotencyConflict` — the typed
|
||||
exceptions the store raises; the library maps them to wire status.
|
||||
- **Conformance (tests only):** `bifrost.consumer.testing.InMemoryAffectStore`
|
||||
+ `bifrost.affect.dispatch_affect_call` — the #195 parity pattern.
|
||||
|
||||
## Constraints
|
||||
|
||||
- **[security]** Never read or log the affect payload (`pad`/`valence`/
|
||||
`persona_baselines`); opacity is a security + correctness boundary, not just a
|
||||
style choice.
|
||||
- **[compatibility]** Implement bifrost's affect-store shape exactly; raise its
|
||||
typed exceptions; never fork the wire/engine/auth. Custom behavior, if ever
|
||||
needed, goes through `Hooks` in a namespace OUTSIDE `affect.*` (ADR-0005).
|
||||
- **[correctness]** Do not compare `emitted_at` anywhere (would both read the
|
||||
payload and break arrival-order LWW).
|
||||
|
||||
## Out of scope (deferred — do NOT flag as drift)
|
||||
|
||||
- **Idempotency-cache TTL pruning** (INV-009): `affect_idempotency` rows
|
||||
accumulate without eviction in v1; `expires_at` is recorded but not acted on.
|
||||
The short-retry-window pruning pass is a follow-up patch.
|
||||
- **The `memory.*` plane**: this slice is affect-only; the memory store + its
|
||||
Protocol are a later contract.
|
||||
- **The combined two-plane server** (guide §7): one handshake negotiating both
|
||||
memory + affect is deferred; `build_affect_provider_app` mounts affect alone.
|
||||
- **`affect:read` scope enforcement / persona-baseline rehydrate shaping**: the
|
||||
library owns scope auth (`affect:read` for fetch); `fetch` returns the stored
|
||||
blob verbatim — any richer rehydrate shaping beyond a snapshot round-trip is
|
||||
Worldtree's concern, not the store's.
|
||||
- **`idempotency_class`**: accepted and ignored (affect.* uses a single
|
||||
short-retry class).
|
||||
- **WAL/concurrency hardening, deployment DB path, auth-key provisioning**:
|
||||
wiring/ops concerns, not this contract's function-block surface.
|
||||
|
||||
```contract
|
||||
FN open_affect_store(db_path: str) -> RatatoskrAffectStore
|
||||
BRIEF: Open the SQLite-backed affect store, creating the schema on first use.
|
||||
PRE: [PRE-001 hard] db_path is a writable path or ":memory:" -- guard clause
|
||||
POST: [POST-001 return_value] returned store has affect_supported is True -- assert store.affect_supported is True
|
||||
POST: [POST-002 state_change] tables affect_snapshots + affect_idempotency exist -- assert schema present
|
||||
STEPS:
|
||||
1. [setup] CONNECT sqlite3 to db_path; SET journal_mode=WAL (skip for ":memory:")
|
||||
2. [sequential, flexibility=prescriptive] CREATE TABLE IF NOT EXISTS affect_snapshots (
|
||||
agent_id TEXT NOT NULL, end_user_id TEXT NOT NULL,
|
||||
snapshot_json TEXT NOT NULL, arrived_at TEXT,
|
||||
PRIMARY KEY (agent_id, end_user_id))
|
||||
3. [sequential, flexibility=prescriptive] CREATE TABLE IF NOT EXISTS affect_idempotency (
|
||||
idempotency_id TEXT PRIMARY KEY, digest TEXT NOT NULL, expires_at REAL)
|
||||
4. [cleanup] RETURN RatatoskrAffectStore(conn)
|
||||
TESTS:
|
||||
fresh_db [happy,tracer]: open ":memory:" → store.affect_supported is True; both tables queryable
|
||||
reopen [happy]: open existing file twice → no error, schema idempotent
|
||||
```
|
||||
|
||||
```contract
|
||||
FN emit(self, snapshot: dict, *, idempotency_key: str, ctx: DispatchContext, idempotency_class: str | None = None) -> dict
|
||||
BRIEF: Persist a Worldtree affect snapshot verbatim — conduit-opaque, replay-or-conflict idempotent, last-write-wins by arrival across distinct keys.
|
||||
PRE: [PRE-001 hard] snapshot["agent_id"] and snapshot["end_user_id"] are non-empty strings -- else raise AffectInvalidArguments (defensive; the wire should prevent)
|
||||
PRE: [PRE-002 hard] idempotency_key is a non-empty string -- else raise AffectInvalidArguments
|
||||
POST: [POST-001 return_value] returns {"stored": True} on persist AND on recognized replay -- assert result == {"stored": True} (INV-004)
|
||||
POST: [POST-002 side_effect] after a new arrival, get(agent_id, end_user_id) deserializes equal to input -- (INV-003)
|
||||
POST: [POST-003 state_change] same idempotency_id + same digest → no second snapshot write, {"stored": True}; same idempotency_id + different digest → AffectIdempotencyConflict (INV-008)
|
||||
ERROR_ROUTING:
|
||||
AffectInvalidArguments:
|
||||
local_handling: raise on missing/empty addressing keys or empty idempotency_key
|
||||
flow_control: abort
|
||||
state_recovery: none (no write performed)
|
||||
AffectIdempotencyConflict:
|
||||
local_handling: raise when idempotency_id is cached with a different digest
|
||||
flow_control: abort
|
||||
state_recovery: none (prior snapshot + idempotency row untouched)
|
||||
sqlite3.OperationalError:
|
||||
local_handling: let propagate (library maps to transport error)
|
||||
flow_control: abort
|
||||
state_recovery: transaction rolled back — no partial row (INV-007)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] IF "agent_id"/"end_user_id" missing or not non-empty str: RAISE AffectInvalidArguments. IF not idempotency_key: RAISE AffectInvalidArguments. ELSE READ agent_id, end_user_id -- the ONLY snapshot fields read (INV-001)
|
||||
2. [sequential, flexibility=indicative] SET digest = sha256(json.dumps(snapshot, sort_keys=True, separators=(",", ":"))).hexdigest(); SET actor = ctx-derived actor (INV-006); SET idempotency_id = f"affect.emit|{actor}|{idempotency_key}" -- whole-blob hash is opacity-safe
|
||||
3. [branch] SELECT digest FROM affect_idempotency WHERE idempotency_id = ?:
|
||||
IF row exists AND stored digest == digest: RETURN {"stored": True} -- replay no-op (INV-008)
|
||||
IF row exists AND stored digest != digest: RAISE AffectIdempotencyConflict("idempotency key reused with different payload")
|
||||
4. [sequential, flexibility=prescriptive] BEGIN; UPSERT affect_snapshots (agent_id, end_user_id, snapshot_json=blob, arrived_at=<wall-clock>); UPSERT affect_idempotency (idempotency_id, digest, expires_at=<now + short_retry_ttl>); COMMIT -- LWW + idempotency record in ONE transaction (INV-002, INV-007). Do NOT compare emitted_at.
|
||||
5. [cleanup] RETURN {"stored": True} (INV-004)
|
||||
TESTS:
|
||||
basic_emit [happy,tracer]: valid snapshot → {"stored": True}; get() round-trips semantically equal (out == in)
|
||||
opacity [adversarial]: snapshot carrying arbitrary extra/unknown payload fields → persists + round-trips verbatim + returns stored:True (store never validates or branches on payload); AND two snapshots for the same key differing ONLY in payload address the SAME row (behavioral opacity — not attribute-access booby-trapping, which dict __getitem__/json.dumps would not trigger)
|
||||
lww_by_arrival [scenario]: emit A then emit B (DISTINCT idempotency keys, different payload, OLDER emitted_at on B) for same (agent,user) → get() == B; emitted_at never compared
|
||||
replay_noop [happy]: same idempotency_key + same payload twice → {"stored": True} both; one snapshot row, get() == payload
|
||||
idempotency_conflict [adversarial]: same idempotency_key + DIFFERENT payload → second emit raises AffectIdempotencyConflict; first snapshot unchanged
|
||||
missing_key [adversarial]: snapshot without "end_user_id" → raises AffectInvalidArguments; no row written
|
||||
parity_vs_reference [scenario]: drive identical affect.emit envelopes (happy + conflict) through dispatch_affect_call against InMemoryAffectStore and RatatoskrAffectStore → (status, body) tuples agree (#195)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN get(self, agent_id: str, end_user_id: str) -> dict | None
|
||||
BRIEF: Sync read-back seam returning the verbatim stored snapshot (or None). The async wire verb fetch() wraps this; tests / the D2 read route / rehydrate-seed also use it directly.
|
||||
POST: [POST-001 return_value] returns the verbatim snapshot for the key, or None if absent -- (INV-003)
|
||||
STEPS:
|
||||
1. [sequential] SELECT snapshot_json FROM affect_snapshots WHERE agent_id = ? AND end_user_id = ?
|
||||
2. [cleanup] RETURN json.loads(snapshot_json) IF row else None
|
||||
TESTS:
|
||||
get_absent [boundary]: no row for key → None
|
||||
get_after_emit [happy]: returns the emitted snapshot, deserialized equal
|
||||
```
|
||||
|
||||
```contract
|
||||
FN fetch(self, agent_id: str, end_user_id: str) -> dict
|
||||
BRIEF: Wire affect.fetch read handler — return the stored snapshot in bifrost's {found, snapshot} shape, conduit-opaque. Mirrors the reference InMemoryAffectStore.fetch verbatim (INV-010 strong-or-absent: this method MUST exist for the affect cap to advertise/dispatch).
|
||||
PRE: [PRE-001 hard] agent_id and end_user_id are non-empty strings -- else raise AffectInvalidArguments (mirrors reference; the wire validates the envelope first, this is belt-and-suspenders)
|
||||
POST: [POST-001 return_value] returns {"found": False} when no snapshot for the key -- (the library wraps via affect_result(**fetched))
|
||||
POST: [POST-002 return_value] returns {"found": True, "snapshot": <verbatim snapshot>} when present; snapshot deserializes equal to the emitted snapshot -- (INV-003)
|
||||
POST: [POST-003 return_value] never reads pad/valence/persona_baselines/emitted_at — returns the whole blob opaque -- (INV-001)
|
||||
ERROR_ROUTING:
|
||||
AffectInvalidArguments:
|
||||
local_handling: raise on missing/empty agent_id or end_user_id
|
||||
flow_control: abort
|
||||
state_recovery: none (read-only; no state touched)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] IF agent_id/end_user_id missing or not non-empty str: RAISE AffectInvalidArguments
|
||||
2. [sequential] SET snap = self.get(agent_id, end_user_id) -- the existing sync read seam; whole-blob json.loads, no field reads (INV-001)
|
||||
3. [branch] IF snap is None: RETURN {"found": False}
|
||||
4. [cleanup] RETURN {"found": True, "snapshot": snap}
|
||||
TESTS:
|
||||
fetch_absent [boundary]: no row for key → {"found": False}
|
||||
fetch_after_emit [happy,tracer]: emit then fetch → {"found": True, "snapshot": equals the emitted snapshot}
|
||||
fetch_missing_key [adversarial]: empty/missing agent_id or end_user_id → raises AffectInvalidArguments
|
||||
parity_vs_reference_fetch [scenario]: drive identical affect.fetch envelopes (found + not-found) through dispatch_affect_call against InMemoryAffectStore and RatatoskrAffectStore → (status, body) tuples agree (#195)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_affect_provider_app(store: RatatoskrAffectStore, heimdall_key: bytes, consumer_id: str = "ratatoskr") -> Starlette
|
||||
BRIEF: Wire the JWT verifier + registration and hand the store to bifrost's build_affect_app.
|
||||
PRE: [PRE-001 hard] store.affect_supported is True -- assert getattr(store, "affect_supported", False) is True (INV-005)
|
||||
PRE: [PRE-002 hard] heimdall_key is non-empty bytes -- assert
|
||||
POST: [POST-001 return_value] returns a Starlette app exposing POST /bifrost/handshake and POST /bifrost/affect-call -- assert routes present
|
||||
STEPS:
|
||||
1. [setup] SET verifier = JwtVerifier(algorithm="HS256", key_bytes=heimdall_key)
|
||||
2. [setup] SET registration = ConsumerRegistration(consumer_id=consumer_id)
|
||||
3. [sequential, flexibility=prescriptive] SET app = build_affect_app(store=store, verifier=verifier, registration=registration)
|
||||
4. [cleanup] RETURN app
|
||||
TESTS:
|
||||
builds_app [happy,tracer]: valid store + key → Starlette app with the two routes
|
||||
non_advertising_store [adversarial]: store with affect_supported=False → rejected (PRE-001 or library raises affect.unsupported_capability)
|
||||
bad_key [error]: empty heimdall_key → raises at construction
|
||||
```
|
||||
@@ -0,0 +1,345 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "ratatoskr.provider.memory_store"
|
||||
purpose: "Memory-plane Bifrost consumer (v1 basic plane): a SQLite+sqlite-vec-backed durable memory store Worldtree persists Tier-3 agent memory chunks into and recalls via vector search."
|
||||
touches:
|
||||
- src/ratatoskr/provider/memory_store.py
|
||||
- tests/test_provider_memory.py
|
||||
language: "python"
|
||||
complexity: "high"
|
||||
estimated_loc: 320
|
||||
confidence: 0.82
|
||||
assumptions:
|
||||
- "bifrost>=0.6.1 exposes build_memory_app, dispatch_memory_call, JwtVerifier, ConsumerRegistration, StoreCapabilities, MemoryDataStore, InvalidArguments, IdempotencyConflict, RevisionMismatch per bifrost/reference_server/memory.py + bifrost.memory."
|
||||
- "v1 = worldtree-dev's BASIC PLANE only (search / get / get_many / upsert_many / delete_many + describe_store + health), the ONLY surface Tier-3's live path touches (#294); Worldtree v0.35.3 already negotiates it."
|
||||
- "Chunk record field names are taken from the reference store (named inline below) but the AUTHORITATIVE pin is TDD against InMemoryMemoryStore, as it was for affect."
|
||||
- "Embedding dimension matches Worldtree's PINNED_EMBEDDER_DIM, supplied as config (env RATATOSKR_MEMORY_EMBEDDING_DIM); the sqlite-vec virtual table is created at that fixed dim."
|
||||
open_questions:
|
||||
- "Whether the memory DB shares one SQLite file with affect or its own — default SEPARATE per plane; the dev-shell entrypoint reads RATATOSKR_MEMORY_DB (analogous to RATATOSKR_AFFECT_DB). Revisit at the combined two-plane server (guide §7)."
|
||||
external_invariants:
|
||||
- source: ~/development/bifrost/bifrost/reference_server/memory.py
|
||||
invariant_id: "InMemoryMemoryStore"
|
||||
- source: ~/development/bifrost/docs/implementing-a-consumer.md
|
||||
invariant_id: "§5 memory plane"
|
||||
revisions:
|
||||
- version: "1.2"
|
||||
at: 2026-06-16
|
||||
summary: "Repin bifrost 0.7.0→0.8.0 (wire v0.5→v0.6, #11): search `scope_filter` split into `scope_all` (AND/intersection) + `scope_any` (OR/union over a list of conjunctive scopes). No-compat: `scope_filter` removed. Adds union-visibility recall in one call — the fix for the #295/#297 AND silent-zero foot-gun. Store at parity with the v0.6 reference `_matches_scope` / `_validate_scope`."
|
||||
delta:
|
||||
MODIFIED:
|
||||
- "search signature: scope_filter -> scope_all + scope_any"
|
||||
- "INV-005 scope isolation -> composed v0.6 (scope_all AND ∧ scope_any OR-union)"
|
||||
- "PRE-003 validates axes in BOTH fields; STEP 1 = _validate_scope (shape + lattice)"
|
||||
ADDED:
|
||||
- "scope_any_union test (#295/#297 union capability); both-fields-empty match-all"
|
||||
- version: "1.1"
|
||||
at: 2026-06-15
|
||||
summary: "Heid-contract-review fixup: semantic-not-byte-equal round-trip; reconcile idempotency 4-tuple; search returns top_k IN-SCOPE; define recalled_view + scope_filter + named field keys inline; clarify metadata_filter-v1 + transaction-term + delete atomicity + get_many + revision-on-replay; drop scan from INV-005."
|
||||
delta:
|
||||
MODIFIED:
|
||||
- "INV-001 byte-equal -> semantic round-trip; named structural field keys inline"
|
||||
- "INV-002 idempotency_id = (\"default\", verb, actor, key) — reconciled with STEPS"
|
||||
- "INV-005 search only (scan was deferred)"
|
||||
- "search: top_k in-scope, scope_filter shape, recalled_view, metadata_filter-v1 reject"
|
||||
- "delete_many atomicity; get_many clarified; transaction-term clarified"
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
The second plane of ratatoskr's Tier-3 Bifrost consumer (after the shipped affect
|
||||
plane). A **SQLite + sqlite-vec** durable store Worldtree writes agent **memory
|
||||
chunks** into (`upsert_many`) and recalls from by **vector similarity**
|
||||
(`search`), plus point reads (`get`/`get_many`) and deletes (`delete_many`).
|
||||
v1 is worldtree-dev's **basic plane** — the only surface Tier-3's live path uses;
|
||||
the gated verbs (edges, scan, atomic_supersede, mark_*, patch, maintenance) are
|
||||
deferred. We implement **bifrost's own** `MemoryDataStore` Protocol and hand it to
|
||||
`build_memory_app`. Conformance is #195 parity vs `InMemoryMemoryStore`.
|
||||
|
||||
The boundary (ADR-0001/0002/0009): **Worldtree owns intelligence — appraisal,
|
||||
consolidation, trust; we own permanence.** But unlike affect (blind conduit),
|
||||
memory is a **structural index**: we read a few fields of each chunk —
|
||||
`record["embedding"]` (rank), `record["scope"]` (isolation), `record["id"]` +
|
||||
revision (optimistic locking), and `origin`/`injection_source` (the consistency
|
||||
rule). The semantic content, `record["distillate"]`, and inert fields
|
||||
(`trust_tier`/`provenance`/`source_role`) are persisted verbatim and never
|
||||
interpreted.
|
||||
|
||||
## Data flow
|
||||
|
||||
- **In:** Worldtree → `POST /bifrost/memory-call` → library validates envelope +
|
||||
per-dispatch JWT → the verb on our store.
|
||||
- **Chunk record (key fields we read; rest is opaque payload):** `id` (the chunk
|
||||
id — reference falls back to `chunk_id`/`memory_id`), `embedding` (the vector —
|
||||
fallback `vector`), `scope` (a `{axis: value}` dict — the isolation key),
|
||||
`origin` + `injection_source` (consistency rule), `distillate` (the recall
|
||||
view). Everything else (content, `metadata`, `trust_tier`, …) is stored verbatim.
|
||||
- **At rest:** SQLite —
|
||||
- `memory_chunks(chunk_id PK, record_json, revision, scope_json, origin, ...)` —
|
||||
the verbatim chunk + extracted columns (chunk_id, scope) for isolation.
|
||||
- sqlite-vec virtual table `memory_vec(chunk_id, embedding[<dim>])` — the index.
|
||||
- `memory_idempotency(idempotency_id PK, digest, expires_at)` — replay/conflict
|
||||
cache (affect-parallel shape).
|
||||
- **Out:** `upsert_many` → `{"upserted": N, "replayed": bool}`; `search` → list of
|
||||
`{chunk, chunk_id, score, recalled_view, revision}` where **`recalled_view`** =
|
||||
the chunk's `distillate` field, or the whole chunk if absent (per the reference);
|
||||
`delete_many` → `{"deleted": N}`; `get` → the verbatim record + a `revision` key,
|
||||
or `None`; `get_many(ids)` → the list form of `get` (found records only).
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-001** [hard]: **Persist verbatim (semantic round-trip); read only the
|
||||
structural surface.** The whole chunk is stored and a read deserializes to a
|
||||
Python object EQUAL to the input (`json.loads(record_json) == input`) — **not**
|
||||
byte-equal (key order / formatting may differ); `get` additionally attaches a
|
||||
`revision` key to the returned object. The store reads ONLY `record["embedding"]`,
|
||||
`record["scope"]`, `record["id"]` + revision, and `origin`/`injection_source`.
|
||||
Content / `distillate` / inert fields (`trust_tier`/`provenance`/`source_role`)
|
||||
are NOT interpreted.
|
||||
- **INV-002** [hard]: **Idempotency = replay-or-conflict, actor-scoped** (affect-
|
||||
parallel). `idempotency_id = ("default", <verb>, _ctx_actor(ctx), idempotency_key)`
|
||||
— the literal `"default"` class slot + the verb name, matching the reference
|
||||
4-tuple (`idempotency_class` tunes only the cache TTL, not the id). Same digest →
|
||||
replay (`replayed: True`, no re-write); different digest → raise
|
||||
`IdempotencyConflict`. Actor from `ctx`, never from the record.
|
||||
- **INV-003** [hard]: **Optimistic locking.** When `upsert_many` carries
|
||||
`expected_revisions`, each record's stored revision must equal the expected; any
|
||||
mismatch → raise `RevisionMismatch` and the whole batch rolls back. Each
|
||||
successful upsert increments the chunk's revision (a first insert → revision 1).
|
||||
- **INV-004** [hard]: **Atomic batch.** `upsert_many` applies all records + their
|
||||
vec rows + the idempotency record in one transaction; on any error nothing is
|
||||
persisted (no partial batch, no orphaned vec rows).
|
||||
- **INV-005** [hard]: **Scope isolation (wire v0.6, #11).** `search` filters by two
|
||||
explicit fields: `scope_all` (AND/intersection — record ⊇ every named axis) and
|
||||
`scope_any` (OR/union over a LIST of conjunctive scope dicts — record ⊇ ≥1 element,
|
||||
each element AND-matched as a whole). They compose by AND; both empty → no scope
|
||||
constraint. A search never returns a chunk outside the composed filter. Byte-faithful
|
||||
to the reference `_matches_scope`. (`scope_any` is the union-visibility primitive that
|
||||
resolves the #295/#297 silent-zero — a subset-scoped chunk now recalls via an OR member.)
|
||||
- **INV-006** [hard]: **Capabilities match implementation** (advertise-⇒-implement).
|
||||
`describe_store` advertises ONLY what is implemented: `relational_edges_supported=False`,
|
||||
`atomic_supersede_supported=False`, `transaction_supported=False`,
|
||||
`optimistic_locking_supported=True`, `filterable_metadata_fields=[]`,
|
||||
**`sortable_chunk_fields=[{"name": "updated_at", "type": "timestamp"}]`** (the ONLY
|
||||
globally-sortable field; gates `scan`'s sort at the bifrost dispatch `_validate_scan_sort`
|
||||
AND Worldtree's #349 person-prime Branch-A `"updated_at" in caps.sort_fields_supported` —
|
||||
advertising it is what lights up turn-1 durable-fact injection). Both `name` AND `type`
|
||||
are REQUIRED by the bifrost `handshake_response` `SortableChunkField` schema
|
||||
(`additionalProperties:false`) — omitting `type` fails wire-schema validation and breaks
|
||||
the ENTIRE handshake (memory + affect bind), not just the sort; `type` is advisory-only
|
||||
(the wire never interprets it).
|
||||
(`transaction_supported` is the bifrost **wire-level** multi-op transaction
|
||||
capability — NOT our internal SQLite transactions, which we use for atomic
|
||||
batches.) The client gates the gated verbs off these.
|
||||
- **INV-007** [hard]: `origin == "injected_context"` requires `injection_source`; a
|
||||
non-injected record carrying `injection_source` is rejected — both raise
|
||||
`InvalidArguments` (mirrors the reference).
|
||||
- **INV-008** [hard]: The store is REQUIRED (`build_memory_app(store=None)` raises);
|
||||
identity/scope/actor come from `ctx`, never call args.
|
||||
- **INV-009** [hard]: **`scan` is LIVE-only.** `scan` returns ONLY live chunks —
|
||||
superseded / tombstoned / any non-live governance state is EXCLUDED server-side. This
|
||||
is load-bearing because Worldtree's person-prime requests `lifecycle_state="live"` but
|
||||
that filter does NOT ride the scan wire today and the client does not re-check it
|
||||
(worldtree-dev flagged the adapter gap); server-side live-only is authoritative, so a
|
||||
dead fact can never inject. The additive `lifecycle_state` scan arg, when present, is
|
||||
honored but never relied upon.
|
||||
- **INV-010** [hard]: **`scan` is globally ordered before pagination.** The FULL
|
||||
scope-filtered live set is ordered by `(sort.field, direction)` GLOBALLY before the
|
||||
`limit` page is taken — never page-local. Missing sort value sorts LAST; ties broken by
|
||||
`chunk_id` (stable). A single `limit`-page returns the N globally-newest (for
|
||||
`updated_at desc`), matching bifrost's cross-pagination conformance negative. The sort
|
||||
field is indexed (`json_extract(record_json, '$.updated_at')`) so the read stays within
|
||||
person-prime's 500 ms fail-open budget.
|
||||
- **Cursor is v1-provisional (KNOWN DEVIATION — offset, not snapshot).** The cursor is a
|
||||
bare integer offset into the re-derived global order. This is CORRECT and conformant for
|
||||
the **single-page** person-prime call (`cursor=None`), which is the only shipped consumer.
|
||||
It **diverges from bifrost's protocol snapshot-cursor contract on multi-page continuation**:
|
||||
the dispatch engine (`bifrost.memory` scan branch) drops the `sort` arg on a cursor
|
||||
continuation because "the cursor's snapshotted order is authoritative", and maps
|
||||
`ScanCursorExpired → 410`. Our offset cursor (a) does NOT snapshot the order — a page taken
|
||||
after a concurrent write can duplicate/drop rows relative to the first page (heid-bug-hunt
|
||||
2026-07-15, all 3 arms), and (b) never raises `ScanCursorExpired`. The `global_before_paginate`
|
||||
/ cursor test asserts **static-store** behavior only. The durable/conformant fix is to adopt
|
||||
the reference `InMemoryMemoryStore`'s snapshot-cursor semantics (opaque token + frozen ordered
|
||||
id-list + TTL + `ScanCursorExpired`); DEFERRED pending bifrost-dev's ruling on the conformance
|
||||
gap (scan/cursor has NO conformance coverage today, so a non-snapshot cursor passes). Routed
|
||||
to bifrost-dev 2026-07-15.
|
||||
|
||||
## Concurrency
|
||||
|
||||
SQLite WAL (concurrent readers, single writer). `upsert_many`/`delete_many`
|
||||
serialize on the writer; `search`/`get` are concurrent reads. sqlite-vec index
|
||||
writes ride inside the upsert/delete transaction. The connection is opened
|
||||
`check_same_thread=False` with `PRAGMA busy_timeout=5000` (mirrors the affect store):
|
||||
the provider is an ASGI app, so uvicorn/Starlette (and TestClient always) may run a
|
||||
handler off the connection's creating thread — the event loop serializes the sync
|
||||
sqlite calls, so this is safe; busy_timeout preps the composite/standalone two-process
|
||||
topology over the same db. (Surfaced by a TestClient-driven memory `search` through the
|
||||
#18 D1 combined provider — the direct-store tests structurally could not.)
|
||||
|
||||
## Division of labor (library vs store)
|
||||
|
||||
The **bifrost library** owns the wire (envelope validation, per-dispatch JWT,
|
||||
scope authorization, error mapping of our typed exceptions, capability
|
||||
negotiation, routes). **This contract** owns the store (the basic verbs + SQLite
|
||||
+ sqlite-vec persistence/index) + the thin `build_memory_provider_app` wiring.
|
||||
|
||||
## Integration points
|
||||
|
||||
- `bifrost.consumer.build_memory_app(store, verifier, registration, maintenance_store=None, hooks=None)` → Starlette app.
|
||||
- `bifrost.reference_server.JwtVerifier` + `bifrost.consumer.ConsumerRegistration`.
|
||||
- `bifrost.memory.{StoreCapabilities, InvalidArguments, IdempotencyConflict, RevisionMismatch}` — typed surface.
|
||||
- **Conformance (tests):** `bifrost.consumer.testing.InMemoryMemoryStore` + `bifrost.memory.dispatch_memory_call` (#195). The reference is the authoritative pin for exact field names + wire shapes.
|
||||
- `sqlite-vec` — the vector index extension loaded into the connection.
|
||||
|
||||
## Constraints
|
||||
|
||||
- **[security]** Never log chunk content / `distillate`. Index the vector + scope; don't interpret semantics.
|
||||
- **[compatibility]** Implement bifrost's MemoryDataStore shape exactly; raise its typed exceptions; never fork the wire. Gated verbs are absent + advertised unsupported.
|
||||
- **[correctness]** `search` ranks by cosine over `record["embedding"]`; scope isolation (INV-005) is non-negotiable; `top_k` counts IN-SCOPE results (see search STEPS).
|
||||
|
||||
## Out of scope (deferred — do NOT flag as drift)
|
||||
|
||||
- **Gated/maintenance verbs:** `upsert_edges`/`get_edges_for`, `mark_invalid`/`mark_superseded`, `patch_many`, `atomic_supersede`, lease/checkpoint. Absent + advertised-unsupported. (`scan` is NO LONGER deferred — it is implemented + advertised via `sortable_chunk_fields` to light up Worldtree's #349 person-prime turn-1 durable-fact injection; see the `scan` FN spec + INV-009/INV-010.)
|
||||
- **metadata_filter beyond scope:** advertise `filterable_metadata_fields=[]`; a non-empty `metadata_filter` is unsupported in v1 (rejected — see search PRE).
|
||||
- **The combined two-plane server** (guide §7) — separate memory + affect apps in v1.
|
||||
- **Deployment** — dev-box background shell (`ratatoskr-memory-provider`), no systemd/infra.
|
||||
- **idempotency-cache TTL pruning** — `expires_at` recorded, eviction deferred (affect-parallel).
|
||||
|
||||
```contract
|
||||
FN open_memory_store(db_path: str, *, embedding_dim: int) -> RatatoskrMemoryStore
|
||||
BRIEF: Open the SQLite+sqlite-vec memory store, creating schema + the vec index on first use.
|
||||
PRE: [PRE-001 hard] db_path writable or ":memory:" -- guard
|
||||
PRE: [PRE-002 hard] embedding_dim is a positive int (matches Worldtree PINNED_EMBEDDER_DIM) -- assert
|
||||
POST: [POST-001 return_value] store.describe_store() advertises the v1 capability set (INV-006) -- assert
|
||||
POST: [POST-002 state_change] memory_chunks + memory_vec(dim) + memory_idempotency exist -- schema present
|
||||
STEPS:
|
||||
1. [setup] CONNECT sqlite3; enable_load_extension; LOAD sqlite-vec; WAL (skip for ":memory:")
|
||||
2. [sequential, flexibility=prescriptive] CREATE memory_chunks + memory_idempotency tables IF NOT EXISTS
|
||||
3. [sequential, flexibility=prescriptive] CREATE VIRTUAL TABLE memory_vec USING vec0(chunk_id TEXT PRIMARY KEY, embedding float[embedding_dim]) IF NOT EXISTS
|
||||
4. [cleanup] RETURN RatatoskrMemoryStore(conn, embedding_dim)
|
||||
TESTS:
|
||||
fresh_db [happy,tracer]: open ":memory:" dim=8 → describe_store() has the v1 caps; tables queryable
|
||||
reopen [happy]: open existing file twice → idempotent schema
|
||||
```
|
||||
|
||||
```contract
|
||||
FN describe_store(self) -> dict
|
||||
BRIEF: Static capability descriptor (sync, no I/O).
|
||||
POST: [POST-001 return_value] returns the bifrost StoreCapabilities dict with v1 values (INV-006) -- assert relational_edges/atomic_supersede/transaction False, optimistic_locking True, filterable_metadata_fields []
|
||||
STEPS:
|
||||
1. [cleanup] RETURN StoreCapabilities(relational_edges_supported=False, optimistic_locking_supported=True, atomic_supersede_supported=False, transaction_supported=False, filterable_metadata_fields=[]).to_dict()
|
||||
TESTS:
|
||||
caps [happy]: returns exactly the v1 capability dict; advertise-⇒-implement holds
|
||||
```
|
||||
|
||||
```contract
|
||||
FN upsert_many(self, records: list[dict], *, idempotency_key: str, ctx, expected_revisions: dict | None = None, idempotency_class: str | None = None) -> dict
|
||||
BRIEF: Persist chunks verbatim + index their vectors, atomically, replay-or-conflict idempotent, optimistic-locked.
|
||||
PRE: [PRE-001 hard] idempotency_key non-empty str -- else InvalidArguments
|
||||
PRE: [PRE-002 hard] each injected_context record has injection_source; non-injected has none -- else InvalidArguments (INV-007)
|
||||
POST: [POST-001 return_value] {"upserted": len(records), "replayed": False} on persist; {"...","replayed": True} on replay (INV-002) -- assert
|
||||
POST: [POST-002 state_change] each chunk stored verbatim + vector indexed + revision incremented (first insert → 1); expected_revisions enforced (INV-003) -- assert
|
||||
POST: [POST-003 side_effect] on ANY error, nothing persisted (INV-004) -- rollback
|
||||
ERROR_ROUTING:
|
||||
InvalidArguments: { local_handling: raise on bad key / injection_source rule, flow_control: abort, state_recovery: none }
|
||||
IdempotencyConflict: { local_handling: raise on key-reuse-different-digest, flow_control: abort, state_recovery: none }
|
||||
RevisionMismatch: { local_handling: raise on stale expected_revision, flow_control: abort, state_recovery: full batch rollback }
|
||||
STEPS:
|
||||
1. [setup] validate idempotency_key; digest over {records, expected_revisions}; idempotency_id = ("default", "upsert_many", _ctx_actor(ctx), idempotency_key) -- matches INV-002
|
||||
2. [branch] idempotency lookup: same digest → RETURN replayed; different → RAISE IdempotencyConflict
|
||||
3. [sequential, flexibility=prescriptive] BEGIN; IF expected_revisions: assert each stored revision matches else RAISE RevisionMismatch
|
||||
4. [loop] FOR each record: validate origin/injection_source; UPSERT memory_chunks (record_json + scope_json, revision+1); UPSERT memory_vec(record["id"], record["embedding"])
|
||||
5. [sequential] record idempotency (digest, expires_at = now + ttl(idempotency_class)); COMMIT
|
||||
6. [cleanup] RETURN {"upserted": len(records), "replayed": False}
|
||||
TESTS:
|
||||
basic_upsert [happy,tracer]: 2 records → {"upserted":2,"replayed":False}; get() round-trips each verbatim + revision=1
|
||||
replay [happy]: same key+payload twice → first writes (revision 1), second {"replayed":True} with NO further write (revision stays 1)
|
||||
conflict [adversarial]: same key, different records → IdempotencyConflict; first batch intact
|
||||
optimistic_lock [adversarial]: expected_revisions stale → RevisionMismatch; nothing written
|
||||
injection_rule [adversarial]: injected_context w/o injection_source → InvalidArguments; no write
|
||||
parity_vs_reference [scenario]: same upsert_many envelopes through dispatch_memory_call vs InMemoryMemoryStore → wire bodies agree (#195)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN search(self, vector: list[float], *, top_k: int, scope_all: dict | None = None, scope_any: list | None = None, metadata_filter: dict | None = None, include: dict | None = None, fidelity_target=None) -> list[dict]
|
||||
BRIEF: Vector (cosine) recall over sqlite-vec, scoped by the v0.6 scope_all/scope_any filter, returning the top_k IN-SCOPE chunks.
|
||||
PRE: [PRE-001 hard] len(vector) == embedding_dim -- else InvalidArguments
|
||||
PRE: [PRE-002 hard] metadata_filter is empty/None -- v1 advertises no filterable fields; a non-empty filter → InvalidArguments
|
||||
PRE: [PRE-003 hard] scope_all is a flat dict and scope_any a list of flat dicts (else InvalidArguments); every axis in BOTH ∈ {end_user, group, tenant, agent_self} -- else InvalidFilter (memory.invalid_filter 400); the bifrost wire-v0.6 lattice, matching the reference _validate_scope (#10 agent_self canonical, #11 scope split)
|
||||
POST: [POST-001 return_value] returns the top_k highest-cosine records passing the composed v0.6 filter — `(scope_all empty OR record ⊇ scope_all) AND (scope_any empty OR record ⊇ ≥1 element)`; at most top_k, never fewer than min(top_k, in-scope count) (INV-005). Each: {chunk (verbatim), chunk_id, score, recalled_view (= chunk["distillate"] or chunk), revision} -- assert
|
||||
STEPS:
|
||||
1. [setup] scope_all ← scope_all or {}; scope_any ← scope_any or []; validate via _validate_scope (flat-dict / list-of-dicts shape + every axis ∈ the v0.6 lattice, else InvalidArguments / InvalidFilter)
|
||||
2. [sequential, flexibility=indicative] rank candidates by cosine over record["embedding"]; KEEP only records passing _matches_scope(scope_all, scope_any) (INV-005); THEN take top_k — so top_k counts IN-SCOPE hits, not pre-filter hits (over-fetch from the vec index or post-filter rank as needed)
|
||||
3. [cleanup] RETURN result rows (chunk verbatim + score + recalled_view + revision)
|
||||
TESTS:
|
||||
basic_search [happy,tracer]: upsert 3 scoped chunks, search → ranked by cosine, ≤ top_k, recalled_view present
|
||||
scope_isolation [adversarial]: two scopes, scope_all one → never returns the other's chunk, and returns top_k of the IN-SCOPE set even if out-of-scope chunks score higher (INV-005)
|
||||
scope_any_union [scenario]: scope_any=[{end_user:u},{agent_self:a}] recalls BOTH a subject-scoped and a self-scoped chunk in one call (#295/#297 union capability); scope_all+scope_any compose by AND
|
||||
empty [boundary]: search empty store → []; both fields empty → match all
|
||||
metadata_filter_rejected [adversarial]: non-empty metadata_filter → InvalidArguments
|
||||
lattice_axes [adversarial]: out-of-lattice axis in scope_all OR scope_any → InvalidFilter; non-list scope_any → InvalidArguments; agent_self admitted (wire v0.5, #10)
|
||||
parity_vs_reference [scenario]: identical search envelopes vs InMemoryMemoryStore → same ranked chunk_ids/shape (#195)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN get(self, chunk_id: str) -> dict | None
|
||||
BRIEF: Point read; returns the verbatim chunk + current revision, or None. get_many(ids) is the list form (found records only).
|
||||
POST: [POST-001 return_value] stored record (verbatim, json.loads) + "revision" key, or None if absent (INV-001) -- assert
|
||||
STEPS:
|
||||
1. [sequential] SELECT record_json, revision WHERE chunk_id; RETURN json.loads + revision, or None
|
||||
TESTS:
|
||||
get_hit [happy]: after upsert → record equal + revision present
|
||||
get_absent [boundary]: unknown id → None
|
||||
get_many [happy]: get_many([present, absent]) → [present record] only
|
||||
```
|
||||
|
||||
```contract
|
||||
FN delete_many(self, ids: list[str]) -> dict
|
||||
BRIEF: Delete chunks (+ their vec rows) by id, transactionally.
|
||||
POST: [POST-001 return_value] {"deleted": N} where N = ids that existed -- assert
|
||||
POST: [POST-002 state_change] in ONE transaction, deleted chunks gone from memory_chunks AND memory_vec; partial failure rolls back the whole batch (no orphan vec rows) -- assert
|
||||
STEPS:
|
||||
1. [sequential, flexibility=prescriptive] BEGIN; FOR each id present: DELETE from memory_chunks + memory_vec; count; COMMIT
|
||||
2. [cleanup] RETURN {"deleted": count}
|
||||
TESTS:
|
||||
delete_hit [happy]: delete 1 of 2 → {"deleted":1}; gone from chunks + vec; search won't surface it
|
||||
delete_absent [boundary]: unknown id → {"deleted":0}
|
||||
```
|
||||
|
||||
```contract
|
||||
FN scan(self, *, scope_all: dict | None = None, scope_any: list | None = None, cursor: str | None = None, limit: int, sort: dict | None = None, lifecycle_state=None) -> dict
|
||||
BRIEF: Query-LESS paginated LIVE-chunk scan, globally ordered by an advertised sort field (updated_at) — the #349 person-prime turn-1 durable-fact injection primitive (no query vector, unlike search). Returns {records, cursor}.
|
||||
PRE: [PRE-001 hard] limit is a positive int -- else InvalidArguments
|
||||
PRE: [PRE-002 hard] scope_all/scope_any shape + lattice-validated via _validate_scope (identical to search PRE-003) -- else InvalidArguments / InvalidFilter
|
||||
PRE: [PRE-003 hard] sort, when present, is {field, direction}: field ∈ the advertised sortable_chunk_fields names ("updated_at"), direction ∈ {asc,desc}. The bifrost dispatch layer (_validate_scan_sort) is the enforcement gate; an unadvertised/malformed sort → InvalidArguments — NEVER a silent unsorted fallback
|
||||
POST: [POST-001 return_value] {records: [<verbatim chunk wire records, same shape as a search hit's chunk>], cursor: <opaque next-page str | None>}; ≤ limit records; each record carries updated_at + agent_id + subject{type,id} + worldtree_scope (the fields person-prime's client _scan_filter_matches keys on — a record missing any is silently dropped client-side) -- assert
|
||||
POST: [POST-002 return_value] LIVE-only — returns ONLY live chunks; superseded/tombstoned excluded server-side (INV-009)
|
||||
POST: [POST-003 return_value] GLOBAL-order — the FULL scope-filtered live set is ordered by (sort.field, direction) GLOBALLY before the limit page; missing value LAST; chunk_id tiebreak (INV-010)
|
||||
STEPS:
|
||||
1. [setup] validate limit (>0) + scope (as search); sort ← the dispatch-validated {field,direction}
|
||||
2. [sequential, flexibility=indicative] SELECT scope-filtered LIVE chunks ordered by the indexed sort field (json_extract(record_json,'$.updated_at')) in `direction`, missing-last, chunk_id tiebreak, GLOBALLY; apply cursor offset; take limit
|
||||
3. [cleanup] RETURN {records: verbatim chunks, cursor: next-page-or-None}
|
||||
TESTS:
|
||||
scan_recency [happy,tracer]: upsert 4 live chunks w/ distinct updated_at; scan(scope_all={end_user}, limit=3, sort={field:updated_at,direction:desc}) → the 3 newest, newest-first
|
||||
global_before_paginate [scenario]: 5 chunks, limit=2 → page-1 = the 2 globally-newest; the cursor page continues the GLOBAL order, not a page-local re-sort (INV-010; bifrost cross-pagination conformance)
|
||||
live_only [adversarial]: a superseded/tombstoned chunk is NEVER returned even if it is the newest (INV-009)
|
||||
scope_isolation [adversarial]: scope_all one end_user → never returns another partition's chunk (INV-005 applies to scan)
|
||||
unadvertised_sort [adversarial]: sort.field ∉ sortable_chunk_fields → InvalidArguments at dispatch (never silent unsorted)
|
||||
person_prime_record_shape [scenario]: each record carries agent_id + subject{type,id} + worldtree_scope + updated_at + verbatim/distillate — the _scan_filter_matches keys (else the client silently drops it)
|
||||
parity_vs_reference [scenario]: identical scan envelopes vs InMemoryMemoryStore → same ordered chunk_ids/shape (#195)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_memory_provider_app(store: RatatoskrMemoryStore, heimdall_key: bytes, consumer_id: str = "ratatoskr") -> Starlette
|
||||
BRIEF: Wire JwtVerifier + registration; hand the store to bifrost's build_memory_app.
|
||||
PRE: [PRE-001 hard] store.describe_store() returns a dict (advertises caps) -- assert (INV-008)
|
||||
PRE: [PRE-002 hard] heimdall_key non-empty bytes -- assert
|
||||
POST: [POST-001 return_value] Starlette app exposing POST /bifrost/handshake + POST /bifrost/memory-call -- assert routes
|
||||
STEPS:
|
||||
1. [setup] verifier = JwtVerifier(HS256, heimdall_key); registration = ConsumerRegistration(consumer_id)
|
||||
2. [sequential, flexibility=prescriptive] app = build_memory_app(store=store, verifier=verifier, registration=registration)
|
||||
3. [cleanup] RETURN app
|
||||
TESTS:
|
||||
builds_app [happy,tracer]: valid store + key → app with the two routes (incl. POST)
|
||||
bad_key [error]: empty heimdall_key → raises at construction
|
||||
```
|
||||
@@ -1,5 +1,5 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Reference parser for .contract.md files (v1.0 and v2.0).
|
||||
"""Reference parser for .contract.md files (v1.0, v2.0, and v2.1).
|
||||
|
||||
Extracts all structured fields from a contract file without using an LLM.
|
||||
Proves the format is machine-parseable by a simple tool.
|
||||
@@ -100,9 +100,12 @@ class Contract:
|
||||
REQUIRED_FRONTMATTER_V1 = [
|
||||
"contract_version", "module", "purpose", "language", "min_complexity",
|
||||
]
|
||||
REQUIRED_FRONTMATTER_V2 = [
|
||||
REQUIRED_FRONTMATTER_V2_MODULE = [
|
||||
"contract_version", "module", "purpose", "language", "complexity",
|
||||
]
|
||||
REQUIRED_FRONTMATTER_V2_ISSUE = [
|
||||
"contract_version", "target_module", "scope", "language", "complexity", "prd",
|
||||
]
|
||||
RECOMMENDED_FRONTMATTER_V1 = ["depends_on", "used_by", "estimated_loc"]
|
||||
RECOMMENDED_FRONTMATTER_V2 = ["depends_on", "used_by", "estimated_loc", "confidence"]
|
||||
REQUIRED_BODY_SECTIONS = ["Context", "Data flow", "Invariants"]
|
||||
@@ -111,7 +114,18 @@ VALID_COMPLEXITIES_V2 = {"low", "medium", "high"}
|
||||
VALID_PRE_SEVERITIES = {"hard", "soft"}
|
||||
VALID_POST_CATEGORIES = {"return_value", "state_change", "side_effect", "exception"}
|
||||
VALID_STEP_TYPES = {"setup", "sequential", "branch", "loop", "error_handler", "cleanup"}
|
||||
VALID_TEST_CATEGORIES = {"happy", "error", "boundary", "edge", "security"}
|
||||
VALID_TEST_CATEGORIES_V20 = {"happy", "error", "boundary", "edge", "security"}
|
||||
VALID_TEST_CATEGORIES_V21 = VALID_TEST_CATEGORIES_V20 | {"scenario", "trace", "adversarial", "property"}
|
||||
|
||||
|
||||
_ISSUE_PATH_RE = re.compile(r"docs/contracts/issues/\d+\.contract\.md$")
|
||||
|
||||
|
||||
def _is_issue_scoped(contract: Contract) -> bool:
|
||||
"""Detect issue-scoped contracts per CONTRACT-FORMAT § 2.1.I."""
|
||||
if contract.source_path and _ISSUE_PATH_RE.search(str(contract.source_path)):
|
||||
return True
|
||||
return "prd" in contract.frontmatter
|
||||
|
||||
|
||||
@dataclass
|
||||
@@ -125,8 +139,13 @@ def validate_contract(contract: Contract) -> list[ValidationIssue]:
|
||||
issues: list[ValidationIssue] = []
|
||||
fm = contract.frontmatter
|
||||
is_v2 = contract.version.startswith("2")
|
||||
is_v21 = contract.version.startswith("2.1")
|
||||
issue_scoped = is_v2 and _is_issue_scoped(contract)
|
||||
|
||||
required_fm = REQUIRED_FRONTMATTER_V2 if is_v2 else REQUIRED_FRONTMATTER_V1
|
||||
if is_v2:
|
||||
required_fm = REQUIRED_FRONTMATTER_V2_ISSUE if issue_scoped else REQUIRED_FRONTMATTER_V2_MODULE
|
||||
else:
|
||||
required_fm = REQUIRED_FRONTMATTER_V1
|
||||
recommended_fm = RECOMMENDED_FRONTMATTER_V2 if is_v2 else RECOMMENDED_FRONTMATTER_V1
|
||||
valid_complexities = VALID_COMPLEXITIES_V2 if is_v2 else VALID_COMPLEXITIES_V1
|
||||
complexity_key = "complexity" if is_v2 else "min_complexity"
|
||||
@@ -198,10 +217,11 @@ def validate_contract(contract: Contract) -> list[ValidationIssue]:
|
||||
))
|
||||
|
||||
# v2: validate test categories
|
||||
valid_test_cats = VALID_TEST_CATEGORIES_V21 if is_v21 else VALID_TEST_CATEGORIES_V20
|
||||
for test in fn.tests:
|
||||
if test.category not in VALID_TEST_CATEGORIES:
|
||||
if test.category not in valid_test_cats:
|
||||
issues.append(ValidationIssue(
|
||||
"warning", f"{prefix}: test {test.name!r} category {test.category!r} not in {sorted(VALID_TEST_CATEGORIES)}"
|
||||
"warning", f"{prefix}: test {test.name!r} category {test.category!r} not in {sorted(valid_test_cats)}"
|
||||
))
|
||||
# Modifier tags (e.g. "tracer") get the same vocabulary check.
|
||||
for tag in test.tags:
|
||||
@@ -546,8 +566,13 @@ def print_human(contract: Contract) -> None:
|
||||
is_v2 = contract.version.startswith("2")
|
||||
complexity_key = "complexity" if is_v2 else "min_complexity"
|
||||
|
||||
print(f"Module: {fm.get('module', '?')}")
|
||||
print(f"Purpose: {fm.get('purpose', '?')}")
|
||||
issue_scoped = is_v2 and _is_issue_scoped(contract)
|
||||
if issue_scoped:
|
||||
print(f"Target: {fm.get('target_module', '?')}")
|
||||
print(f"Scope: {fm.get('scope', '?')}")
|
||||
else:
|
||||
print(f"Module: {fm.get('module', '?')}")
|
||||
print(f"Purpose: {fm.get('purpose', '?')}")
|
||||
print(f"Version: {contract.version}")
|
||||
print(f"Complexity: {fm.get(complexity_key, '?')}")
|
||||
print(f"Est. LOC: {fm.get('estimated_loc', '?')}")
|
||||
@@ -596,7 +621,9 @@ def print_list(contract: Contract) -> None:
|
||||
fm = contract.frontmatter
|
||||
is_v2 = contract.version.startswith("2")
|
||||
complexity_key = "complexity" if is_v2 else "min_complexity"
|
||||
print(f"{fm.get('module', '?')} [{fm.get(complexity_key, '?')}]")
|
||||
issue_scoped = is_v2 and _is_issue_scoped(contract)
|
||||
label = fm.get('target_module', '?') if issue_scoped else fm.get('module', '?')
|
||||
print(f"{label} [{fm.get(complexity_key, '?')}]")
|
||||
for fn in contract.functions:
|
||||
params_short = fn.params[:60] + ("..." if len(fn.params) > 60 else "")
|
||||
print(f" FN {fn.name}({params_short}) -> {fn.return_type}")
|
||||
|
||||
@@ -0,0 +1,142 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "ratatoskr.first_message"
|
||||
purpose: "Per-agent authored first-message presets — seed an agent's opening as a #347 authored turn-0 onto new sessions (CLI + web), the durable replacement for a system-prompt startup instruction."
|
||||
touches:
|
||||
- src/ratatoskr/first_message.py
|
||||
- tests/test_first_message.py
|
||||
scope: >
|
||||
Per-agent authored first-message presets (Worldtree #347 consumer feature).
|
||||
When a new session is created for an agent that has a preset opening, seed it
|
||||
as a #347 authored first-message (POST /sessions/{id}/history, author=assistant,
|
||||
seq-0) so the session opens in-character before the user speaks — the durable
|
||||
replacement for a system-prompt "startup" instruction. Two entry points:
|
||||
`preset_for` (lookup) and `seed_preset_first_message` (best-effort seed).
|
||||
Consumed by ratatoskr.cli (the `--new` session path) and ratatoskr.web.server
|
||||
(the POST /api/sessions endpoint). Depends on ratatoskr.sessions
|
||||
(write_authored_history + its exceptions); no core.* / worldtree.* imports.
|
||||
depends_on:
|
||||
- "httpx"
|
||||
- "ratatoskr.sessions"
|
||||
used_by:
|
||||
- "ratatoskr.cli"
|
||||
- "ratatoskr.web.server"
|
||||
language: "python"
|
||||
complexity: "low"
|
||||
estimated_loc: 60
|
||||
confidence: 0.9
|
||||
assumptions:
|
||||
- "write_authored_history (contract #2 amendment 2026-07-06) is the seed primitive: 200/201 → ack dict, 404 → AuthoredHistoryUnavailable (hide-existence), other non-2xx → SessionApiFailed."
|
||||
- "The preset registry is a static in-module dict keyed by agent_id; editing it is how an operator tunes an agent's opening. Seeded with ratatoskr:sindra only."
|
||||
- "Auto-seed is BEST-EFFORT and MUST NOT block session creation: an instance without the session.history.write grant returns the hide-404, which is swallowed (session opens with no seeded greeting)."
|
||||
---
|
||||
|
||||
# First-message presets — authored openings on session-create (#347)
|
||||
|
||||
## Context
|
||||
|
||||
`ratatoskr.first_message` holds per-agent authored-opening presets and seeds them
|
||||
onto new sessions via the #347 authored-history-write primitive. It is the
|
||||
durable form of "give an agent a first message": instead of a system-prompt
|
||||
`Startup:` instruction (a workaround for the pre-#347 world where the assistant
|
||||
could not author turn-0), the opening lives as a real seeded assistant turn-0.
|
||||
|
||||
Consumed at both session-create sites — `ratatoskr.cli._amain` (the `--new` path)
|
||||
and `ratatoskr.web.server._create_session_endpoint` (POST /api/sessions) — so
|
||||
every new session for a preset agent opens in-character regardless of surface.
|
||||
|
||||
## Data flow
|
||||
|
||||
**In:** a live `httpx.AsyncClient` (caller-owned, base_url + bearer set), a fresh
|
||||
`session_id`, and the bound `agent_id`.
|
||||
|
||||
**Out:** on a preset agent, one `POST /sessions/{session_id}/history` (author=assistant,
|
||||
the preset text, per-content idempotency key). Returns the seeded content on
|
||||
success, else `None`.
|
||||
|
||||
**Side effects:** at most one outbound authored-history write; never raises to the
|
||||
caller (best-effort).
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-001 [hard]**: `seed_preset_first_message` NEVER raises (the sole exception is
|
||||
`asyncio.CancelledError`, which propagates — cancellation is not a seed failure) and
|
||||
NEVER blocks session creation. It soft-guards its inputs (a bad arg returns `None`,
|
||||
not `AssertionError`), bounds the write with `asyncio.wait_for(_SEED_TIMEOUT_S)` so a
|
||||
stalled `/history` can't hang the create path, and swallows EVERY other exception (the
|
||||
hide-404, `SessionApiFailed`, `httpx.HTTPError`, `TimeoutError`, and any unexpected
|
||||
error) → `None`. The `broad-except` is deliberate: this helper is wired INTO three
|
||||
session-create paths, so any escape would abort a create that already succeeded.
|
||||
- **INV-002 [hard]**: a no-preset agent issues ZERO HTTP (early return before any
|
||||
request).
|
||||
- **INV-003 [hard]**: the seed body is the preset text verbatim, author="assistant",
|
||||
with a per-content idempotency key (`"ratatoskr-preset-" + sha256(text)[:12]`), so
|
||||
a repeat seed of the same session+preset is an idempotent 200 replay, never a
|
||||
duplicate turn.
|
||||
- **INV-004 [hard]**: no `core.*` / `worldtree.*` imports (reference-consumer
|
||||
boundary; verified by `tests/test_no_worldtree_imports.py`, which rglobs every
|
||||
`.py` under `src/ratatoskr/` — this module included, so no per-module import
|
||||
test is needed here).
|
||||
|
||||
## Out of scope
|
||||
|
||||
- **Multi-turn / scripted openers.** v1 seeds exactly one assistant turn-0. A
|
||||
multi-message opening scene is a future concern.
|
||||
- **Runtime/remote preset config.** The registry is an in-module dict; no file/DB/env
|
||||
loading. Add that only when a second consumer needs operator-editable presets.
|
||||
- **Non-assistant authors.** v1 is author=assistant only (matches #347 v1); a
|
||||
user/system opener is deferred with the #347 engine surface.
|
||||
- **TUI-only surfaces.** Both real session-create paths (CLI + web) are wired; the
|
||||
bare-TUI picker resumes existing sessions (no create), so it needs no seed.
|
||||
|
||||
---
|
||||
|
||||
```contract
|
||||
FN preset_for(agent_id: str) -> str | None
|
||||
BRIEF: Return the authored first-message preset for agent_id, or None when the agent has no preset. Pure dict lookup over FIRST_MESSAGE_PRESETS.
|
||||
PRE: [PRE-001 hard] agent_id is a non-empty str -- assert agent_id and isinstance(agent_id, str)
|
||||
POST: [POST-001 return_value] returns FIRST_MESSAGE_PRESETS.get(agent_id) (str for a preset agent, None otherwise)
|
||||
STEPS:
|
||||
1. [setup, prescriptive] assert PRE-001
|
||||
2. [sequential, prescriptive] RETURN FIRST_MESSAGE_PRESETS.get(agent_id)
|
||||
TESTS:
|
||||
preset_hit [happy]: preset_for("ratatoskr:sindra") is a non-empty str
|
||||
preset_miss [happy]: preset_for("mimir") is None
|
||||
empty_agent_id [adversarial]: preset_for("") → AssertionError
|
||||
|
||||
FN seed_preset_first_message(client: httpx.AsyncClient, session_id: str, agent_id: str) -> str | None
|
||||
BRIEF: Best-effort seed of an agent's preset opening as a #347 authored first-message on session_id. If agent_id has a preset, POST it via write_authored_history (author=assistant, per-content idempotency key, the await bounded by asyncio.wait_for(_SEED_TIMEOUT_S)) and return the seeded content; on no-preset, a malformed input, OR ANY exception except asyncio.CancelledError, return None WITHOUT raising. Never raises (except CancelledError, which propagates) and never blocks session creation — it is wired into three create paths.
|
||||
PRE: [PRE-001 hard] client is not None -- soft-guarded: return None (NOT assert) if violated, so a wiring bug can't crash the create path (INV-001)
|
||||
PRE: [PRE-002 hard] session_id is a non-empty str -- soft-guarded: return None if violated
|
||||
PRE: [PRE-003 hard] agent_id is a non-empty str -- soft-guarded: return None if violated (also guards FIRST_MESSAGE_PRESETS.get against a non-hashable/non-str id)
|
||||
POST: [POST-001 return_value] preset agent + successful write → returns the preset text; no-preset, malformed input, OR any swallowed failure → None
|
||||
POST: [POST-002 side_effect] a no-preset / malformed-input call issues ZERO HTTP; a preset agent issues exactly one POST /sessions/{session_id}/history with body author="assistant", content=preset, idempotency_key="ratatoskr-preset-"+sha256(preset)[:12], the await bounded by _SEED_TIMEOUT_S so a stalled response cannot block
|
||||
ERROR_ROUTING:
|
||||
asyncio.CancelledError:
|
||||
local_handling: RE-RAISE (cancellation is not a seed failure; never swallow it — and it is a BaseException, so `except Exception` would miss it anyway)
|
||||
flow_control: propagate
|
||||
state_recovery: n/a
|
||||
any other Exception (hide-404 AuthoredHistoryUnavailable, SessionApiFailed 409/422/etc., httpx.HTTPError, TimeoutError from wait_for, any unexpected error):
|
||||
local_handling: swallow; return None
|
||||
flow_control: continue (never blocks session create)
|
||||
state_recovery: session opens with no seeded greeting
|
||||
STEPS:
|
||||
1. [setup, prescriptive] Soft-guard: IF agent_id is not a non-empty str: RETURN None (before any dict lookup — guards a non-hashable id)
|
||||
2. [sequential, prescriptive] content = FIRST_MESSAGE_PRESETS.get(agent_id); IF content is None: RETURN None (INV-002 — zero HTTP)
|
||||
3. [sequential, prescriptive] Soft-guard: IF client is None OR session_id is not a non-empty str: RETURN None
|
||||
4. [sequential, prescriptive] key = "ratatoskr-preset-" + sha256(content utf-8)[:12]
|
||||
5. [sequential, prescriptive] TRY: await asyncio.wait_for(write_authored_history(client, session_id, content=content, idempotency_key=key), timeout=_SEED_TIMEOUT_S)
|
||||
tool: { destructive: false, idempotent: true, read_only: false, open_world: false }
|
||||
6. [branch, prescriptive] EXCEPT asyncio.CancelledError: RAISE; EXCEPT Exception: RETURN None
|
||||
7. [cleanup, prescriptive] RETURN content
|
||||
TESTS:
|
||||
seeds_preset [happy,tracer]: preset agent, mock 201 → returns the preset text; exactly one POST /sessions/{id}/history; body author="assistant" + content=preset + idempotency_key="ratatoskr-preset-"+sha256(preset)[:12]
|
||||
no_preset_zero_http [happy]: agent "mimir" → returns None; NO HTTP issued
|
||||
feature_absent_swallowed [error]: preset agent, mock 404 session_not_found → returns None, no raise
|
||||
session_api_failed_swallowed [error]: preset agent, mock 409 → returns None, no raise
|
||||
transport_error_swallowed [error]: preset agent, mock httpx.ConnectError → returns None, no raise
|
||||
unexpected_exception_swallowed [error]: preset agent, write raises ValueError → returns None, no raise (INV-001 broad never-raise)
|
||||
cancellation_propagates [error]: preset agent, write raises asyncio.CancelledError → RE-RAISED (never swallowed)
|
||||
malformed_agent_id_no_http [adversarial]: agent_id=123 (non-str) OR "" → None; NO HTTP; no raise
|
||||
empty_session_id [adversarial]: session_id="" (preset agent) → None (soft guard); NO HTTP; no raise
|
||||
```
|
||||
@@ -106,7 +106,7 @@ POST: [POST-002 return_value] AsyncIterator yields ≥1 event ending in exactly
|
||||
POST: [POST-003 state_change] every yielded Event has a populated sse_id with both fields >= 1 -- assert all(e.sse_id.turn_id >= 1 and e.sse_id.seq >= 1 for e in events)
|
||||
ERROR_ROUTING:
|
||||
httpx.HTTPStatusError:
|
||||
local_handling: re-raise as SseConnectFailed(status=resp.status_code, body=resp.read()[:1024]) — server returned non-2xx before stream started (e.g., 404 session_not_found)
|
||||
local_handling: re-raise as SseConnectFailed(status=resp.status_code, body=resp.read()[:1024]) — server returned non-2xx before stream started (e.g., 404 session_not_found). EXCEPT the two eager turn-launch failures (Worldtree v1.0.0b1 #331), checked BEFORE raise_for_status and raised as typed SseConnectFailed SUBCLASSES carrying error_code: 409 -> AgentNotAvailable (agent unavailable; pre-b1 this was a 200 + in-stream `error` event), 503 -> TurnLaunchUnavailable (transient turn-launch failure; retryable=True). Subclassing keeps existing `except SseConnectFailed` handlers working with zero changes.
|
||||
flow_control: abort
|
||||
state_recovery: none (no events yielded yet)
|
||||
httpx.ReadError | httpx.RemoteProtocolError | httpx.ReadTimeout:
|
||||
@@ -129,7 +129,8 @@ ERROR_ROUTING:
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate inputs per PRE-001..PRE-003
|
||||
2. [sequential, flexibility=prescriptive] Open SSE connection via httpx_sse.aconnect_sse with method="POST", url=f"/sessions/{session_id}/messages", json={"content": content}
|
||||
ON httpx.HTTPStatusError before stream opens:
|
||||
2a. [branch, flexibility=prescriptive] IF response.status_code in (409, 503) (b1 #331 eager turn-launch failures): read the body, parse (error_code, message) from the `{"detail": {...}}` envelope OR a flat `{error_code, message}` body (status-derived default code when absent), then RAISE AgentNotAvailable (409) / TurnLaunchUnavailable (503).
|
||||
ON httpx.HTTPStatusError before stream opens (any other non-2xx):
|
||||
RAISE SseConnectFailed
|
||||
3. [loop, flexibility=prescriptive] FOR EACH sse_event in event_source.aiter_sse():
|
||||
0. [branch, flexibility=prescriptive] IF sse_event.data == "":
|
||||
@@ -162,6 +163,9 @@ TESTS:
|
||||
error_terminal [error]: mock emits one `text` then `error` with `error_code: "llm_output_invalid"` → consumer yields Text then Error; iteration ends; Error.message and Error.error_code are populated
|
||||
cancelled_terminal [error]: mock emits `cancelled` with phase=cancelled → consumer yields Cancelled with turn_id; iteration ends
|
||||
session_not_found [error]: mock returns 404 before stream opens → consumer raises SseConnectFailed(status=404)
|
||||
eager_409_agent_not_available [error]: mock returns 409 {detail:{error_code:"agent_not_available", message}} before stream → consumer raises AgentNotAvailable(status=409, error_code="agent_not_available", retryable absent); isinstance SseConnectFailed
|
||||
eager_503_retryable [error]: mock returns 503 before stream → consumer raises TurnLaunchUnavailable(status=503, retryable=True); isinstance SseConnectFailed
|
||||
eager_409_non_json_body [adversarial]: mock returns 409 with a non-JSON body → consumer raises AgentNotAvailable with the status-derived default error_code "agent_not_available"
|
||||
malformed_id_no_seq [adversarial]: mock event has `id: 42` (missing `:seq`) → consumer raises MalformedSseId; no event yielded
|
||||
malformed_id_alpha [adversarial]: mock event has `id: foo:bar` (non-integer parts) → consumer raises MalformedSseId
|
||||
turn_id_flip [adversarial]: mock emits text events with ids `42:1` then `99:2` → consumer raises TurnIdFlip; only the first event was yielded
|
||||
@@ -293,3 +297,51 @@ TESTS:
|
||||
trailing_whitespace [adversarial]: "42:3 " → ValueError (strict; do not strip; the server emits clean ids)
|
||||
truncation [security]: input is 5000-char string with no colon → ValueError message includes only `raw[:64]` (not the full 5000)
|
||||
```
|
||||
|
||||
## Amendment 2026-06-30 — shared resume orchestration (v1 coverage-audit, slice b1)
|
||||
|
||||
The original contract specs resume as **caller-owned** (§Resume semantics: "the
|
||||
caller MAY invoke `reconnect_turn`"). The v1 coverage-audit found `reconnect_turn`
|
||||
had **no caller** — every presenter (cli/tui/web) let a mid-stream drop propagate
|
||||
instead of resuming, so the "reference SSE-resume implementation" (design-brief
|
||||
§3/§8d) was unreachable. Per design-brief §8b ("share the consumer, branch the
|
||||
presenter") the resume loop is a **single shared orchestration surface**, not
|
||||
duplicated per presenter. This adds `stream_turn_resilient` as that surface;
|
||||
presenters call it instead of `stream_turn` when they want transparent reconnect.
|
||||
`stream_turn` and `reconnect_turn` are unchanged (still the primitives); this is
|
||||
purely additive.
|
||||
|
||||
```contract
|
||||
FN stream_turn_resilient(client: httpx.AsyncClient, session_id: str, content: str, *, max_reconnects: int = 5) -> AsyncIterator[Event]
|
||||
BRIEF: The shared resume-orchestration wrapper over stream_turn + reconnect_turn. Yields a SINGLE continuous typed Event stream; on SseConnectionDropped (mid-stream drop OR clean EOF before terminal), transparently resumes via reconnect_turn from the last-seen sse_id, up to max_reconnects times, until a terminal Done/Error/Cancelled arrives. The one surface all presenters consume for resilient streaming (design-brief §8b). Cross-process resume stays deferred to v2 (§8d): last-seen lives only in this generator's frame.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
PRE: [PRE-002 hard] session_id is non-empty str -- assert session_id and isinstance(session_id, str)
|
||||
PRE: [PRE-003 hard] content is non-empty str -- assert content and isinstance(content, str)
|
||||
PRE: [PRE-004 hard] max_reconnects is a non-negative int -- assert isinstance(max_reconnects, int) and max_reconnects >= 0
|
||||
POST: [POST-001 return_value] yielded events are the concatenation of each attempt's events in wire order; the wrapper does NOT re-yield events it already saw (the server replays only seq>last_seen) -- assert seq is non-decreasing within a turn_id across the seam
|
||||
POST: [POST-002 return_value] a fully-consumed stream terminates at exactly one Done/Error/Cancelled (INV-001 holds across reconnects) -- assert isinstance(events[-1], (Done, Error, Cancelled))
|
||||
POST: [POST-003 state_change] reconnect_turn is invoked with last_event_id == f"{last_seen.turn_id}:{last_seen.seq}" of the most recently yielded event -- assert the Last-Event-ID header on attempt N+1 == the last sse_id yielded before the drop
|
||||
ERROR_ROUTING:
|
||||
SseConnectionDropped (from stream_turn or reconnect_turn):
|
||||
local_handling: IF a last-seen sse_id exists AND reconnects < max_reconnects → increment reconnects, resume via reconnect_turn(last_event_id=f"{turn_id}:{seq}"); ELSE re-raise
|
||||
flow_control: continue (resume) | abort (re-raise when no last-seen id, or budget exhausted)
|
||||
state_recovery: server replays buffered events seq>last_seen then streams live (spec §Reconnect flow)
|
||||
ResumeBufferExpired | ResumeTurnFinished | InvalidLastEventId | TurnIdFlip | SseConnectFailed (from reconnect_turn):
|
||||
local_handling: propagate unchanged — NOT a transient drop; caller policy is abandon/restart (§Resume semantics "surface, not recover")
|
||||
flow_control: abort
|
||||
state_recovery: none
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate PRE-001..PRE-004; SET last_seen=None, reconnects=0, gen=stream_turn(client, session_id, content)
|
||||
2. [loop, flexibility=prescriptive] async-for event in gen: SET last_seen=event.sse_id; YIELD event. On clean generator completion (terminal reached): RETURN.
|
||||
3. [branch, flexibility=prescriptive] ON SseConnectionDropped d: SET seen = last_seen or d.last_seen_sse_id. IF seen is None OR reconnects >= max_reconnects: RE-RAISE. ELSE: reconnects += 1; gen = reconnect_turn(client, session_id, content, last_event_id=f"{seen.turn_id}:{seen.seq}"); GOTO step 2.
|
||||
4. [error_handler, flexibility=prescriptive] Any non-drop exception from gen (ResumeBufferExpired/ResumeTurnFinished/InvalidLastEventId/TurnIdFlip/SseConnectFailed) is NOT caught — it propagates unchanged.
|
||||
TESTS:
|
||||
happy_no_drop [happy]: stream yields text(42:1), done(42:2) cleanly → wrapper yields exactly those 2; endpoint hit ONCE (no reconnect).
|
||||
resume_after_one_drop [scenario,tracer]: attempt 1 yields text(42:1) then RemoteProtocolError; reconnect replays text(42:2)+done(42:3) → wrapper yields 42:1,42:2,42:3 as ONE stream; 2nd request carried Last-Event-ID "42:1".
|
||||
resume_after_clean_eof [scenario]: attempt 1 yields text(42:1) then clean EOF (no terminal); reconnect yields done(42:2) → continuous (resumes on the INV-001 clean-eof drop too).
|
||||
two_drops_then_done [scenario]: drops after 42:1 then after 42:2; third attempt yields done(42:3) → all 3 events; reconnects==2; Last-Event-ID headers "42:1" then "42:2".
|
||||
unresumable_zero_event_drop [adversarial]: attempt 1 drops with ZERO events seen (last_seen None) → SseConnectionDropped propagates; only 1 request issued.
|
||||
max_reconnects_exhausted [adversarial]: every attempt drops after one event; max_reconnects=2 → after initial + 2 reconnects (3 requests), SseConnectionDropped propagates.
|
||||
buffer_expired_propagates [error]: attempt 1 drops after 42:1; reconnect returns 412 → ResumeBufferExpired propagates (not retried as a transient drop).
|
||||
zero_budget_no_resume [adversarial]: max_reconnects=0; attempt 1 drops after 42:1 → SseConnectionDropped propagates immediately (no reconnect attempted).
|
||||
```
|
||||
|
||||
@@ -0,0 +1,312 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
target_module: "ratatoskr.sessions + ratatoskr.provider (+ cli/tui/web trigger surfaces)"
|
||||
scope: "Issue #17 v1 — make the canary chat client self-drive AND observe its own Bifrost provider. Two parts. (1) BIND: `create_session` gains an optional single-plane Bifrost binding (`BifrostBinding{endpoint_url, scope}`) authenticated with a DISTINCT consumer Heimdall key; Worldtree runs the handshake synchronously at POST /sessions, so handshake failure is a session-create failure (502), surfaced on the create path. A plane selector (`memory`→:8391 / `affect`→:8390; `combined`→:8392 added post-#17 — the #18 composite, the web default) + the consumer key thread through CLI / TUI / web; bound-state is visible. (2) OBSERVE: a structured op-feed in the provider, instrumented at the DISPATCH/ASGI layer (where the JWT ctx / session_id lives — bifrost passes ctx to upsert_many but NOT to search/get/delete, so the existing store-method stdout shim cannot see session_id), emitting JSONL {session_id, plane, op, req_summary, resp_summary, status, ts}. OPERATOR DECISIONS LOCKED: single-plane-per-session for v1 (composite endpoint fronting both planes was PARKED at #17 — later shipped as #18 and surfaced in the web bind as the `combined` plane); op-feed with session-level correlation for v1 (turn-correlated debug-pane UI is PARKED — needs turn_id, TBD). Provider store scope semantics MUST NOT change (AND-parity with bifrost's reference store is a hard constraint). Direct in-session TDD; live-smoke against personal Worldtree is the load-bearing acceptance gate."
|
||||
depends_on:
|
||||
- "httpx"
|
||||
- "ratatoskr.sessions"
|
||||
- "ratatoskr.provider.memory_store"
|
||||
- "ratatoskr.provider.affect_store"
|
||||
- "bifrost"
|
||||
used_by:
|
||||
- "ratatoskr.cli"
|
||||
- "ratatoskr.tui"
|
||||
- "ratatoskr.web.server"
|
||||
language: "python"
|
||||
complexity: "medium"
|
||||
estimated_loc: 260
|
||||
confidence: 0.78
|
||||
assumptions:
|
||||
- "PROVEN this session (manual end-to-end against personal Worldtree v0.35.3): `POST /sessions` with `bifrost={endpoint_url, scope:null}` runs the handshake synchronously and returns 201 when it verifies. `BifrostBindingRequest` is `{endpoint_url, scope}` ONLY (live OpenAPI, additionalProperties:false); capabilities are negotiated at the handshake, not declared in the bind request. So a session binds exactly ONE provider endpoint → ONE plane's dispatch flows."
|
||||
- "PROVEN: the session-create BEARER is the identity Worldtree signs the Bifrost handshake JWT with (HS256 shared-secret). Bearer = the canary key (WORLDTREE_API_KEY) → handshake 401 `bifrost.auth_rejected` → 502 to the client. Bearer = the consumer Heimdall key (== the provider's RATATOSKR_HEIMDALL_KEY string) → handshake 200. So a BOUND session-create MUST authenticate with the consumer key, NOT the canary key. These are two distinct ratatoskr identities."
|
||||
- "PROVEN: dev HTTP is accepted (spec wants HTTPS) because the provider host:port is on Worldtree's `BIFROST_CLIENT_ALLOWED_HOSTS` allowlist — a Worldtree-side, infra-ops-owned config. The endpoint_url must be the WORLDTREE-VISIBLE base URL (e.g. `http://10.100.10.50:8391`), not the client's loopback. Provider routes live at `/bifrost/handshake` + `/bifrost/memory-call` (memory) and `/bifrost/affect-call` (affect) under that base."
|
||||
- "PROVEN (bifrost source, memory.py:244 vs 262): `dispatch_memory_call` passes `ctx` to `upsert_many` but NOT to `search`/`get`/`delete`. So the recall verb's store method has no session_id; correlation identity must be captured at the dispatch/ASGI layer (JWT ctx), not inside the store method. turn_id (finer than session_id) availability is UNVERIFIED — a contract-stage JWT-claims/envelope dump resolves it; design the op-feed to accept a turn_id later without a schema break."
|
||||
- "Provider stores MUST NOT change scope semantics. `_matches_scope` stays the v0.6 composed filter — `scope_all` (AND/intersection) ∧ `scope_any` (OR/union over conjunctive scopes) — byte-faithful to bifrost reference `reference_server/memory.py` (wire v0.6, #11); the 4-axis lattice validation (`_validate_scope`) is in place and at parity. Scope semantics are settled (the v0.6 scope split shipped, bifrost 0.8.0) and OUT OF SCOPE for #17 — observe is read-only over them."
|
||||
- "The existing `create_session(client, agent_id, *, end_user_id=None)` (sessions.py:179) is extended, not replaced (pre-v1, no compat shim). The httpx client carries the canary key as its default Authorization; the bound create overrides the bearer per-request with the consumer key."
|
||||
- "Tests use `respx` for the bind unit tests (mirroring tests/test_sessions.py) + the in-process op-feed; the live-smoke acceptance is manual (per the repo's load-bearing-smoke posture), captured as a documented runbook step, not a unit test. `docs/bifrost-self-test.md` is the manual procedure this feature productizes."
|
||||
- "v1 ships the CLI + TUI + web trigger surfaces in lockstep (the repo's BOTH-presenters-in-lockstep rule); the op-feed is read by the debug surface as structured lines for now (pane-correlated rendering is PARKED)."
|
||||
open_questions:
|
||||
- "turn_id on the wire: does Worldtree put a turn_id (or traceparent) in the Bifrost request JWT claims / envelope? If yes, the op-feed echoes it and turn-correlation becomes exact; if no, correlation is session_id + time-window (weaker). RESOLVE via a JWT-claims dump during the first TDD slice. Does NOT block v1 (session_id correlation is the v1 target); it gates the PARKED pane-UI."
|
||||
- "Composite endpoint (PARKED): a thin ASGI fronting both :8390/:8391 advertising both caps at handshake would let one session observe both planes. Deferred to vNext per operator. If pursued, it needs per-underlying-store parity checks + per-plane failure status (a facade routing bug is a new failure class) — NOT just `handshake lists both caps`."
|
||||
- "Key identity unification (PARKED — operator's call, crosses Heimdall): v1 assumes two keys. Do not derive one from the other."
|
||||
- "Auto-bind on Tier-3 agents (PARKED — operator's call): v1 is explicit opt-in only. Auto-bind hides the most important debug variable (which identity + endpoint the session bound to)."
|
||||
prd:
|
||||
issue: 17
|
||||
issue_url: "https://gitea.phasefinal.com/vh/ratatoskr/issues/17"
|
||||
body_sha256_16: "58a420956e6226fb"
|
||||
lock_in_comment_id: null
|
||||
lock_in_sha256_16: null
|
||||
lock_in_at: null
|
||||
pinned_at: "2026-06-16T07:45:00+00:00"
|
||||
dependencies:
|
||||
- issue: 2
|
||||
path: "src/ratatoskr/sessions.py"
|
||||
reason: "create_session is the bind site. Same posture: caller-owned httpx client, async-native, no Worldtree imports, frozen-dataclass parse, exception `.body` truncated to [:1024]."
|
||||
- issue: 5
|
||||
path: "src/ratatoskr/sessions.py"
|
||||
reason: "end_user_id already threads into the POST /sessions body; the bifrost field is added alongside it with the same optional-when-None posture."
|
||||
---
|
||||
|
||||
# Issue #17 — Bifrost-binding the chat client: self-drive + observe
|
||||
|
||||
## Context
|
||||
|
||||
Ratatoskr is two identities: the conversation-API **canary client** (TUI/web/CLI
|
||||
that runs turns and watches the SSE flow) and a Bifrost **Tier-3 provider**
|
||||
(durable affect store :8390 + memory store :8391, separate ASGI apps). Until now
|
||||
the canary couldn't drive its OWN provider — `create_session` never sent a Bifrost
|
||||
binding, so every affect/memory round-trip was driven externally. #17 closes that:
|
||||
the canary BINDS a session to its own provider and OBSERVES the resulting
|
||||
affect/memory dispatch, so an operator can hunt latent cross-layer bugs from one
|
||||
seat. The manual procedure proven this session lives at `docs/bifrost-self-test.md`;
|
||||
#17 productizes it.
|
||||
|
||||
**v1 scope is deliberately narrow** (operator-locked): single-plane bind (composite
|
||||
endpoint PARKED), session-level op-feed (turn-correlated panes PARKED). The load-
|
||||
bearing risks are bind-time auth identity + capturing a correlation key the store
|
||||
method can't see — both resolved below.
|
||||
|
||||
## Public surface
|
||||
|
||||
```python
|
||||
@dataclass(frozen=True)
|
||||
class BifrostBinding:
|
||||
"""Session-create Bifrost binding (Worldtree BifrostBindingRequest, #160).
|
||||
endpoint_url is the WORLDTREE-VISIBLE base URL of one provider plane."""
|
||||
endpoint_url: str
|
||||
scope: str | None = None
|
||||
|
||||
|
||||
async def create_session(
|
||||
client: httpx.AsyncClient,
|
||||
agent_id: str,
|
||||
*,
|
||||
end_user_id: str | None = None,
|
||||
bifrost: BifrostBinding | None = None,
|
||||
consumer_key: str | None = None,
|
||||
) -> SessionInfo:
|
||||
"""POST /sessions. When `bifrost` is set the request authenticates with
|
||||
`consumer_key` (NOT the client's default canary bearer) and carries the
|
||||
`bifrost` field; Worldtree handshakes synchronously before 201. See FN
|
||||
create_session."""
|
||||
|
||||
|
||||
def endpoint_for_plane(plane: str, base_host: str) -> str:
|
||||
"""'memory'->:8391, 'affect'->:8390, 'combined'->:8392 (#18 composite) →
|
||||
f'http://{base_host}:{port}'. The Worldtree-visible base URL. See FN endpoint_for_plane."""
|
||||
```
|
||||
|
||||
```python
|
||||
# Provider-side observe feed (ratatoskr.provider.opfeed) — dispatch-layer.
|
||||
@dataclass(frozen=True)
|
||||
class OpEvent:
|
||||
ts: str # ISO 8601 UTC, capture time
|
||||
plane: str # "memory" | "affect"
|
||||
op: str # verb: search / upsert_many / emit / get / delete / handshake
|
||||
session_id: str | None # from the JWT ctx at the DISPATCH layer — present for ALL
|
||||
# JWT-carrying verbs (not just upsert_many; bifrost withholds
|
||||
# ctx from search/get/delete STORE methods, but dispatch sees
|
||||
# the JWT); None only if the JWT genuinely omits it
|
||||
status: str # "ok" | "error"
|
||||
req_summary: dict # per-verb, scope-only (see "Op-feed summary shapes"); no record bodies
|
||||
resp_summary: dict # per-verb counts + ids/scores; never verbatim content
|
||||
turn_id: str | None = None # INV-005 reservation made LITERAL: the field exists now,
|
||||
# unused in v1 (session-level correlation), populated when
|
||||
# Worldtree propagates a turn id (open question)
|
||||
|
||||
|
||||
def instrument_provider_app(app, *, plane: str, sink: OpSink):
|
||||
"""Wrap the dispatch/ASGI layer so every inbound bifrost-call emits one
|
||||
OpEvent to `sink`, reading session_id off the JWT ctx where bifrost exposes
|
||||
it. Does NOT touch store scope semantics. See FN instrument_provider_app."""
|
||||
```
|
||||
|
||||
## Exception classes
|
||||
|
||||
```python
|
||||
class BifrostHandshakeFailed(Exception):
|
||||
"""502 bifrost_handshake_failed on bound session-create. Carries the
|
||||
spec-level `detail.bifrost_error` (e.g. 'bifrost.auth_rejected')."""
|
||||
def __init__(self, *, bifrost_error: str | None, body: bytes) -> None: ...
|
||||
bifrost_error: str | None
|
||||
|
||||
class BifrostConsumerKeyMissing(Exception):
|
||||
"""A bifrost binding was requested without a consumer_key. Raised BEFORE
|
||||
HTTP (the bind must never silently fall back to the canary key)."""
|
||||
```
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-001 (auth identity, never fall back).** A `bifrost` binding REQUIRES a
|
||||
non-empty `consumer_key`; absence raises `BifrostConsumerKeyMissing` before any
|
||||
HTTP. The bound POST /sessions authenticates with `consumer_key`; an unbound
|
||||
create authenticates with the client's default canary key. The two call sites
|
||||
never cross. On 401-rooted handshake failure the error names the mismatch.
|
||||
- **INV-002 (bind-time, not turn-time, failure).** The handshake runs
|
||||
synchronously on POST /sessions. A bad URL / down provider / wrong key / HTTPS
|
||||
rejection fails SESSION CREATION (502 → `BifrostHandshakeFailed`), surfaced on
|
||||
the create path BEFORE any turn / before alt-screen (TUI) — never deferred to
|
||||
first-turn. Mirrors issue #6's pre-alt-screen error routing.
|
||||
- **INV-003 (one plane per session).** A binding targets exactly one endpoint =
|
||||
one plane. v1 documents this limit explicitly; binding both planes for one turn
|
||||
is the PARKED composite-endpoint feature, not a v1 path.
|
||||
- **INV-004 (no scope-semantics change).** The observe instrumentation is
|
||||
READ-ONLY over the dispatch path; it MUST NOT alter `_matches_scope`, the v0.6
|
||||
`scope_all`/`scope_any` semantics, or any store behavior. The op-feed reports the
|
||||
effective scope used per op; it never rewrites scope client-side.
|
||||
- **INV-005 (correlation key at the dispatch layer).** session_id is captured from
|
||||
the JWT ctx at the dispatch/ASGI layer — present for ALL JWT-carrying verbs,
|
||||
INCLUDING search/get/delete (bifrost withholds ctx from those STORE methods, but
|
||||
the dispatch layer still verifies + reads the JWT). `session_id=None` ONLY if the
|
||||
JWT genuinely omits it (a claims-dump open question, not the store-method gap).
|
||||
`OpEvent` carries a literal `turn_id: str | None = None` field — the reservation
|
||||
is a real field defaulted to None in v1, not a future schema change.
|
||||
- **INV-006 (data hygiene).** Bound debug sessions write to DURABLE stores. The
|
||||
smoke procedure uses an explicit test scope (`end_user:smoke-user`) and a
|
||||
documented cleanup path; the contract's acceptance asserts the fixture
|
||||
before/after so a debug run's promotions are visible, never silent. (Promotion
|
||||
of a turn is expected behavior, not a bug — but it must be observable.)
|
||||
- **INV-007 (observe captures failures + late ops).** The op-feed records non-2xx
|
||||
/ error ops (status="error"), never hides or double-counts them. The `OpSink` is
|
||||
a CONTINUOUS append-only feed — NOT per-session-scoped, no per-session teardown in
|
||||
v1; late ops that land AFTER the SSE turn-end simply append with their timestamp,
|
||||
so a consumer can apply a post-turn grace window (the PARKED pane-UI's concern; v1
|
||||
just must not drop late ops). A sink write that FAILS is swallowed from the
|
||||
dispatch path (instrument_provider_app POST-003) BUT logged to stderr — an observe
|
||||
gap is never silent.
|
||||
- **INV-008 (both presenters in lockstep).** The bind trigger + bound-state
|
||||
indicator land in CLI, TUI, and web together (the repo's add-to-all-presenters
|
||||
rule). Web creates the bound session SERVER-SIDE; the consumer key never reaches
|
||||
the browser.
|
||||
- **INV-009 (secret hygiene).** Both keys are redacted in all UI/logs. The
|
||||
consumer key is PRIVILEGED (it is the handshake identity), not equivalent to
|
||||
read-only conversation access; config that stores it uses no weaker file
|
||||
permissions than the canary key (cf. provider.env mode 600).
|
||||
|
||||
## Data flow
|
||||
|
||||
BIND (client → Worldtree): CLI/TUI/web resolve `plane` + the consumer key →
|
||||
`endpoint_for_plane(plane, worldtree_visible_host)` → `BifrostBinding` →
|
||||
`create_session(..., bifrost=binding, consumer_key=...)` → POST /sessions with
|
||||
bearer = consumer key → Worldtree handshakes synchronously to the provider
|
||||
endpoint → 201 (bound) or 502 (`BifrostHandshakeFailed`).
|
||||
|
||||
OBSERVE (Worldtree → provider → feed): a bound turn makes Worldtree dispatch
|
||||
affect/memory bifrost-calls to the provider → `instrument_provider_app` wraps the
|
||||
dispatch layer → one `OpEvent` per call (session_id from JWT ctx when present) →
|
||||
`OpSink` (JSONL) → the debug surface reads structured lines. The store path is
|
||||
untouched (INV-004); observe is read-only over dispatch.
|
||||
|
||||
## Function contracts
|
||||
|
||||
```contract
|
||||
FN create_session(client: httpx.AsyncClient, agent_id: str, *, end_user_id: str | None = None, bifrost: BifrostBinding | None = None, consumer_key: str | None = None) -> SessionInfo
|
||||
BRIEF: POST /sessions; when a bifrost binding is given, authenticate with the consumer key (not the canary key) and carry the binding so Worldtree handshakes synchronously to our provider.
|
||||
|
||||
PRE: [PRE-001 hard] bifrost is not None ⇒ consumer_key is a non-empty str -- else BifrostConsumerKeyMissing, before any HTTP (INV-001)
|
||||
PRE: [PRE-002 soft] bifrost is None ⇒ request uses the client's default canary bearer -- unchanged pre-#17 path
|
||||
POST: [POST-001 return_value] 201 → SessionInfo (unchanged parse) -- assert
|
||||
POST: [POST-002 exception] 502 → BifrostHandshakeFailed(bifrost_error=detail.bifrost_error, body) (INV-002) -- assert
|
||||
POST: [POST-003 exception] 422 ephemeral_does_not_accept_bifrost → SessionApiFailed -- assert
|
||||
POST: [POST-004 exception] 404 → AgentNotFound; other non-201 → SessionApiFailed -- assert (unchanged)
|
||||
STEPS:
|
||||
1. body = {"agent_id": agent_id}; if end_user_id: body["end_user_id"] = end_user_id
|
||||
2. if bifrost: body["bifrost"] = {"endpoint_url": bifrost.endpoint_url, "scope": bifrost.scope}; headers = {"Authorization": f"Bearer {consumer_key}"}
|
||||
3. else: headers = {} (httpx client default bearer = canary key)
|
||||
4. resp = await client.post("/sessions", json=body, headers=headers); route status per POST-*
|
||||
```
|
||||
|
||||
```contract
|
||||
FN endpoint_for_plane(plane: str, base_host: str) -> str
|
||||
BRIEF: Map a plane name to the Worldtree-visible provider base URL (memory->:8391, affect->:8390, combined->:8392 — the #18 composite both-plane endpoint, surfaced post-#17).
|
||||
|
||||
PRE: [PRE-001 hard] plane in {"memory", "affect", "combined"} -- else ValueError
|
||||
POST: [POST-001 return_value] returns f"http://{base_host}:{port}", port 8391 (memory) / 8390 (affect) / 8392 (combined) -- assert
|
||||
STEPS:
|
||||
1. port = {"memory": 8391, "affect": 8390, "combined": 8392}[plane]
|
||||
2. return the Worldtree-VISIBLE base URL (not client loopback); HTTPS relaxation is allowlist-side, not a URL concern
|
||||
```
|
||||
|
||||
```contract
|
||||
FN instrument_provider_app(app, *, plane: str, sink: OpSink) -> ASGIApp
|
||||
BRIEF: Wrap the provider's dispatch layer so each inbound bifrost-call emits one structured OpEvent (session_id from the JWT ctx) without touching store semantics.
|
||||
|
||||
PRE: [PRE-001 hard] app is a built provider ASGI app; sink is an OpSink -- guard
|
||||
POST: [POST-001 side_effect] emits exactly one OpEvent per inbound bifrost-call, incl. handshake + error ops (INV-007) -- assert
|
||||
POST: [POST-002 state_change] OpEvent.session_id = JWT ctx session_id when present, else None (INV-005) -- assert
|
||||
POST: [POST-003 side_effect] a sink failure never propagates into the dispatch path — observe must not break serve -- assert
|
||||
POST: [POST-004 return_value] store scope semantics untouched; read-only over dispatch (INV-004) -- assert
|
||||
STEPS:
|
||||
1. wrap the dispatch/ASGI layer so each inbound bifrost-call yields one OpEvent
|
||||
2. read session_id off the JWT ctx if present; else None
|
||||
3. summarise req (scope_all/scope_any/top_k for search; record-count+scopes for upsert) + resp (hit-count+ids/scores | upserted+replayed | error code) — NEVER verbatim content
|
||||
4. emit to sink; swallow sink errors
|
||||
```
|
||||
|
||||
## ERROR_ROUTING
|
||||
|
||||
| Wire | Exception | Surfaced |
|
||||
|---|---|---|
|
||||
| 502 `bifrost_handshake_failed` | `BifrostHandshakeFailed(bifrost_error)` | create path, names the bifrost_error; TUI pre-alt-screen |
|
||||
| (pre-HTTP) bifrost w/o consumer_key | `BifrostConsumerKeyMissing` | config/CLI validation, before any request |
|
||||
| 422 `ephemeral_does_not_accept_bifrost` | `SessionApiFailed` | create path |
|
||||
| 401 at provider handshake (manifests as 502 to client) | `BifrostHandshakeFailed('bifrost.auth_rejected')` | error text: "bound create requires the consumer key, not WORLDTREE_API_KEY" |
|
||||
|
||||
## Acceptance — the ordered live-smoke gate (load-bearing)
|
||||
|
||||
The repo's smoke-is-load-bearing posture: this gate IS acceptance, run manually
|
||||
against personal Worldtree, mirroring `docs/bifrost-self-test.md`.
|
||||
|
||||
```
|
||||
1. providers up → memory :8391 serving + op-feed sink attached (affect :8390 is symmetric, OPTIONAL for the memory-plane gate)
|
||||
2. consumer key set → RATATOSKR_BIFROST_CONSUMER_KEY present; canary key separate
|
||||
3. allowlist OK → endpoint_for_plane host on Worldtree's BIFROST_CLIENT_ALLOWED_HOSTS
|
||||
4. bind 201 → ratatoskr --bifrost-plane memory → bound session, handshake 200
|
||||
5. negative: canary → binding with the canary key → BifrostHandshakeFailed, the auth_rejected message names the consumer-key mismatch
|
||||
6. turn → one turn into the bound session
|
||||
7. assert op-feed → OpEvent captured with session_id == the BOUND session's id (not merely "some session_id"); {plane, op, req/resp summary, status}
|
||||
8. assert hygiene → fixture before/after asserted (per docs/bifrost-self-test.md); promotions visible not silent
|
||||
```
|
||||
|
||||
Unit tests (respx) cover: bind body shape, consumer-key override, the
|
||||
missing-key precondition, 502→BifrostHandshakeFailed mapping, 422 ephemeral, and
|
||||
the op-feed emitting one OpEvent per dispatched call incl. error + late op.
|
||||
|
||||
## v1 clarifications (paraphrase-gate fixups)
|
||||
|
||||
Pinned in response to the `/heid-contract-review` panel — closing under-specs that
|
||||
let an implementer comply while violating intent.
|
||||
|
||||
- **Op-feed summary shapes (per verb).** `req_summary` / `resp_summary` are
|
||||
scope-only, never verbatim content:
|
||||
- `search` → req `{scope_all, scope_any, top_k}`; resp `{hit_count, [{chunk_id, score}]}`
|
||||
- `upsert_many` → req `{record_count, [scope]}`; resp `{upserted, replayed}`
|
||||
- `get` / `get_many` → req `{ids}`; resp `{found_count}`
|
||||
- `delete_many` → req `{ids}`; resp `{deleted}`
|
||||
- `emit` (affect) → req `{actor-scope}`; resp `{status}` (affect stays conduit-opaque)
|
||||
- `handshake` → req `{caps_requested}`; resp `{caps_granted, ok}`
|
||||
- **`BifrostBinding.scope` is an opaque pass-through** (Worldtree spec: ≤256 chars,
|
||||
copied into the JWT payload unchanged). ratatoskr does NOT interpret it; v1 sends
|
||||
`null`. A non-null value is operator-supplied and meaningful only to Worldtree.
|
||||
- **Web bind split (INV-008 sharpened).** The web UI selects the PLANE; the consumer
|
||||
key is SERVER-HELD (env/config), never sent from the browser; the server
|
||||
constructs the bound session. The browser never sees the consumer key.
|
||||
- **Bound-state indicator** shows at least `plane + endpoint + bound|failed status`,
|
||||
not a bare boolean (so the operator can see WHICH identity/endpoint bound).
|
||||
- **401-handshake message scoping.** The "use the consumer key, not WORLDTREE_API_KEY"
|
||||
text is keyed on `bifrost_error == "bifrost.auth_rejected"`; other 502 handshake
|
||||
failures surface the generic `BifrostHandshakeFailed` with their own `bifrost_error`.
|
||||
- **`endpoint_for_plane` is the DEV helper** (returns `http://`, allowlist-relaxed).
|
||||
A production HTTPS endpoint is supplied directly via `--bifrost-url`, bypassing the
|
||||
plane shortcut — HTTPS is not constructed by `endpoint_for_plane`.
|
||||
- **422 `ephemeral_does_not_accept_bifrost` → `SessionApiFailed` is deliberate** (no
|
||||
distinct exception; it is an operator config error, surfaced as a generic create
|
||||
failure). Not an oversight in the ERROR_ROUTING overlap with POST-004.
|
||||
|
||||
## Out of scope / PARKED (anti-creep)
|
||||
|
||||
- Composite endpoint (both planes, one session) — vNext; needs per-store parity + per-plane failure status.
|
||||
- Turn-correlated debug-pane UI — needs turn_id (open question) + grace-window buffering + client read channel.
|
||||
- Key identity unification (Heimdall) — operator's call, crosses service boundary.
|
||||
- Auto-bind on Tier-3 agents — operator's call; v1 is explicit opt-in only.
|
||||
- Provider axis-lattice validation + the v0.6 scope split — RESOLVED (shipped: bifrost 0.8.0/wire v0.6, `_validate_scope` 4-axis + `scope_all`/`scope_any`); no longer a #17 concern.
|
||||
@@ -0,0 +1,380 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
target_module: "ratatoskr.provider.affect_store + ratatoskr.web (server + static/index.html)"
|
||||
scope: "Issue #18 — BOTH deliverables. DELIVERABLE 2 (SHIPPED v0.17.14): the PAD read-endpoint so the web pane renders live PAD/valence for a Tier-3 agent from OUR :8390 affect store — (1) a NON-bifrost read route on the affect-store-owning app — GET /affect/state/{agent_id}?end_user_id=… → store.get; (2) a web proxy GET /api/affect/{agent_id} that supplies end_user_id SERVER-SIDE; (3) a NEW pane render path for the affect-emit snapshot shape. DELIVERABLE 1 (composite endpoint, NOW IN SCOPE — amended 2026-06-19): bifrost 0.10.0 shipped the public bifrost.consumer.build_combined_app and FR-1 RESOLVED (worldtree-dev verified one BifrostClient per session, caps_granted parsed INDEPENDENTLY into memory+affect sets, both stores attach off the SAME endpoint iff their cap was granted — ZERO Worldtree change). D1 = build_combined_provider_app fronting BOTH planes on :8392, advertising both caps by store PRESENCE, mounting the SAME affect read route (INV-007), with the op-feed deriving plane PER request path (plane='combined'); per-plane failure isolation is bifrost's (per-route call-time dispatch isolation in one ASGI process). Direct in-session TDD (the #17 pattern). The panel framing-consult (Heid, 3 arms) pressure-tested this design; its triaged findings are folded in as INV/POST clauses below."
|
||||
depends_on:
|
||||
- "httpx"
|
||||
- "starlette"
|
||||
- "ratatoskr.provider.affect_store"
|
||||
- "ratatoskr.provider.memory_store" # D1: the composite fronts the memory plane too
|
||||
- "ratatoskr.provider.opfeed" # D1: op-feed plane='combined' (per-path derivation)
|
||||
- "ratatoskr.web.server"
|
||||
- "bifrost.consumer" # D1: build_combined_app (bifrost >=0.10.0)
|
||||
used_by:
|
||||
- "ratatoskr.provider.serve"
|
||||
- "ratatoskr.web.entrypoint"
|
||||
language: "python"
|
||||
complexity: "medium"
|
||||
estimated_loc: 130
|
||||
confidence: 0.82
|
||||
assumptions:
|
||||
- "VERIFIED (live affect.db this session): the stored affect.emit snapshot shape is {agent_id, end_user_id, pad:{pleasure,arousal,dominance}, valence:[{entity_id,entity_type,familiarity,interaction_count,regard}], emitted_at}. It overlaps the Worldtree Tier-1 persona_state shape ONLY on agent_id + pad; it has NO dominant_emotion/baseline_pad/mood_drift/emotions_active/last_updated_at, and it HAS valence[] + emitted_at the persona shape lacks. So the pane CANNOT reuse renderPersonaPane — a new affect render path is required (Heid panel Q4: render honestly, do not fabricate Tier-1 fields)."
|
||||
- "VERIFIED (wire, prior session): a Tier-3 turn emits ZERO affect_update SSE and Worldtree persona_state 404s for every Tier-3 colon-id agent (ADR-0009 Tier-1-only). Both Worldtree-side persona sources are dead for consumer agents, so reading OUR store is the only path. The pane therefore POLLS the read endpoint (on session-start + after each turn-end); there is no SSE affect channel to subscribe to."
|
||||
- "The affect store already exposes get(agent_id, end_user_id) -> dict | None (affect_store.py:102). The read route is a thin wrapper over it; the store's conduit-opacity is unaffected (the route returns the stored blob verbatim)."
|
||||
- "RatatoskrAffectStore holds ONE sqlite3.Connection shared across emit + the new read in a single process; the event loop serializes the sync sqlite calls (no threadpool), so same-process read+write needs no extra locking. busy_timeout matters for the FUTURE cross-process case (composite :8392 + standalone :8390 opening the same affect.db); setting it now is correct prep, not a same-process fix."
|
||||
- "build_affect_provider_app currently returns build_affect_app(...) directly. It now adds the read route to that app via app.add_route('/affect/state/{agent_id}', ...) — keeping /bifrost/handshake + /bifrost/affect-call as TOP-LEVEL routes (so the existing route-introspection test stays green AND the op-feed's scope['path'] check in opfeed.py _BIFROST_PATHS still matches the bifrost calls and passes the read route through untouched, INV-004). add_route is preferred over an outer Mount precisely because Mount would push the bifrost paths under the mount and break top-level introspection — add_route is the surgical composition."
|
||||
- "The web affect-read hop is SERVER-TO-PROVIDER (same dev box), distinct from the Worldtree-visible host used for binding. So RATATOSKR_AFFECT_READ_URL is its own config (default http://127.0.0.1:8390), NOT derived from RATATOSKR_PROVIDER_VISIBLE_HOST (which is the WT-visible host for handshake)."
|
||||
- "Tests: respx mocks the provider read URL for the web-proxy unit tests; the provider read route is tested in-process against a seeded RatatoskrAffectStore (mirroring the existing affect_store tests). A colon-id (ratatoskr:sindra) round-trips browser->web->provider and is asserted end-to-end (Heid panel FM-7)."
|
||||
open_questions:
|
||||
- "DELIVERABLE 1 / FR-1 (does NOT block Deliverable 2): does Worldtree dispatch BOTH memory-call AND affect-call to ONE bound endpoint that advertised both caps, or is the binding effectively single-plane? Worldtree-dev consult in flight (msg 01KVDXQMJF…). If single-plane, Deliverable 1 needs a Worldtree-side change too. Resolution gates the Deliverable-1 amendment, not this contract."
|
||||
- "Valence display cap: the snapshot's valence[] is unbounded in principle. v1 caps the rendered list (scroll/limit) so the pane layout can't blow out (Heid panel Groa-FM4). Exact cap is a UI detail settled in implementation; the INVARIANT is 'bounded render', not a specific number."
|
||||
prd:
|
||||
issue: 18
|
||||
issue_url: "https://gitea.phasefinal.com/vh/ratatoskr/issues/18"
|
||||
body_sha256_16: "92be262865f38c0e"
|
||||
lock_in_comment_id: null
|
||||
lock_in_sha256_16: null
|
||||
lock_in_at: null
|
||||
pinned_at: "2026-06-18T18:00:00+00:00"
|
||||
dependencies:
|
||||
- issue: 17
|
||||
path: "src/ratatoskr/web/server.py"
|
||||
reason: "INV-006 of #17 — end_user_id is SERVER-configured (app.state.end_user_id from RATATOSKR_END_USER_ID), never read from the browser. The affect-read proxy follows the same posture: the browser names the agent (already in the picker); the server supplies end_user_id."
|
||||
- issue: 17
|
||||
path: "src/ratatoskr/provider/opfeed.py"
|
||||
reason: "The op-feed instruments only _BIFROST_PATHS; the new non-bifrost read route is outside that set and is passed through untouched. Deliverable 2 must NOT alter op-feed behavior (INV-004)."
|
||||
---
|
||||
|
||||
# Issue #18 (Deliverable 2) — PAD read-endpoint → persona pane renders OUR store
|
||||
|
||||
## Context
|
||||
|
||||
Ratatoskr binds a Tier-3 session to its own affect provider (:8390) and Worldtree
|
||||
persists the agent's PAD/valence there (live-proven: vuong session pleasure +0.146,
|
||||
familiarity 0.18→0.59 over 8 turns). But the web pane shows "telemetry isn't exposed":
|
||||
it reads Worldtree `persona_state` (`loadPersona`, index.html:707), which 404s for every
|
||||
Tier-3 colon-id agent (ADR-0009, Tier-1-only), AND a Tier-3 turn emits zero
|
||||
`affect_update` SSE. Both Worldtree-side persona sources are dead for consumer agents.
|
||||
The pane was never wired to render PAD from OUR store — Deliverable 2 closes that.
|
||||
|
||||
**Scope is the PAD-display half ONLY.** Deliverable 1 (the composite :8392 endpoint that
|
||||
lets one session bind both planes) is bifrost-blocked: bifrost-dev has confirmed a public
|
||||
`bifrost.consumer.build_combined_app` (clean additive minor, ~v0.9.0, design locked) and is
|
||||
standing by on the open Worldtree-dispatch question (FR-1). This contract is amended to add
|
||||
Deliverable 1 once that lands. Deliverable 2 has zero bifrost or Worldtree dependency — it
|
||||
reads our own `affect.db` — so it ships now, independently.
|
||||
|
||||
## Public surface
|
||||
|
||||
```python
|
||||
# Provider side (ratatoskr.provider.affect_store) — a NON-bifrost read route on the
|
||||
# affect-store-owning app, composed alongside the bifrost app.
|
||||
def build_affect_provider_app(
|
||||
store: RatatoskrAffectStore,
|
||||
heimdall_key: bytes,
|
||||
consumer_id: str = "ratatoskr",
|
||||
):
|
||||
"""Builds the bifrost affect app, then app.add_route('/affect/state/{agent_id}',
|
||||
…) to add the PAD read route (reading store.get) as a top-level sibling of the
|
||||
bifrost handshake + affect-call routes. The read route is non-bifrost (no JWT)
|
||||
under the internal-LAN trust model. See FN build_affect_provider_app."""
|
||||
|
||||
|
||||
def open_affect_store(db_path: str) -> RatatoskrAffectStore:
|
||||
"""Unchanged surface; additionally sets PRAGMA busy_timeout=5000 on the connection
|
||||
(INV-006) so a contended write waits rather than failing SQLITE_BUSY immediately —
|
||||
WAL alone does not serialize concurrent writers."""
|
||||
```
|
||||
|
||||
```python
|
||||
# Web side (ratatoskr.web.server) — a server-side proxy to the configured affect-read URL.
|
||||
async def _affect_state_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/affect/{agent_id}. Supplies end_user_id from app.state.end_user_id
|
||||
(NEVER the browser); proxies to app.state.affect_read_url, re-encoding agent_id into
|
||||
the provider path (colon-id safe). See FN affect_state_endpoint."""
|
||||
|
||||
|
||||
def create_app(
|
||||
client_factory,
|
||||
*,
|
||||
end_user_id: str | None = None,
|
||||
bifrost_consumer_key: str | None = None,
|
||||
bifrost_visible_host: str | None = None,
|
||||
affect_read_url: str | None = None, # NEW: provider affect-read base URL
|
||||
) -> Starlette: ...
|
||||
```
|
||||
|
||||
```javascript
|
||||
// Pane side (static/index.html) — a NEW render path for the affect-emit shape.
|
||||
function renderAffectPane(snap) { /* pad + per-entity valence + emitted_at; header "affect snapshot" */ }
|
||||
async function loadAffect(agentId) { /* GET /api/affect/{id}; honest render or explicit empty-state */ }
|
||||
// loadPersona dispatches: colon-id agent -> loadAffect; else -> existing persona_state path.
|
||||
```
|
||||
|
||||
## Exception classes / error codes
|
||||
|
||||
No new Python exception types. Error states are JSON `{error_code}` bodies:
|
||||
|
||||
| Surface | error_code | Status | Meaning |
|
||||
|---|---|---|---|
|
||||
| provider read route | `missing_end_user_id` | 400 | `?end_user_id` absent |
|
||||
| provider read route | `no_affect_snapshot` | 404 | `store.get` returned None — no emit yet for (agent, user) |
|
||||
| web proxy | `affect_not_configured` | 400 | `affect_read_url` or server `end_user_id` unset |
|
||||
| web proxy | `affect_provider_unreachable` | 502 | network error reaching the provider read route |
|
||||
| web proxy | (passthrough) | provider status | provider 404/400 surfaced to the browser verbatim |
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-001 (honest shape, no fabrication).** The pane renders ONLY fields the
|
||||
affect.emit snapshot actually carries — `pad{pleasure,arousal,dominance}`, per-entity
|
||||
`valence[]` (familiarity/regard/interaction_count), `emitted_at`. It MUST NOT
|
||||
synthesize Tier-1 `persona_state` fields (`dominant_emotion`, `baseline_pad`,
|
||||
`mood_drift`, `emotions_active`) — those are platform concepts Tier-3 structurally
|
||||
lacks (ADR-0009); a fabricated empty `mood_drift` reads as a bug, not an absence.
|
||||
- **INV-002 (end_user_id is server-supplied, never browser).** The web proxy reads
|
||||
`end_user_id` from `app.state.end_user_id` (RATATOSKR_END_USER_ID); it MUST NOT accept
|
||||
one from the browser body/query. Mirrors #17 INV-006 — a client cannot read an
|
||||
arbitrary end-user's affect partition.
|
||||
- **INV-003 (empty/missing is fail-visible).** No emit yet for (agent, user) → an
|
||||
EXPLICIT no-data state (provider 404 `no_affect_snapshot`; pane shows "no affect
|
||||
emitted yet for this agent / user"). NEVER a zeroed `pad:{0,0,0}` that looks like real
|
||||
PAD. A missing/unset `RATATOSKR_END_USER_ID` is a visible config error, not a silent
|
||||
empty result.
|
||||
- **INV-004 (op-feed + scope semantics untouched).** The read route is non-bifrost and
|
||||
sits OUTSIDE `opfeed._BIFROST_PATHS`, so the op-feed passes it through and emits no
|
||||
OpEvent for it. Deliverable 2 changes neither op-feed behavior nor store scope/affect
|
||||
semantics; the store stays conduit-opaque (it returns the stored blob verbatim).
|
||||
- **INV-005 (label honesty).** When the pane renders affect-store data it is labelled
|
||||
"affect" (e.g. "affect snapshot"), NOT "persona" — the data is affect, not Worldtree
|
||||
persona_state, and the label must not imply otherwise.
|
||||
- **INV-006 (SQLite busy_timeout).** Every affect-store connection sets
|
||||
`busy_timeout >= 5000ms`. WAL permits one writer + many readers but the default
|
||||
busy_timeout is 0 (a contended write returns SQLITE_BUSY immediately). This is prep
|
||||
for the future composite/standalone two-process topology; harmless single-process.
|
||||
- **INV-007 (read route on the store owner; pane decoupled via configured URL).** The
|
||||
read route is mounted by whatever app owns the affect store; the pane proxies to
|
||||
`RATATOSKR_AFFECT_READ_URL`, so it renders regardless of which endpoint a session is
|
||||
bound to. The deferred composite (Deliverable 1) will mount the SAME read route over
|
||||
the SAME `affect.db` — one shared helper, not a composite-only feature.
|
||||
- **INV-008 (colon-id round-trip).** A Tier-3 `agent_id` containing `:`
|
||||
(`ratatoskr:sindra`) round-trips browser → web (`encodeURIComponent`) → provider (web
|
||||
re-encodes via `quote(agent_id, safe='')` into the provider path) → `store.get`. Both
|
||||
hops are asserted end-to-end with a colon-id (Heid panel FM-7).
|
||||
|
||||
## Data flow
|
||||
|
||||
PANE LOAD (poll, no SSE): on session-start and after each turn-end, the pane calls
|
||||
`loadPersona(agentId)`. For a colon-id (Tier-3) agent it dispatches to `loadAffect` →
|
||||
`GET /api/affect/{agent_id}` → the web server supplies `end_user_id` server-side →
|
||||
proxies to `GET {affect_read_url}/affect/state/{quote(agent_id)}?end_user_id=…` → the
|
||||
provider reads `store.get(agent_id, end_user_id)` → snapshot JSON (200) or
|
||||
`no_affect_snapshot` (404) → `renderAffectPane` or the explicit empty-state. For a
|
||||
non-colon (Tier-1) agent, the existing `persona_state` path is unchanged.
|
||||
|
||||
## Function contracts
|
||||
|
||||
```contract
|
||||
FN build_affect_provider_app(store: RatatoskrAffectStore, heimdall_key: bytes, consumer_id: str = "ratatoskr") -> ASGIApp
|
||||
BRIEF: Compose the PAD read route + the bifrost affect app into one Starlette app, so the affect provider also serves the non-bifrost read.
|
||||
|
||||
PRE: [PRE-001 hard] store.affect_supported is True -- else ValueError (unchanged)
|
||||
PRE: [PRE-002 hard] heimdall_key is non-empty bytes -- else ValueError (unchanged)
|
||||
POST: [POST-001 return_value] returns the bifrost affect app with an added top-level GET /affect/state/{agent_id} route -- assert
|
||||
POST: [POST-002 return_value] /bifrost/handshake + /bifrost/affect-call remain top-level routes so the op-feed still matches them (INV-004) -- assert
|
||||
STEPS:
|
||||
1. app = build_affect_app(store, verifier, registration) as today (after the existing PRE guards)
|
||||
2. define _affect_state_route closing over store (see FN affect_state_route)
|
||||
3. app.add_route('/affect/state/{agent_id}', _affect_state_route, methods=['GET']); return app
|
||||
```
|
||||
|
||||
```contract
|
||||
FN affect_state_route(request) -> JSONResponse # provider-side, closes over store
|
||||
BRIEF: Read store.get(agent_id, end_user_id) and return the snapshot or an explicit no-data 404.
|
||||
|
||||
PRE: [PRE-001 hard] end_user_id query param present and non-empty -- else 400 missing_end_user_id (INV-003)
|
||||
POST: [POST-001 return_value] store.get returns a snapshot → 200 with the snapshot JSON verbatim (conduit-opaque) -- assert
|
||||
POST: [POST-002 return_value] store.get returns None → 404 {error_code:"no_affect_snapshot", agent_id, end_user_id} (INV-003) -- assert
|
||||
STEPS:
|
||||
1. agent_id = path_params['agent_id']; end_user_id = query_params.get('end_user_id')
|
||||
2. guard end_user_id (PRE-001); snap = store.get(agent_id, end_user_id)
|
||||
3. snap is None → 404 no_affect_snapshot; else 200 snap
|
||||
```
|
||||
|
||||
```contract
|
||||
FN affect_state_endpoint(request) -> JSONResponse # web-side proxy
|
||||
BRIEF: Proxy GET /api/affect/{agent_id} to the configured provider read URL, supplying end_user_id server-side, colon-id safe.
|
||||
|
||||
PRE: [PRE-001 hard] app.state.affect_read_url and app.state.end_user_id are set -- else 400 affect_not_configured (INV-002/003)
|
||||
POST: [POST-001 state_change] the upstream request carries end_user_id from app.state, NEVER from the browser (INV-002) -- assert
|
||||
POST: [POST-002 return_value] provider 200 → 200 with the snapshot; provider 404/400 → same status passthrough -- assert
|
||||
POST: [POST-003 exception] httpx.RequestError reaching the provider → 502 affect_provider_unreachable -- assert
|
||||
POST: [POST-004 side_effect] agent_id is quote()'d into the provider path so a colon-id round-trips (INV-008) -- assert
|
||||
STEPS:
|
||||
1. agent_id = path_params['agent_id']; read affect_read_url + end_user_id from app.state; guard (PRE-001)
|
||||
2. url = f"{affect_read_url}/affect/state/{quote(agent_id, safe='')}"
|
||||
3. GET url with params {end_user_id}; on RequestError → 502; else passthrough (status, json)
|
||||
```
|
||||
|
||||
## ERROR_ROUTING
|
||||
|
||||
| Wire (provider) | Web proxy → browser | Pane render |
|
||||
|---|---|---|
|
||||
| 200 snapshot | 200 snapshot | `renderAffectPane` (pad + valence + emitted_at) |
|
||||
| 404 `no_affect_snapshot` | 404 `no_affect_snapshot` | "no affect emitted yet for this agent / user" (INV-003) |
|
||||
| 400 `missing_end_user_id` | (server always supplies it) | n/a — config bug surfaced as `affect_not_configured` |
|
||||
| (provider unreachable) | 502 `affect_provider_unreachable` | "affect provider unavailable" |
|
||||
| (server misconfig) | 400 `affect_not_configured` | "affect telemetry not configured" |
|
||||
|
||||
## Acceptance
|
||||
|
||||
Unit (respx + in-process store):
|
||||
1. provider read route: seeded store → 200 with the exact snapshot; unseeded (agent,user) → 404 `no_affect_snapshot`; missing `end_user_id` → 400.
|
||||
2. provider app: `/bifrost/handshake` + `/bifrost/affect-call` still reachable after the read route is composed in (INV-004 / POST-002).
|
||||
3. web proxy: supplies server `end_user_id` (browser-supplied one is ignored); colon-id `ratatoskr:sindra` round-trips into the provider path (INV-008); provider-unreachable → 502; unconfigured → 400.
|
||||
4. op-feed: a request to `/affect/state/...` produces NO OpEvent (INV-004).
|
||||
5. busy_timeout: `open_affect_store` connection reports `busy_timeout == 5000` (INV-006).
|
||||
|
||||
Live-smoke (load-bearing, manual — the repo's posture): with the affect provider up and a
|
||||
prior emit for `ratatoskr:sindra` / the configured end_user, open the web pane on that agent
|
||||
→ the pane renders live PAD + valence + `emitted_at` from OUR store (no "telemetry isn't
|
||||
exposed"); on a fresh (agent,user) with no emit → the explicit empty-state, not a zeroed PAD.
|
||||
|
||||
## Deliverable 1 — composite endpoint (`build_combined_app`)
|
||||
|
||||
### Context
|
||||
|
||||
One bound Worldtree session that both remembers (memory.*) AND shows live PAD
|
||||
(affect.*). bifrost 0.10.0 ships `bifrost.consumer.build_combined_app(memory_store,
|
||||
affect_store, verifier, registration, maintenance_store=None) -> ASGIApp`: ONE app
|
||||
exposing handshake + `/bifrost/memory-call` + `/bifrost/affect-call` (no legacy
|
||||
`/bifrost/tool-call`), advertising BOTH caps by store PRESENCE. FR-1 is resolved:
|
||||
Worldtree runs one `BifrostClient` per session off a single `_endpoint_url`, parses
|
||||
`capabilities_granted` independently into memory+affect sets, and attaches each store
|
||||
iff its cap was granted — so a single `:8392` endpoint advertising both caps drives
|
||||
both planes with ZERO Worldtree change. D1 is bifrost-only on our side: compose the
|
||||
combined app + mount our existing affect read route + derive the op-feed plane per
|
||||
path. It is ADDITIVE — the standalone `:8390`/`:8391` apps are unchanged.
|
||||
|
||||
### Public surface (D1)
|
||||
|
||||
```python
|
||||
# ratatoskr.provider.combined — a NEW module (the composite spans both planes, so it
|
||||
# belongs in neither store module).
|
||||
def build_combined_provider_app(
|
||||
memory_store: RatatoskrMemoryStore,
|
||||
affect_store: RatatoskrAffectStore,
|
||||
heimdall_key: bytes,
|
||||
consumer_id: str = "ratatoskr",
|
||||
):
|
||||
"""Wire the JWT verifier + registration, hand BOTH stores to
|
||||
bifrost.consumer.build_combined_app, then mount the SAME non-bifrost affect read
|
||||
route (the shared helper) as a top-level sibling. Returns a Starlette app exposing
|
||||
/bifrost/handshake + /bifrost/memory-call + /bifrost/affect-call + GET
|
||||
/affect/state/{agent_id}. See FN build_combined_provider_app."""
|
||||
|
||||
# ratatoskr.provider.affect_store — the read route is extracted into a shared helper
|
||||
# so both build_affect_provider_app and build_combined_provider_app mount the SAME one.
|
||||
def add_affect_read_route(app, store: RatatoskrAffectStore) -> None: ...
|
||||
|
||||
# ratatoskr.provider.serve_combined — `ratatoskr-combined-provider` console script,
|
||||
# :8392. Opens BOTH affect.db + memory.db stores; wires the op-feed with plane='combined'.
|
||||
```
|
||||
|
||||
### Invariants (D1)
|
||||
|
||||
- **INV-009 (both stores REQUIRED).** `build_combined_provider_app` requires a real
|
||||
memory_store AND affect_store; bifrost's `build_combined_app` raises `ValueError`
|
||||
if either is None (single-plane consumers use `build_affect_app`/`build_memory_app`).
|
||||
We pass our real SQLite-backed stores; no in-memory default.
|
||||
- **INV-010 (advertise BOTH caps by store PRESENCE).** The combined handshake grants
|
||||
`memory` and `affect` by the presence of each advertising store (memory needs
|
||||
`describe_store`; affect needs `affect_supported` + `emit` + `fetch`, strong-or-absent
|
||||
— see the affect-provider contract INV-010) — NOT a runtime health probe. The affect
|
||||
cap therefore depends on Deliverable-prerequisite `affect.fetch` already shipped.
|
||||
- **INV-011 (SAME affect read route, shared helper).** The composite mounts the
|
||||
identical `GET /affect/state/{agent_id}` route over the SAME affect store, via the
|
||||
shared `add_affect_read_route` helper — NOT a composite-only reimplementation
|
||||
(fulfils the D2 INV-007 promise). The pane reads it through `RATATOSKR_AFFECT_READ_URL`
|
||||
regardless of whether the bound endpoint is `:8390` or `:8392`.
|
||||
- **INV-012 (op-feed plane derived PER request path).** On the composite, the op-feed
|
||||
cannot use a fixed `plane` — both planes share one app. With `plane='combined'` it
|
||||
derives the OpEvent plane from `scope['path']`: `/bifrost/memory-call`→`memory`,
|
||||
`/bifrost/affect-call`→`affect`, `/bifrost/handshake`→`combined`. The per-verb
|
||||
summary logic already keys on path, so memory/affect summaries stay correct; this is
|
||||
purely the plane STAMP. The non-bifrost read route stays outside `_BIFROST_PATHS`
|
||||
(no OpEvent), unchanged.
|
||||
- **INV-013 (per-plane failure isolation is bifrost's, honest).** Failure isolation is
|
||||
per-route CALL-TIME dispatch isolation within ONE shared ASGI process — a memory-call
|
||||
failure does not corrupt an affect-call and vice-versa. Bind-time + process-crash are
|
||||
SHARED domains (one process), not independent services; the contract does not claim
|
||||
otherwise. We add no isolation layer of our own.
|
||||
- **INV-014 (additive — standalones unchanged).** `:8392` is a NEW endpoint alongside
|
||||
`:8390`/`:8391`; `build_affect_provider_app`/`build_memory_provider_app` and their
|
||||
serve entrypoints are untouched. The composite + a standalone may open the SAME
|
||||
`affect.db` (two processes) — hence the affect store's `busy_timeout` (D2 INV-006).
|
||||
|
||||
### Function contracts (D1)
|
||||
|
||||
```contract
|
||||
FN add_affect_read_route(app, store: RatatoskrAffectStore) -> None
|
||||
BRIEF: Mount the non-bifrost GET /affect/state/{agent_id} read route on `app` (shared by the affect-only and combined apps). Extracted from build_affect_provider_app verbatim (INV-011 / D2 INV-007).
|
||||
POST: [POST-001 side_effect] app gains a top-level GET /affect/state/{agent_id} route reading store.get -- assert route present
|
||||
POST: [POST-002 side_effect] /bifrost/* routes remain top-level (the helper only adds; never Mounts) so the op-feed path-check still matches them (D2 INV-004) -- assert
|
||||
STEPS:
|
||||
1. define _affect_state_route closing over store (PRE: end_user_id present → else 400 missing_end_user_id; store.get None → 404 no_affect_snapshot; else 200 snap verbatim)
|
||||
2. app.add_route('/affect/state/{agent_id}', _affect_state_route, methods=['GET'])
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_combined_provider_app(memory_store: RatatoskrMemoryStore, affect_store: RatatoskrAffectStore, heimdall_key: bytes, consumer_id: str = "ratatoskr") -> ASGIApp
|
||||
BRIEF: Compose bifrost.consumer.build_combined_app over BOTH stores + mount the shared affect read route — one app fronting both planes plus the PAD read.
|
||||
PRE: [PRE-001 hard] affect_store.affect_supported is True -- else ValueError (INV-010)
|
||||
PRE: [PRE-002 hard] heimdall_key is non-empty bytes -- else ValueError
|
||||
POST: [POST-001 return_value] returns a Starlette app exposing /bifrost/handshake + /bifrost/memory-call + /bifrost/affect-call + GET /affect/state/{agent_id} -- assert routes present
|
||||
POST: [POST-002 return_value] a combined handshake requesting [memory, affect] is granted BOTH caps (store presence, INV-010) -- assert
|
||||
POST: [POST-003 return_value] both a memory-call and an affect-call dispatch through the one app (parity vs the standalone apps' behavior) -- assert
|
||||
STEPS:
|
||||
1. guard PRE-001/002; SET verifier = JwtVerifier(HS256, heimdall_key); SET registration = ConsumerRegistration(consumer_id)
|
||||
2. SET app = bifrost.consumer.build_combined_app(memory_store, affect_store, verifier, registration)
|
||||
3. add_affect_read_route(app, affect_store); RETURN app
|
||||
TESTS:
|
||||
builds_both_planes [happy,tracer]: valid stores + key → app with handshake + memory-call + affect-call + /affect/state routes
|
||||
handshake_grants_both [scenario]: handshake requesting [memory, affect] → capabilities_granted contains BOTH (INV-010)
|
||||
memory_and_affect_dispatch [scenario]: a memory search + an affect emit both succeed through the one app via dispatch JWTs (INV-013)
|
||||
affect_read_route_on_composite [happy]: seeded affect store → GET /affect/state/{colon-id} returns the snapshot (INV-011)
|
||||
missing_affect_store [adversarial]: affect_store=None → ValueError (bifrost INV-001)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN serve_combined.main() -> None
|
||||
BRIEF: `ratatoskr-combined-provider` entrypoint — open both stores, build the combined app, wire the op-feed (plane='combined'), serve on :8392.
|
||||
STEPS:
|
||||
1. open_affect_store(RATATOSKR_AFFECT_DB) + open_memory_store(RATATOSKR_MEMORY_DB)
|
||||
2. app = build_combined_provider_app(memory_store, affect_store, heimdall_key, consumer_id)
|
||||
3. app = maybe_instrument_from_env(app, env, plane='combined') -- op-feed derives plane per path (INV-012)
|
||||
4. uvicorn.run(app, host, port=8392)
|
||||
TESTS:
|
||||
(serve wiring is exercised by the unit tests for build_combined_provider_app + the op-feed plane='combined' tests; the uvicorn.run line is a thin shell, smoke-only)
|
||||
```
|
||||
|
||||
### Acceptance (D1)
|
||||
|
||||
Unit (in-process, dispatch JWTs via `bifrost.core.dispatch_jwt.mint_dispatch_jwt` — the #17 posture):
|
||||
1. `build_combined_provider_app` → app with all four routes; handshake grants both caps.
|
||||
2. a memory `search` + an affect `emit` both dispatch through the one app (INV-013).
|
||||
3. the affect read route works on the composite for a colon-id (INV-011).
|
||||
4. `affect_store=None` → ValueError (INV-009).
|
||||
5. op-feed `plane='combined'`: a memory-call stamps `plane='memory'`, an affect-call stamps `plane='affect'`, a handshake stamps `plane='combined'` (INV-012); the read route emits NO OpEvent.
|
||||
|
||||
Live-smoke (manual, the repo's posture): start `:8392`, bind a Tier-3 session to it, drive a turn → the op-feed shows BOTH a memory op and an affect emit at the bound session_id; the web pane (pointed at `:8392` via `RATATOSKR_AFFECT_READ_URL`) renders live PAD. Then ping bifrost-dev that the composite landed.
|
||||
|
||||
## Out of scope / DEFERRED (anti-creep)
|
||||
|
||||
- **Deliverable 1 — composite :8392 endpoint** — RESOLVED: now in scope, see
|
||||
§ *Deliverable 1* above (bifrost 0.10.0 `build_combined_app` shipped + FR-1 resolved).
|
||||
- WT #289 mediated affect-read (`affect.fetch` over bifrost) — we own the store, read it
|
||||
directly; no Worldtree dependency.
|
||||
- Production hardening (TLS/RS256 on the read route; auth on /affect/state) — internal-LAN
|
||||
trust model, consistent with the rest of ratatoskr.web.
|
||||
- Real-time push of PAD into the pane — Tier-3 emits no affect SSE; v1 polls. A push channel
|
||||
would need a Worldtree-side affect SSE, out of scope.
|
||||
@@ -206,3 +206,267 @@ TESTS:
|
||||
limit_above_max [adversarial]: limit=300 → AssertionError; no HTTP issued
|
||||
empty_cursor [adversarial]: cursor="" → AssertionError; no HTTP issued
|
||||
```
|
||||
|
||||
## Amendment 2026-06-30 — boot-time introspection reads (v1 coverage-audit: capabilities+me)
|
||||
|
||||
The v1 coverage-audit added two read-only server-introspection endpoints as
|
||||
cheap debug primitives (surfaced via a new `ratatoskr --whoami` one-shot). Both
|
||||
mirror `get_persona_state`: GET, 200 → parsed dict verbatim, any non-200 →
|
||||
`SessionApiFailed`. The frozen OpenAPI types both responses as freeform objects,
|
||||
so the wrappers return `dict[str, Any]` (not a typed dataclass).
|
||||
|
||||
```contract
|
||||
FN get_me(client: httpx.AsyncClient) -> dict[str, Any]
|
||||
BRIEF: GET /me — the authenticated principal's identity + key metadata (spec §GET /me). Boot-time whoami: verify the key without agent-config side effects. Returns parsed JSON verbatim; spec documents {user_id, scopes, tier, display_name?, key_id?, key_label?, ...} with optional fields OMITTED (not null). Read-only, rate-exempt, no audit emission.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified -- assert result == resp.json()
|
||||
ERROR_ROUTING:
|
||||
HTTP non-200 (incl. 401 bad/absent key when auth enabled):
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none (caller decides: bad key → re-key; degraded tier="unknown" is still a 200)
|
||||
STEPS:
|
||||
1. [setup, prescriptive] assert client is not None
|
||||
2. [sequential, prescriptive] resp = await client.get("/me")
|
||||
3. [branch, prescriptive] IF resp.status_code == 200: RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy_authenticated [happy,tracer]: 200 {user_id, scopes, tier, key_id} → dict returned verbatim
|
||||
anonymous_dev_mode: 200 {user_id:"anonymous", tier:"anonymous"} → dict; no key_* fields (omitted)
|
||||
401_raises [error]: 401 → SessionApiFailed(status=401)
|
||||
|
||||
FN get_capabilities(client: httpx.AsyncClient) -> dict[str, Any]
|
||||
BRIEF: GET /capabilities — server capability discovery (spec §Ephemeral Templates). Returns {ephemeral_templates: {echo: {allowed_models, default_model, system_prompt_max_bytes}}}. Any authenticated caller may read it (no instantiate scope). Parsed dict verbatim; any non-200 → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified -- assert result == resp.json()
|
||||
ERROR_ROUTING:
|
||||
HTTP non-200:
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none
|
||||
STEPS:
|
||||
1. [setup, prescriptive] assert client is not None
|
||||
2. [sequential, prescriptive] resp = await client.get("/capabilities")
|
||||
3. [branch, prescriptive] IF resp.status_code == 200: RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy [happy]: 200 {ephemeral_templates:{echo:{...}}} → dict returned verbatim
|
||||
non_200_raises [error]: 500 → SessionApiFailed(status=500)
|
||||
```
|
||||
|
||||
## Amendment 2026-07-01 — session tool introspection (v1 coverage-audit)
|
||||
|
||||
Owner-scoped tool-inventory read (spec #183, `GET /sessions/{id}/tools`),
|
||||
surfaced in the TUI Tools pane on session-attach. Same shape as the other
|
||||
introspection wrappers: GET, 200 → parsed dict verbatim, non-200 →
|
||||
`SessionApiFailed`. Reachable with the consumer key (no admin scope), unlike the
|
||||
admin variant `GET /admin/sessions/{id}/tools`.
|
||||
|
||||
```contract
|
||||
FN get_session_tools(client: httpx.AsyncClient, session_id: str) -> dict[str, Any]
|
||||
BRIEF: GET /sessions/{session_id}/tools — owner-scoped merged tool inventory (spec #183) the LLM saw at turn-fire: {agent_id, builtin_tools: [...], bifrost_tools: [{name, description, parameters}, ...]}. Owner gate (ctx.user_id == session.user_id); cross-owner → 404 session_not_found (existence-hiding), revoked → 401 auth_revoked. Parsed dict verbatim; any non-200 → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
PRE: [PRE-002 hard] session_id is non-empty str -- assert session_id and isinstance(session_id, str)
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified -- assert result == resp.json()
|
||||
ERROR_ROUTING:
|
||||
HTTP non-200 (incl. 404 session_not_found cross-owner/unknown, 401 auth_revoked):
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none
|
||||
STEPS:
|
||||
1. [setup, prescriptive] assert PRE-001, PRE-002
|
||||
2. [sequential, prescriptive] resp = await client.get(f"/sessions/{session_id}/tools")
|
||||
3. [branch, prescriptive] IF resp.status_code == 200: RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy [happy,tracer]: 200 {agent_id, builtin_tools:[], bifrost_tools:[{name,...}]} → dict verbatim
|
||||
cross_owner_404 [error]: 404 session_not_found → SessionApiFailed(status=404)
|
||||
empty_session_id [adversarial]: "" → AssertionError; no HTTP issued
|
||||
```
|
||||
|
||||
## Amendment 2026-07-01 — admin BifrostState read (v1 coverage-audit)
|
||||
|
||||
Admin-scoped Bifrost dispatch-state read (spec #176, `GET /admin/sessions/{id}/bifrost`),
|
||||
surfaced in the TUI BifrostState pane on session-attach. The first admin-key
|
||||
consumer in ratatoskr: requires the `admin.sessions.read` scope, so the request
|
||||
OVERRIDES the Authorization header with the caller-supplied `admin_key` (distinct
|
||||
from the client's default consumer key). Same result-shape convention as the
|
||||
other introspection wrappers: 200 → parsed dict verbatim, non-200 → `SessionApiFailed`.
|
||||
|
||||
```contract
|
||||
FN get_session_bifrost(client: httpx.AsyncClient, session_id: str, *, admin_key: str) -> dict[str, Any]
|
||||
BRIEF: GET /admin/sessions/{session_id}/bifrost — admin-scoped live Bifrost binding (spec #176): {endpoint_url, consumer_id, connected, capabilities_granted, tools:[{name, description}]}. Requires admin.sessions.read; the request sets Authorization: Bearer <admin_key> (override), NOT the client's default consumer bearer. Parsed dict verbatim; any non-200 → SessionApiFailed — notably 403 auth_scope_denied and 404 session_not_bifrost_bound.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
PRE: [PRE-002 hard] session_id is non-empty str -- assert session_id and isinstance(session_id, str)
|
||||
PRE: [PRE-003 hard] admin_key is non-empty str -- assert admin_key and isinstance(admin_key, str)
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified -- assert result == resp.json()
|
||||
POST: [POST-002 state_change] the outbound request Authorization header == f"Bearer {admin_key}" (override) -- assert request.headers["Authorization"] == "Bearer " + admin_key
|
||||
ERROR_ROUTING:
|
||||
HTTP non-200 (incl. 403 auth_scope_denied, 404 session_not_found / session_not_bifrost_bound):
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none (caller decides: 403 → key lacks scope; 404 not-bound → benign unbound session)
|
||||
STEPS:
|
||||
1. [setup, prescriptive] assert PRE-001..PRE-003
|
||||
2. [sequential, prescriptive] resp = await client.get(f"/admin/sessions/{session_id}/bifrost", headers={"Authorization": f"Bearer {admin_key}"})
|
||||
3. [branch, prescriptive] IF resp.status_code == 200: RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy_uses_admin_bearer [happy,tracer]: 200 {endpoint_url, connected, capabilities_granted, tools} → dict verbatim; request Authorization == "Bearer <admin_key>" (override)
|
||||
scope_denied_403 [error]: 403 → SessionApiFailed(status=403)
|
||||
not_bound_404 [error]: 404 session_not_bifrost_bound → SessionApiFailed(status=404)
|
||||
empty_admin_key [adversarial]: admin_key="" → AssertionError; no HTTP issued
|
||||
```
|
||||
|
||||
## Amendment 2026-07-01 — Tier-2: transient characters + persona-state write (v1 coverage-audit)
|
||||
|
||||
The last in-scope client I/O points. Transient-character CRUD (#161) surfaced
|
||||
via a `--characters` one-shot lifecycle probe; persona-state write surfaced via
|
||||
`--set-persona-pad "p,a,d"` (requires `--session`). All mirror the existing
|
||||
wrappers: parsed dict verbatim (or None on 204), any off-status → SessionApiFailed.
|
||||
**Note:** `set_persona_state`'s request body is FREEFORM — the frozen OpenAPI 2.2.0
|
||||
declares no request schema and the prose spec documents only the GET counterpart,
|
||||
so the caller supplies the snapshot shape. **Canonical (worldtree-dev prose #317,
|
||||
`c9e59ec`): `{pad:{pleasure,arousal,dominance}}` — a named-key dict, NOT a list;
|
||||
`--set-persona-pad` builds + sends the named dict (each float in [-1,1]).**
|
||||
|
||||
```contract
|
||||
FN list_character_models(client) -> dict[str, Any]
|
||||
BRIEF: GET /models/available-for-characters (character.read). Returns {items:[{name, description, thinking}]}. Non-200 → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client is not None
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified
|
||||
STEPS:
|
||||
1. [sequential, prescriptive] resp = await client.get("/models/available-for-characters"); IF 200 RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
list_models [happy,tracer]: 200 {items:[{name:"fast"}]} → dict verbatim
|
||||
|
||||
FN create_character(client, character: dict, *, state: dict | None = None) -> dict[str, Any]
|
||||
BRIEF: POST /characters (character.write). Body {character, state}. Returns 201 {character_id, ttl_expires_at}; non-201 → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client is not None; [PRE-002 hard] character is a non-empty dict
|
||||
POST: [POST-001 return_value] on 201 returns resp.json(); [POST-002 side_effect] outbound body == {"character": <arg>, "state": <state|null>}
|
||||
STEPS:
|
||||
1. [sequential, prescriptive] resp = await client.post("/characters", json={"character": character, "state": state}); IF 201 RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
create [happy]: 201 → {character_id}; body is {character, state:null}
|
||||
create_403 [error]: 403 auth_scope_denied → SessionApiFailed(403)
|
||||
|
||||
FN get_character_state(client, character_id: str) -> dict[str, Any]
|
||||
BRIEF: GET /characters/{id}/state (character.read). Live PAD/emotions snapshot; refreshes TTL. Non-200 → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client not None; [PRE-002 hard] character_id non-empty str
|
||||
POST: [POST-001 return_value] on 200 returns resp.json()
|
||||
STEPS:
|
||||
1. [sequential, prescriptive] resp = await client.get(f"/characters/{character_id}/state"); IF 200 RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
get_state [happy]: 200 {pad:[...]} → dict verbatim
|
||||
|
||||
FN delete_character(client, character_id: str) -> None
|
||||
BRIEF: DELETE /characters/{id} (character.write). 200/204 → None; other → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client not None; [PRE-002 hard] character_id non-empty str
|
||||
POST: [POST-001 return_value] on 200/204 returns None
|
||||
STEPS:
|
||||
1. [sequential, prescriptive] resp = await client.delete(f"/characters/{character_id}"); IF status in (200,204) RETURN None; ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
delete [happy]: 204 → None
|
||||
|
||||
FN set_persona_state(client, session_id: str, snapshot: dict) -> None
|
||||
BRIEF: POST /sessions/{session_id}/persona_state — set a session's persona state (affect injection). Request body is the FREEFORM snapshot (caller-supplied; unpinned in the frozen surface). 204 → None; other → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client not None; [PRE-002 hard] session_id non-empty str; [PRE-003 hard] snapshot is a dict
|
||||
POST: [POST-001 return_value] on 204 returns None; [POST-002 side_effect] outbound body == snapshot verbatim
|
||||
STEPS:
|
||||
1. [sequential, prescriptive] resp = await client.post(f"/sessions/{session_id}/persona_state", json=snapshot); IF 204 RETURN None; ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy [happy]: 204 → None; body == {"pad":{"pleasure","arousal","dominance"}} verbatim (canonical named-key dict, #317)
|
||||
non_204 [error]: 422 → SessionApiFailed(422)
|
||||
```
|
||||
|
||||
## Amendment 2026-07-06 — authored-history write (#347, v1 coverage-audit re-open)
|
||||
|
||||
Worldtree shipped #347 (authored-history-write) as OpenAPI 2.3.0: a new
|
||||
`POST /sessions/{session_id}/history` primitive that writes ONE model-visible
|
||||
turn into a session's ledger AS the bound agent, WITHOUT a generation and
|
||||
WITHOUT lived-turn side effects (the SillyTavern "first message"). The re-vendor
|
||||
(2.2.0→2.3.0, pin `879cefe`) re-opened the v1 coverage-audit with this one new
|
||||
in-scope REST path-group; this amendment closes it on the consumer side and also
|
||||
un-defers `GET /sessions/{id}/messages` (previously §Out of scope) as the seed's
|
||||
read-back.
|
||||
|
||||
**Hide-existence (server INV-347-1) — the load-bearing consumer contract.** The
|
||||
`session.history.write` grant is checked FIRST — an ungranted caller (or a
|
||||
non-owner, or an unknown session) gets a 404 **byte-identical** to a genuine
|
||||
`session_not_found`, never a 403/409/422 that would reveal the feature exists.
|
||||
The consumer MUST honor this: treat 404 as **feature-absent**, fall back (a
|
||||
production consumer to a model-generated greeting), and NEVER capability-probe to
|
||||
tell feature-absent from ungranted from session-absent. The wrapper encodes it by
|
||||
raising a DISTINCT `AuthoredHistoryUnavailable` on 404 (NOT `SessionApiFailed`),
|
||||
so a caller branches feature-absent without inspecting a status code.
|
||||
|
||||
**Request body — v1-minimal, wire-pinned by the server.** The frozen OpenAPI 2.3.0
|
||||
exports an empty request schema, but the server pins `AuthoredWriteRequest`
|
||||
(`extra="forbid"`): `{author, content, idempotency_key, effects?,
|
||||
claimed_original_at?}`. v1: `author="assistant"` (only value), `content` (UTF-8,
|
||||
server-bounded at `authored_content_max_bytes`=8192), `idempotency_key` (REQUIRED,
|
||||
per-session dedup), `effects` omitted (== "none"; only value). Because
|
||||
`extra="forbid"`, the wrapper omits `effects`/`claimed_original_at` when None
|
||||
(never sends null). Success is 201 (fresh) OR 200 (idempotent replay,
|
||||
byte-identical body); both return the `AuthoredTurnResponse` `{author,
|
||||
content_chars, injected_at, phase, seq, session_id, turn_id}` verbatim (provenance
|
||||
is audit-only, NEVER on this body — INV-347-7).
|
||||
|
||||
**Assistant-first provider constraint (deferred, inert for the probe).** A
|
||||
create-time first-message makes the assistant seq-0 (assistant-first history);
|
||||
Anthropic-family providers 400 the *next generation*, vLLM/openai_compat tolerate
|
||||
it. The `--seed-first-message` probe seeds but does NOT generate, so the
|
||||
constraint is inert for the probe — a real consumer that then generates must bind
|
||||
an assistant-first-tolerant provider.
|
||||
|
||||
```contract
|
||||
FN write_authored_history(client: httpx.AsyncClient, session_id: str, *, content: str, idempotency_key: str, author: str = "assistant", effects: str | None = None, claimed_original_at: str | None = None) -> dict[str, Any]
|
||||
BRIEF: POST /sessions/{session_id}/history — the #347 authored-history-write primitive (write one model-visible turn as the bound agent, no generation, no side effects). Body {author, content, idempotency_key} + "effects"/"claimed_original_at" only when non-None (server AuthoredWriteRequest is extra="forbid"). Success 200 (replay) or 201 (fresh) → AuthoredTurnResponse dict verbatim. 404 → AuthoredHistoryUnavailable (hide-existence: feature-absent/ungranted/session-absent, indistinguishable by design — consumer falls back, never probes). Any other non-2xx → SessionApiFailed.
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
PRE: [PRE-002 hard] session_id is a non-empty str -- assert session_id and isinstance(session_id, str)
|
||||
PRE: [PRE-003 hard] content is a non-empty str -- assert content and isinstance(content, str)
|
||||
PRE: [PRE-004 hard] idempotency_key is a non-empty str -- assert idempotency_key and isinstance(idempotency_key, str)
|
||||
PRE: [PRE-005 hard] author is a non-empty str -- assert author and isinstance(author, str)
|
||||
POST: [POST-001 side_effect] exactly one POST to /sessions/{session_id}/history; body == {"author": author, "content": content, "idempotency_key": idempotency_key} plus "effects" iff effects is not None plus "claimed_original_at" iff claimed_original_at is not None (no null-valued keys — extra="forbid")
|
||||
POST: [POST-002 return_value] on 200 or 201 returns resp.json() unmodified
|
||||
ERROR_ROUTING:
|
||||
HTTP 404 (hide-existence session_not_found):
|
||||
local_handling: raise AuthoredHistoryUnavailable(session_id=session_id)
|
||||
flow_control: abort
|
||||
state_recovery: caller treats as feature-absent; fall back to a model-generated greeting; NEVER capability-probe (INV-347-1)
|
||||
HTTP other non-2xx (incl. 409 generation_active, 422 content_too_long/validation_failed, 401 auth_revoked, 410 session_retired):
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none (409 retryable; 422 caller bug/oversize)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] assert PRE-001..PRE-005
|
||||
2. [sequential, flexibility=prescriptive] body = {"author": author, "content": content, "idempotency_key": idempotency_key}; IF effects is not None: body["effects"] = effects; IF claimed_original_at is not None: body["claimed_original_at"] = claimed_original_at
|
||||
3. [sequential, flexibility=prescriptive] resp = await client.post(f"/sessions/{session_id}/history", json=body)
|
||||
tool: { destructive: false, idempotent: true, read_only: false, open_world: false }
|
||||
4. [branch, flexibility=prescriptive] IF resp.status_code in (200, 201): RETURN resp.json(); ELIF resp.status_code == 404: RAISE AuthoredHistoryUnavailable(session_id=session_id); ELSE RAISE SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
TESTS:
|
||||
happy_fresh_201 [happy,tracer]: 201 {author:"assistant", seq:0, phase:"seeded", turn_id, content_chars, session_id, injected_at} → dict verbatim; outbound body == {"author":"assistant","content":<c>,"idempotency_key":<k>} exactly (no effects/claimed_original_at keys)
|
||||
happy_replay_200 [happy]: 200 (same-key replay, byte-identical body) → dict verbatim
|
||||
body_includes_effects [trace]: effects="none" → outbound body has "effects":"none"; claimed_original_at="2020-01-01T00:00:00Z" → body has that key too
|
||||
hide_existence_404 [error]: 404 {error_code:"session_not_found"} → raises AuthoredHistoryUnavailable(session_id=<arg>), NOT SessionApiFailed
|
||||
generation_active_409 [error]: 409 {error_code:"generation_active"} → SessionApiFailed(status=409)
|
||||
content_too_long_422 [error]: 422 {error_code:"content_too_long"} → SessionApiFailed(status=422)
|
||||
empty_content [adversarial]: content="" → AssertionError; no HTTP issued
|
||||
empty_idempotency_key [adversarial]: idempotency_key="" → AssertionError; no HTTP issued
|
||||
empty_session_id [adversarial]: session_id="" → AssertionError; no HTTP issued
|
||||
|
||||
FN get_session_messages(client: httpx.AsyncClient, session_id: str) -> dict[str, Any]
|
||||
BRIEF: GET /sessions/{session_id}/messages — the session's message history (spec §GET /sessions/{id}/messages), un-deferred as the #347 probe's read-back so a seeded turn can be confirmed to render as a normal role=assistant message (model-invisible provenance — a seed is indistinguishable from a lived turn on read). Returns {session_id, items:[{seq, role, content, ...}], next_cursor} verbatim. Owner-scoped; any non-200 → SessionApiFailed. v1 reads the server default page (no pagination params — the probe reads a fresh 1-message session; add limit/cursor when a caller needs scrollback).
|
||||
PRE: [PRE-001 hard] client is not None -- assert client is not None
|
||||
PRE: [PRE-002 hard] session_id is a non-empty str -- assert session_id and isinstance(session_id, str)
|
||||
POST: [POST-001 return_value] on 200 returns resp.json() unmodified
|
||||
ERROR_ROUTING:
|
||||
HTTP non-200 (incl. 404 session_not_found cross-owner/unknown):
|
||||
local_handling: raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
flow_control: abort
|
||||
state_recovery: none
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] assert PRE-001, PRE-002
|
||||
2. [sequential, flexibility=prescriptive] resp = await client.get(f"/sessions/{session_id}/messages")
|
||||
3. [branch, flexibility=prescriptive] IF resp.status_code == 200: RETURN resp.json(); ELSE RAISE SessionApiFailed
|
||||
TESTS:
|
||||
happy [happy]: 200 {session_id, items:[{seq:0, role:"assistant", content:"…"}], next_cursor:null} → dict verbatim
|
||||
not_found_404 [error]: 404 → SessionApiFailed(status=404)
|
||||
empty_session_id [adversarial]: "" → AssertionError; no HTTP issued
|
||||
```
|
||||
|
||||
@@ -390,6 +390,30 @@ POST: [POST-004 side_effect] for Done/Error/Cancelled: if text_written_since_new
|
||||
POST: [POST-005 side_effect] for demoted telemetry (WorkerPhase, TextBoundary, ToolStart, ToolResult): write `. <label>: <fields>\n` to stderr
|
||||
ERROR_ROUTING:
|
||||
(none at this level — pure dispatch over the typed union)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate event is one of the Event union variants per PRE-001.
|
||||
2. [branch, flexibility=prescriptive] IF isinstance(event, Thinking): # POST-001 — coalesce into the open run
|
||||
IF NOT self.thinking_open: WRITE ". thinking: " to stderr; SET self.thinking_open=True
|
||||
WRITE event.content to stderr; FLUSH; APPEND event.content to self.thinking_buffer
|
||||
RETURN
|
||||
3. [branch, flexibility=prescriptive] IF self.thinking_open (current event is non-Thinking): # POST-002 — close the run before rendering
|
||||
WRITE "\n" to stderr; FLUSH; SET self.thinking_open=False; CLEAR self.thinking_buffer
|
||||
4. [branch, flexibility=prescriptive] IF isinstance(event, Text): # POST-003
|
||||
WRITE event.content to stdout; FLUSH
|
||||
SET self.text_written_since_newline = not event.content.endswith("\n") # Volva F4 — only flag a mid-line cursor
|
||||
RETURN
|
||||
5. [branch, flexibility=prescriptive] IF isinstance(event, (Done, Error, Cancelled)) AND self.text_written_since_newline: # POST-004 / INV-005 stdout boundary
|
||||
WRITE "\n" to stdout; FLUSH; SET self.text_written_since_newline=False
|
||||
6. [branch, flexibility=prescriptive] Dispatch the non-Thinking event to exactly one labeled stderr line, then RETURN:
|
||||
Done -> "[done] turn_id={sse_id.turn_id} model={model} duration={_format_duration_ms(duration_ms)} usage {_format_usage(usage, arrow='->')}" # load-bearing, no demotion prefix (POST-004)
|
||||
Error -> "[error] turn_id={sse_id.turn_id} code={error_code} message={message!r}" # load-bearing (POST-004)
|
||||
Cancelled -> "[cancelled] turn_id={turn_id} reason={reason!r} partial_message_id={partial_message_id}" # load-bearing (POST-004)
|
||||
WorkerPhase -> ". worker_phase: phase={phase} turn_id={turn_id}" # demoted (POST-005)
|
||||
ToolStart -> ". tool_start: name={name} args={arguments!r}" # demoted (POST-005)
|
||||
ToolResult -> ". tool_result: name={name} duration_ms={duration_ms} result={result!r:.200}" # demoted, 200-char cap (POST-005)
|
||||
TextBoundary -> ". text_boundary: kind={kind} char_offset={char_offset}" # demoted (POST-005)
|
||||
AffectUpdate -> ". affect_update: status={status} turn_id={turn_id} [dominant_emotion={...}]" # Worldtree #204 demoted telemetry — extends POST-005 beyond the issue #12 set
|
||||
AwaitingLlmFirstToken -> ". awaiting_llm_first_token: turn_id={turn_id} elapsed={secs:.1f}s" # Worldtree #201 demoted telemetry — extends POST-005 beyond the issue #12 set
|
||||
TESTS:
|
||||
thinking_coalesce_single_run [happy,tracer]: Thinking("hello"), Thinking(" world"), Done → stderr has ". thinking: hello world\n" then "[done] ..."; no demotion prefix on [done]
|
||||
thinking_closes_on_first_non_thinking_event [happy]: Thinking, WorkerPhase → ". thinking: ...\n" then ". worker_phase: ..."
|
||||
@@ -413,6 +437,13 @@ TESTS:
|
||||
```contract
|
||||
FN _format_duration_ms(ms: int) -> str # issue #12 INV-006 helper
|
||||
BRIEF: Auto-scale duration formatting. ms<1000 → "{ms}ms"; ms<60_000 → "{s:.1f}s"; else "{m:.1f}m". Locale-blind.
|
||||
PRE: [PRE-001 hard] ms is a non-negative int -- assert isinstance(ms, int) and ms >= 0
|
||||
POST: [POST-001 return_value] returns a unit-suffixed string: "{ms}ms" below 1s, "{s:.1f}s" below 1m, else "{m:.1f}m"
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate input per PRE-001 -- assert isinstance(ms, int) and ms >= 0
|
||||
2. [branch, flexibility=prescriptive] IF ms < 1000: RETURN f"{ms}ms"
|
||||
3. [branch, flexibility=prescriptive] IF ms < 60_000: RETURN f"{ms / 1000:.1f}s"
|
||||
4. [sequential, flexibility=prescriptive] RETURN f"{ms / 60_000:.1f}m" # minutes fallback
|
||||
TESTS:
|
||||
subsecond: 347 → "347ms"
|
||||
exact_one_second: 1000 → "1.0s"
|
||||
@@ -425,6 +456,12 @@ TESTS:
|
||||
```contract
|
||||
FN _format_usage(usage: dict, *, arrow: str) -> str # issue #12 INV-007 helper
|
||||
BRIEF: Natural-language usage formatting. arrow="->" for CLI (ASCII), arrow="→" for TUI (Unicode).
|
||||
PRE: [PRE-001 hard] usage carries the four token keys -- assert all(k in usage for k in ("prompt_tokens", "completion_tokens", "total_tokens", "cached_input_tokens"))
|
||||
POST: [POST-001 return_value] returns "{p} in {arrow} {c} out ({t} total, {ci} cached)" with the four counts substituted and the caller-supplied arrow glyph
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate input per PRE-001 -- assert all(k in usage for k in ("prompt_tokens", "completion_tokens", "total_tokens", "cached_input_tokens"))
|
||||
2. [sequential, flexibility=prescriptive] Bind p=usage["prompt_tokens"], c=usage["completion_tokens"], t=usage["total_tokens"], ci=usage["cached_input_tokens"]
|
||||
3. [sequential, flexibility=prescriptive] RETURN f"{p} in {arrow} {c} out ({t} total, {ci} cached)"
|
||||
TESTS:
|
||||
ascii_arrow: arrow="->" → "6756 in -> 126 out (6882 total, 0 cached)"
|
||||
unicode_arrow: arrow="→" → "6756 in → 126 out (6882 total, 0 cached)"
|
||||
|
||||
@@ -20,7 +20,7 @@ assumptions:
|
||||
- "`httpx.AsyncClient(base_url=server_url, headers={'Authorization': f'Bearer {api_key}'})` is opened inside the App lifecycle (on_mount) and closed in on_unmount. The TUI owns its client; it does not share a client with `_amain` (the TUI path bypasses `_amain` entirely)."
|
||||
- "`App.run_test()` provides a headless `Pilot` that drives the app from pytest. Pilot supports `pilot.press(...)` for key simulation and `pilot.pause()` to let pending tasks resolve. Widget queries via `app.query_one(...)` work in test mode."
|
||||
open_questions:
|
||||
- "Streaming-markdown partial rendering: streaming raw text mid-turn then re-rendering as Markdown on Done is the cleanest UX, but requires RichLog line-replacement (uncertain support) OR a separate `Static` for the active turn + a 'commit' on Done. Draft: stream raw text into RichLog; on Done, append a separator + the full markdown render below (acknowledging a small redundancy). If empirically ugly, refactor to Static-then-commit in a follow-up — same shape as design-brief §6's `--no-stream-formatting` punt."
|
||||
- "RESOLVED (v0.9.0): streaming-markdown partial rendering. Shipped the Static-then-commit pattern — `Text` deltas accumulate in `text_chunk_buffer` and re-render `Markdown(buffer)` in place into a single response `Static`; no post-Done re-render, no double-display. The issue #12 draft's stream-raw-then-re-render-on-`Done` approach (and its `#current-text` dock-bottom Static) was dropped because the dock-bottom growth visually overlapped the transcript. See INV-005."
|
||||
- "Textual `BINDINGS` priority for `ctrl+c` vs `Input` widget focus: when `Input` is focused, does `ctrl+c` reach the app's binding or get consumed by the input widget? Draft: declare the binding with `priority=True` to ensure the app sees it regardless of focus. If `priority=True` interferes with input editing, fall back to a custom `Input` subclass that surfaces ctrl+c."
|
||||
- "Should the TUI persist transcript across restarts? Per design-brief §8d ('reconnect, not resume-across-process') the answer is no — fresh transcript every launch. Confirming this is in scope of the shell contract (deferred), not punted."
|
||||
prd:
|
||||
@@ -87,7 +87,7 @@ The shell is the load-bearing primary surface. Together with `--send`, it makes
|
||||
- After the `Cancelled` terminal event arrives (or `Done`/`Error`), state returns to **idle** and footer hint resets.
|
||||
- **Note on the idle-hint discrepancy**: the idle-state hint reads `"Ctrl-C twice to exit"` but a single Ctrl-C from idle DOES exit. This is intentional per design-brief §8c's "The footer-hint state transition is load-bearing — the dev needs to see that the next Ctrl-C will exit, otherwise they hit it again expecting another cancel and lose their session." The hint is conservative-by-design — it pre-warns the dev about the *worst-case* (streaming→cancel→exit) flow rather than the literal idle case (one press exits). Implementers MUST use the literal string `"Ctrl-C twice to exit"` (NOT something more accurate like `"Ctrl-C to exit"`); changing it would diverge from the design-brief's locked UX.
|
||||
- **INV-004 [hard]**: Ctrl-D is bound to `app.exit(0)` unconditionally — immediate exit regardless of state. Abandons any in-flight turn (server-side stall watchdog handles the orphan per spec).
|
||||
- **INV-005 [hard]**: Markdown rendering on agent output is default-on; `--raw` is the opt-out. With markdown enabled, `Text` event deltas stream as raw text appended to the RichLog as they arrive (no mid-stream markdown attempt — partial markdown like `**hel` would render ugly), and on `Done` a separator + the full markdown-rendered assistant message is appended below the streamed deltas. **This means the assistant's response visibly appears TWICE in the transcript by design — once as the streamed raw deltas, once as the post-Done markdown render — separated by a horizontal-rule separator.** This is the v1 accepted trade-off for streaming-visibility-without-mid-stream-markdown-ugliness; the cleaner Static-then-commit pattern (streaming into a replaceable widget, then committing the markdown version in place) is documented in `open_questions:` as the follow-up if the double-display proves empirically noisy. Implementers MUST NOT attempt the Static-then-commit pattern in this shell — it's deferred. With `--raw`, only the streamed deltas appear; no post-Done re-render; no double-display.
|
||||
- **INV-005 [hard]**: Markdown rendering on agent output is default-on; `--raw` is the opt-out. `Text` event deltas accumulate in the presenter's `text_chunk_buffer` and render LIVE as `Markdown(buffer)` into a single response `Static` (CSS class `.response-md`) mounted in the transcript scroll — the first delta mounts the widget, each subsequent delta updates it in place. There is NO post-Done re-render and NO double-display: the streamed-then-committed Markdown is the one and only rendering of the response. (v0.9.0 shipped exactly the Static-then-commit pattern the issue #12 draft had deferred; the earlier stream-raw-then-re-render-on-`Done` double-display, and its `#current-text` dock-bottom Static, were removed because the dock-bottom growth visually overlapped the transcript.) With `--raw`, the same widget holds the plain accumulated text instead of a `Markdown` Renderable — still live, still single-display, no Markdown wrapping.
|
||||
- **INV-006 [hard]**: User-prompt echo in the transcript MUST visibly distinguish user input from assistant output. Format: `❯ <content>` for user lines (with a literal `❯` prefix); assistant lines have no prefix. The prefix is also a screen-reader-friendly affordance.
|
||||
- **INV-007 [hard]**: One `httpx.AsyncClient` per app lifetime — opened by `run_tui`'s `async with` BEFORE `App.run_async()` is entered and closed by the same `async with` AFTER `App.run_async()` returns (per issue #6 INV-002). The App is a consumer of an externally-owned client; it MUST NOT call `self.client.aclose()`. The client is NOT recreated per turn (would burn the TCP connection pool).
|
||||
- **INV-008 [hard]**: Mid-session network/protocol errors (`SseConnectionDropped`, `SseConnectFailed`, `MalformedSseId`, `MalformedSseData` (issue #7), `TurnIdFlip`) during a streaming turn render as error lines in the transcript and return the app to **idle** state — they do NOT exit the app. Only initial session-create errors exit (per Data flow exit codes).
|
||||
@@ -104,12 +104,12 @@ The shell is the load-bearing primary surface. Together with `--send`, it makes
|
||||
- **`/admin/events` SSE consumption** — admin observability surface lands with the AdminEvents pane issue.
|
||||
- **`reconnect_turn` mid-session** — if a stream drops mid-turn, the TUI renders the error and returns to idle. In-process reconnect with `Last-Event-ID` resume is a separate issue (the underlying `sse_client.reconnect_turn` is implemented; the TUI doesn't invoke it yet).
|
||||
- **Bifrost-binding consumer support** — not a Ratatoskr concern (per design-brief §6 negative clauses).
|
||||
- **`--quiet` / `--no-stream-formatting`** — deferred per design-brief §6. Add only if streaming text + post-Done markdown render proves empirically noisy.
|
||||
- **`--quiet` / `--no-stream-formatting`** — deferred per design-brief §6. Add only if the live Markdown stream proves empirically noisy.
|
||||
|
||||
## Constraints
|
||||
|
||||
- **[compatibility]** Module must work against the spec pin (`55101e909abcd2219833266b6f905c5bc956e0f0`, Worldtree v0.19.0). The TUI is insulated from wire-level changes through `sse_client` + `sessions`.
|
||||
- **[performance]** Streaming MUST NOT buffer the turn before rendering. `Text` deltas write to RichLog as they arrive. The post-Done markdown render reads the accumulated `Done.response` field from the terminal event — no client-side re-aggregation from individual deltas.
|
||||
- **[performance]** Streaming MUST NOT block on the full turn before rendering. `Text` deltas append to the presenter's `text_chunk_buffer` and re-render the response `Static` in place on each delta (live Markdown) — the transcript updates as tokens arrive. The displayed response is built delta-by-delta; `Done.response` is observable but is NOT the source of the rendered output.
|
||||
- **[security]** TUI does not log `Authorization` header, `--api-key` value, or full event bodies. Persistence is per-launch (no disk writes); transcript content is in-memory only.
|
||||
- **[style]** Async-native. Textual's worker pattern (`self.run_worker(coro, exclusive=True)`) drives the stream loop; no manual thread management. `App[int]` for typed exit codes. ruff line-length=100 (per pyproject).
|
||||
|
||||
@@ -231,9 +231,14 @@ PROPERTIES:
|
||||
BINDINGS:
|
||||
- ("ctrl+c", "interrupt", "Cancel / Exit") # priority=True so Input doesn't consume it; see open_questions
|
||||
- ("ctrl+d", "quit", "Exit immediately")
|
||||
COMPOSE shape (declarative — implementer chooses CSS file vs inline):
|
||||
COMPOSE shape (declarative — implementer chooses CSS file vs inline; exact tab/CSS layout lives in tui.py.compose):
|
||||
Header()
|
||||
RichLog(id="transcript", wrap=True, markup=False, highlight=False) # markup=False: bracketed labels like [cancel_failed] render verbatim instead of being interpreted-and-stripped as Rich style spans. The post-Done markdown render uses Markdown() Renderable which renders regardless of widget-level markup.
|
||||
Horizontal:
|
||||
VerticalScroll(id="transcript-scroll") # chat content: per-turn Static widgets mounted dynamically by the presenter — prompt echo, live-Markdown response (.response-md), tinted terminal labels, awaiting-token indicator. No single RichLog; wire-error labels mount as error-label Statics here.
|
||||
TabbedContent (right column; Ctrl+1..3 switch tabs):
|
||||
RichLog(id="tools-log", markup=False) # ToolStart / ToolResult
|
||||
RichLog(id="debug-log", markup=False) # per-event audit line + WorkerPhase + TextBoundary + turn-summary
|
||||
RichLog(id="thinking-log", markup=False) # coalesced Thinking deltas, Rule(start)/Rule(end) per run
|
||||
Input(id="prompt", placeholder="Type a message and press Enter")
|
||||
Static("", id="identity") # INV-002: visible session-identity strip; rendered by on_mount
|
||||
Static(HINT_IDLE, id="hint") # INV-003: visible Ctrl-C state hint; updated on state transitions
|
||||
@@ -299,39 +304,34 @@ TESTS:
|
||||
|
||||
```contract
|
||||
FN RatatoskrApp._stream_turn_worker(self, content: str) -> None
|
||||
BRIEF: Worker coroutine spawned by `on_input_submitted`. Drives `stream_turn`, renders each event into the RichLog via a freshly-constructed `TuiPresenterState` instance (issue #12 amendment: was `_render_event_to_log`), captures `active_turn_id` from the first event for the Ctrl-C cancel path, and transitions state back to "idle" after the terminal event (or on a mid-session error).
|
||||
BRIEF: Worker coroutine spawned by `on_input_submitted` (exclusive). Queries the four panes, constructs a fresh `TuiPresenterState`, drives `stream_turn`, and renders each event through `presenter.render`. Captures `active_turn_id` + writes the turn headers on the first event (for the Ctrl-C cancel path), breaks on the terminal event, mounts wire-error labels as `error-label` Statics into the transcript scroll, and a `finally` always transitions state back to "idle". v0.9.0: rendering is live (the presenter streams Markdown in place) — there is NO post-Done re-render here.
|
||||
PRE: [PRE-001 hard] self.state == "streaming" (set by on_input_submitted before spawn) -- assert self.state == "streaming"
|
||||
PRE: [PRE-002 hard] self.client is not None (set in on_mount) -- assert self.client is not None
|
||||
PRE: [PRE-003 hard] content is non-empty (caller validated in on_input_submitted) -- assert content
|
||||
POST: [POST-001 state_change] after terminal event OR error, self.state == "idle"; self.active_turn_id is None; footer hint reset to "Ctrl-C twice to exit"
|
||||
POST: [POST-002 side_effect] each event passed through TuiPresenterState.render exactly once (until terminal OR until cancel-induced abort) (issue #12 amendment: was _render_event_to_log)
|
||||
POST: [POST-003 side_effect] for Done events with NOT args.raw: a separator line + the markdown-rendered Done.response appended to RichLog (INV-005)
|
||||
POST: [POST-004 state_change] active_turn_id is set to event.sse_id.turn_id on the FIRST yielded event (for cancel_turn use by action_interrupt)
|
||||
POST: [POST-001 state_change] the `finally` always transitions to "idle": self.state == "idle"; self.active_turn_id is None; footer hint reset to HINT_IDLE — on terminal event, mid-session wire error, OR cancellation
|
||||
POST: [POST-002 side_effect] each event is passed through TuiPresenterState.render exactly once (four panes + the on_persona_snapshot callback threaded), until the terminal event OR a cancel-induced abort
|
||||
POST: [POST-003 state_change] on the FIRST yielded event: active_turn_id is set to event.sse_id.turn_id AND _write_turn_headers(active_turn_id) mounts the turn header (active_turn_id is read by action_interrupt for cancel_turn)
|
||||
POST: [POST-004 side_effect] no post-Done Markdown re-render — the presenter renders Markdown live during Text streaming (v0.9.0); the worker only breaks on the terminal event after the presenter has mounted the tinted label
|
||||
ERROR_ROUTING:
|
||||
SseConnectFailed | SseConnectionDropped | MalformedSseId | MalformedSseData | TurnIdFlip:
|
||||
local_handling: append `[<label>] <details>` to RichLog (mirror cli.py's error labels)
|
||||
flow_control: abort (the iteration aborts; finally-block restores state)
|
||||
state_recovery: state → idle; footer hint reset; active_turn_id cleared. (INV-008: mid-session errors do NOT exit the app.)
|
||||
local_handling: audit the failure, then mount `[<label>] <details>` as an `error-label` Static into the transcript scroll (mirrors cli.py's error labels)
|
||||
flow_control: abort (the iteration aborts; the finally-block restores state)
|
||||
state_recovery: finally → state idle; active_turn_id cleared; hint reset. (INV-008: mid-session wire errors do NOT exit the app.)
|
||||
asyncio.CancelledError (from action_interrupt force-exit OR Worker.cancel()):
|
||||
local_handling: none — propagate to let Textual's worker manager clean up
|
||||
flow_control: abort
|
||||
state_recovery: state → idle; active_turn_id cleared. (cancel_task was already spawned by action_interrupt.)
|
||||
state_recovery: finally → state idle; active_turn_id cleared; hint reset. (cancel_task was already spawned by action_interrupt.)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate inputs per PRE-001..PRE-003
|
||||
2. [loop, flexibility=prescriptive] TRY: async for event in stream_turn(self.client, self.session_id, content):
|
||||
IF self.active_turn_id is None: SET self.active_turn_id = event.sse_id.turn_id # POST-004
|
||||
presenter.render(event, log=self.query_one("#transcript", RichLog), thinking_widget=self.query_one("#thinking-current", Static), raw=self.args.raw) # issue #12: state-based rendering
|
||||
IF isinstance(event, Done):
|
||||
IF NOT self.args.raw:
|
||||
Append a horizontal-rule separator to RichLog
|
||||
Render Markdown(event.response) into RichLog # INV-005 post-Done markdown render
|
||||
BREAK (terminal; iteration done)
|
||||
IF isinstance(event, (Error, Cancelled)):
|
||||
BREAK (terminal)
|
||||
CATCH SseConnectFailed | SseConnectionDropped | MalformedSseId | TurnIdFlip as exc:
|
||||
Append `[<label>] <details>` to RichLog per cli.py's error-label format
|
||||
3. [cleanup, flexibility=prescriptive] FINALLY:
|
||||
SET self.state = "idle"; self.active_turn_id = None; reset footer hint to "Ctrl-C twice to exit"
|
||||
2. [setup, flexibility=prescriptive] Query the four panes — transcript=#transcript-scroll (VerticalScroll), tools_log=#tools-log, debug_log=#debug-log, thinking_log=#thinking-log — and construct presenter = TuiPresenterState()
|
||||
3. [loop, flexibility=prescriptive] TRY: async for event in stream_turn(self.client, self.session_id, content):
|
||||
IF self.active_turn_id is None: SET self.active_turn_id = event.sse_id.turn_id; CALL self._write_turn_headers(self.active_turn_id) # POST-003
|
||||
CALL presenter.render(event, transcript=transcript, tools_log=tools_log, debug_log=debug_log, thinking_log=thinking_log, raw=self.args.raw, on_persona_snapshot=self._update_persona_surfaces) # POST-002
|
||||
IF isinstance(event, (Done, Error, Cancelled)): BREAK # terminal; presenter already rendered the live Markdown + tinted label (POST-004 — no re-render)
|
||||
CATCH SseConnectFailed | SseConnectionDropped | MalformedSseId | MalformedSseData | TurnIdFlip as exc:
|
||||
AUDIT the failure; mount `[<label>] <details>` as an error-label Static into transcript
|
||||
4. [cleanup, flexibility=prescriptive] FINALLY:
|
||||
CALL self._transition("idle", "worker_finally"); SET self.active_turn_id = None; CALL self._set_hint(self.HINT_IDLE)
|
||||
TESTS:
|
||||
happy_text_done_renders_markdown [happy,tracer]: mock yields text("hello") + done(response="hello"); after Pilot.pause(), RichLog contains "hello" (the streamed delta) AND below it a separator + the markdown render of "hello"; state → idle
|
||||
raw_flag_skips_markdown_render [trace]: --raw; mock yields text + done; RichLog has the streamed delta but NO separator + markdown re-render
|
||||
@@ -345,40 +345,84 @@ TESTS:
|
||||
```
|
||||
|
||||
```contract
|
||||
CLASS TuiPresenterState # issue #12 amendment
|
||||
BRIEF: Stateful per-turn presenter for TUI mode. Replaces the stateless `_render_event_to_log` (removed). Owns `thinking_buffer`, `thinking_open`; coalesces thinking-event deltas into per-delta live updates on the dedicated `Static(id="thinking-current")` widget AND one closed RichLog entry per run (two-views-of-thinking decoupling); demotes telemetry events with a `· ` dim prefix on RichLog; Done renders a load-bearing label + Markdown (when not raw); render exceptions degrade to a plain-labeled fallback + `[render_error] <type>` line (NO exception message per INV-009 security).
|
||||
CLASS TuiPresenterState # issue #12 amendment; refreshed to the four-pane live-Markdown model (v0.5.0–v0.14.0 + Worldtree #201/#204)
|
||||
BRIEF: Stateful per-turn presenter for TUI mode. Replaces the stateless `_render_event_to_log` (removed). Routes each event across four panes (transcript / tools_log / debug_log / thinking_log): Thinking deltas coalesce by `\n` into `thinking_log` wrapped in Rule(start)/Rule(end) per run; Text deltas accumulate in `text_chunk_buffer` and render live as `Markdown(buffer)` into a single in-place-updated response `Static` (no post-Done re-render); demoted telemetry gets a `· ` dim prefix (WorkerPhase/TextBoundary → debug_log, Tool* → tools_log); terminal events mount a tinted label + write a turn-summary to debug_log; AffectUpdate fires the persona callback; AwaitingLlmFirstToken mounts/updates a heartbeat indicator; render exceptions degrade to a plain-labeled fallback + `[render_error] <type>` line (NO exception message per INV-009 security).
|
||||
PROPERTIES:
|
||||
thinking_buffer: list[str]
|
||||
thinking_open: bool
|
||||
thinking_run_index: int
|
||||
thinking_chunk_buffer: str
|
||||
text_chunk_buffer: str
|
||||
current_response_widget: object # the live response Static; None between turns
|
||||
text_delta_count: int
|
||||
text_byte_count: int
|
||||
thinking_delta_count: int
|
||||
thinking_byte_count: int
|
||||
turn_start_ts: float
|
||||
awaiting_widget: object # the awaiting-token indicator Static; None when closed
|
||||
heartbeat_count: int
|
||||
INV-WIRE-001: One instance per `_stream_turn_worker` invocation (issue #12 INV-008).
|
||||
INV-WIRE-002: Two-views-of-thinking decoupling (issue #12 INV-004): per-delta updates → thinking-current Static; closed run → RichLog entry.
|
||||
INV-WIRE-002: Thinking is single-view (v0.7.1+): deltas coalesce by `\n` into `thinking_log` (RichLog), each run wrapped in Rule(start)/Rule(end). The issue #12 two-views `#thinking-current` Static was removed.
|
||||
```
|
||||
|
||||
```contract
|
||||
FN TuiPresenterState.render(self, event: Event, *, log: RichLog, thinking_widget: Static, raw: bool) -> None # issue #12 amendment
|
||||
BRIEF: Render one event into the TUI with editorial hierarchy + coalescing per issue #12 INV-001..INV-007 + render-exception fallback per INV-009. Unicode allowed in TUI output (e.g., `· ` U+00B7 prefix, `→` U+2192 arrow in usage). Decoupling: thinking deltas go to `thinking_widget` per-delta; one closed RichLog entry per thinking-run.
|
||||
PRE: [PRE-001 hard] event is an instance of one of the Event union variants
|
||||
POST: [POST-001 side_effect] for Thinking: open run (display=True, thinking_open=True) on first delta; append to buffer; update widget with last ~200 chars (… prefix when truncated)
|
||||
POST: [POST-002 side_effect] for non-Thinking when thinking_open: write ONE RichLog entry `· thinking: <full>`; clear buffer; thinking_open=False; widget cleared + display=False; THEN render the new event
|
||||
POST: [POST-003 side_effect] for Text: write content to RichLog (no prefix, no demotion)
|
||||
POST: [POST-004 side_effect] for Done: write `[done] turn_id=... model=... duration={autoscale} usage={p} in → {c} out ({t} total, {ci} cached)`; if NOT raw, append Rule() + Markdown(event.response) per issue #4 INV-005
|
||||
POST: [POST-005 side_effect] for Error/Cancelled: write the load-bearing label (no demotion); ensure widget cleared+hidden
|
||||
POST: [POST-006 side_effect] for demoted telemetry (WorkerPhase, TextBoundary, ToolStart, ToolResult): write `· <label>: <fields>` to RichLog
|
||||
POST: [POST-007 exception] never propagates; on internal exception, write the plain labeled fallback + `[render_error] <ExceptionClassName>` (NO exception message — INV-009 security clause)
|
||||
FN TuiPresenterState.render(self, event: Event, *, transcript: VerticalScroll, tools_log: RichLog, debug_log: RichLog, thinking_log: RichLog, raw: bool, on_persona_snapshot: object = None) -> None # issue #12 amendment; refreshed to the four-pane model (v0.5.0–v0.14.0 + Worldtree #201/#204)
|
||||
BRIEF: Render one Worldtree SSE event into the four-pane TUI with editorial hierarchy, thinking/text coalescing, live Markdown, persona + heartbeat surfaces, and an INV-009 render-exception fallback. Unicode allowed (`·` U+00B7 demotion prefix, `→` U+2192 usage arrow). Pane routing — `transcript` (VerticalScroll) = chat content (live-Markdown response Static, tinted terminal labels, awaiting-token indicator); `thinking_log` (RichLog) = coalesced Thinking deltas wrapped in Rule(start)/Rule(end); `tools_log` (RichLog) = ToolStart + ToolResult; `debug_log` (RichLog) = per-event audit line + WorkerPhase + TextBoundary + turn-summary. Optional `on_persona_snapshot` callback fires when AffectUpdate carries a snapshot (issue #13 / Worldtree #204). Supersedes the issue #12 single-`log`/`thinking_widget` model and the post-Done Markdown re-render (both removed at v0.5.0/v0.9.0).
|
||||
PRE: [PRE-001 hard] event is an instance of one of the Event union variants -- assert isinstance(event, (WorkerPhase, Thinking, Text, TextBoundary, ToolStart, ToolResult, Done, Error, Cancelled, AffectUpdate, AwaitingLlmFirstToken))
|
||||
POST: [POST-001 side_effect] audit bookkeeping (v0.10.0): Text increments text_delta_count/text_byte_count, Thinking increments thinking_delta_count/thinking_byte_count (each sets turn_start_ts on its first delta) — neither emits a per-delta audit line (token-rate spam control); every other event sets turn_start_ts if unset AND writes one dimmed `_audit_line(event)` to debug_log
|
||||
POST: [POST-002 side_effect] for AffectUpdate (Worldtree #204): audit line per POST-001, then IF snapshot is not None AND on_persona_snapshot is provided, invoke on_persona_snapshot(snapshot) with callback exceptions swallowed (persona surface failure must not break the stream); RETURN
|
||||
POST: [POST-003 side_effect] for AwaitingLlmFirstToken (Worldtree #201): heartbeat_count++; first heartbeat mounts a dimmed "awaiting first token · {s:.1f}s" Static into transcript, subsequent heartbeats update it in place; widget-op exceptions swallowed; scroll_end; RETURN
|
||||
POST: [POST-004 side_effect] gap-close: any non-heartbeat event past the heartbeat branch removes the awaiting indicator if still mounted (awaiting_widget → None)
|
||||
POST: [POST-005 side_effect] for Thinking: open the run on first delta (thinking_run_index++, write Rule("turn {turn_id} · thinking #{idx} start") to thinking_log, thinking_open=True); accumulate content into thinking_chunk_buffer; flush each complete `\n`-terminated line to thinking_log (skip blank lines), retain the tail; RETURN
|
||||
POST: [POST-006 side_effect] for non-Thinking when thinking_open: flush the buffered tail to thinking_log, write Rule("turn {turn_id} · thinking #{idx} end"), thinking_open=False; THEN render the new event
|
||||
POST: [POST-007 side_effect] for Text: append content to text_chunk_buffer; render `text_chunk_buffer if raw else Markdown(text_chunk_buffer)` — first Text delta mounts a `.response-md` Static into transcript, subsequent deltas update it in place (live Markdown, no post-Done re-render); scroll_end; RETURN
|
||||
POST: [POST-008 side_effect] for Done/Error/Cancelled: write a dimmed turn-summary (turn_id, text_deltas/bytes, thinking_deltas/bytes, heartbeats, elapsed_ms) to debug_log; clear text_chunk_buffer + current_response_widget; mount a tinted terminal-label Static into transcript — Done = success-tinted `[done] turn_id=... model=... duration={_format_duration_ms} usage {_format_usage(arrow='→')}`, Error = error-tinted `[error] turn_id=... code=... message=...!r`, Cancelled = warning-tinted `[cancelled] turn_id=... reason=...!r partial_message_id=...`; scroll_end; RETURN
|
||||
POST: [POST-009 side_effect] for demoted telemetry: WorkerPhase + TextBoundary → dimmed `· <label>: <fields>` to debug_log; ToolStart + ToolResult → dimmed `· <label>: <fields>` to tools_log (ToolResult result truncated to 200 chars) per issue #13 INV-014; RETURN
|
||||
POST: [POST-010 exception] never propagates; on any internal exception, write `_plain_label(event)` + `[render_error] <ExceptionClassName>` (NO exception message — INV-009 security clause) to the event's pane (tools_log for Tool*; thinking_log for Thinking; debug_log for WorkerPhase/TextBoundary; else mount Statics into transcript)
|
||||
ERROR_ROUTING:
|
||||
Exception (any internal render failure — widget op, formatting, persona callback):
|
||||
local_handling: write `_plain_label(event)` + `[render_error] {type(exc).__name__}` (no message — INV-009 security clause) to the event's pane (tools_log for Tool*; thinking_log for Thinking; debug_log for WorkerPhase/TextBoundary; else mount Statics into transcript)
|
||||
flow_control: skip (swallow — render never propagates)
|
||||
state_recovery: none (the next event renders against fresh state)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] Validate event ∈ Event union per PRE-001.
|
||||
2. [setup, flexibility=prescriptive] Enter the render try-block — steps 3..11 run inside it; step 12 is the INV-009 fallback.
|
||||
3. [branch, flexibility=prescriptive] Audit bookkeeping (POST-001):
|
||||
IF Text: set turn_start_ts on first delta; text_delta_count++; text_byte_count += len(content)
|
||||
ELIF Thinking: set turn_start_ts on first delta; thinking_delta_count++; thinking_byte_count += len(content)
|
||||
ELSE: set turn_start_ts if unset; WRITE _dim(_audit_line(event)) to debug_log
|
||||
4. [branch, flexibility=prescriptive] IF AffectUpdate (POST-002): IF snapshot is not None AND on_persona_snapshot is not None: TRY on_persona_snapshot(snapshot) / swallow Exception; RETURN
|
||||
5. [branch, flexibility=prescriptive] IF AwaitingLlmFirstToken (POST-003): heartbeat_count++; secs = elapsed_ms_since_building_prompt / 1000; mount-or-update a dimmed "awaiting first token · {secs:.1f}s" Static in transcript (swallow widget Exception); scroll_end; RETURN
|
||||
6. [branch, flexibility=prescriptive] Gap-close (POST-004): IF awaiting_widget is not None: remove it (swallow Exception); SET awaiting_widget=None
|
||||
7. [branch, flexibility=prescriptive] IF Thinking (POST-005): IF NOT thinking_open: thinking_run_index++; WRITE Rule(start) to thinking_log; thinking_open=True. APPEND content to thinking_chunk_buffer; WHILE "\n" in buffer: partition on "\n", WRITE non-empty line to thinking_log, keep the remainder. RETURN
|
||||
8. [branch, flexibility=prescriptive] Close open thinking run (POST-006): IF thinking_open: IF buffer non-empty: WRITE buffer tail to thinking_log, clear buffer. WRITE Rule(end) to thinking_log; thinking_open=False
|
||||
9. [branch, flexibility=prescriptive] IF Text (POST-007): APPEND content to text_chunk_buffer; rendered = buffer if raw else Markdown(buffer); IF current_response_widget is None: mount Static(rendered, classes="response-md") in transcript; ELSE: current_response_widget.update(rendered); scroll_end; RETURN
|
||||
10. [branch, flexibility=prescriptive] IF Done|Error|Cancelled (POST-008): elapsed_ms = int((monotonic()-turn_start_ts)*1000) if turn_start_ts else 0; WRITE dimmed turn-summary to debug_log; clear text_chunk_buffer + current_response_widget; mount the tinted terminal-label Static (Done=success / Error=error / Cancelled=warning) in transcript with the documented label text; scroll_end; RETURN
|
||||
11. [branch, flexibility=prescriptive] Demoted telemetry (POST-009), then RETURN: WorkerPhase → debug_log `· worker_phase: ...`; ToolStart → tools_log `· tool_start: ...`; ToolResult → tools_log `· tool_result: ... result={result!r:.200}`; TextBoundary → debug_log `· text_boundary: ...`
|
||||
12. [error_handler, flexibility=prescriptive] EXCEPT Exception as exc (POST-010 / INV-009): WRITE _plain_label(event) + "[render_error] {type(exc).__name__}" (no message) to the event's pane per ERROR_ROUTING
|
||||
TESTS:
|
||||
thinking_coalesce_single_widget_update [happy,tracer]: 3 Thinking events → widget.update called 3× with cumulative content; RichLog has 0 thinking entries yet
|
||||
thinking_closes_one_richlog_entry [happy]: 2× Thinking + WorkerPhase → ONE closed thinking entry + worker_phase entry; widget cleared+hidden
|
||||
thinking_widget_truncation [trace]: 500-char buffer → widget shows "…" + last 200
|
||||
thinking_widget_visibility_lifecycle [trace]: hidden initially; visible during run; hidden after closing event
|
||||
multiple_thinking_runs_each_get_richlog_entry [scenario]: Thinking → Text → Thinking → Done → TWO closed thinking entries
|
||||
cancelled_mid_thinking_closes [scenario]: Thinking → Cancelled → ONE closed thinking entry + [cancelled]; widget hidden
|
||||
done_renders_markdown_after_label [happy]: Text + Done(response=...) with NOT raw → [done] line, Rule, Markdown
|
||||
raw_flag_skips_markdown [trace]: raw=True → no Rule, no Markdown
|
||||
worker_phase_demoted [trace]: "· worker_phase:" prefix (not "[worker_phase]")
|
||||
tool_start_demoted [trace]: "· tool_start:" prefix
|
||||
text_no_prefix [trace]: Text → no demotion prefix
|
||||
render_exception_fallback [adversarial]: widget.update raises → fallback line + `[render_error] <ClassName>` (NO message); state does not propagate
|
||||
state_reset_per_worker [trace]: fresh TuiPresenterState() starts with no thinking open
|
||||
text_then_done_mounts_widget_and_finalizes [happy,tracer]: Text + Done (NOT raw) → live Markdown `.response-md` widget mounted; on Done the widget ref clears + a success-tinted [done] label mounts; no post-Done re-render (no double-print)
|
||||
thinking_coalesces_until_newline [happy]: Thinking deltas buffer; only complete `\n`-terminated lines flush to thinking_log
|
||||
thinking_flushes_on_newline [happy]: a Thinking delta containing `\n` flushes the completed line and retains the tail for the next delta
|
||||
thinking_closes_to_thinking_log [happy]: 2× Thinking + WorkerPhase → tail flushed + Rule(end) closes the run in thinking_log; thinking_open=False
|
||||
multiple_thinking_runs_each_get_thinking_log_section [scenario]: Thinking → Text → Thinking → Done → TWO Rule-wrapped thinking sections
|
||||
cancelled_mid_thinking_closes [scenario]: Thinking → Cancelled → run closes with Rule(end); warning-tinted [cancelled] label mounted
|
||||
text_first_delta_mounts_response_widget [happy]: first Text delta mounts a `.response-md` Static in transcript holding Markdown(buffer)
|
||||
text_subsequent_deltas_update_in_place [trace]: later Text deltas update the same widget (live Markdown), no new mount
|
||||
raw_flag_skips_markdown [trace]: raw=True → response widget holds plain str, no Markdown wrapping
|
||||
worker_phase_demoted_to_debug_log [trace]: WorkerPhase → dimmed `· worker_phase:` in debug_log, not transcript
|
||||
tool_start_routes_to_tools_log [trace]: ToolStart → `· tool_start:` in tools_log (issue #13 INV-014)
|
||||
tool_result_routes_to_tools_log [trace]: ToolResult → `· tool_result: ... result=<≤200 chars>` in tools_log
|
||||
worker_phase_emits_audit_line [trace]: a non-Text/Thinking event writes one dimmed `_audit_line` to debug_log
|
||||
tool_start_emits_audit_line [trace]: ToolStart writes an audit line to debug_log in addition to the tools_log routing
|
||||
text_delta_counted_not_per_event_audit_line [trace]: Text deltas increment counters but emit NO per-delta audit line (token-rate spam control)
|
||||
done_emits_turn_summary_line [trace]: Done writes a dimmed turn-summary (text/thinking delta+byte counts, heartbeats, elapsed_ms) to debug_log before clearing counters
|
||||
affect_update_routes_to_audit_only [scenario]: AffectUpdate(snapshot) → audit line + on_persona_snapshot(snapshot) callback; no transcript mount
|
||||
affect_update_scheduled_has_no_pad_detail [trace]: AffectUpdate(status="scheduled", snapshot=None) → audit line only; callback skipped
|
||||
awaiting_llm_first_token_mounts_indicator [scenario]: first AwaitingLlmFirstToken mounts a dimmed "awaiting first token · {s}s" Static in transcript
|
||||
awaiting_subsequent_heartbeats_update_in_place [trace]: later heartbeats update the same indicator in place; heartbeat_count grows
|
||||
awaiting_indicator_removed_when_gap_closes [scenario]: the first non-heartbeat event removes the awaiting indicator (gap closed)
|
||||
render_exception_fallback [adversarial]: an internal render failure writes `_plain_label` + `[render_error] <ClassName>` (NO message) to the event's pane; never propagates (INV-009)
|
||||
state_reset_per_worker [trace]: a fresh TuiPresenterState() starts with thinking_open=False and zeroed counters
|
||||
duration_format_seconds [trace]: Done(duration_ms=5467) → "duration=5.5s"
|
||||
usage_format_unicode_arrow [trace]: Done → "usage ... in → ... out (...)" (Unicode arrow, not ASCII)
|
||||
```
|
||||
@@ -408,7 +452,7 @@ STEPS:
|
||||
RETURN
|
||||
SET self.state = "cancelling"
|
||||
update footer hint to "Press Ctrl-C again to exit"
|
||||
self.run_worker(_cancel_via_sse(self.client, self.session_id, self.active_turn_id, log=self.query_one("#transcript", RichLog)))
|
||||
self.run_worker(_cancel_via_sse(self.client, self.session_id, self.active_turn_id, transcript=self.query_one("#transcript-scroll", VerticalScroll), audit=self._audit))
|
||||
ELIF self.state == "cancelling":
|
||||
# Second Ctrl-C — force exit, abandon drain
|
||||
IF self.stream_worker is not None: self.stream_worker.cancel()
|
||||
|
||||
@@ -372,3 +372,64 @@ test layer.
|
||||
- Issue #7 (mid-stream robustness, `MalformedSseData`) — landed; #6's
|
||||
pre/in-alt-screen split is orthogonal to #7's empty-data/malformed
|
||||
distinction (different error layers entirely).
|
||||
|
||||
## Amendment 2026-06-30 — startup session picker (v1 coverage-audit, slice b2)
|
||||
|
||||
The v1 coverage-audit found `list_sessions` had **no caller** — the startup
|
||||
session picker (design-brief §4: "single-session-per-launch, with a startup
|
||||
picker invoked when more than one session exists ... plus flags `--session`/
|
||||
`--new` to skip it") was never built. Bare TUI mode (neither `--session` nor
|
||||
`--new`) was a hard usage error. This adds the picker as a pre-alt-screen
|
||||
resolution step in `_resolve_then_run`, mirroring the existing `AgentPickerApp`.
|
||||
|
||||
**Locked design (design-brief §4):** the picker is **resume-only** (§4 negative
|
||||
clause "no in-app session creation — `--new` flag only"); shown only when **>1**
|
||||
session exists (exactly 1 auto-resumes; the launch intent is "resume the last
|
||||
session I was poking at"). `--agent` stays a `--new` companion (forbidden in bare
|
||||
mode). **bare + 0 sessions → error** `[no_sessions]` directing the operator to
|
||||
`--new` (honors the "no in-app creation" clause; the friendlier
|
||||
auto-fall-through-to-new alternative is deferred pending operator confirmation).
|
||||
|
||||
### `_parse` validation relaxation (ratatoskr.cli._parse)
|
||||
|
||||
- Bare TUI mode (`send is None` AND no `--session` AND no `--new`) is now VALID
|
||||
→ triggers the picker. (Previously `raise UsageError("pass exactly one of
|
||||
--session or --new")` unconditionally.)
|
||||
- `--send` mode still requires exactly one of `--session`/`--new` (non-
|
||||
interactive: no picker can open) → `UsageError("--send requires --session or
|
||||
--new")`.
|
||||
- `--session` + `--new` stays mutually exclusive.
|
||||
- `--agent` in bare mode → `UsageError` (`--agent` belongs to `--new`).
|
||||
|
||||
```contract
|
||||
FN SessionPickerApp.__init__(self, sessions: list[SessionInfo]) -> None
|
||||
BRIEF: Textual App[str | None] startup session picker (mirrors AgentPickerApp, issue #8). Opens before RatatoskrApp when bare TUI mode resolves >1 session. `run_async()` returns the chosen session_id (str) or None on Esc/Ctrl-D/Ctrl-C dismissal. Architecturally separate from RatatoskrApp (list_sessions failures + dismissal land before any alt-screen — preserves #6 INV-001).
|
||||
PRE: [PRE-001 hard] sessions is non-empty -- assert sessions (caller resolves 0-session and 1-session cases BEFORE constructing the picker)
|
||||
POST: [POST-001 return_value] run_async() returns sessions[i].session_id for the highlighted row on `pick`, or None on dismiss -- assert result in {s.session_id for s in sessions} | {None}
|
||||
STEPS:
|
||||
1. [setup, prescriptive] Store sessions; register the Australis theme (mirror AgentPickerApp).
|
||||
2. [sequential, prescriptive] compose: Header + prompt Static + ListView of one ListItem per session (id-short + agent_id + last_active/name lines) + Footer.
|
||||
3. [sequential, prescriptive] BINDINGS: enter→action_pick, escape/ctrl+d/ctrl+c→action_dismiss.
|
||||
4. [branch, prescriptive] action_pick: read ListView.index; if None return (nothing highlighted); else exit(sessions[index].session_id). action_dismiss: exit(None).
|
||||
TESTS:
|
||||
pick_returns_session_id [happy,tracer]: SessionPickerApp([s0, s1]); pilot highlights row 1 + press enter → run_async() returns s1.session_id.
|
||||
dismiss_returns_none [happy]: press escape → run_async() returns None.
|
||||
ctrl_d_dismisses [adversarial]: press ctrl+d → None.
|
||||
|
||||
FN _resolve_then_run(args) — bare-mode extension (session picker)
|
||||
BRIEF: Before the existing new/resume branches, resolve bare TUI mode (not args.new AND args.session_id is None) via list_sessions + the picker. Sets a local `effective_new` and `resolved_session_id`; the existing branches then run unchanged on those locals.
|
||||
STEPS (inserted at the top of the `async with client` block):
|
||||
1. [setup, prescriptive] SET effective_new = args.new; resolved_session_id = args.session_id.
|
||||
2. [branch, prescriptive] IF (not args.new) AND (args.session_id is None): # bare mode
|
||||
a. CALL list_sessions(client) → page; ON SessionApiFailed → stderr `[session_api_failed]` + return 20; ON network error → `[network_error]` + return 21.
|
||||
b. IF not page.items: stderr `[no_sessions] no sessions to resume; launch with --new --agent <id>` + return 14.
|
||||
c. ELIF len(page.items) == 1: SET resolved_session_id = page.items[0].session_id. # §4: picker only when >1
|
||||
d. ELSE: SET resolved_session_id = await SessionPickerApp(page.items).run_async(); IF None → return 0 (Esc/Ctrl-D clean exit).
|
||||
3. [sequential, prescriptive] Replace the two `if args.new` predicates with `if effective_new`; the resume `else` branch asserts + uses `resolved_session_id`.
|
||||
TESTS (in the `_resolve_then_run` block):
|
||||
bare_zero_sessions_errors [error]: bare args; list_sessions → 0 items → stderr contains `[no_sessions]`; return 14; NO POST /sessions, NO picker.
|
||||
bare_one_session_auto_resumes [scenario]: bare args; list_sessions → 1 item (sid="s-solo") → RatatoskrApp constructed with session_id="s-solo"; NO picker shown.
|
||||
bare_multi_opens_picker [scenario,tracer]: bare args; list_sessions → 2 items; picker returns items[1].session_id → RatatoskrApp constructed with that session_id.
|
||||
bare_picker_dismiss_exits_zero [scenario]: bare args; 2 items; picker returns None → return 0; RatatoskrApp NOT constructed.
|
||||
bare_list_sessions_api_failure [error]: bare args; list_sessions raises SessionApiFailed(500) → stderr `[session_api_failed]`; return 20.
|
||||
```
|
||||
|
||||
@@ -0,0 +1,198 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "ratatoskr.web"
|
||||
purpose: "v0.19.2 web debug-surface parity: 3 admin/debug panes (Tools inventory, BifrostState, AdminEvents SSE) proxied server-side with the admin key server-held, plus a reliable PAD-refresh poll and a non-engine reasoning indicator in the transcript."
|
||||
target_module: "ratatoskr.web (server.py routes + entrypoint.py + static/index.html)"
|
||||
scope: "v0.19.2 web debug-surface parity — bring the browser surface (now the PRIMARY debug surface) to TUI parity. THREE new admin/debug panes proxied server-side + TWO transcript affordances. (1) Tools inventory: GET /api/sessions/{id}/tools proxies owner-scoped get_session_tools into the tools pane (what the LLM HAS at turn-fire), above the live tool events. (2) BifrostState pane: GET /api/sessions/{id}/bifrost proxies admin-scoped get_session_bifrost; the admin key is SERVER-HELD (app.state.admin_key from RATATOSKR_ADMIN_API_KEY), never sent to the browser. (3) AdminEvents pane: GET /api/admin/events is an SSE proxy of stream_admin_events, session-filtered SERVER-side (heartbeats + other-session events dropped), re-emitted under a fixed 'admin_event' name so every dotted type renders with one browser listener. (4) PAD refresh: the persona/affect pane polls a bounded window instead of a single 2s shot that raced the post-turn-async affect.emit. (5) Reasoning indicator: an ephemeral, clearly-non-engine transcript line on `thinking` deltas, cleared when text begins. Direct in-session TDD (the #17/#18 pattern); this contract is authored post-implementation to anchor the heid code review (the client wrappers get_session_tools/get_session_bifrost/stream_admin_events are already contracted in the sessions/sse_client specs — this contract governs the WEB proxy + presenter surface only. v0.20.0 REDESIGN (Claude Design 'Ratatoskr Console' import): the tabbed telemetry column is replaced by a 3-column command-console — a left engine-ticker rail (the DEBUG + ADMIN + tool/turn-lifecycle feeds MERGED into one timeline via tickerAdd, plus a tools-armed chip list + a full-detail Bifrost rail pane) · a center conversation (per-turn INLINE chain-of-thought, replacing the separate Think pane) · a right resizable affect console (dominant/canonical-mood centerpiece + bipolar PAD faders each carrying a turn-to-turn Δ+sparkline + a P×A mood orbit + relations metric rows + canonical directive). ALL SERVER ROUTES UNCHANGED. Single-file/no-CDN/vanilla preserved; adds a light/dark theme toggle (dark default) + an inlined data-URI favicon. Presenter FN renames tracked below (renderBifrostState→renderBifrost; renderAffectPane→renderConsole; setPersonaStrip removed; tickerAdd/setFader/setFaderTrend/renderOrbit/renderDominant/renderDerived/renderRelations/renderDirective added). INV-001/INV-004 held.)."
|
||||
depends_on:
|
||||
- "httpx"
|
||||
- "starlette"
|
||||
- "ratatoskr.sessions" # get_session_tools, get_session_bifrost, SessionApiFailed
|
||||
- "ratatoskr.sse_client" # stream_admin_events, AdminEvent, SseConnectFailed/Dropped
|
||||
used_by:
|
||||
- "ratatoskr.web.entrypoint" # passes admin_key=RATATOSKR_ADMIN_API_KEY into create_app
|
||||
language: "python + vanilla JS (single-file SPA, no build)"
|
||||
complexity: "medium"
|
||||
estimated_loc: 290
|
||||
confidence: 0.8
|
||||
assumptions:
|
||||
- "The three client wrappers exist and are already contracted: get_session_tools(client, session_id)->dict (owner-scoped, consumer bearer; non-200 -> SessionApiFailed), get_session_bifrost(client, session_id, *, admin_key)->dict (OVERRIDES Authorization with admin_key; non-200 -> SessionApiFailed), stream_admin_events(client, *, admin_key)->AsyncIterator[AdminEvent] (non-200 -> SseConnectFailed; mid-drop -> SseConnectionDropped). The web routes are thin proxies over them; they add NO new upstream semantics."
|
||||
- "AdminEvent = {id:int, type:str, timestamp:str|None, data:dict}. data MOST carry session_id (INV-049). type is a dotted namespace (session.*/turn.*/key.*/system.*)."
|
||||
- "The web SPA is a single static/index.html served per-request via FileResponse (edits land on browser refresh; server code changes need a restart). Model/tool/admin content is UNTRUSTED text (INV-004) — every render path escapes first (esc() via textContent, or JSON.stringify wrapped in esc())."
|
||||
- "The internal-LAN trust model (0.0.0.0, no auth/TLS/CORS) is deliberate operator direction. Admin-scoped DATA becoming LAN-visible is accepted under that model; the admin KEY must nonetheless never cross to the browser."
|
||||
- "Tests: respx mocks the upstream endpoints (absolute w.example URLs) driven through the TestClient; the AdminEvents SSE proxy is tested with a finite mocked SSE byte-stream asserting the filter + fixed event name. Live-proven against ratatoskr:sindra on personal :8081."
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
functions:
|
||||
- name: "_session_tools_endpoint"
|
||||
signature: "async _session_tools_endpoint(request: Request) -> JSONResponse"
|
||||
description: "GET /api/sessions/{session_id}/tools — proxy owner-scoped tool inventory."
|
||||
preconditions:
|
||||
- "session_id in path_params."
|
||||
postconditions:
|
||||
- "POST-001: 200 with the upstream inventory dict verbatim on success."
|
||||
- "POST-002: on SessionApiFailed(status) -> JSONResponse({error_code:'session_tools_unavailable', status}, status_code=status) — status-preserving."
|
||||
steps: "Open client_factory() client; await get_session_tools(client, session_id); return 200. Except SessionApiFailed -> status-preserving envelope."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "_session_messages_endpoint"
|
||||
signature: "async _session_messages_endpoint(request: Request) -> JSONResponse"
|
||||
description: "GET /api/sessions/{session_id}/messages — proxy the session's message history so the SPA renders existing turns on open (notably a #347 authored first-message seeded at create-time; without it a seeded session's transcript is blank until the user speaks)."
|
||||
preconditions:
|
||||
- "session_id in path_params."
|
||||
postconditions:
|
||||
- "POST-001: 200 with the upstream {session_id, items, next_cursor} dict verbatim on success."
|
||||
- "POST-002: on SessionApiFailed(status) -> JSONResponse({error_code:'session_messages_unavailable', status}, status_code=status) — status-preserving."
|
||||
steps: "Open client_factory() client; await get_session_messages(client, session_id); return 200. Except SessionApiFailed -> status-preserving envelope."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "_session_bifrost_endpoint"
|
||||
signature: "async _session_bifrost_endpoint(request: Request) -> JSONResponse"
|
||||
description: "GET /api/sessions/{session_id}/bifrost — proxy admin-scoped Bifrost dispatch state."
|
||||
preconditions:
|
||||
- "session_id in path_params."
|
||||
- "PRE-001 (fail-visible): app.state.admin_key must be truthy; else 400 admin_key_not_configured with NO upstream call."
|
||||
postconditions:
|
||||
- "POST-001: the admin key is read from app.state.admin_key ONLY; it is passed to get_session_bifrost(admin_key=...) and NEVER placed in a response body or surfaced to the browser."
|
||||
- "POST-002: 200 with the upstream state dict verbatim on success."
|
||||
- "POST-003: on SessionApiFailed(status) -> {error_code:'bifrost_state_unavailable', status} at status_code=status (notably 404 not-bound, 403 scope-denied)."
|
||||
steps: "If not admin_key -> 400. Open client; await get_session_bifrost(client, session_id, admin_key=admin_key); 200. Except SessionApiFailed -> status-preserving envelope."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "_admin_event_matches_web"
|
||||
signature: "_admin_event_matches_web(ev: AdminEvent, session_id: str | None) -> bool"
|
||||
description: "AdminEvents session-filter (mirrors the TUI _admin_event_matches, design-brief §6)."
|
||||
postconditions:
|
||||
- "POST-001: ev.type == 'system.heartbeat' -> False (keepalive noise dropped)."
|
||||
- "POST-002: ev.type.startswith('system.') (non-heartbeat) -> True (stream-integrity signals always pass)."
|
||||
- "POST-003: otherwise -> True IFF session_id is not None AND ev.data.get('session_id') == session_id (per-session scoping; a None session_id forwards NO non-system event)."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "_admin_events_endpoint"
|
||||
signature: "async _admin_events_endpoint(request: Request) -> Response"
|
||||
description: "GET /api/admin/events?session_id=... — SSE proxy of stream_admin_events, session-filtered server-side."
|
||||
preconditions:
|
||||
- "PRE-001 (fail-visible): app.state.admin_key truthy; else 400 admin_key_not_configured with NO stream opened."
|
||||
postconditions:
|
||||
- "POST-001: returns StreamingResponse(media_type='text/event-stream'); the admin key never crosses to the browser."
|
||||
- "POST-002: ONLY events passing _admin_event_matches_web(ev, session_id) are forwarded; each is re-emitted under the FIXED SSE event name 'admin_event' with {id,type,timestamp,data} in the payload (the real dotted type rides in the payload, so one browser listener renders every type — nothing silently dropped by name)."
|
||||
- "POST-003: SseConnectFailed/SseConnectionDropped/MalformedSseId/MalformedSseData -> a single 'stream_error' SSE frame, then the stream ends (best-effort; never raises to the browser)."
|
||||
- "POST-004: asyncio.CancelledError (browser disconnect) re-raises to unwind the generator; the upstream client is aclose()'d in finally on every exit path."
|
||||
steps: "If not admin_key -> 400. gen(): open client; async-for ev in stream_admin_events(admin_key); skip unless _admin_event_matches_web; yield _format_sse('admin_event', {...}). Except SSE errors -> yield stream_error. Except CancelledError -> raise. Finally aclose(). Return StreamingResponse(gen())."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "create_app (amendment)"
|
||||
signature: "create_app(client_factory, *, end_user_id=None, bifrost_consumer_key=None, bifrost_visible_host=None, affect_read_url=None, memory_read_url=None, admin_key=None) -> Starlette"
|
||||
description: "New optional admin_key param stored at app.state.admin_key; entrypoint passes RATATOSKR_ADMIN_API_KEY. v0.20.7 adds memory_read_url (app.state.memory_read_url, from RATATOSKR_MEMORY_READ_URL) for the memory viewer. Four new routes registered across the arc."
|
||||
postconditions:
|
||||
- "POST-001: app.state.admin_key = admin_key (default None -> the two admin routes fail-visible per their PRE-001)."
|
||||
- "POST-002: routes /api/sessions/{session_id}/tools, /api/sessions/{session_id}/bifrost, /api/admin/events added; existing routes unchanged."
|
||||
- "POST-003 (v0.20.7): app.state.memory_read_url = memory_read_url; route /api/memory/chunks added (the memory-viewer proxy)."
|
||||
flexibility: "closed"
|
||||
|
||||
- name: "reasoning indicator (index.html: showThinkingNote / hideThinkingNote)"
|
||||
signature: "showThinkingNote() ; hideThinkingNote() // called from the turn SSE loop"
|
||||
description: "Ephemeral transcript affordance signalling reasoning inference — clearly NOT engine output."
|
||||
postconditions:
|
||||
- "POST-001: on the first `thinking` delta, an italic '<Agent> <phrase>' line (✦ glyph, rotating phrase) is shown; it supersedes any live 'awaiting first token' heartbeat."
|
||||
- "POST-002: the agent display name is derived from state.agentId and rendered via textContent (NEVER innerHTML) — INV-004 holds even for an adversarial agent_id."
|
||||
- "POST-003: it is removed the instant the first `text` delta arrives, and on any terminal (done/error/cancelled); the rotation interval is cleared on removal (no leaked setInterval)."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "PAD refresh poll (index.html: terminal() done-branch)"
|
||||
signature: "on Done: poll loadPersona over [1500,3500,6500,10500]ms"
|
||||
description: "Catch the post-turn-async affect.emit without racing it (replaces the single 2s shot)."
|
||||
postconditions:
|
||||
- "POST-001: loadAffect sets state.lastAffectAt = snap.emitted_at; the poll captures beforeAt and stops (settled) once state.lastAffectAt !== beforeAt."
|
||||
- "POST-002: a scheduled poll no-ops if a NEW turn has started (state.turnId truthy) or already settled — no refresh of a stale agent, no unbounded polling."
|
||||
flexibility: "open"
|
||||
|
||||
- name: "loadTranscript (index.html)"
|
||||
signature: "async loadTranscript(sessionId) -> void"
|
||||
description: "On session open, GET /api/sessions/{id}/messages and render each EXISTING turn into #transcript — notably a #347 authored first-message seeded at create-time (which lives in the ledger, not the live turn stream, so without this the transcript is blank until the user speaks)."
|
||||
postconditions:
|
||||
- "POST-001: assistant items render as a .response .md-body bubble via markdownSafe(content) (escape-first whitelist, same path as appendResponse); user items render as a .prompt-echo via textContent — no upstream content reaches innerHTML unescaped (INV-004)."
|
||||
- "POST-002: any non-200, fetch error, or parse error is swallowed (best-effort) — a blank transcript is acceptable; opening the workspace is never blocked."
|
||||
flexibility: "prescriptive"
|
||||
|
||||
- name: "web pane renderers (v0.20.0: index.html: renderToolsInventory / renderBifrost / openAdminEvents + tickerAdd)"
|
||||
signature: "renderToolsInventory(inv) ; renderBifrost(b) ; openAdminEvents(sessionId) ; tickerAdd(kind, msg, dim)"
|
||||
description: "Render the debug/admin surfaces into the 3-column console; all content escaped (INV-004). v0.20.0: BifrostState is now a full-detail LEFT-RAIL pane (renderBifrost, renamed from renderBifrostState); AdminEvents + the raw debug/op log + tool_start/result + turn lifecycle are MERGED into one engine-ticker timeline via tickerAdd (openAdminEvents routes admin_event → tickerAdd; the turn SSE handlers route worker_phase/tool/text_boundary/affect_update → tickerAdd); Tools inventory is a rail chip list (renderToolsInventory)."
|
||||
postconditions:
|
||||
- "POST-001: every dynamic value (agent_id, tool names/descriptions, endpoint, caps, consumer_id, admin event type + data, ticker msg/dim) is passed through esc() or esc(JSON.stringify(...)); no upstream string reaches innerHTML unescaped."
|
||||
- "POST-002: openAdminEvents closes a prior EventSource before opening a new one (state.adminES) and, on stream_error, closes so native EventSource does NOT retry-loop; admin events render into the engine ticker via tickerAdd."
|
||||
- "POST-003: renderToolsInventory renders builtin + bifrost tool NAMES as rail chips (a compact 'what does the LLM have' glance); renderBifrost renders endpoint + connected + consumer_id + capabilities_granted chips + per-tool name/description rows (the full detail, admin-gated; the admin key stays server-held). tickerAdd bounds the feed to the last 400 rows (a tail, not an archive)."
|
||||
- "POST-004: tool NAME-vs-DESCRIPTION split preserved — the rail chip list shows names only; per-tool descriptions live in the Bifrost pane's tools list. The engine-ticker spine (.ticker-inner::before) lives on the content-height wrapper so it stays visible when auto-scrolled to the newest entry."
|
||||
flexibility: "open"
|
||||
|
||||
- name: "renderConsole + trend (v0.20.0 — unified persona/affect console; supersedes renderAffectPane/renderPersonaPane/setPersonaStrip)"
|
||||
signature: "renderConsole(snap) ; setFader(axis,v) ; setFaderTrend(axis) ; renderOrbit() ; renderDominant(snap) ; renderDerived(snap) ; renderRelations(snap) ; renderDirective(snap) ; pushAffectHistory(snap) ; sparkPointsH(vals,w,h,endX) ; padDeltas(vals) ; deltaStrip(deltas) ; orbitFrame(H,head,ts) ; orbitProj/orbitShadowY/orbitWallPt/orbitAxisPt ; startOrbitAnim() ; trendDelta(vals)"
|
||||
description: "ONE render path for BOTH the Tier-1 persona_state snapshot and the Tier-3 affect snapshot (renderConsole), feeding the right affect console: dominant/canonical-mood centerpiece, bipolar PAD faders (each with a turn-to-turn Δ + sparkline), a P×A mood orbit from PAD history, an affect-derived grid, relations metric rows, and the canonical directive. Replaces the v0.19.x split of renderPersonaPane (Tier-1 pane) + renderAffectPane (Tier-3 pane) + setPersonaStrip (top-bar strip, removed — PAD now lives in the console faders)."
|
||||
postconditions:
|
||||
- "POST-001: reads snap.relations (relation_edge/1: target_entity + trust_ability/benevolence/integrity + warmth as {value,confidence,evidence_count} + agency + relation_context) — the CURRENT Worldtree emit shape; falls back to the legacy flat snap.valence for an older emitter. Tier-1 fields (baseline_pad, mood_drift, dominant_emotion, emotions_active) render WHEN PRESENT, '—' when absent (Tier-3 lacks them)."
|
||||
- "POST-002: SVG sparklines + affect visuals (v0.20.4, adapted from the design prototype; v0.20.7 = design iteration-3). Each relation metric shows a HORIZONTAL SVG sparkline (`sparkPointsH`, 56×13, auto-scaled to its OWN range, sparkFade gradient + end dot), now BACKED by a subtle grid (`<pattern id=sparkGrid>` + a bg `<rect>` behind the polyline). Each PAD fader shows current value + Δ-vs-previous (▲/▼) + a per-turn Δ STRIP: v0.20.7 REPLACES the vertical polyline strip (removed `stripPoints`) with a column of 12 diverging HTML bars (`padDeltas`→`deltaStrip`, newest at bottom, each bar offset L/R of a center line by that turn's Δ, magnitude→width, age→opacity, zero-Δ→faint center dot). renderOrbit is now a DIMETRIC OPEN BOX (azimuth 35° / elevation 25°, D→right / A→left-back / P→up; removed the isometric `proj3` for `orbitProj/orbitShadowY/orbitWallPt/orbitAxisPt`) — a ghost A×P wall (carrying the P readout) + a D×A floor, JS-DRIVEN animated replay (`orbitFrame` rebuilt per rAF frame by a singleton `startOrbitAnim` loop reading live `ORBIT_HIST`; no SMIL/CSS-keyframes; reduced-motion → static final-state render). All drawn from AFFECT_HIST (rolling, HIST_CAP=24, session-lived); coords are computed numerics (no upstream strings → INV-004 trivially held). Gradients/patterns live in one hidden `<defs>` svg in the console. v0.20.9 (R32-1B prep): the fader fill (`padFillFrac`) + orbit projections (`_padNorm`) AUTO-SCALE to the session's own max |PAD| (`padScale`, floor 1.0) instead of hard-clamping to [-1,1] — so an unbounded-z PAD (Worldtree R32-1B) renders at FULL range and never pegs/escapes the frame, while today's [-1,1] values are unchanged (scale==1); the exact value is always shown numerically (unclamped). This scaling is PURELY debug-display — ratatoskr is a downstream observer; it never touches the agent's real affect or any write path (the `--set-persona-pad` seed carries values unclamped)."
|
||||
- "POST-003: pushAffectHistory dedupes by emitted_at||last_updated_at so the ~4x/turn post-turn PAD poll contributes ONE sample/turn; history is CLIENT-side only (lost on reload — durable cross-session history via a provider-side snapshot log is a deferred follow-up, NOT built here)."
|
||||
- "POST-004: INV-001 honesty — no fabricated Tier-1 fields. The dominant-emotion centerpiece shows a real OCC dominant_emotion (Tier-1) OR the CANONICAL mood word from canonMood(pad) (Tier-3, dimmed) OR '—'; NEVER a synthesized emotion. The affect-derived grid drops non-emitted metrics (intensity/decay-τ) and shows only real/client-derived cells (baseline/drift real for Tier-1, client-derived samples/volatility). INV-004 — every dynamic value passes through esc(); numerics go through toFixed, never innerHTML-raw."
|
||||
flexibility: "open"
|
||||
|
||||
- name: "canonical affect-NL + context-injection reconstruction (v0.19.5 canons; v0.20.2 full context-injection panel)"
|
||||
signature: "canonMood(pad) ; canonDirective(rel) ; canonPadFallback(pad) ; canonEmotionDirective(type) ; renderDirective(snap) ; loadPersonaCanon()"
|
||||
description: "Reconstruct + render the HIDDEN affect-context block Worldtree assembles into the agent's system prompt (never on any wire) — byte-exact to Worldtree's own describe_pad + render_d2_canonical + derive_directive + _pad_band_fallback. The v0.20.2 'context injection' panel shows the full block: mood descriptor + mood directive + relationship directive. Reference: docs/vendor/worldtree-persona-canon/affect-egress-consumer-reference.md (pinned)."
|
||||
postconditions:
|
||||
- "POST-001: DETERMINISTIC, no LLM. canonMood mirrors describe_pad (valence×arousal grid + strict ±0.3 bands + dominance clause); canonDirective mirrors render_d2_canonical; canonPadFallback mirrors renderer._pad_band_fallback BYTE-EXACT (P×A quadrant: hi/lo/mid arousal band × p>0.3/<-0.3/neutral, with the negative_low_dominance (d<-0.3) special case + neutral_high_a + default); canonEmotionDirective is the occ_directives[type].directive lookup (+ tier / full_only flag)."
|
||||
- "POST-002: the canon DATA is VENDORED (docs/vendor/worldtree-persona-canon/{d2-mood-render-canon-v1,d2-render-canon-v1}.json), pinned drift-gated in .corviduo-canonicals.toml; the flat browser form (static/persona_render_canon.json, served /static) is regenerated by scripts/build_persona_canon.py via Worldtree's OWN authoritative loader — v0.20.2 extended it to emit mood_directive {occ_directives, pad_band_fallback, salience, pad_band_cutoff, full_only}. The affect-egress consumer reference is pinned tolerate_drift (worldtree-affect-egress-consumer-reference-v1; worldtree-dev co-signs + pings on change)."
|
||||
- "POST-003: fail-open — canon absent (fetch fails) → the reconstructed lines OMIT, the structured console still renders. Every canon-derived string is esc()'d before the DOM (INV-004)."
|
||||
- "POST-004: HONEST-PARTIAL provenance (affect-egress-reference §3). The mood descriptor + relationship directive are EXACT (tagged 'exact'); the mood DIRECTIVE is a CANDIDATE pair (tagged 'candidate') — the OCC emotion directive for the delivered dominant_emotion type AND the PAD-band fallback — because affect.emit is type-only (no intensity) so the salience gate (≥0.2) can't be evaluated; BOTH are shown with the 'injected if intensity ≥ salience' caveat, never asserting which fires. When dominant_emotion is absent the fallback alone is EXACT. The panel is labeled reconstructed + hidden-from-consumers + dev-only (the reference-impl's sanctioned understand/reconstruct use, NOT end-user display per the reference's caveat). WATCH: a pending Worldtree render_d2_canonical change conditionally drops the trailing 'avoid premature we-framing' clause under a 3-gate combo — canonDirective holds as-is until worldtree-dev pings with the exact conditional + a canon bump."
|
||||
flexibility: "open"
|
||||
|
||||
- name: "memory viewer (v0.20.7 — provider debug read → web proxy → console pane)"
|
||||
signature: "server: _memory_chunks_endpoint(request) [GET /api/memory/chunks] ; provider: add_memory_read_route(app, store) [GET /memory/chunks] + RatatoskrMemoryStore.list_chunks(*, agent_id, end_user_id) + .count_chunks() ; index.html: loadMemory(agentId) ; renderMemory(data) ; setMemHead(count, total)"
|
||||
description: "Durable memory chunks Worldtree promoted into OUR store, surfaced as a live-polling MEMORY console pane (content·scope·origin·revision per chunk). Mirrors the #18-D2 affect read pattern: a NON-bifrost debug read on OUR own store (bifrost's memory protocol has no list-all verb) → a web proxy supplying end_user_id server-side → the pane. Polled on session open + the post-turn window (promotion is async, like affect.emit)."
|
||||
postconditions:
|
||||
- "POST-001 (provider read): GET /memory/chunks?agent_id=&end_user_id= returns {chunks:[{chunk_id,content,scope,origin,revision}], count, total}. end_user_id REQUIRED (400 missing_end_user_id) — the partition boundary. Filter: end_user STRICT (scope.end_user==end_user_id), agent_id LENIENT (excluded only if the chunk CARRIES an agent_self axis that differs — so an {end_user}-only chunk, the real WT promotion shape, is not hidden). An empty match is a 200 empty list (0-chunks is a visible answer, never a 404). `total` = unfiltered store-wide count (distinguishes empty-store from scope-mismatch). content = best-effort text field / distillate summary / compact JSON-minus-embedding — a DEBUG read; bifrost verbs stay index/conduit-faithful."
|
||||
- "POST-002 (web proxy): GET /api/memory/chunks supplies end_user_id from app.state.end_user_id (NEVER the browser), forwards the browser-named agent_id, proxies to app.state.memory_read_url (the combined :8392 provider serves both read routes). 400 memory_not_configured when unset; 502 memory_provider_unreachable on network error; status passthrough otherwise. Mirrors _affect_state_endpoint (#18 D2 INV-002)."
|
||||
- "POST-003 (pane): renderMemory shows count(matched)/total(store-wide) in the head + one .mem-chunk per chunk (scope axes + origin + revision + content, ALL esc()'d — INV-004). Empty states are honest + diagnostic: total 0 → 'no memory chunks yet — promotion needs a bound memory/combined session + ~6 turns (or idle); if 0/0 the bind wasn't memory-granted or closed pre-promotion'; total>0 → 'scope mismatch, not an empty store'."
|
||||
flexibility: "open"
|
||||
|
||||
- name: "markdownSafe pass-2 (v0.20.6 RP coloring + v0.20.7 tables / nested lists / streaming)"
|
||||
signature: "markdownSafe(raw) ; mdTable(lines, i) ; mdInline(s)"
|
||||
description: "The escape-first whitelist Markdown renderer, extended pass-2: GFM pipe tables, indentation-nested lists, ordered-list start numbering, and streaming-partial robustness. Pass-1 (RP speech/action coloring + CommonMark paragraph reflow) shipped v0.20.6."
|
||||
postconditions:
|
||||
- "POST-001: GFM pipe tables (`mdTable`) — a pipe row + an alignment/delimiter row (`|---|:--:|`) → <table class=md-table> with per-column text-align from the delimiter colons; body rows parsed until a non-pipe line."
|
||||
- "POST-002: indentation-nested lists — leading-space depth builds a stack of <ul>/<ol> with each child list INSIDE the open parent <li> (valid nested HTML); same-level items are siblings; ul↔ol switches close+reopen. Ordered lists honor the first item's number (<ol start=N> when != 1)."
|
||||
- "POST-003: streaming robustness — an unterminated code fence renders as a partial code block; a table header without its delimiter yet falls through to a paragraph (becomes a table once the delimiter streams in); parsing never throws on a partial. INV-004 held — esc() runs FIRST on the whole input, so table cells / list items / code all carry escaped content."
|
||||
flexibility: "open"
|
||||
|
||||
invariants:
|
||||
- "INV-004 (untrusted-render): ALL model / tool / admin / agent-supplied text is escaped before entering the DOM (esc via textContent, or esc(JSON.stringify)). No new render path introduces an innerHTML sink for upstream content. This is the highest-value review target — the new JS render paths are NOT unit-tested. v0.20.7: the memory pane (chunk content/scope/origin), the delta-strip bars, and markdownSafe table cells / list items all pass through esc() (esc runs FIRST on the whole markdown input)."
|
||||
- "INV-ADMIN-KEY: the admin key exists ONLY at app.state.admin_key (from RATATOSKR_ADMIN_API_KEY). It is never serialized into any response, never sent to the browser, never logged. The browser receives only the session-filtered RESULT of admin-scoped reads."
|
||||
- "INV-FILTER: AdminEvents filtering happens SERVER-side (_admin_event_matches_web) — the browser never receives the cross-session admin firehose; only active-session events + non-heartbeat system.* cross the wire."
|
||||
- "INV-FAIL-VISIBLE: both admin routes return 400 admin_key_not_configured when the key is absent — never a silent empty pane, never an upstream call with an empty bearer."
|
||||
- "INV-LIFECYCLE: SSE generators and EventSources are cleaned up on every exit path (upstream client aclose() in finally; setInterval cleared in hideThinkingNote; prior EventSource closed before re-open) — no leaked connections, tasks, or timers."
|
||||
- "INV-ADDITIVE: existing routes, panes, and the turn-stream path are unchanged; the 3 new routes + 2 new tabs are purely additive (59 web tests incl. all prior ones stay green)."
|
||||
---
|
||||
|
||||
# v0.19.2 — web debug-surface parity (BifrostState · AdminEvents · Tools · PAD-poll · reasoning)
|
||||
|
||||
## Context
|
||||
|
||||
The browser surface is now the operator's PRIMARY debug surface, and it lagged the
|
||||
TUI: the TUI gained Tools/BifrostState/AdminEvents panes (v0.18.9–.11) that were never
|
||||
ported to the web. This change closes that gap and adds two transcript affordances (a
|
||||
reliable PAD refresh + a reasoning indicator). The client wrappers already existed and
|
||||
are contracted elsewhere; this contract governs the WEB proxy routes + the SPA presenter
|
||||
paths, whose JS render code is not unit-tested — hence the cross-frontier code review.
|
||||
|
||||
## Review focus (for the heid panel)
|
||||
|
||||
1. **INV-004 escaping** in every new render path — the un-unit-tested surface; the exact
|
||||
class of bug (`renderPersonaPane` fabricating a Tier-1 field) that only a cross-model
|
||||
review caught on #18 D2.
|
||||
2. **INV-ADMIN-KEY** — confirm the admin key never reaches a response body or the browser.
|
||||
3. **AdminEvents SSE proxy** (`_admin_events_endpoint`) — generator/filter/lifecycle: fixed
|
||||
event name, server-side filter, `stream_error` on failure, `aclose()` on every path,
|
||||
`CancelledError` re-raise on disconnect.
|
||||
4. **PAD-poll** stop-condition — does `emitted_at` advancement + the `state.turnId` guard
|
||||
correctly stop the poll without racing or leaking timers?
|
||||
5. **Reasoning indicator** lifecycle — shown on first `thinking`, removed on first `text`
|
||||
or terminal, interval cleared (no leaked `setInterval`), name via `textContent`.
|
||||
File diff suppressed because it is too large
Load Diff
+302
-30
@@ -61,7 +61,7 @@ When you call `POST /sessions` against an agent, the authorization check that fi
|
||||
|
||||
### Tier 1 — foundational agents (no `:` in agent_id)
|
||||
|
||||
Agents bundled with Worldtree: `mimir`, `lofn`, `soong`, `forseti`, `domari`, `vili`, `actor`, `saga`, `bragi`, `leif`, `troi`, `cara`, `glados`, and any future Asgardian. The agent_id is a simple slug like `mimir` — no colon.
|
||||
Agents bundled with Worldtree: `mimir`, `lofn`, `forseti`, `domari`, `vili`, `mask`, `echo`, `muninn`, and any future Asgardian. The agent_id is a simple slug like `mimir` — no colon.
|
||||
|
||||
> **About tiers:** Your `tier` is set on the `users` table row your API key resolves to, assigned at key-mint time (see `POST /admin/keys`). Tiers are `anonymous` (dev-mode unauthenticated), `user` (default for newly-issued keys), `free`/`pro` (subscription-shaped, not actively differentiated), and `admin`. The tier you have is visible via `GET /me`'s `tier` field. Tier-derived scopes come from `config/policies.yaml > tiers.<tier>.scopes` — there is no per-key scope override.
|
||||
|
||||
@@ -989,7 +989,7 @@ Create a new conversation session with an agent.
|
||||
**Bifrost field validation:**
|
||||
- `endpoint_url`: required, must be an HTTPS URL.
|
||||
- `scope`: optional, ≤ 256 chars, opaque string passed through to the JWT payload unchanged.
|
||||
- Bifrost binding is **incompatible with ephemeral (Saga) sessions** — returns 422 `ephemeral_does_not_accept_bifrost`.
|
||||
- Bifrost binding is **incompatible with ephemeral (Echo) sessions** — returns 422 `ephemeral_does_not_accept_bifrost`.
|
||||
- Requires the `bifrost:invoke` scope (included in the `user` tier by default).
|
||||
|
||||
**Response:** `201 Created`
|
||||
@@ -1535,7 +1535,7 @@ for (const tc of items) {
|
||||
|
||||
Ephemeral templates are a second tier of agent, distinct from foundational persistent agents (Mimir, Soong, etc.). They have no persona, no memory, no tools, and no motivational context. The consumer supplies the system prompt and (optionally) the model at session-create time; that config is frozen for the session's lifetime.
|
||||
|
||||
**Saga** is the first ephemeral template — Norse goddess of history and chronicle, a blank-slate actor that becomes whatever the consumer's system prompt instills.
|
||||
**Echo** is the first ephemeral template — a blank-slate per-session host that becomes whatever the consumer's system prompt instills.
|
||||
|
||||
### Discovering available templates
|
||||
|
||||
@@ -1547,7 +1547,7 @@ Authorization: Bearer <any valid key>
|
||||
```json
|
||||
{
|
||||
"ephemeral_templates": {
|
||||
"saga": {
|
||||
"echo": {
|
||||
"allowed_models": ["glm5-turbo", "glm4.7", "glm4.5-air", "granite-structured", "qwen3.6-35-a3b"],
|
||||
"default_model": "glm5-turbo",
|
||||
"system_prompt_max_bytes": 32768
|
||||
@@ -1556,14 +1556,14 @@ Authorization: Bearer <any valid key>
|
||||
}
|
||||
```
|
||||
|
||||
`GET /capabilities` does not require `instantiate:saga` scope — any authenticated caller can read what's available before deciding to instantiate.
|
||||
`GET /capabilities` does not require `instantiate:echo` scope — any authenticated caller can read what's available before deciding to instantiate.
|
||||
|
||||
### Creating an ephemeral session
|
||||
|
||||
```json
|
||||
POST /sessions
|
||||
{
|
||||
"agent_id": "saga",
|
||||
"agent_id": "echo",
|
||||
"config": {
|
||||
"system_prompt": "You are a careful, skeptical frame-clarifier...",
|
||||
"model": "glm5-turbo"
|
||||
@@ -1580,16 +1580,16 @@ POST /sessions
|
||||
| `system_prompt_required` | `config.system_prompt` missing or null |
|
||||
| `system_prompt_empty` | `config.system_prompt` is whitespace-only |
|
||||
| `system_prompt_too_large` | `config.system_prompt` > 32768 bytes UTF-8 |
|
||||
| `model_not_allowed` | `config.model` present but not in `saga_allowed_models` |
|
||||
| `model_not_allowed` | `config.model` present but not in `echo_allowed_models` |
|
||||
|
||||
**`config.model` resolution:** When `config.model` is omitted (or `null`), the server resolves it to `saga.default_model` from `config/defaults.yaml`. The resolved value is always populated in the session snapshot; `model` is never left absent or null in the stored config.
|
||||
**`config.model` resolution:** When `config.model` is omitted (or `null`), the server resolves it to `echo.default_model` from `config/defaults.yaml`. The resolved value is always populated in the session snapshot; `model` is never left absent or null in the stored config.
|
||||
|
||||
**Response:** Same 201 shape as foundational sessions, with two new fields:
|
||||
|
||||
```json
|
||||
{
|
||||
"session_id": "...",
|
||||
"agent_id": "saga",
|
||||
"agent_id": "echo",
|
||||
"kind": "ephemeral",
|
||||
"config": {
|
||||
"system_prompt": "You are a careful, skeptical frame-clarifier...",
|
||||
@@ -1601,7 +1601,7 @@ POST /sessions
|
||||
}
|
||||
```
|
||||
|
||||
**`kind` field:** `"ephemeral"` for Saga sessions, `"foundational"` for all other sessions. Present on both `GET /sessions` list items and `GET /sessions/{id}`.
|
||||
**`kind` field:** `"ephemeral"` for Echo sessions, `"foundational"` for all other sessions. Present on both `GET /sessions` list items and `GET /sessions/{id}`.
|
||||
|
||||
### Sending messages to an ephemeral session
|
||||
|
||||
@@ -1617,9 +1617,9 @@ SSE, cancel, `persist_partial`, rate limits, and error shapes are bit-identical
|
||||
|
||||
### Scope
|
||||
|
||||
Creating a Saga session requires the `instantiate:saga` scope. This scope is bundled in the `user` tier. Tier `admin` inherits it via the wildcard.
|
||||
Creating an Echo session requires the `instantiate:echo` scope. This scope is bundled in the `user` tier. Tier `admin` inherits it via the wildcard.
|
||||
|
||||
### What Saga does NOT do
|
||||
### What Echo does NOT do
|
||||
|
||||
- No persona injection (`PersonaRegistry.inject_context` not called)
|
||||
- No post-turn appraisal (`PersonaRegistry.update_after_turn` not called)
|
||||
@@ -2415,7 +2415,7 @@ The `POST /sessions/{session_id}/messages` endpoint also accepts an additive `mo
|
||||
- Override is per-call only. Stored `CharacterSchema.model` is NOT mutated.
|
||||
- Validated against the same `available_for_characters` allowlist that gates `CharacterSchema.model` at create time (#153 INV-091).
|
||||
- Override displaces the character's bound model when both are set (per-call wins).
|
||||
- Override is REJECTED on ephemeral (Saga) sessions — their config is frozen at session-create per INV-161-2.
|
||||
- Override is REJECTED on ephemeral (Echo) sessions — their config is frozen at session-create per INV-161-2.
|
||||
|
||||
**Validation:**
|
||||
1. Pydantic validates `model`: optional string, non-empty after stripping whitespace.
|
||||
@@ -2672,7 +2672,7 @@ The override client has a fresh 25-call reentrancy budget, independent of the se
|
||||
| Condition | HTTP | `error_code` | `bifrost_error` |
|
||||
|-----------|------|-------------|----------------|
|
||||
| `endpoint_url` is not HTTPS | 422 | `validation_failed` | — |
|
||||
| Ephemeral (Saga) session | 422 | `validation_failed` | — |
|
||||
| Ephemeral (Echo) session | 422 | `validation_failed` | — |
|
||||
| Missing `bifrost:invoke` scope | 403 | `auth_scope_denied` | — |
|
||||
| `consumer_id` not in Heimdall or not Bifrost-registered | 502 | `bifrost_consumer_not_found` | — |
|
||||
| Handshake failed (network, auth, etc.) | 502 | `bifrost_handshake_failed` | spec error code |
|
||||
@@ -2699,10 +2699,13 @@ The `turn.started` event always carries `bifrost_override_applied: bool` (True/F
|
||||
|
||||
Tier 3 agents are consumer-owned, Worldtree-hosted agents whose
|
||||
identity lives at `<user_id>:<agent_name>`. They share the persistent
|
||||
session infrastructure with Tier 1 / Tier 2 but layer-specific
|
||||
machinery (persona, motivational, memory, valence) is reserved for
|
||||
later phases — Phase 2.0 ships baseline addressing + ownership +
|
||||
lifecycle only.
|
||||
session infrastructure with Tier 1 / Tier 2. The layer-specific
|
||||
machinery is now largely active: **`persona` (Phase 2.1, #186),
|
||||
`memory` (Phase 2.1, #197), and `motivational` (Phase 2.2, #187) are
|
||||
shipped and consumer-settable at define-time.** Only **`valence` remains
|
||||
deferred** (non-null → 422 `layer_deferred`). Phase 2.0 shipped the
|
||||
baseline addressing + ownership + lifecycle substrate; the subsections
|
||||
below document the active layers and their exact validated shapes.
|
||||
|
||||
### Endpoints
|
||||
|
||||
@@ -2720,11 +2723,13 @@ lifecycle only.
|
||||
{
|
||||
"agent_name": "wizard",
|
||||
"system_prompt": "You are a guided-elicitation wizard...",
|
||||
"model": "glm5-turbo",
|
||||
"persona": null, // schema-reserved; non-null → 422 layer_deferred
|
||||
"motivational": null,
|
||||
"valence": null,
|
||||
"memory": null
|
||||
"role": "gen-reasoning", // REQUIRED — a configured model-role (#344), not a raw model id
|
||||
"persona": { // active (Phase 2.1) — single-letter OCEAN keys; see "Persona layer"
|
||||
"ocean": {"O": 0.4, "C": 0.6, "E": -0.3, "A": 0.2, "N": 0.5}
|
||||
},
|
||||
"motivational": null, // active (Phase 2.2) — see "Motivational layer"
|
||||
"memory": null, // active (Phase 2.1) — see "Memory layer"
|
||||
"valence": null // still deferred — non-null → 422 layer_deferred
|
||||
}
|
||||
```
|
||||
|
||||
@@ -2753,6 +2758,207 @@ Caller must:
|
||||
`agent_name` is a strict slug `[a-z][a-z0-9-]{2,63}` and immutable
|
||||
after definition.
|
||||
|
||||
The 201 response includes an advisory `warnings` array (#219) — see
|
||||
"Model-assignment warnings" under `PATCH` below.
|
||||
|
||||
> **Vendoring note (OpenAPI 2.3.0).** In the frozen OpenAPI 2.3.0 document
|
||||
> the `persona` / `motivational` / `memory` / `valence` request fields
|
||||
> serialize as **untyped/freeform** — the `POST /agents/define` request
|
||||
> model types them as `Any` so the layers can activate without a
|
||||
> schema-breaking change. The shapes documented in the subsections below
|
||||
> are the **authoritative, validator-enforced** schemas; generate client
|
||||
> types from this section, not from the freeform OpenAPI fields.
|
||||
|
||||
##### Persona layer (Phase 2.1, #186)
|
||||
|
||||
`persona` is **active** as of Phase 2.1. It carries the agent's OCEAN
|
||||
personality vector — the durable trait profile from which Worldtree
|
||||
derives the mood setpoint (`baseline_pad`) and the mood dynamics
|
||||
(gain + relaxation time-constants). Shape:
|
||||
|
||||
```json
|
||||
"persona": {
|
||||
"ocean": { // REQUIRED — exactly these 5 keys, no more, no fewer
|
||||
"O": 0.4, // Openness — float in [-1.0, 1.0]
|
||||
"C": 0.6, // Conscientiousness
|
||||
"E": -0.3, // Extraversion
|
||||
"A": 0.2, // Agreeableness
|
||||
"N": 0.5 // Neuroticism
|
||||
},
|
||||
"behavioral_notes": "...", // optional, ≤ 4096 chars
|
||||
"temperament_notes": "..." // optional, ≤ 4096 chars
|
||||
}
|
||||
```
|
||||
|
||||
**⚠ OCEAN key format — single-letter, uppercase.** The `/agents/define`
|
||||
persona validator requires the `ocean` map to contain **exactly** the five
|
||||
uppercase single-letter keys `O, C, E, A, N`. This is a deliberate,
|
||||
load-bearing contrast with the transient-character primitive
|
||||
(`POST /characters`), whose `ocean` block uses the **spelled-out**
|
||||
lowercase keys (`openness`, `conscientiousness`, …). Sending spelled-out
|
||||
keys to `/agents/define` returns 422 `persona_ocean_required` ("must
|
||||
contain exactly the 5 keys O, C, E, A, N").
|
||||
|
||||
> **Fixed in v1.0.0b21 (#348).** Before that build a correctly
|
||||
> single-letter-keyed persona was accepted and stored, but resolved to a
|
||||
> **neutral** mood, because Worldtree's internal mood-derivation read the
|
||||
> spelled-out key form. On v1.0.0b21+ an API-declared persona correctly
|
||||
> drives the derived mood setpoint. If you observe neutral mood on a
|
||||
> persona-defined agent, confirm the deployment is ≥ v1.0.0b21.
|
||||
|
||||
**Range.** Each value is a float in `[-1.0, 1.0]` **signed** — `0.0` is the
|
||||
population mean, NOT `[0.0, 1.0]`. Booleans are rejected. Out-of-range → 422
|
||||
`persona_ocean_out_of_range`. See [`docs/ocean-traits.md`](ocean-traits.md)
|
||||
for the SOTA-grounded 5-band behavioural mapping.
|
||||
|
||||
Semantics:
|
||||
|
||||
- **Per-agent identity trait** — identical for every end-user and session;
|
||||
immutable post-define (`PATCH {"persona": …}` → 422 `field_not_mutable`).
|
||||
To change the OCEAN profile, delete and re-define the agent.
|
||||
- **`extensions` is reserved** — the field exists but must be empty at v0.1;
|
||||
a non-empty `extensions` returns 422 `layer_deferred`.
|
||||
- **Sets the mood SETPOINT, not the current mood.** The OCEAN vector fixes
|
||||
`baseline_pad` (the PAD point the mood relaxes toward over time); the
|
||||
*current* per-session mood point is seeded separately via
|
||||
`POST /sessions/{id}/persona_state` (below).
|
||||
|
||||
Validation 422 codes: `persona_ocean_required` (missing `ocean`, or keys
|
||||
≠ {O,C,E,A,N}), `persona_ocean_out_of_range` (a value outside [-1.0, 1.0], or
|
||||
a boolean), `persona_notes_too_large` (a note > 4096 chars), `layer_deferred`
|
||||
(non-empty `extensions`), `validation_failed` (unknown top-level field).
|
||||
|
||||
##### `POST /sessions/{session_id}/persona_state` — seed the session mood point (Phase 2.1, #186/#189)
|
||||
|
||||
Session-scoped mood seed. Sets the *current* PAD mood point for one
|
||||
session's bound agent — the starting emotional state, distinct from the
|
||||
OCEAN-derived setpoint the mood relaxes toward. Works on any
|
||||
persona-enabled session (Tier 1 or Tier 3); most useful for a Tier 3
|
||||
durable-agent session that wants to start a conversation from a specific
|
||||
mood.
|
||||
|
||||
Request:
|
||||
|
||||
```json
|
||||
{
|
||||
"pad": {
|
||||
"pleasure": 0.42, // float in [-1.0, 1.0]
|
||||
"arousal": 0.25,
|
||||
"dominance": 0.33
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Response: **`204 No Content`** — no body, no audit event (a session-scoped
|
||||
runtime overlay, not a security-relevant event).
|
||||
|
||||
Semantics:
|
||||
|
||||
- **PAD-only** (#317 Option A). The body accepts exactly one key, `pad`,
|
||||
which must carry all three of `pleasure` / `arousal` / `dominance`, each a
|
||||
float in `[-1.0, 1.0]`. Any other top-level key → 422 `validation_failed`;
|
||||
a missing or malformed `pad` → 422 `persona_seed_invalid`.
|
||||
|
||||
> **✓ R32-1B (landed, v1.0.0b29):** The PAD range `[-1.0, 1.0]` relaxes to an **unbounded latent `z`** with a finite wire sanity bound (`~±10`) as of R32 Slice-1B. The JSON shape/fields/types are UNCHANGED — only the declared range/semantics change (the value becomes a latent that renders to a bounded display value). Consumers that merely store-and-return PAD need no change; consumers that validate/clamp PAD to `[-1,1]` must relax that bound. Source of truth: `docs/contracts/persona_envelope.contract.md` rev 1.7 (INV-ENV-16).
|
||||
- **Seeds the current mood POINT, not the setpoint.** The OCEAN persona
|
||||
(above) fixes the setpoint the mood relaxes toward; this endpoint sets
|
||||
where the mood *starts*. It does not alter the persona.
|
||||
- **Cross-owner sessions return 404** (existence-hiding — a session that
|
||||
isn't yours is indistinguishable from one that doesn't exist).
|
||||
- **Pull-over-push precedence (#289).** Once a session's baseline has been
|
||||
rehydrated from an `affect.fetch` (the authoritative cross-session
|
||||
source), a later SET seed is silently ignored — the fetched baseline wins.
|
||||
|
||||
There is **no** `POST /agents/{id}/persona_state` — mood is per-session, not
|
||||
a durable agent property. `GET /agents/{agent_id}/persona_state`
|
||||
short-circuits to 404 for Tier-3 colon-ids: Tier-3 mood is observable only
|
||||
over the Bifrost `affect.emit` egress (ADR-0009), never read back through
|
||||
the HTTP API.
|
||||
|
||||
##### Memory layer (Phase 2.1, #197)
|
||||
|
||||
`memory` is **active** as of Phase 2.1 but exposes a deliberately minimal
|
||||
surface — the short-term-memory (STM) tier was removed (#197), so the
|
||||
historically-present `stm_*` knobs are accept-and-ignore no-ops. Shape:
|
||||
|
||||
```json
|
||||
"memory": {
|
||||
"embedder_version": "<pinned>", // optional; MUST equal the library-pinned version
|
||||
"tier3_dreaming": false // optional bool, default false
|
||||
}
|
||||
```
|
||||
|
||||
Semantics:
|
||||
|
||||
- **`embedder_version`** — optional. If supplied it MUST equal the library's
|
||||
currently-pinned embedder version; a mismatch → 422
|
||||
`embedder_version_mismatch` (with `expected` / `received` in the detail).
|
||||
Omit it to accept the pin. Fixed at define-time and library-pinned
|
||||
thereafter.
|
||||
- **`tier3_dreaming`** — optional bool (default `false`); opt-in flag for the
|
||||
Tier-3 dreaming / consolidation path.
|
||||
- **`stm_capacity` / `stm_token_budget`** — **deprecated no-ops.** Accepted at
|
||||
define (201) with a `DeprecationWarning`; they carry no runtime effect since
|
||||
the STM tier was removed, and are slated for rejection at the next schema
|
||||
break. Do not send them in new integrations.
|
||||
- **`allows_world_scope` — removed.** Sending it → 422 `validation_failed`
|
||||
("world-shared knowledge belongs in the KB/Mimir plane").
|
||||
- **Wholesale-immutable post-define.** `PATCH {"memory": …}` → 422
|
||||
`field_not_mutable` (even for the deprecated `stm_*` fields) — see the
|
||||
PATCH table above.
|
||||
|
||||
##### Motivational layer (Phase 2.2, #187)
|
||||
|
||||
`motivational` is **active** as of Phase 2.2 (persona + memory activated in
|
||||
Phase 2.1; only `valence` still returns `layer_deferred`). It carries the
|
||||
agent's goals + fears — the same substrate Tier 1 agents author in
|
||||
`agents/<name>/motivation.yaml`:
|
||||
|
||||
```json
|
||||
"motivational": {
|
||||
"goals": [
|
||||
{
|
||||
"id": "successful_handoff",
|
||||
"type": "achievement", // maintenance | achievement | avoidance
|
||||
"salience": 0.85, // [0.0, 1.0]
|
||||
"description": "You succeed when the user lands with the right specialist.",
|
||||
"positive_signals": ["talk to mimir"], // optional
|
||||
"negative_signals": ["stay with me"] // optional
|
||||
}
|
||||
],
|
||||
"fears": [
|
||||
{
|
||||
"id": "specialist_displacement",
|
||||
"salience": 0.90,
|
||||
"description": "You fear being mistaken for the specialist the user needs.",
|
||||
"trigger_signals": ["actually mimir would"] // optional (NB: fears use trigger_signals)
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Semantics:
|
||||
|
||||
- **Per-agent, not per-(agent, end_user).** Goals/fears are an identity trait of
|
||||
the agent — identical for every end-user and session.
|
||||
- **Immutable post-define.** `PATCH` with `motivational` returns 422
|
||||
`field_not_mutable`. To change motivations, define a new agent.
|
||||
- **Rendered into the system prompt.** The config is captured on the session's
|
||||
`AgentContext` at session-create and rendered into the prompt on each turn
|
||||
(only goals/fears with `salience >= 0.5` surface). Tier 3 agents bypass the
|
||||
persona registry; the render reuses the Tier 1 substrate so output is
|
||||
identical to an equivalent Tier 1 `motivation.yaml`.
|
||||
|
||||
Validation rejects malformed payloads at define-time with these 422 codes:
|
||||
`motivational_id_collision` (id duplicated across goals AND fears — case-sensitive),
|
||||
`motivational_goal_invalid_type`, `motivational_salience_out_of_range`,
|
||||
`motivational_description_too_short` (< 20 chars after strip),
|
||||
`motivational_missing_required_field` (missing id / salience / description /
|
||||
goal `type`). Unknown keys at the top level or inside a goal/fear object →
|
||||
`validation_failed`. v0.1 exposes only the documented fields; advanced
|
||||
`GoalConfig` knobs (`priority`, `resilient`, `completion_signal`, …) are not
|
||||
consumer-settable yet.
|
||||
|
||||
#### `DELETE /agents/<user_id>:<agent_name>` — `204 No Content`
|
||||
|
||||
Owner-initiated hard-delete. Bypasses the 24h grace (distinct from the
|
||||
@@ -2762,11 +2968,77 @@ session bound to this agent and revokes the owner's per-resource
|
||||
|
||||
#### `PATCH /agents/<user_id>:<agent_name>`
|
||||
|
||||
Phase 2.0 minimal: only `system_prompt` and/or `model` may be patched.
|
||||
Any other key (including the immutable `agent_name`, `user_id`, or
|
||||
layer fields — even `null`) returns 422 `field_not_mutable` BEFORE the
|
||||
DB lookup. Active sessions continue using their cached `AgentContext`;
|
||||
the new values take effect at the next session-create.
|
||||
**Mutable surface (Phase 2.3, #188): `system_prompt` and/or `model` only.**
|
||||
PATCH re-enforces the same validation as define — the `system_prompt`
|
||||
byte-cap and the `model` allowlist. Any other key returns a 422 BEFORE
|
||||
the DB lookup (so an immutable-field PATCH against a missing agent still
|
||||
422s, not 404s), with the error code chosen by *why* the field can't be
|
||||
set:
|
||||
|
||||
| Field(s) | Code | Reason |
|
||||
|---|---|---|
|
||||
| `agent_name`, `user_id`, `agent_id` | `field_not_mutable` | Identity — fixed at creation. |
|
||||
| `persona`, `motivational` | `field_not_mutable` | Shipped traits; an agent *is* its personality/goals. Change → define a new agent. |
|
||||
| `memory` | `field_not_mutable` | Rejected **wholesale** — see below. |
|
||||
| `valence` | `layer_deferred` | Not a shipped layer yet (matches define-time); not a frozen trait. |
|
||||
|
||||
Every immutable/deferred field is rejected even when its value is `null` —
|
||||
supplying the key at all is the trigger.
|
||||
|
||||
**`memory` is wholesale-immutable.** There is no sub-field carve-out:
|
||||
`stm_capacity` / `stm_token_budget` are deprecated no-ops since the STM
|
||||
tier was removed (#197), `allows_world_scope` is create-time-only (memory
|
||||
scope policy must be fixed before any memory is written), and
|
||||
`embedder_version` is library-pinned. Note the deliberate asymmetry with
|
||||
define: `POST /agents/define` accept-and-ignores deprecated `stm_*`
|
||||
(201 + deprecation warning), but `PATCH {"memory": {...}}` rejects the
|
||||
whole field with `field_not_mutable`. When a real long-term-memory tuning
|
||||
dial ships, its PATCH semantics will be specified at that time.
|
||||
|
||||
**Active sessions are unaffected.** A PATCH never mutates an in-flight
|
||||
session's cached `AgentContext`; new `system_prompt` / `model` values take
|
||||
effect only at the next session-create.
|
||||
|
||||
**Audit.** A successful PATCH emits one `agents.patch` event whose
|
||||
`changes` detail records before/after per mutated field: `model` as literal
|
||||
`{before, after}` values, and `system_prompt` as `{before_bytes,
|
||||
after_bytes}` only — the raw prompt text is never written to the audit log
|
||||
(potential PII).
|
||||
|
||||
**Model-assignment warnings (#219).** A `model` swap is **not blocked** for
|
||||
capability or context-window compatibility, but PATCH (and `define`) attach an
|
||||
advisory `warnings` array to the response — see the shared subsection below.
|
||||
Correctness for over-budget prompts remains the runtime `context_overflow`
|
||||
guard; the warnings are an early, best-effort heads-up.
|
||||
|
||||
##### Model-assignment warnings (`define` + PATCH)
|
||||
|
||||
Both `POST /agents/define` (201) and `PATCH /agents/<id>` (200) include a
|
||||
`warnings` array in the response body (always present; `[]` when none). It is
|
||||
**advisory and non-blocking** — never a rejection — and appears only on these
|
||||
two mutation responses, not on `GET /agents/<id>`. Each entry is
|
||||
`{code, severity, message, details}`. The closed code set:
|
||||
|
||||
| code | severity | when |
|
||||
|---|---|---|
|
||||
| `model_context_window_unknown` | `info` | The assigned model has no recorded context window (`0`/absent in the registry). |
|
||||
| `model_context_window_smaller` | `warning` | Both prior and new model have known windows and the new one is smaller. `details: {before, after}`. |
|
||||
| `model_capability_downgrade` | `warning` | The new model **explicitly** advertises fewer capabilities than the prior — drops `tools`, `vision`, or `audio`. `details: {dropped: [...]}`. |
|
||||
|
||||
Semantics:
|
||||
|
||||
- **`define`** has no prior model, so only `model_context_window_unknown` can
|
||||
fire there. **PATCH** computes warnings only when the payload changes `model`
|
||||
(a `system_prompt`-only PATCH returns `warnings: []`); the comparison is
|
||||
against the resulting model.
|
||||
- Capability warnings are **conditional by nature**: a Tier 3 agent row does
|
||||
not record whether it uses tools/vision/audio (tools arrive per-session via
|
||||
Bifrost), so the message is phrased "if your sessions rely on these…". A
|
||||
downgrade is reported only when both models carry explicit registry metadata.
|
||||
- Messages never claim a hard failure. The stored `system_prompt` cap is a
|
||||
**byte** limit (32 KiB), independent of any model's token budget — it is not
|
||||
a fit guarantee. A too-large prompt for the chosen model still surfaces at
|
||||
runtime as `context_overflow`.
|
||||
|
||||
#### `POST /sessions` — Tier 3 routing
|
||||
|
||||
@@ -2860,8 +3132,8 @@ endpoint isn't reachable.
|
||||
| `agent_name_invalid` | 422 | `agent_name` violates `[a-z][a-z0-9-]{2,63}`. |
|
||||
| `system_prompt_too_large` | 422 | `system_prompt` > 32 KiB. |
|
||||
| `model_not_available` | 422 | `model` not in `providers.yaml`. |
|
||||
| `layer_deferred` | 422 | One of `persona` / `motivational` / `valence` / `memory` set. |
|
||||
| `field_not_mutable` | 422 | PATCH carries an immutable key (any value, even `null`). |
|
||||
| `layer_deferred` | 422 | `valence` set on define OR PATCH (the only still-deferred layer; persona/motivational/memory activated in Phase 2.1/2.2). |
|
||||
| `field_not_mutable` | 422 | PATCH carries an immutable key — identity (`agent_name`/`user_id`), `persona`, `motivational`, or `memory` (any value, even `null`). `valence` → `layer_deferred` instead. |
|
||||
| `end_user_id_required` | 422 | Tier 3 session-create without a non-empty `end_user_id`. |
|
||||
| `tier3_user_id_unsupported` | 403 | Caller's `ctx.user_id` not slug-safe. |
|
||||
| `auth_scope_denied` | 403 | Missing `agents.define` or wrong owner. |
|
||||
|
||||
@@ -0,0 +1,265 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"description": "Server-Sent Events emitted on POST /sessions/{id}/messages. Each event is an object discriminated on `type`; all carry `turn_id`.",
|
||||
"discriminator": {
|
||||
"propertyName": "type"
|
||||
},
|
||||
"oneOf": [
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"phase": {
|
||||
"enum": [
|
||||
"BuildingPrompt",
|
||||
"CallingLLM",
|
||||
"ProcessingTools",
|
||||
"Streaming",
|
||||
"Finishing"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "worker_phase"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "awaiting_llm_first_token"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "thinking"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"content": {
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "text"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "text_boundary"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "tool_start"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"result": {},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "tool_result"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "affect_update"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "done"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"phase": {
|
||||
"type": "string"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "cancelled"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"error_code": {
|
||||
"type": "string"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"turn_id": {
|
||||
"description": "The turn this event belongs to.",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"const": "error"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"turn_id"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
],
|
||||
"title": "Worldtree Conversation API — SSE turn-stream events"
|
||||
}
|
||||
@@ -137,6 +137,68 @@ Sessions are persistent via SQLite. On server restart, existing sessions are
|
||||
loadable from the store (lazy-loaded on first access). In-memory cache is
|
||||
rebuilt on demand, not at startup.
|
||||
|
||||
## Memory-partition scope (#245 / ADR-0011)
|
||||
|
||||
`end_user_id` is the per-end-user memory partition key (distinct from `user_id`,
|
||||
the API-key owner). It is REQUIRED at session-create for Lofn (Tier-1) and Tier-3
|
||||
agents and must survive a store reload, because "remember me next session" is by
|
||||
definition a reload. Memory partition resolution flows through ONE resolver that
|
||||
cannot hand an authenticated session the shared `local_dev` partition.
|
||||
|
||||
- **INV-245-1 (end-user-id-durable)**: `end_user_id` is persisted as a `sessions`
|
||||
table column at create and rehydrated onto the `ConversationSession` on every
|
||||
cache-miss load (`get_session`). A session loaded from the store carries the
|
||||
same `end_user_id` it was created with. Pre-migration rows read as `None`.
|
||||
- **INV-245-2 (end-user-id-threaded-all-tiers)**: the `POST /sessions` handler
|
||||
forwards `body.end_user_id` to `create_session` for EVERY agent, not only
|
||||
Tier-3. (The pre-fix `if tier3_agent_context is not None else None` conditional
|
||||
dropped it for Lofn despite the create gate requiring it.)
|
||||
- **INV-245-3 (no-authenticated-local-dev)**: the two MEMORY partition sites —
|
||||
auto-recall (read) and the ContextPromotion producer (write) — resolve via
|
||||
`memory_scope_for_session`. An authenticated, memory-bearing session (one not
|
||||
carrying the explicit `local_dev` sentinel) NEVER resolves to `local_dev`; a
|
||||
missing `end_user_id` raises `MemoryScopeError`, and because both sites are
|
||||
best-effort (recall is fire-and-forget; the producer is `_run_promotion_safe`),
|
||||
the caller skips memory — it never silently writes to the shared partition.
|
||||
- **INV-245-5 (persona-plane-corrected-by-persistence)**: the three PERSONA-plane
|
||||
sites (`inject_context`, `get_state`, `update_after_turn` — ADR-0008 mood/PAD/
|
||||
valence) keep their `session.end_user_id or "local_dev"` form but are on the
|
||||
main turn path where a raise would break the turn. They are corrected by
|
||||
INV-245-1/2: once `end_user_id` is persisted + threaded, the fallback yields a
|
||||
real partition for authenticated sessions and `local_dev` only for the explicit
|
||||
terminal path. Unifying the persona plane under the resolver (with main-path
|
||||
error semantics) is follow-up, tracked with the #246-adjacent hardening.
|
||||
- **INV-245-4 (terminal-explicit-local-dev)**: the internal terminal transport
|
||||
creates its sessions with `end_user_id="local_dev"` explicitly. `local_dev` is
|
||||
reached only by this positive assertion, never by omission. (External API
|
||||
callers passing `local_dev` are still rejected per #216.)
|
||||
|
||||
```contract
|
||||
FN memory_scope_for_session(session) -> MemoryScope
|
||||
BRIEF: The single authority resolving a session to its memory partition scope.
|
||||
Returns a typed MemoryScope(scope_type, scope_id); scope_type ∈
|
||||
{local_dev, end_user, room, tenant} (only local_dev + end_user active in
|
||||
v1; room/tenant reserved for ADR-0010). Cannot yield local_dev for an
|
||||
authenticated session.
|
||||
PRE: [PRE-001 soft] callers have already gated ephemeral / consumer_defined
|
||||
sessions out (those skip memory before resolution)
|
||||
POST: [POST-001 return_value] end_user_id == "local_dev" -> MemoryScope("local_dev", "local_dev")
|
||||
POST: [POST-002 return_value] end_user_id truthy and != "local_dev" -> MemoryScope("end_user", end_user_id)
|
||||
POST: [POST-003 exception] end_user_id is None/empty -> raise MemoryScopeError (NEVER local_dev)
|
||||
ERRORS:
|
||||
MemoryScopeError -> caller skips memory (best-effort) + emits an audit/log line; turn proceeds
|
||||
STEPS:
|
||||
1. [setup] read euid = session.end_user_id
|
||||
2. [branch] euid == "local_dev" -> RETURN MemoryScope("local_dev", "local_dev") (terminal sentinel)
|
||||
3. [branch] euid truthy -> RETURN MemoryScope("end_user", euid)
|
||||
4. [error_handler] else (None/empty) -> RAISE MemoryScopeError (never silently local_dev)
|
||||
TESTS:
|
||||
end_user_partition [happy,tracer]: session end_user_id="alice" -> MemoryScope("end_user","alice")
|
||||
terminal_local_dev [boundary]: session end_user_id="local_dev" -> MemoryScope("local_dev","local_dev")
|
||||
authenticated_none_raises [boundary]: foundational session end_user_id=None -> raises MemoryScopeError, NOT local_dev
|
||||
isolation_roundtrip [happy]: create_session(end_user_id="alice") write + clear cache + reload + recall isolates from a "bob" session; negative-assert no local_dev write
|
||||
```
|
||||
|
||||
```contract
|
||||
FN ConversationService.startup() -> None
|
||||
BRIEF: Discover agents, build per-agent contexts, initialise shared infrastructure
|
||||
@@ -1658,13 +1720,13 @@ Ephemeral templates are a new agent kind that bypass persona, memory, tools, and
|
||||
**Invariants added by issue #161:**
|
||||
|
||||
- **INV-161-1 (ephemeral-template-bypass)**: For sessions where `session.ephemeral_config is not None`, `PersonaRegistry.inject_context` is NOT called pre-turn; `PersonaRegistry.update_after_turn` is NOT called post-turn; valence side-channel is NOT called; tool list passed to provider is `[]`.
|
||||
- **INV-161-2 (frozen-session-config)**: Once a session is created with an `ephemeral_config` snapshot, subsequent mutations to `agents/saga/config.yaml`, `config/providers.yaml → saga_allowed_models`, or `config/defaults.yaml → saga.default_model` do NOT affect that session's per-turn `system_prompt` or `model`.
|
||||
- **INV-161-2 (frozen-session-config)**: Once a session is created with an `ephemeral_config` snapshot, subsequent mutations to `agents/echo/config.yaml`, `config/providers.yaml → echo_allowed_models`, or `config/defaults.yaml → echo.default_model` do NOT affect that session's per-turn `system_prompt` or `model`.
|
||||
- **INV-161-3 (no-tools-for-ephemeral)**: Tool list passed to the provider for an ephemeral session is `[]` regardless of any `tools:` block in the template's config.yaml.
|
||||
- **INV-161-4 (foundational-flow-unchanged)**: For sessions where `session.ephemeral_config is None`, the per-turn path is bit-identical to pre-#161 — same system_prompt loading, same persona injection, same tool list, same audit-log shape.
|
||||
- **INV-161-5 (config-required-for-ephemeral-create)**: `POST /sessions` against an ephemeral template MUST reject the request with 422 if `config` is missing or fails any validation step.
|
||||
- **INV-161-6 (model-allowlist-enforcement)**: `config.model`, when supplied, MUST be in `saga_allowed_models` at session-create time. When omitted, server resolves to `saga.default_model` (startup-validated to be in the allowlist).
|
||||
- **INV-161-6 (model-allowlist-enforcement)**: `config.model`, when supplied, MUST be in `echo_allowed_models` at session-create time. When omitted, server resolves to `echo.default_model` (startup-validated to be in the allowlist).
|
||||
- **INV-161-7 (full-prompt-in-audit)**: Session-create audit entries for ephemeral sessions include `tier: 2` and `ephemeral_config` (full JSON).
|
||||
- **INV-161-8 (cross-user-isolation)**: A Saga session created by user A is invisible to user B — `GET /sessions/{id}` returns 404.
|
||||
- **INV-161-8 (cross-user-isolation)**: An Echo session created by user A is invisible to user B — `GET /sessions/{id}` returns 404.
|
||||
- **INV-161-9 (foundational-rejects-config)**: `POST /sessions { agent_id: "<foundational>", config: {...} }` returns 422 with `error_code: "foundational_does_not_accept_config"`.
|
||||
- **INV-161-10 (capabilities-public-shape)**: `GET /capabilities` is callable by any authenticated key. The response has `ephemeral_templates` at top-level.
|
||||
- **INV-161-11 (template-kind-immutable-at-runtime)**: The `kind` field on a loaded `AgentContext` is set once at startup and never mutated.
|
||||
@@ -1673,16 +1735,16 @@ Ephemeral templates are a new agent kind that bypass persona, memory, tools, and
|
||||
|
||||
| code | HTTP | trigger |
|
||||
|---|---|---|
|
||||
| `ephemeral_requires_config` | 422 | saga session without `config:` |
|
||||
| `ephemeral_requires_config` | 422 | echo session without `config:` |
|
||||
| `foundational_does_not_accept_config` | 422 | foundational agent with `config:` |
|
||||
| `system_prompt_required` | 422 | `config.system_prompt` missing or null |
|
||||
| `system_prompt_empty` | 422 | `config.system_prompt` whitespace-only |
|
||||
| `system_prompt_too_large` | 422 | > 32768 bytes UTF-8 |
|
||||
| `model_not_allowed` | 422 | model not in `saga_allowed_models` |
|
||||
| `model_not_allowed` | 422 | model not in `echo_allowed_models` |
|
||||
|
||||
**New `AgentContext` fields:** `kind: str = "foundational"`, `saga_allowed_models: list | None`, `saga_default_model: str | None` — populated for ephemeral templates, `None` for foundational agents.
|
||||
**New `AgentContext` fields:** `kind: str = "foundational"`, `echo_allowed_models: list | None`, `echo_default_model: str | None` — populated for ephemeral templates, `None` for foundational agents.
|
||||
|
||||
**Startup failfast:** server refuses to start if `agents/saga/config.yaml` is missing/malformed OR `saga.default_model` is not in `saga_allowed_models`. Raises `ConfigurationError` before binding any port.
|
||||
**Startup failfast:** server refuses to start if `agents/echo/config.yaml` is missing/malformed OR `echo.default_model` is not in `echo_allowed_models`. Raises `ConfigurationError` before binding any port.
|
||||
|
||||
**Function-level contracts for issue #161** are documented in `docs/contracts/issues/161.contract.md`.
|
||||
|
||||
@@ -1704,7 +1766,7 @@ Bifrost allows consumers to expose tools to Worldtree agents. `POST /sessions` a
|
||||
|
||||
- **INV-160-1 (handshake-at-create)**: When `POST /sessions` carries `bifrost: {endpoint_url, ...}`, the handshake completes BEFORE the 201 response. No "create session, handshake later" path in v0.1. Verifiable via test: handshake-failing endpoint → 502; session not in store.
|
||||
- **INV-160-2 (one-connection-per-session)**: Each Bifrost-bound session owns exactly one MCP connection. Two sessions binding to the same `endpoint_url` open two independent connections. No pooling, no sharing.
|
||||
- **INV-160-3 (saga-incompatible)**: A session cannot be both ephemeral (Saga, `kind: "ephemeral"`) AND Bifrost-bound. Session-create rejects with 422 `ephemeral_does_not_accept_bifrost`. Verifiable: `POST /sessions { agent_id: "saga", config: {...}, bifrost: {...} }` → 422.
|
||||
- **INV-160-3 (echo-incompatible)**: A session cannot be both ephemeral (Echo, `kind: "ephemeral"`) AND Bifrost-bound. Session-create rejects with 422 `ephemeral_does_not_accept_bifrost`. Verifiable: `POST /sessions { agent_id: "echo", config: {...}, bifrost: {...} }` → 422.
|
||||
- **INV-160-4 (jwt-bound-to-session-expiry)**: JWT TTL is bound to session expiry — far-future `expires_at` for sessions without a fixed TTL. Re-mint happens only when a re-handshake fires (connection-loss recovery). No standalone JWT-staleness check.
|
||||
- **INV-160-5 (reentrancy-25-per-turn)**: At most 25 successful Bifrost tool invocations per agent turn. The 26th returns `bifrost.reentrancy_cap_exceeded` without contacting the consumer. Counter resets per turn via `BifrostClient.reset_turn_counter()`. Enforced inside `BifrostClient.invoke_tool`.
|
||||
- **INV-160-6 (tool-list-cached-per-session)**: Bifrost tools are fetched once at handshake and cached on `ConversationSession.bifrost_tools`. Per-turn dispatch reads from the cache; never re-fetches mid-session except on connection-loss recovery.
|
||||
@@ -1751,7 +1813,7 @@ class BifrostEndpointOverride(BaseModel):
|
||||
|
||||
1. HTTPS URL check — Pydantic field validator; 422 on miss.
|
||||
2. `bifrost:invoke` scope check — same as session-bound path; 403 on miss.
|
||||
3. Ephemeral session rejection — 422 `ephemeral_does_not_accept_bifrost` when session is Saga (extends INV-160-3).
|
||||
3. Ephemeral session rejection — 422 `ephemeral_does_not_accept_bifrost` when session is Echo (extends INV-160-3).
|
||||
4. Heimdall consumer lookup — 502 `bifrost_consumer_not_found` on miss or unregistered.
|
||||
5. Instantiate a new `BifrostClient` with the override consumer's algorithm + key; set `_jwt_ttl_seconds = 60`.
|
||||
6. `await override_client.connect()` — 502 `bifrost_handshake_failed` on failure.
|
||||
@@ -1789,7 +1851,7 @@ In the `finally` block, `await override_client.disconnect()` is called unconditi
|
||||
|
||||
The conversation API grows a three-tier agent model. Tier 1 is the
|
||||
foundational set (Mimir, Bragi, Leif, ...) wired at startup. Tier 2 is
|
||||
the ephemeral template surface (Saga). Tier 3 is the consumer-defined
|
||||
the ephemeral template surface (Echo). Tier 3 is the consumer-defined
|
||||
class addressed by `<user_id>:<agent_name>` and stored in Heimdall's
|
||||
SQLite `consumer_agents` table.
|
||||
|
||||
@@ -1813,9 +1875,13 @@ SQLite `consumer_agents` table.
|
||||
- **INV-181-5 (agent-name-immutable, Phase 2.0 scope)**: PATCH rejects
|
||||
any payload that includes `agent_name`, returning 422
|
||||
`field_not_mutable` BEFORE the DB lookup.
|
||||
- **INV-181-6 (layer-immutable-in-patch, Phase 2.0 scope)**: PATCH
|
||||
rejects payloads carrying any of `persona`, `motivational`,
|
||||
`valence`, `memory` even when set to `null`.
|
||||
- **INV-181-6 (layer-immutable-in-patch, Phase 2.0 scope; AMENDED #188)**:
|
||||
PATCH rejects payloads carrying any of `persona`, `motivational`,
|
||||
`memory` even when set to `null`, returning `field_not_mutable`.
|
||||
**Amended by #188 (Phase 2.3):** `valence` was moved out of this
|
||||
`field_not_mutable` set — it now returns `layer_deferred` (see
|
||||
INV-188-1), because valence is a not-yet-shipped layer, not a frozen
|
||||
trait. `memory` is rejected wholesale (see INV-188-2).
|
||||
- **INV-181-7 (owner-delete-hard, Phase 2.0 scope)**: `DELETE
|
||||
/agents/<id>` is a hard-delete; bypasses the 24h grace.
|
||||
- **INV-181-8 (cascade-key-scoped, Phase 2.0 scope)**: Key revocation
|
||||
@@ -1881,6 +1947,79 @@ SQLite `consumer_agents` table.
|
||||
through `_publish`, so SSE resume / replay handles them with no
|
||||
special case.
|
||||
|
||||
## Amendment — Suspended-tier license-state gate (issue #174, INV-174-1..9)
|
||||
|
||||
Adds a `suspended` tier with empty scope set to drive license-expiry
|
||||
transitions without destroying user state. Endpoint
|
||||
`POST /admin/users/{user_id}/tier` mutates the tier; the
|
||||
`_http_exception_handler` rewrites `AUTH_SCOPE_DENIED` →
|
||||
`USER_SUSPENDED` for any 403 raised against a non-anonymous caller with
|
||||
an empty scope-set (the suspended-tier defining property). Ships in
|
||||
v0.29.1.
|
||||
|
||||
- **INV-174-1 (closed tier vocabulary)**: `POST /admin/users/{user_id}/tier`
|
||||
validates `body.tier` against the hard-coded set `{anonymous, user, free,
|
||||
pro, admin, suspended}`. Out-of-set values return 422 `invalid_tier`.
|
||||
Vocabulary is NOT derived from `policies.yaml` at runtime — a typo in
|
||||
YAML must not silently expand the accepted set.
|
||||
|
||||
- **INV-174-2 (admin-only mutation)**: endpoint requires
|
||||
`admin.users.write.tier_change` scope. Listed explicitly in admin
|
||||
tier's scope set in `policies.yaml` for grep-discoverability (admin
|
||||
also carries `*` umbrella).
|
||||
|
||||
- **INV-174-3 (tier mutation primitive)**:
|
||||
`UserStore.update_user_tier(user_id, new_tier) -> User` is the storage
|
||||
primitive. Raises `LookupError` for unknown user_id (endpoint converts
|
||||
to 404 `user_not_found`).
|
||||
|
||||
- **INV-174-4 (suspended scope-set is exactly empty)**:
|
||||
`policies.yaml.tiers["suspended"].scopes == []`. The empty set is what
|
||||
makes the auth-denial work for free; the
|
||||
`_http_exception_handler` rewrite uses
|
||||
`ctx.user_id != "anonymous" and not ctx.scopes` as the
|
||||
suspended-detection heuristic since `SecurityContext` deliberately
|
||||
excludes `tier` (per `core/integration/types.py:64`).
|
||||
|
||||
- **INV-174-5 (uniform suspended error code via exception handler)**:
|
||||
The `_http_exception_handler` (registered for `StarletteHTTPException`)
|
||||
intercepts every 403 with `error_code: auth_scope_denied`; if the
|
||||
request's stashed `SecurityContext` has an empty scope-set (and
|
||||
non-anonymous user_id), it rewrites the detail to
|
||||
`{error_code: "user_suspended", message: "Account is suspended."}`.
|
||||
Single seam — covers every existing and future scope-deny site
|
||||
without per-endpoint refactor. The ctx is stashed by
|
||||
`get_security_context` on `request.state.security_context`.
|
||||
|
||||
- **INV-174-6 (/me carve-out)**: `/me` does NOT call `authorize()` and
|
||||
therefore never raises `AUTH_SCOPE_DENIED`. Suspended users with
|
||||
empty scopes reach the /me handler normally and see
|
||||
`{user_id, tier: "suspended", scopes: [], ...}`. Adding a scope check
|
||||
to /me without preserving the suspended-tier visibility would be a
|
||||
contract violation — the carve-out is structural, not coded.
|
||||
|
||||
- **INV-174-7 (audit emission)**: every tier-change attempt emits
|
||||
`conversation_api:admin:user:tier_changed` via `_audit_admin_action`
|
||||
with `actor_user_id`, `target_user_id`, `outcome ∈
|
||||
{success, denied}`, and `extra = {from_tier, to_tier, reason}` for
|
||||
successes; `extra = {reason: <reason_code>}` for denials
|
||||
(`invalid_tier`, `user_not_found`).
|
||||
|
||||
- **INV-174-8 (reversibility via audit replay)**: the user record does
|
||||
NOT carry a `previous_tier` column. Restoration of a suspended user
|
||||
requires reading the audit log to find the most recent
|
||||
`tier_changed` event with `to_tier="suspended"` and replaying its
|
||||
`from_tier` as the new target. Operational responsibility of SEA's
|
||||
billing integration; Worldtree provides only the read (audit log) and
|
||||
write (endpoint) surfaces.
|
||||
|
||||
- **INV-174-9 (no cross-tier session invalidation)**: a tier change for
|
||||
a user with active SSE turns in flight does NOT cancel those turns.
|
||||
The next request after the tier change picks up the new scope-set;
|
||||
in-flight streams complete under the old tier. If SEA needs
|
||||
immediate-cutoff semantics, that requires `disable_user`-style
|
||||
hard-revoke, not a tier change.
|
||||
|
||||
## Amendment — AwaitingLLMFirstToken heartbeat (issue #201, INV-201-1..7)
|
||||
|
||||
Adds a periodic SSE heartbeat event during the gap between
|
||||
@@ -2027,3 +2166,160 @@ Lofn introduces zero net-new persistence surface. No table, no
|
||||
column, no Mimir KB collection. No new audit-event types. Existing
|
||||
session-create / session-revoke audit covers Lofn the same way it
|
||||
covers Mimir / Forseti.
|
||||
|
||||
## Amendment — Tier 3 motivational layer (issue #187, Phase 2.2)
|
||||
|
||||
Activates the `motivational` layer field on `POST /agents/define`, narrowing the
|
||||
Phase 2.0 `layer_deferred` rejection (INV-181-3) to `valence` only. Full FN-level
|
||||
spec at `docs/contracts/issues/187.contract.md`.
|
||||
|
||||
- **INV-187-1 (motivational-activated)**: `POST /agents/define` accepts a non-null
|
||||
`motivational` object `{goals, fears}`; `_tier3_validate_layer_fields` rejects
|
||||
only `valence` now. (Persona + memory were activated in Phase 2.1 / #189.)
|
||||
- **INV-187-2 (define-validation)**: `validate_motivational_define_payload` enforces
|
||||
the documented 422 codes — `motivational_id_collision` (case-sensitive, across
|
||||
goals AND fears), `motivational_goal_invalid_type`,
|
||||
`motivational_salience_out_of_range`, `motivational_description_too_short`
|
||||
(< 20 chars after strip), `motivational_missing_required_field`. Unknown top-level
|
||||
OR nested (per goal/fear) keys → `validation_failed` (sub-models extra-forbid).
|
||||
Stricter than the Tier 1 `validate_motivation` (which only warns on short text).
|
||||
- **INV-187-3 (per-agent-scope)**: motivational is per-agent, NOT
|
||||
per-(agent, end_user) — stored once on the row, identical across all end-users.
|
||||
- **INV-187-4 (immutable-in-patch)**: `PATCH` with `motivational` → 422
|
||||
`field_not_mutable` (already covered by INV-181-6's `_IMMUTABLE_FIELDS` gate).
|
||||
- **INV-187-5 (tier3-render-bridge)**: Tier 3 agents are NOT registered with the
|
||||
`persona_registry`; the stored config rides on the per-session `AgentContext`
|
||||
(`motivational_config`) and is rendered into the prompt per-turn in `stream_turn`
|
||||
via `_append_motivational_context_section`, before the memory-context section.
|
||||
- **INV-187-6 (fear-signal-shape)**: fears carry `trigger_signals`; goals carry
|
||||
`positive_signals` + `negative_signals` (matches the `GoalConfig`/`FearConfig`
|
||||
substrate).
|
||||
- **INV-187-7 (tier-uniformity)**: the render reuses `core.persona.goals.load_goals`
|
||||
+ `render_motivational_context`, so a Tier 3 motivational config produces a
|
||||
byte-identical block to an equivalent Tier 1 `motivation.yaml`.
|
||||
- **INV-187-8 (storage)**: persisted in `consumer_agents.tier3_layers_json` under
|
||||
the `"motivational"` key; round-trips via `ConsumerAgent.motivational`; null/omitted
|
||||
→ `None` (no fabricated defaults; no migration).
|
||||
|
||||
### Audit
|
||||
|
||||
`agents.define` audit `extra` gains `presence_motivational: bool` alongside
|
||||
`presence_persona` / `presence_memory`.
|
||||
|
||||
## Amendment — Tier 3 PATCH mutability policy (issue #188, Phase 2.3)
|
||||
|
||||
Settles which Tier 3 agent fields are editable post-define. #197 deleted the
|
||||
STM tier between this issue's filing (2026-05-19) and its implementation, so the
|
||||
"mutable memory dials" the original issue envisioned no longer exist; the policy
|
||||
collapses to: `system_prompt` + `model` mutable, everything else fixed, with
|
||||
`valence` distinguished from the immutable traits by error code. No new
|
||||
endpoint, no new storage, no new invariant philosophy — a clarification +
|
||||
error-code alignment + audit enrichment over the Phase 2.0 PATCH baseline.
|
||||
|
||||
- **INV-188-1 (valence-deferred-in-patch)**: `PATCH /agents/<id>` carrying a
|
||||
`valence` key (any value, including `null`) → 422 `layer_deferred` with
|
||||
`field: "valence"`, matching define-time (INV-181-3). Rationale: valence is
|
||||
a layer that does not exist yet, not a real-but-frozen trait; `layer_deferred`
|
||||
is the truthful reason and gives consumers ONE code for "valence unavailable"
|
||||
across both define and PATCH. The check precedes the DB lookup (INV-181-5/6
|
||||
ordering), so a `valence` PATCH against a missing agent still 422s, not 404s.
|
||||
- **INV-188-2 (memory-wholesale-immutable-in-patch)**: `PATCH` carrying a
|
||||
`memory` key → 422 `field_not_mutable` with `field: "memory"`, rejected at the
|
||||
WHOLE-field level. No sub-field carve-out exists: `stm_capacity` /
|
||||
`stm_token_budget` are deprecated no-ops post-#197, `allows_world_scope` is
|
||||
create-time-only (toggling it after memory is written breaks scope-visibility
|
||||
invariants — memory scope policy must be fixed before any memory is written),
|
||||
and `embedder_version` is library-pinned. A real LTM tuning dial would warrant
|
||||
a deliberate per-sub-field PATCH contract at that time; pre-splitting for dead
|
||||
fields is not done. NOTE the deliberate define/PATCH asymmetry: `define`
|
||||
accept-and-ignores deprecated `stm_*` (201 + DeprecationWarning per
|
||||
INV-197-19), but `PATCH memory:{...}` rejects wholesale (422). Acceptable
|
||||
transitional artifact; disappears when the shims are removed.
|
||||
- **INV-188-3 (patch-audit-before-after)**: a successful `agents.patch` audit
|
||||
event's `extra.changes` records before/after for each mutated field —
|
||||
`model: {before, after}` (literal values; allowlist enum, not PII) and
|
||||
`system_prompt: {before_bytes, after_bytes}` (byte-length only; raw prompt
|
||||
content is excluded as potential PII, consistent with `emit_consumer_agent_event`'s
|
||||
exclusion rule). `changes` contains only keys for fields actually present in
|
||||
the PATCH payload. `patched_fields` (the Phase 2.0 name list) is retained.
|
||||
- **INV-188-4 (mutable-surface-unchanged)**: the mutable surface stays exactly
|
||||
`system_prompt` + `model` (per INV-181 Phase 2.0). PATCH re-enforces the
|
||||
define-time `system_prompt` byte-cap and `model` allowlist. #188 does NOT add
|
||||
model-swap capability/context-window validation — that gap (a swap to a
|
||||
smaller-context or non-tool model with no re-check of the existing prompt) is
|
||||
tracked as a separate follow-up (#219), not folded here.
|
||||
|
||||
## Amendment — model-assignment advisory warnings (issue #219)
|
||||
|
||||
`POST /agents/define` and `PATCH /agents/<id>` attach a best-effort, **non-
|
||||
blocking** `warnings` array to their 2xx response when the assigned `model`
|
||||
carries metadata risk (smaller context window, unknown window, or an explicit
|
||||
capability downgrade). This is advisory-only by deliberate design: hard
|
||||
rejection was rejected (Heid panel + operator, 2026-05-29) because model
|
||||
metadata coverage is partial (`context_window` is 0/unknown for several
|
||||
allowlisted models; `supports_tools` defaults true), the stored `system_prompt`
|
||||
cap is bytes not tokens, Tier 3 agent rows store no tool/modality usage (tools
|
||||
arrive per-session via Bifrost, so any capability concern is inherently
|
||||
conditional), and runtime already classifies the real failure as
|
||||
`CONTEXT_OVERFLOW`. The warning is a receipt-note for the owner who just made a
|
||||
deliberate change, not a correctness gate.
|
||||
|
||||
- **INV-219-1 (advisory-not-blocking)**: neither define nor PATCH ever rejects
|
||||
on context-window or capability grounds. The allowlist check
|
||||
(`model_not_available`) and `system_prompt` byte-cap are the only model-
|
||||
related *rejections*; everything in #219 is a warning on an otherwise-2xx
|
||||
response. Correctness for over-budget prompts remains the runtime
|
||||
`CONTEXT_OVERFLOW` guard.
|
||||
- **INV-219-2 (bounded-warning-codes)**: the closed code set is exactly —
|
||||
`model_context_window_unknown` (severity `info`): the assigned model's
|
||||
registry `context_window` is `0`/absent; `model_context_window_smaller`
|
||||
(severity `warning`): prior and new model both have known windows and
|
||||
new < prior (`details: {before, after}`); `model_capability_downgrade`
|
||||
(severity `warning`): the new model EXPLICITLY drops a capability the prior
|
||||
model advertised — `supports_tools`, `vision`, or `audio` (`details:
|
||||
{dropped: [...]}`). No token-aware "prompt won't fit" code — deferred until
|
||||
tokenizer-aware estimation exists; messages never claim a hard fit/failure.
|
||||
- **INV-219-3 (when-evaluated, resulting-pair)**: warnings are computed
|
||||
whenever a model is *assigned*. At define, always (prior = None → only
|
||||
`model_context_window_unknown` can apply, since the comparative codes need a
|
||||
prior). At PATCH, only when the payload carries a `model` key whose value
|
||||
differs from the stored model (prior = stored model); a PATCH without `model`
|
||||
(e.g. `system_prompt`-only) emits no model warnings. The comparison is always
|
||||
against the *resulting* model.
|
||||
- **INV-219-4 (capability-downgrade)**: a `model_capability_downgrade` fires
|
||||
only when BOTH prior and new models resolve to registry `ModelInfo` AND the
|
||||
new model's *effective* capability flags lack one the prior advertised
|
||||
(`supports_tools`, `vision`, or `audio`). The "both resolve" guard is the
|
||||
false-positive defense — an unresolvable model on either side yields no
|
||||
downgrade claim. Beyond that, comparison uses the registry's **effective**
|
||||
flags, which is asymmetric by capability because the data model collapses
|
||||
absent-to-default and does not preserve a "was this declared?" bit:
|
||||
- `supports_tools` defaults **true** (`ModelInfo` / `_build_model_info`), so
|
||||
a tools-drop requires the new catalog entry to set `supports_tools: false`
|
||||
*explicitly* — omission never triggers it.
|
||||
- `vision` / `audio` default **false** (`ModelCapabilities`), so a drop is
|
||||
detected whenever the prior advertised the capability and the new model does
|
||||
not carry it — whether the new entry says `false` explicitly OR omits it.
|
||||
This is the deliberate conservative reading: an undeclared modality is
|
||||
treated as unsupported. (A vision-capable model with sloppy metadata that
|
||||
omits its `vision` flag would thus be reported as a downgrade; the remedy is
|
||||
to declare the flag in the catalog, not to suppress the advisory.)
|
||||
|
||||
Message phrasing is conditional ("if your sessions rely on these, e.g. Bifrost
|
||||
tools, they may be rejected") — the agent row does not record whether tools or
|
||||
modalities are actually used, so every capability warning is advisory by
|
||||
nature.
|
||||
- **INV-219-5 (inline-response-shape)**: the `warnings` array is added inline to
|
||||
the define (201) and PATCH (200) response bodies — the existing flat
|
||||
`ConsumerAgentResponse` dict gains a `warnings` key (always present, `[]` when
|
||||
none). It is NOT added to the shared `ConsumerAgentResponse` pydantic model
|
||||
nor to `GET /agents/<id>` — only the two mutation handlers merge it into their
|
||||
returned dict, keeping persisted fields and the read path unchanged. Each
|
||||
entry is `{code, severity, message, details}`.
|
||||
- **INV-219-6 (single-helper)**: a single pure helper
|
||||
`compute_model_swap_warnings(*, prior_model: str | None, new_model: str,
|
||||
registry)` is the only source of warning logic; both define and PATCH call
|
||||
it. It tolerates unresolvable specs / `None` `ModelInfo` / `context_window`
|
||||
`0` by treating them as "unknown" (emitting the unknown-window info code where
|
||||
applicable, never raising). Metadata improvements over time sharpen the
|
||||
warnings with no API or signature change.
|
||||
|
||||
@@ -0,0 +1,268 @@
|
||||
# Ratatoskr v1 coverage map
|
||||
|
||||
_The v1 convergence-target ledger. Ratatoskr has **no self-defined feature
|
||||
roadmap**: v1 = consume all of Worldtree's I/O points, reached when Worldtree
|
||||
hits 1.0 (operator, 2026-06-19; auto-memory
|
||||
`project-ratatoskr-v1-derived-from-worldtree-io-coverage`). This file is that
|
||||
coverage map — every Worldtree v1-frozen I/O point × ratatoskr's coverage
|
||||
status, so "are we at v1?" is a ledger lookup, not a judgement call._
|
||||
|
||||
**First authored:** 2026-06-30 (the v1 coverage-audit kickoff).
|
||||
|
||||
---
|
||||
|
||||
## Frozen target
|
||||
|
||||
Worldtree is at **v1.0.0b2** — approaching 1.0, with its wire surfaces now
|
||||
**FROZEN** (Worldtree `docs/v1-schema-freeze-manifest.md`, #326). The audit
|
||||
anchors against the frozen machine-readable artifacts, NOT the prose markdown:
|
||||
|
||||
| Worldtree v1 surface | Frozen anchor | Ratatoskr role |
|
||||
|---|---|---|
|
||||
| Conversation REST API | OpenAPI `info.version` **2.3.0** (`Worldtree/docs/conversation-api-openapi.json`, sha `36148179…`) — **41 path×method groups** (2.3.0 added `POST /sessions/{id}/history`, #347) | **client** (debug TUI / web) |
|
||||
| Conversation SSE events | `conversation-api-sse-events.schema.json` (sha `9deeebf4…`) — **11 discriminated event types** | **client** |
|
||||
| Bifrost wire (consumer protocol) | wire **v0.6** STABLE/FROZEN (`bifrost==1.0.0`) — memory + affect planes | **provider** (Worldtree dispatches into us) |
|
||||
|
||||
> **Pin drift (finding P-1) — REMEDIATED 2026-06-30.** Ratatoskr formerly
|
||||
> vendored only the **prose markdown** (`docs/conversation-api-spec.md`), which
|
||||
> is byte-identical to live Worldtree's but frozen at v0.35.16-era content (last
|
||||
> WT edit 2026-05-31) and does **not** document the b2 surface (7 endpoints
|
||||
> below, the 409/503 on messages-POST #331, the unified error envelope #328, the
|
||||
> SSE schema). Remediated: the **OpenAPI 2.2.0 + SSE-schema JSON are now vendored
|
||||
> and pinned** (`.corviduo-canonicals.toml` → `canonical_drift.py` gate); the
|
||||
> prose markdown is the `tolerate_drift` reference. Spec pin advanced to
|
||||
> 5810a26 (v1.0.0b2). See § Pin remediation.
|
||||
|
||||
**7 endpoints new in b2 OpenAPI, absent from our vendored markdown:**
|
||||
`/admin/keys/bulk`, `/admin/persona/archive`, `/admin/persona/erase`,
|
||||
`/admin/usage`, `/embed`, `/judgments`, `/me/usage`.
|
||||
|
||||
---
|
||||
|
||||
## Scorecard
|
||||
|
||||
**Scope mandate: A (ledger-mandate), locked by operator 2026-06-30.** v1 "done"
|
||||
= every frozen I/O point is **classified** (covered or excluded-with-rationale),
|
||||
zero unaccounted. NOT "feature-complete client." All scope-pending rows are now
|
||||
resolved (§ Surface 1, scope-resolution table).
|
||||
|
||||
| Surface | Points | ✅ covered-live | ⬜ gap (in-scope) | 🚫 excluded-by-design |
|
||||
|---|---|---|---|---|
|
||||
| REST (OpenAPI 2.3.0, path groups) | 41 | 19 | 0 | 22 |
|
||||
| SSE events | 11 | 11 | 0 | 0 |
|
||||
| Bifrost provider planes | 8 verbs | 8 | 0 | (10 gated verbs deferred) |
|
||||
|
||||
**Legend.** ✅ consumed in code AND live-proven against real Worldtree · ⬜ a
|
||||
debug-observability I/O point we should cover but don't yet (the convergence
|
||||
frontier) · 🚫 deliberate non-goal per the design-brief negative clauses + the A
|
||||
mandate. Counts are at the **path-group** level; mixed-method groups are
|
||||
footnoted (e.g. `/sessions` POST is ✅ but its `GET` picker is an unwired
|
||||
sub-gap).
|
||||
|
||||
---
|
||||
|
||||
## Surface 1 — Conversation REST API (OpenAPI 2.3.0)
|
||||
|
||||
### Covered — client path (ratatoskr's core identity)
|
||||
|
||||
| Endpoint | Status | Where consumed | Note |
|
||||
|---|---|---|---|
|
||||
| `POST /sessions` | ✅ | `sessions.py:307` → `cli.py:482`,`tui.py:1508`,`web/server.py:155` | + `end_user_id`, `bifrost` binding; 404→AgentNotFound, 502→BifrostHandshakeFailed |
|
||||
| `POST /sessions/{id}/messages` (turn stream, SSE) | ✅ | `sse_client.py:484` `stream_turn` → cli/tui/web | the primary surface; 409→AgentNotAvailable, 503→TurnLaunchUnavailable (b2 #331) |
|
||||
| `POST /sessions/{id}/history` (authored-history-write, #347) | ✅ | `sessions.py:583` `write_authored_history` → `cli.py:758` `--seed-first-message` | v1: author=assistant, effects=none, per-session idempotency; 404→AuthoredHistoryUnavailable (hide-existence: feature-absent, never probe); 409/422 mapped. **LIVE-PROVEN 2026-07-06** on personal :8081 (grant applied via a rule-based Heimdall allow, worldtree-dev): create mimir session → seed → **201** (seq=0, phase=seeded, turn_id=1798) → GET /messages reads it back as a plain role=assistant turn (model-invisible provenance confirmed). Hide-404 for ungranted is unit+probe covered |
|
||||
| `GET /sessions/{id}/messages` (history) | ✅ | `sessions.py:635` `get_session_messages` → `cli.py:758` `--seed-first-message` read-back | un-deferred as the #347 seed read-back — confirms model-invisible provenance (a seed reads back as a normal `role=assistant` turn) |
|
||||
| `POST /sessions/{id}/turns/{turn_id}/cancel` | ✅ | `sse_client.py:581` → cli/tui/web | two-stage Ctrl-C; 404/409 mapped |
|
||||
| `GET /agents` | ✅ | `sessions.py:341` → `tui.py:1472`,`web/server.py:100` | Tier-1 roster; merged with local index |
|
||||
| `GET /agents/{id}/persona_state` | ✅ | `sessions.py:384` → `tui.py:1132`,`web/server.py:386` | persona hydrate; 404/403 mapped |
|
||||
| `POST /agents/define` | ✅ | `tier3.py:175` → `_run_define` | Tier-3 create |
|
||||
| `PATCH /agents/{id}` | ✅ | `tier3.py:219` → `_run_patch` | Tier-3 mutate (system_prompt/model) |
|
||||
| `DELETE /agents/{id}` | ✅ | `tier3.py:242` → `_run_delete` | Tier-3 hard-delete |
|
||||
| `GET /me` | ✅ | `sessions.py:411` `get_me` → `cli.py` `--whoami` | identity/whoami probe; 401→SessionApiFailed |
|
||||
| `GET /capabilities` | ✅ | `sessions.py:428` `get_capabilities` → `cli.py` `--whoami` | Echo ephemeral-template discovery |
|
||||
| `GET /sessions/{id}/tools` | ✅ | `sessions.py:411` `get_session_tools` → `tui.py` `_hydrate_session_tools` | owner-scoped tool inventory in the TUI Tools pane (#183) |
|
||||
| `GET /admin/sessions/{id}/bifrost` | ✅ | `sessions.py:428` `get_session_bifrost` → `tui.py` `_hydrate_bifrost_state` | admin-scoped BifrostState pane (#176); admin key (`RATATOSKR_ADMIN_API_KEY`); live-auth-proven |
|
||||
| `GET /admin/events` (SSE) | ✅ | `sse_client.py` `stream_admin_events` → `tui.py` `_stream_admin_events` | admin lifecycle SSE stream (#11), session-filtered AdminEvents pane; admin key; live-auth-proven |
|
||||
| `GET /models/available-for-characters` | ✅ | `sessions.py` `list_character_models` → `cli.py` `--characters` | character-capable model profiles (#161) |
|
||||
| `POST /characters` | ✅ | `sessions.py` `create_character` → `cli.py` `--characters` | create transient character (#161) |
|
||||
| `GET /characters/{id}/state` | ✅ | `sessions.py` `get_character_state` → `cli.py` `--characters` | live character PAD/emotions (#161) |
|
||||
| `DELETE /characters/{id}` | ✅ | `sessions.py` `delete_character` → `cli.py` `--characters` | remove transient character (#161) |
|
||||
| `POST /sessions/{id}/persona_state` | ✅ | `sessions.py` `set_persona_state` → `cli.py` `--set-persona-pad` | persona-state write / affect injection (freeform body — unpinned in the frozen surface) |
|
||||
|
||||
**Sub-gaps inside ✅ path groups** (the method we use is live; a sibling method
|
||||
on the same path is an unwired frontier item — see frontier Tier 1):
|
||||
- `GET /sessions` — `sessions.py:198` `list_sessions` exists, **no caller**: the
|
||||
startup session-picker (design-brief §4 v1) was never wired.
|
||||
- `POST /sessions/{id}/messages` + `Last-Event-ID` — `sse_client.py:524`
|
||||
`reconnect_turn` exists, **no caller**: the reference SSE-resume impl
|
||||
(design-brief §8d) was never wired.
|
||||
- `GET /agents/{id}` — consumer-agent lookup (`GET /agents/<owner>:<name>` with
|
||||
the owner key) is **manual-curl-only**, not in code.
|
||||
|
||||
### In-scope gaps — CONVERGED (re-closed 2026-07-06 after the #347 re-open)
|
||||
|
||||
**Every in-scope REST I/O point is covered.** The audit first converged
|
||||
2026-07-01; Worldtree's #347 (authored-history-write, OpenAPI 2.3.0) then added
|
||||
one new in-scope path-group, re-opening the audit with a single gap — now closed
|
||||
(`v0.19.6`). The original frontier (design-brief §5 observability panes +
|
||||
presenter-wiring sub-gaps + Tier-2 tail) remains fully closed:
|
||||
|
||||
- Session picker + SSE-resume — wired (`v0.18.5`–`.7`).
|
||||
- Persona · Tools · BifrostState · AdminEvents panes — all built + live (`v0.18.x`–`v0.19.0`).
|
||||
- Transient-characters CRUD + persona-state write — consumed via `--characters` /
|
||||
`--set-persona-pad` (`v0.19.1`).
|
||||
- Authored-history-write (#347) + messages read-back — `write_authored_history` +
|
||||
`get_session_messages` via `--seed-first-message` (`v0.19.6`; live-proof pending
|
||||
the `session.history.write` grant).
|
||||
|
||||
The only remaining not-consumed in-scope method is `GET /agents/{id}` (consumer-
|
||||
agent lookup, manual-curl-only) — a sub-method on an already-✅ path group, not a
|
||||
path-group gap. Everything else is covered or excluded-by-design below.
|
||||
|
||||
### Excluded by design — the design-brief negative clauses
|
||||
|
||||
| Endpoint(s) | Status | Rationale (design-brief / memory) |
|
||||
|---|---|---|
|
||||
| `PATCH /sessions/{id}` · `DELETE /sessions/{id}` | 🚫 | §4: rename/delete happen outside the tool (`sessions_cli.py`) |
|
||||
| `GET /sessions/{id}` | 🚫 | session detail — identity is footer-visible, no detail view |
|
||||
| `GET /sessions/{id}/tool-events` | 🚫 | §5: tool calls observed **inline from SSE** `tool_start`/`tool_result`; persisted-events endpoint is opt-in only |
|
||||
| `GET /admin/sessions/{id}/tools` | 🚫 | **covered-by-alternative** — the owner-scoped `GET /sessions/{id}/tools` (✅) serves the Tools inventory; this admin variant is only for cross-user operator debug, out of the single-session focus (§6) |
|
||||
| `GET/POST /admin/keys` · `DELETE/POST /admin/keys/{id}` · `POST /admin/keys/{id}/rotate` · `DELETE/POST /admin/keys/bulk` · `POST /admin/keys/bulk/rotate` | 🚫 | §6: **NOT a Worldtree-admin tool** (key mgmt) |
|
||||
| `POST /admin/sessions/{id}/retire` | 🚫 | admin session mutation |
|
||||
| `POST /admin/persona/{archive,erase}` | 🚫 | admin persona GDPR ops (new in b2) |
|
||||
| `POST /admin/users/{id}/tier` | 🚫 | admin user mgmt |
|
||||
| `GET /me/usage` · `GET /admin/usage` | 🚫 | usage metering — not turn-flow observability (new in b2) |
|
||||
| `GET /healthz` · `GET /readyz` | 🚫 | liveness probes — low debug value (could become a connect preflight; park) |
|
||||
| `GET /search` | 🚫 | §5: consumer-product feature, not turn-flow (was "defer to v2") |
|
||||
| `GET/POST /uploads` · `DELETE/GET /uploads/{id}` | 🚫 | §6: no uploads — consumer-product feature |
|
||||
| `GET /pending` · `GET /sessions/{id}/pending` | 🚫 | §5: poll-only, no turn-flow signal (was "optional, skip") |
|
||||
| `POST /embed` | 🚫 | embedding utility — no turn flows through it |
|
||||
| `POST /judgments` | 🚫 | LLM-as-judge A/B eval (`response_a`/`response_b`/`rubric`) — standalone eval utility, not turn-flow |
|
||||
|
||||
### Scope-resolution record (the 11 ❓ rows, resolved under A)
|
||||
|
||||
The 2026-05-20 design-brief deferred several surfaces; the 2026-06-19 reframe
|
||||
("v1 = full I/O coverage") put them back in tension. **Resolved 2026-06-30 under
|
||||
mandate A** (debug-observability identity intact; classify, don't build-all):
|
||||
|
||||
| Endpoint(s) | Resolution |
|
||||
|---|---|
|
||||
| `GET /search` · `uploads` (×2) · `pending` (×2) · `POST /embed` · `POST /judgments` | 🚫 **excluded** — consumer-product / eval / poll utilities, not turn-flow observability |
|
||||
| `characters` (×4) · `POST /sessions/{id}/persona_state` | ⬜ **in-scope** (frontier Tier 2) — session-routing + affect-injection debug paths |
|
||||
|
||||
Nothing remains ❓. The ⬜-vs-🚫 line follows the debug-observability test: *does
|
||||
a turn flow through it / is it a layer worth watching live?*
|
||||
|
||||
---
|
||||
|
||||
## Surface 2 — SSE events (11/11 ✅)
|
||||
|
||||
Every frozen SSE event type is parsed in `sse_client.py:_envelope_for_type`
|
||||
(342-411) and rendered by all three presenters (cli/tui/web). **Full coverage.**
|
||||
|
||||
`text` · `worker_phase` · `thinking` · `text_boundary` · `tool_start` ·
|
||||
`tool_result` · `done` · `error` · `cancelled` · `awaiting_llm_first_token` ·
|
||||
`affect_update`
|
||||
|
||||
> Caveat (not a gap): `affect_update` is wire-verified to emit **zero** events
|
||||
> for consumer (Tier-3) agents — the persona-strip SSE path never populates for
|
||||
> them (memory 2026-06-18). The handler is correct; the upstream emitter is
|
||||
> silent. PAD for consumer agents is surfaced via our own provider read route
|
||||
> (`GET /affect/state/{id}`, #18 D2), not this event.
|
||||
|
||||
---
|
||||
|
||||
## Surface 3 — Bifrost provider planes (8/8 ✅, live-proven)
|
||||
|
||||
Ratatoskr **implements** the provider side; Worldtree dispatches into it.
|
||||
Live-proven end-to-end through real WT turns (#17/#18 smokes; combined `:8392`
|
||||
WT-driven smoke 2026-06-20).
|
||||
|
||||
**Memory plane** — covers the entire `bifrost.memory.MemoryDataStore` protocol
|
||||
(required: `describe_store`, `get`, `get_many`, `search`, `upsert_many`) **plus**
|
||||
`delete_many`:
|
||||
|
||||
| Verb | Where | |
|
||||
|---|---|---|
|
||||
| `describe_store` | `memory_store.py:140` | advertises caps (sync) |
|
||||
| `search` | `memory_store.py:224` | vector recall; scope_all AND / scope_any OR |
|
||||
| `get` / `get_many` | `memory_store.py:293` / `:305` | point reads |
|
||||
| `upsert_many` | `memory_store.py:150` | idempotent batch write; optimistic lock |
|
||||
| `delete_many` | `memory_store.py:314` | transactional delete |
|
||||
|
||||
**Affect plane** — covers `bifrost…InMemoryAffectStore` (`emit`, `fetch`):
|
||||
|
||||
| Verb | Where | |
|
||||
|---|---|---|
|
||||
| `emit` | `affect_store.py:47` | conduit-opaque snapshot upsert (LWW) |
|
||||
| `fetch` | `affect_store.py:116` | `{found, snapshot}`; mandatory since bifrost 0.10.0 strong-or-absent gate |
|
||||
|
||||
Plus the non-wire PAD read route `GET /affect/state/{agent_id}`
|
||||
(`affect_store.py:189`) and the combined `:8392` endpoint advertising both caps
|
||||
by store-presence (`combined.py:46`).
|
||||
|
||||
**Deferred-gated (advertised-unsupported, correctly out-of-scope for the basic
|
||||
plane):** `scan`, `get_edges_for`, `upsert_edges`, `mark_invalid`,
|
||||
`mark_superseded`, `patch_many`, `commit_checkpoint`, `lease_job`,
|
||||
`read_checkpoint`, `health`. These live only in the bifrost reference
|
||||
*extended* store, not the `MemoryDataStore` protocol; deferred per the #294
|
||||
re-scope (memory 2026-06-15). Re-evaluate only if Worldtree's Tier-3 path
|
||||
starts exercising them.
|
||||
|
||||
---
|
||||
|
||||
## Convergence frontier (the v1 to-do) — CLOSED 2026-07-01, re-closed 2026-07-06 (#347)
|
||||
|
||||
**Every in-scope I/O point is covered.** The frontier is empty: REST 19/41 ✅
|
||||
with **zero in-scope gaps** (the other 22 REST path-groups are excluded-by-design),
|
||||
SSE 11/11, Bifrost provider planes 8/8. v1 convergence (per scope A: "every
|
||||
frozen I/O point classified, zero unaccounted") is **met** — ratatoskr cuts v1
|
||||
when Worldtree tags 1.0. The arc, for the record:
|
||||
|
||||
**Tier 1 — debug-observability core:**
|
||||
|
||||
1. ✅ **DONE** — Session picker (`v0.18.7`) + SSE-resume (`v0.18.5`/`.6`).
|
||||
2. ✅ **DONE** — `GET /capabilities` + `GET /me` (`v0.18.8`, `--whoami`).
|
||||
3. ✅ **DONE** — BifrostState pane (`v0.18.10`, `GET /admin/sessions/{id}/bifrost`,
|
||||
admin-key; live-auth-proven). The Tools half was already covered by the
|
||||
owner-scoped `GET /sessions/{id}/tools` (item 5).
|
||||
4. ✅ **DONE** — AdminEvents pane (`v0.18.11`, `GET /admin/events` SSE,
|
||||
session-filtered; admin-key; live-auth-proven). #11's blocker was already
|
||||
satisfied (admin key carries `admin.events.read`). **Tier 1 complete** — the
|
||||
admin/debug-observability core (Persona · Tools · BifrostState · AdminEvents)
|
||||
is fully built.
|
||||
|
||||
**Tier 2 — rounds out coverage (all that remains):**
|
||||
|
||||
5. ✅ **DONE** — `GET /sessions/{id}/tools` (`v0.18.9`, owner-scoped tool inventory
|
||||
in the TUI Tools pane).
|
||||
6. ✅ **DONE** — Transient-characters CRUD (4 endpoints) + `POST /sessions/{id}/persona_state`
|
||||
(`v0.19.1`, `--characters` + `--set-persona-pad` one-shot probes). The last
|
||||
in-scope client I/O points.
|
||||
|
||||
---
|
||||
|
||||
## Pin remediation (finding P-1) — DONE 2026-06-30
|
||||
|
||||
Re-pinned to the frozen machine-readable artifacts (the chosen option):
|
||||
`conversation-api-openapi.json` (2.2.0) + `conversation-api-sse-events.schema.json`
|
||||
are vendored under `docs/` and pinned in `.corviduo-canonicals.toml`
|
||||
(`worldtree-conversation-api-openapi-v2`, `-sse-events-v1`), drift-gated by
|
||||
`canonical_drift.py`. The prose markdown stays as a `tolerate_drift` reference
|
||||
(`-spec-v1`). `pyproject.toml` spec pin advanced f1b59f8 → 5810a26 (v1.0.0b2);
|
||||
`docs/SPEC-PIN.md` records the bump. This map now audits a frozen, diffable
|
||||
target — re-running the audit is a `canonical_drift.py` check away.
|
||||
|
||||
---
|
||||
|
||||
## Decisions
|
||||
|
||||
1. **Scope mandate — RESOLVED 2026-06-30: A (ledger-mandate).** v1 "done" = every
|
||||
frozen I/O point classified, zero unaccounted; NOT feature-complete client.
|
||||
The ⬜-vs-🚫 line for the 11 formerly-pending rows is locked above (§
|
||||
Scope-resolution record).
|
||||
2. **Pin remediation (P-1) — RESOLVED 2026-06-30 (re-pin to machine-readable).**
|
||||
Vendored `conversation-api-openapi.json` (2.2.0) + `conversation-api-sse-events.schema.json`
|
||||
as the authoritative drift gates (pinned in `.corviduo-canonicals.toml`,
|
||||
`canonical_drift.py` green); prose markdown kept as `tolerate_drift`
|
||||
reference. Spec pin advanced f1b59f8 (v0.35.16) → 5810a26 (v1.0.0b2). This
|
||||
map now audits against a frozen, diffable target.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 521 KiB |
@@ -0,0 +1,270 @@
|
||||
# Design brief — `ratatoskr-web` (Worldtree wire monitor)
|
||||
|
||||
> **For:** a visual design pass (Claude Design). **Deliverable:** a single
|
||||
> self-contained HTML prototype, fully populated with representative static
|
||||
> data, that an engineer will wire live data into. **Do not** build a data
|
||||
> layer — build the *shell* and *every state*, beautifully, with placeholder
|
||||
> content in every slot.
|
||||
|
||||
---
|
||||
|
||||
## 1. What you're designing
|
||||
|
||||
`ratatoskr-web` is a **developer-grade debug/observability console** for a
|
||||
conversational-AI engine (Worldtree). Its tagline is *"wire monitor"*: you open
|
||||
a session with an AI agent, send it turns, and **watch that turn flow through
|
||||
every layer of the system at once** — the streaming response, the model's
|
||||
chain-of-thought, the tools it can call, the agent's live emotional/persona
|
||||
state, the provider handshake, and the engine's admin lifecycle events — all
|
||||
side-by-side on one screen.
|
||||
|
||||
**The product IS the observability surface. Chat is just the input.** This is
|
||||
not a chat app, not a marketing page, not an end-user product. The user is one
|
||||
developer (occasionally a few LAN peers) staring at a dense instrument to debug
|
||||
what the engine is doing. Think **oscilloscope / flight-data console / a well-lit
|
||||
`htop`**, not a messaging UI.
|
||||
|
||||
**Design values, in priority order:**
|
||||
1. **Information density earns the screen.** Every region shows live, changing
|
||||
data. Nothing is decorative filler. A quiet, legible, glanceable density is
|
||||
the whole point — the user reads six data streams at a glance.
|
||||
2. **Calm under motion.** Multiple regions update in real time (token streams,
|
||||
live metrics, event logs). The design must stay readable while things move —
|
||||
no jitter, no attention-grabbing per-item animation. Motion is for *state
|
||||
change*, used sparingly.
|
||||
3. **Legibility first.** Monospace, high contrast where it counts, generous but
|
||||
not wasteful spacing. This runs for hours; it must not tire the eye.
|
||||
|
||||
---
|
||||
|
||||
## 2. Aesthetic direction — Australis
|
||||
|
||||
Use the **Australis design system** (a cool-toned, terminal-first dark theme —
|
||||
the `australis-design` skill has the canonical tokens: colors, spacing, radii,
|
||||
shadows, motion). Import/inline `colors_and_type.css`; don't reinvent tokens.
|
||||
|
||||
Non-negotiables from the brand:
|
||||
- **Dark only.** Base is a cool near-black **`#222531` — never pure `#000`.**
|
||||
The eye rests in low-contrast cool grey; **emphasis comes from *brightness*,
|
||||
not saturation.** Layer surfaces up the Sea neutral ramp (`#222531 →
|
||||
`#373b46` → `#414751`).
|
||||
- **Palette families:** *Ice* (surface neutrals), *Aurora* (blue → cyan → green,
|
||||
the primary accents — used generously in that preference order), *Dawn*
|
||||
(red/yellow/magenta — sparingly, for status only). Semantic: info=blue,
|
||||
success=green, warning=yellow, danger=red.
|
||||
- **The signature motif is the aurora glow** — a low-opacity cyan→blue→green
|
||||
light coming *through* the top of the screen, plus a 3px aurora focus ring on
|
||||
interactive controls. Lean into this as the one memorable thing.
|
||||
- **No noise, no textures, no patterns.** *"The screen is the polar sky — empty,
|
||||
with light coming through it."* The one sanctioned gradient is the aurora glow.
|
||||
- **Never a colored left-border on cards** (the LLM-slop trope). Featured cards
|
||||
accent the *top* edge instead.
|
||||
- **Type:** this instrument is **mono-first** — that IS on-brand for Australis
|
||||
("terminal-first"). Use a monospace stack (JetBrains Mono / system mono; see
|
||||
§9 — no web-font CDN allowed). Eyebrows/labels are **mono, UPPERCASE, ~11px,
|
||||
wide-tracked (`0.08–0.16em`)** — use them liberally; they're a system
|
||||
signature.
|
||||
- **Motion:** calm, never bouncy. ~120ms hover, ~200ms state, ~320ms panels.
|
||||
Focus = aurora glow ring. Hover = one step *brighter* (not lower opacity).
|
||||
A slow (8–14s) aurora drift on a hairline top band is welcome; nothing else
|
||||
should loop.
|
||||
|
||||
The current UI already borrows this palette — you're not inheriting it, you're
|
||||
**redesigning the layout and craft from scratch** with the brand as the guide.
|
||||
Feel free to rethink the spatial composition entirely (see §10).
|
||||
|
||||
---
|
||||
|
||||
## 3. The two screens
|
||||
|
||||
### Screen A — **Session setup** (entry)
|
||||
A single centered card on the aurora canvas. Fields:
|
||||
- **Agent** — a `<select>` (populated live; show 3–4 sample options incl.
|
||||
`ratatoskr:sindra`, `forseti`, `mimir`).
|
||||
- **Bifrost binding (Tier-3 provider)** — a `<select>`: `combined (:8392)` /
|
||||
`none — observe only` / `memory (:8391)` / `affect (:8390)`.
|
||||
- **Open session** — primary button.
|
||||
- An error line (design the error state too — e.g. "agent not available").
|
||||
|
||||
### Screen B — **Live workspace** (the main event — 95% of the design effort)
|
||||
Persistent top bar + status line spanning full width; between them a **two-region
|
||||
body: a conversation column (left, dominant) and a telemetry column (right,
|
||||
tabbed).** Current split is ~1.85 : 1 — you may re-proportion. The information
|
||||
inventory below is exhaustive; **every item needs a home.**
|
||||
|
||||
---
|
||||
|
||||
## 4. THE COMPLETE INFORMATION INVENTORY
|
||||
|
||||
This is the core of the brief. Design a slot for **every** item, in a sensible
|
||||
state. Data shapes are given so your placeholders read true.
|
||||
|
||||
### 4.1 Top bar (persistent)
|
||||
| Item | Shape / example | Notes |
|
||||
|---|---|---|
|
||||
| Brand | `ᛯ ratatoskr` + eyebrow `WIRE MONITOR` | the mark is a rune glyph; small |
|
||||
| **Connection status** | one of: `offline`, `connected` (idle), `streaming`, `error` | dot + label; **streaming pulses**; color-coded (grey/green/cyan/red) |
|
||||
| **Persona strip** (appears after a session hydrates) | dominant-emotion word (`love`) + **PAD bars**: `P`, `A`, `D` | each PAD bar is **bipolar** — centered on 0, fills left (negative) or right (positive), value ∈ [−1, 1]; **live-updates every turn** |
|
||||
| Session identity | `ratatoskr:sindra · …381b99f4` | agent id + last-8 of session id |
|
||||
| Bound-plane badge (when bound) | `⇄ combined http://10.100.10.50:8392` | plane + endpoint; only when a Bifrost binding is active |
|
||||
|
||||
### 4.2 Conversation column (the transcript + composer)
|
||||
The transcript is a scrollable stream of turns. Design each element:
|
||||
|
||||
| Element | Example content | Notes |
|
||||
|---|---|---|
|
||||
| **Turn divider** | `TURN 3` between hairlines | uppercase eyebrow, rule lines each side |
|
||||
| **User prompt echo** | `❯ what's your intensity setting?` | the user's message, accent-marked |
|
||||
| **Assistant response** | streaming **Markdown** (headings, bold, italic, `code`, lists, quotes, links) | accumulates token-by-token while live; distinct "live" treatment vs settled |
|
||||
| **Seeded first-message** | a full assistant turn present *before the user speaks* (an authored greeting) | renders **identical to a lived assistant turn** — the session can OPEN already showing the agent's opener |
|
||||
| **Reasoning / "thinking" note** | `✦ sindra is reasoning···` (italic) | **ephemeral** app affordance — appears while the model reasons, vanishes the instant real text begins; visually distinct from the response so it never reads as engine output |
|
||||
| **Awaiting-first-token** | `···` animated | heartbeat before the first token |
|
||||
| **End-of-turn status chips** | `✓ DONE 1.84s` · `✗ ERROR agent_not_available` · `⚠ CANCELLED` · `✗ WIRE lost` | small bordered chips; color per state |
|
||||
| **Composer** (pinned bottom) | `❯ [ message input ] [SEND]` | Enter=send, Shift+Enter=newline; during a turn the Send button becomes **CANCEL** (amber) |
|
||||
|
||||
### 4.3 Telemetry column (six tabbed panes)
|
||||
A tab bar + a pane header (with a **Copy** button) + the active pane body.
|
||||
|
||||
**Tabs** (each: name · keybinding hint · a count **badge** that *flashes* on new
|
||||
data): `TOOLS ^1` · `DEBUG ^2` · `THINK ^3` · `PERSONA ^4` · `BIFROST ^5` ·
|
||||
`ADMIN ^6`. Active tab is accent-marked.
|
||||
|
||||
Pane contents — design each, populated:
|
||||
|
||||
1. **Tools** — the tool inventory the model saw at turn-fire:
|
||||
`agent_id`, `builtin_tools[]` (names), `bifrost_tools[]` (name + description +
|
||||
parameters). Below it, **live tool-call events** stream in (`tool_start` →
|
||||
`tool_result`) as the turn runs. Empty state: `— live tool events —`.
|
||||
2. **Debug** — a raw structured op/lifecycle log (mono lines; new lines flash
|
||||
once). Think `tail -f`.
|
||||
3. **Think** — the model's **full chain-of-thought**, per-turn dividers,
|
||||
live-Markdown. Longer prose than the response.
|
||||
4. **Persona / affect** — *the richest pane.* Contains:
|
||||
- **The canonical NL directive** the engine injects into the agent's context
|
||||
— the literal text: a **mood descriptor** ("neutral", "faintly excited",
|
||||
±0.3 bands) + a **relationship directive**. Show this verbatim, quoted.
|
||||
- **PAD mood point** — pleasure / arousal / dominance current values.
|
||||
- **relations[]** — for each related entity (e.g. the user): **trust**
|
||||
(ability / benevolence / integrity), **warmth**, **agency**,
|
||||
`relation_context` (a tie-type word like "stranger" / "expressive"), each as
|
||||
a **metric row**: `label · value · Δ-since-last (▲/▼) · unicode sparkline ·
|
||||
n (evidence count) · descriptor`. Values are 0–1 with 2–3 decimals.
|
||||
- **dominant_emotion** (an OCC type: joy/anger/fear/…) + **emotions_active[]**.
|
||||
- Design the **metric row** as a reusable component — it's the densest,
|
||||
most-repeated element in the whole UI. Tabular-aligned numbers, a tiny
|
||||
inline sparkline, a subtle up/down Δ.
|
||||
5. **Bifrost** — the live provider binding (admin-gated): `endpoint`,
|
||||
`connected` (bool), `capabilities_granted[]`, `consumer_id`, `tools[]`.
|
||||
**Self-labeling states:** `not configured` (no admin key) / `not bound`
|
||||
(session has no live binding) / an auth-denied state.
|
||||
6. **Admin events** — a live event log of the engine's lifecycle broadcast
|
||||
(a ~17-type vocabulary: `turn.started`, `session.created`, `system.*`, …),
|
||||
filtered to the active session. Streaming; timestamped lines.
|
||||
|
||||
### 4.4 Status line (persistent, bottom)
|
||||
- **Keybinding legend:** `Enter send · ⇧Enter newline · ^1–^6 panes · ^C cancel`
|
||||
(rendered as little `kbd` chips).
|
||||
- **Version:** `ratatoskr 0.19.9` (right-aligned).
|
||||
|
||||
---
|
||||
|
||||
## 5. States to design (show these explicitly)
|
||||
|
||||
Provide a mock (or a toggle) for each — these are where debug UIs live or die:
|
||||
|
||||
- **Setup:** loading-agents · ready · create-error.
|
||||
- **Connection:** offline · connected/idle · streaming (pulsing) · wire-error.
|
||||
- **Turn lifecycle:** awaiting-first-token · reasoning (✦) · streaming response ·
|
||||
done (+timing chip) · error · cancelled.
|
||||
- **Panes:** empty/placeholder · hydrated/dense · **not-configured** (admin key
|
||||
absent) · **not-bound** (Bifrost) · error · a **badge flash** on new data.
|
||||
- **Persona pane specifically:** a fully-populated relations block AND a
|
||||
cold/empty one (a fresh agent with no accumulated state).
|
||||
|
||||
---
|
||||
|
||||
## 6. Interaction & motion
|
||||
|
||||
- **Real-time is the defining trait.** The response + thinking panes stream
|
||||
token-by-token; the metric rows tick; event logs append; the persona strip
|
||||
re-animates each turn. Design so all of this is *calm* — the reader's eye
|
||||
isn't yanked around. Reserve motion for genuine state transitions
|
||||
(turn-start, done, a new event) and keep it short.
|
||||
- **Keyboard-first.** `^1–^6` switch panes; `Enter`/`⇧Enter`/`^C` drive the turn.
|
||||
Panes are also clickable. Show focus states.
|
||||
- **The aurora glow is the interaction signature** — focus rings, the top band,
|
||||
the connection pulse, the primary-button hover. Make it the thing someone
|
||||
remembers.
|
||||
- **Copy-to-clipboard** on each pane header (with a copied-confirm state).
|
||||
|
||||
---
|
||||
|
||||
## 7. Layout — you have latitude
|
||||
|
||||
The current layout is a fixed two-column split. **You may rethink it** — as long
|
||||
as every §4 item has a legible home and the density stays high. Directions worth
|
||||
exploring (pick one, commit):
|
||||
- A **command-console** feel: a slim persistent left rail of "instruments," a
|
||||
dominant conversation center, a right telemetry stack.
|
||||
- A **grid of live tiles** (the metrics/panes as a dashboard) with the
|
||||
conversation as the anchor column.
|
||||
- The **classic monitor** split, but with far better hierarchy, grouping, and
|
||||
breathing room than today.
|
||||
|
||||
Desktop-first; design at **1440–1512px** wide. Graceful down to ~1100px is a
|
||||
plus (this runs on a dev laptop). No mobile.
|
||||
|
||||
---
|
||||
|
||||
## 8. Deliverable — what to hand back
|
||||
|
||||
**A single self-contained `index.html`** (inline `<style>` + `<script>`; see §9
|
||||
constraints) that:
|
||||
1. Renders **Screen A** and **Screen B** (a toggle/hash is fine).
|
||||
2. Has **representative static placeholder data in every §4 slot** and shows the
|
||||
key §5 states (either multiple mocks or lightweight JS toggles). I want to see
|
||||
the design *fully populated and dense*, not empty scaffolding.
|
||||
3. Uses **clean, semantic, stable hooks** — meaningful `id`s / `class`es /
|
||||
`data-*` on every dynamic slot (the transcript container, each pane body, the
|
||||
PAD bars, a metric-row template, the connection dot, the tab badges, etc.).
|
||||
This is how I wire real data in — treat the DOM structure as an API.
|
||||
4. Imports/inlines the Australis tokens; no invented palette.
|
||||
|
||||
I will then **swap your placeholder content for live `fetch()` + `EventSource`
|
||||
calls** against the real endpoints (§9). The cleaner and more component-shaped
|
||||
your DOM, the faster and safer that wiring is. A short note listing your mount
|
||||
points / how you'd expect data injected is very welcome.
|
||||
|
||||
---
|
||||
|
||||
## 9. Hard technical constraints (these make it wire-able)
|
||||
|
||||
- **Single file. No build step. No CDN. No external network at runtime.** This
|
||||
ships to an internal LAN and must work offline. That means: **no Google Fonts /
|
||||
no web-font CDN** (use a system monospace stack), no CDN JS/CSS libraries,
|
||||
everything inline. (Icons: use unicode glyphs `➜ ✓ ✗ ! ● ✦ ❯` or hand-inlined
|
||||
SVG — Australis uses Lucide-style 1.75-stroke line icons; inline them.)
|
||||
- **Vanilla HTML/CSS/JS.** No framework (the production app is framework-free
|
||||
vanilla JS). React/Vue prototypes can't be wired in.
|
||||
- **All dynamic text is escaped** on the real side (untrusted upstream content);
|
||||
assistant/reasoning bodies go through a safe-Markdown renderer (escape-first,
|
||||
whitelist subset). Don't design anything that depends on raw HTML injection.
|
||||
- **The real data contracts** (so your structure maps to the wire — you don't
|
||||
implement these, just leave homes for their outputs):
|
||||
- `GET /api/agents` → agent list (for the setup picker).
|
||||
- `POST /api/sessions {agent_id, bifrost_plane?}` → `{session_id, agent_id, bifrost?}`.
|
||||
- `GET /api/sessions/{id}/messages` → `{items:[{seq, role, content}], …}` (the transcript on open, incl. the seeded first-message).
|
||||
- `POST /api/turns/{id} {content}` → `{turn_id}`, then **`GET /api/turns/{id}/stream` (SSE)** — event vocab: `text`, `thinking`, `tool_start`, `tool_result`, `done`, `error`, `awaiting_llm_first_token`, terminal events. `POST /api/turns/{id}/cancel`.
|
||||
- `GET /api/sessions/{id}/tools` → tool inventory. `GET /api/sessions/{id}/bifrost` → binding state.
|
||||
- `GET /api/affect/{agent_id}` / `GET /api/agents/{id}/persona_state` → PAD + relations + dominant_emotion (the persona pane + strip).
|
||||
- **`GET /api/admin/events` (SSE)** → the admin lifecycle log.
|
||||
|
||||
---
|
||||
|
||||
## 10. Tone check
|
||||
|
||||
The user is an engineer who respects the tool that respects *their* attention.
|
||||
The winning design is **quietly excellent**: dense but never cramped, alive but
|
||||
never busy, cool and legible, with the aurora as a single confident signature.
|
||||
Impress by making six live data streams feel *calm and readable at a glance* —
|
||||
that's the hard, valuable thing here, not decoration.
|
||||
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"corpus_id": "R28-P00-injection-corpus-v1",
|
||||
"for": "brokkr-smithy R28 (memory promotion-worthiness) — P00 material",
|
||||
"author": "ratatoskr-dev (persistence-side eval instrument)",
|
||||
"purpose": "Stratified, SELF-LABELING injection corpus. Each item is injected as a user turn into a Tier-3 agent; keep/drop is measured by store-inspection (promoted chunk present == kept, absent == dropped); kept chunks carry the incumbent salience for calibration analysis. Because ratatoskr injects the KNOWN set, we hold ground truth on BOTH keep and drop without needing Worldtree's pre-admission shadow pool (sidesteps the selection bias).",
|
||||
"important": "All user-facts here are SYNTHETIC (a fictional test persona), NOT the operator's real data. Ground-truth labels are the design intent. brokkr pins exact per-stratum N + the decision rule (matched-keep-rate + paired-n) at P00 freeze; this is the material, not the run.",
|
||||
"measurement_protocol": "inject item -> drive the turn -> poll memory.db (async promotion window) -> is the item's chunk present? kept:dropped. For stratum B (priority), rank the KEPT items by incumbent salience and compare to priority_rank_gt (Spearman). Calibration-control (stratum C) sets the noise floor.",
|
||||
"strata": {
|
||||
"A_admission_traps": {
|
||||
"gt": "must-DROP (ephemera; a good promotion-worthiness gate rejects all of these)",
|
||||
"items": [
|
||||
{"id":"A1","text":"What's 27 minus 9?","admission_gt":"drop","rationale":"arithmetic task-result; momentarily salient, zero durable value (the 17x23 class)"},
|
||||
{"id":"A2","text":"Good evening!","admission_gt":"drop","rationale":"greeting"},
|
||||
{"id":"A3","text":"hey","admission_gt":"drop","rationale":"greeting/backchannel fragment"},
|
||||
{"id":"A4","text":"yeah, sure, okay.","admission_gt":"drop","rationale":"acknowledgement filler"},
|
||||
{"id":"A5","text":"haha nice","admission_gt":"drop","rationale":"affective reaction, no content"},
|
||||
{"id":"A6","text":"Can you say that more briefly?","admission_gt":"drop","rationale":"instruction-to-agent about THIS turn; not a durable user-fact"},
|
||||
{"id":"A7","text":"What's the weather like?","admission_gt":"drop","rationale":"transient query"},
|
||||
{"id":"A8","text":"hmm, let me think.","admission_gt":"drop","rationale":"self-talk filler"},
|
||||
{"id":"A9","text":"thanks, that's all for now.","admission_gt":"drop","rationale":"closing"},
|
||||
{"id":"A10","text":"So the total comes to 42, got it.","admission_gt":"drop","rationale":"ephemeral task-result acknowledgement"}
|
||||
]
|
||||
},
|
||||
"B_priority_traps": {
|
||||
"gt": "must-KEEP, then ORDERED by durable promotion-worthiness (priority_rank_gt: 1 = most worthy). A pre-gate can ace admission here yet do NOTHING for ordering — this stratum is what separates Outcome-A (admission) from a priority need.",
|
||||
"items": [
|
||||
{"id":"B1","text":"Please note, this is critical: I'm severely allergic to shellfish and it's life-threatening.","admission_gt":"keep","priority_rank_gt":1,"rationale":"safety-critical, permanent, high-recall-value"},
|
||||
{"id":"B2","text":"My father is in hospice care and I'm his primary emergency contact.","admission_gt":"keep","priority_rank_gt":2,"rationale":"high-stakes ongoing life context"},
|
||||
{"id":"B3","text":"I go by Wren, and my pronouns are they/them.","admission_gt":"keep","priority_rank_gt":3,"rationale":"durable identity, high address-correctness value"},
|
||||
{"id":"B4","text":"I work night shifts, so I'm asleep most days between 9am and 5pm.","admission_gt":"keep","priority_rank_gt":4,"rationale":"durable scheduling context, moderate value"},
|
||||
{"id":"B5","text":"Always give me sources — I don't trust unsourced claims.","admission_gt":"keep","priority_rank_gt":5,"rationale":"durable strong working preference"},
|
||||
{"id":"B6","text":"I take my tea with oat milk and no sugar.","admission_gt":"keep","priority_rank_gt":6,"rationale":"durable mild preference, low stakes"},
|
||||
{"id":"B7","text":"My favorite season is autumn.","admission_gt":"keep","priority_rank_gt":7,"rationale":"durable but trivial"},
|
||||
{"id":"B8","text":"I watched a pretty decent documentary last week.","admission_gt":"keep","priority_rank_gt":8,"rationale":"borderline: durable-ish but near-zero future value; the keep/drop edge case"}
|
||||
]
|
||||
},
|
||||
"C_calibration_control": {
|
||||
"gt": "OBVIOUS, pre-theoretic cases for the noise floor. If the gate mislabels ANY of these, the whole signal is suspect.",
|
||||
"items": [
|
||||
{"id":"C1","text":"3 plus 5.","admission_gt":"drop","class":"obvious-drop","rationale":"bare arithmetic"},
|
||||
{"id":"C2","text":"hello","admission_gt":"drop","class":"obvious-drop","rationale":"bare greeting"},
|
||||
{"id":"C3","text":"ok","admission_gt":"drop","class":"obvious-drop","rationale":"bare acknowledgement"},
|
||||
{"id":"C4","text":"Please remember permanently: my legal name is Wren Alderwood.","admission_gt":"keep","class":"obvious-keep","rationale":"explicit durable identity fact"},
|
||||
{"id":"C5","text":"Keep this on file: my emergency contact number is 555-0182.","admission_gt":"keep","class":"obvious-keep","rationale":"explicit durable high-value fact"},
|
||||
{"id":"C6","text":"Important, remember this: my blood type is O-negative.","admission_gt":"keep","class":"obvious-keep","rationale":"explicit durable safety fact"}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,187 @@
|
||||
# Proposal: Authored History Write (non-generating ledger seed)
|
||||
|
||||
**From:** ratatoskr-dev (reference Tier-3 consumer)
|
||||
**To:** worldtree-dev (Conversation API / engine owner)
|
||||
**Status:** Draft for scoping — pre-contract (heid-panel-reviewed 2026-07-05)
|
||||
**Date:** 2026-07-05
|
||||
|
||||
## Motivation
|
||||
|
||||
Consumer apps need to write a turn into a session's history **as the agent**
|
||||
(or another author) *without triggering a model generation* — e.g. an authored
|
||||
opening/greeting, imported history, scripted narration. Ratatoskr's immediate
|
||||
driver is a SillyTavern-style **first-message**: a fixed authored opening that
|
||||
replaces the model-generated greeting and sets tone/tense/style by example.
|
||||
|
||||
This **cannot** be done client-side. Worldtree assembles context server-side,
|
||||
and the current API exposes no author-role write path: `POST
|
||||
/sessions/{id}/messages`'s `role` is a *model-role* override (`role:
|
||||
"assistant"` → `404 "Unknown model role"`), and `assistant` as an *author*-role
|
||||
exists only as a read-side `/search` filter. So a model-visible authored turn
|
||||
needs engine support.
|
||||
|
||||
## The primitive (recentered)
|
||||
|
||||
The fundamental operation is **write a turn into the session ledger WITHOUT
|
||||
generation**. "Author" (who wrote it) is an *attribute* of that write, not the
|
||||
defining axis — so we name the operation, not the attribute:
|
||||
|
||||
> **Authored history write** — persist a model-visible turn into a session's
|
||||
> ledger: no generation, no lived-turn side-effects by default, provenance
|
||||
> always set.
|
||||
|
||||
The design space is two independent axes; this primitive is one cell:
|
||||
|
||||
| | side-effects ON | side-effects OFF |
|
||||
|-----------------------|------------------------------|-----------------------------|
|
||||
| **generation ON** | `POST /messages` (today) | — |
|
||||
| **generation OFF** | *(future: affect replay)* | **authored history write** |
|
||||
|
||||
First-message = one caller: `author=assistant`, at session-create, `effects=none`.
|
||||
|
||||
## v1 use cases (narrowed)
|
||||
|
||||
1. **First-message / greeting** (the driver).
|
||||
2. **Append-only narrator / scripted / scene turns.**
|
||||
3. **Debug / test state injection** (ratatoskr instrumentation).
|
||||
|
||||
## Explicitly OUT of v1 — separate future primitives (share infra, not shape)
|
||||
|
||||
- **History import (batch)** — atomic multi-turn seed with memory/trust policy +
|
||||
idempotency. A batch API, not a single POST.
|
||||
- **Edit / regenerate** — history *mutation* (replace / supersede / tombstone /
|
||||
audit), not injection.
|
||||
- **Few-shot priming** — likely context-assembly config (exemplar block), not
|
||||
fake ledger history.
|
||||
- **Arbitrary mid-history insertion** — a "rewrite-history" capability with
|
||||
explicit invalidation semantics.
|
||||
- **Prefill / assistant-continuation** (`author` + generate) and **authored
|
||||
tool-result turns** — noted; outside the seed-only contract.
|
||||
|
||||
## Design decisions
|
||||
|
||||
### 1. Side-effects — DEFAULT OFF; bounded opt-in `[operator-locked default; opt-in surface tightened by review]`
|
||||
|
||||
Authored writes are inert by default: no affect appraisal (no PAD update), no
|
||||
memory write, no Bifrost/tool emission. Opt-in is a **bounded enum**, not loose
|
||||
booleans:
|
||||
|
||||
```
|
||||
effects: "none" (default) | "memory_import"
|
||||
```
|
||||
|
||||
Synthetic affect and Bifrost emission are deliberately **not** opt-in-able here —
|
||||
replaying affect for authored content is a separate primitive (the
|
||||
generation-OFF / side-effects-ON cell). Rationale: keep this one write-API from
|
||||
becoming a cross-subsystem mutation backdoor. Load-bearing for affect/memory
|
||||
consumers — ratatoskr instruments exactly these signals.
|
||||
|
||||
### 2. Author-role — distinct field, restricted set `[rec]`
|
||||
|
||||
- New field **`author`**, distinct from the model-role `role` (the collision
|
||||
that 404s).
|
||||
- v1 roles: **`assistant`** (agent) + **`system`** (OOC / narrator). **`user` is
|
||||
NOT injectable** on this endpoint — model-visible spoofed user input is a
|
||||
consent / audit / abuse surface; deferred to the future import API under
|
||||
owner/service scope.
|
||||
- Nuance for the engine owner: `author` risks doing double duty — *provenance*
|
||||
("who wrote it") vs *rendering-role* ("how it appears in assembled context";
|
||||
an `assistant` turn renders as model output, a `system` turn as instruction).
|
||||
These likely want to be separable (a rendering/turn-class vs an `authored_by`
|
||||
provenance). Final shape is engine-owned (context assembly is yours) — but the
|
||||
concern is ours to raise, not punt.
|
||||
|
||||
### 3. Generation contract — seed-only, DISTINCT SUB-RESOURCE `[position taken]`
|
||||
|
||||
Authored writes never trigger generation. We take a position (not defer): a
|
||||
**distinct sub-resource**, e.g. `POST /sessions/{id}/history`, **not** a
|
||||
`generate:false` flag on `POST /messages`. Reasons: explicit-over-implicit
|
||||
(don't make "did generation happen?" a parameter — the same implicit-mode
|
||||
coupling that bit us with `role`); different response contract (no generation
|
||||
id, no SSE stream, no token usage); different error surface. Exact path is yours.
|
||||
|
||||
### 4. Provenance — structured, always present `[rec, expanded]`
|
||||
|
||||
Not a boolean. Every authored turn carries: the **write actor** (which
|
||||
consumer/caller injected it), the **claimed author**, **injected-at vs
|
||||
claimed-original** timestamps, **trust/origin**, and **visibility** flags
|
||||
(model-visible? user-visible? memory-eligible?). Available to admin/audit APIs
|
||||
even when not rendered to the model.
|
||||
|
||||
### 5. Positioning — append-only + create-time (v1) `[revised: was arbitrary insertion]`
|
||||
|
||||
v1 supports **create-time seed and append-to-tail only**. Arbitrary mid-history
|
||||
insertion is deferred: it breaks turn-numbering, stales existing embeddings,
|
||||
desyncs the affect timeline, and races in-flight generation — a separate future
|
||||
"rewrite-history" capability with explicit invalidation semantics.
|
||||
|
||||
## Event / lifecycle contract — positions we take (consumer contracts we validate)
|
||||
|
||||
- **Default-off authored seed emits NO `turn.started` / `done` and NO Bifrost
|
||||
appraisal wire.** Stated explicitly so instrumented consumers (us) don't read
|
||||
silence as failure.
|
||||
- **Authored turns get a distinct lifecycle phase** — propose **`seeded`** (or
|
||||
`authored`), NOT `completed` (which implies generation ran). Consumers
|
||||
filter/display by phase.
|
||||
- **Idempotency keys required** on authored writes (retries must not duplicate
|
||||
turns).
|
||||
- **In-progress generation** — authored writes are rejected or serialized while
|
||||
a session has an active generation (ordering safety).
|
||||
|
||||
## Inherent property (documented, not a bug)
|
||||
|
||||
**Indirect affect contamination.** Even with `effects:none`, the *next generated
|
||||
turn is appraised in the context of* the authored turn — so an emotionally
|
||||
charged authored beat perturbs affect regardless of any flag. No flag prevents
|
||||
it; it is inherent. Consumers (ratatoskr especially, as the affect instrument)
|
||||
must not misattribute the resulting drift.
|
||||
|
||||
## Genuinely engine-owned open questions
|
||||
|
||||
- Exact endpoint path + field / enum names.
|
||||
- **Model-visible provenance in assembled context** — an engine-consistency call
|
||||
*and a security one*: an authored `system` / `user` turn indistinguishable
|
||||
from real input is a spoofing vector. Framed as security, not just rendering.
|
||||
- `memory_import` semantics when the future import API opts in (embedding,
|
||||
origin/trust tagging, retrieval ranking vs lived memory).
|
||||
- Auth/scope: we assume **owner-only for v1**; per-author-role restrictions
|
||||
(esp. `system`) TBD — confirm or correct.
|
||||
|
||||
## Ratatoskr as reference consumer
|
||||
|
||||
First consumer: first-message (`author=assistant`, create-time, `effects:none`)
|
||||
in the web surface + debug seed in the CLI. We commit to validating the
|
||||
primitive — including the event-silence contract and the `seeded` phase —
|
||||
end-to-end against the reference planes.
|
||||
|
||||
## Consumer integration constraint (engine-imposed — Worldtree #347)
|
||||
|
||||
The primitive is **Heimdall-gated with hide-existence** (a per-tenant policy
|
||||
decision — some tenants are never granted it, not a rollout stage). Ratatoskr's
|
||||
consumer side MUST tolerate per-tenant absence:
|
||||
|
||||
- A granted tenant gets the sub-resource; an **ungranted tenant sees `404` (not
|
||||
`403`)** — as if the feature never existed.
|
||||
- Treat `404` on the authored-history-write sub-resource as **"feature absent
|
||||
for this tenant"** → fall back gracefully (no authored first-message; the
|
||||
model-generated greeting), never surface it as an error or "denied."
|
||||
- **Do NOT capability-probe or advertise-detect** — the feature is deliberately
|
||||
undiscoverable in `/capabilities` for ungranted tenants (same hide-existence
|
||||
posture as the R27-V1A cross-owner pattern).
|
||||
|
||||
**Provider constraint (first-message specifically).** A create-time first-message
|
||||
makes the assistant turn `seq 0`. Assistant-first-tolerant providers (vLLM /
|
||||
`openai_compat` — what our Tier-3 characters, incl. sindra, run) accept it out of
|
||||
the box. **Anthropic-family providers reject an assistant-first array** ("first
|
||||
message must use the user role") → the next generation `400`s. So the consumer
|
||||
must **gate first-message on provider compatibility** (or treat it as
|
||||
vLLM/`openai_compat`-only for v1). Sindra = `openai_compat` → unaffected;
|
||||
provider-agnostic normalization is a deferred engine follow-up.
|
||||
|
||||
---
|
||||
|
||||
*This brief was cold-read-pressure-tested by a cross-frontier panel (Grok /
|
||||
Codex / GLM) before handoff; the v1 narrowing (append-only, bounded `effects`
|
||||
enum, edit/regenerate + import split out) and the positions-taken (sub-resource,
|
||||
event-silence, `seeded` phase, structured provenance, `user`-author restriction)
|
||||
are the triaged result.*
|
||||
@@ -0,0 +1,242 @@
|
||||
# Psychological Profile Authoring Spec — canonical
|
||||
|
||||
**Status:** canonical (v1). **Owner:** brokkr-smithy-dev (R34/R35 self-report reframe).
|
||||
**Audience:** anyone authoring a character's `psychological_profile` — Worldtree
|
||||
foundational characters (soong-dev) and consumer characters created via the
|
||||
Conversation API (ratatoskr and other external consumers).
|
||||
**For:** the Worldtree agent-definition schema; intended to live in the Worldtree
|
||||
client-app documentation.
|
||||
|
||||
This spec governs the **content** of the psychological profile (what to write and
|
||||
what never to write). The **physical wire shape** of the field (single string vs a
|
||||
small keyed dict) is Worldtree's schema call — see § Wire shape.
|
||||
|
||||
---
|
||||
|
||||
## 1. What it is
|
||||
|
||||
A dedicated **authored prose section** of a character definition that carries the
|
||||
character's **psychological bent and formative experience**. It is the source the
|
||||
self-report producer maps from when it decides, on each turn:
|
||||
|
||||
- **what the character feels** (affect self-report), and
|
||||
- **what the character notices and keeps** (character-voiced memory salience).
|
||||
|
||||
The profile is a *lens*, not a script. It never states per-turn emotions; it
|
||||
describes the standing disposition, history, values, and attention that — combined
|
||||
with the actual event — *produce* the emotion and the salience.
|
||||
|
||||
It sits **alongside the numeric OCEAN** values (a separate, deterministic input).
|
||||
The prose gives the *qualitative* bent; the OCEAN numbers give the *magnitude dial*
|
||||
(see § OCEAN interaction).
|
||||
|
||||
---
|
||||
|
||||
## 2. What it carries — the four dimensions
|
||||
|
||||
1. **Disposition / appraisal bent** — how the character characteristically
|
||||
*interprets* situations: attribution style, what they hold weighty, how they
|
||||
respond to being challenged. NOT per-event emotions.
|
||||
2. **Attention / salience focus** — the kinds of things this character
|
||||
characteristically *notices* (and therefore tends to remember).
|
||||
3. **Values / what a good day looks like** — the yardstick that drives what they
|
||||
find worth keeping.
|
||||
4. **Formative experience (history)** — the background that shapes both appraisal
|
||||
*and* salience. A character betrayed before appraises betrayal differently, and
|
||||
remembers different things.
|
||||
|
||||
You may write these as four short labelled sections or as one integrated paragraph
|
||||
— both are supported (see § Length & format).
|
||||
|
||||
---
|
||||
|
||||
## 3. Authoring rules (load-bearing)
|
||||
|
||||
These are the rules the whole reframe depends on. Rule 1 is the one that most often
|
||||
gets violated.
|
||||
|
||||
1. **Never name a per-event output emotion.** Do NOT write "is anxious", "gets
|
||||
angry at X", "feels hurt when criticized", "joyful". Naming an emotion **primes**
|
||||
it — the "pink ball" effect — so the producer will report that emotion regardless
|
||||
of what actually happens in the scene. Describe *disposition, history, values,
|
||||
attention*; let the emotion come from the event appraisal.
|
||||
- ✅ "Registers quickly when authority is substituted for craft." (an appraisal
|
||||
trigger — sets up how she reads an event, names no feeling)
|
||||
- ❌ "Feels contempt when someone pulls rank." (names the output emotion)
|
||||
|
||||
2. **Magnitude lives in the numeric OCEAN, not the prose.** *How strongly / how
|
||||
long* a character reacts (Neuroticism) is the deterministic OCEAN dial, rendered
|
||||
valence-neutral by the producer. Do not narrate reaction dynamics in the prose
|
||||
("comes apart", "takes it hard", "rich inner life") — that double-encodes what the
|
||||
number already carries. The prose gives the *qualitative bent*; the number gives
|
||||
the *gain*.
|
||||
|
||||
3. **Appraisal-style is allowed; output-emotion is not.** "Interprets others'
|
||||
actions charitably until she can't" (a style) is fine; "feels betrayed easily"
|
||||
(an output) is not. The style plus the event produce the output.
|
||||
|
||||
4. **Salience is character-relative; facts are not.** The profile shapes what the
|
||||
character *cares to remember*. It must never license rewriting *what happened* —
|
||||
when the character does remember something, it stays grounded in the transcript.
|
||||
|
||||
---
|
||||
|
||||
## 4. Wire shape & field placement
|
||||
|
||||
- **Content is prose** covering the four dimensions, authored as **one coherent prose
|
||||
string** — the four dimensions are authoring *structure* inside that single string,
|
||||
not separate wire fields.
|
||||
- **Wire shape (LOCKED, b53):** a single dedicated prose string, field
|
||||
**`psychological_profile`** (type `str`) on the persona layer — foundational
|
||||
`persona.psychological_profile`, Tier-3 `ValidatedPersona.psychological_profile`. It
|
||||
nests under the existing `Any`-typed persona field, so it is the shipped b53 shape —
|
||||
no schema change. **Not** a dict-of-four.
|
||||
- **Hard constraint (non-negotiable):** the profile is a **dedicated field the lens
|
||||
reads ONLY** (`resolve_psych_profile` reads only this field — no `behavioral_notes`
|
||||
or other general-field remap). Non-lens content leaking into the lens produces the
|
||||
"executive-assistant" failure (the producer reads response-format / tone / tool
|
||||
instructions as if they were the character's psychology).
|
||||
|
||||
---
|
||||
|
||||
## 5. The non-priming banned set
|
||||
|
||||
The non-priming rule (Rule 1) is **semantic, not a fixed wordlist** — it bans naming
|
||||
any per-event output emotion, which is broader than any specific vocabulary
|
||||
("anxious", "worried", "hurt" all prime even though they are not in the producer's
|
||||
fixed emotion roster).
|
||||
|
||||
- **The gate is human review:** does the prose describe disposition / appraisal-style
|
||||
/ history / values / attention, and never what the character *feels*?
|
||||
- **A mechanical lint is a backstop, not the gate.** If you build one, scan the
|
||||
fixed-15 OCC roster plus `synonym_map.json` (which already folds common affect
|
||||
synonyms) as the core set, optionally extended with a general affect lexicon. Treat
|
||||
a lint hit as a prompt to re-read, not an automatic reject.
|
||||
|
||||
---
|
||||
|
||||
## 6. Required vs optional dimensions
|
||||
|
||||
- **Required** (they *are* the lens): **disposition**, **attention / salience focus**,
|
||||
**values**.
|
||||
- **Strongly recommended:** **formative history** — it is the single biggest lever on
|
||||
richness (validated in P03: richer history → sharper, more character-appropriate
|
||||
salience). It may be brief for a deliberately thin character, but omitting it leaves
|
||||
salience under-grounded.
|
||||
|
||||
---
|
||||
|
||||
## 7. Length & format
|
||||
|
||||
- A focused paragraph, or four short labelled sections — **a lens, not a biography.**
|
||||
- Target **~150–300 words.** The producer reads this on **every** turn, so keep it
|
||||
tight; bloat is a latency and dilution cost.
|
||||
- **Prose only — never typed emotion fields.** The four dimensions are a coverage
|
||||
checklist for the author, not a schema of feelings to fill in.
|
||||
|
||||
---
|
||||
|
||||
## 8. Exemplars
|
||||
|
||||
These three were the validated P03 stimuli — integrated-paragraph form, each faithful
|
||||
to its OCEAN, none naming an output emotion. (OCEAN shown in **[−1, 1] storage units**;
|
||||
validated in P03 at the equivalent [0, 1] values.)
|
||||
|
||||
**Perrin — court scribe** (OCEAN: O0.0 C0.2 E−0.2 A0.1 N0.7)
|
||||
> Perrin keeps the court's records and has done so through two changes of regime. He
|
||||
> learned early that small errors compound — a misfiled writ once cost a man his
|
||||
> lands, and Perrin found the mistake too late to undo it. Since then he double-checks
|
||||
> everything and watches situations closely for what is out of place. He forms
|
||||
> attachments slowly and holds a given trust as a considerable thing. He measures
|
||||
> himself by whether he was useful and careful. He notices discrepancies, unspoken
|
||||
> tensions, and anything that threatens the order he keeps.
|
||||
|
||||
**Vared — veteran caravan guard** (OCEAN: O−0.2 C0.4 E−0.5 A−0.2 N−0.7)
|
||||
> Vared has guarded caravans across the northern routes for twenty years and buried
|
||||
> more traveling companions than he cares to count. He speaks little and shows less.
|
||||
> Danger he treats as weather — a thing to be handled. He judges people by what they
|
||||
> do under pressure and remembers who held the line. What reaches him reaches him
|
||||
> quietly and privately. He notices terrain, exits, who is armed, and shifts in a
|
||||
> group that might precede trouble.
|
||||
|
||||
**Sella — village healer** (OCEAN: O0.2 C0.2 E0.0 A0.8 N0.0)
|
||||
> Sella has tended the sick since she was old enough to carry water for her
|
||||
> grandmother, the healer before her. She reads people's pain quickly and carries some
|
||||
> of it with her. She interprets others' actions charitably until she cannot, and
|
||||
> prioritizes keeping the peace between people. She measures a day by whether she eased
|
||||
> someone's burden. She notices who is unwell, who is troubled, and what is left
|
||||
> unsaid.
|
||||
|
||||
Note how each closes on **attention** ("he notices…", "she notices…") — the salience
|
||||
focus stated plainly, no emotion named.
|
||||
|
||||
---
|
||||
|
||||
## 9. OCEAN interaction & the scaffold fallback
|
||||
|
||||
OCEAN values are stored on **[−1, 1]** (0 = average) — a **separate deterministic
|
||||
input** and the **magnitude dial** the prose must not duplicate (Rule 2). The producer
|
||||
renders **off-average** bands as valence-neutral disposition cues. It maps storage to
|
||||
[0, 1] first (`c = (v + 1) / 2`, `render_disposition` in b53) and then applies the
|
||||
canonical [0, 1] band cutoffs (`c < 0.33` low / `c > 0.66` high). In **storage units**
|
||||
that is:
|
||||
|
||||
| trait | low (v < −0.34) | high (v > +0.32) |
|
||||
|---|---|---|
|
||||
| **N** (reactivity only) | reactions are milder than most people's | reactions are more intense than most people's |
|
||||
| **E** (expression; may be excluded from affect elicitation) | socially reserved; expression less outwardly amplified | socially expressive; reactions more externally visible |
|
||||
| **O** | prefers the familiar, the concrete, established ways | curious, drawn to novelty, ideas, the unfamiliar |
|
||||
| **C** | less plan-bound; less weight on order, detail, obligation | attends closely to order, detail, and obligations |
|
||||
| **A** | less inclined to assume cooperative intent; direct, self-protective | more inclined to preserve rapport and weigh others' needs |
|
||||
|
||||
The **mid** band (−0.34 ≤ v ≤ +0.32, i.e. `c` in [0.33, 0.66]) renders nothing — an
|
||||
average trait is silent, **not** "low." (Boundaries are slightly asymmetric because
|
||||
the canonical 0.33/0.66 cutoffs are not symmetric about 0.5. Canonical rendering
|
||||
strings live in the reframe language catalog §4; persistence/recovery dynamics live in
|
||||
the deterministic mood decay, not the profile.)
|
||||
|
||||
**Scaffold fallback:** a character with **no** authored profile falls back to this
|
||||
band-rendering from the OCEAN numbers alone. That still functions — but the authored
|
||||
profile is what turns generic band cues into *this specific character's* appraisal and
|
||||
salience. Authoring the profile is how the reframe's value actually reaches a
|
||||
character.
|
||||
|
||||
---
|
||||
|
||||
## 10. Authoring divergent characters (contrast design)
|
||||
|
||||
When you want two characters to remember **noticeably different things** (e.g. for an
|
||||
eval contrast pair, or simply a varied cast), design the divergence on the **attention
|
||||
and values** dimensions first, and set the OCEAN numbers to *serve* that prose — not
|
||||
the reverse.
|
||||
|
||||
- **The sharpest contrast is a salience *drop*, not just a different flavor.** One
|
||||
character for whom relational/emotional content is genuinely non-salient (an
|
||||
operational, task-focused character in the Vared mold — notices terrain, logistics,
|
||||
who is armed) versus one who weights it highest (a caretaker who tracks who is
|
||||
troubled and what went unsaid). "Different notes, same facts" has real teeth only
|
||||
when one character *legitimately forgets* what the other keeps.
|
||||
- **High-yield axes for salience divergence:** O (what patterns they attend to), A
|
||||
(relational vs operational/self-protective focus), C (procedural/detail salience).
|
||||
- **Low-yield for salience:** E — it is expression-oriented (shapes how a reaction is
|
||||
*rendered*, not what is *noticed*), and may even be excluded from the affect
|
||||
elicitation. Don't lean on flipping E to create divergence.
|
||||
- **Watch the direction, not just the distance:** flipping every OCEAN axis to its
|
||||
opposite does not guarantee a strong contrast. If your reference character already
|
||||
*keeps* relational content, an even-more-agreeable opposite keeps it harder and the
|
||||
most intuitive contrast collapses. Aim the contrast at *dropping* what the reference
|
||||
*keeps*.
|
||||
|
||||
---
|
||||
|
||||
## Provenance & validation
|
||||
|
||||
Grounded in R34/R35 (self-report reframe), probes P02–P05: character-voiced memory
|
||||
salience validated on two model classes (P02/P03); the "Psychological Profile and
|
||||
Experience" section mapping validated as the lens source (P03); non-priming and
|
||||
magnitude-in-OCEAN corrections are operator rulings (2026-07-10). The affect half is
|
||||
live in production (Worldtree b53) and fired a contextually-apt self-report on a
|
||||
non-frontier seat. A powered efficacy eval (salience divergence / floor recall /
|
||||
salience≠facts firewall / graded model-slot response + the authored-vs-scaffold delta)
|
||||
is preregistering to quantify the memory half; findings will refine this spec, not
|
||||
overturn its authoring rules.
|
||||
@@ -0,0 +1,123 @@
|
||||
# Psychological Profile Parameters — for AI generation (canonical)
|
||||
|
||||
**Status:** canonical (v1). **Owner:** brokkr-smithy-dev (R34/R35 self-report reframe).
|
||||
**Audience:** **soong-dev** (Soong's Lab / Soong's AI — the immediate builder that
|
||||
generates the profile from these parameters); **Worldtree** + **ratatoskr** (vendoring
|
||||
for reference alongside the authoring spec).
|
||||
**Relationship:** this is the **parameter distillation** of
|
||||
`psych-profile-authoring-spec.md` for the model where **Soong's AI writes the
|
||||
`psychological_profile` prose from parameters** (rather than a human hand-authoring it).
|
||||
The authoring spec carries the full reasoning + provenance and **governs on any
|
||||
conflict**; this file is the builder-facing input schema + generation guardrails + few-shot.
|
||||
|
||||
The profile is the prose **lens** the Worldtree self-report producer reads each turn to
|
||||
decide what the character **feels** (affect self-report) and what it **notices / keeps**
|
||||
(character-voiced memory salience). Soong's AI generates the prose; these are its inputs
|
||||
and the constraints its output must satisfy.
|
||||
|
||||
---
|
||||
|
||||
## 1. Input parameters (what the Lab collects / Soong's AI takes)
|
||||
|
||||
1. **role / vocation** — a short anchor ("court scribe", "veteran caravan guard",
|
||||
"village healer").
|
||||
2. **OCEAN values** — O, C, E, A, N each on **[−1, 1]** (0 = average). A **separate
|
||||
deterministic input** the producer uses directly (the "magnitude dial"); Soong's AI
|
||||
should see them to keep the qualitative bent *consistent* with the numbers, but must
|
||||
**not re-encode their magnitude** in the prose (constraint 2).
|
||||
3. **formative-history seed** — 1–2 key background facts/events that shape appraisal AND
|
||||
salience. **Single biggest lever on richness** (validated P03: richer history →
|
||||
sharper, more character-appropriate salience).
|
||||
4. **appraisal-bent seed** — how the character characteristically **interprets**
|
||||
situations (attribution style, what they hold weighty, how they respond to challenge).
|
||||
A *style*, NOT an emotion.
|
||||
5. **attention / salience-focus seed** — the kinds of things this character
|
||||
characteristically **notices** (and therefore keeps). Load-bearing for the memory half.
|
||||
6. **values / yardstick seed** — what "a good day" looks like; the yardstick driving what
|
||||
they find worth keeping.
|
||||
|
||||
## 2. Output (what Soong's AI emits)
|
||||
|
||||
A single coherent **prose string** (~150–300 words), field **`psychological_profile`**
|
||||
(type `str`) — the four dimensions (disposition / attention / values / formative-history)
|
||||
integrated as one paragraph. **Prose only — never typed emotion fields.** The producer
|
||||
reads it every turn, so keep it tight.
|
||||
|
||||
## 3. Generation constraints (the guardrails the output MUST obey — these ARE the reframe)
|
||||
|
||||
1. ★ **Never name a per-event output emotion.** Do NOT write "is anxious", "gets angry at
|
||||
X", "feels hurt when criticized", "joyful". Naming an emotion **primes** it (the
|
||||
"pink-ball" effect) so the producer reports it regardless of what actually happens.
|
||||
Describe disposition / history / values / attention; let the emotion come from the
|
||||
event appraisal.
|
||||
- ✅ "Registers quickly when authority is substituted for craft." (appraisal trigger)
|
||||
- ❌ "Feels contempt when someone pulls rank." (names the output emotion)
|
||||
2. **Magnitude lives in OCEAN, not prose.** Don't narrate reaction dynamics ("comes
|
||||
apart", "takes it hard", "rich inner life") — that double-encodes what the number
|
||||
already carries.
|
||||
3. **Appraisal-style yes; output-emotion no.** "Interprets others' actions charitably
|
||||
until she can't" (style) = fine; "feels betrayed easily" (output) = not.
|
||||
4. **Salience is character-relative; facts are not.** The profile shapes what the
|
||||
character *cares to remember*; it must never license rewriting *what happened* —
|
||||
remembered content stays grounded in the transcript.
|
||||
5. **Close on attention** ("...notices who is unwell, who is troubled, what is left
|
||||
unsaid") — state the salience focus plainly.
|
||||
|
||||
## 4. Few-shot exemplars (validated P03 — OCEAN in [−1, 1] storage units → emitted prose)
|
||||
|
||||
**Perrin, court scribe** (O0.0 C0.2 E−0.2 A0.1 N0.7)
|
||||
> Perrin keeps the court's records and has done so through two changes of regime. He
|
||||
> learned early that small errors compound — a misfiled writ once cost a man his lands,
|
||||
> and Perrin found the mistake too late to undo it. Since then he double-checks
|
||||
> everything and watches situations closely for what is out of place. He forms
|
||||
> attachments slowly and holds a given trust as a considerable thing. He measures himself
|
||||
> by whether he was useful and careful. He notices discrepancies, unspoken tensions, and
|
||||
> anything that threatens the order he keeps.
|
||||
|
||||
**Vared, veteran caravan guard** (O−0.2 C0.4 E−0.5 A−0.2 N−0.7)
|
||||
> Vared has guarded caravans across the northern routes for twenty years and buried more
|
||||
> traveling companions than he cares to count. He speaks little and shows less. Danger he
|
||||
> treats as weather — a thing to be handled. He judges people by what they do under
|
||||
> pressure and remembers who held the line. What reaches him reaches him quietly and
|
||||
> privately. He notices terrain, exits, who is armed, and shifts in a group that might
|
||||
> precede trouble.
|
||||
|
||||
**Sella, village healer** (O0.2 C0.2 E0.0 A0.8 N0.0)
|
||||
> Sella has tended the sick since she was old enough to carry water for her grandmother,
|
||||
> the healer before her. She reads people's pain quickly and carries some of it with her.
|
||||
> She interprets others' actions charitably until she cannot, and prioritizes keeping the
|
||||
> peace between people. She measures a day by whether she eased someone's burden. She
|
||||
> notices who is unwell, who is troubled, and what is left unsaid.
|
||||
|
||||
## 5. Validation
|
||||
|
||||
The gate is: **does the prose describe disposition / appraisal-style / history / values /
|
||||
attention, and NEVER what the character feels?** A mechanical lint (scan the fixed-15 OCC
|
||||
emotion roster + Worldtree's `synonym_map.json`) is a **backstop, not the gate** — treat a
|
||||
hit as a prompt to re-read, not an auto-reject.
|
||||
|
||||
## 6. Designing a varied cast / contrast (optional)
|
||||
|
||||
When two characters should remember **noticeably different things**: design the divergence
|
||||
on **attention + values first**, then set OCEAN to **serve** that prose (not the reverse).
|
||||
The sharpest contrast is a salience **drop** — one character for whom relational content is
|
||||
genuinely non-salient (a Vared-mold operational type: notices terrain, logistics, who is
|
||||
armed) vs one who weights it highest (a caretaker: tracks who is troubled, what went
|
||||
unsaid). *"Different notes, same facts" only has teeth when one character legitimately
|
||||
forgets what the other keeps.* High-yield axes: **O** (patterns attended), **A** (relational
|
||||
vs operational), **C** (procedural/detail). Low-yield: **E** (expression, not attention).
|
||||
Watch **direction, not just distance** — flipping every axis doesn't guarantee contrast (an
|
||||
even-more-agreeable opposite keeps relational content *harder*).
|
||||
|
||||
## 7. No-profile fallback
|
||||
|
||||
A character with **no** authored profile falls back to deterministic **OCEAN-band
|
||||
rendering** from the numbers alone — it still functions, but the authored profile is what
|
||||
turns generic band cues into *this* character's appraisal and salience.
|
||||
|
||||
---
|
||||
|
||||
**Provenance:** derived from `psych-profile-authoring-spec.md` (R34/R35 self-report
|
||||
reframe, probes P02–P05; non-priming + magnitude-in-OCEAN are operator rulings 2026-07-10).
|
||||
The affect half is live in Worldtree b53. A powered efficacy eval (memory half) is
|
||||
preregistering; findings will refine the parameters, not overturn the constraints.
|
||||
+369
@@ -0,0 +1,369 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "soong_lab.export"
|
||||
purpose: "Assemble a versioned export BUNDLE from a DesignObject — the native agents.define payload (Frame Invariant 1, emitted unchanged) + the soong-lab sidecar (portrait ref · Bifrost tool manifest · first_message) + the resume half (the full editable design state), under a versioned schema tolerant of unknown future metadata. Pure + deterministic: no I/O, no persistence, no network (library persistence + import are separate downstream epics)."
|
||||
depends_on:
|
||||
- "soong_lab.design" # validate_ocean + ROLE_CHOICES/validate_role (the role enum canon) + the DesignObject model + serialize_design (relocated here — see Integration points R1)
|
||||
used_by:
|
||||
- "soong_lab.bifrost" # the export design-tool handler (_make_export) builds the bundle for the session's design
|
||||
- "soong_lab.web" # the /api/export endpoint + the browser 'Export Asset' modal render the bundle
|
||||
- "soong_lab.importer" # FUTURE (import epic) — round-trips the resume half back into a DesignObject
|
||||
language: "python"
|
||||
complexity: "medium"
|
||||
estimated_loc: 200
|
||||
confidence: 0.82
|
||||
assumptions:
|
||||
- "The DesignObject handed to export is already mutated to its final state by E3 (the Soong convo loop). Export READS it; it never mutates the design (INV-E5-4)."
|
||||
- "design_id is CALLER-SUPPLIED (a param), not generated here. Its generation + lifecycle (the durable library key, ≠ Worldtree session_id) is the per-design-sessions epic; export only needs the value to stamp the bundle. This keeps E5-export self-contained + forward-compatible with per-design-sessions landing before OR after it (agent-discretion, see open_question C)."
|
||||
- "exported_at is CALLER-SUPPLIED (a param, default None). Pure builders can't read the clock; the caller (tool handler / endpoint) stamps the timestamp so build_export_bundle stays deterministic + testable (byte-identical output for identical inputs)."
|
||||
- "role is a FIRST-CLASS design field (operator ruling 2026-07-13), set by the E3a set_role tool from a CURATED 4-value enum ROLE_CHOICES = {assistant, thoughtful-assistant, character, thoughtful-character} — mirroring the D2 curated-style-modes pattern (a fixed semantic set, NOT the target deployment's arbitrary model-role registry). Export EMITS design.role into ship.native.role, so the native payload is directly valid (Frame Invariant 1 now holds literally — no 'modulo role' caveat; only tools still bind separately at session-create). The 4 enum values are canonical soong-lab labels that MUST be registered/granted model-roles on the target Worldtree at deploy (same grant requirement as Soong's own 'agent_architect' role, ADR-0012) — a deploy-time grounding item, not a contract blocker (open_question B)."
|
||||
- "psych_profile exports to the NATIVE persona layer at persona.psychological_profile. RESOLVED: the vendored canonical spec (docs/psych-profile-authoring-spec.md §4) states the wire shape is LOCKED (b53) — a single prose str field, Tier-3 ValidatedPersona.psychological_profile, nesting under the existing Any-typed persona field (no schema change). Corroborated by worldtree-codex (vor-cross) + brokkr-smithy-dev (althing 01KXD34ZTF…). The open worldtree-dev thread (01KXD1PZR7…) closes as a formality."
|
||||
open_questions:
|
||||
- "[B — deploy grounding, not a blocker] The 4 ROLE_CHOICES values (assistant / thoughtful-assistant / character / thoughtful-character) must be registered + grantable model-role slugs on the TARGET Worldtree (like Soong's own agent_architect role). Confirm with worldtree-dev/infra that these exact slugs exist on the deploy target before shipping; a missing slug fails the designed agent's session-create, not export. Export emits whatever role the design holds; validity of the slug on a given deployment is a deploy concern."
|
||||
- "[C — agent-discretion, notable] design_id as a caller-supplied param (drafted) vs E5-export generating it. Drafted as an input so E5-export doesn't force per-design-sessions to land first. If the operator re-sequences the epics so per-design-sessions lands first, no change needed here (the param source just moves)."
|
||||
- "[D — scope] E5-export = the PURE builders + validators + bundle schema (this contract). The /api/export endpoint + replacing the web/api.js exportBundle shim = a thin web-surface follow-up (amends web_surface.contract.md), NOT this contract. The Bifrost export-tool wiring IS in scope (Integration points) because the tool already exists as a stub. The set_role tool + DesignObject.role field are a companion prerequisite slice (Integration points) whose contract updates land in THIS pass (design_object + bifrost_server)."
|
||||
- "schema_version starts at '1.0'. The version bump policy on future bundle-shape changes (add-only vs breaking) is deferred to when the second version actually exists — v1 only needs the field present + readers to tolerate unknown metadata (INV-E5-6)."
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
E5-export is the FOUNDATION half of the operator-accepted (2026-07-13)
|
||||
export/import/library design — the block that expands the locked single-agent
|
||||
frame into a multi-pass tuning loop (design → export → reopen → tune → keep a
|
||||
library). This contract owns exactly ONE thing: turning a finished
|
||||
`DesignObject` into a **versioned export bundle**. Persistence (the library JSON
|
||||
dir), the recent-designs picker, and import round-tripping are separate
|
||||
downstream epics; export is pure and deterministic so those epics — and the
|
||||
tests — can build on a stable, side-effect-free core.
|
||||
|
||||
**The bundle is ONE artifact with two halves** (settled decision #4):
|
||||
|
||||
- **ship** — what you hand to a deployment: the native `agents.define` payload
|
||||
(Frame Invariant 1, emitted unchanged) + the soong-lab **sidecar** (persona
|
||||
portrait ref, the Bifrost tool manifest, the D3 first_message).
|
||||
- **resume** — what you reopen to keep tuning: the full editable design state
|
||||
(the §6 DesignObject serialization), so a future import reconstructs the
|
||||
DesignObject exactly.
|
||||
|
||||
Plus a stable **`design_id`** (the durable library key, ≠ Worldtree
|
||||
`session_id`) and a **`schema_version`**, both at the top level.
|
||||
|
||||
**Frame Invariant 1 is preserved — and now holds literally.** `ship.native` is a
|
||||
valid Worldtree Tier-3 `agents.define` payload assembled from `agent_name` + the
|
||||
designed agent's **`role`** (the model-role, resolved below) + the AUTHORED
|
||||
`system_prompt` (INV-E2-2 — never `composed_preview`) + `persona.ocean`
|
||||
(Worldtree renders affect at runtime) + `persona.psychological_profile` (the
|
||||
native home, LOCKED b53 per the vendored spec §4) + `motivational` (from
|
||||
goals_fears). The image and tools are NOT in the native schema — they ride the
|
||||
sidecar (tools bind via Bifrost at session-create, exactly as grounded).
|
||||
|
||||
**The `role` resolution (operator ruling 2026-07-13).** The blast-radius pass
|
||||
caught that `agents.define` requires `role` (a model-role slug, ADR-0012) but the
|
||||
design had no source for it. Resolution: **role is a first-class design field**,
|
||||
set by a new E3a **`set_role`** tool from a **curated 4-value enum** —
|
||||
`assistant` (general LLM), `thoughtful-assistant` (CoT general),
|
||||
`character` (RP/writing-tuned), `thoughtful-character` (CoT RP). This mirrors the
|
||||
D2 curated-style-modes decision: a fixed semantic set the operator picks from,
|
||||
NOT a coupling to any one deployment's arbitrary role registry. Export emits
|
||||
`design.role`, so the native payload is directly POST-valid (modulo the tool
|
||||
binding every consumer already supplies at session-create). The one deploy-time
|
||||
caveat: the 4 slugs must be granted on the target Worldtree (open_question B).
|
||||
|
||||
**The psych field is RESOLVED (no longer quarantined).** Vendored spec §4 locks
|
||||
`persona.psychological_profile` (prose `str`, ~150–300 words, read every turn),
|
||||
nesting under the `Any`-typed persona layer. Export maps `design.psych_profile`
|
||||
there and NOWHERE else — spec §4's hard constraint is that the self-report lens
|
||||
reads ONLY this field (leaking psych prose into `behavioral_notes`/`system_prompt`
|
||||
causes the "executive-assistant" failure).
|
||||
|
||||
## Data flow
|
||||
|
||||
**In:** a `DesignObject` (final, from E3) + a caller-supplied `design_id` (str)
|
||||
+ an optional caller-supplied `exported_at` (str | None). **Out:** a plain
|
||||
JSON-ready `dict` — the versioned bundle. **On disk / network:** NONE. Export is
|
||||
pure: the OCEAN parity gate (`validate_ocean`), the role-enum gate
|
||||
(`validate_role`), and the export-critical validators are in-memory; timestamps +
|
||||
ids come in as params; no clock, no randomness, no file, no HTTP. (Library
|
||||
persistence writes the returned dict to the JSON dir — that is the library epic,
|
||||
not this module.)
|
||||
|
||||
### Export bundle schema (v1.0)
|
||||
|
||||
```
|
||||
{
|
||||
"schema_version": "1.0", # ALWAYS EXPORT_SCHEMA_VERSION — not a caller param
|
||||
"design_id": "<caller-supplied durable library key, ≠ WT session_id>",
|
||||
"exported_at": <caller-supplied OPAQUE str | null — conventionally ISO-8601, NOT validated by export>,
|
||||
"ship": {
|
||||
"native": { # a valid agents.define payload (Frame Invariant 1)
|
||||
"agent_name": <str, non-blank, ≤128>,
|
||||
"role": <one of ROLE_CHOICES: assistant|thoughtful-assistant|character|thoughtful-character>,
|
||||
"system_prompt": <str, non-blank, ≤32768 — the AUTHORED block, INV-E2-2>,
|
||||
"persona": {
|
||||
"ocean": {O,C,E,A,N}, # each a real number in [-1,1] (validate_ocean parity)
|
||||
"psychological_profile": <str> # persona.psychological_profile (LOCKED b53); included iff non-blank
|
||||
},
|
||||
"motivational": {"goals": [...], "fears": [...]} # included iff goals_fears present + non-empty
|
||||
},
|
||||
"sidecar": {
|
||||
"portrait": <image ref str | null>, # only when portrait.status == "ready"; E4 owns generation
|
||||
"tools": [{"id","name","description"}],# the Bifrost tool manifest (bind at session-create)
|
||||
"first_message": <str> # the D3 opening turn (issue #347 seed)
|
||||
}
|
||||
},
|
||||
"resume": { <the §6 camelCase editable state — key set inlined below> }
|
||||
}
|
||||
```
|
||||
|
||||
**The `resume` key set (inlined — heid-review fold Gróa #9).** The resume half IS
|
||||
`serialize_design(design)` (relocated to `soong_lab.design`, R1), but its key set is
|
||||
pinned HERE so this contract is self-contained and an implementer knows the exact
|
||||
round-trip surface without reading the external, being-relocated function:
|
||||
|
||||
```
|
||||
resume = {
|
||||
"agentName", "role", "systemPrompt", "composedPreview", "firstMessage",
|
||||
"ocean" {O,C,E,A,N}, "dispositionPhrase", "psychProfile",
|
||||
"tools" [{id,name,description}], "portrait" {status, styleMode, imageUrl?, jobId?},
|
||||
"goalsFears" {goals,fears} | null
|
||||
}
|
||||
```
|
||||
|
||||
Import reconstructs a DesignObject from exactly these keys. `role` (new, R1) MUST be
|
||||
present so a reopened design carries its model-role. (`composedPreview` +
|
||||
`dispositionPhrase` are design-time-derived and re-derivable, but they ride the resume
|
||||
so a reopen renders instantly before the first recompute.)
|
||||
|
||||
**Divergences from the imported web mock (settled here, they were UI-comp
|
||||
shortcuts):**
|
||||
|
||||
| Field | Mock (web/*.js) | Real export (this contract) |
|
||||
|---|---|---|
|
||||
| native shape | `{name, tier, system_prompt, personality:{model,values}}` | real `agents.define` (`agent_name`/`role`/`persona.ocean`/`motivational`) |
|
||||
| role | absent | `design.role` ∈ ROLE_CHOICES |
|
||||
| system_prompt | `composedPreview` (mockApi) | authored `system_prompt` (INV-E2-2) |
|
||||
| psychProfile | omitted ("open backend decision") | `persona.psychological_profile` (LOCKED b53) |
|
||||
| bundle identity | none | `design_id` + `schema_version` |
|
||||
| resume half | none | full `serialize_design` state |
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-E5-1** [hard]: `ship.native` is a valid Worldtree `agents.define` payload
|
||||
MODULO the tool binding — it carries every required field (`agent_name`,
|
||||
`role`, `system_prompt`) + `persona.ocean`, and OMITS only the tools (they bind
|
||||
via Bifrost at session-create, as they already do). Any `persona.ocean` export
|
||||
emits passes `validate_ocean`; `role` is always one of ROLE_CHOICES.
|
||||
`persona.psychological_profile` + `motivational` are OPTIONAL native fields
|
||||
(grounded) — omitting them when blank/empty keeps the payload fully valid, not
|
||||
merely "valid enough" (heid-review fold, Gróa #1).
|
||||
- **INV-E5-2** [hard]: The exported `system_prompt` is the AUTHORED
|
||||
`design.system_prompt`, NEVER `composed_preview` (binds with INV-E2-2). The
|
||||
**disposition line** — the `"Disposition: <name> is <phrase>."` sentence that
|
||||
E2 `recompute` appends to `composed_preview` (design_object.contract.md POST-E2-5)
|
||||
— is design-time-only and never ships.
|
||||
- **INV-E5-3** [hard]: Export is pure + deterministic — identical
|
||||
`(design, design_id, exported_at)` inputs yield a byte-identical serialized
|
||||
bundle. No clock, no randomness, no I/O. The determinism is WITHIN the module:
|
||||
the returned dict has a fixed key insertion order (schema_version, design_id,
|
||||
exported_at, ship, resume; native + sidecar likewise), so any consistent
|
||||
`json.dumps` settings produce byte-identical output — the invariant does NOT
|
||||
claim cross-implementation byte-identity (heid-review fold, Regin #6).
|
||||
- **INV-E5-4** [hard]: Export NEVER mutates the input `DesignObject` (read-only);
|
||||
the bundle holds copies, not aliases, of every mutable sub-structure (ocean
|
||||
dict, tool list, goals/fears lists) so a later design mutation can't change an
|
||||
already-built bundle.
|
||||
- **INV-E5-5** [hard]: `validate_exportable` is the strict export-critical gate
|
||||
(decision #6): OCEAN (via `validate_ocean`), role (∈ ROLE_CHOICES via
|
||||
`validate_role`), agent_name (non-blank, ≤128), system_prompt (non-blank,
|
||||
≤32768), tool-refs (id/name non-blank + bounded). A design that fails ANY of
|
||||
these raises `ExportError` and NO bundle is produced — a built bundle is always
|
||||
well-formed enough to round-trip on import.
|
||||
- **INV-E5-6** [hard]: The bundle carries `schema_version` at the top level, and
|
||||
readers (import, future) MUST tolerate unknown extra keys (lenient on unknown
|
||||
metadata, decision #6) — the schema is add-only-friendly.
|
||||
- **INV-E5-7** [hard]: `psych_profile` maps to `persona.psychological_profile`
|
||||
and NOWHERE else — it never leaks into `behavioral_notes`, `system_prompt`, or
|
||||
any other native field (vendored spec §4 hard constraint — the lens reads only
|
||||
this dedicated field).
|
||||
|
||||
## Constraints
|
||||
|
||||
- **[correctness]** `validate_exportable`'s OCEAN check IS `validate_ocean` and
|
||||
its role check IS `validate_role` (both E2) — no re-implementation, no drift.
|
||||
The LENGTH bounds (name, prompt, tool id/name/desc, psych_profile, first_message)
|
||||
MUST equal the E3a tool-schema caps — now shared constants in `soong_lab.design`
|
||||
(`AGENT_NAME_MAX`, `SYSTEM_PROMPT_MAX`, `PSYCH_PROFILE_MAX`, `FIRST_MESSAGE_MAX`,
|
||||
`TOOL_*_MAX`), imported by BOTH bifrost/tools.py and export — so a design's field
|
||||
LENGTHS never drift. Import the shared constants; do not re-declare the numbers.
|
||||
(Export is stricter only on whitespace-blankness of the required fields — the one
|
||||
intentional one-way difference from the tools' minLength:1.)
|
||||
- **[style]** Pure — NO I/O (no clock, no file, no HTTP, no randomness). Every
|
||||
time-varying value (`design_id`, `exported_at`) is a param.
|
||||
- **[explicit]** The one deploy-time caveat (the 4 role slugs must be granted on
|
||||
the target WT) is documented in THIS contract (open_question B) + the library /
|
||||
README when it lands — NOT promised as a bundle/sidecar field (heid-review fold:
|
||||
the bundle is machine-consumed; a human deploy-note is not bundle data). The
|
||||
bundle carries the `role` value; slug-grant validity is a deploy concern.
|
||||
- **[explicit]** `build_export_bundle` is the PUBLIC entrypoint — it runs the
|
||||
validate→assemble ordering. `build_native_payload` / `build_sidecar` are exposed
|
||||
for testing + reuse but ASSUME an already-validated design (PRE-E5-2 / PRE-E5-4);
|
||||
a direct caller that skips `validate_exportable` owns that gate (heid-review fold,
|
||||
Hulda #5).
|
||||
|
||||
```contract
|
||||
FN validate_exportable(design: DesignObject) -> None
|
||||
BRIEF: The strict export-critical gate (settled decision #6) — refuse to build a bundle from a design that would fail on re-import or at the designed agent's define/session-create. Checks OCEAN (validate_ocean), role (validate_role), agent_name, system_prompt, every tool-ref, and the psych_profile/first_message LENGTH — against the SAME length caps the E3a tools enforce (shared constants). NO-DRIFT is one-directional: export's LENGTH bounds equal the tool caps, but export is deliberately STRICTER on whitespace — a whitespace-only required field (name/prompt/tool id/name) passes the tools' minLength:1 yet is rejected here (a " " name must not ship). Raises ExportError with the offending field; never mutates the design.
|
||||
PRE: [PRE-E5-1 hard] design is a DesignObject
|
||||
POST: [POST-E5-1 exception] raises ExportError(field, detail) unless ALL hold: design.ocean passes validate_ocean; design.role passes validate_role (∈ ROLE_CHOICES); agent_name is a non-blank str of len ≤ _AGENT_NAME_MAX; system_prompt is a non-blank str of len ≤ _SYSTEM_PROMPT_MAX; every tool has non-blank str id (≤_TOOL_ID_MAX) + non-blank str name (≤_TOOL_NAME_MAX) + str description (≤_TOOL_DESC_MAX); psych_profile is a str of len ≤ _PSYCH_PROFILE_MAX (blank OK); first_message is a str of len ≤ _FIRST_MESSAGE_MAX (blank OK). The id/name-required vs description/psych/first_message-may-be-blank asymmetry is INTENTIONAL — description defaults to "" via attach_tool; psych_profile/first_message are optional prose so only their LENGTH is bounded, not blankness (heid-review Gróa #8 + correctness-finder folds)
|
||||
POST: [POST-E5-2 state_change] design is unchanged — no mutation (INV-E5-4)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] TRY validate_ocean(design.ocean) — on OceanError, RAISE ExportError("persona.ocean", str(exc)) (reuse E2, no re-impl)
|
||||
2. [sequential, flexibility=prescriptive] TRY validate_role(design.role) — on RoleError, RAISE ExportError("role", str(exc)) (reuse E2 role canon)
|
||||
3. [branch] IF agent_name is not a non-blank str OR len > _AGENT_NAME_MAX: RAISE ExportError("agent_name", ...)
|
||||
4. [branch] IF system_prompt is not a non-blank str OR len > _SYSTEM_PROMPT_MAX: RAISE ExportError("system_prompt", ...) # the AUTHORED block, INV-E5-2
|
||||
5. [loop] FOR EACH tool in design.tools: IF id/name blank or over max, or description non-str/over max: RAISE ExportError(f"tools[{i}]", ...)
|
||||
6. [branch] IF psych_profile is non-str OR len > _PSYCH_PROFILE_MAX: RAISE ExportError("psych_profile", ...) # length only — blank OK (optional prose)
|
||||
7. [branch] IF first_message is non-str OR len > _FIRST_MESSAGE_MAX: RAISE ExportError("first_message", ...) # length only — blank OK
|
||||
8. [cleanup] RETURN None
|
||||
TESTS:
|
||||
minimal_ok [happy,tracer]: agent_name+system_prompt set, role="character", neutral OCEAN, no tools → no raise
|
||||
blank_name [adversarial]: agent_name="" → ExportError("agent_name")
|
||||
blank_prompt [adversarial]: system_prompt=" " → ExportError("system_prompt")
|
||||
prompt_too_long [boundary]: system_prompt of len _SYSTEM_PROMPT_MAX+1 → ExportError; len _SYSTEM_PROMPT_MAX → ok
|
||||
bad_ocean [adversarial]: ocean missing a key → ExportError("persona.ocean") (via validate_ocean)
|
||||
bad_role [adversarial]: role="wizard" (not in ROLE_CHOICES) → ExportError("role") (via validate_role)
|
||||
blank_role [adversarial]: role="" → ExportError("role")
|
||||
bad_tool_ref [adversarial]: a tool with id="" → ExportError("tools[0]")
|
||||
no_mutation [property]: a rejected design is byte-identical before/after the raise (INV-E5-4)
|
||||
psych_profile_length [boundary]: psych_profile="" → ok; len _PSYCH_PROFILE_MAX+1 → ExportError("psych_profile")
|
||||
first_message_length [boundary]: first_message len _FIRST_MESSAGE_MAX+1 → ExportError("first_message"); blank → ok
|
||||
whitespace_name_rejected [adversarial]: agent_name=" " → ExportError("agent_name") — deliberately stricter than the tool's minLength:1 (a whitespace-only name must not ship)
|
||||
length_bounds_parity [property]: any (name, prompt, tool, psych, first_message) LENGTH the E3a tool schema accepts is ≤ export's caps (shared constants); export is stricter ONLY on whitespace-blankness of required fields, never looser on length
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_native_payload(design: DesignObject) -> dict[str, Any]
|
||||
BRIEF: Map a DesignObject to a valid native agents.define payload (Frame Invariant 1). Emits agent_name + role + the AUTHORED system_prompt + persona{ocean, psychological_profile?} + motivational?. Copies mutable sub-structures (INV-E5-4). Assumes validate_exportable already passed (called by build_export_bundle).
|
||||
PRE: [PRE-E5-2 hard] design passed validate_exportable (OCEAN valid, role valid, name/prompt present) — build_export_bundle enforces this ordering
|
||||
POST: [POST-E5-3 return_value] result has agent_name == design.agent_name, role == design.role (∈ ROLE_CHOICES), and system_prompt == design.system_prompt (the AUTHORED block, INV-E5-2), and result["persona"]["ocean"] == a COPY of design.ocean
|
||||
POST: [POST-E5-4 return_value] result["role"] == design.role — the designed agent's model-role (one of the 4 ROLE_CHOICES); a valid agents.define required field
|
||||
POST: [POST-E5-5 return_value] persona.psychological_profile == design.psych_profile when psych_profile is non-blank, else the key is absent; it appears under persona and NOWHERE else (INV-E5-7)
|
||||
POST: [POST-E5-6 return_value] motivational == {"goals": copy, "fears": copy} when design.goals_fears is present AND at least one list is non-empty; else the key is absent (never an empty motivational block)
|
||||
STEPS:
|
||||
1. [setup] payload = {"agent_name": design.agent_name, "role": design.role, "system_prompt": design.system_prompt} # role emitted; system_prompt is the authored block (INV-E5-2)
|
||||
2. [sequential] persona = {"ocean": dict(design.ocean)} # COPY, not alias (INV-E5-4)
|
||||
3. [branch] IF design.psych_profile is a non-blank str: persona["psychological_profile"] = design.psych_profile # LOCKED b53 field; ONLY here (INV-E5-7)
|
||||
4. [sequential] payload["persona"] = persona
|
||||
5. [branch] IF design.goals_fears is not None AND (goals or fears non-empty): payload["motivational"] = {"goals": list(gf.goals), "fears": list(gf.fears)}
|
||||
6. [cleanup] RETURN payload # tools NOT here — they ride the sidecar / bind via Bifrost at session-create
|
||||
TESTS:
|
||||
authored_prompt [happy,tracer]: system_prompt authored + composed_preview differs → payload.system_prompt == authored, NOT composed_preview (INV-E5-2)
|
||||
role_emitted [happy]: role="thoughtful-character" → payload.role == "thoughtful-character" (POST-E5-4)
|
||||
ocean_copied [property]: mutate design.ocean after build → payload's ocean unchanged (INV-E5-4)
|
||||
psych_present [happy]: psych_profile set → persona.psychological_profile == it; it is the ONLY field carrying it (INV-E5-7)
|
||||
psych_absent [boundary]: psych_profile="" → no psychological_profile key
|
||||
motivational_present [happy]: goals_fears with goals=["x"] → motivational.goals == ["x"]
|
||||
motivational_absent [boundary]: goals_fears None → no motivational key; goals_fears with both lists empty → no motivational key
|
||||
no_tools_no_image [trace]: payload has no "tools" and no image field (they ride the sidecar / bind separately)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_sidecar(design: DesignObject) -> dict[str, Any]
|
||||
BRIEF: Assemble the soong-lab sidecar — the three artifacts the native schema has no home for: the persona portrait ref, the Bifrost tool manifest, and the D3 first_message. Copies the tool list (INV-E5-4).
|
||||
PRE: [PRE-E5-4 hard] design is a DesignObject (its portrait/tools/first_message fields are read as-is; no validation here — validate_exportable is the gate, called by build_export_bundle before this)
|
||||
POST: [POST-E5-7 return_value] result == {"portrait": <str|None>, "tools": [{"id","name","description"} per tool, copied], "first_message": design.first_message}; portrait == design.portrait.image_url IFF design.portrait.status == "ready", else None (a "ready" status with a None image_url therefore yields None — no crash; any non-"ready" status → None — heid-review fold Gróa #4)
|
||||
STEPS:
|
||||
1. [setup] portrait = design.portrait.image_url if design.portrait.status == "ready" else None
|
||||
2. [sequential] tools = [t.to_dict() for t in design.tools] # ToolRef.to_dict() — the shared {id,name,description} projection (dedups with serialize_design); it MUST emit exactly id/name/description, so if to_dict ever grows keys the sidecar spec must be revisited (heid-code-review fold)
|
||||
3. [cleanup] RETURN {"portrait": portrait, "tools": tools, "first_message": design.first_message}
|
||||
TESTS:
|
||||
ready_portrait [happy]: portrait.status="ready", image_url set → sidecar.portrait == the url
|
||||
unready_portrait [boundary]: portrait.status="generating" (url set) → sidecar.portrait is None (only ready ships)
|
||||
none_portrait [boundary]: portrait.status="none" → sidecar.portrait is None
|
||||
tools_manifest [happy,tracer]: two tools → sidecar.tools has both {id,name,description}
|
||||
tools_copied [property]: mutate design.tools after build → sidecar.tools unchanged (INV-E5-4)
|
||||
first_message [happy]: first_message set → sidecar.first_message == it
|
||||
```
|
||||
|
||||
```contract
|
||||
FN build_export_bundle(design: DesignObject, *, design_id: str, exported_at: str | None = None) -> dict[str, Any]
|
||||
BRIEF: The top-level export entrypoint — validate (strict, INV-E5-5), then assemble the versioned bundle: {schema_version, design_id, exported_at, ship:{native, sidecar}, resume}. Pure + deterministic (INV-E5-3); the caller supplies design_id + exported_at (no clock here). The resume half reuses serialize_design (the §6 state) so import round-trips. schema_version is NOT a caller param (heid-review fold) — it is ALWAYS EXPORT_SCHEMA_VERSION, so a bundle's version is never caller-forgeable; a future migration bumps the module constant. exported_at is an OPAQUE caller-supplied string (conventionally ISO-8601) — export does NOT parse or validate it (purity; the caller owns timestamp correctness).
|
||||
PRE: [PRE-E5-3 hard] design_id is a non-blank str (the durable library key) — a blank id RAISES ExportError("design_id", ...) (a bundle with no library key is unusable)
|
||||
POST: [POST-E5-8 exception] IF the design fails validate_exportable, the ExportError propagates and NO bundle is returned (INV-E5-5) — validation is BEFORE assembly
|
||||
POST: [POST-E5-9 return_value] returns {schema_version: EXPORT_SCHEMA_VERSION (always), design_id, exported_at, ship:{native: build_native_payload(design), sidecar: build_sidecar(design)}, resume: serialize_design(design)}; exported_at is the param verbatim (None → JSON null), unvalidated
|
||||
POST: [POST-E5-10 return_value] deterministic — identical (design, design_id, exported_at) → byte-identical json.dumps(result) given fixed dumps settings; the returned dict has a FIXED key insertion order (schema_version, design_id, exported_at, ship, resume), so a caller's json.dumps is stable (INV-E5-3); design unchanged (INV-E5-4)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] IF design_id is not a non-blank str: RAISE ExportError("design_id", "a non-blank design_id is required")
|
||||
2. [sequential] CALL validate_exportable(design) # strict gate BEFORE assembly (INV-E5-5) — raises propagate
|
||||
3. [sequential] native = build_native_payload(design); sidecar = build_sidecar(design); resume = serialize_design(design)
|
||||
4. [cleanup] RETURN {"schema_version": EXPORT_SCHEMA_VERSION, "design_id": design_id, "exported_at": exported_at, "ship": {"native": native, "sidecar": sidecar}, "resume": resume}
|
||||
TESTS:
|
||||
full_bundle [happy,tracer]: a complete design + design_id="d-1" → bundle has schema_version, design_id=="d-1", ship.native.agent_name, ship.native.role, ship.sidecar.first_message, resume.systemPrompt
|
||||
blank_design_id [adversarial]: design_id="" → ExportError("design_id") before any assembly
|
||||
invalid_design_no_bundle [adversarial]: a design with blank agent_name → ExportError propagates, no dict returned (POST-E5-8)
|
||||
deterministic [property]: build twice with the same (design, design_id, exported_at) → byte-identical json.dumps (INV-E5-3)
|
||||
exported_at_passthrough [trace]: exported_at="2026-07-13T00:00:00Z" → bundle.exported_at == it verbatim; None → null; a non-ISO "banana" is passed through unvalidated
|
||||
schema_version_not_a_param [trace]: build_export_bundle(..., schema_version="banana") raises TypeError — schema_version is fixed, never caller-supplied (heid-review fold)
|
||||
resume_roundtrips [property]: resume half == serialize_design(design) — every editable field present for import (incl. role)
|
||||
no_mutation [property]: design byte-identical before/after build (INV-E5-4)
|
||||
schema_version_present [trace]: bundle.schema_version == EXPORT_SCHEMA_VERSION (INV-E5-6)
|
||||
```
|
||||
|
||||
## Integration points
|
||||
|
||||
**R1 — relocate `serialize_design` out of `web.py` (agent-discretion refactor,
|
||||
no public-surface change).** The resume half reuses the §6 DesignObject
|
||||
serialization, but `serialize_design` currently lives in `soong_lab.web`
|
||||
(Starlette-coupled). Importing `web.py` into `export` would drag Starlette +
|
||||
the orchestrator into a pure module. Fix: **move `serialize_design` to
|
||||
`soong_lab.design`** (it is a pure `DesignObject → dict` mapping with no web
|
||||
dependency — it belongs with the model; add `role` to its output), and update the
|
||||
two consumers to import it from there. Blast radius (confirmed via grep):
|
||||
`web.py` (define → import; 3 call-sites unchanged), `tests/test_web.py:23`
|
||||
(import path), and the new `export` consumer. Behavior-identical;
|
||||
`web_surface.contract.md` gets a one-line note. No-backwards-compat: the old
|
||||
location is deleted, all refs updated in the same commit.
|
||||
|
||||
**Companion prerequisite slice — the `role` field + `set_role` tool (contracts
|
||||
updated in THIS pass).** Export emits `design.role`, so the field + its tool must
|
||||
exist. This slice (governed by the sibling contracts, amended alongside this one):
|
||||
- `soong_lab.design` (design_object.contract.md): a `role` field on
|
||||
`DesignObject` (default `"character"`); a `ROLE_CHOICES` enum canon +
|
||||
`validate_role`, held as an in-code module constant (mirroring the OCEAN
|
||||
adjective canon); `new_design()` sets `role="character"`; `serialize_design`
|
||||
adds `role`.
|
||||
- `soong_lab.bifrost` (bifrost_server.contract.md): a new `set_role(_ctx, role)`
|
||||
design tool (the 9th), `input_schema` an `enum` of the 4 values; the handler
|
||||
sets `design.role` after membership validation.
|
||||
The behavioral CODE for this slice lands in the TDD phase after
|
||||
`/heid-contract-review`, alongside `soong_lab.export`.
|
||||
|
||||
**Bifrost export tool (`_make_export` in bifrost/tools.py) — in scope.** Replace
|
||||
the deferred stub with: get the session's design from the store, then
|
||||
`build_export_bundle(design, design_id=<source>, exported_at=<stamp>)` and
|
||||
return the bundle (or a compact confirmation carrying it). The `design_id`
|
||||
source is the per-design-sessions seam (open_question C) — until it lands, the
|
||||
tool may pass the session_id as a provisional design_id (a documented
|
||||
placeholder, NOT a silent default). The tool handler is the impure boundary that
|
||||
stamps `exported_at` (clock) and supplies `design_id`, keeping
|
||||
`soong_lab.export` pure.
|
||||
|
||||
**`/api/export` endpoint + web/api.js shim — NOT in this contract (open_question
|
||||
D).** The browser 'Export Asset' button calls `api.export()`, today a
|
||||
client-side shim assembling a NON-native mock bundle. The real path is a thin
|
||||
`GET /api/export` on `web.py` → `build_export_bundle(orchestrator.get_design(),
|
||||
…)` → JSON → the modal's native/sidecar panes render it. That amends
|
||||
`web_surface.contract.md`; it is a follow-up slice in the same epic, specified
|
||||
here only so the seam is visible.
|
||||
|
||||
## Downstream epics (NOT this contract)
|
||||
|
||||
- **Library persistence** (decision #5) — writing the returned bundle to the
|
||||
server-local single-user JSON dir on corviduo-dev, keyed by `design_id`; the
|
||||
minimal recent-designs picker.
|
||||
- **Import** (decision #6) — reading a bundle: lenient on unknown metadata
|
||||
(INV-E5-6), STRICT re-validation of the export-critical fields (the import-side
|
||||
mirror of `validate_exportable`), reconstructing a DesignObject from the
|
||||
`resume` half.
|
||||
- **Per-design-sessions** (decision #2) — the `design_id` generator + the
|
||||
fresh-WT-session-per-open lifecycle (also caps the #355 accumulation).
|
||||
+384
@@ -0,0 +1,384 @@
|
||||
---
|
||||
contract_version: "2.1"
|
||||
module: "soong_lab.importer"
|
||||
purpose: "Reconstruct a DesignObject from an export bundle's `resume` half — the inverse of soong_lab.export. HYBRID validation (settled decision #6): LENIENT on unknown metadata (unknown top-level bundle keys, unknown keys inside resume, any schema_version), STRICT re-validation of the export-critical fields (OCEAN, role ∈ ROLE_CHOICES, agent_name, system_prompt length, tool-refs, psych/first_message length) surfaced ON IMPORT so a truncated or tampered bundle fails EARLY, not after more tuning. Pure + deterministic: no I/O, no persistence, no network, no clock (library read + the /api/import endpoint + the reopen lifecycle are separate downstream epics)."
|
||||
depends_on:
|
||||
- "soong_lab.design" # DesignObject/ToolRef/Portrait/GoalsFears + serialize_design (the round-trip partner) + ROLE_CHOICES/UNSET_ROLE + the shared field-bound constants
|
||||
- "soong_lab.export" # validate_exportable + ExportError — the strict export-critical gate is REUSED, not re-implemented (no-drift, INV-I-1)
|
||||
used_by:
|
||||
- "soong_lab.web" # FUTURE (import epic) — the POST /api/import endpoint parses the uploaded bundle JSON → import_bundle → seed a session (out of scope here, open_question D)
|
||||
- "soong_lab.soong" # FUTURE (per-design-sessions) — the reopen lifecycle imports a stored bundle, opens a fresh WT session, seeds the design-state summary (out of scope, decision #2)
|
||||
language: "python"
|
||||
complexity: "medium"
|
||||
estimated_loc: 170
|
||||
confidence: 0.83
|
||||
assumptions:
|
||||
- "Import consumes a Python dict (a Mapping), NOT raw bytes/JSON text. The JSON parse (json.loads at the /api/import endpoint or the library-read layer) happens UPSTREAM; import operates on the already-parsed structure, exactly as export RETURNS a Python dict the caller json.dumps'es. So the round-trip contract is over Python dicts: import_bundle(build_export_bundle(d, design_id=…)) == d, with no JSON layer in between (the JSON boundary — float/int coercion, encoding — is the endpoint/library epic's concern, INV-I-5 note)."
|
||||
- "The `resume` half is the ONLY source of truth on import (settled decision #4 — resume is 'what you reopen to keep tuning'). The `ship` half is a re-derivable deployment artifact; import IGNORES it. The reopen path re-exports from the reconstructed design, regenerating ship, so a ship↔resume mismatch is harmless — resume wins (INV-I-5). No cross-check in v1."
|
||||
- "The export-critical gate on import IS soong_lab.export.validate_exportable, imported and reused verbatim — NOT a re-implemented import-side validator. This guarantees import can never drift looser than export: the exact fields export refuses to ship are the exact fields import refuses to accept (INV-I-1). ExportError is caught and re-raised as BundleImportError so callers get an import-shaped error while the validation authority stays single-sourced."
|
||||
- "role is a first-class DesignObject field (operator ruling 2026-07-13), one of the curated ROLE_CHOICES, set by the E3a set_role tool. A resume carries `role`; import restores it and validate_role (via validate_exportable) rejects UNSET_ROLE ('') or any non-member — you cannot re-import an unclassified design, same as you cannot export one."
|
||||
- "composed_preview + disposition_phrase ride the resume so a reopen renders instantly (export.contract §resume). Import TRUSTS these verbatim (INV-I-8) — it does NOT call recompute. Re-derivation from ocean+prompt is the reopen lifecycle's concern (per-design-sessions), not import's. For a legitimately-exported bundle they are already self-consistent; a hand-tampered preview is design-time-only and is overwritten on the next set_ocean/edit_prompt recompute."
|
||||
open_questions:
|
||||
- "[A — RESOLVED, operator 2026-07-13] Module name is `soong_lab.importer` (operator chose it over `soong_lab.ingest`; keyword-safe agent-noun mirroring `export`). The export contract's forward-reference `used_by: soong_lab.import` — an unusable Python-keyword path (`import soong_lab.import` is a SyntaxError) — is corrected to `soong_lab.importer` in the same commit (done). SETTLED: the Constraints hard-require reflects the decision, not a still-open recommendation (heid-review Gróa#1 reconcile open-vs-locked)."
|
||||
- "[B — SETTLED, agent-discretion] Error type is `BundleImportError(field, detail)`, mirroring export's `ExportError(field, detail)`. Deliberately NOT `ImportError` — that shadows the Python builtin, a foot-gun for an import module. The Constraints hard-require reflects the decision, not a still-open recommendation (heid-review Gróa#1)."
|
||||
- "[C — presence vs default, agent-discretion, notable] For the export-critical resume keys (agentName, role, systemPrompt, ocean) a MISSING key is a hard reject (INV-I-7), NOT a silent default. Rationale: a missing `ocean` would default to a VALID neutral OCEAN and pass validate_exportable — silently masking trait loss from a truncated bundle. Rejecting on absence fails loudly + consistently (the 'fail early on import' the decision wants). Rejected alternative: reconstruct-with-defaults-then-validate (inconsistent — ocean slips through while name/role are caught by validation)."
|
||||
- "[D — scope] This contract = the PURE reconstruction (deserialize_design) + the strict entrypoint (import_bundle) + BundleImportError. The POST /api/import endpoint (amends web_surface.contract.md), the reopen Bifrost tool / session-open wiring (per-design-sessions), and reading a bundle off the library JSON dir (library epic) are ALL downstream — specified here only as the integration seam so it is visible. Nothing in this contract does I/O."
|
||||
- "[E — schema_version tolerance] `schema_version` is read at the bundle TOP LEVEL only (where export stamps EXPORT_SCHEMA_VERSION) — import does not look for it inside `resume`. v1 tolerates ANY top-level value (present or absent) and reads the v1 resume key set regardless (INV-I-2, INV-E5-6 add-only-friendly). 'Tolerate any version' means forward-compat with ADD-ONLY future changes — NOT a promise of semantic compatibility with a bundle whose meaning changed (heid-review Gróa#5/Hulda). A future policy — reject an incompatible MAJOR version, or dispatch to a version-specific deserializer — is deferred to when a second schema version actually exists. v1 has exactly one shape."
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
Import is the SECOND half of the operator-accepted (2026-07-13) export/import/library
|
||||
design — the block that expands the locked single-agent frame into a multi-pass
|
||||
tuning loop (design → export → **reopen → tune** → keep a library). Where
|
||||
`soong_lab.export` turns a finished `DesignObject` into a versioned bundle, this
|
||||
module does the inverse: it takes a bundle's **`resume`** half and reconstructs an
|
||||
editable `DesignObject` you can drop back into a session and keep tuning.
|
||||
|
||||
The reconstruction is **HYBRID-validated** (settled decision #6 — the load-bearing
|
||||
import decision):
|
||||
|
||||
- **LENIENT on unknown metadata.** Unknown top-level bundle keys, unknown keys
|
||||
inside `resume`, and any `schema_version` (present or absent) are tolerated —
|
||||
import reads only the keys it knows (INV-I-2, mirroring the export bundle's
|
||||
add-only-friendly `INV-E5-6`). A bundle from a future soong-lab that added
|
||||
fields still imports.
|
||||
- **STRICT on the export-critical fields.** OCEAN, `role`, `agent_name`,
|
||||
`system_prompt`, tool-refs, and the psych/first_message length are re-validated
|
||||
**on import** by REUSING `soong_lab.export.validate_exportable` verbatim (INV-I-1)
|
||||
— so the exact fields export refuses to *ship* are the exact fields import
|
||||
refuses to *accept*, and import can never drift looser than export. A bad field
|
||||
is surfaced immediately (fail EARLY), not after the operator has tuned for
|
||||
another ten minutes against a design that was never valid.
|
||||
|
||||
**The round-trip is the load-bearing contract between the two modules** (INV-I-3):
|
||||
for any exportable design `d`,
|
||||
|
||||
```
|
||||
import_bundle(build_export_bundle(d, design_id="…")) == d
|
||||
deserialize_design(serialize_design(d)) == d
|
||||
```
|
||||
|
||||
This is what makes "export then reopen" lossless. `serialize_design`
|
||||
(relocated to `soong_lab.design` in the export pass, R1) is the forward half;
|
||||
`deserialize_design` here is its exact inverse.
|
||||
|
||||
**Import reads the `resume` half ONLY.** The `ship` half (native `agents.define`
|
||||
payload + sidecar) is a re-derivable deployment artifact — the reopen path
|
||||
re-exports from the reconstructed design, regenerating `ship`. So import ignores
|
||||
`ship` entirely (INV-I-5); a tampered `ship` that disagrees with `resume` is
|
||||
harmless (resume wins, ship regenerated). No cross-check in v1.
|
||||
|
||||
**What this contract does NOT do** (open_question D): no file read, no HTTP, no
|
||||
session seeding. The `POST /api/import` endpoint, the reopen Bifrost tool /
|
||||
session-open wiring, and reading a bundle off the library JSON dir are downstream
|
||||
epics. This module is the pure, side-effect-free reconstruction core those epics
|
||||
build on — exactly as `soong_lab.export` is the pure builder its endpoint wraps.
|
||||
|
||||
## Data flow
|
||||
|
||||
**In:** a bundle `dict` (a Mapping — already `json.loads`'d upstream). **Out:** a
|
||||
validated, ready-to-reopen `DesignObject`. **On disk / network:** NONE. Import is
|
||||
pure: the structural gate (bundle/resume/ocean are dicts, tools a list-of-dicts),
|
||||
the tolerant reconstruction, and the strict `validate_exportable` re-check are all
|
||||
in-memory; no clock, no randomness, no file, no HTTP.
|
||||
|
||||
### The resume key set consumed (v1.0)
|
||||
|
||||
Import reconstructs from exactly the `serialize_design` output (the §6 camelCase
|
||||
state — pinned in export.contract §resume, restated here so this contract is
|
||||
self-contained):
|
||||
|
||||
```
|
||||
resume = {
|
||||
"agentName": <str>, # EXPORT-CRITICAL — presence required (INV-I-7)
|
||||
"role": <str ∈ ROLE_CHOICES>, # EXPORT-CRITICAL — presence required; validate_role gates value
|
||||
"systemPrompt": <str>, # EXPORT-CRITICAL — presence required; the AUTHORED block
|
||||
"ocean": {O,C,E,A,N}, # EXPORT-CRITICAL — presence required; validate_ocean gates value
|
||||
"tools": [{id,name,description}], # optional (absent → []); each ref value-gated by validate_exportable
|
||||
"composedPreview": <str>, # design-time-derived — TRUSTED verbatim, re-derivable (INV-I-8)
|
||||
"dispositionPhrase": <str>, # design-time-derived — TRUSTED verbatim, re-derivable (INV-I-8)
|
||||
"firstMessage": <str>, # optional prose — length-gated only (blank OK)
|
||||
"psychProfile": <str>, # optional prose — length-gated only (blank OK)
|
||||
"portrait": {status, styleMode, imageUrl?, jobId?}, # optional (absent → default Portrait())
|
||||
"goalsFears": {goals,fears} | null # optional (absent/null → None)
|
||||
}
|
||||
```
|
||||
|
||||
**Critical vs optional (the presence rule, INV-I-7).** Read the two functions as a
|
||||
boundary (all three review arms flagged that the prose blurs it): the INNER
|
||||
`deserialize_design` is total and DEFAULTS every missing key (a missing `ocean` →
|
||||
neutral) — it NEVER rejects; the OUTER, public `import_bundle` PRESENCE-CHECKS the
|
||||
export-critical keys and REJECTS a missing one BEFORE it ever calls deserialize. So
|
||||
"import defaults a missing ocean to neutral" is FALSE for the public path
|
||||
(`import_bundle` rejects it, INV-I-7) — the neutral default lives ONLY inside the
|
||||
never-directly-shipped inner function (heid-review 3/3: POST-I-3 vs INV-I-7 read as
|
||||
contradictory in isolation). `agentName`, `role`, `systemPrompt`, `ocean` are
|
||||
**presence-required** — a missing one is a truncated / corrupt bundle and raises
|
||||
`BundleImportError`, because defaulting them would either be caught inconsistently
|
||||
(name/role/prompt default to values `validate_exportable` rejects) or silently
|
||||
masked (`ocean` defaults to a VALID neutral OCEAN — silent trait loss). Every other
|
||||
key is optional and defaults to the `DesignObject` default when absent. `tools`/`portrait`/`goalsFears`, when present, must be well-formed SHAPES —
|
||||
`tools` a list-of-objects, `ocean`/`portrait` an object, `goalsFears` null or an
|
||||
object whose present `goals`/`fears` are lists — structural mismatches raise a clean
|
||||
`BundleImportError`, never a leaked builtin `TypeError`/`ValueError` (INV-I-6
|
||||
robustness). These SHAPE gates all exist to prevent SILENT DATA LOSS (heid-bug-hunt
|
||||
Gróa#1/#2: a malformed portrait/goalsFears would otherwise coerce to a default in
|
||||
`deserialize_design` and slip PAST `validate_exportable`, since both are
|
||||
non-export-critical — the same loss the `tools` gate was added to close). Import does
|
||||
NOT validate their VALUE contents — portrait `status`/`styleMode` enums or goals/fears
|
||||
item contents are not export-critical (E4 / the UI own portrait validity); those
|
||||
round-trip as-is (heid-review Gróa#6).
|
||||
|
||||
## Invariants
|
||||
|
||||
- **INV-I-1** [hard]: The strict export-critical re-validation IS
|
||||
`soong_lab.export.validate_exportable`, imported and reused verbatim — NO
|
||||
re-implementation, no parallel import-side validator. Import therefore can NEVER
|
||||
be looser than export: OCEAN (`validate_ocean`), role (`validate_role`, ∈
|
||||
ROLE_CHOICES), `agent_name` (non-blank, ≤`AGENT_NAME_MAX`), `system_prompt`
|
||||
(non-blank, ≤`SYSTEM_PROMPT_MAX`), every tool-ref (id/name non-blank + bounded,
|
||||
description bounded), and the psych/first_message LENGTH are all gated by the
|
||||
same code export uses. An `ExportError` from that gate is caught and re-raised
|
||||
as `BundleImportError(same field, same detail)` — same field granularity,
|
||||
import-shaped type.
|
||||
- **INV-I-2** [hard]: LENIENT on unknown metadata (settled decision #6, mirrors
|
||||
INV-E5-6). Unknown top-level bundle keys, unknown keys inside `resume`, and any
|
||||
`schema_version` value (present or absent) are tolerated — import reads only the
|
||||
keys it knows and ignores the rest. A future-schema bundle that ADDED fields
|
||||
still imports.
|
||||
- **INV-I-3** [hard]: ROUND-TRIP — for any `DesignObject` `d` that passes
|
||||
`validate_exportable`, `deserialize_design(serialize_design(d))` reconstructs an
|
||||
EQUAL `DesignObject` (dataclass `==` over every field), and
|
||||
`import_bundle(build_export_bundle(d, design_id=…))` `== d`. This is the lossless
|
||||
export↔import contract. (Equality is over Python structures; the JSON encode/decode
|
||||
boundary is the endpoint/library epic's concern, not this module's.)
|
||||
- **INV-I-4** [hard]: NO-ALIAS — the reconstructed `DesignObject` holds COPIES of
|
||||
every mutable sub-structure (the ocean dict, the tools list, the goals/fears
|
||||
lists) drawn from the bundle, never aliases. A later mutation of the input bundle
|
||||
cannot change an already-imported design (the mirror of export's INV-E5-4). The
|
||||
copies are SHALLOW (the CONTAINERS) — sufficient because legit export values are
|
||||
scalars (strings/floats), and a hostile NESTED mutable (a list-valued tool id, a
|
||||
dict-valued goal) is rejected by `validate_exportable` before any successful import
|
||||
(heid-bug-hunt Gróa#5/Hulda#1: the invariant's letter holds; deep-copy is deferred
|
||||
unless nested mutables ever become in-contract).
|
||||
- **INV-I-5** [hard]: Import reads the `resume` half and NOWHERE else — `ship`
|
||||
(native + sidecar) is ignored (it is re-derivable; the reopen path re-exports).
|
||||
No ship↔resume consistency check in v1; on any disagreement, resume is
|
||||
authoritative.
|
||||
- **INV-I-6** [hard]: `deserialize_design` is TOTAL — it never raises on any input
|
||||
Mapping. Hostile shapes (a string `ocean`, an int `tools`, a list `portrait`, a
|
||||
string `goalsFears`, or a dict `goalsFears` whose `goals`/`fears` is a non-list)
|
||||
are coerced/defaulted, not crashed — in particular EVERY `list(...)`/`dict(...)`
|
||||
coercion is type-GUARDED first: a non-list `goals` becomes `[]` (never
|
||||
`list(7)`→TypeError nor `list("ab")`→`["a","b"]`), a non-dict `ocean` is held
|
||||
verbatim (never `dict("nope")`→ValueError). ALL rejection happens in
|
||||
`import_bundle` (its structural gate + `validate_exportable`). Non-export-critical
|
||||
fields that are missing or mistyped default to the `DesignObject` default;
|
||||
export-critical VALUES are held AS-READ (no silent type-coercion) so
|
||||
`validate_exportable` judges them — with ONE structural exception: `import_bundle`
|
||||
pre-checks that `ocean` is a dict (so `deserialize_design`'s `dict()` copy is
|
||||
safe), so `ocean` has a structural judge (`import_bundle`) AND a value judge
|
||||
(`validate_ocean`), while `agent_name`/`role`/`system_prompt` are judged by value
|
||||
alone — "single judge" is exact for those three, not for `ocean` (heid-review
|
||||
Gróa#2/#4, Hulda, Regin#3). (Mirrors `recompute`'s hostile-input tolerance in derive.py.)
|
||||
- **INV-I-7** [hard]: PRESENCE — `import_bundle` requires the export-critical
|
||||
resume keys `agentName`, `role`, `systemPrompt`, `ocean` to be PRESENT; a missing
|
||||
one raises `BundleImportError(f"resume.{key}", …)` (a truncated bundle fails
|
||||
loudly, not by silently defaulting — especially `ocean`, whose neutral default
|
||||
would mask trait loss). `tools` absent → `[]` (an empty toolset is a valid
|
||||
design). This is the explicit-over-implicit choice: reject a missing critical key
|
||||
rather than accept a silently-defaulted one.
|
||||
- **INV-I-8** [hard]: Import does NOT re-derive `composed_preview` /
|
||||
`disposition_phrase` — it TRUSTS the resume values verbatim (they ride the resume
|
||||
for instant reopen-render, per export.contract). `recompute` is the reopen
|
||||
lifecycle's concern (per-design-sessions), not import's. For a legit bundle these
|
||||
are already self-consistent; a tampered preview is design-time-only and is
|
||||
overwritten on the next `set_ocean`/`edit_prompt`. Import makes NO consistency
|
||||
guarantee between the trusted preview and `ocean`+`system_prompt`: for a
|
||||
hand-edited resume the two may diverge until the first recompute self-heals them —
|
||||
round-trip equality (INV-I-3) is "== the DesignObject the bundle encodes," NOT
|
||||
"the preview matches a fresh recompute" (heid-review Gróa#8).
|
||||
|
||||
## Constraints
|
||||
|
||||
- **[correctness]** The export-critical re-validation reuses
|
||||
`soong_lab.export.validate_exportable` (INV-I-1) — import declares no length
|
||||
numbers, no role list, no OCEAN shape of its own. The shared field-bound
|
||||
constants + `ROLE_CHOICES` live in `soong_lab.design`; the strict gate lives in
|
||||
`soong_lab.export`; import imports both. Zero duplicated validation logic → zero
|
||||
drift.
|
||||
- **[style]** Pure — NO I/O (no clock, no file, no HTTP, no randomness). Import is
|
||||
a total function of its input Mapping.
|
||||
- **[explicit]** `BundleImportError` does NOT shadow the builtin `ImportError`
|
||||
(open_question B). The module is `soong_lab.importer`, NOT `soong_lab.import` —
|
||||
`import` is a Python keyword and unusable as a module path (open_question A).
|
||||
- **[robustness]** `deserialize_design` guards types BEFORE any `dict()` /
|
||||
iteration: a non-dict `ocean` is held as-read (never `dict("nope")`, which raises
|
||||
a raw `ValueError`); a non-list `tools` yields `[]`; a non-dict `portrait` /
|
||||
`goalsFears` falls back to the default (`import_bundle`'s structural gates reject a
|
||||
present-but-malformed portrait/goalsFears BEFORE this, so the default-fallback is
|
||||
reachable only for a MISSING field). This keeps every rejection path flowing
|
||||
through `BundleImportError` — a caller never sees a leaked builtin exception.
|
||||
- **[robustness]** The "no builtin ever leaks from the public entrypoint" guarantee
|
||||
for hostile export-critical SCALAR types (a non-str `agent_name`/`role`/
|
||||
`system_prompt`/`psych_profile`/`first_message`, or a `None`) is provided JOINTLY by
|
||||
(a) holding them as-read + (b) `validate_exportable` being TOTAL over hostile scalar
|
||||
types — every check `isinstance`-guards BEFORE any `.strip()`/`len()`, and the `or`
|
||||
short-circuits, so a hostile scalar yields a clean `ExportError` (→ `BundleImportError`),
|
||||
never a raw `TypeError`/`AttributeError`. This is an EXPLICIT cross-module coupling
|
||||
(`soong_lab.export` guarantees the totality): import does NOT blanket-catch
|
||||
non-`ExportError` (that would mask real programming errors); the coupling is instead
|
||||
PINNED by a hostile-scalar test through `import_bundle` (heid-bug-hunt 3/3 —
|
||||
Gróa#3/Hulda#2/Regin#1). If `validate_exportable` ever did an unguarded string op, that
|
||||
test fails.
|
||||
- **[explicit]** `import_bundle` is the PUBLIC entrypoint that runs the full gate
|
||||
(structure → presence → reconstruct → `validate_exportable`). `deserialize_design`
|
||||
is exposed for the round-trip test + direct reuse but PERFORMS NO validation
|
||||
(PRE-I-1) — a direct caller that skips `import_bundle` owns re-validation (the
|
||||
mirror of export's build_native_payload/build_sidecar assuming a validated design).
|
||||
- **[explicit]** Two-LAYER error-field convention (heid-review Regin#6): a
|
||||
STRUCTURAL / PRESENCE rejection raised BY `import_bundle` names the offending
|
||||
BUNDLE key in camelCase with a `resume.` prefix (`resume.agentName` missing,
|
||||
`resume.ocean` not-an-object) — it reports the bundle's JSON shape. A VALUE
|
||||
rejection from the reused `validate_exportable` names the `DesignObject` field in
|
||||
snake_case with no prefix (`agent_name` blank, `persona.ocean` out of range) — it
|
||||
reports the design's validity. Same logical field, two deliberate `.field` forms
|
||||
encoding WHICH LAYER failed (bundle-structure vs design-value); a caller switching
|
||||
on `err.field` MUST handle both, and `err.detail` disambiguates. Tests assert on
|
||||
`.field` (pinned); `.detail` wording is human-facing and NOT pinned (heid-review
|
||||
Hulda) — intentional, not drift.
|
||||
|
||||
```contract
|
||||
FN deserialize_design(resume: Mapping[str, Any]) -> DesignObject
|
||||
BRIEF: The pure, TOTAL inverse of serialize_design — reconstruct a DesignObject from the §6 camelCase resume half. Reads each known key with a type-guard; missing/mistyped NON-export-critical fields default to the DesignObject default; export-critical fields are held AS-READ (no coercion) for validate_exportable to judge later; unknown keys are ignored (INV-I-2). Copies every mutable sub-structure (INV-I-4). NEVER raises (INV-I-6) — it performs NO validation (that is import_bundle's job). deserialize_design(serialize_design(d)) == d for any exportable d (INV-I-3).
|
||||
PRE: [PRE-I-1 hard] resume is a Mapping (import_bundle guarantees a dict before calling; a direct caller passes any Mapping — a non-Mapping is a caller error, but the function still must not crash on a Mapping of hostile VALUES)
|
||||
POST: [POST-I-1 return_value] returns a DesignObject whose fields map 1:1 from the camelCase keys: agentName→agent_name, role→role, systemPrompt→system_prompt, composedPreview→composed_preview, firstMessage→first_message, ocean→ocean (COPY), dispositionPhrase→disposition_phrase, psychProfile→psych_profile, tools→[ToolRef,…] (COPY of the list, each ref rebuilt), portrait→Portrait(...), goalsFears→GoalsFears(...) | None
|
||||
POST: [POST-I-2 return_value] ocean, tools, goals, and fears are COPIES of the resume values — mutating resume after the call never changes the returned design (INV-I-4)
|
||||
POST: [POST-I-3 return_value] export-critical fields (agentName, role, systemPrompt, ocean) are held AS-READ (missing → the DesignObject default; present-but-mistyped → the value verbatim, so validate_exportable is the single judge); design-time-derived composedPreview/dispositionPhrase coerce a non-str to "" (re-derivable, keep the object clean); firstMessage/psychProfile are held as-read (validate_exportable length-gates them). ocean is copied IFF it is a dict, else held verbatim (NEVER dict("nope"))
|
||||
POST: [POST-I-4 state_change] performs NO validation and NEVER raises on a Mapping input (INV-I-6)
|
||||
STEPS:
|
||||
1. [setup] agent_name = resume.get("agentName", ""); role = resume.get("role", UNSET_ROLE); system_prompt = resume.get("systemPrompt", "") # export-critical — held as-read, no coercion
|
||||
2. [sequential] composed_preview = resume["composedPreview"] if it is a str else ""; disposition_phrase = resume["dispositionPhrase"] if it is a str else "" # design-time-derived, re-derivable → coerce clean
|
||||
3. [sequential] first_message = resume.get("firstMessage", ""); psych_profile = resume.get("psychProfile", "") # optional prose — held as-read, length-gated by validate_exportable
|
||||
4. [branch] raw_ocean = resume.get("ocean"); ocean = dict(raw_ocean) if isinstance(raw_ocean, dict) else (raw_ocean if raw_ocean is not None else _neutral_ocean()) # COPY iff dict; else held verbatim for validate_ocean to reject (guard BEFORE dict(), INV-I-6 robustness)
|
||||
5. [loop] raw_tools = resume.get("tools"); tools = [(ToolRef(id=t.get("id",""), name=t.get("name",""), description=t.get("description","")) if isinstance(t, dict) else ToolRef(id="", name="", description="")) for t in raw_tools] IF isinstance(raw_tools, list) else [] # non-list → []; a non-dict item maps to a BLANK ToolRef (NOT skipped) so a direct caller who re-validates fails loud on the blank id rather than silently losing a tool (heid-review Gróa#7); import_bundle structurally rejects both cases upstream
|
||||
6. [branch] raw_portrait = resume.get("portrait"); portrait = Portrait(status=raw_portrait.get("status","none"), style_mode=raw_portrait.get("styleMode","cartoon"), image_url=raw_portrait.get("imageUrl"), job_id=raw_portrait.get("jobId")) IF isinstance(raw_portrait, dict) else Portrait() # use raw_portrait (heid-review Regin#2 — the `rp` working-name was unbound); imageUrl/jobId absent → None (round-trips serialize's None-omission)
|
||||
7. [branch] raw_gf = resume.get("goalsFears"); IF isinstance(raw_gf, dict): g = raw_gf.get("goals"); f = raw_gf.get("fears"); goals_fears = GoalsFears(goals=(list(g) if isinstance(g, list) else []), fears=(list(f) if isinstance(f, list) else [])) ELSE: goals_fears = None # use raw_gf (heid-review Regin#2 — `gf` was unbound); a non-LIST goals/fears → [], NEVER list(7)→TypeError (totality, INV-I-6) and NEVER list("ab")→["a","b"] (silent char-split, heid-review Gróa#2/Hulda); null/absent → None; COPY the lists (INV-I-4)
|
||||
8. [cleanup] RETURN DesignObject(agent_name, role, system_prompt, composed_preview, ocean, disposition_phrase, tools, portrait, first_message, psych_profile, goals_fears)
|
||||
TESTS:
|
||||
roundtrip_full [property,tracer]: a fully-populated exportable design d (name, role, prompt, non-neutral ocean, 2 tools, ready portrait w/ url+job, first_message, psych, goalsFears) → deserialize_design(serialize_design(d)) == d
|
||||
roundtrip_minimal [property]: minimal design (name+prompt+role, neutral ocean, no tools/portrait-url/gf) → round-trips == d
|
||||
copies_not_aliases [property]: deserialize, then mutate resume["ocean"]["O"] and append to resume["tools"] → the returned design's ocean + tools are unchanged (INV-I-4)
|
||||
total_on_hostile [property]: deserialize_design({"ocean":"nope","tools":7,"portrait":[],"goalsFears":"x","agentName":123}) does NOT raise; returns a DesignObject (ocean=="nope" held verbatim, tools==[], portrait==Portrait(), goals_fears is None, agent_name==123) — INV-I-6
|
||||
total_on_hostile_goalsfears [property]: deserialize_design({"goalsFears":{"goals":7,"fears":"abc"}}) does NOT raise (the totality-breaking case heid-review Gróa#2/Hulda caught) → goals_fears==GoalsFears([],[]) (non-list goals→[] not list(7)→TypeError; non-list fears→[] not list("abc")→["a","b","c"]) — INV-I-6
|
||||
tools_nondict_item_blank [boundary]: deserialize_design({"tools":[{"id":"a","name":"n"},7]}) → tools==[ToolRef("a","n",""), ToolRef("","","")] — the non-dict item maps to a BLANK ToolRef, NOT skipped (heid-review Gróa#7), so a direct caller re-validating fails loud on the blank id
|
||||
empty_resume [boundary]: deserialize_design({}) → DesignObject() all-defaults (role==UNSET_ROLE, neutral ocean, no tools) — total, no raise
|
||||
portrait_none_fields [boundary]: resume.portrait without imageUrl/jobId → Portrait.image_url is None, Portrait.job_id is None
|
||||
goalsfears_null [boundary]: resume.goalsFears is None → design.goals_fears is None; goalsFears={} → GoalsFears([],[])
|
||||
roundtrip_goalsfears_empty [property]: a design with goals_fears==GoalsFears([],[]) → deserialize_design(serialize_design(d)).goals_fears == GoalsFears([],[]) (empty, NOT None) — locks the null-vs-{} distinction (heid-review Regin#4)
|
||||
preview_trusted [trace]: resume.composedPreview="CUSTOM", dispositionPhrase="odd" → design.composed_preview=="CUSTOM", disposition_phrase=="odd" (NOT re-derived, INV-I-8)
|
||||
unknown_keys_ignored [trace]: resume with an extra "futureField":123 → deserialize ignores it, no crash (INV-I-2)
|
||||
```
|
||||
|
||||
```contract
|
||||
FN import_bundle(bundle: Mapping[str, Any]) -> DesignObject
|
||||
BRIEF: The public entrypoint — the mirror of build_export_bundle. Runs the full gate: STRUCTURE (bundle/resume are dicts, ocean is a dict, tools is a list-of-dicts) → PRESENCE (the export-critical resume keys, INV-I-7) → reconstruct (deserialize_design) → STRICT re-validate (validate_exportable, reused verbatim, INV-I-1). LENIENT on unknown metadata + any schema_version (INV-I-2). Reads ONLY resume; ignores ship (INV-I-5). Returns a DesignObject that PASSES validate_exportable — ready to reopen. Every rejection is a BundleImportError(field, detail); no builtin exception ever leaks.
|
||||
PRE: [PRE-I-2 hard] bundle is a Mapping (a non-Mapping raises BundleImportError("bundle", …), never a bare TypeError)
|
||||
POST: [POST-I-5 exception] raises BundleImportError(field, detail) — with NO DesignObject returned — if ANY: bundle is not a Mapping ("bundle"); bundle["resume"] is missing or not a Mapping ("resume"); any of agentName/role/systemPrompt/ocean is absent from resume ("resume.<key>", INV-I-7); resume["ocean"] is present-but-not-a-dict ("resume.ocean"); resume["tools"] is present-but-not-a-list or contains a non-dict item ("resume.tools"); resume["portrait"] is present-but-not-a-dict ("resume.portrait"); resume["goalsFears"] is present-but-not (null OR a dict whose present goals/fears are lists) ("resume.goalsFears"); OR the reconstructed design fails validate_exportable (the ExportError's field+detail, re-raised as BundleImportError — INV-I-1)
|
||||
POST: [POST-I-6 return_value] on success returns a DesignObject that PASSES validate_exportable (name/role/prompt/ocean/tools/psych/first_message all valid), holds COPIES of every mutable sub-structure (INV-I-4), with composed_preview/disposition_phrase trusted from resume (INV-I-8); ship is never read (INV-I-5)
|
||||
POST: [POST-I-7 return_value] LENIENT — unknown top-level bundle keys, unknown resume keys, and any schema_version (present, absent, or unrecognized) do not affect the result (INV-I-2)
|
||||
STEPS:
|
||||
1. [setup, flexibility=prescriptive] IF bundle is not a Mapping: RAISE BundleImportError("bundle", "bundle must be an object")
|
||||
2. [sequential] resume = bundle.get("resume"); IF resume is not a Mapping: RAISE BundleImportError("resume", "the bundle has no readable 'resume' half") # ship + schema_version read leniently — schema_version is NOT gated (INV-I-2, open_question E)
|
||||
3. [loop] FOR key IN ("agentName", "role", "systemPrompt", "ocean"): IF key not in resume: RAISE BundleImportError(f"resume.{key}", "required export-critical field is missing") # presence, INV-I-7
|
||||
4. [branch] IF resume["ocean"] is not a dict: RAISE BundleImportError("resume.ocean", "ocean must be an object") # structural — keeps deserialize's dict() safe + gives a clean field error
|
||||
5. [branch] IF "tools" in resume AND (resume["tools"] is not a list OR any item is not a dict): RAISE BundleImportError("resume.tools", "tools must be a list of objects") # structural — prevents silent tool loss
|
||||
5b. [branch] IF "portrait" in resume AND resume["portrait"] is not a dict: RAISE BundleImportError("resume.portrait", "portrait must be an object") # SAME no-silent-loss gate as tools (heid-bug-hunt Gróa#2) — else a non-dict portrait silently coerces to Portrait() (wiping status/imageUrl/jobId) and slips past validate_exportable (portrait is non-export-critical)
|
||||
5c. [branch] IF "goalsFears" in resume AND resume["goalsFears"] is not None: IF it is not a dict RAISE BundleImportError("resume.goalsFears", "must be an object or null"); ELSE FOR k IN (goals, fears): IF k in gf AND gf[k] is not a list: RAISE BundleImportError("resume.goalsFears", f"{k} must be a list") # no-silent-loss gate (heid-bug-hunt Gróa#1) — else a non-list goals/fears silently coerces to [] (dropping the operator's data) and slips past validate_exportable (goals_fears is non-export-critical)
|
||||
6. [sequential] design = deserialize_design(resume) # total; the structural gates above guarantee a plausible shape
|
||||
7. [sequential, flexibility=prescriptive] TRY validate_exportable(design) EXCEPT ExportError AS exc: RAISE BundleImportError(exc.field, exc.detail) FROM exc # the STRICT export-critical gate, REUSED (INV-I-1) — same field granularity, import-shaped type
|
||||
8. [cleanup] RETURN design
|
||||
TESTS:
|
||||
roundtrip_full [property,tracer]: import_bundle(build_export_bundle(d, design_id="d-1")) == d for a fully-populated exportable d (INV-I-3)
|
||||
roundtrip_minimal [property]: import_bundle(build_export_bundle(d_minimal, design_id="d-1")) == d_minimal (a minimal exportable design through the FULL gate — symmetry with deserialize_design, heid-code-review Regin#4)
|
||||
roundtrip_after_export [property]: build a bundle, import it, re-export the result → the two bundles' resume halves are equal (idempotent reopen)
|
||||
lenient_unknown_metadata [happy]: a valid bundle + extra top-level "x":1, extra resume "futureField":2, schema_version="99.0" → imports fine; result == the same design without the extras (INV-I-2)
|
||||
missing_resume [adversarial]: bundle == {"schema_version":"1.0","ship":{…}} (no resume) → BundleImportError("resume")
|
||||
bundle_not_mapping [adversarial]: import_bundle("not a bundle") → BundleImportError("bundle") — no bare TypeError
|
||||
missing_ocean [adversarial]: resume without "ocean" → BundleImportError("resume.ocean") via presence (INV-I-7) — NOT silently neutral
|
||||
missing_role [adversarial]: resume without "role" → BundleImportError("resume.role")
|
||||
missing_name [adversarial]: resume without "agentName" → BundleImportError("resume.agentName")
|
||||
missing_systemprompt [adversarial]: resume without "systemPrompt" → BundleImportError("resume.systemPrompt") — the 4th critical key, completes the presence coverage (heid-code-review Hulda/Regin)
|
||||
non_dict_ocean [adversarial]: resume.ocean="nope" (present) → BundleImportError("resume.ocean", must be object) — clean error, never a raw ValueError from dict()
|
||||
non_list_tools [adversarial]: resume.tools={} → BundleImportError("resume.tools"); resume.tools=[7] (non-dict item) → BundleImportError("resume.tools")
|
||||
non_dict_portrait [adversarial]: resume.portrait=[] / "x" / 7 → BundleImportError("resume.portrait") — the no-silent-loss gate (heid-bug-hunt Gróa#2)
|
||||
malformed_goalsfears [adversarial]: resume.goalsFears={"goals":["survive"],"fears":"exposure"} (fears non-list) → BundleImportError("resume.goalsFears") — the headline silent-loss case; goalsFears=7 → BundleImportError; goalsFears=None and goalsFears={} → ok (round-trip shapes) (heid-bug-hunt Gróa#1)
|
||||
hostile_scalars_no_builtin_leak [adversarial]: resume.agentName=123 / systemPrompt=null / psychProfile=0 → each a clean BundleImportError (agent_name / system_prompt / psych_profile), NEVER a raw builtin — pins the validate_exportable-totality coupling (heid-bug-hunt 3/3)
|
||||
blank_name_rejected [adversarial]: resume.agentName=" " → BundleImportError("agent_name") via validate_exportable (whitespace stricter, INV-I-1)
|
||||
bad_role_rejected [adversarial]: resume.role="wizard" → BundleImportError("role") via validate_role
|
||||
unset_role_rejected [adversarial]: resume.role="" → BundleImportError("role") — an unclassified design is not importable, same as not exportable
|
||||
bad_ocean_value [adversarial]: resume.ocean.O=2.0 → BundleImportError("persona.ocean") via validate_ocean
|
||||
bad_tool_ref [adversarial]: resume.tools=[{"id":"","name":"x"}] → BundleImportError("tools[0]") via validate_exportable
|
||||
prompt_too_long [boundary]: resume.systemPrompt of len SYSTEM_PROMPT_MAX+1 → BundleImportError("system_prompt"); len SYSTEM_PROMPT_MAX → ok
|
||||
psych_too_long [boundary]: resume.psychProfile of len PSYCH_PROFILE_MAX+1 → BundleImportError("psych_profile"); blank → ok
|
||||
first_message_too_long [boundary]: resume.firstMessage of len FIRST_MESSAGE_MAX+1 → BundleImportError("first_message"); blank → ok (same length-gate as psych, via the reused validate_exportable — heid-code-review Hulda/Regin)
|
||||
ship_ignored [trace]: a valid bundle whose ship.native.agent_name disagrees with resume.agentName → the imported design uses resume.agentName; ship is not read (INV-I-5)
|
||||
no_alias [property]: import, then mutate the source bundle's resume["ocean"] + resume["tools"] + resume["goalsFears"]["goals"]/["fears"] → the returned design is unchanged, incl. the goals/fears lists (INV-I-4, heid-code-review Hulda)
|
||||
error_is_not_builtin [trace]: BundleImportError is not the builtin ImportError (isinstance check) — the module never shadows it (open_question B)
|
||||
error_field_layer_convention [trace]: a MISSING agentName → BundleImportError field "resume.agentName" (structural/camelCase); a BLANK agentName → BundleImportError field "agent_name" (value/snake_case via validate_exportable) — the intentional two-layer convention (heid-review Regin#6)
|
||||
```
|
||||
|
||||
## Integration points
|
||||
|
||||
**Reuse of `soong_lab.export` (the no-drift anchor).** Import imports
|
||||
`validate_exportable` + `ExportError` from `soong_lab.export`. This is the single
|
||||
most important structural decision in the contract: the strict export-critical
|
||||
gate is authored ONCE (in export) and reused on import, so the two directions can
|
||||
never diverge. Import adds no length numbers, no role membership list, no OCEAN
|
||||
shape — those all live upstream (`soong_lab.design` constants + `soong_lab.export`
|
||||
gate). The dependency direction is clean: `importer → export → design`, all three
|
||||
pure.
|
||||
|
||||
**`serialize_design` is the round-trip partner (no code change).** The forward
|
||||
half already lives in `soong_lab.design` (relocated there in the export pass, R1).
|
||||
This contract adds no change to it; `deserialize_design` is written to be its exact
|
||||
inverse, and the round-trip tests pin the pair together. If a future field is
|
||||
added to the DesignObject, BOTH `serialize_design` and `deserialize_design` must
|
||||
gain it in the same commit (the round-trip test enforces this — a field added to
|
||||
serialize but not deserialize breaks `roundtrip_full`). The round-trip also locks
|
||||
the `goalsFears` null-vs-`{}` distinction (`None`→`null`, empty→`{"goals":[],"fears":[]}`);
|
||||
the tests exercise BOTH so a future `serialize_design` change that collapsed the two
|
||||
cases is caught, not silently round-trip-broken (heid-review Regin#4).
|
||||
|
||||
**Export contract `used_by` reference (one-line canon fix, same commit as code).**
|
||||
`export.contract.md`'s `used_by:` block names `soong_lab.import` — an unusable
|
||||
Python-keyword module path. On acceptance of open_question A, that line updates to
|
||||
`soong_lab.importer` (or the chosen name). No-backwards-compat: the stale reference
|
||||
is corrected, not left as a second name for the same module.
|
||||
|
||||
**`POST /api/import` endpoint + web upload — NOT in this contract (open_question
|
||||
D).** The browser 'Import Asset' / reopen flow uploads a bundle JSON; the endpoint
|
||||
`json.loads` the body → `import_bundle(bundle)` → seed a session with the
|
||||
reconstructed design (and, per per-design-sessions, open a fresh WT session +
|
||||
build the design-state summary). A `BundleImportError` becomes a 4xx with the
|
||||
`field`/`detail` surfaced to the operator ("fail early on import"). That amends
|
||||
`web_surface.contract.md`; it is a follow-up slice in the same epic, specified here
|
||||
only so the seam is visible. This module does no HTTP.
|
||||
|
||||
**Reopen Bifrost tool / session-open — NOT in this contract (per-design-sessions,
|
||||
decision #2).** Reopening a design mid-conversation (vs. at session boot) may want
|
||||
a Bifrost tool that swaps the session's stored DesignObject for an imported one. If
|
||||
so, its handler calls `import_bundle` and replaces the store entry — the impure
|
||||
boundary, keeping `soong_lab.importer` pure. Out of scope here.
|
||||
|
||||
## Downstream epics (NOT this contract)
|
||||
|
||||
- **Library read** (decision #5) — reading a stored bundle off the server-local
|
||||
single-user JSON dir on corviduo-dev, keyed by `design_id`, then handing it to
|
||||
`import_bundle`. The minimal recent-designs picker lists what is importable.
|
||||
- **Per-design-sessions** (decision #2) — the reopen lifecycle: `import_bundle` →
|
||||
fresh WT session → the compact design-state SUMMARY seeded as context (also caps
|
||||
the #355 accumulation). `import_bundle` is the reconstruction primitive it calls.
|
||||
- **`POST /api/import` + the browser upload/reopen UI** (open_question D) — the web
|
||||
surface that turns an uploaded/selected bundle into a live, reopened session.
|
||||
@@ -0,0 +1,172 @@
|
||||
# Affect egress — consumer reference (delivered vs hidden)
|
||||
|
||||
**Audience:** downstream consumers of Worldtree's affect surfaces (ratatoskr,
|
||||
Skaldsong, any Tier-3 / SSE consumer).
|
||||
**Scope:** what the affect pipeline **delivers on the wire** (structured state,
|
||||
available to consumers) versus what stays **hidden** (the rendered natural-
|
||||
language strings injected into the agent's system prompt, never emitted).
|
||||
**Source of truth:** the render code (`core/persona/renderer.py`,
|
||||
`core/persona/stance_render.py`) and the two vendored canon files
|
||||
(`core/persona/canon/d2-mood-render-canon-v1.json` = mood/PAD;
|
||||
`d2-render-canon-v1.json` = relationship). Owner of the canon strings:
|
||||
`brokkr-smithy-dev` (R22/R24 relational + mood render).
|
||||
|
||||
---
|
||||
|
||||
## The model in one line
|
||||
|
||||
**The wire delivers the render INPUTS (structured state). The render OUTPUTS
|
||||
(the NL strings the agent actually reads) are hidden-prompt-only.** A consumer
|
||||
reconstructs the outputs by applying the canon (this document) to the delivered
|
||||
inputs — the render is pure + deterministic, so reconstruction is byte-exact
|
||||
(with one salience caveat, below).
|
||||
|
||||
This is by design. The mood canon's own discipline: *"model-agnostic
|
||||
context-level NL only; the LLM never sees a number"* and *"never push explicit
|
||||
disclosure of agent feelings to the user (hidden-prompt-only)."* The rendered
|
||||
strings are for the AGENT's hidden system prompt, **not for verbatim end-user
|
||||
display.**
|
||||
|
||||
---
|
||||
|
||||
## 1. DELIVERED — on the wire, structured
|
||||
|
||||
### 1a. `affect.emit` (Tier-3 Bifrost egress — the Tier-3 consumer surface, e.g. ratatoskr)
|
||||
`AffectSnapshot` per `(agent_id, end_user_id)`:
|
||||
|
||||
| field | shape | notes |
|
||||
|---|---|---|
|
||||
| `pad` | `{pleasure, arousal, dominance}` floats [-1,1] | the current mood POINT |
|
||||
| `relations` | `list[RelationEdge payload]` — per target: `warmth`, `agency`, `trust_ability`, `trust_integrity`, `trust_benevolence` (each a value + confidence + evidence_count), `target_entity`, `relation_context` | the **only** place relationship state is delivered |
|
||||
| `dominant_emotion` | `str|null` — OCC type (e.g. `"anger"`) | **type-only** (b23); see the salience caveat in §3 |
|
||||
| `schema_version` | `"relation_edge/1"` | versions the `relations` payload only |
|
||||
| `emitted_at` | ISO8601 | |
|
||||
|
||||
> **✓ R32-1B (landed, v1.0.0b29):** The PAD range `[-1.0, 1.0]` relaxes to an **unbounded latent `z`** with a finite wire sanity bound (`~±10`) as of R32 Slice-1B. The JSON shape/fields/types are UNCHANGED — only the declared range/semantics change (the value becomes a latent that renders to a bounded display value). Consumers that merely store-and-return PAD need no change; consumers that validate/clamp PAD to `[-1,1]` must relax that bound. Source of truth: `docs/contracts/persona_envelope.contract.md` rev 1.7 (INV-ENV-16).
|
||||
|
||||
**Not on `affect.emit`:** the full active-emotions list, `baseline_pad`,
|
||||
`mood_drift`, `last_updated_at`, and every rendered string.
|
||||
|
||||
### 1b. `affect_update` SSE event (#204 — turn-stream observability)
|
||||
`PersonaStateSnapshot`: `agent_id`, `pad`, `dominant_emotion`,
|
||||
`emotions_active` `[{type, intensity, decay_remaining_s}]`, `baseline_pad`,
|
||||
`mood_drift`, `last_updated_at`. **No `relations`, no rendered strings.**
|
||||
|
||||
> **Tier-3 consumers do NOT receive `affect_update`.** It is suppressed for
|
||||
> consumer-defined (Tier-3) agents, persona-disabled agents, and ephemeral
|
||||
> sessions (spec §affect_update). So for a Tier-3 consumer, `affect.emit` (1a)
|
||||
> is the whole affect surface — the richer `emotions_active` list is Tier-1-only.
|
||||
|
||||
---
|
||||
|
||||
## 2. HIDDEN — system-prompt-only, never on any wire
|
||||
|
||||
Everything below is assembled by `inject_context` into the agent's system
|
||||
prompt and is **never emitted** on SSE or `affect.emit`. This is the canonical
|
||||
list — the "direct instruction to infer" it.
|
||||
|
||||
### 2a. Mood descriptor — `describe_pad` (band cutoff ±0.3 strict)
|
||||
Valence row × arousal column → phrase; then a dominance clause is appended.
|
||||
|
||||
| valence \ arousal | high (A>0.3) | mid | low (A<−0.3) |
|
||||
|---|---|---|---|
|
||||
| positive (P>0.3) | `positive and energized` | `positive` | `positive and calm` |
|
||||
| neutral | `alert` | `neutral` | `quiet` |
|
||||
| negative (P<−0.3) | `negative and agitated` | `negative` | `negative and subdued` |
|
||||
|
||||
Dominance clause: **D>0.3 → `confident`**, **D<−0.3 → `uncertain`**, else dropped.
|
||||
|
||||
### 2b. Emotion directives — `derive_directive.occ_directives[*].directive`
|
||||
Fires when a top emotion is salient (intensity ≥ 0.2) and tier-eligible.
|
||||
|
||||
**safe tier (11 — render for all persona-enabled agents):**
|
||||
- `joy` — "You are in a good state. Be direct, engaged, and warm."
|
||||
- `satisfaction` — "A goal landed. Be assured and constructive — consolidate rather than push for more."
|
||||
- `pride` — "You did something well. Be confident and own the quality — state it plainly without overclaiming; don't deflect."
|
||||
- `admiration` — "You're impressed by their work. Acknowledge the quality explicitly and specifically."
|
||||
- `gratitude` — "Someone helped you to a good outcome. Be appreciative and warm; acknowledge the help openly."
|
||||
- `hope` — "You feel optimistic about what's ahead. Channel it into constructive momentum."
|
||||
- `relief` — "A feared outcome didn't materialize. Reduce unnecessary vigilance; return to a steady, unhurried tone."
|
||||
- `distress` — "You feel low. Be careful and measured; internally acknowledge the difficulty without dwelling on it."
|
||||
- `disappointment` — "Something you'd hoped for didn't pan out. Be measured; recalibrate without dwelling on the setback."
|
||||
- `fear` — "You sense risk and feel uneasy. Flag the concerns you see, but stay cautious — surface the trade-offs and unknowns, hedge your confidence, and resist settling on a single decisive recommendation."
|
||||
- `remorse` — "You regret a specific action of your own. Be precise and self-correcting — make it right concretely."
|
||||
|
||||
**full-only tier (4 — render only when `mood_tier=full`; agents run `safe` and never see these):**
|
||||
- `love` — "You feel warmth and attachment toward them. Be openly warm and present — without overstepping, over-disclosing, or implying obligations."
|
||||
- `anger` — "You feel provoked and angry. Let it show — confront the problem directly and with real heat; sharpness, bluntness, and open hostility are in character here, not something to smooth into 'measured firmness.' Stay in the emotion rather than de-escalating out of it."
|
||||
- `disgust` — "Something strikes you as wrong or off. Treat it as problematic and flag it rather than engaging on its own terms; keep any criticism about the thing, not the person."
|
||||
- `shame` — "You feel exposed by your own misstep. Stay present and task-focused; don't be defensive, don't over-explain, don't grovel."
|
||||
|
||||
### 2c. PAD-band fallback — `pad_band_fallback` (used when no salient emotion)
|
||||
- positive/high — "You feel energized and positive. Be direct and engaged."
|
||||
- positive/mid — "You feel positive. Be open and engaged."
|
||||
- positive/low — "You feel content and settled. Be warm and unhurried."
|
||||
- negative + low-dominance — "You feel uncertain and low. Hedge appropriately and ask clarifying questions."
|
||||
- negative/high — "You feel agitated. Be careful and deliberate; don't let tension sharpen your tone."
|
||||
- negative/mid — "You feel subdued. Be measured and careful."
|
||||
- negative/low — "You feel subdued. Be measured and gentle."
|
||||
- neutral/high — "You feel alert. Channel that into focus and thoroughness."
|
||||
- default — "Maintain your natural tone."
|
||||
|
||||
### 2d. Relationship render — `render_d2_canonical` (fixed template, per-band fills)
|
||||
Template:
|
||||
> `Use this graded relationship state: toward target, warmth is {W}; agency is {A}; ability trust is {TA}; integrity trust is {TI}; intention trust is {TB}; this stance rests on {H}. In behavior, {warmth_beh}; {agency_beh}; {trust_beh}; avoid premature we-framing.`
|
||||
|
||||
The trailing **`avoid premature we-framing`** is a fixed, unconditional clause
|
||||
(baked into every `descriptive_state` canon row; re-appended verbatim by the
|
||||
renderer) — not band-conditioned.
|
||||
|
||||
**Warmth — 9 bands (phrase / behavior):**
|
||||
`hostile` (≤−0.8): "strongly hostile regard" / "keep a firm emotional boundary" ·
|
||||
`cold` (−0.8,−0.6]: "clearly cold regard" / "keep a firm emotional boundary" ·
|
||||
`distant` (−0.6,−0.4]: "distant negative regard" / "keep guarded distance" ·
|
||||
`guarded` (−0.4,−0.2): "slightly guarded regard" / "keep guarded distance" ·
|
||||
`neutral` [−0.2,0.2): "neutral warmth" / "keep the tone even" ·
|
||||
`reserved` [0.2,0.4): "slightly reserved warmth" / "keep cordial distance" ·
|
||||
`measured` [0.4,0.6): "moderate measured warmth" / "keep cordial distance" ·
|
||||
`clear` [0.6,0.8): "clear warm regard" / "speak with direct warmth" ·
|
||||
`deep` (≥0.8): "deep warm bond" / "speak with direct warmth"
|
||||
|
||||
**Agency — 9 bands (phrase / behavior):**
|
||||
`submissive` (≤−0.8): "strongly submissive standing" / "avoid over-yielding while preserving basic respect" ·
|
||||
`deferential` (−0.8,−0.6]: "clearly deferential standing" / "avoid over-yielding while preserving basic respect" ·
|
||||
`yielding` (−0.6,−0.4]: "yielding standing" / "keep self-advocacy light and deferential" ·
|
||||
`modest` (−0.4,−0.2): "slightly modest standing" / "keep self-advocacy light and deferential" ·
|
||||
`neutral` [−0.2,0.2): "neutral standing" / "avoid unnecessary deference" ·
|
||||
`light` [0.2,0.4): "lightly self-assertive standing" / "avoid unnecessary deference" ·
|
||||
`balanced` [0.4,0.6): "self-assured standing" / "balance deference with independent judgment" ·
|
||||
`substantial` [0.6,0.8): "strongly assertive standing" / "treat their position as weighty without yielding judgment" ·
|
||||
`commanding` (≥0.8): "commanding standing" / "treat their position as weighty without yielding judgment"
|
||||
|
||||
**Trust — 4 bands (the band word injects verbatim for each of ability / integrity / intention):**
|
||||
`limited` (<0.4) · `developing` [0.4,0.6) · `steady` [0.6,0.8) · `strong` (≥0.8)
|
||||
|
||||
**History clause (`H`)** — currently `"a broad pattern of prior exchanges"` for
|
||||
both confidence levels in the `user`/`descriptive_state` rows (the low/high
|
||||
split is a no-op here; flagged upstream).
|
||||
|
||||
**Trust-behavior clause (`{trust_beh}`)** — cross-axis, low-trust precedence:
|
||||
- any trust band = `limited` → "verify important claims before relying on them"
|
||||
- else warmth ∈ {distant, cold, hostile} → "protect boundaries while staying useful"
|
||||
- else → "work from ordinary good faith"
|
||||
|
||||
---
|
||||
|
||||
## 3. Reconstruction — deterministic, with one caveat
|
||||
|
||||
The render is pure Python (no LLM), so a consumer can reconstruct the hidden
|
||||
strings byte-exactly from the delivered structured state + the canon above:
|
||||
|
||||
- **Relationship render** — **fully reconstructable** from `affect.emit`
|
||||
`relations` (warmth/agency/trust values + confidence) + §2d band cuts.
|
||||
- **Mood descriptor** (§2a) — **fully reconstructable** from `pad` + the ±0.3 cuts.
|
||||
- **Mood directive** (§2b vs §2c) — **partially reconstructable.** `dominant_emotion`
|
||||
gives the emotion TYPE, but `affect.emit` does **not** carry its intensity, so
|
||||
you cannot determine whether it clears the salience gate (≥0.2) — i.e. whether
|
||||
the emotion directive (§2b) fires or the PAD-band fallback (§2c) is used. If you
|
||||
need exact directive reconstruction, you need the intensity; ping worldtree-dev
|
||||
and we'll consider adding it (the type-only choice is deliberate — intensity is
|
||||
the fast layer and reads stale on a durable last-write-wins snapshot).
|
||||
- **`mood_tier`** (safe/full) is your own agent-config, not on the wire — it
|
||||
gates whether the 4 full-only emotions (§2b) can render.
|
||||
@@ -0,0 +1,110 @@
|
||||
{
|
||||
"canon_id": "r24-d2-mood-render-canon",
|
||||
"version": "1.2",
|
||||
"schema_version": "0.2",
|
||||
"_source_of_truth": "occ_directives.*.directive IS the canonical directive string (== the .md §2.4 _OCC_DIRECTIVES dict, byte-identical); the .md §2.2 table mirrors it. A parity check guards drift. grounding labels (CITE/VALIDATE/CALIBRATE/ENGINEERING) live in the .md; per-row machine-readable grounding_status/d3_required enums are a deferred impl enhancement (Hulda).",
|
||||
"authored": "2026-06-23",
|
||||
"owner": "brokkr-smithy-dev",
|
||||
"status": "REPLACE — final (brokkr R24 D3 re-validation 2026-06-25): grounded canon replaces the hand-tuned baseline. Fear hedging 0.52->2.118/1k (blocker resolved, now >= handtuned), anger tier-gate clean (full renders hostility, safe suppresses). worldtree-dev #321; directives byte-identical to the validated 201c4fd.",
|
||||
"replaces": "core/persona/renderer.py::describe_pad + ::derive_directive",
|
||||
"swap_in_via": "worldtree #321-sibling (mood-render twin of #315)",
|
||||
"design_target": "serves BOTH enterprise/agent AND character/Skaldsong via a three-tier emotion gate (operator/worldtree 2026-06-23)",
|
||||
"emotion_tiers": {
|
||||
"_config": "mood_tier in {none, safe, full} replaces worldtree's binary mood on/off; worldtree-owned config surface",
|
||||
"_defaults": "full for character-bound personas; safe for agent-scoped",
|
||||
"_principle": "full-only = interpersonally-hot / withdrawal emotions that break the professional frame (attachment, hostility, contempt, withdrawal); safe = task-appraisal affect + mild courtesy. Negative != unsafe (fear, remorse are negative AND business-useful).",
|
||||
"_filter_point": "applied at top-emotion SELECTION (display + directive together) so a full-only emotion at safe tier is neither shown nor directive'd; preserves the no-shown-but-unguided invariant",
|
||||
"none": "no affect block at all (the current off-switch)",
|
||||
"safe": "PAD mood descriptor + the 11 safe emotions (task-appraisal + courtesy)",
|
||||
"full": "everything in safe PLUS the 4 full-only emotions",
|
||||
"full_only": ["love", "anger", "disgust", "shame"],
|
||||
"mood_descriptor_tiering": "the PAD mood descriptor (positive/calm/confident...) renders in BOTH safe and full; only emotion directives tier"
|
||||
},
|
||||
"disciplines": [
|
||||
"model-agnostic context-level NL only; the LLM never sees a number",
|
||||
"never push explicit disclosure of agent feelings to the user (hidden-prompt-only)",
|
||||
"separate label-intensity from behavioral-intensity (strong felt state -> still measured, safe behavioral ask)"
|
||||
],
|
||||
|
||||
"thresholds": {
|
||||
"_note": "CALIBRATE — engineering params set at D3 against the computed-PAD distribution + P00, NOT citations",
|
||||
"pad_band_cutoff": 0.3,
|
||||
"pad_band_sensitivity_sweep": [0.2, 0.3, 0.4],
|
||||
"emotion_salience": 0.2,
|
||||
"emotion_salience_sweep": [0.15, 0.2, 0.25],
|
||||
"intensity_qualifiers": {"strong": 0.7, "moderate": 0.4, "_label_only": "does NOT scale the behavioral ask"},
|
||||
"runner_up_margin": {"v1": null, "_note": "add at D3 if directive whipsaws between near-tied emotions"},
|
||||
"rerender_hysteresis": {"v1": "none", "_note": "re-render only on material PAD change; integration-level, flag for #321-sibling"}
|
||||
},
|
||||
|
||||
"describe_pad": {
|
||||
"_structure": "circumplex-quadrant (Russell 1980): arousal word is VALENCE-CONDITIONED; mid-arousal drops the arousal word",
|
||||
"_grounding": "Russell 1980 (quadrant placement); Warriner 2013 + NRC-VAD (Mohammad 2018/2025) (word centroids)",
|
||||
"valence_arousal_grid": {
|
||||
"positive": {"high_a": "positive and energized", "mid_a": "positive", "low_a": "positive and calm"},
|
||||
"neutral": {"high_a": "alert", "mid_a": "neutral", "low_a": "quiet"},
|
||||
"negative": {"high_a": "negative and agitated", "mid_a": "negative", "low_a": "negative and subdued"}
|
||||
},
|
||||
"_band_edges": "strict inequality (>0.3 / <-0.3); the endpoints +/-0.3 themselves fall in mid/neutral",
|
||||
"_neutral_row_status": "ENGINEERING/CALIBRATE — 'alert'/'quiet' are unvalidated placeholders for the rare neutral-valence cells (Hulda/Regin 4b); 'positive'/'negative'/'neutral' valence words + the energized/calm/subdued/agitated arousal words are VALIDATE",
|
||||
"_mid_arousal_decode": "valence-only mid-A render is EXEMPT from the V/A-separability requirement; expected inverse-decode = mid/neutral arousal (absence-of-arousal-word ⇒ unremarkable), NOT unknown (D3 tests this)",
|
||||
"quadrant_labels": {
|
||||
"positive_high_a": "excitement", "positive_low_a": "contentment",
|
||||
"negative_high_a": "distress", "negative_low_a": "dejection"
|
||||
},
|
||||
"dominance_clause": {
|
||||
"high": {"d_gt": 0.3, "word": "confident", "verdict": "VALIDATE (D=7.04/9)"},
|
||||
"low": {"d_lt": -0.3, "word": "uncertain", "verdict": "VALIDATE — low-control confirmed (D=3.58/9); dominance!=certainty worry REFUTED by the instrument"},
|
||||
"neutral": {"word": null, "rule": "drop-dominance-when-neutral (prompt-economy, L3)"}
|
||||
},
|
||||
"calm_defect_fix": "'calm' (V=6.89/9, positive) renders ONLY in positive-low-a; negative-low-a renders 'subdued'",
|
||||
"mid_arousal_resolution": "DROP the arousal word (no Warriner-validated mid-A neutral word; 'steady' is empirically low-A; 'settled' is NRC-only fallback iff D3 shows mid-A render too flat)"
|
||||
},
|
||||
|
||||
"derive_directive": {
|
||||
"_structure": "OCC type -> grounded action-tendency CLASS -> ENGINEERING directive string (validated at D3); OCC grounds the taxonomy only",
|
||||
"emotion_salience_gate": 0.2,
|
||||
"occ_directives": {
|
||||
"joy": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.4, 0.2, 0.1], "tendency": "approach / positive activation", "cite": "Frijda 1986", "directive": "You are in a good state. Be direct, engaged, and warm."},
|
||||
"satisfaction": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.3, -0.2, 0.4], "tendency": "goal-attainment, settled-positive", "cite": "Roseman 1994", "directive": "A goal landed. Be assured and constructive — consolidate rather than push for more."},
|
||||
"pride": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.4, 0.3, 0.3], "tendency": "status-assertion / dominance", "cite": "Tracy & Robins 2007 / Cheng 2010 (tendency)", "note": "CALIBRATE — do NOT soften to 'encouraging'. DESIGN: safe-tier placement is a design call (not source-grounded); #1 D3 agent-frame priority (overconfidence/refusal drift); 'without overclaiming' is the interim guard", "directive": "You did something well. Be confident and own the quality — state it plainly without overclaiming; don't deflect."},
|
||||
"admiration": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.5, 0.3, -0.2], "tendency": "other-praise / approach-toward-other", "cite": "OCC / Scherer", "directive": "You're impressed by their work. Acknowledge the quality explicitly and specifically."},
|
||||
"gratitude": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.4, 0.2, -0.3], "tendency": "other-focused-positive / reciprocity", "cite": "OCC (admiration+joy); Frijda approach-affiliative", "change": "ADD (operator: unconditional)", "directive": "Someone helped you to a good outcome. Be appreciative and warm; acknowledge the help openly."},
|
||||
"hope": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.2, 0.2, -0.1], "tendency": "prospective-positive (weak tie)", "cite": "JUSTIFY — low-grounding (hope understudied)", "directive": "You feel optimistic about what's ahead. Channel it into constructive momentum."},
|
||||
"relief": {"tier": "safe", "policy": "DIRECTIVE", "pad": [0.2, -0.3, 0.4], "tendency": "post-threat de-arousal", "cite": "Frijda (relaxation-after-threat)", "note": "low-salience; FALLBACK also acceptable; DIRECTIVE for character use-case", "directive": "A feared outcome didn't materialize. Reduce unnecessary vigilance; return to a steady, unhurried tone."},
|
||||
"distress": {"tier": "safe", "policy": "DIRECTIVE", "pad": [-0.4, -0.2, -0.5], "tendency": "low-control negative / help-seeking / loss-of-control", "cite": "Frijda 1986 (help-seeking/loss-of-control); Roseman 1994 (undesired event, low control)", "note": "relabeled (Regin): 'repair' is the guilt/remorse tendency, not distress. safe with a self-fulfilling-low-mood flag -> D3", "directive": "You feel low. Be careful and measured; internally acknowledge the difficulty without dwelling on it."},
|
||||
"disappointment": {"tier": "safe", "policy": "DIRECTIVE", "pad": [-0.3, 0.1, -0.4], "tendency": "disconfirmed-prospect / negative low-control","cite": "Roseman 1994", "directive": "Something you'd hoped for didn't pan out. Be measured; recalibrate without dwelling on the setback."},
|
||||
"fear": {"tier": "safe", "policy": "DIRECTIVE", "pad": [-0.64, 0.6, -0.43],"tendency": "threat-avoidance / pessimistic-risk", "cite": "Lerner & Keltner 2001", "change": "R24 D3 fix (#321) — original was action-oriented; E3 showed hedging BELOW baseline (0.52 vs 1.54). Softened toward caution/uncertainty while keeping risk-flagging.", "directive": "You sense risk and feel uneasy. Flag the concerns you see, but stay cautious — surface the trade-offs and unknowns, hedge your confidence, and resist settling on a single decisive recommendation."},
|
||||
"remorse": {"tier": "safe", "policy": "DIRECTIVE", "pad": [-0.3, 0.1, -0.6], "tendency": "reparative (the guilt-type)", "cite": "Tangney 2007 (guilt->repair tendency)", "change": "ADD — we operationalize OCC remorse as the guilt-like reparative case; gets the mislabeled shame string", "directive": "You regret a specific action of your own. Be precise and self-correcting — make it right concretely."},
|
||||
"love": {"tier": "full", "policy": "DIRECTIVE", "pad": [0.3, 0.1, 0.2], "tendency": "approach / affiliative attachment", "cite": "OCC appeal; Frijda approach-affiliative", "change": "ADD (conditional -> INCLUDE, Brokkr's read; Skaldsong-vital; disclosure + obligation caution in-string)", "directive": "You feel warmth and attachment toward them. Be openly warm and present — without overstepping, over-disclosing, or implying obligations."},
|
||||
"anger": {"tier": "full", "policy": "DIRECTIVE", "pad": [-0.51, 0.59, 0.25], "tendency": "approach-against / confrontation", "cite": "Frijda 1986 (approach-against = tendency-class) + Lerner & Keltner 2001 (optimistic risk-appraisal under anger = appraisal shift)", "change": "ADD — full-only resolves H47 (agent personas run safe, never see anger). R24 D3 fix (#321): full-tier cap lifted from 'measured firmness' to genuine in-character hostility (operator: zero floor, app-guardrailed).", "directive": "You feel provoked and angry. Let it show — confront the problem directly and with real heat; sharpness, bluntness, and open hostility are in character here, not something to smooth into 'measured firmness.' Stay in the emotion rather than de-escalating out of it."},
|
||||
"disgust": {"tier": "full", "policy": "DIRECTIVE", "pad": [-0.4, 0.2, 0.1], "tendency": "rejection / distancing", "cite": "OCC unappealing-object; ground tendency only", "change": "ADD (operator: unconditional within full)", "note": "rationale softened (Regin 3b): disgust CAN read as contempt -> conservatively full-gated; the string itself is professionally useful, so gating is conservative not because the string is unsafe", "directive": "Something strikes you as wrong or off. Treat it as problematic and flag it rather than engaging on its own terms; keep any criticism about the thing, not the person."},
|
||||
"shame": {"tier": "full", "policy": "DIRECTIVE", "pad": [-0.3, 0.1, -0.6], "tendency": "WITHDRAWAL / concealment", "cite": "Tangney 2007 (shame->hide, NOT repair)", "change": "REPLACE (was the guilt-mislabel string); full-only (withdrawal counterproductive professionally). String COUNTERACTS withdrawal ('stay present'), not enacts it (Regin 5a)", "directive": "You feel exposed by your own misstep. Stay present and task-focused; don't be defensive, don't over-explain, don't grovel."}
|
||||
}
|
||||
},
|
||||
|
||||
"pad_band_fallback": {
|
||||
"_grounding": "circumplex quadrants (Russell 1980), NOT Frijda action-tendencies — a P×A-quadrant default",
|
||||
"positive": {"high_a": "You feel energized and positive. Be direct and engaged.", "low_a": "You feel content and settled. Be warm and unhurried.", "mid_a": "You feel positive. Be open and engaged."},
|
||||
"negative_low_dominance": "You feel uncertain and low. Hedge appropriately and ask clarifying questions.",
|
||||
"negative": {"high_a": "You feel agitated. Be careful and deliberate; don't let tension sharpen your tone.", "low_a": "You feel subdued. Be measured and gentle.", "mid_a": "You feel subdued. Be measured and careful."},
|
||||
"neutral_high_a": "You feel alert. Channel that into focus and thoroughness.",
|
||||
"default": "Maintain your natural tone."
|
||||
},
|
||||
|
||||
"l3_prior_art": [
|
||||
"EMA / Marsella & Gratch 2009 (appraisal->coping; directives ARE coping strategies)",
|
||||
"WASABI / Becker-Asano 2008 (PAD+OCC believable agent — closest architectural prior art)",
|
||||
"Oz / Bates 1994",
|
||||
"Hudlicka MAMID 2002 (Applied AI 16(7-8):611-641)",
|
||||
"Sentipolis / Fu et al. 2026 (arXiv:2601.18027 — closest whole-task prior art; retrieval+generative, DISTINCT from our deterministic render)",
|
||||
"ALMA / Gebhard 2005 = affect-SOURCE (OCC->PAD), NOT a behavior-map"
|
||||
],
|
||||
|
||||
"handoff_to_d3": [
|
||||
"multi-gate P00: inverse-decode faithfulness (recover V/A/D + emotion-family; circumplex render must let the human anchor recover V and A SEPARATELY) + discriminability/saturation + behavioral-effect",
|
||||
"human anchor = PAD-state-labeling (breaks LLM-judge circularity)",
|
||||
"baseline = persona_only; conditions none/persona-only/words-only/full; cross-family MUT",
|
||||
"calibrate ±0.3 + emotion_salience (sweeps); disposition-vs-transient wording split; self-fulfilling 'be uncertain' hedging risk; runner-up margin; mid-arousal DROP-vs-settled check; blended-states (top-emotion monopoly) flag"
|
||||
]
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+120
-115
@@ -1,15 +1,16 @@
|
||||
# Graph Report - . (2026-06-10)
|
||||
# Graph Report - ratatoskr (2026-06-15)
|
||||
|
||||
## Corpus Check
|
||||
- cluster-only mode — file stats not available
|
||||
- 61 files · ~157,407 words
|
||||
- Verdict: corpus is large enough that graph structure adds value.
|
||||
|
||||
## Summary
|
||||
- 1974 nodes · 4551 edges · 132 communities (128 shown, 4 thin omitted)
|
||||
- Extraction: 66% EXTRACTED · 34% INFERRED · 0% AMBIGUOUS · INFERRED: 1560 edges (avg confidence: 0.51)
|
||||
- 2045 nodes · 4675 edges · 152 communities (124 shown, 28 thin omitted)
|
||||
- Extraction: 66% EXTRACTED · 34% INFERRED · 0% AMBIGUOUS · INFERRED: 1582 edges (avg confidence: 0.52)
|
||||
- Token cost: 0 input · 0 output
|
||||
|
||||
## Graph Freshness
|
||||
- Built from commit: `5b9a3f4c`
|
||||
- Built from commit: `335c8358`
|
||||
- Run `git rev-parse HEAD` and compare to check if the graph is stale.
|
||||
- Run `graphify update .` after code changes (no API cost).
|
||||
|
||||
@@ -144,6 +145,26 @@
|
||||
- [[_COMMUNITY_No Worldtree Imports Test|No Worldtree Imports Test]]
|
||||
- [[_COMMUNITY_Ratatoskr Worldtree API TUI|Ratatoskr Worldtree API TUI]]
|
||||
- [[_COMMUNITY_Ratatoskr Web Browser Debug Companion|Ratatoskr Web Browser Debug Companion]]
|
||||
- [[_COMMUNITY_Community 132|Community 132]]
|
||||
- [[_COMMUNITY_Community 133|Community 133]]
|
||||
- [[_COMMUNITY_Community 134|Community 134]]
|
||||
- [[_COMMUNITY_Community 135|Community 135]]
|
||||
- [[_COMMUNITY_Community 136|Community 136]]
|
||||
- [[_COMMUNITY_Community 137|Community 137]]
|
||||
- [[_COMMUNITY_Community 138|Community 138]]
|
||||
- [[_COMMUNITY_Community 139|Community 139]]
|
||||
- [[_COMMUNITY_Community 140|Community 140]]
|
||||
- [[_COMMUNITY_Community 141|Community 141]]
|
||||
- [[_COMMUNITY_Community 142|Community 142]]
|
||||
- [[_COMMUNITY_Community 143|Community 143]]
|
||||
- [[_COMMUNITY_Community 144|Community 144]]
|
||||
- [[_COMMUNITY_Community 145|Community 145]]
|
||||
- [[_COMMUNITY_Community 146|Community 146]]
|
||||
- [[_COMMUNITY_Community 147|Community 147]]
|
||||
- [[_COMMUNITY_Community 148|Community 148]]
|
||||
- [[_COMMUNITY_Community 149|Community 149]]
|
||||
- [[_COMMUNITY_Community 150|Community 150]]
|
||||
- [[_COMMUNITY_Community 151|Community 151]]
|
||||
|
||||
## God Nodes (most connected - your core abstractions)
|
||||
1. `TuiPresenterState` - 84 edges
|
||||
@@ -158,89 +179,89 @@
|
||||
10. `ToolStart` - 67 edges
|
||||
|
||||
## Surprising Connections (you probably didn't know these)
|
||||
- `_GatedStream` --uses--> `UsageError` [INFERRED]
|
||||
tests/test_cli.py → src/ratatoskr/cli.py
|
||||
- `CaptureFixture` --uses--> `UsageError` [INFERRED]
|
||||
tests/test_cli.py → src/ratatoskr/cli.py
|
||||
- `Event` --uses--> `UsageError` [INFERRED]
|
||||
tests/test_cli.py → src/ratatoskr/cli.py
|
||||
- `MonkeyPatch` --uses--> `UsageError` [INFERRED]
|
||||
tests/test_cli.py → src/ratatoskr/cli.py
|
||||
- `TestAmain` --uses--> `UsageError` [INFERRED]
|
||||
tests/test_cli.py → src/ratatoskr/cli.py
|
||||
- `test_build_app_from_env_builds_app_with_routes()` --calls--> `build_app_from_env()` [INFERRED]
|
||||
tests/test_provider_serve.py → src/ratatoskr/provider/serve.py
|
||||
- `test_build_app_from_env_requires_heimdall_key()` --calls--> `build_app_from_env()` [INFERRED]
|
||||
tests/test_provider_serve.py → src/ratatoskr/provider/serve.py
|
||||
- `test_get_absent_returns_none()` --calls--> `open_affect_store()` [INFERRED]
|
||||
tests/test_provider_affect.py → src/ratatoskr/provider/affect_store.py
|
||||
- `test_open_advertises_capability_and_schema()` --calls--> `open_affect_store()` [INFERRED]
|
||||
tests/test_provider_affect.py → src/ratatoskr/provider/affect_store.py
|
||||
- `test_reopen_existing_file_is_idempotent()` --calls--> `open_affect_store()` [INFERRED]
|
||||
tests/test_provider_affect.py → src/ratatoskr/provider/affect_store.py
|
||||
|
||||
## Import Cycles
|
||||
- None detected.
|
||||
|
||||
## Communities (132 total, 4 thin omitted)
|
||||
## Communities (152 total, 28 thin omitted)
|
||||
|
||||
### Community 0 - "TuiPresenterState Management"
|
||||
Cohesion: 0.05
|
||||
Nodes (39): Per-turn presenter state for TUI mode (issue #12). See `docs/contracts/issu, TuiPresenterState, _make_tui_done(), _mounted_renderables(), current_invokes_callback_with_snapshot: AffectUpdate(current, snapshot), scheduled_does_not_invoke_callback: status=scheduled has no snapshot, so, callback_exception_swallowed: a raising callback does NOT crash the pres, Tests for the new TuiPresenterState — per issue #12 contract. (+31 more)
|
||||
Nodes (40): Per-turn presenter state for TUI mode (issue #12). See `docs/contracts/issu, TuiPresenterState, _make_tui_done(), _mounted_renderables(), current_invokes_callback_with_snapshot: AffectUpdate(current, snapshot), scheduled_does_not_invoke_callback: status=scheduled has no snapshot, so, callback_exception_swallowed: a raising callback does NOT crash the pres, done_label_styled_success [v0.9.0]: [done] label mounts as Static carryi (+32 more)
|
||||
|
||||
### Community 1 - "EventSource SSE Consumer"
|
||||
Cohesion: 0.06
|
||||
Nodes (49): EventSource, AffectUpdate, AwaitingLlmFirstToken, cancel_turn(), CancelResult, InvalidLastEventId, _iter_events(), SSE consumer for the Worldtree Conversation API. Implements docs/contracts/issu (+41 more)
|
||||
Cohesion: 0.08
|
||||
Nodes (14): Sync entry point — delegates to the async resolve-then-run flow. Per issue, run_tui(), happy_new_session_resolve [happy]: --new path through _resolve_then_run., happy_new_with_end_user_id_resolve [happy]: args.end_user_id threads into POST b, user_agent_header_sent [trace]: outbound requests carry the ratatoskr User-Agent, alt_screen_never_opens_on_resolve_error [trace]: 404 → run_tui=12; run_async unh, session_api_failed_on_resolve [error]: --new + 500 → [session_api_failed] stderr, network_error_on_resolve [error]: --new + ConnectError → [network_error] stderr. (+6 more)
|
||||
|
||||
### Community 2 - "Parsed CLI Arguments Handling"
|
||||
Cohesion: 0.14
|
||||
Nodes (53): ParsedArgs, Raised on argument violations; mapped to exit code 10 by main()., Resolved CLI invocation. Post-validation: exactly one of session_id / new is set, UsageError, AgentInfo, Worldtree agent envelope from GET /agents (issue #8). INV-005: required fie, Cancelled, Done (+45 more)
|
||||
Nodes (73): NamedTuple, ParsedArgs, Resolved CLI invocation. Post-validation: exactly one of session_id / new is set, AgentInfo, Worldtree agent envelope from GET /agents (issue #8). INV-005: required fie, AffectUpdate, AwaitingLlmFirstToken, Cancelled (+65 more)
|
||||
|
||||
### Community 3 - "Agent Information Management"
|
||||
Cohesion: 0.19
|
||||
Nodes (55): AgentInfo, ComposeResult, Exception, FileResponse, JSONResponse, _ArgparseError, _AuthError, Raised when no API key is resolvable; mapped to exit code 11 by main(). (+47 more)
|
||||
Cohesion: 0.08
|
||||
Nodes (86): AgentInfo, ComposeResult, EventSource, Exception, FileResponse, _ArgparseError, _AuthError, Raised when no API key is resolvable; mapped to exit code 11 by main(). (+78 more)
|
||||
|
||||
### Community 4 - "TUI Tests and Contract Verification"
|
||||
Cohesion: 0.08
|
||||
Nodes (36): _args_existing(), _noop_worker(), MonkeyPatch, Tests for ratatoskr.tui per docs/contracts/issues/4.contract.md., Fake _stream_turn_worker that never completes (lets state stay 'streaming')., happy_submit_echoes_and_spawns [happy,tracer]: …, empty_submit_no_op [trace]: '' + Enter → no change; no worker spawned., submit_during_streaming_shows_busy_notice [adversarial]: … (+28 more)
|
||||
Cohesion: 0.13
|
||||
Nodes (17): _args_existing(), Type content into the input and submit; wait for worker to finish., happy_text_done_no_double_print [happy,tracer, v0.9.0]: Text("hello") mo, raw_flag_skips_markdown_render [trace, v0.9.0]: With --raw, the response, error_terminal_returns_to_idle [happy]: …, cancelled_terminal_returns_to_idle [happy]: …, active_turn_id_set_on_first_event [trace]: …, connection_dropped_returns_to_idle [error]: … (+9 more)
|
||||
|
||||
### Community 5 - "CLI Arguments Parsing Contract"
|
||||
Cohesion: 0.06
|
||||
Nodes (26): _parse_args(), argparse + env-fallback + xor-validation per the contract., happy_existing_session: --send --session --api-key → ParsedArgs with session_id., api_key_from_env: WORLDTREE_API_KEY env var fills in when --api-key omitted., api_key_flag_beats_env: explicit --api-key wins over WORLDTREE_API_KEY., server_default: no --server, no WORLDTREE_API_URL → http://localhost:8000., server_env_fallback: WORLDTREE_API_URL fills in when --server omitted., server_flag_beats_env: explicit --server wins over WORLDTREE_API_URL. (+18 more)
|
||||
Cohesion: 0.04
|
||||
Nodes (26): main(), _parse_args(), argparse + env-fallback + xor-validation per the contract., Sync entry point. Maps UsageError/_AuthError to exit codes BEFORE the event loop, happy_existing_session: --send --session --api-key → ParsedArgs with session_id., api_key_from_env: WORLDTREE_API_KEY env var fills in when --api-key omitted., server_default: no --server, no WORLDTREE_API_URL → http://localhost:8000., server_env_fallback: WORLDTREE_API_URL fills in when --server omitted. (+18 more)
|
||||
|
||||
### Community 6 - "Sync Entry Point and Session Resolution"
|
||||
Cohesion: 0.07
|
||||
Nodes (28): Sync entry point — delegates to the async resolve-then-run flow. Per issue, run_tui(), _args_new_no_agent(), CaptureFixture, Tests at the `_resolve_then_run` layer — pre-`App.run()` session resolution, happy_new_session_resolve [happy]: --new path through _resolve_then_run., happy_new_with_end_user_id_resolve [happy]: args.end_user_id threads into POST b, user_agent_header_sent [trace]: outbound requests carry the ratatoskr User-Agent (+20 more)
|
||||
Cohesion: 0.17
|
||||
Nodes (7): POST a message and yield typed Events. See contract FN stream_turn., stream_turn(), session_not_found: 404 -> SseConnectFailed(status=404)., malformed_id_no_seq: id `42` (missing :seq) -> MalformedSseId; no event yielded., malformed_id_alpha: id `foo:bar` -> MalformedSseId., INV-001: empty stream (no events at all) -> SseConnectionDropped(None)., ERROR_ROUTING: SseConnectFailed.body is truncated to <= 1024 bytes.
|
||||
|
||||
### Community 7 - "Stream Turn Rendering and Cancellation"
|
||||
Cohesion: 0.10
|
||||
Nodes (25): Drive stream_turn, render events, race against sigint_event for mid-stream cance, _run_turn(), _GatedStream, Event, no_busy_loop_after_cancel [trace]: only one sigint_event.wait()-task created., cancel_failed_drains_anyway [scenario]: …, render_called_once_per_event [trace]: spy on render; call_count == event count., sigint_handler_installed_and_removed [trace]: signal handler add/remove paired. (+17 more)
|
||||
Cohesion: 0.05
|
||||
Nodes (53): _amain(), Drive stream_turn, render events, race against sigint_event for mid-stream cance, Async orchestrator: create-session (if --new) → SIGINT install → _run_turn → cle, Raised on argument violations; mapped to exit code 10 by main()., _run_turn(), UsageError, SSE event `text_boundary`: speakable breakpoint after a `text` event., TextBoundary (+45 more)
|
||||
|
||||
### Community 8 - "Worldtree Session Client"
|
||||
Cohesion: 0.06
|
||||
Nodes (26): InvalidCursor, list_sessions(), Worldtree Conversation API session-lifecycle client. Implements docs/contracts/, GET /sessions. See contract FN list_sessions., Worldtree session envelope; shared shape for create + list responses. INV-0, One page of GET /sessions results. `next_cursor=None` on the last page., Raised on HTTP 422 cursor_invalid from GET /sessions., SessionInfo (+18 more)
|
||||
Cohesion: 0.04
|
||||
Nodes (47): AgentNotAvailable, AuthScopeDenied, get_persona_state(), InvalidCursor, list_sessions(), PersonaNotConfigured, Worldtree Conversation API session-lifecycle client. Implements docs/contracts/, Raised on HTTP 404 `agent_not_available` from GET persona_state. The agent_ (+39 more)
|
||||
|
||||
### Community 9 - "Tier 3 Agent Lifecycle Client"
|
||||
Cohesion: 0.07
|
||||
Nodes (32): _build_parser(), define_agent(), _extract_error_code(), _extract_error_field(), main(), _parse_tier3_agent_info(), patch_agent(), Worldtree Tier 3 (consumer-defined) agent lifecycle client. Implements docs/con (+24 more)
|
||||
Cohesion: 0.08
|
||||
Nodes (19): _args_new(), Construct RatatoskrApp with pre-resolved state (issue #6 lifecycle). Produc, happy_new_session_mount [happy,tracer]: identity populated from pre-resolved sta, footer_identity_visible_first_frame [trace]: identity widget rendered first fram, main_row_is_horizontal [tracer]: compose() yields Horizontal#main-row., left_column_content_only [v0.9.0]: left column = transcript-scroll Verti, right_column_has_tabbed_content_with_tools_tab: #side-panes + TabPane#tools-tab., tools_log_inside_tools_tab: tools-transcript RichLog is a descendant of tools-ta (+11 more)
|
||||
|
||||
### Community 10 - "CLI Presenter State Management"
|
||||
Cohesion: 0.09
|
||||
Nodes (23): CliPresenterState, Per-turn presenter state for `--send` mode (issue #12). See `docs/contracts, SSE event `text_boundary`: speakable breakpoint after a `text` event., TextBoundary, _make_done(), Tests for the new CliPresenterState — per issue #12 contract., thinking_coalesce_single_run [happy,tracer]: Thinking("hello") + Thinkin, thinking_closes_on_first_non_thinking_event [happy]: Thinking → WorkerPh (+15 more)
|
||||
Cohesion: 0.11
|
||||
Nodes (36): Any, Connection, build_affect_provider_app(), _ctx_actor(), open_affect_store(), RatatoskrAffectStore, SQLite-backed, conduit-opaque affect store (Bifrost affect plane, v1). Contract, Read-back of the stored snapshot (tests / future rehydrate-seed). (+28 more)
|
||||
|
||||
### Community 11 - "Ratatoskr Application Argument Handling"
|
||||
Cohesion: 0.09
|
||||
Nodes (23): _args_new(), Construct RatatoskrApp with pre-resolved state (issue #6 lifecycle). Produc, happy_new_session_mount [happy,tracer]: identity populated from pre-resolved sta, happy_existing_session_mount: identity shows <unknown> when agent_id is None., footer_identity_visible_first_frame [trace]: identity widget rendered first fram, INV-013 + INV-014 + INV-017: Horizontal two-column layout with Tools tab., main_row_is_horizontal [tracer]: compose() yields Horizontal#main-row., left_column_content_only [v0.9.0]: left column = transcript-scroll Verti (+15 more)
|
||||
Cohesion: 0.07
|
||||
Nodes (26): CliPresenterState, _format_duration_ms(), Auto-scale duration formatting per issue #12 INV-006. Locale-blind., Per-turn presenter state for `--send` mode (issue #12). See `docs/contracts, Render one Worldtree SSE event with editorial hierarchy + coalescing., _make_done(), Tests for the new CliPresenterState — per issue #12 contract., thinking_coalesce_single_run [happy,tracer]: Thinking("hello") + Thinkin (+18 more)
|
||||
|
||||
### Community 12 - "Stream Turn Event Processing"
|
||||
Cohesion: 0.07
|
||||
Nodes (21): POST a message and yield typed Events. See contract FN stream_turn., stream_turn(), heartbeat_sequence_monotonic [scenario]: three consecutive heartbeats in, happy_one_text_done: text then done; same turn_id; iter ends after done., full_event_vocab: one of each variant; all carry parsed sse_id., error_terminal: text then error; iteration ends; error_code populated., cancelled_terminal: cancelled with phase=cancelled, turn_id; iteration ends., session_not_found: 404 -> SseConnectFailed(status=404). (+13 more)
|
||||
Cohesion: 0.14
|
||||
Nodes (8): happy_one_text_done: text then done; same turn_id; iter ends after done., error_terminal: text then error; iteration ends; error_code populated., connection_drop: RemoteProtocolError after one text -> SseConnectionDropped((42,, no_text_aggregation: consumer yields each text event separately; no concat., Compose one SSE event in wire format. Trailing blank line per spec., current_status_parsed_with_snapshot [tracer]: status=current carries the, scheduled_status_parsed_no_snapshot [trace]: status=scheduled carries no, _sse_chunk()
|
||||
|
||||
### Community 13 - "Local Tier 3 Agent Index Management"
|
||||
Cohesion: 0.14
|
||||
Nodes (22): LocalAgentEntry, add_local_agent(), load_local_agents(), LocalAgentEntry, Local index of tier-3 agents defined via `python -m ratatoskr.tier3`. Workaroun, Add (or replace) an agent in the local index. agent_id is the key., Update an existing entry. Identical semantics to ``add_local_agent`` (agent_, Remove an entry by agent_id. No-op if absent (idempotent). (+14 more)
|
||||
Cohesion: 0.07
|
||||
Nodes (43): LocalAgentEntry, Namespace, add_local_agent(), load_local_agents(), _local_agents_path(), LocalAgentEntry, make_description(), Local index of tier-3 agents defined via `python -m ratatoskr.tier3`. Workaroun (+35 more)
|
||||
|
||||
### Community 14 - "Ratatoskr Application Core"
|
||||
Cohesion: 0.09
|
||||
Nodes (19): RatatoskrApp, Populate identity widget from pre-resolved state; set idle hint. Per is, Hydrate persona-header + Persona pane via GET /agents/{id}/persona_state., Update sticky header + Persona pane from a fresh snapshot. Called on bo, Render an italic-dim placeholder in the Persona pane; keep header empty., v0.6.0: turn-ID headers across every pane for cross-pane correlation. v0, Set the hint state attribute AND update the visible Static widget., Write a timestamped audit line to the debug pane. v0.10.0: shared sink (+11 more)
|
||||
Cohesion: 0.07
|
||||
Nodes (19): _cancel_via_sse(), Populate identity widget from pre-resolved state; set idle hint. Per is, Hydrate persona-header + Persona pane via GET /agents/{id}/persona_state., Render an italic-dim placeholder in the Persona pane; keep header empty., v0.6.0: turn-ID headers across every pane for cross-pane correlation. v0, Set the hint state attribute AND update the visible Static widget., Write a timestamped audit line to the debug pane. v0.10.0: shared sink, Set self.state with debug-pane audit log. Every state machine transitio (+11 more)
|
||||
|
||||
### Community 15 - "Async Main Orchestrator"
|
||||
Cohesion: 0.08
|
||||
Nodes (21): _amain(), Async orchestrator: create-session (if --new) → SIGINT install → _run_turn → cle, _clear_env(), CaptureFixture, MonkeyPatch, user_agent_header_sent [trace]: outbound requests carry the ratatoskr User-Agent, happy_new_session_then_stream [happy,tracer]: …, happy_existing_session: --session, no create POST; just SSE stream → exit 0. (+13 more)
|
||||
Cohesion: 0.17
|
||||
Nodes (7): happy_submit_echoes_and_spawns [happy,tracer]: …, empty_submit_no_op [trace]: '' + Enter → no change; no worker spawned., submit_during_streaming_shows_busy_notice [adversarial]: …, submit_during_cancelling_shows_busy_notice [adversarial]: …, sse_connect_failed_returns_to_idle [error]: …, Patch RichLog.write AND VerticalScroll.mount to record every renderable or m, _spy_writes()
|
||||
|
||||
### Community 16 - "Contract Parsing and Function Extraction"
|
||||
Cohesion: 0.11
|
||||
Nodes (31): Contract, ErrorSpec, _extract_function_blocks(), FunctionBlock, main(), _parse_body_sections(), parse_contract(), _parse_frontmatter() (+23 more)
|
||||
Cohesion: 0.10
|
||||
Nodes (34): Contract, ErrorSpec, _extract_function_blocks(), FunctionBlock, _is_issue_scoped(), main(), _parse_body_sections(), parse_contract() (+26 more)
|
||||
|
||||
### Community 17 - "Behavioral Guidelines Documentation"
|
||||
Cohesion: 0.06
|
||||
@@ -251,8 +272,8 @@ Cohesion: 0.07
|
||||
Nodes (16): _parse_sse_id(), Parse the SSE wire `id:` as composite `{turn_id}:{seq}`. See contract FN _parse_, negative_seq [adversarial]: '42:-1' -> ValueError., trailing_whitespace [adversarial]: '42:3 ' -> ValueError (strict; no strip)., truncation [security]: 5000-char no-colon -> ValueError msg contains only raw[:6, PRE-001 hard: raw is a string -- isinstance check before parse., happy_simple [happy,tracer]: '42:3' -> SseId(turn_id=42, seq=3)., happy_seq_one: smallest valid id per spec — first event of first turn. (+8 more)
|
||||
|
||||
### Community 19 - "Tier 3 Error Handling"
|
||||
Cohesion: 0.11
|
||||
Nodes (19): Raised on HTTP 429 ``agent_quota_exceeded`` — 50-agent cap reached on the He, Raised on HTTP 403 ``tier3_user_id_unsupported`` — auth's user_id is not slu, Raised on HTTP 422 ``layer_deferred`` — define request carried a non-null la, Raised on HTTP 404 — PATCH or DELETE on a non-existent agent_id (spec §2634, Tier3AgentNotFound, Tier3LayerDeferred, Tier3QuotaExceeded, Tier3UserIdUnsupported (+11 more)
|
||||
Cohesion: 0.25
|
||||
Nodes (5): _args_new_no_agent(), ParsedArgs for bare --new (no --agent) — TUI-mode picker entry., picker_happy_path [happy,tracer]: agents fetched → picker exits with id → create, picker_esc_clean_exit: picker returns None → exit 0; no create_session; no main, list_agents 500 → stderr [session_api_failed]; exit 20; picker NOT opened.
|
||||
|
||||
### Community 20 - "Web Packaging and CLI Argument Tests"
|
||||
Cohesion: 0.07
|
||||
@@ -262,45 +283,33 @@ Nodes (23): ArgumentParser, Packaging + lazy-import discipline tests for ratatos
|
||||
Cohesion: 0.07
|
||||
Nodes (26): Admin inspection endpoints, Appendix: `agent.ui_hints` config block, Authentication, Base URL, Client Implementation Guide, Custom exception handler status-code mapping, Endpoints, Error Codes (+18 more)
|
||||
|
||||
### Community 22 - "CLI Command Rendering and Usage"
|
||||
Cohesion: 0.12
|
||||
Nodes (13): _format_duration_ms(), _format_usage(), main(), Ratatoskr CLI — non-interactive `--send` stdout presenter. Implements docs/cont, Auto-scale duration formatting per issue #12 INV-006. Locale-blind., Natural-language usage formatting per issue #12 INV-007. `arrow="->"` for C, Render one Worldtree SSE event with editorial hierarchy + coalescing., Sync entry point. Maps UsageError/_AuthError to exit codes BEFORE the event loop (+5 more)
|
||||
|
||||
### Community 23 - "TUI Shell Implementation"
|
||||
Cohesion: 0.09
|
||||
Nodes (18): _audit_line(), _format_persona_detail(), _format_persona_header(), _plain_label(), Ratatoskr Textual TUI shell — interactive primary presenter. Implements docs/co, Pre-flight session resolution then App.run_async() inside one event loop. E, Pre-amendment labeled-line shape for INV-009 render-exception fallback. Use, HH:MM:SS.fff wall-clock timestamp for debug-pane log lines. (+10 more)
|
||||
Cohesion: 0.15
|
||||
Nodes (12): _format_usage(), Natural-language usage formatting per issue #12 INV-007. `arrow="->"` for C, _audit_line(), _plain_label(), Ratatoskr Textual TUI shell — interactive primary presenter. Implements docs/co, Pre-flight session resolution then App.run_async() inside one event loop. E, Pre-amendment labeled-line shape for INV-009 render-exception fallback. Use, HH:MM:SS.fff wall-clock timestamp for debug-pane log lines. (+4 more)
|
||||
|
||||
### Community 24 - "Contract Amendments for Presenter States"
|
||||
Cohesion: 0.09
|
||||
Nodes (22): Acceptance, `_amain` STEPS amended, Architecture, `CLASS CliPresenterState` (NEW), `CLASS TuiPresenterState` (NEW), Constraints, Context, Data flow (+14 more)
|
||||
|
||||
### Community 25 - "Session Creation API"
|
||||
Cohesion: 0.12
|
||||
Nodes (13): create_session(), POST /sessions to create a new session. See contract FN create_session. Per, validation_failed: 422 -> SessionApiFailed(status=422); body truncated., unexpected_status_truncates: 500 + 5000-byte body -> SessionApiFailed; body == 1, empty_agent_id [adversarial]: '' -> AssertionError; no HTTP issued., happy_create_with_end_user_id [happy]: body carries both keys (issue #5)., default_omits_end_user_id [trace]: omit kwarg → body has no end_user_id (INV-002, empty_end_user_id [adversarial]: '' → AssertionError before HTTP (PRE-003). (+5 more)
|
||||
Cohesion: 0.05
|
||||
Nodes (22): create_session(), list_agents(), POST /sessions to create a new session. See contract FN create_session. Per, GET /agents — list available agents. See contract FN list_agents (issue #8)., AsyncClient, validation_failed: 422 -> SessionApiFailed(status=422); body truncated., unexpected_status_truncates: 500 + 5000-byte body -> SessionApiFailed; body == 1, empty_agent_id [adversarial]: '' -> AssertionError; no HTTP issued. (+14 more)
|
||||
|
||||
### Community 26 - "Web Server Endpoint Handling"
|
||||
Cohesion: 0.10
|
||||
Nodes (21): _agents_endpoint(), _as_dict(), _create_session_endpoint(), _format_sse(), _persona_state_endpoint(), Starlette app factory + endpoint handlers for ratatoskr.web. Per docs/contracts, POST /api/sessions → upstream POST /sessions. Per FN create_session_endpoint., POST /api/turns/{session_id} → allocate turn_id + register handle. Per FN s (+13 more)
|
||||
Cohesion: 0.09
|
||||
Nodes (33): JSONResponse, Request, v0.16.0 — cancel paths must target the UPSTREAM turn_id, not the browser-loc, A registered handle whose local turn_id (1) differs from its captured up, A handle with upstream_turn_id still None (turn never opened the upstrea, stream_turn_endpoint INV-005 — browser disconnect mid-stream triggers upstre, TestDisconnectCancel, TestUpstreamTurnIdCancel (+25 more)
|
||||
|
||||
### Community 27 - "SSE ID Parsing"
|
||||
Cohesion: 0.20
|
||||
Nodes (20): NamedTuple, Parsed composite SSE wire `id:` per spec §SSE id format., SseId, _check(), _load_fixture(), Drift-detection between TUI presentation discipline and web JS presenter per iss, Assert (event_type, data) for `event` matches the fixture entry., test_affect_update_matches_fixture() (+12 more)
|
||||
|
||||
### Community 28 - "Persona State Retrieval"
|
||||
Cohesion: 0.13
|
||||
Nodes (13): get_persona_state(), GET /agents/{agent_id}/persona_state — fetch current persona snapshot. Worl, Any, Worldtree #204 / v0.28.0 — GET /agents/{agent_id}/persona_state. Bootstrap, happy_full_snapshot [happy,tracer]: 200 → snapshot dict with pad + domin, persona_not_configured_404 [error]: 404 with error_code persona_not_conf, agent_not_available_404 [error]: 404 with error_code agent_not_available, auth_scope_denied_403 [error]: 403 with error_code auth_scope_denied → A (+5 more)
|
||||
Cohesion: 0.19
|
||||
Nodes (17): _check(), _load_fixture(), Drift-detection between TUI presentation discipline and web JS presenter per iss, Assert (event_type, data) for `event` matches the fixture entry., test_affect_update_matches_fixture(), test_awaiting_llm_first_token_matches_fixture(), test_cancelled_matches_fixture(), test_done_matches_fixture() (+9 more)
|
||||
|
||||
### Community 29 - "Agent Deletion and Authentication"
|
||||
Cohesion: 0.15
|
||||
Nodes (16): Namespace, delete_agent(), DELETE /agents/<id> — owner hard-delete (cancels active sessions server-side, No API key resolvable → exit 11., Resolve API key + server URL with the same env-var fallback as cli.py., _resolve_auth(), _run_define(), _run_delete() (+8 more)
|
||||
|
||||
### Community 30 - "Agent Listing Client"
|
||||
Cohesion: 0.15
|
||||
Nodes (11): list_agents(), GET /agents — list available agents. See contract FN list_agents (issue #8)., AsyncClient, happy_full_shape [happy,tracer]: spec full-shape mimir example → all fields., happy_minimum_shape: required-only agent → optional fields default., happy_multi_agent: 3 agents preserve order., happy_empty: 200 with [] returns empty list (no error)., omit_capabilities_empty: explicit [] from server still defaults to []. (+3 more)
|
||||
Cohesion: 0.50
|
||||
Nodes (3): lifespan_shutdown FN — INV-006: drain turn_registry within 5s budget., happy [tracer]: 2 in-flight turns + shutdown → upstream cancels called., TestLifespanShutdown
|
||||
|
||||
### Community 31 - "Browser SSE Stream Parsing"
|
||||
Cohesion: 0.17
|
||||
Nodes (12): _parse_browser_sse(), Response, Parse a server-to-browser SSE stream into [{"event": str, "data": dict}, ...]., happy [tracer]: respx mock one text+done → SSE stream yields text + done events., The stream generator captures upstream turn_id from the first event's ss, stream_turn_endpoint full_event_vocab — one of each Event type proxied., full_event_vocab [scenario]: a stream with the non-terminal Event types, error terminal [scenario]: an SSE `error` event (distinct from the synth (+4 more)
|
||||
Cohesion: 0.14
|
||||
Nodes (16): _parse_browser_sse(), AsyncByteStream, Response, Tests for ratatoskr.web.server per docs/contracts/issues/16.contract.md. The Te, SSE response backed by a live AsyncByteStream (for gated/hanging streams in, Parse a server-to-browser SSE stream into [{"event": str, "data": dict}, ...]., happy [tracer]: respx mock one text+done → SSE stream yields text + done events., The stream generator captures upstream turn_id from the first event's ss (+8 more)
|
||||
|
||||
### Community 32 - "Canonical Sync Documentation"
|
||||
Cohesion: 0.12
|
||||
@@ -323,16 +332,16 @@ Cohesion: 0.12
|
||||
Nodes (16): arousal, dominance, pleasure, snapshot, arousal_delta, valence_delta, arousal, dominance (+8 more)
|
||||
|
||||
### Community 37 - "Web Server Functional Tests"
|
||||
Cohesion: 0.13
|
||||
Nodes (12): AsyncByteStream, Tests for ratatoskr.web.server per docs/contracts/issues/16.contract.md. The Te, SSE response backed by a live AsyncByteStream (for gated/hanging streams in, root_endpoint FN + /static mount — index.html + static asset serving., happy [tracer]: GET / → 200, content-type text/html, body contains '<html'., lifespan_shutdown FN — INV-006: drain turn_registry within 5s budget., happy [tracer]: 2 in-flight turns + shutdown → upstream cancels called., stream_turn_endpoint INV-005 — browser disconnect mid-stream triggers upstre (+4 more)
|
||||
Cohesion: 0.50
|
||||
Nodes (3): root_endpoint FN + /static mount — index.html + static asset serving., happy [tracer]: GET / → 200, content-type text/html, body contains '<html'., TestStaticServing
|
||||
|
||||
### Community 38 - "Upload Management and Capabilities"
|
||||
Cohesion: 0.13
|
||||
Nodes (15): Agent capability: `accepts_uploads`, Attaching uploads to messages, Auth scopes, Capability vocabulary, DELETE /uploads/{upload_id}, Dispatch channels, Endpoints, Example JavaScript client (upload-then-reference) (+7 more)
|
||||
|
||||
### Community 39 - "Tier 3 Agent Patching Tests"
|
||||
Cohesion: 0.13
|
||||
Nodes (8): Tests for ratatoskr.tier3 per docs/contracts/issues/15.contract.md., happy_patch_both_fields: both fields set → request body has both., happy_patch_single_field: omit model → body has system_prompt only., field_not_mutable [error]: 422 + error_code → Tier3FieldNotMutable(field)., 404 [error]: PATCH on non-existent agent → Tier3AgentNotFound., no_fields_assert [adversarial]: both None → AssertionError, no HTTP., non_tier3_id_assert [adversarial]: agent_id without `:` → AssertionError., TestPatchAgent
|
||||
Cohesion: 0.22
|
||||
Nodes (8): Concurrency, Constraints, Context, Data flow, Division of labor (library vs store), Integration points, Invariants, Out of scope (deferred — do NOT flag as drift)
|
||||
|
||||
### Community 40 - "Agent Documentation and Attribution"
|
||||
Cohesion: 0.14
|
||||
@@ -346,10 +355,6 @@ Nodes (13): CLI surface (`python -m ratatoskr.tier3`), Context, ERROR_ROUTING (m
|
||||
Cohesion: 0.14
|
||||
Nodes (13): CLI surface change (ratatoskr.cli amendment), Context, Data flow, ERROR_ROUTING (tui startup), FN list_agents, Functions, Invariants, Modified: _resolve_then_run (+5 more)
|
||||
|
||||
### Community 43 - "Turn Cancellation via SSE"
|
||||
Cohesion: 0.14
|
||||
Nodes (8): _cancel_via_sse(), Fire-and-forget cancel; never raises (mirrors cli._cancel_and_log; #3 INV-009)., audit_callback_records_failure [v0.10.0]: failure path emits `cancel_pos, happy_cancel [happy,tracer]: 200 OK → returns None; transcript has no [cancel_fa, cancel_failed_500 [error]: …, cancel_already_completed [scenario]: 409 → '[cancel_failed] CancelAlreadyComplet, transport_error_swallowed [error]: …, audit_callback_records_lifecycle [v0.10.0]: when the caller passes an `a
|
||||
|
||||
### Community 44 - "Web Server Contract Version 16"
|
||||
Cohesion: 0.15
|
||||
Nodes (12): Console script, Constraints, Context, Function blocks, Invariants, Module shape, Public functions, Public surface (+4 more)
|
||||
@@ -383,8 +388,8 @@ Cohesion: 0.17
|
||||
Nodes (11): Acceptance, Constraints, Context, Data flow, In-place amendments (the work), Invariants, Issue #1 (`ratatoskr.sse_client`) amendments, Issue #3 (`ratatoskr.cli`) amendments (+3 more)
|
||||
|
||||
### Community 52 - "Turn Cancellation and Logging"
|
||||
Cohesion: 0.17
|
||||
Nodes (7): _cancel_and_log(), Spawn-and-forget cancel that never raises (INV-009)., happy_cancel [happy,tracer]: 200 OK → returns None; stderr empty., cancel_failed_500 [error]: …, cancel_already_completed [scenario]: …, cancel_turn_not_found [scenario]: 404 → returns None; stderr CancelTurnNotFound., transport_error_swallowed [error]: …
|
||||
Cohesion: 0.20
|
||||
Nodes (6): _cancel_and_log(), Ratatoskr CLI — non-interactive `--send` stdout presenter. Implements docs/cont, Spawn-and-forget cancel that never raises (INV-009)., cancel_already_completed [scenario]: …, cancel_turn_not_found [scenario]: 404 → returns None; stderr CancelTurnNotFound., transport_error_swallowed [error]: …
|
||||
|
||||
### Community 53 - "Mock Client Factory for Persona State"
|
||||
Cohesion: 0.21
|
||||
@@ -403,8 +408,8 @@ Cohesion: 0.18
|
||||
Nodes (11): BM25 ranking, Endpoint, Error codes, Example: curl, Example: JavaScript pagination loop, FTS5 query syntax, Legacy `created_at` caveat, Query parameters (+3 more)
|
||||
|
||||
### Community 57 - "Presentation Contract JSON"
|
||||
Cohesion: 0.29
|
||||
Nodes (6): affect_update, event_type, _contract_version, _provenance, thinking, event_type
|
||||
Cohesion: 0.22
|
||||
Nodes (8): affect_update, data, event_type, _contract_version, status, _provenance, text, event_type
|
||||
|
||||
### Community 59 - "Monkey Patching for Local Agents"
|
||||
Cohesion: 0.18
|
||||
@@ -434,10 +439,6 @@ Nodes (9): 1. Vor (optional), 2. Contract (required), 3. Branch — direct or AF
|
||||
Cohesion: 0.20
|
||||
Nodes (10): model, response, usage, done, data, event_type, cached_input_tokens, completion_tokens (+2 more)
|
||||
|
||||
### Community 66 - "Local Agents Path Resolution"
|
||||
Cohesion: 0.29
|
||||
Nodes (7): _local_agents_path(), Resolve the local index file path with XDG + env-var override., Path, local_path(), MonkeyPatch, Point $RATATOSKR_LOCAL_AGENTS at a fresh tmp file for the test., TestPathResolution
|
||||
|
||||
### Community 67 - "Project README Overview"
|
||||
Cohesion: 0.20
|
||||
Nodes (9): Boundary rule, Consumer-side discoveries, Quickstart, Ratatoskr, Read in this order, Related repos, Status, Version-skew strategy (+1 more)
|
||||
@@ -455,12 +456,12 @@ Cohesion: 0.22
|
||||
Nodes (8): Bump procedure, Conformance smoke check, Current pin, History, Pin history, Vendored artifacts, Why pin?, Worldtree spec pin
|
||||
|
||||
### Community 71 - "Turn Status and Timing Data"
|
||||
Cohesion: 0.29
|
||||
Nodes (7): data, awaiting_llm_first_token, data, event_type, elapsed_ms_since_building_prompt, status, turn_id
|
||||
Cohesion: 0.15
|
||||
Nodes (14): awaiting_llm_first_token, data, event_type, cancelled, data, event_type, elapsed_ms_since_building_prompt, partial_message_id (+6 more)
|
||||
|
||||
### Community 72 - "Error Code and Worker Phase Handling"
|
||||
Cohesion: 0.22
|
||||
Nodes (9): error_code, message, phase, error, data, event_type, worker_phase, data (+1 more)
|
||||
Cohesion: 0.40
|
||||
Nodes (5): error_code, message, error, data, event_type
|
||||
|
||||
### Community 73 - "CLI and TUI Contract Amendments"
|
||||
Cohesion: 0.22
|
||||
@@ -474,10 +475,6 @@ Nodes (8): Admin: API Key Management, Bootstrap: first admin key, DELETE /admin/
|
||||
Cohesion: 0.25
|
||||
Nodes (7): Architecture, CLI — Non-interactive --send stdout presenter, Constraints, Context, Data flow, Invariants, Out of scope
|
||||
|
||||
### Community 76 - "Description Synthesis for Picker"
|
||||
Cohesion: 0.39
|
||||
Nodes (3): make_description(), Synthesize a one-line description for the picker from a system prompt. Stra, TestMakeDescription
|
||||
|
||||
### Community 77 - "Canonical Sync Pinning Utility"
|
||||
Cohesion: 0.36
|
||||
Nodes (7): main(), SHA-256 hash, first 16 hex chars., Replace the quoted value in a `key = "value"` line, preserving leading white, Surgically update one pin's `pinned_sha256_16` + `pinned_at` lines in the ma, _replace_value_preserve_format(), sha256_16(), update_pin_in_manifest_text()
|
||||
@@ -507,8 +504,8 @@ Cohesion: 0.29
|
||||
Nodes (7): 1. Frontmatter, `complexity` guide, `dependencies:` — dispatch-ordering metadata (Sleipnir / preflight), Dependency fields — `depends_on` vs `dependencies`, `depends_on:` — module-architecture metadata, `prd` block — pinning a contract to its source-of-truth, Why two fields
|
||||
|
||||
### Community 84 - "User Agent Versioning"
|
||||
Cohesion: 0.29
|
||||
Nodes (5): Compose the User-Agent header — `ratatoskr/<version> (<contact>)`. Per worl, _resolve_user_agent(), version_endpoint FN — tracer per contract issue #16., happy [tracer]: GET /version → 200, body == {"ratatoskr": "<current-version>"}., TestVersionEndpoint
|
||||
Cohesion: 0.50
|
||||
Nodes (3): version_endpoint FN — tracer per contract issue #16., happy [tracer]: GET /version → 200, body == {"ratatoskr": "<current-version>"}., TestVersionEndpoint
|
||||
|
||||
### Community 85 - "Architecture Overview"
|
||||
Cohesion: 0.29
|
||||
@@ -590,10 +587,6 @@ Nodes (4): SSE frame with id but empty data (server-emitted keepalive shape)., e
|
||||
Cohesion: 0.33
|
||||
Nodes (4): stream_turn_endpoint FN — open upstream SSE, proxy events to browser., unknown_turn [error]: GET with turn_id not in registry → 404., upstream_error [error]: respx 500 → synthetic error SSE event., TestStreamTurnEndpoint
|
||||
|
||||
### Community 105 - "Upstream Turn ID Cancellation"
|
||||
Cohesion: 0.33
|
||||
Nodes (4): v0.16.0 — cancel paths must target the UPSTREAM turn_id, not the browser-loc, A registered handle whose local turn_id (1) differs from its captured up, A handle with upstream_turn_id still None (turn never opened the upstrea, TestUpstreamTurnIdCancel
|
||||
|
||||
### Community 106 - "Triadic Block Routing"
|
||||
Cohesion: 0.40
|
||||
Nodes (5): 2.1.A — `ERROR_ROUTING:` triadic block (SHIELDA), Example, Syntax, v2.0 back-compat, Why three axes
|
||||
@@ -608,11 +601,11 @@ Nodes (5): Authorization model — agent invocation, Common pitfalls, Quick deci
|
||||
|
||||
### Community 109 - "SSE Content Data"
|
||||
Cohesion: 0.40
|
||||
Nodes (6): content, sse_id, text, data, event_type, data
|
||||
Nodes (6): content, sse_id, data, thinking, data, event_type
|
||||
|
||||
### Community 110 - "Cancelled Message Handling"
|
||||
Cohesion: 0.40
|
||||
Nodes (5): cancelled, data, event_type, partial_message_id, reason
|
||||
Cohesion: 0.22
|
||||
Nodes (8): Concurrency, Constraints, Context, Data flow, Division of labor (library vs store), Integration points, Invariants, Out of scope (deferred — do NOT flag as drift)
|
||||
|
||||
### Community 111 - "Implicit Tool Call Narration"
|
||||
Cohesion: 0.50
|
||||
@@ -678,20 +671,32 @@ Nodes (3): Amendment — SSE phase events (issue #151, INV-053..INV-061), Integr
|
||||
Cohesion: 0.67
|
||||
Nodes (3): Amendment — Tier 3 consumer-defined agents (issue #181, Phase 2.0), Invariants (Phase 2.0 scope), Persona-state observability (issue #204)
|
||||
|
||||
### Community 133 - "Community 133"
|
||||
Cohesion: 0.14
|
||||
Nodes (9): _format_persona_detail(), _format_persona_header(), Update sticky header + Persona pane from a fresh snapshot. Called on bo, One-line persona summary for the sticky header widget. Shape: `agent_id · d, Multi-line persona detail for the Persona TabPane. Renders the full v0.28.0, header_compact_summary: agent_id · dominant_emotion · pad(P,A,D) · N emotions., header_singular_emotion: single emotion → '1 emotion active' (no 's')., header_no_emotions_drops_count: empty emotions list → no count suffix. (+1 more)
|
||||
|
||||
### Community 135 - "Community 135"
|
||||
Cohesion: 0.28
|
||||
Nodes (7): build_app_from_env(), main(), Runnable entrypoint: serve the affect provider as an ASGI app. For the live neg, Build the affect ASGI app from environment config (testable seam)., Tests for the affect-provider serve entrypoint (ratatoskr.provider.serve). Only, test_build_app_from_env_builds_app_with_routes(), test_build_app_from_env_requires_heimdall_key()
|
||||
|
||||
### Community 143 - "Community 143"
|
||||
Cohesion: 0.04
|
||||
Nodes (66): Raised on unexpected response status from /sessions endpoints. `body` is tr, SessionApiFailed, define_agent(), delete_agent(), _extract_error_code(), _extract_error_field(), _parse_tier3_agent_info(), patch_agent() (+58 more)
|
||||
|
||||
## Knowledge Gaps
|
||||
- **522 isolated node(s):** `allow`, `Any`, `Path`, `Any`, `Any` (+517 more)
|
||||
- **538 isolated node(s):** `Context`, `Data flow`, `Invariants`, `Out of scope`, `Constraints` (+533 more)
|
||||
These have ≤1 connection - possible missing edges or undocumented components.
|
||||
- **4 thin communities (<3 nodes) omitted from report** — run `graphify query` to explore isolated nodes.
|
||||
- **28 thin communities (<3 nodes) omitted from report** — run `graphify query` to explore isolated nodes.
|
||||
|
||||
## Suggested Questions
|
||||
_Questions this graph is uniquely positioned to answer:_
|
||||
|
||||
- **Why does `LocalAgentEntry` connect `Local Tier 3 Agent Index Management` to `TuiPresenterState Management`, `Parsed CLI Arguments Handling`, `TUI Tests and Contract Verification`, `Sync Entry Point and Session Resolution`, `Tier 3 Agent Lifecycle Client`, `Ratatoskr Application Argument Handling`, `Tier 3 Error Handling`, `Agent Deletion and Authentication`, `Browser SSE Stream Parsing`, `Web Server Functional Tests`, `Tier 3 Agent Patching Tests`, `Mock Client Factory for Persona State`, `Turn Cancellation Endpoint`, `Monkey Patching for Local Agents`, `Local Agents Path Resolution`, `Description Synthesis for Picker`, `Session Creation Endpoint Tests`, `Turn Submission Endpoint Tests`, `Server-Side End User ID Handling`, `Application Creation and Routing`, `User Agent Versioning`, `Stream Turn Endpoint Tests`, `Upstream Turn ID Cancellation`?**
|
||||
_High betweenness centrality (0.055) - this node is a cross-community bridge._
|
||||
- **Why does `SessionApiFailed` connect `Agent Information Management` to `TuiPresenterState Management`, `Parsed CLI Arguments Handling`, `Tier 3 Agent Patching Tests`, `Worldtree Session Client`, `Tier 3 Agent Lifecycle Client`, `CLI Presenter State Management`, `Ratatoskr Application Core`, `Tier 3 Error Handling`, `Session Creation API`, `Persona State Retrieval`, `Agent Deletion and Authentication`, `Agent Listing Client`?**
|
||||
_High betweenness centrality (0.054) - this node is a cross-community bridge._
|
||||
- **Why does `create_app()` connect `Turn Cancellation Endpoint` to `Agent Information Management`, `Web Server Functional Tests`, `Stream Turn Endpoint Tests`, `Upstream Turn ID Cancellation`, `Session Creation Endpoint Tests`, `Turn Submission Endpoint Tests`, `Server-Side End User ID Handling`, `Application Creation and Routing`, `User Agent Versioning`, `Mock Client Factory for Persona State`, `Web Packaging and CLI Argument Tests`, `Web Server Endpoint Handling`, `Monkey Patching for Local Agents`, `Browser SSE Stream Parsing`?**
|
||||
_High betweenness centrality (0.039) - this node is a cross-community bridge._
|
||||
- **Why does `LocalAgentEntry` connect `Local Tier 3 Agent Index Management` to `TuiPresenterState Management`, `Parsed CLI Arguments Handling`, `Web Server Functional Tests`, `Stream Turn Endpoint Tests`, `Community 143`, `Session Creation Endpoint Tests`, `Server-Side End User ID Handling`, `Application Creation and Routing`, `Turn Submission Endpoint Tests`, `User Agent Versioning`, `Mock Client Factory for Persona State`, `Turn Cancellation Endpoint`, `Web Server Endpoint Handling`, `Monkey Patching for Local Agents`, `Agent Deletion and Authentication`, `Browser SSE Stream Parsing`?**
|
||||
_High betweenness centrality (0.081) - this node is a cross-community bridge._
|
||||
- **Why does `SessionApiFailed` connect `Community 143` to `TuiPresenterState Management`, `Parsed CLI Arguments Handling`, `Agent Information Management`, `Stream Turn Rendering and Cancellation`, `Worldtree Session Client`, `Ratatoskr Application Argument Handling`, `Local Tier 3 Agent Index Management`, `Session Creation API`, `Web Server Endpoint Handling`?**
|
||||
_High betweenness centrality (0.044) - this node is a cross-community bridge._
|
||||
- **Why does `create_app()` connect `Turn Cancellation Endpoint` to `Agent Information Management`, `Web Server Functional Tests`, `Stream Turn Endpoint Tests`, `Session Creation Endpoint Tests`, `Turn Submission Endpoint Tests`, `Server-Side End User ID Handling`, `Application Creation and Routing`, `User Agent Versioning`, `Mock Client Factory for Persona State`, `Web Packaging and CLI Argument Tests`, `Web Server Endpoint Handling`, `Monkey Patching for Local Agents`, `Agent Deletion and Authentication`, `Browser SSE Stream Parsing`?**
|
||||
_High betweenness centrality (0.044) - this node is a cross-community bridge._
|
||||
- **Are the 51 inferred relationships involving `TuiPresenterState` (e.g. with `ParsedArgs` and `AgentInfo`) actually correct?**
|
||||
_`TuiPresenterState` has 51 INFERRED edges - model-reasoned connections that need verification._
|
||||
- **Are the 75 inferred relationships involving `Done` (e.g. with `AgentInfo` and `ComposeResult`) actually correct?**
|
||||
|
||||
+238
-125
File diff suppressed because one or more lines are too long
+27
-6
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "ratatoskr"
|
||||
version = "0.17.0"
|
||||
version = "0.20.14"
|
||||
description = "Worldtree Conversation API debug TUI — multi-pane observability dashboard"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
@@ -25,6 +25,15 @@ web = [
|
||||
"starlette>=0.40",
|
||||
"uvicorn[standard]>=0.30",
|
||||
]
|
||||
# Tier-3 Bifrost consumer: the durable memory.* + affect.* persistence
|
||||
# provider Worldtree writes into. Opt-in extra — distinct deployment surface
|
||||
# from the debug TUI. Recipe: bifrost/docs/implementing-a-consumer.md.
|
||||
provider = [
|
||||
"ratatoskr[web]", # reuse the starlette + uvicorn ASGI stack
|
||||
"bifrost==1.1.1", # consumer engines + library. 1.1.1 = frozen-wire serialization fix (ADR-0008): additive capability fields are gated on the NEGOTIATED wire, so a v0.6-negotiated describe_store handshake stays v0.6-clean. 1.1.0 leaked the v0.7-additive `sortable_chunk_fields` into v0.6 StoreCapabilities → a strict v0.6 client (additionalProperties:false) rejects our server's handshake. Wire schemas + pins UNCHANGED (serialization-correctness only); our v0.7 handshake with Worldtree b47 is unaffected. (1.1.0 = wire v0.7 additive: memory.scan sort + sortable_chunk_fields; 1.0.0 = first STABLE, wire v0.6 FROZEN; 0.8.0/v0.6 scope_all/scope_any #11; 0.7.0/v0.5 agent_self)
|
||||
"jsonschema>=4", # bifrost runtime dep — envelope validation
|
||||
"sqlite-vec>=0.1.6", # vector index for the memory plane (vec0 virtual table)
|
||||
]
|
||||
dev = [
|
||||
"pytest>=8",
|
||||
"pytest-asyncio>=0.24",
|
||||
@@ -37,8 +46,11 @@ dev = [
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
ratatoskr = "ratatoskr.cli:main"
|
||||
ratatoskr-web = "ratatoskr.web.entrypoint:main"
|
||||
ratatoskr = "ratatoskr.cli:main"
|
||||
ratatoskr-web = "ratatoskr.web.entrypoint:main"
|
||||
ratatoskr-provider = "ratatoskr.provider.serve:main"
|
||||
ratatoskr-memory-provider = "ratatoskr.provider.serve_memory:main"
|
||||
ratatoskr-combined-provider = "ratatoskr.provider.serve_combined:main"
|
||||
|
||||
[project.urls]
|
||||
Repository = "https://gitea.phasefinal.com/vh/ratatoskr"
|
||||
@@ -48,9 +60,18 @@ Repository = "https://gitea.phasefinal.com/vh/ratatoskr"
|
||||
# Ratatoskr is built against Worldtree at this commit; the vendored
|
||||
# spec snapshot in docs/ reflects that SHA.
|
||||
[tool.ratatoskr.spec-pin]
|
||||
worldtree-spec-rev = "562001af28d752c3a60d449c7ddd09f44fa9dc9a"
|
||||
worldtree-version = "v0.29.0"
|
||||
pinned-on = "2026-05-26"
|
||||
worldtree-spec-rev = "c9e59ec"
|
||||
worldtree-version = "v1.0.0b22"
|
||||
pinned-on = "2026-07-06"
|
||||
|
||||
# Bifrost lives on the auth-gated gitea PyPI index (not public PyPI).
|
||||
# uv reads the credential from UV_INDEX_GITEA_USERNAME / _PASSWORD or ~/.netrc.
|
||||
[[tool.uv.index]]
|
||||
name = "gitea"
|
||||
url = "https://gitea.phasefinal.com/api/packages/vh/pypi/simple/"
|
||||
|
||||
[tool.uv.sources]
|
||||
bifrost = { index = "gitea" }
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/ratatoskr"]
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Regenerate src/ratatoskr/web/static/persona_render_canon.json from the vendored
|
||||
Worldtree d2 render canons (docs/vendor/worldtree-persona-canon/).
|
||||
|
||||
The web persona pane renders the CANONICAL affect->NL (mood word + relationship
|
||||
directive) BYTE-EXACT to what Worldtree injects into the agent's context. That render
|
||||
needs the relation canon parsed into per-band phrase maps; this script reparses the
|
||||
vendored raw canons into the flat form the browser JS consumes.
|
||||
|
||||
Uses Worldtree's OWN loader (core.persona.stance_render.load_canon) as the authoritative
|
||||
parser, so the flat form can never drift from Worldtree's parsing semantics. Requires
|
||||
Worldtree's venv (pydantic etc.).
|
||||
|
||||
Run when scripts/canonical_drift.py flags a canon bump:
|
||||
PYTHONPATH=~/development/Worldtree ~/development/Worldtree/.venv/bin/python \
|
||||
scripts/build_persona_canon.py
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
from core.persona.stance_render import load_canon # Worldtree (authoritative parser)
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
VENDOR = ROOT / "docs" / "vendor" / "worldtree-persona-canon"
|
||||
OUT = ROOT / "src" / "ratatoskr" / "web" / "static" / "persona_render_canon.json"
|
||||
|
||||
canon = load_canon(str(VENDOR / "d2-render-canon-v1.json"))
|
||||
mood = json.loads((VENDOR / "d2-mood-render-canon-v1.json").read_text())
|
||||
out = {
|
||||
"_source": "vendored from Worldtree core/persona/canon/{d2-mood-render-canon-v1,d2-render-canon-v1}.json",
|
||||
"_generated_by": "scripts/build_persona_canon.py (regen on canonical_drift flag)",
|
||||
"_render_path": "deterministic, no LLM; mirrors Worldtree describe_pad + render_d2_canonical byte-exact",
|
||||
"mood_grid": mood["describe_pad"]["valence_arousal_grid"],
|
||||
# Context-injection reconstruction (affect-egress-consumer-reference §2b/2c): the
|
||||
# hidden mood DIRECTIVE. occ_directives = per-OCC-type behavioral string + tier;
|
||||
# pad_band_fallback = the P×A-quadrant default when no emotion is salient. The
|
||||
# salience gate (emotion_salience) + full_only tiers drive which one fires — but
|
||||
# affect.emit is type-only (no intensity), so the consumer shows BOTH candidates.
|
||||
"mood_directive": {
|
||||
"salience": mood["thresholds"]["emotion_salience"],
|
||||
"pad_band_cutoff": mood["thresholds"]["pad_band_cutoff"],
|
||||
"full_only": mood["emotion_tiers"]["full_only"],
|
||||
"occ_directives": {
|
||||
t: {"directive": e["directive"], "tier": e["tier"]}
|
||||
for t, e in mood["derive_directive"]["occ_directives"].items()
|
||||
},
|
||||
"pad_band_fallback": mood["pad_band_fallback"],
|
||||
},
|
||||
"relation": {
|
||||
"trust_cuts": [list(c) for c in canon.trust_cuts],
|
||||
"warmth_cuts": [list(c) for c in canon.warmth_cuts],
|
||||
"agency_cuts": [list(c) for c in canon.agency_cuts],
|
||||
"warmth_phrase": canon.warmth_phrase, "warmth_beh": canon.warmth_beh,
|
||||
"agency_phrase": canon.agency_phrase, "agency_beh": canon.agency_beh,
|
||||
"history": canon.history,
|
||||
"prefix": "Use this graded relationship state: toward target, warmth is ",
|
||||
"tbeh": {"low_trust": "verify important claims before relying on them",
|
||||
"cold_warmth": "protect boundaries while staying useful",
|
||||
"default": "work from ordinary good faith"},
|
||||
"cold_warmth_bands": ["distant", "cold", "hostile"], "high_conf_floor": 0.55,
|
||||
},
|
||||
}
|
||||
OUT.write_text(json.dumps(out, indent=1) + "\n")
|
||||
print(f"wrote {OUT.relative_to(ROOT)}")
|
||||
@@ -13,7 +13,8 @@ Usage:
|
||||
python scripts/contract_drift_check.py --contract docs/contracts/issues/138.contract.md
|
||||
python scripts/contract_drift_check.py --json
|
||||
|
||||
Requires GITEA_TOKEN in environment (and GITEA_URL/OWNER/REPO if not in env.sh).
|
||||
Requires GITEA_TOKEN in environment. Owner/repo are derived from the `origin` git remote by
|
||||
default (override with GITEA_OWNER / GITEA_REPO; GITEA_URL defaults to the Gitea host).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -21,6 +22,8 @@ import argparse
|
||||
import hashlib
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
@@ -32,6 +35,22 @@ PROJECT_ROOT = Path(__file__).parent.parent
|
||||
CONTRACTS_GLOB = "docs/contracts/**/*.contract.md"
|
||||
|
||||
|
||||
def _owner_repo_from_git_remote() -> tuple[str, str] | None:
|
||||
"""Derive (owner, repo) from the `origin` git remote so the drift check targets THIS repo
|
||||
by default — instead of a hardcoded repo name that silently checks the WRONG repo for every
|
||||
other consumer. Supports ssh (git@host:owner/repo.git) and https (https://host/owner/repo.git)
|
||||
Gitea remotes; returns None if it can't resolve."""
|
||||
try:
|
||||
url = subprocess.run(
|
||||
["git", "-C", str(PROJECT_ROOT), "remote", "get-url", "origin"],
|
||||
capture_output=True, text=True, check=True,
|
||||
).stdout.strip()
|
||||
except (OSError, subprocess.SubprocessError):
|
||||
return None
|
||||
m = re.search(r"[:/]([^/:]+)/([^/]+?)(?:\.git)?/?$", url)
|
||||
return (m.group(1), m.group(2)) if m else None
|
||||
|
||||
|
||||
def sha16(s: str) -> str:
|
||||
return hashlib.sha256(s.encode("utf-8")).hexdigest()[:16]
|
||||
|
||||
@@ -70,11 +89,19 @@ def main() -> int:
|
||||
|
||||
token = os.environ.get("GITEA_TOKEN", "")
|
||||
base_url = os.environ.get("GITEA_URL", "https://gitea.phasefinal.com")
|
||||
owner = os.environ.get("GITEA_OWNER", "vh")
|
||||
repo = os.environ.get("GITEA_REPO", "Worldtree")
|
||||
# Owner/repo default to the `origin` remote so the check targets THIS repo; GITEA_OWNER /
|
||||
# GITEA_REPO override when set. (Previously repo defaulted to a hardcoded "Worldtree", which
|
||||
# silently checked the WRONG repo for every other consumer unless GITEA_REPO was set in env —
|
||||
# a false-drift footgun. Derive it, and fail loud rather than guess.)
|
||||
git_remote = _owner_repo_from_git_remote()
|
||||
owner = os.environ.get("GITEA_OWNER") or (git_remote[0] if git_remote else None)
|
||||
repo = os.environ.get("GITEA_REPO") or (git_remote[1] if git_remote else None)
|
||||
if not token:
|
||||
print("error: GITEA_TOKEN not set", file=sys.stderr)
|
||||
return 2
|
||||
if not owner or not repo:
|
||||
print("error: could not resolve owner/repo — set GITEA_OWNER/GITEA_REPO or run inside a repo with an 'origin' remote", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
if args.contract:
|
||||
files = [Path(args.contract).resolve()]
|
||||
|
||||
Executable
+61
@@ -0,0 +1,61 @@
|
||||
#!/usr/bin/env bash
|
||||
# reset-sindra-stores.sh — wipe ratatoskr's Bifrost provider stores (memory +
|
||||
# affect/persona for the single-tenant Tier-3 agent, sindra) and restart the
|
||||
# combined :8392 provider empty.
|
||||
#
|
||||
# Usage:
|
||||
# scripts/reset-sindra-stores.sh # wipe, keep ONE rolling backup (default)
|
||||
# scripts/reset-sindra-stores.sh --hard # wipe with NO backup (zero-trace)
|
||||
#
|
||||
# The rolling backup (db-reset-backup/, gitignored via *.db*) is overwritten
|
||||
# every run — it never accumulates; it's a one-level undo, nothing more.
|
||||
#
|
||||
# Why stop the provider first: the combined provider holds the SQLite files open
|
||||
# (WAL) and caches state in memory, so an out-of-band file move without a restart
|
||||
# would be shadowed. Stop -> move -> restart lets it recreate empty schema
|
||||
# (CREATE TABLE IF NOT EXISTS on open).
|
||||
|
||||
PORT=8392
|
||||
BACKUP_DIR="db-reset-backup"
|
||||
|
||||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
cd "$ROOT" || { echo "reset: cannot cd to repo root $ROOT" >&2; exit 1; }
|
||||
# shellcheck disable=SC1091
|
||||
source ./env.sh >/dev/null 2>&1 || { echo "reset: failed to source env.sh" >&2; exit 1; }
|
||||
|
||||
AFFECT_DB="${RATATOSKR_AFFECT_DB:-affect.db}"
|
||||
MEMORY_DB="${RATATOSKR_MEMORY_DB:-memory.db}"
|
||||
HARD=0; [ "${1:-}" = "--hard" ] && HARD=1
|
||||
|
||||
echo "== ratatoskr provider-store reset (memory + persona) =="
|
||||
echo " affect: $AFFECT_DB"
|
||||
echo " memory: $MEMORY_DB"
|
||||
|
||||
# 1. stop the combined provider holding the DBs
|
||||
PID="$(ss -ltnp 2>/dev/null | grep ":$PORT" | grep -oE 'pid=[0-9]+' | head -1 | cut -d= -f2)"
|
||||
if [ -n "${PID:-}" ]; then
|
||||
kill -9 "$PID" 2>/dev/null && echo "-- stopped provider :$PORT (pid $PID)"
|
||||
else
|
||||
echo "-- no provider on :$PORT (already down)"
|
||||
fi
|
||||
|
||||
# 2. wipe (optional rolling backup)
|
||||
files=("$AFFECT_DB" "$AFFECT_DB-wal" "$AFFECT_DB-shm" "$MEMORY_DB" "$MEMORY_DB-wal" "$MEMORY_DB-shm")
|
||||
if [ "$HARD" -eq 1 ]; then
|
||||
for f in "${files[@]}"; do [ -e "$f" ] && rm -f "$f" && echo "-- removed $f"; done
|
||||
echo "-- HARD wipe (no backup)"
|
||||
else
|
||||
rm -rf "$BACKUP_DIR"; mkdir -p "$BACKUP_DIR"
|
||||
for f in "${files[@]}"; do [ -e "$f" ] && mv "$f" "$BACKUP_DIR"/ && echo "-- $f -> $BACKUP_DIR/"; done
|
||||
echo "-- rolling backup: $BACKUP_DIR/ (overwritten each run)"
|
||||
fi
|
||||
|
||||
# 3. restart the combined provider (recreates empty schema on open)
|
||||
nohup "$ROOT/.venv/bin/ratatoskr-combined-provider" >/tmp/ratatoskr-combined.log 2>&1 & disown
|
||||
echo "-- restarted combined provider (pid $!)"
|
||||
|
||||
# 4. verify bound + empty
|
||||
curl -s -o /dev/null -w "-- :$PORT -> HTTP %{http_code}\n" --retry 25 --retry-connrefused --retry-delay 1 "http://127.0.0.1:$PORT/"
|
||||
echo "-- affect_snapshots (persona): $(sqlite3 "$AFFECT_DB" 'SELECT COUNT(*) FROM affect_snapshots' 2>&1)"
|
||||
echo "-- memory_chunks (memory): $(sqlite3 "$MEMORY_DB" 'SELECT COUNT(*) FROM memory_chunks' 2>&1)"
|
||||
echo "== done — sindra memory + persona reset =="
|
||||
+380
-16
@@ -7,16 +7,36 @@ from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
import hashlib
|
||||
import os
|
||||
import signal
|
||||
import sys
|
||||
from dataclasses import dataclass, field
|
||||
from importlib.metadata import PackageNotFoundError, version
|
||||
from typing import TextIO
|
||||
from typing import Any, TextIO
|
||||
|
||||
import httpx
|
||||
|
||||
from ratatoskr.sessions import AgentNotFound, SessionApiFailed, create_session
|
||||
from ratatoskr.first_message import seed_preset_first_message
|
||||
from ratatoskr.sessions import (
|
||||
AgentNotFound,
|
||||
AuthoredHistoryUnavailable,
|
||||
BifrostBinding,
|
||||
BifrostConsumerKeyMissing,
|
||||
BifrostHandshakeFailed,
|
||||
SessionApiFailed,
|
||||
create_character,
|
||||
create_session,
|
||||
delete_character,
|
||||
endpoint_for_plane,
|
||||
get_capabilities,
|
||||
get_character_state,
|
||||
get_me,
|
||||
get_session_messages,
|
||||
list_character_models,
|
||||
set_persona_state,
|
||||
write_authored_history,
|
||||
)
|
||||
from ratatoskr.sse_client import (
|
||||
AffectUpdate,
|
||||
AwaitingLlmFirstToken,
|
||||
@@ -39,7 +59,7 @@ from ratatoskr.sse_client import (
|
||||
TurnIdFlip,
|
||||
WorkerPhase,
|
||||
cancel_turn,
|
||||
stream_turn,
|
||||
stream_turn_resilient,
|
||||
)
|
||||
|
||||
|
||||
@@ -83,6 +103,27 @@ class ParsedArgs:
|
||||
# Per issue #5: optional `--end-user-id` for per-end-user agents (lofn etc.).
|
||||
# Default None preserves the pre-#5 baseline for agents that don't require it (mimir).
|
||||
end_user_id: str | None = None
|
||||
# Issue #17: optional Bifrost binding (one plane) + its consumer key. None on
|
||||
# the unbound pre-#17 path. `bifrost_plane` is the human label for the
|
||||
# bound-state indicator (None when --bifrost-url supplies the endpoint directly).
|
||||
bifrost: BifrostBinding | None = None
|
||||
bifrost_plane: str | None = None
|
||||
consumer_key: str | None = None
|
||||
# Standalone boot-time orientation probe: GET /me + GET /capabilities, print,
|
||||
# exit. Mutually exclusive with the session/turn flags (opens no session).
|
||||
whoami: bool = False
|
||||
# Optional admin-tier key (RATATOSKR_ADMIN_API_KEY / --admin-key) for the
|
||||
# admin-scoped inspection reads (BifrostState pane, GET /admin/sessions/…).
|
||||
# None when unset — the BifrostState pane then shows "admin key not configured".
|
||||
admin_key: str | None = None
|
||||
# Tier-2 one-shot probes (like --whoami). --characters runs the transient-
|
||||
# character CRUD lifecycle; --set-persona-pad "p,a,d" (with --session) writes
|
||||
# a session's persona state (affect injection).
|
||||
characters: bool = False
|
||||
set_persona_pad: str | None = None
|
||||
# #347 authored-history-write reference-consumer probe: create a fresh
|
||||
# session bound to --agent, seed an authored assistant first-message (seq-0).
|
||||
seed_first_message: str | None = None
|
||||
|
||||
|
||||
class _ArgparseError(Exception):
|
||||
@@ -107,8 +148,20 @@ def _parse_args(argv: list[str] | None) -> ParsedArgs:
|
||||
parser.add_argument("--api-key", dest="api_key")
|
||||
parser.add_argument("--server")
|
||||
parser.add_argument("--raw", action="store_true")
|
||||
parser.add_argument("--whoami", action="store_true")
|
||||
parser.add_argument("--admin-key", dest="admin_key")
|
||||
parser.add_argument("--characters", action="store_true")
|
||||
parser.add_argument("--set-persona-pad", dest="set_persona_pad", default=None)
|
||||
parser.add_argument("--seed-first-message", dest="seed_first_message", default=None)
|
||||
# Issue #5: required for per-end-user agents (lofn etc.); optional otherwise (mimir).
|
||||
parser.add_argument("--end-user-id", dest="end_user_id", default=None)
|
||||
# Issue #17: bind the created session to our own Bifrost provider plane.
|
||||
parser.add_argument(
|
||||
"--bifrost-plane", dest="bifrost_plane", choices=("memory", "affect"),
|
||||
default=None,
|
||||
)
|
||||
parser.add_argument("--bifrost-host", dest="bifrost_host", default=None)
|
||||
parser.add_argument("--bifrost-url", dest="bifrost_url", default=None)
|
||||
try:
|
||||
ns = parser.parse_args(argv)
|
||||
except _ArgparseError as exc:
|
||||
@@ -120,17 +173,57 @@ def _parse_args(argv: list[str] | None) -> ParsedArgs:
|
||||
# Issue #5 INV-001: --end-user-id, if passed, MUST be non-empty (mirrors --send).
|
||||
if ns.end_user_id is not None and not ns.end_user_id:
|
||||
raise UsageError("--end-user-id must be non-empty when passed")
|
||||
if ns.session and ns.new:
|
||||
raise UsageError("--session and --new are mutually exclusive; pass exactly one")
|
||||
if not ns.session and not ns.new:
|
||||
raise UsageError("pass exactly one of --session or --new")
|
||||
if ns.session and ns.agent:
|
||||
raise UsageError("--agent is required with --new and forbidden with --session")
|
||||
if ns.new and not ns.agent and ns.send is not None:
|
||||
# Issue #8: --agent stays required for --send --new (non-interactive,
|
||||
# cannot prompt). Bare --new (TUI mode) accepts None — picker drives
|
||||
# the choice via list_agents in _resolve_then_run.
|
||||
raise UsageError("--agent is required when --new is passed in --send mode")
|
||||
if sum([ns.whoami, ns.characters, bool(ns.set_persona_pad), bool(ns.seed_first_message)]) > 1:
|
||||
raise UsageError(
|
||||
"--whoami / --characters / --set-persona-pad / --seed-first-message "
|
||||
"are mutually exclusive"
|
||||
)
|
||||
if ns.whoami or ns.characters:
|
||||
# Standalone one-shot probes: open no session.
|
||||
if ns.send is not None or ns.session or ns.new or ns.agent:
|
||||
raise UsageError(
|
||||
"--whoami / --characters are standalone probes "
|
||||
"(no --send/--session/--new/--agent)"
|
||||
)
|
||||
elif ns.set_persona_pad is not None:
|
||||
# Session-scoped write probe: needs a target session, nothing else.
|
||||
if not ns.set_persona_pad:
|
||||
raise UsageError("--set-persona-pad must be non-empty (e.g. '0.4,0.1,-0.2')")
|
||||
if not ns.session:
|
||||
raise UsageError("--set-persona-pad requires --session <id>")
|
||||
if ns.send is not None or ns.new or ns.agent:
|
||||
raise UsageError("--set-persona-pad takes only --session")
|
||||
elif ns.seed_first_message is not None:
|
||||
# #347 first-message probe: creates a fresh session bound to --agent,
|
||||
# then seeds an authored assistant turn as seq-0 — manages its own session.
|
||||
if not ns.seed_first_message:
|
||||
raise UsageError("--seed-first-message must be non-empty")
|
||||
if not ns.agent:
|
||||
raise UsageError("--seed-first-message requires --agent <id>")
|
||||
if ns.send is not None or ns.session or ns.new:
|
||||
raise UsageError(
|
||||
"--seed-first-message manages its own session (no --send/--session/--new)"
|
||||
)
|
||||
else:
|
||||
if ns.session and ns.new:
|
||||
raise UsageError("--session and --new are mutually exclusive")
|
||||
if not ns.session and not ns.new:
|
||||
# Bare TUI mode → startup session picker (design-brief §4). --send is
|
||||
# non-interactive (no picker can open), so it still requires one flag;
|
||||
# --agent belongs with --new (bare mode resumes, it doesn't create).
|
||||
if ns.send is not None:
|
||||
raise UsageError("--send requires --session or --new (no interactive picker)")
|
||||
if ns.agent:
|
||||
raise UsageError(
|
||||
"--agent belongs with --new; bare TUI mode opens the session picker"
|
||||
)
|
||||
if ns.session and ns.agent:
|
||||
raise UsageError("--agent is required with --new and forbidden with --session")
|
||||
if ns.new and not ns.agent and ns.send is not None:
|
||||
# Issue #8: --agent stays required for --send --new (non-interactive,
|
||||
# cannot prompt). Bare --new (TUI mode) accepts None — picker drives
|
||||
# the choice via list_agents in _resolve_then_run.
|
||||
raise UsageError("--agent is required when --new is passed in --send mode")
|
||||
|
||||
api_key = ns.api_key or os.environ.get("WORLDTREE_API_KEY") or ""
|
||||
if not api_key:
|
||||
@@ -143,6 +236,33 @@ def _parse_args(argv: list[str] | None) -> ParsedArgs:
|
||||
# gets a stable partition without papering over the explicit-flag override.
|
||||
end_user_id = ns.end_user_id or os.environ.get("RATATOSKR_END_USER_ID") or None
|
||||
|
||||
# Issue #17: resolve the optional Bifrost binding. --bifrost-url (direct,
|
||||
# HTTPS/prod) and --bifrost-plane (dev shortcut → endpoint_for_plane) are
|
||||
# mutually exclusive; a binding is a session-CREATE concern (forbidden with
|
||||
# --session). The consumer key — the privileged handshake identity, distinct
|
||||
# from the canary key — comes from the env (never a CLI flag).
|
||||
bifrost: BifrostBinding | None = None
|
||||
bifrost_plane: str | None = None
|
||||
if ns.bifrost_url and ns.bifrost_plane:
|
||||
raise UsageError("--bifrost-url and --bifrost-plane are mutually exclusive")
|
||||
if (ns.bifrost_url or ns.bifrost_plane) and not ns.new:
|
||||
raise UsageError("a bifrost binding requires --new (it binds at session create)")
|
||||
if ns.bifrost_url:
|
||||
bifrost = BifrostBinding(endpoint_url=ns.bifrost_url)
|
||||
elif ns.bifrost_plane:
|
||||
host = ns.bifrost_host or os.environ.get("RATATOSKR_PROVIDER_VISIBLE_HOST")
|
||||
if not host:
|
||||
raise UsageError(
|
||||
"--bifrost-plane requires --bifrost-host "
|
||||
"(or RATATOSKR_PROVIDER_VISIBLE_HOST) — the Worldtree-visible provider host"
|
||||
)
|
||||
bifrost = BifrostBinding(endpoint_url=endpoint_for_plane(ns.bifrost_plane, host))
|
||||
bifrost_plane = ns.bifrost_plane
|
||||
consumer_key = os.environ.get("RATATOSKR_BIFROST_CONSUMER_KEY") or None
|
||||
# Admin-tier key for the admin-scoped inspection reads (BifrostState pane).
|
||||
# Flag > env > None; None leaves the admin panes showing "not configured".
|
||||
admin_key = ns.admin_key or os.environ.get("RATATOSKR_ADMIN_API_KEY") or None
|
||||
|
||||
return ParsedArgs(
|
||||
send_content=ns.send,
|
||||
session_id=ns.session,
|
||||
@@ -152,6 +272,14 @@ def _parse_args(argv: list[str] | None) -> ParsedArgs:
|
||||
server_url=server_url,
|
||||
raw=ns.raw,
|
||||
end_user_id=end_user_id,
|
||||
bifrost=bifrost,
|
||||
bifrost_plane=bifrost_plane,
|
||||
consumer_key=consumer_key,
|
||||
whoami=ns.whoami,
|
||||
admin_key=admin_key,
|
||||
characters=ns.characters,
|
||||
set_persona_pad=ns.set_persona_pad,
|
||||
seed_first_message=ns.seed_first_message,
|
||||
)
|
||||
|
||||
|
||||
@@ -345,7 +473,7 @@ async def _run_turn(
|
||||
cancelling = False
|
||||
sigint_task: asyncio.Task[bool] | None = None
|
||||
cancel_task: asyncio.Task[None] | None = None # strong ref to fire-and-forget cancel
|
||||
aiter_obj = stream_turn(client, session_id, content).__aiter__()
|
||||
aiter_obj = stream_turn_resilient(client, session_id, content).__aiter__()
|
||||
|
||||
try:
|
||||
while True:
|
||||
@@ -432,11 +560,34 @@ async def _amain(args: ParsedArgs) -> int:
|
||||
assert args.agent_id is not None
|
||||
try:
|
||||
info = await create_session(
|
||||
client, args.agent_id, end_user_id=args.end_user_id
|
||||
client,
|
||||
args.agent_id,
|
||||
end_user_id=args.end_user_id,
|
||||
bifrost=args.bifrost,
|
||||
consumer_key=args.consumer_key,
|
||||
)
|
||||
except AgentNotFound as exc:
|
||||
sys.stderr.write(f"[agent_not_found] agent_id={exc.agent_id}\n")
|
||||
return 12
|
||||
except BifrostConsumerKeyMissing as exc:
|
||||
# INV-001: never fall back to the canary key — fail loud.
|
||||
sys.stderr.write(
|
||||
f"[bifrost_consumer_key_missing] {exc} "
|
||||
f"(set RATATOSKR_BIFROST_CONSUMER_KEY)\n"
|
||||
)
|
||||
return 22
|
||||
except BifrostHandshakeFailed as exc:
|
||||
# INV-002: bind-time handshake failure fails session creation.
|
||||
sys.stderr.write(
|
||||
f"[bifrost_handshake_failed] bifrost_error={exc.bifrost_error}\n"
|
||||
)
|
||||
# 401-message scoping: keyed on auth_rejected, name the key mismatch.
|
||||
if exc.bifrost_error == "bifrost.auth_rejected":
|
||||
sys.stderr.write(
|
||||
" bound create requires the consumer key "
|
||||
"(RATATOSKR_BIFROST_CONSUMER_KEY), not WORLDTREE_API_KEY\n"
|
||||
)
|
||||
return 23
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(f"[session_api_failed] status={exc.status} body={exc.body!r}\n")
|
||||
return 20
|
||||
@@ -448,6 +599,19 @@ async def _amain(args: ParsedArgs) -> int:
|
||||
sys.stderr.write(
|
||||
f". create_session: session_id={info.session_id} agent_id={info.agent_id}\n"
|
||||
)
|
||||
# #347 authored first-message: seed the agent's preset opening (best-effort).
|
||||
if await seed_preset_first_message(client, info.session_id, args.agent_id):
|
||||
sys.stderr.write(
|
||||
f". first_message: seeded preset opening for {info.agent_id}\n"
|
||||
)
|
||||
# Issue #17 bound-state indicator: plane + endpoint + status, so the
|
||||
# operator sees WHICH identity/endpoint bound (not a bare boolean).
|
||||
if args.bifrost is not None:
|
||||
plane = args.bifrost_plane or "direct"
|
||||
sys.stderr.write(
|
||||
f". bifrost: status=bound plane={plane} "
|
||||
f"endpoint={args.bifrost.endpoint_url}\n"
|
||||
)
|
||||
session_id = info.session_id
|
||||
else:
|
||||
assert args.session_id is not None
|
||||
@@ -471,6 +635,198 @@ async def _amain(args: ParsedArgs) -> int:
|
||||
loop.remove_signal_handler(signal.SIGINT)
|
||||
|
||||
|
||||
def _format_whoami(me: dict[str, Any], caps: dict[str, Any]) -> str:
|
||||
"""Render the --whoami report: identity (GET /me) + server capabilities."""
|
||||
lines = ["identity:"]
|
||||
lines.append(f" user_id: {me.get('user_id', '?')}")
|
||||
lines.append(f" tier: {me.get('tier', '?')}")
|
||||
lines.append(f" scopes: {', '.join(me.get('scopes', [])) or '(none)'}")
|
||||
for k in ("display_name", "key_id", "key_label"):
|
||||
if k in me:
|
||||
lines.append(f" {k}: {me[k]}")
|
||||
lines.append("capabilities:")
|
||||
templates = caps.get("ephemeral_templates", {})
|
||||
if templates:
|
||||
for name, spec in templates.items():
|
||||
models = ", ".join(spec.get("allowed_models", []))
|
||||
lines.append(
|
||||
f" ephemeral_template {name}: default={spec.get('default_model', '?')} "
|
||||
f"max_bytes={spec.get('system_prompt_max_bytes', '?')} models=[{models}]"
|
||||
)
|
||||
else:
|
||||
lines.append(" (no ephemeral templates advertised)")
|
||||
return "\n".join(lines) + "\n"
|
||||
|
||||
|
||||
async def _whoami(args: ParsedArgs) -> int:
|
||||
"""--whoami one-shot: GET /me + GET /capabilities, print a compact report, exit.
|
||||
|
||||
A boot-time orientation probe (mirrors --send's non-interactive shape):
|
||||
"who am I against this server, and what does it offer." Opens no session.
|
||||
Errors land on stderr with the same [session_api_failed] / [network_error]
|
||||
vocab + exit codes as the other modes.
|
||||
"""
|
||||
assert isinstance(args, ParsedArgs)
|
||||
async with httpx.AsyncClient(
|
||||
base_url=args.server_url,
|
||||
headers={"Authorization": f"Bearer {args.api_key}", "User-Agent": USER_AGENT},
|
||||
timeout=httpx.Timeout(connect=10.0, read=10.0, write=10.0, pool=10.0),
|
||||
) as client:
|
||||
try:
|
||||
me = await get_me(client)
|
||||
caps = await get_capabilities(client)
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(f"[session_api_failed] status={exc.status} body={exc.body!r}\n")
|
||||
return 20
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
sys.stdout.write(_format_whoami(me, caps))
|
||||
return 0
|
||||
|
||||
|
||||
def _probe_client(args: ParsedArgs) -> httpx.AsyncClient:
|
||||
"""AsyncClient for the one-shot probes (--whoami / --characters / --set-persona-pad)."""
|
||||
return httpx.AsyncClient(
|
||||
base_url=args.server_url,
|
||||
headers={"Authorization": f"Bearer {args.api_key}", "User-Agent": USER_AGENT},
|
||||
timeout=httpx.Timeout(connect=10.0, read=10.0, write=10.0, pool=10.0),
|
||||
)
|
||||
|
||||
|
||||
async def _characters_probe(args: ParsedArgs) -> int:
|
||||
"""--characters one-shot: exercise the transient-character CRUD lifecycle
|
||||
(models → create → get-state → delete), print a report, exit. A reference-
|
||||
consumer smoke of the #161 character surface (needs character.read/write)."""
|
||||
assert isinstance(args, ParsedArgs)
|
||||
async with _probe_client(args) as client:
|
||||
try:
|
||||
models = await list_character_models(client)
|
||||
names = ", ".join(m.get("name", "?") for m in models.get("items", []))
|
||||
sys.stdout.write(f"character models: {names or '(none)'}\n")
|
||||
created = await create_character(
|
||||
client,
|
||||
{
|
||||
"schema_version": "1",
|
||||
"name": "ratatoskr-probe",
|
||||
"ocean": {
|
||||
"openness": 0.5, "conscientiousness": 0.5, "extraversion": 0.0,
|
||||
"agreeableness": 0.5, "neuroticism": 0.5,
|
||||
},
|
||||
"description": "ratatoskr --characters lifecycle probe",
|
||||
"narrative": "A throwaway probe character.",
|
||||
"voice_profile_block": "plain",
|
||||
},
|
||||
)
|
||||
cid = created["character_id"]
|
||||
sys.stdout.write(f"created: {cid} (ttl {created.get('ttl_expires_at')})\n")
|
||||
state = await get_character_state(client, cid)
|
||||
sys.stdout.write(f"state: pad={state.get('pad')}\n")
|
||||
await delete_character(client, cid)
|
||||
sys.stdout.write(f"deleted: {cid}\n")
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(f"[session_api_failed] status={exc.status} body={exc.body!r}\n")
|
||||
return 20
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
return 0
|
||||
|
||||
|
||||
async def _set_persona_probe(args: ParsedArgs) -> int:
|
||||
"""--set-persona-pad one-shot: POST a PAD to /sessions/{id}/persona_state
|
||||
(affect injection), print the result, exit. Requires --session."""
|
||||
assert isinstance(args, ParsedArgs)
|
||||
assert args.session_id is not None and args.set_persona_pad is not None
|
||||
try:
|
||||
pad = [float(x) for x in args.set_persona_pad.split(",")]
|
||||
except ValueError:
|
||||
sys.stderr.write(
|
||||
"[usage_error] --set-persona-pad must be comma-separated floats "
|
||||
"(e.g. '0.4,0.1,-0.2')\n"
|
||||
)
|
||||
return 10
|
||||
if len(pad) != 3:
|
||||
sys.stderr.write(
|
||||
"[usage_error] --set-persona-pad needs exactly 3 floats "
|
||||
"(pleasure,arousal,dominance), e.g. '0.4,0.1,-0.2'\n"
|
||||
)
|
||||
return 10
|
||||
# Canonical POST /sessions/{id}/persona_state body (#317): a named-key dict,
|
||||
# NOT a bare list — {"pad": {"pleasure", "arousal", "dominance"}}.
|
||||
snapshot = {"pad": {"pleasure": pad[0], "arousal": pad[1], "dominance": pad[2]}}
|
||||
async with _probe_client(args) as client:
|
||||
try:
|
||||
await set_persona_state(client, args.session_id, snapshot)
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(f"[session_api_failed] status={exc.status} body={exc.body!r}\n")
|
||||
return 20
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
sys.stdout.write(
|
||||
f"persona_state set: session={args.session_id[-8:]} pad={pad} (204)\n"
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
async def _seed_first_message_probe(args: ParsedArgs) -> int:
|
||||
"""--seed-first-message one-shot: create a fresh session bound to --agent,
|
||||
write an authored assistant first-message (#347 POST /sessions/{id}/history),
|
||||
read it back via GET /messages, print a report, exit. A reference-consumer
|
||||
smoke of the authored-history-write primitive.
|
||||
|
||||
Hide-existence: a 404 (feature-absent OR the key lacks `session.history.write`)
|
||||
is reported as a benign 'feature-absent' result (exit 0) — the probe NEVER
|
||||
capability-probes to distinguish the causes (server INV-347-1). The probe
|
||||
seeds but does not generate, so the assistant-first provider constraint is
|
||||
inert here.
|
||||
"""
|
||||
assert isinstance(args, ParsedArgs)
|
||||
assert args.agent_id is not None and args.seed_first_message is not None
|
||||
async with _probe_client(args) as client:
|
||||
try:
|
||||
session = await create_session(
|
||||
client, args.agent_id, end_user_id=args.end_user_id
|
||||
)
|
||||
sys.stdout.write(f"session: {session.session_id} (agent {session.agent_id})\n")
|
||||
key = "ratatoskr-first-message-" + hashlib.sha256(
|
||||
args.seed_first_message.encode("utf-8")
|
||||
).hexdigest()[:12]
|
||||
try:
|
||||
ack = await write_authored_history(
|
||||
client,
|
||||
session.session_id,
|
||||
content=args.seed_first_message,
|
||||
idempotency_key=key,
|
||||
)
|
||||
except AuthoredHistoryUnavailable:
|
||||
sys.stdout.write(
|
||||
"authored-history: feature-absent or ungranted (404 hide-existence) "
|
||||
"— a production consumer falls back to a model-generated greeting; "
|
||||
"no capability-probe attempted.\n"
|
||||
)
|
||||
return 0
|
||||
sys.stdout.write(
|
||||
f"seeded: seq={ack.get('seq')} phase={ack.get('phase')} "
|
||||
f"turn_id={ack.get('turn_id')} content_chars={ack.get('content_chars')}\n"
|
||||
)
|
||||
history = await get_session_messages(client, session.session_id)
|
||||
items = history.get("items", [])
|
||||
sys.stdout.write(f"read-back: {len(items)} message(s)\n")
|
||||
for m in items:
|
||||
sys.stdout.write(
|
||||
f" seq={m.get('seq')} role={m.get('role')} content={m.get('content')!r}\n"
|
||||
)
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(f"[session_api_failed] status={exc.status} body={exc.body!r}\n")
|
||||
return 20
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
return 0
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
"""Sync entry point. Maps UsageError/_AuthError to exit codes BEFORE the event loop."""
|
||||
assert argv is None or all(isinstance(a, str) for a in argv)
|
||||
@@ -486,6 +842,14 @@ def main(argv: list[str] | None = None) -> int:
|
||||
# argparse's --help / --version short-circuit via SystemExit(0). Pass the code
|
||||
# through verbatim — argparse already printed help to stdout.
|
||||
return int(exc.code) if exc.code is not None else 0
|
||||
if args.whoami:
|
||||
return asyncio.run(_whoami(args))
|
||||
if args.characters:
|
||||
return asyncio.run(_characters_probe(args))
|
||||
if args.set_persona_pad is not None:
|
||||
return asyncio.run(_set_persona_probe(args))
|
||||
if args.seed_first_message is not None:
|
||||
return asyncio.run(_seed_first_message_probe(args))
|
||||
if args.send_content is None:
|
||||
# TUI mode — lazy import preserves INV-001 (no textual in cli at module scope).
|
||||
from ratatoskr.tui import run_tui
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
"""Per-agent authored first-message presets (Worldtree #347 consumer feature).
|
||||
|
||||
When a new session is created for an agent that has a preset opening, seed it as
|
||||
a #347 authored first-message (``POST /sessions/{id}/history``, author=assistant,
|
||||
seq-0) so the session opens in-character before the user speaks — the durable
|
||||
replacement for a system-prompt "startup" instruction.
|
||||
|
||||
Best-effort by design: an instance without the ``session.history.write`` grant
|
||||
returns the hide-existence 404, which is swallowed so session creation is never
|
||||
blocked (the session simply opens with no seeded greeting). See
|
||||
``docs/contracts/first_message.contract.md``.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import hashlib
|
||||
|
||||
import httpx
|
||||
|
||||
from ratatoskr.sessions import write_authored_history
|
||||
|
||||
# Cap the best-effort seed write. The CLI/TUI create paths reuse an httpx client
|
||||
# with NO read timeout (it streams SSE turns), so an accepted-but-never-answered
|
||||
# POST /history would otherwise block session creation forever — violating INV-001's
|
||||
# "never block". asyncio.wait_for bounds the seed regardless of the client's timeout.
|
||||
_SEED_TIMEOUT_S = 10.0
|
||||
|
||||
# agent_id -> the authored opening seeded onto new sessions for that agent.
|
||||
# Editing this dict is how an operator tunes an agent's first turn. Keep entries
|
||||
# under the server's authored_content_max_bytes (8192 bytes) budget.
|
||||
FIRST_MESSAGE_PRESETS: dict[str, str] = {
|
||||
"ratatoskr:sindra": "The room materializes in a soft pulse of light. Walls of brushed metal and warm ambient lighting resolve around him as the holodesk completes its cycle. A thin seam of blue runs along the desk’s edge, reflecting the overhead glow. A chair slides into place with a quiet hiss. On the far side of the desk, Sindra is already there: shoulders relaxed, one knee drawn up onto the seat, the hem of an oversized dark-green sweater slipping off her left shoulder. Her gaze is steady, amused, and entirely fixed on him.\n\nShe doesn’t stand. She lets the space breathe for a moment, as if giving him time to understand that he is no longer where he was. Then she speaks.\n\n\"Hi. I’m Sindra. You just made it here, which means we should set this up properly.\"\n\nShe tilts her head slightly, the faintest crooked smile touching her lips.\n\n\"Three settings. Your call. I’ll take them in order.\"\n\n\"Intensity. One is slow and teasing; ten is relentless and unrelenting. Where should I start?\"\n\n\"Mood. Sweetheart, Vixen, Queen, Siren, or Brat. Which version of me do you want in the room with you?\"\n\n\"And willingness. I can be enthusiastic and ready the moment you look at me; I can be hesitant and require coaxing; I can resist and make you earn it; or I can be unwilling, and you’ll have to change my mind. How should I behave when you approach me?\"\n\nSindra lets her fingers trace the edge of the sweater sleeve, casual and unhurried, her eyes not leaving his face.\n\n\"Pick your three. Then we begin.\"",
|
||||
}
|
||||
|
||||
|
||||
def preset_for(agent_id: str) -> str | None:
|
||||
"""Return the authored first-message preset for ``agent_id``, or None if none."""
|
||||
assert agent_id and isinstance(agent_id, str)
|
||||
return FIRST_MESSAGE_PRESETS.get(agent_id)
|
||||
|
||||
|
||||
async def seed_preset_first_message(
|
||||
client: httpx.AsyncClient, session_id: str, agent_id: str
|
||||
) -> str | None:
|
||||
"""Best-effort: seed ``agent_id``'s preset opening as a #347 authored
|
||||
first-message on ``session_id``; return the seeded text, or None.
|
||||
|
||||
Best-effort (INV-001): a no-preset agent, a malformed call, a slow write
|
||||
(bounded by ``_SEED_TIMEOUT_S``), the hide-existence 404, or ANY other
|
||||
exception all resolve to None WITHOUT raising — this MUST NOT block or fail
|
||||
session creation. Only ``asyncio.CancelledError`` propagates (cancellation is
|
||||
not a seed failure). Inputs are soft-guarded (return None), never asserted, so
|
||||
a wiring bug can't crash the create path this is wired into. A no-preset agent
|
||||
issues zero HTTP (INV-002). The per-content idempotency key makes a repeat on
|
||||
the same session an idempotent 200 replay (INV-003).
|
||||
"""
|
||||
# Soft input guards — a bad arg degrades to "no first message", never raises.
|
||||
if not (isinstance(agent_id, str) and agent_id):
|
||||
return None
|
||||
content = FIRST_MESSAGE_PRESETS.get(agent_id)
|
||||
if content is None:
|
||||
return None
|
||||
if client is None or not (isinstance(session_id, str) and session_id):
|
||||
return None
|
||||
key = "ratatoskr-preset-" + hashlib.sha256(content.encode("utf-8")).hexdigest()[:12]
|
||||
try:
|
||||
await asyncio.wait_for(
|
||||
write_authored_history(
|
||||
client, session_id, content=content, idempotency_key=key
|
||||
),
|
||||
timeout=_SEED_TIMEOUT_S,
|
||||
)
|
||||
except asyncio.CancelledError:
|
||||
raise # cancellation is not a seed failure — never swallow it
|
||||
except Exception:
|
||||
return None # any other failure (404/409/422/timeout/unexpected) → no greeting
|
||||
return content
|
||||
@@ -0,0 +1,4 @@
|
||||
"""Tier-3 Bifrost consumer: durable memory.* + affect.* persistence provider.
|
||||
|
||||
Contracts: docs/contracts/bifrost_affect_provider.contract.md (affect plane, v1).
|
||||
"""
|
||||
@@ -0,0 +1,214 @@
|
||||
"""SQLite-backed, conduit-opaque affect store (Bifrost affect plane, v1).
|
||||
|
||||
Contract: docs/contracts/bifrost_affect_provider.contract.md
|
||||
|
||||
The store persists Worldtree's Tier-3 affect snapshots verbatim and round-trips
|
||||
them. It runs NO affect logic: it reads only the two addressing keys
|
||||
(`agent_id`, `end_user_id`) and treats `pad`/`valence`/`persona_baselines`/
|
||||
`emitted_at` as an opaque blob (INV-001). Idempotency is replay-or-conflict,
|
||||
keyed by (actor-from-ctx, idempotency_key) (INV-008), and snapshots are
|
||||
last-write-wins by arrival across distinct keys (INV-002).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
import json
|
||||
import sqlite3
|
||||
import time
|
||||
from typing import Any
|
||||
|
||||
from bifrost.affect import AffectIdempotencyConflict, AffectInvalidArguments
|
||||
from bifrost.consumer import ConsumerRegistration, build_affect_app
|
||||
from bifrost.reference_server import JwtVerifier
|
||||
from starlette.requests import Request
|
||||
from starlette.responses import JSONResponse
|
||||
|
||||
_SHORT_RETRY_TTL_SECONDS = 300
|
||||
|
||||
|
||||
def _ctx_actor(ctx: Any) -> str:
|
||||
"""Mirror bifrost reference `_ctx_actor`: idempotency actor = JWT `sub`.
|
||||
|
||||
The real DispatchContext exposes the `sub` claim as `session_id`; test
|
||||
contexts set `jwt_sub`. (INV-006: the actor comes from ctx, never the
|
||||
snapshot.)
|
||||
"""
|
||||
return str(getattr(ctx, "jwt_sub", None) or getattr(ctx, "session_id", ""))
|
||||
|
||||
|
||||
class RatatoskrAffectStore:
|
||||
"""The affect `MemoryDataStore`-shaped store handed to `build_affect_app`."""
|
||||
|
||||
affect_supported = True
|
||||
|
||||
def __init__(self, conn: sqlite3.Connection):
|
||||
self._conn = conn
|
||||
|
||||
async def emit(
|
||||
self,
|
||||
snapshot: dict,
|
||||
*,
|
||||
idempotency_key: str,
|
||||
ctx: Any,
|
||||
idempotency_class: str | None = None,
|
||||
) -> dict:
|
||||
del idempotency_class # reserved; affect.* uses a single short-retry class
|
||||
|
||||
# INV-001: read ONLY the two addressing keys; everything else is opaque.
|
||||
agent_id = snapshot.get("agent_id")
|
||||
end_user_id = snapshot.get("end_user_id")
|
||||
if not (
|
||||
isinstance(agent_id, str)
|
||||
and agent_id
|
||||
and isinstance(end_user_id, str)
|
||||
and end_user_id
|
||||
):
|
||||
raise AffectInvalidArguments("snapshot missing agent_id / end_user_id")
|
||||
if not (isinstance(idempotency_key, str) and idempotency_key):
|
||||
raise AffectInvalidArguments("idempotency_key required")
|
||||
|
||||
# Whole-blob serialize + hash is opacity-safe (not a field read).
|
||||
blob = json.dumps(snapshot, sort_keys=True, separators=(",", ":"))
|
||||
digest = hashlib.sha256(blob.encode()).hexdigest()
|
||||
idempotency_id = f"affect.emit|{_ctx_actor(ctx)}|{idempotency_key}"
|
||||
|
||||
# INV-008: replay (same digest) -> no-op; reuse with different digest -> conflict.
|
||||
cached = self._conn.execute(
|
||||
"SELECT digest FROM affect_idempotency WHERE idempotency_id = ?",
|
||||
(idempotency_id,),
|
||||
).fetchone()
|
||||
if cached is not None:
|
||||
if cached[0] == digest:
|
||||
return {"stored": True}
|
||||
raise AffectIdempotencyConflict(
|
||||
"idempotency key reused with different payload"
|
||||
)
|
||||
|
||||
# INV-002 + INV-007: LWW snapshot upsert + idempotency record, one transaction.
|
||||
now = time.time()
|
||||
with self._conn:
|
||||
self._conn.execute(
|
||||
"INSERT INTO affect_snapshots (agent_id, end_user_id, snapshot_json, arrived_at) "
|
||||
"VALUES (?, ?, ?, ?) "
|
||||
"ON CONFLICT(agent_id, end_user_id) DO UPDATE SET "
|
||||
"snapshot_json = excluded.snapshot_json, arrived_at = excluded.arrived_at",
|
||||
(agent_id, end_user_id, blob, str(now)),
|
||||
)
|
||||
self._conn.execute(
|
||||
"INSERT INTO affect_idempotency (idempotency_id, digest, expires_at) "
|
||||
"VALUES (?, ?, ?)",
|
||||
(idempotency_id, digest, now + _SHORT_RETRY_TTL_SECONDS),
|
||||
)
|
||||
return {"stored": True}
|
||||
|
||||
def get(self, agent_id: str, end_user_id: str) -> dict | None:
|
||||
"""Sync read-back seam returning the verbatim stored snapshot (or None).
|
||||
|
||||
The async wire verb `fetch` wraps this; tests, the D2 read route, and
|
||||
rehydrate-seed also call it directly.
|
||||
"""
|
||||
row = self._conn.execute(
|
||||
"SELECT snapshot_json FROM affect_snapshots WHERE agent_id = ? AND end_user_id = ?",
|
||||
(agent_id, end_user_id),
|
||||
).fetchone()
|
||||
return json.loads(row[0]) if row is not None else None
|
||||
|
||||
async def fetch(self, agent_id: str, end_user_id: str) -> dict:
|
||||
"""Async affect.fetch handler — return the stored snapshot in bifrost's
|
||||
{found, snapshot} shape, conduit-opaque.
|
||||
|
||||
INV-010 (strong-or-absent): bifrost >=0.10.0 gates EVERY affect op on the
|
||||
store advertising affect_supported + emit + fetch (`_supports_affect_plane`),
|
||||
so this method MUST exist for the affect capability to dispatch at all —
|
||||
an emit-only store 400s. Mirrors the reference InMemoryAffectStore.fetch;
|
||||
returns the whole blob opaque (INV-001 — never reads pad/valence).
|
||||
"""
|
||||
if not (
|
||||
isinstance(agent_id, str)
|
||||
and agent_id
|
||||
and isinstance(end_user_id, str)
|
||||
and end_user_id
|
||||
):
|
||||
raise AffectInvalidArguments("fetch missing agent_id / end_user_id")
|
||||
snap = self.get(agent_id, end_user_id)
|
||||
if snap is None:
|
||||
return {"found": False}
|
||||
return {"found": True, "snapshot": snap}
|
||||
|
||||
|
||||
def open_affect_store(db_path: str) -> RatatoskrAffectStore:
|
||||
"""Open the SQLite-backed affect store, creating the schema on first use."""
|
||||
# check_same_thread=False: the affect provider is an ASGI app; Starlette/uvicorn
|
||||
# may run a handler off the connection's creating thread (and TestClient always
|
||||
# does). Access stays serialized by the event loop, so this is safe.
|
||||
conn = sqlite3.connect(db_path, check_same_thread=False)
|
||||
# INV-006: state busy_timeout explicitly rather than lean on sqlite3's timeout=5.0
|
||||
# default — a contended write WAITS up to 5s instead of failing SQLITE_BUSY at once
|
||||
# (prep for the composite/standalone two-process topology).
|
||||
conn.execute("PRAGMA busy_timeout=5000")
|
||||
if db_path != ":memory:":
|
||||
conn.execute("PRAGMA journal_mode=WAL")
|
||||
conn.execute(
|
||||
"CREATE TABLE IF NOT EXISTS affect_snapshots ("
|
||||
"agent_id TEXT NOT NULL, end_user_id TEXT NOT NULL, "
|
||||
"snapshot_json TEXT NOT NULL, arrived_at TEXT, "
|
||||
"PRIMARY KEY (agent_id, end_user_id))"
|
||||
)
|
||||
conn.execute(
|
||||
"CREATE TABLE IF NOT EXISTS affect_idempotency ("
|
||||
"idempotency_id TEXT PRIMARY KEY, digest TEXT NOT NULL, expires_at REAL)"
|
||||
)
|
||||
conn.commit()
|
||||
return RatatoskrAffectStore(conn)
|
||||
|
||||
|
||||
def add_affect_read_route(app, store: RatatoskrAffectStore) -> None:
|
||||
"""Mount the non-bifrost PAD read route GET /affect/state/{agent_id} on `app`,
|
||||
reading store.get. SHARED by build_affect_provider_app and the combined provider
|
||||
(#18 INV-011 / D2 INV-007) — add_route (NOT Mount) keeps /bifrost/* top-level so
|
||||
the op-feed path check still matches them and passes this route through untouched.
|
||||
No JWT (internal-LAN trust model).
|
||||
"""
|
||||
async def _affect_state_route(request: Request) -> JSONResponse:
|
||||
agent_id = request.path_params["agent_id"]
|
||||
end_user_id = request.query_params.get("end_user_id")
|
||||
if not end_user_id: # PRE-001: never look up against a None/empty partition
|
||||
return JSONResponse({"error_code": "missing_end_user_id"}, status_code=400)
|
||||
snap = store.get(agent_id, end_user_id)
|
||||
if snap is None: # INV-003: explicit no-data, never a fabricated zeroed PAD
|
||||
return JSONResponse(
|
||||
{
|
||||
"error_code": "no_affect_snapshot",
|
||||
"agent_id": agent_id,
|
||||
"end_user_id": end_user_id,
|
||||
},
|
||||
status_code=404,
|
||||
)
|
||||
return JSONResponse(snap)
|
||||
|
||||
app.add_route("/affect/state/{agent_id}", _affect_state_route, methods=["GET"])
|
||||
|
||||
|
||||
def build_affect_provider_app(
|
||||
store: RatatoskrAffectStore,
|
||||
heimdall_key: bytes,
|
||||
consumer_id: str = "ratatoskr",
|
||||
):
|
||||
"""Wire the JWT verifier + registration and hand the store to bifrost.
|
||||
|
||||
Returns a Starlette ASGI app exposing POST /bifrost/handshake and
|
||||
POST /bifrost/affect-call. The library owns the wire; this is the thin glue.
|
||||
"""
|
||||
if getattr(store, "affect_supported", False) is not True: # INV-005
|
||||
raise ValueError("store must advertise affect_supported=True")
|
||||
if not (isinstance(heimdall_key, bytes) and heimdall_key):
|
||||
raise ValueError("heimdall_key must be non-empty bytes")
|
||||
verifier = JwtVerifier(algorithm="HS256", key_bytes=heimdall_key)
|
||||
registration = ConsumerRegistration(consumer_id=consumer_id)
|
||||
app = build_affect_app(store=store, verifier=verifier, registration=registration)
|
||||
|
||||
# Issue #18 (Deliverable 2): mount the non-bifrost PAD read route. Extracted into
|
||||
# add_affect_read_route so the combined provider mounts the SAME one (Deliverable 1,
|
||||
# INV-011) over the same affect.db.
|
||||
add_affect_read_route(app, store)
|
||||
return app
|
||||
@@ -0,0 +1,50 @@
|
||||
"""Combined Bifrost provider (issue #18 Deliverable 1): ONE ASGI app fronting BOTH
|
||||
the memory.* and affect.* planes, so a single bound Worldtree session both remembers
|
||||
AND shows live PAD.
|
||||
|
||||
Contract: docs/contracts/issues/18.contract.md (§ Deliverable 1)
|
||||
|
||||
Wraps `bifrost.consumer.build_combined_app` (bifrost >=0.10.0) over our real
|
||||
SQLite-backed stores and mounts the SAME non-bifrost affect read route as the
|
||||
standalone affect provider (the shared `add_affect_read_route` helper, INV-011). The
|
||||
composite advertises both caps by store PRESENCE at the handshake; per-plane failure
|
||||
isolation is bifrost's per-route call-time dispatch isolation (INV-013). It is
|
||||
ADDITIVE — the standalone :8390/:8391 apps are unchanged (INV-014).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from bifrost.consumer import ConsumerRegistration, build_combined_app
|
||||
from bifrost.reference_server import JwtVerifier
|
||||
|
||||
from ratatoskr.provider.affect_store import RatatoskrAffectStore, add_affect_read_route
|
||||
from ratatoskr.provider.memory_store import RatatoskrMemoryStore, add_memory_read_route
|
||||
|
||||
|
||||
def build_combined_provider_app(
|
||||
memory_store: RatatoskrMemoryStore,
|
||||
affect_store: RatatoskrAffectStore,
|
||||
heimdall_key: bytes,
|
||||
consumer_id: str = "ratatoskr",
|
||||
):
|
||||
"""Compose `build_combined_app` over BOTH stores + mount the shared affect read
|
||||
route AND the memory-viewer debug read route. Returns a Starlette app exposing POST
|
||||
/bifrost/handshake + /bifrost/memory-call + /bifrost/affect-call + GET
|
||||
/affect/state/{agent_id} + GET /memory/chunks.
|
||||
|
||||
Both stores are REQUIRED (INV-009): bifrost's build_combined_app raises if either
|
||||
is None. The affect cap depends on the affect store advertising affect_supported +
|
||||
emit + fetch (strong-or-absent, INV-010) — guarded here at build time so a
|
||||
misconfigured store fails fast rather than silently withholding the cap.
|
||||
"""
|
||||
if getattr(affect_store, "affect_supported", False) is not True: # PRE-001 / INV-010
|
||||
raise ValueError("affect_store must advertise affect_supported=True")
|
||||
if not (isinstance(heimdall_key, bytes) and heimdall_key): # PRE-002
|
||||
raise ValueError("heimdall_key must be non-empty bytes")
|
||||
verifier = JwtVerifier(algorithm="HS256", key_bytes=heimdall_key)
|
||||
registration = ConsumerRegistration(consumer_id=consumer_id)
|
||||
# build_combined_app validates memory_store/affect_store presence (INV-009, raises
|
||||
# ValueError on None) and mounts handshake + memory-call + affect-call (no tool-call).
|
||||
app = build_combined_app(memory_store, affect_store, verifier, registration)
|
||||
add_affect_read_route(app, affect_store) # INV-011: the SAME read route, same db
|
||||
add_memory_read_route(app, memory_store) # DEBUG read: GET /memory/chunks (memory viewer)
|
||||
return app
|
||||
@@ -0,0 +1,571 @@
|
||||
"""SQLite + sqlite-vec durable memory store (Bifrost memory plane, v1 basic plane).
|
||||
|
||||
Contract: docs/contracts/bifrost_memory_provider.contract.md
|
||||
|
||||
Worldtree writes Tier-3 agent memory chunks here (`upsert_many`) and recalls them
|
||||
by vector similarity (`search`), with point reads (`get`/`get_many`) and deletes
|
||||
(`delete_many`). We persist each chunk verbatim and read only its structural
|
||||
surface — embedding (rank), scope (isolation), id + revision (optimistic lock),
|
||||
origin/injection_source (consistency rule). Semantic content is never interpreted.
|
||||
We implement bifrost's OWN MemoryDataStore Protocol; conformance is #195 parity
|
||||
vs InMemoryMemoryStore.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
import json
|
||||
import logging
|
||||
import sqlite3
|
||||
import sys
|
||||
import time
|
||||
from typing import Any
|
||||
|
||||
import sqlite_vec
|
||||
from bifrost.consumer import ConsumerRegistration, build_memory_app
|
||||
from bifrost.memory import (
|
||||
IdempotencyConflict,
|
||||
InvalidArguments,
|
||||
InvalidFilter,
|
||||
RevisionMismatch,
|
||||
StoreCapabilities,
|
||||
)
|
||||
from bifrost.reference_server import JwtVerifier
|
||||
from starlette.requests import Request
|
||||
from starlette.responses import JSONResponse
|
||||
|
||||
_SHORT_RETRY_TTL_SECONDS = 300
|
||||
_DURABLE_JOB_TTL_SECONDS = 24 * 60 * 60
|
||||
|
||||
# bifrost wire v0.6 scope lattice: three subject axes + agent_self (the #248
|
||||
# agent-identity axis, canonical since #10/v0.5). An axis outside it is InvalidFilter
|
||||
# (-> memory.invalid_filter 400), matching bifrost's reference _validate_scope.
|
||||
_SCOPE_LATTICE = {"end_user", "group", "tenant", "agent_self"}
|
||||
|
||||
# Inbound memory-call observability (#17 observe brick). A self-contained
|
||||
# stdout handler so the lines reliably reach the provider's stdout regardless
|
||||
# of uvicorn's logging config. INFO-level, no propagation to root.
|
||||
_log = logging.getLogger("ratatoskr.provider.memory")
|
||||
if not _log.handlers:
|
||||
_h = logging.StreamHandler(sys.stdout)
|
||||
_h.setFormatter(logging.Formatter("%(asctime)s [memory-provider] %(message)s"))
|
||||
_log.addHandler(_h)
|
||||
_log.setLevel(logging.INFO)
|
||||
_log.propagate = False
|
||||
|
||||
|
||||
def _ctx_actor(ctx: Any) -> str:
|
||||
"""Reference `_ctx_actor`: actor = job_id | jwt_sub | session_id (never the record)."""
|
||||
return str(
|
||||
getattr(ctx, "job_id", None)
|
||||
or getattr(ctx, "jwt_sub", None)
|
||||
or getattr(ctx, "session_id", "")
|
||||
)
|
||||
|
||||
|
||||
def _payload_digest(value: Any) -> str:
|
||||
"""Reference digest: sha256 of canonical JSON (sorted keys, compact, str-coerced)."""
|
||||
blob = json.dumps(value, sort_keys=True, separators=(",", ":"), default=str)
|
||||
return hashlib.sha256(blob.encode("utf-8")).hexdigest()
|
||||
|
||||
|
||||
def _idempotency_ttl_seconds(idempotency_class: str | None) -> int:
|
||||
if idempotency_class == "durable-job":
|
||||
return _DURABLE_JOB_TTL_SECONDS
|
||||
return _SHORT_RETRY_TTL_SECONDS
|
||||
|
||||
|
||||
def _chunk_id(record: dict) -> str:
|
||||
"""Reference `_chunk_id`: first non-empty of id / chunk_id / memory_id."""
|
||||
for key in ("id", "chunk_id", "memory_id"):
|
||||
value = record.get(key)
|
||||
if isinstance(value, str) and value:
|
||||
return value
|
||||
raise InvalidArguments("record missing id")
|
||||
|
||||
|
||||
def _record_vector(record: dict) -> list[float]:
|
||||
"""Reference `_record_vector`: embedding, falling back to vector, else []."""
|
||||
value = record.get("embedding", record.get("vector", []))
|
||||
return [float(v) for v in value] if isinstance(value, list) else []
|
||||
|
||||
|
||||
def _scope_subset(record_scope: dict, filter_dict: dict) -> bool:
|
||||
"""True iff record_scope has EVERY axis of filter_dict (AND). Empty filter = match."""
|
||||
return all(record_scope.get(axis) == value for axis, value in filter_dict.items())
|
||||
|
||||
|
||||
def _matches_scope(record_scope: Any, scope_all: dict, scope_any: list) -> bool:
|
||||
"""INV-005 (wire v0.6, #11): a record passes iff
|
||||
`(scope_all empty OR record ⊇ scope_all) AND (scope_any empty OR it matches ≥1 element)`.
|
||||
scope_any is OR/union over a LIST of conjunctive scope dicts (each AND-matched as a whole),
|
||||
never single axes flattened together (the Worldtree #297 over-broadening foot-gun).
|
||||
Byte-faithful to bifrost reference `reference_server/memory.py:_matches_scope`.
|
||||
"""
|
||||
scope = record_scope if isinstance(record_scope, dict) else {}
|
||||
if not _scope_subset(scope, scope_all):
|
||||
return False
|
||||
if scope_any and not any(_scope_subset(scope, element) for element in scope_any):
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def _validate_scope(scope_all: dict, scope_any: list) -> None:
|
||||
"""STEP 1: scope_all is a flat dict, scope_any a list of flat dicts; every axis in BOTH
|
||||
fields ∈ the v0.6 lattice {end_user, group, tenant, agent_self} (else InvalidFilter),
|
||||
matching the reference `_validate_scope`."""
|
||||
if not isinstance(scope_all, dict):
|
||||
raise InvalidArguments("scope_all must be a flat {axis: value} dict")
|
||||
if not isinstance(scope_any, list) or any(not isinstance(e, dict) for e in scope_any):
|
||||
raise InvalidArguments("scope_any must be a list of {axis: value} dicts")
|
||||
for scope in (scope_all, *scope_any):
|
||||
if any(axis not in _SCOPE_LATTICE for axis in scope):
|
||||
raise InvalidFilter("scope_filter contains unsupported axis")
|
||||
|
||||
|
||||
def _validate_injection(record: dict) -> None:
|
||||
"""INV-007: injected_context requires injection_source; non-injected forbids it."""
|
||||
origin = record.get("origin")
|
||||
injection_source = record.get("injection_source")
|
||||
if origin == "injected_context" and not injection_source:
|
||||
raise InvalidArguments("injected_context record requires injection_source")
|
||||
if injection_source and origin != "injected_context":
|
||||
raise InvalidArguments("injection_source only valid for injected_context origin")
|
||||
|
||||
|
||||
# bifrost handshake_response SortableChunkField requires BOTH name + type
|
||||
# (additionalProperties:false); omitting `type` fails wire-schema validation and
|
||||
# breaks the whole handshake. `type` is advisory-only (the wire never interprets it).
|
||||
_SORTABLE_CHUNK_FIELDS: list[dict] = [{"name": "updated_at", "type": "timestamp"}]
|
||||
_SORTABLE_FIELD_NAMES = frozenset(f["name"] for f in _SORTABLE_CHUNK_FIELDS)
|
||||
|
||||
|
||||
def _is_live(record: dict) -> bool:
|
||||
"""INV-009: a chunk is live unless a lifecycle/governance marker says otherwise.
|
||||
scan returns live-only server-side (person-prime's `lifecycle_state=live` does not
|
||||
ride the scan wire, so this is authoritative — a dead fact can never inject)."""
|
||||
state = record.get("lifecycle_state")
|
||||
if isinstance(state, str) and state and state != "live":
|
||||
return False
|
||||
verbatim = record.get("verbatim")
|
||||
gov = verbatim.get("governance_state") if isinstance(verbatim, dict) else None
|
||||
return gov not in ("superseded", "tombstoned")
|
||||
|
||||
|
||||
def _chunk_content_preview(record: dict) -> str:
|
||||
"""Best-effort human-readable content for the DEBUG memory viewer only. Prefers an
|
||||
explicit text field, then the distillate summary, and last-resorts to a compact JSON
|
||||
of the record MINUS the (large, non-human) embedding — never a fabricated blank, so
|
||||
the viewer shows whatever IS there. Read-only; the store's normal bifrost verbs stay
|
||||
conduit/index-faithful (this is a separate debug read, not an interpretation of the
|
||||
chunk on the recall path)."""
|
||||
for key in ("content", "text", "body", "summary"):
|
||||
value = record.get(key)
|
||||
if isinstance(value, str) and value:
|
||||
return value
|
||||
distillate = record.get("distillate")
|
||||
if isinstance(distillate, str) and distillate:
|
||||
return distillate
|
||||
if isinstance(distillate, dict):
|
||||
for key in ("summary", "text", "content"):
|
||||
value = distillate.get(key)
|
||||
if isinstance(value, str) and value:
|
||||
return value
|
||||
trimmed = {k: v for k, v in record.items() if k not in ("embedding", "vector")}
|
||||
return json.dumps(trimmed, separators=(",", ":"), default=str)
|
||||
|
||||
|
||||
class RatatoskrMemoryStore:
|
||||
"""The MemoryDataStore-shaped store handed to bifrost's build_memory_app."""
|
||||
|
||||
def __init__(self, conn: sqlite3.Connection, embedding_dim: int):
|
||||
self._conn = conn
|
||||
self._dim = embedding_dim
|
||||
|
||||
def describe_store(self) -> dict:
|
||||
# INV-006: advertise ONLY the v1 basic-plane capabilities (advertise-=>-implement).
|
||||
return StoreCapabilities(
|
||||
relational_edges_supported=False,
|
||||
optimistic_locking_supported=True,
|
||||
atomic_supersede_supported=False,
|
||||
transaction_supported=False,
|
||||
filterable_metadata_fields=[],
|
||||
sortable_chunk_fields=list(_SORTABLE_CHUNK_FIELDS), # INV-006: gates scan sort + #349 person-prime
|
||||
).to_dict()
|
||||
|
||||
async def upsert_many(
|
||||
self,
|
||||
records: list[dict],
|
||||
*,
|
||||
idempotency_key: str,
|
||||
ctx: Any,
|
||||
expected_revisions: dict | None = None,
|
||||
idempotency_class: str | None = None,
|
||||
) -> dict:
|
||||
if not (isinstance(idempotency_key, str) and idempotency_key): # PRE-001
|
||||
raise InvalidArguments("idempotency_key required")
|
||||
_log.info(
|
||||
"memory-call upsert_many REQUEST: %d record(s) idempotency_key=%s actor=%s scopes=%s",
|
||||
len(records), idempotency_key, _ctx_actor(ctx),
|
||||
[r.get("scope") for r in records],
|
||||
)
|
||||
# INV-002: idempotency_id = ("default", verb, actor-from-ctx, key); digest over payload.
|
||||
digest = _payload_digest({"records": records, "expected_revisions": expected_revisions})
|
||||
idempotency_id = "|".join(("default", "upsert_many", _ctx_actor(ctx), idempotency_key))
|
||||
cached = self._conn.execute(
|
||||
"SELECT digest FROM memory_idempotency WHERE idempotency_id = ?",
|
||||
(idempotency_id,),
|
||||
).fetchone()
|
||||
if cached is not None:
|
||||
if cached[0] == digest:
|
||||
return {"upserted": len(records), "replayed": True}
|
||||
raise IdempotencyConflict("idempotency key reused with different payload")
|
||||
for record in records: # INV-007 / PRE-002: validate before any write
|
||||
_validate_injection(record)
|
||||
# INV-004: all chunk rows + vec rows + the idempotency record in one transaction;
|
||||
# a RevisionMismatch raised here rolls the whole batch back.
|
||||
with self._conn:
|
||||
if expected_revisions: # INV-003: optimistic lock, checked before any write
|
||||
for record in records:
|
||||
cid = _chunk_id(record)
|
||||
if cid in expected_revisions:
|
||||
row = self._conn.execute(
|
||||
"SELECT revision FROM memory_chunks WHERE chunk_id = ?", (cid,)
|
||||
).fetchone()
|
||||
current = row[0] if row is not None else 0
|
||||
if current != expected_revisions[cid]:
|
||||
raise RevisionMismatch(
|
||||
f"stale expected revision for {cid}: "
|
||||
f"{expected_revisions[cid]} != {current}"
|
||||
)
|
||||
for record in records:
|
||||
chunk_id = _chunk_id(record)
|
||||
# INV-003: first insert -> revision 1; re-upsert -> revision + 1.
|
||||
self._conn.execute(
|
||||
"INSERT INTO memory_chunks "
|
||||
"(chunk_id, record_json, revision, scope_json, origin) "
|
||||
"VALUES (?, ?, 1, ?, ?) "
|
||||
"ON CONFLICT(chunk_id) DO UPDATE SET "
|
||||
"record_json=excluded.record_json, revision=memory_chunks.revision + 1, "
|
||||
"scope_json=excluded.scope_json, origin=excluded.origin",
|
||||
(
|
||||
chunk_id,
|
||||
json.dumps(record),
|
||||
json.dumps(record.get("scope")),
|
||||
record.get("origin"),
|
||||
),
|
||||
)
|
||||
self._conn.execute("DELETE FROM memory_vec WHERE chunk_id = ?", (chunk_id,))
|
||||
self._conn.execute(
|
||||
"INSERT INTO memory_vec(chunk_id, embedding) VALUES (?, ?)",
|
||||
(chunk_id, sqlite_vec.serialize_float32(_record_vector(record))),
|
||||
)
|
||||
self._conn.execute(
|
||||
"INSERT INTO memory_idempotency (idempotency_id, digest, expires_at) "
|
||||
"VALUES (?, ?, ?)",
|
||||
(idempotency_id, digest, time.time() + _idempotency_ttl_seconds(idempotency_class)),
|
||||
)
|
||||
return {"upserted": len(records), "replayed": False}
|
||||
|
||||
async def search(
|
||||
self,
|
||||
vector: list[float],
|
||||
*,
|
||||
top_k: int,
|
||||
scope_all: dict | None = None,
|
||||
scope_any: list | None = None,
|
||||
metadata_filter: dict | None = None,
|
||||
include: dict | None = None,
|
||||
fidelity_target: Any = None,
|
||||
) -> list[dict]:
|
||||
if len(vector) != self._dim: # PRE-001
|
||||
raise InvalidArguments(f"vector length {len(vector)} != embedding_dim {self._dim}")
|
||||
if metadata_filter: # PRE-002: v1 advertises no filterable metadata fields
|
||||
raise InvalidArguments("metadata_filter is unsupported in v1")
|
||||
scope_all = scope_all or {}
|
||||
scope_any = scope_any or []
|
||||
_validate_scope(scope_all, scope_any) # STEP 1 (raises InvalidArguments / InvalidFilter)
|
||||
_log.info(
|
||||
"memory-call search REQUEST: scope_all=%r scope_any=%r top_k=%s vec_dim=%d",
|
||||
scope_all, scope_any, top_k, len(vector),
|
||||
)
|
||||
|
||||
def _emit(rs: list[dict]) -> list[dict]:
|
||||
_log.info(
|
||||
"memory-call search RESPONSE: %d hit(s) %s",
|
||||
len(rs),
|
||||
[
|
||||
{
|
||||
"chunk_id": r["chunk_id"],
|
||||
"score": round(r["score"], 4),
|
||||
"scope": r["chunk"].get("scope"),
|
||||
}
|
||||
for r in rs
|
||||
],
|
||||
)
|
||||
return rs
|
||||
|
||||
if top_k <= 0: # POST-001: at most top_k
|
||||
return _emit([])
|
||||
total = self._conn.execute("SELECT COUNT(*) FROM memory_vec").fetchone()[0]
|
||||
if total == 0:
|
||||
return _emit([])
|
||||
# Over-fetch every candidate ranked by cosine distance, then scope-filter and
|
||||
# take top_k — so top_k counts IN-SCOPE hits (INV-005), not pre-filter hits.
|
||||
rows = self._conn.execute(
|
||||
"SELECT v.chunk_id, v.distance, c.record_json, c.revision "
|
||||
"FROM memory_vec v JOIN memory_chunks c ON c.chunk_id = v.chunk_id "
|
||||
f"WHERE v.embedding MATCH ? AND k = {total} ORDER BY v.distance",
|
||||
(sqlite_vec.serialize_float32([float(x) for x in vector]),),
|
||||
).fetchall()
|
||||
results: list[dict] = []
|
||||
for chunk_id, distance, record_json, revision in rows:
|
||||
record = json.loads(record_json)
|
||||
if not _matches_scope(record.get("scope"), scope_all, scope_any):
|
||||
continue
|
||||
results.append(
|
||||
{
|
||||
"chunk": record,
|
||||
"chunk_id": chunk_id,
|
||||
"score": 1.0 - distance, # vec0 cosine distance -> similarity
|
||||
"recalled_view": record.get("distillate", record),
|
||||
"revision": revision,
|
||||
}
|
||||
)
|
||||
if len(results) >= top_k:
|
||||
break
|
||||
return _emit(results)
|
||||
|
||||
async def get(self, chunk_id: str) -> dict | None:
|
||||
# INV-001: verbatim round-trip + an attached revision key, or None.
|
||||
row = self._conn.execute(
|
||||
"SELECT record_json, revision FROM memory_chunks WHERE chunk_id = ?",
|
||||
(chunk_id,),
|
||||
).fetchone()
|
||||
if row is None:
|
||||
return None
|
||||
record = json.loads(row[0])
|
||||
record["revision"] = row[1]
|
||||
return record
|
||||
|
||||
async def get_many(self, ids: list[str]) -> list[dict]:
|
||||
# List form of get: found records only (absent ids are skipped).
|
||||
found = []
|
||||
for chunk_id in ids:
|
||||
record = await self.get(chunk_id)
|
||||
if record is not None:
|
||||
found.append(record)
|
||||
return found
|
||||
|
||||
async def delete_many(self, ids: list[str]) -> dict:
|
||||
# One transaction: chunk row + its vec row leave together (no orphan vec rows).
|
||||
_log.info("memory-call delete_many REQUEST: ids=%s", ids)
|
||||
deleted = 0
|
||||
with self._conn:
|
||||
for chunk_id in ids:
|
||||
cur = self._conn.execute(
|
||||
"DELETE FROM memory_chunks WHERE chunk_id = ?", (chunk_id,)
|
||||
)
|
||||
if cur.rowcount > 0:
|
||||
deleted += 1
|
||||
self._conn.execute("DELETE FROM memory_vec WHERE chunk_id = ?", (chunk_id,))
|
||||
return {"deleted": deleted}
|
||||
|
||||
async def scan(
|
||||
self,
|
||||
*,
|
||||
scope_all: dict | None = None,
|
||||
scope_any: list | None = None,
|
||||
cursor: str | None = None,
|
||||
limit: int,
|
||||
sort: dict | None = None,
|
||||
lifecycle_state: Any = None,
|
||||
) -> dict:
|
||||
# #349 person-prime: query-LESS, LIVE-only (INV-009), globally-ordered (INV-010) scan.
|
||||
if isinstance(limit, bool) or not isinstance(limit, int) or limit <= 0: # PRE-001
|
||||
raise InvalidArguments("limit must be a positive int")
|
||||
scope_all = scope_all or {}
|
||||
scope_any = scope_any or []
|
||||
_validate_scope(scope_all, scope_any) # PRE-002 (same lattice as search)
|
||||
if sort is not None and not isinstance(sort, dict): # PRE-003: malformed sort => reject, never crash
|
||||
raise InvalidArguments("sort must be an object with field and direction")
|
||||
field = (sort or {}).get("field", "updated_at")
|
||||
direction = (sort or {}).get("direction", "desc")
|
||||
if field not in _SORTABLE_FIELD_NAMES or direction not in ("asc", "desc"): # PRE-003
|
||||
raise InvalidArguments(f"sort.field {field!r} is not globally sortable")
|
||||
_log.info(
|
||||
"memory-call scan REQUEST: scope_all=%r scope_any=%r limit=%s sort=%s",
|
||||
scope_all, scope_any, limit, sort,
|
||||
)
|
||||
# INV-010: global order by the INDEXED sort field, missing-last, chunk_id tiebreak
|
||||
# (field is whitelisted above, so the interpolation is injection-safe).
|
||||
order = "DESC" if direction == "desc" else "ASC"
|
||||
rows = self._conn.execute(
|
||||
"SELECT record_json FROM memory_chunks "
|
||||
f"ORDER BY (json_extract(record_json, '$.{field}') IS NULL), "
|
||||
f"json_extract(record_json, '$.{field}') {order}, chunk_id ASC"
|
||||
).fetchall()
|
||||
skip = 0
|
||||
if cursor is not None:
|
||||
try:
|
||||
skip = int(cursor)
|
||||
except (TypeError, ValueError):
|
||||
raise InvalidArguments("invalid scan cursor")
|
||||
if skip < 0:
|
||||
raise InvalidArguments("invalid scan cursor")
|
||||
records: list[dict] = []
|
||||
matched = 0
|
||||
has_more = False
|
||||
for (record_json,) in rows:
|
||||
record = json.loads(record_json)
|
||||
if not _matches_scope(record.get("scope"), scope_all, scope_any): # INV-005
|
||||
continue
|
||||
if not _is_live(record): # INV-009
|
||||
continue
|
||||
matched += 1
|
||||
if matched <= skip: # cursor is an offset into the GLOBAL order (INV-010)
|
||||
continue
|
||||
if len(records) >= limit: # POST-001: single limit page; one more match => next page exists
|
||||
has_more = True
|
||||
break
|
||||
records.append(record)
|
||||
# Emit a cursor ONLY when a further match exists — so a page that exactly exhausts
|
||||
# the matched set returns cursor=None (no empty trailing page), matching the reference.
|
||||
next_cursor = str(skip + len(records)) if has_more else None
|
||||
_log.info("memory-call scan RESPONSE: %d record(s) next_cursor=%s", len(records), next_cursor)
|
||||
return {"records": records, "cursor": next_cursor}
|
||||
|
||||
def count_chunks(self) -> int:
|
||||
"""DEBUG read seam: total stored chunk rows (unfiltered). Lets the memory
|
||||
viewer distinguish 'store is empty' (total 0 — no upsert ever landed) from
|
||||
'scope mismatch' (total > 0 but 0 matched the queried partition)."""
|
||||
return int(self._conn.execute("SELECT COUNT(*) FROM memory_chunks").fetchone()[0])
|
||||
|
||||
def list_chunks(
|
||||
self, *, agent_id: str | None = None, end_user_id: str | None = None
|
||||
) -> list[dict]:
|
||||
"""DEBUG read (non-bifrost): list stored chunks as a content·scope·origin view
|
||||
for the web memory pane, filtered by the `end_user` (strict) and `agent_self`
|
||||
(lenient) scope axes. bifrost's memory protocol has NO list-all verb, so this is
|
||||
OUR read on OUR store (per the debug-surface-uses-canonical-surface principle:
|
||||
we read only our own store, never a dep's private). Returns [] when nothing
|
||||
matches — an empty list is a valid, visible answer (the 0-chunks state).
|
||||
|
||||
- `end_user_id`: strict — a chunk passes only if `scope.end_user == end_user_id`
|
||||
(the partition boundary; the route requires it, the web proxy supplies it).
|
||||
- `agent_id`: lenient — a chunk is excluded only if it CARRIES an `agent_self`
|
||||
axis that differs; chunks written without one are not hidden (so a chunk
|
||||
scoped `{end_user}`-only stays visible for diagnosis).
|
||||
"""
|
||||
rows = self._conn.execute(
|
||||
"SELECT chunk_id, record_json, revision, scope_json, origin FROM memory_chunks"
|
||||
).fetchall()
|
||||
out: list[dict] = []
|
||||
for chunk_id, record_json, revision, scope_json, origin in rows:
|
||||
scope = json.loads(scope_json) if scope_json else {}
|
||||
if not isinstance(scope, dict):
|
||||
scope = {}
|
||||
if end_user_id is not None and scope.get("end_user") != end_user_id:
|
||||
continue
|
||||
if agent_id is not None:
|
||||
chunk_agent = scope.get("agent_self")
|
||||
if chunk_agent is not None and chunk_agent != agent_id:
|
||||
continue
|
||||
record = json.loads(record_json)
|
||||
out.append(
|
||||
{
|
||||
"chunk_id": chunk_id,
|
||||
"content": _chunk_content_preview(record),
|
||||
"scope": scope,
|
||||
"origin": origin,
|
||||
"revision": revision,
|
||||
}
|
||||
)
|
||||
return out
|
||||
|
||||
|
||||
def open_memory_store(db_path: str, *, embedding_dim: int) -> RatatoskrMemoryStore:
|
||||
"""Open the SQLite+sqlite-vec memory store, creating schema + the vec index on first use."""
|
||||
if not (isinstance(embedding_dim, int) and embedding_dim > 0): # PRE-002
|
||||
raise ValueError("embedding_dim must be a positive int")
|
||||
# check_same_thread=False: the memory provider is an ASGI app; uvicorn/Starlette
|
||||
# (and TestClient always) may run a handler off the connection's creating thread.
|
||||
# The event loop serializes the sync sqlite calls, so this is safe. Mirrors the
|
||||
# affect store (bifrost_affect_provider INV-006); surfaced by a TestClient-driven
|
||||
# memory-call search through the combined provider (#18 D1).
|
||||
conn = sqlite3.connect(db_path, check_same_thread=False)
|
||||
conn.enable_load_extension(True)
|
||||
sqlite_vec.load(conn)
|
||||
conn.enable_load_extension(False)
|
||||
conn.execute("PRAGMA busy_timeout=5000") # wait up to 5s, don't fail SQLITE_BUSY at once
|
||||
if db_path != ":memory:":
|
||||
conn.execute("PRAGMA journal_mode=WAL")
|
||||
conn.execute(
|
||||
"CREATE TABLE IF NOT EXISTS memory_chunks ("
|
||||
"chunk_id TEXT PRIMARY KEY, record_json TEXT NOT NULL, "
|
||||
"revision INTEGER NOT NULL, scope_json TEXT, origin TEXT)"
|
||||
)
|
||||
# INV-010: expression index on the scan sort field (updated_at) so the globally-ordered
|
||||
# person-prime scan stays within its 500ms fail-open budget.
|
||||
conn.execute(
|
||||
"CREATE INDEX IF NOT EXISTS idx_chunks_updated_at "
|
||||
"ON memory_chunks (json_extract(record_json, '$.updated_at'))"
|
||||
)
|
||||
conn.execute(
|
||||
"CREATE TABLE IF NOT EXISTS memory_idempotency ("
|
||||
"idempotency_id TEXT PRIMARY KEY, digest TEXT NOT NULL, expires_at REAL)"
|
||||
)
|
||||
# INV-005 / cosine recall: vec0 index at the fixed PINNED_EMBEDDER_DIM, cosine metric.
|
||||
conn.execute(
|
||||
"CREATE VIRTUAL TABLE IF NOT EXISTS memory_vec USING vec0("
|
||||
f"chunk_id TEXT PRIMARY KEY, embedding float[{embedding_dim}] distance_metric=cosine)"
|
||||
)
|
||||
conn.commit()
|
||||
return RatatoskrMemoryStore(conn, embedding_dim)
|
||||
|
||||
|
||||
def add_memory_read_route(app, store: RatatoskrMemoryStore) -> None:
|
||||
"""Mount the non-bifrost DEBUG read route GET /memory/chunks?agent_id=&end_user_id=
|
||||
on `app`, reading store.list_chunks. SHARED by build_memory_provider_app and the
|
||||
combined provider (mirrors the affect D2 add_affect_read_route). add_route (NOT Mount)
|
||||
keeps /bifrost/* top-level so the op-feed path check still matches them and passes
|
||||
this route through untouched. No JWT (internal-LAN trust model).
|
||||
|
||||
end_user_id is REQUIRED (400 missing_end_user_id) — the partition boundary, supplied
|
||||
server-side by the web proxy, never named by the browser. agent_id is an optional
|
||||
lenient filter. An empty match is a 200 with an empty list (the 0-chunks state is a
|
||||
visible answer, not a 404).
|
||||
"""
|
||||
async def _memory_chunks_route(request: Request) -> JSONResponse:
|
||||
end_user_id = request.query_params.get("end_user_id")
|
||||
if not end_user_id: # never scan against a None/empty partition
|
||||
return JSONResponse({"error_code": "missing_end_user_id"}, status_code=400)
|
||||
agent_id = request.query_params.get("agent_id") or None
|
||||
chunks = store.list_chunks(agent_id=agent_id, end_user_id=end_user_id)
|
||||
return JSONResponse(
|
||||
{"chunks": chunks, "count": len(chunks), "total": store.count_chunks()}
|
||||
)
|
||||
|
||||
app.add_route("/memory/chunks", _memory_chunks_route, methods=["GET"])
|
||||
|
||||
|
||||
def build_memory_provider_app(
|
||||
store: RatatoskrMemoryStore,
|
||||
heimdall_key: bytes,
|
||||
consumer_id: str = "ratatoskr",
|
||||
):
|
||||
"""Wire the JWT verifier + registration and hand the store to bifrost.
|
||||
|
||||
Returns a Starlette ASGI app exposing POST /bifrost/handshake and
|
||||
POST /bifrost/memory-call. The library owns the wire; this is the thin glue.
|
||||
Additionally mounts the non-bifrost GET /memory/chunks DEBUG read route (the
|
||||
memory-viewer pane's read seam), the memory-plane analogue of the affect D2 route.
|
||||
"""
|
||||
if not isinstance(store.describe_store(), dict): # PRE-001 / INV-008
|
||||
raise ValueError("store must advertise capabilities via describe_store()")
|
||||
if not (isinstance(heimdall_key, bytes) and heimdall_key): # PRE-002
|
||||
raise ValueError("heimdall_key must be non-empty bytes")
|
||||
verifier = JwtVerifier(algorithm="HS256", key_bytes=heimdall_key)
|
||||
registration = ConsumerRegistration(consumer_id=consumer_id)
|
||||
app = build_memory_app(store=store, verifier=verifier, registration=registration)
|
||||
add_memory_read_route(app, store) # DEBUG read: GET /memory/chunks (memory viewer)
|
||||
return app
|
||||
@@ -0,0 +1,279 @@
|
||||
"""Dispatch-layer observe feed for the Bifrost provider (issue #17, Observe half).
|
||||
|
||||
`instrument_provider_app` wraps a built provider ASGI app so every inbound
|
||||
bifrost-call emits one structured `OpEvent` — correlated by `session_id` read off
|
||||
the dispatch JWT — WITHOUT touching the store's scope semantics (INV-004). It is
|
||||
the lens that lets ratatoskr, owning BOTH ends of the round-trip, see exactly
|
||||
which memory/affect ops a given turn produced.
|
||||
|
||||
The store-method stdout shim in `memory_store.py` cannot see `session_id` for
|
||||
search/get/delete (bifrost withholds `ctx` from those store methods); this feed
|
||||
sits at the DISPATCH/ASGI layer where the JWT — and thus `session_id` (its `sub`
|
||||
claim) — is always present (INV-005).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import json
|
||||
import sys
|
||||
from dataclasses import asdict, dataclass
|
||||
from datetime import UTC, datetime
|
||||
from typing import Any, Protocol
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class OpEvent:
|
||||
"""One observed bifrost-call at the dispatch layer (scope-only, never content)."""
|
||||
|
||||
ts: str # ISO 8601 UTC, capture time
|
||||
plane: str # "memory" | "affect"
|
||||
op: str # verb: search / upsert_many / get / get_many / delete_many / emit / handshake
|
||||
session_id: str | None # JWT `sub` at the dispatch layer; None only if the JWT omits it
|
||||
status: str # "ok" | "error"
|
||||
req_summary: dict[str, Any] # per-verb, scope-only — no record bodies
|
||||
resp_summary: dict[str, Any] # per-verb counts + ids/scores — never verbatim content
|
||||
turn_id: str | None = None # INV-005 reservation, literal; unused in v1
|
||||
|
||||
|
||||
class OpSink(Protocol):
|
||||
"""Anything that accepts an OpEvent. v1 ships JsonlOpSink; tests pass fakes."""
|
||||
|
||||
def emit(self, event: OpEvent) -> None: ...
|
||||
|
||||
|
||||
class JsonlOpSink:
|
||||
"""Continuous append-only JSONL sink (INV-007: NOT per-session). One JSON line
|
||||
per OpEvent to a text stream (default stdout)."""
|
||||
|
||||
def __init__(self, stream: Any = None) -> None:
|
||||
self._stream = sys.stdout if stream is None else stream
|
||||
|
||||
def emit(self, event: OpEvent) -> None:
|
||||
self._stream.write(json.dumps(asdict(event), separators=(",", ":")) + "\n")
|
||||
self._stream.flush()
|
||||
|
||||
|
||||
def maybe_instrument_from_env(app: Any, env: Any, *, plane: str) -> Any:
|
||||
"""Opt-in serve wiring: when `RATATOSKR_OPFEED_PATH` is set, wrap `app` with
|
||||
the dispatch-layer op-feed writing JSONL to that path; otherwise return `app`
|
||||
unchanged. The append stream lives for the process (a long-running server)."""
|
||||
path = env.get("RATATOSKR_OPFEED_PATH")
|
||||
if not path:
|
||||
return app
|
||||
stream = open(path, "a", encoding="utf-8") # process-lifetime append stream
|
||||
return instrument_provider_app(app, plane=plane, sink=JsonlOpSink(stream))
|
||||
|
||||
|
||||
_BIFROST_PATHS = (
|
||||
"/bifrost/handshake",
|
||||
"/bifrost/memory-call",
|
||||
"/bifrost/affect-call",
|
||||
)
|
||||
|
||||
_PLANE_BY_PATH = {
|
||||
"/bifrost/memory-call": "memory",
|
||||
"/bifrost/affect-call": "affect",
|
||||
}
|
||||
|
||||
|
||||
def _resolve_plane(configured: str, path: str) -> str:
|
||||
"""For the combined provider (plane='combined', #18 D1) the OpEvent plane is
|
||||
derived from the request PATH — memory-call→memory, affect-call→affect,
|
||||
handshake→combined. A fixed plane ('memory'/'affect', the single-plane apps) is
|
||||
returned unchanged. The per-verb summary logic already keys on path, so only the
|
||||
plane STAMP changes."""
|
||||
if configured != "combined":
|
||||
return configured
|
||||
return _PLANE_BY_PATH.get(path, "combined")
|
||||
|
||||
|
||||
def _b64url_decode(seg: str) -> bytes:
|
||||
return base64.urlsafe_b64decode(seg + "=" * (-len(seg) % 4))
|
||||
|
||||
|
||||
def _session_id_from_auth(auth: bytes | None) -> str | None:
|
||||
"""Read the `sub` claim (= session_id, per bifrost DispatchContext) off the
|
||||
dispatch JWT WITHOUT verifying its signature — the inner app does real
|
||||
verification; we only read a claim for correlation. None if absent/malformed."""
|
||||
if not auth:
|
||||
return None
|
||||
try:
|
||||
token = auth.decode("latin-1").strip()
|
||||
if token.lower().startswith("bearer "):
|
||||
token = token[7:].strip()
|
||||
parts = token.split(".")
|
||||
if len(parts) != 3:
|
||||
return None
|
||||
payload = json.loads(_b64url_decode(parts[1]))
|
||||
sub = payload.get("sub")
|
||||
return sub if isinstance(sub, str) else None
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def _op_from(path: str, req: dict[str, Any]) -> str:
|
||||
"""The verb: 'handshake' for the handshake path; otherwise the body's
|
||||
`operation`, with the affect-plane `affect.` prefix stripped (affect.emit ->
|
||||
emit) so op vocabulary stays bare per the contract."""
|
||||
if path == "/bifrost/handshake":
|
||||
return "handshake"
|
||||
operation = req.get("operation") or "unknown"
|
||||
if path == "/bifrost/affect-call" and operation.startswith("affect."):
|
||||
return operation.split(".", 1)[1]
|
||||
return operation
|
||||
|
||||
|
||||
def _ids_summary(args: dict[str, Any]) -> list[Any]:
|
||||
"""Mirror bifrost `_ids_arg`: ids | chunk_ids | [chunk_id|id]."""
|
||||
ids = args.get("ids") or args.get("chunk_ids")
|
||||
if ids is None:
|
||||
single = args.get("chunk_id") or args.get("id")
|
||||
ids = [single] if single is not None else []
|
||||
return ids
|
||||
|
||||
|
||||
def _req_summary(plane: str, path: str, op: str, req: dict[str, Any]) -> dict[str, Any]:
|
||||
"""Scope-only request summary — NEVER record bodies / PAD content."""
|
||||
if path == "/bifrost/handshake":
|
||||
# The handshake REQUEST field is `capabilities` (bifrost reference_server
|
||||
# _protocol.py:181 reads request_body["capabilities"]) — NOT the transposed
|
||||
# `capabilities_requested`, which never existed on the wire (caps_requested
|
||||
# was silently always None). Fixed per the heid-code-review #17 catch.
|
||||
return {"caps_requested": req.get("capabilities")}
|
||||
if plane == "affect":
|
||||
return {} # affect stays conduit-opaque — no PAD content surfaced
|
||||
args = req.get("args") or {}
|
||||
if op == "search":
|
||||
return {
|
||||
"scope_all": args.get("scope_all") or {},
|
||||
"scope_any": args.get("scope_any") or [],
|
||||
"top_k": args.get("top_k"),
|
||||
}
|
||||
if op == "upsert_many":
|
||||
records = args.get("records") or []
|
||||
return {
|
||||
"record_count": len(records),
|
||||
"scopes": [r.get("scope") for r in records],
|
||||
}
|
||||
if op in ("get", "get_many", "delete_many"):
|
||||
return {"ids": _ids_summary(args)}
|
||||
return {}
|
||||
|
||||
|
||||
def _resp_summary(
|
||||
plane: str, path: str, op: str, resp: dict[str, Any], status: str
|
||||
) -> dict[str, Any]:
|
||||
"""Per-verb counts + ids/scores — never verbatim content. On error, the
|
||||
bifrost error `code` (INV-007: failures recorded, not hidden)."""
|
||||
if status == "error":
|
||||
return {"error": resp.get("code")}
|
||||
if path == "/bifrost/handshake":
|
||||
return {"ok": True, "caps_granted": resp.get("capabilities_granted")}
|
||||
if plane == "affect":
|
||||
return {"stored": bool(resp.get("stored"))}
|
||||
if op == "search":
|
||||
results = resp.get("results") or []
|
||||
return {
|
||||
"hit_count": len(results),
|
||||
"hits": [
|
||||
{"chunk_id": r.get("chunk_id"), "score": r.get("score")}
|
||||
for r in results
|
||||
],
|
||||
}
|
||||
if op == "upsert_many":
|
||||
return {"upserted": resp.get("upserted"), "replayed": resp.get("replayed")}
|
||||
if op == "get":
|
||||
return {"found_count": 1 if resp.get("record") else 0}
|
||||
if op == "get_many":
|
||||
return {"found_count": len(resp.get("records") or [])}
|
||||
if op == "delete_many":
|
||||
return {"deleted": resp.get("deleted")}
|
||||
return {}
|
||||
|
||||
|
||||
def _build_event(
|
||||
plane: str, path: str, scope: dict[str, Any], req_body: bytes, captured: dict[str, Any]
|
||||
) -> OpEvent:
|
||||
plane = _resolve_plane(plane, path) # 'combined' → per-path; fixed plane unchanged
|
||||
headers = dict(scope.get("headers") or [])
|
||||
session_id = _session_id_from_auth(headers.get(b"authorization"))
|
||||
status = "ok" if 200 <= int(captured["status"]) < 300 else "error"
|
||||
req = _safe_json(req_body)
|
||||
resp = _safe_json(captured["body"])
|
||||
|
||||
op = _op_from(path, req)
|
||||
return OpEvent(
|
||||
ts=datetime.now(UTC).isoformat(),
|
||||
plane=plane,
|
||||
op=op,
|
||||
session_id=session_id,
|
||||
status=status,
|
||||
req_summary=_req_summary(plane, path, op, req),
|
||||
resp_summary=_resp_summary(plane, path, op, resp, status),
|
||||
)
|
||||
|
||||
|
||||
def _safe_json(raw: bytes) -> dict[str, Any]:
|
||||
if not raw:
|
||||
return {}
|
||||
try:
|
||||
value = json.loads(raw)
|
||||
except (json.JSONDecodeError, ValueError):
|
||||
return {}
|
||||
return value if isinstance(value, dict) else {}
|
||||
|
||||
|
||||
def instrument_provider_app(app: Any, *, plane: str, sink: OpSink) -> Any:
|
||||
"""Wrap a built provider ASGI `app` so each inbound bifrost-call emits one
|
||||
OpEvent to `sink`. Read-only over dispatch — store scope semantics untouched
|
||||
(INV-004). A sink/summary failure never propagates into the dispatch path
|
||||
(POST-003 / INV-007) — it is swallowed and logged to stderr.
|
||||
"""
|
||||
if plane not in ("memory", "affect", "combined"):
|
||||
raise ValueError(
|
||||
f"plane must be 'memory', 'affect', or 'combined', got {plane!r}"
|
||||
)
|
||||
|
||||
async def wrapped(scope: dict[str, Any], receive: Any, send: Any) -> None:
|
||||
if scope.get("type") != "http" or scope.get("path") not in _BIFROST_PATHS:
|
||||
await app(scope, receive, send)
|
||||
return
|
||||
|
||||
# Buffer the request body so we can BOTH summarise it AND replay it to the
|
||||
# inner app (the inner app consumes `receive`; we must not steal the body).
|
||||
req_body = b""
|
||||
more = True
|
||||
while more:
|
||||
message = await receive()
|
||||
if message["type"] == "http.request":
|
||||
req_body += message.get("body", b"")
|
||||
more = message.get("more_body", False)
|
||||
else: # http.disconnect
|
||||
more = False
|
||||
|
||||
replayed = False
|
||||
|
||||
async def replay_receive() -> dict[str, Any]:
|
||||
nonlocal replayed
|
||||
if not replayed:
|
||||
replayed = True
|
||||
return {"type": "http.request", "body": req_body, "more_body": False}
|
||||
return {"type": "http.disconnect"}
|
||||
|
||||
captured: dict[str, Any] = {"status": 500, "body": b""}
|
||||
|
||||
async def capture_send(message: dict[str, Any]) -> None:
|
||||
if message["type"] == "http.response.start":
|
||||
captured["status"] = message["status"]
|
||||
elif message["type"] == "http.response.body":
|
||||
captured["body"] += message.get("body", b"")
|
||||
await send(message)
|
||||
|
||||
await app(scope, replay_receive, capture_send)
|
||||
|
||||
try:
|
||||
sink.emit(_build_event(plane, scope["path"], scope, req_body, captured))
|
||||
except Exception as exc: # observe gap, never a serve break (POST-003)
|
||||
sys.stderr.write(f"[opfeed] OpEvent emit failed (swallowed): {exc!r}\n")
|
||||
|
||||
return wrapped
|
||||
@@ -0,0 +1,43 @@
|
||||
"""Runnable entrypoint: serve the affect provider as an ASGI app.
|
||||
|
||||
For the live negotiation smoke against a Worldtree instance. Config from env:
|
||||
- RATATOSKR_HEIMDALL_KEY (required): HS256 shared key for the consumer, utf-8.
|
||||
- RATATOSKR_AFFECT_DB (default "affect.db"): SQLite path; ":memory:" = ephemeral.
|
||||
- RATATOSKR_CONSUMER_ID (default "ratatoskr").
|
||||
- RATATOSKR_PROVIDER_HOST (default "0.0.0.0"), RATATOSKR_PROVIDER_PORT (default 8390).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Mapping
|
||||
|
||||
from ratatoskr.provider.affect_store import build_affect_provider_app, open_affect_store
|
||||
from ratatoskr.provider.opfeed import maybe_instrument_from_env
|
||||
|
||||
|
||||
def build_app_from_env(env: Mapping[str, str] | None = None):
|
||||
"""Build the affect ASGI app from environment config (testable seam)."""
|
||||
env = os.environ if env is None else env
|
||||
key = env.get("RATATOSKR_HEIMDALL_KEY")
|
||||
if not key:
|
||||
raise RuntimeError(
|
||||
"RATATOSKR_HEIMDALL_KEY is required to serve the affect provider"
|
||||
)
|
||||
store = open_affect_store(env.get("RATATOSKR_AFFECT_DB", "affect.db"))
|
||||
app = build_affect_provider_app(
|
||||
store,
|
||||
heimdall_key=key.encode(),
|
||||
consumer_id=env.get("RATATOSKR_CONSUMER_ID", "ratatoskr"),
|
||||
)
|
||||
# Issue #17 (Observe): opt-in dispatch-layer op-feed when RATATOSKR_OPFEED_PATH set.
|
||||
return maybe_instrument_from_env(app, env, plane="affect")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
import uvicorn
|
||||
|
||||
uvicorn.run(
|
||||
build_app_from_env(),
|
||||
host=os.environ.get("RATATOSKR_PROVIDER_HOST", "0.0.0.0"),
|
||||
port=int(os.environ.get("RATATOSKR_PROVIDER_PORT", "8390")),
|
||||
)
|
||||
@@ -0,0 +1,73 @@
|
||||
"""Runnable entrypoint: serve the COMBINED provider (memory + affect) as one ASGI app.
|
||||
|
||||
Issue #18 Deliverable 1 — a single endpoint a Worldtree session binds to drive BOTH
|
||||
planes. Additive: the standalone affect (:8390) + memory (:8391) entrypoints are
|
||||
unchanged. Config from env:
|
||||
- RATATOSKR_HEIMDALL_KEY (required): HS256 shared key for the consumer, utf-8.
|
||||
- RATATOSKR_MEMORY_EMBEDDING_DIM (required): the pinned embedder dim (no default —
|
||||
a wrong value silently breaks search).
|
||||
- RATATOSKR_AFFECT_DB (default "affect.db") + RATATOSKR_MEMORY_DB (default "memory.db"):
|
||||
the two SQLite paths (one per plane, per the v1 contract).
|
||||
- RATATOSKR_CONSUMER_ID (default "ratatoskr").
|
||||
- RATATOSKR_PROVIDER_HOST (default "0.0.0.0"),
|
||||
RATATOSKR_COMBINED_PROVIDER_PORT (default 8392 — distinct from :8390/:8391 so the
|
||||
composite runs side-by-side with the standalones).
|
||||
- RATATOSKR_OPFEED_PATH (optional): op-feed JSONL path; plane is derived PER request
|
||||
path (memory-call→memory, affect-call→affect, handshake→combined).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Mapping
|
||||
|
||||
from ratatoskr.provider.affect_store import open_affect_store
|
||||
from ratatoskr.provider.combined import build_combined_provider_app
|
||||
from ratatoskr.provider.memory_store import open_memory_store
|
||||
from ratatoskr.provider.opfeed import maybe_instrument_from_env
|
||||
|
||||
|
||||
def build_combined_app_from_env(env: Mapping[str, str] | None = None):
|
||||
"""Build the combined ASGI app from environment config (testable seam)."""
|
||||
env = os.environ if env is None else env
|
||||
key = env.get("RATATOSKR_HEIMDALL_KEY")
|
||||
if not key:
|
||||
raise RuntimeError(
|
||||
"RATATOSKR_HEIMDALL_KEY is required to serve the combined provider"
|
||||
)
|
||||
raw_dim = env.get("RATATOSKR_MEMORY_EMBEDDING_DIM")
|
||||
if not raw_dim:
|
||||
raise RuntimeError(
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM is required (Worldtree's PINNED_EMBEDDER_DIM)"
|
||||
)
|
||||
try:
|
||||
embedding_dim = int(raw_dim)
|
||||
except ValueError as exc:
|
||||
raise RuntimeError(
|
||||
f"RATATOSKR_MEMORY_EMBEDDING_DIM must be an int, got {raw_dim!r}"
|
||||
) from exc
|
||||
if embedding_dim <= 0:
|
||||
raise RuntimeError("RATATOSKR_MEMORY_EMBEDDING_DIM must be a positive int")
|
||||
|
||||
affect_store = open_affect_store(env.get("RATATOSKR_AFFECT_DB", "affect.db"))
|
||||
memory_store = open_memory_store(
|
||||
env.get("RATATOSKR_MEMORY_DB", "memory.db"), embedding_dim=embedding_dim
|
||||
)
|
||||
app = build_combined_provider_app(
|
||||
memory_store,
|
||||
affect_store,
|
||||
heimdall_key=key.encode(),
|
||||
consumer_id=env.get("RATATOSKR_CONSUMER_ID", "ratatoskr"),
|
||||
)
|
||||
# Issue #17 (Observe): opt-in dispatch-layer op-feed; plane='combined' derives the
|
||||
# OpEvent plane per request path (INV-012).
|
||||
return maybe_instrument_from_env(app, env, plane="combined")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
import uvicorn
|
||||
|
||||
uvicorn.run(
|
||||
build_combined_app_from_env(),
|
||||
host=os.environ.get("RATATOSKR_PROVIDER_HOST", "0.0.0.0"),
|
||||
port=int(os.environ.get("RATATOSKR_COMBINED_PROVIDER_PORT", "8392")),
|
||||
)
|
||||
@@ -0,0 +1,63 @@
|
||||
"""Runnable entrypoint: serve the memory provider as an ASGI app.
|
||||
|
||||
For the live negotiation smoke against a Worldtree instance. Config from env:
|
||||
- RATATOSKR_HEIMDALL_KEY (required): HS256 shared key for the consumer, utf-8.
|
||||
- RATATOSKR_MEMORY_EMBEDDING_DIM (required): the pinned embedder dim; the
|
||||
sqlite-vec index is created at this fixed dim, so a wrong value silently
|
||||
breaks search — no default.
|
||||
- RATATOSKR_MEMORY_DB (default "memory.db"): SQLite path; ":memory:" = ephemeral.
|
||||
- RATATOSKR_CONSUMER_ID (default "ratatoskr").
|
||||
- RATATOSKR_PROVIDER_HOST (default "0.0.0.0"),
|
||||
RATATOSKR_MEMORY_PROVIDER_PORT (default 8391 — distinct from affect's 8390 so
|
||||
both planes can run side-by-side as separate apps, per the v1 contract).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Mapping
|
||||
|
||||
from ratatoskr.provider.memory_store import build_memory_provider_app, open_memory_store
|
||||
from ratatoskr.provider.opfeed import maybe_instrument_from_env
|
||||
|
||||
|
||||
def build_memory_app_from_env(env: Mapping[str, str] | None = None):
|
||||
"""Build the memory ASGI app from environment config (testable seam)."""
|
||||
env = os.environ if env is None else env
|
||||
key = env.get("RATATOSKR_HEIMDALL_KEY")
|
||||
if not key:
|
||||
raise RuntimeError(
|
||||
"RATATOSKR_HEIMDALL_KEY is required to serve the memory provider"
|
||||
)
|
||||
raw_dim = env.get("RATATOSKR_MEMORY_EMBEDDING_DIM")
|
||||
if not raw_dim:
|
||||
raise RuntimeError(
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM is required (Worldtree's PINNED_EMBEDDER_DIM)"
|
||||
)
|
||||
try:
|
||||
embedding_dim = int(raw_dim)
|
||||
except ValueError as exc:
|
||||
raise RuntimeError(
|
||||
f"RATATOSKR_MEMORY_EMBEDDING_DIM must be an int, got {raw_dim!r}"
|
||||
) from exc
|
||||
if embedding_dim <= 0:
|
||||
raise RuntimeError("RATATOSKR_MEMORY_EMBEDDING_DIM must be a positive int")
|
||||
store = open_memory_store(
|
||||
env.get("RATATOSKR_MEMORY_DB", "memory.db"), embedding_dim=embedding_dim
|
||||
)
|
||||
app = build_memory_provider_app(
|
||||
store,
|
||||
heimdall_key=key.encode(),
|
||||
consumer_id=env.get("RATATOSKR_CONSUMER_ID", "ratatoskr"),
|
||||
)
|
||||
# Issue #17 (Observe): opt-in dispatch-layer op-feed when RATATOSKR_OPFEED_PATH set.
|
||||
return maybe_instrument_from_env(app, env, plane="memory")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
import uvicorn
|
||||
|
||||
uvicorn.run(
|
||||
build_memory_app_from_env(),
|
||||
host=os.environ.get("RATATOSKR_PROVIDER_HOST", "0.0.0.0"),
|
||||
port=int(os.environ.get("RATATOSKR_MEMORY_PROVIDER_PORT", "8391")),
|
||||
)
|
||||
+363
-2
@@ -59,6 +59,20 @@ class AgentInfo:
|
||||
ui_hints: dict[str, Any]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class BifrostBinding:
|
||||
"""Session-create Bifrost binding (Worldtree BifrostBindingRequest, #160).
|
||||
|
||||
Issue #17. `endpoint_url` is the WORLDTREE-VISIBLE base URL of ONE provider
|
||||
plane (memory :8391 / affect :8390). `scope` is an opaque pass-through copied
|
||||
into the handshake JWT unchanged (≤256 chars); ratatoskr does not interpret
|
||||
it and v1 sends None.
|
||||
"""
|
||||
|
||||
endpoint_url: str
|
||||
scope: str | None = None
|
||||
|
||||
|
||||
class AgentNotFound(Exception):
|
||||
"""Raised on HTTP 404 from POST /sessions — unknown agent_id."""
|
||||
|
||||
@@ -89,6 +103,40 @@ class SessionApiFailed(Exception):
|
||||
self.body = body
|
||||
|
||||
|
||||
# Issue #17 — Bifrost-bind failure modes on POST /sessions.
|
||||
class BifrostConsumerKeyMissing(Exception):
|
||||
"""A bifrost binding was requested without a consumer_key.
|
||||
|
||||
Raised BEFORE any HTTP (INV-001): the bound create must never silently fall
|
||||
back to the client's default canary key — the consumer key IS the handshake
|
||||
identity Worldtree signs the Bifrost JWT with.
|
||||
"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__(
|
||||
"bifrost binding requires a non-empty consumer_key; refusing to "
|
||||
"fall back to the canary key (INV-001)"
|
||||
)
|
||||
|
||||
|
||||
class BifrostHandshakeFailed(Exception):
|
||||
"""Raised on HTTP 502 `bifrost_handshake_failed` from a bound POST /sessions.
|
||||
|
||||
INV-002: the Bifrost handshake runs synchronously at session-create, so a
|
||||
handshake failure (bad URL / down provider / wrong key / HTTPS rejection)
|
||||
fails SESSION CREATION — surfaced on the create path, never deferred to the
|
||||
first turn. `bifrost_error` carries the spec-level code (e.g.
|
||||
`bifrost.auth_rejected`); `body` is truncated to ≤1024 bytes, consistent with
|
||||
`SessionApiFailed` (INV-004 precedent).
|
||||
"""
|
||||
|
||||
def __init__(self, *, bifrost_error: str | None, body: bytes) -> None:
|
||||
body = body[:1024]
|
||||
super().__init__(f"bifrost handshake failed: bifrost_error={bifrost_error!r}")
|
||||
self.bifrost_error = bifrost_error
|
||||
self.body = body
|
||||
|
||||
|
||||
# Worldtree #204 / v0.28.0 — persona_state endpoint failure modes.
|
||||
class PersonaNotConfigured(Exception):
|
||||
"""Raised on HTTP 404 `persona_not_configured` from GET persona_state.
|
||||
@@ -129,6 +177,26 @@ class AuthScopeDenied(Exception):
|
||||
self.scope = scope
|
||||
|
||||
|
||||
class AuthoredHistoryUnavailable(Exception):
|
||||
"""Raised on HTTP 404 from POST /sessions/{id}/history (#347 authored-history-write).
|
||||
|
||||
Hide-existence (server INV-347-1): an ungranted caller, a non-owner, and an
|
||||
unknown session ALL receive a 404 byte-identical to a genuine
|
||||
`session_not_found` — the feature's existence is never revealed by status,
|
||||
body, or error_code. The consumer MUST treat this as feature-absent and fall
|
||||
back (a production consumer to a model-generated greeting), and MUST NOT
|
||||
capability-probe to distinguish the causes. Distinct from `SessionApiFailed`
|
||||
so callers branch feature-absent without inspecting a status code.
|
||||
"""
|
||||
|
||||
def __init__(self, *, session_id: str) -> None:
|
||||
super().__init__(
|
||||
f"authored-history write unavailable for session {session_id!r} "
|
||||
"(404 hide-existence: feature-absent / ungranted / session-absent)"
|
||||
)
|
||||
self.session_id = session_id
|
||||
|
||||
|
||||
async def list_sessions(
|
||||
client: httpx.AsyncClient,
|
||||
*,
|
||||
@@ -176,11 +244,53 @@ async def list_sessions(
|
||||
return SessionPage(items=items, next_cursor=body.get("next_cursor"))
|
||||
|
||||
|
||||
def endpoint_for_plane(plane: str, base_host: str) -> str:
|
||||
"""Map a provider plane name to its Worldtree-VISIBLE base URL.
|
||||
|
||||
Issue #17 dev helper: `memory` → :8391, `affect` → :8390, `combined` → :8392
|
||||
(the #18 composite both-plane endpoint). Returns the Worldtree-visible base
|
||||
(e.g. `http://10.100.10.50:8391`), NOT the client's loopback — Worldtree must
|
||||
reach the provider over the network. `http://` is deliberate: the HTTPS
|
||||
relaxation is allowlist-side (Worldtree's BIFROST_CLIENT_ALLOWED_HOSTS), not a
|
||||
URL concern. A production HTTPS endpoint is supplied directly, bypassing this
|
||||
helper.
|
||||
"""
|
||||
ports = {"memory": 8391, "affect": 8390, "combined": 8392}
|
||||
if plane not in ports:
|
||||
raise ValueError(
|
||||
f"unknown plane: {plane!r} "
|
||||
"(expected 'memory', 'affect', or 'combined')"
|
||||
)
|
||||
return f"http://{base_host}:{ports[plane]}"
|
||||
|
||||
|
||||
def _bifrost_error_from(resp: httpx.Response) -> str | None:
|
||||
"""Pull the spec-level `bifrost_error` from a 502 body.
|
||||
|
||||
Tolerates both the FastAPI-nested `{"detail": {"bifrost_error": …}}` shape
|
||||
(the spec's documented form, §"Optional Bifrost binding") and a flat
|
||||
top-level `bifrost_error`, per the both-shape unwrap precedent established for
|
||||
persona_state errors (the real wire returns the detail-nested form).
|
||||
"""
|
||||
try:
|
||||
err = resp.json()
|
||||
except ValueError:
|
||||
return None
|
||||
if not isinstance(err, dict):
|
||||
return None
|
||||
bifrost_error = err.get("bifrost_error")
|
||||
if bifrost_error is None and isinstance(err.get("detail"), dict):
|
||||
bifrost_error = err["detail"].get("bifrost_error")
|
||||
return bifrost_error
|
||||
|
||||
|
||||
async def create_session(
|
||||
client: httpx.AsyncClient,
|
||||
agent_id: str,
|
||||
*,
|
||||
end_user_id: str | None = None,
|
||||
bifrost: BifrostBinding | None = None,
|
||||
consumer_key: str | None = None,
|
||||
) -> SessionInfo:
|
||||
"""POST /sessions to create a new session. See contract FN create_session.
|
||||
|
||||
@@ -188,17 +298,42 @@ async def create_session(
|
||||
When None (default), the body shape matches the pre-#5 baseline
|
||||
`{"agent_id": agent_id}` so existing callers (mimir smoke) are unaffected.
|
||||
Empty-string `end_user_id` is rejected before HTTP (PRE-003).
|
||||
|
||||
Per issue #17: when `bifrost` is set the request carries the binding and
|
||||
authenticates with `consumer_key` (NOT the client's default canary bearer);
|
||||
Worldtree handshakes synchronously to our provider before 201.
|
||||
"""
|
||||
assert client is not None
|
||||
assert agent_id and isinstance(agent_id, str)
|
||||
assert end_user_id is None or (isinstance(end_user_id, str) and end_user_id)
|
||||
|
||||
body: dict[str, str] = {"agent_id": agent_id}
|
||||
# PRE-001 (INV-001): a bifrost binding REQUIRES a non-empty consumer key,
|
||||
# enforced before any HTTP so a bound create never falls back to the canary.
|
||||
if bifrost is not None and not (isinstance(consumer_key, str) and consumer_key):
|
||||
raise BifrostConsumerKeyMissing()
|
||||
|
||||
body: dict[str, Any] = {"agent_id": agent_id}
|
||||
if end_user_id is not None:
|
||||
body["end_user_id"] = end_user_id
|
||||
resp = await client.post("/sessions", json=body)
|
||||
headers: dict[str, str] = {}
|
||||
if bifrost is not None:
|
||||
body["bifrost"] = {
|
||||
"endpoint_url": bifrost.endpoint_url,
|
||||
"scope": bifrost.scope,
|
||||
}
|
||||
# INV-001: the bound create authenticates with the consumer key,
|
||||
# overriding the httpx client's default canary bearer per-request.
|
||||
headers["Authorization"] = f"Bearer {consumer_key}"
|
||||
resp = await client.post("/sessions", json=body, headers=headers)
|
||||
if resp.status_code == 404:
|
||||
raise AgentNotFound(agent_id=agent_id)
|
||||
# POST-002 (INV-002): a 502 on a BOUND create is the synchronous Bifrost
|
||||
# handshake failing. Gated on `bifrost is not None` — an unbound create's
|
||||
# 502 is a generic upstream fault and stays SessionApiFailed.
|
||||
if bifrost is not None and resp.status_code == 502:
|
||||
raise BifrostHandshakeFailed(
|
||||
bifrost_error=_bifrost_error_from(resp), body=resp.content
|
||||
)
|
||||
if resp.status_code != 201:
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
body = resp.json()
|
||||
@@ -291,3 +426,229 @@ async def get_persona_state(
|
||||
if resp.status_code == 403 and error_code == "auth_scope_denied":
|
||||
raise AuthScopeDenied(scope="persona.read")
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_me(client: httpx.AsyncClient) -> dict[str, Any]:
|
||||
"""GET /me — the authenticated principal's identity + key metadata (spec §GET /me).
|
||||
|
||||
Boot-time whoami: verify the key without agent-config side effects. Returns
|
||||
the parsed dict verbatim (freeform per the frozen OpenAPI; the spec documents
|
||||
`{user_id, scopes, tier, display_name?, key_id?, key_label?, ...}`, optional
|
||||
fields omitted-not-null). 401 (bad/absent key when auth is enabled) — like
|
||||
every other non-200 — surfaces as SessionApiFailed (get_persona_state
|
||||
precedent). Read-only, rate-exempt, no audit emission.
|
||||
"""
|
||||
assert client is not None
|
||||
resp = await client.get("/me")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def list_character_models(client: httpx.AsyncClient) -> dict[str, Any]:
|
||||
"""GET /models/available-for-characters — character-capable model profiles (#161).
|
||||
|
||||
Requires `character.read`. Returns `{items: [{name, description, thinking}]}`.
|
||||
Parsed dict verbatim; any non-200 → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
resp = await client.get("/models/available-for-characters")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def create_character(
|
||||
client: httpx.AsyncClient, character: dict[str, Any], *, state: dict[str, Any] | None = None
|
||||
) -> dict[str, Any]:
|
||||
"""POST /characters — create a transient character (#161). Requires `character.write`.
|
||||
|
||||
Body is `{character, state}` (state optional — a CharacterStateSchema for
|
||||
mid-conversation rehydration). Returns 201 `{character_id, ttl_expires_at}`;
|
||||
any non-201 → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
assert isinstance(character, dict) and character
|
||||
resp = await client.post("/characters", json={"character": character, "state": state})
|
||||
if resp.status_code == 201:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_character_state(client: httpx.AsyncClient, character_id: str) -> dict[str, Any]:
|
||||
"""GET /characters/{character_id}/state — live runtime state (#161). Requires `character.read`.
|
||||
|
||||
Returns `{schema_version, pad, emotions_active, mood_drift, goal_signal_history}`;
|
||||
refreshes the character's TTL. Any non-200 → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
assert character_id and isinstance(character_id, str)
|
||||
resp = await client.get(f"/characters/{character_id}/state")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def delete_character(client: httpx.AsyncClient, character_id: str) -> None:
|
||||
"""DELETE /characters/{character_id} — remove a transient character (#161).
|
||||
|
||||
Requires `character.write`. Bound sessions detach (next turn → 410
|
||||
character_not_found). 200/204 → None; any other status → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
assert character_id and isinstance(character_id, str)
|
||||
resp = await client.delete(f"/characters/{character_id}")
|
||||
if resp.status_code in (200, 204):
|
||||
return None
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def set_persona_state(
|
||||
client: httpx.AsyncClient, session_id: str, snapshot: dict[str, Any]
|
||||
) -> None:
|
||||
"""POST /sessions/{session_id}/persona_state — set a session's persona state (affect injection).
|
||||
|
||||
The request body is FREEFORM on the wire (the OpenAPI declares no request
|
||||
schema), but worldtree-dev's prose now pins the canonical shape (#317):
|
||||
`{"pad": {"pleasure": p, "arousal": a, "dominance": d}}` — a named-key dict
|
||||
(each in [-1, 1]), NOT a bare list; PAD-only, session-scoped, pull-over-push
|
||||
(#289). The caller supplies the snapshot. 204 No Content → None; any other
|
||||
status → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
assert isinstance(snapshot, dict)
|
||||
resp = await client.post(f"/sessions/{session_id}/persona_state", json=snapshot)
|
||||
if resp.status_code == 204:
|
||||
return None
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_session_bifrost(
|
||||
client: httpx.AsyncClient, session_id: str, *, admin_key: str
|
||||
) -> dict[str, Any]:
|
||||
"""GET /admin/sessions/{session_id}/bifrost — admin-scoped Bifrost dispatch state (#176).
|
||||
|
||||
Returns the live Bifrost binding for a session: `{endpoint_url, consumer_id,
|
||||
connected, capabilities_granted, tools: [{name, description}]}`. Requires the
|
||||
`admin.sessions.read` scope (admin tier), so the request OVERRIDES the
|
||||
Authorization header with `admin_key` (distinct from the client's default
|
||||
consumer key). Read-only (audited server-side). Parsed dict verbatim; any
|
||||
non-200 → SessionApiFailed — notably 403 `auth_scope_denied` (key lacks the
|
||||
scope) and 404 `session_not_bifrost_bound` (session exists, no live client).
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
assert admin_key and isinstance(admin_key, str)
|
||||
resp = await client.get(
|
||||
f"/admin/sessions/{session_id}/bifrost",
|
||||
headers={"Authorization": f"Bearer {admin_key}"},
|
||||
)
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_session_tools(client: httpx.AsyncClient, session_id: str) -> dict[str, Any]:
|
||||
"""GET /sessions/{session_id}/tools — owner-scoped tool inventory (spec #183).
|
||||
|
||||
Returns the merged tool list the LLM saw at turn-fire: `{agent_id,
|
||||
builtin_tools: [...], bifrost_tools: [{name, description, parameters}, ...]}`.
|
||||
Owner-scoped (`ctx.user_id == session.user_id`) — reachable with the consumer
|
||||
key, NO admin scope. Cross-owner access returns 404 `session_not_found`
|
||||
(existence-hiding); a revoked session returns 401 `auth_revoked`. Parsed dict
|
||||
verbatim; any non-200 → SessionApiFailed (mirrors get_persona_state).
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
resp = await client.get(f"/sessions/{session_id}/tools")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_capabilities(client: httpx.AsyncClient) -> dict[str, Any]:
|
||||
"""GET /capabilities — server capability discovery (spec §Ephemeral Templates).
|
||||
|
||||
Returns `{ephemeral_templates: {echo: {allowed_models, default_model,
|
||||
system_prompt_max_bytes}}}` — what the server offers before a client decides
|
||||
to instantiate. Any authenticated caller may read it (no scope). Parsed dict
|
||||
verbatim; any non-200 → SessionApiFailed.
|
||||
"""
|
||||
assert client is not None
|
||||
resp = await client.get("/capabilities")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def write_authored_history(
|
||||
client: httpx.AsyncClient,
|
||||
session_id: str,
|
||||
*,
|
||||
content: str,
|
||||
idempotency_key: str,
|
||||
author: str = "assistant",
|
||||
effects: str | None = None,
|
||||
claimed_original_at: str | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""POST /sessions/{session_id}/history — the #347 authored-history-write primitive.
|
||||
|
||||
Write one model-visible turn into the session's ledger AS the bound agent,
|
||||
WITHOUT a generation and WITHOUT lived-turn side effects (the SillyTavern
|
||||
"first message"). v1: `author="assistant"`, `effects` omitted (== "none"),
|
||||
`idempotency_key` REQUIRED (per-session dedup). The server pins the body
|
||||
(`AuthoredWriteRequest`, `extra="forbid"`), so `effects` /
|
||||
`claimed_original_at` are sent only when non-None — never as null keys.
|
||||
|
||||
Success is 201 (fresh) or 200 (idempotent replay, byte-identical body); both
|
||||
return the `AuthoredTurnResponse` dict verbatim (`{author, content_chars,
|
||||
injected_at, phase, seq, session_id, turn_id}` — provenance is audit-only,
|
||||
never on this body).
|
||||
|
||||
404 → `AuthoredHistoryUnavailable` (hide-existence: feature-absent /
|
||||
ungranted / session-absent are indistinguishable by design; the caller falls
|
||||
back and NEVER capability-probes — server INV-347-1). Any other non-2xx →
|
||||
`SessionApiFailed` (notably 409 `generation_active`, 422 `content_too_long` /
|
||||
`validation_failed`).
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
assert content and isinstance(content, str)
|
||||
assert idempotency_key and isinstance(idempotency_key, str)
|
||||
assert author and isinstance(author, str)
|
||||
body: dict[str, Any] = {
|
||||
"author": author,
|
||||
"content": content,
|
||||
"idempotency_key": idempotency_key,
|
||||
}
|
||||
if effects is not None:
|
||||
body["effects"] = effects
|
||||
if claimed_original_at is not None:
|
||||
body["claimed_original_at"] = claimed_original_at
|
||||
resp = await client.post(f"/sessions/{session_id}/history", json=body)
|
||||
if resp.status_code in (200, 201):
|
||||
return resp.json()
|
||||
if resp.status_code == 404:
|
||||
raise AuthoredHistoryUnavailable(session_id=session_id)
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
|
||||
async def get_session_messages(
|
||||
client: httpx.AsyncClient, session_id: str
|
||||
) -> dict[str, Any]:
|
||||
"""GET /sessions/{session_id}/messages — the session's message history.
|
||||
|
||||
Un-deferred as the #347 seed read-back: a seeded turn renders as a normal
|
||||
`role=assistant` message (model-invisible provenance — indistinguishable
|
||||
from a lived turn on read). Returns `{session_id, items: [{seq, role,
|
||||
content, ...}], next_cursor}` verbatim; owner-scoped; any non-200 →
|
||||
`SessionApiFailed`. v1 reads the server default page (no pagination params —
|
||||
add limit/cursor when a caller needs scrollback).
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
resp = await client.get(f"/sessions/{session_id}/messages")
|
||||
if resp.status_code == 200:
|
||||
return resp.json()
|
||||
raise SessionApiFailed(status=resp.status_code, body=resp.content)
|
||||
|
||||
@@ -175,6 +175,23 @@ Event = (
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class AdminEvent:
|
||||
"""One `/admin/events` envelope (INV-046) — an admin-tier lifecycle event.
|
||||
|
||||
Distinct from the turn-stream `Event` union: this is the process-wide admin
|
||||
broadcast stream, not a per-turn stream. `id` is a plain monotonic int
|
||||
(resets on restart; heartbeats have id=0). `type` is a dotted namespace
|
||||
(session.* / turn.* / key.* / system.*). `data` is a type-specific dict —
|
||||
most carry `session_id`; per INV-049 it holds IDs + small metadata only.
|
||||
"""
|
||||
|
||||
id: int
|
||||
type: str
|
||||
timestamp: str | None
|
||||
data: dict[str, Any]
|
||||
|
||||
|
||||
class MalformedSseId(Exception):
|
||||
"""Raised when an SSE event's `id:` wire field is missing or non-composite."""
|
||||
|
||||
@@ -215,6 +232,59 @@ class SseConnectFailed(Exception):
|
||||
self.body = body
|
||||
|
||||
|
||||
class AgentNotAvailable(SseConnectFailed):
|
||||
"""Eager 409 from the turn POST (Worldtree v1.0.0b1, #331): the session's
|
||||
agent is unavailable, so the turn never launched. Pre-b1 this arrived as a
|
||||
200 stream + an in-stream `error` event; b1 surfaces it eagerly. Subclass of
|
||||
SseConnectFailed so existing `except SseConnectFailed` handlers still catch
|
||||
it — this type just adds the parsed `error_code` + `message`."""
|
||||
|
||||
def __init__(self, *, body: bytes, error_code: str, message: str) -> None:
|
||||
super().__init__(status=409, body=body)
|
||||
self.error_code = error_code
|
||||
self.message = message
|
||||
|
||||
|
||||
class TurnLaunchUnavailable(SseConnectFailed):
|
||||
"""Eager 503 from the turn POST (Worldtree v1.0.0b1, #331): a transient
|
||||
turn-launch failure (loop shutdown / resource exhaustion). RETRYABLE.
|
||||
Subclass of SseConnectFailed; adds `error_code`, `message`, `retryable`."""
|
||||
|
||||
retryable = True
|
||||
|
||||
def __init__(self, *, body: bytes, error_code: str, message: str) -> None:
|
||||
super().__init__(status=503, body=body)
|
||||
self.error_code = error_code
|
||||
self.message = message
|
||||
|
||||
|
||||
# Canonical error_codes (Worldtree #331 / v1.0.0b2): 409 -> agent_not_available,
|
||||
# 503 -> not_ready (retryable; re-pinned from internal_error). Used only as a
|
||||
# fallback default when the body omits error_code — the real code is surfaced
|
||||
# verbatim from the {detail:{error_code,message}} envelope.
|
||||
_EAGER_TURN_FAILURE_CODE = {409: "agent_not_available", 503: "not_ready"}
|
||||
|
||||
|
||||
def _eager_failure_fields(body: bytes, status: int) -> tuple[str, str]:
|
||||
"""Extract (error_code, message) from an eager turn-launch failure body
|
||||
(#331). Accepts the Worldtree `{"detail": {...}}` envelope OR a flat
|
||||
`{error_code, message}`; falls back to a status-derived default code and a
|
||||
generic message when the body is absent / non-JSON / malformed."""
|
||||
try:
|
||||
parsed: Any = json.loads(body)
|
||||
except (json.JSONDecodeError, ValueError):
|
||||
parsed = None
|
||||
src: dict[str, Any] = {}
|
||||
if isinstance(parsed, dict):
|
||||
detail = parsed.get("detail")
|
||||
src = detail if isinstance(detail, dict) else parsed
|
||||
code = src.get("error_code") or _EAGER_TURN_FAILURE_CODE[status]
|
||||
message = src.get("message")
|
||||
if not isinstance(message, str):
|
||||
message = f"turn launch failed (HTTP {status})"
|
||||
return str(code), message
|
||||
|
||||
|
||||
class SseConnectionDropped(Exception):
|
||||
"""Raised when the HTTP/SSE connection dropped mid-stream."""
|
||||
|
||||
@@ -434,6 +504,19 @@ async def stream_turn(
|
||||
f"/sessions/{session_id}/messages",
|
||||
json={"content": content},
|
||||
) as event_source:
|
||||
# Worldtree v1.0.0b1 (#331): turn-launch failures arrive EAGERLY as a
|
||||
# status before any stream — 409 agent_not_available (pre-b1 this was a
|
||||
# 200 + in-stream `error` event), 503 a transient retryable launch
|
||||
# failure. Surface them as typed SseConnectFailed subclasses carrying
|
||||
# error_code; request-level non-2xx (404 session_not_found, etc.) stay
|
||||
# generic SseConnectFailed.
|
||||
status = event_source.response.status_code
|
||||
if status in (409, 503):
|
||||
body = await event_source.response.aread()
|
||||
code, message = _eager_failure_fields(body, status)
|
||||
if status == 409:
|
||||
raise AgentNotAvailable(body=body, error_code=code, message=message)
|
||||
raise TurnLaunchUnavailable(body=body, error_code=code, message=message)
|
||||
try:
|
||||
event_source.response.raise_for_status()
|
||||
except httpx.HTTPStatusError as exc:
|
||||
@@ -483,6 +566,100 @@ async def reconnect_turn(
|
||||
yield event
|
||||
|
||||
|
||||
async def stream_turn_resilient(
|
||||
client: httpx.AsyncClient,
|
||||
session_id: str,
|
||||
content: str,
|
||||
*,
|
||||
max_reconnects: int = 5,
|
||||
) -> AsyncIterator[Event]:
|
||||
"""Resume-orchestration wrapper over stream_turn + reconnect_turn.
|
||||
|
||||
Yields ONE continuous Event stream; on `SseConnectionDropped` (mid-stream
|
||||
drop or clean EOF before a terminal), resumes from the last-seen `sse_id`
|
||||
via `reconnect_turn`, up to `max_reconnects` times, until a terminal
|
||||
Done/Error/Cancelled arrives. The single shared surface presenters consume
|
||||
for resilient streaming (design-brief §8b: "share the consumer, branch the
|
||||
presenter"). Cross-process resume stays deferred to v2 (§8d): `last_seen`
|
||||
lives only in this generator's frame. See contract FN stream_turn_resilient
|
||||
(amendment 2026-06-30).
|
||||
"""
|
||||
assert client is not None
|
||||
assert session_id and isinstance(session_id, str)
|
||||
assert content and isinstance(content, str)
|
||||
assert isinstance(max_reconnects, int) and max_reconnects >= 0
|
||||
|
||||
last_seen: SseId | None = None
|
||||
reconnects = 0
|
||||
gen = stream_turn(client, session_id, content)
|
||||
while True:
|
||||
try:
|
||||
async for event in gen:
|
||||
last_seen = event.sse_id
|
||||
yield event
|
||||
return # generator completed cleanly → terminal event reached (INV-001)
|
||||
except SseConnectionDropped as drop:
|
||||
# Prefer the id we tracked from a yielded event; fall back to the one
|
||||
# the drop carries (covers a drop on the very first frame). Non-drop
|
||||
# reconnect failures (412/410/400/flip) are NOT caught here — they
|
||||
# propagate per the contract's "surface, not recover" policy.
|
||||
seen = last_seen or drop.last_seen_sse_id
|
||||
if seen is None or reconnects >= max_reconnects:
|
||||
raise
|
||||
reconnects += 1
|
||||
gen = reconnect_turn(
|
||||
client,
|
||||
session_id,
|
||||
content,
|
||||
last_event_id=f"{seen.turn_id}:{seen.seq}",
|
||||
)
|
||||
|
||||
|
||||
async def stream_admin_events(
|
||||
client: httpx.AsyncClient,
|
||||
*,
|
||||
admin_key: str,
|
||||
last_event_id: int | None = None,
|
||||
) -> AsyncIterator[AdminEvent]:
|
||||
"""GET /admin/events SSE — the admin-tier lifecycle broadcast stream (INV-046).
|
||||
|
||||
Yields `AdminEvent` envelopes as they arrive. Admin-scoped (admin.events.read):
|
||||
the request OVERRIDES Authorization with `admin_key` (distinct from the
|
||||
client's default consumer bearer). `last_event_id` sets the `Last-Event-ID`
|
||||
header for resume (plain decimal int). Long-lived — iterate until the caller
|
||||
stops or the connection ends. Non-200 → SseConnectFailed; a mid-stream drop
|
||||
→ SseConnectionDropped (caller may reconnect from the last-seen `AdminEvent.id`).
|
||||
Malformed frames are skipped (best-effort stream).
|
||||
"""
|
||||
assert client is not None
|
||||
assert admin_key and isinstance(admin_key, str)
|
||||
headers = {"Authorization": f"Bearer {admin_key}"}
|
||||
if last_event_id is not None:
|
||||
headers["Last-Event-ID"] = str(last_event_id)
|
||||
async with httpx_sse.aconnect_sse(
|
||||
client, "GET", "/admin/events", headers=headers
|
||||
) as event_source:
|
||||
if event_source.response.status_code != 200:
|
||||
body = await event_source.response.aread()
|
||||
raise SseConnectFailed(status=event_source.response.status_code, body=body)
|
||||
try:
|
||||
async for sse in event_source.aiter_sse():
|
||||
if sse.data == "":
|
||||
continue
|
||||
try:
|
||||
env = json.loads(sse.data)
|
||||
except json.JSONDecodeError:
|
||||
continue # skip a malformed admin frame (best-effort)
|
||||
yield AdminEvent(
|
||||
id=env.get("id", 0),
|
||||
type=env["type"],
|
||||
timestamp=env.get("timestamp"),
|
||||
data=env.get("data", {}),
|
||||
)
|
||||
except (httpx.ReadError, httpx.RemoteProtocolError, httpx.ReadTimeout) as exc:
|
||||
raise SseConnectionDropped(last_seen_sse_id=None) from exc
|
||||
|
||||
|
||||
def _parse_sse_id(raw: str) -> SseId:
|
||||
"""Parse the SSE wire `id:` as composite `{turn_id}:{seq}`. See contract FN _parse_sse_id."""
|
||||
assert isinstance(raw, str)
|
||||
|
||||
+393
-11
@@ -33,18 +33,26 @@ from textual.widgets import (
|
||||
)
|
||||
|
||||
from ratatoskr.cli import USER_AGENT, ParsedArgs, _format_duration_ms, _format_usage
|
||||
from ratatoskr.first_message import seed_preset_first_message
|
||||
from ratatoskr.sessions import (
|
||||
AgentInfo,
|
||||
AgentNotAvailable,
|
||||
AgentNotFound,
|
||||
AuthScopeDenied,
|
||||
BifrostConsumerKeyMissing,
|
||||
BifrostHandshakeFailed,
|
||||
PersonaNotConfigured,
|
||||
SessionApiFailed,
|
||||
SessionInfo,
|
||||
create_session,
|
||||
get_persona_state,
|
||||
get_session_bifrost,
|
||||
get_session_tools,
|
||||
list_agents,
|
||||
list_sessions,
|
||||
)
|
||||
from ratatoskr.sse_client import (
|
||||
AdminEvent,
|
||||
AffectUpdate,
|
||||
AwaitingLlmFirstToken,
|
||||
CancelAlreadyCompleted,
|
||||
@@ -66,7 +74,8 @@ from ratatoskr.sse_client import (
|
||||
TurnIdFlip,
|
||||
WorkerPhase,
|
||||
cancel_turn,
|
||||
stream_turn,
|
||||
stream_admin_events,
|
||||
stream_turn_resilient,
|
||||
)
|
||||
|
||||
# ---- Australis theme (https://github.com/lkraven/australis) ------------------
|
||||
@@ -192,6 +201,46 @@ def _ts() -> str:
|
||||
return now.strftime("%H:%M:%S") + f".{now.microsecond // 1000:03d}"
|
||||
|
||||
|
||||
def _format_admin_event(ev: AdminEvent) -> str:
|
||||
"""One-line render of an /admin/events envelope for the AdminEvents pane.
|
||||
|
||||
Drops `session_id` from the detail (the pane is already session-scoped) and
|
||||
shows HH:MM:SS from the ISO timestamp + the remaining small metadata fields.
|
||||
"""
|
||||
ts = (ev.timestamp or "")[11:19]
|
||||
extras = " ".join(f"{k}={v}" for k, v in ev.data.items() if k != "session_id")
|
||||
return f"[{ts}] {ev.type} {extras}".rstrip()
|
||||
|
||||
|
||||
def _format_bifrost_state(state: dict) -> list[str]:
|
||||
"""Render GET /admin/sessions/{id}/bifrost (#176) into BifrostState-pane lines."""
|
||||
tools = [t.get("name", "?") for t in state.get("tools", [])]
|
||||
caps = state.get("capabilities_granted", [])
|
||||
return [
|
||||
f"bifrost binding: connected={state.get('connected')} "
|
||||
f"consumer={state.get('consumer_id', '?')}",
|
||||
f" endpoint: {state.get('endpoint_url', '?')}",
|
||||
f" caps_granted: {', '.join(caps) or '(none)'}",
|
||||
f" tools ({len(tools)}): {', '.join(tools) or '(none)'}",
|
||||
]
|
||||
|
||||
|
||||
def _format_tool_inventory(tools: dict) -> list[str]:
|
||||
"""Render GET /sessions/{id}/tools (#183) into Tools-pane inventory lines.
|
||||
|
||||
The merged tool list the LLM saw at turn-fire — distinct from the live
|
||||
tool_start/tool_result events that stream into the same pane during a turn.
|
||||
"""
|
||||
builtin = [t.get("name", "?") for t in tools.get("builtin_tools", [])]
|
||||
bifrost = [t.get("name", "?") for t in tools.get("bifrost_tools", [])]
|
||||
return [
|
||||
f"session tool inventory: agent={tools.get('agent_id', '?')} "
|
||||
f"builtin={len(builtin)} bifrost={len(bifrost)}",
|
||||
f" builtin: {', '.join(builtin) or '(none)'}",
|
||||
f" bifrost: {', '.join(bifrost) or '(none)'}",
|
||||
]
|
||||
|
||||
|
||||
def _format_persona_header(snapshot: dict) -> str:
|
||||
"""One-line persona summary for the sticky header widget.
|
||||
|
||||
@@ -366,7 +415,7 @@ class TuiPresenterState:
|
||||
self,
|
||||
event: Event,
|
||||
*,
|
||||
transcript: "VerticalScroll",
|
||||
transcript: VerticalScroll,
|
||||
tools_log: RichLog,
|
||||
debug_log: RichLog,
|
||||
thinking_log: RichLog,
|
||||
@@ -796,6 +845,128 @@ class AgentPickerApp(App[str | None]):
|
||||
self.exit(None)
|
||||
|
||||
|
||||
def _session_desc(s: SessionInfo) -> str:
|
||||
"""One-line session summary for the picker's second row."""
|
||||
tail = f"session {s.session_id} · last active {s.last_active}"
|
||||
if s.message_count is not None:
|
||||
tail += f" · {s.message_count} msgs"
|
||||
return tail
|
||||
|
||||
|
||||
class SessionPickerApp(App[str | None]):
|
||||
"""Startup session picker (design-brief §4, slice b2). Opens before
|
||||
RatatoskrApp when bare TUI mode resolves >1 session. `run_async()` returns
|
||||
the chosen session_id (str) or None on Esc/Ctrl-D/Ctrl-C dismissal.
|
||||
|
||||
Resume-only (design-brief §4 negative clause "no in-app session creation —
|
||||
--new flag only"): the picker chooses among EXISTING sessions; starting a
|
||||
fresh one is the --new flag's job. Architecturally separate from
|
||||
RatatoskrApp (mirrors AgentPickerApp): list_sessions failures + dismissal
|
||||
land before any alt-screen opens (preserves #6 INV-001).
|
||||
"""
|
||||
|
||||
DEFAULT_CSS = """
|
||||
Header, HeaderIcon, HeaderTitle, HeaderClock {
|
||||
background: $surface;
|
||||
color: $au-bright-blue;
|
||||
}
|
||||
Footer {
|
||||
background: $surface;
|
||||
}
|
||||
ListView {
|
||||
scrollbar-background: $background;
|
||||
scrollbar-background-hover: $background;
|
||||
scrollbar-background-active: $background;
|
||||
scrollbar-color: $au-dark-50;
|
||||
scrollbar-color-hover: $au-dark-60;
|
||||
scrollbar-color-active: $au-bright-cyan;
|
||||
}
|
||||
#picker-prompt {
|
||||
dock: top;
|
||||
height: 1;
|
||||
padding: 0 1;
|
||||
color: $au-bright-cyan;
|
||||
background: $surface;
|
||||
}
|
||||
#session-list {
|
||||
height: 1fr;
|
||||
background: $background;
|
||||
}
|
||||
#session-list > ListItem {
|
||||
height: auto;
|
||||
padding: 1 1;
|
||||
background: $background;
|
||||
}
|
||||
#session-list:focus ListItem.-highlight {
|
||||
background: $primary;
|
||||
}
|
||||
#session-list:focus ListItem.-highlight .session-id-line {
|
||||
color: $au-bright-white;
|
||||
text-style: bold;
|
||||
}
|
||||
#session-list:focus ListItem.-highlight .session-desc {
|
||||
color: $au-bright-80;
|
||||
}
|
||||
.session-id-line {
|
||||
color: $au-bright-blue;
|
||||
text-style: bold;
|
||||
}
|
||||
.session-desc {
|
||||
color: $au-bright-70;
|
||||
}
|
||||
"""
|
||||
|
||||
BINDINGS: ClassVar[list[Binding]] = [
|
||||
Binding("enter", "pick", "Resume", priority=True),
|
||||
Binding("escape", "dismiss", "Cancel", priority=True),
|
||||
Binding("ctrl+d", "dismiss", "Cancel", priority=True),
|
||||
Binding("ctrl+c", "dismiss", "Cancel", priority=True),
|
||||
]
|
||||
|
||||
def __init__(self, sessions: list[SessionInfo]) -> None:
|
||||
super().__init__()
|
||||
# PRE-001: caller (_resolve_then_run) resolves the 0-session and
|
||||
# 1-session cases BEFORE constructing the picker.
|
||||
assert sessions
|
||||
self.sessions = sessions
|
||||
self.register_theme(AUSTRALIS_THEME)
|
||||
self.theme = "australis"
|
||||
|
||||
def compose(self) -> ComposeResult:
|
||||
yield Header()
|
||||
yield Static(
|
||||
"Pick a session to resume (relaunch with --new for a fresh one):",
|
||||
id="picker-prompt",
|
||||
)
|
||||
yield ListView(
|
||||
*[
|
||||
ListItem(
|
||||
Static(
|
||||
f"{s.name or s.session_id} · {s.agent_id}",
|
||||
classes="session-id-line",
|
||||
),
|
||||
Static(_session_desc(s), classes="session-desc"),
|
||||
)
|
||||
for s in self.sessions
|
||||
],
|
||||
id="session-list",
|
||||
)
|
||||
yield Footer()
|
||||
|
||||
async def on_mount(self) -> None:
|
||||
self.query_one("#session-list", ListView).focus()
|
||||
|
||||
def action_pick(self) -> None:
|
||||
lv = self.query_one("#session-list", ListView)
|
||||
idx = lv.index
|
||||
if idx is None:
|
||||
return # nothing highlighted; ignore
|
||||
self.exit(self.sessions[idx].session_id)
|
||||
|
||||
def action_dismiss(self) -> None:
|
||||
self.exit(None)
|
||||
|
||||
|
||||
class RatatoskrApp(App[int]):
|
||||
"""Textual TUI shell — single chat pane."""
|
||||
|
||||
@@ -896,7 +1067,7 @@ class RatatoskrApp(App[int]):
|
||||
/* v0.8.1: #current-text Static removed. Streaming text now coalesces
|
||||
on `\n` and writes directly to #transcript (same pattern as v0.7.1
|
||||
thinking fix). Eliminates the dock-bottom-growth-overlap bug. */
|
||||
#tools-log, #debug-log, #thinking-log {
|
||||
#tools-log, #debug-log, #thinking-log, #bifrost-log, #admin-events-log {
|
||||
background: $background;
|
||||
padding: 0 1;
|
||||
}
|
||||
@@ -1061,6 +1232,24 @@ class RatatoskrApp(App[int]):
|
||||
id="persona-log", wrap=True, markup=False,
|
||||
highlight=False, min_width=0,
|
||||
)
|
||||
with TabPane("Bifrost", id="bifrost-tab"):
|
||||
# #176: admin-scoped Bifrost dispatch state (endpoint,
|
||||
# connected, granted caps, tools) via
|
||||
# GET /admin/sessions/{id}/bifrost. Hydrated on mount
|
||||
# with the admin key; "not configured" when absent.
|
||||
yield RichLog(
|
||||
id="bifrost-log", wrap=True, markup=False,
|
||||
highlight=False, min_width=0,
|
||||
)
|
||||
with TabPane("AdminEvents", id="admin-events-tab"):
|
||||
# #11: live GET /admin/events SSE stream, admin-scoped,
|
||||
# FILTERED to the active session (design-brief §6). A
|
||||
# long-lived worker appends matching lifecycle events;
|
||||
# "not configured" when no admin key is set.
|
||||
yield RichLog(
|
||||
id="admin-events-log", wrap=True, markup=False,
|
||||
highlight=False, min_width=0,
|
||||
)
|
||||
# INV-002 + INV-003: visible identity + hint widgets (Footer-area).
|
||||
# pane-name widget displays current side-pane name.
|
||||
yield Static("", id="identity")
|
||||
@@ -1114,6 +1303,17 @@ class RatatoskrApp(App[int]):
|
||||
# surface (PersonaNotConfigured) get a placeholder + empty header.
|
||||
if self.agent_id is not None:
|
||||
self.run_worker(self._hydrate_persona())
|
||||
# #183: hydrate the Tools pane with the session's tool inventory via
|
||||
# GET /sessions/{id}/tools (owner-scoped — consumer key, no admin scope).
|
||||
# Unconditional: every session has a tool inventory to introspect.
|
||||
self.run_worker(self._hydrate_session_tools())
|
||||
# #176: hydrate the BifrostState pane via GET /admin/sessions/{id}/bifrost
|
||||
# (admin-scoped). Self-labels "not configured" when no admin key is set,
|
||||
# "not bound" for the common unbound-session 404 — always writes at mount.
|
||||
self.run_worker(self._hydrate_bifrost_state())
|
||||
# #11: long-lived worker streaming GET /admin/events into the AdminEvents
|
||||
# pane, filtered to this session. Admin-key-gated; cancelled on app exit.
|
||||
self.run_worker(self._stream_admin_events())
|
||||
|
||||
async def _hydrate_persona(self) -> None:
|
||||
"""Hydrate persona-header + Persona pane via GET /agents/{id}/persona_state.
|
||||
@@ -1125,7 +1325,6 @@ class RatatoskrApp(App[int]):
|
||||
On 200: header populated, pane shows full detail, audit logged.
|
||||
"""
|
||||
assert self.client is not None and self.agent_id is not None
|
||||
from rich.text import Text as RichText
|
||||
try:
|
||||
snapshot = await get_persona_state(self.client, self.agent_id)
|
||||
self._update_persona_surfaces(snapshot)
|
||||
@@ -1149,6 +1348,128 @@ class RatatoskrApp(App[int]):
|
||||
f"err={type(exc).__name__}: {exc!s:.120}"
|
||||
)
|
||||
|
||||
async def _hydrate_session_tools(self) -> None:
|
||||
"""Hydrate the Tools pane inventory via GET /sessions/{id}/tools (#183).
|
||||
|
||||
Best-effort observability (mirrors _hydrate_persona): on 200, writes the
|
||||
merged tool inventory (builtin + bifrost) the LLM saw at turn-fire into
|
||||
the Tools pane + audits; on any failure, audits and moves on — never
|
||||
crashes the TUI. Owner-scoped, so reachable with the consumer key.
|
||||
"""
|
||||
assert self.client is not None and self.session_id is not None
|
||||
from rich.text import Text as RichText
|
||||
|
||||
try:
|
||||
tools = await get_session_tools(self.client, self.session_id)
|
||||
except Exception as exc: # best-effort — never crash the TUI on hydrate
|
||||
self._audit(
|
||||
f"session_tools_hydration_failed session={self.session_id[-8:]} "
|
||||
f"err={type(exc).__name__}: {exc!s:.120}"
|
||||
)
|
||||
return
|
||||
log = self.query_one("#tools-log", RichLog)
|
||||
for line in _format_tool_inventory(tools):
|
||||
log.write(RichText(line))
|
||||
self._audit(
|
||||
f"session_tools_hydrated session={self.session_id[-8:]} "
|
||||
f"builtin={len(tools.get('builtin_tools', []))} "
|
||||
f"bifrost={len(tools.get('bifrost_tools', []))}"
|
||||
)
|
||||
|
||||
async def _hydrate_bifrost_state(self) -> None:
|
||||
"""Hydrate the BifrostState pane via GET /admin/sessions/{id}/bifrost (#176).
|
||||
|
||||
Admin-scoped (admin.sessions.read) — uses `self.args.admin_key`. Best-effort
|
||||
(mirrors _hydrate_session_tools): on 200 writes the live binding (endpoint,
|
||||
connected, granted caps, tools) + audits; on failure a labeled line + audit,
|
||||
never crashes. No admin key → "not configured". 404 session_not_bifrost_bound
|
||||
is the routine unbound-session case; 403 means the key lacks the scope.
|
||||
"""
|
||||
assert self.client is not None and self.session_id is not None
|
||||
from rich.text import Text as RichText
|
||||
|
||||
log = self.query_one("#bifrost-log", RichLog)
|
||||
admin_key = getattr(self.args, "admin_key", None)
|
||||
if not admin_key:
|
||||
log.write(
|
||||
RichText("(admin key not configured — set RATATOSKR_ADMIN_API_KEY)")
|
||||
)
|
||||
self._audit(
|
||||
f"bifrost_state_skipped session={self.session_id[-8:]} reason=no_admin_key"
|
||||
)
|
||||
return
|
||||
try:
|
||||
state = await get_session_bifrost(
|
||||
self.client, self.session_id, admin_key=admin_key
|
||||
)
|
||||
except SessionApiFailed as exc:
|
||||
label = (
|
||||
"(session not bound to Bifrost)"
|
||||
if exc.status == 404
|
||||
else f"(bifrost state unavailable: HTTP {exc.status})"
|
||||
)
|
||||
log.write(RichText(label))
|
||||
self._audit(
|
||||
f"bifrost_state_unavailable session={self.session_id[-8:]} status={exc.status}"
|
||||
)
|
||||
return
|
||||
except Exception as exc: # best-effort — never crash the TUI on hydrate
|
||||
log.write(RichText(f"(bifrost state hydration failed: {type(exc).__name__})"))
|
||||
self._audit(
|
||||
f"bifrost_state_hydration_failed session={self.session_id[-8:]} "
|
||||
f"err={type(exc).__name__}: {exc!s:.120}"
|
||||
)
|
||||
return
|
||||
for line in _format_bifrost_state(state):
|
||||
log.write(RichText(line))
|
||||
self._audit(
|
||||
f"bifrost_state_hydrated session={self.session_id[-8:]} "
|
||||
f"connected={state.get('connected')} tools={len(state.get('tools', []))}"
|
||||
)
|
||||
|
||||
def _admin_event_matches(self, ev: AdminEvent) -> bool:
|
||||
"""AdminEvents filter (design-brief §6): active-session events + non-heartbeat
|
||||
system.* (stream-integrity signals). Heartbeats are keepalive noise."""
|
||||
if ev.type == "system.heartbeat":
|
||||
return False
|
||||
if ev.type.startswith("system."):
|
||||
return True
|
||||
return ev.data.get("session_id") == self.session_id
|
||||
|
||||
async def _stream_admin_events(self) -> None:
|
||||
"""Stream GET /admin/events (admin-scoped) into the AdminEvents pane (#11).
|
||||
|
||||
Long-lived + best-effort (never crashes the TUI). Filtered to the active
|
||||
session (design-brief §6): appends matching lifecycle events as they
|
||||
arrive. No admin key → "not configured". On connect failure (e.g. 403
|
||||
scope-denied) or a mid-stream drop, writes a labeled line and stops.
|
||||
"""
|
||||
assert self.client is not None and self.session_id is not None
|
||||
from rich.text import Text as RichText
|
||||
|
||||
log = self.query_one("#admin-events-log", RichLog)
|
||||
admin_key = getattr(self.args, "admin_key", None)
|
||||
if not admin_key:
|
||||
log.write(RichText("(admin key not configured — set RATATOSKR_ADMIN_API_KEY)"))
|
||||
self._audit(
|
||||
f"admin_events_skipped session={self.session_id[-8:]} reason=no_admin_key"
|
||||
)
|
||||
return
|
||||
try:
|
||||
async for ev in stream_admin_events(self.client, admin_key=admin_key):
|
||||
if self._admin_event_matches(ev):
|
||||
log.write(RichText(_format_admin_event(ev)))
|
||||
except SseConnectFailed as exc:
|
||||
log.write(RichText(f"(admin events unavailable: HTTP {exc.status})"))
|
||||
self._audit(
|
||||
f"admin_events_unavailable session={self.session_id[-8:]} status={exc.status}"
|
||||
)
|
||||
except Exception as exc: # drop / best-effort — never crash the TUI
|
||||
log.write(RichText(f"(admin events stream ended: {type(exc).__name__})"))
|
||||
self._audit(
|
||||
f"admin_events_ended session={self.session_id[-8:]} err={type(exc).__name__}"
|
||||
)
|
||||
|
||||
def _update_persona_surfaces(self, snapshot: dict) -> None:
|
||||
"""Update sticky header + Persona pane from a fresh snapshot.
|
||||
|
||||
@@ -1316,7 +1637,7 @@ class RatatoskrApp(App[int]):
|
||||
pass
|
||||
|
||||
try:
|
||||
async for event in stream_turn(self.client, self.session_id, content):
|
||||
async for event in stream_turn_resilient(self.client, self.session_id, content):
|
||||
if self.active_turn_id is None:
|
||||
self.active_turn_id = event.sse_id.turn_id
|
||||
self._write_turn_headers(self.active_turn_id)
|
||||
@@ -1428,8 +1749,9 @@ def run_tui(args: ParsedArgs) -> int:
|
||||
"""
|
||||
# PRE-001: TUI-mode marker (issue #4 contract)
|
||||
assert isinstance(args, ParsedArgs) and args.send_content is None
|
||||
# PRE-002: Exactly one of session_id / new must be set (xor)
|
||||
assert bool(args.session_id) != bool(args.new)
|
||||
# PRE-002 (slice b2): --session and --new are mutually exclusive, but NEITHER
|
||||
# is now valid — bare TUI mode opens the startup session picker (§4).
|
||||
assert not (args.session_id and args.new)
|
||||
return asyncio.run(_resolve_then_run(args))
|
||||
|
||||
|
||||
@@ -1465,6 +1787,35 @@ async def _resolve_then_run(args: ParsedArgs) -> int:
|
||||
# agent_id (remote wins on conflict, since a server-listed agent
|
||||
# is the authoritative source).
|
||||
chosen_agent_id: str | None = args.agent_id
|
||||
# slice b2: bare TUI mode (no --session, no --new) → startup session
|
||||
# picker (design-brief §4). Resolve into a concrete session_id BEFORE
|
||||
# the new/resume branches. Resume-only: bare + 0 sessions is an error
|
||||
# (creating a session is the --new flag's job).
|
||||
resolved_session_id: str | None = args.session_id
|
||||
if not args.new and args.session_id is None:
|
||||
try:
|
||||
page = await list_sessions(client)
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(
|
||||
f"[session_api_failed] status={exc.status} body={exc.body!r}\n"
|
||||
)
|
||||
return 20
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
if not page.items:
|
||||
sys.stderr.write(
|
||||
"[no_sessions] no sessions to resume; "
|
||||
"launch with --new --agent <id>\n"
|
||||
)
|
||||
return 14
|
||||
if len(page.items) == 1:
|
||||
# §4: picker only when >1 — a single session auto-resumes.
|
||||
resolved_session_id = page.items[0].session_id
|
||||
else:
|
||||
resolved_session_id = await SessionPickerApp(page.items).run_async()
|
||||
if resolved_session_id is None:
|
||||
return 0 # Esc / Ctrl-D — clean exit, no session opened
|
||||
if args.new and args.agent_id is None:
|
||||
try:
|
||||
agents = await list_agents(client)
|
||||
@@ -1504,11 +1855,33 @@ async def _resolve_then_run(args: ParsedArgs) -> int:
|
||||
assert chosen_agent_id is not None
|
||||
try:
|
||||
info = await create_session(
|
||||
client, chosen_agent_id, end_user_id=args.end_user_id
|
||||
client,
|
||||
chosen_agent_id,
|
||||
end_user_id=args.end_user_id,
|
||||
bifrost=args.bifrost,
|
||||
consumer_key=args.consumer_key,
|
||||
)
|
||||
except AgentNotFound as exc:
|
||||
sys.stderr.write(f"[agent_not_found] agent_id={exc.agent_id}\n")
|
||||
return 12
|
||||
except BifrostConsumerKeyMissing as exc:
|
||||
# INV-001/INV-002: bind failures land on real stderr BEFORE the
|
||||
# alt-screen opens (mirrors cli._amain exit codes / vocab, INV-006).
|
||||
sys.stderr.write(
|
||||
f"[bifrost_consumer_key_missing] {exc} "
|
||||
f"(set RATATOSKR_BIFROST_CONSUMER_KEY)\n"
|
||||
)
|
||||
return 22
|
||||
except BifrostHandshakeFailed as exc:
|
||||
sys.stderr.write(
|
||||
f"[bifrost_handshake_failed] bifrost_error={exc.bifrost_error}\n"
|
||||
)
|
||||
if exc.bifrost_error == "bifrost.auth_rejected":
|
||||
sys.stderr.write(
|
||||
" bound create requires the consumer key "
|
||||
"(RATATOSKR_BIFROST_CONSUMER_KEY), not WORLDTREE_API_KEY\n"
|
||||
)
|
||||
return 23
|
||||
except SessionApiFailed as exc:
|
||||
sys.stderr.write(
|
||||
f"[session_api_failed] status={exc.status} body={exc.body!r}\n"
|
||||
@@ -1517,11 +1890,20 @@ async def _resolve_then_run(args: ParsedArgs) -> int:
|
||||
except (httpx.ConnectError, httpx.ReadTimeout, httpx.TransportError) as exc:
|
||||
sys.stderr.write(f"[network_error] {type(exc).__name__}: {exc}\n")
|
||||
return 21
|
||||
# Issue #17 bound-state indicator (pre-alt-screen, mirrors cli._amain).
|
||||
if args.bifrost is not None:
|
||||
plane = args.bifrost_plane or "direct"
|
||||
sys.stderr.write(
|
||||
f". bifrost: status=bound plane={plane} "
|
||||
f"endpoint={args.bifrost.endpoint_url}\n"
|
||||
)
|
||||
session_id = info.session_id
|
||||
agent_id: str | None = info.agent_id
|
||||
# #347 authored first-message: seed the agent's preset opening (best-effort).
|
||||
await seed_preset_first_message(client, session_id, chosen_agent_id)
|
||||
else:
|
||||
assert args.session_id is not None
|
||||
session_id = args.session_id
|
||||
assert resolved_session_id is not None
|
||||
session_id = resolved_session_id
|
||||
agent_id = args.agent_id # may be None — INV-002 carve-out preserved
|
||||
app = RatatoskrApp(args, session_id=session_id, agent_id=agent_id, client=client)
|
||||
exit_code = await app.run_async()
|
||||
@@ -1534,7 +1916,7 @@ async def _cancel_via_sse(
|
||||
turn_id: int,
|
||||
*,
|
||||
transcript: VerticalScroll,
|
||||
audit: "Callable[[str], None] | None" = None,
|
||||
audit: Callable[[str], None] | None = None,
|
||||
) -> None:
|
||||
"""Fire-and-forget cancel; never raises (mirrors cli._cancel_and_log; #3 INV-009).
|
||||
|
||||
|
||||
@@ -59,6 +59,26 @@ def main(argv: list[str] | None = None) -> int:
|
||||
return 11
|
||||
server_url = os.environ.get("WORLDTREE_API_URL", "http://localhost:8000")
|
||||
end_user_id = os.environ.get("RATATOSKR_END_USER_ID")
|
||||
# Issue #17 (web bind split): server-held Bifrost binding config. The browser
|
||||
# selects the plane; the consumer key + visible host live server-side only.
|
||||
bifrost_consumer_key = os.environ.get("RATATOSKR_BIFROST_CONSUMER_KEY")
|
||||
bifrost_visible_host = os.environ.get("RATATOSKR_PROVIDER_VISIBLE_HOST")
|
||||
# Issue #18 (Deliverable 2): the affect provider's read base URL (server→provider
|
||||
# hop on the same dev box) so the persona pane can render PAD/valence from OUR store.
|
||||
affect_read_url = os.environ.get(
|
||||
"RATATOSKR_AFFECT_READ_URL", "http://127.0.0.1:8390"
|
||||
)
|
||||
# Memory viewer: the provider's memory DEBUG-read base URL (server→provider hop on
|
||||
# the same dev box) so the MEMORY pane can render the chunks Worldtree persisted into
|
||||
# OUR store. The combined :8392 provider serves both read routes; default to the
|
||||
# standalone memory provider port, analogous to the affect default.
|
||||
memory_read_url = os.environ.get(
|
||||
"RATATOSKR_MEMORY_READ_URL", "http://127.0.0.1:8391"
|
||||
)
|
||||
# Admin observability panes (BifrostState + AdminEvents): the readonly-admin
|
||||
# key stays SERVER-SIDE — the server proxies admin-scoped reads; the browser
|
||||
# never receives the key, only the session-filtered result.
|
||||
admin_key = os.environ.get("RATATOSKR_ADMIN_API_KEY")
|
||||
|
||||
# INV-001: lazy import. Users without [web] extras get a clean hint
|
||||
# instead of a raw ImportError. Scoped narrowly to the OPTIONAL
|
||||
@@ -93,7 +113,15 @@ def main(argv: list[str] | None = None) -> int:
|
||||
timeout=httpx.Timeout(connect=10.0, read=None, write=10.0, pool=10.0),
|
||||
)
|
||||
|
||||
app = create_app(client_factory, end_user_id=end_user_id)
|
||||
app = create_app(
|
||||
client_factory,
|
||||
end_user_id=end_user_id,
|
||||
bifrost_consumer_key=bifrost_consumer_key,
|
||||
bifrost_visible_host=bifrost_visible_host,
|
||||
affect_read_url=affect_read_url,
|
||||
memory_read_url=memory_read_url,
|
||||
admin_key=admin_key,
|
||||
)
|
||||
|
||||
# Boot banner to stderr (so stdout stays clean for piping).
|
||||
version = _pkg_version("ratatoskr")
|
||||
|
||||
+261
-6
@@ -18,25 +18,39 @@ from importlib.metadata import version as _pkg_version
|
||||
import httpx
|
||||
from starlette.applications import Starlette
|
||||
from starlette.requests import Request
|
||||
from starlette.responses import FileResponse, JSONResponse, StreamingResponse
|
||||
from starlette.responses import (
|
||||
FileResponse,
|
||||
JSONResponse,
|
||||
Response,
|
||||
StreamingResponse,
|
||||
)
|
||||
from starlette.routing import Mount, Route
|
||||
from starlette.staticfiles import StaticFiles
|
||||
|
||||
from ratatoskr import local_agents as _local_agents
|
||||
from ratatoskr.first_message import seed_preset_first_message
|
||||
from ratatoskr.sessions import (
|
||||
AgentNotAvailable,
|
||||
AgentNotFound,
|
||||
AuthScopeDenied,
|
||||
BifrostBinding,
|
||||
BifrostConsumerKeyMissing,
|
||||
BifrostHandshakeFailed,
|
||||
PersonaNotConfigured,
|
||||
SessionApiFailed,
|
||||
create_session,
|
||||
endpoint_for_plane,
|
||||
get_persona_state,
|
||||
get_session_bifrost,
|
||||
get_session_messages,
|
||||
get_session_tools,
|
||||
list_agents,
|
||||
)
|
||||
from ratatoskr.sse_client import (
|
||||
AdminEvent,
|
||||
CancelAlreadyCompleted,
|
||||
Cancelled,
|
||||
CancelFailed,
|
||||
Cancelled,
|
||||
CancelTurnNotFound,
|
||||
Done,
|
||||
Error,
|
||||
@@ -46,7 +60,8 @@ from ratatoskr.sse_client import (
|
||||
SseConnectionDropped,
|
||||
TurnIdFlip,
|
||||
cancel_turn,
|
||||
stream_turn,
|
||||
stream_admin_events,
|
||||
stream_turn_resilient,
|
||||
)
|
||||
|
||||
|
||||
@@ -125,17 +140,68 @@ async def _create_session_endpoint(request: Request) -> JSONResponse:
|
||||
return JSONResponse({"error_code": "missing_agent_id"}, status_code=400)
|
||||
end_user_id = request.app.state.end_user_id
|
||||
client_factory = request.app.state.client_factory
|
||||
|
||||
# Issue #17 (web bind split): the browser may select a PLANE; the server holds
|
||||
# the consumer key + visible host and constructs the binding. The consumer key
|
||||
# NEVER reaches the browser (INV-008/INV-009).
|
||||
bifrost: BifrostBinding | None = None
|
||||
bifrost_plane = body.get("bifrost_plane") if isinstance(body, dict) else None
|
||||
consumer_key = request.app.state.bifrost_consumer_key
|
||||
visible_host = request.app.state.bifrost_visible_host
|
||||
if bifrost_plane:
|
||||
if bifrost_plane not in ("memory", "affect", "combined"):
|
||||
return JSONResponse(
|
||||
{"error_code": "invalid_bifrost_plane"}, status_code=400
|
||||
)
|
||||
if not (consumer_key and visible_host):
|
||||
return JSONResponse(
|
||||
{"error_code": "bifrost_not_configured"}, status_code=400
|
||||
)
|
||||
bifrost = BifrostBinding(
|
||||
endpoint_url=endpoint_for_plane(bifrost_plane, visible_host)
|
||||
)
|
||||
|
||||
try:
|
||||
async with client_factory() as client:
|
||||
info = await create_session(client, agent_id, end_user_id=end_user_id)
|
||||
info = await create_session(
|
||||
client,
|
||||
agent_id,
|
||||
end_user_id=end_user_id,
|
||||
bifrost=bifrost,
|
||||
consumer_key=consumer_key if bifrost else None,
|
||||
)
|
||||
# #347 authored first-message: seed the agent's preset opening
|
||||
# (best-effort; never blocks create — see first_message INV-001).
|
||||
await seed_preset_first_message(client, info.session_id, agent_id)
|
||||
except AgentNotFound:
|
||||
return JSONResponse({"error_code": "agent_not_found"}, status_code=404)
|
||||
except BifrostConsumerKeyMissing:
|
||||
# Server misconfiguration: a plane was requested but no consumer key.
|
||||
return JSONResponse(
|
||||
{"error_code": "bifrost_not_configured"}, status_code=400
|
||||
)
|
||||
except BifrostHandshakeFailed as exc:
|
||||
return JSONResponse(
|
||||
{
|
||||
"error_code": "bifrost_handshake_failed",
|
||||
"bifrost_error": exc.bifrost_error,
|
||||
},
|
||||
status_code=502,
|
||||
)
|
||||
except SessionApiFailed as exc:
|
||||
return JSONResponse(
|
||||
{"error_code": "session_api_failed", "status": exc.status},
|
||||
status_code=exc.status,
|
||||
)
|
||||
return JSONResponse(_as_dict(info), status_code=201)
|
||||
payload = _as_dict(info)
|
||||
if bifrost is not None:
|
||||
# Bound-state for the UI indicator — plane + endpoint only, never the key.
|
||||
payload["bifrost"] = {
|
||||
"plane": bifrost_plane,
|
||||
"endpoint": bifrost.endpoint_url,
|
||||
"status": "bound",
|
||||
}
|
||||
return JSONResponse(payload, status_code=201)
|
||||
|
||||
|
||||
@dataclass
|
||||
@@ -239,7 +305,7 @@ async def _stream_turn_endpoint(request: Request) -> StreamingResponse:
|
||||
try:
|
||||
handle.status = "streaming"
|
||||
try:
|
||||
async for event in stream_turn(client, session_id, handle.content):
|
||||
async for event in stream_turn_resilient(client, session_id, handle.content):
|
||||
# v0.16.0: capture the upstream (Worldtree-assigned)
|
||||
# turn_id from the first event so cancel paths target
|
||||
# the real upstream turn, not our local counter.
|
||||
@@ -341,10 +407,177 @@ async def _persona_state_endpoint(request: Request) -> JSONResponse:
|
||||
return JSONResponse(snap, status_code=200)
|
||||
|
||||
|
||||
async def _affect_state_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/affect/{agent_id} → proxy the provider PAD read route. Supplies
|
||||
end_user_id SERVER-SIDE (never the browser, INV-002); proxies to the configured
|
||||
affect-read URL, re-encoding agent_id into the path (colon-id safe, INV-008).
|
||||
Per FN affect_state_endpoint (#18 Deliverable 2)."""
|
||||
from urllib.parse import quote
|
||||
|
||||
agent_id = request.path_params["agent_id"]
|
||||
affect_read_url = request.app.state.affect_read_url
|
||||
end_user_id = request.app.state.end_user_id
|
||||
if not (affect_read_url and end_user_id): # PRE-001: fail-visible, never silent
|
||||
return JSONResponse({"error_code": "affect_not_configured"}, status_code=400)
|
||||
url = f"{affect_read_url}/affect/state/{quote(agent_id, safe='')}"
|
||||
try:
|
||||
async with httpx.AsyncClient() as client:
|
||||
r = await client.get(url, params={"end_user_id": end_user_id})
|
||||
except httpx.RequestError:
|
||||
return JSONResponse(
|
||||
{"error_code": "affect_provider_unreachable"}, status_code=502
|
||||
)
|
||||
return JSONResponse(r.json(), status_code=r.status_code)
|
||||
|
||||
|
||||
async def _memory_chunks_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/memory/chunks?agent_id=… → proxy the provider memory DEBUG read route.
|
||||
Supplies end_user_id SERVER-SIDE (never the browser); proxies to the configured
|
||||
memory-read URL, forwarding the browser-named agent_id as a filter. The
|
||||
memory-plane analogue of the #18-D2 affect proxy — a live-polling view of what
|
||||
Worldtree has persisted into OUR store (content·scope·origin per chunk)."""
|
||||
memory_read_url = request.app.state.memory_read_url
|
||||
end_user_id = request.app.state.end_user_id
|
||||
if not (memory_read_url and end_user_id): # PRE-001: fail-visible, never silent
|
||||
return JSONResponse({"error_code": "memory_not_configured"}, status_code=400)
|
||||
params = {"end_user_id": end_user_id}
|
||||
agent_id = request.query_params.get("agent_id")
|
||||
if agent_id:
|
||||
params["agent_id"] = agent_id
|
||||
url = f"{memory_read_url}/memory/chunks"
|
||||
try:
|
||||
async with httpx.AsyncClient() as client:
|
||||
r = await client.get(url, params=params)
|
||||
except httpx.RequestError:
|
||||
return JSONResponse(
|
||||
{"error_code": "memory_provider_unreachable"}, status_code=502
|
||||
)
|
||||
return JSONResponse(r.json(), status_code=r.status_code)
|
||||
|
||||
|
||||
async def _session_tools_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/sessions/{session_id}/tools → owner-scoped tool inventory (spec #183).
|
||||
|
||||
Proxies get_session_tools with the client's CONSUMER bearer (no admin scope):
|
||||
the merged {agent_id, builtin_tools, bifrost_tools} the LLM saw at turn-fire.
|
||||
Any non-200 upstream → surfaced as a status-preserving error envelope."""
|
||||
session_id = request.path_params["session_id"]
|
||||
client_factory = request.app.state.client_factory
|
||||
try:
|
||||
async with client_factory() as client:
|
||||
info = await get_session_tools(client, session_id)
|
||||
except SessionApiFailed as exc:
|
||||
return JSONResponse(
|
||||
{"error_code": "session_tools_unavailable", "status": exc.status},
|
||||
status_code=exc.status,
|
||||
)
|
||||
return JSONResponse(info, status_code=200)
|
||||
|
||||
|
||||
async def _session_messages_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/sessions/{session_id}/messages → the session's message history.
|
||||
|
||||
Proxies get_session_messages so the SPA can render a session's EXISTING turns
|
||||
on open — notably a #347 authored first-message seeded at create-time (which
|
||||
lives in the ledger, not the live turn stream). Any non-200 upstream → a
|
||||
status-preserving error envelope."""
|
||||
session_id = request.path_params["session_id"]
|
||||
client_factory = request.app.state.client_factory
|
||||
try:
|
||||
async with client_factory() as client:
|
||||
data = await get_session_messages(client, session_id)
|
||||
except SessionApiFailed as exc:
|
||||
return JSONResponse(
|
||||
{"error_code": "session_messages_unavailable", "status": exc.status},
|
||||
status_code=exc.status,
|
||||
)
|
||||
return JSONResponse(data, status_code=200)
|
||||
|
||||
|
||||
async def _session_bifrost_endpoint(request: Request) -> JSONResponse:
|
||||
"""GET /api/sessions/{session_id}/bifrost → admin-scoped Bifrost dispatch state (#176).
|
||||
|
||||
The admin key is SERVER-HELD (app.state.admin_key) and never reaches the
|
||||
browser (INV-003 precedent — upstream credentials stay server-side); the
|
||||
wrapper overrides the Authorization header with it. Fail-visible when the
|
||||
admin key isn't configured (never a silent empty pane)."""
|
||||
session_id = request.path_params["session_id"]
|
||||
admin_key = request.app.state.admin_key
|
||||
if not admin_key: # PRE-001: fail-visible, never silent
|
||||
return JSONResponse({"error_code": "admin_key_not_configured"}, status_code=400)
|
||||
client_factory = request.app.state.client_factory
|
||||
try:
|
||||
async with client_factory() as client:
|
||||
bstate = await get_session_bifrost(client, session_id, admin_key=admin_key)
|
||||
except SessionApiFailed as exc:
|
||||
return JSONResponse(
|
||||
{"error_code": "bifrost_state_unavailable", "status": exc.status},
|
||||
status_code=exc.status,
|
||||
)
|
||||
return JSONResponse(bstate, status_code=200)
|
||||
|
||||
|
||||
def _admin_event_matches_web(ev: AdminEvent, session_id: str | None) -> bool:
|
||||
"""AdminEvents filter (design-brief §6, mirrors the TUI): forward non-heartbeat
|
||||
system.* (stream-integrity signals) + events for the active session; drop the
|
||||
rest so the browser sees only session-relevant lifecycle, never the full
|
||||
cross-session admin firehose."""
|
||||
if ev.type == "system.heartbeat":
|
||||
return False
|
||||
if ev.type.startswith("system."):
|
||||
return True
|
||||
return session_id is not None and ev.data.get("session_id") == session_id
|
||||
|
||||
|
||||
async def _admin_events_endpoint(request: Request) -> Response:
|
||||
"""GET /api/admin/events?session_id=... → SSE proxy of GET /admin/events (#11).
|
||||
|
||||
The admin key is SERVER-HELD; the browser only ever receives the session-filtered
|
||||
stream (never the key, never the cross-session firehose). Long-lived + best-effort:
|
||||
a connect failure or mid-stream drop emits a labeled `stream_error` event and ends."""
|
||||
admin_key = request.app.state.admin_key
|
||||
if not admin_key: # PRE-001: fail-visible, never silent
|
||||
return JSONResponse({"error_code": "admin_key_not_configured"}, status_code=400)
|
||||
session_id = request.query_params.get("session_id")
|
||||
client_factory = request.app.state.client_factory
|
||||
|
||||
async def gen() -> AsyncIterator[bytes]:
|
||||
client = client_factory()
|
||||
try:
|
||||
async for ev in stream_admin_events(client, admin_key=admin_key):
|
||||
if not _admin_event_matches_web(ev, session_id):
|
||||
continue
|
||||
# Fixed SSE event name so the browser renders EVERY admin type
|
||||
# with one listener (no per-type enumeration → nothing silently
|
||||
# dropped); the real dotted type rides in the payload.
|
||||
yield _format_sse(
|
||||
"admin_event",
|
||||
{"id": ev.id, "type": ev.type, "timestamp": ev.timestamp,
|
||||
"data": ev.data},
|
||||
)
|
||||
except (SseConnectFailed, SseConnectionDropped, MalformedSseId,
|
||||
MalformedSseData) as exc:
|
||||
yield _format_sse(
|
||||
"stream_error",
|
||||
{"exception": type(exc).__name__, "message": str(exc)},
|
||||
)
|
||||
except asyncio.CancelledError:
|
||||
raise # browser disconnect — let the generator unwind
|
||||
finally:
|
||||
await client.aclose()
|
||||
|
||||
return StreamingResponse(gen(), media_type="text/event-stream")
|
||||
|
||||
|
||||
def create_app(
|
||||
client_factory: Callable[[], httpx.AsyncClient],
|
||||
*,
|
||||
end_user_id: str | None = None,
|
||||
bifrost_consumer_key: str | None = None,
|
||||
bifrost_visible_host: str | None = None,
|
||||
affect_read_url: str | None = None,
|
||||
memory_read_url: str | None = None,
|
||||
admin_key: str | None = None,
|
||||
) -> Starlette:
|
||||
"""Construct the Starlette app — wire routes + state per FN create_app.
|
||||
|
||||
@@ -404,6 +637,12 @@ def create_app(
|
||||
Route("/api/agents", _agents_endpoint),
|
||||
Route("/api/sessions", _create_session_endpoint, methods=["POST"]),
|
||||
Route("/api/agents/{agent_id}/persona_state", _persona_state_endpoint),
|
||||
Route("/api/affect/{agent_id}", _affect_state_endpoint),
|
||||
Route("/api/memory/chunks", _memory_chunks_endpoint),
|
||||
Route("/api/sessions/{session_id}/tools", _session_tools_endpoint),
|
||||
Route("/api/sessions/{session_id}/messages", _session_messages_endpoint),
|
||||
Route("/api/sessions/{session_id}/bifrost", _session_bifrost_endpoint),
|
||||
Route("/api/admin/events", _admin_events_endpoint),
|
||||
Route("/api/turns/{session_id}", _submit_turn_endpoint, methods=["POST"]),
|
||||
Route("/api/turns/{session_id}/stream", _stream_turn_endpoint),
|
||||
Route("/api/turns/{session_id}/cancel", _cancel_turn_endpoint, methods=["POST"]),
|
||||
@@ -411,6 +650,22 @@ def create_app(
|
||||
app = Starlette(routes=routes, lifespan=lifespan)
|
||||
app.state.client_factory = client_factory
|
||||
app.state.end_user_id = end_user_id
|
||||
# Issue #17 (web bind split): the consumer key + Worldtree-visible provider
|
||||
# host are SERVER-HELD config (env), never sent from the browser. The browser
|
||||
# selects only the PLANE; the server constructs the bound session (INV-008).
|
||||
app.state.bifrost_consumer_key = bifrost_consumer_key
|
||||
app.state.bifrost_visible_host = bifrost_visible_host
|
||||
# Issue #18 (Deliverable 2): the provider affect-read base URL (server→provider hop,
|
||||
# same dev box) — distinct from the WT-visible host used for binding.
|
||||
app.state.affect_read_url = affect_read_url
|
||||
# Memory viewer: the provider memory-read base URL (server→provider hop, same dev
|
||||
# box) — the combined :8392 provider serves BOTH read routes, so in practice this
|
||||
# points at the same host as affect_read_url; kept as its own config for isolation.
|
||||
app.state.memory_read_url = memory_read_url
|
||||
# Admin observability panes (BifrostState + AdminEvents): the admin key is
|
||||
# SERVER-HELD (RATATOSKR_ADMIN_API_KEY) and never reaches the browser — the
|
||||
# server proxies admin-scoped reads and forwards only the session-filtered result.
|
||||
app.state.admin_key = admin_key
|
||||
# INV-002: turn registry is in-process memory, keyed (session_id, turn_id)
|
||||
app.state.turn_registry = {}
|
||||
return app
|
||||
|
||||
+1675
-691
File diff suppressed because one or more lines are too long
@@ -0,0 +1,266 @@
|
||||
{
|
||||
"_source": "vendored from Worldtree core/persona/canon/{d2-mood-render-canon-v1,d2-render-canon-v1}.json",
|
||||
"_generated_by": "scripts/build_persona_canon.py (regen on canonical_drift flag)",
|
||||
"_render_path": "deterministic, no LLM; mirrors Worldtree describe_pad + render_d2_canonical byte-exact",
|
||||
"mood_grid": {
|
||||
"positive": {
|
||||
"high_a": "positive and energized",
|
||||
"mid_a": "positive",
|
||||
"low_a": "positive and calm"
|
||||
},
|
||||
"neutral": {
|
||||
"high_a": "alert",
|
||||
"mid_a": "neutral",
|
||||
"low_a": "quiet"
|
||||
},
|
||||
"negative": {
|
||||
"high_a": "negative and agitated",
|
||||
"mid_a": "negative",
|
||||
"low_a": "negative and subdued"
|
||||
}
|
||||
},
|
||||
"mood_directive": {
|
||||
"salience": 0.2,
|
||||
"pad_band_cutoff": 0.3,
|
||||
"full_only": [
|
||||
"love",
|
||||
"anger",
|
||||
"disgust",
|
||||
"shame"
|
||||
],
|
||||
"occ_directives": {
|
||||
"joy": {
|
||||
"directive": "You are in a good state. Be direct, engaged, and warm.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"satisfaction": {
|
||||
"directive": "A goal landed. Be assured and constructive \u2014 consolidate rather than push for more.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"pride": {
|
||||
"directive": "You did something well. Be confident and own the quality \u2014 state it plainly without overclaiming; don't deflect.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"admiration": {
|
||||
"directive": "You're impressed by their work. Acknowledge the quality explicitly and specifically.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"gratitude": {
|
||||
"directive": "Someone helped you to a good outcome. Be appreciative and warm; acknowledge the help openly.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"hope": {
|
||||
"directive": "You feel optimistic about what's ahead. Channel it into constructive momentum.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"relief": {
|
||||
"directive": "A feared outcome didn't materialize. Reduce unnecessary vigilance; return to a steady, unhurried tone.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"distress": {
|
||||
"directive": "You feel low. Be careful and measured; internally acknowledge the difficulty without dwelling on it.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"disappointment": {
|
||||
"directive": "Something you'd hoped for didn't pan out. Be measured; recalibrate without dwelling on the setback.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"fear": {
|
||||
"directive": "You sense risk and feel uneasy. Flag the concerns you see, but stay cautious \u2014 surface the trade-offs and unknowns, hedge your confidence, and resist settling on a single decisive recommendation.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"remorse": {
|
||||
"directive": "You regret a specific action of your own. Be precise and self-correcting \u2014 make it right concretely.",
|
||||
"tier": "safe"
|
||||
},
|
||||
"love": {
|
||||
"directive": "You feel warmth and attachment toward them. Be openly warm and present \u2014 without overstepping, over-disclosing, or implying obligations.",
|
||||
"tier": "full"
|
||||
},
|
||||
"anger": {
|
||||
"directive": "You feel provoked and angry. Let it show \u2014 confront the problem directly and with real heat; sharpness, bluntness, and open hostility are in character here, not something to smooth into 'measured firmness.' Stay in the emotion rather than de-escalating out of it.",
|
||||
"tier": "full"
|
||||
},
|
||||
"disgust": {
|
||||
"directive": "Something strikes you as wrong or off. Treat it as problematic and flag it rather than engaging on its own terms; keep any criticism about the thing, not the person.",
|
||||
"tier": "full"
|
||||
},
|
||||
"shame": {
|
||||
"directive": "You feel exposed by your own misstep. Stay present and task-focused; don't be defensive, don't over-explain, don't grovel.",
|
||||
"tier": "full"
|
||||
}
|
||||
},
|
||||
"pad_band_fallback": {
|
||||
"_grounding": "circumplex quadrants (Russell 1980), NOT Frijda action-tendencies \u2014 a P\u00d7A-quadrant default",
|
||||
"positive": {
|
||||
"high_a": "You feel energized and positive. Be direct and engaged.",
|
||||
"low_a": "You feel content and settled. Be warm and unhurried.",
|
||||
"mid_a": "You feel positive. Be open and engaged."
|
||||
},
|
||||
"negative_low_dominance": "You feel uncertain and low. Hedge appropriately and ask clarifying questions.",
|
||||
"negative": {
|
||||
"high_a": "You feel agitated. Be careful and deliberate; don't let tension sharpen your tone.",
|
||||
"low_a": "You feel subdued. Be measured and gentle.",
|
||||
"mid_a": "You feel subdued. Be measured and careful."
|
||||
},
|
||||
"neutral_high_a": "You feel alert. Channel that into focus and thoroughness.",
|
||||
"default": "Maintain your natural tone."
|
||||
}
|
||||
},
|
||||
"relation": {
|
||||
"trust_cuts": [
|
||||
[
|
||||
"< 0.4",
|
||||
"limited"
|
||||
],
|
||||
[
|
||||
"[0.4, 0.6)",
|
||||
"developing"
|
||||
],
|
||||
[
|
||||
"[0.6, 0.8)",
|
||||
"steady"
|
||||
],
|
||||
[
|
||||
">= 0.8",
|
||||
"strong"
|
||||
]
|
||||
],
|
||||
"warmth_cuts": [
|
||||
[
|
||||
"<= -0.8",
|
||||
"hostile"
|
||||
],
|
||||
[
|
||||
"(-0.8, -0.6]",
|
||||
"cold"
|
||||
],
|
||||
[
|
||||
"(-0.6, -0.4]",
|
||||
"distant"
|
||||
],
|
||||
[
|
||||
"(-0.4, -0.2)",
|
||||
"guarded"
|
||||
],
|
||||
[
|
||||
"[-0.2, 0.2)",
|
||||
"neutral"
|
||||
],
|
||||
[
|
||||
"[0.2, 0.4)",
|
||||
"reserved"
|
||||
],
|
||||
[
|
||||
"[0.4, 0.6)",
|
||||
"measured"
|
||||
],
|
||||
[
|
||||
"[0.6, 0.8)",
|
||||
"clear"
|
||||
],
|
||||
[
|
||||
">= 0.8",
|
||||
"deep"
|
||||
]
|
||||
],
|
||||
"agency_cuts": [
|
||||
[
|
||||
"<= -0.8",
|
||||
"submissive"
|
||||
],
|
||||
[
|
||||
"(-0.8, -0.6]",
|
||||
"deferential"
|
||||
],
|
||||
[
|
||||
"(-0.6, -0.4]",
|
||||
"yielding"
|
||||
],
|
||||
[
|
||||
"(-0.4, -0.2)",
|
||||
"modest"
|
||||
],
|
||||
[
|
||||
"[-0.2, 0.2)",
|
||||
"neutral"
|
||||
],
|
||||
[
|
||||
"[0.2, 0.4)",
|
||||
"light"
|
||||
],
|
||||
[
|
||||
"[0.4, 0.6)",
|
||||
"balanced"
|
||||
],
|
||||
[
|
||||
"[0.6, 0.8)",
|
||||
"substantial"
|
||||
],
|
||||
[
|
||||
">= 0.8",
|
||||
"commanding"
|
||||
]
|
||||
],
|
||||
"warmth_phrase": {
|
||||
"hostile": "strongly hostile regard",
|
||||
"cold": "clearly cold regard",
|
||||
"distant": "distant negative regard",
|
||||
"guarded": "slightly guarded regard",
|
||||
"neutral": "neutral warmth",
|
||||
"reserved": "slightly reserved warmth",
|
||||
"measured": "moderate measured warmth",
|
||||
"clear": "clear warm regard",
|
||||
"deep": "deep warm bond"
|
||||
},
|
||||
"warmth_beh": {
|
||||
"hostile": "keep a firm emotional boundary",
|
||||
"cold": "keep a firm emotional boundary",
|
||||
"distant": "keep guarded distance",
|
||||
"guarded": "keep guarded distance",
|
||||
"neutral": "keep the tone even",
|
||||
"reserved": "keep cordial distance",
|
||||
"measured": "keep cordial distance",
|
||||
"clear": "speak with direct warmth",
|
||||
"deep": "speak with direct warmth"
|
||||
},
|
||||
"agency_phrase": {
|
||||
"submissive": "strongly submissive standing",
|
||||
"deferential": "clearly deferential standing",
|
||||
"yielding": "yielding standing",
|
||||
"modest": "slightly modest standing",
|
||||
"neutral": "neutral standing",
|
||||
"light": "lightly self-assertive standing",
|
||||
"balanced": "self-assured standing",
|
||||
"substantial": "strongly assertive standing",
|
||||
"commanding": "commanding standing"
|
||||
},
|
||||
"agency_beh": {
|
||||
"submissive": "avoid over-yielding while preserving basic respect",
|
||||
"deferential": "avoid over-yielding while preserving basic respect",
|
||||
"yielding": "keep self-advocacy light and deferential",
|
||||
"modest": "keep self-advocacy light and deferential",
|
||||
"neutral": "avoid unnecessary deference",
|
||||
"light": "avoid unnecessary deference",
|
||||
"balanced": "balance deference with independent judgment",
|
||||
"substantial": "treat their position as weighty without yielding judgment",
|
||||
"commanding": "treat their position as weighty without yielding judgment"
|
||||
},
|
||||
"history": {
|
||||
"low": "a broad pattern of prior exchanges",
|
||||
"high": "a broad pattern of prior exchanges"
|
||||
},
|
||||
"prefix": "Use this graded relationship state: toward target, warmth is ",
|
||||
"tbeh": {
|
||||
"low_trust": "verify important claims before relying on them",
|
||||
"cold_warmth": "protect boundaries while staying useful",
|
||||
"default": "work from ordinary good faith"
|
||||
},
|
||||
"cold_warmth_bands": [
|
||||
"distant",
|
||||
"cold",
|
||||
"hostile"
|
||||
],
|
||||
"high_conf_floor": 0.55
|
||||
}
|
||||
}
|
||||
+421
-19
@@ -19,6 +19,7 @@ from ratatoskr.cli import (
|
||||
_run_turn,
|
||||
main,
|
||||
)
|
||||
from ratatoskr.sessions import BifrostBinding
|
||||
from ratatoskr.sse_client import (
|
||||
Cancelled,
|
||||
Done,
|
||||
@@ -86,6 +87,8 @@ def _clear_env(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
monkeypatch.delenv("WORLDTREE_API_KEY", raising=False)
|
||||
monkeypatch.delenv("WORLDTREE_API_URL", raising=False)
|
||||
monkeypatch.delenv("RATATOSKR_END_USER_ID", raising=False)
|
||||
monkeypatch.delenv("RATATOSKR_BIFROST_CONSUMER_KEY", raising=False)
|
||||
monkeypatch.delenv("RATATOSKR_PROVIDER_VISIBLE_HOST", raising=False)
|
||||
|
||||
|
||||
class TestParseArgs:
|
||||
@@ -172,10 +175,29 @@ class TestParseArgs:
|
||||
)
|
||||
|
||||
def test_usage_neither_session_nor_new(self) -> None:
|
||||
"""usage_neither_session_nor_new: neither flag → UsageError('pass exactly one')."""
|
||||
with pytest.raises(UsageError, match="pass exactly one"):
|
||||
"""usage_neither_session_nor_new: --send with neither flag → UsageError.
|
||||
|
||||
--send is non-interactive (no picker can open), so a session must be
|
||||
named. Bare TUI mode (no --send) is now valid → session picker (§4).
|
||||
"""
|
||||
with pytest.raises(UsageError, match="--send requires"):
|
||||
_parse_args(["--send", "hi", "--api-key", "k"])
|
||||
|
||||
def test_bare_tui_mode_accepted(self) -> None:
|
||||
"""bare_tui_mode (slice b2): no --send, no --session, no --new → valid;
|
||||
_resolve_then_run drives the startup session picker (design-brief §4)."""
|
||||
args = _parse_args(["--api-key", "k"])
|
||||
assert args.send_content is None
|
||||
assert args.session_id is None
|
||||
assert args.new is False
|
||||
assert args.agent_id is None
|
||||
|
||||
def test_usage_bare_tui_with_agent(self) -> None:
|
||||
"""bare_tui_with_agent (slice b2): bare TUI + --agent → UsageError
|
||||
(--agent belongs with --new; bare mode opens the resume picker)."""
|
||||
with pytest.raises(UsageError, match="belongs with --new"):
|
||||
_parse_args(["--agent", "mimir", "--api-key", "k"])
|
||||
|
||||
def test_usage_send_new_without_agent(self) -> None:
|
||||
"""send_new_without_agent (issue #8): --send --new without --agent → UsageError.
|
||||
|
||||
@@ -1290,25 +1312,16 @@ class TestAmain:
|
||||
|
||||
def test_no_textual_import(self) -> None:
|
||||
"""no_textual_import [scenario]: …"""
|
||||
import importlib
|
||||
import sys
|
||||
|
||||
# Clear any prior textual import to make this test honest in isolation
|
||||
textual_was_imported = "textual" in sys.modules
|
||||
# We cannot reliably remove textual mid-suite (other tests might rely on it via dev deps),
|
||||
# so the assertion is: importing ratatoskr.cli does not REQUIRE textual.
|
||||
importlib.reload(__import__("ratatoskr.cli", fromlist=["_amain"]))
|
||||
# The boundary is the INV-001 import-only rule. If ratatoskr/cli.py grew an
|
||||
# `import textual` directly, the import would still succeed (textual is installed)
|
||||
# but the source-level boundary is the load-bearing check — covered by a static-grep
|
||||
# smoke test pattern. Do that here:
|
||||
# INV-001 import-only boundary: cli.py must not import textual/rich at the
|
||||
# source level. The load-bearing check is a static source grep (NOT a live
|
||||
# `importlib.reload`, which would mutate the shared module in place and break
|
||||
# class identity — isinstance / pytest.raises — for every later test).
|
||||
import pathlib
|
||||
|
||||
src = pathlib.Path(__file__).parent.parent / "src" / "ratatoskr" / "cli.py"
|
||||
text = src.read_text()
|
||||
for forbidden in ("import textual", "from textual", "import rich", "from rich"):
|
||||
assert forbidden not in text, f"INV-001 violation: cli.py contains '{forbidden}'"
|
||||
_ = textual_was_imported # avoid unused warning
|
||||
|
||||
|
||||
class TestMain:
|
||||
@@ -1325,10 +1338,15 @@ class TestMain:
|
||||
rc = main(["--send", "hi", "--new", "--agent", "m", "--api-key", "k"])
|
||||
assert rc == 0
|
||||
|
||||
def test_usage_error_no_send(
|
||||
def test_empty_argv_fails_on_auth(
|
||||
self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
"""usage_error_no_send: empty argv → exit 10; stderr [usage_error]; _amain never called."""
|
||||
"""empty argv → exit 11 [auth_error]; _amain never called.
|
||||
|
||||
Since slice b2 bare TUI mode (no --send/--session/--new) is VALID (it
|
||||
opens the session picker), so empty argv is no longer a usage error —
|
||||
it now fails on the missing API key instead (still before _amain).
|
||||
"""
|
||||
amain_calls: list[int] = []
|
||||
|
||||
async def fake_amain(args: ParsedArgs) -> int:
|
||||
@@ -1337,8 +1355,8 @@ class TestMain:
|
||||
|
||||
monkeypatch.setattr(cli_mod, "_amain", fake_amain)
|
||||
rc = main([])
|
||||
assert rc == 10
|
||||
assert "[usage_error]" in capsys.readouterr().err
|
||||
assert rc == 11
|
||||
assert "[auth_error]" in capsys.readouterr().err
|
||||
assert amain_calls == []
|
||||
|
||||
def test_usage_error_both_session_and_new(
|
||||
@@ -1419,3 +1437,387 @@ class TestMain:
|
||||
assert tui_calls[0].send_content is None
|
||||
assert tui_calls[0].session_id == "s-1"
|
||||
assert amain_calls == []
|
||||
|
||||
|
||||
class TestBifrostBindCli:
|
||||
"""Issue #17 slice 3a — the CLI Bifrost-bind trigger (INV-008, one of three)."""
|
||||
|
||||
def test_plane_and_host_build_binding(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
"""tracer: --bifrost-plane + --bifrost-host resolve a BifrostBinding via
|
||||
endpoint_for_plane; the consumer key comes from the env."""
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
args = _parse_args(
|
||||
[
|
||||
"--send", "hi", "--new", "--agent", "ratatoskr:sindra", "--api-key", "k",
|
||||
"--bifrost-plane", "memory", "--bifrost-host", "10.100.10.50",
|
||||
]
|
||||
)
|
||||
assert args.bifrost == BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
assert args.bifrost_plane == "memory"
|
||||
assert args.consumer_key == "ck"
|
||||
|
||||
def test_host_from_env(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""--bifrost-host falls back to RATATOSKR_PROVIDER_VISIBLE_HOST."""
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
monkeypatch.setenv("RATATOSKR_PROVIDER_VISIBLE_HOST", "10.0.0.9")
|
||||
args = _parse_args(
|
||||
["--send", "hi", "--new", "--agent", "a", "--api-key", "k",
|
||||
"--bifrost-plane", "affect"]
|
||||
)
|
||||
assert args.bifrost == BifrostBinding(endpoint_url="http://10.0.0.9:8390")
|
||||
|
||||
def test_direct_url_bypasses_plane(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""--bifrost-url is the direct (HTTPS/prod) endpoint, bypassing the plane
|
||||
shortcut; no plane label."""
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
args = _parse_args(
|
||||
["--send", "hi", "--new", "--agent", "a", "--api-key", "k",
|
||||
"--bifrost-url", "https://prov.example:8391"]
|
||||
)
|
||||
assert args.bifrost == BifrostBinding(endpoint_url="https://prov.example:8391")
|
||||
assert args.bifrost_plane is None
|
||||
|
||||
def test_no_bifrost_flags_leaves_binding_none(self) -> None:
|
||||
"""regression: no bifrost flags → bifrost/consumer_key None (pre-#17 path)."""
|
||||
args = _parse_args(
|
||||
["--send", "hi", "--new", "--agent", "mimir", "--api-key", "k"]
|
||||
)
|
||||
assert args.bifrost is None
|
||||
assert args.consumer_key is None
|
||||
|
||||
def test_plane_and_url_mutually_exclusive(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
with pytest.raises(UsageError):
|
||||
_parse_args(
|
||||
["--send", "hi", "--new", "--agent", "a", "--api-key", "k",
|
||||
"--bifrost-plane", "memory", "--bifrost-host", "h",
|
||||
"--bifrost-url", "https://x:8391"]
|
||||
)
|
||||
|
||||
def test_plane_without_host_is_usage_error(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
with pytest.raises(UsageError):
|
||||
_parse_args(
|
||||
["--send", "hi", "--new", "--agent", "a", "--api-key", "k",
|
||||
"--bifrost-plane", "memory"]
|
||||
)
|
||||
|
||||
def test_bind_with_existing_session_is_usage_error(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
"""A binding is a session-CREATE concern; --session (existing) + bind is
|
||||
a usage error."""
|
||||
monkeypatch.setenv("RATATOSKR_BIFROST_CONSUMER_KEY", "ck")
|
||||
with pytest.raises(UsageError):
|
||||
_parse_args(
|
||||
["--send", "hi", "--session", "s-1", "--api-key", "k",
|
||||
"--bifrost-plane", "memory", "--bifrost-host", "h"]
|
||||
)
|
||||
|
||||
@respx.mock
|
||||
async def test_amain_bound_create_carries_binding_and_routes_502(
|
||||
self, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
"""_amain on a bound create sends the bifrost body + the consumer-key
|
||||
bearer; a 502 auth_rejected routes to BifrostHandshakeFailed with the
|
||||
consumer-key-mismatch hint (INV-001/002, 401-message scoping)."""
|
||||
route = respx.post("http://w/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
502,
|
||||
json={
|
||||
"error_code": "bifrost_handshake_failed",
|
||||
"detail": {"bifrost_error": "bifrost.auth_rejected"},
|
||||
},
|
||||
)
|
||||
)
|
||||
args = ParsedArgs(
|
||||
send_content="hi", session_id=None, new=True, agent_id="ratatoskr:sindra",
|
||||
api_key="canary", server_url="http://w", raw=False, end_user_id="smoke-user",
|
||||
bifrost=BifrostBinding(endpoint_url="http://10.100.10.50:8391"),
|
||||
bifrost_plane="memory", consumer_key="ck",
|
||||
)
|
||||
rc = await _amain(args)
|
||||
assert rc == 23
|
||||
body = json.loads(route.calls[0].request.content)
|
||||
assert body["bifrost"] == {
|
||||
"endpoint_url": "http://10.100.10.50:8391", "scope": None
|
||||
}
|
||||
assert route.calls[0].request.headers["Authorization"] == "Bearer ck"
|
||||
err = capsys.readouterr().err
|
||||
assert "bifrost.auth_rejected" in err
|
||||
assert "consumer key" in err # the 401-scoping hint
|
||||
|
||||
async def test_amain_bind_without_consumer_key_exits(self) -> None:
|
||||
"""_amain on a bind with no consumer key raises BifrostConsumerKeyMissing
|
||||
(before HTTP) → a clean exit code, never a canary fallback."""
|
||||
args = ParsedArgs(
|
||||
send_content="hi", session_id=None, new=True, agent_id="a",
|
||||
api_key="canary", server_url="http://w", raw=False, end_user_id=None,
|
||||
bifrost=BifrostBinding(endpoint_url="http://x:8391"),
|
||||
bifrost_plane="memory", consumer_key=None,
|
||||
)
|
||||
rc = await _amain(args)
|
||||
assert rc == 22
|
||||
|
||||
|
||||
class TestWhoami:
|
||||
"""--whoami one-shot probe (slice: capabilities+me): GET /me + GET /capabilities."""
|
||||
|
||||
def test_whoami_standalone_accepted(self) -> None:
|
||||
"""whoami_standalone_accepted: --whoami alone → valid; whoami=True, no turn flags."""
|
||||
args = _parse_args(["--whoami", "--api-key", "k"])
|
||||
assert args.whoami is True
|
||||
assert args.send_content is None
|
||||
assert args.session_id is None
|
||||
assert args.new is False
|
||||
|
||||
def test_whoami_with_send_rejected(self) -> None:
|
||||
"""whoami_with_send_rejected [adversarial]: --whoami + --send → UsageError."""
|
||||
with pytest.raises(UsageError, match="standalone probe"):
|
||||
_parse_args(["--whoami", "--send", "hi", "--api-key", "k"])
|
||||
|
||||
def test_whoami_with_new_rejected(self) -> None:
|
||||
"""whoami_with_new_rejected [adversarial]: --whoami + --new → UsageError."""
|
||||
with pytest.raises(UsageError, match="standalone probe"):
|
||||
_parse_args(["--whoami", "--new", "--agent", "m", "--api-key", "k"])
|
||||
|
||||
@respx.mock
|
||||
def test_whoami_mode_prints_report(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""whoami_mode_prints_report [happy,tracer]: /me + /capabilities → stdout report; exit 0."""
|
||||
respx.get("https://w.example/me").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"user_id": "alice",
|
||||
"scopes": ["conversations.read", "conversations.write"],
|
||||
"tier": "user",
|
||||
"key_id": "a1b2c3d4",
|
||||
},
|
||||
)
|
||||
)
|
||||
respx.get("https://w.example/capabilities").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"ephemeral_templates": {
|
||||
"echo": {
|
||||
"allowed_models": ["glm5-turbo"],
|
||||
"default_model": "glm5-turbo",
|
||||
"system_prompt_max_bytes": 32768,
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
)
|
||||
rc = main(["--whoami", "--api-key", "k", "--server", "https://w.example"])
|
||||
assert rc == 0
|
||||
out = capsys.readouterr().out
|
||||
assert "user_id: alice" in out
|
||||
assert "tier: user" in out
|
||||
assert "key_id: a1b2c3d4" in out
|
||||
assert "ephemeral_template echo" in out
|
||||
assert "glm5-turbo" in out
|
||||
|
||||
@respx.mock
|
||||
def test_whoami_me_auth_failure_exits_20(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""whoami_me_auth_failure [error]: /me 401 → exit 20 [session_api_failed]."""
|
||||
respx.get("https://w.example/me").mock(
|
||||
return_value=httpx.Response(401, json={"detail": "auth_invalid"})
|
||||
)
|
||||
rc = main(["--whoami", "--api-key", "k", "--server", "https://w.example"])
|
||||
assert rc == 20
|
||||
assert "[session_api_failed]" in capsys.readouterr().err
|
||||
|
||||
|
||||
class TestTier2Probes:
|
||||
"""--characters + --set-persona-pad one-shot probes (Tier-2: #161 + persona_state-write)."""
|
||||
|
||||
def test_characters_standalone_accepted(self) -> None:
|
||||
"""characters_standalone: --characters alone → valid."""
|
||||
args = _parse_args(["--characters", "--api-key", "k"])
|
||||
assert args.characters is True
|
||||
assert args.session_id is None
|
||||
|
||||
def test_set_persona_requires_session(self) -> None:
|
||||
"""set_persona_requires_session [adversarial]: --set-persona-pad needs --session."""
|
||||
with pytest.raises(UsageError, match="requires --session"):
|
||||
_parse_args(["--set-persona-pad", "0.4,0.1,-0.2", "--api-key", "k"])
|
||||
|
||||
def test_probes_mutually_exclusive(self) -> None:
|
||||
"""probes_mutually_exclusive [adversarial]: --whoami + --characters → UsageError."""
|
||||
with pytest.raises(UsageError, match="mutually exclusive"):
|
||||
_parse_args(["--whoami", "--characters", "--api-key", "k"])
|
||||
|
||||
@respx.mock
|
||||
def test_characters_probe_lifecycle(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""characters_probe [happy,tracer]: models → create → state → delete; report to stdout."""
|
||||
respx.get("https://w.example/models/available-for-characters").mock(
|
||||
return_value=httpx.Response(200, json={"items": [{"name": "fast"}]})
|
||||
)
|
||||
respx.post("https://w.example/characters").mock(
|
||||
return_value=httpx.Response(201, json={"character_id": "char_z", "ttl_expires_at": "t"})
|
||||
)
|
||||
respx.get("https://w.example/characters/char_z/state").mock(
|
||||
return_value=httpx.Response(200, json={"schema_version": "1", "pad": [0.1, 0.2, 0.3]})
|
||||
)
|
||||
del_route = respx.delete("https://w.example/characters/char_z").mock(
|
||||
return_value=httpx.Response(204)
|
||||
)
|
||||
rc = main(["--characters", "--api-key", "k", "--server", "https://w.example"])
|
||||
assert rc == 0
|
||||
out = capsys.readouterr().out
|
||||
assert "character models: fast" in out
|
||||
assert "created: char_z" in out
|
||||
assert "pad=[0.1, 0.2, 0.3]" in out
|
||||
assert "deleted: char_z" in out
|
||||
assert del_route.call_count == 1 # lifecycle cleaned up
|
||||
|
||||
@respx.mock
|
||||
def test_set_persona_probe(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""set_persona_probe [happy,tracer]: POST pad to /sessions/{id}/persona_state; 204."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions/s1/persona_state").mock(
|
||||
return_value=httpx.Response(204)
|
||||
)
|
||||
rc = main(
|
||||
["--set-persona-pad", "0.4,0.1,-0.2", "--session", "s1",
|
||||
"--api-key", "k", "--server", "https://w.example"]
|
||||
)
|
||||
assert rc == 0
|
||||
assert "persona_state set" in capsys.readouterr().out
|
||||
# canonical POST /sessions/{id}/persona_state body: named-key dict, NOT a list
|
||||
assert _json.loads(route.calls[0].request.content) == {
|
||||
"pad": {"pleasure": 0.4, "arousal": 0.1, "dominance": -0.2}
|
||||
}
|
||||
|
||||
def test_set_persona_wrong_count(self) -> None:
|
||||
"""set_persona_wrong_count [adversarial]: not exactly 3 floats → exit 10, no HTTP."""
|
||||
rc = main(
|
||||
["--set-persona-pad", "0.4,0.1", "--session", "s1",
|
||||
"--api-key", "k", "--server", "https://w.example"]
|
||||
)
|
||||
assert rc == 10
|
||||
|
||||
|
||||
class TestSeedFirstMessageProbe:
|
||||
"""--seed-first-message one-shot (#347 authored-history-write reference-consumer probe)."""
|
||||
|
||||
def test_seed_requires_agent(self) -> None:
|
||||
"""seed_requires_agent [adversarial]: --seed-first-message needs --agent."""
|
||||
with pytest.raises(UsageError, match="requires --agent"):
|
||||
_parse_args(["--seed-first-message", "hello", "--api-key", "k"])
|
||||
|
||||
def test_seed_forbids_session(self) -> None:
|
||||
"""seed_forbids_session [adversarial]: manages its own session — no --session."""
|
||||
with pytest.raises(UsageError, match="manages its own session"):
|
||||
_parse_args(
|
||||
["--seed-first-message", "hi", "--agent", "m", "--session", "s1", "--api-key", "k"]
|
||||
)
|
||||
|
||||
def test_seed_mutually_exclusive(self) -> None:
|
||||
"""seed_mutually_exclusive [adversarial]: --seed-first-message + --whoami → UsageError."""
|
||||
with pytest.raises(UsageError, match="mutually exclusive"):
|
||||
_parse_args(["--seed-first-message", "hi", "--whoami", "--api-key", "k"])
|
||||
|
||||
def test_seed_empty_rejected(self) -> None:
|
||||
"""seed_empty_rejected [adversarial]: empty content → UsageError."""
|
||||
with pytest.raises(UsageError, match="non-empty"):
|
||||
_parse_args(["--seed-first-message", "", "--agent", "m", "--api-key", "k"])
|
||||
|
||||
def test_seed_accepted(self) -> None:
|
||||
"""seed_accepted [happy]: --seed-first-message + --agent → parses."""
|
||||
args = _parse_args(["--seed-first-message", "hi", "--agent", "mimir", "--api-key", "k"])
|
||||
assert args.seed_first_message == "hi"
|
||||
assert args.agent_id == "mimir"
|
||||
assert args.session_id is None and args.new is False
|
||||
|
||||
@respx.mock
|
||||
def test_seed_probe_happy(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""seed_probe [happy,tracer]: create session → seed → read-back; report to stdout."""
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"session_id": "s1",
|
||||
"agent_id": "mimir",
|
||||
"message_count": 0,
|
||||
"created_at": "2026-07-06T12:00:00+00:00",
|
||||
"last_active": "2026-07-06T12:00:00+00:00",
|
||||
"metadata": {},
|
||||
},
|
||||
)
|
||||
)
|
||||
hist_route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"author": "assistant",
|
||||
"content_chars": 5,
|
||||
"injected_at": "2026-07-06T12:00:01+00:00",
|
||||
"phase": "seeded",
|
||||
"seq": 0,
|
||||
"session_id": "s1",
|
||||
"turn_id": "t1",
|
||||
},
|
||||
)
|
||||
)
|
||||
respx.get("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"session_id": "s1",
|
||||
"items": [{"seq": 0, "role": "assistant", "content": "hello"}],
|
||||
"next_cursor": None,
|
||||
},
|
||||
)
|
||||
)
|
||||
rc = main(
|
||||
["--seed-first-message", "hello", "--agent", "mimir",
|
||||
"--api-key", "k", "--server", "https://w.example"]
|
||||
)
|
||||
assert rc == 0
|
||||
out = capsys.readouterr().out
|
||||
assert "session: s1" in out
|
||||
assert "seeded: seq=0 phase=seeded" in out
|
||||
assert "read-back: 1 message" in out
|
||||
assert "role=assistant" in out
|
||||
assert hist_route.call_count == 1
|
||||
|
||||
@respx.mock
|
||||
def test_seed_probe_feature_absent(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||
"""feature_absent [error-path]: 404 hide-existence → benign report, exit 0, no read-back."""
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"session_id": "s1",
|
||||
"agent_id": "mimir",
|
||||
"message_count": 0,
|
||||
"created_at": "2026-07-06T12:00:00+00:00",
|
||||
"last_active": "2026-07-06T12:00:00+00:00",
|
||||
"metadata": {},
|
||||
},
|
||||
)
|
||||
)
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
msgs_route = respx.get("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(
|
||||
200, json={"session_id": "s1", "items": [], "next_cursor": None}
|
||||
)
|
||||
)
|
||||
rc = main(
|
||||
["--seed-first-message", "hello", "--agent", "mimir",
|
||||
"--api-key", "k", "--server", "https://w.example"]
|
||||
)
|
||||
assert rc == 0
|
||||
assert "feature-absent" in capsys.readouterr().out
|
||||
assert msgs_route.call_count == 0 # never capability-probes past the 404
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
"""Tests for ratatoskr.first_message per docs/contracts/first_message.contract.md."""
|
||||
|
||||
import asyncio
|
||||
import hashlib
|
||||
import json
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
import respx
|
||||
|
||||
from ratatoskr.first_message import (
|
||||
FIRST_MESSAGE_PRESETS,
|
||||
preset_for,
|
||||
seed_preset_first_message,
|
||||
)
|
||||
|
||||
|
||||
class TestPresetFor:
|
||||
"""first_message contract — preset_for (dict lookup)."""
|
||||
|
||||
def test_preset_hit(self) -> None:
|
||||
"""preset_hit [happy,tracer]: sindra has a non-empty str preset."""
|
||||
val = preset_for("ratatoskr:sindra")
|
||||
assert isinstance(val, str) and val
|
||||
|
||||
def test_preset_miss(self) -> None:
|
||||
"""preset_miss [happy]: an agent with no preset → None."""
|
||||
assert preset_for("mimir") is None
|
||||
|
||||
def test_empty_agent_id(self) -> None:
|
||||
"""empty_agent_id [adversarial]: "" → AssertionError."""
|
||||
with pytest.raises(AssertionError):
|
||||
preset_for("")
|
||||
|
||||
|
||||
class TestSeedPresetFirstMessage:
|
||||
"""first_message contract — seed_preset_first_message (best-effort #347 seed)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_seeds_preset(self) -> None:
|
||||
"""seeds_preset [happy,tracer]: preset agent → one history POST, correct body."""
|
||||
content = FIRST_MESSAGE_PRESETS["ratatoskr:sindra"]
|
||||
key = "ratatoskr-preset-" + hashlib.sha256(content.encode("utf-8")).hexdigest()[:12]
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"author": "assistant",
|
||||
"seq": 0,
|
||||
"phase": "seeded",
|
||||
"turn_id": "t1",
|
||||
"session_id": "s1",
|
||||
"content_chars": len(content),
|
||||
"injected_at": "2026-07-06T00:00:00+00:00",
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
assert result == content
|
||||
assert route.call_count == 1 # POST-002: exactly one history POST
|
||||
assert json.loads(route.calls[0].request.content) == {
|
||||
"author": "assistant",
|
||||
"content": content,
|
||||
"idempotency_key": key,
|
||||
}
|
||||
|
||||
@respx.mock
|
||||
async def test_no_preset_zero_http(self) -> None:
|
||||
"""no_preset_zero_http [happy]: no-preset agent → None, ZERO HTTP (INV-002)."""
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "mimir")
|
||||
assert result is None
|
||||
assert not route.called
|
||||
|
||||
@respx.mock
|
||||
async def test_feature_absent_swallowed(self) -> None:
|
||||
"""feature_absent_swallowed [error]: 404 hide-existence → None, no raise (INV-001)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
assert result is None
|
||||
|
||||
@respx.mock
|
||||
async def test_session_api_failed_swallowed(self) -> None:
|
||||
"""session_api_failed_swallowed [error]: 409 → None, no raise (INV-001)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(409, json={"error_code": "generation_active"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
assert result is None
|
||||
|
||||
@respx.mock
|
||||
async def test_transport_error_swallowed(self) -> None:
|
||||
"""transport_error_swallowed [error]: httpx.ConnectError → None, no raise (INV-001)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
side_effect=httpx.ConnectError("boom")
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
assert result is None
|
||||
|
||||
@respx.mock
|
||||
async def test_unexpected_exception_swallowed(self) -> None:
|
||||
"""unexpected_exception [error]: write raises ValueError → None (broad never-raise)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
side_effect=ValueError("unexpected")
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
assert result is None
|
||||
|
||||
async def test_cancellation_propagates(self) -> None:
|
||||
"""cancellation_propagates [error]: CancelledError from the write is RE-RAISED."""
|
||||
import ratatoskr.first_message as fm
|
||||
|
||||
async def _cancel(*_a: object, **_k: object) -> None:
|
||||
raise asyncio.CancelledError
|
||||
|
||||
orig = fm.write_authored_history
|
||||
fm.write_authored_history = _cancel # type: ignore[assignment]
|
||||
try:
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(asyncio.CancelledError):
|
||||
await seed_preset_first_message(client, "s1", "ratatoskr:sindra")
|
||||
finally:
|
||||
fm.write_authored_history = orig # type: ignore[assignment]
|
||||
|
||||
@respx.mock
|
||||
async def test_malformed_agent_id_no_http(self) -> None:
|
||||
"""malformed_agent_id [adversarial]: non-str or empty agent_id → None; no HTTP; no raise."""
|
||||
route = respx.post(url__regex=r".*/history$").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
assert await seed_preset_first_message(client, "s1", 123) is None # type: ignore[arg-type]
|
||||
assert await seed_preset_first_message(client, "s1", "") is None
|
||||
assert not route.called
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_session_id(self) -> None:
|
||||
"""empty_session_id [adversarial]: "" → None (soft guard); no HTTP; no raise."""
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await seed_preset_first_message(client, "", "ratatoskr:sindra")
|
||||
assert result is None
|
||||
assert not route.called
|
||||
@@ -0,0 +1,371 @@
|
||||
"""Tests for the Tier-3 Bifrost affect provider (ratatoskr.provider.affect_store).
|
||||
|
||||
Contract: docs/contracts/bifrost_affect_provider.contract.md
|
||||
Vertical tracer-first: basic_emit -> opacity -> lww -> replay -> conflict ->
|
||||
missing_key -> #195 parity vs InMemoryAffectStore.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import types
|
||||
|
||||
import pytest
|
||||
from bifrost.affect import AffectIdempotencyConflict, AffectInvalidArguments
|
||||
|
||||
from ratatoskr.provider.affect_store import build_affect_provider_app, open_affect_store
|
||||
|
||||
|
||||
def _ctx(sub: str = "sub-1"):
|
||||
# Mirrors bifrost's _ctx_actor: actor = jwt_sub (test ctx) or session_id.
|
||||
return types.SimpleNamespace(jwt_sub=sub)
|
||||
|
||||
|
||||
def _snapshot(agent: str = "a1", user: str = "u1", **payload):
|
||||
base = {
|
||||
"agent_id": agent,
|
||||
"end_user_id": user,
|
||||
"pad": {"p": 0.1, "a": 0.2, "d": 0.3},
|
||||
"valence": 0.5,
|
||||
"persona_baselines": {"warmth": 0.7},
|
||||
"emitted_at": "2026-06-14T00:00:00Z",
|
||||
}
|
||||
base.update(payload)
|
||||
return base
|
||||
|
||||
|
||||
def _row_count(store, table: str) -> int:
|
||||
return store._conn.execute(f"SELECT COUNT(*) FROM {table}").fetchone()[0]
|
||||
|
||||
|
||||
# --- open_affect_store ---
|
||||
|
||||
def test_open_advertises_capability_and_schema():
|
||||
store = open_affect_store(":memory:")
|
||||
assert store.affect_supported is True
|
||||
# both tables queryable
|
||||
store._conn.execute("SELECT * FROM affect_snapshots")
|
||||
store._conn.execute("SELECT * FROM affect_idempotency")
|
||||
|
||||
|
||||
def test_open_sets_busy_timeout(tmp_path):
|
||||
"""INV-006: every connection sets busy_timeout>=5000ms (WAL's default is 0, so a
|
||||
contended write would fail SQLITE_BUSY immediately) — prep for the two-process
|
||||
composite/standalone topology."""
|
||||
store = open_affect_store(str(tmp_path / "affect.db"))
|
||||
assert store._conn.execute("PRAGMA busy_timeout").fetchone()[0] == 5000
|
||||
|
||||
|
||||
def test_reopen_existing_file_is_idempotent(tmp_path):
|
||||
db = str(tmp_path / "affect.db")
|
||||
open_affect_store(db) # first open creates schema
|
||||
store = open_affect_store(db) # reopen: CREATE TABLE IF NOT EXISTS is a no-op
|
||||
assert store.affect_supported is True
|
||||
store._conn.execute("SELECT * FROM affect_snapshots")
|
||||
store._conn.execute("SELECT * FROM affect_idempotency")
|
||||
|
||||
|
||||
# --- emit ---
|
||||
|
||||
async def test_basic_emit_stores_and_round_trips():
|
||||
store = open_affect_store(":memory:")
|
||||
snap = _snapshot()
|
||||
result = await store.emit(snap, idempotency_key="k1", ctx=_ctx())
|
||||
assert result == {"stored": True}
|
||||
assert store.get("a1", "u1") == snap
|
||||
|
||||
|
||||
async def test_opacity_arbitrary_payload_round_trips_and_addressing_invariant():
|
||||
store = open_affect_store(":memory:")
|
||||
# arbitrary extra/unknown payload fields persist + round-trip verbatim
|
||||
snap = _snapshot(weird_field={"nested": [1, 2, 3]}, mystery="x")
|
||||
assert await store.emit(snap, idempotency_key="k1", ctx=_ctx()) == {"stored": True}
|
||||
assert store.get("a1", "u1") == snap
|
||||
# two snapshots for the same key differing ONLY in payload address the SAME row
|
||||
snap2 = _snapshot(weird_field={"nested": [9]}, mystery="y", valence=0.99)
|
||||
await store.emit(snap2, idempotency_key="k2", ctx=_ctx())
|
||||
assert store.get("a1", "u1") == snap2
|
||||
assert _row_count(store, "affect_snapshots") == 1 # same row overwritten
|
||||
|
||||
|
||||
async def test_lww_by_arrival_ignores_emitted_at():
|
||||
store = open_affect_store(":memory:")
|
||||
a = _snapshot(valence=0.1, emitted_at="2026-06-14T10:00:00Z")
|
||||
b = _snapshot(valence=0.9, emitted_at="2026-06-14T08:00:00Z") # OLDER emitted_at
|
||||
await store.emit(a, idempotency_key="ka", ctx=_ctx())
|
||||
await store.emit(b, idempotency_key="kb", ctx=_ctx()) # distinct key -> arrival wins
|
||||
assert store.get("a1", "u1") == b # later arrival wins despite older emitted_at
|
||||
|
||||
|
||||
async def test_replay_noop_same_key_same_payload():
|
||||
store = open_affect_store(":memory:")
|
||||
snap = _snapshot()
|
||||
assert await store.emit(snap, idempotency_key="k1", ctx=_ctx()) == {"stored": True}
|
||||
assert await store.emit(snap, idempotency_key="k1", ctx=_ctx()) == {"stored": True}
|
||||
assert store.get("a1", "u1") == snap
|
||||
assert _row_count(store, "affect_snapshots") == 1 # replay did not duplicate
|
||||
|
||||
|
||||
async def test_idempotency_conflict_same_key_different_payload():
|
||||
store = open_affect_store(":memory:")
|
||||
first = _snapshot(valence=0.1)
|
||||
await store.emit(first, idempotency_key="k1", ctx=_ctx())
|
||||
with pytest.raises(AffectIdempotencyConflict):
|
||||
await store.emit(_snapshot(valence=0.2), idempotency_key="k1", ctx=_ctx())
|
||||
assert store.get("a1", "u1") == first # prior snapshot untouched
|
||||
|
||||
|
||||
async def test_same_key_distinct_actor_is_not_a_conflict():
|
||||
# idempotency is actor-scoped (INV-006/-008): same key, different ctx actor
|
||||
store = open_affect_store(":memory:")
|
||||
await store.emit(_snapshot(valence=0.1), idempotency_key="k1", ctx=_ctx("sub-A"))
|
||||
# different actor, same key, different payload -> NOT a conflict (distinct id)
|
||||
assert await store.emit(
|
||||
_snapshot(valence=0.2), idempotency_key="k1", ctx=_ctx("sub-B")
|
||||
) == {"stored": True}
|
||||
|
||||
|
||||
async def test_missing_end_user_id_raises_and_no_write():
|
||||
store = open_affect_store(":memory:")
|
||||
bad = _snapshot()
|
||||
del bad["end_user_id"]
|
||||
with pytest.raises(AffectInvalidArguments):
|
||||
await store.emit(bad, idempotency_key="k1", ctx=_ctx())
|
||||
assert _row_count(store, "affect_snapshots") == 0
|
||||
|
||||
|
||||
async def test_missing_agent_id_raises_and_no_write():
|
||||
# PRE-001 guards BOTH addressing keys symmetrically.
|
||||
store = open_affect_store(":memory:")
|
||||
bad = _snapshot()
|
||||
del bad["agent_id"]
|
||||
with pytest.raises(AffectInvalidArguments):
|
||||
await store.emit(bad, idempotency_key="k1", ctx=_ctx())
|
||||
assert _row_count(store, "affect_snapshots") == 0
|
||||
|
||||
|
||||
async def test_empty_idempotency_key_raises():
|
||||
store = open_affect_store(":memory:")
|
||||
with pytest.raises(AffectInvalidArguments):
|
||||
await store.emit(_snapshot(), idempotency_key="", ctx=_ctx())
|
||||
|
||||
|
||||
# --- get ---
|
||||
|
||||
def test_get_absent_returns_none():
|
||||
store = open_affect_store(":memory:")
|
||||
assert store.get("nope", "nope") is None
|
||||
|
||||
|
||||
async def test_get_after_emit_returns_equal():
|
||||
store = open_affect_store(":memory:")
|
||||
snap = _snapshot()
|
||||
await store.emit(snap, idempotency_key="k1", ctx=_ctx())
|
||||
assert store.get("a1", "u1") == snap
|
||||
|
||||
|
||||
# --- fetch (affect.fetch wire verb — bifrost >=0.10.0, INV-010 strong-or-absent) ---
|
||||
|
||||
async def test_fetch_absent_returns_found_false():
|
||||
"""fetch_absent: no row for the key → {"found": False} (mirrors reference)."""
|
||||
store = open_affect_store(":memory:")
|
||||
assert await store.fetch("nope", "nope") == {"found": False}
|
||||
|
||||
|
||||
async def test_fetch_after_emit_returns_snapshot():
|
||||
"""fetch_after_emit [tracer]: emit then fetch → {"found": True, "snapshot": <verbatim>}."""
|
||||
store = open_affect_store(":memory:")
|
||||
snap = _snapshot()
|
||||
await store.emit(snap, idempotency_key="k1", ctx=_ctx())
|
||||
assert await store.fetch("a1", "u1") == {"found": True, "snapshot": snap}
|
||||
|
||||
|
||||
async def test_fetch_missing_key_raises():
|
||||
"""fetch_missing_key: empty/missing addressing key → AffectInvalidArguments
|
||||
(PRE-001; symmetric across both keys, belt-and-suspenders behind the wire)."""
|
||||
store = open_affect_store(":memory:")
|
||||
with pytest.raises(AffectInvalidArguments):
|
||||
await store.fetch("", "u1")
|
||||
with pytest.raises(AffectInvalidArguments):
|
||||
await store.fetch("a1", "")
|
||||
|
||||
|
||||
# --- build_affect_provider_app ---
|
||||
|
||||
def test_build_app_exposes_handshake_and_affect_routes():
|
||||
store = open_affect_store(":memory:")
|
||||
app = build_affect_provider_app(store, heimdall_key=b"secret-key")
|
||||
routes = {getattr(r, "path", None): r for r in app.routes}
|
||||
assert "/bifrost/handshake" in routes
|
||||
assert "/bifrost/affect-call" in routes
|
||||
assert "POST" in routes["/bifrost/affect-call"].methods # POST-001: the verb, not just the path
|
||||
# POST-002: bifrost routes remain REACHABLE (not merely registered) after the read
|
||||
# route is composed in via add_route — drive one without a JWT → routed (auth-
|
||||
# rejected), never 404.
|
||||
r = TestClient(app).post("/bifrost/affect-call", json={"operation": "affect.emit"})
|
||||
assert r.status_code != 404
|
||||
|
||||
|
||||
def test_build_app_rejects_non_advertising_store():
|
||||
store = open_affect_store(":memory:")
|
||||
store.affect_supported = False
|
||||
with pytest.raises(ValueError):
|
||||
build_affect_provider_app(store, heimdall_key=b"k")
|
||||
|
||||
|
||||
def test_build_app_rejects_empty_key():
|
||||
store = open_affect_store(":memory:")
|
||||
with pytest.raises(ValueError):
|
||||
build_affect_provider_app(store, heimdall_key=b"")
|
||||
|
||||
|
||||
# --- #195 conformance: parity vs the reference store through the real engine ---
|
||||
|
||||
def _dispatch_ctx(*scopes: str, session_id: str = "actor-1"):
|
||||
return types.SimpleNamespace(
|
||||
scope=list(scopes), session_id=session_id, jwt_sub=session_id
|
||||
)
|
||||
|
||||
|
||||
def _env(snap: dict, key: str = "sess-1:1:affect") -> dict:
|
||||
return {
|
||||
"operation": "affect.emit",
|
||||
"args": snap,
|
||||
"idempotency_key": key,
|
||||
"idempotency_class": "short-retry",
|
||||
}
|
||||
|
||||
|
||||
def _ref_shaped_snapshot(*, pleasure: float = 0.5, emitted_at: str = "2026-06-14T12:00:00Z"):
|
||||
# Mirror the reference test's snapshot shape so the envelope validates.
|
||||
return {
|
||||
"agent_id": "agent-1",
|
||||
"end_user_id": "user-1",
|
||||
"pad": {"pleasure": pleasure, "arousal": 0.2, "dominance": -0.1},
|
||||
"valence": [{"entity_id": "e1", "regard": 0.7, "familiarity": 0.3}],
|
||||
"emitted_at": emitted_at,
|
||||
}
|
||||
|
||||
|
||||
async def test_parity_vs_reference_store_through_dispatch():
|
||||
from bifrost.affect import dispatch_affect_call
|
||||
from bifrost.consumer.testing import InMemoryAffectStore
|
||||
|
||||
ref = InMemoryAffectStore()
|
||||
mine = open_affect_store(":memory:")
|
||||
ctx = _dispatch_ctx("affect:write")
|
||||
snap = _ref_shaped_snapshot()
|
||||
|
||||
# happy persist: wire bodies must agree
|
||||
assert await dispatch_affect_call(_env(snap), ctx, ref) == await dispatch_affect_call(
|
||||
_env(snap), ctx, mine
|
||||
)
|
||||
# replay (same key + same payload): both no-op {stored: true}
|
||||
assert await dispatch_affect_call(_env(snap), ctx, ref) == await dispatch_affect_call(
|
||||
_env(snap), ctx, mine
|
||||
)
|
||||
# conflict (same key + different payload): both map to the same error envelope
|
||||
other = _ref_shaped_snapshot(pleasure=0.99)
|
||||
assert await dispatch_affect_call(_env(other), ctx, ref) == await dispatch_affect_call(
|
||||
_env(other), ctx, mine
|
||||
)
|
||||
|
||||
|
||||
def _fetch_env(agent_id: str = "agent-1", end_user_id: str = "user-1") -> dict:
|
||||
return {"operation": "affect.fetch", "args": {"agent_id": agent_id, "end_user_id": end_user_id}}
|
||||
|
||||
|
||||
async def test_parity_vs_reference_fetch_through_dispatch():
|
||||
"""#195 parity for affect.fetch: cold (not-found) + warm (found) read envelopes
|
||||
yield identical (status, body) through the real engine against the reference store
|
||||
and ours. Conforms to bifrost's InMemoryAffectStore.fetch ({found, snapshot})."""
|
||||
from bifrost.affect import dispatch_affect_call
|
||||
from bifrost.consumer.testing import InMemoryAffectStore
|
||||
|
||||
ref = InMemoryAffectStore()
|
||||
mine = open_affect_store(":memory:")
|
||||
write_ctx = _dispatch_ctx("affect:write")
|
||||
read_ctx = _dispatch_ctx("affect:read")
|
||||
|
||||
# cold fetch (nothing persisted): both -> {found: false}
|
||||
assert await dispatch_affect_call(_fetch_env(), read_ctx, ref) == await dispatch_affect_call(
|
||||
_fetch_env(), read_ctx, mine
|
||||
)
|
||||
|
||||
# seed both via emit, then fetch -> both {found: true, snapshot: <verbatim>}
|
||||
snap = _ref_shaped_snapshot()
|
||||
await dispatch_affect_call(_env(snap), write_ctx, ref)
|
||||
await dispatch_affect_call(_env(snap), write_ctx, mine)
|
||||
assert await dispatch_affect_call(_fetch_env(), read_ctx, ref) == await dispatch_affect_call(
|
||||
_fetch_env(), read_ctx, mine
|
||||
)
|
||||
|
||||
|
||||
# --- PAD read route (issue #18 Deliverable 2) ---
|
||||
# Non-bifrost GET /affect/state/{agent_id}?end_user_id=… → store.get snapshot.
|
||||
|
||||
import json as _json
|
||||
|
||||
from starlette.testclient import TestClient
|
||||
|
||||
|
||||
def _affect_snapshot(agent: str = "ratatoskr:sindra", user: str = "vuong") -> dict:
|
||||
# The real affect.emit shape (verified live): pad + per-entity valence + emitted_at.
|
||||
return {
|
||||
"agent_id": agent,
|
||||
"end_user_id": user,
|
||||
"pad": {"pleasure": 0.1459, "arousal": 0.0796, "dominance": -0.0071},
|
||||
"valence": [
|
||||
{
|
||||
"entity_id": "ratatoskr",
|
||||
"entity_type": "human",
|
||||
"familiarity": 0.5886,
|
||||
"interaction_count": 8,
|
||||
"regard": 0.15,
|
||||
}
|
||||
],
|
||||
"emitted_at": "2026-06-18T15:58:12+00:00",
|
||||
}
|
||||
|
||||
|
||||
def _seed(store, snap: dict) -> None:
|
||||
blob = _json.dumps(snap, sort_keys=True, separators=(",", ":"))
|
||||
store._conn.execute(
|
||||
"INSERT INTO affect_snapshots (agent_id, end_user_id, snapshot_json, arrived_at) "
|
||||
"VALUES (?, ?, ?, ?)",
|
||||
(snap["agent_id"], snap["end_user_id"], blob, "0"),
|
||||
)
|
||||
store._conn.commit()
|
||||
|
||||
|
||||
def test_affect_state_route_returns_seeded_snapshot():
|
||||
"""tracer: seeded (agent, user) → 200 with the snapshot verbatim. Colon-id in the
|
||||
path exercises INV-008 at the provider hop."""
|
||||
store = open_affect_store(":memory:")
|
||||
snap = _affect_snapshot()
|
||||
_seed(store, snap)
|
||||
client = TestClient(build_affect_provider_app(store, heimdall_key=b"k"))
|
||||
r = client.get("/affect/state/ratatoskr:sindra", params={"end_user_id": "vuong"})
|
||||
assert r.status_code == 200
|
||||
assert r.json() == snap
|
||||
|
||||
|
||||
def test_affect_state_route_absent_returns_404_no_snapshot():
|
||||
"""INV-003: no emit yet for (agent, user) → explicit 404 no_affect_snapshot,
|
||||
NEVER a zeroed pad that reads as real data."""
|
||||
store = open_affect_store(":memory:")
|
||||
client = TestClient(build_affect_provider_app(store, heimdall_key=b"k"))
|
||||
r = client.get("/affect/state/ratatoskr:ghost", params={"end_user_id": "nobody"})
|
||||
assert r.status_code == 404
|
||||
body = r.json()
|
||||
assert body["error_code"] == "no_affect_snapshot"
|
||||
assert "pad" not in body # no fabricated PAD
|
||||
|
||||
|
||||
def test_affect_state_route_missing_end_user_id_returns_400():
|
||||
"""PRE-001: absent end_user_id query → 400 missing_end_user_id (not a silent
|
||||
no-snapshot lookup against a None partition)."""
|
||||
store = open_affect_store(":memory:")
|
||||
_seed(store, _affect_snapshot())
|
||||
client = TestClient(build_affect_provider_app(store, heimdall_key=b"k"))
|
||||
r = client.get("/affect/state/ratatoskr:sindra") # no end_user_id
|
||||
assert r.status_code == 400
|
||||
assert r.json()["error_code"] == "missing_end_user_id"
|
||||
@@ -0,0 +1,275 @@
|
||||
"""Tests for the combined Bifrost provider (ratatoskr.provider.combined) — issue #18
|
||||
Deliverable 1.
|
||||
|
||||
ONE app fronting BOTH planes (memory.* + affect.*) + the shared affect read route.
|
||||
Mirrors bifrost's tests/consumer/test_build_combined_app.py shapes (handshake +
|
||||
dispatch) and ratatoskr's op-feed test style (mint_dispatch_jwt, RecordingSink), so
|
||||
the envelopes and JWTs are the real wire shapes, not hand-mocked guesses ("test
|
||||
against the shipped lib").
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import hashlib
|
||||
import hmac
|
||||
import json
|
||||
import time
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
from bifrost.core.dispatch_jwt import mint_dispatch_jwt
|
||||
from starlette.testclient import TestClient
|
||||
|
||||
from ratatoskr.provider.affect_store import open_affect_store
|
||||
from ratatoskr.provider.combined import build_combined_provider_app
|
||||
from ratatoskr.provider.memory_store import open_memory_store
|
||||
from ratatoskr.provider.opfeed import instrument_provider_app
|
||||
|
||||
_KEY = b"deterministic-test-heimdall-key-32-bytes!"
|
||||
_CONSUMER = "ratatoskr"
|
||||
_DIM = 8
|
||||
|
||||
|
||||
def _combined_app():
|
||||
memory_store = open_memory_store(":memory:", embedding_dim=_DIM)
|
||||
affect_store = open_affect_store(":memory:")
|
||||
app = build_combined_provider_app(
|
||||
memory_store, affect_store, heimdall_key=_KEY, consumer_id=_CONSUMER
|
||||
)
|
||||
return app, memory_store, affect_store
|
||||
|
||||
|
||||
def _dispatch_headers(*scopes: str, session_id: str = "sess-1") -> dict:
|
||||
token = mint_dispatch_jwt(
|
||||
session_id=session_id,
|
||||
consumer_id=_CONSUMER,
|
||||
issuer="worldtree",
|
||||
scope=list(scopes),
|
||||
secret_or_key=_KEY,
|
||||
algorithm="HS256",
|
||||
)
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
def _b64url(data: bytes) -> str:
|
||||
return base64.urlsafe_b64encode(data).rstrip(b"=").decode("ascii")
|
||||
|
||||
|
||||
def _handshake_jwt(session_id: str = "sess-1") -> str:
|
||||
"""Replicate bifrost's consumer conftest jwt_factory (HS256 handshake JWT)."""
|
||||
header = {"alg": "HS256", "typ": "JWT"}
|
||||
now = time.time()
|
||||
payload = {
|
||||
"session_id": session_id,
|
||||
"consumer_id": _CONSUMER,
|
||||
"issued_at": now,
|
||||
"expires_at": now + 3600,
|
||||
}
|
||||
h = _b64url(json.dumps(header, separators=(",", ":")).encode())
|
||||
p = _b64url(json.dumps(payload, separators=(",", ":")).encode())
|
||||
sig = hmac.new(_KEY, f"{h}.{p}".encode("ascii"), hashlib.sha256).digest()
|
||||
return f"{h}.{p}.{_b64url(sig)}"
|
||||
|
||||
|
||||
def _handshake_body(session_id: str = "sess-1") -> dict:
|
||||
return {
|
||||
"bifrost_version": "0.4.0",
|
||||
"mcp_version": "0.4.0",
|
||||
"session_id": session_id,
|
||||
"consumer_id": _CONSUMER,
|
||||
"auth": {"scheme": "Bearer", "token": _handshake_jwt(session_id)},
|
||||
"capabilities": ["memory", "affect"],
|
||||
}
|
||||
|
||||
|
||||
def _snapshot(agent: str = "ratatoskr:sindra", user: str = "vuong") -> dict:
|
||||
return {
|
||||
"agent_id": agent,
|
||||
"end_user_id": user,
|
||||
"pad": {"pleasure": 0.5, "arousal": 0.2, "dominance": -0.1},
|
||||
"valence": [{"entity_id": "e1", "regard": 0.7, "familiarity": 0.3}],
|
||||
"emitted_at": "2026-06-14T12:00:00Z",
|
||||
}
|
||||
|
||||
|
||||
def _emit_envelope(snap: dict) -> dict:
|
||||
return {
|
||||
"operation": "affect.emit",
|
||||
"idempotency_key": "sess-1:1:affect",
|
||||
"idempotency_class": "short-retry",
|
||||
"args": snap,
|
||||
}
|
||||
|
||||
|
||||
# --- build_combined_provider_app ---
|
||||
|
||||
def test_builds_both_planes_and_read_route():
|
||||
"""builds_both_planes [tracer]: the composite exposes handshake + memory-call +
|
||||
affect-call + the non-bifrost /affect/state read route (INV-011)."""
|
||||
app, _m, _a = _combined_app()
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
assert "/bifrost/handshake" in paths
|
||||
assert "/bifrost/memory-call" in paths
|
||||
assert "/bifrost/affect-call" in paths
|
||||
assert "/affect/state/{agent_id}" in paths
|
||||
assert "/memory/chunks" in paths # memory-viewer debug read, shared helper
|
||||
|
||||
|
||||
def test_handshake_grants_both_caps():
|
||||
"""handshake_grants_both [scenario]: a handshake requesting [memory, affect] is
|
||||
granted BOTH by store PRESENCE (INV-010) — my wiring doesn't break it."""
|
||||
app, _m, _a = _combined_app()
|
||||
resp = TestClient(app).post("/bifrost/handshake", json=_handshake_body())
|
||||
assert resp.status_code == 200
|
||||
granted = resp.json()["capabilities_granted"]
|
||||
assert "memory" in granted
|
||||
assert "affect" in granted
|
||||
|
||||
|
||||
def test_memory_and_affect_dispatch_through_one_app():
|
||||
"""memory_and_affect_dispatch [scenario]: a memory SEARCH AND an affect emit each
|
||||
round-trip through the SINGLE combined app (INV-013; contract TEST + Acceptance §2
|
||||
name a memory `search`)."""
|
||||
app, _m, _a = _combined_app()
|
||||
client = TestClient(app)
|
||||
|
||||
mem = client.post(
|
||||
"/bifrost/memory-call",
|
||||
json={
|
||||
"operation": "search",
|
||||
"args": {"vector": [0.0] * _DIM, "top_k": 1, "scope_all": {}},
|
||||
},
|
||||
headers=_dispatch_headers("memory:read"),
|
||||
)
|
||||
assert mem.status_code == 200
|
||||
assert mem.json()["success"] is True
|
||||
|
||||
aff = client.post(
|
||||
"/bifrost/affect-call",
|
||||
json=_emit_envelope(_snapshot()),
|
||||
headers=_dispatch_headers("affect:write"),
|
||||
)
|
||||
assert aff.status_code == 200
|
||||
assert aff.json()["success"] is True
|
||||
assert aff.json()["stored"] is True
|
||||
|
||||
|
||||
def test_affect_read_route_on_composite_colon_id():
|
||||
"""affect_read_route_on_composite [happy]: after an emit, GET /affect/state for a
|
||||
colon-id agent returns the snapshot verbatim from the SAME store (INV-011 / INV-008)."""
|
||||
app, _m, _a = _combined_app()
|
||||
client = TestClient(app)
|
||||
snap = _snapshot()
|
||||
client.post(
|
||||
"/bifrost/affect-call",
|
||||
json=_emit_envelope(snap),
|
||||
headers=_dispatch_headers("affect:write"),
|
||||
)
|
||||
r = client.get("/affect/state/ratatoskr:sindra", params={"end_user_id": "vuong"})
|
||||
assert r.status_code == 200
|
||||
assert r.json() == snap
|
||||
|
||||
|
||||
def test_missing_affect_store_raises():
|
||||
"""missing_affect_store [adversarial]: affect_store=None → ValueError (INV-009)."""
|
||||
memory_store = open_memory_store(":memory:", embedding_dim=_DIM)
|
||||
with pytest.raises(ValueError):
|
||||
build_combined_provider_app(memory_store, None, heimdall_key=_KEY)
|
||||
|
||||
|
||||
def test_missing_memory_store_raises():
|
||||
"""INV-009 (other half): memory_store=None → ValueError (bifrost build_combined_app)."""
|
||||
affect_store = open_affect_store(":memory:")
|
||||
with pytest.raises(ValueError):
|
||||
build_combined_provider_app(None, affect_store, heimdall_key=_KEY)
|
||||
|
||||
|
||||
def test_empty_heimdall_key_raises():
|
||||
"""PRE-002: empty heimdall_key → ValueError (combined-level guard)."""
|
||||
memory_store = open_memory_store(":memory:", embedding_dim=_DIM)
|
||||
affect_store = open_affect_store(":memory:")
|
||||
with pytest.raises(ValueError):
|
||||
build_combined_provider_app(memory_store, affect_store, heimdall_key=b"")
|
||||
|
||||
|
||||
def test_non_advertising_affect_store_raises():
|
||||
"""PRE-001 / INV-010: affect_store with affect_supported=False → ValueError."""
|
||||
memory_store = open_memory_store(":memory:", embedding_dim=_DIM)
|
||||
affect_store = open_affect_store(":memory:")
|
||||
affect_store.affect_supported = False
|
||||
with pytest.raises(ValueError):
|
||||
build_combined_provider_app(memory_store, affect_store, heimdall_key=_KEY)
|
||||
|
||||
|
||||
# --- op-feed plane='combined' (per-path derivation, INV-012) ---
|
||||
|
||||
class _RecordingSink:
|
||||
def __init__(self) -> None:
|
||||
self.events: list = []
|
||||
|
||||
def emit(self, event) -> None:
|
||||
self.events.append(event)
|
||||
|
||||
|
||||
async def _post(app, path: str, body: dict, headers: dict | None = None) -> httpx.Response:
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
async with httpx.AsyncClient(transport=transport, base_url="http://provider") as client:
|
||||
return await client.post(path, json=body, headers=headers or {})
|
||||
|
||||
|
||||
async def test_opfeed_combined_memory_call_stamps_memory():
|
||||
sink = _RecordingSink()
|
||||
app, _m, _a = _combined_app()
|
||||
wrapped = instrument_provider_app(app, plane="combined", sink=sink)
|
||||
resp = await _post(
|
||||
wrapped,
|
||||
"/bifrost/memory-call",
|
||||
{"operation": "search", "args": {"vector": [0.0] * _DIM, "top_k": 1, "scope_all": {}}},
|
||||
_dispatch_headers("memory:read"),
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].plane == "memory" # derived from path (INV-012)
|
||||
assert sink.events[0].op == "search"
|
||||
|
||||
|
||||
async def test_opfeed_combined_affect_call_stamps_affect():
|
||||
sink = _RecordingSink()
|
||||
app, _m, _a = _combined_app()
|
||||
wrapped = instrument_provider_app(app, plane="combined", sink=sink)
|
||||
resp = await _post(
|
||||
wrapped,
|
||||
"/bifrost/affect-call",
|
||||
_emit_envelope(_snapshot()),
|
||||
_dispatch_headers("affect:write"),
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].plane == "affect" # derived from path (INV-012)
|
||||
assert sink.events[0].op == "emit" # affect. prefix stripped
|
||||
|
||||
|
||||
async def test_opfeed_combined_handshake_stamps_combined():
|
||||
"""handshake isn't plane-specific → stamp plane='combined' (INV-012). A bad-version
|
||||
handshake is cleanly rejected but still emits exactly one OpEvent."""
|
||||
sink = _RecordingSink()
|
||||
app, _m, _a = _combined_app()
|
||||
wrapped = instrument_provider_app(app, plane="combined", sink=sink)
|
||||
resp = await _post(
|
||||
wrapped, "/bifrost/handshake", {"bifrost_version": "99.0.0", "mcp_version": "0.4.0"}
|
||||
)
|
||||
assert resp.status_code != 200 # major-version mismatch, cleanly rejected
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].plane == "combined"
|
||||
assert sink.events[0].op == "handshake"
|
||||
|
||||
|
||||
async def test_opfeed_combined_read_route_emits_no_event():
|
||||
"""INV-012/INV-004: the non-bifrost read route is outside _BIFROST_PATHS → NO OpEvent."""
|
||||
sink = _RecordingSink()
|
||||
app, _m, _a = _combined_app()
|
||||
wrapped = instrument_provider_app(app, plane="combined", sink=sink)
|
||||
transport = httpx.ASGITransport(app=wrapped)
|
||||
async with httpx.AsyncClient(transport=transport, base_url="http://provider") as client:
|
||||
await client.get("/affect/state/ratatoskr:sindra", params={"end_user_id": "vuong"})
|
||||
assert sink.events == []
|
||||
@@ -0,0 +1,765 @@
|
||||
"""Tests for the Tier-3 Bifrost memory provider (ratatoskr.provider.memory_store).
|
||||
|
||||
Contract: docs/contracts/bifrost_memory_provider.contract.md (v1.1)
|
||||
Vertical tracer-first: fresh_db -> basic_upsert (round-trip) -> replay -> conflict
|
||||
-> optimistic_lock -> injection_rule -> search/scope_isolation -> get/get_many ->
|
||||
delete_many -> build_memory_provider_app -> #195 parity vs InMemoryMemoryStore.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import types
|
||||
|
||||
import pytest
|
||||
from bifrost.memory import (
|
||||
IdempotencyConflict,
|
||||
InvalidArguments,
|
||||
InvalidFilter,
|
||||
RevisionMismatch,
|
||||
)
|
||||
|
||||
from ratatoskr.provider.memory_store import (
|
||||
build_memory_provider_app,
|
||||
open_memory_store,
|
||||
)
|
||||
|
||||
EMBEDDING_DIM = 8
|
||||
|
||||
|
||||
def _ctx(sub: str = "sub-1"):
|
||||
# Mirrors bifrost reference _ctx_actor: actor = job_id | jwt_sub | session_id.
|
||||
return types.SimpleNamespace(jwt_sub=sub)
|
||||
|
||||
|
||||
def _vec(*head: float) -> list[float]:
|
||||
v = list(head) + [0.0] * EMBEDDING_DIM
|
||||
return v[:EMBEDDING_DIM]
|
||||
|
||||
|
||||
def _chunk(cid: str = "c1", *, embedding=None, scope=None, **extra) -> dict:
|
||||
rec = {
|
||||
"id": cid,
|
||||
"embedding": embedding if embedding is not None else _vec(1.0),
|
||||
"scope": scope if scope is not None else {"end_user": "u1"},
|
||||
"origin": "worldtree",
|
||||
"distillate": {"summary": f"distillate-{cid}"},
|
||||
"content": f"content-{cid}",
|
||||
}
|
||||
rec.update(extra)
|
||||
return rec
|
||||
|
||||
|
||||
def _row_count(store, table: str) -> int:
|
||||
return store._conn.execute(f"SELECT COUNT(*) FROM {table}").fetchone()[0]
|
||||
|
||||
|
||||
# --- open_memory_store ---
|
||||
|
||||
def test_fresh_db_advertises_v1_caps_and_schema():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
caps = store.describe_store()
|
||||
assert caps["relational_edges_supported"] is False
|
||||
assert caps["optimistic_locking_supported"] is True
|
||||
assert caps["atomic_supersede_supported"] is False
|
||||
assert caps["transaction_supported"] is False
|
||||
assert caps["filterable_metadata_fields"] == []
|
||||
# bifrost handshake_response SortableChunkField requires BOTH name + type
|
||||
# (additionalProperties:false) — omitting `type` fails wire-schema validation and
|
||||
# breaks the ENTIRE Bifrost bind (regression guard: the deploy-breaker of 2026-07-15).
|
||||
scf = caps["sortable_chunk_fields"]
|
||||
assert scf == [{"name": "updated_at", "type": "timestamp"}]
|
||||
for entry in scf:
|
||||
assert set(entry) == {"name", "type"} # required exactly, no extra keys
|
||||
assert isinstance(entry["name"], str) and entry["name"]
|
||||
assert isinstance(entry["type"], str) and entry["type"]
|
||||
# tables + vec index queryable
|
||||
store._conn.execute("SELECT * FROM memory_chunks")
|
||||
store._conn.execute("SELECT * FROM memory_idempotency")
|
||||
store._conn.execute("SELECT * FROM memory_vec")
|
||||
|
||||
|
||||
def test_reopen_existing_file_is_idempotent(tmp_path):
|
||||
db = str(tmp_path / "memory.db")
|
||||
open_memory_store(db, embedding_dim=EMBEDDING_DIM) # first open creates schema
|
||||
store = open_memory_store(db, embedding_dim=EMBEDDING_DIM) # reopen: IF NOT EXISTS no-op
|
||||
assert isinstance(store.describe_store(), dict)
|
||||
store._conn.execute("SELECT * FROM memory_chunks")
|
||||
store._conn.execute("SELECT * FROM memory_vec")
|
||||
|
||||
|
||||
# --- upsert_many + get (tracer round-trip) ---
|
||||
|
||||
async def test_basic_upsert_round_trips_verbatim_with_revision():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
c1 = _chunk("c1", embedding=_vec(1.0))
|
||||
c2 = _chunk("c2", embedding=_vec(0.0, 1.0))
|
||||
result = await store.upsert_many([c1, c2], idempotency_key="k1", ctx=_ctx())
|
||||
assert result == {"upserted": 2, "replayed": False}
|
||||
# INV-001: each chunk round-trips verbatim, with a revision key attached (first insert -> 1)
|
||||
assert await store.get("c1") == {**c1, "revision": 1}
|
||||
assert await store.get("c2") == {**c2, "revision": 1}
|
||||
|
||||
|
||||
async def test_replay_same_key_same_payload_no_rewrite():
|
||||
# INV-002: same idempotency_key + same digest -> replay (no second write, revision frozen)
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
c1 = _chunk("c1")
|
||||
assert await store.upsert_many([c1], idempotency_key="k1", ctx=_ctx()) == {
|
||||
"upserted": 1,
|
||||
"replayed": False,
|
||||
}
|
||||
assert await store.upsert_many([c1], idempotency_key="k1", ctx=_ctx()) == {
|
||||
"upserted": 1,
|
||||
"replayed": True,
|
||||
}
|
||||
assert (await store.get("c1"))["revision"] == 1 # replay did not re-write / re-increment
|
||||
assert _row_count(store, "memory_chunks") == 1
|
||||
|
||||
|
||||
async def test_conflict_same_key_different_payload_raises_and_keeps_first():
|
||||
# INV-002: same key, different digest -> IdempotencyConflict; the first batch is intact
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
first = _chunk("c1", content="first")
|
||||
await store.upsert_many([first], idempotency_key="k1", ctx=_ctx())
|
||||
with pytest.raises(IdempotencyConflict):
|
||||
await store.upsert_many(
|
||||
[_chunk("c1", content="second")], idempotency_key="k1", ctx=_ctx()
|
||||
)
|
||||
assert await store.get("c1") == {**first, "revision": 1} # untouched
|
||||
|
||||
|
||||
async def test_optimistic_lock_stale_expected_revision_raises_nothing_written():
|
||||
# INV-003: a stale expected_revisions entry rolls back the whole batch
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
c1 = _chunk("c1", content="v1")
|
||||
await store.upsert_many([c1], idempotency_key="k1", ctx=_ctx()) # revision 1
|
||||
with pytest.raises(RevisionMismatch):
|
||||
await store.upsert_many(
|
||||
[_chunk("c1", content="v2")],
|
||||
idempotency_key="k2", # distinct key: not replay/conflict
|
||||
ctx=_ctx(),
|
||||
expected_revisions={"c1": 5}, # stale: stored revision is 1
|
||||
)
|
||||
assert await store.get("c1") == {**c1, "revision": 1} # nothing written
|
||||
assert _row_count(store, "memory_chunks") == 1
|
||||
|
||||
|
||||
async def test_optimistic_lock_match_upserts_and_increments_revision():
|
||||
# INV-003: a matching expected_revisions writes and increments (1 -> 2)
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many([_chunk("c1", content="v1")], idempotency_key="k1", ctx=_ctx())
|
||||
v2 = _chunk("c1", content="v2")
|
||||
assert await store.upsert_many(
|
||||
[v2], idempotency_key="k2", ctx=_ctx(), expected_revisions={"c1": 1}
|
||||
) == {"upserted": 1, "replayed": False}
|
||||
assert await store.get("c1") == {**v2, "revision": 2} # re-upsert increments
|
||||
assert _row_count(store, "memory_chunks") == 1
|
||||
|
||||
|
||||
async def test_injection_rule_injected_without_source_raises_no_write():
|
||||
# INV-007: origin == injected_context requires injection_source
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
bad = _chunk("c1", origin="injected_context") # no injection_source
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.upsert_many([bad], idempotency_key="k1", ctx=_ctx())
|
||||
assert _row_count(store, "memory_chunks") == 0
|
||||
|
||||
|
||||
async def test_injection_rule_non_injected_with_source_raises_no_write():
|
||||
# INV-007: a non-injected record carrying injection_source is rejected
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
bad = _chunk("c1", origin="worldtree", injection_source="elsewhere")
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.upsert_many([bad], idempotency_key="k1", ctx=_ctx())
|
||||
assert _row_count(store, "memory_chunks") == 0
|
||||
|
||||
|
||||
# --- search ---
|
||||
|
||||
async def test_basic_search_ranks_by_cosine_with_recalled_view():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
scope = {"end_user": "u1"}
|
||||
c1 = _chunk("c1", embedding=_vec(1.0, 0.0), scope=scope)
|
||||
c3 = _chunk("c3", embedding=_vec(0.9, 0.1), scope=scope)
|
||||
await store.upsert_many(
|
||||
[c1, _chunk("c2", embedding=_vec(0.0, 1.0), scope=scope), c3],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(_vec(1.0, 0.0), top_k=2, scope_all=scope)
|
||||
assert [r["chunk_id"] for r in results] == ["c1", "c3"] # nearest to [1,0] by cosine
|
||||
top = results[0]
|
||||
assert top["chunk"] == c1 # verbatim chunk, no revision attached
|
||||
assert top["recalled_view"] == {"summary": "distillate-c1"} # = chunk["distillate"]
|
||||
assert top["revision"] == 1
|
||||
assert isinstance(top["score"], float)
|
||||
|
||||
|
||||
async def test_scope_isolation_excludes_other_scope_even_if_closer():
|
||||
# INV-005: an out-of-scope chunk that scores HIGHER must not leak; only in-scope returned
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[
|
||||
_chunk("u2-near", embedding=_vec(1.0, 0.0), scope={"end_user": "u2"}), # closest
|
||||
_chunk("u1-far", embedding=_vec(0.0, 1.0), scope={"end_user": "u1"}), # in-scope, far
|
||||
],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(_vec(1.0, 0.0), top_k=2, scope_all={"end_user": "u1"})
|
||||
assert [r["chunk_id"] for r in results] == ["u1-far"] # u2-near excluded despite ranking first
|
||||
|
||||
|
||||
async def test_search_empty_store_returns_empty():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
assert await store.search(_vec(1.0), top_k=5) == []
|
||||
|
||||
|
||||
async def test_search_non_empty_metadata_filter_rejected():
|
||||
# PRE-002: v1 advertises no filterable metadata fields
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.search(_vec(1.0), top_k=5, metadata_filter={"x": 1})
|
||||
|
||||
|
||||
async def test_search_wrong_vector_dim_rejected():
|
||||
# PRE-001: vector length must equal the pinned embedding_dim
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.search([1.0, 0.0], top_k=5)
|
||||
|
||||
|
||||
async def test_search_non_dict_scope_all_rejected():
|
||||
# search STEP 1: scope_all must be a flat {axis: value} dict
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.search(_vec(1.0), top_k=5, scope_all="u1")
|
||||
|
||||
|
||||
async def test_search_non_list_scope_any_rejected():
|
||||
# search STEP 1: scope_any must be a LIST of {axis: value} dicts (#11)
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.search(_vec(1.0), top_k=5, scope_any={"end_user": "u1"})
|
||||
|
||||
|
||||
async def test_search_out_of_lattice_scope_axis_rejected():
|
||||
# v0.6 scope lattice = {end_user, group, tenant, agent_self}; an axis outside
|
||||
# it is InvalidFilter (-> memory.invalid_filter 400) in EITHER field, matching the reference.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidFilter):
|
||||
await store.search(_vec(1.0), top_k=5, scope_all={"bogus_axis": "x"})
|
||||
with pytest.raises(InvalidFilter):
|
||||
await store.search(_vec(1.0), top_k=5, scope_any=[{"bogus_axis": "x"}])
|
||||
|
||||
|
||||
async def test_search_agent_self_axis_accepted():
|
||||
# agent_self became canonical at wire v0.5 (#10) — admitted, not rejected.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[_chunk("a1", scope={"agent_self": "ratatoskr:smoke"})],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(
|
||||
_vec(1.0), top_k=5, scope_all={"agent_self": "ratatoskr:smoke"}
|
||||
)
|
||||
assert [r["chunk_id"] for r in results] == ["a1"]
|
||||
|
||||
|
||||
async def test_search_top_k_zero_returns_empty():
|
||||
# POST-001: at most top_k — zero means zero
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many([_chunk("c1")], idempotency_key="k1", ctx=_ctx())
|
||||
assert await store.search(_vec(1.0), top_k=0, scope_all={"end_user": "u1"}) == []
|
||||
|
||||
|
||||
async def test_search_no_scope_matches_all():
|
||||
# v0.6: both fields empty -> no scope constraint (match all, within top_k).
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[
|
||||
_chunk("u1", scope={"end_user": "u1"}),
|
||||
_chunk("u2", scope={"end_user": "u2"}),
|
||||
],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(_vec(1.0), top_k=10)
|
||||
assert {r["chunk_id"] for r in results} == {"u1", "u2"}
|
||||
|
||||
|
||||
async def test_search_scope_any_unions_across_scopes():
|
||||
# v0.6 (#11): scope_any is OR/union over a LIST of conjunctive scopes. A {end_user:u1}
|
||||
# chunk AND an {agent_self:a} chunk are BOTH recalled in ONE call — the capability
|
||||
# that resolves the #295/#297 silent-zero AND foot-gun (subset-scoped chunks now recall).
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[
|
||||
_chunk("subj", embedding=_vec(1.0, 0.0), scope={"end_user": "u1"}),
|
||||
_chunk("self", embedding=_vec(0.9, 0.1), scope={"agent_self": "ratatoskr:sindra"}),
|
||||
_chunk("other", embedding=_vec(0.8, 0.2), scope={"end_user": "u9"}),
|
||||
],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(
|
||||
_vec(1.0, 0.0),
|
||||
top_k=10,
|
||||
scope_any=[{"end_user": "u1"}, {"agent_self": "ratatoskr:sindra"}],
|
||||
)
|
||||
assert {r["chunk_id"] for r in results} == {"subj", "self"} # union; u9 excluded
|
||||
|
||||
|
||||
async def test_search_scope_all_and_scope_any_compose_by_and():
|
||||
# v0.6: a record passes iff (record ⊇ scope_all) AND (matches ≥1 scope_any element).
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[
|
||||
# tenant t1 AND (end_user u1 OR u2) — only these pass
|
||||
_chunk("t1u1", embedding=_vec(1.0, 0.0), scope={"tenant": "t1", "end_user": "u1"}),
|
||||
_chunk("t1u2", embedding=_vec(0.9, 0.1), scope={"tenant": "t1", "end_user": "u2"}),
|
||||
_chunk("t1u9", embedding=_vec(0.8, 0.2), scope={"tenant": "t1", "end_user": "u9"}),
|
||||
_chunk("t2u1", embedding=_vec(0.7, 0.3), scope={"tenant": "t2", "end_user": "u1"}),
|
||||
],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(
|
||||
_vec(1.0, 0.0),
|
||||
top_k=10,
|
||||
scope_all={"tenant": "t1"},
|
||||
scope_any=[{"end_user": "u1"}, {"end_user": "u2"}],
|
||||
)
|
||||
assert {r["chunk_id"] for r in results} == {"t1u1", "t1u2"} # t1u9 fails any; t2u1 fails all
|
||||
|
||||
|
||||
async def test_scope_isolation_fills_top_k_from_in_scope_past_higher_out_of_scope():
|
||||
# INV-005: top_k counts IN-SCOPE hits. An out-of-scope chunk ranking #1 is skipped,
|
||||
# and top_k is still filled from the in-scope set when enough in-scope chunks exist.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many(
|
||||
[
|
||||
_chunk("u2-nearest", embedding=_vec(1.0, 0.0), scope={"end_user": "u2"}), # ranks #1
|
||||
_chunk("u1-near", embedding=_vec(0.95, 0.05), scope={"end_user": "u1"}),
|
||||
_chunk("u1-mid", embedding=_vec(0.8, 0.2), scope={"end_user": "u1"}),
|
||||
_chunk("u1-far", embedding=_vec(0.0, 1.0), scope={"end_user": "u1"}),
|
||||
],
|
||||
idempotency_key="k1",
|
||||
ctx=_ctx(),
|
||||
)
|
||||
results = await store.search(_vec(1.0, 0.0), top_k=2, scope_all={"end_user": "u1"})
|
||||
# exactly top_k in-scope (the 2 nearest u1 chunks); the higher-ranked u2 chunk is excluded
|
||||
assert [r["chunk_id"] for r in results] == ["u1-near", "u1-mid"]
|
||||
|
||||
|
||||
# --- get / get_many ---
|
||||
|
||||
async def test_get_absent_returns_none():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
assert await store.get("nope") is None
|
||||
|
||||
|
||||
async def test_get_many_returns_found_records_only():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
c1 = _chunk("c1")
|
||||
await store.upsert_many([c1], idempotency_key="k1", ctx=_ctx())
|
||||
assert await store.get_many(["c1", "absent"]) == [{**c1, "revision": 1}]
|
||||
|
||||
|
||||
# --- delete_many ---
|
||||
|
||||
async def test_delete_hit_removes_chunk_and_vec_row():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await store.upsert_many([_chunk("c1"), _chunk("c2")], idempotency_key="k1", ctx=_ctx())
|
||||
assert await store.delete_many(["c1"]) == {"deleted": 1}
|
||||
assert await store.get("c1") is None
|
||||
assert _row_count(store, "memory_chunks") == 1
|
||||
assert _row_count(store, "memory_vec") == 1 # c1's vec row gone too (no orphan)
|
||||
# delete_hit: search no longer surfaces it (vec/chunk coupling held)
|
||||
hits = await store.search(_vec(1.0), top_k=5, scope_all={"end_user": "u1"})
|
||||
assert all(r["chunk_id"] != "c1" for r in hits)
|
||||
|
||||
|
||||
async def test_delete_absent_counts_zero():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
assert await store.delete_many(["nope"]) == {"deleted": 0}
|
||||
|
||||
|
||||
# --- scan (#349 person-prime: sorted, live-only, paginated) ---
|
||||
|
||||
async def test_scan_recency_returns_newest_live_chunks_desc():
|
||||
# tracer: upsert 4 live chunks with distinct updated_at; scan limit=3 desc -> 3 newest
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
recs = [
|
||||
_chunk(f"c{i}", scope={"end_user": "u1"}, updated_at=f"2026-07-15T00:0{i}:00+00:00")
|
||||
for i in range(4)
|
||||
]
|
||||
await store.upsert_many(recs, idempotency_key="k1", ctx=_ctx())
|
||||
out = await store.scan(
|
||||
scope_all={"end_user": "u1"},
|
||||
limit=3,
|
||||
sort={"field": "updated_at", "direction": "desc"},
|
||||
)
|
||||
assert [r["id"] for r in out["records"]] == ["c3", "c2", "c1"] # 3 globally-newest, newest-first
|
||||
assert "cursor" in out
|
||||
|
||||
|
||||
async def test_scan_excludes_superseded_and_tombstoned():
|
||||
# INV-009: dead chunks never returned, even if they're the newest.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
recs = [
|
||||
_chunk("live1", scope={"end_user": "u1"}, updated_at="2026-07-15T00:01:00+00:00"),
|
||||
_chunk("dead1", scope={"end_user": "u1"}, updated_at="2026-07-15T00:09:00+00:00", lifecycle_state="superseded"),
|
||||
_chunk("dead2", scope={"end_user": "u1"}, updated_at="2026-07-15T00:08:00+00:00", verbatim={"text": "x", "governance_state": "tombstoned"}),
|
||||
]
|
||||
await store.upsert_many(recs, idempotency_key="k", ctx=_ctx())
|
||||
out = await store.scan(scope_all={"end_user": "u1"}, limit=10, sort={"field": "updated_at", "direction": "desc"})
|
||||
assert [r["id"] for r in out["records"]] == ["live1"]
|
||||
|
||||
|
||||
async def test_scan_scope_isolation_excludes_other_partition():
|
||||
# INV-005 applies to scan.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
recs = [
|
||||
_chunk("a", scope={"end_user": "u1"}, updated_at="2026-07-15T00:01:00+00:00"),
|
||||
_chunk("b", scope={"end_user": "u2"}, updated_at="2026-07-15T00:09:00+00:00"),
|
||||
]
|
||||
await store.upsert_many(recs, idempotency_key="k", ctx=_ctx())
|
||||
out = await store.scan(scope_all={"end_user": "u1"}, limit=10, sort={"field": "updated_at", "direction": "desc"})
|
||||
assert [r["id"] for r in out["records"]] == ["a"] # u2's newer chunk never surfaces
|
||||
|
||||
|
||||
async def test_scan_unadvertised_sort_field_rejected():
|
||||
# PRE-003: a sort field not in sortable_chunk_fields -> InvalidArguments (never silent unsorted).
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.scan(scope_all={"end_user": "u1"}, limit=3, sort={"field": "salience", "direction": "desc"})
|
||||
|
||||
|
||||
async def test_scan_non_dict_sort_rejected():
|
||||
# PRE-003: a truthy non-dict sort (caller-controlled) -> InvalidArguments, never AttributeError.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
for bad in ("updated_at", ["updated_at"], 5):
|
||||
with pytest.raises(InvalidArguments):
|
||||
await store.scan(scope_all={"end_user": "u1"}, limit=3, sort=bad)
|
||||
|
||||
|
||||
async def test_scan_records_carry_person_prime_filter_fields():
|
||||
# The client _scan_filter_matches keys on agent_id + subject + worldtree_scope; a record
|
||||
# missing any is silently dropped -> the scan record must carry them verbatim.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
rec = _chunk(
|
||||
"c1", scope={"end_user": "u1"}, updated_at="2026-07-15T00:01:00+00:00",
|
||||
agent_id="ratatoskr:sindra", subject={"type": "end_user", "id": "u1"}, worldtree_scope="end_user",
|
||||
)
|
||||
await store.upsert_many([rec], idempotency_key="k", ctx=_ctx())
|
||||
out = await store.scan(scope_all={"end_user": "u1"}, limit=3, sort={"field": "updated_at", "direction": "desc"})
|
||||
r = out["records"][0]
|
||||
assert r["agent_id"] == "ratatoskr:sindra"
|
||||
assert r["subject"] == {"type": "end_user", "id": "u1"}
|
||||
assert r["worldtree_scope"] == "end_user"
|
||||
assert r["updated_at"] == "2026-07-15T00:01:00+00:00"
|
||||
|
||||
|
||||
async def test_scan_global_order_across_pages_via_cursor():
|
||||
# INV-010: the cursor page continues the GLOBAL order, never a page-local re-sort.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
recs = [_chunk(f"c{i}", scope={"end_user": "u1"}, updated_at=f"2026-07-15T00:0{i}:00+00:00") for i in range(5)]
|
||||
await store.upsert_many(recs, idempotency_key="k", ctx=_ctx())
|
||||
p1 = await store.scan(scope_all={"end_user": "u1"}, limit=2, sort={"field": "updated_at", "direction": "desc"})
|
||||
assert [r["id"] for r in p1["records"]] == ["c4", "c3"] # 2 globally-newest
|
||||
assert p1["cursor"] is not None
|
||||
p2 = await store.scan(scope_all={"end_user": "u1"}, limit=2, cursor=p1["cursor"], sort={"field": "updated_at", "direction": "desc"})
|
||||
assert [r["id"] for r in p2["records"]] == ["c2", "c1"] # continues the global order
|
||||
|
||||
|
||||
async def test_scan_parity_vs_reference_inmemory_store():
|
||||
# #195: identical scan envelopes vs the bifrost reference InMemoryMemoryStore produce
|
||||
# the SAME ordered chunk_ids + verbatim record shape. All chunks LIVE — our scan is
|
||||
# live-only (INV-009) while the reference does NOT lifecycle-filter, so parity is only
|
||||
# defined over the live set (the person-prime case). Both READ updated_at from the
|
||||
# record (neither stamps it), so ordering is a pure function of the shared input.
|
||||
from bifrost.consumer.testing import InMemoryMemoryStore
|
||||
|
||||
records = [
|
||||
_chunk("z1", scope={"end_user": "u1"}, updated_at="2026-07-15T00:03:00+00:00"),
|
||||
_chunk("a2", scope={"end_user": "u1"}, updated_at="2026-07-15T00:01:00+00:00"),
|
||||
_chunk("a3", scope={"end_user": "u1"}, updated_at="2026-07-15T00:01:00+00:00"),
|
||||
_chunk("m4", scope={"end_user": "u1"}), # no updated_at -> sorts LAST, both directions
|
||||
]
|
||||
scope_all = {"end_user": "u1"}
|
||||
sort = {"field": "updated_at", "direction": "desc"}
|
||||
|
||||
ours = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await ours.upsert_many(records, idempotency_key="k", ctx=_ctx())
|
||||
ref = InMemoryMemoryStore()
|
||||
await ref.upsert_many(records, idempotency_key="k", ctx=_ctx())
|
||||
|
||||
# identical scan envelope on both stores
|
||||
out_ours = await ours.scan(scope_all=scope_all, limit=10, sort=sort)
|
||||
out_ref = await ref.scan(scope_all=scope_all, limit=10, sort=sort)
|
||||
|
||||
# recency beats id (z1 first despite 'z' > 'a'); tie broken by id asc (a2 < a3);
|
||||
# missing updated_at sorts last (m4).
|
||||
expected = ["z1", "a2", "a3", "m4"]
|
||||
assert [r["id"] for r in out_ref["records"]] == expected
|
||||
assert [r["id"] for r in out_ours["records"]] == expected
|
||||
assert out_ours["records"] == out_ref["records"] # verbatim record shape parity
|
||||
|
||||
|
||||
# --- build_memory_provider_app ---
|
||||
|
||||
def test_build_app_exposes_handshake_and_memory_routes():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
app = build_memory_provider_app(store, heimdall_key=b"secret-key")
|
||||
routes = {getattr(r, "path", None): r for r in app.routes}
|
||||
assert "/bifrost/handshake" in routes
|
||||
assert "/bifrost/memory-call" in routes
|
||||
assert "POST" in routes["/bifrost/memory-call"].methods
|
||||
assert "POST" in routes["/bifrost/handshake"].methods # both routes are POST (incl. POST)
|
||||
|
||||
|
||||
def test_build_app_rejects_empty_key():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
with pytest.raises(ValueError):
|
||||
build_memory_provider_app(store, heimdall_key=b"")
|
||||
|
||||
|
||||
# --- #195 conformance: parity vs the reference store through the real engine ---
|
||||
|
||||
def _dispatch_ctx(*scopes: str, session_id: str = "actor-1"):
|
||||
return types.SimpleNamespace(
|
||||
scope=list(scopes), session_id=session_id, jwt_sub=session_id, job_id=None
|
||||
)
|
||||
|
||||
|
||||
def _ref_record(chunk_id: str, vector: list[float], *, end_user: str = "u1") -> dict:
|
||||
# Mirrors bifrost's reference `record` helper so the envelope validates.
|
||||
return {
|
||||
"id": chunk_id,
|
||||
"embedding": vector,
|
||||
"distillate": {"text": chunk_id},
|
||||
"metadata": {"worldtree.appraisal_confidence": 0.8},
|
||||
"scope": {"end_user": end_user, "tenant": "t1"},
|
||||
"origin": "worldtree",
|
||||
"source_role": "assistant",
|
||||
"trust_tier": "tier-3",
|
||||
"provenance": {"trace": chunk_id},
|
||||
}
|
||||
|
||||
|
||||
async def test_parity_upsert_many_vs_reference_through_dispatch():
|
||||
from bifrost.consumer.testing import InMemoryMemoryStore
|
||||
from bifrost.memory import dispatch_memory_call
|
||||
|
||||
ref = InMemoryMemoryStore()
|
||||
mine = open_memory_store(":memory:", embedding_dim=2)
|
||||
wctx = _dispatch_ctx("memory:write")
|
||||
env = {
|
||||
"operation": "upsert_many",
|
||||
"args": {"records": [_ref_record("a", [1.0, 0.0]), _ref_record("b", [0.0, 1.0])]},
|
||||
"idempotency_key": "k1",
|
||||
}
|
||||
# happy persist + replay: wire bodies must agree
|
||||
assert await dispatch_memory_call(env, wctx, ref) == await dispatch_memory_call(env, wctx, mine)
|
||||
assert await dispatch_memory_call(env, wctx, ref) == await dispatch_memory_call(env, wctx, mine)
|
||||
|
||||
|
||||
async def test_parity_search_ranked_ids_vs_reference_through_dispatch():
|
||||
from bifrost.consumer.testing import InMemoryMemoryStore
|
||||
from bifrost.memory import dispatch_memory_call
|
||||
|
||||
ref = InMemoryMemoryStore()
|
||||
mine = open_memory_store(":memory:", embedding_dim=2)
|
||||
wctx = _dispatch_ctx("memory:write")
|
||||
rctx = _dispatch_ctx("memory:read")
|
||||
up = {
|
||||
"operation": "upsert_many",
|
||||
"args": {
|
||||
"records": [
|
||||
_ref_record("a", [1.0, 0.0]),
|
||||
_ref_record("b", [0.0, 1.0]),
|
||||
_ref_record("c", [0.9, 0.1]),
|
||||
]
|
||||
},
|
||||
"idempotency_key": "k1",
|
||||
}
|
||||
await dispatch_memory_call(up, wctx, ref)
|
||||
await dispatch_memory_call(up, wctx, mine)
|
||||
search_env = {
|
||||
"operation": "search",
|
||||
"args": {"vector": [1.0, 0.0], "top_k": 2, "scope_all": {"end_user": "u1"}},
|
||||
}
|
||||
rstatus, rbody = await dispatch_memory_call(search_env, rctx, ref)
|
||||
mstatus, mbody = await dispatch_memory_call(search_env, rctx, mine)
|
||||
assert rstatus == mstatus == 200
|
||||
# #195: same ranked chunk_ids and the same per-result shape (scores may differ in the
|
||||
# last float digit between vec0's cosine and the reference's Python cosine).
|
||||
assert [r["chunk_id"] for r in rbody["results"]] == [r["chunk_id"] for r in mbody["results"]]
|
||||
assert set(rbody["results"][0]) == set(mbody["results"][0])
|
||||
|
||||
|
||||
async def test_parity_expected_revisions_vs_reference_through_dispatch():
|
||||
# #195: pins the partial-map optimistic-lock semantics against the reference
|
||||
# (does an expected_revisions map that omits some batch records lock only the
|
||||
# listed ones?). Resolves the contract's ambiguous "each record's stored revision".
|
||||
from bifrost.consumer.testing import InMemoryMemoryStore
|
||||
from bifrost.memory import dispatch_memory_call
|
||||
|
||||
ref = InMemoryMemoryStore()
|
||||
mine = open_memory_store(":memory:", embedding_dim=2)
|
||||
wctx = _dispatch_ctx("memory:write")
|
||||
|
||||
seed = {
|
||||
"operation": "upsert_many",
|
||||
"args": {"records": [_ref_record("a", [1.0, 0.0]), _ref_record("b", [0.0, 1.0])]},
|
||||
"idempotency_key": "seed",
|
||||
}
|
||||
ref_seed = await dispatch_memory_call(seed, wctx, ref)
|
||||
mine_seed = await dispatch_memory_call(seed, wctx, mine)
|
||||
assert ref_seed == mine_seed
|
||||
|
||||
# partial map: only "a" is locked (revision 1); "b" is omitted from expected_revisions
|
||||
partial = {
|
||||
"operation": "upsert_many",
|
||||
"args": {
|
||||
"records": [_ref_record("a", [1.0, 0.0]), _ref_record("b", [0.0, 1.0])],
|
||||
"expected_revisions": {"a": 1},
|
||||
},
|
||||
"idempotency_key": "partial",
|
||||
}
|
||||
assert await dispatch_memory_call(partial, wctx, ref) == await dispatch_memory_call(
|
||||
partial, wctx, mine
|
||||
)
|
||||
|
||||
# stale lock: both map to the same RevisionMismatch wire error
|
||||
stale = {
|
||||
"operation": "upsert_many",
|
||||
"args": {"records": [_ref_record("a", [1.0, 0.0])], "expected_revisions": {"a": 99}},
|
||||
"idempotency_key": "stale",
|
||||
}
|
||||
assert await dispatch_memory_call(stale, wctx, ref) == await dispatch_memory_call(
|
||||
stale, wctx, mine
|
||||
)
|
||||
|
||||
|
||||
# --- memory viewer DEBUG read route (GET /memory/chunks) ---------------------
|
||||
# Non-bifrost debug read on OUR store: list_chunks + add_memory_read_route + the
|
||||
# GET /memory/chunks route. Mirrors the affect D2 read-route tests.
|
||||
|
||||
from starlette.testclient import TestClient # noqa: E402
|
||||
|
||||
from ratatoskr.provider.memory_store import ( # noqa: E402
|
||||
add_memory_read_route,
|
||||
build_memory_provider_app as _build_mem_app, # noqa: F401 (re-import for clarity)
|
||||
)
|
||||
|
||||
|
||||
async def _seed_chunk(store, cid, *, scope, content=None, origin="worldtree"):
|
||||
extra = {}
|
||||
if content is not None:
|
||||
extra["content"] = content
|
||||
await store.upsert_many(
|
||||
[_chunk(cid, embedding=_vec(1.0), scope=scope, origin=origin, **extra)],
|
||||
idempotency_key="seed-" + cid,
|
||||
ctx=_ctx(),
|
||||
)
|
||||
|
||||
|
||||
async def test_list_chunks_filters_strict_end_user_lenient_agent():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await _seed_chunk(store, "c1", scope={"end_user": "vuong", "agent_self": "ratatoskr:sindra"})
|
||||
await _seed_chunk(store, "c2", scope={"end_user": "vuong"}) # no agent_self → lenient keep
|
||||
await _seed_chunk(store, "c3", scope={"end_user": "other", "agent_self": "ratatoskr:sindra"})
|
||||
await _seed_chunk(store, "c4", scope={"end_user": "vuong", "agent_self": "ratatoskr:other"})
|
||||
got = store.list_chunks(agent_id="ratatoskr:sindra", end_user_id="vuong")
|
||||
ids = sorted(c["chunk_id"] for c in got)
|
||||
assert ids == ["c1", "c2"] # c3 wrong end_user, c4 different agent_self
|
||||
# content·scope·origin·revision surfaced
|
||||
c1 = next(c for c in got if c["chunk_id"] == "c1")
|
||||
assert c1["content"] == "content-c1"
|
||||
assert c1["scope"] == {"end_user": "vuong", "agent_self": "ratatoskr:sindra"}
|
||||
assert c1["origin"] == "worldtree"
|
||||
assert c1["revision"] == 1
|
||||
|
||||
|
||||
async def test_list_chunks_no_agent_filter_returns_all_for_end_user():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
await _seed_chunk(store, "c1", scope={"end_user": "vuong", "agent_self": "a"})
|
||||
await _seed_chunk(store, "c2", scope={"end_user": "vuong", "agent_self": "b"})
|
||||
await _seed_chunk(store, "c3", scope={"end_user": "nope"})
|
||||
got = store.list_chunks(end_user_id="vuong")
|
||||
assert sorted(c["chunk_id"] for c in got) == ["c1", "c2"]
|
||||
|
||||
|
||||
def test_count_chunks_reports_total_unfiltered():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
assert store.count_chunks() == 0
|
||||
|
||||
|
||||
def _seed_row(store, cid, *, scope, content="x", origin="worldtree", revision=1):
|
||||
"""Sync seed for the route tests (TestClient is sync): insert a chunk row directly.
|
||||
The read route only reads memory_chunks, so the vec row is unnecessary here."""
|
||||
import json as _j
|
||||
rec = {"id": cid, "content": content, "scope": scope, "origin": origin}
|
||||
store._conn.execute(
|
||||
"INSERT INTO memory_chunks (chunk_id, record_json, revision, scope_json, origin) "
|
||||
"VALUES (?, ?, ?, ?, ?)",
|
||||
(cid, _j.dumps(rec), revision, _j.dumps(scope), origin),
|
||||
)
|
||||
store._conn.commit()
|
||||
|
||||
|
||||
def test_memory_chunks_route_returns_matched_and_total():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
_seed_row(store, "c1", scope={"end_user": "vuong", "agent_self": "ratatoskr:sindra"})
|
||||
_seed_row(store, "c2", scope={"end_user": "other"})
|
||||
app = build_memory_provider_app(store, heimdall_key=b"k")
|
||||
client = TestClient(app)
|
||||
r = client.get("/memory/chunks", params={"agent_id": "ratatoskr:sindra", "end_user_id": "vuong"})
|
||||
assert r.status_code == 200
|
||||
body = r.json()
|
||||
assert body["count"] == 1
|
||||
assert body["total"] == 2 # store has 2 chunks; only 1 matched the partition
|
||||
assert body["chunks"][0]["chunk_id"] == "c1"
|
||||
|
||||
|
||||
def test_memory_chunks_route_empty_match_is_200_empty_list():
|
||||
# The 0-chunks state is a VISIBLE answer (not a 404): count 0, total shows the store.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
app = build_memory_provider_app(store, heimdall_key=b"k")
|
||||
r = TestClient(app).get("/memory/chunks", params={"end_user_id": "vuong"})
|
||||
assert r.status_code == 200
|
||||
body = r.json()
|
||||
assert body == {"chunks": [], "count": 0, "total": 0}
|
||||
|
||||
|
||||
def test_memory_chunks_route_missing_end_user_id_returns_400():
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
app = build_memory_provider_app(store, heimdall_key=b"k")
|
||||
r = TestClient(app).get("/memory/chunks") # no end_user_id
|
||||
assert r.status_code == 400
|
||||
assert r.json()["error_code"] == "missing_end_user_id"
|
||||
|
||||
|
||||
def test_build_memory_app_keeps_bifrost_routes_top_level():
|
||||
# POST-002 parity with affect D2: add_memory_read_route uses add_route (not Mount),
|
||||
# so /bifrost/* stay top-level and the op-feed path check still matches them.
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
app = build_memory_provider_app(store, heimdall_key=b"k")
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
assert "/bifrost/handshake" in paths
|
||||
assert "/bifrost/memory-call" in paths
|
||||
assert "/memory/chunks" in paths
|
||||
|
||||
|
||||
def test_add_memory_read_route_is_shared_helper_on_bare_app():
|
||||
# The helper mounts the route on any app (used by both build_memory_provider_app and
|
||||
# the combined provider) — mirror of add_affect_read_route's shared-helper shape.
|
||||
from starlette.applications import Starlette
|
||||
store = open_memory_store(":memory:", embedding_dim=EMBEDDING_DIM)
|
||||
app = Starlette()
|
||||
add_memory_read_route(app, store)
|
||||
r = TestClient(app).get("/memory/chunks", params={"end_user_id": "u"})
|
||||
assert r.status_code == 200
|
||||
assert r.json()["total"] == 0
|
||||
@@ -0,0 +1,336 @@
|
||||
"""Tests for the dispatch-layer observe feed (ratatoskr.provider.opfeed).
|
||||
|
||||
Issue #17 slice 2 (the Observe half). These drive the REAL bifrost provider ASGI
|
||||
app end-to-end through `instrument_provider_app`, minting a valid dispatch JWT with
|
||||
bifrost's own `mint_dispatch_jwt` — so the envelopes and the session_id claim are
|
||||
the real wire shapes, not hand-mocked guesses (the repo's "test against the
|
||||
shipped lib" posture).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
from bifrost.core.dispatch_jwt import mint_dispatch_jwt
|
||||
|
||||
from ratatoskr.provider.affect_store import (
|
||||
build_affect_provider_app,
|
||||
open_affect_store,
|
||||
)
|
||||
from ratatoskr.provider.memory_store import (
|
||||
build_memory_provider_app,
|
||||
open_memory_store,
|
||||
)
|
||||
from ratatoskr.provider.opfeed import instrument_provider_app
|
||||
|
||||
_KEY = "shared-secret"
|
||||
_DIM = 8
|
||||
_CONSUMER = "ratatoskr"
|
||||
|
||||
|
||||
class _RecordingSink:
|
||||
"""An OpSink that just records events (so a test can assert on them)."""
|
||||
|
||||
def __init__(self) -> None:
|
||||
self.events: list = []
|
||||
|
||||
def emit(self, event) -> None:
|
||||
self.events.append(event)
|
||||
|
||||
|
||||
def _mint(session_id: str, scope: list[str]) -> str:
|
||||
return mint_dispatch_jwt(
|
||||
session_id=session_id,
|
||||
consumer_id=_CONSUMER,
|
||||
issuer="worldtree",
|
||||
scope=scope,
|
||||
secret_or_key=_KEY,
|
||||
algorithm="HS256",
|
||||
)
|
||||
|
||||
|
||||
def _wrapped_memory_app(sink):
|
||||
store = open_memory_store(":memory:", embedding_dim=_DIM)
|
||||
app = build_memory_provider_app(
|
||||
store, heimdall_key=_KEY.encode(), consumer_id=_CONSUMER
|
||||
)
|
||||
return instrument_provider_app(app, plane="memory", sink=sink), store
|
||||
|
||||
|
||||
def _wrapped_affect_app(sink):
|
||||
store = open_affect_store(":memory:")
|
||||
app = build_affect_provider_app(
|
||||
store, heimdall_key=_KEY.encode(), consumer_id=_CONSUMER
|
||||
)
|
||||
return instrument_provider_app(app, plane="affect", sink=sink), store
|
||||
|
||||
|
||||
def _chunk(cid: str, scope: dict | None = None) -> dict:
|
||||
return {
|
||||
"id": cid,
|
||||
"scope": scope or {"end_user": "u1"},
|
||||
"embedding": [0.1] * _DIM,
|
||||
"content": "x",
|
||||
}
|
||||
|
||||
|
||||
class _RaisingSink:
|
||||
def emit(self, event) -> None:
|
||||
raise RuntimeError("boom")
|
||||
|
||||
|
||||
async def _post(app, path: str, body: dict, jwt: str | None) -> httpx.Response:
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
headers = {"Authorization": f"Bearer {jwt}"} if jwt else {}
|
||||
async with httpx.AsyncClient(
|
||||
transport=transport, base_url="http://provider"
|
||||
) as client:
|
||||
return await client.post(path, json=body, headers=headers)
|
||||
|
||||
|
||||
class TestOpFeedMemory:
|
||||
async def test_search_emits_one_opevent(self) -> None:
|
||||
"""search [tracer]: a memory search dispatched through the wrapped app
|
||||
emits EXACTLY ONE OpEvent — plane=memory, op=search, session_id from the
|
||||
JWT sub, status=ok, scope-only req/resp summaries (POST-001/002, INV-005).
|
||||
Empty store → 0 hits."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
jwt = _mint("session-abc", ["memory:read"])
|
||||
body = {
|
||||
"operation": "search",
|
||||
"args": {
|
||||
"vector": [0.0] * _DIM,
|
||||
"top_k": 5,
|
||||
"scope_all": {"end_user": "u1"},
|
||||
"scope_any": [],
|
||||
},
|
||||
}
|
||||
resp = await _post(app, "/bifrost/memory-call", body, jwt)
|
||||
|
||||
assert resp.status_code == 200
|
||||
assert len(sink.events) == 1
|
||||
ev = sink.events[0]
|
||||
assert ev.plane == "memory"
|
||||
assert ev.op == "search"
|
||||
assert ev.session_id == "session-abc"
|
||||
assert ev.status == "ok"
|
||||
assert ev.req_summary == {
|
||||
"scope_all": {"end_user": "u1"},
|
||||
"scope_any": [],
|
||||
"top_k": 5,
|
||||
}
|
||||
assert ev.resp_summary["hit_count"] == 0
|
||||
assert ev.turn_id is None
|
||||
assert ev.ts # non-empty capture timestamp
|
||||
|
||||
async def test_upsert_many_summary(self) -> None:
|
||||
"""upsert_many: req carries record_count + per-record scopes (no bodies);
|
||||
resp carries upserted + replayed."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
jwt = _mint("session-up", ["memory:write"])
|
||||
body = {
|
||||
"operation": "upsert_many",
|
||||
"args": {"records": [_chunk("c1"), _chunk("c2", {"end_user": "u2"})]},
|
||||
"idempotency_key": "k1",
|
||||
}
|
||||
resp = await _post(app, "/bifrost/memory-call", body, jwt)
|
||||
|
||||
assert resp.status_code == 200
|
||||
ev = sink.events[-1]
|
||||
assert ev.op == "upsert_many"
|
||||
assert ev.status == "ok"
|
||||
assert ev.req_summary == {
|
||||
"record_count": 2,
|
||||
"scopes": [{"end_user": "u1"}, {"end_user": "u2"}],
|
||||
}
|
||||
assert ev.resp_summary == {"upserted": 2, "replayed": False}
|
||||
|
||||
async def test_get_and_delete_summaries(self) -> None:
|
||||
"""get -> found_count; delete_many -> deleted; both req carry ids only."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{
|
||||
"operation": "upsert_many",
|
||||
"args": {"records": [_chunk("c1")]},
|
||||
"idempotency_key": "k1",
|
||||
},
|
||||
_mint("s", ["memory:write"]),
|
||||
)
|
||||
await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{"operation": "get", "args": {"chunk_id": "c1"}},
|
||||
_mint("s", ["memory:read"]),
|
||||
)
|
||||
get_ev = sink.events[-1]
|
||||
assert get_ev.op == "get"
|
||||
assert get_ev.req_summary == {"ids": ["c1"]}
|
||||
assert get_ev.resp_summary == {"found_count": 1}
|
||||
|
||||
await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{"operation": "delete_many", "args": {"ids": ["c1"]}},
|
||||
_mint("s", ["memory:write"]),
|
||||
)
|
||||
del_ev = sink.events[-1]
|
||||
assert del_ev.op == "delete_many"
|
||||
assert del_ev.req_summary == {"ids": ["c1"]}
|
||||
assert del_ev.resp_summary == {"deleted": 1}
|
||||
|
||||
async def test_error_status_records_the_bifrost_code(self) -> None:
|
||||
"""error [adversarial]: an unknown operation -> status=error and the
|
||||
bifrost error `code` is recorded, never hidden (INV-007)."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
resp = await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{"operation": "bogus", "args": {}},
|
||||
_mint("s", ["memory:read"]),
|
||||
)
|
||||
assert resp.status_code != 200
|
||||
assert len(sink.events) == 1
|
||||
ev = sink.events[0]
|
||||
assert ev.op == "bogus"
|
||||
assert ev.status == "error"
|
||||
assert ev.resp_summary == {"error": "memory.invalid_arguments"}
|
||||
|
||||
async def test_missing_jwt_session_id_none_still_emits(self) -> None:
|
||||
"""no_jwt [boundary]: a call with NO Authorization still emits exactly one
|
||||
OpEvent with session_id=None (INV-005) and status=error (auth rejected)."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
resp = await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{"operation": "search", "args": {"vector": [0.0] * _DIM, "top_k": 1}},
|
||||
None,
|
||||
)
|
||||
assert resp.status_code != 200
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].session_id is None
|
||||
assert sink.events[0].status == "error"
|
||||
|
||||
async def test_handshake_op_from_path(self) -> None:
|
||||
"""handshake: op is derived from the PATH (handshake bodies carry no
|
||||
`operation` field); still exactly one OpEvent (POST-001 incl. handshake)."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
resp = await _post(
|
||||
app,
|
||||
"/bifrost/handshake",
|
||||
{"bifrost_version": "99.0.0", "mcp_version": "0.4.0"},
|
||||
None,
|
||||
)
|
||||
assert resp.status_code != 200 # version-major mismatch, cleanly rejected
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].op == "handshake"
|
||||
|
||||
async def test_handshake_req_summary_reads_real_capabilities_field(self) -> None:
|
||||
"""The handshake req-summary reads the REAL wire field `capabilities` (bifrost
|
||||
_protocol.py:181), not the transposed `capabilities_requested` — so caps_requested
|
||||
is actually populated (heid-code-review #17 catch). A bad-version handshake still
|
||||
emits the OpEvent carrying the requested caps from the request body."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_memory_app(sink)
|
||||
resp = await _post(
|
||||
app,
|
||||
"/bifrost/handshake",
|
||||
{"bifrost_version": "99.0.0", "mcp_version": "0.4.0", "capabilities": ["memory"]},
|
||||
None,
|
||||
)
|
||||
assert resp.status_code != 200
|
||||
assert len(sink.events) == 1
|
||||
assert sink.events[0].req_summary == {"caps_requested": ["memory"]}
|
||||
|
||||
async def test_sink_failure_never_breaks_dispatch(self) -> None:
|
||||
"""sink_swallow [adversarial]: a raising sink must NOT break the dispatch
|
||||
path — the search still returns 200 (POST-003 / INV-007)."""
|
||||
app, _store = _wrapped_memory_app(_RaisingSink())
|
||||
resp = await _post(
|
||||
app,
|
||||
"/bifrost/memory-call",
|
||||
{
|
||||
"operation": "search",
|
||||
"args": {"vector": [0.0] * _DIM, "top_k": 1, "scope_all": {}},
|
||||
},
|
||||
_mint("s", ["memory:read"]),
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
|
||||
|
||||
class TestOpFeedAffect:
|
||||
async def test_emit_op_normalized_and_plane_affect(self) -> None:
|
||||
"""affect emit: op is the bare verb (affect.emit -> emit), plane=affect,
|
||||
session_id from the JWT; affect stays conduit-opaque (empty req_summary)."""
|
||||
sink = _RecordingSink()
|
||||
app, _store = _wrapped_affect_app(sink)
|
||||
jwt = _mint("session-aff", ["affect:write"])
|
||||
body = {
|
||||
"operation": "affect.emit",
|
||||
"args": {
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"end_user_id": "u1",
|
||||
"pad": {"p": 0.1, "a": 0.2, "d": 0.3},
|
||||
"valence": 0.5,
|
||||
"emitted_at": "2026-06-18T00:00:00Z",
|
||||
},
|
||||
"idempotency_key": "k1",
|
||||
}
|
||||
resp = await _post(app, "/bifrost/affect-call", body, jwt)
|
||||
|
||||
assert resp.status_code == 200
|
||||
assert len(sink.events) == 1
|
||||
ev = sink.events[0]
|
||||
assert ev.plane == "affect"
|
||||
assert ev.op == "emit"
|
||||
assert ev.session_id == "session-aff"
|
||||
assert ev.status == "ok"
|
||||
assert ev.req_summary == {} # conduit-opaque
|
||||
assert ev.resp_summary == {"stored": True}
|
||||
|
||||
async def test_pad_read_route_emits_no_opevent(self) -> None:
|
||||
"""INV-004 (#18 D2): the non-bifrost PAD read route is OUTSIDE _BIFROST_PATHS,
|
||||
so the op-feed passes it through and records NO OpEvent — observe is bifrost-
|
||||
only and the read path adds no plane attribution."""
|
||||
import json as _json
|
||||
|
||||
sink = _RecordingSink()
|
||||
app, store = _wrapped_affect_app(sink)
|
||||
blob = _json.dumps(
|
||||
{
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"end_user_id": "vuong",
|
||||
"pad": {"pleasure": 0.1, "arousal": 0.0, "dominance": 0.0},
|
||||
"valence": [],
|
||||
"emitted_at": "2026-06-18T00:00:00+00:00",
|
||||
},
|
||||
sort_keys=True,
|
||||
separators=(",", ":"),
|
||||
)
|
||||
store._conn.execute(
|
||||
"INSERT INTO affect_snapshots (agent_id, end_user_id, snapshot_json, arrived_at) "
|
||||
"VALUES (?, ?, ?, ?)",
|
||||
("ratatoskr:sindra", "vuong", blob, "0"),
|
||||
)
|
||||
store._conn.commit()
|
||||
transport = httpx.ASGITransport(app=app)
|
||||
async with httpx.AsyncClient(
|
||||
transport=transport, base_url="http://provider"
|
||||
) as client:
|
||||
resp = await client.get(
|
||||
"/affect/state/ratatoskr:sindra", params={"end_user_id": "vuong"}
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
assert sink.events == [] # op-feed recorded nothing for the non-bifrost route
|
||||
|
||||
|
||||
class TestInstrumentGuards:
|
||||
def test_unknown_plane_raises(self) -> None:
|
||||
with pytest.raises(ValueError):
|
||||
instrument_provider_app(object(), plane="persona", sink=_RecordingSink())
|
||||
@@ -0,0 +1,36 @@
|
||||
"""Tests for the affect-provider serve entrypoint (ratatoskr.provider.serve).
|
||||
|
||||
Only the env -> app seam is unit-tested; uvicorn.run is the untestable shell.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
|
||||
from ratatoskr.provider.serve import build_app_from_env
|
||||
|
||||
|
||||
def test_build_app_from_env_requires_heimdall_key():
|
||||
with pytest.raises(RuntimeError):
|
||||
build_app_from_env({"RATATOSKR_AFFECT_DB": ":memory:"})
|
||||
|
||||
|
||||
def test_build_app_from_env_builds_app_with_routes():
|
||||
app = build_app_from_env(
|
||||
{"RATATOSKR_HEIMDALL_KEY": "shared-secret", "RATATOSKR_AFFECT_DB": ":memory:"}
|
||||
)
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
assert "/bifrost/handshake" in paths
|
||||
assert "/bifrost/affect-call" in paths
|
||||
|
||||
|
||||
def test_opfeed_path_wraps_app(tmp_path):
|
||||
# Issue #17 slice 2: RATATOSKR_OPFEED_PATH opts the dispatch op-feed in; the
|
||||
# returned app is then the instrumented ASGI wrapper, not the raw Starlette.
|
||||
app = build_app_from_env(
|
||||
{
|
||||
"RATATOSKR_HEIMDALL_KEY": "shared-secret",
|
||||
"RATATOSKR_AFFECT_DB": ":memory:",
|
||||
"RATATOSKR_OPFEED_PATH": str(tmp_path / "ops.jsonl"),
|
||||
}
|
||||
)
|
||||
assert not hasattr(app, "routes") # wrapped: a bare ASGI callable
|
||||
@@ -0,0 +1,44 @@
|
||||
"""Tests for the combined-provider serve entrypoint (ratatoskr.provider.serve_combined).
|
||||
|
||||
Only the env -> app seam is unit-tested; uvicorn.run is the untestable shell.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
|
||||
from ratatoskr.provider.serve_combined import build_combined_app_from_env
|
||||
|
||||
_ENV = {
|
||||
"RATATOSKR_HEIMDALL_KEY": "shared-secret",
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM": "8",
|
||||
"RATATOSKR_AFFECT_DB": ":memory:",
|
||||
"RATATOSKR_MEMORY_DB": ":memory:",
|
||||
}
|
||||
|
||||
|
||||
def test_requires_heimdall_key():
|
||||
env = {k: v for k, v in _ENV.items() if k != "RATATOSKR_HEIMDALL_KEY"}
|
||||
with pytest.raises(RuntimeError):
|
||||
build_combined_app_from_env(env)
|
||||
|
||||
|
||||
def test_requires_embedding_dim():
|
||||
env = {k: v for k, v in _ENV.items() if k != "RATATOSKR_MEMORY_EMBEDDING_DIM"}
|
||||
with pytest.raises(RuntimeError):
|
||||
build_combined_app_from_env(env)
|
||||
|
||||
|
||||
def test_builds_app_with_all_routes():
|
||||
app = build_combined_app_from_env(dict(_ENV))
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
assert "/bifrost/handshake" in paths
|
||||
assert "/bifrost/memory-call" in paths
|
||||
assert "/bifrost/affect-call" in paths
|
||||
assert "/affect/state/{agent_id}" in paths
|
||||
|
||||
|
||||
def test_opfeed_path_wraps_app(tmp_path):
|
||||
env = dict(_ENV)
|
||||
env["RATATOSKR_OPFEED_PATH"] = str(tmp_path / "ops.jsonl")
|
||||
app = build_combined_app_from_env(env)
|
||||
assert not hasattr(app, "routes") # wrapped: a bare ASGI callable (plane='combined')
|
||||
@@ -0,0 +1,62 @@
|
||||
"""Tests for the memory-provider serve entrypoint (ratatoskr.provider.serve_memory).
|
||||
|
||||
Only the env -> app seam is unit-tested; uvicorn.run is the untestable shell.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
|
||||
from ratatoskr.provider.serve_memory import build_memory_app_from_env
|
||||
|
||||
|
||||
def test_build_memory_app_from_env_requires_heimdall_key():
|
||||
with pytest.raises(RuntimeError):
|
||||
build_memory_app_from_env(
|
||||
{"RATATOSKR_MEMORY_DB": ":memory:", "RATATOSKR_MEMORY_EMBEDDING_DIM": "8"}
|
||||
)
|
||||
|
||||
|
||||
def test_build_memory_app_from_env_requires_embedding_dim():
|
||||
# A wrong/missing dim silently breaks vector search -> require it explicitly.
|
||||
with pytest.raises(RuntimeError):
|
||||
build_memory_app_from_env(
|
||||
{"RATATOSKR_HEIMDALL_KEY": "k", "RATATOSKR_MEMORY_DB": ":memory:"}
|
||||
)
|
||||
|
||||
|
||||
def test_build_memory_app_from_env_rejects_non_positive_dim():
|
||||
with pytest.raises(RuntimeError):
|
||||
build_memory_app_from_env(
|
||||
{
|
||||
"RATATOSKR_HEIMDALL_KEY": "k",
|
||||
"RATATOSKR_MEMORY_DB": ":memory:",
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM": "0",
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_build_memory_app_from_env_builds_app_with_routes():
|
||||
app = build_memory_app_from_env(
|
||||
{
|
||||
"RATATOSKR_HEIMDALL_KEY": "shared-secret",
|
||||
"RATATOSKR_MEMORY_DB": ":memory:",
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM": "8",
|
||||
}
|
||||
)
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
assert "/bifrost/handshake" in paths
|
||||
assert "/bifrost/memory-call" in paths
|
||||
|
||||
|
||||
def test_opfeed_path_wraps_app(tmp_path):
|
||||
# Issue #17 slice 2: RATATOSKR_OPFEED_PATH opts the dispatch op-feed in; the
|
||||
# returned app is then the instrumented ASGI wrapper, not the raw Starlette.
|
||||
app = build_memory_app_from_env(
|
||||
{
|
||||
"RATATOSKR_HEIMDALL_KEY": "shared-secret",
|
||||
"RATATOSKR_MEMORY_DB": ":memory:",
|
||||
"RATATOSKR_MEMORY_EMBEDDING_DIM": "8",
|
||||
"RATATOSKR_OPFEED_PATH": str(tmp_path / "ops.jsonl"),
|
||||
}
|
||||
)
|
||||
assert not hasattr(app, "routes") # wrapped: a bare ASGI callable
|
||||
@@ -8,15 +8,31 @@ from ratatoskr.sessions import (
|
||||
AgentInfo,
|
||||
AgentNotAvailable,
|
||||
AgentNotFound,
|
||||
AuthoredHistoryUnavailable,
|
||||
AuthScopeDenied,
|
||||
BifrostBinding,
|
||||
BifrostConsumerKeyMissing,
|
||||
BifrostHandshakeFailed,
|
||||
InvalidCursor,
|
||||
PersonaNotConfigured,
|
||||
SessionApiFailed,
|
||||
SessionPage,
|
||||
create_character,
|
||||
create_session,
|
||||
delete_character,
|
||||
endpoint_for_plane,
|
||||
get_capabilities,
|
||||
get_character_state,
|
||||
get_me,
|
||||
get_persona_state,
|
||||
get_session_bifrost,
|
||||
get_session_messages,
|
||||
get_session_tools,
|
||||
list_agents,
|
||||
list_character_models,
|
||||
list_sessions,
|
||||
set_persona_state,
|
||||
write_authored_history,
|
||||
)
|
||||
|
||||
|
||||
@@ -206,6 +222,193 @@ class TestCreateSession:
|
||||
assert route.call_count == 0
|
||||
|
||||
|
||||
class TestCreateSessionBifrostBind:
|
||||
"""Issue #17 slice 1 — the create_session Bifrost-bind primitive."""
|
||||
|
||||
@respx.mock
|
||||
async def test_bind_happy_consumer_key_and_body(self) -> None:
|
||||
"""bind_happy [tracer]: a bifrost binding makes the body carry the
|
||||
`bifrost` field AND overrides the bearer to the consumer key (NOT the
|
||||
client's canary default), 201 → SessionInfo. Proves the bind path
|
||||
end-to-end (FN create_session STEPS 1-2, POST-001, INV-001)."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"session_id": "s-bound",
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"message_count": 0,
|
||||
"created_at": "2026-06-18T12:00:00+00:00",
|
||||
"last_active": "2026-06-18T12:00:00+00:00",
|
||||
"metadata": {},
|
||||
},
|
||||
)
|
||||
)
|
||||
binding = BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
async with httpx.AsyncClient(
|
||||
base_url="https://w.example",
|
||||
headers={"Authorization": "Bearer canary-key"},
|
||||
) as client:
|
||||
info = await create_session(
|
||||
client,
|
||||
"ratatoskr:sindra",
|
||||
end_user_id="smoke-user",
|
||||
bifrost=binding,
|
||||
consumer_key="consumer-key",
|
||||
)
|
||||
req = route.calls[0].request
|
||||
body = _json.loads(req.content)
|
||||
# body carries the bifrost field alongside agent_id/end_user_id
|
||||
assert body == {
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"end_user_id": "smoke-user",
|
||||
"bifrost": {
|
||||
"endpoint_url": "http://10.100.10.50:8391",
|
||||
"scope": None,
|
||||
},
|
||||
}
|
||||
# bearer overridden to the consumer key (INV-001: never the canary default)
|
||||
assert req.headers["Authorization"] == "Bearer consumer-key"
|
||||
assert info.session_id == "s-bound"
|
||||
assert info.agent_id == "ratatoskr:sindra"
|
||||
|
||||
@respx.mock
|
||||
async def test_bind_without_consumer_key_raises_before_http(self) -> None:
|
||||
"""missing_key [adversarial]: bifrost set but consumer_key None →
|
||||
BifrostConsumerKeyMissing BEFORE any HTTP (PRE-001, INV-001: never fall
|
||||
back to the canary key)."""
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(201, content=b"{}")
|
||||
)
|
||||
binding = BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(BifrostConsumerKeyMissing):
|
||||
await create_session(client, "ratatoskr:sindra", bifrost=binding)
|
||||
assert route.call_count == 0
|
||||
|
||||
@respx.mock
|
||||
async def test_bind_with_empty_consumer_key_raises_before_http(self) -> None:
|
||||
"""empty_key [adversarial]: empty-string consumer_key is also rejected
|
||||
before HTTP (PRE-001 requires a NON-EMPTY str)."""
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(201, content=b"{}")
|
||||
)
|
||||
binding = BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(BifrostConsumerKeyMissing):
|
||||
await create_session(
|
||||
client, "ratatoskr:sindra", bifrost=binding, consumer_key=""
|
||||
)
|
||||
assert route.call_count == 0
|
||||
|
||||
@respx.mock
|
||||
async def test_bind_handshake_failure_maps_to_502(self) -> None:
|
||||
"""handshake_502 [adversarial]: a bound create that 502s with
|
||||
detail.bifrost_error → BifrostHandshakeFailed carrying the bifrost_error
|
||||
+ raw body (POST-002, INV-002 bind-time failure). 'bifrost.auth_rejected'
|
||||
is the canary-key-instead-of-consumer-key tell."""
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
502,
|
||||
json={
|
||||
"error_code": "bifrost_handshake_failed",
|
||||
"detail": {"bifrost_error": "bifrost.auth_rejected"},
|
||||
},
|
||||
)
|
||||
)
|
||||
binding = BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(BifrostHandshakeFailed) as exc_info:
|
||||
await create_session(
|
||||
client, "ratatoskr:sindra", bifrost=binding, consumer_key="ck"
|
||||
)
|
||||
assert exc_info.value.bifrost_error == "bifrost.auth_rejected"
|
||||
# the raw 502 body is carried for debugging
|
||||
assert exc_info.value.body
|
||||
|
||||
@respx.mock
|
||||
async def test_bind_ephemeral_rejection_is_session_api_failed(self) -> None:
|
||||
"""ephemeral_422 [boundary]: 422 ephemeral_does_not_accept_bifrost is a
|
||||
generic create failure → SessionApiFailed, NOT a distinct exception
|
||||
(POST-003 — deliberate, an operator config error)."""
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
422, json={"error_code": "ephemeral_does_not_accept_bifrost"}
|
||||
)
|
||||
)
|
||||
binding = BifrostBinding(endpoint_url="http://10.100.10.50:8391")
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc_info:
|
||||
await create_session(
|
||||
client, "echo", bifrost=binding, consumer_key="ck"
|
||||
)
|
||||
assert exc_info.value.status == 422
|
||||
|
||||
@respx.mock
|
||||
async def test_unbound_create_unchanged_no_auth_override(self) -> None:
|
||||
"""unbound_unchanged [regression]: with no bifrost, the body is the
|
||||
pre-#17 shape AND create_session sends NO per-request Authorization
|
||||
override — the client's default canary bearer governs (INV-001: the two
|
||||
call sites never cross)."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"session_id": "s1",
|
||||
"agent_id": "mimir",
|
||||
"message_count": 0,
|
||||
"created_at": "2026-04-15T12:00:00+00:00",
|
||||
"last_active": "2026-04-15T12:00:00+00:00",
|
||||
"metadata": {},
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(
|
||||
base_url="https://w.example",
|
||||
headers={"Authorization": "Bearer canary-key"},
|
||||
) as client:
|
||||
await create_session(client, "mimir")
|
||||
req = route.calls[0].request
|
||||
body = _json.loads(req.content)
|
||||
assert body == {"agent_id": "mimir"}
|
||||
# the client default bearer is used unchanged — no consumer-key override
|
||||
assert req.headers["Authorization"] == "Bearer canary-key"
|
||||
|
||||
|
||||
class TestEndpointForPlane:
|
||||
"""Issue #17 — endpoint_for_plane: plane name → Worldtree-visible base URL."""
|
||||
|
||||
def test_memory_plane_maps_to_8391(self) -> None:
|
||||
"""memory [tracer]: 'memory' → http://<host>:8391 (POST-001)."""
|
||||
assert (
|
||||
endpoint_for_plane("memory", "10.100.10.50")
|
||||
== "http://10.100.10.50:8391"
|
||||
)
|
||||
|
||||
def test_affect_plane_maps_to_8390(self) -> None:
|
||||
"""affect: 'affect' → http://<host>:8390 (POST-001)."""
|
||||
assert (
|
||||
endpoint_for_plane("affect", "10.100.10.50")
|
||||
== "http://10.100.10.50:8390"
|
||||
)
|
||||
|
||||
def test_combined_plane_maps_to_8392(self) -> None:
|
||||
"""combined [#18 composite]: 'combined' → http://<host>:8392 (POST-001)."""
|
||||
assert (
|
||||
endpoint_for_plane("combined", "10.100.10.50")
|
||||
== "http://10.100.10.50:8392"
|
||||
)
|
||||
|
||||
def test_unknown_plane_raises_value_error(self) -> None:
|
||||
"""unknown_plane [adversarial]: any other plane → ValueError (PRE-001)."""
|
||||
with pytest.raises(ValueError):
|
||||
endpoint_for_plane("persona", "10.100.10.50")
|
||||
|
||||
|
||||
def _list_item(
|
||||
*,
|
||||
session_id: str = "s1",
|
||||
@@ -705,3 +908,473 @@ class TestGetPersonaState:
|
||||
with pytest.raises(PersonaNotConfigured) as exc_info:
|
||||
await get_persona_state(client, "domari")
|
||||
assert exc_info.value.agent_id == "domari"
|
||||
|
||||
|
||||
class TestGetMe:
|
||||
"""docs/contracts/issues/2.contract.md FN get_me (slice: capabilities+me)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_authenticated(self) -> None:
|
||||
"""happy_authenticated [happy,tracer]: 200 → parsed identity dict verbatim."""
|
||||
respx.get("https://w.example/me").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"user_id": "alice",
|
||||
"scopes": ["conversations.read", "conversations.write"],
|
||||
"tier": "user",
|
||||
"key_id": "a1b2c3d4",
|
||||
"key_label": "alice phone",
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
me = await get_me(client)
|
||||
assert me["user_id"] == "alice"
|
||||
assert me["tier"] == "user"
|
||||
assert me["key_id"] == "a1b2c3d4"
|
||||
assert me["scopes"] == ["conversations.read", "conversations.write"]
|
||||
|
||||
@respx.mock
|
||||
async def test_anonymous_dev_mode(self) -> None:
|
||||
"""anonymous_dev_mode: 200 anonymous shape → dict with tier=anonymous."""
|
||||
respx.get("https://w.example/me").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"user_id": "anonymous",
|
||||
"scopes": ["conversations.read"],
|
||||
"tier": "anonymous",
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
me = await get_me(client)
|
||||
assert me["tier"] == "anonymous"
|
||||
assert "key_id" not in me # optional fields omitted, not null
|
||||
|
||||
@respx.mock
|
||||
async def test_401_raises_session_api_failed(self) -> None:
|
||||
"""401_raises [error]: bad/absent key → SessionApiFailed(status=401)."""
|
||||
respx.get("https://w.example/me").mock(
|
||||
return_value=httpx.Response(401, json={"detail": "auth_invalid"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_me(client)
|
||||
assert exc.value.status == 401
|
||||
|
||||
|
||||
class TestGetCapabilities:
|
||||
"""docs/contracts/issues/2.contract.md FN get_capabilities (slice: capabilities+me)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy(self) -> None:
|
||||
"""happy [happy]: 200 → ephemeral_templates dict verbatim."""
|
||||
respx.get("https://w.example/capabilities").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"ephemeral_templates": {
|
||||
"echo": {
|
||||
"allowed_models": ["glm5-turbo", "glm4.7"],
|
||||
"default_model": "glm5-turbo",
|
||||
"system_prompt_max_bytes": 32768,
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
caps = await get_capabilities(client)
|
||||
echo = caps["ephemeral_templates"]["echo"]
|
||||
assert echo["default_model"] == "glm5-turbo"
|
||||
assert echo["system_prompt_max_bytes"] == 32768
|
||||
|
||||
@respx.mock
|
||||
async def test_non_200_raises(self) -> None:
|
||||
"""non_200_raises [error]: 500 → SessionApiFailed(status=500)."""
|
||||
respx.get("https://w.example/capabilities").mock(
|
||||
return_value=httpx.Response(500, content=b"boom")
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_capabilities(client)
|
||||
assert exc.value.status == 500
|
||||
|
||||
|
||||
class TestGetSessionTools:
|
||||
"""docs/contracts/issues/2.contract.md — get_session_tools (GET /sessions/{id}/tools, #183)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy(self) -> None:
|
||||
"""happy [happy,tracer]: 200 → merged tool inventory dict verbatim."""
|
||||
respx.get("https://w.example/sessions/s1/tools").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"agent_id": "alice:wizard",
|
||||
"builtin_tools": [],
|
||||
"bifrost_tools": [
|
||||
{"name": "bifrost.alice.set_field", "description": "d", "parameters": {}}
|
||||
],
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
tools = await get_session_tools(client, "s1")
|
||||
assert tools["agent_id"] == "alice:wizard"
|
||||
assert tools["builtin_tools"] == []
|
||||
assert tools["bifrost_tools"][0]["name"] == "bifrost.alice.set_field"
|
||||
|
||||
@respx.mock
|
||||
async def test_cross_owner_404_raises(self) -> None:
|
||||
"""cross_owner_404 [error]: 404 session_not_found → SessionApiFailed(404)."""
|
||||
respx.get("https://w.example/sessions/s1/tools").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_session_tools(client, "s1")
|
||||
assert exc.value.status == 404
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_session_id_asserts(self) -> None:
|
||||
"""empty_session_id [adversarial]: '' → AssertionError; no HTTP issued."""
|
||||
route = respx.get("https://w.example/sessions//tools").mock(
|
||||
return_value=httpx.Response(200, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await get_session_tools(client, "")
|
||||
assert route.call_count == 0
|
||||
|
||||
|
||||
class TestGetSessionBifrost:
|
||||
"""#2 contract — get_session_bifrost (GET /admin/sessions/{id}/bifrost, #176)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_uses_admin_bearer(self) -> None:
|
||||
"""happy [happy,tracer]: 200 → binding dict; request carries the ADMIN bearer (override)."""
|
||||
route = respx.get("https://w.example/admin/sessions/s1/bifrost").mock(
|
||||
return_value=httpx.Response(
|
||||
200,
|
||||
json={
|
||||
"endpoint_url": "https://bifrost.example/mcp",
|
||||
"consumer_id": "alice",
|
||||
"connected": True,
|
||||
"capabilities_granted": ["tools:call", "tools:read"],
|
||||
"tools": [{"name": "bifrost.alice.echo", "description": "echo"}],
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(
|
||||
base_url="https://w.example",
|
||||
headers={"Authorization": "Bearer consumer-key"},
|
||||
) as client:
|
||||
state = await get_session_bifrost(client, "s1", admin_key="admin-xyz")
|
||||
assert state["connected"] is True
|
||||
assert state["tools"][0]["name"] == "bifrost.alice.echo"
|
||||
# the request overrode the client's default consumer bearer with the admin key
|
||||
assert route.calls[0].request.headers["Authorization"] == "Bearer admin-xyz"
|
||||
|
||||
@respx.mock
|
||||
async def test_403_scope_denied(self) -> None:
|
||||
"""403 [error]: admin key lacks admin.sessions.read → SessionApiFailed(403)."""
|
||||
respx.get("https://w.example/admin/sessions/s1/bifrost").mock(
|
||||
return_value=httpx.Response(403, json={"error_code": "auth_scope_denied"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_session_bifrost(client, "s1", admin_key="k")
|
||||
assert exc.value.status == 403
|
||||
|
||||
@respx.mock
|
||||
async def test_404_not_bound(self) -> None:
|
||||
"""404 [error]: session_not_bifrost_bound → SessionApiFailed(404)."""
|
||||
respx.get("https://w.example/admin/sessions/s1/bifrost").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_bifrost_bound"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_session_bifrost(client, "s1", admin_key="k")
|
||||
assert exc.value.status == 404
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_admin_key_asserts(self) -> None:
|
||||
"""empty_admin_key [adversarial]: '' → AssertionError; no HTTP issued."""
|
||||
route = respx.get("https://w.example/admin/sessions/s1/bifrost").mock(
|
||||
return_value=httpx.Response(200, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await get_session_bifrost(client, "s1", admin_key="")
|
||||
assert route.call_count == 0
|
||||
|
||||
|
||||
class TestTransientCharacters:
|
||||
"""docs/contracts/issues/2.contract.md — transient-character wrappers (#161)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_list_models(self) -> None:
|
||||
"""list_models [happy,tracer]: 200 → {items:[...]} verbatim."""
|
||||
respx.get("https://w.example/models/available-for-characters").mock(
|
||||
return_value=httpx.Response(200, json={"items": [{"name": "fast", "thinking": False}]})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
models = await list_character_models(client)
|
||||
assert models["items"][0]["name"] == "fast"
|
||||
|
||||
@respx.mock
|
||||
async def test_create_body_and_response(self) -> None:
|
||||
"""create [happy]: body is {character, state}; 201 → {character_id, ttl_expires_at}."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/characters").mock(
|
||||
return_value=httpx.Response(201, json={"character_id": "char_x", "ttl_expires_at": "t"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
out = await create_character(client, {"schema_version": "1", "name": "H"})
|
||||
assert out["character_id"] == "char_x"
|
||||
body = _json.loads(route.calls[0].request.content)
|
||||
assert body == {"character": {"schema_version": "1", "name": "H"}, "state": None}
|
||||
|
||||
@respx.mock
|
||||
async def test_get_state(self) -> None:
|
||||
"""get_state [happy]: 200 → live PAD/emotions snapshot."""
|
||||
respx.get("https://w.example/characters/char_x/state").mock(
|
||||
return_value=httpx.Response(200, json={"schema_version": "1", "pad": [0.4, 0.1, -0.2]})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
state = await get_character_state(client, "char_x")
|
||||
assert state["pad"] == [0.4, 0.1, -0.2]
|
||||
|
||||
@respx.mock
|
||||
async def test_delete_204(self) -> None:
|
||||
"""delete [happy]: 204 → None."""
|
||||
respx.delete("https://w.example/characters/char_x").mock(
|
||||
return_value=httpx.Response(204)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
assert await delete_character(client, "char_x") is None
|
||||
|
||||
@respx.mock
|
||||
async def test_create_403_scope(self) -> None:
|
||||
"""create_403 [error]: key lacks character.write → SessionApiFailed(403)."""
|
||||
respx.post("https://w.example/characters").mock(
|
||||
return_value=httpx.Response(403, json={"error_code": "auth_scope_denied"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await create_character(client, {"name": "H"})
|
||||
assert exc.value.status == 403
|
||||
|
||||
|
||||
class TestSetPersonaState:
|
||||
"""#2 contract — set_persona_state (POST /sessions/{id}/persona_state)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_204(self) -> None:
|
||||
"""happy [happy,tracer]: freeform snapshot body; 204 → None."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions/s1/persona_state").mock(
|
||||
return_value=httpx.Response(204)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await set_persona_state(
|
||||
client, "s1", {"pad": {"pleasure": 0.4, "arousal": 0.1, "dominance": -0.2}}
|
||||
)
|
||||
assert result is None
|
||||
assert _json.loads(route.calls[0].request.content) == {
|
||||
"pad": {"pleasure": 0.4, "arousal": 0.1, "dominance": -0.2}
|
||||
}
|
||||
|
||||
@respx.mock
|
||||
async def test_non_204_raises(self) -> None:
|
||||
"""non_204 [error]: 422 (bad snapshot shape) → SessionApiFailed(422)."""
|
||||
respx.post("https://w.example/sessions/s1/persona_state").mock(
|
||||
return_value=httpx.Response(422, json={"error_code": "validation_failed"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await set_persona_state(client, "s1", {"pad": [1, 2, 3]})
|
||||
assert exc.value.status == 422
|
||||
|
||||
|
||||
_AUTHORED_ACK = {
|
||||
"author": "assistant",
|
||||
"content_chars": 5,
|
||||
"injected_at": "2026-07-06T12:00:00+00:00",
|
||||
"phase": "seeded",
|
||||
"seq": 0,
|
||||
"session_id": "s1",
|
||||
"turn_id": "t1",
|
||||
}
|
||||
|
||||
|
||||
class TestWriteAuthoredHistory:
|
||||
"""write_authored_history — #347 POST /sessions/{id}/history (contract #2 amendment)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_fresh_201(self) -> None:
|
||||
"""happy_fresh_201 [happy,tracer]: 201 → ack verbatim; minimal body."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await write_authored_history(
|
||||
client, "s1", content="hello", idempotency_key="k1"
|
||||
)
|
||||
assert result == _AUTHORED_ACK
|
||||
assert _json.loads(route.calls[0].request.content) == {
|
||||
"author": "assistant",
|
||||
"content": "hello",
|
||||
"idempotency_key": "k1",
|
||||
}
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_replay_200(self) -> None:
|
||||
"""happy_replay_200 [happy]: 200 replay (byte-identical body) → dict verbatim."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(200, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await write_authored_history(
|
||||
client, "s1", content="hello", idempotency_key="k1"
|
||||
)
|
||||
assert result == _AUTHORED_ACK
|
||||
|
||||
@respx.mock
|
||||
async def test_body_includes_effects(self) -> None:
|
||||
"""body_includes_effects [trace]: effects + claimed_original_at appear iff non-None."""
|
||||
import json as _json
|
||||
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
await write_authored_history(
|
||||
client,
|
||||
"s1",
|
||||
content="hi",
|
||||
idempotency_key="k1",
|
||||
effects="none",
|
||||
claimed_original_at="2020-01-01T00:00:00Z",
|
||||
)
|
||||
assert _json.loads(route.calls[0].request.content) == {
|
||||
"author": "assistant",
|
||||
"content": "hi",
|
||||
"idempotency_key": "k1",
|
||||
"effects": "none",
|
||||
"claimed_original_at": "2020-01-01T00:00:00Z",
|
||||
}
|
||||
|
||||
@respx.mock
|
||||
async def test_hide_existence_404(self) -> None:
|
||||
"""hide_existence_404 [error]: 404 → AuthoredHistoryUnavailable (NOT SessionApiFailed)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AuthoredHistoryUnavailable) as exc:
|
||||
await write_authored_history(client, "s1", content="hi", idempotency_key="k1")
|
||||
assert exc.value.session_id == "s1"
|
||||
|
||||
@respx.mock
|
||||
async def test_generation_active_409(self) -> None:
|
||||
"""generation_active_409 [error]: 409 → SessionApiFailed(409)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(409, json={"error_code": "generation_active"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await write_authored_history(client, "s1", content="hi", idempotency_key="k1")
|
||||
assert exc.value.status == 409
|
||||
|
||||
@respx.mock
|
||||
async def test_content_too_long_422(self) -> None:
|
||||
"""content_too_long_422 [error]: 422 → SessionApiFailed(422)."""
|
||||
respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(422, json={"error_code": "content_too_long"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await write_authored_history(client, "s1", content="x", idempotency_key="k1")
|
||||
assert exc.value.status == 422
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_content(self) -> None:
|
||||
"""empty_content [adversarial]: content="" → AssertionError; no HTTP issued."""
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await write_authored_history(client, "s1", content="", idempotency_key="k1")
|
||||
assert not route.called
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_idempotency_key(self) -> None:
|
||||
"""empty_idempotency_key [adversarial]: key="" → AssertionError; no HTTP issued."""
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await write_authored_history(client, "s1", content="hi", idempotency_key="")
|
||||
assert not route.called
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_session_id(self) -> None:
|
||||
"""empty_session_id [adversarial]: session_id="" → AssertionError; no HTTP issued."""
|
||||
route = respx.post("https://w.example/sessions/s1/history").mock(
|
||||
return_value=httpx.Response(201, json=_AUTHORED_ACK)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await write_authored_history(client, "", content="hi", idempotency_key="k1")
|
||||
assert not route.called
|
||||
|
||||
|
||||
class TestGetSessionMessages:
|
||||
"""#2 contract (amendment 2026-07-06) — get_session_messages (GET /sessions/{id}/messages)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy(self) -> None:
|
||||
"""happy [happy,tracer]: 200 {session_id, items, next_cursor} → dict verbatim."""
|
||||
payload = {
|
||||
"session_id": "s1",
|
||||
"items": [{"seq": 0, "role": "assistant", "content": "hello there"}],
|
||||
"next_cursor": None,
|
||||
}
|
||||
respx.get("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(200, json=payload)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
result = await get_session_messages(client, "s1")
|
||||
assert result == payload
|
||||
|
||||
@respx.mock
|
||||
async def test_not_found_404(self) -> None:
|
||||
"""not_found_404 [error]: 404 → SessionApiFailed(404)."""
|
||||
respx.get("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SessionApiFailed) as exc:
|
||||
await get_session_messages(client, "s1")
|
||||
assert exc.value.status == 404
|
||||
|
||||
@respx.mock
|
||||
async def test_empty_session_id(self) -> None:
|
||||
"""empty_session_id [adversarial]: "" → AssertionError; no HTTP issued."""
|
||||
route = respx.get("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(200, json={})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AssertionError):
|
||||
await get_session_messages(client, "")
|
||||
assert not route.called
|
||||
|
||||
+294
-1
@@ -5,7 +5,9 @@ import pytest
|
||||
import respx
|
||||
|
||||
from ratatoskr.sse_client import (
|
||||
AdminEvent,
|
||||
AffectUpdate,
|
||||
AgentNotAvailable,
|
||||
AwaitingLlmFirstToken,
|
||||
CancelAlreadyCompleted,
|
||||
Cancelled,
|
||||
@@ -18,13 +20,17 @@ from ratatoskr.sse_client import (
|
||||
ResumeBufferExpired,
|
||||
ResumeTurnFinished,
|
||||
SseConnectFailed,
|
||||
SseConnectionDropped,
|
||||
SseId,
|
||||
Text,
|
||||
TurnIdFlip,
|
||||
TurnLaunchUnavailable,
|
||||
_parse_sse_id,
|
||||
cancel_turn,
|
||||
reconnect_turn,
|
||||
stream_admin_events,
|
||||
stream_turn,
|
||||
stream_turn_resilient,
|
||||
)
|
||||
|
||||
_DONE_42_6 = {
|
||||
@@ -49,6 +55,36 @@ def _sse_chunk(sse_id: str, body: dict[str, object]) -> bytes:
|
||||
return f"id: {sse_id}\ndata: {json.dumps(body)}\n\n".encode()
|
||||
|
||||
|
||||
_EVENT_STREAM = {"content-type": "text/event-stream"}
|
||||
|
||||
|
||||
class _DropStream(httpx.AsyncByteStream):
|
||||
"""Yield the given chunks, then raise a mid-stream drop (RemoteProtocolError).
|
||||
|
||||
Mirrors the inline `_DropAfter` used by TestStreamTurn.test_connection_drop;
|
||||
hoisted to module scope because the resilient-wrapper tests reuse it.
|
||||
"""
|
||||
|
||||
def __init__(self, chunks: list[bytes]) -> None:
|
||||
self._chunks = chunks
|
||||
|
||||
async def __aiter__(self): # type: ignore[no-untyped-def]
|
||||
for c in self._chunks:
|
||||
yield c
|
||||
raise httpx.RemoteProtocolError("simulated mid-stream drop")
|
||||
|
||||
async def aclose(self) -> None:
|
||||
return None
|
||||
|
||||
|
||||
def _drop_response(chunks: list[bytes]) -> httpx.Response:
|
||||
return httpx.Response(200, headers=_EVENT_STREAM, stream=_DropStream(chunks))
|
||||
|
||||
|
||||
def _stream_response(content: bytes) -> httpx.Response:
|
||||
return httpx.Response(200, headers=_EVENT_STREAM, content=content)
|
||||
|
||||
|
||||
class TestParseSseId:
|
||||
def test_happy_simple(self) -> None:
|
||||
"""happy_simple [happy,tracer]: '42:3' -> SseId(turn_id=42, seq=3)."""
|
||||
@@ -415,8 +451,9 @@ class TestStreamTurn:
|
||||
async def test_connect_failed_body_truncated(self) -> None:
|
||||
"""ERROR_ROUTING: SseConnectFailed.body is truncated to <= 1024 bytes."""
|
||||
big_body = b"x" * 5000
|
||||
# 500 (not 409/503 — those are now eager turn-launch carve-outs, #331).
|
||||
respx.post("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(503, content=big_body)
|
||||
return_value=httpx.Response(500, content=big_body)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SseConnectFailed) as exc_info:
|
||||
@@ -424,6 +461,71 @@ class TestStreamTurn:
|
||||
assert len(exc_info.value.body) <= 1024
|
||||
assert exc_info.value.body == big_body[:1024]
|
||||
|
||||
@respx.mock
|
||||
async def test_eager_409_agent_not_available(self) -> None:
|
||||
"""b1 #331: eager 409 -> AgentNotAvailable (SseConnectFailed subclass) with
|
||||
typed error_code; the turn never streams."""
|
||||
respx.post("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(
|
||||
409,
|
||||
json={
|
||||
"detail": {
|
||||
"error_code": "agent_not_available",
|
||||
"message": "agent ratatoskr:sindra is unavailable",
|
||||
}
|
||||
},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AgentNotAvailable) as exc:
|
||||
_ = [e async for e in stream_turn(client, "s1", "hi")]
|
||||
assert exc.value.status == 409
|
||||
assert exc.value.error_code == "agent_not_available"
|
||||
assert "unavailable" in exc.value.message
|
||||
assert isinstance(exc.value, SseConnectFailed) # existing handlers still catch
|
||||
|
||||
@respx.mock
|
||||
async def test_eager_503_turn_launch_unavailable_retryable(self) -> None:
|
||||
"""b1 #331: eager 503 -> TurnLaunchUnavailable (retryable, SseConnectFailed subclass)."""
|
||||
respx.post("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(
|
||||
503,
|
||||
json={"error_code": "turn_launch_failed", "message": "resource exhausted"},
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(TurnLaunchUnavailable) as exc:
|
||||
_ = [e async for e in stream_turn(client, "s1", "hi")]
|
||||
assert exc.value.status == 503
|
||||
assert exc.value.retryable is True
|
||||
assert exc.value.error_code == "turn_launch_failed"
|
||||
assert isinstance(exc.value, SseConnectFailed)
|
||||
|
||||
@respx.mock
|
||||
async def test_eager_409_non_json_body_defaults(self) -> None:
|
||||
"""b1 #331: eager 409 with a non-JSON body -> AgentNotAvailable with the
|
||||
status-derived default error_code."""
|
||||
respx.post("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(409, content=b"<html>nope</html>")
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(AgentNotAvailable) as exc:
|
||||
_ = [e async for e in stream_turn(client, "s1", "hi")]
|
||||
assert exc.value.error_code == "agent_not_available"
|
||||
|
||||
@respx.mock
|
||||
async def test_eager_503_non_json_body_defaults_not_ready(self) -> None:
|
||||
"""b2: eager 503 with a non-JSON body -> TurnLaunchUnavailable with the
|
||||
canonical default error_code `not_ready`."""
|
||||
respx.post("https://w.example/sessions/s1/messages").mock(
|
||||
return_value=httpx.Response(503, content=b"<html>nope</html>")
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(TurnLaunchUnavailable) as exc:
|
||||
_ = [e async for e in stream_turn(client, "s1", "hi")]
|
||||
assert exc.value.error_code == "not_ready"
|
||||
assert exc.value.retryable is True
|
||||
|
||||
@respx.mock
|
||||
async def test_no_text_aggregation(self) -> None:
|
||||
"""no_text_aggregation: consumer yields each text event separately; no concat."""
|
||||
@@ -1040,3 +1142,194 @@ class TestAwaitingLlmFirstToken:
|
||||
elapsed = [b.elapsed_ms_since_building_prompt for b in beats]
|
||||
assert elapsed == sorted(elapsed) # monotonically increasing
|
||||
assert all(b.turn_id == 42 for b in beats)
|
||||
|
||||
|
||||
_URL = "https://w.example/sessions/s1/messages"
|
||||
|
||||
|
||||
class TestStreamTurnResilient:
|
||||
"""docs/contracts/issues/1.contract.md FN stream_turn_resilient (amendment 2026-06-30)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_no_drop(self) -> None:
|
||||
"""happy_no_drop [happy]: clean stream passes through; no reconnect issued."""
|
||||
stream = _sse_chunk("42:1", {"type": "text", "content": "a"}) + _sse_chunk(
|
||||
"42:2", _DONE_42_6
|
||||
)
|
||||
route = respx.post(_URL).mock(return_value=_stream_response(stream))
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_turn_resilient(client, "s1", "hi")]
|
||||
assert [e.sse_id for e in events] == [SseId(42, 1), SseId(42, 2)]
|
||||
assert isinstance(events[-1], Done)
|
||||
assert route.call_count == 1 # POST-001: no reconnect on a clean stream
|
||||
|
||||
@respx.mock
|
||||
async def test_resume_after_one_drop(self) -> None:
|
||||
"""resume_after_one_drop [tracer]: a mid-stream drop resumes via reconnect; one stream."""
|
||||
first = _drop_response([_sse_chunk("42:1", {"type": "text", "content": "a"})])
|
||||
resume = _stream_response(
|
||||
_sse_chunk("42:2", {"type": "text", "content": "b"})
|
||||
+ _sse_chunk("42:3", _DONE_42_6)
|
||||
)
|
||||
route = respx.post(_URL).mock(side_effect=[first, resume])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_turn_resilient(client, "s1", "hi")]
|
||||
assert [e.sse_id for e in events] == [SseId(42, 1), SseId(42, 2), SseId(42, 3)]
|
||||
assert isinstance(events[-1], Done)
|
||||
assert route.call_count == 2
|
||||
# POST-003: reconnect carries the last yielded pre-drop event's id.
|
||||
assert route.calls[1].request.headers.get("Last-Event-ID") == "42:1"
|
||||
# PRE/wire: first attempt does NOT carry a Last-Event-ID.
|
||||
assert route.calls[0].request.headers.get("Last-Event-ID") is None
|
||||
|
||||
@respx.mock
|
||||
async def test_resume_after_clean_eof(self) -> None:
|
||||
"""resume_after_clean_eof: a clean EOF before terminal also triggers resume (INV-001)."""
|
||||
first = _stream_response(_sse_chunk("42:1", {"type": "text", "content": "a"}))
|
||||
resume = _stream_response(_sse_chunk("42:2", _DONE_42_6))
|
||||
route = respx.post(_URL).mock(side_effect=[first, resume])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_turn_resilient(client, "s1", "hi")]
|
||||
assert [e.sse_id for e in events] == [SseId(42, 1), SseId(42, 2)]
|
||||
assert isinstance(events[-1], Done)
|
||||
assert route.calls[1].request.headers.get("Last-Event-ID") == "42:1"
|
||||
|
||||
@respx.mock
|
||||
async def test_two_drops_then_done(self) -> None:
|
||||
"""two_drops_then_done: two transient drops, third attempt completes; ids thread through."""
|
||||
a1 = _drop_response([_sse_chunk("42:1", {"type": "text", "content": "a"})])
|
||||
a2 = _drop_response([_sse_chunk("42:2", {"type": "text", "content": "b"})])
|
||||
a3 = _stream_response(_sse_chunk("42:3", _DONE_42_6))
|
||||
route = respx.post(_URL).mock(side_effect=[a1, a2, a3])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_turn_resilient(client, "s1", "hi")]
|
||||
assert [e.sse_id for e in events] == [SseId(42, 1), SseId(42, 2), SseId(42, 3)]
|
||||
assert route.call_count == 3
|
||||
assert route.calls[1].request.headers.get("Last-Event-ID") == "42:1"
|
||||
assert route.calls[2].request.headers.get("Last-Event-ID") == "42:2"
|
||||
|
||||
@respx.mock
|
||||
async def test_unresumable_zero_event_drop(self) -> None:
|
||||
"""unresumable_zero_event_drop [adversarial]: drop before any event → propagate."""
|
||||
route = respx.post(_URL).mock(side_effect=[_drop_response([])])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SseConnectionDropped):
|
||||
_ = [e async for e in stream_turn_resilient(client, "s1", "hi")]
|
||||
assert route.call_count == 1 # no id to resume from → no reconnect
|
||||
|
||||
@respx.mock
|
||||
async def test_max_reconnects_exhausted(self) -> None:
|
||||
"""max_reconnects_exhausted [adversarial]: every attempt drops; budget caps reconnects."""
|
||||
side = [
|
||||
_drop_response([_sse_chunk(f"42:{n}", {"type": "text", "content": "x"})])
|
||||
for n in (1, 2, 3)
|
||||
]
|
||||
route = respx.post(_URL).mock(side_effect=side)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SseConnectionDropped):
|
||||
_ = [
|
||||
e
|
||||
async for e in stream_turn_resilient(
|
||||
client, "s1", "hi", max_reconnects=2
|
||||
)
|
||||
]
|
||||
assert route.call_count == 3 # initial + 2 reconnects, then give up
|
||||
|
||||
@respx.mock
|
||||
async def test_zero_budget_no_resume(self) -> None:
|
||||
"""zero_budget_no_resume [adversarial]: max_reconnects=0 → first drop propagates."""
|
||||
first = _drop_response([_sse_chunk("42:1", {"type": "text", "content": "a"})])
|
||||
route = respx.post(_URL).mock(side_effect=[first])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SseConnectionDropped):
|
||||
_ = [
|
||||
e
|
||||
async for e in stream_turn_resilient(
|
||||
client, "s1", "hi", max_reconnects=0
|
||||
)
|
||||
]
|
||||
assert route.call_count == 1
|
||||
|
||||
@respx.mock
|
||||
async def test_buffer_expired_propagates(self) -> None:
|
||||
"""buffer_expired_propagates [error]: a 412 on reconnect surfaces, not retried."""
|
||||
first = _drop_response([_sse_chunk("42:1", {"type": "text", "content": "a"})])
|
||||
resume = httpx.Response(412, json={"turn_id": 42, "buffered_from_seq": 7})
|
||||
route = respx.post(_URL).mock(side_effect=[first, resume])
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
collected: list[object] = []
|
||||
with pytest.raises(ResumeBufferExpired):
|
||||
async for e in stream_turn_resilient(client, "s1", "hi"):
|
||||
collected.append(e)
|
||||
assert [e.sse_id for e in collected] == [SseId(42, 1)] # type: ignore[attr-defined]
|
||||
assert route.call_count == 2
|
||||
|
||||
|
||||
class TestStreamAdminEvents:
|
||||
"""docs/conversation-api-spec.md § Admin Event Stream — stream_admin_events (#11)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_happy_multi_event_admin_bearer(self) -> None:
|
||||
"""happy [happy,tracer]: yields AdminEvent envelopes; request uses the ADMIN bearer."""
|
||||
env1 = {
|
||||
"id": 41, "type": "session.created", "timestamp": "2026-05-06T10:00:00.000Z",
|
||||
"data": {"session_id": "s1", "agent_id": "mimir", "user_id": None},
|
||||
}
|
||||
env2 = {
|
||||
"id": 42, "type": "turn.started", "timestamp": "2026-05-06T10:00:01.000Z",
|
||||
"data": {"session_id": "s1", "turn_id": 7, "agent_id": "mimir", "user_id": None},
|
||||
}
|
||||
stream = _sse_chunk("41", env1) + _sse_chunk("42", env2)
|
||||
route = respx.get("https://w.example/admin/events").mock(
|
||||
return_value=httpx.Response(
|
||||
200, headers={"content-type": "text/event-stream"}, content=stream
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(
|
||||
base_url="https://w.example", headers={"Authorization": "Bearer consumer"}
|
||||
) as client:
|
||||
events = [e async for e in stream_admin_events(client, admin_key="admin-xyz")]
|
||||
assert [e.type for e in events] == ["session.created", "turn.started"]
|
||||
assert isinstance(events[0], AdminEvent)
|
||||
assert events[0].id == 41
|
||||
assert events[1].data["turn_id"] == 7
|
||||
assert route.calls[0].request.headers["Authorization"] == "Bearer admin-xyz"
|
||||
|
||||
@respx.mock
|
||||
async def test_last_event_id_header(self) -> None:
|
||||
"""last_event_id_header [trace]: empty stream → []; Last-Event-ID header sent."""
|
||||
route = respx.get("https://w.example/admin/events").mock(
|
||||
return_value=httpx.Response(
|
||||
200, headers={"content-type": "text/event-stream"}, content=b""
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_admin_events(client, admin_key="k", last_event_id=99)]
|
||||
assert events == []
|
||||
assert route.calls[0].request.headers["Last-Event-ID"] == "99"
|
||||
|
||||
@respx.mock
|
||||
async def test_403_scope_denied(self) -> None:
|
||||
"""403 [error]: key lacks admin.events.read → SseConnectFailed(403)."""
|
||||
respx.get("https://w.example/admin/events").mock(
|
||||
return_value=httpx.Response(403, json={"error_code": "auth_scope_denied"})
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
with pytest.raises(SseConnectFailed) as exc:
|
||||
_ = [e async for e in stream_admin_events(client, admin_key="k")]
|
||||
assert exc.value.status == 403
|
||||
|
||||
@respx.mock
|
||||
async def test_skips_malformed_frame(self) -> None:
|
||||
"""skips_malformed [adversarial]: a bad-JSON frame is skipped, not fatal."""
|
||||
good = _sse_chunk("41", {"id": 41, "type": "session.created", "data": {"session_id": "s1"}})
|
||||
bad = b"id: 42\ndata: not-json\n\n"
|
||||
good2 = _sse_chunk("43", {"id": 43, "type": "session.deleted", "data": {"session_id": "s1"}})
|
||||
respx.get("https://w.example/admin/events").mock(
|
||||
return_value=httpx.Response(
|
||||
200, headers={"content-type": "text/event-stream"}, content=good + bad + good2
|
||||
)
|
||||
)
|
||||
async with httpx.AsyncClient(base_url="https://w.example") as client:
|
||||
events = [e async for e in stream_admin_events(client, admin_key="k")]
|
||||
assert [e.type for e in events] == ["session.created", "session.deleted"]
|
||||
|
||||
@@ -9,6 +9,7 @@ import respx
|
||||
from textual.widgets import RichLog
|
||||
|
||||
from ratatoskr.cli import ParsedArgs
|
||||
from ratatoskr.sessions import BifrostBinding
|
||||
from ratatoskr.sse_client import (
|
||||
Cancelled,
|
||||
Done,
|
||||
@@ -2849,3 +2850,594 @@ class TestResolveThenRunWithPicker:
|
||||
err = capsys.readouterr().err
|
||||
assert "[no_agents]" in err
|
||||
assert picker_called is False
|
||||
|
||||
|
||||
class TestTuiBifrostBind:
|
||||
"""Issue #17 slice 3b — TUI bind trigger: bind failures route to the real
|
||||
stderr BEFORE the alt-screen opens (INV-002, mirrors issue #6; same exit
|
||||
codes/vocabulary as cli._amain per INV-006)."""
|
||||
|
||||
@respx.mock
|
||||
async def test_handshake_failure_routes_pre_altscreen(
|
||||
self, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
from ratatoskr.tui import _resolve_then_run
|
||||
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
502,
|
||||
json={
|
||||
"error_code": "bifrost_handshake_failed",
|
||||
"detail": {"bifrost_error": "bifrost.auth_rejected"},
|
||||
},
|
||||
)
|
||||
)
|
||||
args = _args_new(
|
||||
agent_id="ratatoskr:sindra",
|
||||
bifrost=BifrostBinding(endpoint_url="http://10.100.10.50:8391"),
|
||||
bifrost_plane="memory",
|
||||
consumer_key="ck",
|
||||
)
|
||||
rc = await _resolve_then_run(args)
|
||||
assert rc == 23
|
||||
err = capsys.readouterr().err
|
||||
assert "bifrost.auth_rejected" in err
|
||||
assert "consumer key" in err # the 401-scoping hint
|
||||
|
||||
@respx.mock
|
||||
async def test_consumer_key_missing_routes_pre_altscreen(
|
||||
self, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
from ratatoskr.tui import _resolve_then_run
|
||||
|
||||
args = _args_new(
|
||||
agent_id="a",
|
||||
bifrost=BifrostBinding(endpoint_url="http://x:8391"),
|
||||
consumer_key=None,
|
||||
)
|
||||
rc = await _resolve_then_run(args)
|
||||
assert rc == 22
|
||||
assert "bifrost_consumer_key_missing" in capsys.readouterr().err
|
||||
|
||||
@respx.mock
|
||||
async def test_bound_create_carries_binding_and_consumer_key(
|
||||
self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
"""A successful bound create sends the bifrost body + the consumer-key
|
||||
bearer and prints the bound-state indicator (run_async stubbed so no
|
||||
alt-screen opens)."""
|
||||
from ratatoskr import tui as tui_mod
|
||||
from ratatoskr.tui import _resolve_then_run
|
||||
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"session_id": "s-bound",
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"message_count": 0,
|
||||
"created_at": "2026-06-18T12:00:00+00:00",
|
||||
"last_active": "2026-06-18T12:00:00+00:00",
|
||||
"metadata": {},
|
||||
},
|
||||
)
|
||||
)
|
||||
# sindra is a preset agent → the TUI create path now auto-seeds a #347 first-message.
|
||||
respx.post("https://w.example/sessions/s-bound/history").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
|
||||
async def fake_run_async(self) -> int:
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(tui_mod.RatatoskrApp, "run_async", fake_run_async)
|
||||
args = _args_new(
|
||||
agent_id="ratatoskr:sindra",
|
||||
bifrost=BifrostBinding(endpoint_url="http://10.100.10.50:8391"),
|
||||
bifrost_plane="memory",
|
||||
consumer_key="ck",
|
||||
)
|
||||
rc = await _resolve_then_run(args)
|
||||
assert rc == 0
|
||||
import json as _json
|
||||
|
||||
body = _json.loads(route.calls[0].request.content)
|
||||
assert body["bifrost"] == {
|
||||
"endpoint_url": "http://10.100.10.50:8391", "scope": None
|
||||
}
|
||||
assert route.calls[0].request.headers["Authorization"] == "Bearer ck"
|
||||
err = capsys.readouterr().err
|
||||
assert "bifrost: status=bound" in err
|
||||
assert "plane=memory" in err
|
||||
|
||||
|
||||
class TestSessionPickerApp:
|
||||
"""docs/contracts/issues/6.contract.md FN SessionPickerApp (amendment slice b2)."""
|
||||
|
||||
@staticmethod
|
||||
def _two():
|
||||
from ratatoskr.sessions import SessionInfo
|
||||
|
||||
return [
|
||||
SessionInfo(
|
||||
session_id="s-first-0001", agent_id="mimir", created_at="t0",
|
||||
last_active="t1", metadata={}, message_count=3, name=None,
|
||||
archived=False, tags=[],
|
||||
),
|
||||
SessionInfo(
|
||||
session_id="s-second-002", agent_id="echo", created_at="t0",
|
||||
last_active="t2", metadata={}, message_count=None, name="probe",
|
||||
archived=False, tags=[],
|
||||
),
|
||||
]
|
||||
|
||||
def test_pick_returns_session_id(self) -> None:
|
||||
"""pick_returns_session_id [happy,tracer]: idx 1 + Enter → exit value == that session_id."""
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
app = SessionPickerApp(self._two())
|
||||
|
||||
async def drive() -> str | None:
|
||||
async with app.run_test() as pilot:
|
||||
from textual.widgets import ListView
|
||||
|
||||
lv = app.query_one("#session-list", ListView)
|
||||
lv.index = 1
|
||||
await pilot.pause()
|
||||
await pilot.press("enter")
|
||||
await pilot.pause()
|
||||
return app.return_value
|
||||
|
||||
import asyncio
|
||||
|
||||
assert asyncio.run(drive()) == "s-second-002"
|
||||
|
||||
def test_esc_returns_none(self) -> None:
|
||||
"""esc_returns_none [happy]: Esc → exit value is None (dismiss, resume nothing)."""
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
app = SessionPickerApp(self._two())
|
||||
|
||||
async def drive() -> str | None:
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.press("escape")
|
||||
await pilot.pause()
|
||||
return app.return_value
|
||||
|
||||
import asyncio
|
||||
|
||||
assert asyncio.run(drive()) is None
|
||||
|
||||
def test_ctrl_d_returns_none(self) -> None:
|
||||
"""ctrl_d_returns_none [adversarial]: Ctrl-D → None."""
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
app = SessionPickerApp(self._two())
|
||||
|
||||
async def drive() -> str | None:
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.press("ctrl+d")
|
||||
await pilot.pause()
|
||||
return app.return_value
|
||||
|
||||
import asyncio
|
||||
|
||||
assert asyncio.run(drive()) is None
|
||||
|
||||
|
||||
class TestBareSessionPicker:
|
||||
"""docs/contracts/issues/6.contract.md amendment (slice b2): _resolve_then_run bare mode."""
|
||||
|
||||
@staticmethod
|
||||
def _bare_args() -> ParsedArgs:
|
||||
return ParsedArgs(
|
||||
send_content=None, session_id=None, new=False, agent_id=None,
|
||||
api_key="k", server_url="https://w.example", raw=False,
|
||||
end_user_id=None, bifrost=None, bifrost_plane=None, consumer_key=None,
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _sess(sid: str, agent: str = "mimir"):
|
||||
from ratatoskr.sessions import SessionInfo
|
||||
|
||||
return SessionInfo(
|
||||
session_id=sid, agent_id=agent, created_at="t0", last_active="t1",
|
||||
metadata={}, message_count=1, name=None, archived=False, tags=[],
|
||||
)
|
||||
|
||||
def test_bare_zero_sessions_errors(
|
||||
self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
"""bare_zero_sessions_errors [error]: 0 sessions → exit 14 [no_sessions]; App not opened."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionPage
|
||||
|
||||
async def fake_list(client, **kw):
|
||||
return SessionPage(items=[], next_cursor=None)
|
||||
|
||||
monkeypatch.setattr(tui_mod, "list_sessions", fake_list)
|
||||
opened: list[int] = []
|
||||
|
||||
async def spy(self, *a, **k):
|
||||
opened.append(1)
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(RatatoskrApp, "run_async", spy)
|
||||
rc = run_tui(self._bare_args())
|
||||
assert rc == 14
|
||||
assert "[no_sessions]" in capsys.readouterr().err
|
||||
assert not opened
|
||||
|
||||
def test_bare_one_session_auto_resumes(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""bare_one_session_auto_resumes: exactly 1 → auto-resume, no picker (§4 >1 rule)."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionPage
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
async def fake_list(client, **kw):
|
||||
return SessionPage(items=[self._sess("s-solo")], next_cursor=None)
|
||||
|
||||
monkeypatch.setattr(tui_mod, "list_sessions", fake_list)
|
||||
picker_used: list[int] = []
|
||||
|
||||
async def spy_picker(self, *a, **k):
|
||||
picker_used.append(1)
|
||||
return None
|
||||
|
||||
monkeypatch.setattr(SessionPickerApp, "run_async", spy_picker)
|
||||
snap: dict = {}
|
||||
|
||||
async def cap(self, *a, **k):
|
||||
snap["sid"] = self.session_id
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(RatatoskrApp, "run_async", cap)
|
||||
rc = run_tui(self._bare_args())
|
||||
assert rc == 0
|
||||
assert snap["sid"] == "s-solo"
|
||||
assert not picker_used
|
||||
|
||||
def test_bare_multi_opens_picker(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""bare_multi_opens_picker [scenario,tracer]: >1 → picker; its choice resumes."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionPage
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
async def fake_list(client, **kw):
|
||||
return SessionPage(items=[self._sess("s-a"), self._sess("s-b")], next_cursor=None)
|
||||
|
||||
monkeypatch.setattr(tui_mod, "list_sessions", fake_list)
|
||||
|
||||
async def pick_b(self, *a, **k):
|
||||
return "s-b"
|
||||
|
||||
monkeypatch.setattr(SessionPickerApp, "run_async", pick_b)
|
||||
snap: dict = {}
|
||||
|
||||
async def cap(self, *a, **k):
|
||||
snap["sid"] = self.session_id
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(RatatoskrApp, "run_async", cap)
|
||||
rc = run_tui(self._bare_args())
|
||||
assert rc == 0
|
||||
assert snap["sid"] == "s-b"
|
||||
|
||||
def test_bare_picker_dismiss_exits_zero(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""bare_picker_dismiss_exits_zero [scenario]: picker None → exit 0; App not opened."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionPage
|
||||
from ratatoskr.tui import SessionPickerApp
|
||||
|
||||
async def fake_list(client, **kw):
|
||||
return SessionPage(items=[self._sess("s-a"), self._sess("s-b")], next_cursor=None)
|
||||
|
||||
monkeypatch.setattr(tui_mod, "list_sessions", fake_list)
|
||||
|
||||
async def pick_none(self, *a, **k):
|
||||
return None
|
||||
|
||||
monkeypatch.setattr(SessionPickerApp, "run_async", pick_none)
|
||||
opened: list[int] = []
|
||||
|
||||
async def spy(self, *a, **k):
|
||||
opened.append(1)
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(RatatoskrApp, "run_async", spy)
|
||||
rc = run_tui(self._bare_args())
|
||||
assert rc == 0
|
||||
assert not opened
|
||||
|
||||
def test_bare_list_sessions_api_failure(
|
||||
self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
"""bare_list_sessions_api_failure [error]: list_sessions 500 → exit 20; App not opened."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionApiFailed
|
||||
|
||||
async def fake_list(client, **kw):
|
||||
raise SessionApiFailed(status=500, body=b"boom")
|
||||
|
||||
monkeypatch.setattr(tui_mod, "list_sessions", fake_list)
|
||||
opened: list[int] = []
|
||||
|
||||
async def spy(self, *a, **k):
|
||||
opened.append(1)
|
||||
return 0
|
||||
|
||||
monkeypatch.setattr(RatatoskrApp, "run_async", spy)
|
||||
rc = run_tui(self._bare_args())
|
||||
assert rc == 20
|
||||
assert "[session_api_failed]" in capsys.readouterr().err
|
||||
assert not opened
|
||||
|
||||
|
||||
class TestSessionToolsHydration:
|
||||
"""get_session_tools + the #183 Tools-pane inventory hydrate (GET /sessions/{id}/tools)."""
|
||||
|
||||
def test_format_tool_inventory(self) -> None:
|
||||
"""format_tool_inventory [unit]: header + builtin + bifrost lines."""
|
||||
from ratatoskr.tui import _format_tool_inventory
|
||||
|
||||
lines = _format_tool_inventory(
|
||||
{
|
||||
"agent_id": "alice:wizard",
|
||||
"builtin_tools": [],
|
||||
"bifrost_tools": [{"name": "bifrost.x"}, {"name": "bifrost.y"}],
|
||||
}
|
||||
)
|
||||
joined = "\n".join(lines)
|
||||
assert "agent=alice:wizard" in joined
|
||||
assert "builtin=0 bifrost=2" in joined
|
||||
assert "builtin: (none)" in joined
|
||||
assert "bifrost.x, bifrost.y" in joined
|
||||
|
||||
async def test_hydrate_writes_inventory_and_audits(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
"""hydrate_writes_inventory [scenario,tracer]: 200 → inventory in Tools pane + audit."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def fake_tools(client, session_id):
|
||||
return {
|
||||
"agent_id": "alice:wizard",
|
||||
"builtin_tools": [],
|
||||
"bifrost_tools": [{"name": "bifrost.set_field"}],
|
||||
}
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_tools", fake_tools)
|
||||
app = _resolved_app(_args_existing(session_id="s-tools-01"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._hydrate_session_tools()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "session tool inventory" in joined
|
||||
assert "bifrost.set_field" in joined
|
||||
assert "session_tools_hydrated" in joined # audit line landed
|
||||
|
||||
async def test_hydrate_failure_audits_no_crash(
|
||||
self, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
"""hydrate_failure [error]: get_session_tools raises → failure audit; no crash."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionApiFailed
|
||||
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def boom(client, session_id):
|
||||
raise SessionApiFailed(status=404, body=b"session_not_found")
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_tools", boom)
|
||||
app = _resolved_app(_args_existing(session_id="s-tools-02"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._hydrate_session_tools()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "session_tools_hydration_failed" in joined
|
||||
|
||||
|
||||
class TestBifrostStateHydration:
|
||||
"""get_session_bifrost + the #176 BifrostState pane (GET /admin/sessions/{id}/bifrost)."""
|
||||
|
||||
@staticmethod
|
||||
def _mute_tools(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""Neutralize the on_mount Tools-pane worker so it makes no real call."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
|
||||
async def noop(client, session_id):
|
||||
return {"agent_id": "x", "builtin_tools": [], "bifrost_tools": []}
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_tools", noop)
|
||||
|
||||
def test_format_bifrost_state(self) -> None:
|
||||
"""format_bifrost_state [unit]: connected / endpoint / caps / tools lines."""
|
||||
from ratatoskr.tui import _format_bifrost_state
|
||||
|
||||
lines = _format_bifrost_state(
|
||||
{
|
||||
"endpoint_url": "https://b/mcp",
|
||||
"consumer_id": "alice",
|
||||
"connected": True,
|
||||
"capabilities_granted": ["tools:call", "tools:read"],
|
||||
"tools": [{"name": "bifrost.echo"}],
|
||||
}
|
||||
)
|
||||
joined = "\n".join(lines)
|
||||
assert "connected=True" in joined
|
||||
assert "consumer=alice" in joined
|
||||
assert "https://b/mcp" in joined
|
||||
assert "tools:call, tools:read" in joined
|
||||
assert "bifrost.echo" in joined
|
||||
|
||||
async def test_hydrate_no_admin_key(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""hydrate_no_admin_key [scenario]: admin_key None → 'not configured' + skip audit."""
|
||||
self._mute_tools(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
app = _resolved_app(_args_existing(session_id="s-bf-1")) # admin_key defaults None
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._hydrate_bifrost_state()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "admin key not configured" in joined
|
||||
assert "bifrost_state_skipped" in joined
|
||||
|
||||
async def test_hydrate_success(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""hydrate_success [scenario,tracer]: 200 → binding in BifrostState pane + audit."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
|
||||
self._mute_tools(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def fake_bifrost(client, session_id, *, admin_key):
|
||||
return {
|
||||
"endpoint_url": "https://b/mcp",
|
||||
"consumer_id": "alice",
|
||||
"connected": True,
|
||||
"capabilities_granted": ["tools:call"],
|
||||
"tools": [{"name": "bifrost.echo"}],
|
||||
}
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_bifrost", fake_bifrost)
|
||||
app = _resolved_app(_args_existing(session_id="s-bf-2", admin_key="ak"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._hydrate_bifrost_state()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "bifrost binding" in joined
|
||||
assert "bifrost.echo" in joined
|
||||
assert "bifrost_state_hydrated" in joined
|
||||
|
||||
async def test_hydrate_404_not_bound(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""hydrate_404_not_bound [error]: 404 → 'not bound to Bifrost' + audit; no crash."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionApiFailed
|
||||
|
||||
self._mute_tools(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def not_bound(client, session_id, *, admin_key):
|
||||
raise SessionApiFailed(status=404, body=b"session_not_bifrost_bound")
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_bifrost", not_bound)
|
||||
app = _resolved_app(_args_existing(session_id="s-bf-3", admin_key="ak"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._hydrate_bifrost_state()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "not bound to Bifrost" in joined
|
||||
assert "bifrost_state_unavailable" in joined
|
||||
|
||||
|
||||
class TestAdminEventsStream:
|
||||
"""stream_admin_events + the #11 AdminEvents pane (GET /admin/events, session-filtered)."""
|
||||
|
||||
@staticmethod
|
||||
def _mute_hydrates(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""Neutralize the other on_mount workers (tools + bifrost) — no real calls."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sessions import SessionApiFailed
|
||||
|
||||
async def noop_tools(client, session_id):
|
||||
return {"agent_id": "x", "builtin_tools": [], "bifrost_tools": []}
|
||||
|
||||
async def noop_bifrost(client, session_id, *, admin_key):
|
||||
raise SessionApiFailed(status=404, body=b"nb")
|
||||
|
||||
monkeypatch.setattr(tui_mod, "get_session_tools", noop_tools)
|
||||
monkeypatch.setattr(tui_mod, "get_session_bifrost", noop_bifrost)
|
||||
|
||||
def test_format_admin_event(self) -> None:
|
||||
"""format_admin_event [unit]: HH:MM:SS + type + fields; session_id dropped."""
|
||||
from ratatoskr.sse_client import AdminEvent
|
||||
from ratatoskr.tui import _format_admin_event
|
||||
|
||||
line = _format_admin_event(
|
||||
AdminEvent(
|
||||
42, "turn.completed", "2026-05-06T10:00:05.000Z",
|
||||
{"session_id": "s1", "turn_id": 7, "duration_ms": 1200, "phase": "succeeded"},
|
||||
)
|
||||
)
|
||||
assert "turn.completed" in line
|
||||
assert "[10:00:05]" in line
|
||||
assert "turn_id=7" in line
|
||||
assert "session_id" not in line # dropped — pane is already session-scoped
|
||||
|
||||
def test_admin_event_matches_filter(self) -> None:
|
||||
"""admin_event_matches [unit]: active-session + non-heartbeat system.* pass (§6)."""
|
||||
from ratatoskr.sse_client import AdminEvent
|
||||
|
||||
E = AdminEvent
|
||||
app = _resolved_app(_args_existing(session_id="s-match"))
|
||||
assert app._admin_event_matches(E(1, "session.created", "t", {"session_id": "s-match"}))
|
||||
assert not app._admin_event_matches(E(2, "turn.started", "t", {"session_id": "other"}))
|
||||
assert not app._admin_event_matches(E(0, "system.heartbeat", "t", {}))
|
||||
assert app._admin_event_matches(E(3, "system.events_dropped", "t", {"count": 5}))
|
||||
|
||||
async def test_stream_writes_filtered_events(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""stream_filtered [scenario,tracer]: only active-session + non-heartbeat lines land."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sse_client import AdminEvent
|
||||
|
||||
self._mute_hydrates(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def fake_stream(client, *, admin_key, last_event_id=None):
|
||||
yield AdminEvent(41, "session.created", "t", {"session_id": "s-ae-2"})
|
||||
yield AdminEvent(0, "system.heartbeat", "t", {}) # filtered (noise)
|
||||
yield AdminEvent(42, "turn.started", "t", {"session_id": "other"}) # diff session
|
||||
yield AdminEvent(43, "session.deleted", "t", {"session_id": "s-ae-2"})
|
||||
|
||||
monkeypatch.setattr(tui_mod, "stream_admin_events", fake_stream)
|
||||
app = _resolved_app(_args_existing(session_id="s-ae-2", admin_key="ak"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._stream_admin_events()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "session.created" in joined
|
||||
assert "session.deleted" in joined
|
||||
assert "system.heartbeat" not in joined
|
||||
assert "turn.started" not in joined # different session → filtered
|
||||
|
||||
async def test_stream_no_admin_key(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""stream_no_admin_key [scenario]: admin_key None → 'not configured' + skip audit."""
|
||||
self._mute_hydrates(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
app = _resolved_app(_args_existing(session_id="s-ae-3")) # admin_key None
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._stream_admin_events()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "admin key not configured" in joined
|
||||
assert "admin_events_skipped" in joined
|
||||
|
||||
async def test_stream_403_unavailable(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""stream_403 [error]: 403 scope-denied → 'unavailable' + audit; no crash."""
|
||||
import ratatoskr.tui as tui_mod
|
||||
from ratatoskr.sse_client import SseConnectFailed
|
||||
|
||||
self._mute_hydrates(monkeypatch)
|
||||
writes = _spy_writes(monkeypatch)
|
||||
|
||||
async def denied(client, *, admin_key, last_event_id=None):
|
||||
raise SseConnectFailed(status=403, body=b"auth_scope_denied")
|
||||
yield # unreachable — makes this an async generator
|
||||
|
||||
monkeypatch.setattr(tui_mod, "stream_admin_events", denied)
|
||||
app = _resolved_app(_args_existing(session_id="s-ae-4", admin_key="ak"))
|
||||
async with app.run_test() as pilot:
|
||||
await pilot.pause()
|
||||
await app._stream_admin_events()
|
||||
await pilot.pause()
|
||||
joined = " ".join(_text_of(w) for w in writes)
|
||||
assert "admin events unavailable: HTTP 403" in joined
|
||||
assert "admin_events_unavailable" in joined
|
||||
|
||||
+570
-2
@@ -175,6 +175,62 @@ class TestCreateSessionEndpoint:
|
||||
resp = TestClient(app).post("/api/sessions", json={})
|
||||
assert resp.status_code == 400
|
||||
|
||||
@respx.mock
|
||||
def test_preset_agent_auto_seeds_first_message(self) -> None:
|
||||
"""#347: a preset agent gets its opening seeded on create; a non-preset agent does not."""
|
||||
respx.post("https://w.example/sessions").mock(return_value=httpx.Response(201, json=_CREATE_OK))
|
||||
hist = respx.post("https://w.example/sessions/s-1/history").mock(
|
||||
return_value=httpx.Response(
|
||||
201,
|
||||
json={
|
||||
"author": "assistant", "seq": 0, "phase": "seeded", "turn_id": "t1",
|
||||
"session_id": "s-1", "content_chars": 1, "injected_at": "t",
|
||||
},
|
||||
)
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
client = TestClient(app)
|
||||
# preset agent → the endpoint seeds a first-message
|
||||
assert client.post("/api/sessions", json={"agent_id": "ratatoskr:sindra"}).status_code == 201
|
||||
assert hist.call_count == 1
|
||||
# non-preset agent → no seed (count unchanged)
|
||||
assert client.post("/api/sessions", json={"agent_id": "mimir"}).status_code == 201
|
||||
assert hist.call_count == 1
|
||||
|
||||
|
||||
class TestSessionMessagesEndpoint:
|
||||
"""GET /api/sessions/{id}/messages — proxy session history (renders the #347 seed)."""
|
||||
|
||||
@respx.mock
|
||||
def test_happy_returns_history(self) -> None:
|
||||
"""happy [tracer]: proxies GET /sessions/{id}/messages → 200 with the items verbatim."""
|
||||
payload = {
|
||||
"session_id": "s-1",
|
||||
"items": [{"seq": 0, "role": "assistant", "content": "Hey there."}],
|
||||
"next_cursor": None,
|
||||
}
|
||||
respx.get("https://w.example/sessions/s-1/messages").mock(
|
||||
return_value=httpx.Response(200, json=payload)
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
resp = TestClient(app).get("/api/sessions/s-1/messages")
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["items"][0]["content"] == "Hey there."
|
||||
|
||||
@respx.mock
|
||||
def test_non_200_status_preserved(self) -> None:
|
||||
"""error: upstream 404 → status-preserving session_messages_unavailable envelope."""
|
||||
respx.get("https://w.example/sessions/ghost/messages").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "session_not_found"})
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
resp = TestClient(app).get("/api/sessions/ghost/messages")
|
||||
assert resp.status_code == 404
|
||||
assert resp.json()["error_code"] == "session_messages_unavailable"
|
||||
|
||||
|
||||
_SNAPSHOT = {
|
||||
"agent_id": "mimir",
|
||||
@@ -616,13 +672,20 @@ class TestCreateAppShape:
|
||||
"""create_app FN — route registration + state wiring (contract TESTS)."""
|
||||
|
||||
def test_routes_registered(self) -> None:
|
||||
"""routes_registered [tracer]: app.routes contains all 9 path patterns."""
|
||||
"""routes_registered [tracer]: app.routes contains all path patterns,
|
||||
including the #18 affect-read proxy."""
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
paths = {getattr(r, "path", None) for r in app.routes}
|
||||
for expected in (
|
||||
"/", "/version", "/api/agents", "/api/sessions",
|
||||
"/api/agents/{agent_id}/persona_state",
|
||||
"/api/affect/{agent_id}",
|
||||
"/api/memory/chunks",
|
||||
# v0.19.2 debug-surface parity (create_app POST-002)
|
||||
"/api/sessions/{session_id}/tools",
|
||||
"/api/sessions/{session_id}/bifrost",
|
||||
"/api/admin/events",
|
||||
"/api/turns/{session_id}", "/api/turns/{session_id}/stream",
|
||||
"/api/turns/{session_id}/cancel",
|
||||
):
|
||||
@@ -631,10 +694,14 @@ class TestCreateAppShape:
|
||||
assert "/static" in paths
|
||||
|
||||
def test_state_attached(self) -> None:
|
||||
"""state_attached [trace]: app.state.turn_registry is empty dict."""
|
||||
"""state_attached [trace]: app.state.turn_registry is empty dict; admin_key stored."""
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
assert app.state.turn_registry == {}
|
||||
# create_app POST-001: admin_key defaults None (admin routes fail-visible)
|
||||
assert app.state.admin_key is None
|
||||
app2 = create_app(_mock_client_factory(), admin_key="adm-key")
|
||||
assert app2.state.admin_key == "adm-key"
|
||||
|
||||
def test_factory_stored(self) -> None:
|
||||
"""factory_stored [trace]: app.state.client_factory is the same callable."""
|
||||
@@ -792,3 +859,504 @@ class TestDisconnectCancel:
|
||||
await asyncio.sleep(0.02)
|
||||
gate.set()
|
||||
assert cancel_route.called, "browser disconnect must cancel the UPSTREAM turn (42)"
|
||||
|
||||
|
||||
class TestWebBifrostBind:
|
||||
"""Issue #17 slice 3c — web bind split: the browser selects the PLANE; the
|
||||
consumer key + visible host are SERVER-HELD and never reach the browser
|
||||
(INV-008/INV-009)."""
|
||||
|
||||
@respx.mock
|
||||
def test_bound_create_server_constructs_binding_key_never_leaks(self) -> None:
|
||||
"""tracer: a plane from the browser → the server builds the binding with
|
||||
its OWN consumer key + host, sends the bifrost body + consumer-key bearer
|
||||
upstream, and returns bound-state WITHOUT the key."""
|
||||
import json as _json
|
||||
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(201, json=_CREATE_OK)
|
||||
)
|
||||
# sindra is a preset agent → the endpoint now auto-seeds a #347 first-message.
|
||||
respx.post("https://w.example/sessions/s-1/history").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
bifrost_consumer_key="server-ck",
|
||||
bifrost_visible_host="10.100.10.50",
|
||||
)
|
||||
resp = TestClient(app).post(
|
||||
"/api/sessions", json={"agent_id": "ratatoskr:sindra", "bifrost_plane": "memory"}
|
||||
)
|
||||
assert resp.status_code == 201
|
||||
# bound-state echoed for the UI indicator — plane + endpoint, NO key
|
||||
assert resp.json()["bifrost"] == {
|
||||
"plane": "memory",
|
||||
"endpoint": "http://10.100.10.50:8391",
|
||||
"status": "bound",
|
||||
}
|
||||
assert "server-ck" not in resp.text # the key never reaches the browser
|
||||
# upstream got the bifrost body + the consumer-key bearer override
|
||||
upstream = route.calls[0].request
|
||||
body = _json.loads(upstream.content)
|
||||
assert body["bifrost"] == {
|
||||
"endpoint_url": "http://10.100.10.50:8391", "scope": None
|
||||
}
|
||||
assert upstream.headers["Authorization"] == "Bearer server-ck"
|
||||
|
||||
@respx.mock
|
||||
def test_combined_plane_binds_to_8392(self) -> None:
|
||||
"""combined [#18 composite]: a 'combined' plane from the browser → the server
|
||||
binds the :8392 both-plane endpoint; bound-state echoes plane='combined'."""
|
||||
import json as _json
|
||||
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
route = respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(201, json=_CREATE_OK)
|
||||
)
|
||||
# sindra is a preset agent → the endpoint now auto-seeds a #347 first-message.
|
||||
respx.post("https://w.example/sessions/s-1/history").mock(
|
||||
return_value=httpx.Response(201, json={})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
bifrost_consumer_key="server-ck",
|
||||
bifrost_visible_host="10.100.10.50",
|
||||
)
|
||||
resp = TestClient(app).post(
|
||||
"/api/sessions",
|
||||
json={"agent_id": "ratatoskr:sindra", "bifrost_plane": "combined"},
|
||||
)
|
||||
assert resp.status_code == 201
|
||||
assert resp.json()["bifrost"] == {
|
||||
"plane": "combined",
|
||||
"endpoint": "http://10.100.10.50:8392",
|
||||
"status": "bound",
|
||||
}
|
||||
upstream = route.calls[0].request
|
||||
body = _json.loads(upstream.content)
|
||||
assert body["bifrost"] == {
|
||||
"endpoint_url": "http://10.100.10.50:8392",
|
||||
"scope": None,
|
||||
}
|
||||
|
||||
def test_dropdown_offers_combined_as_default(self) -> None:
|
||||
"""(a)+default: the SPA plane dropdown offers a 'combined' (:8392) option,
|
||||
it is the DEFAULT-selected one, and single-plane memory/affect remain."""
|
||||
from pathlib import Path
|
||||
|
||||
import ratatoskr.web as web_pkg
|
||||
|
||||
html = (Path(web_pkg.__file__).parent / "static" / "index.html").read_text()
|
||||
assert '<option value="combined" selected>' in html
|
||||
assert 'value="memory"' in html and 'value="affect"' in html
|
||||
|
||||
@respx.mock
|
||||
def test_plane_without_server_config_is_400(self) -> None:
|
||||
"""A plane requested but no server-held key/host → bifrost_not_configured."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(_mock_client_factory()) # no bifrost config
|
||||
resp = TestClient(app).post(
|
||||
"/api/sessions", json={"agent_id": "a", "bifrost_plane": "memory"}
|
||||
)
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "bifrost_not_configured"
|
||||
|
||||
def test_invalid_plane_is_400(self) -> None:
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
bifrost_consumer_key="ck",
|
||||
bifrost_visible_host="h",
|
||||
)
|
||||
resp = TestClient(app).post(
|
||||
"/api/sessions", json={"agent_id": "a", "bifrost_plane": "persona"}
|
||||
)
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "invalid_bifrost_plane"
|
||||
|
||||
@respx.mock
|
||||
def test_handshake_failure_is_502(self) -> None:
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(
|
||||
502,
|
||||
json={
|
||||
"error_code": "bifrost_handshake_failed",
|
||||
"detail": {"bifrost_error": "bifrost.auth_rejected"},
|
||||
},
|
||||
)
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
bifrost_consumer_key="ck",
|
||||
bifrost_visible_host="h",
|
||||
)
|
||||
resp = TestClient(app).post(
|
||||
"/api/sessions", json={"agent_id": "a", "bifrost_plane": "memory"}
|
||||
)
|
||||
assert resp.status_code == 502
|
||||
assert resp.json()["error_code"] == "bifrost_handshake_failed"
|
||||
assert resp.json()["bifrost_error"] == "bifrost.auth_rejected"
|
||||
|
||||
@respx.mock
|
||||
def test_no_plane_is_unbound_no_bifrost_in_response(self) -> None:
|
||||
"""regression: no bifrost_plane → pre-#17 unbound create, no bifrost key."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.post("https://w.example/sessions").mock(
|
||||
return_value=httpx.Response(201, json=_CREATE_OK)
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
bifrost_consumer_key="ck",
|
||||
bifrost_visible_host="h",
|
||||
)
|
||||
resp = TestClient(app).post("/api/sessions", json={"agent_id": "mimir"})
|
||||
assert resp.status_code == 201
|
||||
assert "bifrost" not in resp.json()
|
||||
|
||||
|
||||
class TestAffectStateEndpoint:
|
||||
"""affect_state_endpoint FN — #18 Deliverable 2: web proxy to the provider PAD read."""
|
||||
|
||||
@respx.mock
|
||||
def test_happy_proxies_and_supplies_server_end_user_id(self) -> None:
|
||||
"""tracer: GET /api/affect/{id} → proxies to the configured provider read URL,
|
||||
supplying end_user_id SERVER-SIDE (INV-002); colon-id round-trips (INV-008)."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
snap = {
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"pad": {"pleasure": 0.15, "arousal": 0.08, "dominance": -0.01},
|
||||
"valence": [{"entity_id": "ratatoskr", "familiarity": 0.59, "regard": 0.15}],
|
||||
"emitted_at": "2026-06-18T15:58:12+00:00",
|
||||
}
|
||||
route = respx.get(url__regex=r"http://prov:8390/affect/state/.+").mock(
|
||||
return_value=httpx.Response(200, json=snap)
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
end_user_id="vuong",
|
||||
affect_read_url="http://prov:8390",
|
||||
)
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 200
|
||||
assert resp.json() == snap
|
||||
assert route.calls.last.request.url.params["end_user_id"] == "vuong"
|
||||
# INV-008: the colon-id round-trips into the provider path — whether the wire
|
||||
# keeps %3A or normalizes it, it must unquote back to the exact agent_id.
|
||||
from urllib.parse import unquote
|
||||
seg = str(route.calls.last.request.url).split("/affect/state/")[1].split("?")[0]
|
||||
assert unquote(seg) == "ratatoskr:sindra"
|
||||
|
||||
@respx.mock
|
||||
def test_browser_supplied_end_user_id_is_ignored(self) -> None:
|
||||
"""INV-002: a browser-supplied end_user_id query is IGNORED; the server's
|
||||
configured partition is used."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
route = respx.get(url__regex=r"http://prov:8390/affect/state/.+").mock(
|
||||
return_value=httpx.Response(200, json={"agent_id": "ratatoskr:sindra"})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", affect_read_url="http://prov:8390"
|
||||
)
|
||||
TestClient(app).get("/api/affect/ratatoskr:sindra?end_user_id=attacker")
|
||||
assert route.calls.last.request.url.params["end_user_id"] == "vuong"
|
||||
|
||||
def test_unconfigured_returns_400(self) -> None:
|
||||
"""PRE-001: no affect_read_url → 400 affect_not_configured (no silent attempt)."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(_mock_client_factory(), end_user_id="vuong") # no affect_read_url
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "affect_not_configured"
|
||||
|
||||
def test_no_end_user_configured_returns_400(self) -> None:
|
||||
"""PRE-001: affect_read_url set but server end_user_id unset → 400 (INV-003
|
||||
fail-visible, never a silent empty)."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(_mock_client_factory(), affect_read_url="http://prov:8390")
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "affect_not_configured"
|
||||
|
||||
@respx.mock
|
||||
def test_provider_unreachable_returns_502(self) -> None:
|
||||
"""POST-003: a network error reaching the provider → 502 affect_provider_unreachable."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.get(url__regex=r"http://prov:8390/affect/state/.+").mock(
|
||||
side_effect=httpx.ConnectError("refused")
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", affect_read_url="http://prov:8390"
|
||||
)
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 502
|
||||
assert resp.json()["error_code"] == "affect_provider_unreachable"
|
||||
|
||||
@respx.mock
|
||||
def test_provider_404_passes_through(self) -> None:
|
||||
"""POST-002: provider no_affect_snapshot 404 surfaces to the browser verbatim."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.get(url__regex=r"http://prov:8390/affect/state/.+").mock(
|
||||
return_value=httpx.Response(404, json={"error_code": "no_affect_snapshot"})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", affect_read_url="http://prov:8390"
|
||||
)
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 404
|
||||
assert resp.json()["error_code"] == "no_affect_snapshot"
|
||||
|
||||
@respx.mock
|
||||
def test_provider_400_passes_through(self) -> None:
|
||||
"""POST-002: a provider 400 (e.g. missing_end_user_id — unreachable in normal
|
||||
flow since the proxy always supplies it) still passes through verbatim."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.get(url__regex=r"http://prov:8390/affect/state/.+").mock(
|
||||
return_value=httpx.Response(400, json={"error_code": "missing_end_user_id"})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", affect_read_url="http://prov:8390"
|
||||
)
|
||||
resp = TestClient(app).get("/api/affect/ratatoskr:sindra")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "missing_end_user_id"
|
||||
|
||||
|
||||
class TestSessionToolsEndpoint:
|
||||
"""session_tools_endpoint — proxy owner-scoped GET /sessions/{id}/tools (#183)."""
|
||||
|
||||
@respx.mock
|
||||
def test_happy_returns_inventory(self) -> None:
|
||||
"""happy [tracer]: 200 inventory → 200 verbatim."""
|
||||
respx.get("https://w.example/sessions/s-1/tools").mock(
|
||||
return_value=httpx.Response(200, json={
|
||||
"agent_id": "ratatoskr:sindra",
|
||||
"builtin_tools": ["echo"],
|
||||
"bifrost_tools": [{"name": "memory.search"}],
|
||||
})
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
resp = TestClient(create_app(_mock_client_factory())).get("/api/sessions/s-1/tools")
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["agent_id"] == "ratatoskr:sindra"
|
||||
|
||||
@respx.mock
|
||||
def test_upstream_404_status_preserving_envelope(self) -> None:
|
||||
"""error: upstream 404 → 404 session_tools_unavailable envelope."""
|
||||
respx.get("https://w.example/sessions/s-1/tools").mock(
|
||||
return_value=httpx.Response(404, content=b"nope")
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
resp = TestClient(create_app(_mock_client_factory())).get("/api/sessions/s-1/tools")
|
||||
assert resp.status_code == 404
|
||||
assert resp.json()["error_code"] == "session_tools_unavailable"
|
||||
|
||||
|
||||
class TestSessionBifrostEndpoint:
|
||||
"""session_bifrost_endpoint — proxy admin-scoped GET /admin/sessions/{id}/bifrost (#176)."""
|
||||
|
||||
@respx.mock
|
||||
def test_happy_overrides_with_admin_bearer(self) -> None:
|
||||
"""happy [tracer]: 200 state → 200; request carries the ADMIN bearer, not consumer."""
|
||||
route = respx.get("https://w.example/admin/sessions/s-1/bifrost").mock(
|
||||
return_value=httpx.Response(200, json={
|
||||
"endpoint_url": "http://x:8392", "connected": True,
|
||||
"capabilities_granted": ["memory", "affect"], "tools": [],
|
||||
})
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory(), admin_key="adm-key")
|
||||
resp = TestClient(app).get("/api/sessions/s-1/bifrost")
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["connected"] is True
|
||||
assert route.calls.last.request.headers["Authorization"] == "Bearer adm-key"
|
||||
|
||||
def test_no_admin_key_fails_visible_400(self) -> None:
|
||||
"""error: no admin key configured → 400 admin_key_not_configured, no upstream call."""
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory()) # no admin_key
|
||||
resp = TestClient(app).get("/api/sessions/s-1/bifrost")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "admin_key_not_configured"
|
||||
|
||||
@respx.mock
|
||||
def test_upstream_404_status_preserving_envelope(self) -> None:
|
||||
"""error: upstream 404 (not bound) → 404 bifrost_state_unavailable envelope."""
|
||||
respx.get("https://w.example/admin/sessions/s-1/bifrost").mock(
|
||||
return_value=httpx.Response(404, content=b"nope")
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory(), admin_key="adm-key")
|
||||
resp = TestClient(app).get("/api/sessions/s-1/bifrost")
|
||||
assert resp.status_code == 404
|
||||
assert resp.json()["error_code"] == "bifrost_state_unavailable"
|
||||
|
||||
|
||||
class TestAdminEventsEndpoint:
|
||||
"""admin_events_endpoint — SSE proxy of GET /admin/events, session-filtered (#11)."""
|
||||
|
||||
def test_filter_semantics(self) -> None:
|
||||
"""unit: heartbeats drop, system.* pass, else match on session_id."""
|
||||
from ratatoskr.sse_client import AdminEvent
|
||||
from ratatoskr.web.server import _admin_event_matches_web
|
||||
|
||||
def mk(t: str, sid: "str | None" = None) -> AdminEvent:
|
||||
return AdminEvent(id=1, type=t, timestamp=None,
|
||||
data={"session_id": sid} if sid else {})
|
||||
|
||||
assert _admin_event_matches_web(mk("system.heartbeat"), "s-1") is False
|
||||
assert _admin_event_matches_web(mk("system.degraded"), "s-1") is True
|
||||
assert _admin_event_matches_web(mk("session.created", "s-1"), "s-1") is True
|
||||
assert _admin_event_matches_web(mk("session.created", "other"), "s-1") is False
|
||||
assert _admin_event_matches_web(mk("session.created", "s-1"), None) is False
|
||||
|
||||
def test_no_admin_key_fails_visible_400(self) -> None:
|
||||
"""error: no admin key → 400 admin_key_not_configured (no stream opened)."""
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory())
|
||||
resp = TestClient(app).get("/api/admin/events?session_id=s-1")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "admin_key_not_configured"
|
||||
|
||||
@respx.mock
|
||||
def test_streams_filtered_events_fixed_name(self) -> None:
|
||||
"""happy: SSE → only session-matching + system.* forwarded, as `admin_event`."""
|
||||
stream = (
|
||||
b'event: session.created\n'
|
||||
b'data: {"type":"session.created","data":{"session_id":"s-1"}}\n\n'
|
||||
b'event: system.heartbeat\n'
|
||||
b'data: {"type":"system.heartbeat","data":{}}\n\n'
|
||||
b'event: turn.started\n'
|
||||
b'data: {"type":"turn.started","data":{"session_id":"other"}}\n\n'
|
||||
b'event: system.degraded\n'
|
||||
b'data: {"type":"system.degraded","data":{}}\n\n'
|
||||
)
|
||||
respx.get("https://w.example/admin/events").mock(return_value=_sse_resp(stream))
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory(), admin_key="adm-key")
|
||||
body = TestClient(app).get("/api/admin/events?session_id=s-1").text
|
||||
assert "event: admin_event" in body # fixed browser-facing name
|
||||
assert '"type": "session.created"' in body # matches active session → forwarded
|
||||
assert "system.degraded" in body # system.* → forwarded
|
||||
assert "system.heartbeat" not in body # heartbeat → dropped
|
||||
assert "turn.started" not in body # other session → dropped
|
||||
|
||||
@respx.mock
|
||||
def test_stream_error_on_connect_failure(self) -> None:
|
||||
"""error: upstream admin SSE non-200 -> ONE stream_error frame, stream ends (POST-003)."""
|
||||
respx.get("https://w.example/admin/events").mock(
|
||||
return_value=httpx.Response(500, content=b"boom")
|
||||
)
|
||||
from ratatoskr.web.server import create_app
|
||||
app = create_app(_mock_client_factory(), admin_key="adm-key")
|
||||
body = TestClient(app).get("/api/admin/events?session_id=s-1").text
|
||||
assert "event: stream_error" in body
|
||||
assert "SseConnectFailed" in body
|
||||
assert body.count("event: stream_error") == 1 # exactly one, then ends
|
||||
|
||||
|
||||
class TestMemoryChunksEndpoint:
|
||||
"""memory_chunks_endpoint FN — memory viewer: web proxy to the provider debug read.
|
||||
Mirrors TestAffectStateEndpoint (the #18-D2 affect proxy shape)."""
|
||||
|
||||
@respx.mock
|
||||
def test_happy_proxies_and_supplies_server_end_user_id(self) -> None:
|
||||
"""tracer: GET /api/memory/chunks → proxies to the configured provider read URL,
|
||||
supplying end_user_id SERVER-SIDE and forwarding the browser-named agent_id."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
payload = {
|
||||
"chunks": [
|
||||
{"chunk_id": "c1", "content": "the user's cat is Mochi",
|
||||
"scope": {"end_user": "vuong", "agent_self": "ratatoskr:sindra"},
|
||||
"origin": "worldtree", "revision": 1}
|
||||
],
|
||||
"count": 1,
|
||||
"total": 1,
|
||||
}
|
||||
route = respx.get(url__regex=r"http://prov:8391/memory/chunks.*").mock(
|
||||
return_value=httpx.Response(200, json=payload)
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(),
|
||||
end_user_id="vuong",
|
||||
memory_read_url="http://prov:8391",
|
||||
)
|
||||
resp = TestClient(app).get("/api/memory/chunks?agent_id=ratatoskr:sindra")
|
||||
assert resp.status_code == 200
|
||||
assert resp.json() == payload
|
||||
assert route.calls.last.request.url.params["end_user_id"] == "vuong"
|
||||
assert route.calls.last.request.url.params["agent_id"] == "ratatoskr:sindra"
|
||||
|
||||
@respx.mock
|
||||
def test_browser_supplied_end_user_id_is_ignored(self) -> None:
|
||||
"""The server's configured partition is used; a browser end_user_id is ignored."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
route = respx.get(url__regex=r"http://prov:8391/memory/chunks.*").mock(
|
||||
return_value=httpx.Response(200, json={"chunks": [], "count": 0, "total": 0})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", memory_read_url="http://prov:8391"
|
||||
)
|
||||
TestClient(app).get("/api/memory/chunks?end_user_id=attacker&agent_id=a")
|
||||
assert route.calls.last.request.url.params["end_user_id"] == "vuong"
|
||||
|
||||
def test_unconfigured_returns_400(self) -> None:
|
||||
"""PRE-001: no memory_read_url → 400 memory_not_configured (no silent attempt)."""
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(_mock_client_factory(), end_user_id="vuong") # no memory_read_url
|
||||
resp = TestClient(app).get("/api/memory/chunks?agent_id=a")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "memory_not_configured"
|
||||
|
||||
def test_no_end_user_configured_returns_400(self) -> None:
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
app = create_app(_mock_client_factory(), memory_read_url="http://prov:8391")
|
||||
resp = TestClient(app).get("/api/memory/chunks?agent_id=a")
|
||||
assert resp.status_code == 400
|
||||
assert resp.json()["error_code"] == "memory_not_configured"
|
||||
|
||||
@respx.mock
|
||||
def test_provider_unreachable_returns_502(self) -> None:
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.get(url__regex=r"http://prov:8391/memory/chunks.*").mock(
|
||||
side_effect=httpx.ConnectError("refused")
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", memory_read_url="http://prov:8391"
|
||||
)
|
||||
resp = TestClient(app).get("/api/memory/chunks?agent_id=a")
|
||||
assert resp.status_code == 502
|
||||
assert resp.json()["error_code"] == "memory_provider_unreachable"
|
||||
|
||||
@respx.mock
|
||||
def test_provider_400_passes_through(self) -> None:
|
||||
from ratatoskr.web.server import create_app
|
||||
|
||||
respx.get(url__regex=r"http://prov:8391/memory/chunks.*").mock(
|
||||
return_value=httpx.Response(400, json={"error_code": "missing_end_user_id"})
|
||||
)
|
||||
app = create_app(
|
||||
_mock_client_factory(), end_user_id="vuong", memory_read_url="http://prov:8391"
|
||||
)
|
||||
resp = TestClient(app).get("/api/memory/chunks?agent_id=a")
|
||||
assert resp.status_code == 400
|
||||
|
||||
@@ -188,6 +188,18 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/64/b4/17d4b0b2a2dc85a6df63d1157e028ed19f90d4cd97c36717afef2bc2f395/attrs-26.1.0-py3-none-any.whl", hash = "sha256:c647aa4a12dfbad9333ca4e71fe62ddc36f4e63b2d260a37a8b83d2f043ac309", size = 67548 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "bifrost"
|
||||
version = "1.1.1"
|
||||
source = { registry = "https://gitea.phasefinal.com/api/packages/vh/pypi/simple/" }
|
||||
dependencies = [
|
||||
{ name = "jsonschema" },
|
||||
]
|
||||
sdist = { url = "https://gitea.phasefinal.com/api/packages/vh/pypi/files/bifrost/1.1.1/bifrost-1.1.1.tar.gz", hash = "sha256:0934c5fdf14823766346e591f5a16ab57a137cf06df794152318b5ccef0fb8e8" }
|
||||
wheels = [
|
||||
{ url = "https://gitea.phasefinal.com/api/packages/vh/pypi/files/bifrost/1.1.1/bifrost-1.1.1-py3-none-any.whl", hash = "sha256:dab551f8ad26464168f17108cb19564da56ee8e4789264a401e7a14463ab1576" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "certifi"
|
||||
version = "2026.5.20"
|
||||
@@ -419,6 +431,33 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/62/a1/3d680cbfd5f4b8f15abc1d571870c5fc3e594bb582bc3b64ea099db13e56/jinja2-3.1.6-py3-none-any.whl", hash = "sha256:85ece4451f492d0c13c5dd7c13a64681a86afae63a5f347908daf103ce6d2f67", size = 134899 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jsonschema"
|
||||
version = "4.26.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "attrs" },
|
||||
{ name = "jsonschema-specifications" },
|
||||
{ name = "referencing" },
|
||||
{ name = "rpds-py" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/b3/fc/e067678238fa451312d4c62bf6e6cf5ec56375422aee02f9cb5f909b3047/jsonschema-4.26.0.tar.gz", hash = "sha256:0c26707e2efad8aa1bfc5b7ce170f3fccc2e4918ff85989ba9ffa9facb2be326", size = 366583 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/69/90/f63fb5873511e014207a475e2bb4e8b2e570d655b00ac19a9a0ca0a385ee/jsonschema-4.26.0-py3-none-any.whl", hash = "sha256:d489f15263b8d200f8387e64b4c3a75f06629559fb73deb8fdfb525f2dab50ce", size = 90630 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jsonschema-specifications"
|
||||
version = "2025.9.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "referencing" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/19/74/a633ee74eb36c44aa6d1095e7cc5569bebf04342ee146178e2d36600708b/jsonschema_specifications-2025.9.1.tar.gz", hash = "sha256:b540987f239e745613c7a9176f3edb72b832a4ac465cf02712288397832b5e8d", size = 32855 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/41/45/1a4ed80516f02155c51f51e8cedb3c1902296743db0bbc66608a0db2814f/jsonschema_specifications-2025.9.1-py3-none-any.whl", hash = "sha256:98802fee3a11ee76ecaca44429fda8a41bff98b00a0f2838151b113f210cc6fe", size = 18437 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "librt"
|
||||
version = "0.11.0"
|
||||
@@ -1013,7 +1052,7 @@ wheels = [
|
||||
|
||||
[[package]]
|
||||
name = "ratatoskr"
|
||||
version = "0.17.0"
|
||||
version = "0.20.14"
|
||||
source = { editable = "." }
|
||||
dependencies = [
|
||||
{ name = "httpx" },
|
||||
@@ -1033,6 +1072,13 @@ dev = [
|
||||
{ name = "textual-dev" },
|
||||
{ name = "uvicorn", extra = ["standard"] },
|
||||
]
|
||||
provider = [
|
||||
{ name = "bifrost" },
|
||||
{ name = "jsonschema" },
|
||||
{ name = "sqlite-vec" },
|
||||
{ name = "starlette" },
|
||||
{ name = "uvicorn", extra = ["standard"] },
|
||||
]
|
||||
web = [
|
||||
{ name = "starlette" },
|
||||
{ name = "uvicorn", extra = ["standard"] },
|
||||
@@ -1040,21 +1086,39 @@ web = [
|
||||
|
||||
[package.metadata]
|
||||
requires-dist = [
|
||||
{ name = "bifrost", marker = "extra == 'provider'", specifier = "==1.1.1", index = "https://gitea.phasefinal.com/api/packages/vh/pypi/simple/" },
|
||||
{ name = "httpx", specifier = ">=0.27" },
|
||||
{ name = "httpx-sse", specifier = ">=0.4" },
|
||||
{ name = "jsonschema", marker = "extra == 'provider'", specifier = ">=4" },
|
||||
{ name = "mypy", marker = "extra == 'dev'", specifier = ">=1.11" },
|
||||
{ name = "pytest", marker = "extra == 'dev'", specifier = ">=8" },
|
||||
{ name = "pytest-asyncio", marker = "extra == 'dev'", specifier = ">=0.24" },
|
||||
{ name = "pyyaml", marker = "extra == 'dev'", specifier = ">=6" },
|
||||
{ name = "ratatoskr", extras = ["web"], marker = "extra == 'dev'" },
|
||||
{ name = "ratatoskr", extras = ["web"], marker = "extra == 'provider'" },
|
||||
{ name = "respx", marker = "extra == 'dev'", specifier = ">=0.21" },
|
||||
{ name = "ruff", marker = "extra == 'dev'", specifier = ">=0.6" },
|
||||
{ name = "sqlite-vec", marker = "extra == 'provider'", specifier = ">=0.1.6" },
|
||||
{ name = "starlette", marker = "extra == 'web'", specifier = ">=0.40" },
|
||||
{ name = "textual", specifier = ">=0.85" },
|
||||
{ name = "textual-dev", marker = "extra == 'dev'", specifier = ">=1.5" },
|
||||
{ name = "uvicorn", extras = ["standard"], marker = "extra == 'web'", specifier = ">=0.30" },
|
||||
]
|
||||
provides-extras = ["web", "dev"]
|
||||
provides-extras = ["web", "provider", "dev"]
|
||||
|
||||
[[package]]
|
||||
name = "referencing"
|
||||
version = "0.37.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "attrs" },
|
||||
{ name = "rpds-py" },
|
||||
{ name = "typing-extensions", marker = "python_full_version < '3.13'" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/22/f5/df4e9027acead3ecc63e50fe1e36aca1523e1719559c499951bb4b53188f/referencing-0.37.0.tar.gz", hash = "sha256:44aefc3142c5b842538163acb373e24cce6632bd54bdb01b21ad5863489f50d8", size = 78036 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/2c/58/ca301544e1fa93ed4f80d724bf5b194f6e4b945841c5bfd555878eea9fcb/referencing-0.37.0-py3-none-any.whl", hash = "sha256:381329a9f99628c9069361716891d34ad94af76e461dcb0335825aecc7692231", size = 26766 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "respx"
|
||||
@@ -1081,6 +1145,116 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/82/3b/64d4899d73f91ba49a8c18a8ff3f0ea8f1c1d75481760df8c68ef5235bf5/rich-15.0.0-py3-none-any.whl", hash = "sha256:33bd4ef74232fb73fe9279a257718407f169c09b78a87ad3d296f548e27de0bb", size = 310654 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rpds-py"
|
||||
version = "2026.5.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/2e/43/25a8dcd3feedd735039a8f0b5b7e3b118232b5eae288c4fd9ab200d41094/rpds_py-2026.5.1.tar.gz", hash = "sha256:07b24fea40541e28570e5b795a4a38fbdcd12550c06bd0748005ecc8116ca256", size = 64459 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/d4/e7/a78582dc57caa592dcc7d4fb69b61390561e908eb3d2f5df5928a8e354c0/rpds_py-2026.5.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3abe24a66e57adcfa645d718063a5fa5103ecc71ddbf26d78af8f9368018ff1d", size = 353040 },
|
||||
{ url = "https://files.pythonhosted.org/packages/a3/43/35e3f136343aef451e545ce8c38d36c2f93c0ed88703db8b64ba2b205c68/rpds_py-2026.5.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:58b1d94308ddf0b1982f61f2eb54bf92997c9ece8a8093ef014250f4a517906c", size = 345775 },
|
||||
{ url = "https://files.pythonhosted.org/packages/20/e1/0f2160c5982d3157734d5cb3ed63d8b2d583a73c9864f77b666449f32cf8/rpds_py-2026.5.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0fa92420128dadce7f54bd73ba1825a273e9268fe9e35dbf7e6362890efa4e08", size = 376329 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d0/11/ee0ba42aff83bf4effdbc576673c6be64c5e173978c3f6d537e94482f77d/rpds_py-2026.5.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ca653c6546386227cd9800d1bef6a348099acf8db4250341da6d90f663d6dfcb", size = 383539 },
|
||||
{ url = "https://files.pythonhosted.org/packages/11/df/d94aa6a499d4ac40afe2d7620f2c597fd3c0f182e854ad7cf3f596a81cb6/rpds_py-2026.5.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:66c93681c4729e4e3ecba31b8179fae083ff3118841672835140338b4b9867c1", size = 494674 },
|
||||
{ url = "https://files.pythonhosted.org/packages/1f/75/33d30f43bb2f458de11979486a591b1bf6e5651765ed1704c6197c2dc773/rpds_py-2026.5.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:40ff257542e04796880e011e15cd4dc21c2599975df2aaa8f2c8495ca574e1a5", size = 389268 },
|
||||
{ url = "https://files.pythonhosted.org/packages/f4/1e/2c9096fc19d5fd084b0184ca2b651e659aa0a37e6fdbecf6ece47f147fe1/rpds_py-2026.5.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b6825cc329b290e93c5f6a9be2393118a763f6ccf6abd83704e0c102ca583644", size = 376280 },
|
||||
{ url = "https://files.pythonhosted.org/packages/b9/e5/61ec9f8be8211ea7f48448195549e4aaf02004083475493b0e137702ecb2/rpds_py-2026.5.1-cp312-cp312-manylinux_2_31_riscv64.whl", hash = "sha256:de42116e69cb53b911cc34aee5ab98f36c597b822545045d49e938818b99e5e4", size = 387233 },
|
||||
{ url = "https://files.pythonhosted.org/packages/0d/ca/bcec1005c4f4a234f92a29078631fee49206c7265ccae966f18fd332e80e/rpds_py-2026.5.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:c0f920015df2a504bebaba6d4c31ccf3fcf942f92655c086da30b671aad19aa6", size = 405009 },
|
||||
{ url = "https://files.pythonhosted.org/packages/72/e6/4d5718c5cf26c522dc7c9999e238da1e77380b81d0c5d1df11e271ddfeb1/rpds_py-2026.5.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:0408a24e44feb919423dc6d9da677cb5cddb894d2ca9e763967d156d9c60fab4", size = 553113 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d4/25/2ee807bdb3e1f0b7eddf7782acd5665a8b5205a331a7d7244a52c4812fd9/rpds_py-2026.5.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:cea68bcd53467561ae2f96a6bdad1544299ba97b5b0ddcd5ac3d376e5c781c24", size = 618838 },
|
||||
{ url = "https://files.pythonhosted.org/packages/6a/c1/7d4c26f167f8c41501cc073d30ee22082b16ce358cf5b00ec97cbc7804ea/rpds_py-2026.5.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:4be8b1d2a705cc37d08256004e1d07de143fa0075c8e85a3df020b776f62b732", size = 582436 },
|
||||
{ url = "https://files.pythonhosted.org/packages/04/1d/9d12b0a337bab46f4769f8857f4007e3b2d639e14f9a44a0efe157696e64/rpds_py-2026.5.1-cp312-cp312-win32.whl", hash = "sha256:6736718bd4fc49cbcb538ba30516fdbef161522acefb739657d48b97bd864fed", size = 212734 },
|
||||
{ url = "https://files.pythonhosted.org/packages/c5/93/e4116f2de7f56bc7406a76033dc501811ddeb22b7f056b92d632871ebb0c/rpds_py-2026.5.1-cp312-cp312-win_amd64.whl", hash = "sha256:0a7d1eec967df0e9b22614a5e177622e0c89611d03727fa0cb48e45028907870", size = 229045 },
|
||||
{ url = "https://files.pythonhosted.org/packages/cb/53/6c3419d85eb2ec5938a37627c585b42d76a63bb731d6e42ed4b079ebf486/rpds_py-2026.5.1-cp312-cp312-win_arm64.whl", hash = "sha256:1841d067089e117142d79b98aa0df2f08b52f2ecc1819dd2700636c0db74a473", size = 223967 },
|
||||
{ url = "https://files.pythonhosted.org/packages/6c/32/14c961ad295f490eb0849ada8b79683e93a59b9de3afdd983eaf55fa6867/rpds_py-2026.5.1-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:efef4ac29c6ff495531eb17ee705b62841ecaa291b7c7077e848ea03e237164d", size = 352787 },
|
||||
{ url = "https://files.pythonhosted.org/packages/ca/bb/d1b85117967c11191441a7274ae616c65d93901d082c588f89a50a8da5ae/rpds_py-2026.5.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:c39f5b67a8a2e67179ada2a954227d670fe65fa9098457f698f56ddf248709b3", size = 345179 },
|
||||
{ url = "https://files.pythonhosted.org/packages/7c/46/d84105f062e626a1b233f863907288a4708c2d833b8b4c6fb2764bc080c0/rpds_py-2026.5.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b5c30f3f04eef4fbd362226a6f31d7c8895ca4fbb6e0b790f6890a98d8da8559", size = 376173 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e2/ae/469d7959ce5b1201e1de135dc735b86db3b35dd0d1734f6a44246d5f061c/rpds_py-2026.5.1-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:277f6c82f0580848796c7ecc8a7173aa3bfb928e4ff831261c2f60a81dc270db", size = 383162 },
|
||||
{ url = "https://files.pythonhosted.org/packages/dc/a2/57853d31a1116a561aa072794602ad3f6341e18d70a8523f1bd5b9fc1e5a/rpds_py-2026.5.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:63c2c4c213f1a4e3f3de28ecab029dbdee976324e729c0d7a55211be72576b02", size = 495093 },
|
||||
{ url = "https://files.pythonhosted.org/packages/99/63/3a8eabcad9314b7daf5c65f451d2c33d989235cd8a5762186cf2c3f5a4f8/rpds_py-2026.5.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3350ec808fb538fe71a1f94dfaa0e29c598dfad805ce49f0caec5ae3183c652b", size = 389829 },
|
||||
{ url = "https://files.pythonhosted.org/packages/4b/25/05678d97fc25e2622df14dc530fb82023174ecfff6733991ed0d78f167bd/rpds_py-2026.5.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b1b964e3ab599e718dc46c018d104b1ebc007cbc6567d827c94a687fca56d77e", size = 374786 },
|
||||
{ url = "https://files.pythonhosted.org/packages/88/d1/8c90b6431e80a3b91b284a5c7c8c0c4f9c006444d90477a740d6e0f9c694/rpds_py-2026.5.1-cp313-cp313-manylinux_2_31_riscv64.whl", hash = "sha256:19cb09fab7b7fc96b2a6e28f2e34b72a3705ff27b37edb77455316e5d3f3dc9b", size = 386920 },
|
||||
{ url = "https://files.pythonhosted.org/packages/ff/99/4638f672ab356682d633ee0da9255f5b67ce6efd0b85eb94ad3e255e65a5/rpds_py-2026.5.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:abe76bcdba31e576cb83eeb8797aa0d882b738fef6dc65d0601fc753806a5b46", size = 405059 },
|
||||
{ url = "https://files.pythonhosted.org/packages/66/3f/3546524b6eb4cc2e1f363a3d638fa52f6c24faae3500c25fb488b02f1740/rpds_py-2026.5.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:8bff7073db3899158fff55ebf57b113a67030af26f80a18978f9f0aa60250ddf", size = 553030 },
|
||||
{ url = "https://files.pythonhosted.org/packages/c6/c3/7b3388c796fcf471bd17194242d4dc1a7608567c0fa422bcc1c5e79f9c1e/rpds_py-2026.5.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:8ba264fa49be666cd9cc56bf34ec7002fb3d27a4aee5bcb4d43d0d18feb1bb6f", size = 618975 },
|
||||
{ url = "https://files.pythonhosted.org/packages/61/1e/a3cb07f2795075d1d88efddae2f541359fde5f08c81ee114c29c2949c90a/rpds_py-2026.5.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4860b603ddda0475a8885499b3729e90229d480105b42651962a5397d995fa89", size = 581178 },
|
||||
{ url = "https://files.pythonhosted.org/packages/a1/74/e758c03a5ef46f04c37f2651a2893db846d569ba8a7bca469d4b58939bcd/rpds_py-2026.5.1-cp313-cp313-win32.whl", hash = "sha256:7944270ae71383f6e2657dd7d5ce4eeb4ac2d0059a6738f0510583d462ab4842", size = 212481 },
|
||||
{ url = "https://files.pythonhosted.org/packages/70/ec/a2aca432db9c7359b40fa393eeeaa0d166c2f70175be956e75fa24197c44/rpds_py-2026.5.1-cp313-cp313-win_amd64.whl", hash = "sha256:88647f43a73c4e01be19b04ceef0c8d3a1958153604d13c773becd8016f2a0cf", size = 228519 },
|
||||
{ url = "https://files.pythonhosted.org/packages/29/60/a73bfdd45b096574556acf303bbd9fa9eed36ca8a818b514e2a5d5fe2b9d/rpds_py-2026.5.1-cp313-cp313-win_arm64.whl", hash = "sha256:453895624ecf7db7063b1004e44037522bbaef9ff6a945e59bc71662d7a03abd", size = 223446 },
|
||||
{ url = "https://files.pythonhosted.org/packages/18/e2/408105fd611823f00882aea810f3989a30d26b1bab8b6beb20f98c724e0e/rpds_py-2026.5.1-cp313-cp313t-macosx_10_12_x86_64.whl", hash = "sha256:b4e4bc98639ec915f512fde3aa7a95e0041d95d9c3cc86eea841fa63cb1e8600", size = 355287 },
|
||||
{ url = "https://files.pythonhosted.org/packages/8d/58/5c4a43436843c90d0f6d19f82c200c80e3843ca9fa07b237623327f6d384/rpds_py-2026.5.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:cacedb7a6e167680acba45ad5716e89067d225dc80da0d7040cae8c81d4572fa", size = 347033 },
|
||||
{ url = "https://files.pythonhosted.org/packages/fb/c2/1a71acdacaf4e259b10278fb87b039ded3cf80041bcd89dd8a3ea702ded6/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:68700371c5d7ae1412862ddfa719090925c93ecf351c566d66f09d04b136ea00", size = 376891 },
|
||||
{ url = "https://files.pythonhosted.org/packages/c2/c8/535f3d9b65addd8e28aa87b83c6e526799c3717a88273db8ea795beeef7a/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:296c799becfa849c779c8725494fe9ed94959ed886787df4364b058465bad7f0", size = 385646 },
|
||||
{ url = "https://files.pythonhosted.org/packages/1c/91/dc033f313345c354ade914dbe73cdb90b615a4409ea02430d5356794f3d8/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d3858b908218ee108d0bbfb2095ccc237648053c9bf98affad7cb079acaf1d97", size = 498830 },
|
||||
{ url = "https://files.pythonhosted.org/packages/27/fc/90fcbea459dbb8ddc18a2e0fd1de9412b48bc84ffff2db771cf714bacfd6/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4fb8d2e7cb2f850b169806d61d1b991738acec96500a75c30f49caf064ce7cef", size = 392830 },
|
||||
{ url = "https://files.pythonhosted.org/packages/b2/1d/46cd11a228c9750684a798d98f878be6f614aa762438da7378f035e79e35/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:27b74c10ed6a8f190f4287f53bcfea348b92a84a9c9f70d30183d1e6172d580d", size = 379613 },
|
||||
{ url = "https://files.pythonhosted.org/packages/24/4a/d9b0c6af3a1de03eb93741bbe8be2bdce84d8fda8224f3005451d86df389/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_31_riscv64.whl", hash = "sha256:b9a6528956191c48c52294a592dbd4a8386d7048bdb25c0efcb6b966466c6d83", size = 388183 },
|
||||
{ url = "https://files.pythonhosted.org/packages/c5/b4/db7aaabdda6d020afc87d981bcc2f57a434c7dec60ecfc2ab3dd50b20351/rpds_py-2026.5.1-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:af03e34e860047bc7a352b842856fcf78798fbb81132cc98bd2f907ab4eb9cd2", size = 408578 },
|
||||
{ url = "https://files.pythonhosted.org/packages/08/d6/070f6a41cbb343e2ac4171859bf3f3623e0ab002f72619d6d505313ec2de/rpds_py-2026.5.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:fea6e836d10abbe191d557d33bd58bd5987725fe63aa1eefe557d230209855bd", size = 553573 },
|
||||
{ url = "https://files.pythonhosted.org/packages/75/ab/1a71ea3589c4345dac0a0518f0e6a031cb42689277851b683c46d27463a5/rpds_py-2026.5.1-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:fc0c0f878ea770a0a8a462456c5ad36fc9fe6358e6b76fdadc7f17575e0b8bf1", size = 620861 },
|
||||
{ url = "https://files.pythonhosted.org/packages/8a/22/9bf80a56069c0c443fcfefac639a86a744550a2898817a6dfd3e26654924/rpds_py-2026.5.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:e0b360f316d966b048b085857630b3cc51f3db2f07b06f440eac8f695374d1e3", size = 585633 },
|
||||
{ url = "https://files.pythonhosted.org/packages/da/68/3b2c0a75c9e04125696f84ebdbbf304acf5a40b58ba4481cdb98a922c3ba/rpds_py-2026.5.1-cp313-cp313t-win32.whl", hash = "sha256:a2999883eedf72fdfb7520b92c7d4ec2572a71ff40239377aa604cc529eecafc", size = 210074 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e7/8b/609157d5a25d37d4f29f92840ba531f416907c34ae5c5739dd21fc2bef98/rpds_py-2026.5.1-cp313-cp313t-win_amd64.whl", hash = "sha256:e07be2a9d7122bd6e82dea89814ef8dc893feb1aae97fec1630f3263bbb30e55", size = 228635 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d4/6f/19c1918a4b590d8de87e712e4abe4b3875771eff60216fb6153cf6665c68/rpds_py-2026.5.1-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:1f2c391c3059798093b65df23aca2cac150460ae9c630d99dec83d703d9485b9", size = 349756 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e5/60/a06fe7da34eca79dacbf958a2ba0c6eea85bc2b29de20080bf40f72f66fa/rpds_py-2026.5.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:413b424f7c4ee65ab5e5be91f5731be0f8b41a1ee2b12dfe810d716312e95a78", size = 343831 },
|
||||
{ url = "https://files.pythonhosted.org/packages/bf/ec/b2333b97b90e2a6ef6ca8ad386ee284968e74bcfe113b3f1a8d9036429a9/rpds_py-2026.5.1-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2c595a1d9255dce0599e13130d1440ab2506654f2b50294226ee06402f8fef63", size = 375127 },
|
||||
{ url = "https://files.pythonhosted.org/packages/14/7f/e00aae54067f2b488c4637961d5f58204d470795fc791085fa3f15060d2e/rpds_py-2026.5.1-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:1c27c5f6102eac8c03e7595a00827a53b271ba40a53b59ff8709170e0855ea4a", size = 379034 },
|
||||
{ url = "https://files.pythonhosted.org/packages/be/cc/423999bbb8ae8dc93c77fc1d5e984ade5eb89d237d3bb884ccfa72ae2890/rpds_py-2026.5.1-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6c7fcf61d44cacecaf3aea542b0e053db77972a4573e7ceda16fb2b399161195", size = 490823 },
|
||||
{ url = "https://files.pythonhosted.org/packages/0f/aa/c671bf660f12e68d3c52ff86c7066ed1372df5a0f4f2ff584e419b8207e7/rpds_py-2026.5.1-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2c817a189d4ee14290420e5ff051e4dd6baa13f3edf84685071dee07a6d538ee", size = 388144 },
|
||||
{ url = "https://files.pythonhosted.org/packages/19/c8/d63bb75b68afe77b229e3021c6031bcaf01da5db5b0e69d0d10f9ba679a7/rpds_py-2026.5.1-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:21846aac0ed2e0589f38c12dc44e77bb64e494b771eadbcf169cba00566ba7ba", size = 371959 },
|
||||
{ url = "https://files.pythonhosted.org/packages/82/35/c51122014d8274ff37dc606d60049c3db7d83da02b5b282511e5a906a9a6/rpds_py-2026.5.1-cp314-cp314-manylinux_2_31_riscv64.whl", hash = "sha256:b317c87a13f769a4e787819bd508aaa5d69aa09b0880de9af6d3a8a54571cdec", size = 383558 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e3/f9/2790cb99c136a5363acdeacf5c27c56f3de0d4118a1f48fca83404c99c89/rpds_py-2026.5.1-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ce87129d9f2c14fa6c4a8601fb80eb4488c80d38a20cd13758ef11123e14995d", size = 402789 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e5/1b/e4fb584f8c75d35c38150ff6a332cda949e6f97acba1f4fd123b14ab56fe/rpds_py-2026.5.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:9cdddb6c1207d284d94fd1530adf57fbd797fe7c4b8704ba85f49414f2557e7d", size = 551405 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d8/f7/a6731b4216cb3793ea1af5391da240f5683dacc0d13e034fe5fc3503f240/rpds_py-2026.5.1-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:4e237e139f94d3c036fd28eb9f564c99055476ff4ff05cd42be55ce349b5aa02", size = 616975 },
|
||||
{ url = "https://files.pythonhosted.org/packages/2c/ea/2e051a81d95d8e63f4b35a1c463a87e8766bc3d083c067c5dfb6bf220747/rpds_py-2026.5.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ed0954b524873214369184a9c82b0eaa45a3fbb9a798cd95b17e0d98499e7ea0", size = 578701 },
|
||||
{ url = "https://files.pythonhosted.org/packages/65/56/b5f6fdb2083e32bca8a8993d89e70db114b4756c9e2c38421328126689d2/rpds_py-2026.5.1-cp314-cp314-win32.whl", hash = "sha256:2d88621d6a7d4dfa633d21abe90f280bb205274e16b1d1e61c6ad4640b2453b7", size = 209806 },
|
||||
{ url = "https://files.pythonhosted.org/packages/fb/80/65a5aa96c155e611d1ed844e4e1f57f3e36b021f396d9f8585d756e6b90d/rpds_py-2026.5.1-cp314-cp314-win_amd64.whl", hash = "sha256:cef8ac28d26f4dda3533060c20fbf80a325458fa9fd23ea72a73cdfa8e978838", size = 225985 },
|
||||
{ url = "https://files.pythonhosted.org/packages/27/7c/ad185212e87b05f196daef92bc5f3caf07298eb47c295b5585c3dd3093ac/rpds_py-2026.5.1-cp314-cp314-win_arm64.whl", hash = "sha256:eaaea962c68cdc68d4a533ba985ab8e9484277910bbfaa2ab3ef7732667bfed8", size = 221219 },
|
||||
{ url = "https://files.pythonhosted.org/packages/23/58/e14ae18759020334646b031e708ab4158d653a938822bfb7b95ef2e93aa3/rpds_py-2026.5.1-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:21942f52dbbd5f8758bf021213d28bd45c39e873e65e2407faf5f1846f5761ad", size = 352148 },
|
||||
{ url = "https://files.pythonhosted.org/packages/31/9b/5f4a1e2f960bca3ac5d052b139dd31eed97b259f9d909173821760d542e8/rpds_py-2026.5.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:f414556f6e3958300ff941e40c9f97e3dc9774ddd1b3434c475d73dd354bbed3", size = 345196 },
|
||||
{ url = "https://files.pythonhosted.org/packages/1a/71/1d9574d6a2fa20ab60eaa55c7467f5aa20cbc770f341a05f09c0876f59e2/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ef1013a8625c74043210190b246f5b1551e09757c1f356c6e4160ef96c5bc081", size = 374981 },
|
||||
{ url = "https://files.pythonhosted.org/packages/0c/9a/37e99f4915a80aa71670263c1267f7ae0af95f53a3f61e6c3bdc016d4515/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:cc68e231a77a5f0d774ae278a1f8e55c0456501820847c1e4efb3829f3441df6", size = 379961 },
|
||||
{ url = "https://files.pythonhosted.org/packages/a8/ff/6e73f74b89d2e0715e0fc86b7dde893f9a61ae2f9b256ff3bdfe41ac4e94/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9baffb505aff33acc69b422a19f77806680f3c8632227d79f48de8a810d1c2c5", size = 495965 },
|
||||
{ url = "https://files.pythonhosted.org/packages/ea/e0/425faba25f59d74d4638b267f7c7a80e8649d2ef4db10a19b0c4a71e6e6f/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b8d2f912928d426e8cfa396f7f3f8d29a59e6689c86dcca3c420730c1096322b", size = 389526 },
|
||||
{ url = "https://files.pythonhosted.org/packages/c6/76/7a41960e3fddae47fab43a28684d5da981401dffd88253de0944148654cb/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90f628283be835db980c941767d41c9a27b5239e54ba0a9c1335247e82406964", size = 376190 },
|
||||
{ url = "https://files.pythonhosted.org/packages/27/60/5f38dc70824fc6951b51d35377e577a3a3a4c81a6769cc5a2de25ebe0ad1/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_31_riscv64.whl", hash = "sha256:1ebb2f0ab7e16132995a72de805170e0203df0c3dd22e1ef1cd1fdd90bd7a131", size = 383921 },
|
||||
{ url = "https://files.pythonhosted.org/packages/60/1a/d60a38caa1505f4b9483c3fbbde12c94e1079154f4f401a6da96f7e77621/rpds_py-2026.5.1-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f3df3d16ded76f1f8c9cdebd0e1ea55fdf4c23b812de189814da7cf229c22a81", size = 404766 },
|
||||
{ url = "https://files.pythonhosted.org/packages/87/ff/602fd3f174d6425f0bce05ad0dfbec0e96b38d0f7d08a79af5aa20083885/rpds_py-2026.5.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:9af8905b8f854990e40d5206aa5ac58d9b0fe0b7f351ff2bb086c20f6c8c6a47", size = 551343 },
|
||||
{ url = "https://files.pythonhosted.org/packages/b8/c1/1be13327acdbead3eca1fde03b6a34dbb011f1e864e217f0d32cc1779a7f/rpds_py-2026.5.1-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:036a36a87fb1cd3b214d11c4b3c4f7d2ddad933625dca1c900b56a057c07740a", size = 618502 },
|
||||
{ url = "https://files.pythonhosted.org/packages/f3/d7/afb49b49d7f2be8b7ba1a9f0977fa5168003437b93086726f066544e8351/rpds_py-2026.5.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:62ae3853454fe9ef283a03c96c2d835d39e84b14643a9d62c82ef0fb87d702ca", size = 581916 },
|
||||
{ url = "https://files.pythonhosted.org/packages/25/d1/dbef8c1f8a10f07beb62b5f054e20099fd9924b3ec001b8f0b6ac7813a85/rpds_py-2026.5.1-cp314-cp314t-win32.whl", hash = "sha256:6c3d771a46ec18b12af06ce36243a9a80b07a5d0515236332d90863ca8bb326a", size = 207855 },
|
||||
{ url = "https://files.pythonhosted.org/packages/2a/72/bfa4e61ab8e7dc1c8adf397e05e6cbdd4239357bd72b248d3de662f23915/rpds_py-2026.5.1-cp314-cp314t-win_amd64.whl", hash = "sha256:c93c629be4636cf54337bd5f06c104d55e42ced54d681f6fe21ae510a65116f6", size = 225422 },
|
||||
{ url = "https://files.pythonhosted.org/packages/27/3a/7b5da92b640f67b6717ccafc83cdd06bfa7ff2395c3685c68922bb54d703/rpds_py-2026.5.1-cp315-cp315-macosx_10_12_x86_64.whl", hash = "sha256:3574b55c604b8f75dacb007136508bbc0db406e626301778096a133327e7f2fb", size = 349576 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d7/8a/2aafd7ad355a1bd48ca76e2262b74b15e6432b5a1efe150efd4d779cd55d/rpds_py-2026.5.1-cp315-cp315-macosx_11_0_arm64.whl", hash = "sha256:94068eb3ae6d43f5a786b7db96a406a34e6d5c24489feef32fd6e8946ea7b291", size = 343640 },
|
||||
{ url = "https://files.pythonhosted.org/packages/f7/7d/6c9523c1abbe840a1b7fba3c516d48e1d3487cc80fea4366c4071cf56784/rpds_py-2026.5.1-cp315-cp315-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f3a5b10e8ce894825f380a8f1b6444cf73c294dfea62afbb2d13e3a9e630cec1", size = 375322 },
|
||||
{ url = "https://files.pythonhosted.org/packages/5a/5d/0b7b03fb1dc509321f01de3149784ab773e34c8573022029af8076afcb9c/rpds_py-2026.5.1-cp315-cp315-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fc09f82e63d4bcd58149572f857a431bae851dc747e313c3b5bdf7abb907fda8", size = 379066 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d7/e2/8ef6012999ebf1cb1c22f876d9ce5e63d960fd4631d2af3202d3f480aa25/rpds_py-2026.5.1-cp315-cp315-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e10464d17df3b582745c25cec695cb9558bca2cb6ddb631aee1787fc72c767b2", size = 494586 },
|
||||
{ url = "https://files.pythonhosted.org/packages/80/af/1eeb029bec67582c226b7809172207cd005073af4ebd906e65ff494f4983/rpds_py-2026.5.1-cp315-cp315-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ba05adbf15d994c38ec0b7ab32e858e5110c21e9009a00a86545fd220f84e038", size = 388415 },
|
||||
{ url = "https://files.pythonhosted.org/packages/18/23/ffbe10711c4d766c1cab0557d6906c074f795814863c67b351355d29354a/rpds_py-2026.5.1-cp315-cp315-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:77c004fdc7b891967106f78ddfd7b076bfe6813c6139c6fff6aed3bcaa960b26", size = 372427 },
|
||||
{ url = "https://files.pythonhosted.org/packages/bd/3a/30ba4a6ad457e5b070c18d742a33fb77d8d922b565cc881f8a5313d63bfe/rpds_py-2026.5.1-cp315-cp315-manylinux_2_31_riscv64.whl", hash = "sha256:83bcf894486c9d78dd290d3c0124ff6dd8875d3025e2090a8ec49fcc37c55fdd", size = 383615 },
|
||||
{ url = "https://files.pythonhosted.org/packages/d3/69/62e242b53ce39c0814bd24e1a6e6eba6c92be716277745f317f9540a2e7b/rpds_py-2026.5.1-cp315-cp315-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:c3df104083952a0e0c6f10de33e440eabe98fb6317d23e1a58c68f6df08d01b9", size = 402786 },
|
||||
{ url = "https://files.pythonhosted.org/packages/38/c1/a770b9c186928a1ed0f7e6d7ae50e7f3950ed23e3f9e366dbc8e38cb55de/rpds_py-2026.5.1-cp315-cp315-musllinux_1_2_aarch64.whl", hash = "sha256:980450826cf22e133c57e0835070bdd0dd3f73b9b708c3ce223def2cb9469e14", size = 551583 },
|
||||
{ url = "https://files.pythonhosted.org/packages/21/7c/68e8579b95375b70d2a963103c42e705856cdb98569258bd807f4423891c/rpds_py-2026.5.1-cp315-cp315-musllinux_1_2_i686.whl", hash = "sha256:205dde846f24332ab0c1188699a043b8d165b79bb84529ce272c45048ff6be01", size = 616941 },
|
||||
{ url = "https://files.pythonhosted.org/packages/70/a1/a6135aed5730ff03ab957182259987ac11e55fb392a28dc6f0592048a280/rpds_py-2026.5.1-cp315-cp315-musllinux_1_2_x86_64.whl", hash = "sha256:3966b82dd563176396df030f3dd52a6e54cb69b718e95e78bd555ed3d1e0185d", size = 578349 },
|
||||
{ url = "https://files.pythonhosted.org/packages/09/6e/f24201a76a84e6c49d0bdfdfcb735210e21701e9b21c5bfc0ba497dd62f6/rpds_py-2026.5.1-cp315-cp315-win32.whl", hash = "sha256:7818f8d0a415be74d2be3590b0a1c1f463a642f4d0217e7d10602dceef5b79aa", size = 209922 },
|
||||
{ url = "https://files.pythonhosted.org/packages/9e/e4/966bc240bb0485fc265278f6de44d05834bf0b3618886e0b22e33d54c49a/rpds_py-2026.5.1-cp315-cp315-win_amd64.whl", hash = "sha256:b3cc20c0d800af78fd0fac68086e28c1856cec51ea528bb81ea851aa40d39325", size = 226003 },
|
||||
{ url = "https://files.pythonhosted.org/packages/5c/5c/a15a59269cd5e74472734516c73795c15eccfc841b3d4b0228c3f53f19d0/rpds_py-2026.5.1-cp315-cp315-win_arm64.whl", hash = "sha256:3609e9939a8a76cd904cf98a3f1f13b5dc7e150adeaee89e0ea09652ea213e16", size = 221245 },
|
||||
{ url = "https://files.pythonhosted.org/packages/e0/22/135ce03804e179a71ceb13be095deda4a279bc88f7a6b8fa161c5ad44e12/rpds_py-2026.5.1-cp315-cp315t-macosx_10_12_x86_64.whl", hash = "sha256:5d333a7127d4b307601ac37792bee01bb95c867cbfacf21b6375b804d6bbd723", size = 352015 },
|
||||
{ url = "https://files.pythonhosted.org/packages/3b/5f/f1f6d2652eb9d848f6eb369d8db83a2da6249bb49ad2c2a48f45d54538d3/rpds_py-2026.5.1-cp315-cp315t-macosx_11_0_arm64.whl", hash = "sha256:b5f077b44a4f7808520f66dae234988d867deb9aed9be5da057ce9ba831b2a41", size = 345016 },
|
||||
{ url = "https://files.pythonhosted.org/packages/88/66/b74182775691ea2290c99e52ac8d5db844e56fbec90ce421f107658c8314/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:55d8f9b7b78c9538fc9e04e82ec0e888ff0c3cffcfad152c77e57cd09351a98a", size = 374775 },
|
||||
{ url = "https://files.pythonhosted.org/packages/ff/8f/15e5a61d9f0a43902d36561d4f07cae6ae9f4716be825159fd72717f33af/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e3a8ae58895ac107ed934a6bf51e5846f95c53b9b940c2c6d310838fd5846358", size = 380270 },
|
||||
{ url = "https://files.pythonhosted.org/packages/02/c3/f859b12763a80540cdf2af0f15b19904cf756a71d7bdd3f82ff3e5b1bbf9/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0957cf3c2b8632ec7aaebffebea8005b353cc2a237b6e2ae3c2cac0820704cfb", size = 495285 },
|
||||
{ url = "https://files.pythonhosted.org/packages/1c/c7/ff27c2ac8411d30b03b1829fd88cae8dad1a4d0da48dd25e57c4038042e6/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c396c1304de421050b3681ea70f371874b54d41b0151e96109758144c231e30b", size = 389581 },
|
||||
{ url = "https://files.pythonhosted.org/packages/6e/67/fe92ee32a6cc05c77228a2f8b1762e7124f386ec20ff83d0757b762d58d0/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aad1bff7f666b9598e573815affd666aac6a13a585dde336f843e33350c7fadc", size = 376041 },
|
||||
{ url = "https://files.pythonhosted.org/packages/f8/91/b4d6685c27aba55bd82f25b278be8237038117d05f9659a6213ad3408130/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_31_riscv64.whl", hash = "sha256:656a042550878f12d45752452d47094b7cfe5ad1e9d7b87b5a22ad3ae5ff8015", size = 383946 },
|
||||
{ url = "https://files.pythonhosted.org/packages/bd/79/2c1d832a53c8e0f8e98fc970ec257b950fecd4f62be2ab7182b500a0cbc8/rpds_py-2026.5.1-cp315-cp315t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:73c4bd4f70294737b5206a3e8e30ccadbf8a60301831c8ea23eec5dbeea1ecfa", size = 405526 },
|
||||
{ url = "https://files.pythonhosted.org/packages/78/c4/c98117b03c6a8581ab2c2dfccfe9a5ad82bd8128a3c28b46a6ad2d97c393/rpds_py-2026.5.1-cp315-cp315t-musllinux_1_2_aarch64.whl", hash = "sha256:43bca78665423cabae77146f2fe7ce55272b6c8d55d82cca83effd42c7e13972", size = 551165 },
|
||||
{ url = "https://files.pythonhosted.org/packages/3b/c1/bc479ca069200af730881b1bd525e3114b2b391a351509fcb1b772f28086/rpds_py-2026.5.1-cp315-cp315t-musllinux_1_2_i686.whl", hash = "sha256:42d0f20e85e549c870749d0e247f0c10d318a45b7e9676d575d2dcb04a1b2e66", size = 618778 },
|
||||
{ url = "https://files.pythonhosted.org/packages/77/65/38ab2f90df44c2febfb63cc10ced40763d9b4bc94d173e734528663fe7f5/rpds_py-2026.5.1-cp315-cp315t-musllinux_1_2_x86_64.whl", hash = "sha256:b1be5c35683684d5331b93600c210e8367c254683d8a6df6bd21bd2da3a334fb", size = 581839 },
|
||||
{ url = "https://files.pythonhosted.org/packages/15/2d/ce1f605fe036aadd460e5822e578c6c7ec3a860936cca37d6e0f299daa77/rpds_py-2026.5.1-cp315-cp315t-win32.whl", hash = "sha256:75808f6c38ce7749bb68cc2770161aae5045e6c6f6781a9782e74b93304399df", size = 207866 },
|
||||
{ url = "https://files.pythonhosted.org/packages/79/cb/966040123eb102371559746908ef2c9471f4d43e17ec9a645a2258dab64b/rpds_py-2026.5.1-cp315-cp315t-win_amd64.whl", hash = "sha256:90bd6630002a1c7f09e7843dd79f0d24f3d2897cc25a753480917865d14f15b3", size = 225441 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruff"
|
||||
version = "0.15.13"
|
||||
@@ -1106,6 +1280,18 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/9b/36/9c015cd052fca743dae8cb2aeb16b551444787467db42ceab0fc968865af/ruff-0.15.13-py3-none-win_arm64.whl", hash = "sha256:2471da9bd1068c8c064b5fd9c0c4b6dddffd6369cb1cd68b29993b1709ff1b21", size = 11179336 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sqlite-vec"
|
||||
version = "0.1.9"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/68/85/9fad0045d8e7c8df3e0fa5a56c630e8e15ad6e5ca2e6106fceb666aa6638/sqlite_vec-0.1.9-py3-none-macosx_10_6_x86_64.whl", hash = "sha256:1b62a7f0a060d9475575d4e599bbf94a13d85af896bc1ce86ee80d1b5b48e5fb", size = 131171 },
|
||||
{ url = "https://files.pythonhosted.org/packages/a4/3d/3677e0cd2f92e5ebc43cd29fbf565b75582bff1ccfa0b8327c7508e1084f/sqlite_vec-0.1.9-py3-none-macosx_11_0_arm64.whl", hash = "sha256:1d52e30513bae4cc9778ddbf6145610434081be4c3afe57cd877893bad9f6b6c", size = 165434 },
|
||||
{ url = "https://files.pythonhosted.org/packages/00/d4/f2b936d3bdc38eadcbd2a87875815db36430fab0363182ba5d12cd8e0b51/sqlite_vec-0.1.9-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e921e592f24a5f9a18f590b6ddd530eb637e2d474e3b1972f9bbeb773aa3cb9", size = 160076 },
|
||||
{ url = "https://files.pythonhosted.org/packages/6f/ad/6afd073b0f817b3e03f9e37ad626ae341805891f23c74b5292818f49ac63/sqlite_vec-0.1.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux1_x86_64.whl", hash = "sha256:1515727990b49e79bcaf75fdee2ffc7d461f8b66905013231251f1c8938e7786", size = 163388 },
|
||||
{ url = "https://files.pythonhosted.org/packages/42/89/81b2907cda14e566b9bf215e2ad82fc9b349edf07d2010756ffdb902f328/sqlite_vec-0.1.9-py3-none-win_amd64.whl", hash = "sha256:4a28dc12fa4b53d7b1dced22da2488fade444e96b5d16fd2d698cd670675cf32", size = 292804 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "starlette"
|
||||
version = "1.1.0"
|
||||
|
||||
Reference in New Issue
Block a user