Files
ersatztv/docs/decisions/records/scan/zero-item-fetch-guard.md
T
timothy fba5233caf
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 11s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Failing after 23s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m17s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 1m29s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m5s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 16m5s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m6s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
feat(610): split the decision corpus into one YAML-frontmatter file per record
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
2026-07-25 19:45:09 +02:00

4.7 KiB

key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
key title status since supersedes superseded-by rule signals mechanics
scan.zero-item-fetch-guard 2026-07-19 — A media-server library sweep refuses to flag when a successful fetch returns zero items, rather than nuking the whole library (#477) active 2026-07-19 none none A media-server library sweep refuses to flag missing items when a successful fetch returns zero incoming items against a non-empty existing set (`MediaServerReconciliationGuard.ShouldFlagMissing`), rather than treating an ambiguous empty result as a full-library deletion. library sweep, zero-item guard, anti-nuke · paths: `MediaServerReconciliationGuard`, `MediaServerTelevisionLibraryScanner`/`MovieLibraryScanner`/`OtherVideoLibraryScanner` · issues: #477, #476 `MediaServerReconciliationGuardTests` policy table

Each media-server scanner reconciles "gone upstream" as existing.Except(incoming) and flags the result FileNotFound. If a successful fetch returns zero items — the server is up but mid-restore / mid-rebuild, or the library was genuinely emptied upstream — then existing.Except([]) is every item, so one scan flags the entire library. That is data-loss-adjacent: EmptyTrashHandler permanently deletes state:FileNotFound rows (a user clicking Empty Trash after a bad scan), and PlayoutSkipMissingItems empties every affected collection (dead channels). There was no zero-count / ratio / server-total guard; the only thing that stopped a mid-pagination failure was an exception unwinding past the flag step — protection by accident of control flow, not by design.

  • The guard is a single shared policy. MediaServerReconciliationGuard.ShouldFlagMissing(logger, libraryName, incomingCount, existingCount) returns false (and logs a Warning) only when incomingCount == 0 && existingCount > 0; every other combination sweeps normally. Wired into the three library-level sweeps — MediaServerTelevisionLibraryScanner (shows), MediaServerMovieLibraryScanner, MediaServerOtherVideoLibraryScanner. One place owns the invariant so the policy can't drift between scanners.
  • An empty incoming set is genuinely ambiguous, so we choose the non-destructive branch. "User removed every item" and "server returned empty erroneously" are indistinguishable at scan time — both report a total of zero (the paginator computes pages from TotalRecordCount, so a 0 total is a clean empty enumeration, not an error). Given the blast radius, skipping wins: the cost of not flagging a legitimately-emptied library (stale rows persist until an item returns or the library is removed by hand) is far smaller than a one-scan permanent wipe of a live library.
  • This partially overrides #476 for the degenerate case, on purpose. #476 cascades a removed show's flag to its seasons/episodes. Its common path — some items removed while survivors are present (incoming non-empty) — still flags and cascades exactly as before. Only the degenerate "the last item was removed, so incoming is empty" case now skips instead of flagging. The #476 characterization test was rewritten from an empty incoming to a survivor-plus-removed partial deletion so it exercises the cascade without tripping the guard.
  • Scope: library-level sweeps only; the nested TV season/episode sweeps are deliberately left unguarded. Their blast radius is one show's seasons / one season's episodes (not the whole library), a per-parent empty is a more plausible legitimate state there, and the #476 descendant cascade already handles a fully removed parent. Guarding them would alter #476's per-parent behaviour for little safety gain.
  • Deferred — ratio threshold and projection-failure detection. The issue also floated "skip if the missing fraction exceeds a threshold" and "distinguish a silently-dropped projection failure from a real deletion." A ratio threshold risks suppressing a legitimate bulk deletion and needs a tunable, telemetry- backed policy; projection-failure detection needs a dropped-count threaded out of JellyfinApiClient through to the scanner (a cross-layer change). The deterministic zero-count guard has no false positives and covers the reported catastrophic case, so both are deferred to a follow-up rather than guessed at here.
  • Tests. MediaServerReconciliationGuardTests pins the policy table (only (0, N>0) skips-and-warns; (0,0), (3,5), (3,0) all sweep). Per-scanner integration tests (MediaServer{Television,Movie,OtherVideo}LibraryScannerTests) prove the wiring: empty incoming + non-empty existing flags nothing and reindexes nothing. Proven non-vacuous by neutralizing the guard and watching all four anti-nuke assertions fail while the (0,0) no-op case stays green.