Replace Rocket with Axum. #58
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Axum gives us more control over the flow of requests and allows us to use all the tower ecosystem, which has a lot of nice middlewares. The first immediate benefit we get is better logging using the tracing ecosystem and support for a request ID. Clients can send a `x-request-id` header, which will be included in all log messages printed by the request. If no ID is provided one is generated randomly by the server. The ID, generated or provided by the client, is also included in the response. Most of our business code and endpoints are untouched, since Rocket and Axum use fairly similar paradigms anyway. Most of the changes are in auxilary code, such as testing, metrics and response formatting.
I actually find tracing-mock a little nicer, but it isn't available on crates.io and importing it from Git is a bit of a mess, because it tries to pull tracing and tracing-core from Git too.
plietar
force-pushed
the
rocket-no-more
branch
from
db2e620 to
3414aed
Compare
r-ash
approved these changes
Feb 15, 2024
|
|
||
| pub fn serve(root: &Path) -> anyhow::Result<()> { | ||
| tracing_subscriber::fmt() | ||
| .with_max_level(tracing::Level::TRACE) |
There was a problem hiding this comment.
We should probably make this configurable at some point
There was a problem hiding this comment.
Yeah, I agree. This used to be configurable with Rocket.toml I guess, and we would have to replace it with our own config file, or even simpler with CLI arguments.
richfitz
approved these changes
Feb 19, 2024
| #[catch(500)] | ||
| fn internal_error(_req: &Request) -> Json<FailResponse> { | ||
| Json(FailResponse::from(OutpackError { | ||
| fn internal_error(_err: Box<dyn Any + Send + 'static>) -> Response { |
There was a problem hiding this comment.
curious why this does not need to be async but everything else is?
There was a problem hiding this comment.
That's a good question, and I honestly don't know. Seems to just be a consequence of how the CatchPanicLayer is implemented.
This is the PR that implemented it, but the topic never got brought up: tower-rs/tower-http#214
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Axum gives us more control over the flow of requests and allows us to use all the tower ecosystem, which has a lot of nice middlewares.
The first immediate benefit we get is better logging using the tracing ecosystem and support for a request ID. Clients can send a
x-request-idheader, which will be included in all log messages printed by the request. If no ID is provided one is generated randomly by the server. The ID, generated or provided by the client, is also included in the response.Most of our business code and endpoints are untouched, since Rocket and Axum use fairly similar paradigms anyway. Most of the changes are in auxilary code, such as testing, metrics and response formatting.