iei-protocol 0.1.0

A bounded, acknowledged delivery state machine
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
//! A bounded, acknowledged delivery state machine.
//!
//! This crate deliberately leaves transport I/O to its caller. [`Delivery`]
//! owns the protocol state and makes send, wait, retry, expiry, and completion
//! decisions deterministic.

#![forbid(unsafe_code)]
#![warn(missing_docs)]

use std::error::Error;
use std::fmt;

/// A payload with stable identity and a bounded lifetime.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Envelope<T> {
    id: String,
    payload: T,
    created_at_ms: u64,
    expires_at_ms: u64,
}

impl<T> Envelope<T> {
    /// Creates an envelope.
    ///
    /// `ttl_ms` must be positive, the identifier must not be blank, and the
    /// calculated expiry must fit in `u64`.
    pub fn new(
        id: impl Into<String>,
        payload: T,
        created_at_ms: u64,
        ttl_ms: u64,
    ) -> Result<Self, ProtocolError> {
        let id = id.into();
        if id.trim().is_empty() {
            return Err(ProtocolError::EmptyMessageId);
        }
        if ttl_ms == 0 {
            return Err(ProtocolError::ZeroTimeToLive);
        }
        let expires_at_ms = created_at_ms
            .checked_add(ttl_ms)
            .ok_or(ProtocolError::TimeOverflow)?;
        Ok(Self {
            id,
            payload,
            created_at_ms,
            expires_at_ms,
        })
    }

    /// Returns the stable message identifier.
    pub fn id(&self) -> &str {
        &self.id
    }

    /// Returns the payload.
    pub const fn payload(&self) -> &T {
        &self.payload
    }

    /// Returns the creation timestamp in monotonic milliseconds.
    pub const fn created_at_ms(&self) -> u64 {
        self.created_at_ms
    }

    /// Returns the exclusive expiry boundary in monotonic milliseconds.
    pub const fn expires_at_ms(&self) -> u64 {
        self.expires_at_ms
    }

    /// Consumes the envelope and returns its payload.
    pub fn into_payload(self) -> T {
        self.payload
    }
}

/// Retry limits for a delivery.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DeliveryPolicy {
    acknowledgement_timeout_ms: u64,
    max_attempts: u32,
}

impl DeliveryPolicy {
    /// Creates a policy with positive timeout and attempt count.
    pub fn new(acknowledgement_timeout_ms: u64, max_attempts: u32) -> Result<Self, ProtocolError> {
        if acknowledgement_timeout_ms == 0 {
            return Err(ProtocolError::ZeroAcknowledgementTimeout);
        }
        if max_attempts == 0 {
            return Err(ProtocolError::ZeroMaxAttempts);
        }
        Ok(Self {
            acknowledgement_timeout_ms,
            max_attempts,
        })
    }

    /// Returns acknowledgement timeout in milliseconds.
    pub const fn acknowledgement_timeout_ms(self) -> u64 {
        self.acknowledgement_timeout_ms
    }

    /// Returns the maximum number of send attempts.
    pub const fn max_attempts(self) -> u32 {
        self.max_attempts
    }
}

/// Current protocol state.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DeliveryState {
    /// Ready for a first send or retry.
    Ready,
    /// A send was recorded and acknowledgement is pending.
    AwaitingAcknowledgement {
        /// Timestamp at which the current attempt was sent.
        sent_at_ms: u64,
        /// Timestamp at which this attempt becomes eligible for retry.
        retry_at_ms: u64,
    },
    /// Acknowledgement was accepted.
    Delivered {
        /// Timestamp at which acknowledgement was accepted.
        acknowledged_at_ms: u64,
    },
    /// The envelope reached its expiry boundary.
    Expired {
        /// Timestamp at which expiry was observed.
        observed_at_ms: u64,
    },
    /// Every permitted attempt was used without acknowledgement.
    Exhausted {
        /// Timestamp at which exhaustion was observed.
        observed_at_ms: u64,
    },
}

/// Terminal result of a delivery.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DeliveryOutcome {
    /// Delivery was acknowledged.
    Delivered,
    /// The envelope expired.
    Expired,
    /// The retry limit was exhausted.
    Exhausted,
}

/// Instruction returned by [`Delivery::poll`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NextAction {
    /// The caller should make this numbered send attempt now.
    SendNow {
        /// One-based attempt number.
        attempt: u32,
    },
    /// No action is required before this monotonic timestamp.
    WaitUntil(u64),
    /// The delivery is terminal.
    Complete(DeliveryOutcome),
}

/// Result of recording an acknowledgement.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AckResult {
    /// The first valid acknowledgement completed the delivery.
    Accepted,
    /// Delivery was already acknowledged; no state changed.
    Duplicate,
}

/// Stateful delivery coordinator for one envelope.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Delivery<T> {
    envelope: Envelope<T>,
    policy: DeliveryPolicy,
    state: DeliveryState,
    attempts: u32,
    last_observed_ms: u64,
}

impl<T> Delivery<T> {
    /// Creates a ready delivery at the envelope's creation timestamp.
    pub const fn new(envelope: Envelope<T>, policy: DeliveryPolicy) -> Self {
        let last_observed_ms = envelope.created_at_ms;
        Self {
            envelope,
            policy,
            state: DeliveryState::Ready,
            attempts: 0,
            last_observed_ms,
        }
    }

    /// Returns the envelope.
    pub const fn envelope(&self) -> &Envelope<T> {
        &self.envelope
    }

    /// Returns the policy.
    pub const fn policy(&self) -> DeliveryPolicy {
        self.policy
    }

    /// Returns the current state.
    pub const fn state(&self) -> DeliveryState {
        self.state
    }

    /// Returns the number of send attempts already recorded.
    pub const fn attempts(&self) -> u32 {
        self.attempts
    }

    /// Advances protocol time and returns the next instruction.
    pub fn poll(&mut self, now_ms: u64) -> Result<NextAction, ProtocolError> {
        self.observe(now_ms)?;

        if let Some(outcome) = terminal_outcome(self.state) {
            return Ok(NextAction::Complete(outcome));
        }
        if self.expire_if_due(now_ms) {
            return Ok(NextAction::Complete(DeliveryOutcome::Expired));
        }

        match self.state {
            DeliveryState::Ready => self.ready_action(now_ms),
            DeliveryState::AwaitingAcknowledgement { retry_at_ms, .. } => {
                if now_ms < retry_at_ms {
                    Ok(NextAction::WaitUntil(
                        retry_at_ms.min(self.envelope.expires_at_ms),
                    ))
                } else if self.attempts < self.policy.max_attempts {
                    self.state = DeliveryState::Ready;
                    self.ready_action(now_ms)
                } else {
                    self.state = DeliveryState::Exhausted {
                        observed_at_ms: now_ms,
                    };
                    Ok(NextAction::Complete(DeliveryOutcome::Exhausted))
                }
            }
            DeliveryState::Delivered { .. }
            | DeliveryState::Expired { .. }
            | DeliveryState::Exhausted { .. } => unreachable!("terminal states handled above"),
        }
    }

    /// Records that the caller performed the currently available send.
    pub fn record_sent(&mut self, now_ms: u64) -> Result<(), ProtocolError> {
        self.observe(now_ms)?;
        if terminal_outcome(self.state).is_some() {
            return Err(ProtocolError::DeliveryAlreadyTerminal);
        }
        if self.expire_if_due(now_ms) {
            return Err(ProtocolError::DeliveryAlreadyTerminal);
        }
        if self.state != DeliveryState::Ready {
            return Err(ProtocolError::SendAlreadyAwaitingAcknowledgement);
        }
        if self.attempts >= self.policy.max_attempts {
            self.state = DeliveryState::Exhausted {
                observed_at_ms: now_ms,
            };
            return Err(ProtocolError::AttemptsExhausted);
        }

        let retry_at_ms = now_ms
            .checked_add(self.policy.acknowledgement_timeout_ms)
            .ok_or(ProtocolError::TimeOverflow)?;
        self.attempts += 1;
        self.state = DeliveryState::AwaitingAcknowledgement {
            sent_at_ms: now_ms,
            retry_at_ms,
        };
        Ok(())
    }

    /// Records an acknowledgement, accepting duplicates idempotently.
    pub fn acknowledge(&mut self, now_ms: u64) -> Result<AckResult, ProtocolError> {
        self.observe(now_ms)?;
        if matches!(self.state, DeliveryState::Delivered { .. }) {
            return Ok(AckResult::Duplicate);
        }
        if terminal_outcome(self.state).is_some() {
            return Err(ProtocolError::DeliveryAlreadyTerminal);
        }
        if self.expire_if_due(now_ms) {
            return Err(ProtocolError::DeliveryAlreadyTerminal);
        }

        if matches!(self.state, DeliveryState::AwaitingAcknowledgement { .. }) {
            self.state = DeliveryState::Delivered {
                acknowledged_at_ms: now_ms,
            };
            Ok(AckResult::Accepted)
        } else {
            Err(ProtocolError::UnexpectedAcknowledgement)
        }
    }

    fn ready_action(&mut self, now_ms: u64) -> Result<NextAction, ProtocolError> {
        if self.attempts < self.policy.max_attempts {
            Ok(NextAction::SendNow {
                attempt: self.attempts + 1,
            })
        } else {
            self.state = DeliveryState::Exhausted {
                observed_at_ms: now_ms,
            };
            Ok(NextAction::Complete(DeliveryOutcome::Exhausted))
        }
    }

    fn observe(&mut self, now_ms: u64) -> Result<(), ProtocolError> {
        if now_ms < self.last_observed_ms {
            return Err(ProtocolError::TimeMovedBackwards {
                previous_ms: self.last_observed_ms,
                supplied_ms: now_ms,
            });
        }
        self.last_observed_ms = now_ms;
        Ok(())
    }

    fn expire_if_due(&mut self, now_ms: u64) -> bool {
        if now_ms >= self.envelope.expires_at_ms {
            self.state = DeliveryState::Expired {
                observed_at_ms: now_ms,
            };
            true
        } else {
            false
        }
    }
}

fn terminal_outcome(state: DeliveryState) -> Option<DeliveryOutcome> {
    match state {
        DeliveryState::Delivered { .. } => Some(DeliveryOutcome::Delivered),
        DeliveryState::Expired { .. } => Some(DeliveryOutcome::Expired),
        DeliveryState::Exhausted { .. } => Some(DeliveryOutcome::Exhausted),
        DeliveryState::Ready | DeliveryState::AwaitingAcknowledgement { .. } => None,
    }
}

/// Invalid configuration, time, or protocol transition.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ProtocolError {
    /// The envelope identifier was blank.
    EmptyMessageId,
    /// The envelope time-to-live was zero.
    ZeroTimeToLive,
    /// The acknowledgement timeout was zero.
    ZeroAcknowledgementTimeout,
    /// The maximum attempt count was zero.
    ZeroMaxAttempts,
    /// Timestamp arithmetic overflowed.
    TimeOverflow,
    /// A timestamp was older than a previously observed timestamp.
    TimeMovedBackwards {
        /// Most recently observed timestamp.
        previous_ms: u64,
        /// Newly supplied timestamp.
        supplied_ms: u64,
    },
    /// A send was recorded while acknowledgement was already pending.
    SendAlreadyAwaitingAcknowledgement,
    /// An acknowledgement arrived before any send was recorded.
    UnexpectedAcknowledgement,
    /// An operation was attempted after terminal completion.
    DeliveryAlreadyTerminal,
    /// A send was requested after all attempts were used.
    AttemptsExhausted,
}

impl fmt::Display for ProtocolError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptyMessageId => formatter.write_str("message id must not be blank"),
            Self::ZeroTimeToLive => formatter.write_str("time-to-live must be greater than zero"),
            Self::ZeroAcknowledgementTimeout => {
                formatter.write_str("acknowledgement timeout must be greater than zero")
            }
            Self::ZeroMaxAttempts => {
                formatter.write_str("maximum attempts must be greater than zero")
            }
            Self::TimeOverflow => formatter.write_str("timestamp arithmetic overflowed"),
            Self::TimeMovedBackwards {
                previous_ms,
                supplied_ms,
            } => write!(
                formatter,
                "time moved backwards from {previous_ms} to {supplied_ms}"
            ),
            Self::SendAlreadyAwaitingAcknowledgement => {
                formatter.write_str("a send is already awaiting acknowledgement")
            }
            Self::UnexpectedAcknowledgement => {
                formatter.write_str("acknowledgement arrived before a send")
            }
            Self::DeliveryAlreadyTerminal => formatter.write_str("delivery is already terminal"),
            Self::AttemptsExhausted => formatter.write_str("all send attempts are exhausted"),
        }
    }
}

impl Error for ProtocolError {}

#[cfg(test)]
mod tests {
    use super::*;

    fn delivery(ttl: u64, timeout: u64, attempts: u32) -> Delivery<&'static str> {
        Delivery::new(
            Envelope::new("message-1", "payload", 1_000, ttl).unwrap(),
            DeliveryPolicy::new(timeout, attempts).unwrap(),
        )
    }

    #[test]
    fn ready_send_and_wait_are_explicit() {
        let mut delivery = delivery(10_000, 500, 3);
        assert_eq!(
            delivery.poll(1_000).unwrap(),
            NextAction::SendNow { attempt: 1 }
        );
        delivery.record_sent(1_000).unwrap();
        assert_eq!(delivery.attempts(), 1);
        assert_eq!(delivery.poll(1_200).unwrap(), NextAction::WaitUntil(1_500));
    }

    #[test]
    fn timeout_enables_next_numbered_attempt() {
        let mut delivery = delivery(10_000, 500, 3);
        delivery.record_sent(1_000).unwrap();
        assert_eq!(
            delivery.poll(1_500).unwrap(),
            NextAction::SendNow { attempt: 2 }
        );
        delivery.record_sent(1_500).unwrap();
        assert_eq!(delivery.attempts(), 2);
    }

    #[test]
    fn attempt_limit_terminates_delivery() {
        let mut delivery = delivery(10_000, 100, 2);
        delivery.record_sent(1_000).unwrap();
        assert_eq!(
            delivery.poll(1_100).unwrap(),
            NextAction::SendNow { attempt: 2 }
        );
        delivery.record_sent(1_100).unwrap();
        assert_eq!(
            delivery.poll(1_200).unwrap(),
            NextAction::Complete(DeliveryOutcome::Exhausted)
        );
    }

    #[test]
    fn expiry_has_priority_over_retry() {
        let mut delivery = delivery(200, 500, 3);
        delivery.record_sent(1_000).unwrap();
        assert_eq!(
            delivery.poll(1_200).unwrap(),
            NextAction::Complete(DeliveryOutcome::Expired)
        );
    }

    #[test]
    fn duplicate_acknowledgement_is_idempotent() {
        let mut delivery = delivery(10_000, 500, 3);
        delivery.record_sent(1_000).unwrap();
        assert_eq!(delivery.acknowledge(1_100).unwrap(), AckResult::Accepted);
        assert_eq!(delivery.acknowledge(1_200).unwrap(), AckResult::Duplicate);
        assert_eq!(
            delivery.poll(20_000).unwrap(),
            NextAction::Complete(DeliveryOutcome::Delivered)
        );
    }

    #[test]
    fn late_ack_before_envelope_expiry_is_accepted() {
        let mut delivery = delivery(10_000, 100, 3);
        delivery.record_sent(1_000).unwrap();
        assert_eq!(delivery.acknowledge(1_500).unwrap(), AckResult::Accepted);
    }

    #[test]
    fn invalid_transitions_are_rejected() {
        let mut delivery = delivery(10_000, 500, 3);
        assert_eq!(
            delivery.acknowledge(1_000),
            Err(ProtocolError::UnexpectedAcknowledgement)
        );
        delivery.record_sent(1_000).unwrap();
        assert_eq!(
            delivery.record_sent(1_001),
            Err(ProtocolError::SendAlreadyAwaitingAcknowledgement)
        );
    }

    #[test]
    fn time_cannot_move_backwards() {
        let mut delivery = delivery(10_000, 500, 3);
        delivery.poll(1_100).unwrap();
        assert_eq!(
            delivery.poll(1_099),
            Err(ProtocolError::TimeMovedBackwards {
                previous_ms: 1_100,
                supplied_ms: 1_099,
            })
        );
    }

    #[test]
    fn invalid_configuration_is_rejected() {
        assert_eq!(
            Envelope::new(" ", (), 0, 1),
            Err(ProtocolError::EmptyMessageId)
        );
        assert_eq!(
            Envelope::new("id", (), 0, 0),
            Err(ProtocolError::ZeroTimeToLive)
        );
        assert_eq!(
            DeliveryPolicy::new(0, 1),
            Err(ProtocolError::ZeroAcknowledgementTimeout)
        );
        assert_eq!(
            DeliveryPolicy::new(1, 0),
            Err(ProtocolError::ZeroMaxAttempts)
        );
    }
}