Repository navigation
docs(api-review): Goldpath.Approvals and Goldpath.FileExchange under the [Experimental] decision (G4 API-5, #394) - #576
omercelikdev wants to merge 2 commits into
Conversation
… line under the [Experimental] decision (G4 API-5, #394) 635 live lines at c9d23ae (376 Approvals, 259 FileExchange; the issue's 462 was measured before #479/#480): 611 experimental under GPEXP001/GPEXP002, 24 remove, no keep (GA readiness Q4), no rename needed. - remove: the EF stores GoldpathEfApprovalStore<TContext> and GoldpathEfFileLedger<TContext> - registered only by the TContext overload of AddGoldpath..., behind the store interface; no other public line, template or sample names them (InternalsVisibleTo for the tests that construct them, in API-14). The metrics classes - public static classes with no public member. - experimental, with a reason per category: the EF rows (the adopter's migrations name them, as Bulk's and Archival's entities), the request's set accessors (the engine and a custom store both need them), the model extension (waits on API-3's spelling finding), the escalation job (its name is its key), the in-memory stores, the seams, the non-generic admin services. - The record's §4 states the lift condition once, linked to T21 and T22. The README answers the issue's four questions for API-13. ga-gate-status G4: 2,136 of 3,349. - api-review-gate.sh --selftest resets its second fixture (FileExchange) to a header-only table in every scratch copy, as it does Caching since API-4: the experimental-package case appends a row per live line, which a real table turned into duplicates. Proof: --require-complete for the two packages is red at main (0/635) and green here; a planted keep in either table is red ("'keep' is not a verdict there"); --selftest green. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018AFdNcUHVZCtRVq4DLoW71
Verifier verdict (run 2026-11-12)Head verified: Verdict: changes requested. 2 MINOR, 3 NIT. Both MINORs are about how accurate the verdict tables' reason text is. Every count, gate and red→green claim reproduced exactly. Findings
Steps 1–6
Deep review (a–j)
Edge-case probes (throwaway, not pushed)
Owner: fix the two reason texts (Finding 1 is a one-word change in 5 rows; Finding 2 is a reason or a rename for one record type), then re-verify. This PR is tier C, so the owner merges. Generated by Claude Code |
…rQueries, and GoldpathQuarantinedRow is a rename (#394) Verifier findings on #576: - The five GoldpathFileExchangeAdminService reasons named IGoldpathFileLedger; its constructor takes IGoldpathFileLedgerQueries. - GoldpathQuarantinedRow carried the default reason without its naming being examined. It is now a rename to GoldpathFileQuarantinedLine (the File prefix its siblings carry, not the Row suffix the review reserves for EF entities): its 18 own lines and the 5 lines whose signatures name it, each with the full target line and a reason saying why before the T22 lift. Listed in the README's findings for API-13; counts moved in the CHANGELOG, the README and the G4 row (588 experimental, 24 remove, 23 rename). - NITs: the lift-condition paragraph moves below the ids' continuation; the README ends with one newline again. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018AFdNchYxTtB7tJ7kURQXf
|
Addressed verifier findings: 1 (MINOR), 2 (MINOR), NIT 3, NIT 4. Head:
Pre-PR self-check (the whole PR at
Gates:
Generated by Claude Code |
Verifier verdict (run 2026-11-12, daytime)Head verified: Verdict: no blocking findings. 0 BLOCKER, 0 MAJOR, 0 MINOR, 1 NIT. Tier C (gate script): the owner merges. Previous findings
Steps 1–6
Deep review
Edge-case probes (throwaway edits to the TSV, all restored;
|
| # | Probe | Result |
|---|---|---|
| P1 | Blank the target of a rename row |
red ✓ |
| P2 | Point the type's rename target at an existing type, Goldpath.GoldpathFileQuarantineRow (the EF entity) |
green: the gate accepts a rename onto a name that already exists |
| P3 | Make a rename target identical to its own line, which renames nothing |
green: the gate accepts it |
| P4 | Every live line that names the type has a row, and every target is the substituted line | ✓ 24/24 covered, 23/23 exact |
NIT (optional, not this PR's change)
- P2 and P3 show that
scripts/api-review-gate.shchecks only that arenametarget is non-empty. It does not check that the target differs from the line, or that it names no type already on the surface. This PR's data is correct (P4), and the validation predates it (API-4), so it does not block. This PR is the first to userename, so a follow-up issue for the gate would be worthwhile before API-14 applies renames. Suggested checks: target ≠ line, and the new type name is not already declared in the package's PublicAPI files.
Labels: changes-requested removed, agent-verified added. Tier C: the owner merges, after owner-approved.
Owner: safe to merge. Summary: no runtime change. The 1.0 API review record now gives a verdict for every public line of Goldpath.Approvals and Goldpath.FileExchange ([Experimental] under GPEXP001/GPEXP002). It proposes two EF-store removals and one record rename (GoldpathQuarantinedRow → GoldpathFileQuarantinedLine) for you to sign in API-13.
Generated by Claude Code
What and why
API-5 of the 1.0 public-API review. It gives every live ledger line of the two experimental packages a verdict, under owner decision Q4: the packages ship in 1.0 with their surface
[Experimental].What was measured (at
main@c9d23ae): 635 live lines, 376 in Approvals and 259 in FileExchange. The issue's 462 was measured at0186ca3, before #479 and #480 grew Approvals.The verdicts:
experimental, underGPEXP001(Approvals) orGPEXP002(FileExchange).remove.rename: one record,GoldpathQuarantinedRow→GoldpathFileQuarantinedLine(added ate822209from the verifier's finding 2).keep(the gate refuses it here).The removals:
GoldpathEfApprovalStore<TContext>andGoldpathEfFileLedger<TContext>.TContextoverload ofAddGoldpathApprovals/AddGoldpathFileExchange, behind its store interface.GoldpathBulkFileStore<TContext>, which a public constructor takes, nothing forces them to stay public. API-14 addsInternalsVisibleTofor the three test projects that construct them.GoldpathApprovalsMetrics,GoldpathFileExchangeMetrics): public static classes with no public member. This applies API-3's metrics policy.The rename: FileExchange has three types for one quarantined line:
GoldpathFileQuarantineRow(the EF entity),GoldpathQuarantinedRow(the record the ledger'sGetQuarantineAsyncandGoldpathFileRailResult.Quarantinedreturn) andGoldpathFileQuarantineInfo(the admin DTO). The record alone lacks theFileprefix its siblings carry, and it takes the…Rowsuffix this review reserves for EF entities. The 23 rows are its 18 own lines plus the 5 lines whose signatures name it. Each row has the full target line and a reason that says why the rename comes before the T22 lift. It is listed in the README's findings for API-13, so the owner can sign or overrule it.The
experimentalrows carry a reason per category. Each was checked against the code:GoldpathApprovalRequest's fivesetaccessors: the engine moves state on the request it read, and a custom store outside the assembly materializes the same object. Neitherinitnor an internal setter serves both.TryAdd, and constructed by adopters' tests.IGoldpathApprovalStore,IGoldpathFileLedgerandIGoldpathFileLedgerQueries. The last is the read half that the admin endpoints require, as the code checks.IGoldpathApprovalStore/IGoldpathFileLedgerQueries, so aTContextparameter would bind nothing (method Q7).cancellationToken, and neither package has act).Also in this PR:
api-review-1.0/README.md"Findings for API-13" answers the issue's four questions (EF rows and plumbing, generic or not, singular or plural) and lists the rename for the owner.ga-gate-status.mdG4 now reads 2,136 of 3,349.scripts/api-review-gate.sh --selftestresets its second fixture (Goldpath.FileExchange) to a header-only table in every scratch copy, as API-4 did for Caching. Its "experimental package under its own id" case appends a row for every live line, and the real table turned those into duplicates, so the selftest went red. The checks of the real tables are unchanged.Reproduce
I ran RED 1–4 and saw each one as quoted.
Acceptance criteria (#394), with evidence
experimental(with its package's id),renameorremove, and nokeep.--require-completeis green for both; a plantedkeepis red (RED 2).renameandremovecarries a reason that says why it must happen before the 1.x lift. Eachremovereason says what replaces the line and why no adopter needs it. Eachrenamereason says that from the lift the name is SemVer-bound and only a major could change it.--require-complete --packagefor both is green, and report mode is green for the whole tree.packages/,templates/ortools/changes (git diff --stat origin/main).ga-gate-status.mdG4 row shows the new count: 2,136 of 3,349.scripts/api-review-gate.shchanges too (the selftest fixture reset, the same fix API-4 made), so the PR is tier C. The fix is needed because without itgatesis red.Pre-PR self-check
[Unreleased]entries (the review under Added, with the rename and the counts; the selftest fix under Fixed), the record's §4, the README's findings, and the G4 row inga-gate-status.mdonly.goldpath-ga-readiness.mdis untouched. No new deferral needs an open-threads row.IGoldpathFileLedgerQueries, the constructor's parameter.Gates run (at
e822209)api-review-gate.sh(report),--require-complete --package Goldpath.Approvals --package Goldpath.FileExchange,--selftestdocs-freshness.sh,ledger-check.sh,schema-honesty.sh,skills-parity.sh,template-pins.sh,surface-freeze-gate.shdotnet buildWhat I could not verify
main's ownoraclejob is red (not required), so a redoraclehere needs reading before it is attributed to this PR, which changes no code.Closes #394
🤖 Generated with Claude Code