risingwave_rpc_client/
channel.rs

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
// Copyright 2025 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::task::{Context, Poll};

use futures::Future;
use http::HeaderValue;
use risingwave_common::util::tracing::TracingContext;
use tonic::body::BoxBody;
use tower::Service;

/// A service wrapper that hacks the gRPC request and response for observability.
///
/// - Inject the [`TracingContext`] obtained from the current tracing span into the HTTP headers of the request.
///   The server can then extract the [`TracingContext`] from the HTTP headers with the `TracingExtract` middleware.
///   See also `TracingExtract` in the `common_service` crate.
///
/// - Add the path of the request (indicating the gRPC call) to the response headers. The error reporting can then
///   include the gRPC call name in the message.
#[derive(Clone, Debug)]
pub struct WrappedChannel {
    inner: tonic::transport::Channel,
}

#[cfg(not(madsim))]
impl Service<http::Request<BoxBody>> for WrappedChannel {
    type Error = tonic::transport::Error;
    type Response = http::Response<BoxBody>;

    type Future = impl Future<Output = Result<Self::Response, Self::Error>>;

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

    fn call(&mut self, mut req: http::Request<BoxBody>) -> Self::Future {
        // This is necessary because tonic internally uses `tower::buffer::Buffer`.
        // See https://github.com/tower-rs/tower/issues/547#issuecomment-767629149
        // for details on why this is necessary
        let clone = self.inner.clone();
        let mut inner = std::mem::replace(&mut self.inner, clone);

        async move {
            let path = req.uri().path().to_owned();

            let headers = TracingContext::from_current_span().to_http_headers();
            req.headers_mut().extend(headers);

            let mut response = inner.call(req).await;

            if let Ok(response) = &mut response {
                if let Ok(path) = HeaderValue::from_str(&path) {
                    response
                        .headers_mut()
                        .insert(risingwave_error::tonic::CALL_KEY, path);
                }
            }

            response
        }
    }
}

#[cfg(not(madsim))]
pub type Channel = WrappedChannel;
#[cfg(madsim)]
pub type Channel = tonic::transport::Channel;

/// An extension trait for tonic's `Channel` that wraps it into a [`WrappedChannel`].
#[easy_ext::ext(WrappedChannelExt)]
impl tonic::transport::Channel {
    /// Wraps the channel into a [`WrappedChannel`] for observability.
    pub fn wrapped(self) -> Channel {
        #[cfg(not(madsim))]
        return WrappedChannel { inner: self };
        #[cfg(madsim)]
        return self;
    }
}