blueprint-router 0.2.0-alpha.5

Job routing utilities for the Blueprint SDK
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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
extern crate alloc;
extern crate std;

use crate::Router;
use crate::test_helpers::setup_log;
use alloc::vec;
use alloc::vec::Vec;
use blueprint_core::error::BoxError;
use blueprint_core::job::call::JobCall;
use bytes::Bytes;
use std::sync::Arc;
use std::sync::atomic::{AtomicU32, Ordering};
use tower::Service;

// =============================================================================
// BASIC ROUTING TESTS
// =============================================================================

#[tokio::test]
async fn route_dispatches_to_correct_handler() {
    setup_log();

    let call_count = Arc::new(AtomicU32::new(0));
    let count_clone = call_count.clone();

    let mut router: Router = Router::new().route(42u32, move || {
        count_clone.fetch_add(1, Ordering::SeqCst);
        async { "handled" }
    });

    let result = router
        .call(JobCall::new(42u32, Bytes::new()))
        .await
        .unwrap();
    assert!(result.is_some());
    assert_eq!(call_count.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn multiple_routes_dispatch_independently() {
    setup_log();

    let job_a_count = Arc::new(AtomicU32::new(0));
    let job_b_count = Arc::new(AtomicU32::new(0));
    let a_clone = job_a_count.clone();
    let b_clone = job_b_count.clone();

    let mut router: Router = Router::new()
        .route(1u32, move || {
            a_clone.fetch_add(1, Ordering::SeqCst);
            async { "job_a" }
        })
        .route(2u32, move || {
            b_clone.fetch_add(1, Ordering::SeqCst);
            async { "job_b" }
        });

    // Call job A twice
    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    // Call job B once
    router.call(JobCall::new(2u32, Bytes::new())).await.unwrap();

    assert_eq!(job_a_count.load(Ordering::SeqCst), 2);
    assert_eq!(job_b_count.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn unknown_job_id_returns_none() {
    setup_log();

    let mut router: Router = Router::new().route(1u32, || async { "exists" });

    let result = router
        .call(JobCall::new(999u32, Bytes::new()))
        .await
        .unwrap();

    assert!(result.is_none(), "Unknown job ID should return None");
}

#[tokio::test]
async fn empty_router_returns_none() {
    setup_log();

    let mut router: Router = Router::new();

    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    assert!(result.is_none());
}

// =============================================================================
// FALLBACK ROUTE TESTS
// =============================================================================

#[tokio::test]
async fn fallback_catches_unmatched_job_ids() {
    setup_log();

    let fallback_count = Arc::new(AtomicU32::new(0));
    let count_clone = fallback_count.clone();

    let mut router: Router =
        Router::new()
            .route(1u32, || async { "specific" })
            .fallback(move || {
                count_clone.fetch_add(1, Ordering::SeqCst);
                async { "fallback" }
            });

    // Known route - fallback NOT called
    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    assert_eq!(fallback_count.load(Ordering::SeqCst), 0);

    // Unknown route - fallback IS called
    let result = router
        .call(JobCall::new(999u32, Bytes::new()))
        .await
        .unwrap();
    assert!(result.is_some());
    assert_eq!(fallback_count.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn fallback_replaces_previous_fallback() {
    setup_log();

    let first_fallback = Arc::new(AtomicU32::new(0));
    let second_fallback = Arc::new(AtomicU32::new(0));
    let first_clone = first_fallback.clone();
    let second_clone = second_fallback.clone();

    let mut router: Router = Router::new()
        .fallback(move || {
            first_clone.fetch_add(1, Ordering::SeqCst);
            async { "first" }
        })
        .fallback(move || {
            second_clone.fetch_add(1, Ordering::SeqCst);
            async { "second" }
        });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    assert_eq!(
        first_fallback.load(Ordering::SeqCst),
        0,
        "First fallback should be replaced"
    );
    assert_eq!(
        second_fallback.load(Ordering::SeqCst),
        1,
        "Second fallback should be called"
    );
}

// =============================================================================
// ALWAYS ROUTE TESTS
// =============================================================================

#[tokio::test]
async fn always_route_called_for_every_job() {
    setup_log();

    let always_count = Arc::new(AtomicU32::new(0));
    let count_clone = always_count.clone();

    let mut router: Router = Router::new()
        .route(1u32, || async { "job_1" })
        .route(2u32, || async { "job_2" })
        .always(move || {
            count_clone.fetch_add(1, Ordering::SeqCst);
            async { "always" }
        });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    router.call(JobCall::new(2u32, Bytes::new())).await.unwrap();
    router
        .call(JobCall::new(999u32, Bytes::new()))
        .await
        .unwrap(); // Unknown ID

    assert_eq!(always_count.load(Ordering::SeqCst), 3);
}

#[tokio::test]
async fn always_and_specific_route_both_execute() {
    setup_log();

    let specific_count = Arc::new(AtomicU32::new(0));
    let always_count = Arc::new(AtomicU32::new(0));
    let specific_clone = specific_count.clone();
    let always_clone = always_count.clone();

    let mut router: Router = Router::new()
        .route(1u32, move || {
            specific_clone.fetch_add(1, Ordering::SeqCst);
            async { "specific" }
        })
        .always(move || {
            always_clone.fetch_add(1, Ordering::SeqCst);
            async { "always" }
        });

    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    // Both should execute
    assert_eq!(specific_count.load(Ordering::SeqCst), 1);
    assert_eq!(always_count.load(Ordering::SeqCst), 1);

    // Result should contain outputs from both
    let results = result.expect("Should have results");
    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn always_route_disables_fallback() {
    setup_log();

    let fallback_count = Arc::new(AtomicU32::new(0));
    let always_count = Arc::new(AtomicU32::new(0));
    let fallback_clone = fallback_count.clone();
    let always_clone = always_count.clone();

    // Fallback first, then always - fallback should be disabled
    let mut router: Router = Router::new()
        .fallback(move || {
            fallback_clone.fetch_add(1, Ordering::SeqCst);
            async { "fallback" }
        })
        .always(move || {
            always_clone.fetch_add(1, Ordering::SeqCst);
            async { "always" }
        });

    router
        .call(JobCall::new(999u32, Bytes::new()))
        .await
        .unwrap();

    assert_eq!(
        fallback_count.load(Ordering::SeqCst),
        0,
        "Fallback should not be called when always exists"
    );
    assert_eq!(always_count.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn multiple_always_routes_all_execute() {
    setup_log();

    let first_always = Arc::new(AtomicU32::new(0));
    let second_always = Arc::new(AtomicU32::new(0));
    let first_clone = first_always.clone();
    let second_clone = second_always.clone();

    let mut router: Router = Router::new()
        .always(move || {
            first_clone.fetch_add(1, Ordering::SeqCst);
            async { "first" }
        })
        .always(move || {
            second_clone.fetch_add(1, Ordering::SeqCst);
            async { "second" }
        });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    assert_eq!(first_always.load(Ordering::SeqCst), 1);
    assert_eq!(second_always.load(Ordering::SeqCst), 1);
}

// =============================================================================
// ERROR HANDLING TESTS
// =============================================================================

#[tokio::test]
async fn fallible_job_ok_returns_ok_result() {
    setup_log();

    async fn job_ok() -> Result<&'static str, BoxError> {
        Ok("success")
    }

    let mut router: Router = Router::new().route(0u32, job_ok);

    let result = router.call(JobCall::new(0u32, Bytes::new())).await.unwrap();
    let results = result.expect("Should have results");
    assert_eq!(results.len(), 1);
    assert!(results[0].is_ok());
}

#[tokio::test]
async fn fallible_job_err_returns_err_result() {
    setup_log();

    async fn job_err() -> Result<&'static str, BoxError> {
        Err("intentional error".into())
    }

    let mut router: Router = Router::new().route(0u32, job_err);

    let result = router.call(JobCall::new(0u32, Bytes::new())).await.unwrap();
    let results = result.expect("Should have results");
    assert_eq!(results.len(), 1);
    assert!(results[0].is_err());
}

#[tokio::test]
#[should_panic(expected = "intentional panic")]
async fn job_panic_propagates() {
    setup_log();

    async fn panicking_job() -> &'static str {
        panic!("intentional panic")
    }

    let mut router: Router = Router::new().route(0u32, panicking_job);

    // Panics propagate through the router - this tests that panics aren't silently swallowed
    let _ = router.call(JobCall::new(0u32, Bytes::new())).await;
}

// =============================================================================
// CONTEXT TESTS
// =============================================================================

#[tokio::test]
async fn with_context_converts_router_type() {
    setup_log();

    #[derive(Clone)]
    struct TestContext {
        _value: u32,
    }

    // Router<TestContext> requires context to be provided
    let router_needing_context: Router<TestContext> =
        Router::new().route(1u32, || async { "no context needed for this job" });

    // Providing context converts Router<TestContext> to Router<()>
    let ctx = TestContext { _value: 42 };
    let mut router: Router<()> = router_needing_context.with_context(ctx);

    // Now it can be called
    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    assert!(result.is_some());
}

#[tokio::test]
async fn context_accessible_via_arc_state() {
    setup_log();

    // Use Arc to share state that jobs can access
    let shared_counter = Arc::new(AtomicU32::new(0));
    let counter_clone = shared_counter.clone();

    let mut router: Router = Router::new().route(1u32, move || {
        let counter = counter_clone.clone();
        async move {
            counter.fetch_add(1, Ordering::SeqCst);
            "incremented"
        }
    });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    assert_eq!(shared_counter.load(Ordering::SeqCst), 2);
}

// =============================================================================
// JOB INPUT/OUTPUT TESTS
// =============================================================================

#[tokio::test]
async fn job_receives_call_body_via_bytes_extractor() {
    setup_log();

    let received_body = Arc::new(std::sync::Mutex::new(Vec::new()));
    let body_clone = received_body.clone();

    // Using Bytes extractor - the body is automatically extracted
    let mut router: Router = Router::new().route(1u32, move |body: Bytes| {
        let captured = body_clone.clone();
        async move {
            captured.lock().unwrap().extend_from_slice(&body);
            "received"
        }
    });

    let input = Bytes::from("test input data");
    router
        .call(JobCall::new(1u32, input.clone()))
        .await
        .unwrap();

    let captured = received_body.lock().unwrap();
    assert_eq!(&*captured, &input[..]);
}

#[tokio::test]
async fn job_receives_empty_body() {
    setup_log();

    let mut router: Router = Router::new().route(1u32, move |body: Bytes| async move {
        assert!(body.is_empty());
        "empty"
    });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
}

// =============================================================================
// ROUTER STATE TESTS
// =============================================================================

#[tokio::test]
async fn has_routes_reports_correctly() {
    let empty_router: Router = Router::new();
    assert!(!empty_router.has_routes());

    let router_with_route: Router = Router::new().route(1u32, || async { "job" });
    assert!(router_with_route.has_routes());
}

#[tokio::test]
async fn has_routes_false_with_only_fallback() {
    // Fallback doesn't count as a "route"
    let router_with_fallback: Router = Router::new().fallback(|| async { "fallback" });
    assert!(!router_with_fallback.has_routes());
}

#[tokio::test]
async fn router_clone_works_independently() {
    setup_log();

    let call_count = Arc::new(AtomicU32::new(0));
    let count_clone = call_count.clone();

    let router: Router = Router::new().route(1u32, move || {
        count_clone.fetch_add(1, Ordering::SeqCst);
        async { "job" }
    });

    let mut router_clone = router.clone();
    let mut original = router;

    original
        .call(JobCall::new(1u32, Bytes::new()))
        .await
        .unwrap();
    router_clone
        .call(JobCall::new(1u32, Bytes::new()))
        .await
        .unwrap();

    assert_eq!(call_count.load(Ordering::SeqCst), 2);
}

#[tokio::test]
async fn router_is_always_ready() {
    use std::future::poll_fn;
    use std::task::Poll;

    let mut router: Router = Router::new().route(1u32, || async { "job" });

    let ready = poll_fn(|cx| match Service::<JobCall>::poll_ready(&mut router, cx) {
        Poll::Ready(Ok(())) => Poll::Ready(true),
        Poll::Ready(Err(_)) => Poll::Ready(false),
        Poll::Pending => Poll::Ready(false),
    })
    .await;

    assert!(ready, "Router should always be ready");
}

// =============================================================================
// LAYER TESTS
// =============================================================================

#[tokio::test]
async fn layer_wraps_all_routes() {
    setup_log();

    use tower::limit::ConcurrencyLimitLayer;

    let call_count = Arc::new(AtomicU32::new(0));
    let count_clone = call_count.clone();

    let mut router: Router = Router::new()
        .route(1u32, move || {
            count_clone.fetch_add(1, Ordering::SeqCst);
            async { "job" }
        })
        .layer(ConcurrencyLimitLayer::new(1));

    // Should work - layer doesn't block single calls
    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    assert_eq!(call_count.load(Ordering::SeqCst), 1);
}

// =============================================================================
// CONCURRENT EXECUTION TESTS
// =============================================================================

#[tokio::test]
async fn concurrent_job_calls_execute_independently() {
    setup_log();

    use std::time::Duration;
    use tokio::time::sleep;

    let execution_order = Arc::new(std::sync::Mutex::new(Vec::new()));

    let order1 = execution_order.clone();
    let order2 = execution_order.clone();

    let router: Router = Router::new()
        .route(1u32, move || {
            let order = order1.clone();
            async move {
                sleep(Duration::from_millis(50)).await;
                order.lock().unwrap().push(1);
                "slow"
            }
        })
        .route(2u32, move || {
            let order = order2.clone();
            async move {
                order.lock().unwrap().push(2);
                "fast"
            }
        });

    let mut r1 = router.clone();
    let mut r2 = router.clone();

    // Start slow job first, then fast job
    let slow = tokio::spawn(async move { r1.call(JobCall::new(1u32, Bytes::new())).await });
    let fast = tokio::spawn(async move { r2.call(JobCall::new(2u32, Bytes::new())).await });

    let _ = tokio::join!(slow, fast);

    let order = execution_order.lock().unwrap();
    // Fast job (2) should complete before slow job (1)
    assert_eq!(*order, vec![2, 1]);
}

// =============================================================================
// EDGE CASES
// =============================================================================

#[tokio::test]
async fn job_id_zero_works() {
    setup_log();

    let mut router: Router = Router::new().route(0u32, || async { "zero" });

    let result = router.call(JobCall::new(0u32, Bytes::new())).await.unwrap();
    assert!(result.is_some());
}

#[tokio::test]
async fn large_job_id_works() {
    setup_log();

    let large_id = u32::MAX;
    let mut router: Router = Router::new().route(large_id, || async { "max" });

    let result = router
        .call(JobCall::new(large_id, Bytes::new()))
        .await
        .unwrap();
    assert!(result.is_some());
}

#[tokio::test]
async fn empty_body_handled() {
    setup_log();

    let mut router: Router = Router::new().route(1u32, |call: JobCall| async move {
        assert!(call.body().is_empty());
        "handled"
    });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
}

#[tokio::test]
async fn large_body_handled() {
    setup_log();

    let large_body = Bytes::from(vec![0xABu8; 1024 * 1024]); // 1MB
    let body_clone = large_body.clone();

    let mut router: Router = Router::new().route(1u32, move |call: JobCall| {
        let expected = body_clone.clone();
        async move {
            assert_eq!(call.body().len(), expected.len());
            "handled"
        }
    });

    router.call(JobCall::new(1u32, large_body)).await.unwrap();
}

#[tokio::test]
async fn job_returning_unit_produces_result() {
    setup_log();

    async fn unit_job() {
        // Returns ()
    }

    let mut router: Router = Router::new().route(1u32, unit_job);

    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    assert!(result.is_some());
}

#[tokio::test]
async fn job_returning_option_none_excluded_from_results() {
    setup_log();

    // Option<T> where T: IntoJobResult - using &'static str which implements IntoJobResult
    async fn none_job() -> Option<&'static str> {
        None
    }

    let mut router: Router = Router::new().route(1u32, none_job);

    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    // When job returns None, the result is filtered out
    assert!(result.is_none() || result.unwrap().is_empty());
}

#[tokio::test]
async fn job_returning_option_some_included_in_results() {
    setup_log();

    async fn some_job() -> Option<&'static str> {
        Some("value")
    }

    let mut router: Router = Router::new().route(1u32, some_job);

    let result = router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();
    let results = result.expect("Should have results vec");
    assert!(!results.is_empty());
}

// =============================================================================
// ROUTING BEHAVIOR TESTS
// =============================================================================

#[tokio::test]
async fn same_job_id_overwrites_previous_route() {
    setup_log();

    let first_handler = Arc::new(AtomicU32::new(0));
    let second_handler = Arc::new(AtomicU32::new(0));
    let first_clone = first_handler.clone();
    let second_clone = second_handler.clone();

    // Add route for job 1, then add another route for same job 1
    let mut router: Router = Router::new()
        .route(1u32, move || {
            first_clone.fetch_add(1, Ordering::SeqCst);
            async { "first" }
        })
        .route(1u32, move || {
            second_clone.fetch_add(1, Ordering::SeqCst);
            async { "second" }
        });

    router.call(JobCall::new(1u32, Bytes::new())).await.unwrap();

    // Second handler should be called (overwrites first)
    assert_eq!(first_handler.load(Ordering::SeqCst), 0);
    assert_eq!(second_handler.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn string_job_id_hashes_to_consistent_route() {
    setup_log();

    let call_count = Arc::new(AtomicU32::new(0));
    let count_clone = call_count.clone();

    let mut router: Router = Router::new().route("my_job", move || {
        count_clone.fetch_add(1, Ordering::SeqCst);
        async { "handled" }
    });

    // Same string should route to same handler
    router
        .call(JobCall::new("my_job", Bytes::new()))
        .await
        .unwrap();
    router
        .call(JobCall::new("my_job", Bytes::new()))
        .await
        .unwrap();

    assert_eq!(call_count.load(Ordering::SeqCst), 2);

    // Different string should not match
    let result = router
        .call(JobCall::new("other_job", Bytes::new()))
        .await
        .unwrap();
    assert!(result.is_none());
}

#[tokio::test]
async fn router_default_is_empty() {
    let router: Router = Router::default();
    assert!(!router.has_routes());
}

#[tokio::test]
async fn router_debug_impl_works() {
    let router: Router = Router::new().route(1u32, || async { "test" });
    let debug_str = std::format!("{:?}", router);
    assert!(debug_str.contains("Router"));
}