mailbridge 0.1.0

Provider-neutral transactional email library for Rust services
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
use std::any::Any;
use std::collections::VecDeque;
use std::fmt;
use std::sync::Arc;
use std::time::{Duration, Instant};

use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use tokio::sync::Mutex;
use uuid::Uuid;

use crate::client::SendReceipt;
use crate::config::QueueBackend;
use crate::email::EmailMessage;
use crate::error::{MailError, Result};

#[cfg(feature = "queue-postgres")]
use secrecy::{ExposeSecret, SecretString};

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct QueueId(String);

impl QueueId {
    #[must_use]
    pub fn new(value: impl Into<String>) -> Self {
        Self(value.into())
    }

    #[must_use]
    pub fn new_uuid() -> Self {
        Self(Uuid::new_v4().to_string())
    }

    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl std::fmt::Display for QueueId {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(&self.0)
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct QueueItem {
    message: EmailMessage,
    idempotency_key: Option<String>,
}

impl QueueItem {
    #[must_use]
    pub fn new(message: EmailMessage) -> Self {
        Self {
            message,
            idempotency_key: None,
        }
    }

    #[must_use]
    pub fn with_idempotency_key(mut self, key: impl Into<String>) -> Self {
        self.idempotency_key = Some(key.into());
        self
    }

    #[must_use]
    pub fn into_message(self) -> EmailMessage {
        match self.idempotency_key {
            Some(key) => self.message.with_idempotency_key(key),
            None => self.message.ensure_idempotency_key(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct QueuedEmail {
    id: QueueId,
    message: EmailMessage,
    attempt_count: u32,
}

impl QueuedEmail {
    #[must_use]
    pub fn new(id: QueueId, message: EmailMessage, attempt_count: u32) -> Self {
        Self {
            id,
            message,
            attempt_count,
        }
    }

    #[must_use]
    pub fn id(&self) -> &QueueId {
        &self.id
    }

    #[must_use]
    pub fn message(&self) -> &EmailMessage {
        &self.message
    }

    #[must_use]
    pub const fn attempt_count(&self) -> u32 {
        self.attempt_count
    }

    #[must_use]
    pub fn into_message(self) -> EmailMessage {
        self.message
    }
}

#[async_trait]
pub trait MailQueue: Send + Sync {
    fn as_any(&self) -> &dyn Any;
    async fn enqueue(&self, item: QueueItem) -> Result<QueueId>;
    async fn reserve_batch(&self, worker_id: &str, limit: u32) -> Result<Vec<QueuedEmail>>;
    async fn mark_sent(&self, id: &QueueId, receipt: &SendReceipt) -> Result<()>;
    async fn release_for_retry(
        &self,
        id: &QueueId,
        delay: Duration,
        error: &MailError,
    ) -> Result<()>;
    async fn dead_letter(&self, id: &QueueId, error: &MailError) -> Result<()>;
    async fn pending_len(&self) -> Result<usize>;
    async fn dead_letter_len(&self) -> Result<usize>;
}

#[derive(Clone)]
pub struct QueueHandle {
    inner: Arc<dyn MailQueue>,
}

impl fmt::Debug for QueueHandle {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("QueueHandle")
            .finish_non_exhaustive()
    }
}

impl QueueHandle {
    #[must_use]
    pub fn new(queue: impl MailQueue + 'static) -> Self {
        Self {
            inner: Arc::new(queue),
        }
    }

    #[must_use]
    pub fn from_arc(queue: Arc<dyn MailQueue>) -> Self {
        Self { inner: queue }
    }

    #[must_use]
    pub fn memory(capacity: usize) -> Self {
        Self::new(MemoryQueue::new(capacity))
    }

    #[must_use]
    pub fn memory_default() -> Self {
        Self::memory(1024)
    }

    /// Builds a queue handle for a configured backend.
    ///
    /// # Errors
    ///
    /// Returns an error when the backend feature is disabled or the durable
    /// backend cannot be initialized.
    pub async fn from_backend(backend: &QueueBackend) -> Result<Self> {
        match backend {
            QueueBackend::Memory => Ok(Self::memory_default()),
            QueueBackend::Sqlite { path } => {
                #[cfg(feature = "queue-sqlite")]
                {
                    crate::queue::SqliteQueue::connect(path.clone())
                        .await
                        .map(crate::queue::SqliteQueue::handle)
                }
                #[cfg(not(feature = "queue-sqlite"))]
                {
                    let _ = path;
                    Err(MailError::Config(
                        "queue backend sqlite requires the queue-sqlite feature".to_owned(),
                    ))
                }
            }
            QueueBackend::Postgres { database_url } => {
                #[cfg(feature = "queue-postgres")]
                {
                    crate::queue::PostgresQueue::connect(secret_copy(database_url))
                        .await
                        .map(crate::queue::PostgresQueue::handle)
                }
                #[cfg(not(feature = "queue-postgres"))]
                {
                    let _ = database_url;
                    Err(MailError::Config(
                        "queue backend postgres requires the queue-postgres feature".to_owned(),
                    ))
                }
            }
            QueueBackend::Scylla {
                uri,
                keyspace,
                table,
            } => {
                #[cfg(feature = "queue-scylla")]
                {
                    Box::pin(crate::queue::ScyllaQueue::connect(
                        uri.clone(),
                        keyspace.clone(),
                        table.clone(),
                    ))
                    .await
                    .map(crate::queue::ScyllaQueue::handle)
                }
                #[cfg(not(feature = "queue-scylla"))]
                {
                    let _ = (uri, keyspace, table);
                    Err(MailError::Config(
                        "queue backend scylla requires the queue-scylla feature".to_owned(),
                    ))
                }
            }
        }
    }

    /// Returns the number of pending messages.
    ///
    /// # Errors
    ///
    /// Returns an error when the backing queue cannot count pending messages.
    pub async fn pending_len(&self) -> Result<usize> {
        self.inner.pending_len().await
    }

    /// Returns the number of dead-lettered messages.
    ///
    /// # Errors
    ///
    /// Returns an error when the backing queue cannot count dead letters.
    pub async fn dead_letter_len(&self) -> Result<usize> {
        self.inner.dead_letter_len().await
    }

    #[must_use]
    pub fn is_memory(&self) -> bool {
        self.inner.as_any().is::<MemoryQueue>()
    }
}

#[cfg(feature = "queue-postgres")]
fn secret_copy(secret: &SecretString) -> SecretString {
    SecretString::new(secret.expose_secret().to_owned().into_boxed_str())
}

impl Default for QueueHandle {
    fn default() -> Self {
        Self::memory_default()
    }
}

#[async_trait]
impl MailQueue for QueueHandle {
    fn as_any(&self) -> &dyn Any {
        self.inner.as_any()
    }

    async fn enqueue(&self, item: QueueItem) -> Result<QueueId> {
        self.inner.enqueue(item).await
    }

    async fn reserve_batch(&self, worker_id: &str, limit: u32) -> Result<Vec<QueuedEmail>> {
        self.inner.reserve_batch(worker_id, limit).await
    }

    async fn mark_sent(&self, id: &QueueId, receipt: &SendReceipt) -> Result<()> {
        self.inner.mark_sent(id, receipt).await
    }

    async fn release_for_retry(
        &self,
        id: &QueueId,
        delay: Duration,
        error: &MailError,
    ) -> Result<()> {
        self.inner.release_for_retry(id, delay, error).await
    }

    async fn dead_letter(&self, id: &QueueId, error: &MailError) -> Result<()> {
        self.inner.dead_letter(id, error).await
    }

    async fn pending_len(&self) -> Result<usize> {
        self.inner.pending_len().await
    }

    async fn dead_letter_len(&self) -> Result<usize> {
        self.inner.dead_letter_len().await
    }
}

#[derive(Debug)]
struct MemoryQueue {
    capacity: usize,
    state: Mutex<MemoryQueueState>,
}

impl MemoryQueue {
    fn new(capacity: usize) -> Self {
        Self {
            capacity,
            state: Mutex::new(MemoryQueueState::default()),
        }
    }
}

#[async_trait]
impl MailQueue for MemoryQueue {
    fn as_any(&self) -> &dyn Any {
        self
    }

    async fn enqueue(&self, item: QueueItem) -> Result<QueueId> {
        let mut state = self.state.lock().await;
        if state.pending.len() >= self.capacity {
            return Err(MailError::Queue("memory queue is full".to_owned()));
        }

        let id = QueueId::new_uuid();
        let queued = PendingEmail {
            id: id.clone(),
            message: item.into_message(),
            available_at: Instant::now(),
            attempt_count: 0,
            locked_by: None,
            last_error: None,
        };
        state.pending.push_back(queued);

        Ok(id)
    }

    async fn reserve_batch(&self, worker_id: &str, limit: u32) -> Result<Vec<QueuedEmail>> {
        let mut state = self.state.lock().await;
        let now = Instant::now();
        let limit = usize::try_from(limit).unwrap_or(usize::MAX);
        let mut reserved = Vec::with_capacity(limit.min(state.pending.len()));

        let mut remaining = VecDeque::with_capacity(state.pending.len());
        while let Some(mut pending) = state.pending.pop_front() {
            if reserved.len() < limit && pending.available_at <= now && pending.locked_by.is_none()
            {
                pending.locked_by = Some(worker_id.to_owned());
                reserved.push(QueuedEmail::new(
                    pending.id.clone(),
                    pending.message.clone(),
                    pending.attempt_count,
                ));
                state.inflight.push(pending);
            } else {
                remaining.push_back(pending);
            }
        }

        state.pending = remaining;
        Ok(reserved)
    }

    async fn mark_sent(&self, id: &QueueId, _receipt: &SendReceipt) -> Result<()> {
        let mut state = self.state.lock().await;
        state.inflight.retain(|item| item.id != *id);
        Ok(())
    }

    async fn release_for_retry(
        &self,
        id: &QueueId,
        delay: Duration,
        error: &MailError,
    ) -> Result<()> {
        let mut state = self.state.lock().await;
        let Some(index) = state.inflight.iter().position(|item| item.id == *id) else {
            return Err(MailError::Queue(format!("queued message not found: {id}")));
        };

        let mut item = state.inflight.remove(index);
        item.attempt_count = item.attempt_count.saturating_add(1);
        item.available_at = Instant::now() + delay;
        item.locked_by = None;
        item.last_error = Some(error.to_string());
        state.pending.push_back(item);

        Ok(())
    }

    async fn dead_letter(&self, id: &QueueId, error: &MailError) -> Result<()> {
        let mut state = self.state.lock().await;
        let Some(index) = state.inflight.iter().position(|item| item.id == *id) else {
            return Err(MailError::Queue(format!("queued message not found: {id}")));
        };

        let mut item = state.inflight.remove(index);
        item.last_error = Some(error.to_string());
        state.dead_letters.push(item);

        Ok(())
    }

    async fn pending_len(&self) -> Result<usize> {
        Ok(self.state.lock().await.pending.len())
    }

    async fn dead_letter_len(&self) -> Result<usize> {
        Ok(self.state.lock().await.dead_letters.len())
    }
}

#[derive(Debug, Default)]
struct MemoryQueueState {
    pending: VecDeque<PendingEmail>,
    inflight: Vec<PendingEmail>,
    dead_letters: Vec<PendingEmail>,
}

#[derive(Debug, Clone)]
struct PendingEmail {
    id: QueueId,
    message: EmailMessage,
    available_at: Instant,
    attempt_count: u32,
    locked_by: Option<String>,
    last_error: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::client::{MessageId, SendReceipt};

    #[tokio::test]
    async fn memory_queue_enqueues_and_reserves_message() {
        let queue = QueueHandle::memory(4);
        let message = test_message();

        let id = queue
            .enqueue(QueueItem::new(message))
            .await
            .expect("enqueue succeeds");
        let reserved = queue
            .reserve_batch("worker", 2)
            .await
            .expect("reserve succeeds");

        assert_eq!(reserved.len(), 1);
        assert_eq!(reserved[0].id(), &id);
        assert!(reserved[0].message().idempotency_key().is_some());
    }

    #[tokio::test]
    async fn memory_queue_dead_letters_reserved_message() {
        let queue = QueueHandle::memory(4);
        let id = queue
            .enqueue(QueueItem::new(test_message()))
            .await
            .expect("enqueue succeeds");
        let _reserved = queue
            .reserve_batch("worker", 1)
            .await
            .expect("reserve succeeds");

        queue
            .dead_letter(&id, &MailError::Validation("bad".to_owned()))
            .await
            .expect("dead letter succeeds");

        assert_eq!(queue.dead_letter_len().await.expect("len"), 1);
    }

    #[tokio::test(start_paused = true)]
    async fn memory_queue_releases_for_retry_after_delay() {
        let queue = QueueHandle::memory(4);
        let id = queue
            .enqueue(QueueItem::new(test_message()))
            .await
            .expect("enqueue succeeds");
        let _reserved = queue
            .reserve_batch("worker", 1)
            .await
            .expect("reserve succeeds");

        queue
            .release_for_retry(&id, Duration::from_secs(2), &MailError::RateLimited)
            .await
            .expect("release succeeds");

        assert!(
            queue
                .reserve_batch("worker", 1)
                .await
                .expect("reserve")
                .is_empty()
        );
    }

    fn test_message() -> EmailMessage {
        EmailMessage::builder()
            .from("App", "sender@example.com")
            .expect("valid from")
            .to("User", "user@example.net")
            .expect("valid to")
            .subject("Hello")
            .text("Body")
            .build()
            .expect("valid message")
    }

    #[allow(dead_code)]
    fn test_receipt() -> SendReceipt {
        SendReceipt::new("test", MessageId::new("message"), None)
    }
}