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

use std::error::Error;

use dfir_rs::scheduled::ticks::{TickDuration, TickInstant};
use dfir_rs::{assert_graphvis_snapshots, dfir_syntax, rassert_eq};
use multiplatform_test::multiplatform_test;
use tokio::time::timeout;
use web_time::Duration;

// Note: inline codegen does not have strata; the DAG topological sort
// replaces/is analogous to stratification. next_stratum() is removed below.

#[multiplatform_test(test, wasm, env_tracing)]
pub fn test_stratum_loop() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<TickInstant>();

    let mut df = dfir_syntax! {
        source_iter([TickInstant::new(0)]) -> union_tee;
        union_tee = union() -> tee();
        union_tee -> map(|n| n + TickDuration::SINGLE_TICK) -> filter(|&n| n < TickInstant::new(10)) -> defer_tick() -> union_tee;
        union_tee -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_graphvis_snapshots!(df);
    df.run_available_sync();

    assert_eq!(
        &[
            TickInstant::new(0),
            TickInstant::new(1),
            TickInstant::new(2),
            TickInstant::new(3),
            TickInstant::new(4),
            TickInstant::new(5),
            TickInstant::new(6),
            TickInstant::new(7),
            TickInstant::new(8),
            TickInstant::new(9)
        ],
        &*dfir_rs::util::collect_ready::<Vec<_>, _>(&mut out_recv)
    );
    assert_eq!(TickInstant::new(10), df.current_tick());
}

#[multiplatform_test(test, wasm, env_tracing)]
pub fn test_tick_loop() {
    let (out_send, mut out_recv) = dfir_rs::util::unbounded_channel::<TickInstant>();

    let mut df = dfir_syntax! {
        source_iter([TickInstant::new(0)]) -> union_tee;
        union_tee = union() -> tee();
        union_tee -> map(|n| n + TickDuration::SINGLE_TICK) -> filter(|&n| n < TickInstant::new(10)) -> defer_tick() -> union_tee;
        union_tee -> for_each(|v| out_send.send(v).unwrap());
    };
    assert_graphvis_snapshots!(df);
    df.run_available_sync();

    assert_eq!(
        &[
            TickInstant::new(0),
            TickInstant::new(1),
            TickInstant::new(2),
            TickInstant::new(3),
            TickInstant::new(4),
            TickInstant::new(5),
            TickInstant::new(6),
            TickInstant::new(7),
            TickInstant::new(8),
            TickInstant::new(9)
        ],
        &*dfir_rs::util::collect_ready::<Vec<_>, _>(&mut out_recv)
    );
    assert_eq!(TickInstant::new(10), df.current_tick());
}

#[multiplatform_test(dfir, env_tracing)]
async fn test_persist_stratum_run_available() -> Result<(), Box<dyn Error>> {
    let (out_send, out_recv) = dfir_rs::util::unbounded_channel();

    let mut df = dfir_syntax! {
        a = source_iter([0])
            -> persist::<'static>()
            -> for_each(|x| out_send.send(x).unwrap());
    };
    assert_graphvis_snapshots!(df);
    df.run_available().await;

    let seen: Vec<_> = dfir_rs::util::collect_ready_async(out_recv).await;
    rassert_eq!(
        &[0],
        &*seen,
        "Only one tick should have run, actually ran {}",
        seen.len()
    )?;

    Ok(())
}

#[multiplatform_test(dfir, env_tracing)]
async fn test_persist_stratum_run_async() -> Result<(), Box<dyn Error>> {
    let (out_send, out_recv) = dfir_rs::util::unbounded_channel();

    let mut df = dfir_syntax! {
        source_iter([0])
            -> persist::<'static>()
            -> for_each(|x| out_send.send(x).unwrap());
    };
    assert_graphvis_snapshots!(df);

    timeout(Duration::from_millis(200), df.run())
        .await
        .expect_err("Expected time out");

    let seen: Vec<_> = dfir_rs::util::collect_ready_async(out_recv).await;
    rassert_eq!(
        &[0],
        &*seen,
        "Only one tick should have run, actually ran {}",
        seen.len()
    )?;

    Ok(())
}

// TODO(inline): intra-tick cycle (my_union_tee -> filter -> my_union_tee), not supported
// #[multiplatform_test(test, wasm, env_tracing)]
// pub fn test_issue_800_1050_persist() {
//     let mut df = dfir_syntax! {
//         in1 = source_iter(0..10) -> map(|i| (i, i));
//         in1 -> persist::<'static>() -> my_union_tee;
//
//         my_union_tee = union() -> tee();
//         my_union_tee -> filter(|_| false) -> my_union_tee;
//         my_union_tee -> for_each(|x| println!("A {} {} {:?}", context.current_tick(), context.current_stratum(), x));
//     };
//     assert_graphvis_snapshots!(df);
//     df.run_available_sync();
// }

// TODO(inline): intra-tick cycle (my_union_tee -> filter -> my_union_tee), not supported
// #[multiplatform_test(test, wasm, env_tracing)]
// pub fn test_issue_800_1050_fold_keyed() {
//     let mut df = dfir_syntax! {
//         in1 = source_iter(0..10) -> map(|i| (i, i));
//         in1 -> fold_keyed::<'static>(Vec::new, Vec::push) -> my_union_tee;
//
//         my_union_tee = union() -> tee();
//         my_union_tee -> filter(|_| false) -> my_union_tee;
//         my_union_tee -> for_each(|x| println!("A {} {} {:?}", context.current_tick(), context.current_stratum(), x));
//     };
//     assert_graphvis_snapshots!(df);
//     df.run_available_sync();
// }

// TODO(inline): intra-tick cycle (my_union_tee -> filter -> my_union_tee), not supported
// #[multiplatform_test(test, wasm, env_tracing)]
// pub fn test_issue_800_1050_reduce_keyed() {
//     let mut df = dfir_syntax! {
//         in1 = source_iter(0..10) -> map(|i| (i, i));
//         in1 -> reduce_keyed::<'static>(std::ops::AddAssign::add_assign) -> my_union_tee;
//
//         my_union_tee = union() -> tee();
//         my_union_tee -> filter(|_| false) -> my_union_tee;
//         my_union_tee -> for_each(|x| println!("A {} {} {:?}", context.current_tick(), context.current_stratum(), x));
//     };
//     assert_graphvis_snapshots!(df);
//     df.run_available_sync();
// }

#[multiplatform_test(dfir, env_tracing)]
async fn test_nospin_issue_961() {
    let mut df = dfir_syntax! {
        source_iter([1])
            -> persist::<'static>()
            -> defer_tick_lazy()
            -> null();
    };
    assert_graphvis_snapshots!(df);

    timeout(Duration::from_millis(100), df.run_available())
        .await
        .expect("Should not spin.");
}

// TODO(inline): intra-tick cycle (double -> items), not supported
// #[multiplatform_test(dfir, env_tracing)]
// async fn test_nospin_issue_961_complicated() {
//     let mut df = dfir_syntax! {
//         source_iter([1]) -> items;
//         items = union();
//
//         double = items
//             -> persist::<'static>()
//             -> fold(|| 0, |accum, x| *accum += x)
//             -> defer_tick_lazy()
//             -> filter(|_| false)
//             -> tee();
//
//         double -> null();
//
//         double -> items;
//     };
//     assert_graphvis_snapshots!(df);
//
//     timeout(Duration::from_millis(100), df.run_available())
//         .await
//         .expect("Should not spin.");
// }