lean-ctx-engine 3.12.1

LeanCTX | OSS library: the open-source runtime for the Context Gateway for AI agents behind the lean-ctx CLI, MCP server and proxy integrations.
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
pub mod admission;
pub mod caller;
mod compaction;
mod finding_sources;
mod heuristics;
pub mod housekeeping;
mod journal;
mod paths;
mod persistence;
pub mod playbook;
mod save_outcome;
mod slot;
mod state;
pub(crate) use journal::AttachSessionJournalV1;
#[cfg(any(test, feature = "test-support"))]
/// `TaskInfo.intent` of a task inferred from the working tree (tests).
pub const GIT_TASK_INTENT: &str = state::GIT_TASK_INTENT;
#[cfg(any(test, feature = "test-support"))]
/// `TaskInfo.intent` of a task inferred from touched files (tests).
pub const INFERRED_TASK_INTENT: &str = state::INFERRED_TASK_INTENT;
pub use state::{extract_session_facts, is_auto_task_intent};
mod types;
pub(crate) use paths::{EngineSessionId, parse_engine_session_id};

pub use playbook::{DeltaOutcome, EntryKind, Playbook, PlaybookEntry};
pub use slot::{SessionSlot, SharedSession};
pub use types::{
    Decision, EvidenceKind, EvidenceRecord, FileTouched, Finding, LiveZoneSessionState,
    PreparedSave, ProgressEntry, SaveError, SessionDayCounts, SessionState, SessionStats,
    SessionSummary, TaskInfo, TestSnapshot,
};

#[cfg(test)]
mod tests {
    use super::paths::{extract_cd_target, sessions_dir};
    use super::types::*;
    use chrono::{Duration, Utc};

    /// Bypass path "memory": findings and decisions the agent records are
    /// recalled into later context, so a credential never enters them.
    #[test]
    fn session_memory_never_stores_a_credential() {
        let _isolation = crate::core::data_dir::isolated_data_dir();
        let credential = concat!("AK", "IAQ3EGRZ7MEMORYKEY");
        let mut session = SessionState::new();
        session.add_finding(Some("deploy.env"), Some(3), &format!("key is {credential}"));
        session.add_decision(
            &format!("rotate {credential}"),
            Some(&format!("it leaked as {credential}")),
        );
        let stored = serde_json::to_string(&session).expect("serialize session");
        assert!(
            !stored.contains(credential),
            "session memory kept the credential"
        );
        assert!(stored.contains("key is"), "the finding itself is kept");
    }

    /// `wakeup_manifest` is retired with LITM calibration: a session file
    /// written before still loads, and its next save no longer carries it.
    #[test]
    fn a_session_with_the_retired_wakeup_manifest_still_loads() {
        let _isolation = crate::core::data_dir::isolated_data_dir();
        let mut stored = serde_json::to_value(SessionState::new()).expect("serialize session");
        stored["wakeup_manifest"] = serde_json::json!([
            { "key": "fact:a", "position": "begin", "profile": "claude", "missed": true }
        ]);
        let loaded: SessionState = serde_json::from_value(stored).expect("old session loads");
        let saved = serde_json::to_value(&loaded).expect("serialize session");
        assert!(saved.get("wakeup_manifest").is_none());
    }

    /// A git-derived task names the uncommitted files; it was a `--stat`
    /// summary ("Modified: 2 files changed, 19 insertions(+) … in ") whose
    /// words then steered task-filtered reads.
    #[test]
    fn git_task_names_uncommitted_files_not_diff_counters() {
        use super::state::describe_uncommitted_files;
        assert_eq!(describe_uncommitted_files(["", "  "]), None);
        assert_eq!(
            describe_uncommitted_files([".gitignore", "AGENTS.md"]).as_deref(),
            Some("Uncommitted changes: .gitignore, AGENTS.md")
        );
        assert_eq!(
            describe_uncommitted_files([
                "rust/src/core/entropy.rs",
                "rust/src/core/call_graph.rs",
                "rust/src/core/quality.rs",
                "README.md",
                "docs/a.md",
            ])
            .as_deref(),
            Some("Uncommitted changes: entropy.rs, call_graph.rs, quality.rs (+2 more)")
        );
    }

    #[test]
    fn load_latest_for_broad_root_returns_none_without_scanning() {
        // The daemon boots with cwd "/" and the dispatcher passes that as the
        // project root. Broad roots must bail out before walking the session
        // store — stat-ing persisted roots under ~/Documents from the launchd
        // daemon pops the macOS TCC prompt (#356).
        assert!(SessionState::load_latest_for_project_root("/").is_none());
        if let Some(home) = dirs::home_dir() {
            let home = home.to_string_lossy().to_string();
            assert!(SessionState::load_latest_for_project_root(&home).is_none());
        }
    }

    #[test]
    #[cfg(target_os = "macos")]
    #[serial_test::serial]
    fn normalize_session_skips_marker_probe_for_real_roots() {
        // Both guards are needed: `#[serial]` and `test_env_lock` are separate
        // mutexes, and the `LEAN_CTX_TCC_STANDALONE` this test relies on is read
        // by every path normalization, including in tests that take only the lock.
        let _env_lock = crate::core::data_dir::test_env_lock();
        // A session whose project_root is a plausible real project must not be
        // marker-probed at load time when the process is TCC-standalone: the
        // probe itself would trip the privacy prompt (#356). The repair
        // heuristic only ever fires for agent/temp roots.
        crate::test_env::set_var("LEAN_CTX_TCC_STANDALONE", "1");
        let mut session = SessionState::new();
        let docs_root = dirs::home_dir()
            .unwrap_or_default()
            .join("Documents/some-project")
            .to_string_lossy()
            .to_string();
        session.project_root = Some(docs_root.clone());
        session.shell_cwd = Some(docs_root.clone());
        let normalized = super::heuristics::normalize_loaded_session(session);
        // Root is not an agent/temp dir → kept as-is, no probe needed.
        assert_eq!(normalized.project_root.as_deref(), Some(docs_root.as_str()));
        crate::test_env::remove_var("LEAN_CTX_TCC_STANDALONE");
    }

    /// #707: an explicit, jail-accepted `cwd` param must persist as the live
    /// shell cwd — worktree switches arrive as `cwd` params, not `cd`
    /// commands, and the divergence check in path resolution reads
    /// `shell_cwd`. Relative or nonexistent paths are ignored.
    #[test]
    fn note_explicit_cwd_persists_absolute_dirs_only() {
        let tmp = std::env::temp_dir().join(format!("lc_707_cwd_{}", std::process::id()));
        std::fs::create_dir_all(&tmp).unwrap();

        let mut session = SessionState::new();
        session.note_explicit_cwd(&tmp.to_string_lossy());
        let noted = session.shell_cwd.clone().expect("cwd should persist");
        // Canonicalized (macOS /tmp → /private/tmp), so compare canonical forms.
        assert_eq!(
            noted,
            crate::core::pathutil::safe_canonicalize_or_self(&tmp)
                .to_string_lossy()
                .to_string()
        );

        session.note_explicit_cwd("relative/dir");
        assert_eq!(session.shell_cwd.as_deref(), Some(noted.as_str()));
        session.note_explicit_cwd(&tmp.join("does-not-exist").to_string_lossy());
        assert_eq!(session.shell_cwd.as_deref(), Some(noted.as_str()));

        let _ = std::fs::remove_dir_all(&tmp);
    }

    /// #717: the 5-change batch alone left slowly-ticking sessions invisible
    /// to the dashboard. First change on a fresh in-memory session flushes
    /// immediately; afterwards the time-based trigger fires once a change is
    /// older than SESSION_FLUSH_INTERVAL, and the batch threshold still wins.
    #[test]
    fn should_save_flushes_first_change_and_stale_changes() {
        use super::state::SESSION_FLUSH_INTERVAL;
        let mut session = SessionState::new();
        assert!(!session.should_save(), "no changes → no save");

        session.increment();
        assert!(session.should_save(), "first change must flush immediately");

        session.last_flush = Some(std::time::Instant::now());
        assert!(
            !session.should_save(),
            "inside window + below batch → defer"
        );

        for _ in 0..4 {
            session.increment();
        }
        assert!(session.should_save(), "batch threshold still applies");

        session.stats.unsaved_changes = 1;
        if let Some(old) = std::time::Instant::now().checked_sub(SESSION_FLUSH_INTERVAL) {
            session.last_flush = Some(old);
            assert!(session.should_save(), "stale change must trigger flush");
        }
    }

    #[test]
    fn delete_session_removes_file_snapshot_and_latest_pointer() {
        let _data = crate::core::data_dir::isolated_data_dir();
        let mut session = SessionState::new();
        session.id = "delete-me".to_string();
        session.save().unwrap();

        let dir = sessions_dir().unwrap();
        let path = dir.join("delete-me.json");
        let snapshot = dir.join("delete-me_snapshot.txt");
        let latest = dir.join("latest.json");
        std::fs::write(&snapshot, "snapshot").unwrap();
        assert!(path.exists());
        assert!(snapshot.exists());
        assert!(latest.exists());

        assert!(SessionState::delete_session("delete-me").unwrap());

        assert!(!path.exists());
        assert!(!snapshot.exists());
        assert!(!latest.exists());
        assert!(SessionState::list_sessions().is_empty());
    }

    #[test]
    fn delete_latest_session_repoints_latest_to_newest_remaining() {
        let _data = crate::core::data_dir::isolated_data_dir();
        let mut older = SessionState::new();
        older.id = "older".to_string();
        older.updated_at = Utc::now() - Duration::days(1);
        older.save().unwrap();

        let mut newer = SessionState::new();
        newer.id = "newer".to_string();
        newer.updated_at = Utc::now();
        newer.save().unwrap();
        assert_eq!(
            SessionState::load_global_latest_pointer().unwrap().id,
            "newer"
        );

        assert!(SessionState::delete_session("newer").unwrap());

        let latest = SessionState::load_global_latest_pointer().unwrap();
        assert_eq!(latest.id, "older");
        assert_eq!(SessionState::list_sessions().len(), 1);
    }

    #[test]
    fn delete_session_rejects_path_traversal_id() {
        let data = crate::core::data_dir::isolated_data_dir();
        let outside = data.path().join("outside.json");
        std::fs::write(&outside, "{}").unwrap();

        let err = SessionState::delete_session("../outside").unwrap_err();

        assert_eq!(err, "invalid session id");
        assert!(outside.exists());
    }

    #[test]
    fn extract_cd_absolute_path() {
        let result = extract_cd_target("cd /usr/local/bin", "/home/user");
        assert_eq!(result, Some("/usr/local/bin".to_string()));
    }

    #[test]
    fn extract_cd_relative_path() {
        let result = extract_cd_target("cd subdir", "/home/user");
        assert_eq!(result, Some("/home/user/subdir".to_string()));
    }

    #[test]
    fn extract_cd_with_chained_command() {
        let result = extract_cd_target("cd /tmp && ls", "/home/user");
        assert_eq!(result, Some("/tmp".to_string()));
    }

    #[test]
    fn extract_cd_with_semicolon() {
        let result = extract_cd_target("cd /tmp; ls", "/home/user");
        assert_eq!(result, Some("/tmp".to_string()));
    }

    #[test]
    fn extract_cd_parent_dir() {
        let result = extract_cd_target("cd ..", "/home/user/project");
        assert_eq!(result, Some("/home/user/project/..".to_string()));
    }

    #[test]
    fn extract_cd_no_cd_returns_none() {
        let result = extract_cd_target("ls -la", "/home/user");
        assert!(result.is_none());
    }

    #[test]
    fn extract_cd_bare_cd_goes_home() {
        let result = extract_cd_target("cd", "/home/user");
        assert!(result.is_some());
    }

    #[test]
    fn effective_cwd_explicit_takes_priority() {
        let tmp = std::env::temp_dir().join("lean-ctx-test-cwd-explicit");
        let sub = tmp.join("sub");
        let _ = std::fs::create_dir_all(&sub);
        let root_canon = crate::core::pathutil::safe_canonicalize_or_self(&tmp)
            .to_string_lossy()
            .to_string();
        let sub_canon = crate::core::pathutil::safe_canonicalize_or_self(&sub)
            .to_string_lossy()
            .to_string();

        let mut session = SessionState::new();
        session.project_root = Some(root_canon);
        let result = session.effective_cwd(Some(&sub_canon));
        assert_eq!(result, sub_canon);
        let _ = std::fs::remove_dir_all(&tmp);
    }

    #[cfg(not(feature = "no-jail"))]
    #[test]
    fn effective_cwd_explicit_outside_root_is_jailed() {
        let tmp = std::env::temp_dir().join("lean-ctx-test-cwd-jail");
        let _ = std::fs::create_dir_all(&tmp);
        let root_canon = crate::core::pathutil::safe_canonicalize_or_self(&tmp)
            .to_string_lossy()
            .to_string();

        let mut session = SessionState::new();
        session.project_root = Some(root_canon.clone());
        let result = session.effective_cwd(Some("/nonexistent-outside-path"));
        assert_eq!(result, root_canon);
        let _ = std::fs::remove_dir_all(&tmp);
    }

    /// The checked variant must report *why* a jailed cwd was rejected, so
    /// `ctx_shell` can surface it instead of silently swapping in the root (#629).
    #[cfg(not(feature = "no-jail"))]
    #[test]
    fn effective_cwd_checked_reports_jail_rejection_reason() {
        let tmp = std::env::temp_dir().join("lean-ctx-test-cwd-checked");
        let _ = std::fs::create_dir_all(&tmp);
        let root_canon = crate::core::pathutil::safe_canonicalize_or_self(&tmp)
            .to_string_lossy()
            .to_string();

        let mut session = SessionState::new();
        session.project_root = Some(root_canon.clone());

        // Rejected: falls back to the root AND surfaces a non-empty reason.
        let (path, reason) = session.effective_cwd_checked(Some("/nonexistent-outside-path"));
        assert_eq!(path, root_canon);
        let reason = reason.expect("a jailed cwd must report a rejection reason");
        assert!(!reason.is_empty(), "the rejection reason must not be empty");

        // Accepted (no explicit cwd): no reason, path is the project root.
        let (accepted, none_reason) = session.effective_cwd_checked(None);
        assert_eq!(accepted, root_canon);
        assert!(
            none_reason.is_none(),
            "a non-jailed path must not report a reason"
        );

        let _ = std::fs::remove_dir_all(&tmp);
    }

    #[test]
    fn effective_cwd_shell_cwd_second_priority() {
        let mut session = SessionState::new();
        session.project_root = Some("/project".to_string());
        session.shell_cwd = Some("/project/src".to_string());
        assert_eq!(session.effective_cwd(None), "/project/src");
    }

    #[test]
    fn effective_cwd_project_root_third_priority() {
        let mut session = SessionState::new();
        session.project_root = Some("/project".to_string());
        assert_eq!(session.effective_cwd(None), "/project");
    }

    #[test]
    fn effective_cwd_dot_ignored() {
        let mut session = SessionState::new();
        session.project_root = Some("/project".to_string());
        assert_eq!(session.effective_cwd(Some(".")), "/project");
    }

    /// A command must never run in a directory the caller did not name. An
    /// explicit `cwd` outside the project jail is an error, not the project
    /// root; a stored shell cwd that is no longer inside the project is one
    /// too. Accepted directories resolve as before.
    #[cfg(not(feature = "no-jail"))]
    #[test]
    fn execution_cwd_refuses_instead_of_substituting_the_project_root() {
        let base = tempfile::tempdir().unwrap();
        let root = base.path().join("project");
        let inside = root.join("src");
        let outside = base.path().join("elsewhere");
        for dir in [&inside, &outside] {
            std::fs::create_dir_all(dir).unwrap();
        }
        let canon = |path: &std::path::Path| {
            crate::core::pathutil::safe_canonicalize_or_self(path)
                .to_string_lossy()
                .to_string()
        };
        let (root, inside, outside) = (canon(&root), canon(&inside), canon(&outside));

        let mut session = SessionState::new();
        session.project_root = Some(root.clone());

        let refused = session.execution_cwd(Some(&outside));
        assert!(
            refused.as_ref().is_err_and(|reason| !reason.is_empty()),
            "an explicit cwd outside the project must fail: {refused:?}"
        );
        assert_eq!(session.execution_cwd(Some(&inside)), Ok(inside.clone()));
        assert_eq!(session.execution_cwd(None), Ok(root.clone()));
        assert_eq!(session.execution_cwd(Some(".")), Ok(root.clone()));

        session.shell_cwd = Some(inside.clone());
        assert_eq!(session.execution_cwd(None), Ok(inside));

        session.shell_cwd = Some(outside.clone());
        let stale = session.execution_cwd(None);
        assert!(
            stale.is_err(),
            "a stored shell cwd outside the project must fail: {stale:?}"
        );

        // Without a project root there is no jail to hold a stored cwd to.
        session.project_root = None;
        assert_eq!(session.execution_cwd(None), Ok(outside));
    }

    #[test]
    fn compaction_snapshot_includes_compression_config_when_enabled() {
        let mut session = SessionState::new();
        session.compression_level = "standard".to_string();
        session.terse_mode = true;
        session.set_task("x", None);
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.contains("<config compression=\"standard\" />"));
    }

    #[test]
    fn resume_block_prefixes_compression_hint_when_enabled() {
        let mut session = SessionState::new();
        session.compression_level = "lite".to_string();
        session.terse_mode = true;
        let block = session.build_resume_block();
        assert!(block.contains("[COMPRESSION: lite]"));
    }

    #[test]
    fn compaction_snapshot_includes_task() {
        let mut session = SessionState::new();
        session.set_task("fix auth bug", None);
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.contains("<task>fix auth bug</task>"));
        assert!(snapshot.contains("<session_snapshot>"));
        assert!(snapshot.contains("</session_snapshot>"));
    }

    #[test]
    fn compaction_snapshot_includes_files() {
        let mut session = SessionState::new();
        session.touch_file("src/auth.rs", None, "full", 500);
        session.files_touched[0].modified = true;
        session.touch_file("src/main.rs", None, "map", 100);
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.contains("auth.rs"));
        assert!(snapshot.contains("<files>"));
    }

    #[test]
    fn compaction_snapshot_includes_decisions() {
        let mut session = SessionState::new();
        session.add_decision("Use JWT RS256", None);
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.contains("JWT RS256"));
        assert!(snapshot.contains("<decisions>"));
    }

    #[test]
    fn compaction_snapshot_respects_size_limit() {
        let mut session = SessionState::new();
        session.set_task("a]task", None);
        for i in 0..100 {
            session.add_finding(
                Some(&format!("file{i}.rs")),
                Some(i),
                &format!("Finding number {i} with some detail text here"),
            );
        }
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.len() <= 2200);
    }

    #[test]
    fn compaction_snapshot_includes_stats() {
        let mut session = SessionState::new();
        session.stats.total_tool_calls = 42;
        session.stats.total_tokens_saved = 10000;
        let snapshot = session.build_compaction_snapshot();
        assert!(snapshot.contains("calls=42"));
        assert!(snapshot.contains("saved=10000"));
    }
}