codex-helper-core 0.15.0

Core library for codex-helper.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use std::fs;
use std::io::Write;
use std::path::{Path, PathBuf};

use anyhow::{Context, Result};

fn temp_path_for(path: &Path) -> PathBuf {
    path.with_extension("tmp.codex-helper")
}

#[cfg(windows)]
fn replace_existing_file_sync(tmp_path: &Path, path: &Path) -> Result<()> {
    if path.exists() {
        fs::copy(tmp_path, path).with_context(|| format!("copy {:?} -> {:?}", tmp_path, path))?;
        fs::remove_file(tmp_path).with_context(|| format!("remove {:?}", tmp_path))?;
    } else {
        fs::rename(tmp_path, path)
            .with_context(|| format!("rename {:?} -> {:?}", tmp_path, path))?;
    }
    Ok(())
}

#[cfg(not(windows))]
fn replace_existing_file_sync(tmp_path: &Path, path: &Path) -> Result<()> {
    fs::rename(tmp_path, path).with_context(|| format!("rename {:?} -> {:?}", tmp_path, path))?;
    Ok(())
}

#[cfg(windows)]
async fn replace_existing_file_async(tmp_path: &Path, path: &Path) -> Result<()> {
    if path.exists() {
        tokio::fs::copy(tmp_path, path)
            .await
            .with_context(|| format!("copy {:?} -> {:?}", tmp_path, path))?;
        tokio::fs::remove_file(tmp_path)
            .await
            .with_context(|| format!("remove {:?}", tmp_path))?;
    } else {
        tokio::fs::rename(tmp_path, path)
            .await
            .with_context(|| format!("rename {:?} -> {:?}", tmp_path, path))?;
    }
    Ok(())
}

#[cfg(not(windows))]
async fn replace_existing_file_async(tmp_path: &Path, path: &Path) -> Result<()> {
    tokio::fs::rename(tmp_path, path)
        .await
        .with_context(|| format!("rename {:?} -> {:?}", tmp_path, path))?;
    Ok(())
}

pub fn write_text_file(path: &Path, data: &str) -> Result<()> {
    if let Some(parent) = path.parent() {
        fs::create_dir_all(parent).with_context(|| format!("create_dir_all {:?}", parent))?;
    }

    let tmp_path = temp_path_for(path);
    {
        let mut file =
            fs::File::create(&tmp_path).with_context(|| format!("create {:?}", tmp_path))?;
        file.write_all(data.as_bytes())
            .with_context(|| format!("write {:?}", tmp_path))?;
        file.sync_all().ok();
    }

    replace_existing_file_sync(&tmp_path, path)
}

pub async fn write_bytes_file_async(path: &Path, data: &[u8]) -> Result<()> {
    if let Some(parent) = path.parent() {
        tokio::fs::create_dir_all(parent)
            .await
            .with_context(|| format!("create_dir_all {:?}", parent))?;
    }

    let tmp_path = temp_path_for(path);
    tokio::fs::write(&tmp_path, data)
        .await
        .with_context(|| format!("write {:?}", tmp_path))?;

    replace_existing_file_async(&tmp_path, path).await
}

#[cfg(test)]
mod tests {
    use super::*;

    fn temp_path(name: &str) -> PathBuf {
        std::env::temp_dir()
            .join(format!(
                "codex-helper-file-replace-{}",
                uuid::Uuid::new_v4()
            ))
            .join(name)
    }

    #[test]
    fn write_text_file_overwrites_existing_file() {
        let path = temp_path("state.json");
        if let Some(parent) = path.parent() {
            std::fs::create_dir_all(parent).expect("create parent");
        }

        std::fs::write(&path, "old").expect("write old file");
        write_text_file(&path, "new").expect("overwrite file");

        let text = std::fs::read_to_string(&path).expect("read new file");
        assert_eq!(text, "new");
        assert!(
            !path.with_extension("tmp.codex-helper").exists(),
            "temp file should be cleaned up"
        );
    }

    #[tokio::test]
    async fn write_bytes_file_async_overwrites_existing_file() {
        let path = temp_path("state.json");
        if let Some(parent) = path.parent() {
            tokio::fs::create_dir_all(parent)
                .await
                .expect("create parent");
        }

        tokio::fs::write(&path, b"old")
            .await
            .expect("write old file");
        write_bytes_file_async(&path, b"new")
            .await
            .expect("overwrite file");

        let text = tokio::fs::read_to_string(&path)
            .await
            .expect("read new file");
        assert_eq!(text, "new");
        assert!(
            !path.with_extension("tmp.codex-helper").exists(),
            "temp file should be cleaned up"
        );
    }
}