itsi-server 0.1.1 → 0.2.2

data/ext/itsi_server/src/ruby_types/itsi_grpc_response_stream/mod.rs

@@ -0,0 +1,264 @@
+use super::itsi_grpc_call::CompressionAlgorithm;
+use crate::prelude::*;
+use crate::server::http_message_types::HttpResponse;
+use crate::server::size_limited_incoming::SizeLimitedIncoming;
+use crate::server::{byte_frame::ByteFrame, serve_strategy::single_mode::RunningPhase};
+use bytes::Bytes;
+use derive_more::Debug;
+use futures::stream::unfold;
+use http::Version;
+use http::{
+    header::{HeaderName, HeaderValue},
+    HeaderMap, Response,
+};
+use http_body_util::{combinators::BoxBody, BodyDataStream, BodyExt, Empty, Full, StreamBody};
+use hyper::body::{Frame, Incoming};
+use magnus::error::Result as MagnusResult;
+use nix::unistd::pipe;
+use parking_lot::Mutex;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::{
+    collections::HashMap,
+    os::fd::{AsRawFd, FromRawFd, IntoRawFd, OwnedFd},
+    sync::Arc,
+};
+use tokio::{
+    spawn,
+    sync::{
+        mpsc::{self, Sender},
+        oneshot, watch,
+    },
+};
+use tokio_stream::{wrappers::ReceiverStream, StreamExt};
+
+#[derive(Debug, Clone)]
+#[magnus::wrap(class = "Itsi::GrpcResponseStream", free_immediately, size)]
+pub struct ItsiGrpcResponseStream {
+    pub inner: Arc<Mutex<ItsiGrpcResponseStreamInner>>,
+    pub cancelled: Arc<AtomicBool>,
+}
+
+#[derive(Debug)]
+pub struct ItsiGrpcResponseStreamInner {
+    pub incoming_reader: Option<OwnedFd>,
+    pub buf: Vec<u8>,
+    pub response_sender: Sender<ByteFrame>,
+    pub response: Option<HttpResponse>,
+    pub response_headers: HeaderMap,
+    trailer_tx: oneshot::Sender<HeaderMap>,
+    trailer_rx: Option<oneshot::Receiver<HeaderMap>>,
+}
+
+impl ItsiGrpcResponseStreamInner {
+    pub fn reader(&mut self) -> MagnusResult<i32> {
+        Ok(self.incoming_reader.take().unwrap().into_raw_fd())
+    }
+
+    pub fn write(&mut self, bytes: Bytes) -> MagnusResult<()> {
+        self.response_sender
+            .blocking_send(ByteFrame::Data(bytes))
+            .map_err(|err| {
+                magnus::Error::new(
+                    magnus::exception::io_error(),
+                    format!("Trying to write to closed stream: {:?}", err),
+                )
+            })?;
+        Ok(())
+    }
+
+    pub fn flush(&mut self) -> MagnusResult<()> {
+        Ok(())
+    }
+
+    pub fn send_trailers(&mut self, trailers: HashMap<String, String>) -> MagnusResult<()> {
+        let mut header_map = HeaderMap::new();
+        for (key, value) in trailers {
+            if let (Ok(hn), Ok(hv)) = (key.parse::<HeaderName>(), value.parse::<HeaderValue>()) {
+                header_map.insert(hn, hv);
+            }
+        }
+        let trailer_tx = std::mem::replace(&mut self.trailer_tx, oneshot::channel().0);
+        trailer_tx.send(header_map).map_err(|err| {
+            magnus::Error::new(
+                magnus::exception::standard_error(),
+                format!("Error sending trailers {:?}", err),
+            )
+        })?;
+        Ok(())
+    }
+
+    pub fn close(&mut self) -> MagnusResult<()> {
+        self.response_sender.blocking_send(ByteFrame::Empty).ok();
+        Ok(())
+    }
+
+    pub fn add_headers(&mut self, headers: HashMap<Bytes, Vec<Bytes>>) -> MagnusResult<()> {
+        for (name, values) in headers {
+            let header_name = HeaderName::from_bytes(&name).map_err(|e| {
+                itsi_error::ItsiError::InvalidInput(format!(
+                    "Invalid header name {:?}: {:?}",
+                    name, e
+                ))
+            })?;
+            for value in values {
+                let header_value = unsafe { HeaderValue::from_maybe_shared_unchecked(value) };
+                self.response_headers.insert(&header_name, header_value);
+            }
+        }
+
+        Ok(())
+    }
+}
+
+impl ItsiGrpcResponseStream {
+    pub async fn new(
+        compression_out: CompressionAlgorithm,
+        response_sender: Sender<ByteFrame>,
+        mut body: BodyDataStream<SizeLimitedIncoming<Incoming>>,
+    ) -> Self {
+        let (trailer_tx, trailer_rx) = oneshot::channel::<HeaderMap>();
+        let (pipe_read, pipe_write) = pipe().unwrap();
+
+        nix::fcntl::fcntl(
+            pipe_read.as_raw_fd(),
+            nix::fcntl::FcntlArg::F_SETFL(nix::fcntl::OFlag::O_NONBLOCK),
+        )
+        .unwrap();
+
+        nix::fcntl::fcntl(
+            pipe_write.as_raw_fd(),
+            nix::fcntl::FcntlArg::F_SETFL(nix::fcntl::OFlag::O_NONBLOCK),
+        )
+        .unwrap();
+
+        let pipe_raw_fd = pipe_write.into_raw_fd();
+
+        let cancelled = Arc::new(AtomicBool::new(false));
+        let cancelled_clone = cancelled.clone();
+        spawn(async move {
+            use std::io::Write;
+            let mut write_end = unsafe { std::fs::File::from_raw_fd(pipe_raw_fd) };
+            while let Some(Ok(body)) = body.next().await {
+                write_end.write_all(&body).unwrap();
+            }
+            cancelled_clone.store(true, Ordering::SeqCst);
+        });
+
+        let mut response_headers = HeaderMap::new();
+
+        match compression_out {
+            CompressionAlgorithm::None => (),
+            CompressionAlgorithm::Deflate => {
+                response_headers.insert("grpc-encoding", "deflate".parse().unwrap());
+            }
+            CompressionAlgorithm::Gzip => {
+                response_headers.insert("grpc-encoding", "gzip".parse().unwrap());
+            }
+        }
+        ItsiGrpcResponseStream {
+            inner: Arc::new(Mutex::new(ItsiGrpcResponseStreamInner {
+                buf: Vec::new(),
+                response_headers,
+                incoming_reader: Some(pipe_read),
+                response_sender,
+                response: Some(Response::new(BoxBody::new(Empty::new()))),
+                trailer_tx,
+                trailer_rx: Some(trailer_rx),
+            })),
+            cancelled,
+        }
+    }
+
+    pub fn reader(&self) -> MagnusResult<i32> {
+        self.inner.lock().reader()
+    }
+
+    pub fn write(&self, bytes: Bytes) -> MagnusResult<()> {
+        self.inner.lock().write(bytes)
+    }
+
+    pub fn flush(&self) -> MagnusResult<()> {
+        self.inner.lock().flush()
+    }
+
+    pub fn is_cancelled(&self) -> MagnusResult<bool> {
+        Ok(self.cancelled.load(Ordering::SeqCst))
+    }
+
+    pub fn send_trailers(&self, trailers: HashMap<String, String>) -> MagnusResult<()> {
+        self.inner.lock().send_trailers(trailers)
+    }
+
+    pub fn close(&self) -> MagnusResult<()> {
+        self.inner.lock().close()
+    }
+
+    pub fn add_headers(&self, headers: HashMap<Bytes, Vec<Bytes>>) -> MagnusResult<()> {
+        self.inner.lock().add_headers(headers)
+    }
+
+    pub async fn build_response(
+        &self,
+        first_frame: ByteFrame,
+        receiver: mpsc::Receiver<ByteFrame>,
+        shutdown_rx: watch::Receiver<RunningPhase>,
+    ) -> HttpResponse {
+        let mut response = self.inner.lock().response.take().unwrap();
+        let rx = self.inner.lock().trailer_rx.take().unwrap();
+        *response.version_mut() = Version::HTTP_2;
+        *response.headers_mut() = self.inner.lock().response_headers.clone();
+        *response.body_mut() = if matches!(first_frame, ByteFrame::Empty) {
+            BoxBody::new(Empty::new())
+        } else if matches!(first_frame, ByteFrame::End(_)) {
+            BoxBody::new(Full::new(first_frame.into()))
+        } else {
+            let initial_frame = tokio_stream::once(Ok(Frame::data(Bytes::from(first_frame))));
+            let frame_stream = unfold(
+                (ReceiverStream::new(receiver), shutdown_rx),
+                |(mut receiver, mut shutdown_rx)| async move {
+                    if let RunningPhase::ShutdownPending = *shutdown_rx.borrow() {
+                        return None;
+                    }
+                    loop {
+                        tokio::select! {
+                            maybe_bytes = receiver.next() => {
+                              match maybe_bytes {
+                                Some(ByteFrame::Data(bytes)) | Some(ByteFrame::End(bytes)) => {
+                                  return Some((Ok(Frame::data(bytes)), (receiver, shutdown_rx)));
+                                }
+                                _ => {
+                                  return None;
+                                }
+                              }
+                            },
+                            _ = shutdown_rx.changed() => {
+                                match *shutdown_rx.borrow() {
+                                    RunningPhase::ShutdownPending => {
+                                        warn!("Disconnecting streaming client.");
+                                        return None;
+                                    },
+                                    _ => continue,
+                                }
+                            }
+                        }
+                    }
+                },
+            );
+
+            let combined_stream = initial_frame.chain(frame_stream);
+            BoxBody::new(StreamBody::new(combined_stream))
+        }
+        .with_trailers(async move {
+            match rx.await {
+                Ok(trailers) => Some(Ok(trailers)),
+                Err(_err) => None,
+            }
+        })
+        .boxed();
+        response
+    }
+
+    pub fn internal_server_error(&self, message: String) {
+        error!(message);
+    }
+}

data/ext/itsi_server/src/ruby_types/itsi_http_request.rs

@@ -0,0 +1,362 @@
+use derive_more::Debug;
+use futures::StreamExt;
+use http::{header::CONTENT_LENGTH, request::Parts, Response, StatusCode, Version};
+use http_body_util::{combinators::BoxBody, BodyExt, Empty};
+use itsi_error::CLIENT_CONNECTION_CLOSED;
+use itsi_rb_helpers::{print_rb_backtrace, HeapValue};
+use itsi_tracing::{debug, error};
+use magnus::{
+    block::Proc,
+    error::{ErrorType, Result as MagnusResult},
+    Error, RHash, Symbol,
+};
+use magnus::{
+    value::{LazyId, ReprValue},
+    Ruby, Value,
+};
+use std::{fmt, io::Write, sync::Arc, time::Instant};
+use tokio::sync::mpsc::{self};
+
+use super::{
+    itsi_body_proxy::{big_bytes::BigBytes, ItsiBody, ItsiBodyProxy},
+    itsi_http_response::ItsiHttpResponse,
+};
+use crate::{
+    server::{
+        byte_frame::ByteFrame,
+        http_message_types::{HttpRequest, HttpResponse},
+        request_job::RequestJob,
+        size_limited_incoming::MaxBodySizeReached,
+    },
+    services::itsi_http_service::HttpRequestContext,
+};
+
+static ID_MESSAGE: LazyId = LazyId::new("message");
+
+#[derive(Debug)]
+#[magnus::wrap(class = "Itsi::HttpRequest", free_immediately, size)]
+pub struct ItsiHttpRequest {
+    pub parts: Parts,
+    #[debug(skip)]
+    pub body: ItsiBody,
+    pub version: Version,
+    pub response: ItsiHttpResponse,
+    pub start: Instant,
+    #[debug(skip)]
+    pub context: HttpRequestContext,
+    pub script_name: String,
+}
+
+impl fmt::Display for ItsiHttpRequest {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(
+            f,
+            "{} {} {}",
+            self.version().unwrap(),
+            self.method().unwrap(),
+            self.path().unwrap()
+        )
+    }
+}
+
+impl ItsiHttpRequest {
+    pub fn is_connection_closed_err(ruby: &Ruby, err: &Error) -> bool {
+        match err.error_type() {
+            ErrorType::Jump(_) => false,
+            ErrorType::Error(_, _) => false,
+            ErrorType::Exception(exception) => {
+                exception.is_kind_of(ruby.exception_eof_error())
+                    && err
+                        .value()
+                        .map(|v| {
+                            v.funcall::<_, _, String>(*ID_MESSAGE, ())
+                                .unwrap_or("".to_string())
+                                .eq(CLIENT_CONNECTION_CLOSED)
+                        })
+                        .unwrap_or(false)
+            }
+        }
+    }
+    pub fn content_type_str(&self) -> &str {
+        self.parts
+            .headers
+            .get("Content-Type")
+            .and_then(|hv| hv.to_str().ok())
+            .unwrap_or("application/x-www-form-urlencoded")
+    }
+
+    pub fn is_json(&self) -> bool {
+        self.content_type_str() == "application/json"
+    }
+
+    #[allow(unexpected_cfgs)]
+    pub fn url_params(&self) -> magnus::error::Result<RHash> {
+        let captures = self
+            .context
+            .matching_pattern
+            .as_ref()
+            .and_then(|re| re.captures(self.parts.uri.path()));
+        if let Some(caps) = &captures {
+            let re = self.context.matching_pattern.as_ref().unwrap();
+            let params = {
+                // when building against Ruby ≥ 3.2...
+                #[cfg(ruby_gte_3_2)]
+                {
+                    RHash::with_capacity(caps.len())
+                }
+
+                // when building against Ruby < 3.2...
+                #[cfg(not(ruby_gte_3_2))]
+                {
+                    RHash::new()
+                }
+            };
+            for (i, group_name) in re.capture_names().enumerate().skip(1) {
+                if let Some(name) = group_name {
+                    if let Some(m) = caps.get(i) {
+                        // Insert into the hash: key is the group name, value is the match.
+                        params.aset(Symbol::new(name), m.as_str())?;
+                    }
+                }
+            }
+            Ok(params)
+        } else {
+            Ok(RHash::new())
+        }
+    }
+
+    pub fn is_html(&self) -> bool {
+        self.content_type_str() == "text/html"
+    }
+
+    pub fn is_url_encoded(&self) -> bool {
+        self.content_type_str() == "application/x-www-form-urlencoded"
+    }
+
+    pub fn is_multipart(&self) -> bool {
+        self.content_type_str().starts_with("multipart/form-data")
+    }
+
+    pub fn content_length(&self) -> Option<u64> {
+        self.parts
+            .headers
+            .get(CONTENT_LENGTH)
+            .and_then(|hv| hv.to_str().ok())
+            .and_then(|s| s.parse().ok())
+    }
+
+    pub fn process(self, ruby: &Ruby, app_proc: Arc<HeapValue<Proc>>) -> magnus::error::Result<()> {
+        let response = self.response.clone();
+        let result = app_proc.call::<_, Value>((self,));
+        if let Err(err) = result {
+            Self::internal_error(ruby, response, err);
+        }
+        Ok(())
+    }
+
+    pub fn internal_error(ruby: &Ruby, response: ItsiHttpResponse, err: Error) {
+        if Self::is_connection_closed_err(ruby, &err) {
+            debug!("Connection closed by client");
+            response.close();
+        } else if let Some(rb_err) = err.value() {
+            print_rb_backtrace(rb_err);
+            response.internal_server_error(err.to_string());
+        } else {
+            response.internal_server_error(err.to_string());
+        }
+    }
+
+    pub fn error(self, message: String) {
+        self.response.internal_server_error(message);
+    }
+
+    pub(crate) async fn process_request(
+        app: Arc<HeapValue<Proc>>,
+        hyper_request: HttpRequest,
+        context: &HttpRequestContext,
+        script_name: String,
+        nonblocking: bool,
+    ) -> itsi_error::Result<HttpResponse> {
+        match ItsiHttpRequest::new(hyper_request, context, script_name).await {
+            Ok((request, mut receiver)) => {
+                let shutdown_channel = context.service.shutdown_channel.clone();
+                let response = request.response.clone();
+                let sender = if nonblocking {
+                    &context.nonblocking_sender
+                } else {
+                    &context.sender
+                };
+                match sender
+                    .send(RequestJob::ProcessHttpRequest(request, app))
+                    .await
+                {
+                    Err(err) => {
+                        error!("Error occurred: {}", err);
+                        let mut response = Response::new(BoxBody::new(Empty::new()));
+                        *response.status_mut() = StatusCode::BAD_REQUEST;
+                        Ok(response)
+                    }
+                    _ => match receiver.recv().await {
+                        Some(first_frame) => Ok(response
+                            .build(first_frame, receiver, shutdown_channel)
+                            .await),
+                        None => Ok(response
+                            .build(ByteFrame::Empty, receiver, shutdown_channel)
+                            .await),
+                    },
+                }
+            }
+            Err(err_resp) => Ok(err_resp),
+        }
+    }
+
+    pub(crate) async fn new(
+        request: HttpRequest,
+        context: &HttpRequestContext,
+        script_name: String,
+    ) -> Result<(ItsiHttpRequest, mpsc::Receiver<ByteFrame>), HttpResponse> {
+        let (parts, body) = request.into_parts();
+        let body = if context.server_params.streamable_body {
+            ItsiBody::Stream(ItsiBodyProxy::new(body))
+        } else {
+            let mut body_bytes = BigBytes::new();
+            let mut stream = body.into_data_stream();
+            while let Some(chunk) = stream.next().await {
+                match chunk {
+                    Ok(byte_array) => body_bytes.write_all(&byte_array).unwrap(),
+                    Err(e) => {
+                        let mut err_resp = Response::new(BoxBody::new(Empty::new()));
+                        if e.downcast_ref::<MaxBodySizeReached>().is_some() {
+                            *err_resp.status_mut() = StatusCode::PAYLOAD_TOO_LARGE;
+                        }
+                        return Err(err_resp);
+                    }
+                }
+            }
+            ItsiBody::Buffered(body_bytes)
+        };
+        let response_channel = mpsc::channel::<ByteFrame>(100);
+        Ok((
+            Self {
+                context: context.clone(),
+                version: parts.version,
+                response: ItsiHttpResponse::new(parts.clone(), response_channel.0),
+                start: Instant::now(),
+                script_name,
+                body,
+                parts,
+            },
+            response_channel.1,
+        ))
+    }
+
+    pub(crate) fn path(&self) -> MagnusResult<&str> {
+        Ok(self
+            .parts
+            .uri
+            .path()
+            .strip_prefix(self.script_name()?)
+            .unwrap_or(self.parts.uri.path()))
+    }
+
+    pub(crate) fn script_name(&self) -> MagnusResult<&str> {
+        Ok(self.script_name.trim_end_matches("/"))
+    }
+
+    pub(crate) fn query_string(&self) -> MagnusResult<&str> {
+        Ok(self.parts.uri.query().unwrap_or(""))
+    }
+
+    pub(crate) fn method(&self) -> MagnusResult<&str> {
+        Ok(self.parts.method.as_str())
+    }
+
+    pub(crate) fn version(&self) -> MagnusResult<&str> {
+        Ok(match self.version {
+            Version::HTTP_09 => "HTTP/0.9",
+            Version::HTTP_10 => "HTTP/1.0",
+            Version::HTTP_11 => "HTTP/1.1",
+            Version::HTTP_2 => "HTTP/2.0",
+            Version::HTTP_3 => "HTTP/3.0",
+            _ => "HTTP/Unknown",
+        })
+    }
+
+    pub(crate) fn rack_protocol(&self) -> MagnusResult<Vec<&str>> {
+        Ok(self
+            .parts
+            .headers
+            .get("upgrade")
+            .or_else(|| self.parts.headers.get("protocol"))
+            .map(|value| {
+                value
+                    .to_str()
+                    .unwrap_or("")
+                    .split(',')
+                    .map(|s| s.trim())
+                    .collect::<Vec<&str>>()
+            })
+            .unwrap_or_else(|| vec!["http"]))
+    }
+
+    pub(crate) fn host(&self) -> MagnusResult<&str> {
+        Ok(self
+            .parts
+            .uri
+            .host()
+            .unwrap_or_else(|| &self.context.listener.host))
+    }
+
+    pub(crate) fn scheme(&self) -> MagnusResult<&str> {
+        Ok(self
+            .parts
+            .uri
+            .scheme()
+            .map(|scheme| scheme.as_str())
+            .unwrap_or_else(|| &self.context.listener.scheme))
+    }
+
+    pub(crate) fn headers(&self) -> MagnusResult<Vec<(&str, &str)>> {
+        Ok(self
+            .parts
+            .headers
+            .iter()
+            .map(|(hn, hv)| (hn.as_str(), hv.to_str().unwrap_or("")))
+            .collect::<Vec<(&str, &str)>>())
+    }
+
+    pub(crate) fn uri(&self) -> MagnusResult<String> {
+        Ok(self.parts.uri.to_string())
+    }
+
+    pub fn header(&self, name: String) -> MagnusResult<Option<Vec<&str>>> {
+        let result: Vec<&str> = self
+            .parts
+            .headers
+            .get_all(&name)
+            .iter()
+            .filter_map(|value| value.to_str().ok())
+            .collect();
+        Ok(Some(result))
+    }
+
+    pub(crate) fn remote_addr(&self) -> MagnusResult<&str> {
+        Ok(&self.context.addr)
+    }
+
+    pub(crate) fn port(&self) -> MagnusResult<u16> {
+        Ok(self
+            .parts
+            .uri
+            .port_u16()
+            .unwrap_or(self.context.listener.port))
+    }
+
+    pub(crate) fn body(&self) -> MagnusResult<Option<Value>> {
+        Ok(self.body.into_value())
+    }
+
+    pub(crate) fn response(&self) -> MagnusResult<ItsiHttpResponse> {
+        Ok(self.response.clone())
+    }
+}