Skip to main content

heddle_fs_prims/
fs_atomic.rs

1// SPDX-License-Identifier: Apache-2.0
2use std::{
3    fs::{self, File, OpenOptions},
4    io::{self, Write},
5    path::{Path, PathBuf},
6    sync::{
7        Arc, Mutex, OnceLock,
8        atomic::{AtomicU64, Ordering},
9    },
10    time::{SystemTime, UNIX_EPOCH},
11};
12
13#[derive(Default)]
14struct CloneDurabilityStats {
15    barriers: AtomicU64,
16    skipped: AtomicU64,
17}
18
19#[derive(Clone)]
20struct CloneDurabilityEntry {
21    root: PathBuf,
22    stats: Arc<CloneDurabilityStats>,
23}
24
25fn clone_durability_entries() -> &'static Mutex<Vec<CloneDurabilityEntry>> {
26    static ENTRIES: OnceLock<Mutex<Vec<CloneDurabilityEntry>>> = OnceLock::new();
27    ENTRIES.get_or_init(|| Mutex::new(Vec::new()))
28}
29
30fn deferred_clone_stats(path: &Path) -> Option<Arc<CloneDurabilityStats>> {
31    clone_durability_entries()
32        .lock()
33        .ok()?
34        .iter()
35        .rev()
36        .find(|entry| path.starts_with(&entry.root))
37        .map(|entry| Arc::clone(&entry.stats))
38}
39
40pub fn clone_write_is_deferred(path: &Path) -> bool {
41    deferred_clone_stats(path).is_some()
42}
43
44pub fn record_deferred_clone_barrier(path: &Path) {
45    if let Some(stats) = deferred_clone_stats(path) {
46        stats.skipped.fetch_add(1, Ordering::Relaxed);
47    }
48}
49
50/// Path-scoped durability suppression for reconstructible clone writes.
51///
52/// The caller must first persist a clone-intent marker outside this scope and
53/// must call [`commit`](Self::commit) only after hash-verifying the fetched
54/// closure. Writes outside `root` retain their ordinary per-operation fsyncs.
55pub struct CloneDurabilityBatch {
56    root: PathBuf,
57    stats: Arc<CloneDurabilityStats>,
58}
59
60impl CloneDurabilityBatch {
61    pub fn begin(root: impl AsRef<Path>) -> Self {
62        let root = root.as_ref().to_path_buf();
63        let stats = Arc::new(CloneDurabilityStats::default());
64        clone_durability_entries()
65            .lock()
66            .unwrap_or_else(std::sync::PoisonError::into_inner)
67            .push(CloneDurabilityEntry {
68                root: root.clone(),
69                stats: Arc::clone(&stats),
70            });
71        Self { root, stats }
72    }
73
74    /// Flush every dirty file and directory on the destination filesystem in
75    /// one kernel barrier. Refs remain unpublished while this runs.
76    pub fn commit(&self) -> io::Result<()> {
77        sync_filesystem(&self.root)?;
78        self.stats.barriers.fetch_add(1, Ordering::Relaxed);
79        Ok(())
80    }
81
82    pub fn barrier_count(&self) -> u64 {
83        self.stats.barriers.load(Ordering::Relaxed)
84    }
85
86    pub fn skipped_barrier_count(&self) -> u64 {
87        self.stats.skipped.load(Ordering::Relaxed)
88    }
89}
90
91impl Drop for CloneDurabilityBatch {
92    fn drop(&mut self) {
93        let mut entries = clone_durability_entries()
94            .lock()
95            .unwrap_or_else(std::sync::PoisonError::into_inner);
96        if let Some(index) = entries
97            .iter()
98            .rposition(|entry| entry.root == self.root && Arc::ptr_eq(&entry.stats, &self.stats))
99        {
100            entries.remove(index);
101        }
102    }
103}
104
105#[derive(Clone, Copy)]
106enum AtomicWriteKind {
107    Normal,
108    Secret,
109}
110
111impl AtomicWriteKind {
112    fn open_tmp(self, tmp: &Path) -> io::Result<File> {
113        let mut options = OpenOptions::new();
114        options.create_new(true).write(true);
115
116        #[cfg(unix)]
117        if matches!(self, Self::Secret) {
118            use std::os::unix::fs::OpenOptionsExt;
119            options.mode(0o600);
120        }
121
122        options.open(tmp)
123    }
124
125    fn enforce_before_write(self, file: &File) -> io::Result<()> {
126        match self {
127            Self::Normal => Ok(()),
128            Self::Secret => enforce_secret_permissions_before_write(file),
129        }
130    }
131}
132
133#[cfg(unix)]
134fn enforce_secret_permissions_before_write(file: &File) -> io::Result<()> {
135    use std::os::unix::fs::PermissionsExt;
136
137    file.set_permissions(fs::Permissions::from_mode(0o600))?;
138    let mode = file.metadata()?.permissions().mode() & 0o777;
139    if mode != 0o600 {
140        return Err(io::Error::new(
141            io::ErrorKind::PermissionDenied,
142            format!("secret temp file permissions are {mode:o}, expected 600"),
143        ));
144    }
145    Ok(())
146}
147
148#[cfg(not(unix))]
149fn enforce_secret_permissions_before_write(_file: &File) -> io::Result<()> {
150    // Non-Unix platforms do not expose POSIX mode bits through
151    // OpenOptions. The secret variant still uses the same create-new,
152    // write-fsync-rename discipline, but cannot verify a 0600 mode.
153    Ok(())
154}
155
156static TEMP_PATH_COUNTER: AtomicU64 = AtomicU64::new(0);
157
158/// POSIX `ENOSPC`. Identical on Linux and macOS. Windows surfaces disk-full
159/// as `ERROR_DISK_FULL` (112) or `ERROR_HANDLE_DISK_FULL` (39); we cover
160/// those by also checking `ErrorKind::StorageFull` (stable as of 1.83) and
161/// the older `ErrorKind::Other` "no space" message text as a fallback.
162const ENOSPC: i32 = 28;
163
164/// POSIX `ENOTEMPTY`. Linux=39, macOS/BSD=66. Windows surfaces this as
165/// `ERROR_DIR_NOT_EMPTY` (145). `ErrorKind::DirectoryNotEmpty` covers the
166/// portable case, but the raw codes are the canonical signal — Rust may
167/// still surface raw OS errors for paths the kernel reports unusually.
168const ENOTEMPTY_LINUX: i32 = 39;
169const ENOTEMPTY_MACOS: i32 = 66;
170const ENOTEMPTY_WINDOWS: i32 = 145;
171
172/// POSIX `EACCES`. Same code on Linux and macOS. `ErrorKind::PermissionDenied`
173/// covers Windows `ERROR_ACCESS_DENIED` (5) too.
174const EACCES: i32 = 13;
175
176/// POSIX `ENOENT`. Same code on Linux and macOS. `ErrorKind::NotFound` covers
177/// Windows `ERROR_FILE_NOT_FOUND` (2) and `ERROR_PATH_NOT_FOUND` (3).
178const ENOENT: i32 = 2;
179
180/// POSIX `EROFS`. Linux=30, macOS=30. `ErrorKind::ReadOnlyFilesystem` is
181/// the portable variant (stable as of 1.83).
182const EROFS: i32 = 30;
183
184/// POSIX `EXDEV` ("cross-device link"). Linux=18, macOS=18.
185/// `ErrorKind::CrossesDevices` is the portable variant (stable as of 1.83).
186const EXDEV: i32 = 18;
187
188/// Returns true when an `io::Error` indicates the filesystem is out of
189/// space. Centralised here because it's the same predicate used by
190/// `write_file_atomic` (the inner helper) and by the higher-level
191/// `cmd_snapshot` recovery path that prints the actionable message.
192pub fn is_out_of_space(err: &io::Error) -> bool {
193    if err.raw_os_error() == Some(ENOSPC) {
194        return true;
195    }
196    // `ErrorKind::StorageFull` is the portable kind. It maps to ENOSPC
197    // on Unix and the Windows disk-full codes. Available since Rust
198    // 1.83; the workspace MSRV is well past that.
199    if err.kind() == io::ErrorKind::StorageFull {
200        return true;
201    }
202    // `write_all` translates a short write into `WriteZero`. On a full
203    // disk, kernel can return a short write rather than ENOSPC outright
204    // (especially over network filesystems), so a `WriteZero` we couldn't
205    // otherwise classify is treated as out-of-space — overly inclusive
206    // here is safer than missing the signal.
207    if err.kind() == io::ErrorKind::WriteZero {
208        return true;
209    }
210    false
211}
212
213/// Returns true when an `io::Error` indicates a directory could not be
214/// removed because it still contained entries. The apply planner only removes
215/// tracked descendants; when tracked content is removed and the parent
216/// directory still holds untracked or explicitly ignored siblings, `remove_dir`
217/// returns this signal. We need both `ErrorKind::DirectoryNotEmpty` and the raw
218/// codes — Linux=39, macOS/BSD=66, Windows=145 — because Rust does not
219/// always translate every kernel surface into the portable `ErrorKind`.
220pub fn is_directory_not_empty(err: &io::Error) -> bool {
221    if err.kind() == io::ErrorKind::DirectoryNotEmpty {
222        return true;
223    }
224    matches!(
225        err.raw_os_error(),
226        Some(ENOTEMPTY_LINUX) | Some(ENOTEMPTY_MACOS) | Some(ENOTEMPTY_WINDOWS)
227    )
228}
229
230/// Returns true when an `io::Error` indicates the operation was denied
231/// for permissions reasons (`EACCES` on Unix, `ERROR_ACCESS_DENIED` on
232/// Windows). The portable `ErrorKind::PermissionDenied` covers most
233/// surfaces; the raw `EACCES` check handles oddball platforms that
234/// surface the OS code without translating to the portable kind.
235pub fn is_permission_denied(err: &io::Error) -> bool {
236    if err.kind() == io::ErrorKind::PermissionDenied {
237        return true;
238    }
239    err.raw_os_error() == Some(EACCES)
240}
241
242/// Returns true when an `io::Error` indicates the path referenced by an
243/// operation does not exist (`ENOENT` on Unix, `ERROR_FILE_NOT_FOUND` /
244/// `ERROR_PATH_NOT_FOUND` on Windows). Use this *only* at call sites
245/// where the operation expected the path to exist — the predicate alone
246/// can't distinguish "I expected this" from "I checked optionally".
247pub fn is_not_found(err: &io::Error) -> bool {
248    if err.kind() == io::ErrorKind::NotFound {
249        return true;
250    }
251    err.raw_os_error() == Some(ENOENT)
252}
253
254/// Returns true when an `io::Error` indicates the underlying filesystem
255/// is mounted read-only (`EROFS` on Unix). The portable
256/// `ErrorKind::ReadOnlyFilesystem` is preferred when present; we also
257/// match the raw OS code because some platforms (notably older macOS
258/// surfaces and certain remote filesystems) do not always translate.
259pub fn is_read_only_filesystem(err: &io::Error) -> bool {
260    if err.kind() == io::ErrorKind::ReadOnlyFilesystem {
261        return true;
262    }
263    err.raw_os_error() == Some(EROFS)
264}
265
266/// Returns true when an `io::Error` indicates a `rename` (or other
267/// link-style operation) attempted to bridge two filesystems (`EXDEV`).
268/// This is what trips when `temp_path` lands on a different mount than
269/// the destination — typically because `TMPDIR` is on a different volume,
270/// or the parent directory itself is a bind mount. We match both the
271/// portable `ErrorKind::CrossesDevices` and the raw `EXDEV` code.
272pub fn is_cross_device_link(err: &io::Error) -> bool {
273    if err.kind() == io::ErrorKind::CrossesDevices {
274        return true;
275    }
276    err.raw_os_error() == Some(EXDEV)
277}
278
279pub fn temp_path(path: &Path) -> PathBuf {
280    let parent = path.parent().unwrap_or_else(|| Path::new("."));
281    let file_name = path
282        .file_name()
283        .and_then(|s| s.to_str())
284        .filter(|s| !s.is_empty())
285        .unwrap_or("heddle-tmp");
286    let unique = SystemTime::now()
287        .duration_since(UNIX_EPOCH)
288        .map(|d| d.as_nanos())
289        .unwrap_or(0);
290    let counter = TEMP_PATH_COUNTER.fetch_add(1, Ordering::Relaxed);
291    let pid = std::process::id();
292    parent.join(format!(".{file_name}.tmp-{pid}-{unique}-{counter}"))
293}
294
295/// Kick a file's dirty page cache into background writeback WITHOUT waiting
296/// for it or issuing a device flush. Best-effort: any error is ignored, since
297/// the caller's subsequent `fsync` is what actually guarantees durability —
298/// this only *starts* the I/O early so many files' writeback overlaps instead
299/// of each `fsync` flushing its file synchronously from scratch.
300///
301/// Linux-only (`sync_file_range`); a no-op elsewhere, where the batched-fsync
302/// pass in [`stage_temp_files_durable`] simply runs without the overlap.
303#[cfg(target_os = "linux")]
304fn kick_writeback(file: &File) {
305    use std::os::unix::io::AsRawFd;
306    // SYNC_FILE_RANGE_WRITE = 2: initiate writeback of dirty pages in the
307    // given range (0..0 = whole file) without blocking. No barrier, no error
308    // path — a failure just means the later `sync_all` does the work.
309    const SYNC_FILE_RANGE_WRITE: libc::c_uint = 2;
310    unsafe {
311        libc::sync_file_range(file.as_raw_fd(), 0, 0, SYNC_FILE_RANGE_WRITE);
312    }
313}
314
315#[cfg(not(target_os = "linux"))]
316fn kick_writeback(_file: &File) {}
317
318/// Write many temp files with a single overlapped-writeback durability pass.
319///
320/// For each `(temp_path, bytes)`: create the temp file and write its contents,
321/// then start its page-cache writeback in the background ([`kick_writeback`]).
322/// After every file is written, `fsync` each one. On return, every temp file's
323/// data is on stable storage — the SAME guarantee as writing + `fsync`-ing each
324/// file individually — but the writeback I/O overlaps instead of serializing
325/// one synchronous `fsync` barrier per file.
326///
327/// This is the bulk-ref hot path (`heddle adopt` of N branches publishes N ref
328/// files in one batch): the per-file `write → fsync` loop paid ~N serial fsync
329/// barriers (~2.3s for 800 refs on a local SSD); overlapping the writeback
330/// collapses that to ~0.1s with no change to the durability contract. Callers
331/// still `rename` each temp into place and `fsync` the parent directory to make
332/// the renames durable.
333///
334/// The temp files' parent directories must already exist. On the first write
335/// error the partial temp files are left for the caller's rollback/cleanup to
336/// remove (they are uniquely named and never renamed into place).
337pub fn stage_temp_files_durable(files: &[(PathBuf, Vec<u8>)]) -> io::Result<()> {
338    let mut handles: Vec<File> = Vec::with_capacity(files.len());
339    for (temp_path, bytes) in files {
340        let mut file = File::create(temp_path).map_err(|err| enrich_write_error(temp_path, err))?;
341        file.write_all(bytes)
342            .map_err(|err| enrich_write_error(temp_path, err))?;
343        kick_writeback(&file);
344        handles.push(file);
345    }
346    // Barrier pass: by now most files' writeback is already in flight (or done),
347    // so each `sync_all` blocks only on the tail, not a cold synchronous flush.
348    for (file, (temp_path, _)) in handles.iter().zip(files) {
349        sync_file(file, temp_path).map_err(|err| enrich_write_error(temp_path, err))?;
350    }
351    Ok(())
352}
353
354/// fsync the directory inode so a preceding `rename` is durable across
355/// crashes. POSIX-only — on Windows this is a no-op.
356///
357/// On Linux/macOS, after an `fsync(file)` + `rename(tmp, dest)` the
358/// rename itself still needs to be made durable, which requires
359/// `fsync(parent_dir)` (open parent for read, `sync_all`). Without it
360/// a crash between the rename and the next directory writeback can
361/// leave the destination dirent missing even though the file's data is
362/// on disk.
363///
364/// Windows directories don't support this pattern. `CreateFileW` with
365/// `GENERIC_READ` against a directory returns `ERROR_ACCESS_DENIED`
366/// unless the caller passes `FILE_FLAG_BACKUP_SEMANTICS`, and even
367/// then `FlushFileBuffers` on a directory handle is undefined — NTFS
368/// reports access-denied. Directory metadata durability on Windows is
369/// handled by the NTFS log; there is no userspace knob equivalent to
370/// `fsync(dirfd)`, and standard ecosystem crates (`tempfile`,
371/// `atomicwrites`) treat the directory sync as a Unix-only concern.
372///
373/// Returning `Ok(())` on Windows matches that consensus and fixes
374/// heddle#105 (`Repository::init_default` panicking with
375/// `PermissionDenied` on every `write_file_atomic` of an oplog or
376/// state file under a Windows tempdir).
377#[cfg(windows)]
378pub fn sync_directory(_path: &Path) -> io::Result<()> {
379    Ok(())
380}
381
382#[cfg(not(windows))]
383pub fn sync_directory(path: &Path) -> io::Result<()> {
384    if let Some(stats) = deferred_clone_stats(path) {
385        stats.skipped.fetch_add(1, Ordering::Relaxed);
386        return Ok(());
387    }
388    let dir = OpenOptions::new().read(true).open(path)?;
389    dir.sync_all()
390}
391
392/// Sync one file unless it belongs to an active clone durability batch.
393pub fn sync_file(file: &File, path: &Path) -> io::Result<()> {
394    if let Some(stats) = deferred_clone_stats(path) {
395        stats.skipped.fetch_add(1, Ordering::Relaxed);
396        return Ok(());
397    }
398    file.sync_all()
399}
400
401pub fn sync_file_data(file: &File, path: &Path) -> io::Result<()> {
402    if let Some(stats) = deferred_clone_stats(path) {
403        stats.skipped.fetch_add(1, Ordering::Relaxed);
404        return Ok(());
405    }
406    file.sync_data()
407}
408
409#[cfg(any(target_os = "linux", target_os = "android"))]
410fn sync_filesystem(path: &Path) -> io::Result<()> {
411    use std::os::fd::AsRawFd;
412
413    let file = OpenOptions::new().read(true).open(path)?;
414    // SAFETY: `file` owns a live descriptor for the duration of the call.
415    if unsafe { libc::syncfs(file.as_raw_fd()) } == 0 {
416        Ok(())
417    } else {
418        Err(io::Error::last_os_error())
419    }
420}
421
422#[cfg(all(unix, not(any(target_os = "linux", target_os = "android"))))]
423fn sync_filesystem(_path: &Path) -> io::Result<()> {
424    // `syncfs(2)` is Linux-specific. `sync(2)` is the closest portable Unix
425    // whole-filesystem commit primitive and avoids a barrier per clone object.
426    unsafe { libc::sync() };
427    Ok(())
428}
429
430#[cfg(windows)]
431fn sync_filesystem(path: &Path) -> io::Result<()> {
432    // Windows exposes no non-privileged `syncfs` equivalent. Keep one logical
433    // clone commit phase, flushing every clone file only after verification;
434    // directory metadata is covered by NTFS journaling (see `sync_directory`).
435    for entry in fs::read_dir(path)? {
436        let entry = entry?;
437        let file_type = entry.file_type()?;
438        if file_type.is_dir() {
439            sync_filesystem(&entry.path())?;
440        } else if file_type.is_file() {
441            OpenOptions::new()
442                .read(true)
443                .open(entry.path())?
444                .sync_all()?;
445        }
446    }
447    Ok(())
448}
449
450/// Collect missing path components (deepest-first) and the deepest pre-existing
451/// parent that will hold the first new dirent. Used by durable dir creators so
452/// post-create fsync covers every new link without weakening create semantics.
453fn plan_missing_dirs(path: &Path) -> (Vec<PathBuf>, Option<PathBuf>) {
454    // Walk from `path` upward until we hit an existing directory (or run out of
455    // parents). `missing[0]` is the leaf; `missing.last()` is the shallowest new dir.
456    let mut missing: Vec<PathBuf> = Vec::new();
457    {
458        let mut cur = path;
459        loop {
460            match fs::metadata(cur) {
461                Ok(meta) if meta.is_dir() => break,
462                Ok(_) => {
463                    // Exists but is not a directory. Fall through to the create
464                    // call so the error matches the platform/create helper.
465                    break;
466                }
467                Err(e) if e.kind() == io::ErrorKind::NotFound => {
468                    missing.push(cur.to_path_buf());
469                    match cur.parent() {
470                        // `Path::new("a").parent()` is `Some("")` for a single
471                        // relative component — treat empty as cwd (`.`).
472                        Some(parent) if parent.as_os_str().is_empty() => break,
473                        // Root is its own parent (`"/".parent() == Some("/")`).
474                        Some(parent) if parent != cur => cur = parent,
475                        _ => break,
476                    }
477                }
478                // Permission / IO errors walking ancestors: let the create
479                // helper surface a consistent failure for the full path.
480                Err(_) => break,
481            }
482        }
483    }
484
485    let deepest_existing = missing
486        .last()
487        .and_then(|shallowest| match shallowest.parent() {
488            Some(parent) if parent.as_os_str().is_empty() => Some(PathBuf::from(".")),
489            Some(parent) => Some(parent.to_path_buf()),
490            None => None,
491        });
492
493    (missing, deepest_existing)
494}
495
496/// Fsync newly created directories deepest-first, then the deepest pre-existing
497/// parent so each new child dirent is durable. No-op when nothing was created.
498fn sync_new_dirents(missing: &[PathBuf], deepest_existing: Option<&Path>) -> io::Result<()> {
499    if missing.is_empty() {
500        return Ok(());
501    }
502    for dir in missing {
503        sync_directory(dir)?;
504    }
505    // Fsync the deepest pre-existing parent so the first new child dirent
506    // (the grandparent→shard link in the classic `blobs/ab/` case) is durable.
507    if let Some(existing) = deepest_existing {
508        sync_directory(existing)?;
509    }
510    Ok(())
511}
512
513/// Create a directory and any missing ancestors, making new dirents crash-durable.
514///
515/// Bare [`fs::create_dir_all`] only ensures the directories exist in the live
516/// filesystem view. After the first write into a newly created shard
517/// (e.g. `blobs/ab/…`), [`write_file_atomic`] fsyncs the shard directory so
518/// the *file* dirent is durable — but the grandparent that holds the new
519/// shard dirent may never be fsynced. A crash can then drop the entire new
520/// shard tree despite per-file durability (GAP_MAP L6).
521///
522/// This helper:
523/// 1. creates missing ancestor directories (same end state as `create_dir_all`);
524/// 2. fsyncs each newly created directory, deepest-first;
525/// 3. fsyncs the deepest pre-existing parent so the new child dirent is durable.
526///
527/// On Windows, directory fsync is a no-op (see [`sync_directory`]); creation
528/// still proceeds. Cost is once per new path segment (typically once per
529/// object-store shard).
530pub fn create_dir_all_durable(path: &Path) -> io::Result<()> {
531    let (missing, deepest_existing) = plan_missing_dirs(path);
532    fs::create_dir_all(path)?;
533    sync_new_dirents(&missing, deepest_existing.as_deref())
534}
535
536/// Wrap an `io::Error` raised while writing `path` so that ENOSPC carries
537/// an actionable message naming the path. Non-ENOSPC errors pass through
538/// unchanged. The wrapped error's `raw_os_error()` still returns 28, and
539/// [`is_out_of_space`] still detects it — callers (e.g. `cmd_snapshot`)
540/// rely on this for stable exit-code mapping.
541///
542/// Thin wrapper over [`enrich_fs_error`] for the historical "writing"
543/// call sites. New code should prefer `enrich_fs_error(path, "writing", err)`
544/// directly so the operation name is explicit at the call site.
545fn enrich_write_error(path: &Path, err: io::Error) -> io::Error {
546    enrich_fs_error(path, "writing", err)
547}
548
549/// Wrap an `io::Error` produced by a filesystem operation against `path`
550/// with a heddle-context message naming both the operation and the path.
551///
552/// The mapping covers the cases users actually hit and the messages we
553/// promise from heddle's CLI surface:
554/// - **ENOTEMPTY** — usually `remove_dir` against a directory that still
555///   holds untracked or explicitly ignored content, such as build output.
556///   The high-level fix is to leave the directory in place, but when the
557///   error does surface (e.g. a path the planner *did* expect to remove),
558///   the message names the path so the user can investigate.
559/// - **EACCES** — naming the path and the action ("removing", "writing",
560///   "renaming") is enough for the user to inspect mode bits.
561/// - **ENOENT** — caller-driven: only enriched when the operation
562///   expected the path to exist (so optional reads like a missing index
563///   pass through unchanged via the `is_not_found` predicate).
564/// - **EROFS** — points the user at the filesystem mount, not at heddle.
565/// - **EXDEV** — points the user at the temp path / mount mismatch.
566/// - **ENOSPC** — same actionable disk-full message the snapshot path
567///   already relies on.
568///
569/// `op` is a verb in the present-progressive ("writing", "removing",
570/// "renaming", "creating") so the resulting message reads naturally:
571///   `"could not remove `<path>` because it contains content..."`.
572///
573/// The wrapped error preserves `raw_os_error()` (callers still classify
574/// disk-full via [`is_out_of_space`]) and exposes the original `io::Error`
575/// through the `Error::source` chain (so `RUST_BACKTRACE=1` and
576/// `anyhow`'s chain printer still surface the OS error).
577pub fn enrich_fs_error(path: &Path, op: &'static str, err: io::Error) -> io::Error {
578    if is_out_of_space(&err) {
579        let msg = format!(
580            "out of disk space {op} {}: free disk space and re-run the command — your working tree is unchanged",
581            path.display()
582        );
583        return io::Error::new(
584            io::ErrorKind::StorageFull,
585            EnrichedFsError { msg, source: err },
586        );
587    }
588    if is_directory_not_empty(&err) {
589        let msg = format!(
590            "could not remove directory `{}` because it contains content (heddle-ignored or otherwise) — leaving in place",
591            path.display()
592        );
593        return io::Error::new(
594            io::ErrorKind::DirectoryNotEmpty,
595            EnrichedFsError { msg, source: err },
596        );
597    }
598    if is_read_only_filesystem(&err) {
599        let msg = format!(
600            "filesystem is read-only — `{}` cannot be modified",
601            path.display()
602        );
603        return io::Error::new(
604            io::ErrorKind::ReadOnlyFilesystem,
605            EnrichedFsError { msg, source: err },
606        );
607    }
608    if is_permission_denied(&err) {
609        let msg = format!(
610            "permission denied {op} `{}` — check filesystem permissions",
611            path.display()
612        );
613        return io::Error::new(
614            io::ErrorKind::PermissionDenied,
615            EnrichedFsError { msg, source: err },
616        );
617    }
618    if is_not_found(&err) {
619        let msg = format!("could not find `{}` for {op}", path.display());
620        return io::Error::new(
621            io::ErrorKind::NotFound,
622            EnrichedFsError { msg, source: err },
623        );
624    }
625    if is_cross_device_link(&err) {
626        let msg = format!(
627            "cannot rename across filesystems — temp file for `{}` lives on a different mount; set TMPDIR to the same filesystem as the destination",
628            path.display()
629        );
630        return io::Error::new(
631            io::ErrorKind::CrossesDevices,
632            EnrichedFsError { msg, source: err },
633        );
634    }
635    err
636}
637
638/// Wrap an `EXDEV` error from `fs::rename` with both the source temp path
639/// and the destination — the user needs both to understand which mount
640/// boundary the rename tripped on. Other error kinds delegate to
641/// [`enrich_fs_error`] using the destination as the principal path.
642pub fn enrich_rename_error(src: &Path, dst: &Path, err: io::Error) -> io::Error {
643    if is_cross_device_link(&err) {
644        let msg = format!(
645            "cannot rename across filesystems — temp file at `{}` cannot be renamed to `{}`; set TMPDIR to the same filesystem as the destination",
646            src.display(),
647            dst.display()
648        );
649        return io::Error::new(
650            io::ErrorKind::CrossesDevices,
651            EnrichedFsError { msg, source: err },
652        );
653    }
654    enrich_fs_error(dst, "renaming", err)
655}
656
657#[derive(Debug)]
658struct EnrichedFsError {
659    msg: String,
660    source: io::Error,
661}
662
663impl std::fmt::Display for EnrichedFsError {
664    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
665        f.write_str(&self.msg)
666    }
667}
668
669impl std::error::Error for EnrichedFsError {
670    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
671        Some(&self.source)
672    }
673}
674
675pub struct StagedAtomicWrite {
676    path: PathBuf,
677    parent: PathBuf,
678    tmp: PathBuf,
679    pending: bool,
680}
681
682impl StagedAtomicWrite {
683    pub fn publish(mut self) -> io::Result<()> {
684        fs::rename(&self.tmp, &self.path)
685            .map_err(|error| enrich_rename_error(&self.tmp, &self.path, error))?;
686        self.pending = false;
687        sync_directory(&self.parent)
688            .map_err(|error| enrich_fs_error(&self.parent, "syncing", error))
689    }
690}
691
692impl Drop for StagedAtomicWrite {
693    fn drop(&mut self) {
694        if self.pending {
695            let _ = fs::remove_file(&self.tmp);
696        }
697    }
698}
699
700fn stage_file_atomic_impl(
701    path: &Path,
702    bytes: &[u8],
703    kind: AtomicWriteKind,
704    before_write: impl FnOnce(&File, &Path) -> io::Result<()>,
705) -> io::Result<StagedAtomicWrite> {
706    let parent = path.parent().unwrap_or_else(|| Path::new("."));
707    create_dir_all_durable(parent).map_err(|e| enrich_fs_error(parent, "creating", e))?;
708
709    let tmp = temp_path(path);
710    let inner = (|| -> io::Result<()> {
711        let mut file = kind.open_tmp(&tmp)?;
712        kind.enforce_before_write(&file)?;
713        before_write(&file, &tmp)?;
714        file.write_all(bytes)?;
715        sync_file(&file, &tmp)?;
716        Ok(())
717    })();
718
719    if let Err(err) = inner {
720        // Best-effort cleanup. On ENOSPC the tempfile may itself be the
721        // cause of the disk pressure; removing it gives the user back
722        // some slack before they re-run.
723        let _ = fs::remove_file(&tmp);
724        return Err(enrich_write_error(path, err));
725    }
726
727    Ok(StagedAtomicWrite {
728        path: path.to_path_buf(),
729        parent: parent.to_path_buf(),
730        tmp,
731        pending: true,
732    })
733}
734
735fn write_file_atomic_impl(
736    path: &Path,
737    bytes: &[u8],
738    kind: AtomicWriteKind,
739    before_write: impl FnOnce(&File, &Path) -> io::Result<()>,
740) -> io::Result<()> {
741    stage_file_atomic_impl(path, bytes, kind, before_write)?.publish()
742}
743
744pub fn write_file_atomic(path: &Path, bytes: &[u8]) -> io::Result<()> {
745    write_file_atomic_impl(path, bytes, AtomicWriteKind::Normal, |_, _| Ok(()))
746}
747
748/// Create a directory tree with owner-only permissions on Unix (`0o700`),
749/// making newly created dirents crash-durable (same fsync chain as
750/// [`create_dir_all_durable`]).
751///
752/// Used for `.heddle` / `~/.heddle` trees that hold credentials, keys, and
753/// repository secrets. On Unix, missing ancestors are created with mode
754/// `0o700` and then fsynced deepest-first, plus the deepest pre-existing
755/// parent. On non-Unix platforms this falls back to durable
756/// [`create_dir_all_durable`] (no portable POSIX mode API). Existing
757/// directories are left as-is (creation-time privacy; callers that need to
758/// tighten existing modes should do so explicitly).
759pub fn create_private_dir_all(path: &Path) -> io::Result<()> {
760    #[cfg(unix)]
761    {
762        use std::os::unix::fs::DirBuilderExt;
763        let (missing, deepest_existing) = plan_missing_dirs(path);
764        let mut builder = fs::DirBuilder::new();
765        builder.recursive(true).mode(0o700);
766        match builder.create(path) {
767            Ok(()) => {}
768            Err(e) if e.kind() == io::ErrorKind::AlreadyExists => {}
769            Err(e) => return Err(e),
770        }
771        sync_new_dirents(&missing, deepest_existing.as_deref())
772    }
773    #[cfg(not(unix))]
774    {
775        // No portable POSIX mode API — same durable create chain as public dirs.
776        create_dir_all_durable(path)
777    }
778}
779
780/// Atomically write secret material without ever creating a group/world
781/// readable temporary file.
782///
783/// On Unix the temp inode is created with `OpenOptions::mode(0o600)` before
784/// any bytes are written, then the open file descriptor is enforced to exact
785/// `0600` before the payload is written. Permission failures are hard errors
786/// and the temp file is removed best-effort. On non-Unix platforms there is no
787/// portable POSIX mode API, so this uses the normal create-new temp file,
788/// fsync, and rename sequence.
789pub fn write_file_atomic_secret(path: &Path, bytes: &[u8]) -> io::Result<()> {
790    write_file_atomic_impl(path, bytes, AtomicWriteKind::Secret, |_, _| Ok(()))
791}
792
793pub fn stage_file_atomic_secret(path: &Path, bytes: &[u8]) -> io::Result<StagedAtomicWrite> {
794    stage_file_atomic_impl(path, bytes, AtomicWriteKind::Secret, |_, _| Ok(()))
795}
796
797/// Publish an existing on-disk file at `src` to `dst` with the same
798/// crash-consistency contract as [`write_file_atomic`]:
799///
800/// 1. `fsync` the source so its data blocks are stable before any directory
801///    entry is updated (`rename` moves a dirent; it does not re-write bytes).
802/// 2. `rename(src, dst)` when both paths share a filesystem — atomic dirent
803///    publish.
804/// 3. On `EXDEV`, stream-copy into a *same-directory* temp, `fsync` the temp,
805///    `rename` over `dst`, then remove `src`. Never write the final path in
806///    place: a crash mid-copy must not leave a torn content-addressed object
807///    under its final name.
808/// 4. `fsync` the destination parent so the new dirent is durable.
809///
810/// If `dst` already exists and rename reports `AlreadyExists` (Windows;
811/// POSIX `rename` replaces files), the source is removed and `Ok(())` is
812/// returned — content-addressed install idempotency.
813///
814/// Non-`EXDEV` rename failures propagate. Callers must not silently fall
815/// through to a raw in-place copy on unrelated errors (the previous
816/// streaming-pack install path did exactly that).
817/// Fsync an existing regular file's data blocks.
818///
819/// On Windows, `FlushFileBuffers` requires write access — a read-only
820/// `File::open` + `sync_all` returns `ERROR_ACCESS_DENIED` (code 5). Open
821/// with write so pack install / L8 journal publish works under Windows
822/// tempdirs (projfs smoke fixtures).
823fn fsync_file_data(path: &Path) -> io::Result<()> {
824    let file = OpenOptions::new()
825        .read(true)
826        .write(true)
827        .open(path)
828        .map_err(|e| enrich_fs_error(path, "opening", e))?;
829    sync_file(&file, path).map_err(|e| enrich_fs_error(path, "syncing", e))
830}
831
832pub fn publish_file_durable(src: &Path, dst: &Path) -> io::Result<()> {
833    let parent = dst.parent().unwrap_or_else(|| Path::new("."));
834    create_dir_all_durable(parent).map_err(|e| enrich_fs_error(parent, "creating", e))?;
835
836    // Data-block durability before publishing the dirent. Required even on
837    // the same-filesystem rename path: StreamingPackBuilder (and similar
838    // staged writers) only `flush` buffered writers; without this fsync a
839    // crash after rename can lose the published object.
840    fsync_file_data(src)?;
841
842    match fs::rename(src, dst) {
843        Ok(()) => {}
844        Err(e) if e.kind() == io::ErrorKind::AlreadyExists => {
845            // Content-addressed install: destination already present.
846            let _ = fs::remove_file(src);
847        }
848        Err(e) if is_cross_device_link(&e) => {
849            publish_file_via_copy_durable(src, dst)?;
850        }
851        Err(e) => return Err(enrich_rename_error(src, dst, e)),
852    }
853
854    sync_directory(parent).map_err(|e| enrich_fs_error(parent, "syncing", e))
855}
856
857/// Cross-device publish path: copy to a same-dir temp, fsync, rename over
858/// `dst`. Exposed to unit tests so the no-torn-final-path contract is
859/// exercised without needing a real multi-mount layout.
860fn publish_file_via_copy_durable(src: &Path, dst: &Path) -> io::Result<()> {
861    let parent = dst.parent().unwrap_or_else(|| Path::new("."));
862    create_dir_all_durable(parent).map_err(|e| enrich_fs_error(parent, "creating", e))?;
863
864    let tmp = temp_path(dst);
865    let result = (|| -> io::Result<()> {
866        fs::copy(src, &tmp).map_err(|e| enrich_fs_error(&tmp, "writing", e))?;
867        fsync_file_data(&tmp)?;
868        fs::rename(&tmp, dst).map_err(|e| enrich_rename_error(&tmp, dst, e))?;
869        let _ = fs::remove_file(src);
870        Ok(())
871    })();
872    if result.is_err() {
873        let _ = fs::remove_file(&tmp);
874    }
875    result
876}
877
878#[cfg(test)]
879mod tests {
880    use super::*;
881
882    fn enospc_io_error() -> io::Error {
883        io::Error::from_raw_os_error(ENOSPC)
884    }
885
886    #[test]
887    fn is_out_of_space_detects_enospc_raw() {
888        assert!(is_out_of_space(&enospc_io_error()));
889    }
890
891    #[test]
892    fn is_out_of_space_detects_storage_full_kind() {
893        let err = io::Error::new(io::ErrorKind::StorageFull, "mock disk full");
894        assert!(is_out_of_space(&err));
895    }
896
897    #[test]
898    fn is_out_of_space_detects_write_zero() {
899        let err = io::Error::new(io::ErrorKind::WriteZero, "short write");
900        assert!(is_out_of_space(&err));
901    }
902
903    #[test]
904    fn is_out_of_space_rejects_unrelated_errors() {
905        assert!(!is_out_of_space(&io::Error::new(
906            io::ErrorKind::NotFound,
907            "missing"
908        )));
909        assert!(!is_out_of_space(&io::Error::new(
910            io::ErrorKind::PermissionDenied,
911            "nope"
912        )));
913        assert!(!is_out_of_space(&io::Error::other("generic")));
914    }
915
916    #[test]
917    fn is_directory_not_empty_detects_kind() {
918        let err = io::Error::new(io::ErrorKind::DirectoryNotEmpty, "still has children");
919        assert!(is_directory_not_empty(&err));
920    }
921
922    #[test]
923    fn is_directory_not_empty_detects_raw_codes() {
924        for code in [ENOTEMPTY_LINUX, ENOTEMPTY_MACOS, ENOTEMPTY_WINDOWS] {
925            assert!(
926                is_directory_not_empty(&io::Error::from_raw_os_error(code)),
927                "expected raw OS error {code} to classify as ENOTEMPTY"
928            );
929        }
930    }
931
932    #[test]
933    fn is_directory_not_empty_rejects_unrelated() {
934        assert!(!is_directory_not_empty(&io::Error::new(
935            io::ErrorKind::NotFound,
936            "missing"
937        )));
938        assert!(!is_directory_not_empty(&enospc_io_error()));
939    }
940
941    #[test]
942    fn is_permission_denied_detects_kind_and_raw() {
943        assert!(is_permission_denied(&io::Error::new(
944            io::ErrorKind::PermissionDenied,
945            "nope"
946        )));
947        assert!(is_permission_denied(&io::Error::from_raw_os_error(EACCES)));
948    }
949
950    #[test]
951    fn is_not_found_detects_kind_and_raw() {
952        assert!(is_not_found(&io::Error::new(
953            io::ErrorKind::NotFound,
954            "missing"
955        )));
956        assert!(is_not_found(&io::Error::from_raw_os_error(ENOENT)));
957    }
958
959    #[test]
960    fn is_read_only_filesystem_detects_raw() {
961        assert!(is_read_only_filesystem(&io::Error::from_raw_os_error(
962            EROFS
963        )));
964    }
965
966    #[test]
967    fn is_cross_device_link_detects_raw() {
968        assert!(is_cross_device_link(&io::Error::from_raw_os_error(EXDEV)));
969    }
970
971    #[test]
972    fn enrich_fs_error_passes_through_unclassified() {
973        let path = Path::new("/tmp/example");
974        let original = io::Error::other("weird");
975        let wrapped = enrich_fs_error(path, "writing", original);
976        // Unclassified errors are returned untouched.
977        assert_eq!(wrapped.kind(), io::ErrorKind::Other);
978        assert_eq!(wrapped.to_string(), "weird");
979    }
980
981    #[test]
982    fn enrich_fs_error_wraps_enospc_with_path_and_recovery_hint() {
983        let path = Path::new("/repo/.heddle/state/abc.bin");
984        let wrapped = enrich_fs_error(path, "writing", enospc_io_error());
985
986        // Stable kind so the CLI exit-code mapper finds it.
987        assert_eq!(wrapped.kind(), io::ErrorKind::StorageFull);
988        // Message names the failure, the path, and the recovery.
989        let msg = wrapped.to_string();
990        assert!(
991            msg.contains("out of disk space"),
992            "missing failure name: {msg}"
993        );
994        assert!(
995            msg.contains("/repo/.heddle/state/abc.bin"),
996            "missing path: {msg}"
997        );
998        assert!(
999            msg.contains("free disk space") && msg.contains("re-run"),
1000            "missing recovery hint: {msg}"
1001        );
1002        assert!(
1003            msg.contains("working tree is unchanged"),
1004            "missing reassurance: {msg}"
1005        );
1006        // Source chain preserved so callers that walk `source()` (e.g.
1007        // anyhow's chain printer) can still see the original ENOSPC.
1008        let src = std::error::Error::source(&wrapped as &dyn std::error::Error)
1009            .or_else(|| wrapped.get_ref().and_then(|e| e.source()))
1010            .expect("source preserved");
1011        assert!(src.to_string().to_lowercase().contains("space"));
1012    }
1013
1014    #[test]
1015    fn enrich_fs_error_wraps_enotempty_with_directory_message() {
1016        let path = Path::new("/repo/web");
1017        let wrapped = enrich_fs_error(
1018            path,
1019            "removing",
1020            io::Error::from_raw_os_error(ENOTEMPTY_MACOS),
1021        );
1022        assert_eq!(wrapped.kind(), io::ErrorKind::DirectoryNotEmpty);
1023        let msg = wrapped.to_string();
1024        assert!(
1025            msg.contains("could not remove directory"),
1026            "missing action: {msg}"
1027        );
1028        assert!(msg.contains("/repo/web"), "missing path: {msg}");
1029        assert!(
1030            msg.contains("heddle-ignored"),
1031            "missing heddle-ignored hint: {msg}"
1032        );
1033        assert!(
1034            msg.contains("leaving in place"),
1035            "missing reassurance: {msg}"
1036        );
1037        // raw_os_error() does NOT round-trip — `io::Error::new(kind, source)`
1038        // synthesizes a new error whose `raw_os_error()` is None — but the
1039        // source chain still exposes the original OS code for callers that
1040        // walk it.
1041        let src = wrapped.get_ref().and_then(|e| e.source()).expect("source");
1042        let original = src
1043            .downcast_ref::<io::Error>()
1044            .expect("original io::Error preserved");
1045        assert_eq!(original.raw_os_error(), Some(ENOTEMPTY_MACOS));
1046    }
1047
1048    #[test]
1049    fn enrich_fs_error_wraps_eacces_with_op_and_path() {
1050        let path = Path::new("/repo/.heddle/state/index.bin");
1051        let wrapped = enrich_fs_error(path, "writing", io::Error::from_raw_os_error(EACCES));
1052        assert_eq!(wrapped.kind(), io::ErrorKind::PermissionDenied);
1053        let msg = wrapped.to_string();
1054        assert!(msg.starts_with("permission denied writing"), "msg: {msg}");
1055        assert!(msg.contains("/repo/.heddle/state/index.bin"), "msg: {msg}");
1056        assert!(msg.contains("check filesystem permissions"), "msg: {msg}");
1057    }
1058
1059    #[test]
1060    fn enrich_fs_error_wraps_enoent_with_op_and_path() {
1061        let path = Path::new("/repo/.heddle");
1062        let wrapped = enrich_fs_error(path, "opening", io::Error::from_raw_os_error(ENOENT));
1063        assert_eq!(wrapped.kind(), io::ErrorKind::NotFound);
1064        let msg = wrapped.to_string();
1065        assert!(msg.contains("could not find"), "missing action: {msg}");
1066        assert!(msg.contains("/repo/.heddle"), "missing path: {msg}");
1067        assert!(msg.contains("for opening"), "missing op: {msg}");
1068    }
1069
1070    #[test]
1071    fn enrich_fs_error_wraps_erofs_with_path() {
1072        let path = Path::new("/mnt/readonly/.heddle/state/index.bin");
1073        let wrapped = enrich_fs_error(path, "writing", io::Error::from_raw_os_error(EROFS));
1074        assert_eq!(wrapped.kind(), io::ErrorKind::ReadOnlyFilesystem);
1075        let msg = wrapped.to_string();
1076        assert!(msg.contains("filesystem is read-only"), "msg: {msg}");
1077        assert!(
1078            msg.contains("/mnt/readonly/.heddle/state/index.bin"),
1079            "msg: {msg}"
1080        );
1081        assert!(msg.contains("cannot be modified"), "msg: {msg}");
1082    }
1083
1084    #[test]
1085    fn enrich_rename_error_wraps_exdev_with_src_and_dst() {
1086        let src = Path::new("/tmp-mount/.x.tmp-1234");
1087        let dst = Path::new("/repo/.heddle/state/index.bin");
1088        let wrapped = enrich_rename_error(src, dst, io::Error::from_raw_os_error(EXDEV));
1089        assert_eq!(wrapped.kind(), io::ErrorKind::CrossesDevices);
1090        let msg = wrapped.to_string();
1091        assert!(
1092            msg.contains("cannot rename across filesystems"),
1093            "msg: {msg}"
1094        );
1095        assert!(msg.contains("/tmp-mount/.x.tmp-1234"), "missing src: {msg}");
1096        assert!(
1097            msg.contains("/repo/.heddle/state/index.bin"),
1098            "missing dst: {msg}"
1099        );
1100        assert!(msg.contains("TMPDIR"), "missing recovery hint: {msg}");
1101    }
1102
1103    #[test]
1104    fn enrich_rename_error_falls_through_to_generic_for_other_kinds() {
1105        let src = Path::new("/tmp/.x.tmp");
1106        let dst = Path::new("/repo/file");
1107        let wrapped = enrich_rename_error(src, dst, io::Error::from_raw_os_error(EACCES));
1108        // Non-EXDEV rename failures get the generic `enrich_fs_error`
1109        // treatment, which preserves the dst path and the "renaming" op.
1110        assert_eq!(wrapped.kind(), io::ErrorKind::PermissionDenied);
1111        let msg = wrapped.to_string();
1112        assert!(msg.starts_with("permission denied renaming"), "msg: {msg}");
1113        assert!(msg.contains("/repo/file"), "missing dst: {msg}");
1114    }
1115
1116    #[test]
1117    fn enrich_write_error_passes_through_non_enospc_unclassified() {
1118        // The historical helper now delegates to `enrich_fs_error`, so a
1119        // generic Other error still passes through unchanged.
1120        let path = Path::new("/tmp/example");
1121        let original = io::Error::other("weird");
1122        let wrapped = enrich_write_error(path, original);
1123        assert_eq!(wrapped.kind(), io::ErrorKind::Other);
1124        assert_eq!(wrapped.to_string(), "weird");
1125    }
1126
1127    #[test]
1128    fn write_file_atomic_round_trip() {
1129        let dir = tempfile::TempDir::new().unwrap();
1130        let target = dir.path().join("nested/under/here/file.bin");
1131        write_file_atomic(&target, b"hello").unwrap();
1132        assert_eq!(fs::read(&target).unwrap(), b"hello");
1133    }
1134
1135    #[test]
1136    fn stage_temp_files_durable_writes_every_file_verbatim() {
1137        // The bulk-ref hot path stages N temp files in one overlapped-writeback
1138        // pass. Every file must land with its exact bytes — the batching is a
1139        // durability/perf optimization, never a content one.
1140        let dir = tempfile::TempDir::new().unwrap();
1141        let files: Vec<(PathBuf, Vec<u8>)> = (0..50)
1142            .map(|i| {
1143                (
1144                    dir.path().join(format!("ref-{i}.tmp")),
1145                    format!("change-id-{i}\n").into_bytes(),
1146                )
1147            })
1148            .collect();
1149
1150        stage_temp_files_durable(&files).unwrap();
1151
1152        for (path, bytes) in &files {
1153            assert_eq!(&fs::read(path).unwrap(), bytes, "mismatch at {path:?}");
1154        }
1155    }
1156
1157    #[test]
1158    fn stage_temp_files_durable_empty_batch_is_ok() {
1159        // A publish with no new-content plans (e.g. a pure delete batch) hands
1160        // an empty slice; it must be a clean no-op, not an error.
1161        stage_temp_files_durable(&[]).unwrap();
1162    }
1163
1164    #[test]
1165    fn stage_temp_files_durable_errors_when_parent_missing() {
1166        // The helper does NOT create parent directories (callers pre-create
1167        // them via `alloc_temp_path`); a missing parent surfaces as an error
1168        // rather than silently dropping the write.
1169        let dir = tempfile::TempDir::new().unwrap();
1170        let files = vec![(dir.path().join("does/not/exist/ref.tmp"), b"x".to_vec())];
1171        assert!(stage_temp_files_durable(&files).is_err());
1172    }
1173
1174    #[cfg(unix)]
1175    #[test]
1176    fn create_private_dir_all_sets_0700() {
1177        use std::os::unix::fs::PermissionsExt;
1178
1179        let dir = tempfile::TempDir::new().unwrap();
1180        let target = dir.path().join("nested/private");
1181        create_private_dir_all(&target).expect("create private dir");
1182        let mode = fs::metadata(&target).unwrap().permissions().mode() & 0o777;
1183        assert_eq!(mode, 0o700, "new private dir must be 0700, got {mode:o}");
1184        // Intermediate ancestors created by the recursive private create must
1185        // also be owner-only (DirBuilder mode applies to each new segment).
1186        let mid_mode = fs::metadata(dir.path().join("nested"))
1187            .unwrap()
1188            .permissions()
1189            .mode()
1190            & 0o777;
1191        assert_eq!(
1192            mid_mode, 0o700,
1193            "intermediate private ancestor must be 0700"
1194        );
1195        // Idempotent after durable create: re-run is success and modes stick.
1196        create_private_dir_all(&target).expect("idempotent private create");
1197        let mode_again = fs::metadata(&target).unwrap().permissions().mode() & 0o777;
1198        assert_eq!(mode_again, 0o700);
1199    }
1200
1201    #[cfg(unix)]
1202    #[test]
1203    fn write_file_atomic_secret_is_0600_before_write_and_after_rename() {
1204        use std::os::unix::fs::PermissionsExt;
1205
1206        let dir = tempfile::TempDir::new().unwrap();
1207        let target = dir.path().join("nested/secret.txt");
1208        let mut observed_tmp_mode = None;
1209
1210        write_file_atomic_impl(&target, b"secret", AtomicWriteKind::Secret, |file, tmp| {
1211            let fd_mode = file.metadata()?.permissions().mode() & 0o777;
1212            let path_mode = fs::metadata(tmp)?.permissions().mode() & 0o777;
1213            observed_tmp_mode = Some((fd_mode, path_mode));
1214            Ok(())
1215        })
1216        .unwrap();
1217
1218        assert_eq!(observed_tmp_mode, Some((0o600, 0o600)));
1219        let final_mode = fs::metadata(&target).unwrap().permissions().mode() & 0o777;
1220        assert_eq!(final_mode, 0o600);
1221        assert_eq!(fs::read(&target).unwrap(), b"secret");
1222    }
1223
1224    #[test]
1225    fn write_file_atomic_secret_cleans_up_when_pre_write_check_fails() {
1226        let dir = tempfile::TempDir::new().unwrap();
1227        let target = dir.path().join("secret.txt");
1228        let mut tmp_path = None;
1229
1230        let err = write_file_atomic_impl(&target, b"secret", AtomicWriteKind::Secret, |_, tmp| {
1231            tmp_path = Some(tmp.to_path_buf());
1232            Err(io::Error::new(
1233                io::ErrorKind::PermissionDenied,
1234                "injected permission failure",
1235            ))
1236        })
1237        .expect_err("permission failure should propagate");
1238
1239        assert!(is_permission_denied(&err), "unexpected error: {err}");
1240        assert!(!target.exists(), "secret write must not publish target");
1241        let tmp = tmp_path.expect("pre-write hook observed temp path");
1242        assert!(!tmp.exists(), "failed secret write should remove temp file");
1243    }
1244
1245    #[test]
1246    fn staged_secret_is_unpublished_until_publish() {
1247        let dir = tempfile::TempDir::new().unwrap();
1248        let target = dir.path().join("secret.txt");
1249        let staged = stage_file_atomic_secret(&target, b"secret").unwrap();
1250
1251        assert!(!target.exists());
1252        staged.publish().unwrap();
1253        assert_eq!(fs::read(target).unwrap(), b"secret");
1254    }
1255
1256    #[test]
1257    fn dropping_staged_secret_removes_temporary_file() {
1258        let dir = tempfile::TempDir::new().unwrap();
1259        let target = dir.path().join("secret.txt");
1260        let staged = stage_file_atomic_secret(&target, b"secret").unwrap();
1261        drop(staged);
1262
1263        assert!(!target.exists());
1264        assert_eq!(fs::read_dir(dir.path()).unwrap().count(), 0);
1265    }
1266
1267    /// Regression for heddle#105: `sync_directory` must succeed on any
1268    /// writable directory. The original implementation called
1269    /// `OpenOptions::new().read(true).open(dir)` + `sync_all()`, which
1270    /// fails on Windows with `ERROR_ACCESS_DENIED` (5) because Windows
1271    /// directory handles require `FILE_FLAG_BACKUP_SEMANTICS` and
1272    /// `FlushFileBuffers` on a directory handle is not a supported
1273    /// operation. The failure cascaded through `write_file_atomic` into
1274    /// `Repository::init_default`, breaking `heddle init` on Windows.
1275    #[test]
1276    fn sync_directory_succeeds_on_writable_tempdir() {
1277        let dir = tempfile::TempDir::new().unwrap();
1278        sync_directory(dir.path()).expect("sync_directory on writable tempdir");
1279    }
1280
1281    /// Regression for heddle#105: full `write_file_atomic` round-trip
1282    /// against a freshly-created nested directory must not surface
1283    /// `PermissionDenied`. The previous failure mode was the
1284    /// `sync_directory(parent)` call at the end of `write_file_atomic`.
1285    #[test]
1286    fn write_file_atomic_does_not_permission_deny_on_parent_sync() {
1287        let dir = tempfile::TempDir::new().unwrap();
1288        let target = dir.path().join("oplog/oplog.bin");
1289        let result = write_file_atomic(&target, b"hello");
1290        if let Err(e) = &result {
1291            assert!(
1292                !is_permission_denied(e),
1293                "write_file_atomic surfaced PermissionDenied on a writable \
1294                 tempdir (heddle#105): {e}"
1295            );
1296        }
1297        result.expect("write_file_atomic");
1298    }
1299
1300    #[test]
1301    fn publish_file_durable_renames_and_removes_source() {
1302        let dir = tempfile::TempDir::new().unwrap();
1303        let src = dir.path().join("staged.pack");
1304        let dst = dir.path().join("objects/packs/final.pack");
1305        fs::write(&src, b"pack-bytes").unwrap();
1306
1307        publish_file_durable(&src, &dst).unwrap();
1308
1309        assert!(!src.exists(), "source must be consumed by publish");
1310        assert_eq!(fs::read(&dst).unwrap(), b"pack-bytes");
1311    }
1312
1313    /// Windows: FlushFileBuffers needs write access; read-only open +
1314    /// sync_all fails with ERROR_ACCESS_DENIED and broke L8 pack install /
1315    /// projfs fixture setup under tempdirs.
1316    #[test]
1317    fn publish_file_durable_syncs_source_without_permission_deny() {
1318        let dir = tempfile::TempDir::new().unwrap();
1319        let src = dir.path().join("staged.bin");
1320        let dst = dir.path().join("final.bin");
1321        fs::write(&src, b"need-fsync-before-rename").unwrap();
1322        let result = publish_file_durable(&src, &dst);
1323        if let Err(e) = &result {
1324            assert!(
1325                !is_permission_denied(e),
1326                "publish_file_durable PermissionDenied on source fsync: {e}"
1327            );
1328        }
1329        result.expect("publish_file_durable");
1330        assert_eq!(fs::read(&dst).unwrap(), b"need-fsync-before-rename");
1331    }
1332
1333    #[test]
1334    fn publish_file_via_copy_durable_never_writes_final_path_directly() {
1335        // Regression for streaming pack install: the EXDEV fallback used
1336        // `fs::copy(src, dst)` straight into the content-addressed final
1337        // path. A crash mid-copy left a torn pack under its BLAKE3 name
1338        // (readers treat that name as authoritative). The durable path
1339        // must land bytes at a temp sibling first, then rename.
1340        let dir = tempfile::TempDir::new().unwrap();
1341        let src = dir.path().join("staged.pack");
1342        let dst = dir.path().join("final.pack");
1343        // Pre-existing destination simulates a previous torn install that
1344        // a naive in-place copy would non-atomically overwrite.
1345        fs::write(&dst, b"TORN-OLD-CONTENT!!!!!!!!!!!!!").unwrap();
1346        fs::write(&src, b"complete-new-pack-bytes").unwrap();
1347
1348        publish_file_via_copy_durable(&src, &dst).unwrap();
1349
1350        assert!(!src.exists(), "source must be removed after copy publish");
1351        assert_eq!(fs::read(&dst).unwrap(), b"complete-new-pack-bytes");
1352        // No leftover temps in the destination directory.
1353        let leftovers: Vec<_> = fs::read_dir(dir.path())
1354            .unwrap()
1355            .filter_map(|e| e.ok())
1356            .map(|e| e.file_name().to_string_lossy().into_owned())
1357            .filter(|name| name.contains(".tmp-"))
1358            .collect();
1359        assert!(
1360            leftovers.is_empty(),
1361            "durable copy must not leave temp siblings: {leftovers:?}"
1362        );
1363    }
1364
1365    #[test]
1366    fn publish_file_via_copy_durable_cleans_temp_when_rename_cannot_publish() {
1367        // If the final rename cannot complete, the temp sibling must be
1368        // removed so a crash/retry path doesn't accumulate junk — and the
1369        // pre-existing destination must be left untouched (atomic replace
1370        // failed → old bytes still authoritative).
1371        let dir = tempfile::TempDir::new().unwrap();
1372        let src = dir.path().join("staged.pack");
1373        let dst_dir = dir.path().join("final.pack");
1374        fs::write(&src, b"new-bytes").unwrap();
1375        // Make `dst` a directory so `rename(temp, dst)` fails (EISDIR /
1376        // ERROR_ACCESS_DENIED class). The copy-into-temp step succeeds;
1377        // only the publish rename fails.
1378        fs::create_dir(&dst_dir).unwrap();
1379
1380        let err = publish_file_via_copy_durable(&src, &dst_dir).expect_err("rename over dir");
1381        assert!(
1382            err.kind() == io::ErrorKind::AlreadyExists
1383                || err.raw_os_error().is_some()
1384                || is_permission_denied(&err)
1385                || err.kind() == io::ErrorKind::Other
1386                || err.kind() == io::ErrorKind::IsADirectory
1387                || err.kind() == io::ErrorKind::DirectoryNotEmpty,
1388            "unexpected error kind for rename-over-dir: {err:?}"
1389        );
1390        assert!(src.exists(), "failed publish must leave source intact");
1391        assert!(dst_dir.is_dir(), "destination directory must be untouched");
1392        let leftovers: Vec<_> = fs::read_dir(dir.path())
1393            .unwrap()
1394            .filter_map(|e| e.ok())
1395            .map(|e| e.file_name().to_string_lossy().into_owned())
1396            .filter(|name| name.contains(".tmp-"))
1397            .collect();
1398        assert!(
1399            leftovers.is_empty(),
1400            "failed publish must clean temp siblings: {leftovers:?}"
1401        );
1402    }
1403
1404    #[test]
1405    fn publish_file_durable_propagates_non_exdev_rename_failures() {
1406        // The previous install_pack_files_streaming path treated *any*
1407        // rename failure as "try fs::copy into the final path". A
1408        // permission / type error must surface, not be laundered into a
1409        // second write attempt against the content-addressed name.
1410        let dir = tempfile::TempDir::new().unwrap();
1411        let src = dir.path().join("staged.pack");
1412        let dst = dir.path().join("final.pack");
1413        fs::write(&src, b"pack-bytes").unwrap();
1414        fs::create_dir(&dst).unwrap();
1415
1416        let err = publish_file_durable(&src, &dst).expect_err("rename over directory");
1417        assert!(
1418            !is_cross_device_link(&err),
1419            "failure must not be misclassified as EXDEV: {err}"
1420        );
1421        // Source remains for the caller to retry / clean up.
1422        assert!(src.exists());
1423    }
1424
1425    /// GAP_MAP L6: nested shard directories must be creatable via the durable
1426    /// helper. We cannot observe fsync from userspace, but we can assert the
1427    /// end state matches `create_dir_all` (full nested path exists as dirs).
1428    #[test]
1429    fn create_dir_all_durable_creates_nested_path() {
1430        let dir = tempfile::TempDir::new().unwrap();
1431        // Classic object-store shard layout: grandparent holds the new shard
1432        // dirent (`ab`), parent is the shard itself.
1433        let shard = dir.path().join("blobs/ab");
1434        create_dir_all_durable(&shard).expect("create nested shard path");
1435        assert!(shard.is_dir(), "leaf shard directory must exist");
1436        assert!(
1437            dir.path().join("blobs").is_dir(),
1438            "intermediate grandparent must exist"
1439        );
1440        // Idempotent: re-running against an existing tree is a no-op success.
1441        create_dir_all_durable(&shard).expect("idempotent durable create");
1442        assert!(shard.is_dir());
1443    }
1444
1445    /// GAP_MAP L6: `write_file_atomic` must still round-trip when the full
1446    /// parent chain is missing — it now goes through `create_dir_all_durable`
1447    /// instead of bare `create_dir_all`.
1448    #[test]
1449    fn write_file_atomic_creates_missing_shard_parents() {
1450        let dir = tempfile::TempDir::new().unwrap();
1451        let target = dir.path().join("blobs/ab/object.bin");
1452        write_file_atomic(&target, b"shard-bytes").unwrap();
1453        assert_eq!(fs::read(&target).unwrap(), b"shard-bytes");
1454        assert!(dir.path().join("blobs/ab").is_dir());
1455    }
1456
1457    /// Existing parent chain: durable create must not fail or alter contents.
1458    #[test]
1459    fn create_dir_all_durable_ok_when_path_already_exists() {
1460        let dir = tempfile::TempDir::new().unwrap();
1461        let nested = dir.path().join("already/there");
1462        fs::create_dir_all(&nested).unwrap();
1463        create_dir_all_durable(&nested).expect("existing dir");
1464        assert!(nested.is_dir());
1465    }
1466}