authentication-service/crates/tower/src/utils.rs

// 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 opentelemetry::{KeyValue, Value};
use tower::{Layer, Service};

/// A simple static key-value pair.
#[derive(Clone, Debug)]
pub struct KV<V>(pub &'static str, pub V);

impl<V> From<KV<V>> for KeyValue
where
    V: Into<Value>,
{
    fn from(value: KV<V>) -> Self {
        Self::new(value.0, value.1.into())
    }
}

/// A wrapper around a function that can be used to generate a key-value pair,
/// make or enrich spans.
#[derive(Clone, Debug)]
pub struct FnWrapper<F>(pub F);

/// A no-op layer that has the request type bound.
#[derive(Clone, Copy, Debug)]
pub struct IdentityLayer<R> {
    _request: std::marker::PhantomData<R>,
}

impl<R> Default for IdentityLayer<R> {
    fn default() -> Self {
        Self {
            _request: std::marker::PhantomData,
        }
    }
}

/// A no-op service that has the request type bound.
#[derive(Clone, Copy, Debug)]
pub struct IdentityService<R, S> {
    _request: std::marker::PhantomData<R>,
    inner: S,
}

impl<R, S> Default for IdentityService<R, S>
where
    S: Default,
{
    fn default() -> Self {
        Self {
            _request: std::marker::PhantomData,
            inner: S::default(),
        }
    }
}

impl<R, S> Layer<S> for IdentityLayer<R> {
    type Service = IdentityService<R, S>;

    fn layer(&self, inner: S) -> Self::Service {
        IdentityService {
            _request: std::marker::PhantomData,
            inner,
        }
    }
}

impl<S, R> Service<R> for IdentityService<R, S>
where
    S: Service<R>,
{
    type Response = S::Response;
    type Error = S::Error;
    type Future = 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 {
        self.inner.call(req)
    }
}