rskit-http 0.1.0-alpha.1

Framework-neutral HTTP abstractions and Tower adapters for rskit transport
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

use http::StatusCode;
use rskit_errors::{AppError, ErrorCode};

/// Framework-neutral HTTP request type.
pub type HttpRequest<B = Vec<u8>> = http::Request<B>;

/// Framework-neutral HTTP response type.
pub type HttpResponse<B = Vec<u8>> = http::Response<B>;

/// Framework-neutral HTTP header collection.
pub type HttpHeaders = http::HeaderMap;

/// Framework-neutral HTTP status code.
pub type HttpStatusCode = http::StatusCode;

/// Convert an HTTP status code into the canonical rskit error code.
#[must_use]
pub fn status_to_error_code(status: StatusCode) -> ErrorCode {
    match status.as_u16() {
        400 => ErrorCode::InvalidInput,
        401 => ErrorCode::Unauthorized,
        403 => ErrorCode::Forbidden,
        404 => ErrorCode::NotFound,
        409 => ErrorCode::Conflict,
        429 => ErrorCode::RateLimited,
        408 => ErrorCode::Cancelled,
        500 => ErrorCode::Internal,
        502 => ErrorCode::ExternalService,
        503 => ErrorCode::ServiceUnavailable,
        504 => ErrorCode::Timeout,
        _ if status.is_client_error() || status.is_server_error() => ErrorCode::ExternalService,
        _ => ErrorCode::Internal,
    }
}

/// Return `true` when a status is in the successful 2xx range.
#[must_use]
pub fn is_success_status(status: StatusCode) -> bool {
    status.is_success()
}

/// Return the HTTP status code carried by an [`AppError`].
#[must_use]
pub fn app_error_status(error: &AppError) -> StatusCode {
    error.http_status()
}

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

    #[test]
    fn maps_http_status_to_error_code() {
        assert_eq!(
            status_to_error_code(StatusCode::BAD_REQUEST),
            ErrorCode::InvalidInput
        );
        assert_eq!(
            status_to_error_code(StatusCode::NOT_FOUND),
            ErrorCode::NotFound
        );
        assert_eq!(
            status_to_error_code(StatusCode::TOO_MANY_REQUESTS),
            ErrorCode::RateLimited
        );
        assert_eq!(
            status_to_error_code(StatusCode::BAD_GATEWAY),
            ErrorCode::ExternalService
        );
        assert_eq!(
            status_to_error_code(StatusCode::SERVICE_UNAVAILABLE),
            ErrorCode::ServiceUnavailable
        );
        assert_eq!(
            status_to_error_code(StatusCode::GATEWAY_TIMEOUT),
            ErrorCode::Timeout
        );
        assert_eq!(
            status_to_error_code(StatusCode::INTERNAL_SERVER_ERROR),
            ErrorCode::Internal
        );
    }

    #[test]
    fn canonical_server_statuses_round_trip_through_error_code() {
        for code in [
            ErrorCode::ServiceUnavailable,
            ErrorCode::Timeout,
            ErrorCode::ExternalService,
            ErrorCode::Internal,
        ] {
            assert_eq!(status_to_error_code(code.http_status()), code);
        }
    }

    #[test]
    fn cancelled_status_round_trips_through_error_code() {
        let status = ErrorCode::Cancelled.http_status();
        assert_eq!(status_to_error_code(status), ErrorCode::Cancelled);
    }

    #[test]
    fn exposes_protocol_types_without_framework_coupling() {
        let request: HttpRequest = http::Request::builder()
            .uri("/healthz")
            .body(Vec::new())
            .unwrap();
        let response: HttpResponse = http::Response::builder()
            .status(StatusCode::OK)
            .body(Vec::new())
            .unwrap();

        assert_eq!(request.uri(), "/healthz");
        assert!(is_success_status(response.status()));
    }
}