mechanics-core 0.2.2

mechanics automation framework (core)
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

use super::super::*;
use crate::internal::http::EndpointHttpHeaders;
use serde_json::json;

#[test]
fn endpoint_deserializes_retry_policy_from_json() {
    let endpoint: HttpEndpoint = serde_json::from_value(json!({
        "method": "get",
        "url_template": "https://example.com/{id}",
        "url_param_specs": { "id": {} },
        "retry_policy": {
            "max_attempts": 4,
            "base_backoff_ms": 25,
            "max_backoff_ms": 200,
            "max_retry_delay_ms": 500,
            "rate_limit_backoff_ms": 75,
            "retry_on_io_errors": true,
            "retry_on_timeout": true,
            "respect_retry_after": true,
            "retry_on_status": [429, 503]
        }
    }))
    .expect("endpoint with retry policy should deserialize");

    endpoint
        .validate_config()
        .expect("retry policy values should validate");
}

#[test]
fn endpoint_rejects_invalid_retry_policy() {
    let err = serde_json::from_value::<MechanicsConfig>(json!({
        "endpoints": {
            "bad": {
                "method": "get",
                "url_template": "https://example.com/{id}",
                "url_param_specs": { "id": {} },
                "retry_policy": {
                    "max_attempts": 0
                }
            }
        }
    }))
    .expect_err("invalid retry policy should fail config parsing");

    assert!(
        err.to_string()
            .contains("retry_policy.max_attempts must be > 0")
    );
}

#[test]
fn endpoint_rejects_unknown_retry_policy_fields() {
    let err = serde_json::from_value::<MechanicsConfig>(json!({
        "endpoints": {
            "bad": {
                "method": "get",
                "url_template": "https://example.com/{id}",
                "url_param_specs": { "id": {} },
                "retry_policy": {
                    "max_attempts": 2,
                    "unknown": true
                }
            }
        }
    }))
    .expect_err("unknown retry_policy fields should fail config parsing");

    assert!(err.to_string().contains("unknown field"));
}

#[test]
fn endpoint_rejects_zero_max_retry_delay() {
    let err = serde_json::from_value::<MechanicsConfig>(json!({
        "endpoints": {
            "bad": {
                "method": "get",
                "url_template": "https://example.com/{id}",
                "url_param_specs": { "id": {} },
                "retry_policy": {
                    "max_attempts": 2,
                    "max_retry_delay_ms": 0
                }
            }
        }
    }))
    .expect_err("zero max_retry_delay_ms should fail config parsing");

    assert!(
        err.to_string()
            .contains("retry_policy.max_retry_delay_ms must be > 0")
    );
}

#[test]
fn retry_policy_uses_retry_after_for_rate_limit() {
    let policy = EndpointRetryPolicy {
        max_attempts: 3,
        base_backoff_ms: 10,
        max_backoff_ms: 100,
        max_retry_delay_ms: 5_000,
        rate_limit_backoff_ms: 250,
        retry_on_io_errors: true,
        retry_on_timeout: true,
        respect_retry_after: true,
        retry_on_status: vec![429],
    };

    let mut headers = EndpointHttpHeaders::new();
    headers.insert("retry-after", "2");
    let delay = policy.retry_delay_for_status(429, &headers, 1);
    assert_eq!(delay, std::time::Duration::from_secs(2));
}

#[test]
fn retry_policy_falls_back_to_rate_limit_backoff_without_retry_after() {
    let policy = EndpointRetryPolicy {
        max_attempts: 3,
        base_backoff_ms: 10,
        max_backoff_ms: 100,
        max_retry_delay_ms: 5_000,
        rate_limit_backoff_ms: 250,
        retry_on_io_errors: true,
        retry_on_timeout: true,
        respect_retry_after: true,
        retry_on_status: vec![429],
    };

    let delay = policy.retry_delay_for_status(429, &EndpointHttpHeaders::new(), 1);
    assert_eq!(delay, std::time::Duration::from_millis(250));
}

#[test]
fn retry_policy_backoff_caps_to_max_delay() {
    let policy = EndpointRetryPolicy {
        max_attempts: 5,
        base_backoff_ms: 200,
        max_backoff_ms: 10_000,
        max_retry_delay_ms: 500,
        rate_limit_backoff_ms: 100,
        retry_on_io_errors: true,
        retry_on_timeout: true,
        respect_retry_after: true,
        retry_on_status: vec![500],
    };

    let delay = policy.retry_delay_for_status(500, &EndpointHttpHeaders::new(), 4);
    assert_eq!(delay, std::time::Duration::from_millis(500));
}