-
Notifications
You must be signed in to change notification settings - Fork 0
docs(matrix): consolidate ten conflicting sdk-feature-matrix PRs into one code-verified refresh (LAB-1400) #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
2bcb174
docs(matrix): consolidate ten conflicting matrix PRs into one code-ve…
27Bslash6 de5b68e
docs(matrix): apply expert-panel findings — release-state, fail-open,…
27Bslash6 897ac91
fix: address coderabbit review — matrix date, unreleased Rust SWR qua…
27Bslash6 0aaf298
fix(matrix): re-verify every version claim against published artifact…
27Bslash6 7d14dae
fix(matrix): correct an inverted TypeScript fail-mode claim (LAB-1400)
27Bslash6 cdbedba
fix(matrix): scope floor semantics to the SDK Overview table (LAB-1400)
763871d
fix(matrix): correct my own floor-scoping regression (LAB-1400)
15e030e
fix(matrix): settle the dual-read question by test; make the gate hon…
27Bslash6 d488c35
fix(matrix): stop inventing a crypto risk; close two checker gaps (LA…
27Bslash6 349f5fb
style(tools): escape ambiguous dash literals in the floors checker (L…
27Bslash6 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| **[Protocol](../README.md)** > **Decisions** > **Matrix Version Verification** | ||
|
|
||
| # Decision Record: Verify the Feature Matrix Against Published Artifacts, Not Branches | ||
|
|
||
| | | | | ||
| | :--- | :--- | | ||
| | **Status** | Accepted | | ||
| | **Date** | 2026-08-04 | | ||
| | **Ticket** | LAB-1400 (consolidation of ten conflicting `sdk-feature-matrix.md` PRs) | | ||
| | **Applies to** | [`sdk-feature-matrix.md`](../sdk-feature-matrix.md), and any version- or ship-status claim in [`spec/`](../spec) | | ||
|
|
||
| --- | ||
|
|
||
| ## Context | ||
|
|
||
| [`sdk-feature-matrix.md`](../sdk-feature-matrix.md) is a trust surface: readers use it to decide what they can rely on without reading four SDKs. In six weeks it produced **four** failures of one mechanical class — a cell describing a repository branch while claiming to describe a shipped SDK: | ||
|
|
||
| | # | Failure | Direction | | ||
| | :--- | :--- | :--- | | ||
| | LAB-388 | "SWR ✓" for orphaned, never-called code | claimed more than shipped | | ||
| | LAB-998 | interop/v1 ship-status false | claimed less than shipped | | ||
| | LAB-1400 (first pass) | six Rust reliability cells marked 🚧 unreleased — `cachekit-rs` 0.6.0 had published 74 minutes earlier | claimed less than shipped | | ||
| | LAB-1400 (first pass) | "cachekit-ts ships the `bin` flip as of 0.1.5" — the published 0.1.5 pins a NAPI addon embedding `cachekit-core` 0.2.0 | claimed more than shipped | | ||
|
|
||
| The last two were committed *by the audit that existed to remove the first two.* That is the signal: the failure is not carelessness, it is a method that cannot detect this class. Reading `main` tells you what the next release will contain, never what the current one does, and the gap between them is exactly where a trust bug lives. | ||
|
|
||
| Two properties make it worse than ordinary staleness: | ||
|
|
||
| - **It is bidirectional.** A ❌ hiding a shipped feature makes users hand-roll what they already have; a ✅ they cannot install makes them plan around vapour. Neither is safer. | ||
| - **It rots without an edit.** A registry release falsifies a cell while the file is untouched. `cachekit-rs` 0.6.0 falsified six cells and a footnote in one event. | ||
|
|
||
| ## Decision | ||
|
|
||
| **A version- or ship-status claim in the matrix is verified against the published artifact, or it is not made.** | ||
|
|
||
| 1. **Registry metadata is the floor, not the proof.** Latest version and publish timestamp come from the registry API (crates.io, npm, PyPI). That establishes *which* artifact is current — nothing more. | ||
|
|
||
| 2. **When an embedded or transitive dependency version decides the claim, open the artifact.** Downloading and inspecting is mandatory, not optional: | ||
| - Rust — fetch the `.crate`, read the *published* `Cargo.toml` for `[features] default` and dependency requirements, and list `src/` for the modules the claim names. | ||
| - npm — read the exact `dependencies` pins from the registry document (caret-free pins do **not** float), fetch the `.tgz`, and `strings` the `.node` / `.wasm` for the embedded `cachekit-core-X.Y.Z`. A source-level pin bump in a monorepo does **not** mean the consumed binary was republished. | ||
| - Python — the wheel's bundled extension, when a core version decides the claim. | ||
|
|
||
| 3. **A merged PR is not a shipped feature.** Cite the release that carries it, not the PR that landed it. `git log` and tags describe intent; the registry describes reality. | ||
|
|
||
| 4. **Every SDK Overview version is a floor (`X+`), never a snapshot.** A floor stays true as new releases publish; a snapshot is wrong the moment the next one lands and silently misleads until someone notices. This is why that table carries `+`, and why the CI guard polices only it. Exact versions *elsewhere* are artifact evidence under rule 2 — an embedded `cachekit-core-0.2.0` is a fact about one `.node` binary, a caret-free `0.1.2` is a fact about one npm pin — and stay bare. | ||
|
|
||
| 5. **Record the verification date** next to the claim. A floor plus a date is auditable; a bare number is a guess with a decimal point. | ||
|
|
||
| ## Consequences | ||
|
|
||
| - Refreshing the matrix costs a handful of artifact downloads. That is the price of the document meaning anything, and it is minutes. | ||
| - CI enforces rule 4 mechanically: [`.github/workflows/verify.yml`](../.github/workflows/verify.yml) runs [`tools/check-version-floors.py`](../tools/check-version-floors.py), which fails on any bare `X.Y.Z` in `sdk-feature-matrix.md` that is not written as a floor. It cannot catch a *wrong* floor — only a snapshot masquerading as fact. Rules 1–3 and 5 remain reviewer discipline. | ||
| - The guard is deliberately narrow. It encodes the one failure mode that recurred four times and nothing speculative. | ||
|
|
||
| ## Rejected alternatives | ||
|
|
||
| - **Generate the version table from the registries in CI.** Removes the class outright, but the matrix's value is the *prose* — "shipped but unreachable", "on by default since 0.6.0" — which no generator produces. A generated table beside hand-written prose would drift from it, trading one inconsistency for another. | ||
| - **Drop versions from the matrix entirely.** "Which release do I need?" is the question the document is most often opened to answer. | ||
| - **Trust the SDK repos' own CHANGELOGs.** They record merges, and release-please tags can precede or follow publication. `cachekit-ts` 0.1.5's changelog lists the core-0.4.0 bump ([cachekit-ts#91](https://github.com/cachekit-io/cachekit-ts/pull/91)) while its published tree still pins the old addon — the changelog is exactly how the false claim was produced. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.