2018-06-28 15:55:15 +00:00
|
|
|
#[macro_use] extern crate rocket;
|
2018-01-12 16:34:53 +00:00
|
|
|
|
|
|
|
use std::sync::atomic::{AtomicUsize, Ordering};
|
|
|
|
|
|
|
|
use rocket::State;
|
|
|
|
use rocket::fairing::AdHoc;
|
|
|
|
use rocket::http::Method;
|
|
|
|
|
|
|
|
#[derive(Default)]
|
|
|
|
struct Counter {
|
|
|
|
attach: AtomicUsize,
|
|
|
|
get: AtomicUsize,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[get("/")]
|
2019-06-13 01:48:02 +00:00
|
|
|
fn index(counter: State<'_, Counter>) -> String {
|
2018-01-12 16:34:53 +00:00
|
|
|
let attaches = counter.attach.load(Ordering::Relaxed);
|
|
|
|
let gets = counter.get.load(Ordering::Acquire);
|
|
|
|
format!("{}, {}", attaches, gets)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn rocket() -> rocket::Rocket {
|
|
|
|
rocket::ignite()
|
|
|
|
.mount("/", routes![index])
|
Remove 'attach' fairings. Add 'liftoff' fairings.
Launch fairings are now fallible and take the place of attach fairings,
but they are only run, as the name implies, at launch time.
This is is a fundamental shift from eager execution of set-up routines,
including the now defunct attach fairings, to lazy execution,
precipitated by the transition to `async`. The previous functionality,
while simple, caused grave issues:
1. A instance of 'Rocket' with async attach fairings requires an async
runtime to be constructed.
2. The instance is accessible in non-async contexts.
3. The async attach fairings have no runtime in which to be run.
Here's an example:
```rust
let rocket = rocket::ignite()
.attach(AttachFairing::from(|rocket| async {
Ok(rocket.manage(load_from_network::<T>().await))
}));
let state = rocket.state::<T>();
```
This had no real meaning previously yet was accepted by running the
attach fairing future in an isolated runtime. In isolation, this causes
no issue, but when attach fairing futures share reactor state with other
futures in Rocket, panics ensue.
The new Rocket application lifecycle is this:
* Build - A Rocket instance is constructed. No fairings are run.
* Ignition - All launch fairings are run.
* Liftoff - If all launch fairings succeeded, the server is started.
New 'liftoff' fairings are run in this third phase.
2021-04-01 19:32:52 +00:00
|
|
|
.attach(AdHoc::on_launch("Outer", |rocket| async {
|
2018-01-12 16:34:53 +00:00
|
|
|
let counter = Counter::default();
|
|
|
|
counter.attach.fetch_add(1, Ordering::Relaxed);
|
|
|
|
let rocket = rocket.manage(counter)
|
2018-08-14 16:14:06 +00:00
|
|
|
.attach(AdHoc::on_request("Inner", |req, _| {
|
2019-12-11 00:34:32 +00:00
|
|
|
Box::pin(async move {
|
|
|
|
if req.method() == Method::Get {
|
2020-01-31 09:34:15 +00:00
|
|
|
let counter = req.guard::<State<'_, Counter>>()
|
|
|
|
.await.unwrap();
|
2019-12-11 00:34:32 +00:00
|
|
|
counter.get.fetch_add(1, Ordering::Release);
|
|
|
|
}
|
|
|
|
})
|
2018-01-12 16:34:53 +00:00
|
|
|
}));
|
|
|
|
|
|
|
|
Ok(rocket)
|
|
|
|
}))
|
|
|
|
}
|
|
|
|
|
|
|
|
mod nested_fairing_attaches_tests {
|
|
|
|
use super::*;
|
2020-07-05 18:35:36 +00:00
|
|
|
use rocket::local::blocking::Client;
|
2018-01-12 16:34:53 +00:00
|
|
|
|
2020-07-05 18:35:36 +00:00
|
|
|
#[test]
|
|
|
|
fn test_counts() {
|
Test 'secret_key' validation, now on pre-launch.
Prior to this commit, it was not possible to test Rocket crates in
production mode without setting a global secret key or bypassing secret
key checking - the testing script did the latter. The consequence is
that it became impossible to test secret key related failures because
the tests passed regardless.
This commit undoes this. As a consequence, all tests are now aware of
the difference between debug and release configurations, the latter of
which validates 'secret_key' by default. New 'Client::debug()' and
'Client::debug_with()' simplify creating an instance of 'Client' with
configuration in debug mode to avoid undesired test failures.
The summary of changes in this commit are:
* Config 'secret_key' success and failure are now tested.
* 'secret_key' validation was moved to pre-launch from 'Config:from()'.
* 'Config::from()' only extracts the config.
* Added 'Config::try_from()' for non-panicking extraction.
* 'Config' now knows the profile it was extracted from.
* The 'Config' provider sets a profile of 'Config.profile'.
* 'Rocket', 'Client', 'Fairings', implement 'Debug'.
* 'fairing::Info' implements 'Copy', 'Clone'.
* 'Fairings' keeps track of, logs attach fairings.
* 'Rocket::reconfigure()' was added to allow modifying a config.
Internally, the testing script was refactored to properly test the
codebase with the new changes. In particular, it no longer sets a rustc
'cfg' to avoid secret-key checking.
Resolves #1543.
Fixes #1564.
2021-03-09 08:07:43 +00:00
|
|
|
let client = Client::debug(rocket()).unwrap();
|
2020-07-05 18:35:36 +00:00
|
|
|
let response = client.get("/").dispatch();
|
|
|
|
assert_eq!(response.into_string(), Some("1, 1".into()));
|
2018-01-12 16:34:53 +00:00
|
|
|
|
2020-07-05 18:35:36 +00:00
|
|
|
let response = client.get("/").dispatch();
|
|
|
|
assert_eq!(response.into_string(), Some("1, 2".into()));
|
2018-01-12 16:34:53 +00:00
|
|
|
|
2020-07-05 18:35:36 +00:00
|
|
|
client.get("/").dispatch();
|
|
|
|
client.get("/").dispatch();
|
|
|
|
let response = client.get("/").dispatch();
|
|
|
|
assert_eq!(response.into_string(), Some("1, 5".into()));
|
2018-01-12 16:34:53 +00:00
|
|
|
}
|
|
|
|
}
|