Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[breaking change] Implement HTTP/1/2-only support #130

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[breaking change] Implement HTTP/1/2-only support #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog], and this project adheres to
[Semantic Versioning].

# Unreleased

- **added**: `http1` and `http2` crate feature, both enabled by default.
- **changed**: Renamed `tls-rustls-no-provider` crate feature to `tls-rustls-no-default`.
- **removed**: `Server::http_builder()`.
- **added**: `Server::http1_only()` and `Server::http2_only()`.

# 0.7.1 (31. July 2024)

- **added**: Crate feature `tls-rustls-no-provider`, which enables no `rustls::crypto::CryptoProvider`.
Expand Down
19 changes: 11 additions & 8 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ repository = "https://github.com/programatik29/axum-server"
version = "0.7.1"

[features]
default = []
tls-rustls = ["tls-rustls-no-provider", "rustls/aws-lc-rs"]
tls-rustls-no-provider = ["arc-swap", "rustls", "rustls-pemfile", "tokio/fs", "tokio/time", "tokio-rustls", "rustls-pki-types"]
tls-openssl = ["arc-swap", "openssl", "tokio-openssl"]
default = ["http1", "http2"]
http1 = ["hyper/http1", "hyper-util/http1"]
http2 = ["hyper/http2", "hyper-util/http2"]
tls-rustls = ["tls-rustls-no-default", "rustls/aws-lc-rs", "rustls/tls12", "tokio-rustls/aws-lc-rs", "tokio-rustls/tls12"]
tls-rustls-no-default = ["dep:arc-swap", "dep:rustls", "dep:rustls-pemfile", "tokio/fs", "tokio/time", "dep:tokio-rustls", "dep:rustls-pki-types"]
tls-openssl = ["dep:arc-swap", "dep:openssl", "dep:tokio-openssl"]

[dependencies]
bytes = "1"
Expand All @@ -24,21 +26,21 @@ futures-util = { version = "0.3", default-features = false, features = [
] }
http = "1.1"
http-body = "1.0"
hyper = { version = "1.4", features = ["http1", "http2", "server"] }
hyper = { version = "1.4", features = ["server"] }
tokio = { version = "1", features = ["macros", "net", "sync"] }
tower-service = "0.3"
http-body-util = "0.1"
hyper-util = { version = "0.1.2", features = ["server-auto", "tokio"] }
hyper-util = { version = "0.1.2", features = ["server", "tokio"] }
pin-project-lite = "0.2"
tower = { version = "0.4", features = ["util"] }

# optional dependencies
## rustls
arc-swap = { version = "1", optional = true }
rustls = { version = "0.23", default-features = false, optional = true }
rustls = { version = "0.23", default-features = false, features = ["logging", "std"], optional = true }
rustls-pki-types = { version = "1.7", optional = true }
rustls-pemfile = { version = "2.1", optional = true }
tokio-rustls = { version = "0.26", default-features = false, optional = true }
tokio-rustls = { version = "0.26", default-features = false, features = ["logging"], optional = true }

## openssl
openssl = { version = "0.10", optional = true }
Expand All @@ -47,6 +49,7 @@ tokio-openssl = { version = "0.6", optional = true }
[dev-dependencies]
serial_test = "3.1"
axum = "0.7"
axum-server = { path = "" }
hyper = { version = "1.4", features = ["full"] }
tokio = { version = "1", features = ["full"] }
tower = { version = "0.4", features = ["util"] }
Expand Down
8 changes: 5 additions & 3 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@
//!
//! # Features
//!
//! * `http1` - enables HTTP/1 support (enabled by default).
//! * `http2` - enables HTTP/2 support (enabled by default).
//! * `tls-rustls` - activate [rustls] support.
//! * `tls-rustls-no-provider` - activate [rustls] support without a default provider.
//! * `tls-rustls-no-default` - activate [rustls] support without a default crypto provider or TLS v1.2 support.
//! * `tls-openssl` - activate [openssl] support.
//!
//! # Example
Expand Down Expand Up @@ -108,12 +110,12 @@ pub use self::{
server::{bind, from_tcp, Server},
};

#[cfg(feature = "tls-rustls-no-provider")]
#[cfg(feature = "tls-rustls-no-default")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls-rustls")))]
pub mod tls_rustls;

#[doc(inline)]
#[cfg(feature = "tls-rustls-no-provider")]
#[cfg(feature = "tls-rustls-no-default")]
pub use self::tls_rustls::export::{bind_rustls, from_tcp_rustls};

#[cfg(feature = "tls-openssl")]
Expand Down
123 changes: 100 additions & 23 deletions src/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use crate::{
service::TowerToHyperService,
service::{MakeService, SendService},
};
use futures_util::future::poll_fn;
use futures_util::future::{poll_fn, Either};
use http::Request;
use hyper::body::Incoming;
use hyper_util::{
Expand All @@ -28,6 +28,7 @@ pub struct Server<A = DefaultAcceptor> {
builder: Builder<TokioExecutor>,
listener: Listener,
handle: Handle,
http1_only: bool,
}

// Builder doesn't implement Debug or Clone right now
Expand All @@ -40,6 +41,7 @@ where
.field("acceptor", &self.acceptor)
.field("listener", &self.listener)
.field("handle", &self.handle)
.field("http1_only", &self.http1_only)
.finish_non_exhaustive()
}
}
Expand Down Expand Up @@ -72,6 +74,7 @@ impl Server {
builder,
listener: Listener::Bind(addr),
handle,
http1_only: false,
}
}

Expand All @@ -86,6 +89,7 @@ impl Server {
builder,
listener: Listener::Std(listener),
handle,
http1_only: false,
}
}
}
Expand All @@ -98,6 +102,7 @@ impl<A> Server<A> {
builder: self.builder,
listener: self.listener,
handle: self.handle,
http1_only: self.http1_only,
}
}

Expand All @@ -111,6 +116,7 @@ impl<A> Server<A> {
builder: self.builder,
listener: self.listener,
handle: self.handle,
http1_only: self.http1_only,
}
}

Expand All @@ -124,9 +130,30 @@ impl<A> Server<A> {
&mut self.acceptor
}

/// Returns a mutable reference to the Http builder.
pub fn http_builder(&mut self) -> &mut Builder<TokioExecutor> {
&mut self.builder
Comment on lines -127 to -129
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see this API remain available, as I use it to configure many settings for both HTTP/1 and HTTP/2 👀

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea here is to expose anything Builder exposes through axum-servers interface.
What method exactly are you unable to access with the new API?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I don't see how I would access these:

serve
    .http_builder()
    .http1()
    .timer(hyper_util::rt::TokioTimer::new())
    .keep_alive(true)
    .header_read_timeout(Duration::from_secs(5))
    .max_buf_size(32768)
    .http2()
    .timer(hyper_util::rt::TokioTimer::new())
    .keep_alive_interval(Duration::from_secs(16))
    .keep_alive_timeout(Duration::from_secs(5))
    .max_header_list_size(512 * 1024)
    .max_send_buf_size(64 * 1024)
    .max_concurrent_streams(16);

Copy link
Collaborator Author

@daxpedda daxpedda Aug 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, I assume if we expose Builder::http1() and Builder::http2() this would cover all the methods you have listed?
The PR should probably be in draft mode.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have an intermediate solution that does not breaks compatibility that can be used, see #156. Let me know what you think.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad it doesn't break compatibility. Still don't personally understand the API or the use-case but you have to convince the maintainer, not me ;)

/// Only accepts HTTP/1.
#[cfg(feature = "http1")]
#[cfg_attr(docsrs, doc(cfg(feature = "http1")))]
pub fn http1_only(self) -> Self {
Server {
acceptor: self.acceptor,
builder: self.builder.http1_only(),
listener: self.listener,
handle: self.handle,
http1_only: true,
}
}

/// Only accepts HTTP/2.
#[cfg(feature = "http2")]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub fn http2_only(self) -> Self {
Server {
acceptor: self.acceptor,
builder: self.builder.http2_only(),
listener: self.listener,
handle: self.handle,
http1_only: false,
}
}

/// Provide a handle for additional utilities.
Expand Down Expand Up @@ -199,13 +226,22 @@ impl<A> Server<A> {
let service = send_service.into_service();
let service = TowerToHyperService::new(service);

let serve_future = builder.serve_connection_with_upgrades(io, service);
let serve_future = if self.http1_only {
Either::Left(builder.serve_connection(io, service))
} else {
Either::Right(builder.serve_connection_with_upgrades(io, service))
};

tokio::pin!(serve_future);
let mut serve_future = serve_future.as_pin_mut();

tokio::select! {
biased;
_ = watcher.wait_graceful_shutdown() => {
serve_future.as_mut().graceful_shutdown();
match &mut serve_future {
Either::Left(serve_future) => serve_future.as_mut().graceful_shutdown(),
Either::Right(serve_future) => serve_future.as_mut().graceful_shutdown(),
}
tokio::select! {
biased;
_ = watcher.wait_shutdown() => (),
Expand Down Expand Up @@ -280,16 +316,15 @@ mod tests {
use http::{Method, Request, Uri};
use http_body::Frame;
use http_body_util::{BodyExt, StreamBody};
use hyper::client::conn::http1::handshake;
use hyper::client::conn::http1::SendRequest;
use hyper_util::rt::TokioIo;
use hyper::client::conn::{http1, http2};
use hyper_util::rt::{TokioExecutor, TokioIo};
use std::{io, net::SocketAddr, time::Duration};
use tokio::sync::oneshot;
use tokio::{net::TcpStream, task::JoinHandle, time::timeout};

#[tokio::test]
async fn start_and_request() {
let (_handle, _server_task, addr) = start_server().await;
let (_handle, _server_task, addr) = start_server(false).await;

let (mut client, _conn) = connect(addr).await;

Expand All @@ -304,7 +339,7 @@ mod tests {

#[tokio::test]
async fn test_shutdown() {
let (handle, _server_task, addr) = start_server().await;
let (handle, _server_task, addr) = start_server(false).await;

let (mut client, conn) = connect(addr).await;

Expand All @@ -323,7 +358,7 @@ mod tests {
// Test graceful shutdown with no timeout.
#[tokio::test]
async fn test_graceful_shutdown_no_timeout() {
let (handle, server_task, addr) = start_server().await;
let (handle, server_task, addr) = start_server(false).await;

let (mut client1, _conn1) = connect(addr).await;
let (mut client2, _conn2) = connect(addr).await;
Expand Down Expand Up @@ -354,6 +389,9 @@ mod tests {
hdr1_rx.await.unwrap();
handle.graceful_shutdown(None);

// Wait for graceful shutdown to register
tokio::time::sleep(Duration::from_millis(250)).await;

// Any new requests after graceful shutdown begins will fail
do_empty_request(&mut client2).await.unwrap_err();
do_empty_request(&mut client2).await.unwrap_err();
Expand All @@ -378,7 +416,7 @@ mod tests {
// Test graceful shutdown with a timeout.
#[tokio::test]
async fn test_graceful_shutdown_timeout() {
let (handle, server_task, addr) = start_server().await;
let (handle, server_task, addr) = start_server(false).await;

let (mut client1, _conn1) = connect(addr).await;
let (mut client2, _conn2) = connect(addr).await;
Expand Down Expand Up @@ -430,7 +468,41 @@ mod tests {
tokio::join!(task1, task2, task3);
}

async fn start_server() -> (Handle, JoinHandle<io::Result<()>>, SocketAddr) {
#[tokio::test]
async fn http1() {
let (_handle, _server_task, addr) = start_server(true).await;

// HTTP/2 should fail
{
let (mut client, _conn) = connect(addr).await;
do_empty_request(&mut client).await.unwrap_err();
}

// HTTP/1 should succeed
{
let (mut client, _conn) = {
let stream = TokioIo::new(TcpStream::connect(addr).await.unwrap());
let (send_request, connection) = http1::handshake(stream).await.unwrap();
let task = tokio::spawn(async move {
let _ = connection.await;
});
(send_request, task)
};

client.ready().await.unwrap();

let body = client
.send_request(Request::new(Body::empty()))
.await
.unwrap()
.into_body();

let body = body.collect().await.unwrap().to_bytes();
assert_eq!(body.as_ref(), b"Hello, world!");
}
}

async fn start_server(http1_only: bool) -> (Handle, JoinHandle<io::Result<()>>, SocketAddr) {
let handle = Handle::new();

let server_handle = handle.clone();
Expand All @@ -447,20 +519,25 @@ mod tests {

let addr = SocketAddr::from(([127, 0, 0, 1], 0));

Server::bind(addr)
.handle(server_handle)
.serve(app.into_make_service())
.await
let mut server = Server::bind(addr).handle(server_handle);

if http1_only {
server = server.http1_only()
}

server.serve(app.into_make_service()).await
});

let addr = handle.listening().await.unwrap();

(handle, server_task, addr)
}

async fn connect(addr: SocketAddr) -> (SendRequest<Body>, JoinHandle<()>) {
async fn connect(addr: SocketAddr) -> (http2::SendRequest<Body>, JoinHandle<()>) {
let stream = TokioIo::new(TcpStream::connect(addr).await.unwrap());
let (send_request, connection) = handshake(stream).await.unwrap();
let (send_request, connection) = http2::handshake(TokioExecutor::new(), stream)
.await
.unwrap();

let task = tokio::spawn(async move {
let _ = connection.await;
Expand All @@ -470,7 +547,7 @@ mod tests {
}

// Send a basic `GET /` request.
async fn do_empty_request(client: &mut SendRequest<Body>) -> hyper::Result<()> {
async fn do_empty_request(client: &mut http2::SendRequest<Body>) -> hyper::Result<()> {
client.ready().await?;

let body = client
Expand All @@ -486,15 +563,15 @@ mod tests {
// Send a request with a body streamed byte-by-byte, over a given duration,
// then wait for the full response.
async fn do_slow_request(
client: &mut SendRequest<Body>,
client: &mut http2::SendRequest<Body>,
duration: Duration,
) -> hyper::Result<()> {
let response = send_slow_request(client, duration).await?;
recv_slow_response_body(response).await
}

async fn send_slow_request(
client: &mut SendRequest<Body>,
client: &mut http2::SendRequest<Body>,
duration: Duration,
) -> hyper::Result<http::Response<hyper::body::Incoming>> {
let req_body_len: usize = 10;
Expand Down