road-runner-common 0.11.0

Shared Rust utilities for exchange ecosystem backend 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

use road_runner_common::error::{AppError, ErrorCode};
use road_runner_common::response::ApiErrorDetail;

#[test]
fn error_code_wire_strings_are_stable() {
    // Arrange / Act / Assert
    assert_eq!(ErrorCode::Validation.as_str(), "VALIDATION_ERROR");
    assert_eq!(ErrorCode::Unauthorized.as_str(), "UNAUTHORIZED");
    assert_eq!(ErrorCode::Forbidden.as_str(), "FORBIDDEN");
    assert_eq!(ErrorCode::NotFound.as_str(), "NOT_FOUND");
    assert_eq!(ErrorCode::Conflict.as_str(), "CONFLICT");
    assert_eq!(ErrorCode::RateLimited.as_str(), "RATE_LIMITED");
    assert_eq!(ErrorCode::Internal.as_str(), "INTERNAL_ERROR");
    assert_eq!(ErrorCode::External.as_str(), "EXTERNAL_ERROR");
    assert_eq!(ErrorCode::ServiceUnavailable.as_str(), "SERVICE_UNAVAILABLE");
}

#[test]
fn app_error_code_and_public_message_cover_all_variants() {
    // Arrange
    let cases = vec![
        (AppError::validation("invalid", vec![]), ErrorCode::Validation, "invalid"),
        (AppError::Unauthorized { message: "login".to_string() }, ErrorCode::Unauthorized, "login"),
        (AppError::Forbidden { message: "no".to_string() }, ErrorCode::Forbidden, "no"),
        (AppError::NotFound { message: "missing".to_string() }, ErrorCode::NotFound, "missing"),
        (AppError::Conflict { message: "duplicate".to_string() }, ErrorCode::Conflict, "duplicate"),
        (AppError::RateLimited { message: "slow".to_string() }, ErrorCode::RateLimited, "slow"),
        (AppError::internal("secret", None), ErrorCode::Internal, "Internal server error"),
        (AppError::external("upstream detail", None), ErrorCode::External, "Upstream service error"),
        (
            AppError::ServiceUnavailable { message: "down".to_string() },
            ErrorCode::ServiceUnavailable,
            "down",
        ),
    ];

    // Act / Assert
    for (error, code, public_message) in cases {
        assert_eq!(error.code().as_str(), code.as_str());
        assert_eq!(error.public_message(), public_message);
    }
}

#[test]
fn validation_constructor_preserves_details_in_api_response() {
    // Arrange
    let error = AppError::validation(
        "invalid request",
        vec![ApiErrorDetail::new("FIELD", "bad").with_field("name")],
    );

    // Act
    let response = error.to_api_response("rid-validation");

    // Assert
    assert!(!response.success);
    assert_eq!(response.meta.request_id, "rid-validation");
    assert_eq!(response.errors.len(), 1);
    assert_eq!(response.errors[0].code, "FIELD");
    assert_eq!(response.errors[0].field.as_deref(), Some("name"));
}

#[test]
fn validation_without_details_uses_error_code_and_message() {
    // Arrange
    let error = AppError::validation("missing body", vec![]);

    // Act
    let response = error.to_api_response("rid-empty-validation");

    // Assert
    assert_eq!(response.errors.len(), 1);
    assert_eq!(response.errors[0].code, "VALIDATION_ERROR");
    assert_eq!(response.errors[0].message, "missing body");
}

#[test]
fn non_validation_api_response_contains_single_public_error() {
    // Arrange
    let error = AppError::internal("database password leaked here", None);

    // Act
    let response = error.to_api_response("rid-internal");

    // Assert
    assert!(!response.success);
    assert_eq!(response.errors.len(), 1);
    assert_eq!(response.errors[0].code, "INTERNAL_ERROR");
    assert_eq!(response.errors[0].message, "Internal server error");
}

#[cfg(feature = "web")]
mod web {
    use actix_web::http::StatusCode;
    use actix_web::ResponseError;
    use road_runner_common::error::AppError;

    #[test]
    fn http_status_maps_all_error_variants() {
        // Arrange
        let cases = vec![
            (AppError::validation("invalid", vec![]), StatusCode::BAD_REQUEST),
            (AppError::Unauthorized { message: "login".to_string() }, StatusCode::UNAUTHORIZED),
            (AppError::Forbidden { message: "no".to_string() }, StatusCode::FORBIDDEN),
            (AppError::NotFound { message: "missing".to_string() }, StatusCode::NOT_FOUND),
            (AppError::Conflict { message: "duplicate".to_string() }, StatusCode::CONFLICT),
            (AppError::RateLimited { message: "slow".to_string() }, StatusCode::TOO_MANY_REQUESTS),
            (AppError::internal("secret", None), StatusCode::INTERNAL_SERVER_ERROR),
            (AppError::external("upstream", None), StatusCode::BAD_GATEWAY),
            (
                AppError::ServiceUnavailable { message: "down".to_string() },
                StatusCode::SERVICE_UNAVAILABLE,
            ),
        ];

        // Act / Assert
        for (error, status) in cases {
            assert_eq!(error.http_status(), status);
            assert_eq!(error.status_code(), status);
        }
    }

    #[test]
    fn error_response_uses_status_and_json_content_type() {
        // Arrange
        let error = AppError::Forbidden { message: "blocked".to_string() };

        // Act
        let response = error.error_response();

        // Assert
        assert_eq!(response.status(), StatusCode::FORBIDDEN);
        assert_eq!(
            response.headers().get("content-type").unwrap().to_str().unwrap(),
            "application/json"
        );
    }
}