use crate::context::token_extract::HeaderLookup;
use crate::error::GarrisonError;
use actix_web::http::header::{HeaderName, HeaderValue};
use actix_web::http::StatusCode;
use actix_web::{HttpResponse, ResponseError};
const X_REQUEST_ID: HeaderName = HeaderName::from_static("x-request-id");
const RETRY_AFTER: HeaderName = HeaderName::from_static("retry-after");
impl HeaderLookup for actix_web::http::header::HeaderMap {
fn get_header(&self, name: &str) -> Option<&str> {
self.get(name).and_then(|v| v.to_str().ok())
}
}
impl ResponseError for GarrisonError {
fn status_code(&self) -> StatusCode {
let (s, _, _, _) = self.response_parts();
StatusCode::from_u16(s).unwrap_or(StatusCode::INTERNAL_SERVER_ERROR)
}
fn error_response(&self) -> HttpResponse {
self.log_rejection();
let body = self.to_json_body();
let status = self.status_code();
let mut builder = HttpResponse::build(status);
if let Some(id) = crate::context::request_id::current() {
if let Ok(value) = HeaderValue::from_str(id.as_ref()) {
builder.insert_header((X_REQUEST_ID, value));
}
}
if let Some(secs) = self.retry_after_secs() {
builder.insert_header((RETRY_AFTER, HeaderValue::from(secs)));
}
builder.json(body)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::error::GarrisonError;
#[test]
fn rate_limited_error_response_sets_retry_after_header() {
let resp = GarrisonError::RateLimited {
retry_after_secs: 30,
}
.error_response();
assert_eq!(resp.status(), StatusCode::TOO_MANY_REQUESTS);
assert_eq!(
resp.headers()
.get(RETRY_AFTER.as_str())
.and_then(|v| v.to_str().ok()),
Some("30"),
"Retry-After 头必须等于秒数"
);
}
#[test]
fn non_rate_limited_error_response_has_no_retry_after_header() {
let resp = GarrisonError::NotLogin("x".to_string()).error_response();
assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
assert!(resp.headers().get(RETRY_AFTER.as_str()).is_none());
}
#[tokio::test]
async fn rate_limited_error_response_sets_x_request_id_within_scope() {
let resp =
crate::context::request_id::scope(std::sync::Arc::from("actix-rl-req-id"), async {
GarrisonError::RateLimited {
retry_after_secs: 30,
}
.error_response()
})
.await;
assert_eq!(
resp.headers()
.get(X_REQUEST_ID.as_str())
.and_then(|v| v.to_str().ok()),
Some("actix-rl-req-id"),
"scope 内必须回传 X-Request-ID 头"
);
assert_eq!(
resp.headers()
.get(RETRY_AFTER.as_str())
.and_then(|v| v.to_str().ok()),
Some("30")
);
}
}