Skip to content

TML-2584: close out contract-ir-planes — migrate ADR 221, strip scaffolding#643

Merged
wmadden merged 5 commits into
mainfrom
tml-2584-contract-ir-planes-closeout
May 30, 2026
Merged

TML-2584: close out contract-ir-planes — migrate ADR 221, strip scaffolding#643
wmadden merged 5 commits into
mainfrom
tml-2584-contract-ir-planes-closeout

Conversation

@wmadden-electric
Copy link
Copy Markdown
Contributor

@wmadden-electric wmadden-electric commented May 30, 2026

What this is

Close-out for the contract-ir-planes sub-project (the contract IR two-plane reshape + uniform entity coordinate + pack-contributed entity-kind mechanism, with Postgres enum migrated onto the pack-contribution path). All slices have merged; this PR preserves the durable knowledge and removes the transient scaffolding.

Scope is docs / project-folder only — no source changes.

Project DoD verification

PDoD State Evidence
1 — slices delivered / deferred S1.A–C + #630 (S1.D-1) + #631 (S1.D-2) + #632 (S1.E) + #629 (S1.D-3) merged; deferred items → TML-2743 / TML-2744 / TML-2745
2 — contracts canonical shape cross-reference encoding slice + fixture regen; fixtures:check green on merged slices
3 — enum pack-contributed, no hardcoded framework/family paths enum-migration slice + #632
4 — cross-refs object pairs cross-reference-encoding slice
5 — Namespace {id,kind}; clean-removable helpers deleted #630 / #631 / #629; structural items scoped out → deferred tickets
6 — elementCoordinates walk consumed substrate slice + #629 (migration aggregate routed through it)
7 — deserializeContract<T> generic substrate slice
8 — repo gates clean CI green on each merged slice
9 — ADR accepted + migrated this PR 0001-contract-planesADR 221 (status: Accepted)
10 — subsumed tickets resolved TML-2579 (closed via S1.D-2), TML-2580 (closed via S1.D-3) marked Done; TML-2582 stays Canceled (its work deferred → TML-2745)
11 — docs migrated, folder deleted, refs stripped this PR see below

Mandatory final retro (invariant I10): complete — synthesised in the close-out commit docs(drive): mandatory final retro and landed as a durable trial-findings stanza (drive/retro/findings.md).

Migration summary

1 long-lived file migrated; everything else under projects/contract-ir-planes/ was transient and deleted.

  • projects/contract-ir-planes/adrs/0001-contract-planes.mddocs/architecture docs/adrs/ADR 221 - Contract IR two planes with uniform entity coordinate and pack-contributed entity kinds.md
    • Prose-audited at migration: stripped project-shaping voice, transient projects/… paths, slice/dispatch IDs, and the findings pointer; sibling links fixed; status set to Accepted.

Reference-strip summary

3 files re-pointed, 0 dangling references remaining (git grep "projects/contract-ir-planes/" outside the deleted folder returns empty):

  • projects/target-extensible-ir-namespaces/plan.md — umbrella references to S1's spec/plan re-pointed at ADR 221; S1 noted closed.
  • projects/target-extensible-ir-namespaces/spec.md — same.
  • drive/retro/findings.md — historical co-ship-win prose softened to drop the transient path.

Deferred scope (durably ticketed)

  • TML-2743 — namespaced SqlModelStorage coordinate → delete findSqlTable + assertUniqueSqlTableNames
  • TML-2744 — kind-agnostic descriptor hashing → delete stripNamespaceKinds
  • TML-2745 — namespace-aware query-builder selection → delete query-builder UnboundTables

Linear

Closes the close-out task for TML-2584. The umbrella project (target-extensible-ir-namespaces) remains open — S2/S3 are still ahead.

Summary by CodeRabbit

  • Documentation
    • Published an ADR describing a Contract IR with two planes, a uniform entity coordinate identity, cross-namespace reference conventions, and rules for how packs contribute additional entity kinds; includes consequences and rejected alternatives.
    • Added Drive retrospective findings documenting a trial “win” with updated scope-verification guidance and a minor clarification to prior planning notes.

Review Change Stack

@wmadden-electric wmadden-electric requested a review from a team as a code owner May 30, 2026 17:52
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: fe9e00d4-12ee-42a2-991b-69c34d449a46

📥 Commits

Reviewing files that changed from the base of the PR and between f95ef37 and ecc0347.

⛔ Files ignored due to path filters (30)
  • projects/contract-ir-planes/adrs/0001-contract-planes.md is excluded by !projects/**
  • projects/contract-ir-planes/deferred.md is excluded by !projects/**
  • projects/contract-ir-planes/plan.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/canonicalizer-family-hook/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/construction-discipline-shims/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/cross-reference-encoding/dispatches/01-framework-shape.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/cross-reference-encoding/dispatches/02-family-lowering-emitter-consumers.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/cross-reference-encoding/dispatches/03-fixture-regen-and-pr.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/cross-reference-encoding/plan.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/cross-reference-encoding/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/enum-migration/dispatches/01-source-migration.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/enum-migration/dispatches/02-fixture-regen.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/enum-migration/dispatches/03-grep-and-pr.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/enum-migration/plan.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/enum-migration/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/migration-element-coordinates/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/namespace-aware-enum-planning/plan.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/namespace-aware-enum-planning/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/01-framework-primitives.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/02-descriptor-mechanism.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/03-vocabulary-cleanup.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/04-coord-plane-axis.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/05-test-layering-fix.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/06-mongo-builder-class-lift.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/dispatches/07-hydrate-and-arktype-cleanup.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/plan.md is excluded by !projects/**
  • projects/contract-ir-planes/slices/substrate/spec.md is excluded by !projects/**
  • projects/contract-ir-planes/spec.md is excluded by !projects/**
  • projects/target-extensible-ir-namespaces/plan.md is excluded by !projects/**
  • projects/target-extensible-ir-namespaces/spec.md is excluded by !projects/**
📒 Files selected for processing (2)
  • docs/architecture docs/adrs/ADR 221 - Contract IR two planes with uniform entity coordinate and pack-contributed entity kinds.md
  • drive/retro/findings.md
✅ Files skipped from review due to trivial changes (1)
  • drive/retro/findings.md

📝 Walkthrough

Walkthrough

ADR 221 was finalized to Accepted, documenting a two‑plane Contract IR with a canonical entity coordinate and pack‑contributed entity kinds; drive retro findings were updated with a new planning correction entry and a clarified note about mid‑flight slice collapsing.

Changes

Architecture and planning documentation updates

Layer / File(s) Summary
ADR 221 finalization to Accepted status
docs/architecture docs/adrs/ADR 221 - Contract IR two planes with uniform entity coordinate and pack-contributed entity kinds.md
ADR 221 header and status set to Accepted. Establishes two planes (domain, storage) and the canonical entity coordinate (plane, namespaceId, entityKind, entityName); specifies elementCoordinates(plane) enumeration as a free function; encodes cross‑namespace references as object pairs; defines pack‑contributed entity‑kind descriptors keyed by a discriminator and singular slot-key naming; constrains Namespace to { id, kind }; updates consequences, rejected alternatives, and references.
Trial findings: planning corrections and slice collapsing
drive/retro/findings.md
Adds a new Drive trial “win” entry (2026-05-30) describing a planning correction where inventory falsified a clean‑slice deletion premise, splitting mechanical deletes (shipped) from structural fixes (deferred to Linear tickets) and updating DoD/verification wording; clarifies an existing drive-plan-project entry to record mid‑flight application of the co-ship falsifier before Linear ticket slice‑locking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • prisma/prisma-next#549: Both PRs modify drive/retro/findings.md documenting mid‑flight application of the co-ship falsifier and slice collapsing before ticket creation.

Poem

I’m a rabbit in the docs, I hop and sing,
ADRs tucked neat beneath my wing.
Two planes aligned, coordinates in place,
Retro lessons saved—no vanished trace.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately references the main change: closing out the contract-ir-planes sub-project by migrating ADR 221 and removing scaffolding, which matches the file changes (ADR 221 migration and retro documentation).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tml-2584-contract-ir-planes-closeout

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

wmadden added 5 commits May 30, 2026 20:03
Synthesise the project-level retro (invariant I10) into projects/contract-ir-planes/retros.md
and land the narrow-and-defer planning win as a durable trial-findings stanza. Per-slice
lessons already landed continuously during delivery; this captures the project-as-a-whole
view ahead of close-out.

Signed-off-by: Will Madden <madden@prisma.io>
Lift the durable contract-IR architectural decisions (two planes, uniform entity
coordinate, pack-contributed entity-kind mechanism) out of the closing project
folder into the ADR root. Strip project-shaping voice, transient projects/ paths,
and slice/dispatch IDs per close-out prose-audit; status set to Accepted.

Signed-off-by: Will Madden <madden@prisma.io>
The contract-ir-planes sub-project closes; re-point the umbrella plan/spec and the
retro findings log at the migrated ADR 221 (and drop the transient spec/plan links
that vanish with the folder) so no reference dangles after deletion.

Signed-off-by: Will Madden <madden@prisma.io>
All slices merged, durable decisions migrated to ADR 221, deferred items ticketed
(TML-2743/2744/2745), references re-pointed. Transient project scaffolding removed.

Signed-off-by: Will Madden <madden@prisma.io>
Lead with a grounding contract example and the decision, build the reasoning up
one idea per section, and move all rejected options to the end. Remove ticket/PR
references and refactor-state framing (the slot-key-field option is reframed as a
rejected alternative rather than something built and torn out).

Signed-off-by: Will Madden <madden@prisma.io>
@wmadden wmadden force-pushed the tml-2584-contract-ir-planes-closeout branch from f95ef37 to ecc0347 Compare May 30, 2026 18:03
@wmadden wmadden merged commit ab6875c into main May 30, 2026
20 checks passed
@wmadden wmadden deleted the tml-2584-contract-ir-planes-closeout branch May 30, 2026 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants