docs: add Gotchas & Pitfalls section to state_exec developer guide#100
Merged
Conversation
New Section 12 documenting non-obvious behaviours discovered during CI debugging and integration testing: - First write to a new state path is not replicated (lazy observer attachment in state_sync_adapter) - Duplicate-value writes silently dropped (equality guard) - Pumping before a peer connects permanently loses mutations (drain_local cursor advancement) - let scoping vs set for loop-carried state - All state values are strings - Generators are single-use - msg-recv blocks and can deadlock single-process programs - sleep granularity depends on scheduler tick rate - break exits only the innermost loop - Fork-based IPC tests and socket cleanup
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
1 participant
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
Adds a new Section 12 — Gotchas & Pitfalls to the
STATE_EXEC_DEVELOPER_GUIDE.md, documenting non-obvious behaviours discovered during CI debugging and integration testing of PRs #96–#99.Contents
state_sync_adapter)state::value()equality guard)drain_localcursor advancement)letscoping vssetfor loop-carried statemsg-recvblocks and can deadlock single-process programssleepgranularity depends on scheduler tick ratebreakexits only the innermost loopThe existing Architecture Reference section is renumbered from 12 → 13 and the TOC is updated accordingly.