debtmap 0.17.2

Code complexity and technical debt analyzer
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
//! Inter-Procedural Purity Propagation
//!
//! This module implements two-phase purity analysis that propagates purity information
//! from callees to callers, enabling whole-program purity inference.
//!
//! # Architecture
//!
//! - **Phase 1**: Intrinsic analysis of each function in isolation using PurityAnalyzer
//! - **Phase 2**: Bottom-up propagation of purity through the call graph
//!
//! # Example
//!
//! ```ignore
//! let propagator = PurityPropagator::new(call_graph, purity_analyzer);
//! propagator.propagate(&functions)?;
//! ```

mod cache;
mod call_graph_adapter;
mod known_pure_functions;

pub use cache::PurityCache;
pub use call_graph_adapter::PurityCallGraphAdapter;
pub use known_pure_functions::{
    aggregate_callee_purity, resolve_callee_purity, CalleeEvidence, CalleePurity,
};

use crate::analysis::purity_analysis::{PurityAnalysis, PurityAnalyzer, PurityLevel};
use crate::core::FunctionMetrics;
use crate::priority::call_graph::FunctionId;
use anyhow::{anyhow, Result};
use dashmap::DashMap;

/// Result of purity propagation for a function
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PurityResult {
    pub level: PurityLevel,
    pub confidence: f64,
    pub reason: PurityReason,
}

/// Reason for purity classification
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub enum PurityReason {
    /// Function has no side effects or calls
    Intrinsic,

    /// All dependencies are pure
    PropagatedFromDeps { depth: usize },

    /// Has side effects
    SideEffects { effects: Vec<String> },

    /// Part of recursive cycle with side effects
    RecursiveWithSideEffects,

    /// Part of recursive cycle but otherwise pure
    RecursivePure,

    /// Unknown dependencies
    UnknownDeps { count: usize },
}

impl PurityResult {
    /// Convert from existing PurityAnalysis (phase 1 result)
    pub fn from_analysis(analysis: PurityAnalysis) -> Self {
        let reason = if !analysis.violations.is_empty() {
            PurityReason::SideEffects {
                effects: analysis
                    .violations
                    .iter()
                    .map(|v| v.description())
                    .collect(),
            }
        } else {
            PurityReason::Intrinsic
        };

        Self {
            level: analysis.purity,
            confidence: 1.0,
            reason,
        }
    }
}

/// Purity propagator for whole-program analysis
pub struct PurityPropagator {
    /// Cache of function purity results
    cache: DashMap<FunctionId, PurityResult>,

    /// Call graph adapter for dependency tracking
    call_graph: PurityCallGraphAdapter,

    /// Existing purity analyzer for intrinsic analysis (phase 1)
    #[allow(dead_code)]
    purity_analyzer: PurityAnalyzer,
}

struct DependencyPuritySummary {
    all_deps_pure: bool,
    aggregated_confidence: f64,
    impure_reasons: Vec<String>,
    max_depth: usize,
    unknown_count: usize,
}

impl PurityPropagator {
    /// Create a new purity propagator
    pub fn new(call_graph: PurityCallGraphAdapter, purity_analyzer: PurityAnalyzer) -> Self {
        Self {
            cache: DashMap::new(),
            call_graph,
            purity_analyzer,
        }
    }

    /// Propagate purity information through all functions
    pub fn propagate(&mut self, functions: &[FunctionMetrics]) -> Result<()> {
        // Phase 1: Initial purity analysis using existing PurityAnalyzer
        for func in functions {
            let initial = self.analyze_intrinsic_purity(func)?;
            let func_id = FunctionId::new(func.file.clone(), func.name.clone(), func.line);
            self.cache.insert(func_id, initial);
        }

        // Phase 2: Propagate purity bottom-up
        let sorted = self.call_graph.topological_sort()?;

        for func_id in sorted {
            self.propagate_for_function(&func_id)?;
        }

        Ok(())
    }

    /// Analyze intrinsic purity using existing PurityAnalyzer
    fn analyze_intrinsic_purity(&self, func: &FunctionMetrics) -> Result<PurityResult> {
        // For now, use existing purity information if available
        if let (Some(is_pure), Some(confidence)) = (func.is_pure, func.purity_confidence) {
            let level = if is_pure {
                PurityLevel::StrictlyPure
            } else {
                PurityLevel::Impure
            };
            return Ok(PurityResult {
                level,
                confidence: confidence as f64,
                reason: PurityReason::Intrinsic,
            });
        }

        // Default to impure with low confidence if no information available
        Ok(PurityResult {
            level: PurityLevel::Impure,
            confidence: 0.3,
            reason: PurityReason::UnknownDeps { count: 0 },
        })
    }

    /// Propagate purity for a single function
    ///
    /// Uses call graph and known pure std functions (Spec 261) to propagate
    /// purity information from callees to callers.
    fn propagate_for_function(&mut self, func_id: &FunctionId) -> Result<()> {
        let result = self.cached_result(func_id)?;
        let deps = self.call_graph.get_dependencies(func_id);
        let result = if self.call_graph.is_in_cycle(func_id) {
            propagate_recursive_result(result)
        } else {
            let callee_evidence = self.callee_evidence(&deps);
            let summary = self.dependency_summary(&deps, &callee_evidence);
            propagate_dependency_result(result, summary)
        };

        self.cache.insert(func_id.clone(), result);
        Ok(())
    }

    fn cached_result(&self, func_id: &FunctionId) -> Result<PurityResult> {
        self.cache
            .get(func_id)
            .map(|result| result.clone())
            .ok_or_else(|| anyhow!("Function not in cache"))
    }

    fn callee_evidence(&self, deps: &[FunctionId]) -> Vec<CalleeEvidence> {
        deps.iter()
            .map(|dep_id| CalleeEvidence {
                callee_name: dep_id.name.clone(),
                callee_purity: resolve_callee_purity(
                    &dep_id.name,
                    None,
                    self.cached_callee_purity(dep_id),
                ),
            })
            .collect()
    }

    fn cached_callee_purity(&self, dep_id: &FunctionId) -> Option<(bool, f64)> {
        self.cache.get(dep_id).map(|result| {
            let is_pure = result.level == PurityLevel::StrictlyPure;
            (is_pure, result.confidence)
        })
    }

    fn dependency_summary(
        &self,
        deps: &[FunctionId],
        evidence: &[CalleeEvidence],
    ) -> DependencyPuritySummary {
        let (all_deps_pure, aggregated_confidence, impure_reasons) =
            aggregate_callee_purity(evidence);

        DependencyPuritySummary {
            all_deps_pure,
            aggregated_confidence,
            impure_reasons,
            max_depth: self.max_dependency_depth(deps),
            unknown_count: count_unknown_dependencies(evidence),
        }
    }

    fn max_dependency_depth(&self, deps: &[FunctionId]) -> usize {
        deps.iter()
            .filter_map(|dep_id| self.cache.get(dep_id))
            .filter_map(|result| propagated_depth(&result.reason))
            .max()
            .unwrap_or(0)
    }

    /// Get the purity result for a function
    pub fn get_result(&self, func_id: &FunctionId) -> Option<PurityResult> {
        self.cache.get(func_id).map(|r| r.clone())
    }
}

fn propagate_recursive_result(mut result: PurityResult) -> PurityResult {
    if is_recursion_eligible_pure(&result.level) {
        result.reason = PurityReason::RecursivePure;
        result.confidence *= 0.7;
        return result;
    }

    result.level = PurityLevel::Impure;
    result.reason = PurityReason::RecursiveWithSideEffects;
    result.confidence = 0.95;
    result
}

fn propagate_dependency_result(
    result: PurityResult,
    summary: DependencyPuritySummary,
) -> PurityResult {
    if has_pure_dependencies(&result, &summary) {
        return propagated_pure_result(result, &summary);
    }

    if !summary.impure_reasons.is_empty() {
        return propagated_impure_result(summary);
    }

    if summary.unknown_count > 0 {
        return propagated_unknown_result(result, &summary);
    }

    result
}

fn is_recursion_eligible_pure(level: &PurityLevel) -> bool {
    matches!(level, PurityLevel::StrictlyPure | PurityLevel::LocallyPure)
}

fn has_pure_dependencies(result: &PurityResult, summary: &DependencyPuritySummary) -> bool {
    summary.all_deps_pure
        && result.level != PurityLevel::Impure
        && summary.impure_reasons.is_empty()
}

fn propagated_pure_result(
    mut result: PurityResult,
    summary: &DependencyPuritySummary,
) -> PurityResult {
    let depth = summary.max_depth + 1;
    let depth_confidence = 0.9_f64.powi(depth as i32);

    result.level = PurityLevel::StrictlyPure;
    result.reason = PurityReason::PropagatedFromDeps { depth };
    result.confidence =
        (result.confidence * depth_confidence * summary.aggregated_confidence).clamp(0.5, 1.0);
    result
}

fn propagated_impure_result(summary: DependencyPuritySummary) -> PurityResult {
    PurityResult {
        level: PurityLevel::Impure,
        confidence: summary.aggregated_confidence,
        reason: PurityReason::SideEffects {
            effects: summary.impure_reasons,
        },
    }
}

fn propagated_unknown_result(
    mut result: PurityResult,
    summary: &DependencyPuritySummary,
) -> PurityResult {
    result.reason = PurityReason::UnknownDeps {
        count: summary.unknown_count,
    };
    result.confidence = (result.confidence * summary.aggregated_confidence).clamp(0.3, 1.0);
    result
}

fn propagated_depth(reason: &PurityReason) -> Option<usize> {
    match reason {
        PurityReason::PropagatedFromDeps { depth } => Some(*depth),
        _ => None,
    }
}

fn count_unknown_dependencies(evidence: &[CalleeEvidence]) -> usize {
    evidence
        .iter()
        .filter(|entry| matches!(entry.callee_purity, CalleePurity::Unknown))
        .count()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn result(level: PurityLevel, confidence: f64) -> PurityResult {
        PurityResult {
            level,
            confidence,
            reason: PurityReason::Intrinsic,
        }
    }

    fn summary(
        all_deps_pure: bool,
        aggregated_confidence: f64,
        impure_reasons: Vec<String>,
        max_depth: usize,
        unknown_count: usize,
    ) -> DependencyPuritySummary {
        DependencyPuritySummary {
            all_deps_pure,
            aggregated_confidence,
            impure_reasons,
            max_depth,
            unknown_count,
        }
    }

    #[test]
    fn recursive_pure_result_keeps_purity_with_penalty() {
        let propagated = propagate_recursive_result(result(PurityLevel::StrictlyPure, 0.9));

        assert_eq!(propagated.level, PurityLevel::StrictlyPure);
        assert_eq!(propagated.reason, PurityReason::RecursivePure);
        assert!((propagated.confidence - 0.63).abs() < f64::EPSILON);
    }

    #[test]
    fn recursive_impure_result_marks_side_effect_cycle() {
        let propagated = propagate_recursive_result(result(PurityLevel::Impure, 0.4));

        assert_eq!(propagated.level, PurityLevel::Impure);
        assert_eq!(propagated.reason, PurityReason::RecursiveWithSideEffects);
        assert!((propagated.confidence - 0.95).abs() < f64::EPSILON);
    }

    #[test]
    fn pure_dependencies_set_depth_and_confidence() {
        let propagated = propagate_dependency_result(
            result(PurityLevel::LocallyPure, 0.95),
            summary(true, 0.9, Vec::new(), 2, 0),
        );

        assert_eq!(propagated.level, PurityLevel::StrictlyPure);
        assert_eq!(
            propagated.reason,
            PurityReason::PropagatedFromDeps { depth: 3 }
        );
        assert!(propagated.confidence < 0.95);
    }

    #[test]
    fn impure_dependencies_override_current_result() {
        let propagated = propagate_dependency_result(
            result(PurityLevel::StrictlyPure, 0.95),
            summary(
                false,
                0.95,
                vec!["Calls impure function: write".into()],
                0,
                0,
            ),
        );

        assert_eq!(propagated.level, PurityLevel::Impure);
        assert_eq!(
            propagated.reason,
            PurityReason::SideEffects {
                effects: vec!["Calls impure function: write".into()]
            }
        );
    }

    #[test]
    fn unknown_dependencies_reduce_confidence_without_changing_level() {
        let propagated = propagate_dependency_result(
            result(PurityLevel::StrictlyPure, 0.8),
            summary(true, 0.9, Vec::new(), 0, 2),
        );

        assert_eq!(propagated.level, PurityLevel::StrictlyPure);
        assert_eq!(
            propagated.reason,
            PurityReason::PropagatedFromDeps { depth: 1 }
        );
    }

    #[test]
    fn counts_unknown_dependencies_from_evidence() {
        let evidence = vec![
            CalleeEvidence {
                callee_name: "external".into(),
                callee_purity: CalleePurity::Unknown,
            },
            CalleeEvidence {
                callee_name: "len".into(),
                callee_purity: CalleePurity::KnownPure,
            },
        ];

        assert_eq!(count_unknown_dependencies(&evidence), 1);
    }
}