typeway 0.1.0

Type-level web framework for Rust: your API is a type
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

//! Benchmarks for typeway routing, handler dispatch, and comparison with axum.
//!
//! Three rows are reported per scenario, all driven through a Tower
//! `Service::call`:
//!
//! - `axum/...`: `axum::Router` directly. Baseline.
//! - `typeway/...`: `Router` wrapped in a Tower service that takes
//!   `Request<axum::body::Body>` (the same wire shape axum's bench uses).
//!   This is the apples-to-apples comparison: same Service trait dispatch,
//!   same body type, same matchit matcher under the hood.
//! - `typeway_in_axum/...`: typeway's router nested inside `axum::Router` via
//!   `into_axum_router()` (which uses `fallback_service`). Every request walks
//!   axum's outer router AND typeway's inner router, so this is strictly more
//!   work than either (and shows the cost of nesting).

use std::convert::Infallible;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};

use criterion::{black_box, criterion_group, criterion_main, Criterion};
use http::Request;
use http_body_util::BodyExt;
use tower::ServiceExt;
use tower_service::Service;

use typeway::prelude::*;
use typeway_server::BoxBody;

// Tower-service wrapper around `Arc<Router>` that takes `axum::body::Body`,
// mirroring axum's per-request shape. This is what makes the `typeway/...`
// row directly comparable to the `axum/...` row.
#[derive(Clone)]
struct TypewayService {
    router: Arc<Router>,
}

impl Service<Request<axum::body::Body>> for TypewayService {
    type Response = http::Response<BoxBody>;
    type Error = Infallible;
    type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

    fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: Request<axum::body::Body>) -> Self::Future {
        let router = self.router.clone();
        Box::pin(async move {
            let (parts, body) = req.into_parts();
            let body_bytes = body
                .collect()
                .await
                .map(|c| c.to_bytes())
                .unwrap_or_default();
            Ok(router.route_with_bytes(parts, body_bytes).await)
        })
    }
}

// ---------------------------------------------------------------------------
// Typeway setup
// ---------------------------------------------------------------------------

typeway_path!(type HelloPath = "hello");
typeway_path!(type UsersPath = "users");
typeway_path!(type UserByIdPath = "users" / u32);
typeway_path!(type UserPostsPath = "users" / u32 / "posts" / u32);
typeway_path!(type P5 = "a" / u32 / "b" / u32 / "c");
typeway_path!(type P6 = "x" / "y" / "z");
typeway_path!(type P7 = "api" / "v1" / "items" / u32);
typeway_path!(type P8 = "api" / "v1" / "items");
typeway_path!(type P9 = "api" / "v2" / "things" / u32);
typeway_path!(type P10 = "health");

async fn noop() -> &'static str {
    "ok"
}
async fn noop_path(_p: Path<UserByIdPath>) -> &'static str {
    "ok"
}
async fn noop_path2(_p: Path<UserPostsPath>) -> &'static str {
    "ok"
}
async fn noop_p5(_p: Path<P5>) -> &'static str {
    "ok"
}
async fn noop_p7(_p: Path<P7>) -> &'static str {
    "ok"
}
async fn noop_p9(_p: Path<P9>) -> &'static str {
    "ok"
}

// 1-route API (reserved for future single-route benchmarks)
#[allow(dead_code)]
type Api1 = (GetEndpoint<HelloPath, String>,);

// 10-route API
type Api10 = (
    GetEndpoint<HelloPath, String>,
    GetEndpoint<UsersPath, String>,
    GetEndpoint<UserByIdPath, String>,
    GetEndpoint<UserPostsPath, String>,
    GetEndpoint<P5, String>,
    GetEndpoint<P6, String>,
    GetEndpoint<P7, String>,
    GetEndpoint<P8, String>,
    GetEndpoint<P9, String>,
    GetEndpoint<P10, String>,
);

fn make_typeway_server_10() -> Server<Api10> {
    Server::<Api10>::new((
        bind::<_, _, _>(noop),
        bind::<_, _, _>(noop),
        bind::<_, _, _>(noop_path),
        bind::<_, _, _>(noop_path2),
        bind::<_, _, _>(noop_p5),
        bind::<_, _, _>(noop),
        bind::<_, _, _>(noop_p7),
        bind::<_, _, _>(noop),
        bind::<_, _, _>(noop_p9),
        bind::<_, _, _>(noop),
    ))
}

fn make_typeway_tower_10() -> TypewayService {
    TypewayService {
        router: Arc::new(make_typeway_server_10().into_router()),
    }
}

fn make_typeway_in_axum_10() -> axum::Router {
    make_typeway_server_10().into_axum_router()
}

// ---------------------------------------------------------------------------
// Axum setup
// ---------------------------------------------------------------------------

fn make_axum_10() -> axum::Router {
    axum::Router::new()
        .route("/hello", axum::routing::get(|| async { "ok" }))
        .route("/users", axum::routing::get(|| async { "ok" }))
        .route("/users/{id}", axum::routing::get(|| async { "ok" }))
        .route(
            "/users/{id}/posts/{post_id}",
            axum::routing::get(|| async { "ok" }),
        )
        .route("/a/{x}/b/{y}/c", axum::routing::get(|| async { "ok" }))
        .route("/x/y/z", axum::routing::get(|| async { "ok" }))
        .route("/api/v1/items/{id}", axum::routing::get(|| async { "ok" }))
        .route("/api/v1/items", axum::routing::get(|| async { "ok" }))
        .route("/api/v2/things/{id}", axum::routing::get(|| async { "ok" }))
        .route("/health", axum::routing::get(|| async { "ok" }))
}

fn axum_get(path: &str) -> Request<axum::body::Body> {
    Request::builder()
        .method("GET")
        .uri(path)
        .body(axum::body::Body::empty())
        .unwrap()
}

// ---------------------------------------------------------------------------
// Benchmarks
// ---------------------------------------------------------------------------

fn bench_route_matching(c: &mut Criterion) {
    let rt = tokio::runtime::Runtime::new().unwrap();

    let mut group = c.benchmark_group("route_matching");

    // --- Axum 10 routes ---

    let axum10 = make_axum_10();

    group.bench_function("axum/10_routes/first", |b| {
        b.to_async(&rt).iter(|| {
            let svc = axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/hello")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("axum/10_routes/last", |b| {
        b.to_async(&rt).iter(|| {
            let svc = axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/health")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("axum/10_routes/capture", |b| {
        b.to_async(&rt).iter(|| {
            let svc = axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/users/42")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("axum/10_routes/miss", |b| {
        b.to_async(&rt).iter(|| {
            let svc = axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/nonexistent")).await.unwrap();
                black_box(resp);
            }
        });
    });

    // --- Typeway 10 routes (bare Tower service, apples-to-apples with axum) ---

    let typeway10 = make_typeway_tower_10();

    group.bench_function("typeway/10_routes/first", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/hello")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway/10_routes/last", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/health")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway/10_routes/capture", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/users/42")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway/10_routes/miss", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/nonexistent")).await.unwrap();
                black_box(resp);
            }
        });
    });

    // --- Typeway 10 routes nested inside axum::Router via into_axum_router ---
    //
    // Strictly more work: every request walks axum's outer router AND
    // typeway's inner router. Useful as the upper bound of nesting cost.

    let typeway_in_axum10 = make_typeway_in_axum_10();

    group.bench_function("typeway_in_axum/10_routes/first", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway_in_axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/hello")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway_in_axum/10_routes/last", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway_in_axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/health")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway_in_axum/10_routes/capture", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway_in_axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/users/42")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.bench_function("typeway_in_axum/10_routes/miss", |b| {
        b.to_async(&rt).iter(|| {
            let svc = typeway_in_axum10.clone();
            async move {
                let resp = svc.oneshot(axum_get("/nonexistent")).await.unwrap();
                black_box(resp);
            }
        });
    });

    group.finish();
}

criterion_group!(benches, bench_route_matching);
criterion_main!(benches);