rocket 0.5.1

Web framework with a focus on usability, security, extensibility, and speed.
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

#[macro_use] extern crate rocket;

use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};

use rocket::fairing::AdHoc;

// Want to test:
//
//   * stalled connection + sleep in shutdown -> conn closed
//   * stalled shutdown fairing stalls shutdown but not > grace + mercy
//     - sleep < grace + mercy
//     - sleep > grace + mercy

#[derive(Default)]
struct Flags {
    liftoff: AtomicBool,
    shutdown: AtomicUsize
}

#[test]
fn shutdown_fairing_runs() {
    use rocket::local::blocking::Client;

    let rocket = rocket::build()
        .manage(Flags::default())
        .attach(AdHoc::on_liftoff("Liftoff Flag", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.liftoff.store(true, Ordering::SeqCst);
        })))
        .attach(AdHoc::on_shutdown("Shutdown Flag", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.shutdown.fetch_add(1, Ordering::SeqCst);
        })));

    let client = Client::debug(rocket).unwrap();
    let flags = client.rocket().state::<Flags>().unwrap();
    assert!(flags.liftoff.load(Ordering::SeqCst));
    assert_eq!(0, flags.shutdown.load(Ordering::SeqCst));

    let rocket = client.terminate();
    let flags = rocket.state::<Flags>().unwrap();
    assert_eq!(1, flags.shutdown.load(Ordering::SeqCst));
}

#[async_test]
async fn async_shutdown_fairing_runs() {
    use rocket::local::asynchronous::Client;

    let rocket = rocket::build()
        .manage(Flags::default())
        .attach(AdHoc::on_liftoff("Liftoff Flag", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.liftoff.store(true, Ordering::SeqCst);
        })))
        .attach(AdHoc::on_shutdown("Shutdown Flag", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.shutdown.fetch_add(1, Ordering::SeqCst);
        })));

    let client = Client::debug(rocket).await.unwrap();
    let flags = client.rocket().state::<Flags>().unwrap();
    assert!(flags.liftoff.load(Ordering::SeqCst));
    assert_eq!(0, flags.shutdown.load(Ordering::SeqCst));

    let rocket = client.terminate().await;
    let flags = rocket.state::<Flags>().unwrap();
    assert_eq!(1, flags.shutdown.load(Ordering::SeqCst));
}

#[async_test]
async fn multiple_shutdown_fairing_runs() {
    use rocket::local::asynchronous::Client;

    let rocket = rocket::build()
        .manage(Flags::default())
        .attach(AdHoc::on_shutdown("Shutdown Flag 1", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.shutdown.fetch_add(1, Ordering::SeqCst);
        })))
        .attach(AdHoc::on_shutdown("Shutdown Flag 2", |rocket| Box::pin(async move {
            let flags = rocket.state::<Flags>().unwrap();
            flags.shutdown.fetch_add(1, Ordering::SeqCst);
        })));

    let client = Client::debug(rocket).await.unwrap();
    let flags = client.rocket().state::<Flags>().unwrap();
    assert_eq!(0, flags.shutdown.load(Ordering::SeqCst));

    let rocket = client.terminate().await;
    let flags = rocket.state::<Flags>().unwrap();
    assert_eq!(2, flags.shutdown.load(Ordering::SeqCst));
}

#[async_test]
async fn async_slow_shutdown_doesnt_elongate_grace() {
    use rocket::local::asynchronous::Client;

    let mut config = rocket::Config::debug_default();
    config.shutdown.grace = 1;
    config.shutdown.mercy = 1;

    let rocket = rocket::build()
        .manage(Flags::default())
        .configure(config)
        .attach(AdHoc::on_shutdown("Slow Shutdown", |rocket| Box::pin(async move {
            tokio::time::sleep(std::time::Duration::from_secs(4)).await;
            let flags = rocket.state::<Flags>().unwrap();
            flags.shutdown.fetch_add(1, Ordering::SeqCst);
        })));

    let client = Client::debug(rocket).await.unwrap();
    let flags = client.rocket().state::<Flags>().unwrap();
    assert_eq!(0, flags.shutdown.load(Ordering::SeqCst));

    let start = std::time::Instant::now();
    let rocket = client.terminate().await;
    let elapsed = start.elapsed();

    let flags = rocket.state::<Flags>().unwrap();
    assert!(elapsed > std::time::Duration::from_secs(2));
    assert!(elapsed < std::time::Duration::from_secs(5));
    assert_eq!(1, flags.shutdown.load(Ordering::SeqCst));
}

#[test]
fn background_tasks_dont_prevent_terminate() {
    use rocket::local::blocking::Client;

    #[get("/")]
    fn index() {
        tokio::task::spawn(async {
            tokio::time::sleep(std::time::Duration::from_secs(10)).await;
        });

        tokio::task::spawn_blocking(|| {
            std::thread::sleep(std::time::Duration::from_secs(10));
        });
    }

    let mut config = rocket::Config::debug_default();
    config.shutdown.grace = 1;
    config.shutdown.mercy = 1;

    let rocket = rocket::build().configure(config).mount("/", routes![index]);

    let client = Client::debug(rocket).unwrap();
    let response = client.get("/").dispatch();
    assert!(response.status().class().is_success());
    drop(response);
    let _ = client.terminate();
}