shove 0.11.2

Async tasks via pubsub on steroids. Comes with built-in support for complex queue configurations, audit logs, autoscaling consumer groups and more.
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

use lapin::Channel;
use lapin::options::{ExchangeDeclareOptions, QueueBindOptions, QueueDeclareOptions};
use lapin::types::{AMQPValue, FieldTable};

use crate::error::{Result, ShoveError};
use crate::topology::QueueTopology;

const X_DEAD_LETTER_EXCHANGE: &str = "x-dead-letter-exchange";
const X_DEAD_LETTER_ROUTING_KEY: &str = "x-dead-letter-routing-key";
const X_MESSAGE_TTL: &str = "x-message-ttl";
const X_SINGLE_ACTIVE_CONSUMER: &str = "x-single-active-consumer";

fn with_dlq_routing(args: &mut FieldTable, dlq: &str) {
    args.insert(
        X_DEAD_LETTER_EXCHANGE.into(),
        AMQPValue::LongString("".into()),
    );
    args.insert(
        X_DEAD_LETTER_ROUTING_KEY.into(),
        AMQPValue::LongString(dlq.into()),
    );
}

fn hold_queue_args(route_back_to: &str, ttl_ms: i64) -> FieldTable {
    let mut args = FieldTable::default();
    args.insert(X_MESSAGE_TTL.into(), AMQPValue::LongLongInt(ttl_ms));
    with_dlq_routing(&mut args, route_back_to);
    args
}

/// Declares RabbitMQ broker resources for a topic's topology.
///
/// All declarations are idempotent — safe to call on every startup.
pub struct RabbitMqTopologyDeclarer {
    channel: Channel,
}

impl RabbitMqTopologyDeclarer {
    pub fn new(channel: Channel) -> Self {
        Self { channel }
    }

    async fn declare_queue(&self, name: &str, args: FieldTable) -> Result<()> {
        self.channel
            .queue_declare(
                name.into(),
                QueueDeclareOptions {
                    durable: true,
                    ..Default::default()
                },
                args,
            )
            .await
            .map_err(|e| ShoveError::Topology(format!("failed to declare queue '{name}': {e}")))?;
        Ok(())
    }

    async fn declare_unsequenced(&self, topology: &QueueTopology) -> Result<()> {
        if let Some(dlq) = topology.dlq() {
            self.declare_queue(dlq, FieldTable::default()).await?;
        }

        let mut main_args = FieldTable::default();
        if let Some(dlq) = topology.dlq() {
            with_dlq_routing(&mut main_args, dlq);
        }
        self.declare_queue(topology.queue(), main_args).await?;

        for hq in topology.hold_queues() {
            let args = hold_queue_args(topology.queue(), hq.delay().as_millis() as i64);
            self.declare_queue(hq.name(), args).await?;
        }

        Ok(())
    }

    async fn declare_sequenced(&self, topology: &QueueTopology) -> Result<()> {
        let seq = topology.sequencing().ok_or(ShoveError::Topology(
            "declare_sequenced called without sequencing config".into(),
        ))?;

        if let Some(dlq) = topology.dlq() {
            self.declare_queue(dlq, FieldTable::default()).await?;
        }

        // 2. Declare consistent-hash exchange
        self.channel
            .exchange_declare(
                seq.exchange().into(),
                lapin::ExchangeKind::Custom("x-consistent-hash".to_string()),
                ExchangeDeclareOptions {
                    durable: true,
                    ..Default::default()
                },
                FieldTable::default(),
            )
            .await
            .map_err(|e| {
                ShoveError::Topology(format!(
                    "failed to declare exchange '{}': {e}",
                    seq.exchange()
                ))
            })?;

        // 3. Declare N sub-queues with single-active-consumer, bind to hash exchange
        for i in 0..seq.routing_shards() {
            let sub_queue = format!("{}-seq-{i}", topology.queue());

            // Per-shard hold queues dead-letter back to this sub-queue
            for hq in topology.shard_hold_queue_names(i) {
                let args = hold_queue_args(&sub_queue, hq.delay().as_millis() as i64);
                self.declare_queue(hq.name(), args).await?;
            }

            let mut args = FieldTable::default();
            args.insert(X_SINGLE_ACTIVE_CONSUMER.into(), AMQPValue::Boolean(true));
            if let Some(dlq) = topology.dlq() {
                with_dlq_routing(&mut args, dlq);
            }
            self.declare_queue(&sub_queue, args).await?;

            // Bind to hash exchange — routing weight "1" for even distribution
            self.channel
                .queue_bind(
                    sub_queue.as_str().into(),
                    seq.exchange().into(),
                    "1".into(),
                    QueueBindOptions::default(),
                    FieldTable::default(),
                )
                .await
                .map_err(|e| {
                    ShoveError::Topology(format!(
                        "failed to bind '{sub_queue}' to '{}': {e}",
                        seq.exchange()
                    ))
                })?;
        }

        Ok(())
    }
}

impl RabbitMqTopologyDeclarer {
    pub async fn declare(&self, topology: &QueueTopology) -> Result<()> {
        if topology.sequencing().is_some() {
            self.declare_sequenced(topology).await
        } else {
            self.declare_unsequenced(topology).await
        }
    }
}