apollo-router 2.13.1

A configurable, high-performance routing runtime for Apollo Federation 🚀
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

use std::pin::Pin;
use std::task::Context;
use std::task::Poll;

use bytes::Buf;
use http_body::SizeHint;
use pin_project_lite::pin_project;
use tokio::sync::OwnedSemaphorePermit;

use super::layer::BodyLimitControl;

pin_project! {
    /// An implementation of http_body::Body that limits the number of bytes read from the inner body.
    /// Unlike the `RequestBodyLimit` middleware, this will always return Pending if the inner body has exceeded the limit.
    /// Upon reaching the limit the guard will be dropped allowing the RequestBodyLimitLayer to return.
    pub(crate) struct Limited<Body> {
        #[pin]
        inner: Body,
        #[pin]
        permit: ForgetfulPermit,
        control: BodyLimitControl,
    }
}

impl<Body> Limited<Body>
where
    Body: http_body::Body,
{
    pub(super) fn new(
        inner: Body,
        control: BodyLimitControl,
        permit: OwnedSemaphorePermit,
    ) -> Self {
        Self {
            inner,
            control,
            permit: permit.into(),
        }
    }
}

struct ForgetfulPermit(Option<OwnedSemaphorePermit>);

impl ForgetfulPermit {
    fn release(&mut self) {
        self.0.take();
    }
}

impl Drop for ForgetfulPermit {
    fn drop(&mut self) {
        // If the limit was not hit we must not release the guard otherwise a response of 413 will be returned.
        // This may be because the inner body was not fully read.
        // Instead we must forget the permit.
        if let Some(permit) = self.0.take() {
            permit.forget();
        }
    }
}

impl From<OwnedSemaphorePermit> for ForgetfulPermit {
    fn from(permit: OwnedSemaphorePermit) -> Self {
        Self(Some(permit))
    }
}

impl<Body> http_body::Body for Limited<Body>
where
    Body: http_body::Body,
{
    type Data = Body::Data;
    type Error = Body::Error;

    fn poll_frame(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<Result<http_body::Frame<Self::Data>, Self::Error>>> {
        let mut this = self.project();
        let res = match this.inner.poll_frame(cx) {
            Poll::Pending => return Poll::Pending,
            Poll::Ready(None) => None,
            Poll::Ready(Some(Ok(frame))) => {
                let Some(data) = frame.data_ref() else {
                    return Poll::Ready(Some(Ok(frame)));
                };

                if data.remaining() > this.control.remaining() {
                    // This is the difference between http_body::Limited and our implementation.
                    // Dropping this mutex allows the containing layer to immediately return an error response
                    // This prevents the need to deal with wrapped errors.
                    this.permit.release();
                    return Poll::Pending;
                } else {
                    this.control.increment(data.remaining());
                    Some(Ok(frame))
                }
            }
            Poll::Ready(Some(Err(err))) => Some(Err(err)),
        };

        Poll::Ready(res)
    }

    fn is_end_stream(&self) -> bool {
        self.inner.is_end_stream()
    }

    fn size_hint(&self) -> SizeHint {
        match u64::try_from(self.control.remaining()) {
            Ok(n) => {
                let mut hint = self.inner.size_hint();
                if hint.lower() >= n {
                    hint.set_exact(n)
                } else if let Some(max) = hint.upper() {
                    hint.set_upper(n.min(max))
                } else {
                    hint.set_upper(n)
                }
                hint
            }
            Err(_) => self.inner.size_hint(),
        }
    }
}

#[cfg(test)]
mod test {
    use std::pin::Pin;
    use std::sync::Arc;

    use bytes::Bytes;
    use http_body::Body;
    use tower::BoxError;

    use crate::plugins::limits::layer::BodyLimitControl;
    use crate::services::router::body;

    #[test]
    fn test_completes() {
        let control = BodyLimitControl::new(100);
        let semaphore = Arc::new(tokio::sync::Semaphore::new(1));
        let lock = semaphore.clone().try_acquire_owned().unwrap();
        let mut limited = super::Limited::new(body::from_bytes("test".to_string()), control, lock);

        match Pin::new(&mut limited).poll_frame(&mut std::task::Context::from_waker(
            &futures::task::noop_waker(),
        )) {
            std::task::Poll::Ready(Some(Ok(data))) => {
                let data = data.into_data().unwrap().to_vec();
                let content = String::from_utf8_lossy(data.as_slice());
                assert_eq!(&content, "test");
            }
            std::task::Poll::Pending => panic!("it should be ready"),
            _ => panic!("the data returned is incorrect"),
        }

        assert!(semaphore.try_acquire().is_err());

        // We need to assert that if the stream is dropped the semaphore isn't released.
        // It's only explicitly hitting the limit that releases the semaphore.
        drop(limited);
        assert!(semaphore.try_acquire().is_err());
    }

    #[test]
    fn test_limit_hit() {
        let control = BodyLimitControl::new(1);
        let semaphore = Arc::new(tokio::sync::Semaphore::new(1));
        let lock = semaphore.clone().try_acquire_owned().unwrap();
        let mut limited = super::Limited::new("test".to_string(), control, lock);

        match Pin::new(&mut limited).poll_frame(&mut std::task::Context::from_waker(
            &futures::task::noop_waker(),
        )) {
            std::task::Poll::Pending => {}
            std::task::Poll::Ready(_) => panic!("it should be pending"),
        }
        assert!(semaphore.try_acquire().is_ok())
    }

    #[test]
    fn test_limit_hit_after_multiple() {
        let control = BodyLimitControl::new(5);
        let semaphore = Arc::new(tokio::sync::Semaphore::new(1));
        let lock = semaphore.clone().try_acquire_owned().unwrap();

        let mut limited = super::Limited::new(
            body::from_result_stream(futures::stream::iter(vec![
                Ok::<Bytes, BoxError>("hello".into()),
                Ok("world".into()),
            ])),
            control,
            lock,
        );
        match Pin::new(&mut limited).poll_frame(&mut std::task::Context::from_waker(
            &futures::task::noop_waker(),
        )) {
            std::task::Poll::Ready(Some(Ok(_))) => {}
            _ => panic!("it should be ready with Some(Ok(_)"),
        }
        assert!(semaphore.try_acquire().is_err());
        if Pin::new(&mut limited)
            .poll_frame(&mut std::task::Context::from_waker(
                &futures::task::noop_waker(),
            ))
            .is_ready()
        {
            panic!("it should be pending");
        }
        assert!(semaphore.try_acquire().is_ok());
    }
}