fix: use atomic write-then-rename for state files#262
Open
tylerbutler wants to merge 2 commits intomainfrom
Open
fix: use atomic write-then-rename for state files#262tylerbutler wants to merge 2 commits intomainfrom
tylerbutler wants to merge 2 commits intomainfrom
Conversation
State file writes using fs::write are non-atomic (truncate then write), risking corruption if the process is interrupted mid-write. Replace with a write-then-rename pattern using tempfile::NamedTempFile, which writes to a temporary file in the same directory then atomically renames it into place. Closes #237 🤖 Generated with [Nori](https://noriagentic.com) Co-Authored-By: Nori <contact@tilework.tech>
Contributor
Missing Changelog EntryThis PR includes commits with types that typically require a changelog entry ( To add one, run: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
# Conflicts: # src/state.rs
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
fs::writecalls in state file operations with a write-then-rename pattern usingtempfile::NamedTempFileatomic_writehelper function that writes to a temporary file in the same directory then atomically renames it into placetempfilefrom dev-dependency to regular dependencyCloses #237
Details
Three state file write locations were vulnerable to corruption if the process was interrupted mid-write (
fs::writetruncates then writes):save_overlay_state- in-repo overlay state filessave_external_state- external backup state filesremove_external_state- marking overlays as removedThe
.target_pathmarker file write insave_external_stateis left asfs::writesince it's a non-critical debug marker.Test plan