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
// 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, task::ready};
use pin_project_lite::pin_project;
use tracing::Span;
pin_project! {
pub struct TraceFuture<F, OnResponse, OnError> {
#[pin]
inner: F,
span: Span,
on_response: OnResponse,
on_error: OnError,
}
}
impl<F, OnResponse, OnError> TraceFuture<F, OnResponse, OnError> {
pub fn new(inner: F, span: Span, on_response: OnResponse, on_error: OnError) -> Self {
Self {
inner,
span,
on_response,
on_error,
}
}
}
impl<F, R, E, OnResponse, OnError> Future for TraceFuture<F, OnResponse, OnError>
where
F: Future<Output = Result<R, E>>,
OnResponse: super::enrich_span::EnrichSpan<R>,
OnError: super::enrich_span::EnrichSpan<E>,
{
type Output = Result<R, E>;
fn poll(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Self::Output> {
let this = self.project();
// Poll the inner future, with the span entered. This is effectively what
// [`tracing::Instrumented`] does.
let _guard = this.span.enter();
let result = ready!(this.inner.poll(cx));
match &result {
Ok(response) => {
this.on_response.enrich_span(this.span, response);
}
Err(error) => {
this.on_error.enrich_span(this.span, error);
}
}
std::task::Poll::Ready(result)
}
}