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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// 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::future::Future;

use opentelemetry::{metrics::UpDownCounter, KeyValue};
use pin_project_lite::pin_project;
use tower::{Layer, Service};

use crate::MetricsAttributes;

/// A [`Layer`] that records the number of in-flight requests.
///
/// # Generic Parameters
///
/// * `OnRequest`: A type that can extract attributes from a request.
#[derive(Clone, Debug)]
pub struct InFlightCounterLayer<OnRequest = ()> {
    counter: UpDownCounter<i64>,
    on_request: OnRequest,
}

impl InFlightCounterLayer {
    /// Create a new [`InFlightCounterLayer`].
    #[must_use]
    pub fn new(name: &'static str) -> Self {
        let counter = crate::meter()
            .i64_up_down_counter(name)
            .with_unit("{request}")
            .with_description("The number of in-flight requests")
            .init();

        Self {
            counter,
            on_request: (),
        }
    }
}

impl<F> InFlightCounterLayer<F> {
    /// Set the [`MetricsAttributes`] to use.
    #[must_use]
    pub fn on_request<OnRequest>(self, on_request: OnRequest) -> InFlightCounterLayer<OnRequest> {
        InFlightCounterLayer {
            counter: self.counter,
            on_request,
        }
    }
}

impl<S, OnRequest> Layer<S> for InFlightCounterLayer<OnRequest>
where
    OnRequest: Clone,
{
    type Service = InFlightCounterService<S, OnRequest>;

    fn layer(&self, inner: S) -> Self::Service {
        InFlightCounterService {
            inner,
            counter: self.counter.clone(),
            on_request: self.on_request.clone(),
        }
    }
}

/// A middleware that records the number of in-flight requests.
///
/// # Generic Parameters
///
/// * `S`: The type of the inner service.
/// * `OnRequest`: A type that can extract attributes from a request.
#[derive(Clone, Debug)]
pub struct InFlightCounterService<S, OnRequest = ()> {
    inner: S,
    counter: UpDownCounter<i64>,
    on_request: OnRequest,
}

/// A guard that decrements the in-flight request count when dropped.
struct InFlightGuard {
    counter: UpDownCounter<i64>,
    attributes: Vec<KeyValue>,
}

impl InFlightGuard {
    fn new(counter: UpDownCounter<i64>, attributes: Vec<KeyValue>) -> Self {
        counter.add(1, &attributes);

        Self {
            counter,
            attributes,
        }
    }
}

impl Drop for InFlightGuard {
    fn drop(&mut self) {
        self.counter.add(-1, &self.attributes);
    }
}

pin_project! {
    /// The future returned by [`InFlightCounterService`]
    pub struct InFlightFuture<F> {
        guard: InFlightGuard,

        #[pin]
        inner: F,
    }
}

impl<F> Future for InFlightFuture<F>
where
    F: Future,
{
    type Output = F::Output;

    fn poll(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Self::Output> {
        self.project().inner.poll(cx)
    }
}

impl<R, S, OnRequest> Service<R> for InFlightCounterService<S, OnRequest>
where
    S: Service<R>,
    OnRequest: MetricsAttributes<R>,
{
    type Response = S::Response;
    type Error = S::Error;
    type Future = InFlightFuture<S::Future>;

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

    fn call(&mut self, req: R) -> Self::Future {
        // Extract attributes from the request.
        let attributes = self.on_request.attributes(&req).collect();

        // Increment the in-flight request count.
        let guard = InFlightGuard::new(self.counter.clone(), attributes);

        // Call the inner service, and return a future that decrements the in-flight
        // when dropped.
        let inner = self.inner.call(req);
        InFlightFuture { guard, inner }
    }
}