timeout-tracing 0.1.0

Returns stack and span trace when the future hits a timeout
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

use std::time::Duration;

use pin_project_lite::pin_project;
use serial_test::serial;
use tokio::time::{Sleep, sleep};
use tracing::instrument;

use crate::{
    TimeoutElapsed,
    tests::{insta_trace_filters, run_with_tracing},
};

#[tokio::test]
#[serial]
async fn with_custom_future() {
    let result = run_with_tracing(Duration::from_millis(100), do_sleep()).await;

    assert!(matches!(result, Err(TimeoutElapsed { .. })));
    assert_eq!(result.as_ref().err().unwrap().active_traces.len(), 1);
    assert!(
        result
            .as_ref()
            .err()
            .unwrap()
            .active_traces
            .iter()
            .any(|e| e.stack_trace.to_string().contains("do_sleep"))
    );
    insta::with_settings!({
        filters => insta_trace_filters()
    }, {
        insta::assert_debug_snapshot!(result);
    });
}

#[instrument]
async fn do_sleep() {
    CustomFut::new(Duration::from_secs(1)).await;
}

pin_project! {
    struct CustomFut {
        #[pin]
        inner: Sleep,
    }
}

impl CustomFut {
    fn new(duration: Duration) -> Self {
        Self {
            inner: sleep(duration),
        }
    }
}

impl Future for CustomFut {
    type Output = ();

    fn poll(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Self::Output> {
        // Retaining waker is an indicator of await
        // This tests that dropping a waker erases the corresponding trace
        _ = cx.waker().clone();
        self.project().inner.poll(cx)
    }
}