shiplog-team 0.6.0

Team aggregation mode for generating team-level shipping summaries.
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
//! Team aggregation mode for generating team-level shipping summaries.
//!
//! The team crate keeps a narrow API boundary:
//! - Read multiple member ledgers from disk
//! - Merge them with the shared `shiplog-merge` pipeline
//! - Emit a deterministic, sectioned aggregate summary

use anyhow::{Context, Result, anyhow};
use chrono::{NaiveDate, Utc};
use serde_json::Value;
use shiplog_ports::IngestOutput;
use shiplog_schema::coverage::{Completeness, CoverageManifest, TimeWindow};
use shiplog_schema::event::EventEnvelope;
use std::fs;
use std::io::Write;
use std::path::{Path, PathBuf};

use crate::core::TeamConfig;
use crate::render::{self, TeamAggregateResult, TeamMemberSummary};
use shiplog_merge::{ConflictResolution, merge_ingest_outputs};

/// Stable output artifact locations from team packet generation.
#[derive(Debug, Clone)]
pub struct TeamOutputFiles {
    pub packet: PathBuf,
    pub events: PathBuf,
    pub coverage: PathBuf,
}

/// Build team summaries from multiple member ledgers.
#[derive(Debug)]
pub struct TeamAggregator {
    config: TeamConfig,
}

impl TeamAggregator {
    /// Create an aggregator with the given config.
    pub fn new(config: TeamConfig) -> Self {
        Self { config }
    }

    /// Aggregate every configured member into one output packet.
    pub fn aggregate(&self, member_root: &Path) -> Result<TeamAggregateResult> {
        if self.config.members.is_empty() {
            return Err(anyhow!("No team members configured"));
        }

        let mut requested_members = self.config.members.clone();
        requested_members.sort();
        requested_members.dedup();

        let mut member_outputs = Vec::new();
        let mut member_summaries = Vec::new();
        let mut included_members = Vec::new();
        let mut missing_members = Vec::new();
        let mut incompatible_members = Vec::new();
        let mut warnings = Vec::new();

        for member in &requested_members {
            let alias = self
                .config
                .aliases
                .get(member)
                .cloned()
                .unwrap_or_else(|| member.clone());
            let ledger_dir = member_root.join(member);

            match load_member_output(&ledger_dir, self.config.since, self.config.until) {
                Ok(Some((output, member_warnings))) => {
                    if is_compatible_schema(&ledger_dir, &self.config.required_schema_version)? {
                        included_members.push(member.clone());
                        let warning_count = member_warnings.len();
                        if warning_count > 0 {
                            warnings.extend(member_warnings.iter().cloned());
                        }
                        member_summaries.push(TeamMemberSummary {
                            member: member.clone(),
                            display_name: alias,
                            included: true,
                            ledger_dir,
                            event_count: output.events.len(),
                            warnings: member_warnings,
                        });
                        member_outputs.push(output);
                    } else {
                        let warning =
                            format!("Ledger for '{member}' skipped due to schema incompatibility");
                        incompatible_members.push(member.clone());
                        warnings.push(warning.clone());
                        member_summaries.push(TeamMemberSummary {
                            member: member.clone(),
                            display_name: alias,
                            included: false,
                            ledger_dir,
                            event_count: 0,
                            warnings: vec![warning],
                        });
                    }
                }
                Ok(None) => {
                    let warning = format!(
                        "Missing ledger or coverage for member '{member}' at {}",
                        ledger_dir.display()
                    );
                    missing_members.push(member.clone());
                    warnings.push(warning.clone());
                    member_summaries.push(TeamMemberSummary {
                        member: member.clone(),
                        display_name: alias,
                        included: false,
                        ledger_dir,
                        event_count: 0,
                        warnings: vec![warning],
                    });
                }
                Err(err) => {
                    let warning = format!(
                        "Failed reading ledger for '{member}' from {}: {err}",
                        ledger_dir.display()
                    );
                    missing_members.push(member.clone());
                    warnings.push(warning.clone());
                    member_summaries.push(TeamMemberSummary {
                        member: member.clone(),
                        display_name: alias,
                        included: false,
                        ledger_dir,
                        event_count: 0,
                        warnings: vec![warning],
                    });
                }
            }
        }

        let (coverage, events) = if member_outputs.is_empty() {
            (
                empty_coverage(
                    self.config.since,
                    self.config.until,
                    requested_members.clone(),
                    warnings.clone(),
                ),
                Vec::new(),
            )
        } else {
            let merged =
                merge_ingest_outputs(&member_outputs, ConflictResolution::PreferMostRecent)?;
            let mut coverage = merged.ingest_output.coverage;
            if let Some(since) = self.config.since {
                coverage.window.since = since;
            }
            if let Some(until) = self.config.until {
                coverage.window.until = until;
            }
            coverage.sources = requested_members.clone();
            coverage.warnings.extend(warnings.clone());
            (coverage, merged.ingest_output.events)
        };

        if self.config.required_schema_version.is_some()
            && member_outputs.is_empty()
            && !warnings.is_empty()
        {
            // All members were skipped for schema incompatibility — warnings already recorded.
        }

        Ok(TeamAggregateResult {
            requested_members,
            included_members,
            missing_members,
            incompatible_members,
            members: member_summaries,
            coverage,
            events,
            warnings,
        })
    }

    /// Render a markdown packet from aggregate output.
    pub fn render_packet_markdown(&self, output: &TeamAggregateResult) -> Result<String> {
        render::render_packet_markdown(&self.config, output)
    }
}

/// Persist team outputs in the current directory layout used by the shiplog app.
pub fn write_team_outputs(
    out_dir: &Path,
    packet_markdown: &str,
    result: &TeamAggregateResult,
) -> Result<TeamOutputFiles> {
    std::fs::create_dir_all(out_dir)
        .with_context(|| format!("create output directory {out_dir:?}"))?;

    let packet_path = out_dir.join("team.packet.md");
    let events_path = out_dir.join("team.ledger.events.jsonl");
    let coverage_path = out_dir.join("team.coverage.manifest.json");

    std::fs::write(&packet_path, packet_markdown)?;
    let mut events_file =
        std::fs::File::create(&events_path).context("create team events output")?;
    for event in &result.events {
        let line = serde_json::to_string(event).context("serialize team event")?;
        events_file.write_all(line.as_bytes())?;
        events_file.write_all(b"\n")?;
    }

    let coverage_payload = serde_json::to_string_pretty(&result.coverage)
        .context("serialize team coverage manifest")?;
    std::fs::write(&coverage_path, coverage_payload)?;

    Ok(TeamOutputFiles {
        packet: packet_path,
        events: events_path,
        coverage: coverage_path,
    })
}

fn is_compatible_schema(ledger_dir: &Path, required_version: &Option<String>) -> Result<bool> {
    let required = required_version.as_deref();
    if required.is_none() {
        return Ok(true);
    }

    let version_path = ledger_dir.join("coverage.manifest.json");
    let text = fs::read_to_string(&version_path)
        .with_context(|| format!("read coverage manifest {version_path:?}"))?;
    let json: Value = serde_json::from_str(&text).context("parse coverage manifest")?;
    let detected = json
        .get("schema_version")
        .and_then(Value::as_str)
        .unwrap_or("0.2.0");
    Ok(detected == required.unwrap())
}

fn load_member_output(
    ledger_dir: &Path,
    since: Option<NaiveDate>,
    until: Option<NaiveDate>,
) -> Result<Option<(IngestOutput, Vec<String>)>> {
    let events_path = ledger_dir.join("ledger.events.jsonl");
    let coverage_path = ledger_dir.join("coverage.manifest.json");

    if !events_path.exists() || !coverage_path.exists() {
        return Ok(None);
    }

    let events = read_events(&events_path)?;
    let coverage = read_coverage(&coverage_path)?;
    let mut warnings = Vec::new();

    let filtered: Vec<EventEnvelope> = events
        .into_iter()
        .filter(|event| {
            if let Some(since) = since
                && event.occurred_at.date_naive() < since
            {
                return false;
            }
            if let Some(until) = until
                && event.occurred_at.date_naive() >= until
            {
                return false;
            }
            true
        })
        .collect();

    if filtered.is_empty() {
        warnings.push(format!(
            "Member at {} had zero events after filtering",
            ledger_dir.display()
        ));
    }

    Ok(Some((
        IngestOutput {
            events: filtered,
            coverage,
            freshness: Vec::new(),
        },
        warnings,
    )))
}

fn read_events(path: &Path) -> Result<Vec<EventEnvelope>> {
    let text = fs::read_to_string(path).with_context(|| format!("read {path:?}"))?;
    let mut events = Vec::new();
    for (i, line) in text.lines().enumerate() {
        let line = line.trim();
        if line.is_empty() {
            continue;
        }
        let event: EventEnvelope = serde_json::from_str(line)
            .with_context(|| format!("parse event line {} in {:?}", i + 1, path))?;
        events.push(event);
    }
    Ok(events)
}

fn read_coverage(path: &Path) -> Result<CoverageManifest> {
    let text = fs::read_to_string(path).with_context(|| format!("read {path:?}"))?;
    let cov: CoverageManifest =
        serde_json::from_str(&text).with_context(|| format!("parse coverage manifest {path:?}"))?;
    Ok(cov)
}

fn empty_coverage(
    since: Option<NaiveDate>,
    until: Option<NaiveDate>,
    sources: Vec<String>,
    warnings: Vec<String>,
) -> CoverageManifest {
    let today = Utc::now().date_naive();
    CoverageManifest {
        run_id: shiplog_ids::RunId::now("team"),
        generated_at: Utc::now(),
        user: "team".to_string(),
        window: TimeWindow {
            since: since.unwrap_or(today),
            until: until.unwrap_or(today),
        },
        mode: "team".to_string(),
        sources,
        slices: Vec::new(),
        warnings,
        completeness: Completeness::Complete,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::{NaiveDate, TimeZone, Utc};
    use shiplog_ids::EventId;
    use shiplog_schema::coverage::TimeWindow;
    use std::io::Write;

    fn event(id: &str, repo: &str, when: chrono::DateTime<Utc>) -> EventEnvelope {
        EventEnvelope {
            id: EventId::from_parts(["team", id]),
            kind: shiplog_schema::event::EventKind::PullRequest,
            occurred_at: when,
            actor: shiplog_schema::event::Actor {
                login: "alice".to_string(),
                id: None,
            },
            repo: shiplog_schema::event::RepoRef {
                full_name: repo.to_string(),
                html_url: None,
                visibility: shiplog_schema::event::RepoVisibility::Public,
            },
            payload: shiplog_schema::event::EventPayload::PullRequest(
                shiplog_schema::event::PullRequestEvent {
                    number: 1,
                    title: format!("Event {id}"),
                    state: shiplog_schema::event::PullRequestState::Merged,
                    created_at: when,
                    merged_at: Some(when),
                    additions: Some(1),
                    deletions: Some(0),
                    changed_files: Some(1),
                    touched_paths_hint: vec![],
                    window: Some(TimeWindow {
                        since: NaiveDate::from_ymd_opt(2025, 1, 1).unwrap(),
                        until: NaiveDate::from_ymd_opt(2025, 2, 1).unwrap(),
                    }),
                },
            ),
            tags: vec![],
            links: vec![],
            source: shiplog_schema::event::SourceRef {
                system: shiplog_schema::event::SourceSystem::Github,
                url: None,
                opaque_id: None,
            },
        }
    }

    fn coverage(run_id: &str) -> shiplog_schema::coverage::CoverageManifest {
        shiplog_schema::coverage::CoverageManifest {
            run_id: shiplog_ids::RunId(run_id.to_string()),
            generated_at: Utc::now(),
            user: "alice".to_string(),
            window: TimeWindow {
                since: NaiveDate::from_ymd_opt(2025, 1, 1).unwrap(),
                until: NaiveDate::from_ymd_opt(2025, 2, 1).unwrap(),
            },
            mode: "test".to_string(),
            sources: vec!["github".to_string()],
            slices: vec![],
            warnings: vec![],
            completeness: Completeness::Complete,
        }
    }

    fn write_run(dir: &Path, member: &str, include_coverage: bool) -> PathBuf {
        let run_dir = dir.join(member);
        std::fs::create_dir_all(&run_dir).unwrap();
        if include_coverage {
            let mut events = std::fs::File::create(run_dir.join("ledger.events.jsonl")).unwrap();
            let e1 = event(
                &format!("{member}-1"),
                "repo/one",
                Utc.with_ymd_and_hms(2025, 1, 2, 0, 0, 0).unwrap(),
            );
            let e2 = event(
                &format!("{member}-2"),
                "repo/two",
                Utc.with_ymd_and_hms(2025, 1, 3, 0, 0, 0).unwrap(),
            );
            writeln!(events, "{}", serde_json::to_string(&e1).unwrap()).unwrap();
            writeln!(events, "{}", serde_json::to_string(&e2).unwrap()).unwrap();
            std::fs::write(
                run_dir.join("coverage.manifest.json"),
                serde_json::to_string(&coverage(&format!("{member}-run"))).unwrap(),
            )
            .unwrap();
        }
        run_dir
    }

    #[test]
    fn aggregates_multiple_members() {
        let root = tempfile::tempdir().unwrap();
        let dir = root.path();
        write_run(dir, "alice", true);
        write_run(dir, "bob", true);

        let agg = TeamAggregator::new(TeamConfig {
            members: vec!["alice".into(), "bob".into()],
            ..TeamConfig::default()
        });

        let result = agg.aggregate(dir).unwrap();
        assert_eq!(result.included_members.len(), 2);
        assert_eq!(result.events.len(), 4);
        assert!(result.warnings.is_empty());
    }

    #[test]
    fn missing_member_reports_warning_and_continues() {
        let root = tempfile::tempdir().unwrap();
        write_run(root.path(), "alice", true);

        let agg = TeamAggregator::new(TeamConfig {
            members: vec!["alice".into(), "missing".into()],
            ..TeamConfig::default()
        });

        let result = agg.aggregate(root.path()).unwrap();
        assert_eq!(result.included_members.len(), 1);
        assert_eq!(result.members.len(), 2);
        assert!(
            result.warnings.iter().any(|w| w.contains("Missing ledger")),
            "missing warnings: {:?}",
            result.warnings
        );
    }

    #[test]
    fn renders_default_packet() {
        let root = tempfile::tempdir().unwrap();
        write_run(root.path(), "alice", true);
        let agg = TeamAggregator::new(TeamConfig {
            members: vec!["alice".into()],
            ..TeamConfig::default()
        });
        let output = agg.aggregate(root.path()).unwrap();
        let packet = agg.render_packet_markdown(&output).unwrap();
        assert!(packet.contains("# Team Shipping Packet"));
        assert!(packet.contains("Total events: 2"));
    }
}