secure_errors 0.1.0

Secure error handling with public-safe responses, incident IDs, and panic boundaries.
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

//! BDD tests for M15: ErrorMappingLayer and retry-after.

#![cfg(feature = "axum")]

use axum::body::Body;
use axum::routing::get;
use axum::Router;
use http::{Request, StatusCode};
use http_body_util::BodyExt;
use secure_errors::kind::AppError;
use secure_errors::middleware::ErrorMappingLayer;
use tower::ServiceExt;

async fn validation_error_handler() -> Result<String, AppError> {
    Err(AppError::Validation { code: "bad_email" })
}

async fn forbidden_error_handler() -> Result<String, AppError> {
    Err(AppError::Forbidden {
        policy: "admin_only",
    })
}

async fn rate_limit_handler() -> Result<String, AppError> {
    Err(AppError::RateLimit {
        retry_after_seconds: Some(30),
    })
}

async fn rate_limit_no_retry_handler() -> Result<String, AppError> {
    Err(AppError::RateLimit {
        retry_after_seconds: None,
    })
}

async fn ok_handler() -> Result<String, AppError> {
    Ok("hello".to_string())
}

async fn send_get(app: Router, uri: &str) -> http::Response<Body> {
    let req = Request::builder().uri(uri).body(Body::empty()).unwrap();
    app.oneshot(req).await.unwrap()
}

// ---------- Feature: ErrorMappingLayer ----------

#[tokio::test]
async fn apperror_validation_auto_mapped_to_400() {
    // Given: handler returns Err(AppError::Validation)
    let app = Router::new()
        .route("/test", get(validation_error_handler))
        .layer(ErrorMappingLayer);

    // When: through ErrorMappingLayer
    let resp = send_get(app, "/test").await;

    // Then: 400 response with PublicError
    assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    let json: serde_json::Value = serde_json::from_slice(&body).unwrap();
    assert_eq!(json["code"], "invalid_request");
}

#[tokio::test]
async fn apperror_forbidden_auto_mapped_to_403() {
    // Given: handler returns Err(AppError::Forbidden)
    let app = Router::new()
        .route("/test", get(forbidden_error_handler))
        .layer(ErrorMappingLayer);

    // When: through layer
    let resp = send_get(app, "/test").await;

    // Then: 403
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    let json: serde_json::Value = serde_json::from_slice(&body).unwrap();
    assert_eq!(json["code"], "forbidden");
}

#[tokio::test]
async fn apperror_ratelimit_with_retry_after() {
    // Given: handler returns Err(AppError::RateLimit { retry_after_seconds: Some(30) })
    let app = Router::new()
        .route("/test", get(rate_limit_handler))
        .layer(ErrorMappingLayer);

    // When: through layer
    let resp = send_get(app, "/test").await;

    // Then: 429 with Retry-After: 30 header
    assert_eq!(resp.status(), StatusCode::TOO_MANY_REQUESTS);
    assert_eq!(
        resp.headers().get("retry-after").unwrap().to_str().unwrap(),
        "30"
    );
}

#[tokio::test]
async fn apperror_ratelimit_without_retry_after() {
    // Given: handler returns Err(AppError::RateLimit { retry_after_seconds: None })
    let app = Router::new()
        .route("/test", get(rate_limit_no_retry_handler))
        .layer(ErrorMappingLayer);

    // When: through layer
    let resp = send_get(app, "/test").await;

    // Then: 429 with no Retry-After header
    assert_eq!(resp.status(), StatusCode::TOO_MANY_REQUESTS);
    assert!(resp.headers().get("retry-after").is_none());
}

#[tokio::test]
async fn non_error_responses_pass_through() {
    // Given: handler returns Ok(Json(...))
    let app = Router::new()
        .route("/test", get(ok_handler))
        .layer(ErrorMappingLayer);

    // When: through layer
    let resp = send_get(app, "/test").await;

    // Then: 200 unchanged
    assert_eq!(resp.status(), StatusCode::OK);
}