feat(durability): pin directory synchronization - #57
Merged
Conversation
Contributor
|
ClawSweeper status: review started. I am starting a fresh review of this pull request: feat(durability): pin directory synchronization This is item 1/1 in the current shard. Shard 0/1. This placeholder means the worker is alive and reading the current context. I will edit this same comment with the actual review when the claws are done clicking. Crustacean status: shell secured, claws on keyboard, evidence pebbles being sorted. |
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.
What Problem This Solves
Fixes an issue where consumers performing crash-safe file or directory publication had to reimplement directory identity pinning, parent-edge synchronization, and platform-specific unsupported handling. File synchronization alone does not make a newly created, linked, renamed, or removed directory entry durable.
Why This Change Was Made
Adds a focused
@openclaw/fs-safe/durabilitysubpath with pinned directory receipts, strict async and sync directory synchronization, explicitly named best-effort variants, and guarded durable creation of nested directory paths. The implementation rejects final symlinks, FIFOs, path replacement, canonical-path drift, and descriptor/path identity mismatch. Known Windows directory-flush limitations return an explicit unsupported outcome, while directory-open access failures and POSIX I/O errors remain strict.Existing best-effort root, pinned-write, and sibling-temp behavior is preserved and routed through the shared primitive. Application commit markers, permission policy, and decisions about accepting unsupported platforms remain caller-owned.
User Impact
Consumers can build crash-consistent publication protocols without duplicating low-level directory handle and identity logic. The change is additive; existing APIs and defaults keep their current compatibility behavior.
Evidence
Node 24
pnpm check: 45 test files passed, 494 assertions passed, 4 platform skips; build, file-size guard, filesystem-boundary guard, and tarball/import verification passed.pnpm test:coverage: package thresholds passed; the new directory durability module has 90% line coverage and 82.5% branch coverage.33 focused assertions cover nested parent-edge sync order, custom creation, existing identities, symlink and FIFO replacement, transient path swaps, POSIX failure propagation, Windows open-vs-sync classification, synchronous behavior, best-effort compatibility, and public exports.
Final Codex autoreview: no accepted/actionable findings.
git diff --checkpassed.Tests added or updated when behavior changed
Security and compatibility impact considered
CHANGELOG.mdupdated when release-relevantNo credentials, private paths, private hosts, or sensitive contents included