16 releases (breaking)
0.13.0 | Sep 27, 2024 |
---|---|
0.12.0 | Apr 29, 2024 |
0.11.0 | Apr 5, 2024 |
0.10.0 | Mar 29, 2024 |
0.4.1 | Mar 13, 2023 |
#374 in HTTP server
22 downloads per month
14KB
198 lines
axum-cloudflare-adapter
An adapter to easily run an Axum server in a Cloudflare worker.
Cloudflare workers perliminary native support for Axum on 0.0.21+
Axum support in workers-rs is enabled by the http feature in worker-rs.
This is possible because both Axum and worker-rs http uses the same http crate.
This adapter can be used as an easy way to migrate from the non http workers-rs version to the http version:
- Do not change your current workers-rs project dependency on the non http version of workers-rs (keep the http flag disabled).
- Add the dependency to this adapter.
- Add a catch all route to the existing router:
.or_else_any_method_async("/*catchall", |_, ctx| async move {
- Inside the catch all route, add an axum router like in the example bellow.
- Start to incrementally migrate the paths one by one, from the old router to the axum router.
- Once finished, drop the dependency on this adapter and enable the "http" flag on workers-rs.
- If you have any issues you can ask for help on #rust-on-workers on discord or open an issue in workers-rs github.
Usage
use worker::*;
use axum::{
response::{Html},
routing::get,
Router as AxumRouter,
extract::State,
};
use axum_cloudflare_adapter::{to_axum_request, to_worker_response, wasm_compat, EnvWrapper};
use tower_service::Service;
use std::ops::Deref;
#[derive(Clone)]
pub struct AxumState {
pub env_wrapper: EnvWrapper,
}
#[wasm_compat]
async fn index(State(state): State<AxumState>) -> Html<&'static str> {
let env: &Env = state.env_wrapper.env.deref();
let worker_rs_version: Var = env.var("WORKERS_RS_VERSION").unwrap();
console_log!("WORKERS_RS_VERSION: {}", worker_rs_version.to_string());
Html("<p>Hello from Axum!</p>")
}
#[event(fetch)]
pub async fn main(req: Request, env: Env, _ctx: worker::Context) -> Result<Response> {
let mut _router: AxumRouter = AxumRouter::new()
.route("/", get(index))
.with_state(AxumState {
env_wrapper: EnvWrapper::new(env),
});
let axum_request = to_axum_request(req).await.unwrap();
let axum_response = _router.call(axum_request).await.unwrap();
let response = to_worker_response(axum_response).await.unwrap();
Ok(response)
}
Running tests
cd adapter && wasm-pack test --firefox --headless
Building
cd adapter && cargo build --target wasm32-unknown-unknown
Example
The /example
directory contains a Cloudflare worker running an Axum sever
Dependencies
~15–25MB
~361K SLoC