moonlight-core 0.1.2

Shared comparison, diffing, classification, and JSONL storage primitives for Moonlight.
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

mod capture;
mod diff;
mod json_path;

use crate::{target::CapturedTarget, Classification, ComparisonSummary, DiffEntry};
use std::collections::HashSet;

pub use capture::{
    capture_body, capture_body_with_redaction_patterns, capture_body_with_redactions,
    capture_headers, is_hop_by_hop_header,
};

#[derive(Debug, Clone)]
pub struct CompareConfig {
    pub ignore_json_paths: HashSet<String>,
    pub ignore_json_path_patterns: Vec<String>,
    pub redact_json_paths: HashSet<String>,
    pub redact_json_path_patterns: Vec<String>,
    pub ignore_headers: HashSet<String>,
    pub ignore_stderr: bool,
}

impl CompareConfig {
    pub fn new(
        ignore_json_paths: &[String],
        ignore_headers: &[String],
        ignore_stderr: bool,
    ) -> Self {
        Self::new_with_redactions(ignore_json_paths, &[], ignore_headers, ignore_stderr)
    }

    pub fn new_with_redactions(
        ignore_json_paths: &[String],
        redact_json_paths: &[String],
        ignore_headers: &[String],
        ignore_stderr: bool,
    ) -> Self {
        Self::new_with_patterns(
            ignore_json_paths,
            &[],
            redact_json_paths,
            &[],
            ignore_headers,
            ignore_stderr,
        )
    }

    pub fn new_with_patterns(
        ignore_json_paths: &[String],
        ignore_json_path_patterns: &[String],
        redact_json_paths: &[String],
        redact_json_path_patterns: &[String],
        ignore_headers: &[String],
        ignore_stderr: bool,
    ) -> Self {
        Self {
            ignore_json_paths: ignore_json_paths.iter().cloned().collect(),
            ignore_json_path_patterns: ignore_json_path_patterns.to_vec(),
            redact_json_paths: redact_json_paths.iter().cloned().collect(),
            redact_json_path_patterns: redact_json_path_patterns.to_vec(),
            ignore_headers: ignore_headers
                .iter()
                .map(|value| value.to_ascii_lowercase())
                .collect(),
            ignore_stderr,
        }
    }
}

pub fn compare_targets(
    primary: &CapturedTarget,
    candidate: &CapturedTarget,
    secondary: Option<&CapturedTarget>,
    config: &CompareConfig,
) -> ComparisonSummary {
    let raw_candidate_diffs =
        diff::diff_pair(primary, candidate, diff::TargetRole::Candidate, config);
    let reference_noise = secondary
        .map(|secondary| diff::diff_pair(primary, secondary, diff::TargetRole::Secondary, config))
        .unwrap_or_default();
    let noise_filtered_diffs = filter_candidate_diffs(&raw_candidate_diffs, &reference_noise);

    let target_error = primary.observation.error.is_some()
        || candidate.observation.error.is_some()
        || secondary
            .and_then(|target| target.observation.error.as_ref())
            .is_some();

    let classification = if target_error {
        Classification::TargetError
    } else if raw_candidate_diffs.is_empty() && reference_noise.is_empty() {
        Classification::Match
    } else if noise_filtered_diffs.is_empty() {
        Classification::ReferenceNoise
    } else if !reference_noise.is_empty() {
        Classification::SuspiciousWithNoise
    } else {
        Classification::SuspiciousDifference
    };

    ComparisonSummary {
        classification,
        raw_diff_summary: summarize("candidate", &raw_candidate_diffs),
        noise_summary: summarize("reference noise", &reference_noise),
        raw_candidate_diffs,
        reference_noise,
        noise_filtered_diffs,
    }
}

fn summarize(label: &str, diffs: &[DiffEntry]) -> String {
    if diffs.is_empty() {
        format!("no {label} diffs")
    } else {
        format!("{label}: {} diff(s)", diffs.len())
    }
}

fn filter_candidate_diffs(
    candidate_diffs: &[DiffEntry],
    reference_noise: &[DiffEntry],
) -> Vec<DiffEntry> {
    candidate_diffs
        .iter()
        .filter(|candidate_diff| {
            let Some(reference_diff) = reference_noise.iter().find(|reference_diff| {
                reference_diff.kind == candidate_diff.kind
                    && reference_diff.path == candidate_diff.path
            }) else {
                return true;
            };

            candidate_diff.candidate != candidate_diff.primary
                && candidate_diff.candidate != reference_diff.secondary
        })
        .cloned()
        .collect()
}

#[cfg(test)]
mod tests;