rust-webx 0.7.0

rust-webx — A Rust WebApi framework inspired by ASP.NET Core
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
//! End-to-end tests for the request binding layer.
//!
//! Covers the sources that used to be unreachable or silently dropped:
//! non-string query values, repeated query keys, headers, claims, and mixed
//! path + body + header models — plus the 400 shape that reports every field
//! failure at once.

use std::net::TcpListener;

use jsonwebtoken::{EncodingKey, Header};
use serde::{Deserialize, Serialize};
use webx::*;

const TEST_SECRET: &[u8] = b"binding-test-secret";

// ---------------------------------------------------------------------------
// Query binding
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
struct QueryRequest {
    q: String,
    page: u32,
    size: Option<u32>,
    ids: Vec<u32>,
}

#[get("/bind/query")]
impl IRequest<serde_json::Value> for QueryRequest {}

#[derive(Default)]
struct QueryHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<QueryRequest, serde_json::Value> for QueryHandler {
    async fn handle(&mut self, req: QueryRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({
            "q": req.q,
            "page": req.page,
            "size": req.size,
            "ids": req.ids,
        }))
    }
}

// ---------------------------------------------------------------------------
// Header binding
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
struct HeaderRequest {
    #[frompath]
    id: String,
    #[fromheader("X-Tenant")]
    tenant: String,
    #[fromheader]
    x_trace_id: Option<String>,
    /// A repeated header binds as a list, comma-separated.
    #[fromheader("X-Scopes")]
    scopes: Vec<String>,
}

#[get("/bind/header/{id}")]
impl IRequest<serde_json::Value> for HeaderRequest {}

#[derive(Default)]
struct HeaderHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<HeaderRequest, serde_json::Value> for HeaderHandler {
    async fn handle(&mut self, req: HeaderRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({
            "id": req.id,
            "tenant": req.tenant,
            "trace": req.x_trace_id,
            "scopes": req.scopes,
        }))
    }
}

// ---------------------------------------------------------------------------
// Claim binding
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
struct ClaimRequest {
    #[fromclaim("sub")]
    user: String,
    #[fromclaim("roles")]
    roles: Vec<String>,
    #[fromclaim("tenant_id")]
    tenant: Option<String>,
}

#[get("/bind/claim")]
impl IRequest<serde_json::Value> for ClaimRequest {}

#[derive(Default)]
struct ClaimHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<ClaimRequest, serde_json::Value> for ClaimHandler {
    async fn handle(&mut self, req: ClaimRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({
            "user": req.user,
            "roles": req.roles,
            "tenant": req.tenant,
        }))
    }
}

// ---------------------------------------------------------------------------
// Mixed path + body + header
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
struct MixedRequest {
    #[frompath]
    id: String,
    name: String,
    #[fromheader("X-Actor")]
    actor: String,
}

#[put("/bind/mixed/{id}")]
impl IRequest<serde_json::Value> for MixedRequest {}

#[derive(Default)]
struct MixedHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<MixedRequest, serde_json::Value> for MixedHandler {
    async fn handle(&mut self, req: MixedRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({
            "id": req.id,
            "name": req.name,
            "actor": req.actor,
        }))
    }
}

// ---------------------------------------------------------------------------
// `#[request(queryall)]`
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
#[request(queryall)]
struct QueryAllRequest {
    term: String,
    limit: u32,
}

#[post("/bind/query-all")]
impl IRequest<serde_json::Value> for QueryAllRequest {}

#[derive(Default)]
struct QueryAllHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<QueryAllRequest, serde_json::Value> for QueryAllHandler {
    async fn handle(&mut self, req: QueryAllRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({ "term": req.term, "limit": req.limit }))
    }
}

// ---------------------------------------------------------------------------
// Method-dependent priority for unmarked fields
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize, WebxRequestMeta)]
struct PriorityGetRequest {
    key: String,
}

#[get("/bind/priority/{key}")]
impl IRequest<serde_json::Value> for PriorityGetRequest {}

#[derive(Default)]
struct PriorityGetHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<PriorityGetRequest, serde_json::Value> for PriorityGetHandler {
    async fn handle(&mut self, req: PriorityGetRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({ "key": req.key }))
    }
}

#[derive(Default, Deserialize, WebxRequestMeta)]
struct PriorityWriteRequest {
    #[frompath]
    id: String,
    key: String,
}

#[post("/bind/priority-body/{id}")]
impl IRequest<serde_json::Value> for PriorityWriteRequest {}

#[derive(Default)]
struct PriorityWriteHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<PriorityWriteRequest, serde_json::Value> for PriorityWriteHandler {
    async fn handle(&mut self, req: PriorityWriteRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({ "id": req.id, "key": req.key }))
    }
}

// ---------------------------------------------------------------------------
// Composite (complex) body fields
// ---------------------------------------------------------------------------

#[derive(Default, Deserialize)]
struct Address {
    city: String,
    zip: String,
}

#[derive(Default, Deserialize)]
struct LineItem {
    sku: String,
    qty: u32,
}

#[derive(Default, Deserialize)]
struct Meta {
    source: String,
}

#[derive(Default, Deserialize, WebxRequestMeta)]
struct ComplexRequest {
    #[frompath]
    id: String,
    address: Address,
    items: Vec<LineItem>,
    meta: Option<Meta>,
    note: Option<String>,
}

#[put("/bind/complex/{id}")]
impl IRequest<serde_json::Value> for ComplexRequest {}

#[derive(Default)]
struct ComplexHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<ComplexRequest, serde_json::Value> for ComplexHandler {
    async fn handle(&mut self, req: ComplexRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({
            "id": req.id,
            "city": req.address.city,
            "zip": req.address.zip,
            "items": req.items.iter().map(|i| i.sku.clone()).collect::<Vec<_>>(),
            "qty_total": req.items.iter().map(|i| i.qty).sum::<u32>(),
            "meta": req.meta.map(|m| m.source),
            "note": req.note,
        }))
    }
}

// ---------------------------------------------------------------------------
// Explicit custom scalars (`FromStr` types)
// ---------------------------------------------------------------------------

#[derive(Debug)]
struct Slug(String);

impl std::str::FromStr for Slug {
    type Err = std::convert::Infallible;

    fn from_str(value: &str) -> std::result::Result<Self, Self::Err> {
        Ok(Slug(value.to_ascii_lowercase()))
    }
}

/// No `Deserialize`/`Default`: a request model does not need either when every
/// field has an explicit scalar source.
#[derive(WebxRequestMeta)]
struct CustomScalarRequest {
    #[frompath]
    id: Slug,
    #[fromquery]
    filter: Slug,
}

#[get("/bind/custom/{id}")]
impl IRequest<serde_json::Value> for CustomScalarRequest {}

#[derive(Default)]
struct CustomScalarHandler;

#[handler]
#[async_trait::async_trait]
impl IRequestHandler<CustomScalarRequest, serde_json::Value> for CustomScalarHandler {
    async fn handle(&mut self, req: CustomScalarRequest) -> Result<serde_json::Value> {
        Ok(serde_json::json!({ "id": req.id.0, "filter": req.filter.0 }))
    }
}

// ---------------------------------------------------------------------------
// Harness
// ---------------------------------------------------------------------------

#[derive(Serialize)]
struct TokenClaims {
    sub: String,
    roles: Vec<String>,
    permissions: Vec<String>,
    exp: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    tenant_id: Option<String>,
}

fn token(tenant: Option<&str>) -> String {
    let exp = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .unwrap()
        .as_secs() as usize
        + 3600;
    let claims = TokenClaims {
        sub: "user-42".to_string(),
        roles: vec!["admin".to_string(), "auditor".to_string()],
        permissions: Vec::new(),
        exp,
        tenant_id: tenant.map(str::to_string),
    };
    jsonwebtoken::encode(
        &Header::default(),
        &claims,
        &EncodingKey::from_secret(TEST_SECRET),
    )
    .unwrap()
}

fn find_free_port() -> u16 {
    let listener = TcpListener::bind("127.0.0.1:0").unwrap();
    listener.local_addr().unwrap().port()
}

async fn spawn_host() -> String {
    let port = find_free_port();
    let addr = format!("127.0.0.1:{port}");
    let host = Host::builder()
        .mode(AppMode::Development)
        .no_spa()
        .add_authentication()
        .configure(|b| {
            b.useOptions(|o| {
                o.jwt.secret = String::from_utf8_lossy(TEST_SECRET).to_string();
            });
        })
        .build();
    let base = format!("http://{addr}");
    tokio::spawn(async move {
        host.run_at(&addr).await.unwrap();
    });
    // Wait for the listener to accept connections.
    for _ in 0..100 {
        if reqwest::get(format!("{base}/health/live")).await.is_ok() {
            return base;
        }
        tokio::time::sleep(std::time::Duration::from_millis(20)).await;
    }
    panic!("host did not start");
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[tokio::test]
async fn query_binds_non_string_types_and_repeated_keys() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::get(format!(
        "{base}/bind/query?q=hello&page=2&size=10&ids=1&ids=2&ids=3"
    ))
    .await
    .unwrap()
    .json()
    .await
    .unwrap();

    assert_eq!(body["q"], "hello");
    assert_eq!(body["page"], 2);
    assert_eq!(body["size"], 10);
    assert_eq!(body["ids"], serde_json::json!([1, 2, 3]));
}

#[tokio::test]
async fn query_expands_comma_separated_lists() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::get(format!("{base}/bind/query?q=x&page=1&ids=4,5,6"))
        .await
        .unwrap()
        .json()
        .await
        .unwrap();
    assert_eq!(body["ids"], serde_json::json!([4, 5, 6]));
    assert_eq!(body["size"], serde_json::Value::Null);
}

#[tokio::test]
async fn invalid_query_value_reports_the_field() {
    let base = spawn_host().await;
    let resp = reqwest::get(format!("{base}/bind/query?q=x&page=abc"))
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 400);
    let problem: serde_json::Value = resp.json().await.unwrap();
    let page = &problem["errors"]["page"];
    assert!(
        page.as_array().is_some_and(|messages| !messages.is_empty()),
        "expected a `page` error, got {problem}"
    );
}

#[tokio::test]
async fn query_all_binds_unmarked_fields_on_a_post() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::Client::new()
        .post(format!("{base}/bind/query-all?term=abc&limit=5"))
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["term"], "abc");
    assert_eq!(body["limit"], 5);
}

#[tokio::test]
async fn missing_required_query_field_reports_the_field() {
    let base = spawn_host().await;
    let resp = reqwest::get(format!("{base}/bind/query?q=x"))
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 400);
    let problem: serde_json::Value = resp.json().await.unwrap();
    assert!(
        problem["errors"]["page"].is_array(),
        "expected a `page` error, got {problem}"
    );
}

#[tokio::test]
async fn headers_bind_case_insensitively() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::Client::new()
        .get(format!("{base}/bind/header/7"))
        .header("x-tenant", "acme")
        .header("X-Trace-Id", "trace-1")
        .header("X-Scopes", "read, write")
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["id"], "7");
    assert_eq!(body["tenant"], "acme");
    assert_eq!(body["trace"], "trace-1");
    assert_eq!(body["scopes"], serde_json::json!(["read", "write"]));
}

#[tokio::test]
async fn missing_required_header_reports_the_field() {
    let base = spawn_host().await;
    let resp = reqwest::Client::new()
        .get(format!("{base}/bind/header/7"))
        .send()
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 400);
    let problem: serde_json::Value = resp.json().await.unwrap();
    assert!(
        problem["errors"]["tenant"].is_array(),
        "expected a `tenant` error, got {problem}"
    );
}

#[tokio::test]
async fn claims_bind_subject_and_roles() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::Client::new()
        .get(format!("{base}/bind/claim"))
        .bearer_auth(token(Some("acme")))
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["user"], "user-42");
    assert_eq!(body["roles"], serde_json::json!(["admin", "auditor"]));
    assert_eq!(body["tenant"], "acme");
}

#[tokio::test]
async fn claims_are_optional_when_the_field_is() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::Client::new()
        .get(format!("{base}/bind/claim"))
        .bearer_auth(token(None))
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["user"], "user-42");
    assert_eq!(body["tenant"], serde_json::Value::Null);
}

#[tokio::test]
async fn claim_binding_without_a_principal_is_unauthorized() {
    let base = spawn_host().await;
    let resp = reqwest::get(format!("{base}/bind/claim")).await.unwrap();
    assert_eq!(resp.status().as_u16(), 401);
}

#[tokio::test]
async fn path_body_and_header_bind_together() {
    let base = spawn_host().await;
    let resp = reqwest::Client::new()
        .put(format!("{base}/bind/mixed/99"))
        .header("x-actor", "alice")
        .json(&serde_json::json!({ "name": "renamed" }))
        .send()
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 200);
    let body: serde_json::Value = resp.json().await.unwrap();
    assert_eq!(body["id"], "99");
    assert_eq!(body["name"], "renamed");
    assert_eq!(body["actor"], "alice");
}

#[tokio::test]
async fn missing_body_field_is_reported_not_defaulted() {
    let base = spawn_host().await;
    let resp = reqwest::Client::new()
        .put(format!("{base}/bind/mixed/99"))
        .header("x-actor", "alice")
        .json(&serde_json::json!({}))
        .send()
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 400);
    let problem: serde_json::Value = resp.json().await.unwrap();
    assert!(
        problem["errors"]["name"].is_array(),
        "expected a `name` error, got {problem}"
    );
}

#[tokio::test]
async fn query_wins_over_the_route_on_get() {
    let base = spawn_host().await;

    let from_path: serde_json::Value = reqwest::get(format!("{base}/bind/priority/from-path"))
        .await
        .unwrap()
        .json()
        .await
        .unwrap();
    assert_eq!(from_path["key"], "from-path");

    let from_query: serde_json::Value =
        reqwest::get(format!("{base}/bind/priority/from-path?key=from-query"))
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
    assert_eq!(from_query["key"], "from-query");
}

#[tokio::test]
async fn body_is_authoritative_on_write_methods() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::Client::new()
        .post(format!("{base}/bind/priority-body/7?key=from-query"))
        .json(&serde_json::json!({ "key": "from-body" }))
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["id"], "7");
    assert_eq!(body["key"], "from-body");
}

#[tokio::test]
async fn composite_fields_bind_from_the_body() {
    let base = spawn_host().await;
    let resp = reqwest::Client::new()
        .put(format!("{base}/bind/complex/42"))
        .json(&serde_json::json!({
            "address": { "city": "Shanghai", "zip": "200000" },
            "items": [
                { "sku": "a-1", "qty": 1 },
                { "sku": "b-2", "qty": 2 }
            ],
            "meta": { "source": "web" }
        }))
        .send()
        .await
        .unwrap();

    assert_eq!(resp.status().as_u16(), 200);
    let body: serde_json::Value = resp.json().await.unwrap();
    assert_eq!(body["id"], "42");
    assert_eq!(body["city"], "Shanghai");
    assert_eq!(body["zip"], "200000");
    assert_eq!(body["items"], serde_json::json!(["a-1", "b-2"]));
    assert_eq!(body["qty_total"], 3);
    assert_eq!(body["meta"], "web");
}

#[tokio::test]
async fn explicit_custom_scalars_bind_from_path_and_query() {
    let base = spawn_host().await;
    let body: serde_json::Value = reqwest::get(format!("{base}/bind/custom/ABC?filter=XYZ"))
        .await
        .unwrap()
        .json()
        .await
        .unwrap();

    assert_eq!(body["id"], "abc");
    assert_eq!(body["filter"], "xyz");
}