dfir_rs 0.16.0

DFIR runtime for Rust, used by Hydro.
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

use dfir_rs::dfir_syntax;
use dfir_rs::util::{collect_ready, unbounded_channel};
use multiplatform_test::multiplatform_test;

/// Asserts that keys appear in the expected probe order, but allows values
/// for each key to appear in any order. This tests the ordering property
/// (probe order preserved) without over-constraining build-side value order.
fn assert_key_order_values_unordered<
    K: Eq + std::fmt::Debug + Clone,
    V: Ord + std::fmt::Debug + Clone,
>(
    actual: &[(K, V)],
    expected_keys_in_order: &[K],
    expected_values_per_key: &[(K, Vec<V>)],
) {
    // Check keys appear in expected order
    let actual_keys: Vec<&K> = actual.iter().map(|(k, _)| k).collect();
    let mut expected_key_iter = expected_keys_in_order.iter();
    let mut cur_expected = expected_key_iter.next();
    for actual_key in &actual_keys {
        if cur_expected.is_some_and(|k| k != *actual_key) {
            cur_expected = expected_key_iter.next();
            assert_eq!(
                cur_expected,
                Some(*actual_key),
                "key order mismatch: got {actual_keys:?}, expected order {expected_keys_in_order:?}"
            );
        }
    }

    // Check values per key (unordered)
    for (key, expected_vals) in expected_values_per_key {
        let mut actual_vals: Vec<&V> = actual
            .iter()
            .filter(|(k, _)| k == key)
            .map(|(_, v)| v)
            .collect();
        actual_vals.sort();
        let mut sorted_expected = expected_vals.clone();
        sorted_expected.sort();
        assert_eq!(
            actual_vals,
            sorted_expected.iter().collect::<Vec<_>>(),
            "values mismatch for key {key:?}"
        );
    }
}

#[multiplatform_test]
pub fn test_join_multiset_half_basic() {
    let (build_send, build_recv) = unbounded_channel::<(&str, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(&str, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(&str, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half() -> for_each(|x| out_send.send(x).unwrap());
    };

    // Build side: cat->x, dog->y
    build_send.send(("cat", 'x')).unwrap();
    build_send.send(("dog", 'y')).unwrap();
    // Probe side: cat->1, dog->2, cat->3
    probe_send.send(("cat", 1)).unwrap();
    probe_send.send(("dog", 2)).unwrap();
    probe_send.send(("cat", 3)).unwrap();

    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    // Keys must follow probe order: cat, dog, cat
    assert_key_order_values_unordered(
        &out,
        &["cat", "dog", "cat"],
        &[("cat", vec![(1, 'x'), (3, 'x')]), ("dog", vec![(2, 'y')])],
    );
}

#[multiplatform_test]
pub fn test_join_multiset_half_preserves_probe_order() {
    let (build_send, build_recv) = unbounded_channel::<(i32, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(i32, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(i32, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half() -> for_each(|x| out_send.send(x).unwrap());
    };

    // Build side available first (stratum-delayed)
    build_send.send((1, 'a')).unwrap();
    build_send.send((2, 'b')).unwrap();

    // Probe side arrives in specific order
    probe_send.send((2, 20)).unwrap();
    probe_send.send((1, 10)).unwrap();

    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    // Output should follow probe order: key 2 first, then key 1
    assert_eq!(out, vec![(2, (20, 'b')), (1, (10, 'a'))]);
}

#[multiplatform_test]
pub fn test_join_multiset_half_no_match() {
    let (build_send, build_recv) = unbounded_channel::<(i32, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(i32, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(i32, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half() -> for_each(|x| out_send.send(x).unwrap());
    };

    build_send.send((1, 'a')).unwrap();
    probe_send.send((2, 20)).unwrap(); // no match

    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    assert_eq!(out, vec![]);
}

#[multiplatform_test]
pub fn test_join_multiset_half_multiple_build_values() {
    let (build_send, build_recv) = unbounded_channel::<(i32, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(i32, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(i32, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half() -> for_each(|x| out_send.send(x).unwrap());
    };

    // Multiple values for same key on build side
    build_send.send((1, 'a')).unwrap();
    build_send.send((1, 'b')).unwrap();
    probe_send.send((1, 10)).unwrap();

    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    // Single probe key, but build-side values can appear in any order
    assert_key_order_values_unordered(&out, &[1], &[(1, vec![(10, 'a'), (10, 'b')])]);
}

#[multiplatform_test]
pub fn test_join_multiset_half_tick_static() {
    let (build_send, build_recv) = unbounded_channel::<(i32, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(i32, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(i32, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half::<'static, 'tick>() -> for_each(|x| out_send.send(x).unwrap());
    };

    // Tick 1
    build_send.send((1, 'a')).unwrap();
    probe_send.send((1, 10)).unwrap();
    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    assert_key_order_values_unordered(&out, &[1], &[(1, vec![(10, 'a')])]);

    // Tick 2: build side persists ('static), new probe items
    probe_send.send((1, 20)).unwrap();
    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    assert_key_order_values_unordered(&out, &[1], &[(1, vec![(20, 'a')])]);
}

#[multiplatform_test]
pub fn test_join_multiset_half_probe_does_not_persist() {
    // Regression: with swapped persistence args, the probe side would
    // incorrectly get 'static persistence and replay old probe items.
    let (build_send, build_recv) = unbounded_channel::<(i32, char)>();
    let (probe_send, probe_recv) = unbounded_channel::<(i32, i32)>();
    let (out_send, mut out_recv) = unbounded_channel::<(i32, (i32, char))>();
    let mut flow = dfir_syntax! {
        source_stream(build_recv) -> [build]my_join;
        source_stream(probe_recv) -> [probe]my_join;
        my_join = join_multiset_half::<'static, 'tick>() -> for_each(|x| out_send.send(x).unwrap());
    };

    // Tick 1
    build_send.send((1, 'a')).unwrap();
    probe_send.send((1, 10)).unwrap();
    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    assert_eq!(out, vec![(1, (10, 'a'))]);

    // Tick 2: only new build data, no new probe data.
    // Probe is 'tick so old probe item (1, 10) should NOT replay.
    build_send.send((1, 'b')).unwrap();
    flow.run_tick_sync();
    let out: Vec<_> = collect_ready(&mut out_recv);
    assert_eq!(out, vec![]);
}