shiplog-engine 0.4.0

Pipeline orchestrator that drives collect, render, refresh, and import flows.
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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
//! Error-path tests for the shiplog-engine orchestration pipeline.
//!
//! Verifies that errors from renderers, clusterers, redactors, and filesystem
//! operations propagate correctly through `run()`, `import()`, and `refresh()`.

use anyhow::Result;
use chrono::{NaiveDate, TimeZone, Utc};
use shiplog_engine::Engine;
use shiplog_ids::RunId;
use shiplog_ports::{IngestOutput, Redactor, Renderer, WorkstreamClusterer};
use shiplog_render_md::MarkdownRenderer;
use shiplog_schema::bundle::BundleProfile;
use shiplog_schema::coverage::{Completeness, CoverageManifest, TimeWindow};
use shiplog_schema::event::*;
use shiplog_schema::workstream::{Workstream, WorkstreamStats, WorkstreamsFile};
use shiplog_workstreams::RepoClusterer;
use shiplog_workstreams::WorkstreamManager;

// ---------------------------------------------------------------------------
// Stubs
// ---------------------------------------------------------------------------

struct FailingRenderer;
impl Renderer for FailingRenderer {
    fn render_packet_markdown(
        &self,
        _user: &str,
        _window_label: &str,
        _events: &[EventEnvelope],
        _workstreams: &WorkstreamsFile,
        _coverage: &CoverageManifest,
    ) -> Result<String> {
        anyhow::bail!("renderer exploded")
    }
}

struct FailingClusterer;
impl WorkstreamClusterer for FailingClusterer {
    fn cluster(&self, _events: &[EventEnvelope]) -> Result<WorkstreamsFile> {
        anyhow::bail!("clusterer exploded")
    }
}

struct FailingRedactor;
impl Redactor for FailingRedactor {
    fn redact_events(
        &self,
        _events: &[EventEnvelope],
        _profile: &str,
    ) -> Result<Vec<EventEnvelope>> {
        anyhow::bail!("redactor exploded")
    }
    fn redact_workstreams(&self, _ws: &WorkstreamsFile, _profile: &str) -> Result<WorkstreamsFile> {
        anyhow::bail!("redactor exploded")
    }
}

struct NoopRedactor;
impl Redactor for NoopRedactor {
    fn redact_events(
        &self,
        events: &[EventEnvelope],
        _profile: &str,
    ) -> Result<Vec<EventEnvelope>> {
        Ok(events.to_vec())
    }
    fn redact_workstreams(&self, ws: &WorkstreamsFile, _profile: &str) -> Result<WorkstreamsFile> {
        Ok(ws.clone())
    }
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn make_coverage() -> CoverageManifest {
    CoverageManifest {
        run_id: RunId("error_test".into()),
        generated_at: Utc.timestamp_opt(0, 0).unwrap(),
        user: "tester".into(),
        window: TimeWindow {
            since: NaiveDate::from_ymd_opt(2025, 1, 1).unwrap(),
            until: NaiveDate::from_ymd_opt(2025, 2, 1).unwrap(),
        },
        mode: "merged".into(),
        sources: vec!["github".into()],
        slices: vec![],
        warnings: vec![],
        completeness: Completeness::Complete,
    }
}

fn make_ingest(events: Vec<EventEnvelope>) -> IngestOutput {
    IngestOutput {
        events,
        coverage: make_coverage(),
    }
}

fn one_event() -> Vec<EventEnvelope> {
    vec![shiplog_testkit::pr_event("acme/foo", 1, "test PR")]
}

fn real_engine() -> Engine<'static> {
    let renderer: &'static dyn Renderer = Box::leak(Box::new(MarkdownRenderer::default()));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    Engine::new(renderer, clusterer, redactor)
}

fn empty_workstreams() -> WorkstreamsFile {
    WorkstreamsFile {
        version: 1,
        generated_at: Utc::now(),
        workstreams: vec![],
    }
}

// ---------------------------------------------------------------------------
// import() error propagation
// ---------------------------------------------------------------------------

#[test]
fn import_propagates_renderer_error() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("import_fail_render");

    let renderer: &'static dyn Renderer = Box::leak(Box::new(FailingRenderer));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let result = engine.import(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        None,
        &BundleProfile::Internal,
    );

    let err = match result {
        Err(e) => e,
        Ok(_) => panic!("expected renderer error"),
    };
    let msg = format!("{err:#}");
    assert!(msg.contains("renderer exploded"), "unexpected: {msg}");
}

#[test]
fn import_propagates_redactor_error() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("import_fail_redact");

    let renderer: &'static dyn Renderer = Box::leak(Box::new(MarkdownRenderer::default()));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(FailingRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let result = engine.import(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        None,
        &BundleProfile::Internal,
    );

    let err = match result {
        Err(e) => e,
        Ok(_) => panic!("expected redactor error"),
    };
    let msg = format!("{err:#}");
    assert!(msg.contains("redactor exploded"), "unexpected: {msg}");
}

#[test]
fn import_propagates_clusterer_error_when_no_workstreams() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("import_fail_cluster");

    let renderer: &'static dyn Renderer = Box::leak(Box::new(MarkdownRenderer::default()));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(FailingClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    // No pre-existing workstreams and None passed → must cluster → error
    let result = engine.import(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        None,
        &BundleProfile::Internal,
    );

    let err = match result {
        Err(e) => e,
        Ok(_) => panic!("expected clusterer error"),
    };
    let msg = format!("{err:#}");
    assert!(msg.contains("clusterer exploded"), "unexpected: {msg}");
}

// ---------------------------------------------------------------------------
// refresh() error propagation
// ---------------------------------------------------------------------------

#[test]
fn refresh_propagates_renderer_error() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("refresh_fail_render");
    std::fs::create_dir_all(&out).unwrap();

    // Pre-write workstreams so refresh passes the "no workstreams" check
    shiplog_workstreams::write_workstreams(
        &WorkstreamManager::curated_path(&out),
        &empty_workstreams(),
    )
    .unwrap();

    let renderer: &'static dyn Renderer = Box::leak(Box::new(FailingRenderer));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let result = engine.refresh(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );

    let err = match result {
        Err(e) => e,
        Ok(_) => panic!("expected renderer error"),
    };
    let msg = format!("{err:#}");
    assert!(msg.contains("renderer exploded"), "unexpected: {msg}");
}

#[test]
fn refresh_propagates_redactor_error() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("refresh_fail_redact");
    std::fs::create_dir_all(&out).unwrap();

    shiplog_workstreams::write_workstreams(
        &WorkstreamManager::curated_path(&out),
        &empty_workstreams(),
    )
    .unwrap();

    let renderer: &'static dyn Renderer = Box::leak(Box::new(MarkdownRenderer::default()));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(FailingRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let result = engine.refresh(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );

    let err = match result {
        Err(e) => e,
        Ok(_) => panic!("expected redactor error"),
    };
    let msg = format!("{err:#}");
    assert!(msg.contains("redactor exploded"), "unexpected: {msg}");
}

#[test]
fn refresh_errors_on_corrupted_workstreams_yaml() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("refresh_corrupted_yaml");
    std::fs::create_dir_all(&out).unwrap();

    // Write invalid YAML to the curated path
    std::fs::write(WorkstreamManager::curated_path(&out), "{{{{not yaml").unwrap();

    let engine = real_engine();
    let result = engine.refresh(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );

    assert!(result.is_err(), "corrupted YAML should cause an error");
    let err = match result {
        Err(e) => e,
        Ok(_) => unreachable!(),
    };
    assert!(
        err.to_string().contains("parse curated workstreams yaml"),
        "unexpected: {err}"
    );
}

#[test]
fn refresh_errors_on_corrupted_suggested_yaml_when_no_curated() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("refresh_corrupted_suggested");
    std::fs::create_dir_all(&out).unwrap();

    // Write invalid YAML to the suggested path (no curated exists)
    std::fs::write(
        WorkstreamManager::suggested_path(&out),
        "not: [valid: yaml: {",
    )
    .unwrap();

    let engine = real_engine();
    let result = engine.refresh(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );

    assert!(result.is_err(), "corrupted suggested YAML should error");
    let err = match result {
        Err(e) => e,
        Ok(_) => unreachable!(),
    };
    assert!(
        err.to_string().contains("parse suggested workstreams yaml"),
        "unexpected: {err}"
    );
}

// ---------------------------------------------------------------------------
// Empty event list edge cases across all commands
// ---------------------------------------------------------------------------

#[test]
fn run_empty_events_produces_zero_line_ledger() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("empty_ledger");

    let engine = real_engine();
    let (outputs, _) = engine
        .run(
            make_ingest(vec![]),
            "nobody",
            "2025-01-01..2025-02-01",
            &out,
            false,
            &BundleProfile::Internal,
        )
        .unwrap();

    let ledger = std::fs::read_to_string(&outputs.ledger_events_jsonl).unwrap();
    assert!(
        ledger.trim().is_empty(),
        "empty events should produce empty ledger"
    );
}

#[test]
fn import_empty_events_with_provided_workstreams_succeeds() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("import_empty_ws");

    let ws = WorkstreamsFile {
        version: 1,
        generated_at: Utc::now(),
        workstreams: vec![Workstream {
            id: shiplog_ids::WorkstreamId::from_parts(["ws", "orphan"]),
            title: "Orphan Workstream".into(),
            summary: None,
            tags: vec![],
            stats: WorkstreamStats::zero(),
            events: vec![],
            receipts: vec![],
        }],
    };

    let engine = real_engine();
    let (outputs, _) = engine
        .import(
            make_ingest(vec![]),
            "tester",
            "2025-01-01..2025-02-01",
            &out,
            false,
            Some(ws),
            &BundleProfile::Internal,
        )
        .unwrap();

    assert!(outputs.packet_md.exists());
    let content = std::fs::read_to_string(&outputs.packet_md).unwrap();
    assert!(
        content.contains("Orphan Workstream"),
        "workstream title should appear in packet"
    );
}

// ---------------------------------------------------------------------------
// merge() error paths
// ---------------------------------------------------------------------------

#[test]
fn merge_single_input_succeeds() {
    let engine = real_engine();
    let result = engine.merge(
        vec![make_ingest(one_event())],
        shiplog_engine::ConflictResolution::PreferFirst,
    );
    assert!(result.is_ok());
    assert_eq!(result.unwrap().events.len(), 1);
}

// ---------------------------------------------------------------------------
// Error context message quality
// ---------------------------------------------------------------------------

#[test]
fn run_to_invalid_dir_includes_path_in_error() {
    let engine = real_engine();
    let temp = tempfile::tempdir().unwrap();
    let invalid = temp
        .path()
        .join("does")
        .join("not")
        .join("exist")
        .join("nested")
        .join("deep");
    drop(temp);
    let result = engine.run(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &invalid,
        false,
        &BundleProfile::Internal,
    );
    // Should fail creating the directory, and the error context should mention the path
    // The tempdir was dropped so the parent is gone
    if let Err(e) = result {
        let msg = format!("{e:#}");
        assert!(
            msg.contains("does") || msg.contains("not") || msg.contains("exist"),
            "error should include the path: {msg}"
        );
    }
}

#[test]
fn import_renderer_error_chain_preserves_cause() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("chain_test");

    let renderer: &'static dyn Renderer = Box::leak(Box::new(FailingRenderer));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let err = match engine.import(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        None,
        &BundleProfile::Internal,
    ) {
        Err(e) => e,
        Ok(_) => panic!("expected renderer error for chain test"),
    };

    // The original cause "renderer exploded" should be reachable via the chain
    let chain: Vec<String> = err.chain().map(|e| e.to_string()).collect();
    assert!(
        chain.iter().any(|msg| msg.contains("renderer exploded")),
        "error chain should contain original cause: {chain:?}"
    );
}

#[test]
fn refresh_no_workstreams_error_message_is_actionable() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("no_ws");
    std::fs::create_dir_all(&out).unwrap();

    let engine = real_engine();
    let err = match engine.refresh(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    ) {
        Err(e) => e,
        Ok(_) => panic!("expected no-workstreams error"),
    };

    let msg = err.to_string();
    assert!(
        msg.contains("collect"),
        "error should suggest running collect: {msg}"
    );
}

#[test]
fn run_with_failing_renderer_still_writes_ledger_before_error() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("partial_write");

    let renderer: &'static dyn Renderer = Box::leak(Box::new(FailingRenderer));
    let clusterer: &'static dyn WorkstreamClusterer = Box::leak(Box::new(RepoClusterer));
    let redactor: &'static dyn Redactor = Box::leak(Box::new(NoopRedactor));
    let engine = Engine::new(renderer, clusterer, redactor);

    let _ = engine.run(
        make_ingest(one_event()),
        "tester",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );

    // Ledger is written before rendering, so it should exist even on render failure
    let ledger = out.join("ledger.events.jsonl");
    assert!(
        ledger.exists(),
        "ledger should be written before render step"
    );
}

#[test]
fn merge_empty_inputs_returns_error() {
    let engine = real_engine();
    let result = engine.merge(vec![], shiplog_engine::ConflictResolution::PreferFirst);
    // Merging zero sources is an error condition
    assert!(result.is_err(), "merging zero inputs should error");
    let msg = result.unwrap_err().to_string();
    assert!(!msg.is_empty(), "merge error should have a message");
}

#[test]
fn run_empty_user_does_not_panic() {
    let dir = tempfile::tempdir().unwrap();
    let out = dir.path().join("empty_user");

    let engine = real_engine();
    let result = engine.run(
        make_ingest(one_event()),
        "",
        "2025-01-01..2025-02-01",
        &out,
        false,
        &BundleProfile::Internal,
    );
    // Should succeed (empty user is valid, just unusual)
    assert!(result.is_ok());
}