Skip to content

Notes how each retired conformance hash differs - #252

Merged
johnnyt merged 1 commit into
mainfrom
sp-ne8c-retention-hash-note
Sep 30, 2026
Merged

johnnyt merged 1 commit into
mainfrom
sp-ne8c-retention-hash-note

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 30, 2026

Copy link
Copy Markdown
Member

What

A dated foot Note on ADR-0012 (retention and retirement) makes one sentence of its 2026-09-29 Note on the lock-upgrade hazard exact. That Note says every chart hash a generated conformance case retires "carries a suffix derived from the using module's name". Every such hash is derived from the module's name, in one of two ways:

  • Suffixed: a literal hash ending with @conformance_hash_suffix, for the adapter retirement block, the never-stored miss, the capability case and the tombstone-read case.
  • Computed over a source carrying it: the content hash of a chart source whose XML comment holds the suffix, for the facade create case's loan chart, the facade migration case's to chart, and the tombstone-check case's own copy of chart "a".

The Note decides nothing and removes nothing: git diff origin/main -- docs/adr/ shows zero removed lines, and the earlier Note's conclusion (two hosts running the suite in one database never retire the same hash) holds for both kinds.

Gate

This branch touches no gated path (the gate's build paths are lib/, test/, config/, mix.exs and mix.lock), so no local gate applies; CI runs the full quality gate on the request. No changelog fragment: changelog.d/README.md excludes ADRs.

In-turn review and direction check

Every claim in the Note was checked against lib/statifier_persistence/testing/storage_conformance.ex on main at 9f9eaa0, by anchor: @conformance_hash_suffix is the first sixteen hex characters of the SHA-256 of inspect(__MODULE__) in the using module; @conformance_retire_hash and the hashes in "adapter: a hash this store never held is a miss, not a retirement", "facade: a retirement either runs or is declined at open" and "adapter: the tombstone read answers what the retired arm of fetch_chart/2 carries" each end with the suffix; @conformance_loan_source and @conformance_renewed_source carry it in a comment, the first retired in the facade create case and the second as the facade migration case's to hash, each through ConformanceRetiringSerialization; conformance_own_chart_a/0 adds the same comment to StatifierPersistence.Testing.Charts.chart_a/0's source for "facade: the tombstone check refuses a retired chart and lets a live one through". The Note is appended at the end of the file, after the 2026-09-29 Amendment, under the repo's ## Note (date, bead id) heading; the earlier Note and the Amendment are untouched, and nothing flips.

The retention record's Note on the lock-upgrade hazard says every
chart hash a generated conformance case retires carries a suffix
derived from the using module's name. The literal hashes do; the
three content-hashed charts are hashes of a source whose comment
holds the suffix, so they differ per module without carrying it.

Adds a dated foot Note to ADR-0012 naming each hash under the one of
the two ways it takes. Zero removed lines under docs/adr/. The branch
touches no gated path (lib/, test/, config/, mix.exs, mix.lock), so no
gate applies; CI runs it on the request.

Refs: sp-ne8c
@johnnyt
johnnyt merged commit 20e59b2 into main Sep 30, 2026
1 check passed
@johnnyt
johnnyt deleted the sp-ne8c-retention-hash-note branch September 30, 2026 11:01
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.

1 participant