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
4.5 KiB
key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
| key | title | status | since | supersedes | superseded-by | rule | signals | mechanics |
|---|---|---|---|---|---|---|---|---|
| sched.shuffle-source-builder | 2026-07-17 — Shuffle-source construction extracted to `ShuffleSourceBuilder`; per-family seam, not a god-factory (#380) | active | 2026-07-17 | none | none | Shuffle-source construction moves to a static, DI-free `ShuffleSourceBuilder` (a shared seam, not a service) so Classic and Playlist stop cross-engine reaching into `PlayoutBuilder` statics; a unified Classic+Playlist enumerator factory is explicitly rejected as a god-factory. Block/Scripted/YAML duplication is left alone, deferred to a follow-up gated on #381. | ShuffleSourceBuilder, PlaybackOrder, cross-engine reach-in, god-factory rejection · paths: `ErsatzTV.Core/Scheduling/ShuffleSourceBuilder.cs`, `PlayoutBuilder`, `PlaylistEnumerator` · issues: #380, #163, #176, #70, #381 | `ShuffleSourceBuilder.GetGroupedMediaItemsForShuffle`/`GetCollectionItemsForShuffleInOrder`; `classic-shuffle` golden in `PlayoutBuildGoldenTests` |
PlaybackOrder is turned into an enumerator at five independent sites (one per schedule kind, dispatched
by BuildPlayoutHandler on ScheduleKind): Classic (PlayoutBuilder), Block (BlockPlayoutBuilder,
PlayoutHistory rotation), Scripted (SchedulingEngine.EnumeratorForContent), Sequential/YAML
(EnumeratorCache), and the Playlist leaf (PlaylistEnumerator.Create, consumed by the others). These
are not accidental duplication — they map the same enum to different enumerator families keyed on
different state models (Block's history cursor vs the stateless-index CollectionEnumeratorState
enumerators). The real smell was one cross-engine reach-in: PlaylistEnumerator called
PlayoutBuilder.GetGroupedMediaItemsForShuffle / GetCollectionItemsForShuffleInOrder as statics —
one engine reaching into another engine's class.
- Fix (a) shipped, not (b). The two shuffle-source helpers moved verbatim to a new
public static class ShuffleSourceBuilderinErsatzTV.Core/Scheduling(sibling to the also-staticMultiCollectionGrouper/MultiPartEpisodeGrouper; dependencies passed as parameters, not a DI service —PlaylistEnumerator.Createis itself a static factory). Both Classic and Playlist now consume it, so the reach-in is gone and shuffle-source construction lives in one directly-unit-tested place. - One intentional signature change.
GetGroupedMediaItemsForShufflenow takesbool keepMultiPartEpisodesTogether, bool treatCollectionsAsShowsinstead of aProgramSchedule(verified those are the only two properties it read). This deletesPlaylistEnumerator's fakenew ProgramSchedule { KeepMultiPartEpisodesTogether = false }(its TODO becomes an honestfalse, false) and gives future callers with noProgramSchedule(#176 PseudoTV, #70 distribution) a schedule-entity-free entry point. Behavior is unchanged. - Rejected: a unified Classic+Playlist enumerator factory (b). That would be the god-factory the issue
forbids — three concrete hazards: Classic's
Marathonarm produces aPlaylistEnumerator(a factory consumed byPlaylistEnumerator.Createthat also builds one is a dependency cycle); Playlist hardcodesKeepMultiPartEpisodesTogether=false/randomStartPoint=falsewhere Classic reads schedule flags (a merge silently changes behavior); and Classic'sCustomOrder/Rerun/MultiEpisodeShuffle-template arms gate on instance deps Playlist doesn't have. Engine separation is deliberately preserved. - Block / Scripted / YAML left alone. Block is a distinct family; the Scripted≡YAML construction
duplication (
EnumeratorForContent≡EnumeratorCache.GetEnumerator, both using the differentBlockPlayoutShuffledMediaCollectionEnumeratorfor shuffle) is a real but separate cleanup — deferred to a follow-up gated on #381 (those paths have no golden coverage yet). - Net first, because #163's was too narrow.
PlayoutBuildGoldenTestsonly pinnedPlaybackOrder.Chronological; the moved shuffle paths (incl. the entire Playlist reach-in) were uncovered, so "goldens green" would have been a false signal. The PR adds aclassic-shufflegolden (pinnedPlayout.Seed+Continuebuild, sinceResetrandomizes the seed) and aPlaylistEnumerator.Createreach-in characterization (Shuffle + ShuffleInOrder items) before the move, plus directShuffleSourceBuilderunit tests for the branches goldens don't reach (multi-collection vs fake-multi-collection lookup; multi-part grouping on/off).