docs: stop telling operators a halt performed nothing after the checkpoint - #87
Merged
Conversation
…point The durable-runtime page said: When the run halts (an unhandled screen, a refuted write, an escalation) ... nothing after the checkpoint was performed. That is false for the case the same sentence names. A refuted write is a write that WAS delivered and then read back absent from the system of record; a postcondition halt is a halt on evidence collected after the click. openadapt-flow states this explicitly in `transaction.py::_reached_delivery`: "a postcondition is checked after the click, so an over-halt that aborts the run on one is proof the write was already delivered, not proof it was not." The engine models this correctly and has a terminal outcome for it. Only the prose was wrong -- and wrong in the most expensive direction, since "nothing after the checkpoint was performed" is exactly the sentence that tells a customer they have nothing to reconcile. Replaces it with what the runtime actually guarantees: everything up to the last checkpoint is verified; the halting step is not checkpointed and is not rolled back; and what it may already have done is read from the terminal `transaction_outcome` -- `HALTED_BEFORE_EFFECT` (absence positively established, nothing to reconcile) or `RECONCILIATION_REQUIRED` (reconcile before resuming).
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.
The sentence
docs/concepts/durable-runtime.md:The truth
False for the very case the sentence names.
A refuted write is a write that was delivered and then read back absent from the system of record. A postcondition halt fires on evidence collected after the click. In both cases an action after the last checkpoint was performed.
The engine says so itself —
openadapt_flow/transaction.py::_reached_delivery:And
runtime/durable/controller.py::recordonly writes a checkpoint whenresult.ok; the halting step's actuation is neither checkpointed nor rolled back.The code is right. The prose is wrong. No behaviour changes here.
Why it is worth a PR
"Nothing after the checkpoint was performed" is precisely the sentence that tells a customer they have nothing to reconcile. The engine has a first-class terminal outcome whose entire job is to refuse that claim without positive evidence of absence (
RECONCILIATION_REQUIRED, tightened in openadapt-flow #280). This page overrode it in prose on the operator-facing surface.The fix
States what the runtime actually guarantees:
transaction_outcome—HALTED_BEFORE_EFFECT(absence positively established; nothing to reconcile) orRECONCILIATION_REQUIRED(reconcile before resuming; the runtime will not blind-retry);Checks
scripts/validate_docs.py(passed) ·mkdocs build --strict(clean) ·pytest tests/(101 passed).Related
openadapt-flow #298 fixes the same class of stale halt claim in
docs/EXECUTION_PROFILES.md, which namedHALTED_BEFORE_EFFECTfor a probe whose own pinned test assertsRECONCILIATION_REQUIRED.🤖 Generated with Claude Code
https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM