Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| daebb54f47 | |||
| a598221812 | |||
| bada72f87e | |||
| 7d8371dea1 | |||
| 3a51425ec7 | |||
| 7c6c906db2 | |||
| 2ac20b1621 | |||
| 493d6b6eee | |||
| 959fc906de | |||
| b648b3ed45 | |||
| 54736de91c | |||
| adb5d25715 | |||
| cbf02d5507 | |||
| 317738ed79 | |||
| 5be2c48afe | |||
| cbc9949972 | |||
| e0d9ed7c5a | |||
| 69a166a6f2 | |||
| bb5137f176 | |||
| 477f496cbf | |||
| 822f4266f6 | |||
| 39e57706d9 | |||
| ac3513a686 | |||
| 213f6862d5 |
+184
@@ -23,6 +23,190 @@ skip versions are the composition of each intervening adjacent
|
|||||||
release's steps in order — no A-to-B path is pre-computed beyond
|
release's steps in order — no A-to-B path is pre-computed beyond
|
||||||
that.
|
that.
|
||||||
|
|
||||||
|
## 0.23.0 — 2026-05-28
|
||||||
|
|
||||||
|
Roadmap item #29: signing in lands the user on their most recently
|
||||||
|
viewed app state instead of the empty-state home view. Shipped from
|
||||||
|
driver session 0022.0. Per-user, server-side, on by default; first-ever
|
||||||
|
sign-ins still land on home.
|
||||||
|
|
||||||
|
1. **Server-side last-state.** A new `user_session_state` table holds one
|
||||||
|
row per user: `last_route TEXT`, `last_route_state TEXT` (light view
|
||||||
|
state encoded as JSON — SQLite has no native JSONB — never draft-buffer
|
||||||
|
contents), `resume_enabled INTEGER NOT NULL DEFAULT 1`, and
|
||||||
|
`last_updated_at`. Per-user (not per-device), matching the
|
||||||
|
"go to where I was last" intent.
|
||||||
|
2. **Route-change capture.** A new frontend hook (`frontend/src/lib/
|
||||||
|
useLastState.js`) debounce-posts the current route + light state to
|
||||||
|
`PUT /api/me/last-state` for authenticated users only; anonymous
|
||||||
|
sessions are a no-op. The handler upserts the user's row and no-ops
|
||||||
|
when `resume_enabled` is 0.
|
||||||
|
3. **Sign-in redirect.** The stored `last_route` (+ decoded state +
|
||||||
|
`resume_enabled`) is folded onto the existing `/api/auth/me` payload
|
||||||
|
(no new GET endpoint), so the frontend reads it on boot. On a hard
|
||||||
|
sign-in landing (app booted on `/`), the app redirects to the stored
|
||||||
|
route. The redirect is gated on the #21-Part-C Amplitude `identify`
|
||||||
|
having fired (`identifyReady`), preserving identify-then-track
|
||||||
|
ordering — the first event on the resumed route carries the user_id.
|
||||||
|
4. **Edge cases.** Stale routes (an RFC since withdrawn or now
|
||||||
|
unreadable) are a graceful no-op — existing routing falls through to
|
||||||
|
the catalog/empty-state. Opt-out ships at the column level
|
||||||
|
(`resume_enabled`); the profile-settings toggle UI is a follow-up.
|
||||||
|
Stored state is route + light view state only, never draft contents
|
||||||
|
(documented in `SPEC.md` §6.8).
|
||||||
|
|
||||||
|
Migration `022_user_session_state.sql` creates the table. No new
|
||||||
|
environment variables, overlay keys, or secrets.
|
||||||
|
|
||||||
|
Upgrade steps:
|
||||||
|
|
||||||
|
1. Deployments **MUST** apply database migrations; `022_user_session_state.sql`
|
||||||
|
runs automatically on next boot (the migration runner globs
|
||||||
|
`backend/migrations/*.sql` and applies any not yet recorded in
|
||||||
|
`schema_migrations`). The migration is additive — a new table — and
|
||||||
|
requires no data backfill.
|
||||||
|
2. No new environment variables, overlay keys, or secrets. No operator
|
||||||
|
action beyond the standard `flotilla deploy ohm-rfc-app`.
|
||||||
|
|
||||||
|
## 0.22.0 — 2026-05-28
|
||||||
|
|
||||||
|
Roadmap item #26: an optional **"What will you be using this for?"**
|
||||||
|
field on both propose surfaces. Shipped from driver session 0022.0.
|
||||||
|
Additive and backward-compatible — no behavior changes for anyone who
|
||||||
|
leaves the field blank.
|
||||||
|
|
||||||
|
1. **Propose-RFC modal.** Below the required "Why is this RFC needed?"
|
||||||
|
field (`pitch`) sits a new optional **"What will you be using this
|
||||||
|
RFC for?"** textarea. "Needed" is the abstract justification; "using
|
||||||
|
it for" is the concrete ground-truth use case — captured without
|
||||||
|
being forced.
|
||||||
|
2. **Propose-PR modal.** Below the required "Why is this change needed?"
|
||||||
|
field (`description`) sits a new optional **"What will you be using
|
||||||
|
this change for?"** textarea.
|
||||||
|
3. **Display.** The RFC view (`RFCView` / `ProposalView`) and PR review
|
||||||
|
view (`PRView`) render the captured use case alongside the existing
|
||||||
|
"why" text, with a muted "left blank" treatment when absent.
|
||||||
|
4. **Persistence (deployment note).** In this deployment the framework's
|
||||||
|
`rfcs` / PR surfaces are the Gitea-backed cache tables `cached_rfcs`
|
||||||
|
/ `cached_prs`, rebuilt by the reconciler. Because the propose write
|
||||||
|
path is endpoint → Gitea → reconcile (and the reconciler doesn't
|
||||||
|
carry the new field), the durable home is a canonical, reconcile-proof
|
||||||
|
side table `proposed_use_cases` (keyed by `(scope, pr_number)`) that
|
||||||
|
the propose/open endpoints write directly and the view endpoints read
|
||||||
|
back. The literal nullable `proposed_use_case` columns named by the
|
||||||
|
roadmap are also added to `cached_rfcs` / `cached_prs` for parity and
|
||||||
|
any future reconciler that learns to carry the field. NULL/blank use
|
||||||
|
cases simply never write a side-table row — absence is "left blank".
|
||||||
|
|
||||||
|
Migration `021_proposed_use_case.sql` adds the two cache columns
|
||||||
|
(`ALTER TABLE … ADD COLUMN proposed_use_case TEXT`), the
|
||||||
|
`proposed_use_cases` canonical table, and its lookup indexes. The
|
||||||
|
reconciler's upsert (`ON CONFLICT DO UPDATE`) sets only known columns,
|
||||||
|
so the added cache columns survive reconciles. Backend validators accept
|
||||||
|
the field as NULL/omitted (no required-validation) with an 8000-char cap
|
||||||
|
matching the existing PR `description` bound; blank/whitespace is treated
|
||||||
|
as absent.
|
||||||
|
|
||||||
|
Upgrade steps:
|
||||||
|
|
||||||
|
1. Deployments **MUST** apply database migrations; `021_proposed_use_case.sql`
|
||||||
|
runs automatically on next boot (the migration runner globs
|
||||||
|
`backend/migrations/*.sql` and applies any not yet recorded in
|
||||||
|
`schema_migrations`). The migration is additive — nullable cache
|
||||||
|
columns plus a new table — and requires no data backfill.
|
||||||
|
2. No new environment variables, overlay keys, or secrets. No operator
|
||||||
|
action beyond the standard `flotilla deploy ohm-rfc-app`.
|
||||||
|
|
||||||
|
## 0.21.0 — 2026-05-28
|
||||||
|
|
||||||
|
UX-polish wave. Roadmap items #31 (comprehensive UX polish — foundation
|
||||||
|
slice), #24 (header "About" → "Philosophy"), #25 (inbox icon + light UX),
|
||||||
|
and #32 (session/transcript page polish). Pure frontend; no schema, no
|
||||||
|
backend changes, no new secret. Shipped from one driver session (0019.0)
|
||||||
|
via three parallel subagents working on disjoint surfaces.
|
||||||
|
|
||||||
|
1. **Design-token foundation (#31).** New `frontend/src/styles/tokens.css`
|
||||||
|
establishes the app's first coherent design system — semantic color
|
||||||
|
palette, type scale, spacing scale, radius scale, elevation, and a
|
||||||
|
motion vocabulary (with `prefers-reduced-motion` honored) — as CSS
|
||||||
|
custom properties, imported first in `main.jsx`. Before this the app
|
||||||
|
carried ~98 distinct hardcoded hex colors, font sizes across 16
|
||||||
|
unscaled values, and radii across 13. `App.css` and `index.css` were
|
||||||
|
swept to the tokens (~630 color / 280 font-size / 128 radius
|
||||||
|
references), consolidating near-duplicate grays to the nearest ramp
|
||||||
|
step and rounding off-scale type to the nearest step. No CSS class was
|
||||||
|
renamed or removed; an additive `:focus-visible` ring and a subtle
|
||||||
|
hover/transition layer were added. 35 special-purpose hexes (true
|
||||||
|
blues/violets, status dots, deep diff-contrast shades) were
|
||||||
|
deliberately left as literals. This is the polish *foundation*; a
|
||||||
|
follow-up (#31b) covers the bespoke per-surface re-spacing that wants
|
||||||
|
operator review against screenshots.
|
||||||
|
|
||||||
|
2. **Header: "About" → "Philosophy" (#24).** The persistent header link
|
||||||
|
now reads "Philosophy" (the route `/philosophy` and its page already
|
||||||
|
existed; only the label changed).
|
||||||
|
|
||||||
|
3. **Inbox icon + light UX (#25).** The header inbox trigger's `📮`
|
||||||
|
emoji is replaced with a dependency-free inline-SVG envelope icon
|
||||||
|
(`aria-label="Inbox"`); no icon library was added. The inbox panel
|
||||||
|
got a light pass — clearer unread/read distinction, mark-all-read and
|
||||||
|
per-row affordances surfaced, better empty state, tokenized spacing in
|
||||||
|
a new component-scoped `Inbox.css`. Behavior, filters, deep-links, and
|
||||||
|
§15 notification data flow are unchanged. A full inbox redesign is
|
||||||
|
deferred to a #25 follow-up (the operator's reference screenshot did
|
||||||
|
not transmit).
|
||||||
|
|
||||||
|
4. **Session/transcript page polish (#32).** `/docs/sessions/<NNNN>` no
|
||||||
|
longer dead-ends on a "select a transcript" placeholder: a
|
||||||
|
single-transcript session renders that transcript inline at the
|
||||||
|
session root; a multi-transcript session renders its `.0` driver
|
||||||
|
transcript inline and lists the siblings. Each rendered transcript now
|
||||||
|
carries a metadata header — session title, Started/Ended (parsed from
|
||||||
|
the filename's ISO segments), derived Duration, an optional one-line
|
||||||
|
TL;DR, and a "View source on git.wiggleverse.org" external link to the
|
||||||
|
canonical raw transcript. The TL;DR reads an optional `tldr` string on
|
||||||
|
the per-session `sessions.json` manifest entry and degrades gracefully
|
||||||
|
when absent.
|
||||||
|
|
||||||
|
Upgrade steps:
|
||||||
|
|
||||||
|
MAY: add a `tldr` string to any per-session entry in
|
||||||
|
`wiggleverse/ohm-session-history`'s `sessions.json`
|
||||||
|
(e.g. `"0019": { "title": "…", "tldr": "one-line summary" }`) to surface
|
||||||
|
a summary in each transcript's metadata header. Absent `tldr` renders
|
||||||
|
nothing — no deployment action is required. This is a data edit in the
|
||||||
|
session-history repo, not a `flotilla` gesture.
|
||||||
|
|
||||||
|
## 0.20.0 — 2026-05-28
|
||||||
|
|
||||||
|
Wave 9 follow-up to roadmap item #30. Three changes bundled into one minor:
|
||||||
|
|
||||||
|
1. **Specs on `/docs/specs/<name>`** — a new public surface alongside the user guide that renders the framework's spec corpus at runtime. Configured via the `OHM_DOCS_SPECS` env var; the framework default carries OHM's two specs (`rfc-app/SPEC.md` and `ohm-rfc-app-flotilla/SPEC.md`) fetched from gitea raw URLs with a 5-minute TTL cache. Each spec page renders the current version only — git is the history surface; a "View source" link beside the title points at the upstream raw URL. Bare `/docs/specs` client-side redirects to the first configured spec (or renders a "no specs configured" empty state if the deployment cleared the list).
|
||||||
|
|
||||||
|
2. **Nested flyout nav hierarchy** — `/docs/*` nav now renders sessions as a tree: each session row has its transcripts nested under it as nav children, labeled by their `.N` ordinal (`0014.0`, `0014.1`, …). Each session's transcript index is fetched alongside the manifest on layout mount (Promise.all over the manifest's keys); the backend's 5-minute content TTL makes the repeat cost negligible. Always-expanded — at the current scale (≤20 sessions) lazy expansion isn't worth the click. A new "Specs" section sits between User Guide and Sessions, populated by the new manifest endpoint.
|
||||||
|
|
||||||
|
3. **`/docs/sessions/<NNNN>` body-list removed** — operator preference: navigation lives in the left nav, not in body content. The per-session page is now a session-overview card (title + transcript count + "select a transcript from the navigation" hint). Empty-state, not-found, and error paths preserved; only the inline transcript-link list is gone.
|
||||||
|
|
||||||
|
Upgrade steps:
|
||||||
|
|
||||||
|
MAY: `flotilla overlay set ohm-rfc-app OHM_DOCS_SPECS='<JSON array>'` to override the configured spec set. Each entry is `{"name": "<slug>", "title": "<human label>", "url": "<gitea raw URL>"}`. Malformed JSON, a non-array root, or an entry that fails validation (missing fields, non-slug `name`) logs a warning and falls back to the framework default; deployment startup is never crashed by a bad value.
|
||||||
|
|
||||||
|
MAY: `flotilla overlay set ohm-rfc-app OHM_DOCS_SPECS_CONTENT_TTL_SEC=300` to tune the per-spec content cache TTL.
|
||||||
|
|
||||||
|
Note on the `frontend/package-lock.json` version drift fix: the lockfile's top-level and `packages.""` version fields drifted to `0.15.0` somewhere in the v0.16.0–v0.19.0 window and weren't caught. This release syncs them to `0.20.0` alongside `frontend/package.json` and `VERSION`. No dependency changes; only the version-string fields move.
|
||||||
|
|
||||||
|
## 0.19.0 — 2026-05-28
|
||||||
|
|
||||||
|
Roadmap item #30: docs nav with on-site sessions browser. Adds a left-side flyout nav on `/docs/*` and three new public surfaces — `/docs/sessions/about` (renders the session-history README), `/docs/sessions/<NNNN>` (per-session index), `/docs/sessions/<NNNN>/<filename>` (per-transcript view). Backend mediates the fetch from `wiggleverse/ohm-session-history` over gitea raw URLs with a small in-process TTL cache (60 s manifest, 5 min content; both env-tunable). Existing `/docs` content moves to `/docs/user-guide`; bare `/docs` redirects.
|
||||||
|
|
||||||
|
Upgrade steps:
|
||||||
|
|
||||||
|
MAY: `flotilla overlay set ohm-rfc-app OHM_SESSION_HISTORY_RAW_BASE=<url>` if the deployment points at a non-OHM transcript repo. Default in code matches OHM's `wiggleverse/ohm-session-history`.
|
||||||
|
|
||||||
|
MAY: `flotilla overlay set ohm-rfc-app OHM_DOCS_SESSIONS_MANIFEST_TTL_SEC=60` and `OHM_DOCS_SESSIONS_CONTENT_TTL_SEC=300` to tune cache TTLs.
|
||||||
|
|
||||||
|
Note: this release depends on the parallel restructure of `wiggleverse/ohm-session-history` into per-session `NNNN/` folders + `README.md` + `sessions.json` (driver session 0017.0, subsession 0017.2). If the repo is still flat at deploy time, `/docs/sessions/about` and the per-session pages return 404 and the route tree degrades to "About not yet published" — no JS crashes; the User Guide remains fully functional.
|
||||||
|
|
||||||
## 0.18.0 — 2026-05-28
|
## 0.18.0 — 2026-05-28
|
||||||
|
|
||||||
**Minor — schema migration required; one env var now mandatory; no
|
**Minor — schema migration required; one env var now mandatory; no
|
||||||
|
|||||||
+407
@@ -0,0 +1,407 @@
|
|||||||
|
# Contributing to rfc-app
|
||||||
|
|
||||||
|
`rfc-app` is the framework that hosts RFC-shaped collections of
|
||||||
|
documents — one repo per RFC, a meta repo per collection, a web app
|
||||||
|
that turns the Git substrate into a writeable surface. The Open
|
||||||
|
Human Model (OHM) deployment at `ohm.wiggleverse.org` is one
|
||||||
|
instance. The framework is intended to host more.
|
||||||
|
|
||||||
|
This document explains how to propose a change to the framework
|
||||||
|
itself — a new endpoint, a schema migration, a UI affordance, a
|
||||||
|
spec clarification. For changes to *content* hosted by a specific
|
||||||
|
deployment (the OHM RFCs, the OHM roadmap), see that deployment's
|
||||||
|
own contribution guide (e.g. [`ohm-rfc/CONTRIBUTING.md`](https://git.wiggleverse.org/wiggleverse/ohm-rfc/src/branch/main/CONTRIBUTING.md)).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How the project actually evolves
|
||||||
|
|
||||||
|
rfc-app is built in the open in the literal sense: **every build
|
||||||
|
session produces a full transcript** at
|
||||||
|
[`wiggleverse/ohm-session-history`](https://git.wiggleverse.org/wiggleverse/ohm-session-history)
|
||||||
|
on `git.wiggleverse.org`. The transcripts are the authoritative
|
||||||
|
record of how the framework got from one release to the next — the
|
||||||
|
decisions, the friction, the dead ends, the reasoning. They are not
|
||||||
|
curated retrospectives; wrong turns stay in.
|
||||||
|
|
||||||
|
If you are proposing a change to rfc-app, **read at least the most
|
||||||
|
recent session transcript before opening a PR.** The transcripts
|
||||||
|
show what shape a feature lands in, where the spec gets touched,
|
||||||
|
what the operator pushes back on, and how the release rides into
|
||||||
|
deployment. A PR that matches that texture is much more likely to
|
||||||
|
land cleanly than one shaped by the README alone.
|
||||||
|
|
||||||
|
Worked examples to start with:
|
||||||
|
|
||||||
|
- **Session E** ([transcript](https://git.wiggleverse.org/wiggleverse/ohm-session-history)) —
|
||||||
|
a clean small release. Read this for the simplest possible release
|
||||||
|
shape: one feature, one version bump, one upgrade-steps block, no
|
||||||
|
surprises.
|
||||||
|
- **Session I** — recovery from a deploy fault. Read this for how
|
||||||
|
the project handles things going wrong mid-deploy, and for the
|
||||||
|
honest no-curation discipline.
|
||||||
|
- **Session K** — a multi-feature wave with one item paused on an
|
||||||
|
operator-provided secret. Read this for the subagent dispatch
|
||||||
|
pattern (the model the project uses to ship multiple features in
|
||||||
|
parallel), and for the binding rule that the assistant **never**
|
||||||
|
asks the operator to paste secret bytes into the conversation.
|
||||||
|
- **Session L** — squash-merge integration across three parallel
|
||||||
|
features (v0.15.0 / v0.16.0 / v0.17.0), with `#21 Part C`
|
||||||
|
identity-lifecycle Amplitude wiring folded inline across all
|
||||||
|
three releases. Read this for how cross-cutting concerns (analytics,
|
||||||
|
observability) get layered into already-in-flight features
|
||||||
|
without scope-creeping any single release.
|
||||||
|
|
||||||
|
The repository where transcripts live —
|
||||||
|
[`wiggleverse/ohm-session-history`](https://git.wiggleverse.org/wiggleverse/ohm-session-history) —
|
||||||
|
is the canonical history. The `git log` of `rfc-app` is the artifact;
|
||||||
|
the transcripts are the story behind it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How a contribution flows
|
||||||
|
|
||||||
|
The framework runs on a **subagents push feature branches; operator
|
||||||
|
tags and deploys** model. Contributors — whether human or AI agents
|
||||||
|
running in a Claude Code subsession — open feature branches and
|
||||||
|
submit PRs. The operator (the person running the deployment) is the
|
||||||
|
one who merges, tags, bumps `VERSION`, runs `flotilla deploy` (or
|
||||||
|
the equivalent for non-OHM deployments), and moves the deployment's
|
||||||
|
`.rfc-app-version` pin. The driver session transcripts inherit
|
||||||
|
this shape; contributors inherit it from them.
|
||||||
|
|
||||||
|
Concretely:
|
||||||
|
|
||||||
|
1. Read the most recent session transcript. Understand what just
|
||||||
|
shipped and what is in flight.
|
||||||
|
2. Open an Issue first if your change is exploratory, structural,
|
||||||
|
or might overlap with in-flight work. The operator will name
|
||||||
|
any collision.
|
||||||
|
3. Branch from `main`. Name the branch
|
||||||
|
`feature/<short-description>` for additive work, `fix/<short-
|
||||||
|
description>` for bug fixes, `docs/<short-description>` for
|
||||||
|
documentation-only work. The driver sessions use
|
||||||
|
`feature/v<target-version>-<slug>` (e.g.
|
||||||
|
`feature/v0.16.0-owner-invite`) — that shape is welcome but not
|
||||||
|
required for outside contributors, since contributors do not
|
||||||
|
pick the target version.
|
||||||
|
4. **Do not bump `VERSION` or `frontend/package.json#version` in
|
||||||
|
your PR.** The operator picks the target version at integration
|
||||||
|
time; bumping ahead causes cherry-pick conflicts. The same
|
||||||
|
applies to the `CHANGELOG.md` entry header — see below.
|
||||||
|
5. **Do not tag releases, do not run any deploy gesture, do not
|
||||||
|
touch any deployment's `.rfc-app-version` pin.** The operator
|
||||||
|
alone owns those gestures. (For OHM specifically: "I'm the only
|
||||||
|
one that gets to yolo." See the boundary section in
|
||||||
|
`ohm-rfc/CONTRIBUTING.md`.)
|
||||||
|
6. Push your branch and open a PR. Describe what you're proposing
|
||||||
|
and why, in language the operator can paste into the eventual
|
||||||
|
release commit. If the change touches `SPEC.md`, name which
|
||||||
|
section(s) and the contract change.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## CHANGELOG convention: strict descending
|
||||||
|
|
||||||
|
`CHANGELOG.md` is ordered **newest-on-top**. The header line for
|
||||||
|
the in-progress version goes at the top of the file; older
|
||||||
|
releases descend below it. This is the binding convention; the
|
||||||
|
operator hand-resolves the conflict when two parallel feature
|
||||||
|
branches both insert at the top of the file (the squash-merge
|
||||||
|
integration that ships parallel-feature waves keeps the strict-
|
||||||
|
descending shape — see Session K for the cherry-pick mechanics and
|
||||||
|
Session L for the hand-resolved-with-a-small-script variant).
|
||||||
|
|
||||||
|
A new entry has this shape (read the existing 0.15.0 / 0.16.0 /
|
||||||
|
0.17.0 entries for worked examples):
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## 0.X.Y — YYYY-MM-DD
|
||||||
|
|
||||||
|
**Minor — schema migration auto-applied; no operator action.** This
|
||||||
|
release ships <one or two sentences naming the feature and why>.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **<New module/endpoint/component>** — what it does, where it lives,
|
||||||
|
why it exists. Include file paths inline so a reader can click through.
|
||||||
|
### Changed
|
||||||
|
- **<Existing surface>** — what changed and how a deployment notices.
|
||||||
|
### Migration
|
||||||
|
- **`<NNN_name>.sql`** — auto-applied by `db.run_migrations()` on
|
||||||
|
backend start. <Describe the schema delta in one sentence.>
|
||||||
|
### Upgrade steps (from 0.(X-1).Y)
|
||||||
|
- You **MUST** … (per RFC 2119; see SPEC.md §20.4).
|
||||||
|
- You **MUST NOT** …
|
||||||
|
- You **SHOULD** …
|
||||||
|
- You **MAY** …
|
||||||
|
```
|
||||||
|
|
||||||
|
The header version number is filled in by the operator at merge
|
||||||
|
time. Your PR's CHANGELOG diff can leave the version as
|
||||||
|
`0.X.Y — YYYY-MM-DD` (literal placeholder), or use a guessed value
|
||||||
|
the operator overwrites; either is fine.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## `Upgrade steps:` blocks use RFC 2119 keywords
|
||||||
|
|
||||||
|
If your change requires deployments to do anything when they
|
||||||
|
upgrade — set an env var, apply a migration, restart a process,
|
||||||
|
flip an overlay value, accept a behavioral change — your CHANGELOG
|
||||||
|
entry **must** include an `### Upgrade steps` block, and that
|
||||||
|
block **must** use the [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119)
|
||||||
|
/ [RFC 8174](https://www.rfc-editor.org/rfc/rfc8174) keywords as
|
||||||
|
defined in `SPEC.md` §20.4:
|
||||||
|
|
||||||
|
- **MUST** / **SHALL** / **REQUIRED** — without this step the
|
||||||
|
deployment will not function correctly. Skipping is a regression
|
||||||
|
the framework does not handle.
|
||||||
|
- **MUST NOT** / **SHALL NOT** — previously valid, now no longer
|
||||||
|
supported.
|
||||||
|
- **SHOULD** / **RECOMMENDED** — the framework's tested path. A
|
||||||
|
deployment may deviate when it has a reason.
|
||||||
|
- **SHOULD NOT** / **NOT RECOMMENDED** — discouraged without being
|
||||||
|
forbidden.
|
||||||
|
- **MAY** / **OPTIONAL** — an affordance you can take or skip.
|
||||||
|
|
||||||
|
Cross-version upgrades (jumping more than one minor) are computed by
|
||||||
|
the operator composing each intervening release's steps in order.
|
||||||
|
Each adjacent step must therefore be locally unambiguous — this is
|
||||||
|
the whole reason the keyword discipline is binding. Avoid words
|
||||||
|
like "should probably" or "might want to" inside an upgrade step;
|
||||||
|
either the framework needs the action or it doesn't.
|
||||||
|
|
||||||
|
If your change touches the env contract, **also update**
|
||||||
|
`backend/.env.example` and/or `frontend/.env.example` in the same
|
||||||
|
PR so the contract and the documentation land together (§20.4).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## SPEC.md and §19.2 candidates
|
||||||
|
|
||||||
|
`SPEC.md` is the framework's binding spec. It is honest about open
|
||||||
|
questions — large sections of it carry "§19.2 candidates," which
|
||||||
|
are decisions the project has deliberately deferred rather than
|
||||||
|
guessed at.
|
||||||
|
|
||||||
|
The discipline: **architectural or process deferrals get noted as
|
||||||
|
§19.2 candidates rather than scope-creeping a release.** When you
|
||||||
|
notice that your change opens a question larger than the change
|
||||||
|
itself (a different DB shape, a new auth contract, a cross-cutting
|
||||||
|
UX rethink), the right move is usually to land the narrow change
|
||||||
|
and add a §19.2 candidate naming the larger question. The candidate
|
||||||
|
documents what was set aside and why, so a future session can pick
|
||||||
|
it up with context.
|
||||||
|
|
||||||
|
Worked examples from recent sessions:
|
||||||
|
|
||||||
|
- v0.11.0 (Session K) shipped device trust and surfaced three new
|
||||||
|
§19.2 candidates: cross-device session revocation, password-
|
||||||
|
equivalent change invalidating trust, device-trust window
|
||||||
|
tunables via env. None of those were in the v0.11.0 scope; they
|
||||||
|
were noted in SPEC.md §19.2 so a future session can address them
|
||||||
|
on their own terms.
|
||||||
|
- v0.15.0 (Session L) shipped the Amplitude wrapper and added
|
||||||
|
candidates around session-replay-specific consent category +
|
||||||
|
bundle-size measurement, both deferred to the future Part-A audit.
|
||||||
|
|
||||||
|
When you spot a deferred decision in your PR's territory, name it
|
||||||
|
in your PR description and add it to `SPEC.md` §19.2 in the same
|
||||||
|
diff. Do not silently expand scope to settle it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test-coverage expectations
|
||||||
|
|
||||||
|
The backend has the load-bearing test suite at
|
||||||
|
`backend/tests/`. Tests are organized as `*_vertical.py` files,
|
||||||
|
each covering one feature end-to-end through the FastAPI app
|
||||||
|
(provisioning fixtures, hitting the HTTP surface, asserting on the
|
||||||
|
database state). At time of writing, the suite is ~250 tests across
|
||||||
|
~25 files. Examples:
|
||||||
|
|
||||||
|
- `test_admin_create_user_invite_vertical.py` — v0.17.0's
|
||||||
|
admin-create user + invite + claim flow, 15 tests covering happy
|
||||||
|
path + every refusal shape + the audit-trail row.
|
||||||
|
- `test_rfc_invitations_vertical.py` — v0.16.0's per-RFC invite +
|
||||||
|
accept flow, 18 tests.
|
||||||
|
- `test_device_trust_vertical.py` — v0.11.0's 30-day device trust,
|
||||||
|
14 tests including cookie shape, hash-vs-raw-token discipline,
|
||||||
|
expired / revoked / forged / cross-user invariants.
|
||||||
|
|
||||||
|
Expected coverage for a new feature:
|
||||||
|
|
||||||
|
- **Backend feature** — one new `test_<feature>_vertical.py` file
|
||||||
|
that covers the happy path, every documented refusal/error code,
|
||||||
|
and any cross-surface effect (rows the feature writes to existing
|
||||||
|
tables, fields it adds to existing endpoints). Reuse fixtures
|
||||||
|
from neighboring test files (e.g. `test_propose_vertical.py`'s
|
||||||
|
`FakeGitea` is widely reused).
|
||||||
|
- **Migration** — verify migrations are reachable from `backend/.venv`
|
||||||
|
before pushing: `cd backend && PYTHONPATH=. .venv/bin/pytest -q`
|
||||||
|
exercises `db.run_migrations()` through the fixture setup.
|
||||||
|
- **Frontend feature** — there is currently no frontend test
|
||||||
|
runner. The discipline is: keep the change ships-clean
|
||||||
|
(`cd frontend && npm run build` succeeds), and the backend
|
||||||
|
vertical test exercises the HTTP contract the frontend
|
||||||
|
consumes, which is the meaningful behavioral guarantee.
|
||||||
|
Frontend changes that ride along with a backend feature land
|
||||||
|
with the backend test as the regression boundary.
|
||||||
|
- **Bug fix** — add a regression test in the same vertical file
|
||||||
|
that proves the original failure mode and verifies the fix.
|
||||||
|
|
||||||
|
Run the backend suite before pushing. From `backend/`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
PYTHONPATH=. .venv/bin/pytest -q
|
||||||
|
```
|
||||||
|
|
||||||
|
(The `PYTHONPATH=.` is a known ergonomic gap — see SPEC.md §19.2
|
||||||
|
candidate; the suite does not pick up `app/` without it.)
|
||||||
|
|
||||||
|
If your PR doesn't include tests, the operator will ask for them
|
||||||
|
before merge unless the change is genuinely test-irrelevant
|
||||||
|
(documentation, comments, dev-only tooling).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Analytics instrumentation checklist
|
||||||
|
|
||||||
|
> *(This section codifies `ohm-rfc/ROADMAP.md` #21 Part B's
|
||||||
|
> CONTRIBUTING checklist. It is discipline, not a gate — but the
|
||||||
|
> operator will push back on PRs that skip it.)*
|
||||||
|
|
||||||
|
If your PR adds or changes a user-facing feature, walk this
|
||||||
|
checklist before opening the PR. The instrumentation conventions
|
||||||
|
themselves are specified in `SPEC.md` §21 (Analytics instrumentation
|
||||||
|
and identity); this section is the procedural reminder.
|
||||||
|
|
||||||
|
1. **What named event(s) does this feature need?**
|
||||||
|
Open `frontend/src/lib/analytics.js` and look at the `EVENTS`
|
||||||
|
constant. Does an existing event cover your feature? If not, is
|
||||||
|
the new event in the spec's "Subject Verb" Title Case form
|
||||||
|
(`Comment Posted`, `Invitation Sent`)? Are the prop families
|
||||||
|
consistent with SPEC.md §21's required-prop catalog (opaque
|
||||||
|
ids only, no PII, enums lowercased like `'otc'` not `'OTC'`)?
|
||||||
|
|
||||||
|
2. **Do interactive elements have stable text / ARIA labels /
|
||||||
|
`data-amp-track-*` so autocapture is meaningful?**
|
||||||
|
The frontend ships `autocapture: true`, which instruments
|
||||||
|
every click and form interaction. The *value* of those events
|
||||||
|
depends on the DOM the SDK sees: a `<button>` with stable
|
||||||
|
visible text or an `aria-label` shows up as a meaningful
|
||||||
|
dashboard row; an icon-only `<button>` with no label shows up
|
||||||
|
as garbage. New components that introduce interactive elements
|
||||||
|
should either carry meaningful labels (visible text or ARIA) or
|
||||||
|
carry a `data-amp-track-name="<Stable Name>"` attribute. For
|
||||||
|
repeated rows (per-RFC lists, comment lists), use a stable
|
||||||
|
`data-amp-track-*` identifier so per-row click counts aggregate
|
||||||
|
to the row's identity rather than to a generic label.
|
||||||
|
|
||||||
|
3. **Does any new form field need replay masking?**
|
||||||
|
Session replay records at `sampleRate: 1` (100% of consented
|
||||||
|
sessions). New form inputs that capture passwords, OTC codes,
|
||||||
|
tokens, magic-link URLs, or other secret/credential-equivalent
|
||||||
|
material **MUST** be masked with Amplitude's masking conventions
|
||||||
|
(the `.amp-mask` class or the `data-amp-mask` attribute,
|
||||||
|
whichever the wrapper integration expects in this version).
|
||||||
|
New inputs that capture arguably-PII (email, real name, free-
|
||||||
|
text drafts) **SHOULD** also be masked; if a deliberate
|
||||||
|
un-masking decision is taken, document it in the PR description
|
||||||
|
and in `SPEC.md` §21.
|
||||||
|
|
||||||
|
4. **Does the PR description name the instrumentation decisions?**
|
||||||
|
A one-sentence summary in the PR description — "fires
|
||||||
|
`Comment Posted` with `{rfc_slug, comment_id}`; no new form
|
||||||
|
fields, no new replay-masking concerns" — is enough. If the
|
||||||
|
decision is "we chose not to instrument this," say that too;
|
||||||
|
the absence of an event is itself a decision the operator
|
||||||
|
wants visible. The relevant SPEC chapter (§21) is the binding
|
||||||
|
reference for what shapes are correct.
|
||||||
|
|
||||||
|
If your feature touches an identity-meaningful surface (sign-in,
|
||||||
|
sign-out, invite-claim, role change, account state change), also
|
||||||
|
walk the **identity lifecycle** contract in SPEC.md §21.6: every
|
||||||
|
new claim/sign-in path **MUST** call `identify({ user_id, properties })`
|
||||||
|
BEFORE the first `track()` event on that surface, so the Amplitude
|
||||||
|
user record is created with the OHM user_id from the very first
|
||||||
|
event rather than as an anonymous device that retroactively links.
|
||||||
|
v0.16.0's `AcceptInvitation.jsx` and v0.17.0's `InviteClaim.jsx`
|
||||||
|
are the worked examples; mirror their shape.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The operator-only gestures
|
||||||
|
|
||||||
|
Some gestures are operator-only. Contributors do not perform them;
|
||||||
|
PRs that perform them get rejected on principle, not on merit:
|
||||||
|
|
||||||
|
- **Tagging a release** (`git tag v0.X.Y` + `git push --tags`).
|
||||||
|
- **Pushing to `main`** after merge (the operator merges; the
|
||||||
|
framework's `main` branch tracks releases the operator has
|
||||||
|
shipped).
|
||||||
|
- **Bumping `VERSION` and `frontend/package.json#version` to the
|
||||||
|
shipped value.** The operator does this at integration time so
|
||||||
|
the version line is consistent across the release commit.
|
||||||
|
- **Running `flotilla deploy` or any equivalent deployment gesture**
|
||||||
|
in any deployment of rfc-app. Contributors do not deploy.
|
||||||
|
- **Moving a deployment's `.rfc-app-version` pin.** That pin lives
|
||||||
|
in the deployment's content repo (e.g. `ohm-rfc/.rfc-app-version`)
|
||||||
|
and is moved by the deployment's operator. Contributors to that
|
||||||
|
deployment do not move it; contributors to the framework
|
||||||
|
certainly do not.
|
||||||
|
- **Setting secrets** (anywhere — Secret Manager, env files,
|
||||||
|
`flotilla secret set`, vendor dashboards, anything). The
|
||||||
|
binding rule baked in mid-Session-K is: **the assistant never
|
||||||
|
asks the operator to paste secret bytes into a conversation,
|
||||||
|
even as one offered option**. The corollary for contributors:
|
||||||
|
do not include secret values in PR descriptions, commit
|
||||||
|
messages, or issue comments. Reference secrets by their binding
|
||||||
|
name (`SMTP_PASSWORD`, `AMPLITUDE_API_KEY`) and let the
|
||||||
|
operator handle the bytes.
|
||||||
|
|
||||||
|
If your change requires a new secret or env var, document the
|
||||||
|
requirement in the CHANGELOG `### Upgrade steps` block in the
|
||||||
|
RFC 2119 form ("operators **MUST** set `<NEW_VAR>` ...") and
|
||||||
|
update the `*.env.example` file. The operator will run the
|
||||||
|
secret/overlay-set gesture themselves at deploy time.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## When in doubt
|
||||||
|
|
||||||
|
- **Open an Issue first.** Especially for any change that touches
|
||||||
|
SPEC.md, the auth/permissions model (§6), the storage shape (§4
|
||||||
|
/ §5), or the deploy contract (§20). The operator (or a future
|
||||||
|
driver session) will name what they want before you write code.
|
||||||
|
- **Read the most recent session transcript.** It will tell you
|
||||||
|
what shipped last and what's in flight.
|
||||||
|
- **Cite SPEC.md sections in your PR description.** "Touches §15.4
|
||||||
|
(per-category email toggles) and adds §19.2 candidate around
|
||||||
|
per-channel mute granularity" gives the operator a map of where
|
||||||
|
to read.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
The framework is released under the MIT License (see
|
||||||
|
[`LICENSE`](./LICENSE)). By contributing, you agree your work
|
||||||
|
ships under those terms.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [`SPEC.md`](./SPEC.md) — the framework's binding spec. §19.2
|
||||||
|
is the deferred-decisions queue; §20 is the versioning + deploy
|
||||||
|
contract; §21 is the analytics instrumentation contract.
|
||||||
|
- [`CHANGELOG.md`](./CHANGELOG.md) — release history in strict
|
||||||
|
descending order. Read recent entries for the shape your PR's
|
||||||
|
release-commit will take.
|
||||||
|
- [`PHILOSOPHY.md`](./PHILOSOPHY.md) — what the framework is for.
|
||||||
|
PRs whose shape conflicts with the philosophy get a longer
|
||||||
|
conversation than PRs that fit.
|
||||||
|
- [`wiggleverse/ohm-session-history`](https://git.wiggleverse.org/wiggleverse/ohm-session-history)
|
||||||
|
— the authoritative record of how the project has actually
|
||||||
|
evolved, session by session.
|
||||||
@@ -714,6 +714,47 @@ The lighter half ships the structural shape — frontmatter, consent,
|
|||||||
resolution, revocation. The heavier half ships the runtime
|
resolution, revocation. The heavier half ships the runtime
|
||||||
hardening.
|
hardening.
|
||||||
|
|
||||||
|
### 6.8 Sign-in state resume (roadmap item #29, v0.23.0)
|
||||||
|
|
||||||
|
Signing in lands the user back on their most recently-viewed app
|
||||||
|
state instead of always on the empty-state home view. The model is
|
||||||
|
**per-user**, not per-device — the safe default the roadmap calls
|
||||||
|
for: a sign-in on any device resumes the most-recently-recorded
|
||||||
|
route. A per-device split and a profile-settings toggle UI are
|
||||||
|
follow-ups; v0.23.0 ships the column-level opt-out flag
|
||||||
|
(`resume_enabled`, default on) and the default-on behavior.
|
||||||
|
|
||||||
|
**Storage.** A single row per user in `user_session_state`
|
||||||
|
(migration 022): `user_id` (PK, FK → `users.id`, cascade-delete),
|
||||||
|
`last_route` (TEXT, the frontend pathname), `last_route_state`
|
||||||
|
(TEXT, JSON-encoded — SQLite has no native JSONB, so JSON-as-TEXT
|
||||||
|
matches how the app stores every other JSON blob), `resume_enabled`
|
||||||
|
(INTEGER, default 1), and `last_updated_at`.
|
||||||
|
|
||||||
|
**Wiring.** A debounced (~1s) frontend route-change hook posts the
|
||||||
|
current route to `PUT /api/me/last-state` for authenticated users
|
||||||
|
(anonymous: no-op). The stored `last_route` is folded onto the
|
||||||
|
existing `/api/auth/me` payload (no extra round-trip); on sign-in,
|
||||||
|
after the §21-Part-C Amplitude `identify` fires, the frontend
|
||||||
|
`navigate()`s to it. The identify-then-redirect ordering is
|
||||||
|
preserved: the redirect is gated on identify having fired.
|
||||||
|
|
||||||
|
**Stale state.** If the stored route is an RFC since withdrawn or
|
||||||
|
one the user lost rights to read, the redirect is a graceful no-op:
|
||||||
|
`navigate(last_route)` lands on whatever that route renders today,
|
||||||
|
and the existing routing already falls through to the
|
||||||
|
catalog/empty-state for a missing/unreadable RFC. No special-casing
|
||||||
|
on the server.
|
||||||
|
|
||||||
|
**Privacy (binding).** The stored state is **route + light view
|
||||||
|
state ONLY** — scroll anchors, open-tab selection, filter chips, and
|
||||||
|
the like. It **MUST NOT** carry draft-buffer contents, PR/comment
|
||||||
|
draft text, or any user-typed content. The frontend never sends such
|
||||||
|
content; the `last_route_state` column comment in migration 022 and
|
||||||
|
this paragraph are the contract. Resume state is purposely cheap to
|
||||||
|
discard: a deliberate "clear" (or `resume_enabled = 0`) drops the
|
||||||
|
user back to today's empty-state behavior.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7. The left pane
|
## 7. The left pane
|
||||||
@@ -2284,6 +2325,13 @@ a given signal, the **storage shape** that makes triage tractable, and
|
|||||||
the **out-of-session channels** (email, digest) that let asynchrony
|
the **out-of-session channels** (email, digest) that let asynchrony
|
||||||
actually work.
|
actually work.
|
||||||
|
|
||||||
|
(The framework's separate **analytics + session-replay** surface —
|
||||||
|
Amplitude wiring, event taxonomy, identity lifecycle, consent
|
||||||
|
contract — is a peer cross-cutting concern specified in §21.
|
||||||
|
Notifications cover in-product signal-of-others-acting-on-your-work;
|
||||||
|
analytics covers observability of how the product is used. The two
|
||||||
|
surfaces do not overlap.)
|
||||||
|
|
||||||
### 15.1 The signal-surface stack
|
### 15.1 The signal-surface stack
|
||||||
|
|
||||||
Five surfaces, each with one narrow job:
|
Five surfaces, each with one narrow job:
|
||||||
@@ -4300,3 +4348,465 @@ Downstream deployments, in exchange for the contract above, commit to:
|
|||||||
order;
|
order;
|
||||||
- supply every required env var the framework documents at the
|
- supply every required env var the framework documents at the
|
||||||
version they are running.
|
version they are running.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 21. Analytics instrumentation and identity
|
||||||
|
|
||||||
|
The framework ships an Amplitude Analytics + Session Replay wrapper
|
||||||
|
in v0.15.0 (`frontend/src/lib/analytics.js`), gated by the v0.13.0
|
||||||
|
cookie/privacy consent surface (`frontend/src/lib/consent.js`,
|
||||||
|
§14.5). This section codifies the conventions that keep the
|
||||||
|
instrumentation **quality** healthy as features land — taxonomy
|
||||||
|
shape, autocapture hygiene, replay masking, the consent contract,
|
||||||
|
and the identity lifecycle. The conventions are framework-neutral:
|
||||||
|
every deployment of rfc-app that turns on the wrapper inherits
|
||||||
|
them.
|
||||||
|
|
||||||
|
This chapter is placed semantically after §15 (Notifications) and
|
||||||
|
§16 (deliberately deferred) as a peer cross-cutting framework
|
||||||
|
concern. It was added after §20 in the chapter sequence to avoid
|
||||||
|
renumbering the deferred-decisions surface §19.2, which is a
|
||||||
|
load-bearing project noun referenced across CLAUDE.md, transcripts,
|
||||||
|
and prior commits.
|
||||||
|
|
||||||
|
### 21.1 Event-taxonomy conventions
|
||||||
|
|
||||||
|
Events live in the public `EVENTS` constant in
|
||||||
|
`frontend/src/lib/analytics.js`. Callers **SHOULD** use one of the
|
||||||
|
named constants rather than firing arbitrary event strings — that
|
||||||
|
keeps the Amplitude dashboard coherent over time and makes the
|
||||||
|
taxonomy reviewable as a single source of truth.
|
||||||
|
|
||||||
|
- **Name form: Title Case, "Subject Verb".** E.g.
|
||||||
|
`Comment Posted`, `Invitation Sent`, `RFC Viewed`,
|
||||||
|
`User Signed In`, `Admin Permission Decision`. Spaces between
|
||||||
|
words, no punctuation, no leading verbs (use `RFC Proposed`,
|
||||||
|
not `Propose RFC`). The strings match the Amplitude dashboard
|
||||||
|
names exactly.
|
||||||
|
- **Stability.** New events **SHOULD** land via a release, not
|
||||||
|
ad-hoc — adding an entry to `EVENTS` is a CHANGELOG-worthy
|
||||||
|
change because it widens the framework's observable surface
|
||||||
|
(§20.3). Renaming an event after it has shipped breaks the
|
||||||
|
dashboard's historical continuity; renames **SHOULD** be
|
||||||
|
treated as a deprecation cycle (ship both, dashboard-migrate,
|
||||||
|
drop the old one).
|
||||||
|
- **Opaque ids only in prop values.** Properties **MUST NOT**
|
||||||
|
carry PII — no email, no display name, no IP, no free-text
|
||||||
|
field bodies (titles, comment text, RFC drafts). Properties
|
||||||
|
**SHOULD** be limited to:
|
||||||
|
- opaque ids: `rfc_slug`, `rfc_id`, `pr_number`,
|
||||||
|
`target_user_id`, `invited_by_admin_id`, `thread_id`,
|
||||||
|
`comment_id`;
|
||||||
|
- enums (lowercased): `method: 'otc' | 'passcode' |
|
||||||
|
'device-trust' | 'admin-invite' | 'rfc-invite'`;
|
||||||
|
- booleans: `trust_device`, `needs_passcode`, `passcode_set`;
|
||||||
|
- timestamps (ISO 8601);
|
||||||
|
- small bounded integers: `custom_message_chars` (coarse-grained
|
||||||
|
signal of admin effort, NOT the message text itself).
|
||||||
|
- **Casing consistency.** Prop keys use `snake_case` (matches the
|
||||||
|
backend's JSON shape). Enum values use lowercase with hyphens
|
||||||
|
(`'rfc-invite'`, not `'rfcInvite'` or `'RFC_INVITE'`). Drift
|
||||||
|
here ruins dashboard aggregation; the operator-side audit
|
||||||
|
(§21.7 / `ohm-rfc/ROADMAP.md` #21 Part A) checks for it.
|
||||||
|
|
||||||
|
The starting taxonomy as of v0.17.0:
|
||||||
|
|
||||||
|
```
|
||||||
|
PAGE_VIEWED: 'Page Viewed'
|
||||||
|
RFC_VIEWED: 'RFC Viewed'
|
||||||
|
USER_SIGNED_IN: 'User Signed In'
|
||||||
|
USER_SIGNED_OUT: 'User Signed Out'
|
||||||
|
RFC_PROPOSED: 'RFC Proposed'
|
||||||
|
PR_OPENED: 'PR Opened'
|
||||||
|
COMMENT_POSTED: 'Comment Posted'
|
||||||
|
BETA_ACCESS_REQUESTED: 'Beta Access Requested'
|
||||||
|
ADMIN_PERMISSION_DECISION: 'Admin Permission Decision'
|
||||||
|
INVITATION_SENT: 'Invitation Sent' # v0.16.0 / #12
|
||||||
|
INVITATION_ACCEPTED: 'Invitation Accepted' # v0.16.0 / #12
|
||||||
|
USER_INVITED: 'User Invited' # v0.17.0 / #16
|
||||||
|
INVITE_CLAIMED: 'Invite Claimed' # v0.17.0 / #16
|
||||||
|
```
|
||||||
|
|
||||||
|
### 21.2 Required prop families per event kind
|
||||||
|
|
||||||
|
Each event family carries a small required prop set. These are
|
||||||
|
load-bearing for the dashboard's cohort analysis; releases that
|
||||||
|
add a new event in an existing family **SHOULD** carry the
|
||||||
|
family's required props.
|
||||||
|
|
||||||
|
- **Navigation events** (`Page Viewed`, `RFC Viewed`): carry
|
||||||
|
`path` (string, pathname only — never the query string if it
|
||||||
|
could carry a token) for `Page Viewed`; carry `rfc_slug` for
|
||||||
|
`RFC Viewed`. `rfc_id` **MAY** be added when the cached row is
|
||||||
|
in hand.
|
||||||
|
- **Auth-state events** (`User Signed In`, `User Signed Out`):
|
||||||
|
`User Signed In` carries `method` (one of `'otc'`,
|
||||||
|
`'passcode'`, `'device-trust'`, `'admin-invite'`). `User
|
||||||
|
Signed Out` carries no props (the identity binding is cleared
|
||||||
|
separately via `anonymize()`).
|
||||||
|
- **Authored-action events** (`RFC Proposed`, `PR Opened`,
|
||||||
|
`Comment Posted`): carry `rfc_slug`. PRs additionally carry
|
||||||
|
`pr_number` once the row exists. Comments additionally carry
|
||||||
|
`thread_id`. None carry the body text.
|
||||||
|
- **Admin-action events** (`Beta Access Requested`,
|
||||||
|
`Admin Permission Decision`): the latter carries `action`
|
||||||
|
(lowercase: `'grant'` / `'revoke'`) and `target_user_id`.
|
||||||
|
- **Invite-side events** (`Invitation Sent`, `User Invited`): fire
|
||||||
|
from the inviter's signed-in session. `Invitation Sent` (per-RFC,
|
||||||
|
#12) carries `rfc_slug` + `role_in_rfc`. `User Invited`
|
||||||
|
(admin-create, #16) carries `target_user_id` (the OHM user_id of
|
||||||
|
the just-provisioned user) + `initial_role` +
|
||||||
|
`custom_message_chars` (a bounded integer signal of admin
|
||||||
|
effort, never the message text). Per #21 Part C: when the
|
||||||
|
invitee is not yet a user (#12 per-RFC invitations to an email
|
||||||
|
address that has never signed in), the invite-side event **MAY**
|
||||||
|
carry a hashed `target_email` fingerprint (SHA-256 of the
|
||||||
|
normalized lower-cased email) so the invite + claim pair can be
|
||||||
|
correlated later. Plain-text `target_email` **MUST NOT** be
|
||||||
|
carried.
|
||||||
|
- **Claim-side events** (`Invitation Accepted`, `Invite Claimed`):
|
||||||
|
fire from the invitee's session, immediately after an
|
||||||
|
`identify({ user_id, properties })` call binds the OHM user_id
|
||||||
|
to the Amplitude record (see §21.6). The events carry the
|
||||||
|
invite context (`rfc_slug` + `role_in_rfc` for the per-RFC
|
||||||
|
shape; `invited_by_admin_id` + `initial_role` + `needs_passcode`
|
||||||
|
+ `trust_device` for the admin-create shape).
|
||||||
|
|
||||||
|
When in doubt, the principle: a property is correctly shaped iff
|
||||||
|
the operator could publish it in a session transcript without
|
||||||
|
hesitation.
|
||||||
|
|
||||||
|
### 21.3 Autocapture-friendly DOM patterns
|
||||||
|
|
||||||
|
The wrapper initializes Amplitude with `analytics.autocapture: true`,
|
||||||
|
which auto-instruments page views, clicks, and form interactions.
|
||||||
|
The *value* of those auto-captured events depends entirely on the
|
||||||
|
DOM the SDK observes. Releases that add interactive UI **SHOULD**
|
||||||
|
follow these patterns so the dashboard rows are readable rather
|
||||||
|
than rows like "Click on `<button>` at `:nth-child(7)`".
|
||||||
|
|
||||||
|
- **Stable visible text on interactive elements.** Buttons and
|
||||||
|
links **SHOULD** have stable, human-readable text content (the
|
||||||
|
same string Amplitude uses to label the row). Avoid generic
|
||||||
|
labels like "Read more" / "Click here" that lose context.
|
||||||
|
- **`aria-label` on icon-only buttons.** Icon-only buttons (the
|
||||||
|
chevron expanders, kebab menus, close `X`s) **MUST** carry a
|
||||||
|
meaningful `aria-label`. Default autocapture for an unlabeled
|
||||||
|
icon button reads as garbage. The `aria-label` is also an
|
||||||
|
accessibility requirement — the two goals align.
|
||||||
|
- **`data-amp-track-*` for repeating-list per-row identifiers.**
|
||||||
|
When a list renders many rows of the same shape (RFC rows,
|
||||||
|
comment rows, PR rows in a listing), per-row interactive elements
|
||||||
|
**SHOULD** carry a `data-amp-track-name` attribute that
|
||||||
|
identifies the row's *kind* and a `data-amp-track-*` attribute
|
||||||
|
carrying the row's stable id. The convention:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button
|
||||||
|
data-amp-track-name="RFC Row Expand"
|
||||||
|
data-amp-track-rfc-slug={slug}
|
||||||
|
>…</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
This makes per-RFC click counts aggregate to the RFC rather
|
||||||
|
than to a generic label, and lets the dashboard answer "which
|
||||||
|
RFCs got the most engagement" rather than "how many buttons
|
||||||
|
were clicked."
|
||||||
|
- **`data-amp-track-suppress` for noise surfaces.** Crowded surfaces
|
||||||
|
(the admin user-listing post-v0.9.0, the RFC discussion panel
|
||||||
|
during heavy review) **MAY** apply
|
||||||
|
`data-amp-track-suppress` (or its current equivalent in the
|
||||||
|
SDK version in use) to elements whose clicks would flood the
|
||||||
|
dashboard without informing anything. Suppression is a
|
||||||
|
deliberate decision; document it inline.
|
||||||
|
|
||||||
|
### 21.4 Session-replay masking conventions
|
||||||
|
|
||||||
|
The wrapper initializes Amplitude with `sessionReplay.sampleRate: 1`
|
||||||
|
(100% of consented sessions are recorded for full-DOM playback —
|
||||||
|
vendor-recommended default for new Amplitude deployments). Replay
|
||||||
|
has a meaningfully larger privacy footprint than event counters,
|
||||||
|
and the masking discipline is binding.
|
||||||
|
|
||||||
|
- **Credentials MUST be masked.** The OTC code input, passcode
|
||||||
|
input, any password-type field, the Turnstile widget internals,
|
||||||
|
the magic-link-claim token if it survives in the URL bar
|
||||||
|
(browser history, screenshot windows) — these **MUST** be masked
|
||||||
|
with Amplitude's masking convention (the `.amp-mask` class or the
|
||||||
|
`data-amp-mask` attribute, whichever the wrapper's SDK version
|
||||||
|
uses; the wrapper's bootstrap comment names the current
|
||||||
|
convention). Confirm each masking attribute survives the
|
||||||
|
wrapper init by inspecting a recorded session before each
|
||||||
|
release that touches an auth input.
|
||||||
|
- **PII SHOULD be masked or carefully un-masked.** Email-entry
|
||||||
|
fields, real-name capture fields (the v0.8.0 first/last/why
|
||||||
|
panel), free-text RFC body drafts, comment-compose text —
|
||||||
|
each is arguably PII or near-PII. The per-field decision is
|
||||||
|
the release's responsibility; document the choice in `SPEC.md`
|
||||||
|
§21 (this section) and in the release CHANGELOG so future
|
||||||
|
deployments inherit the call rather than re-deciding.
|
||||||
|
- **Privacy-policy alignment.** The recorded data **MUST** match
|
||||||
|
what the deployment's privacy / cookies policy claims. If
|
||||||
|
reality is broader than the document promises, update the policy
|
||||||
|
text in the same release.
|
||||||
|
- **Selective redaction.** Amplitude supports field-level mask
|
||||||
|
classes that hide value while preserving DOM shape (so the
|
||||||
|
session is replayable but the value is not). Prefer this over
|
||||||
|
whole-form masking when only a subset is sensitive.
|
||||||
|
|
||||||
|
### 21.5 Consent-gate contract
|
||||||
|
|
||||||
|
The wrapper is bound to the v0.13.0 cookie/privacy consent surface
|
||||||
|
(`frontend/src/lib/consent.js`, §14.5). The binding is **load-
|
||||||
|
bearing**: the SDK and the session-replay recorder **MUST NOT**
|
||||||
|
load before consent is granted, and any consent revocation **MUST**
|
||||||
|
take effect within one tick of the consent flip.
|
||||||
|
|
||||||
|
The wrapper's bootstrap implements this contract; releases that
|
||||||
|
touch the analytics surface **MUST** preserve it.
|
||||||
|
|
||||||
|
- **Pre-consent: no init, no network, no recording.** If
|
||||||
|
`consent.analytics === true` is not currently true (either
|
||||||
|
because the user denied, or because the banner is up and no
|
||||||
|
decision has been recorded), the wrapper **MUST NOT** import
|
||||||
|
the Amplitude SDK, **MUST NOT** open any network request to
|
||||||
|
Amplitude, and **MUST NOT** start any session-replay recording.
|
||||||
|
The consent-gated lazy `import('@amplitude/unified')` is the
|
||||||
|
binding implementation; preserve it.
|
||||||
|
- **Denied → granted: init at the consent moment.** When consent
|
||||||
|
flips from denied/undecided to granted, the wrapper **MUST**
|
||||||
|
initialize the SDK at that moment (a new `initAll(KEY, …)` call
|
||||||
|
through the lazy-import path). Track and identify calls made
|
||||||
|
before init resolves **MUST** be queued and drained on init,
|
||||||
|
so the first signed-in user's first event is not dropped on
|
||||||
|
the cold-load race.
|
||||||
|
- **Granted → denied: setOptOut(true) within one tick.** When
|
||||||
|
consent flips from granted to denied mid-session, the wrapper
|
||||||
|
**MUST** call `amplitude.setOptOut(true)` so subsequent events
|
||||||
|
are dropped client-side and session replay stops recording.
|
||||||
|
The wrapper cannot unload the script tag (the SDK is already
|
||||||
|
in memory), but the SDK's contract for "drop subsequent events"
|
||||||
|
is `setOptOut(true)`. This **MUST** happen within one tick of
|
||||||
|
the consent flip (i.e. synchronously inside the
|
||||||
|
`onConsentChange` handler).
|
||||||
|
- **No silent re-grant.** A granted → denied → granted sequence
|
||||||
|
**MUST** call `setOptOut(false)` (re-enabling the SDK that was
|
||||||
|
paused) rather than firing a second `initAll` (which would
|
||||||
|
double-init). The wrapper's bootstrap implements this; releases
|
||||||
|
that touch the consent integration **MUST** preserve the
|
||||||
|
distinction.
|
||||||
|
- **Build-time vs. runtime.** The API key is read from
|
||||||
|
`import.meta.env.VITE_AMPLITUDE_API_KEY` at build time. When
|
||||||
|
the env var is unset, the wrapper **MUST** log one console
|
||||||
|
warning and no-op (every public function becomes a deterministic
|
||||||
|
no-op) so dev environments without an Amplitude account keep
|
||||||
|
working. The deploy gesture binds the key via the deployment's
|
||||||
|
overlay verb (for OHM-shape deployments, `flotilla overlay set`);
|
||||||
|
see §21.8 for the secret-vs-public discussion.
|
||||||
|
|
||||||
|
### 21.6 Identity lifecycle (per #21 Part C)
|
||||||
|
|
||||||
|
Amplitude's identity model has a specific pattern that the
|
||||||
|
framework follows verbatim. Every release that touches an
|
||||||
|
identity-meaningful surface **MUST** observe this pattern. The
|
||||||
|
pattern shipped inline across v0.15.0 / v0.16.0 / v0.17.0
|
||||||
|
(Session L's wave); this section codifies the contract so future
|
||||||
|
releases inherit it.
|
||||||
|
|
||||||
|
**On sign-in success** (`App.jsx`'s `me.user` resolution):
|
||||||
|
|
||||||
|
- The wrapper's `identify({ user_id, properties })` call **MUST**
|
||||||
|
carry both the OHM user_id (`amplitude.setUserId(<id>)`
|
||||||
|
internally) AND the user's durable property bag. `setUserId`
|
||||||
|
alone is **NOT** sufficient — without properties, the Amplitude
|
||||||
|
user record carries only the id, and cohort analysis loses the
|
||||||
|
shape (role distribution, sign-in-method distribution, etc.)
|
||||||
|
the dashboard depends on.
|
||||||
|
- Properties **MUST** be a bag of opaque ids, enums, booleans,
|
||||||
|
and timestamps — no PII (no email, no display name, no IP).
|
||||||
|
- Properties **MUST** be classified `set` vs `setOnce` deliberately
|
||||||
|
(see §21.6.1 below).
|
||||||
|
- The same `identify` call **MUST** be re-issued on every sign-in
|
||||||
|
(idempotent at Amplitude's side; cheap; corrects any drift in
|
||||||
|
the mutable property half).
|
||||||
|
|
||||||
|
**On user-state change mid-session** (role grant/revoke, trust-
|
||||||
|
device add, passcode set, beta-permission flip):
|
||||||
|
|
||||||
|
- The wrapper's `setUserProperties(properties)` call **MUST** fire
|
||||||
|
so the Amplitude record stays current. Mid-session state changes
|
||||||
|
**MUST NOT** wait for the next sign-in to surface — the dashboard
|
||||||
|
cohort an admin uses to grant permission is the same dashboard
|
||||||
|
that next sees the granted user's behavior; staleness here breaks
|
||||||
|
the cohort feedback loop.
|
||||||
|
|
||||||
|
**On sign-out**:
|
||||||
|
|
||||||
|
- The wrapper's `anonymize()` call (internally `amplitude.reset()`)
|
||||||
|
**MUST** fire. `reset` clears the device-id linking AND **MUST**
|
||||||
|
also clear the property cache so the next anonymous session is a
|
||||||
|
fresh slate (the wrapper's `anonymize()` does both — releases
|
||||||
|
that touch the wrapper **MUST** preserve this).
|
||||||
|
- The `User Signed Out` `track()` call **MUST** fire *before*
|
||||||
|
`anonymize()`, so the sign-out event is correctly attributed to
|
||||||
|
the signing-out user rather than to the post-reset anonymous
|
||||||
|
device.
|
||||||
|
|
||||||
|
**On invite-claim** (the v0.16.0 per-RFC invite + v0.17.0 admin-
|
||||||
|
create invite paths):
|
||||||
|
|
||||||
|
- The wrapper's `identify({ user_id, properties })` call **MUST**
|
||||||
|
fire BEFORE the first `track()` event on the claim surface, so
|
||||||
|
the Amplitude user record is created with the OHM user_id from
|
||||||
|
the first event. **MUST NOT** fire `track()` first and `identify`
|
||||||
|
later — that creates an anonymous device record that
|
||||||
|
retroactively links, and the cohort attribution for
|
||||||
|
invite-driven onboarding loses precision.
|
||||||
|
- The invite-context properties (`claim_method`,
|
||||||
|
`invited_by_admin_id`, `invited_at`, `initial_role`) are
|
||||||
|
`setOnce` (immutable user-history markers) — see §21.6.1.
|
||||||
|
|
||||||
|
**Inviter-side identification on invite-send events**:
|
||||||
|
|
||||||
|
- The inviter's `track('Invitation Sent', …)` and
|
||||||
|
`track('User Invited', …)` events fire from the inviter's
|
||||||
|
signed-in session, so the `user_id` attribution is already
|
||||||
|
correct (it's the inviter's id). The event body carries
|
||||||
|
`target_user_id` (#16 — admin-create, where the future user is
|
||||||
|
provisioned at create-time) or a hashed `target_email`
|
||||||
|
fingerprint (#12 — per-RFC invite, where the invitee is not
|
||||||
|
yet a user) so the invite + claim pair can be correlated later
|
||||||
|
in the dashboard.
|
||||||
|
|
||||||
|
#### 21.6.1 `set` vs `setOnce` taxonomy
|
||||||
|
|
||||||
|
Amplitude distinguishes two property-write semantics:
|
||||||
|
|
||||||
|
- **`set(k, v)`** — overwrites the property on every call. The
|
||||||
|
user record reflects the most recent value.
|
||||||
|
- **`setOnce(k, v)`** — writes only if the property is not
|
||||||
|
already present. Subsequent calls are no-ops. The user record
|
||||||
|
reflects the first value ever written.
|
||||||
|
|
||||||
|
The wrapper's `applyProperties` function accepts both: a bare
|
||||||
|
value uses `.set()`; a sentinel-wrapped value
|
||||||
|
`['__setOnce__', value]` uses `.setOnce()`. Releases that add new
|
||||||
|
user properties **MUST** classify each one explicitly, by the
|
||||||
|
following rule:
|
||||||
|
|
||||||
|
- A property whose value is **expected to change over the user's
|
||||||
|
lifetime** is `set`. Examples: `role` (can flip from
|
||||||
|
`contributor` to `owner`), `permission_state` (pending → granted),
|
||||||
|
`passcode_set` (false → true), `device_trusted` (changes per
|
||||||
|
active device). On each sign-in, the latest value is written;
|
||||||
|
the dashboard always sees current state.
|
||||||
|
- A property that is an **immutable historical marker** is
|
||||||
|
`setOnce`. Examples: `first_sign_in_at` (the timestamp of the
|
||||||
|
user's first observed sign-in — never re-write), `account_
|
||||||
|
created_at` (the timestamp of provisioning),
|
||||||
|
`invited_by_admin_id` (the admin who provisioned this user via
|
||||||
|
the v0.17.0 path — preserved even if the user is later
|
||||||
|
re-invited or has their role changed), `invited_at` (the
|
||||||
|
timestamp at which the invite was sent — distinct from
|
||||||
|
`claim_method` which is also setOnce because once claim_method
|
||||||
|
is `'admin-invite'`, that's the path this user took).
|
||||||
|
|
||||||
|
The classification is part of the release's contract — flipping a
|
||||||
|
property from `set` to `setOnce` (or vice versa) mid-life corrupts
|
||||||
|
the user record and **MUST** be avoided. If a property's
|
||||||
|
semantics genuinely change, retire the old key and introduce a new
|
||||||
|
one (same deprecation discipline as event renames in §21.1).
|
||||||
|
|
||||||
|
### 21.7 Cohort-shape implications (informative)
|
||||||
|
|
||||||
|
The conventions above are designed so that the Amplitude dashboard
|
||||||
|
can answer cohort questions the operator actually asks:
|
||||||
|
|
||||||
|
- *"How many users signed in via the admin-invite path in week N
|
||||||
|
vs. organic OTC?"* — uses `claim_method` (setOnce) on the user
|
||||||
|
record + `User Signed In` events with `method`.
|
||||||
|
- *"Of admin-invited users, what fraction set a passcode within
|
||||||
|
their first session?"* — uses `claim_method` + `passcode_set`
|
||||||
|
on the user record + `Page Viewed` events to define "session."
|
||||||
|
- *"Which RFCs have the most owner-invited contributors?"* — uses
|
||||||
|
per-RFC `Invitation Sent` / `Invitation Accepted` correlated
|
||||||
|
via `rfc_slug` + `role_in_rfc`.
|
||||||
|
- *"What's the gap between invite-send and invite-claim, broken
|
||||||
|
out by inviter?"* — uses `Invitation Sent` (inviter's session,
|
||||||
|
inviter `user_id`) + `Invitation Accepted` (invitee's session,
|
||||||
|
invitee `user_id` after the BEFORE-track identify) joined on
|
||||||
|
`rfc_slug` + inviter (the inviter's id is the same id on both
|
||||||
|
events because both invite and claim sides observe it).
|
||||||
|
|
||||||
|
The Part-A audit (per `ohm-rfc/ROADMAP.md` #21) confirms these
|
||||||
|
shapes against real data once a week of beta traffic is in. The
|
||||||
|
audit is a point-in-time pass; this chapter is the standing
|
||||||
|
discipline that keeps future work in shape.
|
||||||
|
|
||||||
|
### 21.8 Secret vs. public — overlay binding
|
||||||
|
|
||||||
|
The Amplitude browser API key (`VITE_AMPLITUDE_API_KEY`) is
|
||||||
|
**bundle-embedded by design**: it appears as a literal string in
|
||||||
|
the deployment's JavaScript bundle, visible to anyone with browser
|
||||||
|
dev tools. The vendor's installation prompt embeds it inline. This
|
||||||
|
puts it in the same category as Cloudflare Turnstile's site key
|
||||||
|
(`VITE_TURNSTILE_SITE_KEY`, v0.12.0) — public, not secret.
|
||||||
|
|
||||||
|
Deployments **MUST** bind such keys via their overlay verb (for
|
||||||
|
OHM-shape deployments, `flotilla overlay set`), not via the secret
|
||||||
|
binding. The matching secret half (the Cloudflare Turnstile
|
||||||
|
**secret** key, `CLOUDFLARE_TURNSTILE_SECRET`, used server-side
|
||||||
|
for siteverify) is a true secret bound via `flotilla secret set`.
|
||||||
|
This per-key distinction is the deployment's responsibility; the
|
||||||
|
framework's `*.env.example` files name the binding for each.
|
||||||
|
|
||||||
|
The binding rule baked in mid-Session-K is: **the operator's
|
||||||
|
secret bytes never enter the conversation with an assistant**,
|
||||||
|
even as one offered option. The conversation-layer corollary of
|
||||||
|
the build-pipeline §3-invariant-1 rule from
|
||||||
|
`ohm-rfc-app-flotilla/SPEC.md` is that sessions publish in full,
|
||||||
|
and a secret in a transcript is a leaked secret. The canonical
|
||||||
|
secret-set gesture for OHM is `pbpaste | flotilla secret set
|
||||||
|
<deployment> <SECRET_NAME>` (the value goes clipboard → stdin →
|
||||||
|
Secret Manager without ever appearing in shell history or the
|
||||||
|
model context). Non-OHM deployments inherit the same discipline
|
||||||
|
through their own deploy tooling.
|
||||||
|
|
||||||
|
### 21.9 §19.2 candidates surfaced by this chapter
|
||||||
|
|
||||||
|
- **Session-replay-specific consent category.** v0.13.0's cookie
|
||||||
|
banner has a single `analytics` toggle that gates both event
|
||||||
|
counters and full-DOM session replay. Recording has a larger
|
||||||
|
privacy footprint than counters; a separate consent category
|
||||||
|
for session replay is the cleaner shape. Captured here and in
|
||||||
|
`ohm-rfc/ROADMAP.md` #21 Part A.
|
||||||
|
- **Bundle-size budget for the analytics wrapper.** The
|
||||||
|
`@amplitude/unified` package adds ~150 KB gzipped (the session-
|
||||||
|
replay recorder is the bulk). The consent-gated lazy import
|
||||||
|
keeps the cost off the initial bundle for users who haven't
|
||||||
|
opted in; the post-consent init path has not been measured
|
||||||
|
for jank. Captured in #21 Part A.
|
||||||
|
- **Property-shape lint.** The conventions in §21.1 / §21.2 are
|
||||||
|
enforced today by review discipline. A small lint (CI grep
|
||||||
|
against `track(` / `identify(` callsites with a property-key
|
||||||
|
allowlist + a PII-name denylist) is a future affordance that
|
||||||
|
catches drift mechanically.
|
||||||
|
- **Hashed `target_email` derivation.** §21.2 names SHA-256 of
|
||||||
|
the normalized lower-cased email as the hashing function. The
|
||||||
|
framework does not currently expose a helper for this — a
|
||||||
|
small `frontend/src/lib/hash.js` or `backend/app/hash.py` that
|
||||||
|
centralizes the normalization + hash would make the contract
|
||||||
|
enforceable. Captured here.
|
||||||
|
|
||||||
|
### 21.10 Open question
|
||||||
|
|
||||||
|
The wrapper currently uses the Amplitude SDK's autocapture +
|
||||||
|
session-replay defaults. The v0.13.0 consent surface has a single
|
||||||
|
toggle for "analytics." Splitting the consent into "analytics"
|
||||||
|
vs "session replay" is a §19.2 candidate (above) but settling it
|
||||||
|
also requires a privacy-policy update and a re-prompt of
|
||||||
|
existing consenters. The cleanest moment to do this is the next
|
||||||
|
material privacy-policy revision; the conventions in §21.4 hold
|
||||||
|
in the interim.
|
||||||
|
|
||||||
|
|||||||
+310
-1
@@ -15,6 +15,7 @@ import json
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from fastapi import APIRouter, HTTPException, Request
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
|
from fastapi.responses import PlainTextResponse, Response
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
from . import (
|
from . import (
|
||||||
@@ -29,6 +30,8 @@ from . import (
|
|||||||
db,
|
db,
|
||||||
device_trust as device_trust_mod,
|
device_trust as device_trust_mod,
|
||||||
docs as docs_mod,
|
docs as docs_mod,
|
||||||
|
docs_sessions,
|
||||||
|
docs_specs,
|
||||||
entry as entry_mod,
|
entry as entry_mod,
|
||||||
cache,
|
cache,
|
||||||
funder,
|
funder,
|
||||||
@@ -48,6 +51,11 @@ class ProposeBody(BaseModel):
|
|||||||
slug: str = Field(min_length=1, max_length=80)
|
slug: str = Field(min_length=1, max_length=80)
|
||||||
pitch: str = Field(min_length=1)
|
pitch: str = Field(min_length=1)
|
||||||
tags: list[str] = Field(default_factory=list)
|
tags: list[str] = Field(default_factory=list)
|
||||||
|
# Roadmap #26: optional "What will you be using this RFC for?" — the
|
||||||
|
# concrete ground-truth use case, distinct from the `pitch`'s abstract
|
||||||
|
# "why is this needed." Optional (NULL/omitted accepted), no minimum,
|
||||||
|
# generous cap matching the pitch's free-text body bound.
|
||||||
|
proposed_use_case: str | None = Field(default=None, max_length=8000)
|
||||||
|
|
||||||
|
|
||||||
class DeclineBody(BaseModel):
|
class DeclineBody(BaseModel):
|
||||||
@@ -59,6 +67,18 @@ class FunderCredentialBody(BaseModel):
|
|||||||
api_key: str = Field(min_length=1, max_length=2048)
|
api_key: str = Field(min_length=1, max_length=2048)
|
||||||
|
|
||||||
|
|
||||||
|
class LastStateBody(BaseModel):
|
||||||
|
# v0.23.0 / roadmap item #29: server-side sign-in state resume.
|
||||||
|
# `route` is a frontend pathname the user was last on (bounded so a
|
||||||
|
# hostile client can't stuff arbitrary blobs through). `state` is an
|
||||||
|
# optional bag of *light* view state (scroll anchors, open tab,
|
||||||
|
# filter chips). PRIVACY: it MUST NOT carry draft-buffer contents —
|
||||||
|
# the frontend only ever sends ephemeral view state, and the column
|
||||||
|
# comment in migration 022 + SPEC §6.2 are the binding contract.
|
||||||
|
route: str = Field(min_length=1, max_length=2048)
|
||||||
|
state: dict[str, Any] | None = None
|
||||||
|
|
||||||
|
|
||||||
class BetaRequestBody(BaseModel):
|
class BetaRequestBody(BaseModel):
|
||||||
# v0.8.0 — captured on the first OTC sign-in. All three fields are
|
# v0.8.0 — captured on the first OTC sign-in. All three fields are
|
||||||
# required so the admin queue has a coherent triage shape.
|
# required so the admin queue has a coherent triage shape.
|
||||||
@@ -143,6 +163,177 @@ def make_router(
|
|||||||
payload = docs_mod.load()
|
payload = docs_mod.load()
|
||||||
return {"body": payload["body"]}
|
return {"body": payload["body"]}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
# v0.19.0 / roadmap item #30 — /api/docs/sessions/*
|
||||||
|
#
|
||||||
|
# The framework mediates reads against the public
|
||||||
|
# `wiggleverse/ohm-session-history` gitea repo so the rendered
|
||||||
|
# `/docs/sessions/*` surface inherits the same chrome as the
|
||||||
|
# /docs/user-guide route and doesn't require a cross-origin
|
||||||
|
# gesture from the frontend. See backend/app/docs_sessions.py
|
||||||
|
# for the cache shape and env knobs.
|
||||||
|
#
|
||||||
|
# The route mapping for the three `status` values returned by
|
||||||
|
# the fetchers:
|
||||||
|
#
|
||||||
|
# "ok" → HTTP 200, payload as documented per endpoint
|
||||||
|
# "404" → HTTP 200/404 depending on the endpoint (the
|
||||||
|
# manifest's empty state is 200 + {} so the
|
||||||
|
# frontend can short-circuit without an error
|
||||||
|
# banner; transcripts/about return 404 so the
|
||||||
|
# frontend can render its own empty-state)
|
||||||
|
# "error" → HTTP 502, {"error": ..., "detail": ...} so the
|
||||||
|
# frontend retry surface reads as "couldn't reach
|
||||||
|
# the session-history repo" rather than as a
|
||||||
|
# generic 5xx.
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
|
||||||
|
@router.get("/api/docs/sessions/manifest")
|
||||||
|
async def get_sessions_manifest() -> dict[str, Any]:
|
||||||
|
result = await docs_sessions.fetch_manifest()
|
||||||
|
if result["status"] == "ok":
|
||||||
|
return result["manifest"]
|
||||||
|
if result["status"] == "404":
|
||||||
|
# Empty-state contract: render no session rows in the
|
||||||
|
# flyout but don't show an error banner. The frontend
|
||||||
|
# treats `{}` as "no sessions published yet".
|
||||||
|
return {}
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail={
|
||||||
|
"error": "session-history fetch failed",
|
||||||
|
"detail": result.get("detail", "unknown"),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
@router.get("/api/docs/sessions/about")
|
||||||
|
async def get_sessions_about() -> Response:
|
||||||
|
result = await docs_sessions.fetch_about()
|
||||||
|
if result["status"] == "ok":
|
||||||
|
return PlainTextResponse(
|
||||||
|
content=result["body"],
|
||||||
|
media_type="text/markdown; charset=utf-8",
|
||||||
|
)
|
||||||
|
if result["status"] == "404":
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=404,
|
||||||
|
detail="session-history README not yet published",
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail={
|
||||||
|
"error": "session-history fetch failed",
|
||||||
|
"detail": result.get("detail", "unknown"),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
@router.get("/api/docs/sessions/{nnnn}/index")
|
||||||
|
async def get_sessions_index(nnnn: str) -> dict[str, Any]:
|
||||||
|
if not docs_sessions._is_valid_session_dir(nnnn):
|
||||||
|
# 400 over 404: the request itself is malformed (the
|
||||||
|
# session directory name doesn't match `^\d{4}$`),
|
||||||
|
# distinct from "no such session published yet".
|
||||||
|
raise HTTPException(status_code=400, detail="invalid session directory")
|
||||||
|
result = await docs_sessions.fetch_session_index(nnnn)
|
||||||
|
if result["status"] == "ok":
|
||||||
|
return {"files": result["files"]}
|
||||||
|
if result["status"] == "404":
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=404,
|
||||||
|
detail="no transcripts published for this session",
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail={
|
||||||
|
"error": "session-history fetch failed",
|
||||||
|
"detail": result.get("detail", "unknown"),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
@router.get("/api/docs/sessions/{nnnn}/{filename}")
|
||||||
|
async def get_sessions_transcript(nnnn: str, filename: str) -> Response:
|
||||||
|
# Path-shape validation before any network — refuses anything
|
||||||
|
# that would resolve outside the `NNNN/SESSION-...md` layout
|
||||||
|
# (e.g. legacy `SESSION-A-TRANSCRIPT.md` at the repo root,
|
||||||
|
# `../etc/passwd`, or any non-numeric session dir).
|
||||||
|
if not docs_sessions._is_valid_session_dir(nnnn):
|
||||||
|
raise HTTPException(status_code=400, detail="invalid session directory")
|
||||||
|
if not docs_sessions._is_valid_transcript_filename(filename):
|
||||||
|
raise HTTPException(status_code=400, detail="invalid transcript filename")
|
||||||
|
result = await docs_sessions.fetch_transcript(nnnn, filename)
|
||||||
|
if result["status"] == "ok":
|
||||||
|
return PlainTextResponse(
|
||||||
|
content=result["body"],
|
||||||
|
media_type="text/markdown; charset=utf-8",
|
||||||
|
)
|
||||||
|
if result["status"] == "404":
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=404,
|
||||||
|
detail="transcript not found",
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail={
|
||||||
|
"error": "session-history fetch failed",
|
||||||
|
"detail": result.get("detail", "unknown"),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
# v0.20.0 — /api/docs/specs/*
|
||||||
|
#
|
||||||
|
# Sibling of the v0.19.0 docs-sessions surface: the framework
|
||||||
|
# mediates a fetch against the public gitea raw URL for each
|
||||||
|
# configured spec so the rendered `/docs/specs/*` route inherits
|
||||||
|
# the same chrome (and the same auth-less reach) as the user
|
||||||
|
# guide and the session-history browser. See
|
||||||
|
# backend/app/docs_specs.py for the manifest shape, the env
|
||||||
|
# knobs, and the cache.
|
||||||
|
#
|
||||||
|
# Status-to-HTTP mapping mirrors docs_sessions:
|
||||||
|
# "ok" → HTTP 200, payload as documented per endpoint
|
||||||
|
# "404" → HTTP 200 / 404 (manifest 404 doesn't apply here —
|
||||||
|
# the manifest is derived from env, never 404s; spec
|
||||||
|
# 404 returns HTTP 404 so the frontend can render
|
||||||
|
# "spec not yet published / unknown name")
|
||||||
|
# "error" → HTTP 502
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
|
||||||
|
@router.get("/api/docs/specs/manifest")
|
||||||
|
async def get_specs_manifest() -> dict[str, Any]:
|
||||||
|
# The manifest is derived from env (`OHM_DOCS_SPECS`) and
|
||||||
|
# never fails — a malformed value falls back to the framework
|
||||||
|
# default at parse time. So this endpoint always returns 200
|
||||||
|
# + a list (the framework default is non-empty).
|
||||||
|
result = docs_specs.fetch_specs_manifest()
|
||||||
|
return {"specs": result["specs"]}
|
||||||
|
|
||||||
|
@router.get("/api/docs/specs/{name}")
|
||||||
|
async def get_spec(name: str) -> Response:
|
||||||
|
# Slug validation before any network — refuses `..`, `/`,
|
||||||
|
# uppercase, whitespace, etc. Same defense-in-depth posture
|
||||||
|
# as the docs-sessions transcript endpoint.
|
||||||
|
if not docs_specs._is_valid_name(name):
|
||||||
|
raise HTTPException(status_code=400, detail="invalid spec name")
|
||||||
|
result = await docs_specs.fetch_spec(name)
|
||||||
|
if result["status"] == "ok":
|
||||||
|
return PlainTextResponse(
|
||||||
|
content=result["body"],
|
||||||
|
media_type="text/markdown; charset=utf-8",
|
||||||
|
)
|
||||||
|
if result["status"] == "404":
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=404,
|
||||||
|
detail="spec not found",
|
||||||
|
)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=502,
|
||||||
|
detail={
|
||||||
|
"error": "specs fetch failed",
|
||||||
|
"detail": result.get("detail", "unknown"),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
# Auth surface — reads role from our users table per §6.
|
# Auth surface — reads role from our users table per §6.
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
@@ -175,6 +366,28 @@ def make_router(
|
|||||||
)
|
)
|
||||||
has_passcode = bool(row and row["passcode_hash"])
|
has_passcode = bool(row and row["passcode_hash"])
|
||||||
passcode_set_at = row["passcode_set_at"] if (row and has_passcode) else None
|
passcode_set_at = row["passcode_set_at"] if (row and has_passcode) else None
|
||||||
|
# v0.23.0 / item #29: fold the sign-in-resume state onto the
|
||||||
|
# same round-trip the frontend already makes on boot. When
|
||||||
|
# resume is disabled (resume_enabled = 0) we hand back a null
|
||||||
|
# route so the client never redirects; the stored row stays put
|
||||||
|
# so re-enabling later resumes the last-known route.
|
||||||
|
state_row = db.conn().execute(
|
||||||
|
"SELECT last_route, last_route_state, resume_enabled "
|
||||||
|
"FROM user_session_state WHERE user_id = ?",
|
||||||
|
(user.user_id,),
|
||||||
|
).fetchone()
|
||||||
|
resume_enabled = bool(state_row["resume_enabled"]) if state_row else True
|
||||||
|
last_route = (
|
||||||
|
state_row["last_route"]
|
||||||
|
if (state_row and resume_enabled)
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
last_route_state = None
|
||||||
|
if state_row and resume_enabled and state_row["last_route_state"]:
|
||||||
|
try:
|
||||||
|
last_route_state = json.loads(state_row["last_route_state"])
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
last_route_state = None
|
||||||
return {
|
return {
|
||||||
"authenticated": True,
|
"authenticated": True,
|
||||||
"user": {
|
"user": {
|
||||||
@@ -191,6 +404,10 @@ def make_router(
|
|||||||
"needs_profile": needs_profile,
|
"needs_profile": needs_profile,
|
||||||
"has_passcode": has_passcode,
|
"has_passcode": has_passcode,
|
||||||
"passcode_set_at": passcode_set_at,
|
"passcode_set_at": passcode_set_at,
|
||||||
|
# v0.23.0 / item #29 — sign-in state resume.
|
||||||
|
"resume_enabled": resume_enabled,
|
||||||
|
"last_route": last_route,
|
||||||
|
"last_route_state": last_route_state,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -260,6 +477,52 @@ def make_router(
|
|||||||
notify.fan_out_new_beta_request(requester_user_id=user.user_id)
|
notify.fan_out_new_beta_request(requester_user_id=user.user_id)
|
||||||
return {"ok": True}
|
return {"ok": True}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
# v0.23.0 (§6.2, roadmap item #29): server-side sign-in state
|
||||||
|
# resume. The frontend debounce-posts the user's current route +
|
||||||
|
# a small bag of light view state here on every route change; the
|
||||||
|
# next sign-in reads `last_route` off `/api/auth/me` and redirects.
|
||||||
|
#
|
||||||
|
# Per-user (NOT per-device) — one row per user, keyed on user_id.
|
||||||
|
# `resume_enabled` is the opt-out flag (default on); when it's 0
|
||||||
|
# this endpoint no-ops so a user who turned resume off doesn't keep
|
||||||
|
# silently rewriting their stored route. PRIVACY: the body carries
|
||||||
|
# route + light state ONLY, never draft-buffer contents (migration
|
||||||
|
# 022 column comment + SPEC §6.2 are the binding contract).
|
||||||
|
#
|
||||||
|
# `require_user` (not `require_contributor`) — a pending/granted
|
||||||
|
# distinction is irrelevant for "remember where I was", and a
|
||||||
|
# pending user navigating read-only surfaces should still resume.
|
||||||
|
# Anonymous callers get the 401 `require_user` raises.
|
||||||
|
# ---------------------------------------------------------------
|
||||||
|
|
||||||
|
@router.put("/api/me/last-state")
|
||||||
|
async def put_last_state(body: LastStateBody, request: Request) -> dict[str, Any]:
|
||||||
|
user = auth.require_user(request)
|
||||||
|
# Respect the opt-out: if a row already exists with resume
|
||||||
|
# disabled, leave it untouched and report the no-op. A first-
|
||||||
|
# ever POST (no row yet) defaults to enabled and stores.
|
||||||
|
existing = db.conn().execute(
|
||||||
|
"SELECT resume_enabled FROM user_session_state WHERE user_id = ?",
|
||||||
|
(user.user_id,),
|
||||||
|
).fetchone()
|
||||||
|
if existing is not None and not existing["resume_enabled"]:
|
||||||
|
return {"ok": True, "stored": False}
|
||||||
|
state_json = json.dumps(body.state) if body.state is not None else None
|
||||||
|
db.conn().execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO user_session_state
|
||||||
|
(user_id, last_route, last_route_state, last_updated_at)
|
||||||
|
VALUES (?, ?, ?, datetime('now'))
|
||||||
|
ON CONFLICT(user_id) DO UPDATE SET
|
||||||
|
last_route = excluded.last_route,
|
||||||
|
last_route_state = excluded.last_route_state,
|
||||||
|
last_updated_at = excluded.last_updated_at
|
||||||
|
""",
|
||||||
|
(user.user_id, body.route, state_json),
|
||||||
|
)
|
||||||
|
return {"ok": True, "stored": True}
|
||||||
|
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
# v0.11.0: trust device for 30 days (§6.2, roadmap item #9).
|
# v0.11.0: trust device for 30 days (§6.2, roadmap item #9).
|
||||||
#
|
#
|
||||||
@@ -383,12 +646,36 @@ def make_router(
|
|||||||
).fetchone()
|
).fetchone()
|
||||||
if row is None:
|
if row is None:
|
||||||
raise HTTPException(404, "Not found")
|
raise HTTPException(404, "Not found")
|
||||||
return _serialize_rfc(row)
|
payload = _serialize_rfc(row)
|
||||||
|
# Roadmap #26: surface the optional propose-time use case on the
|
||||||
|
# RFC view. The idea PR closes on merge, but the canonical row in
|
||||||
|
# `proposed_use_cases` persists; look it up by slug (the latest
|
||||||
|
# 'rfc'-scope row for this slug). NULL == "left blank".
|
||||||
|
uc = db.conn().execute(
|
||||||
|
"""
|
||||||
|
SELECT use_case FROM proposed_use_cases
|
||||||
|
WHERE scope = 'rfc' AND rfc_slug = ?
|
||||||
|
ORDER BY id DESC LIMIT 1
|
||||||
|
""",
|
||||||
|
(slug,),
|
||||||
|
).fetchone()
|
||||||
|
payload["proposed_use_case"] = uc["use_case"] if uc else None
|
||||||
|
return payload
|
||||||
|
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
# §7.3 / §9.3: pending ideas
|
# §7.3 / §9.3: pending ideas
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
|
|
||||||
|
def _proposal_use_case(pr_number: int) -> str | None:
|
||||||
|
"""Roadmap #26: read the optional use case for an idea PR from the
|
||||||
|
canonical side table. Returns None when none was supplied (the
|
||||||
|
"left blank" sentinel the frontend renders tastefully)."""
|
||||||
|
row = db.conn().execute(
|
||||||
|
"SELECT use_case FROM proposed_use_cases WHERE scope = 'rfc' AND pr_number = ?",
|
||||||
|
(pr_number,),
|
||||||
|
).fetchone()
|
||||||
|
return row["use_case"] if row else None
|
||||||
|
|
||||||
@router.get("/api/proposals")
|
@router.get("/api/proposals")
|
||||||
async def list_proposals() -> dict[str, Any]:
|
async def list_proposals() -> dict[str, Any]:
|
||||||
rows = db.conn().execute(
|
rows = db.conn().execute(
|
||||||
@@ -408,6 +695,7 @@ def make_router(
|
|||||||
"description": r["description"],
|
"description": r["description"],
|
||||||
"opened_by": r["opened_by"],
|
"opened_by": r["opened_by"],
|
||||||
"opened_at": r["opened_at"],
|
"opened_at": r["opened_at"],
|
||||||
|
"proposed_use_case": _proposal_use_case(r["pr_number"]),
|
||||||
}
|
}
|
||||||
for r in rows
|
for r in rows
|
||||||
]
|
]
|
||||||
@@ -456,6 +744,7 @@ def make_router(
|
|||||||
"opened_at": row["opened_at"],
|
"opened_at": row["opened_at"],
|
||||||
"entry": entry_payload,
|
"entry": entry_payload,
|
||||||
"affordances": affordances,
|
"affordances": affordances,
|
||||||
|
"proposed_use_case": _proposal_use_case(pr_number),
|
||||||
}
|
}
|
||||||
|
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
@@ -532,6 +821,26 @@ def make_router(
|
|||||||
# cache write is idempotent.)
|
# cache write is idempotent.)
|
||||||
await cache.refresh_meta_pulls(config, gitea)
|
await cache.refresh_meta_pulls(config, gitea)
|
||||||
|
|
||||||
|
# Roadmap #26: persist the optional use case to the canonical,
|
||||||
|
# reconcile-proof side table keyed by the idea PR number. NULL/
|
||||||
|
# blank simply writes no row (absence == "left blank"). Done after
|
||||||
|
# the refresh so the cache row exists; the mirror onto cached_prs
|
||||||
|
# keeps the cache column in parity for any read that uses it.
|
||||||
|
use_case = (payload.proposed_use_case or "").strip()
|
||||||
|
if use_case:
|
||||||
|
db.conn().execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO proposed_use_cases (scope, rfc_slug, pr_number, use_case)
|
||||||
|
VALUES ('rfc', ?, ?, ?)
|
||||||
|
ON CONFLICT(scope, pr_number) DO UPDATE SET use_case = excluded.use_case
|
||||||
|
""",
|
||||||
|
(slug, pr["number"], use_case),
|
||||||
|
)
|
||||||
|
db.conn().execute(
|
||||||
|
"UPDATE cached_prs SET proposed_use_case = ? WHERE pr_kind = 'idea' AND pr_number = ?",
|
||||||
|
(use_case, pr["number"]),
|
||||||
|
)
|
||||||
|
|
||||||
return {"pr_number": pr["number"], "slug": slug}
|
return {"pr_number": pr["number"], "slug": slug}
|
||||||
|
|
||||||
# ---------------------------------------------------------------
|
# ---------------------------------------------------------------
|
||||||
|
|||||||
@@ -42,6 +42,11 @@ RFC_FILE_PATH = "RFC.md"
|
|||||||
class OpenPRBody(BaseModel):
|
class OpenPRBody(BaseModel):
|
||||||
title: str = Field(min_length=1, max_length=240)
|
title: str = Field(min_length=1, max_length=240)
|
||||||
description: str = Field(max_length=8000)
|
description: str = Field(max_length=8000)
|
||||||
|
# Roadmap #26: optional "What will you be using this change for?" —
|
||||||
|
# the concrete ground-truth use case sibling to the required
|
||||||
|
# "why is this change needed" (the `description`). Optional, generous
|
||||||
|
# cap matching the description bound.
|
||||||
|
proposed_use_case: str | None = Field(default=None, max_length=8000)
|
||||||
|
|
||||||
|
|
||||||
class PRDescriptionBody(BaseModel):
|
class PRDescriptionBody(BaseModel):
|
||||||
@@ -173,6 +178,26 @@ def make_router(
|
|||||||
raise HTTPException(502, f"Gitea: {e.detail}")
|
raise HTTPException(502, f"Gitea: {e.detail}")
|
||||||
|
|
||||||
await _refresh_after_pr_write(rfc)
|
await _refresh_after_pr_write(rfc)
|
||||||
|
|
||||||
|
# Roadmap #26: persist the optional use case to the canonical,
|
||||||
|
# reconcile-proof side table keyed by the PR number. Blank/omitted
|
||||||
|
# writes no row (absence == "left blank"). The mirror onto
|
||||||
|
# cached_prs keeps the cache column in parity.
|
||||||
|
use_case = (body.proposed_use_case or "").strip()
|
||||||
|
if use_case:
|
||||||
|
db.conn().execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO proposed_use_cases (scope, rfc_slug, pr_number, use_case)
|
||||||
|
VALUES ('pr', ?, ?, ?)
|
||||||
|
ON CONFLICT(scope, pr_number) DO UPDATE SET use_case = excluded.use_case
|
||||||
|
""",
|
||||||
|
(slug, pr["number"], use_case),
|
||||||
|
)
|
||||||
|
db.conn().execute(
|
||||||
|
"UPDATE cached_prs SET proposed_use_case = ? WHERE rfc_slug = ? AND pr_number = ?",
|
||||||
|
(use_case, slug, pr["number"]),
|
||||||
|
)
|
||||||
|
|
||||||
return {"pr_number": pr["number"], "slug": slug, "branch": branch}
|
return {"pr_number": pr["number"], "slug": slug, "branch": branch}
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
# -------------------------------------------------------------------
|
||||||
@@ -300,6 +325,7 @@ def make_router(
|
|||||||
"pr_number": pr_number,
|
"pr_number": pr_number,
|
||||||
"title": pr_row["title"],
|
"title": pr_row["title"],
|
||||||
"description": pr_row["description"],
|
"description": pr_row["description"],
|
||||||
|
"proposed_use_case": _pr_use_case(pr_number),
|
||||||
"state": pr_row["state"],
|
"state": pr_row["state"],
|
||||||
"opened_by": pr_row["opened_by"],
|
"opened_by": pr_row["opened_by"],
|
||||||
"opened_at": pr_row["opened_at"],
|
"opened_at": pr_row["opened_at"],
|
||||||
@@ -762,6 +788,17 @@ def _can_edit_pr_text(rfc, pr_row, viewer) -> bool:
|
|||||||
return _can_withdraw(rfc, pr_row, viewer)
|
return _can_withdraw(rfc, pr_row, viewer)
|
||||||
|
|
||||||
|
|
||||||
|
def _pr_use_case(pr_number: int) -> str | None:
|
||||||
|
"""Roadmap #26: the optional propose-PR use case from the canonical
|
||||||
|
side table, or None when the change was opened without one ("left
|
||||||
|
blank")."""
|
||||||
|
row = db.conn().execute(
|
||||||
|
"SELECT use_case FROM proposed_use_cases WHERE scope = 'pr' AND pr_number = ?",
|
||||||
|
(pr_number,),
|
||||||
|
).fetchone()
|
||||||
|
return row["use_case"] if row else None
|
||||||
|
|
||||||
|
|
||||||
def _pr_capabilities(rfc, pr_row, viewer) -> dict:
|
def _pr_capabilities(rfc, pr_row, viewer) -> dict:
|
||||||
return {
|
return {
|
||||||
"can_merge": _can_merge(rfc, viewer) and pr_row["state"] == "open",
|
"can_merge": _can_merge(rfc, viewer) and pr_row["state"] == "open",
|
||||||
|
|||||||
@@ -0,0 +1,358 @@
|
|||||||
|
"""§14 + roadmap item #30 — on-site sessions-history browser source.
|
||||||
|
|
||||||
|
Sibling of `docs.py` / `philosophy.py` but with a different read shape:
|
||||||
|
the bodies here live in the **public** `wiggleverse/ohm-session-history`
|
||||||
|
gitea repo (transcripts of every OHM build session, published per the
|
||||||
|
ohm-infra SESSION-PROTOCOL.md), not on disk. The framework mediates
|
||||||
|
the gitea fetch on behalf of the browser so the rendered `/docs/sessions/*`
|
||||||
|
surface inherits the same chrome as `/philosophy` and `/docs/user-guide`
|
||||||
|
and stays free of any cross-origin gestures from the frontend.
|
||||||
|
|
||||||
|
Three read endpoints, all anonymous-reachable:
|
||||||
|
|
||||||
|
GET /api/docs/sessions/manifest — sessions.json (title manifest)
|
||||||
|
GET /api/docs/sessions/about — README.md (the about page)
|
||||||
|
GET /api/docs/sessions/<NNNN>/<file> — a transcript body
|
||||||
|
GET /api/docs/sessions/<NNNN>/index — per-session file listing
|
||||||
|
|
||||||
|
All three sit behind a small in-process TTL cache (manifest TTL default
|
||||||
|
60 s, content TTL default 300 s). Negative results (404 from gitea) are
|
||||||
|
also cached at the content TTL to avoid hammering gitea when a
|
||||||
|
deployment hasn't yet been populated with transcripts. The cache key
|
||||||
|
is the URL path on the gitea raw base (or the contents API for the
|
||||||
|
per-session listing); the cache lives in-process, plain dict +
|
||||||
|
`time.monotonic()` check, no external dep.
|
||||||
|
|
||||||
|
Env knobs:
|
||||||
|
|
||||||
|
OHM_SESSION_HISTORY_RAW_BASE
|
||||||
|
Override the gitea raw base URL. Default points at OHM's canonical
|
||||||
|
transcript repo:
|
||||||
|
https://git.wiggleverse.org/wiggleverse/ohm-session-history/raw/branch/main
|
||||||
|
The framework-default value is OHM-flavored because OHM is the
|
||||||
|
only deployment to date — a deployment running its own
|
||||||
|
transcript repo overrides this via flotilla's overlay.
|
||||||
|
|
||||||
|
OHM_SESSION_HISTORY_CONTENTS_BASE
|
||||||
|
Override the gitea contents-API base URL (for the per-session
|
||||||
|
listing endpoint, which enumerates files inside a `NNNN/` folder).
|
||||||
|
Default:
|
||||||
|
https://git.wiggleverse.org/api/v1/repos/wiggleverse/ohm-session-history/contents
|
||||||
|
|
||||||
|
OHM_DOCS_SESSIONS_MANIFEST_TTL_SEC
|
||||||
|
Cache TTL for the manifest (default 60 s). The manifest is small
|
||||||
|
and changes when a new session is added; 60 s strikes a balance
|
||||||
|
between freshness and gitea load.
|
||||||
|
|
||||||
|
OHM_DOCS_SESSIONS_CONTENT_TTL_SEC
|
||||||
|
Cache TTL for transcript bodies + README + per-session listings
|
||||||
|
(default 300 s = 5 minutes). Transcripts are append-only once
|
||||||
|
published, so 5 minutes of staleness is harmless.
|
||||||
|
|
||||||
|
§3 invariant 1 is preserved: the framework holds no secret bytes; the
|
||||||
|
gitea repo is public, the fetch carries no auth header.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
_DEFAULT_RAW_BASE = (
|
||||||
|
"https://git.wiggleverse.org/wiggleverse/ohm-session-history/raw/branch/main"
|
||||||
|
)
|
||||||
|
_DEFAULT_CONTENTS_BASE = (
|
||||||
|
"https://git.wiggleverse.org/api/v1/repos/wiggleverse/ohm-session-history/contents"
|
||||||
|
)
|
||||||
|
_DEFAULT_MANIFEST_TTL_SEC = 60.0
|
||||||
|
_DEFAULT_CONTENT_TTL_SEC = 300.0
|
||||||
|
|
||||||
|
# The transcript filename shape per SESSION-PROTOCOL.md §1. The
|
||||||
|
# `<start>--<end>` suffix is optional so legacy renamed-letter
|
||||||
|
# transcripts (e.g. `SESSION-0009.0-TRANSCRIPT.md` without timestamps)
|
||||||
|
# remain reachable. The `\.\d+(\.\d+)*` after the session number
|
||||||
|
# accommodates `0017.0`, `0017.1`, `0017.1.1`, etc.
|
||||||
|
_TRANSCRIPT_FILENAME_RE = re.compile(
|
||||||
|
r"^SESSION-\d{4}\.\d+(\.\d+)*-TRANSCRIPT"
|
||||||
|
r"(-\d{4}-\d{2}-\d{2}T\d{2}-\d{2}--\d{4}-\d{2}-\d{2}T\d{2}-\d{2})?"
|
||||||
|
r"\.md$"
|
||||||
|
)
|
||||||
|
_SESSION_DIR_RE = re.compile(r"^\d{4}$")
|
||||||
|
|
||||||
|
_HTTP_TIMEOUT_SEC = 5.0
|
||||||
|
|
||||||
|
|
||||||
|
def _env_float(name: str, default: float) -> float:
|
||||||
|
raw = os.environ.get(name, "").strip()
|
||||||
|
if not raw:
|
||||||
|
return default
|
||||||
|
try:
|
||||||
|
return float(raw)
|
||||||
|
except ValueError:
|
||||||
|
log.warning("invalid %s=%r — falling back to %s", name, raw, default)
|
||||||
|
return default
|
||||||
|
|
||||||
|
|
||||||
|
def _raw_base() -> str:
|
||||||
|
return os.environ.get("OHM_SESSION_HISTORY_RAW_BASE", "").strip() or _DEFAULT_RAW_BASE
|
||||||
|
|
||||||
|
|
||||||
|
def _contents_base() -> str:
|
||||||
|
return (
|
||||||
|
os.environ.get("OHM_SESSION_HISTORY_CONTENTS_BASE", "").strip()
|
||||||
|
or _DEFAULT_CONTENTS_BASE
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _manifest_ttl() -> float:
|
||||||
|
return _env_float("OHM_DOCS_SESSIONS_MANIFEST_TTL_SEC", _DEFAULT_MANIFEST_TTL_SEC)
|
||||||
|
|
||||||
|
|
||||||
|
def _content_ttl() -> float:
|
||||||
|
return _env_float("OHM_DOCS_SESSIONS_CONTENT_TTL_SEC", _DEFAULT_CONTENT_TTL_SEC)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# In-process TTL cache
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
#
|
||||||
|
# Plain dict + `time.monotonic()` check, no external dep. The cache
|
||||||
|
# value is a `(stored_at, payload)` tuple; `payload` may carry an
|
||||||
|
# error-shape sentinel for negative caching (404s). Lock guards
|
||||||
|
# read-modify-write across worker tasks; entries are immutable once
|
||||||
|
# stored so reads under the lock are fast.
|
||||||
|
|
||||||
|
_lock = threading.Lock()
|
||||||
|
_cache: dict[str, tuple[float, dict[str, Any]]] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _cache_get(key: str, ttl_sec: float) -> dict[str, Any] | None:
|
||||||
|
with _lock:
|
||||||
|
entry = _cache.get(key)
|
||||||
|
if entry is None:
|
||||||
|
return None
|
||||||
|
stored_at, payload = entry
|
||||||
|
if time.monotonic() - stored_at > ttl_sec:
|
||||||
|
# Don't evict here; let _cache_put overwrite on next fetch.
|
||||||
|
# The stale entry is gated by the TTL check, so it stays
|
||||||
|
# invisible to readers regardless.
|
||||||
|
return None
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _cache_put(key: str, payload: dict[str, Any]) -> None:
|
||||||
|
with _lock:
|
||||||
|
_cache[key] = (time.monotonic(), payload)
|
||||||
|
|
||||||
|
|
||||||
|
def reset_cache() -> None:
|
||||||
|
"""Drop every cached entry. Test seam — not called in production."""
|
||||||
|
with _lock:
|
||||||
|
_cache.clear()
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Public fetch surface
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
#
|
||||||
|
# Each fetcher returns a `{status, ...}` dict. `status` is one of:
|
||||||
|
# "ok" — payload field carries the body
|
||||||
|
# "404" — gitea returned 404 (or content was missing)
|
||||||
|
# "error" — gitea returned 5xx, timed out, or returned malformed data
|
||||||
|
#
|
||||||
|
# The route layer maps these onto HTTP responses; keeping the mapping
|
||||||
|
# out of this module makes the cache transparent to the test harness.
|
||||||
|
|
||||||
|
|
||||||
|
async def _http_get(url: str) -> tuple[int, str]:
|
||||||
|
"""Perform a single GET against `url`; return (status_code, body).
|
||||||
|
|
||||||
|
On timeout or network error, returns (599, error_message). The 599
|
||||||
|
pseudo-status maps to a 502 at the route layer the same way an
|
||||||
|
upstream 5xx does — the caller doesn't care which leg of the
|
||||||
|
network broke.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
async with httpx.AsyncClient(timeout=_HTTP_TIMEOUT_SEC) as client:
|
||||||
|
r = await client.get(url)
|
||||||
|
return r.status_code, r.text
|
||||||
|
except httpx.HTTPError as e:
|
||||||
|
log.warning("gitea fetch failed for %s: %s", url, e)
|
||||||
|
return 599, f"fetch error: {e}"
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_session_dir(nnnn: str) -> bool:
|
||||||
|
return bool(_SESSION_DIR_RE.match(nnnn))
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_transcript_filename(filename: str) -> bool:
|
||||||
|
return bool(_TRANSCRIPT_FILENAME_RE.match(filename))
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_manifest() -> dict[str, Any]:
|
||||||
|
"""Fetch and parse `sessions.json` from the public repo.
|
||||||
|
|
||||||
|
Returns one of:
|
||||||
|
{"status": "ok", "manifest": {...}} — successful parse
|
||||||
|
{"status": "404"} — gitea 404 (empty state)
|
||||||
|
{"status": "error", "detail": "..."} — 5xx / timeout / bad JSON
|
||||||
|
"""
|
||||||
|
cache_key = "manifest"
|
||||||
|
cached = _cache_get(cache_key, _manifest_ttl())
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
url = f"{_raw_base()}/sessions.json"
|
||||||
|
status, body = await _http_get(url)
|
||||||
|
|
||||||
|
if status == 200:
|
||||||
|
try:
|
||||||
|
import json
|
||||||
|
|
||||||
|
data = json.loads(body)
|
||||||
|
except (json.JSONDecodeError, ValueError) as e:
|
||||||
|
payload: dict[str, Any] = {
|
||||||
|
"status": "error",
|
||||||
|
"detail": f"sessions.json malformed: {e}",
|
||||||
|
}
|
||||||
|
# Don't cache parse errors — give the upstream a chance to
|
||||||
|
# fix the file without waiting for TTL expiry.
|
||||||
|
return payload
|
||||||
|
if not isinstance(data, dict):
|
||||||
|
return {
|
||||||
|
"status": "error",
|
||||||
|
"detail": "sessions.json is not a JSON object",
|
||||||
|
}
|
||||||
|
payload = {"status": "ok", "manifest": data}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
if status == 404:
|
||||||
|
payload = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
return {"status": "error", "detail": f"upstream returned {status}"}
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_about() -> dict[str, Any]:
|
||||||
|
"""Fetch the repo's README.md (rendered as the /docs/sessions/about page).
|
||||||
|
|
||||||
|
Returns one of:
|
||||||
|
{"status": "ok", "body": "..."}
|
||||||
|
{"status": "404"}
|
||||||
|
{"status": "error", "detail": "..."}
|
||||||
|
"""
|
||||||
|
cache_key = "about:README.md"
|
||||||
|
cached = _cache_get(cache_key, _content_ttl())
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
url = f"{_raw_base()}/README.md"
|
||||||
|
status, body = await _http_get(url)
|
||||||
|
|
||||||
|
if status == 200:
|
||||||
|
payload: dict[str, Any] = {"status": "ok", "body": body}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
if status == 404:
|
||||||
|
payload = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
return {"status": "error", "detail": f"upstream returned {status}"}
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_transcript(nnnn: str, filename: str) -> dict[str, Any]:
|
||||||
|
"""Fetch a single transcript body from `{nnnn}/{filename}` in the repo.
|
||||||
|
|
||||||
|
The caller is expected to have validated `nnnn` and `filename`
|
||||||
|
against `_is_valid_session_dir` / `_is_valid_transcript_filename`
|
||||||
|
before calling this — invalid paths shouldn't reach the network.
|
||||||
|
"""
|
||||||
|
cache_key = f"transcript:{nnnn}/{filename}"
|
||||||
|
cached = _cache_get(cache_key, _content_ttl())
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
url = f"{_raw_base()}/{nnnn}/{filename}"
|
||||||
|
status, body = await _http_get(url)
|
||||||
|
|
||||||
|
if status == 200:
|
||||||
|
payload: dict[str, Any] = {"status": "ok", "body": body}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
if status == 404:
|
||||||
|
payload = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
return {"status": "error", "detail": f"upstream returned {status}"}
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_session_index(nnnn: str) -> dict[str, Any]:
|
||||||
|
"""List the transcript filenames inside the `{nnnn}/` folder.
|
||||||
|
|
||||||
|
Uses gitea's contents API (one HTTP per session-index page-view per
|
||||||
|
cache-TTL) rather than the raw URL — there's no flat way to list a
|
||||||
|
folder via the raw mount.
|
||||||
|
|
||||||
|
Returns one of:
|
||||||
|
{"status": "ok", "files": ["SESSION-...md", ...]}
|
||||||
|
{"status": "404"}
|
||||||
|
{"status": "error", "detail": "..."}
|
||||||
|
|
||||||
|
Only filenames that match `_is_valid_transcript_filename` are
|
||||||
|
surfaced — sibling files (e.g. an attached `notes.md`) are ignored
|
||||||
|
so the /docs/sessions/<NNNN> page never lists a non-transcript
|
||||||
|
masquerading as one.
|
||||||
|
"""
|
||||||
|
cache_key = f"index:{nnnn}"
|
||||||
|
cached = _cache_get(cache_key, _content_ttl())
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
url = f"{_contents_base()}/{nnnn}"
|
||||||
|
status, body = await _http_get(url)
|
||||||
|
|
||||||
|
if status == 200:
|
||||||
|
try:
|
||||||
|
import json
|
||||||
|
|
||||||
|
data = json.loads(body)
|
||||||
|
except (json.JSONDecodeError, ValueError) as e:
|
||||||
|
return {
|
||||||
|
"status": "error",
|
||||||
|
"detail": f"contents API response malformed: {e}",
|
||||||
|
}
|
||||||
|
if not isinstance(data, list):
|
||||||
|
return {
|
||||||
|
"status": "error",
|
||||||
|
"detail": "contents API returned non-list",
|
||||||
|
}
|
||||||
|
files: list[str] = []
|
||||||
|
for entry in data:
|
||||||
|
if not isinstance(entry, dict):
|
||||||
|
continue
|
||||||
|
if entry.get("type") != "file":
|
||||||
|
continue
|
||||||
|
name = entry.get("name")
|
||||||
|
if not isinstance(name, str):
|
||||||
|
continue
|
||||||
|
if _is_valid_transcript_filename(name):
|
||||||
|
files.append(name)
|
||||||
|
files.sort()
|
||||||
|
payload: dict[str, Any] = {"status": "ok", "files": files}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
if status == 404:
|
||||||
|
payload = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
return {"status": "error", "detail": f"upstream returned {status}"}
|
||||||
@@ -0,0 +1,326 @@
|
|||||||
|
"""v0.20.0 — on-site framework-specs surface source.
|
||||||
|
|
||||||
|
Sibling of `docs_sessions.py` (v0.19.0 / roadmap item #30): the
|
||||||
|
framework mediates a gitea fetch on behalf of the browser so the
|
||||||
|
rendered `/docs/specs/*` surface inherits the same chrome as
|
||||||
|
`/docs/user-guide` and `/docs/sessions/*` and stays free of any
|
||||||
|
cross-origin gestures from the frontend.
|
||||||
|
|
||||||
|
Two read endpoints, both anonymous-reachable:
|
||||||
|
|
||||||
|
GET /api/docs/specs/manifest — the configured spec list
|
||||||
|
GET /api/docs/specs/<name> — a single spec body (markdown)
|
||||||
|
|
||||||
|
The framework-default manifest is OHM-flavored (rfc-app's own SPEC.md
|
||||||
|
+ flotilla's SPEC.md on `git.wiggleverse.org`) for the same reason
|
||||||
|
`docs_sessions.py`'s defaults are: OHM is the only deployment to
|
||||||
|
date. A deployment running its own spec set overrides the manifest
|
||||||
|
via the `OHM_DOCS_SPECS` env var (set through flotilla's overlay).
|
||||||
|
History is intentionally not surfaced here — the operator-stated
|
||||||
|
intent is "current version only; git is the history surface".
|
||||||
|
|
||||||
|
Per-spec entries carry three fields:
|
||||||
|
|
||||||
|
name — URL-safe slug (`[a-z0-9-]+`) — the path segment
|
||||||
|
title — human-readable label shown in the nav and the page header
|
||||||
|
url — the upstream raw URL the framework fetches
|
||||||
|
|
||||||
|
Validation:
|
||||||
|
|
||||||
|
- The configured list must be a JSON array of `{name, title, url}`
|
||||||
|
objects. A malformed `OHM_DOCS_SPECS` value (bad JSON, wrong
|
||||||
|
shape, invalid slug) logs a warning and falls back to the default
|
||||||
|
so a typo in the overlay doesn't crash startup.
|
||||||
|
- Each `name` is checked against `^[a-z0-9-]+$` before the manifest
|
||||||
|
is accepted. The route layer also validates the path-bound `name`
|
||||||
|
parameter before any network call, so a malformed URL never
|
||||||
|
reaches the cache or the upstream.
|
||||||
|
|
||||||
|
Cache shape mirrors `docs_sessions.py`: in-process `dict` + monotonic
|
||||||
|
TTL check, negative results (404) cached, no external dep. The
|
||||||
|
manifest is cheap (parsed from an env var, no network), so it has no
|
||||||
|
TTL — every request re-derives it. Per-spec content has a 5-minute
|
||||||
|
default TTL (env-tunable via `OHM_DOCS_SPECS_CONTENT_TTL_SEC`).
|
||||||
|
|
||||||
|
§3 invariant 1 is preserved: the framework holds no secret bytes;
|
||||||
|
the upstream specs are public-repo raw URLs, the fetch carries no
|
||||||
|
auth header.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
# The framework-default spec set. OHM-flavored per the same precedent
|
||||||
|
# `docs_sessions.py` set: the only live deployment is OHM, so the
|
||||||
|
# default points there. A deployment running its own specs overrides
|
||||||
|
# `OHM_DOCS_SPECS` via the overlay.
|
||||||
|
_DEFAULT_SPECS: list[dict[str, str]] = [
|
||||||
|
{
|
||||||
|
"name": "rfc-app",
|
||||||
|
"title": "rfc-app SPEC",
|
||||||
|
"url": (
|
||||||
|
"https://git.wiggleverse.org/ben.stull/rfc-app/"
|
||||||
|
"raw/branch/main/SPEC.md"
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "flotilla",
|
||||||
|
"title": "flotilla SPEC",
|
||||||
|
"url": (
|
||||||
|
"https://git.wiggleverse.org/wiggleverse/ohm-rfc-app-flotilla/"
|
||||||
|
"raw/branch/main/SPEC.md"
|
||||||
|
),
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
_DEFAULT_CONTENT_TTL_SEC = 300.0
|
||||||
|
|
||||||
|
# URL-safe slug. Matches `docs_sessions.py`'s `_SESSION_DIR_RE` spirit
|
||||||
|
# (rejecting anything that could resolve outside the intended layout)
|
||||||
|
# but with the lowercase-alphanumeric-plus-dash shape the manifest
|
||||||
|
# enforces. Path traversal (`..`), separators (`/`), tilde, uppercase,
|
||||||
|
# and whitespace all fail this regex; the route layer rejects 400
|
||||||
|
# before any cache or network call.
|
||||||
|
_NAME_RE = re.compile(r"^[a-z0-9-]+$")
|
||||||
|
|
||||||
|
_HTTP_TIMEOUT_SEC = 5.0
|
||||||
|
|
||||||
|
|
||||||
|
def _env_float(name: str, default: float) -> float:
|
||||||
|
raw = os.environ.get(name, "").strip()
|
||||||
|
if not raw:
|
||||||
|
return default
|
||||||
|
try:
|
||||||
|
return float(raw)
|
||||||
|
except ValueError:
|
||||||
|
log.warning("invalid %s=%r — falling back to %s", name, raw, default)
|
||||||
|
return default
|
||||||
|
|
||||||
|
|
||||||
|
def _content_ttl() -> float:
|
||||||
|
return _env_float("OHM_DOCS_SPECS_CONTENT_TTL_SEC", _DEFAULT_CONTENT_TTL_SEC)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_name(name: str) -> bool:
|
||||||
|
"""Slug guard for path-bound `name` parameters.
|
||||||
|
|
||||||
|
Mirrors `docs_sessions._is_valid_session_dir`'s contract: the
|
||||||
|
route layer calls this before any network or cache work, so a
|
||||||
|
malformed name never escapes the FastAPI surface.
|
||||||
|
"""
|
||||||
|
return bool(isinstance(name, str) and _NAME_RE.match(name))
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_spec_entry(entry: Any) -> dict[str, str] | None:
|
||||||
|
"""Validate a single manifest entry; return None if invalid.
|
||||||
|
|
||||||
|
Required fields: `name`, `title`, `url`. All three must be
|
||||||
|
non-empty strings; `name` must match `_NAME_RE`. The validator is
|
||||||
|
strict: an entry that fails any check is dropped from the manifest
|
||||||
|
(and the caller logs at warning level).
|
||||||
|
"""
|
||||||
|
if not isinstance(entry, dict):
|
||||||
|
return None
|
||||||
|
name = entry.get("name")
|
||||||
|
title = entry.get("title")
|
||||||
|
url = entry.get("url")
|
||||||
|
if not isinstance(name, str) or not _is_valid_name(name):
|
||||||
|
return None
|
||||||
|
if not isinstance(title, str) or not title.strip():
|
||||||
|
return None
|
||||||
|
if not isinstance(url, str) or not url.strip():
|
||||||
|
return None
|
||||||
|
return {"name": name, "title": title.strip(), "url": url.strip()}
|
||||||
|
|
||||||
|
|
||||||
|
def _load_configured_specs() -> list[dict[str, str]]:
|
||||||
|
"""Parse `OHM_DOCS_SPECS` (if set) or return the default list.
|
||||||
|
|
||||||
|
Malformed JSON or wrong-shape values log a warning and fall back
|
||||||
|
to the default — the deployment continues to render the spec
|
||||||
|
surface rather than crashing startup. The strict validation (each
|
||||||
|
entry's name slug, presence of all three fields) drops bad entries
|
||||||
|
one-by-one; if every entry is dropped, the default applies.
|
||||||
|
"""
|
||||||
|
raw = os.environ.get("OHM_DOCS_SPECS", "").strip()
|
||||||
|
if not raw:
|
||||||
|
return list(_DEFAULT_SPECS)
|
||||||
|
try:
|
||||||
|
parsed = json.loads(raw)
|
||||||
|
except (json.JSONDecodeError, ValueError) as e:
|
||||||
|
log.warning(
|
||||||
|
"OHM_DOCS_SPECS is not valid JSON (%s) — falling back to default", e
|
||||||
|
)
|
||||||
|
return list(_DEFAULT_SPECS)
|
||||||
|
if not isinstance(parsed, list):
|
||||||
|
log.warning(
|
||||||
|
"OHM_DOCS_SPECS must be a JSON array — falling back to default"
|
||||||
|
)
|
||||||
|
return list(_DEFAULT_SPECS)
|
||||||
|
out: list[dict[str, str]] = []
|
||||||
|
seen: set[str] = set()
|
||||||
|
for entry in parsed:
|
||||||
|
validated = _parse_spec_entry(entry)
|
||||||
|
if validated is None:
|
||||||
|
log.warning(
|
||||||
|
"OHM_DOCS_SPECS entry %r failed validation — dropped", entry
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
if validated["name"] in seen:
|
||||||
|
log.warning(
|
||||||
|
"OHM_DOCS_SPECS has duplicate name %r — dropped", validated["name"]
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
seen.add(validated["name"])
|
||||||
|
out.append(validated)
|
||||||
|
if not out:
|
||||||
|
log.warning(
|
||||||
|
"OHM_DOCS_SPECS yielded no valid entries — falling back to default"
|
||||||
|
)
|
||||||
|
return list(_DEFAULT_SPECS)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# In-process TTL cache
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
#
|
||||||
|
# Same shape as `docs_sessions.py`: plain dict + `time.monotonic()` check,
|
||||||
|
# no external dep. The cache value is a `(stored_at, payload)` tuple;
|
||||||
|
# `payload` may carry an error-shape sentinel for negative caching (404s).
|
||||||
|
# Lock guards read-modify-write across worker tasks; entries are immutable
|
||||||
|
# once stored so reads under the lock are fast.
|
||||||
|
|
||||||
|
_lock = threading.Lock()
|
||||||
|
_cache: dict[str, tuple[float, dict[str, Any]]] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _cache_get(key: str, ttl_sec: float) -> dict[str, Any] | None:
|
||||||
|
with _lock:
|
||||||
|
entry = _cache.get(key)
|
||||||
|
if entry is None:
|
||||||
|
return None
|
||||||
|
stored_at, payload = entry
|
||||||
|
if time.monotonic() - stored_at > ttl_sec:
|
||||||
|
return None
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _cache_put(key: str, payload: dict[str, Any]) -> None:
|
||||||
|
with _lock:
|
||||||
|
_cache[key] = (time.monotonic(), payload)
|
||||||
|
|
||||||
|
|
||||||
|
def reset_cache() -> None:
|
||||||
|
"""Drop every cached entry. Test seam — not called in production."""
|
||||||
|
with _lock:
|
||||||
|
_cache.clear()
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Public fetch surface
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
#
|
||||||
|
# Each fetcher returns a `{status, ...}` dict, same convention as
|
||||||
|
# `docs_sessions.py`:
|
||||||
|
# "ok" — payload field carries the body / manifest
|
||||||
|
# "404" — gitea returned 404 (or the configured name doesn't exist)
|
||||||
|
# "error" — gitea returned 5xx, timed out, or returned malformed data
|
||||||
|
#
|
||||||
|
# The route layer maps these onto HTTP responses; keeping the mapping
|
||||||
|
# out of this module makes the cache transparent to the test harness.
|
||||||
|
|
||||||
|
|
||||||
|
async def _http_get(url: str) -> tuple[int, str]:
|
||||||
|
"""Perform a single GET against `url`; return (status_code, body).
|
||||||
|
|
||||||
|
On timeout or network error, returns (599, error_message). The 599
|
||||||
|
pseudo-status maps to a 502 at the route layer the same way an
|
||||||
|
upstream 5xx does — the caller doesn't care which leg of the
|
||||||
|
network broke.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
async with httpx.AsyncClient(timeout=_HTTP_TIMEOUT_SEC) as client:
|
||||||
|
r = await client.get(url)
|
||||||
|
return r.status_code, r.text
|
||||||
|
except httpx.HTTPError as e:
|
||||||
|
log.warning("specs fetch failed for %s: %s", url, e)
|
||||||
|
return 599, f"fetch error: {e}"
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_specs_manifest() -> dict[str, Any]:
|
||||||
|
"""Return the configured spec manifest.
|
||||||
|
|
||||||
|
The manifest is derived from the `OHM_DOCS_SPECS` env var (or the
|
||||||
|
framework default if unset / malformed) and carries no network
|
||||||
|
work — it's safe to call on every request. The return shape mirrors
|
||||||
|
the docs_sessions manifest endpoint for frontend consistency:
|
||||||
|
|
||||||
|
{"status": "ok", "specs": [{"name", "title", "url"}, ...]}
|
||||||
|
|
||||||
|
The "url" field is exposed in the manifest so the frontend can
|
||||||
|
offer a "view source on gitea" affordance alongside each rendered
|
||||||
|
spec (operator-stated intent: "include the history so you can see
|
||||||
|
it in git" — that gesture lives in the source link, not on the
|
||||||
|
rendered page).
|
||||||
|
"""
|
||||||
|
specs = _load_configured_specs()
|
||||||
|
return {"status": "ok", "specs": specs}
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_spec(name: str) -> dict[str, Any]:
|
||||||
|
"""Fetch a single spec body by its manifest `name`.
|
||||||
|
|
||||||
|
The caller is expected to have validated `name` against
|
||||||
|
`_is_valid_name` before calling this — an invalid name shouldn't
|
||||||
|
reach the network. We re-check inside as defense-in-depth: a
|
||||||
|
bogus name here returns the same `{status: "404"}` shape so the
|
||||||
|
route layer's `404 → HTTP 404` mapping handles it uniformly.
|
||||||
|
|
||||||
|
Returns one of:
|
||||||
|
{"status": "ok", "body": "..."}
|
||||||
|
{"status": "404"} — no such spec OR upstream 404
|
||||||
|
{"status": "error", "detail": "..."} — upstream 5xx / timeout
|
||||||
|
"""
|
||||||
|
if not _is_valid_name(name):
|
||||||
|
return {"status": "404"}
|
||||||
|
|
||||||
|
cache_key = f"spec:{name}"
|
||||||
|
cached = _cache_get(cache_key, _content_ttl())
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
specs = _load_configured_specs()
|
||||||
|
match = next((s for s in specs if s["name"] == name), None)
|
||||||
|
if match is None:
|
||||||
|
# Cache the negative — a deployment with an unstable manifest
|
||||||
|
# would still benefit from the TTL window, and the cached 404
|
||||||
|
# is automatically displaced when the next request happens
|
||||||
|
# after TTL expiry.
|
||||||
|
payload: dict[str, Any] = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
url = match["url"]
|
||||||
|
status, body = await _http_get(url)
|
||||||
|
|
||||||
|
if status == 200:
|
||||||
|
payload = {"status": "ok", "body": body}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
if status == 404:
|
||||||
|
payload = {"status": "404"}
|
||||||
|
_cache_put(cache_key, payload)
|
||||||
|
return payload
|
||||||
|
return {"status": "error", "detail": f"upstream returned {status}"}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
-- Roadmap #26 (rfc-app v0.22.0): the optional "What will you be using
|
||||||
|
-- this for?" capture on the two propose surfaces.
|
||||||
|
--
|
||||||
|
-- The roadmap's framing names "the rfcs table" and "the PR-metadata
|
||||||
|
-- table" for a `proposed_use_case TEXT NULL` column. In this deployment
|
||||||
|
-- those two surfaces are the cache tables `cached_rfcs` and `cached_prs`
|
||||||
|
-- (002_cache.sql). We add the nullable column to each, matching the
|
||||||
|
-- existing naming convention (no NOT NULL, no default — NULL is the
|
||||||
|
-- "left blank" sentinel the view surfaces render tastefully).
|
||||||
|
--
|
||||||
|
-- BUT: those tables are *cache*, rebuilt from Gitea by the §4.1
|
||||||
|
-- reconciler (cache.py). The reconciler's INSERT...ON CONFLICT DO UPDATE
|
||||||
|
-- sets only the columns it knows about, so an unlisted column is
|
||||||
|
-- preserved on the update path — yet a propose/open never *writes* the
|
||||||
|
-- column through the cache (the write path is endpoint -> Gitea ->
|
||||||
|
-- reconcile, and the reconciler does not carry this field). So the cache
|
||||||
|
-- column alone would always read NULL.
|
||||||
|
--
|
||||||
|
-- The durable home is therefore a dedicated app-truth table the propose
|
||||||
|
-- /open endpoints write directly (keyed by the PR number, which is the
|
||||||
|
-- stable identity for both idea PRs and rfc_branch PRs) and the view
|
||||||
|
-- endpoints read back. This is not cache — it is canonical and survives
|
||||||
|
-- any reconcile. The cache columns are added too for parity with the
|
||||||
|
-- roadmap's literal shape and for any future reconciler that learns to
|
||||||
|
-- carry the field, but the side table is the source of truth read at
|
||||||
|
-- view time.
|
||||||
|
|
||||||
|
ALTER TABLE cached_rfcs ADD COLUMN proposed_use_case TEXT;
|
||||||
|
ALTER TABLE cached_prs ADD COLUMN proposed_use_case TEXT;
|
||||||
|
|
||||||
|
-- Canonical, reconcile-proof store. One row per propose/open that
|
||||||
|
-- supplied a use case. `scope` distinguishes the propose-RFC surface
|
||||||
|
-- ('rfc') from the propose-PR-against-an-RFC surface ('pr'); `pr_number`
|
||||||
|
-- is the join key the endpoints already have in hand. NULL/omitted use
|
||||||
|
-- cases simply never write a row here, so absence == "left blank".
|
||||||
|
CREATE TABLE proposed_use_cases (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
scope TEXT NOT NULL CHECK (scope IN ('rfc', 'pr')),
|
||||||
|
rfc_slug TEXT NOT NULL,
|
||||||
|
pr_number INTEGER NOT NULL,
|
||||||
|
use_case TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
UNIQUE (scope, pr_number)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX idx_proposed_use_cases_lookup ON proposed_use_cases (scope, pr_number);
|
||||||
|
CREATE INDEX idx_proposed_use_cases_slug ON proposed_use_cases (scope, rfc_slug);
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
-- v0.23.0 / roadmap item #29: server-side sign-in state resume.
|
||||||
|
--
|
||||||
|
-- Track each authenticated user's last-viewed route + a small bag of
|
||||||
|
-- "light" component state so that the *next* sign-in can land the user
|
||||||
|
-- back where they left off, rather than always dropping them on the
|
||||||
|
-- empty-state home view.
|
||||||
|
--
|
||||||
|
-- Storage shape (one row per user — per-user, NOT per-device, per the
|
||||||
|
-- #29 "safe default"):
|
||||||
|
--
|
||||||
|
-- * `user_id` — PRIMARY KEY and FK into users(id) with cascade on
|
||||||
|
-- delete. INTEGER to match users.id (INTEGER PRIMARY KEY
|
||||||
|
-- AUTOINCREMENT). A deleted user automatically loses their stored
|
||||||
|
-- resume state. One row per user means a later sign-in on any
|
||||||
|
-- device resumes the most-recently-recorded route — the per-user
|
||||||
|
-- model the roadmap asks for.
|
||||||
|
--
|
||||||
|
-- * `last_route` — the frontend pathname the user was last on
|
||||||
|
-- (e.g. "/rfc/open-human-model"). TEXT, nullable until the first
|
||||||
|
-- route-change POST lands. NEVER contains draft-buffer contents —
|
||||||
|
-- it is a route only. See SPEC §6.2 "Sign-in state resume
|
||||||
|
-- (privacy)".
|
||||||
|
--
|
||||||
|
-- * `last_route_state` — a JSON-encoded bag of *light* component
|
||||||
|
-- state (scroll anchors, open-tab selection, filter chips, etc.).
|
||||||
|
-- SQLite has no native JSONB; we store JSON as TEXT exactly as the
|
||||||
|
-- rest of the app stores its JSON blobs (json.dumps / json.loads,
|
||||||
|
-- cf. permission_events.details, actions.details). Nullable.
|
||||||
|
-- PRIVACY INVARIANT: this column MUST NOT carry draft-buffer text,
|
||||||
|
-- PR bodies, comment drafts, or any user-typed content — only
|
||||||
|
-- ephemeral view state safe to replay. The PUT handler is the
|
||||||
|
-- enforcement point; the column comment is the contract.
|
||||||
|
--
|
||||||
|
-- * `resume_enabled` — the per-user opt-out flag. 1 (default) means
|
||||||
|
-- "resume me where I left off"; 0 means "always land on home". The
|
||||||
|
-- PUT handler no-ops the upsert when this is 0, and the read path
|
||||||
|
-- refuses to hand back a stored route when this is 0. A
|
||||||
|
-- profile-settings toggle UI to flip this is a follow-up (the
|
||||||
|
-- column + default-on behavior ship now); see CHANGELOG v0.23.0.
|
||||||
|
--
|
||||||
|
-- * `last_updated_at` — TEXT timestamp, app convention
|
||||||
|
-- `datetime('now')`, matching device_trust.last_seen_at /
|
||||||
|
-- users.last_seen_at. Refreshed on every successful upsert.
|
||||||
|
--
|
||||||
|
-- No new env vars. The debounce interval for the frontend route-change
|
||||||
|
-- POST is a frontend constant (~1s), not a server knob.
|
||||||
|
|
||||||
|
CREATE TABLE user_session_state (
|
||||||
|
user_id INTEGER PRIMARY KEY REFERENCES users(id) ON DELETE CASCADE,
|
||||||
|
last_route TEXT,
|
||||||
|
last_route_state TEXT, -- JSON-encoded light state, nullable
|
||||||
|
resume_enabled INTEGER NOT NULL DEFAULT 1,
|
||||||
|
last_updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
@@ -0,0 +1,379 @@
|
|||||||
|
"""v0.19.0 / roadmap item #30 — `/api/docs/sessions/*` endpoints.
|
||||||
|
|
||||||
|
The framework mediates reads against the public
|
||||||
|
`wiggleverse/ohm-session-history` gitea repo so the rendered
|
||||||
|
`/docs/sessions/*` surface inherits the same chrome as `/docs/user-guide`.
|
||||||
|
This test suite covers the four endpoints + the in-process TTL cache,
|
||||||
|
mocking the upstream HTTP via `httpx.MockTransport` (the same shape the
|
||||||
|
rest of the test suite uses for Gitea).
|
||||||
|
|
||||||
|
The tests do NOT spin up the full FakeGitea — they only need to mock
|
||||||
|
the gitea raw URL surface (and the contents API for the session-index
|
||||||
|
endpoint). Each test owns its mock transport so we can dial in 200 /
|
||||||
|
404 / 5xx / timeout responses per case.
|
||||||
|
|
||||||
|
Path-validation tests intentionally bypass the network — a malformed
|
||||||
|
`nnnn` or `filename` MUST be rejected at the route layer before any
|
||||||
|
upstream call is made.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from app import docs_sessions
|
||||||
|
|
||||||
|
# Reuse the proven app-construction fixtures from the proposal vertical
|
||||||
|
# (same shape every test file in this repo uses).
|
||||||
|
from test_propose_vertical import ( # noqa: F401
|
||||||
|
app_with_fake_gitea,
|
||||||
|
tmp_env,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Test scaffolding
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
class _UpstreamHandler:
|
||||||
|
"""Records every URL the docs_sessions module fetched and returns
|
||||||
|
canned responses keyed by URL substring. Allows the test to assert
|
||||||
|
on call count (for cache verification) without needing a full Gitea
|
||||||
|
simulator.
|
||||||
|
|
||||||
|
`calls` tracks only URLs that hit the session-history host (the
|
||||||
|
`OHM_SESSION_HISTORY_*` bases) so reconciler/Gitea-side calls — which
|
||||||
|
also pass through this handler because `httpx.AsyncClient` is a
|
||||||
|
shared attribute the gitea-side fixture also monkeypatches — don't
|
||||||
|
inflate the count we use for cache-hit assertions.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_SESSION_HOST_MARKERS = ("ohm-session-history", "wiggleverse/ohm-session-history")
|
||||||
|
|
||||||
|
def __init__(self, responses: dict[str, tuple[int, str]]):
|
||||||
|
self.responses = responses
|
||||||
|
self.calls: list[str] = []
|
||||||
|
|
||||||
|
def __call__(self, request: httpx.Request) -> httpx.Response:
|
||||||
|
url = str(request.url)
|
||||||
|
if any(m in url for m in self._SESSION_HOST_MARKERS):
|
||||||
|
self.calls.append(url)
|
||||||
|
for key, (status, body) in self.responses.items():
|
||||||
|
if key in url:
|
||||||
|
return httpx.Response(status, text=body)
|
||||||
|
# Default: 404. Lets tests skip declaring "the rest is 404".
|
||||||
|
return httpx.Response(404, text="not found")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def patched_httpx(monkeypatch):
|
||||||
|
"""Provide a hook the test can call to install a MockTransport.
|
||||||
|
|
||||||
|
Returns a closure: `install(handler)` patches
|
||||||
|
`app.docs_sessions.httpx.AsyncClient` so every constructed client
|
||||||
|
uses the handler's transport.
|
||||||
|
|
||||||
|
NB: the upstream `app_with_fake_gitea` fixture also patches
|
||||||
|
`httpx.AsyncClient` (to route gitea calls to a FakeGitea handler),
|
||||||
|
and because `httpx` is a single shared module, that patch mutates
|
||||||
|
the *same* `AsyncClient` attribute we're about to overwrite. We
|
||||||
|
therefore import the unpatched class directly from the
|
||||||
|
`httpx._client` module so our install path can construct a fresh
|
||||||
|
real client around our MockTransport without going through the
|
||||||
|
FakeGitea wrapper.
|
||||||
|
"""
|
||||||
|
from httpx._client import AsyncClient as RealAsyncClient
|
||||||
|
|
||||||
|
def install(handler):
|
||||||
|
def patched(*args, **kwargs):
|
||||||
|
kwargs["transport"] = httpx.MockTransport(handler)
|
||||||
|
return RealAsyncClient(*args, **kwargs)
|
||||||
|
|
||||||
|
monkeypatch.setattr("app.docs_sessions.httpx.AsyncClient", patched)
|
||||||
|
return handler
|
||||||
|
|
||||||
|
yield install
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def app(app_with_fake_gitea):
|
||||||
|
"""Wrap the shared app fixture, resetting the docs-sessions cache so
|
||||||
|
cross-test state can't leak. Returns just the FastAPI app — the
|
||||||
|
fake-Gitea handle is irrelevant for the docs-sessions surface.
|
||||||
|
"""
|
||||||
|
docs_sessions.reset_cache()
|
||||||
|
fastapi_app, _fake = app_with_fake_gitea
|
||||||
|
return fastapi_app
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Manifest endpoint
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_happy_path(app, patched_httpx):
|
||||||
|
manifest_body = json.dumps(
|
||||||
|
{
|
||||||
|
"0001": {"title": "Bootstrap"},
|
||||||
|
"0014": {"title": "Wave 7 driver"},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
patched_httpx(
|
||||||
|
_UpstreamHandler({"sessions.json": (200, manifest_body)})
|
||||||
|
)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
payload = r.json()
|
||||||
|
assert payload == {
|
||||||
|
"0001": {"title": "Bootstrap"},
|
||||||
|
"0014": {"title": "Wave 7 driver"},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_empty_state(app, patched_httpx):
|
||||||
|
"""A 404 from gitea means the manifest hasn't been published yet.
|
||||||
|
The endpoint returns HTTP 200 + `{}` so the frontend can render the
|
||||||
|
no-sessions-yet state without an error banner.
|
||||||
|
"""
|
||||||
|
patched_httpx(_UpstreamHandler({"sessions.json": (404, "not found")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
assert r.json() == {}
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_upstream_5xx_returns_502(app, patched_httpx):
|
||||||
|
patched_httpx(_UpstreamHandler({"sessions.json": (500, "internal")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/manifest")
|
||||||
|
assert r.status_code == 502, r.text
|
||||||
|
body = r.json()
|
||||||
|
assert body["detail"]["error"] == "session-history fetch failed"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# About endpoint
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_about_happy_path(app, patched_httpx):
|
||||||
|
readme = "# OHM session history\n\nWelcome.\n"
|
||||||
|
patched_httpx(_UpstreamHandler({"README.md": (200, readme)}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/about")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
assert "text/markdown" in r.headers["content-type"]
|
||||||
|
assert r.text == readme
|
||||||
|
|
||||||
|
|
||||||
|
def test_about_404(app, patched_httpx):
|
||||||
|
patched_httpx(_UpstreamHandler({"README.md": (404, "")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/about")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_about_upstream_5xx_returns_502(app, patched_httpx):
|
||||||
|
patched_httpx(_UpstreamHandler({"README.md": (503, "down")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/about")
|
||||||
|
assert r.status_code == 502, r.text
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Transcript endpoint
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_happy_path(app, patched_httpx):
|
||||||
|
body = "# Session 0017.1 — Transcript\n\nbody.\n"
|
||||||
|
fname = "SESSION-0017.1-TRANSCRIPT-2026-05-28T08-50--2026-05-28T11-20.md"
|
||||||
|
patched_httpx(_UpstreamHandler({fname: (200, body)}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get(f"/api/docs/sessions/0017/{fname}")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
assert "text/markdown" in r.headers["content-type"]
|
||||||
|
assert r.text == body
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_404(app, patched_httpx):
|
||||||
|
fname = "SESSION-9999.0-TRANSCRIPT-2026-01-01T00-00--2026-01-01T00-01.md"
|
||||||
|
patched_httpx(_UpstreamHandler({})) # everything 404s
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get(f"/api/docs/sessions/9999/{fname}")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_rejects_invalid_session_dir(app, patched_httpx):
|
||||||
|
"""`nnnn` must be exactly 4 digits. `abcd` fails before any
|
||||||
|
network call.
|
||||||
|
"""
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get(
|
||||||
|
"/api/docs/sessions/abcd/"
|
||||||
|
"SESSION-0001.0-TRANSCRIPT-2026-01-01T00-00--2026-01-01T00-01.md"
|
||||||
|
)
|
||||||
|
assert r.status_code == 400, r.text
|
||||||
|
assert handler.calls == [], "rejected path must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_rejects_path_traversal(app, patched_httpx):
|
||||||
|
"""A filename that doesn't match the SESSION-NNNN.M-TRANSCRIPT regex
|
||||||
|
is rejected. `../etc/passwd` doesn't match; neither does the legacy
|
||||||
|
flat-root `SESSION-A-TRANSCRIPT.md`.
|
||||||
|
"""
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
# Path traversal — but FastAPI normalizes `..` in the path before
|
||||||
|
# routing, so this resolves to /api/docs/sessions/0001/etc/passwd
|
||||||
|
# which routes to the same handler with filename=etc/passwd, and
|
||||||
|
# gets rejected as an invalid transcript filename. Even if the
|
||||||
|
# normalization didn't apply (some intermediary), the regex
|
||||||
|
# check rejects anything not matching the SESSION- prefix.
|
||||||
|
r = client.get(
|
||||||
|
"/api/docs/sessions/0001/etc%2Fpasswd"
|
||||||
|
)
|
||||||
|
# 400 (filename validation) or 404 (path didn't match the
|
||||||
|
# route); both reject before any network call. Either is
|
||||||
|
# acceptable — what matters is that we never fetched it.
|
||||||
|
assert r.status_code in (400, 404), r.text
|
||||||
|
assert handler.calls == [], "rejected path must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_rejects_legacy_flat_filename(app, patched_httpx):
|
||||||
|
"""Legacy `SESSION-A-TRANSCRIPT.md` (letter form) doesn't match the
|
||||||
|
numeric regex — by design, since post-#23 transcripts live in
|
||||||
|
`NNNN/` folders with numeric names. Reject 400.
|
||||||
|
"""
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/0001/SESSION-A-TRANSCRIPT.md")
|
||||||
|
assert r.status_code == 400, r.text
|
||||||
|
assert handler.calls == [], "rejected path must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_upstream_5xx_returns_502(app, patched_httpx):
|
||||||
|
fname = "SESSION-0001.0-TRANSCRIPT-2026-01-01T00-00--2026-01-01T00-01.md"
|
||||||
|
patched_httpx(_UpstreamHandler({fname: (502, "bad gateway")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get(f"/api/docs/sessions/0001/{fname}")
|
||||||
|
assert r.status_code == 502, r.text
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Session-index endpoint
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_session_index_happy_path(app, patched_httpx):
|
||||||
|
"""The contents API returns a JSON list of file entries. The
|
||||||
|
endpoint filters to entries that match the transcript regex and
|
||||||
|
sorts them.
|
||||||
|
"""
|
||||||
|
# Two transcripts (driver + subagent) + a non-transcript sibling
|
||||||
|
# that must be filtered out.
|
||||||
|
listing = json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "SESSION-0017.0-TRANSCRIPT-"
|
||||||
|
"2026-05-28T08-30--2026-05-28T12-00.md",
|
||||||
|
"type": "file",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "SESSION-0017.1-TRANSCRIPT-"
|
||||||
|
"2026-05-28T08-50--2026-05-28T11-20.md",
|
||||||
|
"type": "file",
|
||||||
|
},
|
||||||
|
{"name": "notes.md", "type": "file"}, # not a transcript
|
||||||
|
{"name": "attached-dir", "type": "dir"}, # not a file
|
||||||
|
]
|
||||||
|
)
|
||||||
|
patched_httpx(_UpstreamHandler({"/contents/0017": (200, listing)}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/0017/index")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
files = r.json()["files"]
|
||||||
|
assert files == [
|
||||||
|
"SESSION-0017.0-TRANSCRIPT-2026-05-28T08-30--2026-05-28T12-00.md",
|
||||||
|
"SESSION-0017.1-TRANSCRIPT-2026-05-28T08-50--2026-05-28T11-20.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_session_index_404(app, patched_httpx):
|
||||||
|
patched_httpx(_UpstreamHandler({})) # everything 404s
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/9999/index")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_session_index_rejects_invalid_session_dir(app, patched_httpx):
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/sessions/abc/index")
|
||||||
|
assert r.status_code == 400, r.text
|
||||||
|
assert handler.calls == [], "rejected path must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Cache behavior
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_cache_hits_within_ttl(app, patched_httpx, monkeypatch):
|
||||||
|
"""Two consecutive manifest calls within the TTL window should
|
||||||
|
issue exactly one HTTP request to gitea.
|
||||||
|
"""
|
||||||
|
# Generous TTL so the test never races.
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SESSIONS_MANIFEST_TTL_SEC", "60")
|
||||||
|
handler = _UpstreamHandler(
|
||||||
|
{"sessions.json": (200, json.dumps({"0001": {"title": "x"}}))}
|
||||||
|
)
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r1 = client.get("/api/docs/sessions/manifest")
|
||||||
|
r2 = client.get("/api/docs/sessions/manifest")
|
||||||
|
assert r1.status_code == 200
|
||||||
|
assert r2.status_code == 200
|
||||||
|
assert len(handler.calls) == 1, (
|
||||||
|
f"expected one upstream call, got {handler.calls}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_cache_hits_within_ttl(app, patched_httpx, monkeypatch):
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SESSIONS_CONTENT_TTL_SEC", "300")
|
||||||
|
fname = "SESSION-0001.0-TRANSCRIPT-2026-01-01T00-00--2026-01-01T00-01.md"
|
||||||
|
handler = _UpstreamHandler({fname: (200, "# body\n")})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r1 = client.get(f"/api/docs/sessions/0001/{fname}")
|
||||||
|
r2 = client.get(f"/api/docs/sessions/0001/{fname}")
|
||||||
|
assert r1.status_code == 200
|
||||||
|
assert r2.status_code == 200
|
||||||
|
assert len(handler.calls) == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_transcript_404_is_cached(app, patched_httpx, monkeypatch):
|
||||||
|
"""Negative caching: a 404 result is cached at the content TTL so a
|
||||||
|
deployment with no published transcripts doesn't hammer gitea on
|
||||||
|
every navigation. Documented in `docs_sessions.fetch_transcript`.
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SESSIONS_CONTENT_TTL_SEC", "300")
|
||||||
|
fname = "SESSION-9999.0-TRANSCRIPT-2026-01-01T00-00--2026-01-01T00-01.md"
|
||||||
|
handler = _UpstreamHandler({}) # everything 404s
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r1 = client.get(f"/api/docs/sessions/9999/{fname}")
|
||||||
|
r2 = client.get(f"/api/docs/sessions/9999/{fname}")
|
||||||
|
assert r1.status_code == 404
|
||||||
|
assert r2.status_code == 404
|
||||||
|
assert len(handler.calls) == 1, "negative caching should suppress the 2nd call"
|
||||||
@@ -0,0 +1,469 @@
|
|||||||
|
"""v0.20.0 — `/api/docs/specs/*` endpoints.
|
||||||
|
|
||||||
|
Sibling of `test_docs_sessions_vertical.py`. The framework mediates
|
||||||
|
reads of the configured framework-spec URLs (default: rfc-app's own
|
||||||
|
SPEC.md + flotilla's SPEC.md on `git.wiggleverse.org`) so the
|
||||||
|
`/docs/specs/*` surface inherits the same chrome as
|
||||||
|
`/docs/user-guide` and `/docs/sessions/*`.
|
||||||
|
|
||||||
|
This file covers:
|
||||||
|
|
||||||
|
- The manifest endpoint with the framework default
|
||||||
|
- The manifest endpoint with an overridden `OHM_DOCS_SPECS` JSON value
|
||||||
|
- Slug validation at the route layer (rejects `..`, `/`, `~`,
|
||||||
|
uppercase, whitespace, path traversal attempts)
|
||||||
|
- Gitea 200 / 404 / 5xx response mapping
|
||||||
|
- Negative caching (404 is cached, not re-fetched within TTL)
|
||||||
|
- Malformed `OHM_DOCS_SPECS` → fallback to the default + a logged
|
||||||
|
warning (asserted by caplog)
|
||||||
|
- A manifest entry that fails per-entry validation (bad slug,
|
||||||
|
missing field) is dropped, with the rest of the list retained
|
||||||
|
|
||||||
|
Mocking approach: same as docs_sessions — `httpx.MockTransport`
|
||||||
|
substituted into `app.docs_specs.httpx.AsyncClient` via a fixture.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from app import docs_specs
|
||||||
|
|
||||||
|
# Reuse the proven app-construction fixtures from the proposal vertical
|
||||||
|
# (same shape every test file in this repo uses).
|
||||||
|
from test_propose_vertical import ( # noqa: F401
|
||||||
|
app_with_fake_gitea,
|
||||||
|
tmp_env,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Test scaffolding
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
class _UpstreamHandler:
|
||||||
|
"""Records every URL the docs_specs module fetched and returns
|
||||||
|
canned responses keyed by URL substring. Lets the test assert on
|
||||||
|
call count (for cache verification) without booting a full upstream
|
||||||
|
simulator.
|
||||||
|
|
||||||
|
`calls` tracks only URLs that hit a host configured in the spec
|
||||||
|
manifest under test — so unrelated httpx clients (gitea-side
|
||||||
|
fixtures, etc.) don't inflate the count we use for cache-hit
|
||||||
|
assertions. We marker-match on substrings the manifest carries.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
responses: dict[str, tuple[int, str]],
|
||||||
|
host_markers: tuple[str, ...] = ("rfc-app", "flotilla", "specs.example"),
|
||||||
|
):
|
||||||
|
self.responses = responses
|
||||||
|
self.host_markers = host_markers
|
||||||
|
self.calls: list[str] = []
|
||||||
|
|
||||||
|
def __call__(self, request: httpx.Request) -> httpx.Response:
|
||||||
|
url = str(request.url)
|
||||||
|
if any(m in url for m in self.host_markers):
|
||||||
|
self.calls.append(url)
|
||||||
|
for key, (status, body) in self.responses.items():
|
||||||
|
if key in url:
|
||||||
|
return httpx.Response(status, text=body)
|
||||||
|
# Default: 404. Lets tests skip declaring "the rest is 404".
|
||||||
|
return httpx.Response(404, text="not found")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def patched_httpx(monkeypatch):
|
||||||
|
"""Provide a hook the test can call to install a MockTransport.
|
||||||
|
|
||||||
|
Same shape as the docs_sessions fixture — `app_with_fake_gitea`
|
||||||
|
monkeypatches `httpx.AsyncClient` for the gitea side, so we
|
||||||
|
construct from the unpatched class directly to avoid the
|
||||||
|
FakeGitea wrapper.
|
||||||
|
"""
|
||||||
|
from httpx._client import AsyncClient as RealAsyncClient
|
||||||
|
|
||||||
|
def install(handler):
|
||||||
|
def patched(*args, **kwargs):
|
||||||
|
kwargs["transport"] = httpx.MockTransport(handler)
|
||||||
|
return RealAsyncClient(*args, **kwargs)
|
||||||
|
|
||||||
|
monkeypatch.setattr("app.docs_specs.httpx.AsyncClient", patched)
|
||||||
|
return handler
|
||||||
|
|
||||||
|
yield install
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def app(app_with_fake_gitea):
|
||||||
|
"""Reset the docs-specs cache so cross-test state can't leak."""
|
||||||
|
docs_specs.reset_cache()
|
||||||
|
fastapi_app, _fake = app_with_fake_gitea
|
||||||
|
return fastapi_app
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Manifest endpoint
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_default(app, monkeypatch):
|
||||||
|
"""With `OHM_DOCS_SPECS` unset, the manifest endpoint returns the
|
||||||
|
framework default (rfc-app + flotilla).
|
||||||
|
"""
|
||||||
|
monkeypatch.delenv("OHM_DOCS_SPECS", raising=False)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
payload = r.json()
|
||||||
|
assert "specs" in payload
|
||||||
|
names = [s["name"] for s in payload["specs"]]
|
||||||
|
assert names == ["rfc-app", "flotilla"]
|
||||||
|
# The default URLs point at the OHM-canonical gitea raw paths.
|
||||||
|
assert all("git.wiggleverse.org" in s["url"] for s in payload["specs"])
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_overridden(app, monkeypatch):
|
||||||
|
"""A deployment overriding `OHM_DOCS_SPECS` gets its custom list.
|
||||||
|
|
||||||
|
The manifest is parsed per-request from the env var (no startup
|
||||||
|
binding) so a runtime overlay change is visible without a
|
||||||
|
restart — same shape as the docs_sessions env knobs.
|
||||||
|
"""
|
||||||
|
custom = json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "custom-spec",
|
||||||
|
"title": "Custom Spec",
|
||||||
|
"url": "https://specs.example.org/CUSTOM.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
)
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS", custom)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
payload = r.json()
|
||||||
|
assert payload == {
|
||||||
|
"specs": [
|
||||||
|
{
|
||||||
|
"name": "custom-spec",
|
||||||
|
"title": "Custom Spec",
|
||||||
|
"url": "https://specs.example.org/CUSTOM.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_malformed_json_falls_back(app, monkeypatch, caplog):
|
||||||
|
"""A non-JSON value in `OHM_DOCS_SPECS` logs a warning and the
|
||||||
|
endpoint falls back to the framework default. Startup is
|
||||||
|
unaffected — the deployment continues to render the spec surface
|
||||||
|
rather than crashing on the typo.
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS", "{not-json")
|
||||||
|
with caplog.at_level(logging.WARNING, logger="app.docs_specs"):
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
payload = r.json()
|
||||||
|
names = [s["name"] for s in payload["specs"]]
|
||||||
|
assert names == ["rfc-app", "flotilla"]
|
||||||
|
assert any(
|
||||||
|
"OHM_DOCS_SPECS is not valid JSON" in rec.message
|
||||||
|
for rec in caplog.records
|
||||||
|
), f"expected a logged warning; got {[r.message for r in caplog.records]}"
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_non_list_falls_back(app, monkeypatch, caplog):
|
||||||
|
"""`OHM_DOCS_SPECS` must be a JSON array. A JSON object (or any
|
||||||
|
non-list value) falls back to the default + logs a warning.
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS", json.dumps({"name": "not-a-list"}))
|
||||||
|
with caplog.at_level(logging.WARNING, logger="app.docs_specs"):
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
names = [s["name"] for s in r.json()["specs"]]
|
||||||
|
assert names == ["rfc-app", "flotilla"]
|
||||||
|
assert any(
|
||||||
|
"must be a JSON array" in rec.message for rec in caplog.records
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_drops_invalid_entry_keeps_valid(app, monkeypatch, caplog):
|
||||||
|
"""Per-entry validation: an entry with a bad slug or missing field
|
||||||
|
is dropped; valid entries in the same list are retained.
|
||||||
|
"""
|
||||||
|
custom = json.dumps(
|
||||||
|
[
|
||||||
|
{"name": "Bad Slug", "title": "Bad", "url": "https://x"}, # uppercase + space
|
||||||
|
{"name": "..", "title": "Traversal", "url": "https://x"}, # path traversal
|
||||||
|
{"name": "missing-url", "title": "Missing URL"}, # no url
|
||||||
|
{
|
||||||
|
"name": "good-spec",
|
||||||
|
"title": "Good",
|
||||||
|
"url": "https://specs.example.org/GOOD.md",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
)
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS", custom)
|
||||||
|
with caplog.at_level(logging.WARNING, logger="app.docs_specs"):
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
names = [s["name"] for s in r.json()["specs"]]
|
||||||
|
assert names == ["good-spec"]
|
||||||
|
# Three drop warnings (one per bad entry).
|
||||||
|
drops = [r for r in caplog.records if "failed validation" in r.message]
|
||||||
|
assert len(drops) == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_all_invalid_falls_back(app, monkeypatch, caplog):
|
||||||
|
"""If every entry is dropped, the framework default applies (the
|
||||||
|
surface never goes empty due to a bad overlay).
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps([{"name": "BAD"}, {"name": "..", "title": "x", "url": "y"}]),
|
||||||
|
)
|
||||||
|
with caplog.at_level(logging.WARNING, logger="app.docs_specs"):
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
names = [s["name"] for s in r.json()["specs"]]
|
||||||
|
assert names == ["rfc-app", "flotilla"]
|
||||||
|
assert any(
|
||||||
|
"yielded no valid entries" in rec.message for rec in caplog.records
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_drops_duplicate_names(app, monkeypatch, caplog):
|
||||||
|
"""A duplicate `name` is dropped (the first occurrence wins). The
|
||||||
|
route layer's `/api/docs/specs/{name}` path lookup is by name, so
|
||||||
|
duplicates would otherwise be ambiguous.
|
||||||
|
"""
|
||||||
|
custom = json.dumps(
|
||||||
|
[
|
||||||
|
{"name": "x", "title": "First", "url": "https://specs.example/1"},
|
||||||
|
{"name": "x", "title": "Second", "url": "https://specs.example/2"},
|
||||||
|
]
|
||||||
|
)
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS", custom)
|
||||||
|
with caplog.at_level(logging.WARNING, logger="app.docs_specs"):
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/manifest")
|
||||||
|
payload = r.json()
|
||||||
|
assert [s["title"] for s in payload["specs"]] == ["First"]
|
||||||
|
assert any("duplicate name" in rec.message for rec in caplog.records)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Spec endpoint — happy + error paths
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_happy_path(app, patched_httpx, monkeypatch):
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "rfc-app",
|
||||||
|
"title": "rfc-app SPEC",
|
||||||
|
"url": "https://specs.example.org/rfc-app/SPEC.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
body = "# rfc-app SPEC\n\nSection 1...\n"
|
||||||
|
patched_httpx(_UpstreamHandler({"rfc-app/SPEC.md": (200, body)}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/rfc-app")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
assert "text/markdown" in r.headers["content-type"]
|
||||||
|
assert r.text == body
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_upstream_404(app, patched_httpx, monkeypatch):
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "missing-spec",
|
||||||
|
"title": "Missing",
|
||||||
|
"url": "https://specs.example.org/missing.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
patched_httpx(_UpstreamHandler({})) # everything 404s
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/missing-spec")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_upstream_5xx_returns_502(app, patched_httpx, monkeypatch):
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "broken-spec",
|
||||||
|
"title": "Broken",
|
||||||
|
"url": "https://specs.example.org/broken.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
patched_httpx(_UpstreamHandler({"broken.md": (500, "internal")}))
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/broken-spec")
|
||||||
|
assert r.status_code == 502, r.text
|
||||||
|
body = r.json()
|
||||||
|
assert body["detail"]["error"] == "specs fetch failed"
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_unknown_name_returns_404(app, patched_httpx, monkeypatch):
|
||||||
|
"""A name that doesn't appear in the manifest returns 404 without
|
||||||
|
touching the network. The handler treats "no such configured spec"
|
||||||
|
and "upstream 404" as the same outcome — both render the same
|
||||||
|
"spec not found" empty state on the frontend.
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "rfc-app",
|
||||||
|
"title": "rfc-app",
|
||||||
|
"url": "https://specs.example.org/x.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r = client.get("/api/docs/specs/does-not-exist")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
assert handler.calls == [], "unknown-name lookup must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Spec endpoint — slug validation
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"raw_name",
|
||||||
|
[
|
||||||
|
"UPPER", # uppercase
|
||||||
|
"spaces here", # whitespace (post-decoding)
|
||||||
|
"with~tilde", # tilde
|
||||||
|
"with.dot", # dot
|
||||||
|
"with_under", # underscore (not allowed by [a-z0-9-]+)
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_spec_rejects_invalid_name(app, patched_httpx, raw_name):
|
||||||
|
"""Names that don't match `^[a-z0-9-]+$` are rejected with 400 at
|
||||||
|
the route layer before any network or cache work.
|
||||||
|
|
||||||
|
Note: `..` is intentionally not in this list because the URL-
|
||||||
|
parsing layer collapses `/api/docs/specs/..` to `/api/docs/specs`
|
||||||
|
before the handler is reached — the path-traversal protection is
|
||||||
|
therefore framework-level (httpx/urllib's path normalizer) rather
|
||||||
|
than route-layer. The slug-validation guard still rejects any
|
||||||
|
`..` that *would* reach the handler (e.g. via an env-configured
|
||||||
|
manifest entry); see `test_manifest_drops_invalid_entry_keeps_valid`
|
||||||
|
for that path.
|
||||||
|
"""
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
from urllib.parse import quote
|
||||||
|
|
||||||
|
r = client.get(f"/api/docs/specs/{quote(raw_name, safe='')}")
|
||||||
|
assert r.status_code == 400, r.text
|
||||||
|
assert handler.calls == [], "rejected name must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_rejects_slash_in_name(app, patched_httpx):
|
||||||
|
"""A literal `/` in the path can't make it through the path
|
||||||
|
parameter — FastAPI routes it as a separate segment. The check
|
||||||
|
here is that the request never reaches an upstream fetch.
|
||||||
|
"""
|
||||||
|
handler = _UpstreamHandler({})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
# `/api/docs/specs/sub/path` — the second segment makes this
|
||||||
|
# not match the `/{name}` route at all; FastAPI returns 404.
|
||||||
|
r = client.get("/api/docs/specs/sub/path")
|
||||||
|
assert r.status_code == 404, r.text
|
||||||
|
assert handler.calls == [], "non-matching path must not hit the network"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Cache behavior
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_cache_hits_within_ttl(app, patched_httpx, monkeypatch):
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS_CONTENT_TTL_SEC", "300")
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "rfc-app",
|
||||||
|
"title": "rfc-app",
|
||||||
|
"url": "https://specs.example.org/rfc-app/SPEC.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
handler = _UpstreamHandler({"rfc-app/SPEC.md": (200, "# body\n")})
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r1 = client.get("/api/docs/specs/rfc-app")
|
||||||
|
r2 = client.get("/api/docs/specs/rfc-app")
|
||||||
|
assert r1.status_code == 200
|
||||||
|
assert r2.status_code == 200
|
||||||
|
assert len(handler.calls) == 1, (
|
||||||
|
f"expected one upstream call, got {handler.calls}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_spec_404_is_cached(app, patched_httpx, monkeypatch):
|
||||||
|
"""Negative caching: a 404 result is cached at the content TTL so
|
||||||
|
a deployment with a misconfigured spec URL doesn't hammer the
|
||||||
|
upstream on every navigation.
|
||||||
|
"""
|
||||||
|
monkeypatch.setenv("OHM_DOCS_SPECS_CONTENT_TTL_SEC", "300")
|
||||||
|
monkeypatch.setenv(
|
||||||
|
"OHM_DOCS_SPECS",
|
||||||
|
json.dumps(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "missing-spec",
|
||||||
|
"title": "Missing",
|
||||||
|
"url": "https://specs.example.org/missing.md",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
),
|
||||||
|
)
|
||||||
|
handler = _UpstreamHandler({}) # everything 404s
|
||||||
|
patched_httpx(handler)
|
||||||
|
with TestClient(app) as client:
|
||||||
|
r1 = client.get("/api/docs/specs/missing-spec")
|
||||||
|
r2 = client.get("/api/docs/specs/missing-spec")
|
||||||
|
assert r1.status_code == 404
|
||||||
|
assert r2.status_code == 404
|
||||||
|
assert len(handler.calls) == 1, "negative caching should suppress the 2nd call"
|
||||||
@@ -0,0 +1,161 @@
|
|||||||
|
"""End-to-end vertical for roadmap #26 (rfc-app v0.22.0): the optional
|
||||||
|
"What will you be using this for?" capture on the two propose surfaces.
|
||||||
|
|
||||||
|
Reuses the FakeGitea + session helpers from test_propose_vertical.py and
|
||||||
|
the active-RFC seed from test_rfc_view_vertical.py. Proves:
|
||||||
|
|
||||||
|
(a) propose-RFC persists and returns `proposed_use_case` when supplied,
|
||||||
|
and the value survives onto the merged super-draft's RFC view;
|
||||||
|
(b) propose-RFC accepts a NULL / omitted use case ("left blank");
|
||||||
|
(c) propose-PR persists and returns `proposed_use_case` when supplied,
|
||||||
|
and accepts a NULL / omitted one.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from test_propose_vertical import ( # noqa: F401
|
||||||
|
FakeGitea,
|
||||||
|
app_with_fake_gitea,
|
||||||
|
provision_user_row,
|
||||||
|
sign_in_as,
|
||||||
|
tmp_env,
|
||||||
|
)
|
||||||
|
from test_pr_flow_vertical import _cut_branch_and_accept_change
|
||||||
|
from test_rfc_view_vertical import SEED_BODY, seed_active_rfc
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# propose-RFC
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_propose_rfc_persists_and_returns_use_case(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
provision_user_row(user_id=1, login="ben", role="owner")
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor", email="alice@test")
|
||||||
|
|
||||||
|
r = client.post("/api/rfcs/propose", json={
|
||||||
|
"title": "Open Human Model",
|
||||||
|
"slug": "open-human-model",
|
||||||
|
"pitch": "A shared definition of what we mean by *human*.",
|
||||||
|
"tags": ["identity"],
|
||||||
|
"proposed_use_case": "Wiring OHM into the OpenXML consent surface.",
|
||||||
|
})
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_number = r.json()["pr_number"]
|
||||||
|
|
||||||
|
# The pending-idea list carries the use case.
|
||||||
|
items = client.get("/api/proposals").json()["items"]
|
||||||
|
assert items[0]["proposed_use_case"] == "Wiring OHM into the OpenXML consent surface."
|
||||||
|
|
||||||
|
# The pending-idea detail view carries it too.
|
||||||
|
proposal = client.get(f"/api/proposals/{pr_number}").json()
|
||||||
|
assert proposal["proposed_use_case"] == "Wiring OHM into the OpenXML consent surface."
|
||||||
|
|
||||||
|
# Merge as owner; the use case survives onto the RFC view (looked
|
||||||
|
# up by slug from the canonical side table, since the idea PR
|
||||||
|
# closes on merge).
|
||||||
|
sign_in_as(client, user_id=1, gitea_login="ben", display_name="Ben", role="owner", email="ben@test")
|
||||||
|
r = client.post(f"/api/proposals/{pr_number}/merge")
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
|
||||||
|
view = client.get("/api/rfcs/open-human-model").json()
|
||||||
|
assert view["proposed_use_case"] == "Wiring OHM into the OpenXML consent surface."
|
||||||
|
|
||||||
|
|
||||||
|
def test_propose_rfc_use_case_optional(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=3, login="carol", role="contributor")
|
||||||
|
sign_in_as(client, user_id=3, gitea_login="carol", display_name="Carol", role="contributor")
|
||||||
|
|
||||||
|
# Omitted entirely.
|
||||||
|
r = client.post("/api/rfcs/propose", json={
|
||||||
|
"title": "No Use Case", "slug": "no-use-case", "pitch": "p", "tags": [],
|
||||||
|
})
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_a = r.json()["pr_number"]
|
||||||
|
|
||||||
|
# Explicit null.
|
||||||
|
r = client.post("/api/rfcs/propose", json={
|
||||||
|
"title": "Null Use Case", "slug": "null-use-case", "pitch": "p",
|
||||||
|
"tags": [], "proposed_use_case": None,
|
||||||
|
})
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_b = r.json()["pr_number"]
|
||||||
|
|
||||||
|
# Blank/whitespace — treated as "left blank", no row written.
|
||||||
|
r = client.post("/api/rfcs/propose", json={
|
||||||
|
"title": "Blank Use Case", "slug": "blank-use-case", "pitch": "p",
|
||||||
|
"tags": [], "proposed_use_case": " ",
|
||||||
|
})
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_c = r.json()["pr_number"]
|
||||||
|
|
||||||
|
for pr in (pr_a, pr_b, pr_c):
|
||||||
|
assert client.get(f"/api/proposals/{pr}").json()["proposed_use_case"] is None
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# propose-PR (against an active RFC)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_propose_pr_persists_and_returns_use_case(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
seed_active_rfc(fake, slug="ohm", title="OHM", body=SEED_BODY)
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor")
|
||||||
|
|
||||||
|
branch, _ = _cut_branch_and_accept_change(
|
||||||
|
client, fake, slug="ohm",
|
||||||
|
original="Open Human Model is a framework for representing humans.",
|
||||||
|
proposed="Open Human Model is a framework for representing humans across systems.",
|
||||||
|
)
|
||||||
|
r = client.post(
|
||||||
|
f"/api/rfcs/ohm/branches/{branch}/open-pr",
|
||||||
|
json={
|
||||||
|
"title": "Tighten the opening",
|
||||||
|
"description": "Scope to systems.",
|
||||||
|
"proposed_use_case": "Building a cross-system consent registry.",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_number = r.json()["pr_number"]
|
||||||
|
|
||||||
|
pr = client.get(f"/api/rfcs/ohm/prs/{pr_number}").json()
|
||||||
|
assert pr["proposed_use_case"] == "Building a cross-system consent registry."
|
||||||
|
|
||||||
|
|
||||||
|
def test_propose_pr_use_case_optional(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
seed_active_rfc(fake, slug="ohm", title="OHM", body=SEED_BODY)
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor")
|
||||||
|
|
||||||
|
branch, _ = _cut_branch_and_accept_change(
|
||||||
|
client, fake, slug="ohm",
|
||||||
|
original="It defines consent, trait, and agency in compatible terms.",
|
||||||
|
proposed="It defines consent, trait, harm, and agency in compatible terms.",
|
||||||
|
)
|
||||||
|
# No proposed_use_case key at all.
|
||||||
|
r = client.post(
|
||||||
|
f"/api/rfcs/ohm/branches/{branch}/open-pr",
|
||||||
|
json={"title": "Add harm", "description": "Name harm explicitly."},
|
||||||
|
)
|
||||||
|
assert r.status_code == 200, r.text
|
||||||
|
pr_number = r.json()["pr_number"]
|
||||||
|
|
||||||
|
pr = client.get(f"/api/rfcs/ohm/prs/{pr_number}").json()
|
||||||
|
assert pr["proposed_use_case"] is None
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
"""End-to-end integration tests for the v0.23.0 sign-in state-resume
|
||||||
|
vertical (§6.2, roadmap item #29).
|
||||||
|
|
||||||
|
New behavior: each authenticated user's last-viewed route + a small bag
|
||||||
|
of light view state is tracked server-side, so the next sign-in can land
|
||||||
|
them back where they left off rather than on the empty-state home view.
|
||||||
|
|
||||||
|
The tests below prove:
|
||||||
|
|
||||||
|
* `PUT /api/me/last-state` requires auth — an anonymous client gets
|
||||||
|
401, and nothing is stored.
|
||||||
|
* An authenticated PUT upserts the route, and the stored route is
|
||||||
|
read back for that user off `GET /api/auth/me` (`last_route`).
|
||||||
|
* A second PUT overwrites (upsert, one row per user) — the latest
|
||||||
|
route wins.
|
||||||
|
* `last_route_state` round-trips as decoded JSON on `/api/auth/me`.
|
||||||
|
* Per-user isolation: user A's stored route is not visible to user B.
|
||||||
|
* `resume_enabled = 0` disables resume: the PUT no-ops (does not
|
||||||
|
rewrite the stored route) and `/api/auth/me` hands back a null
|
||||||
|
`last_route` even though a stored row exists.
|
||||||
|
|
||||||
|
The fakes from `test_propose_vertical` give us a working app harness +
|
||||||
|
the `sign_in_as` / `provision_user_row` seams.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from test_propose_vertical import ( # noqa: F401
|
||||||
|
FakeGitea,
|
||||||
|
app_with_fake_gitea,
|
||||||
|
provision_user_row,
|
||||||
|
sign_in_as,
|
||||||
|
tmp_env,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_put_last_state_requires_auth(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
from app import db
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
# Anonymous — no session cookie set.
|
||||||
|
r = client.put("/api/me/last-state", json={"route": "/rfc/open-human-model"})
|
||||||
|
assert r.status_code == 401
|
||||||
|
# Nothing landed in the table.
|
||||||
|
row = db.conn().execute("SELECT COUNT(*) AS n FROM user_session_state").fetchone()
|
||||||
|
assert row["n"] == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_put_last_state_upserts_and_reads_back(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor", email="alice@test")
|
||||||
|
|
||||||
|
# First POST stores a route + light state.
|
||||||
|
r = client.put(
|
||||||
|
"/api/me/last-state",
|
||||||
|
json={"route": "/rfc/open-human-model", "state": {"tab": "discussion", "scroll": 420}},
|
||||||
|
)
|
||||||
|
assert r.status_code == 200
|
||||||
|
assert r.json()["stored"] is True
|
||||||
|
|
||||||
|
# /api/auth/me hands the route + decoded state back.
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["authenticated"] is True
|
||||||
|
assert me["user"]["resume_enabled"] is True
|
||||||
|
assert me["user"]["last_route"] == "/rfc/open-human-model"
|
||||||
|
assert me["user"]["last_route_state"] == {"tab": "discussion", "scroll": 420}
|
||||||
|
|
||||||
|
# A later POST overwrites — one row per user, latest wins.
|
||||||
|
r = client.put("/api/me/last-state", json={"route": "/proposals/7"})
|
||||||
|
assert r.status_code == 200
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["user"]["last_route"] == "/proposals/7"
|
||||||
|
# state was omitted on the second POST → cleared to null.
|
||||||
|
assert me["user"]["last_route_state"] is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_last_state_is_per_user(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
provision_user_row(user_id=3, login="bob", role="contributor")
|
||||||
|
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor", email="alice@test")
|
||||||
|
client.put("/api/me/last-state", json={"route": "/rfc/alice-route"})
|
||||||
|
|
||||||
|
# Switch to bob — he has no stored route yet.
|
||||||
|
sign_in_as(client, user_id=3, gitea_login="bob", display_name="Bob", role="contributor", email="bob@test")
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["user"]["last_route"] is None
|
||||||
|
|
||||||
|
client.put("/api/me/last-state", json={"route": "/rfc/bob-route"})
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["user"]["last_route"] == "/rfc/bob-route"
|
||||||
|
|
||||||
|
# Back to alice — her route is untouched by bob's write.
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor", email="alice@test")
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["user"]["last_route"] == "/rfc/alice-route"
|
||||||
|
|
||||||
|
|
||||||
|
def test_resume_disabled_no_ops_put_and_hides_route(app_with_fake_gitea):
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
from app import db
|
||||||
|
|
||||||
|
app, _fake = app_with_fake_gitea
|
||||||
|
with TestClient(app) as client:
|
||||||
|
provision_user_row(user_id=2, login="alice", role="contributor")
|
||||||
|
sign_in_as(client, user_id=2, gitea_login="alice", display_name="Alice", role="contributor", email="alice@test")
|
||||||
|
|
||||||
|
# Seed a stored row, then flip resume_enabled off directly (the
|
||||||
|
# profile-settings toggle UI to do this from the client is a
|
||||||
|
# follow-up; the column + behavior ship now).
|
||||||
|
client.put("/api/me/last-state", json={"route": "/rfc/before-disable"})
|
||||||
|
db.conn().execute(
|
||||||
|
"UPDATE user_session_state SET resume_enabled = 0 WHERE user_id = ?",
|
||||||
|
(2,),
|
||||||
|
)
|
||||||
|
|
||||||
|
# /api/auth/me reports resume off and hands back a null route
|
||||||
|
# even though a stored row exists.
|
||||||
|
me = client.get("/api/auth/me").json()
|
||||||
|
assert me["user"]["resume_enabled"] is False
|
||||||
|
assert me["user"]["last_route"] is None
|
||||||
|
|
||||||
|
# A PUT while disabled no-ops: stored=False and the stored route
|
||||||
|
# is NOT rewritten.
|
||||||
|
r = client.put("/api/me/last-state", json={"route": "/rfc/after-disable"})
|
||||||
|
assert r.status_code == 200
|
||||||
|
assert r.json()["stored"] is False
|
||||||
|
row = db.conn().execute(
|
||||||
|
"SELECT last_route FROM user_session_state WHERE user_id = ?", (2,)
|
||||||
|
).fetchone()
|
||||||
|
assert row["last_route"] == "/rfc/before-disable"
|
||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "rfc-app-frontend",
|
"name": "rfc-app-frontend",
|
||||||
"version": "0.15.0",
|
"version": "0.21.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "rfc-app-frontend",
|
"name": "rfc-app-frontend",
|
||||||
"version": "0.15.0",
|
"version": "0.21.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@amplitude/unified": "^1.1.9",
|
"@amplitude/unified": "^1.1.9",
|
||||||
"@codemirror/commands": "^6.10.3",
|
"@codemirror/commands": "^6.10.3",
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "rfc-app-frontend",
|
"name": "rfc-app-frontend",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.18.0",
|
"version": "0.23.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
|
|||||||
+979
-685
File diff suppressed because it is too large
Load Diff
+77
-7
@@ -1,7 +1,8 @@
|
|||||||
import { useEffect, useRef, useState } from 'react'
|
import { useEffect, useRef, useState } from 'react'
|
||||||
import { Routes, Route, Link, useLocation, useNavigate } from 'react-router-dom'
|
import { Routes, Route, Link, Navigate, useLocation, useNavigate } from 'react-router-dom'
|
||||||
import { getMe, subscribeToNotifications } from './api'
|
import { getMe, subscribeToNotifications } from './api'
|
||||||
import { anonymize, EVENTS, identify, track } from './lib/analytics'
|
import { anonymize, EVENTS, identify, track } from './lib/analytics'
|
||||||
|
import { useLastState } from './lib/useLastState'
|
||||||
import Catalog from './components/Catalog.jsx'
|
import Catalog from './components/Catalog.jsx'
|
||||||
import Inbox from './components/Inbox.jsx'
|
import Inbox from './components/Inbox.jsx'
|
||||||
import RFCView from './components/RFCView.jsx'
|
import RFCView from './components/RFCView.jsx'
|
||||||
@@ -12,7 +13,13 @@ import Landing from './components/Landing.jsx'
|
|||||||
import Login from './components/Login.jsx'
|
import Login from './components/Login.jsx'
|
||||||
import BetaPending from './components/BetaPending.jsx'
|
import BetaPending from './components/BetaPending.jsx'
|
||||||
import Philosophy from './components/Philosophy.jsx'
|
import Philosophy from './components/Philosophy.jsx'
|
||||||
import Docs from './components/Docs.jsx'
|
import DocsLayout from './components/DocsLayout.jsx'
|
||||||
|
import DocsUserGuide from './components/DocsUserGuide.jsx'
|
||||||
|
import DocsSessionsAbout from './components/DocsSessionsAbout.jsx'
|
||||||
|
import DocsSessionIndex from './components/DocsSessionIndex.jsx'
|
||||||
|
import DocsSessionTranscript from './components/DocsSessionTranscript.jsx'
|
||||||
|
import DocsSpec from './components/DocsSpec.jsx'
|
||||||
|
import DocsSpecsIndex from './components/DocsSpecsIndex.jsx'
|
||||||
import NotificationSettings from './components/NotificationSettings.jsx'
|
import NotificationSettings from './components/NotificationSettings.jsx'
|
||||||
import Admin from './components/Admin.jsx'
|
import Admin from './components/Admin.jsx'
|
||||||
import AcceptInvitation from './components/AcceptInvitation.jsx'
|
import AcceptInvitation from './components/AcceptInvitation.jsx'
|
||||||
@@ -36,6 +43,12 @@ export default function App() {
|
|||||||
// "Privacy & cookies" tab dispatches a `rfc-app:cookie-consent-reopen`
|
// "Privacy & cookies" tab dispatches a `rfc-app:cookie-consent-reopen`
|
||||||
// event that bumps this.
|
// event that bumps this.
|
||||||
const [consentReopenTick, setConsentReopenTick] = useState(0)
|
const [consentReopenTick, setConsentReopenTick] = useState(0)
|
||||||
|
// v0.23.0 / item #29 — flips true once the #21-Part-C identify effect
|
||||||
|
// has fired (or once we've confirmed there's no authenticated user to
|
||||||
|
// identify). useLastState gates its resume redirect on this so the
|
||||||
|
// redirect always happens AFTER identify, preserving identify-then-
|
||||||
|
// track ordering.
|
||||||
|
const [identifyReady, setIdentifyReady] = useState(false)
|
||||||
const navigate = useNavigate()
|
const navigate = useNavigate()
|
||||||
const location = useLocation()
|
const location = useLocation()
|
||||||
// v0.15.0 — Page Viewed event taxonomy. We fire on every
|
// v0.15.0 — Page Viewed event taxonomy. We fire on every
|
||||||
@@ -80,6 +93,9 @@ export default function App() {
|
|||||||
if (viewer?.first_sign_in_at) props.first_sign_in_at = ['__setOnce__', viewer.first_sign_in_at]
|
if (viewer?.first_sign_in_at) props.first_sign_in_at = ['__setOnce__', viewer.first_sign_in_at]
|
||||||
if (viewer?.created_at) props.account_created_at = ['__setOnce__', viewer.created_at]
|
if (viewer?.created_at) props.account_created_at = ['__setOnce__', viewer.created_at]
|
||||||
identify({ user_id: String(uid), properties: props })
|
identify({ user_id: String(uid), properties: props })
|
||||||
|
// v0.23.0 / item #29 — identify has now fired for this sign-in;
|
||||||
|
// release useLastState's resume redirect (it waits on this).
|
||||||
|
setIdentifyReady(true)
|
||||||
} else if (uid == null && lastUserIdRef.current != null) {
|
} else if (uid == null && lastUserIdRef.current != null) {
|
||||||
// Sign-out edge — App-level reset is handled separately by the
|
// Sign-out edge — App-level reset is handled separately by the
|
||||||
// sign-out gesture that fires User Signed Out. Clear our local
|
// sign-out gesture that fires User Signed Out. Clear our local
|
||||||
@@ -88,6 +104,14 @@ export default function App() {
|
|||||||
}
|
}
|
||||||
}, [me?.authenticated, me?.user?.id, me?.user?.role, me?.user?.permission_state, me?.user?.passcode_set, me?.user?.device_trusted])
|
}, [me?.authenticated, me?.user?.id, me?.user?.role, me?.user?.permission_state, me?.user?.passcode_set, me?.user?.device_trusted])
|
||||||
|
|
||||||
|
// v0.23.0 / item #29 — once `me` has resolved, if there's no
|
||||||
|
// authenticated user there is nothing to identify, so release the
|
||||||
|
// resume gate immediately (anonymous boots have no resume to do, but
|
||||||
|
// the hook still needs the gate resolved to be a clean no-op).
|
||||||
|
useEffect(() => {
|
||||||
|
if (me != null && !me.authenticated) setIdentifyReady(true)
|
||||||
|
}, [me])
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const handler = () => setConsentReopenTick(t => t + 1)
|
const handler = () => setConsentReopenTick(t => t + 1)
|
||||||
window.addEventListener('rfc-app:cookie-consent-reopen', handler)
|
window.addEventListener('rfc-app:cookie-consent-reopen', handler)
|
||||||
@@ -101,6 +125,18 @@ export default function App() {
|
|||||||
.finally(() => setLoading(false))
|
.finally(() => setLoading(false))
|
||||||
}, [])
|
}, [])
|
||||||
|
|
||||||
|
// v0.23.0 / item #29 — server-side sign-in state resume. The hook
|
||||||
|
// debounce-posts the current route for authenticated users and, once
|
||||||
|
// identify has fired, redirects a fresh sign-in (which hard-lands on
|
||||||
|
// "/") to the user's stored last route. Anonymous users: no-op.
|
||||||
|
useLastState({
|
||||||
|
authenticated: !!me?.authenticated,
|
||||||
|
pathname: location.pathname,
|
||||||
|
identifyReady,
|
||||||
|
lastRoute: me?.authenticated ? me.user?.last_route : null,
|
||||||
|
navigate,
|
||||||
|
})
|
||||||
|
|
||||||
// §15.3 — subscribe to the live SSE stream for authenticated viewers
|
// §15.3 — subscribe to the live SSE stream for authenticated viewers
|
||||||
// so the badge counter and the toast surface stay in lockstep with
|
// so the badge counter and the toast surface stay in lockstep with
|
||||||
// the inbox. Tabs that miss an event because they were closed pick
|
// the inbox. Tabs that miss an event because they were closed pick
|
||||||
@@ -163,7 +199,7 @@ export default function App() {
|
|||||||
wonders why a conversation is public can reach the answer
|
wonders why a conversation is public can reach the answer
|
||||||
in two clicks. Anonymous viewers see it too. */}
|
in two clicks. Anonymous viewers see it too. */}
|
||||||
<Link to="/philosophy" className="header-about" title="Why this exists (§14)">
|
<Link to="/philosophy" className="header-about" title="Why this exists (§14)">
|
||||||
About
|
Philosophy
|
||||||
</Link>
|
</Link>
|
||||||
<Link to="/docs" className="header-about" title="User guide">
|
<Link to="/docs" className="header-about" title="User guide">
|
||||||
Docs
|
Docs
|
||||||
@@ -182,9 +218,17 @@ export default function App() {
|
|||||||
<button
|
<button
|
||||||
className="inbox-trigger"
|
className="inbox-trigger"
|
||||||
onClick={() => setInboxOpen(o => !o)}
|
onClick={() => setInboxOpen(o => !o)}
|
||||||
title="Notifications inbox (§15.2)"
|
aria-label="Inbox"
|
||||||
|
title="Inbox (§15.2)"
|
||||||
>
|
>
|
||||||
<span aria-hidden>📮</span>
|
<svg
|
||||||
|
width="18" height="18" viewBox="0 0 24 24"
|
||||||
|
fill="none" stroke="currentColor" strokeWidth="1.75"
|
||||||
|
strokeLinecap="round" strokeLinejoin="round" aria-hidden
|
||||||
|
>
|
||||||
|
<path d="M4 5h16a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1H4a1 1 0 0 1-1-1V6a1 1 0 0 1 1-1Z" />
|
||||||
|
<path d="m3.5 6.5 8.5 6 8.5-6" />
|
||||||
|
</svg>
|
||||||
{unreadCount > 0 && (
|
{unreadCount > 0 && (
|
||||||
<span className="badge">{unreadCount > 99 ? '99+' : unreadCount}</span>
|
<span className="badge">{unreadCount > 99 ? '99+' : unreadCount}</span>
|
||||||
)}
|
)}
|
||||||
@@ -233,7 +277,13 @@ export default function App() {
|
|||||||
itself establishes the session on success. */}
|
itself establishes the session on success. */}
|
||||||
<Route path="/invites/claim" element={<InviteClaim />} />
|
<Route path="/invites/claim" element={<InviteClaim />} />
|
||||||
<Route path="/philosophy" element={<PhilosophyWithSidebar viewer={viewer} />} />
|
<Route path="/philosophy" element={<PhilosophyWithSidebar viewer={viewer} />} />
|
||||||
<Route path="/docs" element={<DocsWithSidebar viewer={viewer} />} />
|
{/* v0.19.0 / roadmap item #30 — /docs/* is a hub with sub-nav.
|
||||||
|
The bare /docs path redirects to the user guide; sessions
|
||||||
|
browser lives at /docs/sessions/*. See DocsLayout.jsx
|
||||||
|
for the flyout shape and CHANGELOG v0.19.0 for the
|
||||||
|
upgrade path. */}
|
||||||
|
<Route path="/docs" element={<Navigate to="/docs/user-guide" replace />} />
|
||||||
|
<Route path="/docs/*" element={<DocsWithSidebar viewer={viewer} />} />
|
||||||
{/* §14.5 / §14.6: cookie-consent companions to /philosophy.
|
{/* §14.5 / §14.6: cookie-consent companions to /philosophy.
|
||||||
Available to anonymous and authenticated viewers alike. */}
|
Available to anonymous and authenticated viewers alike. */}
|
||||||
<Route path="/privacy" element={<PolicyShell><Privacy /></PolicyShell>} />
|
<Route path="/privacy" element={<PolicyShell><Privacy /></PolicyShell>} />
|
||||||
@@ -303,9 +353,29 @@ function PhilosophyWithSidebar({ viewer }) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function DocsWithSidebar({ viewer }) {
|
function DocsWithSidebar({ viewer }) {
|
||||||
|
// v0.19.0 / roadmap item #30 — the `/docs/*` surface is a flyout
|
||||||
|
// shell with sub-routes. The shell (sidebar + content area) is the
|
||||||
|
// DocsLayout outlet host; the sub-routes mount their respective
|
||||||
|
// pages into the outlet. Bare `/docs/sessions` redirects to the
|
||||||
|
// sessions about page so deep-linkers and the flyout's "Sessions"
|
||||||
|
// header both land somewhere coherent.
|
||||||
return (
|
return (
|
||||||
<main className="chrome-pane">
|
<main className="chrome-pane">
|
||||||
<Docs authenticated={!!viewer} />
|
<Routes>
|
||||||
|
<Route element={<DocsLayout authenticated={!!viewer} />}>
|
||||||
|
<Route index element={<Navigate to="user-guide" replace />} />
|
||||||
|
<Route path="user-guide" element={<DocsUserGuide />} />
|
||||||
|
<Route path="sessions" element={<Navigate to="about" replace />} />
|
||||||
|
<Route path="sessions/about" element={<DocsSessionsAbout />} />
|
||||||
|
<Route path="sessions/:nnnn" element={<DocsSessionIndex />} />
|
||||||
|
<Route path="sessions/:nnnn/:filename" element={<DocsSessionTranscript />} />
|
||||||
|
{/* v0.20.0 — /docs/specs/* surface (framework spec + flotilla spec
|
||||||
|
at runtime via gitea raw). Bare /docs/specs lands on the
|
||||||
|
client-side redirect to the first configured spec. */}
|
||||||
|
<Route path="specs" element={<DocsSpecsIndex />} />
|
||||||
|
<Route path="specs/:name" element={<DocsSpec />} />
|
||||||
|
</Route>
|
||||||
|
</Routes>
|
||||||
</main>
|
</main>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
+111
-4
@@ -25,6 +25,25 @@ export async function getMe() {
|
|||||||
return jsonOrThrow(res)
|
return jsonOrThrow(res)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── v0.23.0: sign-in state resume (§6.2, roadmap item #29) ───────────────
|
||||||
|
//
|
||||||
|
// The route-change hook (useLastState) debounce-posts the user's current
|
||||||
|
// route + a small bag of *light* view state here for authenticated users.
|
||||||
|
// The next sign-in reads `last_route` off `/api/auth/me` and redirects.
|
||||||
|
// Privacy: `state` carries ephemeral view state ONLY — never draft-buffer
|
||||||
|
// contents (see SPEC §6.2). Best-effort: callers ignore failures (an
|
||||||
|
// offline/401 POST must never disrupt navigation).
|
||||||
|
export async function putLastState(route, state) {
|
||||||
|
const body = { route }
|
||||||
|
if (state != null) body.state = state
|
||||||
|
const res = await fetch('/api/me/last-state', {
|
||||||
|
method: 'PUT',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: JSON.stringify(body),
|
||||||
|
})
|
||||||
|
return jsonOrThrow(res)
|
||||||
|
}
|
||||||
|
|
||||||
// ── v0.7.0: email + one-time-code sign-in (§6.2) ─────────────────────────
|
// ── v0.7.0: email + one-time-code sign-in (§6.2) ─────────────────────────
|
||||||
//
|
//
|
||||||
// The legacy /auth/login → /auth/callback OAuth flow remains during the
|
// The legacy /auth/login → /auth/callback OAuth flow remains during the
|
||||||
@@ -166,11 +185,19 @@ export async function getProposal(prNumber) {
|
|||||||
return jsonOrThrow(await fetch(`/api/proposals/${prNumber}`))
|
return jsonOrThrow(await fetch(`/api/proposals/${prNumber}`))
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function proposeRFC({ title, slug, pitch, tags }) {
|
export async function proposeRFC({ title, slug, pitch, tags, proposedUseCase }) {
|
||||||
const res = await fetch('/api/rfcs/propose', {
|
const res = await fetch('/api/rfcs/propose', {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers: { 'Content-Type': 'application/json' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
body: JSON.stringify({ title, slug, pitch, tags: tags || [] }),
|
// #26: proposed_use_case is optional; send null when blank so the
|
||||||
|
// backend treats it as "left blank".
|
||||||
|
body: JSON.stringify({
|
||||||
|
title,
|
||||||
|
slug,
|
||||||
|
pitch,
|
||||||
|
tags: tags || [],
|
||||||
|
proposed_use_case: proposedUseCase || null,
|
||||||
|
}),
|
||||||
})
|
})
|
||||||
return jsonOrThrow(res)
|
return jsonOrThrow(res)
|
||||||
}
|
}
|
||||||
@@ -492,13 +519,14 @@ export async function draftPRText(slug, branch) {
|
|||||||
return jsonOrThrow(res)
|
return jsonOrThrow(res)
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function openPR(slug, branch, { title, description }) {
|
export async function openPR(slug, branch, { title, description, proposedUseCase }) {
|
||||||
const res = await fetch(
|
const res = await fetch(
|
||||||
`/api/rfcs/${slug}/branches/${encodeURIComponent(branch)}/open-pr`,
|
`/api/rfcs/${slug}/branches/${encodeURIComponent(branch)}/open-pr`,
|
||||||
{
|
{
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers: { 'Content-Type': 'application/json' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
body: JSON.stringify({ title, description }),
|
// #26: proposed_use_case is optional; null when blank.
|
||||||
|
body: JSON.stringify({ title, description, proposed_use_case: proposedUseCase || null }),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
return jsonOrThrow(res)
|
return jsonOrThrow(res)
|
||||||
@@ -720,6 +748,85 @@ export async function getDocs() {
|
|||||||
return jsonOrThrow(await fetch('/api/docs'))
|
return jsonOrThrow(await fetch('/api/docs'))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// v0.19.0 / roadmap item #30 — /api/docs/sessions/* surface
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
//
|
||||||
|
// The framework mediates reads against the public
|
||||||
|
// `wiggleverse/ohm-session-history` gitea repo so the rendered
|
||||||
|
// `/docs/sessions/*` surface inherits the same chrome as
|
||||||
|
// `/docs/user-guide`. Three text-bearing endpoints return markdown
|
||||||
|
// (Content-Type: text/markdown) and the manifest returns JSON. We
|
||||||
|
// wrap each into a small helper.
|
||||||
|
//
|
||||||
|
// 404 from `getSessionAbout` / `getSessionTranscript` / `getSessionIndex`
|
||||||
|
// throws an Error with `.status === 404` so the UI can render its own
|
||||||
|
// empty-state. 502 (gitea unreachable) throws `.status === 502` so
|
||||||
|
// the UI can offer a retry button.
|
||||||
|
|
||||||
|
export async function getSessionsManifest() {
|
||||||
|
// Manifest 404 is mapped server-side to HTTP 200 + `{}` so this
|
||||||
|
// helper never throws on the empty-state path.
|
||||||
|
return jsonOrThrow(await fetch('/api/docs/sessions/manifest'))
|
||||||
|
}
|
||||||
|
|
||||||
|
async function _textOrThrow(res) {
|
||||||
|
if (!res.ok) {
|
||||||
|
let detail = ''
|
||||||
|
try {
|
||||||
|
const body = await res.json()
|
||||||
|
detail = body.detail || JSON.stringify(body)
|
||||||
|
} catch {
|
||||||
|
detail = await res.text()
|
||||||
|
}
|
||||||
|
const error = new Error(detail || `HTTP ${res.status}`)
|
||||||
|
error.status = res.status
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
return res.text()
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getSessionsAbout() {
|
||||||
|
return _textOrThrow(await fetch('/api/docs/sessions/about'))
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getSessionTranscript(nnnn, filename) {
|
||||||
|
return _textOrThrow(await fetch(
|
||||||
|
`/api/docs/sessions/${encodeURIComponent(nnnn)}/${encodeURIComponent(filename)}`
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getSessionIndex(nnnn) {
|
||||||
|
return jsonOrThrow(await fetch(
|
||||||
|
`/api/docs/sessions/${encodeURIComponent(nnnn)}/index`
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// v0.20.0 — /api/docs/specs/* surface
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
//
|
||||||
|
// Sibling of the docs-sessions helpers above. The framework mediates
|
||||||
|
// reads against the configured spec URLs (default: rfc-app's own
|
||||||
|
// SPEC.md + flotilla's SPEC.md on `git.wiggleverse.org`) so the
|
||||||
|
// `/docs/specs/*` route inherits the same chrome as `/docs/user-guide`
|
||||||
|
// and `/docs/sessions/*`. The manifest endpoint always returns 200 +
|
||||||
|
// {specs: [...]} — a malformed `OHM_DOCS_SPECS` env var falls back to
|
||||||
|
// the framework default at parse time on the backend.
|
||||||
|
//
|
||||||
|
// 404 from `getSpec` throws `.status === 404`; 502 throws `.status === 502`,
|
||||||
|
// matching the docs-sessions helper convention.
|
||||||
|
|
||||||
|
export async function getSpecsManifest() {
|
||||||
|
return jsonOrThrow(await fetch('/api/docs/specs/manifest'))
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getSpec(name) {
|
||||||
|
return _textOrThrow(await fetch(
|
||||||
|
`/api/docs/specs/${encodeURIComponent(name)}`
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Slice 7: admin neighborhood (§17 admin/* + user search for the §15.8 mute
|
// Slice 7: admin neighborhood (§17 admin/* + user search for the §15.8 mute
|
||||||
// typeahead).
|
// typeahead).
|
||||||
|
|||||||
@@ -0,0 +1,128 @@
|
|||||||
|
/* Docs.css — docs-surface polish scoped to v0.21.0 / roadmap item #32.
|
||||||
|
*
|
||||||
|
* This sheet owns ONLY the classes introduced by item #32 (the
|
||||||
|
* transcript metadata header and the session-root sibling list). The
|
||||||
|
* pre-existing docs classes (.docs-article, .docs-empty, .docs-error,
|
||||||
|
* .docs-source-link, .philosophy-body, .muted) live in App.css and are
|
||||||
|
* deliberately NOT touched here — redefining them would race the #31
|
||||||
|
* App.css token sweep for the same selectors. Every value below reads
|
||||||
|
* a token from tokens.css so the new surfaces sit on the same
|
||||||
|
* spacing/type/color scale as the rest of the docs chrome.
|
||||||
|
*
|
||||||
|
* Imported from DocsSessionTranscript.jsx + DocsSessionIndex.jsx (the
|
||||||
|
* two components that render these elements). CSS custom properties are
|
||||||
|
* not import-order-sensitive at use time, so the import site doesn't
|
||||||
|
* matter for correctness.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* ── Transcript metadata header ─────────────────────────────────────
|
||||||
|
* A compact card above the rendered transcript body: title, the
|
||||||
|
* started/ended/duration grid, an optional TL;DR, and the external
|
||||||
|
* "view source" link. */
|
||||||
|
.docs-transcript-meta {
|
||||||
|
margin: 0 0 var(--space-9);
|
||||||
|
padding: var(--space-7);
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: var(--radius-lg);
|
||||||
|
background: var(--color-surface-sunken);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-title {
|
||||||
|
margin: 0 0 var(--space-5);
|
||||||
|
font-size: var(--text-lg);
|
||||||
|
font-weight: var(--weight-semibold);
|
||||||
|
line-height: var(--leading-tight);
|
||||||
|
color: var(--color-text-strong);
|
||||||
|
font-family: var(--font-mono);
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-grid {
|
||||||
|
margin: 0;
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: max-content 1fr;
|
||||||
|
gap: var(--space-2) var(--space-7);
|
||||||
|
align-items: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-row {
|
||||||
|
display: contents;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-grid dt {
|
||||||
|
margin: 0;
|
||||||
|
font-size: var(--text-xs);
|
||||||
|
font-weight: var(--weight-semibold);
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.04em;
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-grid dd {
|
||||||
|
margin: 0;
|
||||||
|
font-size: var(--text-base);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-tldr {
|
||||||
|
margin: var(--space-6) 0 0;
|
||||||
|
padding-top: var(--space-6);
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
font-size: var(--text-base);
|
||||||
|
line-height: var(--leading-relaxed);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-transcript-meta-source {
|
||||||
|
display: inline-block;
|
||||||
|
margin-top: var(--space-6);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ── Session-root sibling-transcript list ───────────────────────────
|
||||||
|
* Rendered above the inlined primary transcript when a session has
|
||||||
|
* more than one transcript (driver `.0` + subagents). The primary is
|
||||||
|
* marked "(shown below)"; the rest link to their standalone routes. */
|
||||||
|
.docs-session-siblings {
|
||||||
|
margin: 0 0 var(--space-9);
|
||||||
|
padding: var(--space-6) var(--space-7);
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: var(--radius-lg);
|
||||||
|
background: var(--color-surface-muted);
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
align-items: baseline;
|
||||||
|
gap: var(--space-3) var(--space-6);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-session-siblings-label {
|
||||||
|
font-size: var(--text-xs);
|
||||||
|
font-weight: var(--weight-semibold);
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.04em;
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-session-siblings-list {
|
||||||
|
list-style: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: var(--space-2) var(--space-5);
|
||||||
|
font-family: var(--font-mono);
|
||||||
|
font-size: var(--text-base);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-session-siblings-list a {
|
||||||
|
color: var(--color-link);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-session-siblings-list a:hover {
|
||||||
|
color: var(--color-accent-strong);
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-session-siblings-current {
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
}
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
// `/docs` — the user-facing guide.
|
|
||||||
//
|
|
||||||
// Sibling of Philosophy.jsx: same chrome, same data path, different
|
|
||||||
// source file. Renders DOCS.md verbatim with light chrome around it.
|
|
||||||
// Reachable anonymously, same as `/philosophy`, so a visitor can read
|
|
||||||
// the guide before deciding to sign in.
|
|
||||||
|
|
||||||
import { useEffect, useState } from 'react'
|
|
||||||
import { Link, useNavigate } from 'react-router-dom'
|
|
||||||
import MarkdownPreview from './MarkdownPreview.jsx'
|
|
||||||
import { getDocs } from '../api.js'
|
|
||||||
|
|
||||||
export default function Docs({ authenticated }) {
|
|
||||||
const [body, setBody] = useState('')
|
|
||||||
const [error, setError] = useState(null)
|
|
||||||
const [loading, setLoading] = useState(true)
|
|
||||||
const navigate = useNavigate()
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
let active = true
|
|
||||||
getDocs()
|
|
||||||
.then(r => { if (active) setBody(r.body || '') })
|
|
||||||
.catch(e => { if (active) setError(e.message || String(e)) })
|
|
||||||
.finally(() => { if (active) setLoading(false) })
|
|
||||||
return () => { active = false }
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="philosophy-page">
|
|
||||||
<header className="philosophy-header">
|
|
||||||
<button
|
|
||||||
className="philosophy-back"
|
|
||||||
onClick={() => (history.length > 1 ? navigate(-1) : navigate('/'))}
|
|
||||||
>
|
|
||||||
← Back
|
|
||||||
</button>
|
|
||||||
<span className="philosophy-title">User guide</span>
|
|
||||||
{!authenticated && (
|
|
||||||
<Link className="philosophy-signin" to="/">Home</Link>
|
|
||||||
)}
|
|
||||||
</header>
|
|
||||||
<article className="philosophy-body">
|
|
||||||
{loading && <p className="muted">Loading…</p>}
|
|
||||||
{error && <p className="error">Could not load the guide: {error}</p>}
|
|
||||||
{!loading && !error && (
|
|
||||||
<MarkdownPreview content={body} />
|
|
||||||
)}
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,340 @@
|
|||||||
|
// DocsLayout.jsx — v0.20.0 (was v0.19.0 / roadmap item #30).
|
||||||
|
//
|
||||||
|
// Left-side flyout nav + content area for the `/docs/*` route tree:
|
||||||
|
//
|
||||||
|
// /docs → redirect to /docs/user-guide
|
||||||
|
// /docs/user-guide → DOCS.md (existing v0.14.0 content)
|
||||||
|
// /docs/specs → client-side redirect to first configured spec
|
||||||
|
// /docs/specs/:name → a single framework spec (v0.20.0)
|
||||||
|
// /docs/sessions → redirect to /docs/sessions/about
|
||||||
|
// /docs/sessions/about → README.md from the sessions repo
|
||||||
|
// /docs/sessions/:nnnn → per-session overview (nav-only navigation)
|
||||||
|
// /docs/sessions/:nnnn/:file → per-transcript view
|
||||||
|
//
|
||||||
|
// v0.20.0 changes (Session 0018.0):
|
||||||
|
// - Adds a "Specs" section between User Guide and Sessions, driven
|
||||||
|
// by `/api/docs/specs/manifest`.
|
||||||
|
// - Sessions render a nested tree: each session row has the
|
||||||
|
// session's transcripts nested under it as their own nav rows
|
||||||
|
// (labeled by `.N` ordinal). The transcript list is fetched per
|
||||||
|
// session via `/api/docs/sessions/:nnnn/index` (cached server-
|
||||||
|
// side, so the manifest+index fan-out is cheap on subsequent
|
||||||
|
// loads). Always-expanded; no collapse toggle (current scale is
|
||||||
|
// under twenty sessions — well under the threshold where lazy
|
||||||
|
// expansion would pay).
|
||||||
|
//
|
||||||
|
// The flyout is a persistent left sidebar on desktop and a slide-out
|
||||||
|
// drawer on mobile (toggled by the icon button in the docs header).
|
||||||
|
//
|
||||||
|
// Amplitude analytics (per SPEC §21):
|
||||||
|
// - track('Doc Viewed', { section: '...' }) on each sub-route mount;
|
||||||
|
// the sub-route component owns the fire.
|
||||||
|
// - flyout buttons + links carry `aria-label` + `data-amp-track-name`
|
||||||
|
// so autocapture rows are readable rather than ":nth-child(7)".
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import { Link, useNavigate, useLocation, Outlet } from 'react-router-dom'
|
||||||
|
import { getSessionsManifest, getSessionIndex, getSpecsManifest } from '../api.js'
|
||||||
|
|
||||||
|
// Extract the `.N` ordinal from a transcript filename:
|
||||||
|
// "SESSION-0014.1-TRANSCRIPT-...md" → "0014.1"
|
||||||
|
// "SESSION-0013.1.1-TRANSCRIPT-...md" → "0013.1.1" (nested subagent)
|
||||||
|
// Returns the bare filename as fallback if the expected shape isn't
|
||||||
|
// matched (which shouldn't happen — the backend index endpoint
|
||||||
|
// filters by the same regex).
|
||||||
|
function transcriptOrdinal(filename) {
|
||||||
|
const m = /^SESSION-(\d{4}\.\d+(?:\.\d+)*)-TRANSCRIPT/.exec(filename)
|
||||||
|
return m ? m[1] : filename
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function DocsLayout({ authenticated }) {
|
||||||
|
const [manifest, setManifest] = useState(null)
|
||||||
|
const [manifestState, setManifestState] = useState('loading') // loading | ok | error
|
||||||
|
const [sessionFiles, setSessionFiles] = useState({}) // { nnnn: [filename, ...] }
|
||||||
|
const [specs, setSpecs] = useState([])
|
||||||
|
const [specsState, setSpecsState] = useState('loading') // loading | ok | error
|
||||||
|
const [drawerOpen, setDrawerOpen] = useState(false)
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
const navigate = useNavigate()
|
||||||
|
const location = useLocation()
|
||||||
|
|
||||||
|
// Manifest fetch — drives the Sessions section.
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setManifestState('loading')
|
||||||
|
getSessionsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
setManifest(payload || {})
|
||||||
|
setManifestState('ok')
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
if (!active) return
|
||||||
|
setManifest({})
|
||||||
|
setManifestState('error')
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [reloadTick])
|
||||||
|
|
||||||
|
// Per-session transcript lists — fan out from the manifest. Always-
|
||||||
|
// expanded means we pre-fetch every session's index alongside the
|
||||||
|
// manifest, gated on the manifest having loaded successfully. The
|
||||||
|
// backend's 5-minute content TTL makes the repeat cost negligible.
|
||||||
|
useEffect(() => {
|
||||||
|
if (manifestState !== 'ok' || !manifest) return
|
||||||
|
let active = true
|
||||||
|
const nnnnList = Object.keys(manifest).sort()
|
||||||
|
Promise.all(
|
||||||
|
nnnnList.map(nnnn =>
|
||||||
|
getSessionIndex(nnnn)
|
||||||
|
.then(payload => [nnnn, (payload && payload.files) || []])
|
||||||
|
.catch(() => [nnnn, []])
|
||||||
|
)
|
||||||
|
).then(pairs => {
|
||||||
|
if (!active) return
|
||||||
|
setSessionFiles(Object.fromEntries(pairs))
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [manifest, manifestState])
|
||||||
|
|
||||||
|
// Specs fetch — drives the Specs section. Independent of sessions.
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setSpecsState('loading')
|
||||||
|
getSpecsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
setSpecs((payload && payload.specs) || [])
|
||||||
|
setSpecsState('ok')
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
if (!active) return
|
||||||
|
setSpecs([])
|
||||||
|
setSpecsState('error')
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [reloadTick])
|
||||||
|
|
||||||
|
// Close the mobile drawer on every navigation so a click in the nav
|
||||||
|
// doesn't strand the user on a drawer-open view.
|
||||||
|
useEffect(() => {
|
||||||
|
setDrawerOpen(false)
|
||||||
|
}, [location.pathname])
|
||||||
|
|
||||||
|
const retryManifest = useCallback(() => {
|
||||||
|
setReloadTick(t => t + 1)
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="docs-layout">
|
||||||
|
<header className="docs-header">
|
||||||
|
<button
|
||||||
|
className="docs-back"
|
||||||
|
onClick={() => (history.length > 1 ? navigate(-1) : navigate('/'))}
|
||||||
|
aria-label="Back to previous page"
|
||||||
|
data-amp-track-name="Docs Back"
|
||||||
|
>
|
||||||
|
← Back
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
className="docs-drawer-toggle"
|
||||||
|
onClick={() => setDrawerOpen(o => !o)}
|
||||||
|
aria-label="Toggle docs navigation"
|
||||||
|
aria-expanded={drawerOpen}
|
||||||
|
data-amp-track-name="Docs Drawer Toggle"
|
||||||
|
>
|
||||||
|
<span aria-hidden>☰</span>
|
||||||
|
</button>
|
||||||
|
<span className="docs-title">Docs</span>
|
||||||
|
{!authenticated && (
|
||||||
|
<Link
|
||||||
|
className="docs-signin"
|
||||||
|
to="/"
|
||||||
|
aria-label="Home"
|
||||||
|
data-amp-track-name="Docs Home"
|
||||||
|
>
|
||||||
|
Home
|
||||||
|
</Link>
|
||||||
|
)}
|
||||||
|
</header>
|
||||||
|
<div className={'docs-body' + (drawerOpen ? ' docs-body--drawer-open' : '')}>
|
||||||
|
<aside className="docs-nav" aria-label="Docs navigation">
|
||||||
|
<DocsNav
|
||||||
|
manifest={manifest}
|
||||||
|
manifestState={manifestState}
|
||||||
|
sessionFiles={sessionFiles}
|
||||||
|
specs={specs}
|
||||||
|
specsState={specsState}
|
||||||
|
onRetry={retryManifest}
|
||||||
|
currentPath={location.pathname}
|
||||||
|
/>
|
||||||
|
</aside>
|
||||||
|
<main className="docs-content">
|
||||||
|
<Outlet />
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
{drawerOpen && (
|
||||||
|
<button
|
||||||
|
className="docs-drawer-scrim"
|
||||||
|
aria-label="Close drawer"
|
||||||
|
onClick={() => setDrawerOpen(false)}
|
||||||
|
data-amp-track-name="Docs Drawer Close"
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function DocsNav({
|
||||||
|
manifest,
|
||||||
|
manifestState,
|
||||||
|
sessionFiles,
|
||||||
|
specs,
|
||||||
|
specsState,
|
||||||
|
onRetry,
|
||||||
|
currentPath,
|
||||||
|
}) {
|
||||||
|
const isActive = (path) => currentPath === path || currentPath.startsWith(path + '/')
|
||||||
|
const isExactly = (path) => currentPath === path
|
||||||
|
|
||||||
|
const sessionKeys = Object.keys(manifest || {}).sort()
|
||||||
|
|
||||||
|
return (
|
||||||
|
<nav className="docs-nav-inner">
|
||||||
|
<div className="docs-nav-section">
|
||||||
|
<div className="docs-nav-section-label">Docs</div>
|
||||||
|
<ul className="docs-nav-list">
|
||||||
|
<li>
|
||||||
|
<Link
|
||||||
|
to="/docs/user-guide"
|
||||||
|
className={isActive('/docs/user-guide') ? 'active' : ''}
|
||||||
|
aria-label="User Guide"
|
||||||
|
data-amp-track-name="Docs Nav User Guide"
|
||||||
|
>
|
||||||
|
User Guide
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="docs-nav-section">
|
||||||
|
<div className="docs-nav-section-label">Specs</div>
|
||||||
|
{specsState === 'loading' && (
|
||||||
|
<ul className="docs-nav-list docs-nav-skeleton" aria-hidden>
|
||||||
|
<li><span className="skeleton-row" /></li>
|
||||||
|
<li><span className="skeleton-row" /></li>
|
||||||
|
</ul>
|
||||||
|
)}
|
||||||
|
{specsState === 'error' && (
|
||||||
|
<div className="docs-nav-error" role="alert">
|
||||||
|
<span>Couldn't load specs.</span>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{specsState === 'ok' && specs.length > 0 && (
|
||||||
|
<ul className="docs-nav-list">
|
||||||
|
{specs.map(spec => {
|
||||||
|
const to = `/docs/specs/${spec.name}`
|
||||||
|
return (
|
||||||
|
<li key={spec.name}>
|
||||||
|
<Link
|
||||||
|
to={to}
|
||||||
|
className={isExactly(to) ? 'active' : ''}
|
||||||
|
aria-label={`Spec: ${spec.title}`}
|
||||||
|
data-amp-track-name="Docs Nav Spec"
|
||||||
|
data-amp-track-spec={spec.name}
|
||||||
|
>
|
||||||
|
{spec.title}
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
)
|
||||||
|
})}
|
||||||
|
</ul>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="docs-nav-section">
|
||||||
|
<div className="docs-nav-section-label">Sessions</div>
|
||||||
|
<ul className="docs-nav-list">
|
||||||
|
<li>
|
||||||
|
<Link
|
||||||
|
to="/docs/sessions/about"
|
||||||
|
className={isExactly('/docs/sessions/about') ? 'active' : ''}
|
||||||
|
aria-label="About sessions"
|
||||||
|
data-amp-track-name="Docs Nav Sessions About"
|
||||||
|
>
|
||||||
|
About
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
{manifestState === 'loading' && (
|
||||||
|
<ul className="docs-nav-list docs-nav-skeleton" aria-hidden>
|
||||||
|
<li><span className="skeleton-row" /></li>
|
||||||
|
<li><span className="skeleton-row" /></li>
|
||||||
|
<li><span className="skeleton-row" /></li>
|
||||||
|
</ul>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{manifestState === 'error' && (
|
||||||
|
<div className="docs-nav-error" role="alert">
|
||||||
|
<span>Couldn't load session list.</span>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={onRetry}
|
||||||
|
aria-label="Retry session list"
|
||||||
|
data-amp-track-name="Docs Nav Sessions Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{manifestState === 'ok' && sessionKeys.length > 0 && (
|
||||||
|
<ul className="docs-nav-list docs-nav-list--tree">
|
||||||
|
{sessionKeys.map(nnnn => {
|
||||||
|
const entry = manifest[nnnn] || {}
|
||||||
|
const title = entry.title || ''
|
||||||
|
const label = title ? `${nnnn} — ${title}` : nnnn
|
||||||
|
const to = `/docs/sessions/${nnnn}`
|
||||||
|
const files = sessionFiles[nnnn] || []
|
||||||
|
return (
|
||||||
|
<li key={nnnn}>
|
||||||
|
<Link
|
||||||
|
to={to}
|
||||||
|
className={isExactly(to) ? 'active' : ''}
|
||||||
|
aria-label={`Session ${nnnn}${title ? ': ' + title : ''}`}
|
||||||
|
data-amp-track-name="Docs Nav Session"
|
||||||
|
data-amp-track-session={nnnn}
|
||||||
|
>
|
||||||
|
{label}
|
||||||
|
</Link>
|
||||||
|
{files.length > 0 && (
|
||||||
|
<ul className="docs-nav-list docs-nav-list--children">
|
||||||
|
{files.map(f => {
|
||||||
|
const tTo = `/docs/sessions/${nnnn}/${f}`
|
||||||
|
return (
|
||||||
|
<li key={f}>
|
||||||
|
<Link
|
||||||
|
to={tTo}
|
||||||
|
className={isExactly(tTo) ? 'active' : ''}
|
||||||
|
aria-label={`Transcript ${transcriptOrdinal(f)}`}
|
||||||
|
data-amp-track-name="Docs Nav Transcript"
|
||||||
|
data-amp-track-session={nnnn}
|
||||||
|
data-amp-track-filename={f}
|
||||||
|
>
|
||||||
|
{transcriptOrdinal(f)}
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
)
|
||||||
|
})}
|
||||||
|
</ul>
|
||||||
|
)}
|
||||||
|
</li>
|
||||||
|
)
|
||||||
|
})}
|
||||||
|
</ul>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,246 @@
|
|||||||
|
// DocsSessionIndex.jsx — v0.21.0 (was v0.20.0 / roadmap item #30).
|
||||||
|
//
|
||||||
|
// Per-session landing at `/docs/sessions/:nnnn`. v0.20.0 rendered a
|
||||||
|
// dead-end "N transcript(s) in this session. Select one from the
|
||||||
|
// navigation." placeholder. v0.21.0 / roadmap item #32 collapses that:
|
||||||
|
// the session root now renders a transcript INLINE so the URL is never
|
||||||
|
// an empty stop.
|
||||||
|
//
|
||||||
|
// - Exactly one transcript → render it inline at the session root.
|
||||||
|
// - Multiple transcripts → render the `.0` driver transcript
|
||||||
|
// inline (fall back to the first file by
|
||||||
|
// sort order if there's no `.0`), AND
|
||||||
|
// list/link the remaining transcripts so
|
||||||
|
// the siblings are one click away.
|
||||||
|
//
|
||||||
|
// The URL stays stable to the session number — this is an inline
|
||||||
|
// render, not a 301/redirect. The per-transcript route
|
||||||
|
// (`/docs/sessions/:nnnn/:filename`) still exists and is what the
|
||||||
|
// sibling links and the left-nav transcript rows point at.
|
||||||
|
//
|
||||||
|
// The transcript count + filenames come from `/api/docs/sessions/:nnnn/index`
|
||||||
|
// so the empty-state ("no transcripts yet"), not-found, and error
|
||||||
|
// paths remain meaningful when the upstream is mid-publish or
|
||||||
|
// unreachable. The metadata header + body rendering are imported from
|
||||||
|
// DocsSessionTranscript.jsx so the inline view is byte-identical to the
|
||||||
|
// standalone per-transcript view.
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import { Link, useParams } from 'react-router-dom'
|
||||||
|
import MarkdownPreview from './MarkdownPreview.jsx'
|
||||||
|
import {
|
||||||
|
getSessionsManifest,
|
||||||
|
getSessionIndex,
|
||||||
|
getSessionTranscript,
|
||||||
|
} from '../api.js'
|
||||||
|
import {
|
||||||
|
TranscriptMetaHeader,
|
||||||
|
transcriptOrdinal,
|
||||||
|
} from './DocsSessionTranscript.jsx'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
import './Docs.css'
|
||||||
|
|
||||||
|
// Pick the transcript to render inline at the session root: prefer the
|
||||||
|
// `.0` driver transcript; otherwise the first file by sort order. The
|
||||||
|
// backend already returns the file list sorted, so `files[0]` is a
|
||||||
|
// stable fallback.
|
||||||
|
function pickPrimary(files) {
|
||||||
|
if (!files || files.length === 0) return null
|
||||||
|
const driver = files.find(f => /^SESSION-\d{4}\.0-TRANSCRIPT/.test(f))
|
||||||
|
return driver || files[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function DocsSessionIndex() {
|
||||||
|
const { nnnn } = useParams()
|
||||||
|
const [title, setTitle] = useState('')
|
||||||
|
const [tldr, setTldr] = useState('')
|
||||||
|
const [files, setFiles] = useState([])
|
||||||
|
const [status, setStatus] = useState('loading') // loading | ok | notfound | error
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
|
||||||
|
// The inline body for the primary transcript.
|
||||||
|
const [body, setBody] = useState('')
|
||||||
|
const [bodyStatus, setBodyStatus] = useState('idle') // idle | loading | ok | notfound | error
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: `sessions/${nnnn}` })
|
||||||
|
}, [nnnn])
|
||||||
|
|
||||||
|
// Title + optional TL;DR from the manifest — cheap, cached server-side.
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
getSessionsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
const entry = (payload && payload[nnnn]) || {}
|
||||||
|
setTitle(entry.title || '')
|
||||||
|
// `tldr` is an optional manifest field (string). Absent ⇒ the
|
||||||
|
// header renders no TL;DR line (graceful degrade).
|
||||||
|
setTldr(typeof entry.tldr === 'string' ? entry.tldr : '')
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
// Title + TL;DR are decorative; the transcript list + body
|
||||||
|
// fetches below are the load-bearing ones.
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [nnnn])
|
||||||
|
|
||||||
|
// File list from the per-session index endpoint.
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setStatus('loading')
|
||||||
|
getSessionIndex(nnnn)
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
setFiles((payload && payload.files) || [])
|
||||||
|
setStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(e => {
|
||||||
|
if (!active) return
|
||||||
|
if (e.status === 404) {
|
||||||
|
setStatus('notfound')
|
||||||
|
} else {
|
||||||
|
setStatus('error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [nnnn, reloadTick])
|
||||||
|
|
||||||
|
const primary = status === 'ok' ? pickPrimary(files) : null
|
||||||
|
|
||||||
|
// Fetch the primary transcript body once we know which file it is.
|
||||||
|
useEffect(() => {
|
||||||
|
if (!primary) {
|
||||||
|
setBody('')
|
||||||
|
setBodyStatus('idle')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
let active = true
|
||||||
|
setBodyStatus('loading')
|
||||||
|
getSessionTranscript(nnnn, primary)
|
||||||
|
.then(text => {
|
||||||
|
if (!active) return
|
||||||
|
setBody(text || '')
|
||||||
|
setBodyStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(e => {
|
||||||
|
if (!active) return
|
||||||
|
setBodyStatus(e.status === 404 ? 'notfound' : 'error')
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [nnnn, primary, reloadTick])
|
||||||
|
|
||||||
|
const retry = useCallback(() => setReloadTick(t => t + 1), [])
|
||||||
|
|
||||||
|
const header = title ? `${nnnn} — ${title}` : `Session ${nnnn}`
|
||||||
|
const siblings = primary ? files.filter(f => f !== primary) : []
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<h1 className="docs-article-title">{header}</h1>
|
||||||
|
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
|
||||||
|
{status === 'notfound' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>
|
||||||
|
No transcripts have been published for this session yet.{' '}
|
||||||
|
<Link
|
||||||
|
to="/docs/sessions/about"
|
||||||
|
aria-label="About sessions"
|
||||||
|
data-amp-track-name="Docs Session Empty About Link"
|
||||||
|
>
|
||||||
|
About sessions
|
||||||
|
</Link>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't reach the session-history repo.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs Session Index Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{status === 'ok' && files.length === 0 && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>This session has no transcripts published.</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{status === 'ok' && primary && (
|
||||||
|
<>
|
||||||
|
{siblings.length > 0 && (
|
||||||
|
<nav className="docs-session-siblings" aria-label="Transcripts in this session">
|
||||||
|
<span className="docs-session-siblings-label">Transcripts</span>
|
||||||
|
<ul className="docs-session-siblings-list">
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
className="docs-session-siblings-current"
|
||||||
|
aria-current="true"
|
||||||
|
>
|
||||||
|
{transcriptOrdinal(primary)} (shown below)
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
{siblings.map(f => (
|
||||||
|
<li key={f}>
|
||||||
|
<Link
|
||||||
|
to={`/docs/sessions/${nnnn}/${f}`}
|
||||||
|
aria-label={`Transcript ${transcriptOrdinal(f)}`}
|
||||||
|
data-amp-track-name="Docs Session Sibling Transcript"
|
||||||
|
data-amp-track-session={nnnn}
|
||||||
|
data-amp-track-filename={f}
|
||||||
|
>
|
||||||
|
{transcriptOrdinal(f)}
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{bodyStatus === 'loading' && <p className="muted">Loading transcript…</p>}
|
||||||
|
{bodyStatus === 'notfound' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>This transcript isn't published yet.</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{bodyStatus === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't reach the session-history repo.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs Session Inline Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{bodyStatus === 'ok' && (
|
||||||
|
<>
|
||||||
|
<TranscriptMetaHeader
|
||||||
|
nnnn={nnnn}
|
||||||
|
filename={primary}
|
||||||
|
title={title}
|
||||||
|
tldr={tldr}
|
||||||
|
/>
|
||||||
|
<div className="philosophy-body">
|
||||||
|
<MarkdownPreview content={body} />
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,266 @@
|
|||||||
|
// DocsSessionTranscript.jsx — v0.21.0 (was v0.19.0 / roadmap item #30).
|
||||||
|
//
|
||||||
|
// Per-transcript view at `/docs/sessions/:nnnn/:filename`. Fetches the
|
||||||
|
// transcript body via the backend mediator and renders it through the
|
||||||
|
// shared MarkdownPreview.
|
||||||
|
//
|
||||||
|
// v0.21.0 / roadmap item #32:
|
||||||
|
// - A compact metadata header now sits above the rendered body
|
||||||
|
// (title, started/ended, duration, optional TL;DR, and a
|
||||||
|
// "View source on git.wiggleverse.org" external link). The parse
|
||||||
|
// + render helpers (`parseTranscriptMeta`, `TranscriptMetaHeader`,
|
||||||
|
// `gitSourceUrl`) are exported here so the session-root inline-
|
||||||
|
// collapse view (DocsSessionIndex.jsx) reuses the exact same
|
||||||
|
// rendering for the transcript(s) it inlines.
|
||||||
|
//
|
||||||
|
// Empty-state contract:
|
||||||
|
// 404 → "This transcript isn't published yet" with a link back to
|
||||||
|
// the parent session index
|
||||||
|
// 502 → "Couldn't reach the session-history repo" + retry button
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import { Link, useParams } from 'react-router-dom'
|
||||||
|
import MarkdownPreview from './MarkdownPreview.jsx'
|
||||||
|
import { getSessionTranscript, getSessionsManifest } from '../api.js'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
import './Docs.css'
|
||||||
|
|
||||||
|
// The canonical published-repo source URL for a transcript file, per
|
||||||
|
// SESSION-PROTOCOL.md §1's folder layout (one folder per session).
|
||||||
|
export function gitSourceUrl(nnnn, filename) {
|
||||||
|
return (
|
||||||
|
'https://git.wiggleverse.org/wiggleverse/ohm-session-history/src/branch/main/' +
|
||||||
|
`${encodeURIComponent(nnnn)}/${encodeURIComponent(filename)}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract the `.N` ordinal from a transcript filename:
|
||||||
|
// "SESSION-0014.1-TRANSCRIPT-...md" → "0014.1"
|
||||||
|
// "SESSION-0013.1.1-TRANSCRIPT-...md" → "0013.1.1" (nested subagent)
|
||||||
|
export function transcriptOrdinal(filename) {
|
||||||
|
const m = /^SESSION-(\d{4}\.\d+(?:\.\d+)*)-TRANSCRIPT/.exec(filename || '')
|
||||||
|
return m ? m[1] : filename || ''
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse the `<start>--<end>` ISO segment out of a transcript filename.
|
||||||
|
// Per the protocol the segment is `YYYY-MM-DDTHH-MM--YYYY-MM-DDTHH-MM`
|
||||||
|
// (colons replaced by dashes for filesystem portability, minute
|
||||||
|
// precision, PST implied). Legacy renamed-letter transcripts omit the
|
||||||
|
// segment entirely; in that case every derived field comes back null
|
||||||
|
// and the header degrades gracefully.
|
||||||
|
//
|
||||||
|
// Returns { ordinal, start: Date|null, end: Date|null, durationMs: number|null }.
|
||||||
|
export function parseTranscriptMeta(filename) {
|
||||||
|
const ordinal = transcriptOrdinal(filename)
|
||||||
|
const m = /-TRANSCRIPT-(\d{4}-\d{2}-\d{2})T(\d{2})-(\d{2})--(\d{4}-\d{2}-\d{2})T(\d{2})-(\d{2})\.md$/.exec(
|
||||||
|
filename || ''
|
||||||
|
)
|
||||||
|
if (!m) {
|
||||||
|
return { ordinal, start: null, end: null, durationMs: null }
|
||||||
|
}
|
||||||
|
const [, sDate, sH, sM, eDate, eH, eM] = m
|
||||||
|
// Parse as local wall-clock time. The filename carries no timezone
|
||||||
|
// (PST is implied per the protocol); we render the wall-clock value
|
||||||
|
// verbatim rather than shifting it, so we build a local Date and read
|
||||||
|
// it back with the same calendar fields. Duration is a difference of
|
||||||
|
// two local Dates, so the implied-timezone ambiguity cancels out.
|
||||||
|
const start = new Date(`${sDate}T${sH}:${sM}:00`)
|
||||||
|
const end = new Date(`${eDate}T${eH}:${eM}:00`)
|
||||||
|
const startOk = !Number.isNaN(start.getTime())
|
||||||
|
const endOk = !Number.isNaN(end.getTime())
|
||||||
|
const durationMs =
|
||||||
|
startOk && endOk && end.getTime() >= start.getTime()
|
||||||
|
? end.getTime() - start.getTime()
|
||||||
|
: null
|
||||||
|
return {
|
||||||
|
ordinal,
|
||||||
|
start: startOk ? start : null,
|
||||||
|
end: endOk ? end : null,
|
||||||
|
durationMs,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function fmtDateTime(d) {
|
||||||
|
if (!d) return null
|
||||||
|
// e.g. "May 28, 2026, 11:11 AM" — human-readable, wall-clock.
|
||||||
|
try {
|
||||||
|
return d.toLocaleString(undefined, {
|
||||||
|
year: 'numeric',
|
||||||
|
month: 'short',
|
||||||
|
day: 'numeric',
|
||||||
|
hour: 'numeric',
|
||||||
|
minute: '2-digit',
|
||||||
|
})
|
||||||
|
} catch {
|
||||||
|
return d.toISOString()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function fmtDuration(ms) {
|
||||||
|
if (ms == null || ms <= 0) return null
|
||||||
|
const totalMin = Math.round(ms / 60000)
|
||||||
|
const h = Math.floor(totalMin / 60)
|
||||||
|
const m = totalMin % 60
|
||||||
|
if (h > 0 && m > 0) return `${h}h ${m}m`
|
||||||
|
if (h > 0) return `${h}h`
|
||||||
|
return `${m}m`
|
||||||
|
}
|
||||||
|
|
||||||
|
// The compact metadata block rendered above every transcript body.
|
||||||
|
// Shared between the standalone transcript route and the session-root
|
||||||
|
// inline-collapse view. `tldr` is optional — absent ⇒ rendered nothing
|
||||||
|
// (graceful degrade, per the manifest schema where `tldr` may be unset).
|
||||||
|
export function TranscriptMetaHeader({ nnnn, filename, title, tldr }) {
|
||||||
|
const { ordinal, start, end, durationMs } = parseTranscriptMeta(filename)
|
||||||
|
const started = fmtDateTime(start)
|
||||||
|
const ended = fmtDateTime(end)
|
||||||
|
const duration = fmtDuration(durationMs)
|
||||||
|
const heading = title ? `${ordinal} — ${title}` : `Session ${ordinal}`
|
||||||
|
|
||||||
|
return (
|
||||||
|
<header className="docs-transcript-meta">
|
||||||
|
<h2 className="docs-transcript-meta-title">{heading}</h2>
|
||||||
|
{(started || ended || duration) && (
|
||||||
|
<dl className="docs-transcript-meta-grid">
|
||||||
|
{started && (
|
||||||
|
<div className="docs-transcript-meta-row">
|
||||||
|
<dt>Started</dt>
|
||||||
|
<dd>{started}</dd>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{ended && (
|
||||||
|
<div className="docs-transcript-meta-row">
|
||||||
|
<dt>Ended</dt>
|
||||||
|
<dd>{ended}</dd>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{duration && (
|
||||||
|
<div className="docs-transcript-meta-row">
|
||||||
|
<dt>Duration</dt>
|
||||||
|
<dd>{duration}</dd>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</dl>
|
||||||
|
)}
|
||||||
|
{tldr && <p className="docs-transcript-meta-tldr">{tldr}</p>}
|
||||||
|
<a
|
||||||
|
className="docs-source-link docs-transcript-meta-source"
|
||||||
|
href={gitSourceUrl(nnnn, filename)}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
aria-label={`View transcript ${ordinal} source on git.wiggleverse.org`}
|
||||||
|
data-amp-track-name="Docs Transcript Source Link"
|
||||||
|
data-amp-track-session={nnnn}
|
||||||
|
data-amp-track-filename={filename}
|
||||||
|
>
|
||||||
|
View source on git.wiggleverse.org ↗
|
||||||
|
</a>
|
||||||
|
</header>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function DocsSessionTranscript() {
|
||||||
|
const { nnnn, filename } = useParams()
|
||||||
|
const [body, setBody] = useState('')
|
||||||
|
const [title, setTitle] = useState('')
|
||||||
|
const [tldr, setTldr] = useState('')
|
||||||
|
const [status, setStatus] = useState('loading') // loading | ok | notfound | error
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: `sessions/${nnnn}/${filename}` })
|
||||||
|
}, [nnnn, filename])
|
||||||
|
|
||||||
|
// Title + optional tl;dr from the manifest — decorative metadata that
|
||||||
|
// feeds the header. Failure leaves the header showing the bare NNNN
|
||||||
|
// and no TL;DR; the body fetch below is the load-bearing one.
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
getSessionsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
const entry = (payload && payload[nnnn]) || {}
|
||||||
|
setTitle(entry.title || '')
|
||||||
|
setTldr(typeof entry.tldr === 'string' ? entry.tldr : '')
|
||||||
|
})
|
||||||
|
.catch(() => {})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [nnnn])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setStatus('loading')
|
||||||
|
getSessionTranscript(nnnn, filename)
|
||||||
|
.then(text => {
|
||||||
|
if (!active) return
|
||||||
|
setBody(text || '')
|
||||||
|
setStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(e => {
|
||||||
|
if (!active) return
|
||||||
|
if (e.status === 404) {
|
||||||
|
setStatus('notfound')
|
||||||
|
} else {
|
||||||
|
setStatus('error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [nnnn, filename, reloadTick])
|
||||||
|
|
||||||
|
const retry = useCallback(() => setReloadTick(t => t + 1), [])
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<div className="docs-breadcrumbs">
|
||||||
|
<Link
|
||||||
|
to={`/docs/sessions/${nnnn}`}
|
||||||
|
aria-label={`Back to session ${nnnn} index`}
|
||||||
|
data-amp-track-name="Docs Transcript Back To Index"
|
||||||
|
>
|
||||||
|
← Session {nnnn}
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
{status === 'notfound' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>This transcript isn't published yet.</p>
|
||||||
|
<p>
|
||||||
|
<Link
|
||||||
|
to={`/docs/sessions/${nnnn}`}
|
||||||
|
aria-label={`Back to session ${nnnn}`}
|
||||||
|
data-amp-track-name="Docs Transcript Back To Session"
|
||||||
|
>
|
||||||
|
← Back to session {nnnn}
|
||||||
|
</Link>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't reach the session-history repo.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs Transcript Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'ok' && (
|
||||||
|
<>
|
||||||
|
<TranscriptMetaHeader
|
||||||
|
nnnn={nnnn}
|
||||||
|
filename={filename}
|
||||||
|
title={title}
|
||||||
|
tldr={tldr}
|
||||||
|
/>
|
||||||
|
<div className="philosophy-body">
|
||||||
|
<MarkdownPreview content={body} />
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
// DocsSessionsAbout.jsx — v0.19.0 / roadmap item #30.
|
||||||
|
//
|
||||||
|
// Renders the README.md of the public `wiggleverse/ohm-session-history`
|
||||||
|
// repo at `/docs/sessions/about`. The framework backend mediates the
|
||||||
|
// gitea fetch (see backend/app/docs_sessions.py); this component
|
||||||
|
// handles three response paths:
|
||||||
|
//
|
||||||
|
// 200 → render the markdown via MarkdownPreview
|
||||||
|
// 404 → "About not yet published" empty-state (the upstream README
|
||||||
|
// doesn't exist yet — happens when a deployment hasn't
|
||||||
|
// restructured its session-history repo yet, expected at
|
||||||
|
// v0.19.0 deploy time per the CHANGELOG)
|
||||||
|
// 502 → "Couldn't reach the session-history repo" with a retry
|
||||||
|
// button. The retry just re-invokes the fetch — no extra
|
||||||
|
// backoff because the backend cache already smoothes
|
||||||
|
// repeated 502s.
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import MarkdownPreview from './MarkdownPreview.jsx'
|
||||||
|
import { getSessionsAbout } from '../api.js'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
|
||||||
|
export default function DocsSessionsAbout() {
|
||||||
|
const [body, setBody] = useState('')
|
||||||
|
const [status, setStatus] = useState('loading') // loading | ok | notfound | error
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: 'sessions/about' })
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setStatus('loading')
|
||||||
|
getSessionsAbout()
|
||||||
|
.then(text => {
|
||||||
|
if (!active) return
|
||||||
|
setBody(text || '')
|
||||||
|
setStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(e => {
|
||||||
|
if (!active) return
|
||||||
|
if (e.status === 404) {
|
||||||
|
setStatus('notfound')
|
||||||
|
} else {
|
||||||
|
setStatus('error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [reloadTick])
|
||||||
|
|
||||||
|
const retry = useCallback(() => setReloadTick(t => t + 1), [])
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<h1 className="docs-article-title">About sessions</h1>
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
{status === 'notfound' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>
|
||||||
|
The session-history About page isn't published yet. Sessions
|
||||||
|
are still authored — once a few have shipped, this page will
|
||||||
|
render the canonical introduction.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
In the meantime, browse the source repo directly at{' '}
|
||||||
|
<a
|
||||||
|
href="https://git.wiggleverse.org/wiggleverse/ohm-session-history"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
aria-label="Open session-history repo on gitea"
|
||||||
|
data-amp-track-name="Docs Sessions About Repo Link"
|
||||||
|
>
|
||||||
|
wiggleverse/ohm-session-history
|
||||||
|
</a>.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't reach the session-history repo.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs Sessions About Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'ok' && (
|
||||||
|
<div className="philosophy-body">
|
||||||
|
<MarkdownPreview content={body} />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
// DocsSpec.jsx — v0.20.0.
|
||||||
|
//
|
||||||
|
// Per-spec view at `/docs/specs/:name`. Fetches a configured spec
|
||||||
|
// body via the backend mediator (which proxies the gitea raw URL)
|
||||||
|
// and renders it through the shared MarkdownPreview. The page header
|
||||||
|
// pulls the spec's `title` from the manifest so the breadcrumb-free
|
||||||
|
// page still names what you're looking at.
|
||||||
|
//
|
||||||
|
// Empty-state contract:
|
||||||
|
// 404 → "This spec isn't published yet / unknown name" with a hint
|
||||||
|
// to pick a configured spec from the nav.
|
||||||
|
// 502 → "Couldn't reach the spec source" + retry button.
|
||||||
|
//
|
||||||
|
// History view is intentionally absent — the operator's framing for
|
||||||
|
// v0.20.0 is "current version only; git is the history surface".
|
||||||
|
// A small "View on gitea" link beside the title points at the
|
||||||
|
// upstream source URL the manifest carries so the history gesture
|
||||||
|
// remains one click away.
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import { Link, useParams } from 'react-router-dom'
|
||||||
|
import MarkdownPreview from './MarkdownPreview.jsx'
|
||||||
|
import { getSpec, getSpecsManifest } from '../api.js'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
|
||||||
|
export default function DocsSpec() {
|
||||||
|
const { name } = useParams()
|
||||||
|
const [title, setTitle] = useState('')
|
||||||
|
const [sourceUrl, setSourceUrl] = useState('')
|
||||||
|
const [body, setBody] = useState('')
|
||||||
|
const [status, setStatus] = useState('loading') // loading | ok | notfound | error
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: `specs/${name}` })
|
||||||
|
}, [name])
|
||||||
|
|
||||||
|
// Title + upstream URL from the manifest (cheap — the manifest is
|
||||||
|
// derived from an env var on the backend, no network).
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
getSpecsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
const entry = (payload && payload.specs || []).find(s => s.name === name)
|
||||||
|
setTitle((entry && entry.title) || '')
|
||||||
|
setSourceUrl((entry && entry.url) || '')
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
// Title + source link are decorative; the body fetch below
|
||||||
|
// is the load-bearing one. A failed manifest fetch just
|
||||||
|
// leaves the page rendering the bare name.
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [name])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setStatus('loading')
|
||||||
|
getSpec(name)
|
||||||
|
.then(text => {
|
||||||
|
if (!active) return
|
||||||
|
setBody(text || '')
|
||||||
|
setStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(e => {
|
||||||
|
if (!active) return
|
||||||
|
if (e.status === 404) {
|
||||||
|
setStatus('notfound')
|
||||||
|
} else {
|
||||||
|
setStatus('error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [name, reloadTick])
|
||||||
|
|
||||||
|
const retry = useCallback(() => setReloadTick(t => t + 1), [])
|
||||||
|
|
||||||
|
const header = title || `Spec: ${name}`
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<header className="docs-article-header">
|
||||||
|
<h1 className="docs-article-title">{header}</h1>
|
||||||
|
{sourceUrl && (
|
||||||
|
<a
|
||||||
|
className="docs-source-link"
|
||||||
|
href={sourceUrl}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
aria-label="View spec source on gitea"
|
||||||
|
data-amp-track-name="Docs Spec Source Link"
|
||||||
|
data-amp-track-spec={name}
|
||||||
|
>
|
||||||
|
View source
|
||||||
|
</a>
|
||||||
|
)}
|
||||||
|
</header>
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
{status === 'notfound' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>This spec isn't available.</p>
|
||||||
|
<p>
|
||||||
|
<Link
|
||||||
|
to="/docs/user-guide"
|
||||||
|
aria-label="User guide"
|
||||||
|
data-amp-track-name="Docs Spec Notfound User Guide Link"
|
||||||
|
>
|
||||||
|
← Back to the user guide
|
||||||
|
</Link>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't reach the spec source.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs Spec Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'ok' && (
|
||||||
|
<div className="philosophy-body">
|
||||||
|
<MarkdownPreview content={body} />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
// DocsSpecsIndex.jsx — v0.20.0.
|
||||||
|
//
|
||||||
|
// Landing route at `/docs/specs`. The operator-stated body shape for
|
||||||
|
// the parallel `/docs/sessions/:nnnn` page is "no body list — pick a
|
||||||
|
// transcript from the nav", and the same gesture applies here: the
|
||||||
|
// `/docs/specs` route either redirects to the first configured spec
|
||||||
|
// (the common case) or renders a "no specs configured" empty state
|
||||||
|
// (only reachable if a deployment overrides `OHM_DOCS_SPECS` to an
|
||||||
|
// empty list — the framework default has two entries).
|
||||||
|
//
|
||||||
|
// The redirect is client-side because the manifest is a single API
|
||||||
|
// call away; server-side redirect would require either a backend
|
||||||
|
// route for the bare `/docs/specs` path (out of scope for v0.20.0)
|
||||||
|
// or a build-time bake of the first spec name (which couples the
|
||||||
|
// frontend bundle to the deployment overlay, which we don't do).
|
||||||
|
|
||||||
|
import { useEffect, useState } from 'react'
|
||||||
|
import { Navigate, Link } from 'react-router-dom'
|
||||||
|
import { getSpecsManifest } from '../api.js'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
|
||||||
|
export default function DocsSpecsIndex() {
|
||||||
|
const [firstName, setFirstName] = useState(null)
|
||||||
|
// Tri-state: 'loading' (waiting on manifest), 'redirect' (we have a
|
||||||
|
// name to redirect to — render <Navigate>), 'empty' (no specs
|
||||||
|
// configured), or 'error' (couldn't load the manifest at all).
|
||||||
|
const [status, setStatus] = useState('loading')
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: 'specs' })
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
getSpecsManifest()
|
||||||
|
.then(payload => {
|
||||||
|
if (!active) return
|
||||||
|
const specs = (payload && payload.specs) || []
|
||||||
|
if (specs.length === 0) {
|
||||||
|
setStatus('empty')
|
||||||
|
} else {
|
||||||
|
setFirstName(specs[0].name)
|
||||||
|
setStatus('redirect')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
if (!active) return
|
||||||
|
setStatus('error')
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
if (status === 'redirect' && firstName) {
|
||||||
|
return <Navigate to={firstName} replace />
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<h1 className="docs-article-title">Specs</h1>
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
{status === 'empty' && (
|
||||||
|
<div className="docs-empty">
|
||||||
|
<p>No specs are configured for this deployment.</p>
|
||||||
|
<p>
|
||||||
|
<Link
|
||||||
|
to="/docs/user-guide"
|
||||||
|
aria-label="User guide"
|
||||||
|
data-amp-track-name="Docs Specs Empty User Guide Link"
|
||||||
|
>
|
||||||
|
← Back to the user guide
|
||||||
|
</Link>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't load the spec list.</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
// DocsUserGuide.jsx — v0.19.0 / roadmap item #30.
|
||||||
|
//
|
||||||
|
// Renders DOCS.md at `/docs/user-guide`. Was `/docs` before v0.19.0
|
||||||
|
// (the v0.14.0 single-route Docs.jsx surface, now superseded). The
|
||||||
|
// content path is unchanged: backend reads `DOCS.md` from disk and
|
||||||
|
// serves it at `/api/docs`. The body is rendered via the existing
|
||||||
|
// `MarkdownPreview` (the same component the `/philosophy` route uses,
|
||||||
|
// so we don't introduce a second markdown library).
|
||||||
|
|
||||||
|
// v0.21.0 / roadmap item #31: the loading + error states are brought
|
||||||
|
// onto the same `.docs-empty` / `.docs-error` convention every other
|
||||||
|
// docs surface uses (was a bare `<p className="error">`), with a retry
|
||||||
|
// button so a transient `/api/docs` failure isn't a dead end.
|
||||||
|
|
||||||
|
import { useEffect, useState, useCallback } from 'react'
|
||||||
|
import { Link } from 'react-router-dom'
|
||||||
|
import MarkdownPreview from './MarkdownPreview.jsx'
|
||||||
|
import { getDocs } from '../api.js'
|
||||||
|
import { EVENTS, track } from '../lib/analytics'
|
||||||
|
|
||||||
|
export default function DocsUserGuide() {
|
||||||
|
const [body, setBody] = useState('')
|
||||||
|
const [status, setStatus] = useState('loading') // loading | ok | error
|
||||||
|
const [reloadTick, setReloadTick] = useState(0)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
track(EVENTS.DOC_VIEWED, { section: 'user-guide' })
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let active = true
|
||||||
|
setStatus('loading')
|
||||||
|
getDocs()
|
||||||
|
.then(r => {
|
||||||
|
if (!active) return
|
||||||
|
setBody(r.body || '')
|
||||||
|
setStatus('ok')
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
if (!active) return
|
||||||
|
setStatus('error')
|
||||||
|
})
|
||||||
|
return () => { active = false }
|
||||||
|
}, [reloadTick])
|
||||||
|
|
||||||
|
const retry = useCallback(() => setReloadTick(t => t + 1), [])
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article className="docs-article">
|
||||||
|
<h1 className="docs-article-title">User guide</h1>
|
||||||
|
{status === 'loading' && <p className="muted">Loading…</p>}
|
||||||
|
{status === 'error' && (
|
||||||
|
<div className="docs-error" role="alert">
|
||||||
|
<p>Couldn't load the user guide.</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={retry}
|
||||||
|
aria-label="Retry"
|
||||||
|
data-amp-track-name="Docs User Guide Retry"
|
||||||
|
>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
<p>
|
||||||
|
<Link
|
||||||
|
to="/docs/sessions/about"
|
||||||
|
aria-label="About sessions"
|
||||||
|
data-amp-track-name="Docs User Guide Error About Link"
|
||||||
|
>
|
||||||
|
About sessions
|
||||||
|
</Link>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{status === 'ok' && (
|
||||||
|
<div className="philosophy-body">
|
||||||
|
<MarkdownPreview content={body} />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,128 @@
|
|||||||
|
/* Inbox.css — §15.2 inbox panel refinements (roadmap #25, light pass).
|
||||||
|
*
|
||||||
|
* The base inbox layout/structure lives in App.css (the §15 / Slice 6
|
||||||
|
* block). This sheet is a TOKENIZED polish layer on top of it: it does
|
||||||
|
* NOT re-lay-out the panel, it sharpens the unread/read distinction,
|
||||||
|
* adds the per-row "mark read" affordance + the unread dot, and gives
|
||||||
|
* the empty/loading states real copy and spacing.
|
||||||
|
*
|
||||||
|
* Cascade note: Inbox.jsx is imported by App.jsx (line 6) BEFORE the
|
||||||
|
* App.css import (line 30), so under ESM depth-first evaluation this
|
||||||
|
* sheet is injected FIRST and App.css wins on equal specificity. Any
|
||||||
|
* rule here that must override an App.css value is therefore written
|
||||||
|
* one notch more specific (e.g. `.inbox-list .inbox-row.unread`).
|
||||||
|
* New classes that App.css doesn't define need no such guard.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* ===== Unread vs. read distinction ===== */
|
||||||
|
|
||||||
|
/* A clear left accent bar + warmer tint on unread; read rows sit calm. */
|
||||||
|
.inbox-list .inbox-row {
|
||||||
|
position: relative;
|
||||||
|
border-bottom: 1px solid var(--color-border);
|
||||||
|
transition: background var(--motion-fast) var(--ease-out);
|
||||||
|
}
|
||||||
|
.inbox-list .inbox-row.unread {
|
||||||
|
background: var(--color-warning-bg-soft, var(--c-warning-bg-soft));
|
||||||
|
box-shadow: inset 3px 0 0 var(--color-accent);
|
||||||
|
}
|
||||||
|
.inbox-list .inbox-row.read .inbox-summary {
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
font-weight: var(--weight-normal);
|
||||||
|
}
|
||||||
|
.inbox-list .inbox-row.unread .inbox-summary {
|
||||||
|
color: var(--color-text);
|
||||||
|
font-weight: var(--weight-medium);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The dot is a NEW affordance: a filled accent dot for unread, hidden
|
||||||
|
* (but space-reserved) for read so summaries stay column-aligned. */
|
||||||
|
.inbox-unread-dot {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
width: 8px;
|
||||||
|
height: 8px;
|
||||||
|
border-radius: var(--radius-pill);
|
||||||
|
background: var(--color-accent);
|
||||||
|
}
|
||||||
|
.inbox-row.read .inbox-unread-dot {
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ===== Per-row "mark read" affordance ===== */
|
||||||
|
|
||||||
|
/* The row is a flex Link followed by this button; pin the button to the
|
||||||
|
* right edge, revealed on row hover/focus and always visible on touch. */
|
||||||
|
.inbox-row {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
.inbox-row .inbox-row-link {
|
||||||
|
flex: 1 1 auto;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
.inbox-row-dismiss {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 28px;
|
||||||
|
height: 28px;
|
||||||
|
margin-right: var(--space-5);
|
||||||
|
padding: 0;
|
||||||
|
color: var(--color-text-subtle);
|
||||||
|
background: transparent;
|
||||||
|
border: 1px solid transparent;
|
||||||
|
border-radius: var(--radius-md);
|
||||||
|
cursor: pointer;
|
||||||
|
opacity: 0;
|
||||||
|
transition:
|
||||||
|
opacity var(--motion-fast) var(--ease-out),
|
||||||
|
color var(--motion-fast) var(--ease-out),
|
||||||
|
background var(--motion-fast) var(--ease-out),
|
||||||
|
border-color var(--motion-fast) var(--ease-out);
|
||||||
|
}
|
||||||
|
.inbox-row:hover .inbox-row-dismiss,
|
||||||
|
.inbox-row:focus-within .inbox-row-dismiss,
|
||||||
|
.inbox-row-dismiss:focus-visible {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
.inbox-row-dismiss:hover {
|
||||||
|
color: var(--color-success-fg);
|
||||||
|
background: var(--color-success-bg);
|
||||||
|
border-color: var(--color-success-bg);
|
||||||
|
}
|
||||||
|
.inbox-row-dismiss:focus-visible {
|
||||||
|
outline: 2px solid var(--color-focus-ring);
|
||||||
|
outline-offset: 1px;
|
||||||
|
}
|
||||||
|
/* Coarse pointers (touch) have no hover; keep the affordance discoverable. */
|
||||||
|
@media (hover: none) {
|
||||||
|
.inbox-row-dismiss { opacity: 1; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ===== Mark-all-read button ===== */
|
||||||
|
.inbox-mark-all {
|
||||||
|
margin-left: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ===== Empty / loading states ===== */
|
||||||
|
.inbox-state {
|
||||||
|
padding: var(--space-9) var(--space-7);
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.inbox-empty {
|
||||||
|
padding: var(--space-11) var(--space-7);
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.inbox-empty-title {
|
||||||
|
margin: 0 0 var(--space-3);
|
||||||
|
font-size: var(--text-md);
|
||||||
|
font-weight: var(--weight-semibold);
|
||||||
|
color: var(--color-text-strong);
|
||||||
|
}
|
||||||
|
.inbox-empty .muted {
|
||||||
|
margin: 0;
|
||||||
|
font-size: var(--text-base);
|
||||||
|
line-height: var(--leading-normal);
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
}
|
||||||
@@ -15,6 +15,7 @@ import {
|
|||||||
markNotificationRead,
|
markNotificationRead,
|
||||||
markNotificationsReadByFilter,
|
markNotificationsReadByFilter,
|
||||||
} from '../api.js'
|
} from '../api.js'
|
||||||
|
import './Inbox.css'
|
||||||
|
|
||||||
const CATEGORIES = [
|
const CATEGORIES = [
|
||||||
{ value: '', label: 'All categories' },
|
{ value: '', label: 'All categories' },
|
||||||
@@ -56,11 +57,15 @@ export default function Inbox({ onClose, lastChangeTick }) {
|
|||||||
return Array.from(seen.entries())
|
return Array.from(seen.entries())
|
||||||
}, [items])
|
}, [items])
|
||||||
|
|
||||||
|
async function markOneRead(item) {
|
||||||
|
if (item.read_at) return
|
||||||
|
await markNotificationRead(item.id)
|
||||||
|
setItems(prev => prev.map(p => p.id === item.id ? { ...p, read_at: new Date().toISOString() } : p))
|
||||||
|
setUnreadCount(c => Math.max(0, c - 1))
|
||||||
|
}
|
||||||
|
|
||||||
async function handleRowClick(item) {
|
async function handleRowClick(item) {
|
||||||
if (!item.read_at) {
|
await markOneRead(item)
|
||||||
await markNotificationRead(item.id)
|
|
||||||
setItems(prev => prev.map(p => p.id === item.id ? { ...p, read_at: new Date().toISOString() } : p))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function markAllUnderFilter() {
|
async function markAllUnderFilter() {
|
||||||
@@ -121,22 +126,36 @@ export default function Inbox({ onClose, lastChangeTick }) {
|
|||||||
</label>
|
</label>
|
||||||
|
|
||||||
<button
|
<button
|
||||||
className="btn-link"
|
className="btn-link inbox-mark-all"
|
||||||
onClick={markAllUnderFilter}
|
onClick={markAllUnderFilter}
|
||||||
disabled={items.every(i => i.read_at)}
|
disabled={items.every(i => i.read_at)}
|
||||||
|
title="Mark every notification matching the current filter as read"
|
||||||
>
|
>
|
||||||
Mark all read (under filter)
|
Mark all read
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="inbox-body">
|
<div className="inbox-body">
|
||||||
{loading && <p className="muted">Loading…</p>}
|
{loading && <p className="inbox-state muted">Loading your inbox…</p>}
|
||||||
{!loading && items.length === 0 && (
|
{!loading && items.length === 0 && (
|
||||||
<p className="muted">No notifications match. Try a different filter, or come back later.</p>
|
<div className="inbox-empty">
|
||||||
|
<p className="inbox-empty-title">You're all caught up.</p>
|
||||||
|
<p className="muted">
|
||||||
|
{filters.unread || filters.rfcSlug || filters.category
|
||||||
|
? 'Nothing matches the current filters. Clear them to see everything.'
|
||||||
|
: 'New activity on RFCs you follow will show up here.'}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
)}
|
)}
|
||||||
<ul className="inbox-list">
|
<ul className="inbox-list">
|
||||||
{items.map(item => (
|
{items.map(item => (
|
||||||
<InboxRow key={item.id} item={item} onClick={handleRowClick} onClose={onClose} />
|
<InboxRow
|
||||||
|
key={item.id}
|
||||||
|
item={item}
|
||||||
|
onClick={handleRowClick}
|
||||||
|
onMarkRead={markOneRead}
|
||||||
|
onClose={onClose}
|
||||||
|
/>
|
||||||
))}
|
))}
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@@ -145,16 +164,24 @@ export default function Inbox({ onClose, lastChangeTick }) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
function InboxRow({ item, onClick, onClose }) {
|
function InboxRow({ item, onClick, onMarkRead, onClose }) {
|
||||||
const unread = !item.read_at
|
const unread = !item.read_at
|
||||||
const target = deepLink(item)
|
const target = deepLink(item)
|
||||||
const handle = async () => {
|
const handle = async () => {
|
||||||
await onClick(item)
|
await onClick(item)
|
||||||
if (target) onClose?.()
|
if (target) onClose?.()
|
||||||
}
|
}
|
||||||
|
const handleMarkRead = async (e) => {
|
||||||
|
// Don't let the row's Link fire — this affordance only marks read,
|
||||||
|
// it never navigates.
|
||||||
|
e.preventDefault()
|
||||||
|
e.stopPropagation()
|
||||||
|
await onMarkRead(item)
|
||||||
|
}
|
||||||
return (
|
return (
|
||||||
<li className={`inbox-row ${unread ? 'unread' : ''}`}>
|
<li className={`inbox-row ${unread ? 'unread' : 'read'}`}>
|
||||||
<Link to={target || '#'} onClick={handle} className="inbox-row-link">
|
<Link to={target || '#'} onClick={handle} className="inbox-row-link">
|
||||||
|
<span className="inbox-unread-dot" aria-hidden />
|
||||||
<span className={`inbox-cat cat-${item.category || 'unknown'}`}>{item.category || '·'}</span>
|
<span className={`inbox-cat cat-${item.category || 'unknown'}`}>{item.category || '·'}</span>
|
||||||
<span className="inbox-summary">{item.summary}</span>
|
<span className="inbox-summary">{item.summary}</span>
|
||||||
{item.bundled_count > 1 && (
|
{item.bundled_count > 1 && (
|
||||||
@@ -162,6 +189,24 @@ function InboxRow({ item, onClick, onClose }) {
|
|||||||
)}
|
)}
|
||||||
<span className="inbox-when">{formatWhen(item.created_at)}</span>
|
<span className="inbox-when">{formatWhen(item.created_at)}</span>
|
||||||
</Link>
|
</Link>
|
||||||
|
{unread && (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className="inbox-row-dismiss"
|
||||||
|
onClick={handleMarkRead}
|
||||||
|
aria-label="Mark as read"
|
||||||
|
title="Mark as read"
|
||||||
|
>
|
||||||
|
{/* check glyph — dependency-free inline SVG */}
|
||||||
|
<svg
|
||||||
|
width="14" height="14" viewBox="0 0 24 24"
|
||||||
|
fill="none" stroke="currentColor" strokeWidth="2.25"
|
||||||
|
strokeLinecap="round" strokeLinejoin="round" aria-hidden
|
||||||
|
>
|
||||||
|
<path d="m5 13 4 4 10-11" />
|
||||||
|
</svg>
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
</li>
|
</li>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,6 +15,8 @@ import { EVENTS, track } from '../lib/analytics'
|
|||||||
export default function PRModal({ slug, branch, branchIsPrivate, onClose, onOpened }) {
|
export default function PRModal({ slug, branch, branchIsPrivate, onClose, onOpened }) {
|
||||||
const [title, setTitle] = useState('')
|
const [title, setTitle] = useState('')
|
||||||
const [description, setDescription] = useState('')
|
const [description, setDescription] = useState('')
|
||||||
|
// #26: optional ground-truth use case for this change.
|
||||||
|
const [useCase, setUseCase] = useState('')
|
||||||
const [drafting, setDrafting] = useState(true)
|
const [drafting, setDrafting] = useState(true)
|
||||||
const [submitting, setSubmitting] = useState(false)
|
const [submitting, setSubmitting] = useState(false)
|
||||||
const [confirmed, setConfirmed] = useState(!branchIsPrivate)
|
const [confirmed, setConfirmed] = useState(!branchIsPrivate)
|
||||||
@@ -39,7 +41,11 @@ export default function PRModal({ slug, branch, branchIsPrivate, onClose, onOpen
|
|||||||
setSubmitting(true)
|
setSubmitting(true)
|
||||||
setError(null)
|
setError(null)
|
||||||
try {
|
try {
|
||||||
const { pr_number } = await openPR(slug, branch, { title: title.trim(), description: description.trim() })
|
const { pr_number } = await openPR(slug, branch, {
|
||||||
|
title: title.trim(),
|
||||||
|
description: description.trim(),
|
||||||
|
proposedUseCase: useCase.trim() || null,
|
||||||
|
})
|
||||||
// v0.15.0 — analytics: fire on §10.2 PR-open success. slug
|
// v0.15.0 — analytics: fire on §10.2 PR-open success. slug
|
||||||
// and pr_number are the join keys; title/description stay out.
|
// and pr_number are the join keys; title/description stay out.
|
||||||
track(EVENTS.PR_OPENED, { rfc_slug: slug, pr_number })
|
track(EVENTS.PR_OPENED, { rfc_slug: slug, pr_number })
|
||||||
@@ -104,6 +110,20 @@ export default function PRModal({ slug, branch, branchIsPrivate, onClose, onOpen
|
|||||||
what was argued, what shifted, what the arbiters are asked
|
what was argued, what shifted, what the arbiters are asked
|
||||||
to consider.
|
to consider.
|
||||||
</p>
|
</p>
|
||||||
|
<label className="modal-label">What will you be using this change for? (optional)</label>
|
||||||
|
<textarea
|
||||||
|
className="modal-textarea"
|
||||||
|
value={useCase}
|
||||||
|
onChange={e => setUseCase(e.target.value)}
|
||||||
|
placeholder="The concrete thing this change unlocks for you. Optional."
|
||||||
|
disabled={drafting || submitting}
|
||||||
|
rows={3}
|
||||||
|
maxLength={8000}
|
||||||
|
/>
|
||||||
|
<p className="field-help">
|
||||||
|
#26: the concrete ground-truth use case — distinct from "why
|
||||||
|
it's needed" above. Leave blank if you'd rather not say.
|
||||||
|
</p>
|
||||||
{error && <p className="field-error">{error}</p>}
|
{error && <p className="field-error">{error}</p>}
|
||||||
</div>
|
</div>
|
||||||
<div className="modal-actions">
|
<div className="modal-actions">
|
||||||
|
|||||||
@@ -220,6 +220,17 @@ export default function PRView({ viewer }) {
|
|||||||
{pr.description && (
|
{pr.description && (
|
||||||
<p className="pr-description">{pr.description}</p>
|
<p className="pr-description">{pr.description}</p>
|
||||||
)}
|
)}
|
||||||
|
{/* #26: the optional ground-truth use case for this change,
|
||||||
|
captured when the PR was opened. Muted "left blank"
|
||||||
|
treatment when none was supplied. */}
|
||||||
|
<div className="pr-use-case" style={{ margin: '6px 0', fontSize: 13 }}>
|
||||||
|
<span style={{ fontWeight: 700, color: '#888', textTransform: 'uppercase', letterSpacing: '0.05em', fontSize: 11 }}>
|
||||||
|
Intended use case:
|
||||||
|
</span>{' '}
|
||||||
|
{pr.proposed_use_case
|
||||||
|
? <span style={{ whiteSpace: 'pre-wrap' }}>{pr.proposed_use_case}</span>
|
||||||
|
: <span style={{ color: '#999', fontStyle: 'italic' }}>left blank</span>}
|
||||||
|
</div>
|
||||||
{pr.capabilities?.can_edit_text && (
|
{pr.capabilities?.can_edit_text && (
|
||||||
<button className="btn-link" onClick={startHeaderEdit}>Edit title & description</button>
|
<button className="btn-link" onClick={startHeaderEdit}>Edit title & description</button>
|
||||||
)}
|
)}
|
||||||
|
|||||||
@@ -163,6 +163,14 @@ export default function ProposalView({ viewer, onChange }) {
|
|||||||
className="entry-body"
|
className="entry-body"
|
||||||
dangerouslySetInnerHTML={{ __html: marked.parse(data.entry?.body || '') }}
|
dangerouslySetInnerHTML={{ __html: marked.parse(data.entry?.body || '') }}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
{/* #26: the optional ground-truth use case the proposer supplied. */}
|
||||||
|
<h3 style={{ fontSize: 13, fontWeight: 700, color: '#888', textTransform: 'uppercase', letterSpacing: '0.05em', marginTop: 24 }}>
|
||||||
|
Intended use case
|
||||||
|
</h3>
|
||||||
|
{data.proposed_use_case
|
||||||
|
? <div className="entry-body" dangerouslySetInnerHTML={{ __html: marked.parse(data.proposed_use_case) }} />
|
||||||
|
: <p style={{ color: '#999', fontStyle: 'italic' }}>Left blank by the proposer.</p>}
|
||||||
</article>
|
</article>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,6 +26,8 @@ export default function ProposeModal({ viewer, onClose, onSubmitted }) {
|
|||||||
const [slug, setSlug] = useState('')
|
const [slug, setSlug] = useState('')
|
||||||
const [slugEdited, setSlugEdited] = useState(false)
|
const [slugEdited, setSlugEdited] = useState(false)
|
||||||
const [pitch, setPitch] = useState('')
|
const [pitch, setPitch] = useState('')
|
||||||
|
// #26: optional ground-truth use case, sibling to the required pitch.
|
||||||
|
const [useCase, setUseCase] = useState('')
|
||||||
const [tagInput, setTagInput] = useState('')
|
const [tagInput, setTagInput] = useState('')
|
||||||
const [tags, setTags] = useState([])
|
const [tags, setTags] = useState([])
|
||||||
const [submitting, setSubmitting] = useState(false)
|
const [submitting, setSubmitting] = useState(false)
|
||||||
@@ -52,6 +54,7 @@ export default function ProposeModal({ viewer, onClose, onSubmitted }) {
|
|||||||
slug,
|
slug,
|
||||||
pitch: pitch.trim(),
|
pitch: pitch.trim(),
|
||||||
tags,
|
tags,
|
||||||
|
proposedUseCase: useCase.trim() || null,
|
||||||
})
|
})
|
||||||
// v0.15.0 — analytics: fire on the §9.1 propose-RFC submit.
|
// v0.15.0 — analytics: fire on the §9.1 propose-RFC submit.
|
||||||
// Slug is a stable, low-cardinality identifier (kebab-case
|
// Slug is a stable, low-cardinality identifier (kebab-case
|
||||||
@@ -105,6 +108,19 @@ export default function ProposeModal({ viewer, onClose, onSubmitted }) {
|
|||||||
required
|
required
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
<label htmlFor="propose-use-case">What will you be using this RFC for? (optional)</label>
|
||||||
|
<textarea
|
||||||
|
id="propose-use-case"
|
||||||
|
value={useCase}
|
||||||
|
onChange={e => setUseCase(e.target.value)}
|
||||||
|
placeholder="The concrete thing you intend to build or do with this RFC. Optional, but it helps ground the work."
|
||||||
|
rows={3}
|
||||||
|
/>
|
||||||
|
<p className="field-help">
|
||||||
|
The concrete ground-truth use case — distinct from "why it's
|
||||||
|
needed" above. Leave blank if you'd rather not say.
|
||||||
|
</p>
|
||||||
|
|
||||||
<label htmlFor="propose-tag">Tags (optional)</label>
|
<label htmlFor="propose-tag">Tags (optional)</label>
|
||||||
<div style={{ display: 'flex', gap: 6, alignItems: 'center', marginBottom: 4 }}>
|
<div style={{ display: 'flex', gap: 6, alignItems: 'center', marginBottom: 4 }}>
|
||||||
<input
|
<input
|
||||||
|
|||||||
@@ -669,6 +669,19 @@ export default function RFCView({ viewer }) {
|
|||||||
: 'main is read-only — PRs are the only path to change it. Open a branch to propose edits.'}
|
: 'main is read-only — PRs are the only path to change it. Open a branch to propose edits.'}
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
{/* #26: the optional ground-truth use case captured at propose
|
||||||
|
time. Shown on the canonical (main) view; muted "left blank"
|
||||||
|
treatment when the proposer didn't supply one. */}
|
||||||
|
{branchParam === 'main' && (
|
||||||
|
<div className="rfc-use-case" style={{ margin: '8px 0 16px', padding: '10px 14px', borderLeft: '3px solid #e0e0e0', background: '#fafafa' }}>
|
||||||
|
<div style={{ fontSize: 11, fontWeight: 700, color: '#888', textTransform: 'uppercase', letterSpacing: '0.05em', marginBottom: 4 }}>
|
||||||
|
Intended use case
|
||||||
|
</div>
|
||||||
|
{entry.proposed_use_case
|
||||||
|
? <div style={{ whiteSpace: 'pre-wrap' }}>{entry.proposed_use_case}</div>
|
||||||
|
: <span style={{ color: '#999', fontStyle: 'italic' }}>Left blank by the proposer.</span>}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
{inDiscuss && branchParam !== 'main' && (
|
{inDiscuss && branchParam !== 'main' && (
|
||||||
<div className="discuss-mode-banner">
|
<div className="discuss-mode-banner">
|
||||||
Discuss mode on <strong>{branchParam}</strong> — chat freely;
|
Discuss mode on <strong>{branchParam}</strong> — chat freely;
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
:root {
|
:root {
|
||||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue",
|
font-family: var(--font-sans);
|
||||||
Arial, sans-serif;
|
color: var(--color-text);
|
||||||
color: #1a1a1a;
|
background: var(--color-bg);
|
||||||
background: #fafaf8;
|
|
||||||
-webkit-font-smoothing: antialiased;
|
-webkit-font-smoothing: antialiased;
|
||||||
-moz-osx-font-smoothing: grayscale;
|
-moz-osx-font-smoothing: grayscale;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -97,6 +97,13 @@ export const EVENTS = Object.freeze({
|
|||||||
// v0.17.0 / item #16 — admin-create user + invite email.
|
// v0.17.0 / item #16 — admin-create user + invite email.
|
||||||
USER_INVITED: 'User Invited',
|
USER_INVITED: 'User Invited',
|
||||||
INVITE_CLAIMED: 'Invite Claimed',
|
INVITE_CLAIMED: 'Invite Claimed',
|
||||||
|
// v0.19.0 / item #30 — `/docs/*` flyout + sessions browser. Carries
|
||||||
|
// `section`: 'user-guide' | 'sessions/about' | 'sessions/<NNNN>' |
|
||||||
|
// 'sessions/<NNNN>/<filename>' so the dashboard can answer which
|
||||||
|
// docs surfaces get read most. The transcript-section value includes
|
||||||
|
// the filename so an aggregator can group by `sessions/<NNNN>` or by
|
||||||
|
// exact transcript.
|
||||||
|
DOC_VIEWED: 'Doc Viewed',
|
||||||
})
|
})
|
||||||
|
|
||||||
// Internal state.
|
// Internal state.
|
||||||
|
|||||||
@@ -0,0 +1,91 @@
|
|||||||
|
// useLastState — v0.23.0 / roadmap item #29: server-side sign-in state
|
||||||
|
// resume. Two responsibilities, kept in one small hook so App.jsx's
|
||||||
|
// surface stays minimal:
|
||||||
|
//
|
||||||
|
// 1. Debounce-post the authenticated user's current route to
|
||||||
|
// `PUT /api/me/last-state` on every route change (~1s debounce so
|
||||||
|
// a fast click-through doesn't spray the endpoint). Anonymous
|
||||||
|
// users: no-op. Best-effort: a failed POST never disrupts nav.
|
||||||
|
//
|
||||||
|
// 2. On the first authenticated load, read the stored `last_route`
|
||||||
|
// (handed back on `/api/auth/me`) and `navigate()` to it ONCE.
|
||||||
|
// Stale routes (a withdrawn RFC, a slug the user lost rights to)
|
||||||
|
// are not special-cased here: navigating lands on whatever that
|
||||||
|
// route renders today, and the existing routing already falls
|
||||||
|
// through to the catalog/empty-state for a missing RFC. Keeping
|
||||||
|
// this dumb is deliberate (see SPEC §6.2 + the #29 scope note).
|
||||||
|
//
|
||||||
|
// Ordering with #21 Part C (Amplitude identify): App.jsx fires
|
||||||
|
// `identify` in its own effect when `me.user.id` first appears. This
|
||||||
|
// hook's resume redirect is gated on `identifyReady` — App.jsx flips it
|
||||||
|
// true only after the identify effect has run — so the redirect always
|
||||||
|
// happens AFTER identify, preserving the identify-then-track ordering
|
||||||
|
// the roadmap calls out.
|
||||||
|
import { useEffect, useRef } from 'react'
|
||||||
|
import { putLastState } from '../api'
|
||||||
|
|
||||||
|
// ~1s debounce on the route-change POST. A frontend constant, not a
|
||||||
|
// server knob — the backend takes whatever lands.
|
||||||
|
const DEBOUNCE_MS = 1000
|
||||||
|
|
||||||
|
// Routes we never want to resume *to* — auth/landing surfaces that
|
||||||
|
// would be nonsensical or hostile to drop a returning user onto. We
|
||||||
|
// still record them (cheap, and the user may legitimately be sitting on
|
||||||
|
// /docs), but the resume redirect skips them and falls through to the
|
||||||
|
// default landing. Anything not listed resumes normally.
|
||||||
|
const NON_RESUMABLE_PREFIXES = ['/login', '/welcome', '/invites/', '/invitations/']
|
||||||
|
|
||||||
|
function isResumable(route) {
|
||||||
|
if (!route || typeof route !== 'string') return false
|
||||||
|
if (route === '/') return false // "/" is already the default landing
|
||||||
|
return !NON_RESUMABLE_PREFIXES.some(p => route.startsWith(p))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {object} opts
|
||||||
|
* @param {boolean} opts.authenticated whether a viewer is signed in
|
||||||
|
* @param {string} opts.pathname current location.pathname
|
||||||
|
* @param {boolean} opts.identifyReady App flips true after identify fires
|
||||||
|
* @param {string|null} opts.lastRoute stored route from /api/auth/me
|
||||||
|
* @param {function} opts.navigate react-router navigate()
|
||||||
|
*/
|
||||||
|
export function useLastState({ authenticated, pathname, identifyReady, lastRoute, navigate }) {
|
||||||
|
// ── 1. Debounced route-change POST ────────────────────────────────
|
||||||
|
const timerRef = useRef(null)
|
||||||
|
useEffect(() => {
|
||||||
|
if (!authenticated) return undefined
|
||||||
|
if (timerRef.current) clearTimeout(timerRef.current)
|
||||||
|
timerRef.current = setTimeout(() => {
|
||||||
|
// Best-effort — swallow failures so an offline/401 POST never
|
||||||
|
// surfaces as a navigation error.
|
||||||
|
putLastState(pathname).catch(() => {})
|
||||||
|
}, DEBOUNCE_MS)
|
||||||
|
return () => {
|
||||||
|
if (timerRef.current) clearTimeout(timerRef.current)
|
||||||
|
}
|
||||||
|
}, [authenticated, pathname])
|
||||||
|
|
||||||
|
// ── 2. One-time resume redirect ───────────────────────────────────
|
||||||
|
// Fires once, after identify is ready, when there's a resumable
|
||||||
|
// stored route AND the user is currently sitting on the default
|
||||||
|
// landing ("/"). We only redirect from "/" so we never yank a user
|
||||||
|
// who deep-linked somewhere specific (or refreshed mid-RFC) back to
|
||||||
|
// their last route.
|
||||||
|
const resumedRef = useRef(false)
|
||||||
|
useEffect(() => {
|
||||||
|
if (resumedRef.current) return
|
||||||
|
if (!authenticated || !identifyReady) return
|
||||||
|
// Only resume when the app booted on the default landing — a hard
|
||||||
|
// sign-in nav lands on "/", which is exactly the case we want.
|
||||||
|
if (pathname !== '/') {
|
||||||
|
resumedRef.current = true // user deep-linked; don't resume later either
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (isResumable(lastRoute)) {
|
||||||
|
resumedRef.current = true
|
||||||
|
navigate(lastRoute, { replace: true })
|
||||||
|
} else {
|
||||||
|
resumedRef.current = true // nothing to resume to; keep default landing
|
||||||
|
}
|
||||||
|
}, [authenticated, identifyReady, lastRoute, pathname, navigate])
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ import React from 'react'
|
|||||||
import ReactDOM from 'react-dom/client'
|
import ReactDOM from 'react-dom/client'
|
||||||
import { BrowserRouter } from 'react-router-dom'
|
import { BrowserRouter } from 'react-router-dom'
|
||||||
import App from './App.jsx'
|
import App from './App.jsx'
|
||||||
|
import './styles/tokens.css'
|
||||||
import './index.css'
|
import './index.css'
|
||||||
|
|
||||||
ReactDOM.createRoot(document.getElementById('root')).render(
|
ReactDOM.createRoot(document.getElementById('root')).render(
|
||||||
|
|||||||
@@ -0,0 +1,162 @@
|
|||||||
|
/* tokens.css — the design-token foundation for rfc-app's UI.
|
||||||
|
*
|
||||||
|
* Roadmap item #31 (comprehensive UX polish). Before this file the app
|
||||||
|
* had ~98 distinct hardcoded hex colors, font sizes scattered across 16
|
||||||
|
* values with no scale, and radii across 13 values — classic prototype
|
||||||
|
* sprawl. This module establishes ONE coherent system; the App.css sweep
|
||||||
|
* (and component-scoped CSS) reference these custom properties instead of
|
||||||
|
* literal values, so "what color/size/space is this" has a single answer.
|
||||||
|
*
|
||||||
|
* Imported FIRST in main.jsx so :root is defined before any other sheet.
|
||||||
|
* Custom properties are not cascade-order-sensitive at use time, but
|
||||||
|
* importing first keeps the dependency obvious.
|
||||||
|
*
|
||||||
|
* Conventions for anyone sweeping values to these tokens:
|
||||||
|
* - Map each literal to the NEAREST semantic token, then fall back to a
|
||||||
|
* primitive ramp step. Consolidating near-duplicate grays is the point.
|
||||||
|
* - Never invent a new literal in a component; add a token here instead.
|
||||||
|
* - Spacing/radii/type use the scales below — no off-scale px values.
|
||||||
|
*/
|
||||||
|
|
||||||
|
:root {
|
||||||
|
/* ===== Color primitives — neutral ramp ===== */
|
||||||
|
--c-white: #ffffff;
|
||||||
|
--c-gray-50: #fafafa;
|
||||||
|
--c-gray-100: #f3f4f6;
|
||||||
|
--c-gray-150: #f0f0ee; /* the app's warm canvas tint */
|
||||||
|
--c-gray-200: #e5e7eb;
|
||||||
|
--c-gray-300: #d1d5db;
|
||||||
|
--c-gray-400: #9ca3af;
|
||||||
|
--c-gray-500: #6b7280;
|
||||||
|
--c-gray-600: #4b5563;
|
||||||
|
--c-gray-700: #374151;
|
||||||
|
--c-gray-800: #1f2937;
|
||||||
|
--c-gray-900: #111111;
|
||||||
|
--c-ink: #1a1a1a; /* near-black used for the header + body text */
|
||||||
|
|
||||||
|
/* ===== Color primitives — accent (indigo/violet) ===== */
|
||||||
|
--c-accent: #5b5bd6;
|
||||||
|
--c-accent-strong: #4338ca;
|
||||||
|
--c-violet: #7c3aed;
|
||||||
|
|
||||||
|
/* ===== Color primitives — status ===== */
|
||||||
|
--c-success-fg: #166534;
|
||||||
|
--c-success-bg: #dcfce7;
|
||||||
|
--c-danger-fg: #991b1b;
|
||||||
|
--c-danger-fg-strong: #b91c1c;
|
||||||
|
--c-danger-bg: #fef2f2;
|
||||||
|
--c-danger-border: #fecaca;
|
||||||
|
--c-warning-fg: #92400e;
|
||||||
|
--c-warning-accent: #b45309;
|
||||||
|
--c-warning-bg: #fef3c7;
|
||||||
|
--c-warning-bg-soft:#fffbeb;
|
||||||
|
|
||||||
|
/* ===== Semantic colors ===== */
|
||||||
|
--color-bg: var(--c-gray-150);
|
||||||
|
--color-surface: var(--c-white);
|
||||||
|
--color-surface-sunken: var(--c-gray-50);
|
||||||
|
--color-surface-muted: var(--c-gray-100);
|
||||||
|
--color-header-bg: var(--c-ink);
|
||||||
|
|
||||||
|
--color-text: var(--c-ink);
|
||||||
|
--color-text-strong: var(--c-gray-900);
|
||||||
|
--color-text-muted: var(--c-gray-500);
|
||||||
|
--color-text-subtle: var(--c-gray-400);
|
||||||
|
--color-text-inverse: var(--c-white);
|
||||||
|
|
||||||
|
--color-border: var(--c-gray-200);
|
||||||
|
--color-border-strong: var(--c-gray-300);
|
||||||
|
|
||||||
|
--color-link: var(--c-accent);
|
||||||
|
--color-accent: var(--c-accent);
|
||||||
|
--color-accent-strong: var(--c-accent-strong);
|
||||||
|
--color-accent-contrast: var(--c-white);
|
||||||
|
|
||||||
|
--color-success-fg: var(--c-success-fg);
|
||||||
|
--color-success-bg: var(--c-success-bg);
|
||||||
|
--color-danger-fg: var(--c-danger-fg);
|
||||||
|
--color-danger-bg: var(--c-danger-bg);
|
||||||
|
--color-warning-fg: var(--c-warning-fg);
|
||||||
|
--color-warning-bg: var(--c-warning-bg);
|
||||||
|
|
||||||
|
/* On the dark header, translucent white is the established pattern. */
|
||||||
|
--color-on-dark-soft: rgba(255, 255, 255, 0.15);
|
||||||
|
--color-on-dark-hover: rgba(255, 255, 255, 0.25);
|
||||||
|
--color-on-dark-muted: #dddddd;
|
||||||
|
|
||||||
|
--color-focus-ring: rgba(91, 91, 214, 0.45);
|
||||||
|
|
||||||
|
/* ===== Type ===== */
|
||||||
|
--font-sans: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
||||||
|
Helvetica, Arial, sans-serif;
|
||||||
|
--font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas,
|
||||||
|
monospace;
|
||||||
|
|
||||||
|
--text-2xs: 10px;
|
||||||
|
--text-xs: 11px;
|
||||||
|
--text-sm: 12px;
|
||||||
|
--text-base: 13px; /* the app's dominant body size */
|
||||||
|
--text-md: 14px;
|
||||||
|
--text-lg: 16px;
|
||||||
|
--text-xl: 18px;
|
||||||
|
--text-2xl: 22px;
|
||||||
|
--text-3xl: 28px;
|
||||||
|
|
||||||
|
--leading-tight: 1.25;
|
||||||
|
--leading-normal: 1.5;
|
||||||
|
--leading-relaxed: 1.65;
|
||||||
|
|
||||||
|
--weight-normal: 400;
|
||||||
|
--weight-medium: 500;
|
||||||
|
--weight-semibold: 600;
|
||||||
|
--weight-bold: 700;
|
||||||
|
|
||||||
|
/* ===== Spacing scale (4-based, with the 2/6/10 half-steps the app
|
||||||
|
* already leans on heavily) ===== */
|
||||||
|
--space-0: 0;
|
||||||
|
--space-1: 2px;
|
||||||
|
--space-2: 4px;
|
||||||
|
--space-3: 6px;
|
||||||
|
--space-4: 8px;
|
||||||
|
--space-5: 10px;
|
||||||
|
--space-6: 12px;
|
||||||
|
--space-7: 16px;
|
||||||
|
--space-8: 20px;
|
||||||
|
--space-9: 24px;
|
||||||
|
--space-10: 32px;
|
||||||
|
--space-11: 48px;
|
||||||
|
--space-12: 64px;
|
||||||
|
|
||||||
|
/* ===== Radius ===== */
|
||||||
|
--radius-xs: 2px;
|
||||||
|
--radius-sm: 4px;
|
||||||
|
--radius-md: 6px;
|
||||||
|
--radius-lg: 8px;
|
||||||
|
--radius-xl: 12px;
|
||||||
|
--radius-pill: 999px;
|
||||||
|
|
||||||
|
/* ===== Elevation ===== */
|
||||||
|
--shadow-sm: 0 1px 2px rgba(0, 0, 0, 0.06);
|
||||||
|
--shadow-md: 0 2px 8px rgba(0, 0, 0, 0.08);
|
||||||
|
--shadow-lg: 0 8px 24px rgba(0, 0, 0, 0.12);
|
||||||
|
|
||||||
|
/* ===== Motion ===== */
|
||||||
|
--motion-fast: 120ms;
|
||||||
|
--motion-base: 150ms;
|
||||||
|
--motion-slow: 200ms;
|
||||||
|
--ease-out: cubic-bezier(0.16, 1, 0.3, 1);
|
||||||
|
--ease-in-out: cubic-bezier(0.4, 0, 0.2, 1);
|
||||||
|
|
||||||
|
/* ===== Layout ===== */
|
||||||
|
--header-height: 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Honor reduced-motion globally — any transition/animation that reads
|
||||||
|
* these duration tokens collapses to instant. */
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
:root {
|
||||||
|
--motion-fast: 0ms;
|
||||||
|
--motion-base: 0ms;
|
||||||
|
--motion-slow: 0ms;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user