oxide-framework-core 0.1.0

Core runtime and framework logic for the Oxide web framework.
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
/// Edge tests for lifecycle hooks, controller-level middleware,
/// middleware ordering, and the Month 2 edge-case checklist.

use axum::extract::Request;
use axum::middleware::Next;
use axum::response::Response;
use oxide_framework_core::{controller, ApiResponse, App, AppState};
use serde::{Deserialize, Serialize};
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;

// ---------------------------------------------------------------------------
// Shared types
// ---------------------------------------------------------------------------

#[derive(Serialize, Deserialize, Debug)]
struct Msg {
    text: String,
}

#[derive(Clone)]
struct HitCounter(Arc<AtomicU64>);

// ---------------------------------------------------------------------------
// Controllers
// ---------------------------------------------------------------------------

#[derive(Default)]
struct ApiV1Controller;

#[controller("/api/v1")]
impl ApiV1Controller {
    #[get("/ping")]
    async fn ping(&self) -> ApiResponse<Msg> {
        ApiResponse::ok(Msg { text: "pong-v1".into() })
    }
}

#[derive(Default)]
struct ApiV2Controller;

#[controller("/api/v2")]
impl ApiV2Controller {
    #[get("/ping")]
    async fn ping(&self) -> ApiResponse<Msg> {
        ApiResponse::ok(Msg { text: "pong-v2".into() })
    }
}

#[derive(Default)]
struct GuardedController;

#[controller("/api/guarded")]
impl GuardedController {
    fn middleware(router: axum::Router) -> axum::Router {
        router.layer(axum::middleware::from_fn(require_secret_header))
    }

    #[get("/secret")]
    async fn secret(&self) -> ApiResponse<Msg> {
        ApiResponse::ok(Msg { text: "top-secret".into() })
    }

    #[get("/also-secret")]
    async fn also_secret(&self) -> ApiResponse<Msg> {
        ApiResponse::ok(Msg { text: "classified".into() })
    }
}

async fn require_secret_header(req: Request, next: Next) -> Response {
    if req.headers().get("x-secret").map(|v| v == "open-sesame").unwrap_or(false) {
        next.run(req).await
    } else {
        let body = serde_json::json!({"status": 403, "error": "forbidden"});
        (
            axum::http::StatusCode::FORBIDDEN,
            axum::Json(body),
        )
            .into_response()
    }
}

#[derive(Default)]
struct PanicController;

#[controller("/api/panic")]
impl PanicController {
    #[get("/boom")]
    async fn boom(&self) -> ApiResponse<Msg> {
        panic!("controller panic test");
    }

    #[get("/safe")]
    async fn safe(&self) -> ApiResponse<Msg> {
        ApiResponse::ok(Msg { text: "survived".into() })
    }
}

struct CountingController {
    counter: HitCounter,
}

#[controller("/api/counted")]
impl CountingController {
    fn new(state: &AppState) -> Self {
        Self {
            counter: state.get::<HitCounter>().expect("HitCounter missing").as_ref().clone(),
        }
    }

    #[get("/hit")]
    async fn hit(&self) -> ApiResponse<Msg> {
        let n = self.counter.0.fetch_add(1, Ordering::Relaxed) + 1;
        ApiResponse::ok(Msg { text: format!("{n}") })
    }
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

async fn add_powered_by(mut res: Response) -> Response {
    res.headers_mut().insert("x-powered-by", "Oxide".parse().unwrap());
    res
}

async fn counting_hook(req: Request, next: Next) -> Response {
    if let Some(counter) = req.extensions().get::<AppState>() {
        if let Some(c) = counter.get::<HitCounter>() {
            c.0.fetch_add(1, Ordering::Relaxed);
        }
    }
    next.run(req).await
}

use axum::response::IntoResponse;

// ---------------------------------------------------------------------------
// Tests: Global Hooks
// ---------------------------------------------------------------------------

#[tokio::test]
async fn after_hook_adds_header() {
    let server = App::new()
        .disable_request_logging()
        .after(add_powered_by)
        .get("/", || async { ApiResponse::ok(Msg { text: "hi".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/")).await.unwrap();
    assert_eq!(res.status(), 200);
    assert_eq!(
        res.headers().get("x-powered-by").unwrap().to_str().unwrap(),
        "Oxide"
    );
}

#[tokio::test]
async fn after_hook_applies_to_error_responses() {
    let server = App::new()
        .disable_request_logging()
        .after(add_powered_by)
        .get("/", || async { ApiResponse::ok(Msg { text: "ok".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/nope")).await.unwrap();
    assert_eq!(res.status(), 404);
    assert_eq!(
        res.headers().get("x-powered-by").unwrap().to_str().unwrap(),
        "Oxide"
    );
}

#[tokio::test]
async fn before_hook_can_short_circuit() {
    async fn block_everything(_req: Request, _next: Next) -> Response {
        (
            axum::http::StatusCode::SERVICE_UNAVAILABLE,
            axum::Json(serde_json::json!({"error": "maintenance"})),
        )
            .into_response()
    }

    let server = App::new()
        .disable_request_logging()
        .before(block_everything)
        .get("/", || async { ApiResponse::ok(Msg { text: "should not reach".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/")).await.unwrap();
    assert_eq!(res.status(), 503);
}

#[tokio::test]
async fn before_hook_can_access_state() {
    let counter = HitCounter(Arc::new(AtomicU64::new(0)));
    let server = App::new()
        .disable_request_logging()
        .state(counter.clone())
        .before(counting_hook)
        .get("/", || async { ApiResponse::ok(Msg { text: "ok".into() }) })
        .into_test_server()
        .await;

    for _ in 0..5 {
        reqwest::get(server.url("/")).await.unwrap();
    }

    assert_eq!(counter.0.load(Ordering::Relaxed), 5);
}

// ---------------------------------------------------------------------------
// Tests: Controller-Level Middleware
// ---------------------------------------------------------------------------

#[tokio::test]
async fn controller_middleware_blocks_without_header() {
    let server = App::new()
        .disable_request_logging()
        .controller::<GuardedController>()
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/api/guarded/secret")).await.unwrap();
    assert_eq!(res.status(), 403);
}

#[tokio::test]
async fn controller_middleware_allows_with_header() {
    let client = reqwest::Client::new();
    let server = App::new()
        .disable_request_logging()
        .controller::<GuardedController>()
        .into_test_server()
        .await;

    let res = client
        .get(server.url("/api/guarded/secret"))
        .header("x-secret", "open-sesame")
        .send()
        .await
        .unwrap();

    assert_eq!(res.status(), 200);
    let body: serde_json::Value = res.json().await.unwrap();
    assert_eq!(body["data"]["text"], "top-secret");
}

#[tokio::test]
async fn controller_middleware_applies_to_all_routes() {
    let server = App::new()
        .disable_request_logging()
        .controller::<GuardedController>()
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/api/guarded/also-secret")).await.unwrap();
    assert_eq!(res.status(), 403);
}

#[tokio::test]
async fn controller_middleware_doesnt_leak_to_other_controllers() {
    let server = App::new()
        .disable_request_logging()
        .controller::<GuardedController>()
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    // Guarded controller blocks
    let res = reqwest::get(server.url("/api/guarded/secret")).await.unwrap();
    assert_eq!(res.status(), 403);

    // V1 controller is unaffected
    let res = reqwest::get(server.url("/api/v1/ping")).await.unwrap();
    assert_eq!(res.status(), 200);
}

// ---------------------------------------------------------------------------
// Tests: Nested / Multiple Controllers
// ---------------------------------------------------------------------------

#[tokio::test]
async fn multiple_versioned_controllers() {
    let server = App::new()
        .disable_request_logging()
        .controller::<ApiV1Controller>()
        .controller::<ApiV2Controller>()
        .into_test_server()
        .await;

    let v1: serde_json::Value = reqwest::get(server.url("/api/v1/ping"))
        .await.unwrap().json().await.unwrap();
    let v2: serde_json::Value = reqwest::get(server.url("/api/v2/ping"))
        .await.unwrap().json().await.unwrap();

    assert_eq!(v1["data"]["text"], "pong-v1");
    assert_eq!(v2["data"]["text"], "pong-v2");
}

#[tokio::test]
async fn controllers_and_manual_routes_coexist() {
    let server = App::new()
        .disable_request_logging()
        .get("/health", || async { ApiResponse::ok(Msg { text: "up".into() }) })
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    let health: serde_json::Value = reqwest::get(server.url("/health"))
        .await.unwrap().json().await.unwrap();
    let v1: serde_json::Value = reqwest::get(server.url("/api/v1/ping"))
        .await.unwrap().json().await.unwrap();

    assert_eq!(health["data"]["text"], "up");
    assert_eq!(v1["data"]["text"], "pong-v1");
}

// ---------------------------------------------------------------------------
// Tests: Panic Isolation (handler + hook)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn panic_in_controller_returns_500() {
    let server = App::new()
        .disable_request_logging()
        .controller::<PanicController>()
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/api/panic/boom")).await.unwrap();
    assert_eq!(res.status(), 500);
}

#[tokio::test]
async fn panic_doesnt_kill_other_routes() {
    let server = App::new()
        .disable_request_logging()
        .controller::<PanicController>()
        .into_test_server()
        .await;

    let _ = reqwest::get(server.url("/api/panic/boom")).await.unwrap();
    let res = reqwest::get(server.url("/api/panic/safe")).await.unwrap();
    assert_eq!(res.status(), 200);
    let body: serde_json::Value = res.json().await.unwrap();
    assert_eq!(body["data"]["text"], "survived");
}

#[tokio::test]
async fn panic_in_before_hook_returns_500() {
    async fn panicking_hook(_req: Request, _next: Next) -> Response {
        panic!("hook panic");
    }

    let server = App::new()
        .disable_request_logging()
        .before(panicking_hook)
        .get("/", || async { ApiResponse::ok(Msg { text: "ok".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/")).await.unwrap();
    assert_eq!(res.status(), 500);
}

// ---------------------------------------------------------------------------
// Tests: Hooks + CORS / Rate Limit interaction
// ---------------------------------------------------------------------------

#[tokio::test]
async fn cors_headers_present_with_hooks() {
    let server = App::new()
        .disable_request_logging()
        .cors_permissive()
        .after(add_powered_by)
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let res = client
        .get(server.url("/api/v1/ping"))
        .header("Origin", "http://evil.com")
        .send()
        .await
        .unwrap();

    assert_eq!(res.status(), 200);
    assert!(res.headers().contains_key("access-control-allow-origin"));
    assert_eq!(
        res.headers().get("x-powered-by").unwrap().to_str().unwrap(),
        "Oxide"
    );
}

#[tokio::test]
async fn rate_limit_applies_to_controller_routes() {
    let server = App::new()
        .disable_request_logging()
        .rate_limit(2, 60)
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let r1 = client.get(server.url("/api/v1/ping")).send().await.unwrap();
    let r2 = client.get(server.url("/api/v1/ping")).send().await.unwrap();
    let r3 = client.get(server.url("/api/v1/ping")).send().await.unwrap();

    assert_eq!(r1.status(), 200);
    assert_eq!(r2.status(), 200);
    assert_eq!(r3.status(), 429);
}

#[tokio::test]
async fn cors_headers_on_rate_limited_response() {
    let server = App::new()
        .disable_request_logging()
        .cors_permissive()
        .rate_limit(1, 60)
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let _ = client.get(server.url("/api/v1/ping")).send().await.unwrap();
    let res = client
        .get(server.url("/api/v1/ping"))
        .header("Origin", "http://other.com")
        .send()
        .await
        .unwrap();

    assert_eq!(res.status(), 429);
    assert!(res.headers().contains_key("access-control-allow-origin"));
}

#[tokio::test]
async fn preflight_options_through_controller_routes() {
    let server = App::new()
        .disable_request_logging()
        .cors_permissive()
        .controller::<ApiV1Controller>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let res = client
        .request(reqwest::Method::OPTIONS, server.url("/api/v1/ping"))
        .header("Origin", "http://example.com")
        .header("Access-Control-Request-Method", "GET")
        .send()
        .await
        .unwrap();

    assert!(res.status().is_success());
    assert!(res.headers().contains_key("access-control-allow-origin"));
    assert!(res.headers().contains_key("access-control-allow-methods"));
}

// ---------------------------------------------------------------------------
// Tests: Concurrency
// ---------------------------------------------------------------------------

#[tokio::test]
async fn concurrent_requests_to_multiple_controllers() {
    let server = App::new()
        .disable_request_logging()
        .controller::<ApiV1Controller>()
        .controller::<ApiV2Controller>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let mut handles = Vec::new();

    for i in 0..100 {
        let c = client.clone();
        let version = if i % 2 == 0 { "v1" } else { "v2" };
        let url = server.url(&format!("/api/{version}/ping"));
        handles.push(tokio::spawn(async move {
            let res = c.get(&url).send().await.unwrap();
            assert_eq!(res.status(), 200);
            let body: serde_json::Value = res.json().await.unwrap();
            let expected = format!("pong-{version}");
            assert_eq!(body["data"]["text"], expected);
        }));
    }

    for h in handles {
        h.await.unwrap();
    }
}

#[tokio::test]
async fn concurrent_requests_with_stateful_controller() {
    let counter = HitCounter(Arc::new(AtomicU64::new(0)));
    let server = App::new()
        .disable_request_logging()
        .state(counter.clone())
        .controller::<CountingController>()
        .into_test_server()
        .await;

    let client = reqwest::Client::new();
    let mut handles = Vec::new();

    for _ in 0..50 {
        let c = client.clone();
        let url = server.url("/api/counted/hit");
        handles.push(tokio::spawn(async move {
            c.get(&url).send().await.unwrap();
        }));
    }

    for h in handles {
        h.await.unwrap();
    }

    assert_eq!(counter.0.load(Ordering::Relaxed), 50);
}

// ---------------------------------------------------------------------------
// Tests: Middleware Ordering
// ---------------------------------------------------------------------------

#[tokio::test]
async fn hook_runs_after_state_injection() {
    async fn state_check_hook(req: Request, next: Next) -> Response {
        let has_state = req.extensions().get::<AppState>().is_some();
        let mut resp = next.run(req).await;
        resp.headers_mut().insert(
            "x-state-available",
            if has_state { "yes" } else { "no" }.parse().unwrap(),
        );
        resp
    }

    let server = App::new()
        .disable_request_logging()
        .before(state_check_hook)
        .get("/", || async { ApiResponse::ok(Msg { text: "ok".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/")).await.unwrap();
    assert_eq!(res.status(), 200);
    assert_eq!(
        res.headers().get("x-state-available").unwrap().to_str().unwrap(),
        "yes"
    );
}

#[tokio::test]
async fn timeout_applies_to_hooks() {
    async fn slow_hook(req: Request, next: Next) -> Response {
        tokio::time::sleep(std::time::Duration::from_secs(3)).await;
        next.run(req).await
    }

    let server = App::new()
        .disable_request_logging()
        .request_timeout(1)
        .before(slow_hook)
        .get("/", || async { ApiResponse::ok(Msg { text: "ok".into() }) })
        .into_test_server()
        .await;

    let res = reqwest::get(server.url("/")).await.unwrap();
    assert_eq!(res.status(), 408);
}