fallow-api 3.30.0

Programmatic API contract types for fallow
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
use std::path::{Path, PathBuf};
use std::time::Instant;

use fallow_engine::repo_refs::{self, TemporaryBaseWorktree};
use fallow_output::ReviewDeltas;
use rustc_hash::{FxHashMap, FxHashSet};

use crate::{
    AnalysisOptions, AuditOptions, DecisionSurfaceOptions, DecisionSurfaceProgrammaticOutput,
    ProgrammaticError,
    analysis_context::{
        ProgrammaticAnalysisContext, changed_files_for_run,
        resolve_programmatic_analysis_context_deferred_workspace, workspace_roots_for_session,
    },
    decision_surface::{
        BoundaryAnchor, CoordinationAnchor, DEFAULT_DECISION_CAP, DecisionInputs,
        extract_decision_surface,
    },
};

use super::ProgrammaticResult;

/// Run changed-code decision-surface analysis through the typed programmatic API.
///
/// # Errors
///
/// Returns a structured error for invalid options, base-ref discovery failures,
/// git changed-file failures, or analysis failures.
pub fn run_decision_surface(
    options: &DecisionSurfaceOptions,
) -> ProgrammaticResult<DecisionSurfaceProgrammaticOutput> {
    let start = Instant::now();
    let audit_options = audit_options_for_decision_surface(options);
    let resolved_base = super::audit::resolve_audit_base_ref(&audit_options)?;
    let analysis = AnalysisOptions {
        changed_since: Some(resolved_base.git_ref.clone()),
        ..options.analysis.clone()
    };
    let resolved = resolve_programmatic_analysis_context_deferred_workspace(&analysis)?;
    let changed_files = changed_files_for_run(&resolved)?.unwrap_or_default();
    if changed_files.is_empty() {
        return Ok(DecisionSurfaceProgrammaticOutput {
            surface: fallow_output::DecisionSurface::default(),
            elapsed: start.elapsed(),
            telemetry_analysis_run_id: None,
        });
    }

    let head = run_decision_analysis(&resolved, Some(&changed_files), None)?;
    let manifests = changed_manifests(&resolved.root, &changed_files);
    let base = compute_base_decision_snapshot(
        options,
        &resolved.root,
        &resolved_base.git_ref,
        &manifests,
        &head.config,
    )?;
    let manifest_pairs = manifest_pairs(&resolved.root, &manifests, &base);
    let dependency_anchors = crate::dependency_deltas::dependency_anchors_from_manifests(
        &manifest_pairs,
        head.package_importers.as_ref(),
    );
    let deltas = build_decision_deltas(&head, &base, &dependency_anchors);
    let surface = build_surface(options, &head, &deltas, &dependency_anchors);

    Ok(DecisionSurfaceProgrammaticOutput {
        surface,
        elapsed: start.elapsed(),
        telemetry_analysis_run_id: None,
    })
}

fn audit_options_for_decision_surface(options: &DecisionSurfaceOptions) -> AuditOptions {
    AuditOptions {
        analysis: options.analysis.clone(),
        base: options.base.clone(),
        ..AuditOptions::default()
    }
}

pub(super) struct DecisionAnalysis {
    root: PathBuf,
    pub(super) results: fallow_types::results::AnalysisResults,
    public_api: FxHashSet<String>,
    impact_closure: Option<fallow_engine::module_graph::ImpactClosurePaths>,
    export_lines: Option<FxHashMap<String, Vec<(String, u32)>>>,
    internal_consumers: Option<FxHashMap<String, u64>>,
    package_importers: Option<FxHashMap<String, fallow_engine::module_graph::PackageImporters>>,
    routing: fallow_output::RoutingFacts,
    /// The configuration the analysis session loaded, kept so the base
    /// snapshot can resolve rule severity against the head configuration.
    pub(super) config: fallow_config::ResolvedConfig,
}

struct DecisionGraphSignals {
    public_api: FxHashSet<String>,
    impact_closure: Option<fallow_engine::module_graph::ImpactClosurePaths>,
    export_lines: Option<FxHashMap<String, Vec<(String, u32)>>>,
    internal_consumers: Option<FxHashMap<String, u64>>,
    package_importers: Option<FxHashMap<String, fallow_engine::module_graph::PackageImporters>>,
}

/// Root-relative, forward-slashed paths of the changed `package.json`
/// manifests, sorted.
fn changed_manifests(root: &Path, changed_files: &FxHashSet<PathBuf>) -> Vec<String> {
    let mut manifests: Vec<String> = changed_files
        .iter()
        .filter_map(|abs| abs.strip_prefix(root).ok())
        .map(|rel| rel.to_string_lossy().replace('\\', "/"))
        .filter(|rel| crate::dependency_deltas::is_manifest_path(rel))
        .collect();
    manifests.sort();
    manifests
}

/// Pair each changed manifest's head text with the base text captured from the
/// base worktree. A manifest unreadable at head is skipped; one absent at base
/// reads as new.
fn manifest_pairs(
    root: &Path,
    manifests: &[String],
    base: &DecisionSnapshot,
) -> Vec<crate::dependency_deltas::ManifestPair> {
    manifests
        .iter()
        .filter_map(|manifest| {
            let head = std::fs::read_to_string(root.join(manifest)).ok()?;
            Some(crate::dependency_deltas::ManifestPair {
                manifest: manifest.clone(),
                base: base.manifests.get(manifest).cloned(),
                head,
            })
        })
        .collect()
}

/// Analyze one revision for the decision surface. `severity_config` resolves
/// rule severity in place of the session's own configuration; the base
/// snapshot passes the head configuration so both revisions are judged by the
/// rules under review, as the CLI's base worktree pass already does.
pub(super) fn run_decision_analysis(
    resolved: &ProgrammaticAnalysisContext,
    changed_files: Option<&FxHashSet<PathBuf>>,
    severity_config: Option<&fallow_config::ResolvedConfig>,
) -> ProgrammaticResult<DecisionAnalysis> {
    let session = super::dead_code::load_dead_code_session(
        &super::dead_code::default_dead_code_options_for_context(resolved),
        resolved,
    )?;
    let root = session.root().to_path_buf();
    let artifacts = session
        .analyze_dead_code_with_session_artifacts(false, true, changed_files.cloned())
        .map_err(|err| {
            ProgrammaticError::new(format!("decision-surface analysis failed: {err}"), 2)
                .with_code("FALLOW_DECISION_SURFACE_FAILED")
                .with_context("decision-surface")
        })?;
    let fallow_engine::session::AnalysisSessionArtifacts {
        analysis: mut output,
        changed_files,
        ..
    } = artifacts;
    let changed_files = changed_files.as_ref();

    // Rule severity is resolved before anything is framed as a decision, so a
    // rule or a per-path override that turns a finding off also removes the
    // decision built from it. The CLI reaches the same state through `check`.
    let severity = severity_config.unwrap_or_else(|| session.config());
    fallow_engine::dead_code::apply_rule_severities(&mut output.results, severity);

    let workspace_roots = workspace_roots_for_session(resolved, session.workspaces())?;
    filter_decision_results(
        &mut output.results,
        workspace_roots.as_deref(),
        changed_files,
    );

    let graph_signals =
        decision_graph_signals(output.graph.as_ref(), &session, &root, changed_files);
    let routing = changed_files.map_or_else(fallow_output::RoutingFacts::default, |files| {
        crate::routing::compute_routing(&root, session.config(), files)
    });

    Ok(DecisionAnalysis {
        root,
        results: output.results,
        public_api: graph_signals.public_api,
        impact_closure: graph_signals.impact_closure,
        export_lines: graph_signals.export_lines,
        internal_consumers: graph_signals.internal_consumers,
        package_importers: graph_signals.package_importers,
        routing,
        config: session.config().clone(),
    })
}

fn decision_graph_signals(
    graph: Option<&fallow_engine::module_graph::RetainedModuleGraph>,
    session: &fallow_engine::session::AnalysisSession,
    root: &Path,
    changed_files: Option<&FxHashSet<PathBuf>>,
) -> DecisionGraphSignals {
    let public_api = graph.map_or_else(FxHashSet::default, |graph| {
        crate::review_deltas::public_export_keys_for(
            graph,
            session.config(),
            session.workspaces(),
            root,
        )
    });
    let impact_closure = graph.and_then(|graph| {
        changed_files.and_then(|files| {
            fallow_engine::module_graph::impact_closure_for_changed_paths(graph, root, files)
        })
    });
    let export_lines = graph.and_then(|graph| {
        changed_files.and_then(|files| {
            fallow_engine::module_graph::export_lines_for_changed_paths(graph, root, files)
        })
    });
    let internal_consumers = graph.and_then(|graph| {
        changed_files.and_then(|files| {
            fallow_engine::module_graph::internal_consumers_for_changed_paths(graph, root, files)
        })
    });
    let package_importers = graph.and_then(|graph| {
        changed_files.and_then(|files| {
            fallow_engine::module_graph::package_importers_for_changed_paths(graph, files)
        })
    });

    DecisionGraphSignals {
        public_api,
        impact_closure,
        export_lines,
        internal_consumers,
        package_importers,
    }
}

fn filter_decision_results(
    results: &mut fallow_types::results::AnalysisResults,
    workspace_roots: Option<&[PathBuf]>,
    changed_files: Option<&FxHashSet<PathBuf>>,
) {
    if let Some(workspace_roots) = workspace_roots {
        fallow_engine::dead_code::filter_to_workspaces(results, workspace_roots);
    }
    if let Some(changed_files) = changed_files {
        fallow_engine::dead_code::filter_by_changed_files(results, changed_files);
    }
}

fn compute_base_decision_snapshot(
    options: &DecisionSurfaceOptions,
    current_root: &Path,
    base_ref: &str,
    manifests: &[String],
    head_config: &fallow_config::ResolvedConfig,
) -> ProgrammaticResult<DecisionSnapshot> {
    let worktree = TemporaryBaseWorktree::create(current_root, base_ref).map_err(|err| {
        ProgrammaticError::new(err.to_string(), 2)
            .with_code("FALLOW_DECISION_SURFACE_FAILED")
            .with_context("decisionSurface.base")
    })?;
    let base_root = match repo_refs::resolve_base_analysis_root(current_root, worktree.path()) {
        repo_refs::BaseAnalysisRoot::Present(root) => root,
        // A root the base commit does not contain has an empty base snapshot:
        // no boundary edges, no cycles, no public API and no manifests, so the
        // whole surface reads as new in this change.
        repo_refs::BaseAnalysisRoot::NewInHead(_) => return Ok(DecisionSnapshot::default()),
    };
    // The base manifests are read while the worktree still exists; a manifest
    // absent at base stays absent (it is new in this change).
    let base_manifests: FxHashMap<String, String> = manifests
        .iter()
        .filter_map(|manifest| {
            std::fs::read_to_string(base_root.join(manifest))
                .ok()
                .map(|text| (manifest.clone(), text))
        })
        .collect();
    let base_analysis = AnalysisOptions {
        root: Some(base_root),
        config_path: options.analysis.config_path.clone(),
        changed_since: None,
        explain: false,
        ..options.analysis.clone()
    };
    let resolved = resolve_programmatic_analysis_context_deferred_workspace(&base_analysis)?;
    let base = run_decision_analysis(&resolved, None, Some(head_config))?;
    let mut snapshot = snapshot_from_decision_analysis(&base);
    snapshot.manifests = base_manifests;
    Ok(snapshot)
}

#[derive(Default)]
struct DecisionSnapshot {
    boundary_edges: FxHashSet<String>,
    cycles: FxHashSet<String>,
    public_api: FxHashSet<String>,
    /// Base text of each changed manifest, keyed by root-relative path.
    manifests: FxHashMap<String, String>,
}

fn snapshot_from_decision_analysis(analysis: &DecisionAnalysis) -> DecisionSnapshot {
    DecisionSnapshot {
        boundary_edges: crate::review_deltas::boundary_edge_keys(
            &analysis.results.boundary_violations,
        ),
        cycles: crate::review_deltas::cycle_keys(
            &analysis.results.circular_dependencies,
            &analysis.root,
        ),
        public_api: analysis.public_api.clone(),
        manifests: FxHashMap::default(),
    }
}

fn build_decision_deltas(
    head: &DecisionAnalysis,
    base: &DecisionSnapshot,
    dependency_anchors: &[crate::decision_surface::DependencyAnchor],
) -> ReviewDeltas {
    let head_snapshot = snapshot_from_decision_analysis(head);
    let mut deltas = fallow_output::ReviewDeltas {
        boundary_introduced: crate::review_deltas::introduced_keys(
            &head_snapshot.boundary_edges,
            &base.boundary_edges,
        ),
        cycle_introduced: crate::review_deltas::introduced_keys(
            &head_snapshot.cycles,
            &base.cycles,
        ),
        public_api_added: crate::review_deltas::introduced_keys(
            &head_snapshot.public_api,
            &base.public_api,
        ),
        dependency_added: Vec::new(),
        dependency_major_bumped: Vec::new(),
    };
    crate::dependency_deltas::fill_dependency_delta_keys(&mut deltas, dependency_anchors);
    deltas
}

fn build_surface(
    options: &DecisionSurfaceOptions,
    head: &DecisionAnalysis,
    deltas: &ReviewDeltas,
    dependency_anchors: &[crate::decision_surface::DependencyAnchor],
) -> fallow_output::DecisionSurface {
    let boundary_anchors = boundary_anchors(head, deltas);
    let mut coordination = coordination_anchors(head.impact_closure.as_ref());
    let resolve_line = export_line_resolver(head.export_lines.as_ref());
    for anchor in &mut coordination {
        anchor.line = resolve_line(&anchor.changed_file, &anchor.consumed_symbols);
    }
    let public_api_anchor_line = deltas.public_api_added.first().map_or(0, |key| {
        let mut parts = key.splitn(2, "::");
        let path = parts.next().unwrap_or_default();
        let name = parts.next().unwrap_or_default();
        resolve_line(path, &[name.to_string()])
    });
    let affected_not_shown = head
        .impact_closure
        .as_ref()
        .map_or(0, |closure| closure.affected_not_shown.len() as u64);
    let root = head.root.clone();
    let head_source = move |rel: &str| std::fs::read_to_string(root.join(rel)).ok();
    let rename_old_path = |_rel: &str| -> Option<String> { None };
    let internal_consumers_map = head.internal_consumers.as_ref();
    let internal_consumers = |rel: &str| -> u64 {
        internal_consumers_map
            .and_then(|map| map.get(rel))
            .copied()
            .unwrap_or(0)
    };
    extract_decision_surface(&DecisionInputs {
        deltas,
        boundary_anchors: &boundary_anchors,
        coordination: &coordination,
        dependency_anchors,
        public_api_anchor_line,
        affected_not_shown,
        routing: &head.routing,
        head_source: &head_source,
        rename_old_path: &rename_old_path,
        internal_consumers: &internal_consumers,
        cap: options.max_decisions.unwrap_or(DEFAULT_DECISION_CAP),
    })
}

fn boundary_anchors(head: &DecisionAnalysis, deltas: &ReviewDeltas) -> Vec<BoundaryAnchor> {
    let mut boundary_anchors = Vec::new();
    let mut seen_pairs = FxHashSet::default();
    for finding in &head.results.boundary_violations {
        let key = crate::review_deltas::boundary_edge_key(finding);
        if !deltas.boundary_introduced.contains(&key) || !seen_pairs.insert(key.clone()) {
            continue;
        }
        boundary_anchors.push(BoundaryAnchor {
            zone_pair_key: key,
            from_file: crate::audit_keys::relative_key_path(
                &finding.violation.from_path,
                &head.root,
            ),
            from_zone: finding.violation.from_zone.clone(),
            to_zone: finding.violation.to_zone.clone(),
            line: finding.violation.line,
        });
    }
    boundary_anchors
}

fn coordination_anchors(
    closure: Option<&fallow_engine::module_graph::ImpactClosurePaths>,
) -> Vec<CoordinationAnchor> {
    let Some(closure) = closure else {
        return Vec::new();
    };
    let mut by_file: FxHashMap<String, (u64, FxHashSet<String>)> = FxHashMap::default();
    for gap in &closure.coordination_gap {
        let entry = by_file
            .entry(gap.changed_file.clone())
            .or_insert_with(|| (0, FxHashSet::default()));
        entry.0 += 1;
        for symbol in &gap.consumed_symbols {
            entry.1.insert(symbol.clone());
        }
    }
    let mut anchors = by_file
        .into_iter()
        .map(|(changed_file, (consumer_count, symbols))| {
            let mut consumed_symbols: Vec<String> = symbols.into_iter().collect();
            consumed_symbols.sort_unstable();
            CoordinationAnchor {
                changed_file,
                consumed_symbols,
                consumer_count,
                line: 0,
            }
        })
        .collect::<Vec<_>>();
    anchors.sort_by(|a, b| a.changed_file.cmp(&b.changed_file));
    anchors
}

fn export_line_resolver(
    export_lines: Option<&FxHashMap<String, Vec<(String, u32)>>>,
) -> impl Fn(&str, &[String]) -> u32 + '_ {
    move |rel: &str, symbols: &[String]| -> u32 {
        let Some(exports) = export_lines.and_then(|map| map.get(rel)) else {
            return 0;
        };
        exports
            .iter()
            .find(|(name, _)| symbols.iter().any(|symbol| name == symbol))
            .or_else(|| exports.first())
            .map_or(0, |(_, line)| *line)
    }
}