tako-rs-plugins 2.0.0

Internal plugin and concrete-middleware implementations for tako-rs. Use the `tako-rs` umbrella crate instead.
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

//! `application/problem+json` error normalizer middleware.
//!
//! Wraps the response so 4xx and 5xx replies that lack a JSON body are
//! rewritten into RFC 7807 / RFC 9457 problem documents. Handlers that
//! already produced a structured JSON error stay authoritative — the
//! `Content-Type` of the original response is the trigger.
//!
//! Sister to [`Router::use_problem_json`](tako_rs_core::router::Router::use_problem_json)
//! / [`tako::problem::default_problem_responder`](tako_rs_core::problem::default_problem_responder).
//! The router hook fires only when the response originated from the framework
//! itself (e.g. 404, 405, default error handler), whereas this middleware
//! converts any 4xx/5xx that bubbles up from handler code.

use std::future::Future;
use std::pin::Pin;

use tako_rs_core::middleware::IntoMiddleware;
use tako_rs_core::middleware::Next;
use tako_rs_core::problem::default_problem_responder;
use tako_rs_core::types::Request;
use tako_rs_core::types::Response;

/// Middleware that rewrites non-JSON 4xx/5xx responses into `problem+json`.
pub struct ProblemJson {
  /// Convert 4xx responses (default true).
  client_errors: bool,
  /// Convert 5xx responses (default true).
  server_errors: bool,
}

impl Default for ProblemJson {
  fn default() -> Self {
    Self::new()
  }
}

impl ProblemJson {
  /// Creates the middleware with both 4xx and 5xx conversion enabled.
  pub fn new() -> Self {
    Self {
      client_errors: true,
      server_errors: true,
    }
  }

  /// Toggles 4xx → problem+json conversion.
  pub fn client_errors(mut self, on: bool) -> Self {
    self.client_errors = on;
    self
  }

  /// Toggles 5xx → problem+json conversion.
  pub fn server_errors(mut self, on: bool) -> Self {
    self.server_errors = on;
    self
  }
}

impl IntoMiddleware for ProblemJson {
  fn into_middleware(
    self,
  ) -> impl Fn(Request, Next) -> Pin<Box<dyn Future<Output = Response> + Send + 'static>>
  + Clone
  + Send
  + Sync
  + 'static {
    let client = self.client_errors;
    let server = self.server_errors;

    move |req: Request, next: Next| {
      Box::pin(async move {
        let resp = next.run(req).await;
        let status = resp.status();
        let should_convert =
          (client && status.is_client_error()) || (server && status.is_server_error());
        if !should_convert {
          return resp;
        }
        default_problem_responder(resp)
      })
    }
  }
}