ntex/http/

service.rs

use crate::error::{Error, IntoFailure};
use crate::io::{Filter, Io, types};
use crate::service::{IntoServiceFactory, RequestState, pipeline::PipelineFactory};
use crate::{Ctx, Service, ServiceFactory};

use super::error::{DispatchError, H2Error, ResponseError};
use super::{Request, Response, config::DispatcherConfig, h1, h2};

/// An HTTP/1.1 and HTTP/2 transport service.
///
/// The protocol is selected from
/// [`HttpProtocol`](crate::http::HttpProtocol) metadata attached to the I/O
/// stream, normally by a TLS ALPN acceptor. Connections without HTTP/2
/// metadata are handled as HTTP/1.
#[derive(derive_more::Debug)]
#[debug("HttpService")]
pub struct HttpService<F, Req: RequestState<Io<F>>, Err> {
    sf: super::HttpPipeline<Req::State, Err>,
    /// Without a control service the default action is applied to every event.
    h1_ctl: Option<super::Ctl1Pipeline<Req::State, F, Err>>,
    h2_ctl: super::Ctl2Pipeline<Req::State>,
    config: DispatcherConfig,
}

impl<F, Req, Err> HttpService<F, Req, Err>
where
    F: Filter + 'static,
    Req: RequestState<Io<F>>,
    Req::State: Clone,
    Err: ResponseError + 'static,
{
    #[must_use]
    /// Creates a service that supports HTTP/1.1 and HTTP/2.
    pub fn new<H>(sf: impl IntoServiceFactory<H, Req::State, Request>) -> Self
    where
        H: ServiceFactory<Req::State, Request, Error = Err> + 'static,
        H::Res: Into<Response>,
        H::InitError: IntoFailure,
    {
        HttpService {
            sf: PipelineFactory::new(
                sf.into_factory()
                    .map(Into::into)
                    .map_init_err(|e| DispatchError::Control(e.fail())),
            ),
            h1_ctl: None,
            h2_ctl: PipelineFactory::new(h2::DefaultControlService),
            config: DispatcherConfig::default(),
        }
    }

    #[must_use]
    /// Creates an HTTP/1-only service.
    pub fn h1<H>(sf: impl IntoServiceFactory<H, Req::State, Request>) -> h1::H1Service<F, Req, Err>
    where
        H: ServiceFactory<Req::State, Request, Error = Err> + 'static,
        H::Res: Into<Response>,
        H::InitError: IntoFailure,
    {
        h1::H1Service::new(sf)
    }

    #[must_use]
    /// Creates an HTTP/2-only service.
    pub fn h2<H>(sf: impl IntoServiceFactory<H, Req::State, Request>) -> h2::H2Service<F, Req, Err>
    where
        H: ServiceFactory<Req::State, Request, Error = Err> + 'static,
        H::Res: Into<Response>,
        H::InitError: IntoFailure,
    {
        h2::H2Service::new(sf)
    }
}

impl<F, Req, Err> HttpService<F, Req, Err>
where
    F: Filter,
    Req: RequestState<Io<F>>,
    Err: ResponseError + 'static,
{
    #[must_use]
    /// Provides the HTTP/1 control service.
    ///
    /// The service receives the lifecycle events described by
    /// [`h1::Control`]. Unless this method is called, the default action is
    /// applied to each event without a service call.
    pub fn h1_control<Ctl>(
        self,
        ctl: impl IntoServiceFactory<Ctl, Req::State, h1::Control<F, Err>>,
    ) -> Self
    where
        Ctl: ServiceFactory<Req::State, h1::Control<F, Err>, Res = h1::ControlAck<F>> + 'static,
        Ctl::Error: IntoFailure,
        Ctl::InitError: IntoFailure,
    {
        HttpService {
            sf: self.sf,
            h1_ctl: Some(PipelineFactory::new(
                ctl.into_factory()
                    .map_err(|e| DispatchError::Service(e.fail()))
                    .map_init_err(|e| DispatchError::Control(e.fail())),
            )),
            h2_ctl: self.h2_ctl,
            config: self.config,
        }
    }

    #[must_use]
    /// Provides the HTTP/2 control service.
    ///
    /// A default service that acknowledges each HTTP/2 control event is used
    /// unless this method is called.
    pub fn h2_control<Ctl>(
        self,
        ctl: impl IntoServiceFactory<Ctl, Req::State, h2::Control<Error<H2Error>>>,
    ) -> Self
    where
        Ctl:
            ServiceFactory<Req::State, h2::Control<Error<H2Error>>, Res = h2::ControlAck> + 'static,
        Ctl::Error: IntoFailure,
        Ctl::InitError: IntoFailure,
    {
        HttpService {
            sf: self.sf,
            h1_ctl: self.h1_ctl,
            h2_ctl: PipelineFactory::new(
                ctl.into_factory()
                    .map_err(|e| DispatchError::Service(e.fail()))
                    .map_init_err(|e| DispatchError::Control(e.fail())),
            ),
            config: self.config,
        }
    }
}

impl<St, F, Req, Err> Service<St, Req> for HttpService<F, Req, Err>
where
    F: Filter + 'static,
    Req: RequestState<Io<F>>,
    Req::State: Clone,
    Err: ResponseError + 'static,
{
    type Res = ();
    type Error = DispatchError;

    async fn call(&self, req: Req, _: Ctx<'_, Self, St>) -> Result<Self::Res, Self::Error> {
        let (st, io) = req.unpack();

        let svc = self.sf.create(st.clone()).await?;

        let id = self.config.next_id();
        let ioref = io.get_ref();
        let (_guard, inflight) = self.config.insert_io(&ioref);

        if io.query::<types::HttpProtocol>().get() == Some(types::HttpProtocol::Http2) {
            log::trace!(
                "{}: New http2 connection {id}, peer address {:?}, in-flight: {inflight}",
                io.tag(),
                io.query::<types::PeerAddr>().get(),
            );
            let ctl = self.h2_ctl.create(st).await?;

            h2::handle(id, io.into(), svc, ctl).await
        } else {
            log::trace!(
                "{}: New http1 connection {id}, peer address {:?}, in-flight: {inflight}",
                io.tag(),
                io.query::<types::PeerAddr>().get(),
            );
            let ctl = match &self.h1_ctl {
                Some(ctl) => Some(ctl.create(st).await?),
                None => None,
            };

            h1::handle_io(id, io, svc, ctl, self.config.clone()).await
        }
    }

    async fn ready(&self, _: Ctx<'_, Self, St>) -> Result<(), Self::Error> {
        Ok(())
    }

    async fn shutdown(&self, _: crate::Ctx<'_, Self, St>) {
        // check inflight connections
        let inflight = self.config.shutdown();
        if inflight != 0 {
            log::trace!("Shutting down service, in-flight connections: {inflight}");

            self.config.wait_shutdown().await;
            log::trace!("Shutting down is complected");
        }
    }
}