alien-worker-protocol 3.3.39

gRPC Worker app protocol for task delivery, lifecycle, and waitUntil
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

//! Validation shared by batch transports and application hosts.

use std::collections::{HashMap, HashSet};

use crate::control::{queue_delivery_outcome::Disposition, QueueBatch, QueueBatchResult};

/// Validate every outcome before making any acknowledgment decision.
/// Returns dispositions in delivery order, regardless of result order.
/// Invalid input or results cause the entire batch to remain unacknowledged.
pub fn validate_outcomes(
    batch: &QueueBatch,
    result: &QueueBatchResult,
) -> Option<Vec<Disposition>> {
    if batch.deliveries.is_empty() || batch.deliveries.len() != result.outcomes.len() {
        return None;
    }
    let mut identities = HashSet::with_capacity(batch.deliveries.len());
    for delivery in &batch.deliveries {
        if delivery.delivery_id.is_empty()
            || delivery.message.is_none()
            || !identities.insert(delivery.delivery_id.as_str())
        {
            return None;
        }
    }
    let mut outcomes = HashMap::with_capacity(result.outcomes.len());
    for outcome in &result.outcomes {
        let disposition = Disposition::try_from(outcome.disposition).ok()?;
        if disposition == Disposition::Unspecified
            || !identities.contains(outcome.delivery_id.as_str())
            || outcomes
                .insert(outcome.delivery_id.as_str(), disposition)
                .is_some()
        {
            return None;
        }
    }
    batch
        .deliveries
        .iter()
        .map(|delivery| outcomes.get(delivery.delivery_id.as_str()).copied())
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::control::{QueueDelivery, QueueDeliveryOutcome, QueueMessage};

    fn batch() -> QueueBatch {
        QueueBatch {
            source: "jobs".into(),
            deliveries: ["attempt-a", "attempt-b"]
                .into_iter()
                .map(|id| QueueDelivery {
                    delivery_id: id.into(),
                    message: Some(QueueMessage {
                        id: "same-provider-id".into(),
                        ..Default::default()
                    }),
                })
                .collect(),
        }
    }

    fn result() -> QueueBatchResult {
        QueueBatchResult {
            outcomes: vec![
                QueueDeliveryOutcome {
                    delivery_id: "attempt-b".into(),
                    disposition: Disposition::Retry as i32,
                },
                QueueDeliveryOutcome {
                    delivery_id: "attempt-a".into(),
                    disposition: Disposition::Success as i32,
                },
            ],
        }
    }

    #[test]
    fn correlates_attempts_independently_of_provider_ids_and_result_order() {
        assert_eq!(
            validate_outcomes(&batch(), &result()),
            Some(vec![Disposition::Success, Disposition::Retry])
        );
    }

    #[test]
    fn rejects_missing_duplicate_unknown_and_unspecified_outcomes() {
        let mut missing = result();
        missing.outcomes.pop();
        assert_eq!(validate_outcomes(&batch(), &missing), None);
        let mut duplicate = result();
        duplicate.outcomes[0].delivery_id = "attempt-a".into();
        assert_eq!(validate_outcomes(&batch(), &duplicate), None);
        let mut unknown = result();
        unknown.outcomes[0].delivery_id = "attempt-c".into();
        assert_eq!(validate_outcomes(&batch(), &unknown), None);
        for invalid in [0, 99] {
            let mut unspecified = result();
            unspecified.outcomes[0].disposition = invalid;
            assert_eq!(validate_outcomes(&batch(), &unspecified), None);
        }
        let mut ambiguous = batch();
        ambiguous.deliveries[0].delivery_id = "attempt-b".into();
        assert_eq!(validate_outcomes(&ambiguous, &result()), None);
    }
}