broccoli_queue 0.4.6

Broccoli is a simple, fast, and reliable job queue for Rust.
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
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
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
use std::sync::Arc;

use broccoli_queue::{
    error::BroccoliError,
    queue::{ConsumeOptions, ConsumeOptionsBuilder, PublishOptions},
};
#[cfg(feature = "redis")]
use redis::AsyncCommands;
use serde::{Deserialize, Serialize};
use time::Duration;
use tokio::sync::Mutex;

mod common;

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
struct TestMessage {
    id: String,
    content: String,
}

#[tokio::test]
async fn test_publish_and_consume() {
    //env_logger::init();
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_publish_and_consume";

    // Test message
    let message = TestMessage {
        id: "1".to_string(),
        content: "test content".to_string(),
    };

    // Publish message
    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish(test_topic, None, &message, None)
        .await
        .expect("Failed to publish message");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish(test_topic, Some(String::from("job-1")), &message, None)
        .await
        .expect("Failed to publish message");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Consume message
    let consumed = queue
        .consume::<TestMessage>(test_topic, Some(consume_options))
        .await
        .expect("Failed to consume message");

    assert_eq!(published.payload, consumed.payload);
    assert_eq!(published.task_id, consumed.task_id);

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let processing_queue_name = format!("{}_processing", test_topic);
        #[cfg(feature = "test-fairness")]
        let processing_queue_name = format!("{}_job-1_processing", test_topic);

        // Verify message is in the processing queue
        let processing: usize = redis.llen(processing_queue_name).await.unwrap();
        assert_eq!(processing, 1, "Message should be in processing queue");

        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        queue
            .acknowledge(&queue_name, consumed)
            .await
            .expect("Failed to acknowledge message");

        // After acknowledge, verify cleanup
        let exists: bool = redis.exists(published.task_id.to_string()).await.unwrap();
        assert!(!exists, "Message should be cleaned up after acknowledge");
    }
}

#[tokio::test]
async fn test_batch_publish_and_consume() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_batch_topic";

    // Test messages
    let messages = vec![
        TestMessage {
            id: "1".to_string(),
            content: "content 1".to_string(),
        },
        TestMessage {
            id: "2".to_string(),
            content: "content 2".to_string(),
        },
    ];

    // Publish batch
    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish_batch(test_topic, None, messages.clone(), None)
        .await
        .expect("Failed to publish batch");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish_batch(
            test_topic,
            Some(String::from("job-1")),
            messages.clone(),
            None,
        )
        .await
        .expect("Failed to publish batch");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Consume messages
    let consumed = queue
        .consume_batch::<TestMessage>(test_topic, 2, Duration::seconds(5), Some(consume_options))
        .await
        .expect("Failed to consume batch");

    assert_eq!(2, consumed.len());
    assert_eq!(published.len(), consumed.len());
    assert_eq!(published[0].payload, consumed[0].payload);
    assert_eq!(published[1].payload, consumed[1].payload);

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue size after consuming
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(
            remaining, 0,
            "Queue should be empty after consuming all messages"
        );
    }
}

#[tokio::test]
async fn test_try_consume_batch() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_try_batch_topic";

    // Test messages
    let messages = vec![
        TestMessage {
            id: "1".to_string(),
            content: "content 1".to_string(),
        },
        TestMessage {
            id: "2".to_string(),
            content: "content 2".to_string(),
        },
    ];

    // Publish batch
    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish_batch(test_topic, None, messages.clone(), None)
        .await
        .expect("Failed to publish batch");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish_batch(
            test_topic,
            Some(String::from("job-1")),
            messages.clone(),
            None,
        )
        .await
        .expect("Failed to publish batch");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Consume messages
    let consumed = queue
        .try_consume_batch::<TestMessage>(test_topic, 2, Some(consume_options))
        .await
        .expect("Failed to consume batch");

    assert_eq!(2, consumed.len());
    assert_eq!(published.len(), consumed.len());
    assert_eq!(published[0].payload, consumed[0].payload);
    assert_eq!(published[1].payload, consumed[1].payload);

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue size after consuming
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(
            remaining, 0,
            "Queue should be empty after consuming all messages"
        );
    }
}

#[tokio::test]
async fn test_delayed_message() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_delayed_topic";

    let message = TestMessage {
        id: "delayed".to_string(),
        content: "delayed content".to_string(),
    };

    // Publish with delay
    let options = PublishOptions::builder()
        .delay(time::Duration::seconds(2))
        .build();

    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &message, Some(options))
        .await
        .expect("Failed to publish delayed message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(
            test_topic,
            Some(String::from("job-1")),
            &message,
            Some(options),
        )
        .await
        .expect("Failed to publish delayed message");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();
    // Try immediate consume (should be None)
    let immediate_result = queue
        .try_consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to try_consume");
    assert!(immediate_result.is_none());

    // Wait for delay
    tokio::time::sleep(std::time::Duration::from_secs(3)).await;

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify delayed message score
        let scores: Vec<(String, f64)> = redis
            .zrangebyscore_withscores(queue_name, "-inf", "+inf")
            .await
            .unwrap();
        assert!(!scores.is_empty(), "Delayed message should be in queue");
        let now = time::OffsetDateTime::now_utc().unix_timestamp_nanos() as f64;
        assert!(scores[0].1 > now, "Message score should be in future");
    }

    // Now consume (should get message)
    let delayed_result = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume delayed message");

    assert_eq!(message.content, delayed_result.payload.content);
}

#[tokio::test]
async fn test_scheduled_message() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_scheduled_topic";

    let message = TestMessage {
        id: "scheduled".to_string(),
        content: "scheduled content".to_string(),
    };

    // Schedule for 2 seconds in the future
    let schedule_time = time::OffsetDateTime::now_utc() + time::Duration::seconds(2);
    let options = PublishOptions::builder().schedule_at(schedule_time).build();

    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish(test_topic, None, &message, Some(options))
        .await
        .expect("Failed to publish scheduled message");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish(
            test_topic,
            Some(String::from("job-1")),
            &message,
            Some(options),
        )
        .await
        .expect("Failed to publish scheduled message");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Try immediate consume (should be None)
    let immediate_result = queue
        .try_consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to try_consume");

    assert!(immediate_result.is_none());

    // Wait for schedule time
    tokio::time::sleep(std::time::Duration::from_secs(3)).await;

    // Now consume (should get message)
    let scheduled_result = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume scheduled message");

    assert_eq!(published.payload.content, scheduled_result.payload.content);

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue is empty
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(remaining, 0, "Queue should be empty after consuming");
    }
}

#[tokio::test]
async fn test_message_retry() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_retry_topic";

    let message = TestMessage {
        id: "retry".to_string(),
        content: "retry content".to_string(),
    };

    // Publish message
    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish(test_topic, None, &message, None)
        .await
        .expect("Failed to publish message");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish(test_topic, Some(String::from("job-1")), &message, None)
        .await
        .expect("Failed to publish message");

    // Simulate failed processing 3 times
    for _ in 0..3 {
        #[cfg(not(feature = "test-fairness"))]
        let consume_options = ConsumeOptions::default();
        #[cfg(feature = "test-fairness")]
        let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

        let consumed = queue
            .consume::<TestMessage>(test_topic, Some(consume_options))
            .await
            .expect("Failed to consume message");

        // Reject the message
        queue
            .reject(test_topic, consumed)
            .await
            .expect("Failed to reject message");
    }

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // // Try to consume again - should be in failed queue
    let result = queue
        .try_consume::<TestMessage>(test_topic, Some(consume_options))
        .await
        .unwrap();
    assert!(result.is_none());

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let failed_queue_name = format!("{}_failed", test_topic);
        #[cfg(feature = "test-fairness")]
        let failed_queue_name = format!("{}_job-1_failed", test_topic);

        // Verify message in failed queue
        let failed_len: usize = redis.llen(failed_queue_name).await.unwrap();
        assert_eq!(failed_len, 1, "Message should be in failed queue");

        // Verify attempts counter
        let attempts: String = redis
            .hget(published.task_id.to_string(), "attempts")
            .await
            .unwrap();
        assert_eq!(attempts, "2", "Attempts counter should be 2");
    }
}

#[tokio::test]
async fn test_message_acknowledgment() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_ack_topic";

    let message = TestMessage {
        id: "ack".to_string(),
        content: "ack content".to_string(),
    };

    // Publish message
    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &message, None)
        .await
        .expect("Failed to publish message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(test_topic, Some(String::from("job-1")), &message, None)
        .await
        .expect("Failed to publish message");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();
    // Consume and acknowledge
    let consumed = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume message");
    //panic!();
    queue
        .acknowledge(test_topic, consumed)
        .await
        .expect("Failed to acknowledge message");

    // Try to consume again - should be none
    let result = queue
        .try_consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .unwrap();
    assert!(result.is_none());

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue is empty
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(remaining, 0, "Queue should be empty after acknowledgment");

        // Verify processing queue is empty
        #[cfg(not(feature = "test-fairness"))]
        let processing_queue = format!("{}_processing", test_topic);
        #[cfg(feature = "test-fairness")]
        let processing_queue = format!("{}_job-1_processing", test_topic);

        let processing: usize = redis.llen(processing_queue).await.unwrap();
        assert_eq!(processing, 0, "Processing queue should be empty");
    }

    #[cfg(feature = "surrealdb")]
    {
        // we verify processing and index tables are empty
        let db = common::get_surrealdb_client().await;
        let mut res = db
            .query("(SELECT VALUE COUNT() FROM test_ack_topic___processing GROUP ALL).count")
            .await
            .unwrap();
        let c: Option<i64> = res.take(0).unwrap();
        let c = c.unwrap();
        assert_eq!(0, c);
        let db = common::get_surrealdb_client().await;
        let mut res = db
            .query("(SELECT VALUE COUNT() FROM test_ack_topic___index GROUP ALL).count")
            .await
            .unwrap();
        let c: Option<i64> = res.take(0).unwrap();
        let c = c.unwrap();
        assert_eq!(0, c);
    }
}

#[tokio::test]
async fn test_message_auto_ack() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_auto_ack_topic";

    let message = TestMessage {
        id: "ack".to_string(),
        content: "ack content".to_string(),
    };

    // Publish message
    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &message, None)
        .await
        .expect("Failed to publish message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(test_topic, Some(String::from("job-1")), &message, None)
        .await
        .expect("Failed to publish message");

    #[cfg(not(feature = "test-fairness"))]
    let options = ConsumeOptionsBuilder::new().auto_ack(true).build();
    #[cfg(feature = "test-fairness")]
    let options = ConsumeOptionsBuilder::new()
        .fairness(true)
        .auto_ack(true)
        .build();
    // Consume and auto-ack
    queue
        .consume::<TestMessage>(test_topic, Some(options.clone()))
        .await
        .expect("Failed to consume message");
    // Try to consume again - should be none
    let result = queue
        .try_consume::<TestMessage>(test_topic, Some(options))
        .await
        .unwrap();
    assert!(result.is_none());

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue is empty
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(remaining, 0, "Queue should be empty after auto-ack");

        // Verify processing queue doesn't exist (auto-ack skips processing queue)
        #[cfg(not(feature = "test-fairness"))]
        let processing_queue = format!("{}_processing", test_topic);
        #[cfg(feature = "test-fairness")]
        let processing_queue = format!("{}_job-1_processing", test_topic);

        let processing: usize = redis.llen(processing_queue).await.unwrap();
        assert_eq!(processing, 0, "Processing queue should be empty");
    }
}

#[tokio::test]
async fn test_message_cancellation() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_cancel_topic";

    let message = TestMessage {
        id: "cancel".to_string(),
        content: "cancel content".to_string(),
    };

    // Publish message
    #[cfg(not(feature = "test-fairness"))]
    let published = queue
        .publish(test_topic, None, &message, None)
        .await
        .expect("Failed to publish message");
    #[cfg(feature = "test-fairness")]
    let published = queue
        .publish(test_topic, Some(String::from("job-1")), &message, None)
        .await
        .expect("Failed to publish message");

    // Cancel the message
    let result = queue
        .cancel(test_topic, published.task_id.to_string())
        .await;

    match result {
        Ok(()) => (),
        Err(e) if e.to_string().contains("NotImplemented") => {
            println!("This feature is not implemented for this broker");
            return;
        }
        Err(e) => {
            panic!("Failed to get message position: {e:?}");
        }
    };

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Try to consume - should be none
    let result = queue
        .try_consume::<TestMessage>(test_topic, Some(consume_options))
        .await
        .unwrap();
    assert!(result.is_none());

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify message removed from queue
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(remaining, 0, "Queue should be empty after cancellation");

        // Verify message metadata cleaned up
        let exists: bool = redis.exists(published.task_id.to_string()).await.unwrap();
        assert!(!exists, "Message should be cleaned up after cancellation");
    }
}

#[tokio::test]
async fn test_message_priority() {
    let queue = common::setup_queue().await;

    #[cfg(feature = "redis")]
    let mut redis = common::get_redis_client().await;
    let test_topic = "test_priority_topic";

    // Create messages with different priorities
    let messages = [
        TestMessage {
            id: "1".to_string(),
            content: "low priority".to_string(),
        },
        TestMessage {
            id: "2".to_string(),
            content: "high priority".to_string(),
        },
        TestMessage {
            id: "3".to_string(),
            content: "medium priority".to_string(),
        },
    ];

    // Publish messages with different priorities
    let options_low = PublishOptions::builder().priority(5).build();
    let options_high = PublishOptions::builder().priority(1).build();
    let options_medium = PublishOptions::builder().priority(3).build();

    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &messages[0], Some(options_low))
        .await
        .expect("Failed to publish low priority message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(
            test_topic,
            Some(String::from("job-1")),
            &messages[0],
            Some(options_low),
        )
        .await
        .expect("Failed to publish low priority message");

    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &messages[1], Some(options_high))
        .await
        .expect("Failed to publish high priority message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(
            test_topic,
            Some(String::from("job-1")),
            &messages[1],
            Some(options_high),
        )
        .await
        .expect("Failed to publish high priority message");

    #[cfg(not(feature = "test-fairness"))]
    queue
        .publish(test_topic, None, &messages[2], Some(options_medium))
        .await
        .expect("Failed to publish medium priority message");
    #[cfg(feature = "test-fairness")]
    queue
        .publish(
            test_topic,
            Some(String::from("job-1")),
            &messages[2],
            Some(options_medium),
        )
        .await
        .expect("Failed to publish medium priority message");

    #[cfg(not(feature = "test-fairness"))]
    let consume_options = ConsumeOptions::default();
    #[cfg(feature = "test-fairness")]
    let consume_options = ConsumeOptionsBuilder::new().fairness(true).build();

    // Consume messages - they should come in priority order (high to low)
    let first = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume first message");
    queue
        .acknowledge(test_topic, first.clone())
        .await
        .expect("Failed to acknowledge first message");
    let second = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume second message");
    queue
        .acknowledge(test_topic, second.clone())
        .await
        .expect("Failed to acknowledge second message");
    let third = queue
        .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
        .await
        .expect("Failed to consume third message");
    queue
        .acknowledge(test_topic, third.clone())
        .await
        .expect("Failed to acknowledge third message");

    // Verify priority ordering
    assert_eq!(first.payload.content, "high priority");
    assert_eq!(second.payload.content, "medium priority");
    assert_eq!(third.payload.content, "low priority");

    #[cfg(feature = "redis")]
    {
        #[cfg(not(feature = "test-fairness"))]
        let queue_name = test_topic;
        #[cfg(feature = "test-fairness")]
        let queue_name = format!("{}_job-1_queue", test_topic);

        // Verify queue is empty
        let remaining: usize = redis.zcard(queue_name).await.unwrap();
        assert_eq!(
            remaining, 0,
            "Queue should be empty after consuming all messages"
        );

        // Verify all messages cleaned up
        let exists_first: bool = redis.exists(first.task_id.to_string()).await.unwrap();
        let exists_second: bool = redis.exists(second.task_id.to_string()).await.unwrap();
        let exists_third: bool = redis.exists(third.task_id.to_string()).await.unwrap();
        assert!(
            !exists_first && !exists_second && !exists_third,
            "All messages should be cleaned up"
        );
    }
}

#[cfg(feature = "redis")]
#[tokio::test]
async fn test_queue_size() {
    let queue = common::setup_queue().await;
    let test_topic = "test_queue_size_topic";

    // Test messages
    let messages: Vec<TestMessage> = (0..5)
        .map(|i| TestMessage {
            id: i.to_string(),
            content: format!("content {i}"),
        })
        .collect();

    #[cfg(not(feature = "test-fairness"))]
    {
        // Publish messages to unfair queue
        queue
            .publish_batch(test_topic, None, messages.clone(), None)
            .await
            .expect("Failed to publish batch");

        // Check queue size
        let sizes = queue
            .size(test_topic)
            .await
            .expect("Failed to get queue size");

        assert_eq!(sizes.len(), 1, "Should have exactly one queue");
        assert_eq!(
            sizes.get(test_topic),
            Some(&5),
            "Queue should have 5 messages"
        );

        // Consume some messages and check size again
        let consume_options = ConsumeOptions::default();
        for _ in 0..2 {
            let msg = queue
                .consume::<TestMessage>(test_topic, Some(consume_options.clone()))
                .await
                .expect("Failed to consume");
            queue
                .acknowledge(test_topic, msg)
                .await
                .expect("Failed to ack");
        }

        let sizes = queue
            .size(test_topic)
            .await
            .expect("Failed to get queue size");

        assert_eq!(
            sizes.get(test_topic),
            Some(&3),
            "Queue should have 3 messages after consuming 2"
        );
    }

    #[cfg(feature = "test-fairness")]
    {
        // Publish messages to multiple fairness queues
        queue
            .publish_batch(
                test_topic,
                Some(String::from("queue-1")),
                messages.clone(),
                None,
            )
            .await
            .expect("Failed to publish batch to job-1");

        queue
            .publish_batch(
                test_topic,
                Some(String::from("queue-2")),
                messages[0..3].to_vec(),
                None,
            )
            .await
            .expect("Failed to publish batch to job-2");

        // Check queue sizes
        let sizes = queue
            .size(test_topic)
            .await
            .expect("Failed to get queue size");

        assert_eq!(sizes.len(), 2, "Should have two fairness queues");

        let job1_queue = format!("{}_queue-1_queue", test_topic);
        let job2_queue = format!("{}_queue-2_queue", test_topic);

        assert_eq!(
            sizes.get(&job1_queue),
            Some(&5),
            "queue-1 queue should have 5 messages"
        );
        assert_eq!(
            sizes.get(&job2_queue),
            Some(&3),
            "queue-2 queue should have 3 messages"
        );
    }
}

lazy_static::lazy_static! {
    // warning: do not share these variables across tests in the same run
    static ref processed: Arc<tokio::sync::Mutex<usize>> = Arc::new(Mutex::new(0));
    static ref handled: Arc<tokio::sync::Mutex<usize>> = Arc::new(Mutex::new(0));
    static ref succeeded: Arc<tokio::sync::Mutex<usize>> = Arc::new(Mutex::new(0));
}

async fn process_job(m: TestMessage) -> Result<(), BroccoliError> {
    // helper function to test process_messages
    let mut lock = processed.lock().await;
    let value = m.id.parse::<usize>().expect("should have id as an int");
    *lock += value;
    Ok(())
}

async fn process_handler(m: TestMessage) -> Result<(), BroccoliError> {
    // helper function to test process_messages_with_handlers
    let mut lock = handled.lock().await;
    *lock += m.id.parse::<usize>().expect("should have id as an int");
    Ok(())
}

async fn success_handler(m: TestMessage) -> Result<(), BroccoliError> {
    // helper function to test process_messages_with_handlers
    let mut lock = succeeded.lock().await;
    *lock += m.id.parse::<usize>().expect("should have id as an int");
    Ok(())
}

async fn error_handler(_: TestMessage, err: BroccoliError) -> Result<(), BroccoliError> {
    // helper function to test process_messages_with_handlers
    panic!("Should not invoke the error handler in testing {err}");
}

#[tokio::test]
async fn test_process_messages() {
    let producer_queue = common::setup_queue().await;
    let consumer_queue = producer_queue.clone();

    // launch consumer first
    let consumer = tokio::spawn(async move {
        let _ = consumer_queue
            .process_messages(
                "test_process_messages_topic",
                Some(5),
                Some(
                    ConsumeOptionsBuilder::new()
                        .consume_wait(std::time::Duration::from_millis(1))
                        .build(),
                ),
                |msg| async { process_job(msg.payload).await },
            )
            .await;
        panic!("Spawn should have been killed while processing");
    });
    // Create multiple messages
    let messages: Vec<_> = (0..10)
        .map(|i| TestMessage {
            id: i.to_string(),
            content: format!("content test_process_messages {i}"),
        })
        .collect();
    let published = producer_queue
        .publish_batch("test_process_messages_topic", None, messages, None)
        .await
        .expect("Could not publish");
    assert_eq!(10, published.len());
    let expected_count = 9 * 10 / 2; // 0 + 1 + ... + n = n(n+1)/2
    let wait = tokio::spawn(async move {
        let mut counter = 0;
        while counter < expected_count {
            tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;
            let lock = processed.lock().await;
            counter = *lock;
        }
        consumer.abort();
    });
    // consumer will block forever once consumed all messages, so we
    // just wait for 1 second and check the counter
    let _ = tokio::time::timeout(std::time::Duration::from_secs(2), wait).await;
    let lock = processed.lock().await;
    let total_processed = *lock;
    assert_eq!(
        expected_count, total_processed,
        "We should have processed 10 messages"
    );

    let empty: Option<broccoli_queue::brokers::broker::BrokerMessage<TestMessage>> =
        common::setup_queue()
            .await
            .try_consume("test_process_messages_topic", None)
            .await
            .expect("");
    assert!(empty.is_none(), "No messages left");
}

#[tokio::test]
async fn test_process_messages_with_handlers() {
    let producer_queue = common::setup_queue().await;
    let consumer_queue = producer_queue.clone();

    // launch consumer first
    let consumer = tokio::spawn(async move {
        let _ = consumer_queue
            .process_messages_with_handlers(
                "test_process_messages_with_handlers_topic",
                Some(5),
                None,
                |msg| async move { process_handler(msg.payload).await },
                |msg, _result| async { success_handler(msg.payload).await },
                |msg, err| async { error_handler(msg.payload, err).await },
            )
            .await;
        panic!("Spawn should have been killed while processing");
    });
    // Create multiple messages
    let messages: Vec<_> = (0..10)
        .map(|i| TestMessage {
            id: i.to_string(),
            content: format!("content test_process_messages_with_handlers_topic {i}"),
        })
        .collect();
    let published = producer_queue
        .publish_batch(
            "test_process_messages_with_handlers_topic",
            None,
            messages,
            None,
        )
        .await
        .expect("Could not publish");
    assert_eq!(10, published.len());
    let expected_count = 9 * 10 / 2; // 0 + 1 + ... + n = n(n+1)/2

    let wait = tokio::spawn(async move {
        let mut counter = 0;
        while counter < expected_count {
            tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;
            let lock = succeeded.lock().await;
            counter = *lock;
        }
        consumer.abort();
    });
    let _ = tokio::time::timeout(std::time::Duration::from_secs(1), wait)
        .await
        .expect("Took too long to consume");
    let lock = succeeded.lock().await;
    let total_succeeded = *lock;
    assert_eq!(
        expected_count, total_succeeded,
        "Should have successfully handled 10 messages"
    );
    let empty: Option<broccoli_queue::brokers::broker::BrokerMessage<TestMessage>> =
        common::setup_queue()
            .await
            .try_consume("test_process_messages_with_handlers_topic", None)
            .await
            .expect("");
    assert!(empty.is_none(), "No messages left");
}