timothy
fba5233caf
168 records -> docs/decisions/records/<area>/<topic>.md (163 active, 23 dirs) and docs/decisions/archive/<area>/<topic>.md (5 archived). The filename IS the key, so one-active-record-per-key becomes a filesystem property rather than a validator check, and supersession becomes a `git mv`. WHY: the monolith was a concurrency problem before an aesthetic one. A 3,900-line append target made parallel sessions collide -- PR #605 and PR #614 both hit append-vs-append conflicts during routine rebases, and hand-resolving those inside the corpus is exactly the operation the rationale-rewrite guard exists to police. HOW IT IS VERIFIED: a ~170-file diff cannot be meaningfully read, so correctness does not rest on reading it. The parser was taught BOTH formats first, so the body-diff guard parses the old form at the merge-base and the new form at head -- the migration validates itself, no bypass. The proof is a field-level equivalence harness: 168 records before and after, zero lost, zero gained, zero field mismatches, zero rationale bodies differing. Reviewers should scrutinise the harness; it is the actual evidence. What measuring caught that reading would not have: - ~500 lines sit OUTSIDE any record -- decisions.md's lifecycle schema and each topic file's preamble, mostly the only copy. Source files are kept and stripped, never deleted. They also cannot be filed per-area: topic files hold several areas and 4 of 23 areas span several files. - Archive discovery was a non-recursive glob; after the split it found ZERO archived records, surfacing as four bogus "supersedes points to unknown key" errors rather than an obvious failure. - ~32 live docs point into the corpus BY DATE, which the split dangles. Each stripped file now ends with a generated "Records formerly in this file" index, which also rescues the identical breadcrumbs in old issue comments. - decisions.md's "In this file:" list was 97 same-file anchor bullets that the split makes WRONG, not merely stale. Dropped; the generated index replaces them with links that resolve. The equivalence harness now runs against a checked-in FIXTURE, not the live corpus. The earlier version migrated the real tree, which made it a one-shot: the moment the migration landed there was nothing left to move and the tests failed for reasons unrelated to the code. A fixture keeps them testing the SCRIPT rather than the repo's current state. Keys preserved verbatim, warts included: `sched` (12) and `scheduling` (1) remain two directories for one concept. Renaming a key is not a move -- it changes identity, breaks the equivalence proof, and invalidates MemPalace's per-key drawers. Taxonomy normalisation is separate work. refs #610
3.8 KiB
key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
| key | title | status | since | supersedes | superseded-by | rule | signals | mechanics |
|---|---|---|---|---|---|---|---|---|
| api.healthcheck-remediation-dto | 2026-07-17 — Health-check remediation is server-declared `{Kind, Target}` on an additive DTO; the SPA acts on it (#164) | active | 2026-07-17 | none | none | Health-check remediation is server-declared `{Kind, Target}` metadata on an additive DTO field; the SPA renders/acts on it, it doesn't derive labels itself. | health checks, remediation, AppRoute/ExternalDoc · paths: `HealthCheckResponseModel`, `HealthCheckLink` · issues: #164, #286, #108 | `HealthCheckResponseModel.Remediation`; Application `Mapper.GetStatus` |
#164 asked to make the ~14 health checks actionable — the Dashboard health panel showed problems with no way to investigate or fix them. Two structural decisions came out of it.
Remediation is server-declared metadata, not SPA-derived. Each check that has a fix knows where the
fix lives, so the check declares it. The domain HealthCheckLink grew from (string Link) to
(string Target, HealthCheckLinkKind Kind) with Kind ∈ {ExternalDoc, AppRoute} and two factories
(HealthCheckLink.ExternalDoc(url) / HealthCheckLink.AppRoute("/app/...")). Only the 4 checks that
built links and the API mapper touched .Link, so the widening was local. The SPA then acts on the
kind: AppRoute → client-side navigateToPath(target) button; ExternalDoc → new-tab anchor. The
human label is derived SPA-side from the route (a small lookup + prettified fallback) rather than sent
over the wire — keeping the DTO minimal.
The DTO evolved additively (/api/v1 is frozen-additive, #286). HealthCheckResponseModel kept
its existing Detail and gained Brief (← the domain BriefMessage the old mapper silently dropped)
and Remediation { Kind, Target } (a nested HealthCheckRemediationResponseModel). The old flat
string? Link is kept and still populated (mirrors Remediation.Target) but documented deprecated —
we don't remove a frozen field, and existing consumers keep working. Remediation.Kind is a plain
string ("ExternalDoc"/"AppRoute") mapped in the Application Mapper exactly like Status
("pass"/"fail"/…), not a wire enum — matching the established pattern for that DTO.
Three defects the audit surfaced, fixed here. (1) The Application Mapper.GetStatus threw
ArgumentOutOfRangeException on NotApplicable; the handler filters NotApplicable before mapping so
it was latent, but the mapper is now total (defense-in-depth — a future caller that skips the filter
can't 500 the endpoint). InternalsVisibleTo("ErsatzTV.Tests") was added to the Application assembly
(mirroring Core's precedent) to unit-test that totality directly. (2) Two checks linked to stale
Blazor routes (media/trash, search?query=…) — repointed to the SPA /app/trash and
/app/search?query=… as AppRoutes. (3) A dead Open Classic UI → /system/health link lingered in
SettingsScreen (a #91b leftover that just 302'd to /app); removed (see blazor-route-parity.md
Section 4 correction).
Actionable checks that had no link gained an AppRoute (metadata → /app/libraries, empty
schedules → /app/schedules, HW-accel / VAAPI → /app/ffmpeg-profiles, FFmpeg reports → /app/settings).
Pure-noise / no-clean-action checks (UnifiedDocker, MacOsConfigFolder, FFmpegCapabilities, the Info-tier
nags) were left untouched — semantic-tier changes (e.g. adding a Pass path, demoting a nag) were
deliberately not bundled into a remediation-UX PR.
Deferred (own issue): a TTL cache for PerformHealthChecks (#108 — every GET /api/v1/health
re-runs all 14 checks, 4 shelling out to ffmpeg, and the existing summary cache is write-only dead
code). Orthogonal to the UX; filed separately so a SPA-polled health panel gets a cache before it
polls.