newgit-core 0.1.1

Core domain model for newgit: branch instances, tracker lanes, and resource lifecycles
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use std::process::Command;

use camino::{Utf8Path, Utf8PathBuf};
use newgit_core::branch::ResourceStatus;
use newgit_core::checkpoint::CheckpointReason;
use newgit_core::config::WorkspaceSection;
use newgit_core::manager::BranchManager;
use newgit_core::store::MetadataStore;
use newgit_core::supervisor::Supervisor;
use newgit_core::tracker::Storage;
use newgit_core::{NewgitError, SourceSubstrate};

fn git(dir: &Utf8Path, args: &[&str]) {
    let output = Command::new("git")
        .arg("-C")
        .arg(dir.as_str())
        .args(args)
        .env("GIT_AUTHOR_NAME", "test")
        .env("GIT_AUTHOR_EMAIL", "test@example.com")
        .env("GIT_COMMITTER_NAME", "test")
        .env("GIT_COMMITTER_EMAIL", "test@example.com")
        .output()
        .expect("git runs");
    assert!(
        output.status.success(),
        "git {args:?} failed: {}",
        String::from_utf8_lossy(&output.stderr)
    );
}

fn git_stdout(dir: &Utf8Path, args: &[&str]) -> String {
    let output = Command::new("git")
        .arg("-C")
        .arg(dir.as_str())
        .args(args)
        .output()
        .expect("git runs");
    assert!(
        output.status.success(),
        "git {args:?} failed: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    String::from_utf8_lossy(&output.stdout).trim().to_owned()
}

fn setup(temp: &Utf8Path) -> MetadataStore {
    let repo = temp.join("store");
    std::fs::create_dir_all(&repo).expect("mkdir");
    git(&repo, &["init", "-q", "-b", "main"]);
    std::fs::write(repo.join("README.md"), "hello\n").expect("write");
    std::fs::write(repo.join(".gitignore"), ".env.local\n").expect("write");
    git(&repo, &["add", "."]);
    git(&repo, &["commit", "-q", "-m", "initial"]);

    let store = MetadataStore::init(&repo, "proj", SourceSubstrate::Git).expect("init");
    let mut config = store.load_config().expect("config");
    config.workspace = Some(WorkspaceSection {
        root: Some(temp.join("workspaces")),
        materializer: None,
    });
    store.write_config(&config).expect("write config");
    store
}

fn tempdir() -> (tempfile::TempDir, Utf8PathBuf) {
    let temp = tempfile::tempdir().expect("tempdir");
    let path = Utf8PathBuf::from_path_buf(temp.path().canonicalize().expect("canonicalize"))
        .expect("utf8 tempdir");
    (temp, path)
}

fn manager(store: MetadataStore) -> BranchManager {
    BranchManager::open(store).expect("manager")
}

fn write_resource(store: &MetadataStore, name: &str, contents: &str) {
    std::fs::write(
        store.paths().resources.join(format!("{name}.toml")),
        contents,
    )
    .expect("write resource");
}

fn read(path: &Utf8Path) -> String {
    std::fs::read_to_string(path).unwrap_or_else(|_| panic!("read {path}"))
}

#[test]
fn checkpoint_and_undo_restore_source_trackers_and_dirty_state() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create tracker");
    m.track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");
    let m = manager(m.store().clone());

    let ws = m
        .spawn("feature-a", None)
        .expect("spawn")
        .branch
        .workspace_path;

    // Committed work, tracker content, and dirty state on top.
    std::fs::write(ws.join("src.txt"), "code\n").expect("write");
    git(&ws, &["add", "src.txt"]);
    git(&ws, &["commit", "-q", "-m", "add src"]);
    let good_head = git_stdout(&ws, &["rev-parse", "HEAD"]);
    std::fs::write(ws.join(".env.local"), "SECRET=1\n").expect("write");
    std::fs::write(ws.join("README.md"), "hello v2\n").expect("write");
    std::fs::write(ws.join("notes.txt"), "untracked notes\n").expect("write");

    let outcome = m
        .checkpoint("feature-a", Some("good state"))
        .expect("checkpoint");
    assert_eq!(outcome.record.source.head_rev, good_head);
    assert!(
        outcome.record.source.dirty_rev.is_some(),
        "worktree was dirty"
    );
    assert!(outcome.record.tracker_states[0].content_rev.is_some());
    // The store branch was blessed to the workspace head.
    let repo = m.store().paths().project_root.clone();
    assert_eq!(
        git_stdout(&repo, &["rev-parse", "refs/heads/feature-a"]),
        good_head
    );

    // The agent makes a mess: garbage commit, deleted file, mangled content.
    std::fs::write(ws.join("junk.txt"), "junk\n").expect("write");
    git(&ws, &["add", "junk.txt"]);
    git(&ws, &["commit", "-q", "-m", "junk"]);
    std::fs::remove_file(ws.join("notes.txt")).expect("rm");
    std::fs::write(ws.join("README.md"), "mangled\n").expect("write");
    std::fs::write(ws.join(".env.local"), "SECRET=evil\n").expect("write");

    let undo = m.undo("feature-a", None).expect("undo");
    assert_eq!(undo.restored.id, outcome.record.id);
    assert_eq!(undo.safety.reason, CheckpointReason::BeforeUndo);

    // Every layer is back: HEAD, dirty files, untracked file, tracker content.
    assert_eq!(git_stdout(&ws, &["rev-parse", "HEAD"]), good_head);
    assert_eq!(read(&ws.join("README.md")), "hello v2\n");
    assert_eq!(read(&ws.join("notes.txt")), "untracked notes\n");
    assert_eq!(read(&ws.join(".env.local")), "SECRET=1\n");
    assert!(!ws.join("junk.txt").exists(), "junk commit is gone");
    // The dirty state is uncommitted again, not baked into a commit.
    let status = git_stdout(&ws, &["status", "--porcelain"]);
    assert!(
        status.contains("README.md"),
        "README shows as modified: {status}"
    );
    // The workspace marker survived restore (it is self-ignored).
    assert!(ws.join(".newgit/local/instance.toml").is_file());

    // Undo twice is redo: the safety checkpoint brings the mess back.
    let redo = m.undo("feature-a", None).expect("redo");
    assert_eq!(redo.restored.id, undo.safety.id);
    assert_eq!(read(&ws.join("README.md")), "mangled\n");
    assert_eq!(read(&ws.join(".env.local")), "SECRET=evil\n");
    assert!(ws.join("junk.txt").exists());
    assert!(!ws.join("notes.txt").exists());
}

#[test]
fn undo_to_targets_an_older_checkpoint() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let m = manager(store);
    let ws = m
        .spawn("feature-b", None)
        .expect("spawn")
        .branch
        .workspace_path;

    std::fs::write(ws.join("README.md"), "version one\n").expect("write");
    git(&ws, &["commit", "-qam", "v1"]);
    let first = m.checkpoint("feature-b", Some("v1")).expect("checkpoint");

    std::fs::write(ws.join("README.md"), "version two\n").expect("write");
    git(&ws, &["commit", "-qam", "v2"]);
    m.checkpoint("feature-b", Some("v2")).expect("checkpoint");

    m.undo("feature-b", Some(&first.record.id))
        .expect("undo --to");
    assert_eq!(read(&ws.join("README.md")), "version one\n");

    assert!(matches!(
        m.undo("feature-b", Some("ckpt_099")),
        Err(NewgitError::UnknownCheckpoint { .. })
    ));
    // Explicit + explicit + before-undo safety.
    assert_eq!(m.list_checkpoints("feature-b").expect("list").len(), 3);
}

const HASH_RECOMPUTE_RESOURCE: &str = r#"kind = "command"
ownership = "workspace"

[actions.prepare]
command = "echo run >> prep-runs.txt"

[checkpoint]
mode = "hash"
paths = ["README.md"]

[restore]
mode = "recompute"
action = "prepare"
"#;

#[test]
fn recompute_restore_reruns_prepare_and_hash_is_recorded() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    write_resource(&store, "deps", HASH_RECOMPUTE_RESOURCE);
    let m = manager(store);
    let ws = m
        .spawn("feature-c", None)
        .expect("spawn")
        .branch
        .workspace_path;
    assert_eq!(read(&ws.join("prep-runs.txt")).lines().count(), 1);

    let outcome = m.checkpoint("feature-c", None).expect("checkpoint");
    let state = &outcome.record.resource_states[0];
    assert_eq!(state.mode, "hash");
    assert!(
        state
            .state_ref
            .as_deref()
            .is_some_and(|r| r.starts_with("hash:"))
    );

    let undo = m.undo("feature-c", None).expect("undo");
    assert_eq!(undo.resources[0].action, "recompute(prepare)");
    assert!(undo.resources[0].ok);
    assert!(undo.recovery_record.is_none());
    // Restored to 1 captured line, then prepare re-ran and appended one.
    assert_eq!(read(&ws.join("prep-runs.txt")).lines().count(), 2);
}

const DB_TRACKER_DEPOSIT_RESOURCE: &str = r#"kind = "command-snapshot"
ownership = "branch"

[checkpoint]
mode = "command"
command = "echo dump-data > {{snapshot.path}}/db.sql && echo {{snapshot.path}}/db.sql"
into_tracker = "db-snapshots"

[restore]
mode = "command"
command = "cp {{state_ref}} restored.sql"
"#;

#[test]
fn into_tracker_deposits_into_lane_and_restore_reads_it_back() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    write_resource(&store, "db", DB_TRACKER_DEPOSIT_RESOURCE);
    let m = manager(store);
    // Deposit-only lane: no owned workspace paths.
    m.create_tracker("db-snapshots", "project-devs", Storage::Local, false)
        .expect("create tracker");
    let m = manager(m.store().clone());
    let ws = m
        .spawn("feature-d", None)
        .expect("spawn")
        .branch
        .workspace_path;

    let outcome = m.checkpoint("feature-d", None).expect("checkpoint");
    let state = &outcome.record.resource_states[0];
    assert!(
        state
            .state_ref
            .as_deref()
            .is_some_and(|r| r.starts_with("tracker:db-snapshots@")),
        "state_ref was {:?}",
        state.state_ref
    );
    let state_path = state.state_path.clone().expect("state path");
    assert_eq!(read(&state_path), "dump-data\n");
    // The deposit is recorded as the deposit-only tracker's checkpoint rev.
    let tracker_state = outcome
        .record
        .tracker_states
        .iter()
        .find(|t| t.name == "db-snapshots")
        .expect("tracker state");
    assert!(tracker_state.content_rev.is_some());

    let undo = m.undo("feature-d", None).expect("undo");
    assert!(undo.resources[0].ok);
    assert_eq!(read(&ws.join("restored.sql")), "dump-data\n");
}

const BAD_RESTORE_RESOURCE: &str = r#"kind = "command"
ownership = "branch"

[checkpoint]
mode = "none"

[restore]
mode = "command"
command = "exit 3"
"#;

#[test]
fn failed_restore_writes_recovery_record_and_restores_the_rest() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    write_resource(&store, "bad", BAD_RESTORE_RESOURCE);
    write_resource(&store, "deps", HASH_RECOMPUTE_RESOURCE);
    let m = manager(store);
    let ws = m
        .spawn("feature-e", None)
        .expect("spawn")
        .branch
        .workspace_path;

    m.checkpoint("feature-e", None).expect("checkpoint");
    let undo = m.undo("feature-e", None).expect("undo");

    let bad = undo
        .resources
        .iter()
        .find(|r| r.name == "bad")
        .expect("bad");
    assert!(!bad.ok);
    let deps = undo
        .resources
        .iter()
        .find(|r| r.name == "deps")
        .expect("deps");
    assert!(deps.ok, "other resources still restored");
    assert_eq!(read(&ws.join("prep-runs.txt")).lines().count(), 2);

    let recovery = undo.recovery_record.expect("recovery record");
    let contents = read(&recovery);
    assert!(
        contents.contains("bad"),
        "recovery names the resource: {contents}"
    );
    assert!(contents.contains("exited with 3"));

    let report = m
        .statuses()
        .expect("statuses")
        .into_iter()
        .find(|r| r.branch.name == "feature-e")
        .expect("report");
    let bad_state = &report.branch.resources.get("bad").expect("binding").status;
    assert_eq!(*bad_state, ResourceStatus::Failed);
}

const RUNNING_APP_RESOURCE: &str = r#"kind = "process"
ownership = "branch"

[ports]
app = { start = 4210, env = "PORT" }

[actions.start]
command = "sleep 30"
long_running = true

[actions.stop]
signal = "term"
"#;

#[test]
fn undo_stops_running_processes_and_restarts_what_was_running() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    write_resource(&store, "app", RUNNING_APP_RESOURCE);
    let m = manager(store);
    let spawn = m.spawn("feature-f", None).expect("spawn");
    let slug = spawn.branch.slug.clone();

    m.run_action("feature-f", "app.start").expect("start");
    let supervisor = Supervisor::new(m.store().instance_state_dir(&slug));
    let pid_before = supervisor.running_pid("app").expect("running");

    let outcome = m.checkpoint("feature-f", None).expect("checkpoint");
    assert!(outcome.record.resource_states[0].was_running);

    let undo = m.undo("feature-f", None).expect("undo");
    assert!(undo.resources[0].action.ends_with("+ restarted"));
    let pid_after = supervisor.running_pid("app").expect("restarted");
    assert_ne!(pid_before, pid_after, "a fresh process was started");

    m.run_action("feature-f", "app.stop").expect("stop");
}

#[test]
fn identical_checkpoints_dedupe_lane_revs() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create tracker");
    m.track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");
    let m = manager(m.store().clone());
    let ws = m
        .spawn("feature-g", None)
        .expect("spawn")
        .branch
        .workspace_path;
    std::fs::write(ws.join(".env.local"), "SECRET=1\n").expect("write");

    let first = m.checkpoint("feature-g", None).expect("checkpoint");
    let second = m.checkpoint("feature-g", None).expect("checkpoint");
    assert_eq!(
        first.record.tracker_states[0].content_rev, second.record.tracker_states[0].content_rev,
        "identical content dedupes to the same lane rev"
    );
    assert_ne!(first.record.id, second.record.id);
}