rs-zero 0.2.1

Rust-first microservice framework inspired by go-zero engineering practices
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
139
140
141
142
143
144
145
146
147
148
149
150

use std::{
    convert::Infallible,
    future::Future,
    pin::Pin,
    task::{Context, Poll},
};

use http::{Request, Response};
use http_body::Body;
use tower::{Layer, Service};

use crate::rpc::{RpcResilienceLayer, status_counts_as_failure};

/// Tower layer that applies [`RpcResilienceLayer`] to tonic unary services.
#[derive(Debug, Clone)]
pub struct RpcUnaryResilienceLayer {
    resilience: RpcResilienceLayer,
}

impl RpcUnaryResilienceLayer {
    /// Creates a unary resilience layer from a shared RPC resilience helper.
    pub fn new(resilience: RpcResilienceLayer) -> Self {
        Self { resilience }
    }
}

impl<S> Layer<S> for RpcUnaryResilienceLayer {
    type Service = RpcUnaryResilienceService<S>;

    fn layer(&self, inner: S) -> Self::Service {
        RpcUnaryResilienceService {
            inner,
            resilience: self.resilience.clone(),
        }
    }
}

/// Tower service produced by [`RpcUnaryResilienceLayer`].
#[derive(Debug, Clone)]
pub struct RpcUnaryResilienceService<S> {
    inner: S,
    resilience: RpcResilienceLayer,
}

impl<S, B> Service<Request<B>> for RpcUnaryResilienceService<S>
where
    S: Service<Request<B>, Response = Response<tonic::body::Body>, Error = Infallible>
        + Clone
        + Send
        + 'static,
    S::Future: Send + 'static,
    B: Body + Send + 'static,
{
    type Response = Response<tonic::body::Body>;
    type Error = Infallible;
    type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.inner.poll_ready(cx)
    }

    fn call(&mut self, request: Request<B>) -> Self::Future {
        let method = request.uri().path().to_string();
        let mut inner = self.inner.clone();
        let resilience = self.resilience.clone();

        Box::pin(async move {
            let result = resilience
                .run_unary(&method, || async move {
                    let response = match inner.call(request).await {
                        Ok(response) => response,
                        Err(never) => match never {},
                    };
                    if let Some(status) = tonic::Status::from_header_map(response.headers()) {
                        if status_counts_as_failure(&status) {
                            return Err(status);
                        }
                    }
                    Ok(response)
                })
                .await;

            Ok(match result {
                Ok(response) => response,
                Err(status) => status.into_http::<tonic::body::Body>(),
            })
        })
    }
}

#[cfg(test)]
mod tests {
    use std::{convert::Infallible, task::Poll};

    use http::{Request, Response};
    use tower::{Layer, Service};

    use super::RpcUnaryResilienceLayer;
    use crate::rpc::{RpcResilienceConfig, RpcResilienceLayer};

    #[derive(Clone)]
    struct SlowService;

    impl Service<Request<tonic::body::Body>> for SlowService {
        type Response = Response<tonic::body::Body>;
        type Error = Infallible;
        type Future =
            std::pin::Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

        fn poll_ready(
            &mut self,
            _cx: &mut std::task::Context<'_>,
        ) -> Poll<Result<(), Self::Error>> {
            Poll::Ready(Ok(()))
        }

        fn call(&mut self, _request: Request<tonic::body::Body>) -> Self::Future {
            Box::pin(async move {
                tokio::time::sleep(std::time::Duration::from_millis(20)).await;
                Ok(Response::new(tonic::body::Body::empty()))
            })
        }
    }

    #[tokio::test]
    async fn unary_layer_maps_timeout_without_manual_helper() {
        let layer = RpcUnaryResilienceLayer::new(RpcResilienceLayer::new(
            "hello",
            RpcResilienceConfig {
                request_timeout: std::time::Duration::from_millis(1),
                ..RpcResilienceConfig::default()
            },
        ));
        let mut service = layer.layer(SlowService);

        let response = service
            .call(Request::new(tonic::body::Body::empty()))
            .await
            .expect("infallible");

        assert_eq!(response.status(), http::StatusCode::OK);
        assert_eq!(
            response
                .headers()
                .get("grpc-status")
                .and_then(|value| value.to_str().ok()),
            Some("4")
        );
    }
}