ito-domain 0.1.31

Domain models and repositories for Ito
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
//! Reconciliation diff logic: compare materialized audit state against
//! file-on-disk state and produce drift items and compensating events.
//!
//! This module contains only pure functions with no I/O. The orchestration
//! (reading files, writing events) lives in `ito-core`.

use std::collections::HashMap;

use super::event::{Actor, AuditEvent, AuditEventBuilder, EntityType, EventContext, ops};
use super::materialize::EntityKey;

/// File-on-disk state: a map from entity keys to their current status as
/// read from the filesystem (e.g., from tasks.md).
pub type FileState = HashMap<EntityKey, String>;

/// A single drift item: a discrepancy between audit log state and file state.
#[derive(Debug, Clone, PartialEq)]
pub enum Drift {
    /// Entity exists in files but has no events in the audit log.
    Missing {
        /// Entity key.
        key: EntityKey,
        /// Status found in the file.
        file_status: String,
    },
    /// Audit log and file disagree on the entity's status.
    Diverged {
        /// Entity key.
        key: EntityKey,
        /// Status according to the audit log.
        log_status: String,
        /// Status according to the file.
        file_status: String,
    },
    /// Entity has events in the audit log but does not exist in the files.
    Extra {
        /// Entity key.
        key: EntityKey,
        /// Status according to the audit log.
        log_status: String,
    },
}

impl std::fmt::Display for Drift {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Drift::Missing { key, file_status } => write!(
                f,
                "Missing: {}/{} (scope: {:?}) has file status '{}' but no audit events",
                key.entity, key.entity_id, key.scope, file_status
            ),
            Drift::Diverged {
                key,
                log_status,
                file_status,
            } => write!(
                f,
                "Diverged: {}/{} (scope: {:?}) audit='{}' file='{}'",
                key.entity, key.entity_id, key.scope, log_status, file_status
            ),
            Drift::Extra { key, log_status } => write!(
                f,
                "Extra: {}/{} (scope: {:?}) has audit status '{}' but no file entry",
                key.entity, key.entity_id, key.scope, log_status
            ),
        }
    }
}

/// Compare materialized audit state against file-on-disk state.
///
/// Returns a list of drift items. An empty list means the log and files agree.
pub fn compute_drift(
    audit_entities: &HashMap<EntityKey, String>,
    file_state: &FileState,
) -> Vec<Drift> {
    let mut drifts = Vec::new();

    // Check all file entries against audit log
    for (key, file_status) in file_state {
        match audit_entities.get(key) {
            None => {
                drifts.push(Drift::Missing {
                    key: key.clone(),
                    file_status: file_status.clone(),
                });
            }
            Some(log_status) if log_status != file_status => {
                drifts.push(Drift::Diverged {
                    key: key.clone(),
                    log_status: log_status.clone(),
                    file_status: file_status.clone(),
                });
            }
            Some(_) => {
                // Match -- no drift
            }
        }
    }

    // Check for audit entries not in files (extras)
    for (key, log_status) in audit_entities {
        // Only report extras for task entities (other entities like config
        // may not have a corresponding file entry).
        if key.entity == "task" && !file_state.contains_key(key) {
            drifts.push(Drift::Extra {
                key: key.clone(),
                log_status: log_status.clone(),
            });
        }
    }

    // Sort for deterministic output
    drifts.sort_by(|a, b| {
        let key_a = match a {
            Drift::Missing { key, .. } => key,
            Drift::Diverged { key, .. } => key,
            Drift::Extra { key, .. } => key,
        };
        let key_b = match b {
            Drift::Missing { key, .. } => key,
            Drift::Diverged { key, .. } => key,
            Drift::Extra { key, .. } => key,
        };
        (&key_a.entity, &key_a.entity_id).cmp(&(&key_b.entity, &key_b.entity_id))
    });

    drifts
}

/// Generate compensating events that bring the audit log in sync with the file state.
///
/// Each drift item produces a single `reconciled` event with `actor: "reconcile"`.
pub fn generate_compensating_events(
    drifts: &[Drift],
    scope: Option<&str>,
    ctx: &EventContext,
) -> Vec<AuditEvent> {
    let mut events = Vec::new();

    for drift in drifts {
        let event = match drift {
            Drift::Missing { key, file_status } => AuditEventBuilder::new()
                .entity(parse_entity_type(&key.entity))
                .entity_id(&key.entity_id)
                .op(ops::RECONCILED)
                .to(file_status)
                .actor(Actor::Reconcile)
                .by("@reconcile")
                .meta(serde_json::json!({
                    "reason": format!(
                        "{} '{}' has file status '{}' but no audit events",
                        key.entity, key.entity_id, file_status
                    )
                }))
                .ctx(ctx.clone()),
            Drift::Diverged {
                key,
                log_status,
                file_status,
            } => AuditEventBuilder::new()
                .entity(parse_entity_type(&key.entity))
                .entity_id(&key.entity_id)
                .op(ops::RECONCILED)
                .from(log_status)
                .to(file_status)
                .actor(Actor::Reconcile)
                .by("@reconcile")
                .meta(serde_json::json!({
                    "reason": format!(
                        "{} '{}' audit status '{}' differs from file status '{}'",
                        key.entity, key.entity_id, log_status, file_status
                    )
                }))
                .ctx(ctx.clone()),
            Drift::Extra { key, log_status } => AuditEventBuilder::new()
                .entity(parse_entity_type(&key.entity))
                .entity_id(&key.entity_id)
                .op(ops::RECONCILED)
                .from(log_status)
                .actor(Actor::Reconcile)
                .by("@reconcile")
                .meta(serde_json::json!({
                    "reason": format!(
                        "{} '{}' has audit status '{}' but no file entry",
                        key.entity, key.entity_id, log_status
                    )
                }))
                .ctx(ctx.clone()),
        };

        // Add scope if provided
        let event = if let Some(s) = scope {
            event.scope(s)
        } else if let Some(s) = match drift {
            Drift::Missing { key, .. } => key.scope.as_deref(),
            Drift::Diverged { key, .. } => key.scope.as_deref(),
            Drift::Extra { key, .. } => key.scope.as_deref(),
        } {
            event.scope(s)
        } else {
            event
        };

        if let Some(built) = event.build() {
            events.push(built);
        }
    }

    events
}

/// Parse entity type string to `EntityType`, defaulting to `Task` for unknown types.
fn parse_entity_type(s: &str) -> EntityType {
    match s {
        "task" => EntityType::Task,
        "change" => EntityType::Change,
        "module" => EntityType::Module,
        "wave" => EntityType::Wave,
        "planning" => EntityType::Planning,
        "config" => EntityType::Config,
        // Default to Task for any unrecognized entity type
        _ => EntityType::Task,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::audit::materialize::EntityKey;

    fn test_ctx() -> EventContext {
        EventContext {
            session_id: "test-session".to_string(),
            harness_session_id: None,
            branch: None,
            worktree: None,
            commit: None,
        }
    }

    fn task_key(id: &str, scope: &str) -> EntityKey {
        EntityKey {
            entity: "task".to_string(),
            entity_id: id.to_string(),
            scope: Some(scope.to_string()),
        }
    }

    #[test]
    fn no_drift_when_states_match() {
        let mut audit = HashMap::new();
        audit.insert(task_key("1.1", "ch"), "complete".to_string());
        audit.insert(task_key("1.2", "ch"), "pending".to_string());

        let mut files = HashMap::new();
        files.insert(task_key("1.1", "ch"), "complete".to_string());
        files.insert(task_key("1.2", "ch"), "pending".to_string());

        let drifts = compute_drift(&audit, &files);
        assert!(drifts.is_empty());
    }

    #[test]
    fn detect_missing_entity_in_log() {
        let audit: HashMap<EntityKey, String> = HashMap::new();
        let mut files = HashMap::new();
        files.insert(task_key("1.1", "ch"), "complete".to_string());

        let drifts = compute_drift(&audit, &files);
        assert_eq!(drifts.len(), 1);
        match &drifts[0] {
            Drift::Missing { key, file_status } => {
                assert_eq!(key.entity_id, "1.1");
                assert_eq!(file_status, "complete");
            }
            other => panic!("Expected Missing, got {other:?}"),
        }
    }

    #[test]
    fn detect_diverged_status() {
        let mut audit = HashMap::new();
        audit.insert(task_key("1.1", "ch"), "pending".to_string());

        let mut files = HashMap::new();
        files.insert(task_key("1.1", "ch"), "complete".to_string());

        let drifts = compute_drift(&audit, &files);
        assert_eq!(drifts.len(), 1);
        match &drifts[0] {
            Drift::Diverged {
                log_status,
                file_status,
                ..
            } => {
                assert_eq!(log_status, "pending");
                assert_eq!(file_status, "complete");
            }
            other => panic!("Expected Diverged, got {other:?}"),
        }
    }

    #[test]
    fn detect_extra_in_log() {
        let mut audit = HashMap::new();
        audit.insert(task_key("1.1", "ch"), "in-progress".to_string());

        let files: HashMap<EntityKey, String> = HashMap::new();

        let drifts = compute_drift(&audit, &files);
        assert_eq!(drifts.len(), 1);
        match &drifts[0] {
            Drift::Extra { key, log_status } => {
                assert_eq!(key.entity_id, "1.1");
                assert_eq!(log_status, "in-progress");
            }
            other => panic!("Expected Extra, got {other:?}"),
        }
    }

    #[test]
    fn multiple_drift_types_detected() {
        let mut audit = HashMap::new();
        audit.insert(task_key("1.1", "ch"), "pending".to_string()); // diverged
        audit.insert(task_key("1.3", "ch"), "complete".to_string()); // extra

        let mut files = HashMap::new();
        files.insert(task_key("1.1", "ch"), "complete".to_string()); // diverged
        files.insert(task_key("1.2", "ch"), "pending".to_string()); // missing

        let drifts = compute_drift(&audit, &files);
        assert_eq!(drifts.len(), 3);
    }

    #[test]
    fn display_drift_items() {
        let drift = Drift::Diverged {
            key: task_key("1.1", "ch"),
            log_status: "pending".to_string(),
            file_status: "complete".to_string(),
        };
        let s = drift.to_string();
        assert!(s.contains("Diverged"));
        assert!(s.contains("1.1"));
        assert!(s.contains("pending"));
        assert!(s.contains("complete"));
    }

    #[test]
    fn generate_compensating_events_for_missing() {
        let drifts = vec![Drift::Missing {
            key: task_key("1.1", "ch"),
            file_status: "complete".to_string(),
        }];

        let events = generate_compensating_events(&drifts, Some("ch"), &test_ctx());
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].op, "reconciled");
        assert_eq!(events[0].actor, "reconcile");
        assert_eq!(events[0].to, Some("complete".to_string()));
        assert!(events[0].meta.is_some());
    }

    #[test]
    fn generate_compensating_events_for_diverged() {
        let drifts = vec![Drift::Diverged {
            key: task_key("1.1", "ch"),
            log_status: "pending".to_string(),
            file_status: "complete".to_string(),
        }];

        let events = generate_compensating_events(&drifts, Some("ch"), &test_ctx());
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].from, Some("pending".to_string()));
        assert_eq!(events[0].to, Some("complete".to_string()));
    }

    #[test]
    fn generate_compensating_events_for_extra() {
        let drifts = vec![Drift::Extra {
            key: task_key("1.1", "ch"),
            log_status: "in-progress".to_string(),
        }];

        let events = generate_compensating_events(&drifts, Some("ch"), &test_ctx());
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].from, Some("in-progress".to_string()));
        assert!(events[0].to.is_none());
    }

    #[test]
    fn compensating_events_use_scope_from_drift_key() {
        let drifts = vec![Drift::Missing {
            key: task_key("1.1", "my-change"),
            file_status: "pending".to_string(),
        }];

        // Pass None for scope — should use the key's scope
        let events = generate_compensating_events(&drifts, None, &test_ctx());
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].scope, Some("my-change".to_string()));
    }
}