docs: sync ARCHITECTURE.md and python/README.md with the I143-I146 fixes - #91
Merged
Conversation
ARCHITECTURE.md's Recovery-on-open diagram still showed the pre-I143 create-vs-open race; added landmines for the three other bug classes (I143 TOCTOU, I144 unvalidated stride, I145 poison_on_fatal gap) so a future editor doesn't reintroduce them. python/README.md's error tables were missing DecryptionFailedError and, pre-dating this week's fixes, the five encryption operational-error classes entirely.
🚦 Bench results: PR vs main
Per-scenario detail (4 metrics × cells)document-store
mutation-log
ycsb-a
ycsb-b
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Ran a /codebase-docs pass to bring README/ARCHITECTURE/THEORY back in sync with the code after PR #89 (I143-I146 bug fixes). Both changed files are "Update" disposition — no restructuring, targeted factual corrections and additions only.
ARCHITECTURE.md
file_existsstat. It now shows the actual post-fix order —PageIo::open(flock) first, then the branch decided from post-lockpage_count().stridefield (I144), and the "everyTransactionManagerfatal-error path must route throughpoison_on_fatal" rule that I145 violated.DecryptionFailed-is-fatal, superblock byte ranges) was already correct — the stale bits were code comments, not the docs.python/README.md
DecryptionFailedErrorto the Fatal error table (new class from PR fix: four BUG-severity findings from the 2026-07-02 deep review (I143–I146) #89).NoEncryptionKeyError,InvalidEncryptionKeyError,EncryptionNotSupportedError,NoFreeKeySlotError,LastKeySlotError.Top-level README.md and THEORY.md were checked and need no changes (README's I146 fix already landed in #89; THEORY's narrative doesn't contradict anything in the recent diff).
Test plan
src/lib.rs,src/transaction/recovery.rs,src/transaction/freemap.rs,python/src/errors.rs,src/error.rs)..github/workflows/*.yml.