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
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

use std::collections::BTreeSet;

use dfir_rs::assert_graphvis_snapshots;
use dfir_rs::scheduled::ticks::TickInstant;
use dfir_rs::util::collect_ready;
use multiplatform_test::multiplatform_test;

#[multiplatform_test]
pub fn test_fold_keyed_infer_basic() {
    pub struct SubordResponse {
        pub xid: &'static str,
        pub mtype: u32,
    }
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<(&'static str, u32)>();

    let mut df = dfir_rs::dfir_syntax! {
        source_iter([
                SubordResponse { xid: "123", mtype: 33 },
                SubordResponse { xid: "123", mtype: 52 },
                SubordResponse { xid: "123", mtype: 72 },
                SubordResponse { xid: "123", mtype: 83 },
                SubordResponse { xid: "123", mtype: 78 },
            ])
            -> map(|m: SubordResponse| (m.xid, m.mtype))
            -> fold_keyed::<'static>(|| 0, |old: &mut u32, val: u32| *old += val)
            -> for_each(|kv| result_send.send(kv).unwrap());
    };
    assert_graphvis_snapshots!(df);

    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());

    df.run_available_sync(); // Should return quickly and not hang

    assert_eq!(
        &[("123", 318), ("123", 318)],
        &*collect_ready::<Vec<_>, _>(&mut result_recv)
    );
}

#[multiplatform_test]
pub fn test_fold_keyed_typed_basic() {
    pub struct SubordResponse {
        pub xid: &'static str,
        pub mtype: u32,
    }
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<(&'static str, u32)>();

    let mut df = dfir_rs::dfir_syntax! {
        source_iter([
                SubordResponse { xid: "123", mtype: 33 },
                SubordResponse { xid: "123", mtype: 52 },
                SubordResponse { xid: "123", mtype: 72 },
                SubordResponse { xid: "123", mtype: 83 },
                SubordResponse { xid: "123", mtype: 78 },
            ])
            -> map(|m: SubordResponse| (m.xid, m.mtype))
            -> fold_keyed::<'static, &'static str, u32>(|| 0, |old: &mut u32, val: u32| *old += val)
            -> for_each(|kv| result_send.send(kv).unwrap());
    };
    assert_graphvis_snapshots!(df);

    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());

    df.run_available_sync(); // Should return quickly and not hang

    assert_eq!(
        &[("123", 318), ("123", 318)],
        &*collect_ready::<Vec<_>, _>(&mut result_recv)
    );
}

#[multiplatform_test]
pub fn test_fold_keyed_tick() {
    let (items_send, items_recv) = dfir_rs::util::unbounded_channel::<(u32, Vec<u32>)>();
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<(u32, Vec<u32>)>();

    let mut df = dfir_rs::dfir_syntax! {
        source_stream(items_recv)
            -> fold_keyed::<'tick>(Vec::new, |old: &mut Vec<u32>, mut x: Vec<u32>| old.append(&mut x))
            -> for_each(|v| result_send.send(v).unwrap());
    };
    assert_graphvis_snapshots!(df);

    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());

    items_send.send((0, vec![1, 2])).unwrap();
    items_send.send((0, vec![3, 4])).unwrap();
    items_send.send((1, vec![1])).unwrap();
    items_send.send((1, vec![1, 2])).unwrap();
    df.run_tick_sync();

    assert_eq!(TickInstant::new(2), df.current_tick());
    assert_eq!(
        [(0, vec![1, 2, 3, 4]), (1, vec![1, 1, 2])]
            .into_iter()
            .collect::<BTreeSet<_>>(),
        collect_ready::<BTreeSet<_>, _>(&mut result_recv)
    );

    items_send.send((0, vec![5, 6])).unwrap();
    items_send.send((0, vec![7, 8])).unwrap();
    items_send.send((1, vec![10])).unwrap();
    items_send.send((1, vec![11, 12])).unwrap();
    df.run_tick_sync();

    assert_eq!(TickInstant::new(3), df.current_tick());
    assert_eq!(
        [(0, vec![5, 6, 7, 8]), (1, vec![10, 11, 12])]
            .into_iter()
            .collect::<BTreeSet<_>>(),
        collect_ready::<BTreeSet<_>, _>(&mut result_recv)
    );

    df.run_available_sync(); // Should return quickly and not hang
}

#[multiplatform_test]
pub fn test_fold_keyed_static() {
    let (items_send, items_recv) = dfir_rs::util::unbounded_channel::<(u32, Vec<u32>)>();
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<(u32, Vec<u32>)>();

    let mut df = dfir_rs::dfir_syntax! {
        source_stream(items_recv)
            -> fold_keyed::<'static>(Vec::new, |old: &mut Vec<u32>, mut x: Vec<u32>| old.append(&mut x))
            -> for_each(|v| result_send.send(v).unwrap());
    };
    assert_graphvis_snapshots!(df);

    assert_eq!(TickInstant::new(0), df.current_tick());
    df.run_tick_sync();
    assert_eq!(TickInstant::new(1), df.current_tick());

    items_send.send((0, vec![1, 2])).unwrap();
    items_send.send((0, vec![3, 4])).unwrap();
    items_send.send((1, vec![1])).unwrap();
    items_send.send((1, vec![1, 2])).unwrap();
    df.run_tick_sync();

    assert_eq!(TickInstant::new(2), df.current_tick());
    assert_eq!(
        [(0, vec![1, 2, 3, 4]), (1, vec![1, 1, 2])]
            .into_iter()
            .collect::<BTreeSet<_>>(),
        collect_ready::<BTreeSet<_>, _>(&mut result_recv)
    );

    items_send.send((0, vec![5, 6])).unwrap();
    items_send.send((0, vec![7, 8])).unwrap();
    items_send.send((1, vec![10])).unwrap();
    items_send.send((1, vec![11, 12])).unwrap();
    df.run_tick_sync();

    assert_eq!(TickInstant::new(3), df.current_tick());
    assert_eq!(
        [
            (0, vec![1, 2, 3, 4, 5, 6, 7, 8]),
            (1, vec![1, 1, 2, 10, 11, 12])
        ]
        .into_iter()
        .collect::<BTreeSet<_>>(),
        collect_ready::<BTreeSet<_>, _>(&mut result_recv)
    );

    df.run_available_sync(); // Should return quickly and not hang
}

// TODO(inline): commented out, not yet supported in dfir_syntax! (loop {} blocks)
// #[multiplatform_test]
// pub fn test_fold_keyed_loop_lifetime() {
//     let (result1_send, mut result1_recv) = dfir_rs::util::unbounded_channel::<_>();
//     let (result2_send, mut result2_recv) = dfir_rs::util::unbounded_channel::<_>();
//
//     let mut df = dfir_rs::dfir_syntax! {
//         a = source_iter([
//             ("foo", 0),
//             ("foo", 1),
//             ("foo", 2),
//             ("foo", 3),
//             ("foo", 4),
//             ("bar", 0),
//             ("bar", 1),
//             ("bar", 2),
//             ("bar", 3),
//             ("foo", 5),
//             ("foo", 6),
//             ("foo", 7),
//             ("foo", 8),
//             ("foo", 9),
//             ("bar", 4),
//             ("bar", 5),
//             ("bar", 6),
//             ("bar", 7),
//             ("bar", 8),
//             ("bar", 9),
//         ]);
//
//         loop {
//             b = a -> batch() -> tee();
//             loop {
//                 b -> repeat_n(5)
//                     -> fold_keyed::<'none>(|| 10000, |old: &mut u32, val: u32| *old += val)
//                     -> for_each(|v| result1_send.send(v).unwrap());
//
//                 b -> repeat_n(5)
//                     -> fold_keyed::<'loop>(|| 10000, |old: &mut u32, val: u32| *old += val)
//                     -> for_each(|v| result2_send.send(v).unwrap());
//             };
//         };
//     };
//     df.run_available_sync();
//
//     // `'none` resets each iteration.
//     assert_eq!(
//         BTreeSet::from_iter([
//             ("bar", 10045),
//             ("foo", 10045),
//             ("bar", 10045),
//             ("foo", 10045),
//             ("bar", 10045),
//             ("foo", 10045),
//             ("bar", 10045),
//             ("foo", 10045),
//             ("bar", 10045),
//             ("foo", 10045),
//         ]),
//         collect_ready::<BTreeSet<_>, _>(&mut result1_recv)
//     );
//     // `'loop` accumulates across iterations.
//     assert_eq!(
//         BTreeSet::from_iter([
//             ("bar", 10045),
//             ("foo", 10045),
//             ("bar", 10090),
//             ("foo", 10090),
//             ("bar", 10135),
//             ("foo", 10135),
//             ("bar", 10180),
//             ("foo", 10180),
//             ("bar", 10225),
//             ("foo", 10225),
//         ]),
//         collect_ready::<BTreeSet<_>, _>(&mut result2_recv)
//     );
// }