From d3499feb800849fecfe5f99ed19fc628f3cdcb5b Mon Sep 17 00:00:00 2001 From: Sergey Vilgelm <523825+SVilgelm@users.noreply.github.com> Date: Thu, 28 Mar 2024 02:00:43 -0700 Subject: [PATCH] Move the websocket code to a separate `ws` feature (#320) --- .github/workflows/cov.yml | 4 ++-- .github/workflows/linux.yml | 2 +- ntex/Cargo.toml | 29 +++++++++++++++++++---------- ntex/src/http/client/response.rs | 1 + ntex/src/http/test.rs | 11 ++++++++--- ntex/src/lib.rs | 2 ++ ntex/src/web/error_default.rs | 2 ++ ntex/src/web/mod.rs | 2 ++ ntex/src/web/test.rs | 7 ++++++- 9 files changed, 43 insertions(+), 17 deletions(-) diff --git a/.github/workflows/cov.yml b/.github/workflows/cov.yml index 76a8bba6..010df083 100644 --- a/.github/workflows/cov.yml +++ b/.github/workflows/cov.yml @@ -31,10 +31,10 @@ jobs: run: cargo llvm-cov clean --workspace - name: Code coverage (glommio) - run: cargo +nightly llvm-cov --no-report --all --no-default-features --features="glommio,cookie,url,compress,openssl,rustls" + run: cargo +nightly llvm-cov --no-report --all --no-default-features --features="glommio,cookie,url,compress,openssl,rustls,ws" - name: Code coverage - run: cargo +nightly llvm-cov --no-report --all --doctests --no-default-features --features="tokio,cookie,url,compress,openssl,rustls" + run: cargo +nightly llvm-cov --no-report --all --doctests --no-default-features --features="tokio,cookie,url,compress,openssl,rustls,ws" - name: Generate coverage report run: cargo +nightly llvm-cov report --lcov --output-path lcov.info --ignore-filename-regex="ntex-tokio|ntex-glommio|ntex-async-std" diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml index 2739e069..53e0f2c2 100644 --- a/.github/workflows/linux.yml +++ b/.github/workflows/linux.yml @@ -59,7 +59,7 @@ jobs: continue-on-error: true run: | cd ntex - cargo test --no-default-features --no-fail-fast --features="async-std,cookie,url,compress,openssl,rustls" + cargo test --no-default-features --no-fail-fast --features="async-std,cookie,url,compress,openssl,rustls,ws" - name: Install cargo-cache continue-on-error: true diff --git a/ntex/Cargo.toml b/ntex/Cargo.toml index 60fdd75e..c1fabccd 100644 --- a/ntex/Cargo.toml +++ b/ntex/Cargo.toml @@ -7,9 +7,12 @@ readme = "README.md" keywords = ["ntex", "networking", "framework", "async", "futures"] repository = "https://github.com/ntex-rs/ntex.git" documentation = "https://docs.rs/ntex/" -categories = ["network-programming", "asynchronous", - "web-programming::http-server", - "web-programming::websocket"] +categories = [ + "network-programming", + "asynchronous", + "web-programming::http-server", + "web-programming::websocket", +] license = "MIT OR Apache-2.0" edition = "2021" @@ -47,6 +50,9 @@ glommio = ["ntex-net/glommio"] # async-std runtime async-std = ["ntex-net/async-std"] +# websocket support +ws = ["dep:sha-1"] + [dependencies] ntex-codec = "0.6.2" ntex-http = "0.1.12" @@ -65,11 +71,14 @@ ntex-tls = "1.0.0" base64 = "0.22" bitflags = "2" log = "0.4" -nanorand = { version = "0.7", default-features = false, features = ["std", "wyrand"] } +nanorand = { version = "0.7", default-features = false, features = [ + "std", + "wyrand", +] } pin-project-lite = "0.2" regex = { version = "1.10", default-features = false, features = ["std"] } -serde = { version = "1.0", features=["derive"] } -sha-1 = "0.10" +serde = { version = "1.0", features = ["derive"] } +sha-1 = { version = "0.10", optional = true } thiserror = "1.0" # http/web framework @@ -84,14 +93,14 @@ url-pkg = { version = "2.4", package = "url", optional = true } coo-kie = { version = "0.18", package = "cookie", optional = true } # openssl -tls-openssl = { version="0.10", package = "openssl", optional = true } +tls-openssl = { version = "0.10", package = "openssl", optional = true } # rustls tls-rustls = { version = "0.23", package = "rustls", optional = true } webpki-roots = { version = "0.26", optional = true } # compression -brotli2 = { version="0.3.2", optional = true } +brotli2 = { version = "0.3.2", optional = true } flate2 = { version = "1.0.22", optional = true } [dev-dependencies] @@ -99,7 +108,7 @@ env_logger = "0.11" rand = "0.8" time = "0.3" futures-util = "0.3" -tls-openssl = { version="0.10", package = "openssl" } -tls-rustls = { version = "0.23", package="rustls" } +tls-openssl = { version = "0.10", package = "openssl" } +tls-rustls = { version = "0.23", package = "rustls" } rustls-pemfile = "2" webpki-roots = "0.26" diff --git a/ntex/src/http/client/response.rs b/ntex/src/http/client/response.rs index beb49041..a5562add 100644 --- a/ntex/src/http/client/response.rs +++ b/ntex/src/http/client/response.rs @@ -71,6 +71,7 @@ impl ClientResponse { } } + #[cfg(feature = "ws")] pub(crate) fn with_empty_payload(head: ResponseHead, config: Rc) -> Self { ClientResponse::new(head, Payload::None, config) } diff --git a/ntex/src/http/test.rs b/ntex/src/http/test.rs index a7ea10a3..5660f37c 100644 --- a/ntex/src/http/test.rs +++ b/ntex/src/http/test.rs @@ -4,7 +4,10 @@ use std::{net, str::FromStr, sync::mpsc, thread}; #[cfg(feature = "cookie")] use coo_kie::{Cookie, CookieJar}; -use crate::io::{Filter, Io}; +#[cfg(feature = "ws")] +use crate::io::Filter; +use crate::io::Io; +#[cfg(feature = "ws")] use crate::ws::{error::WsClientError, WsClient, WsConnection}; use crate::{rt::System, service::ServiceFactory}; use crate::{time::Millis, time::Seconds, util::Bytes}; @@ -333,11 +336,13 @@ impl TestServer { response.body().limit(10_485_760).await } + #[cfg(feature = "ws")] /// Connect to a websocket server pub async fn ws(&mut self) -> Result, WsClientError> { self.ws_at("/").await } + #[cfg(feature = "ws")] /// Connect to websocket server at a given path pub async fn ws_at( &mut self, @@ -352,7 +357,7 @@ impl TestServer { .await } - #[cfg(feature = "openssl")] + #[cfg(all(feature = "openssl", feature = "ws"))] /// Connect to a websocket server pub async fn wss( &mut self, @@ -363,7 +368,7 @@ impl TestServer { self.wss_at("/").await } - #[cfg(feature = "openssl")] + #[cfg(all(feature = "openssl", feature = "ws"))] /// Connect to secure websocket server at a given path pub async fn wss_at( &mut self, diff --git a/ntex/src/lib.rs b/ntex/src/lib.rs index c45b3596..07341ad1 100644 --- a/ntex/src/lib.rs +++ b/ntex/src/lib.rs @@ -31,6 +31,8 @@ pub use ntex_service::{forward_poll_ready, forward_poll_shutdown}; pub mod http; pub mod web; + +#[cfg(feature = "ws")] pub mod ws; pub use self::service::{ diff --git a/ntex/src/web/error_default.rs b/ntex/src/web/error_default.rs index 4cbc587e..dfe53783 100644 --- a/ntex/src/web/error_default.rs +++ b/ntex/src/web/error_default.rs @@ -9,6 +9,7 @@ use crate::http::body::Body; use crate::http::helpers::Writer; use crate::http::{self, header, StatusCode}; use crate::util::{timeout::TimeoutError, BytesMut}; +#[cfg(feature = "ws")] use crate::ws::error::HandshakeError; use super::error::{self, ErrorContainer, ErrorRenderer, WebResponseError}; @@ -234,6 +235,7 @@ impl WebResponseError for http::client::error::SendRequestError { } } +#[cfg(feature = "ws")] /// Error renderer for ws::HandshakeError impl WebResponseError for HandshakeError { fn error_response(&self, _: &HttpRequest) -> HttpResponse { diff --git a/ntex/src/web/mod.rs b/ntex/src/web/mod.rs index f438133b..1f885b49 100644 --- a/ntex/src/web/mod.rs +++ b/ntex/src/web/mod.rs @@ -85,6 +85,8 @@ mod service; pub mod test; pub mod types; mod util; + +#[cfg(feature = "ws")] pub mod ws; // re-export proc macro diff --git a/ntex/src/web/test.rs b/ntex/src/web/test.rs index 22d2dd3a..01be0191 100644 --- a/ntex/src/web/test.rs +++ b/ntex/src/web/test.rs @@ -11,14 +11,17 @@ use crate::http::error::{HttpError, PayloadError, ResponseError}; use crate::http::header::{HeaderName, HeaderValue, CONTENT_TYPE}; use crate::http::test::TestRequest as HttpTestRequest; use crate::http::{HttpService, Method, Payload, Request, StatusCode, Uri, Version}; +#[cfg(feature = "ws")] +use crate::io::Sealed; use crate::router::{Path, ResourceDef}; use crate::service::{ map_config, IntoService, IntoServiceFactory, Pipeline, Service, ServiceFactory, }; use crate::time::{sleep, Millis, Seconds}; use crate::util::{stream_recv, Bytes, BytesMut, Extensions, Ready, Stream}; +#[cfg(feature = "ws")] use crate::ws::{error::WsClientError, WsClient, WsConnection}; -use crate::{io::Sealed, rt::System, server::Server}; +use crate::{rt::System, server::Server}; use crate::web::error::{DefaultError, ErrorRenderer}; use crate::web::httprequest::{HttpRequest, HttpRequestPool}; @@ -907,6 +910,7 @@ impl TestServer { response.body().limit(10_485_760).await } + #[cfg(feature = "ws")] /// Connect to websocket server at a given path pub async fn ws_at(&self, path: &str) -> Result, WsClientError> { if self.ssl { @@ -947,6 +951,7 @@ impl TestServer { } } + #[cfg(feature = "ws")] /// Connect to a websocket server pub async fn ws(&self) -> Result, WsClientError> { self.ws_at("/").await