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::{
marker::PhantomData,
task::{Context, Poll},
};
use futures::{future::Either, ready};
use tower::{Layer, Service};
/// A filter that allows a service to be executed based on a condition
///
/// # Example
/// ```rust
/// # use tower_fallthrough_filter::Filter;
///
/// #[derive(Debug, Clone)]
/// struct MyFilter;
///
/// impl<T> Filter<T> for MyFilter {
/// fn matches(&self, _: &T) -> bool {
/// true
/// }
/// }
///
/// let filter = MyFilter;
/// assert_eq!(filter.matches(&()), true);
/// ```
pub trait Filter<T>: Clone {
/// Whether the service should be executed
///
/// If `true`, the service will be executed, otherwise it will
/// fall through to the next service.
fn matches(&self, item: &T) -> bool;
}
/// A Tower layer that executes the provided service only
/// if the given filter returns true.
/// Otherwise it falls through to the inner server.
///
/// # Example
/// ```rust
/// use tower_fallthrough_filter::{Filter, FilterLayer};
/// use tower::{Service, Layer};
///
/// #[derive(Debug, Clone)]
/// struct MyFilter;
///
/// impl Filter<bool> for MyFilter {
/// fn matches(&self, data: &bool) -> bool {
/// *data
/// }
/// }
///
/// #[derive(Debug, Clone)]
/// struct StringService(String);
///
/// impl Service<bool> for StringService {
/// type Response = String;
/// type Error = std::convert::Infallible;
/// type Future = std::future::Ready::<Result<Self::Response, Self::Error>>;
///
/// fn poll_ready(
/// &mut self,
/// _: &mut std::task::Context<'_>,
/// ) -> std::task::Poll<Result<(), Self::Error>> {
/// std::task::Poll::Ready(Ok(()))
/// }
///
/// fn call(&mut self, req: bool) -> Self::Future {
/// std::future::ready(Ok(self.0.clone()))
/// }
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let service_a = StringService("A".to_string());
/// let service_b = StringService("B".to_string());
/// let filter = MyFilter;
///
/// let mut middleware = FilterLayer::new(filter, service_a).layer(service_b);
///
/// assert_eq!(middleware.call(true).await, Ok("A".to_string()));
/// assert_eq!(middleware.call(false).await, Ok("B".to_string()));
/// }
///
#[derive(Debug)]
pub struct FilterLayer<F, S, T, R, E>
where
F: Filter<T>,
S: Service<T, Response = R, Error = E>,
{
filter: F,
service: S,
_marker: PhantomData<(T, R, E)>,
}
// NOTE: This is required to make the `FilterLayer` clonable
// as the `PhantomData` might be not clonable.
impl<F, S, R, E, T> Clone for FilterLayer<F, S, T, R, E>
where
F: Filter<T> + Clone,
S: Service<T, Response = R, Error = E> + Clone,
{
fn clone(&self) -> Self {
Self {
filter: self.filter.clone(),
service: self.service.clone(),
_marker: PhantomData,
}
}
}
impl<F: Filter<T>, S: Service<T>, T> FilterLayer<F, S, T, S::Response, S::Error> {
/// Creates a new FilterLayer given a `Service` and a `Filter`.
///
/// NOTE: The Service and the Filter have to operate on the same
/// type `T`.
pub fn new(filter: F, service: S) -> Self {
Self {
filter,
service,
_marker: PhantomData,
}
}
}
impl<F, S, I, T, R, E> Layer<I> for FilterLayer<F, S, T, R, E>
where
F: Filter<T> + Clone,
S: Service<T, Response = R, Error = E> + Clone,
I: Service<T, Response = R, Error = E> + Clone,
{
type Service = FilterService<F, S, I, T, R, E>;
fn layer(&self, inner_service: I) -> Self::Service {
let filter = self.filter.clone();
let filtered_service = self.service.clone();
FilterService {
filter,
service: filtered_service,
inner: inner_service,
_marker: PhantomData,
}
}
}
#[derive(Debug)]
pub struct FilterService<F, S, I, T, R, E>
where
F: Filter<T>,
S: Service<T, Response = R, Error = E>,
I: Service<T, Response = R, Error = E>,
{
filter: F,
service: S,
inner: I,
_marker: PhantomData<(T, R, E)>,
}
// NOTE: This is required to make the `FilterService` clonable
// as the `PhantomData` might be not clonable.
impl<F, S, I, T, R, E> Clone for FilterService<F, S, I, T, R, E>
where
F: Filter<T>,
S: Service<T, Response = R, Error = E> + Clone,
I: Service<T, Response = R, Error = E> + Clone,
{
fn clone(&self) -> Self {
Self {
filter: self.filter.clone(),
service: self.service.clone(),
inner: self.inner.clone(),
_marker: PhantomData,
}
}
}
impl<F, S, I, T, R, E> Service<T> for FilterService<F, S, I, T, R, E>
where
F: Filter<T>,
S: Service<T, Response = R, Error = E>,
S::Future: Send + 'static,
I: Service<T, Response = R, Error = E>,
I::Future: Send + 'static,
{
type Response = S::Response;
type Error = S::Error;
type Future = Either<S::Future, I::Future>;
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
ready!(self.service.poll_ready(cx))?;
// NOTE: It is probably best to poll the `inner_service` here as well
// as otherwise it might be called when it isn't ready yet.
ready!(self.inner.poll_ready(cx))?;
Poll::Ready(Ok(()))
}
fn call(&mut self, req: T) -> Self::Future {
if self.filter.matches(&req) {
Either::Left(self.service.call(req))
} else {
Either::Right(self.inner.call(req))
}
}
}