debugbundle 1.0.0-alpha.1

Safe, bounded runtime error reporting for Rust, Axum and Actix Web
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

use super::*;
use crate::runtime::{CallbackWorker, CLIENTS};
use std::time::Duration;

fn locked_file() -> (tempfile::NamedTempFile, File, File) {
    let anchor = tempfile::NamedTempFile::new().unwrap();
    let file = anchor.reopen().unwrap();
    let witness = anchor.reopen().unwrap();
    file.try_lock().unwrap();
    assert!(matches!(
        witness.try_lock(),
        Err(std::fs::TryLockError::WouldBlock)
    ));
    (anchor, file, witness)
}

#[tokio::test]
async fn native_persistence_never_runs_on_a_poisoned_or_disconnected_lane() {
    for poisoned in [true, false] {
        let (sender, receiver) = mpsc::sync_channel(1);
        drop(receiver);
        let worker = CallbackWorker {
            sender,
            poisoned: Arc::new(AtomicBool::new(poisoned)),
            capacity: Arc::new(tokio::sync::Notify::new()),
        };
        assert!(matches!(
            worker
                .persist_native(|| panic!("unavailable lane executed native work"))
                .await,
            Err(CallbackFailure::Unavailable)
        ));
    }
}

#[tokio::test]
async fn file_cleanup_on_its_callback_lane_releases_the_lease_before_returning() {
    assert!(crate::runtime::claim(&CLIENTS));
    let slot = Arc::new(ClientSlot);
    let worker = CallbackWorker::new(slot.clone()).unwrap();
    let native = worker.native_cleanup();
    let (_anchor, file, witness) = locked_file();
    let reservation = Arc::new(FileReservation::default());
    reservation.pending.store(true, Ordering::Release);
    let released = reservation.released.notified();
    tokio::pin!(released);
    released.as_mut().enable();
    let pending = reservation.clone();
    worker
        .call(move || {
            assert!(crate::runtime::in_callback());
            native.close(file, pending.clone(), slot);
            assert!(!pending.pending.load(Ordering::Acquire));
            witness.try_lock().unwrap();
        })
        .await
        .unwrap();
    tokio::time::timeout(Duration::from_secs(2), released)
        .await
        .expect("inline native close must notify existing reservation waiters");
}

#[tokio::test]
async fn disconnected_callback_lane_defers_file_close_and_releases_its_client_slot() {
    assert!(crate::runtime::claim(&CLIENTS));
    let slot = Arc::new(ClientSlot);
    let weak_slot = Arc::downgrade(&slot);
    let (sender, receiver) = mpsc::sync_channel(1);
    drop(receiver);
    let native = NativeCleanup {
        sender,
        capacity: Arc::new(tokio::sync::Notify::new()),
    };
    let (_anchor, file, witness) = locked_file();
    let reservation = Arc::new(FileReservation::default());
    reservation.pending.store(true, Ordering::Release);
    let released = reservation.released.notified();
    tokio::pin!(released);
    released.as_mut().enable();
    native.close(file, reservation.clone(), slot);
    tokio::time::timeout(Duration::from_secs(2), released)
        .await
        .expect("disconnected native close must release its reservation");
    assert!(!reservation.pending.load(Ordering::Acquire));
    witness.try_lock().unwrap();
    tokio::time::timeout(Duration::from_secs(2), async {
        while weak_slot.upgrade().is_some() {
            tokio::task::yield_now().await;
        }
    })
    .await
    .expect("fallback close must retain then release the client capacity permit");
}

#[tokio::test]
async fn file_cleanup_waits_for_its_callback_lane_without_joining_stalled_app_cleanup() {
    assert!(crate::runtime::claim(&CLIENTS));
    let slot = Arc::new(ClientSlot);
    let worker = CallbackWorker::new(slot.clone()).unwrap();
    let native = worker.native_cleanup();
    let (global_started, global_ready) = mpsc::channel();
    let (global_release, global_wait) = mpsc::channel();
    crate::runtime::enqueue_cleanup(
        Box::new(move || {
            global_started.send(()).unwrap();
            let _ = global_wait.recv_timeout(Duration::from_secs(3));
        }),
        slot.clone(),
    );
    global_ready.recv_timeout(Duration::from_secs(1)).unwrap();

    let (callback_started, callback_ready) = mpsc::channel();
    let (callback_release, callback_wait) = mpsc::channel();
    worker
        .sender
        .try_send(Box::new(move || {
            callback_started.send(()).unwrap();
            let _ = callback_wait.recv_timeout(Duration::from_secs(3));
        }))
        .ok()
        .unwrap();
    callback_ready.recv_timeout(Duration::from_secs(1)).unwrap();
    // Occupy the one queued callback slot in addition to the executing one.
    worker.sender.try_send(Box::new(|| {})).ok().unwrap();
    let reservation = Arc::new(FileReservation::default());
    reservation.pending.store(true, Ordering::Release);
    native.close(
        tempfile::tempfile().unwrap(),
        reservation.clone(),
        slot.clone(),
    );
    tokio::task::yield_now().await;
    assert!(reservation.pending.load(Ordering::Acquire));
    callback_release.send(()).unwrap();
    tokio::time::timeout(Duration::from_secs(1), async {
        while reservation.pending.load(Ordering::Acquire) {
            let notified = reservation.released.notified();
            tokio::pin!(notified);
            notified.as_mut().enable();
            if !reservation.pending.load(Ordering::Acquire) {
                break;
            }
            notified.await;
        }
    })
    .await
    .expect("native cleanup must not wait for application cleanup");
    global_release.send(()).unwrap();
}