docs: add session file locking guidance to HARNESS.md#59
Open
JasonOA888 wants to merge 1 commit intoHKUDS:mainfrom
Open
docs: add session file locking guidance to HARNESS.md#59JasonOA888 wants to merge 1 commit intoHKUDS:mainfrom
JasonOA888 wants to merge 1 commit intoHKUDS:mainfrom
Conversation
Following PR HKUDS#52, add a new subsection to 'Critical Lessons Learned' documenting best practices for session file locking: - Use fcntl.flock() for exclusive locking during writes - Prevent race conditions in multi-session scenarios - Handle filesystems that don't support flock - Document common pitfalls (use fcntl.flock, not flock directly) This prevents future contributors from making similar mistakes when implementing session persistence. Co-authored-by: yuh-yang <yuh-yang@users.noreply.github.com>
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
Following PR #52 (file locking fix), adds documentation to prevent similar bugs in future harness implementations.
Changes
Added new subsection "Session File Locking for Concurrency" to
Critical Lessons Learned:fcntl.flock()usagefcntl.flock(), notflockdirectlyLOCK_UNIOError/OSErrorfor unsupported filesystemsContext
PR #52 fixed a race condition in
anygen/agent-harness/session.py. This PR documents the pattern so future contributors don't make similar mistakes.Testing
Related: #51, #52