From 8470ad7fe3aef752564e5ed6a08e607db01ad073 Mon Sep 17 00:00:00 2001 From: Nikolay Kim Date: Sat, 30 Nov 2024 09:29:09 +0530 Subject: [PATCH] Move body related types from ntex::http (#474) --- ntex-compio/Cargo.toml | 1 + ntex-http/CHANGES.md | 4 ++ ntex-http/Cargo.toml | 9 ++- {ntex/src/http => ntex-http/src}/body.rs | 80 ++++++++++-------------- ntex-http/src/lib.rs | 1 + ntex/Cargo.toml | 4 +- ntex/src/http/mod.rs | 3 +- ntex/src/http/response.rs | 39 +++++++----- ntex/src/web/responder.rs | 22 +++---- ntex/src/web/types/form.rs | 2 +- ntex/src/web/types/json.rs | 2 +- 11 files changed, 85 insertions(+), 82 deletions(-) rename {ntex/src/http => ntex-http/src}/body.rs (94%) diff --git a/ntex-compio/Cargo.toml b/ntex-compio/Cargo.toml index 20d25fe6..9eb5b4c1 100644 --- a/ntex-compio/Cargo.toml +++ b/ntex-compio/Cargo.toml @@ -20,5 +20,6 @@ path = "src/lib.rs" ntex-bytes = "0.1" ntex-io = "2.5" ntex-util = "2" +ntex-rt = "0.4" log = "0.4" compio = { version = "0.13.0", features = ["macros", "runtime", "io", "io-uring", "polling"], default-features = false } diff --git a/ntex-http/CHANGES.md b/ntex-http/CHANGES.md index 875dd380..9d66b099 100644 --- a/ntex-http/CHANGES.md +++ b/ntex-http/CHANGES.md @@ -1,5 +1,9 @@ # Changes +## [0.1.13] - 2024-01-xx + +* Move body related types from ntex::http + ## [0.1.12] - 2024-01-16 * Update http dependency diff --git a/ntex-http/Cargo.toml b/ntex-http/Cargo.toml index 40929a7a..ccb4b5a6 100644 --- a/ntex-http/Cargo.toml +++ b/ntex-http/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ntex-http" -version = "0.1.12" +version = "0.1.13" authors = ["ntex contributors "] description = "Http types for ntex framework" keywords = ["network", "framework", "async", "futures"] @@ -20,9 +20,14 @@ http = "1" log = "0.4" fxhash = "0.2.1" itoa = "1.0.4" -ntex-bytes = "0.1.21" +ntex-bytes = "0.1" serde = "1" +futures-core = { version = "0.3", default-features = false, features = ["alloc"] } [dev-dependencies] bincode = "1" serde_json = "1" +ntex = "2" +ntex-util = "2" +ntex-macros = "0.1.3" +futures-util = { version = "0.3", default-features = false, features = ["alloc"] } diff --git a/ntex/src/http/body.rs b/ntex-http/src/body.rs similarity index 94% rename from ntex/src/http/body.rs rename to ntex-http/src/body.rs index 048854e7..f00f0d18 100644 --- a/ntex/src/http/body.rs +++ b/ntex-http/src/body.rs @@ -1,8 +1,10 @@ +//! Traits and structures to aid consuming and writing HTTP payloads. use std::{ error::Error, fmt, marker::PhantomData, mem, pin::Pin, task::Context, task::Poll, }; -use crate::util::{Bytes, BytesMut, Stream}; +use futures_core::Stream; +use ntex_bytes::{Bytes, BytesMut}; #[derive(Debug, PartialEq, Eq, Copy, Clone)] /// Body size hint @@ -19,8 +21,9 @@ impl BodySize { } } -/// Type that provides this trait can be streamed to a peer. +/// Interface for types that can be streamed to a peer. pub trait MessageBody: 'static { + /// Message body size hind fn size(&self) -> BodySize; fn poll_next_chunk( @@ -30,10 +33,12 @@ pub trait MessageBody: 'static { } impl MessageBody for () { + #[inline] fn size(&self) -> BodySize { BodySize::Empty } + #[inline] fn poll_next_chunk( &mut self, _: &mut Context<'_>, @@ -43,10 +48,12 @@ impl MessageBody for () { } impl MessageBody for Box { + #[inline] fn size(&self) -> BodySize { self.as_ref().size() } + #[inline] fn poll_next_chunk( &mut self, cx: &mut Context<'_>, @@ -56,6 +63,7 @@ impl MessageBody for Box { } #[derive(Debug)] +/// Represents http response body pub enum ResponseBody { Body(B), Other(Body), @@ -86,10 +94,12 @@ impl From for ResponseBody { } impl ResponseBody { + #[inline] pub fn new(body: B) -> Self { ResponseBody::Body(body) } + #[inline] pub fn take_body(&mut self) -> ResponseBody { std::mem::replace(self, ResponseBody::Other(Body::None)) } @@ -106,6 +116,7 @@ impl ResponseBody { } impl MessageBody for ResponseBody { + #[inline] fn size(&self) -> BodySize { match self { ResponseBody::Body(ref body) => body.size(), @@ -113,6 +124,7 @@ impl MessageBody for ResponseBody { } } + #[inline] fn poll_next_chunk( &mut self, cx: &mut Context<'_>, @@ -154,12 +166,13 @@ impl Body { } /// Create body from generic message body. - pub fn from_message(body: B) -> Body { + pub fn from_message(body: B) -> Body { Body::Message(Box::new(body)) } } impl MessageBody for Body { + #[inline] fn size(&self) -> BodySize { match self { Body::None => BodySize::None, @@ -253,12 +266,6 @@ impl From for Body { } } -impl From for Body { - fn from(v: serde_json::Value) -> Body { - Body::Bytes(v.to_string().into()) - } -} - impl From> for Body where S: Stream>> + Unpin + 'static, @@ -551,11 +558,12 @@ where #[cfg(test)] mod tests { - use futures_util::stream; use std::{future::poll_fn, io}; + use futures_util::stream; + use ntex_util::future::Ready; + use super::*; - use crate::util::Ready; impl Body { pub(crate) fn get_ref(&self) -> &[u8] { @@ -566,16 +574,7 @@ mod tests { } } - impl ResponseBody { - pub(crate) fn get_ref(&self) -> &[u8] { - match *self { - ResponseBody::Body(ref b) => b.get_ref(), - ResponseBody::Other(ref b) => b.get_ref(), - } - } - } - - #[crate::rt_test] + #[ntex::test] async fn test_static_str() { assert_eq!(Body::from("").size(), BodySize::Sized(0)); assert_eq!(Body::from("test").size(), BodySize::Sized(4)); @@ -593,7 +592,7 @@ mod tests { assert!(poll_fn(|cx| "".poll_next_chunk(cx)).await.is_none()); } - #[crate::rt_test] + #[ntex::test] async fn test_static_bytes() { assert_eq!(Body::from(b"test".as_ref()).size(), BodySize::Sized(4)); assert_eq!(Body::from(b"test".as_ref()).get_ref(), b"test"); @@ -615,7 +614,7 @@ mod tests { assert!(poll_fn(|cx| (&b""[..]).poll_next_chunk(cx)).await.is_none()); } - #[crate::rt_test] + #[ntex::test] async fn test_vec() { assert_eq!(Body::from(Vec::from("test")).size(), BodySize::Sized(4)); assert_eq!(Body::from(Vec::from("test")).get_ref(), b"test"); @@ -640,7 +639,7 @@ mod tests { .is_none()); } - #[crate::rt_test] + #[ntex::test] async fn test_bytes() { let mut b = Bytes::from("test"); assert_eq!(Body::from(b.clone()).size(), BodySize::Sized(4)); @@ -654,7 +653,7 @@ mod tests { assert!(poll_fn(|cx| b.poll_next_chunk(cx)).await.is_none(),); } - #[crate::rt_test] + #[ntex::test] async fn test_bytes_mut() { let mut b = Body::from(BytesMut::from("test")); assert_eq!(b.size(), BodySize::Sized(4)); @@ -675,7 +674,7 @@ mod tests { assert!(poll_fn(|cx| b.poll_next_chunk(cx)).await.is_none(),); } - #[crate::rt_test] + #[ntex::test] async fn test_string() { let mut b = "test".to_owned(); assert_eq!(Body::from(b.clone()).size(), BodySize::Sized(4)); @@ -691,20 +690,20 @@ mod tests { assert!(poll_fn(|cx| b.poll_next_chunk(cx)).await.is_none(),); } - #[crate::rt_test] + #[ntex::test] async fn test_unit() { assert_eq!(().size(), BodySize::Empty); assert!(poll_fn(|cx| ().poll_next_chunk(cx)).await.is_none()); } - #[crate::rt_test] + #[ntex::test] async fn test_box() { let mut val = Box::new(()); assert_eq!(val.size(), BodySize::Empty); assert!(poll_fn(|cx| val.poll_next_chunk(cx)).await.is_none()); } - #[crate::rt_test] + #[ntex::test] #[allow(clippy::eq_op)] async fn test_body_eq() { assert!(Body::None == Body::None); @@ -717,27 +716,14 @@ mod tests { assert!(Body::Bytes(Bytes::from_static(b"1")) != Body::None); } - #[crate::rt_test] + #[ntex::test] async fn test_body_debug() { assert!(format!("{:?}", Body::None).contains("Body::None")); assert!(format!("{:?}", Body::Empty).contains("Body::Empty")); assert!(format!("{:?}", Body::Bytes(Bytes::from_static(b"1"))).contains('1')); } - #[crate::rt_test] - async fn test_serde_json() { - use serde_json::json; - assert_eq!( - Body::from(serde_json::Value::String("test".into())).size(), - BodySize::Sized(6) - ); - assert_eq!( - Body::from(json!({"test-key":"test-value"})).size(), - BodySize::Sized(25) - ); - } - - #[crate::rt_test] + #[ntex::test] async fn body_stream() { let st = BodyStream::new(stream::once(Ready::<_, io::Error>::Ok(Bytes::from("1")))); assert!(format!("{:?}", st).contains("BodyStream")); @@ -749,7 +735,7 @@ mod tests { assert!(res.as_ref().is_some()); } - #[crate::rt_test] + #[ntex::test] async fn boxed_body_stream() { let st = BoxedBodyStream::new(stream::once(Ready::<_, Box>::Ok( Bytes::from("1"), @@ -763,7 +749,7 @@ mod tests { assert!(res.as_ref().is_some()); } - #[crate::rt_test] + #[ntex::test] async fn body_skips_empty_chunks() { let mut body = BodyStream::new(stream::iter( ["1", "", "2"] @@ -780,7 +766,7 @@ mod tests { ); } - #[crate::rt_test] + #[ntex::test] async fn sized_skips_empty_chunks() { let mut body = SizedStream::new( 2, diff --git a/ntex-http/src/lib.rs b/ntex-http/src/lib.rs index faefe9b3..88a962f3 100644 --- a/ntex-http/src/lib.rs +++ b/ntex-http/src/lib.rs @@ -1,6 +1,7 @@ //! Http protocol support. #![deny(rust_2018_idioms, unreachable_pub, missing_debug_implementations)] +pub mod body; pub mod error; mod map; mod serde; diff --git a/ntex/Cargo.toml b/ntex/Cargo.toml index 0359e7e5..0c2462ce 100644 --- a/ntex/Cargo.toml +++ b/ntex/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ntex" -version = "2.8.0" +version = "2.9.0" authors = ["ntex contributors "] description = "Framework for composable network services" readme = "README.md" @@ -62,7 +62,7 @@ brotli = ["dep:brotli2"] [dependencies] ntex-codec = "0.6" -ntex-http = "0.1.12" +ntex-http = "0.1.13" ntex-router = "0.5" ntex-service = "3.3" ntex-macros = "0.1" diff --git a/ntex/src/http/mod.rs b/ntex/src/http/mod.rs index 29d79bb3..3190259f 100644 --- a/ntex/src/http/mod.rs +++ b/ntex/src/http/mod.rs @@ -1,5 +1,4 @@ //! Http protocol support. -pub mod body; mod builder; pub mod client; mod config; @@ -36,4 +35,4 @@ pub use crate::io::types::HttpProtocol; // re-exports pub use ntex_http::uri::{self, Uri}; -pub use ntex_http::{HeaderMap, Method, StatusCode, Version}; +pub use ntex_http::{body, HeaderMap, Method, StatusCode, Version}; diff --git a/ntex/src/http/response.rs b/ntex/src/http/response.rs index faea582c..9c68c6fe 100644 --- a/ntex/src/http/response.rs +++ b/ntex/src/http/response.rs @@ -227,6 +227,20 @@ impl Response { } } +#[cfg(test)] +impl Response { + pub(crate) fn get_body_ref(&self) -> &[u8] { + let b = match *self.body() { + ResponseBody::Body(ref b) => b, + ResponseBody::Other(ref b) => b, + }; + match b { + Body::Bytes(bin) => bin, + _ => panic!(), + } + } +} + impl fmt::Debug for Response { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let res = writeln!( @@ -925,7 +939,7 @@ mod tests { let resp = Response::build(StatusCode::OK).json(&vec!["v1", "v2", "v3"]); let ct = resp.headers().get(CONTENT_TYPE).unwrap(); assert_eq!(ct, HeaderValue::from_static("application/json")); - assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]"); + assert_eq!(resp.get_body_ref(), b"[\"v1\",\"v2\",\"v3\"]"); } #[test] @@ -935,14 +949,7 @@ mod tests { .json(&vec!["v1", "v2", "v3"]); let ct = resp.headers().get(CONTENT_TYPE).unwrap(); assert_eq!(ct, HeaderValue::from_static("text/json")); - assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]"); - } - - #[test] - fn test_serde_json_in_body() { - use serde_json::json; - let resp = Response::build(StatusCode::OK).body(json!({"test-key":"test-value"})); - assert_eq!(resp.body().get_ref(), br#"{"test-key":"test-value"}"#); + assert_eq!(resp.get_body_ref(), b"[\"v1\",\"v2\",\"v3\"]"); } #[test] @@ -955,7 +962,7 @@ mod tests { HeaderValue::from_static("text/plain; charset=utf-8") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let resp: Response = b"test".as_ref().into(); assert_eq!(resp.status(), StatusCode::OK); @@ -964,7 +971,7 @@ mod tests { HeaderValue::from_static("application/octet-stream") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let resp: Response = "test".to_owned().into(); assert_eq!(resp.status(), StatusCode::OK); @@ -973,7 +980,7 @@ mod tests { HeaderValue::from_static("text/plain; charset=utf-8") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let resp: Response = (&"test".to_owned()).into(); assert_eq!(resp.status(), StatusCode::OK); @@ -982,7 +989,7 @@ mod tests { HeaderValue::from_static("text/plain; charset=utf-8") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let b = Bytes::from_static(b"test"); let resp: Response = b.into(); @@ -992,7 +999,7 @@ mod tests { HeaderValue::from_static("application/octet-stream") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let b = Bytes::from_static(b"test"); let resp: Response = b.into(); @@ -1002,7 +1009,7 @@ mod tests { HeaderValue::from_static("application/octet-stream") ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let b = BytesMut::from("test"); let resp: Response = b.into(); @@ -1013,7 +1020,7 @@ mod tests { ); assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); let builder = Response::build_from(ResponseBuilder::new(StatusCode::OK)) .keep_alive() diff --git a/ntex/src/web/responder.rs b/ntex/src/web/responder.rs index b42ee506..a8f1bf42 100644 --- a/ntex/src/web/responder.rs +++ b/ntex/src/web/responder.rs @@ -371,7 +371,7 @@ pub(crate) mod tests { let resp: HttpResponse = responder("test").respond_to(&req).await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("text/plain; charset=utf-8") @@ -379,7 +379,7 @@ pub(crate) mod tests { let resp: HttpResponse = responder(&b"test"[..]).respond_to(&req).await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("application/octet-stream") @@ -387,7 +387,7 @@ pub(crate) mod tests { let resp: HttpResponse = responder("test".to_string()).respond_to(&req).await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("text/plain; charset=utf-8") @@ -395,7 +395,7 @@ pub(crate) mod tests { let resp: HttpResponse = responder(&"test".to_string()).respond_to(&req).await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("text/plain; charset=utf-8") @@ -405,7 +405,7 @@ pub(crate) mod tests { .respond_to(&req) .await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("application/octet-stream") @@ -415,7 +415,7 @@ pub(crate) mod tests { .respond_to(&req) .await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("application/octet-stream") @@ -440,7 +440,7 @@ pub(crate) mod tests { ) .await; assert_eq!(resp.status(), StatusCode::OK); - assert_eq!(resp.body().get_ref(), b"test"); + assert_eq!(resp.get_body_ref(), b"test"); assert_eq!( resp.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("text/plain; charset=utf-8") @@ -463,7 +463,7 @@ pub(crate) mod tests { .respond_to(&req) .await; assert_eq!(res.status(), StatusCode::BAD_REQUEST); - assert_eq!(res.body().get_ref(), b"test"); + assert_eq!(res.get_body_ref(), b"test"); let res = responder("test".to_string()) .with_header("content-type", "json") @@ -471,7 +471,7 @@ pub(crate) mod tests { .await; assert_eq!(res.status(), StatusCode::OK); - assert_eq!(res.body().get_ref(), b"test"); + assert_eq!(res.get_body_ref(), b"test"); assert_eq!( res.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("json") @@ -487,7 +487,7 @@ pub(crate) mod tests { ) .await; assert_eq!(res.status(), StatusCode::BAD_REQUEST); - assert_eq!(res.body().get_ref(), b"test"); + assert_eq!(res.get_body_ref(), b"test"); let req = TestRequest::default().to_http_request(); let res = @@ -496,7 +496,7 @@ pub(crate) mod tests { .respond_to(&req) .await; assert_eq!(res.status(), StatusCode::OK); - assert_eq!(res.body().get_ref(), b"test"); + assert_eq!(res.get_body_ref(), b"test"); assert_eq!( res.headers().get(CONTENT_TYPE).unwrap(), HeaderValue::from_static("json") diff --git a/ntex/src/web/types/form.rs b/ntex/src/web/types/form.rs index 5605aa7f..1b69407c 100644 --- a/ntex/src/web/types/form.rs +++ b/ntex/src/web/types/form.rs @@ -493,6 +493,6 @@ mod tests { HeaderValue::from_static("application/x-www-form-urlencoded") ); - assert_eq!(resp.body().get_ref(), b"hello=world&counter=123"); + assert_eq!(resp.get_body_ref(), b"hello=world&counter=123"); } } diff --git a/ntex/src/web/types/json.rs b/ntex/src/web/types/json.rs index 580b1db8..2f429791 100644 --- a/ntex/src/web/types/json.rs +++ b/ntex/src/web/types/json.rs @@ -434,7 +434,7 @@ mod tests { header::HeaderValue::from_static("application/json") ); - assert_eq!(resp.body().get_ref(), b"{\"name\":\"test\"}"); + assert_eq!(resp.get_body_ref(), b"{\"name\":\"test\"}"); } #[crate::rt_test]