fix(server): make tower::Service impl generic over HttpBody (#1475)

hanabi1224 · niklasad1 · web-flow · commit 93722cb93d8e · 2024-10-16T17:23:13.000+02:00
* fix: compatibility issue of CompressionLayer in http middleware

* changelog

* revert tower* upgrade

* bump patch versions

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

* update links in README.md

* Update README.md

---------

Co-authored-by: Niklas Adolfsson &lt;niklasadolfsson1@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,14 @@ The format is based on [Keep a Changelog].
 
 [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/
 
+## [v0.24.7]
+
+This is a bug-fix release that fixes the tower::Service implementation to be generic over the HttpBody to work with all middleware layers. 
+For instance, this makes `tower_http::compression::CompressionLayer` work, which didn't compile before.
+
+### [Fixed]
+- fix(server): make tower::Service impl generic over HttpBody ([#1475](https://github.com/paritytech/jsonrpsee/pull/1475))
+
 ## [v0.24.6] - 2024-10-07
 
 This is a bug-fix release that fixes that the `ConnectionGuard` was dropped before the future was resolved which,
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,7 +20,7 @@ resolver = "2"
 
 [workspace.package]
 authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-version = "0.24.6"
+version = "0.24.7"
 edition = "2021"
 rust-version = "1.74.1"
 license = "MIT"
@@ -31,11 +31,14 @@ keywords = ["jsonrpc", "json", "http", "websocket", "WASM"]
 readme = "README.md"
 
 [workspace.dependencies]
-jsonrpsee-types = { path = "types", version = "0.24.6" }
-jsonrpsee-core = { path = "core", version = "0.24.6" }
-jsonrpsee-server = { path = "server", version = "0.24.6" }
-jsonrpsee-ws-client = { path = "client/ws-client", version = "0.24.6" }
-jsonrpsee-http-client = { path = "client/http-client", version = "0.24.6" }
-jsonrpsee-wasm-client = { path = "client/wasm-client", version = "0.24.6" }
-jsonrpsee-client-transport = { path = "client/transport", version = "0.24.6" }
-jsonrpsee-proc-macros = { path = "proc-macros", version = "0.24.6" }
+jsonrpsee-types = { path = "types", version = "0.24.7" }
+jsonrpsee-core = { path = "core", version = "0.24.7" }
+jsonrpsee-server = { path = "server", version = "0.24.7" }
+jsonrpsee-ws-client = { path = "client/ws-client", version = "0.24.7" }
+jsonrpsee-http-client = { path = "client/http-client", version = "0.24.7" }
+jsonrpsee-wasm-client = { path = "client/wasm-client", version = "0.24.7" }
+jsonrpsee-client-transport = { path = "client/transport", version = "0.24.7" }
+jsonrpsee-proc-macros = { path = "proc-macros", version = "0.24.7" }
+
+tower = "0.4"
+tower-http = "0.5"
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 ![MIT](https://img.shields.io/crates/l/jsonrpsee.svg)
 [![CI](https://github.com/paritytech/jsonrpsee/actions/workflows/ci.yml/badge.svg)](https://github.com/paritytech/jsonrpsee/actions/workflows/ci.yml)
 [![Benchmarks](https://github.com/paritytech/jsonrpsee/actions/workflows/benchmarks_gitlab.yml/badge.svg)](https://github.com/paritytech/jsonrpsee/actions/workflows/benchmarks_gitlab.yml)
-[![dependency status](https://deps.rs/crate/jsonrpsee/0.24.6/status.svg)](https://deps.rs/crate/jsonrpsee/0.24.6)
+[![dependency status](https://deps.rs/crate/jsonrpsee/latest/status.svg)](https://deps.rs/crate/jsonrpsee)
 
 JSON-RPC library designed for async/await in Rust.
 
diff --git a/client/http-client/Cargo.toml b/client/http-client/Cargo.toml
@@ -29,7 +29,7 @@ serde_json = "1"
 thiserror = "1"
 tokio = { version = "1.23.1", features = ["time"] }
 tracing = "0.1.34"
-tower = { version = "0.4.13", features = ["util"] }
+tower = { workspace = true, features = ["util"] }
 url = "2.4.0"
 
 [dev-dependencies]
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -19,7 +19,7 @@ tokio = { version = "1.23.1", features = ["full"] }
 tokio-stream = { version = "0.1", features = ["sync"] }
 serde_json = { version = "1" }
 tower-http = { version = "0.5.2", features = ["full"] }
-tower = { version = "0.4.13", features = ["full"] }
+tower = { workspace = true, features = ["full"] }
 hyper = "1.3"
 hyper-util = { version = "0.1.3", features = ["client", "client-legacy"]}
 console-subscriber = "0.4.0"
diff --git a/examples/examples/http_middleware.rs b/examples/examples/http_middleware.rs
@@ -40,6 +40,7 @@ use jsonrpsee::rpc_params;
 use std::iter::once;
 use std::net::SocketAddr;
 use std::time::Duration;
+use tower_http::compression::CompressionLayer;
 use tower_http::cors::CorsLayer;
 use tower_http::sensitive_headers::SetSensitiveRequestHeadersLayer;
 use tower_http::trace::{DefaultMakeSpan, DefaultOnResponse, TraceLayer};
@@ -107,6 +108,7 @@ async fn run_server() -> anyhow::Result<SocketAddr> {
 		// Mark the `Authorization` request header as sensitive so it doesn't show in logs
 		.layer(SetSensitiveRequestHeadersLayer::new(once(hyper::header::AUTHORIZATION)))
 		.layer(cors)
+		.layer(CompressionLayer::new())
 		.timeout(Duration::from_secs(2));
 
 	let server =
diff --git a/examples/examples/jsonrpsee_as_service.rs b/examples/examples/jsonrpsee_as_service.rs
@@ -48,6 +48,7 @@ use jsonrpsee::ws_client::{HeaderValue, WsClientBuilder};
 use jsonrpsee::{MethodResponse, Methods};
 use tokio::net::TcpListener;
 use tower::Service;
+use tower_http::compression::CompressionLayer;
 use tower_http::cors::CorsLayer;
 use tracing_subscriber::util::SubscriberInitExt;
 
@@ -202,14 +203,18 @@ async fn run_server(metrics: Metrics) -> anyhow::Result<ServerHandle> {
 				let transport_label = if is_websocket { "ws" } else { "http" };
 				let PerConnection { methods, stop_handle, metrics, svc_builder } = per_conn2.clone();
 
+				let http_middleware = tower::ServiceBuilder::new().layer(CompressionLayer::new());
 				// NOTE, the rpc middleware must be initialized here to be able to created once per connection
 				// with data from the connection such as the headers in this example
 				let headers = req.headers().clone();
 				let rpc_middleware = RpcServiceBuilder::new().rpc_logger(1024).layer_fn(move |service| {
 					AuthorizationMiddleware { inner: service, headers: headers.clone(), transport_label }
 				});
 
-				let mut svc = svc_builder.set_rpc_middleware(rpc_middleware).build(methods, stop_handle);
+				let mut svc = svc_builder
+					.set_http_middleware(http_middleware)
+					.set_rpc_middleware(rpc_middleware)
+					.build(methods, stop_handle);
 
 				if is_websocket {
 					// Utilize the session close future to know when the actual WebSocket
diff --git a/proc-macros/Cargo.toml b/proc-macros/Cargo.toml
@@ -33,4 +33,4 @@ serde_json = "1"
 serde = "1"
 trybuild = "1.0.97"
 tokio = { version = "1.23.1", features = ["rt", "macros"] }
-tower = "0.4"
+tower = { workspace = true }
diff --git a/server/Cargo.toml b/server/Cargo.toml
@@ -29,13 +29,13 @@ hyper-util = { version = "0.1", features = ["tokio", "service", "tokio", "server
 http = "1"
 http-body = "1"
 http-body-util = "0.1.0"
-tower = { version = "0.4.13", features = ["util"] }
+tower = { workspace = true, features = ["util"] }
 thiserror = "1"
 route-recognizer = "0.3.1"
 pin-project = "1.1.3"
 
 [dev-dependencies]
 jsonrpsee-test-utils = { path = "../test-utils" }
 tracing-subscriber = { version = "0.3.3", features = ["env-filter"] }
-tower = { version = "0.4.13", features = ["timeout"] }
+tower = { workspace = true, features = ["timeout"] }
 socket2 = "0.5.1"
diff --git a/server/src/server.rs b/server/src/server.rs
@@ -970,28 +970,28 @@ impl<RpcMiddleware, HttpMiddleware> TowerService<RpcMiddleware, HttpMiddleware>
 	}
 }
 
-impl<Body, RpcMiddleware, HttpMiddleware> Service<HttpRequest<Body>> for TowerService<RpcMiddleware, HttpMiddleware>
+impl<RequestBody, ResponseBody, RpcMiddleware, HttpMiddleware> Service<HttpRequest<RequestBody>> for TowerService<RpcMiddleware, HttpMiddleware>
 where
 	RpcMiddleware: for<'a> tower::Layer<RpcService> + Clone,
 	<RpcMiddleware as Layer<RpcService>>::Service: Send + Sync + 'static,
 	for<'a> <RpcMiddleware as Layer<RpcService>>::Service: RpcServiceT<'a>,
 	HttpMiddleware: Layer<TowerServiceNoHttp<RpcMiddleware>> + Send + 'static,
 	<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service:
-		Send + Service<HttpRequest<Body>, Response = HttpResponse, Error = Box<(dyn StdError + Send + Sync + 'static)>>,
-	<<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service as Service<HttpRequest<Body>>>::Future:
+		Send + Service<HttpRequest<RequestBody>, Response = HttpResponse<ResponseBody>, Error = Box<(dyn StdError + Send + Sync + 'static)>>,
+	<<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service as Service<HttpRequest<RequestBody>>>::Future:
 		Send + 'static,
-	Body: http_body::Body<Data = Bytes> + Send + 'static,
-	Body::Error: Into<BoxError>,
+	RequestBody: http_body::Body<Data = Bytes> + Send + 'static,
+	RequestBody::Error: Into<BoxError>,
 {
-	type Response = HttpResponse;
+	type Response = HttpResponse<ResponseBody>;
 	type Error = BoxError;
 	type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;
 
 	fn poll_ready(&mut self, _cx: &mut std::task::Context<'_>) -> Poll<Result<(), Self::Error>> {
 		Poll::Ready(Ok(()))
 	}
 
-	fn call(&mut self, request: HttpRequest<Body>) -> Self::Future {
+	fn call(&mut self, request: HttpRequest<RequestBody>) -> Self::Future {
 		Box::pin(self.http_middleware.service(self.rpc_middleware.clone()).call(request))
 	}
 }
diff --git a/tests/Cargo.toml b/tests/Cargo.toml
@@ -22,8 +22,8 @@ serde_json = "1"
 tokio = { version = "1.23.1", features = ["full"] }
 tokio-stream = "0.1"
 tokio-util = { version = "0.7", features = ["compat"]}
-tower = { version = "0.4.13", features = ["full"] }
-tower-http = { version = "0.5.2", features = ["full"] }
+tower = { workspace = true, features = ["full"] }
+tower-http = { workspace = true, features = ["full"] }
 tracing = "0.1.34"
 tracing-subscriber = { version = "0.3.3", features = ["env-filter"] }
 pin-project = "1"

Original file line number	Diff line number	Diff line change
`@@ -970,28 +970,28 @@ impl<RpcMiddleware, HttpMiddleware> TowerService<RpcMiddleware, HttpMiddleware>`
`970`	`970`	`}`
`971`	`971`	`}`
`972`	`972`
`973`		`-impl<Body, RpcMiddleware, HttpMiddleware> Service<HttpRequest<Body>> for TowerService<RpcMiddleware, HttpMiddleware>`
	`973`	`+impl<RequestBody, ResponseBody, RpcMiddleware, HttpMiddleware> Service<HttpRequest<RequestBody>> for TowerService<RpcMiddleware, HttpMiddleware>`
`974`	`974`	`where`
`975`	`975`	`RpcMiddleware: for<'a> tower::Layer<RpcService> + Clone,`
`976`	`976`	`<RpcMiddleware as Layer<RpcService>>::Service: Send + Sync + 'static,`
`977`	`977`	`for<'a> <RpcMiddleware as Layer<RpcService>>::Service: RpcServiceT<'a>,`
`978`	`978`	`HttpMiddleware: Layer<TowerServiceNoHttp<RpcMiddleware>> + Send + 'static,`
`979`	`979`	`<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service:`
`980`		`- Send + Service<HttpRequest<Body>, Response = HttpResponse, Error = Box<(dyn StdError + Send + Sync + 'static)>>,`
`981`		`- <<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service as Service<HttpRequest<Body>>>::Future:`
	`980`	`+ Send + Service<HttpRequest<RequestBody>, Response = HttpResponse<ResponseBody>, Error = Box<(dyn StdError + Send + Sync + 'static)>>,`
	`981`	`+ <<HttpMiddleware as Layer<TowerServiceNoHttp<RpcMiddleware>>>::Service as Service<HttpRequest<RequestBody>>>::Future:`
`982`	`982`	`Send + 'static,`
`983`		`- Body: http_body::Body<Data = Bytes> + Send + 'static,`
`984`		`- Body::Error: Into<BoxError>,`
	`983`	`+ RequestBody: http_body::Body<Data = Bytes> + Send + 'static,`
	`984`	`+ RequestBody::Error: Into<BoxError>,`
`985`	`985`	`{`
`986`		`- type Response = HttpResponse;`
	`986`	`+ type Response = HttpResponse<ResponseBody>;`
`987`	`987`	`type Error = BoxError;`
`988`	`988`	`type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;`
`989`	`989`
`990`	`990`	`fn poll_ready(&mut self, _cx: &mut std::task::Context<'_>) -> Poll<Result<(), Self::Error>> {`
`991`	`991`	`Poll::Ready(Ok(()))`
`992`	`992`	`}`
`993`	`993`
`994`		`- fn call(&mut self, request: HttpRequest<Body>) -> Self::Future {`
	`994`	`+ fn call(&mut self, request: HttpRequest<RequestBody>) -> Self::Future {`
`995`	`995`	`Box::pin(self.http_middleware.service(self.rpc_middleware.clone()).call(request))`
`996`	`996`	`}`
`997`	`997`	`}`