feat: Add native-tls feature (#119)

keelerm84 · web-flow · commit 523aff7b890d · 2026-02-19T13:55:45.000-05:00
diff --git a/.github/actions/build-docs/action.yml b/.github/actions/build-docs/action.yml
diff --git a/.github/actions/ci/action.yml b/.github/actions/ci/action.yml
@@ -1,11 +1,11 @@
 name: CI Workflow
-description: 'Shared CI workflow.'
+description: "Shared CI workflow."
 
 inputs:
-  feature-flags:
-    description: 'Cargo feature flags to pass to test and clippy commands'
+  cargo-flags:
+    description: "Flags to pass to cargo commands."
     required: false
-    default: ''
+    default: ""
 
 runs:
   using: composite
@@ -16,24 +16,24 @@ runs:
 
     - name: Run tests
       shell: bash
-      run: cargo test ${{ inputs.feature-flags }} -p eventsource-client
+      run: cargo test ${{ inputs.cargo-flags }} -p eventsource-client
 
     - name: Run slower integration tests
       shell: bash
-      run: cargo test ${{ inputs.feature-flags }} -p eventsource-client --lib -- --ignored
+      run: cargo test ${{ inputs.cargo-flags }} -p eventsource-client --lib -- --ignored
 
     - name: Run clippy checks
       shell: bash
-      run: cargo clippy ${{ inputs.feature-flags }} -p eventsource-client -- -D warnings
+      run: cargo clippy ${{ inputs.cargo-flags }} -p eventsource-client -- -D warnings
 
     - name: Build contract tests
       shell: bash
-      run: make build-contract-tests
+      run: CARGO_FLAGS="${{ inputs.cargo-flags }}" make build-contract-tests
 
     - name: Start contract test service
       shell: bash
-      run: make start-contract-test-service-bg
+      run: CARGO_FLAGS="${{ inputs.cargo-flags }}" make start-contract-test-service-bg
 
     - name: Run contract tests
       shell: bash
-      run: make run-contract-tests
+      run: CARGO_FLAGS="${{ inputs.cargo-flags }}" make run-contract-tests
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,13 +21,13 @@ jobs:
       matrix:
         features:
           - name: "default"
-            flags: ""
-          - name: "no-features"
-            flags: "--no-default-features"
-          - name: "hyper"
-            flags: "--no-default-features --features hyper"
-          - name: "hyper-rustls"
-            flags: "--no-default-features --features hyper-rustls"
+            cargo-flags: ""
+          - name: "hyper-rustls-native-roots"
+            cargo-flags: "--no-default-features --features hyper-rustls-native-roots"
+          - name: "hyper-rustls-webpki-roots"
+            cargo-flags: "--no-default-features --features hyper-rustls-webpki-roots"
+          - name: "native-tls"
+            cargo-flags: "--no-default-features --features native-tls"
 
     name: CI (${{ matrix.features.name }})
 
@@ -47,7 +47,7 @@ jobs:
 
       - uses: ./.github/actions/ci
         with:
-          feature-flags: ${{ matrix.features.flags }}
+          cargo-flags: ${{ matrix.features.cargo-flags }}
 
   build-docs:
     runs-on: ubuntu-latest
@@ -58,12 +58,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Get Rust version
-        id: rust-version
-        run: cat ./.github/variables/rust-versions.env >> $GITHUB_OUTPUT
-
       - name: Setup rust tooling
-        run: |
-          rustup override set ${{ steps.rust-version.outputs.target }}
+        run: rustup override set nightly
+
+      - name: Install cargo-docs-rs
+        run: cargo install cargo-docs-rs
 
-      - uses: ./.github/actions/build-docs
+      - name: Build documentation
+        run: cargo docs-rs -p eventsource-client
diff --git a/.github/workflows/manual-publish.yml b/.github/workflows/manual-publish.yml
@@ -27,7 +27,6 @@ jobs:
           rustup component add rustfmt clippy
 
       - uses: ./.github/actions/ci
-      - uses: ./.github/actions/build-docs
 
       - uses: launchdarkly/gh-actions/actions/release-secrets@release-secrets-v1.2.0
         name: "Get crates.io token"
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -43,9 +43,6 @@ jobs:
       - uses: ./.github/actions/ci
         if: ${{ steps.release.outputs['eventsource-client--release_created'] == 'true' }}
 
-      - uses: ./.github/actions/build-docs
-        if: ${{ steps.release.outputs['eventsource-client--release_created'] == 'true' }}
-
       - uses: ./.github/actions/publish
         if: ${{ steps.release.outputs['eventsource-client--release_created'] == 'true' }}
         with:
diff --git a/Makefile b/Makefile
@@ -1,14 +1,15 @@
 TEMP_TEST_OUTPUT=/tmp/contract-test-service.log
+CARGO_FLAGS ?= ""
 
 build-contract-tests:
-	@cargo build
+	@cargo build $(CARGO_FLAGS)
 
 start-contract-test-service: build-contract-tests
 	@./target/debug/sse-test-api
 
 start-contract-test-service-bg:
 	@echo "Test service output will be captured in $(TEMP_TEST_OUTPUT)"
-	@make start-contract-test-service >$(TEMP_TEST_OUTPUT) 2>&1 &
+	@$(MAKE) start-contract-test-service >$(TEMP_TEST_OUTPUT) 2>&1 &
 
 run-contract-tests:
 	@curl -s https://raw.githubusercontent.com/launchdarkly/sse-contract-tests/main/downloader/run.sh \
diff --git a/contract-tests/Cargo.toml b/contract-tests/Cargo.toml
@@ -7,7 +7,7 @@ license = "Apache-2.0"
 [dependencies]
 futures = { version = "0.3.21" }
 serde = { version = "1.0", features = ["derive"] }
-eventsource-client = { path = "../eventsource-client", features = ["hyper-rustls"] }
+eventsource-client = { path = "../eventsource-client" }
 serde_json = { version = "1.0.39"}
 actix = { version = "0.13.1"}
 actix-web = { version = "4"}
@@ -18,7 +18,14 @@ log = "0.4.6"
 http = "1.0"
 bytes = "1.5"
 
-launchdarkly-sdk-transport = { git = "https://github.com/launchdarkly/rust-sdk-transport.git", branch = "main" }
+launchdarkly-sdk-transport = { version = "0.1.0" }
 
 [[bin]]
 name = "sse-test-api"
+
+[features]
+default = ["hyper"]
+hyper = ["eventsource-client/hyper", "launchdarkly-sdk-transport/hyper"]
+native-tls = ["hyper", "eventsource-client/native-tls"]
+hyper-rustls-native-roots = ["hyper", "eventsource-client/hyper-rustls-native-roots"]
+hyper-rustls-webpki-roots = ["hyper", "eventsource-client/hyper-rustls-webpki-roots"]
diff --git a/contract-tests/src/bin/sse-test-api/stream_entity.rs b/contract-tests/src/bin/sse-test-api/stream_entity.rs
@@ -131,9 +131,22 @@ impl Inner {
             transport_builder = transport_builder.read_timeout(Duration::from_millis(timeout_ms));
         }
 
+        #[cfg(any(
+            feature = "hyper-rustls-native-roots",
+            feature = "hyper-rustls-webpki-roots",
+            feature = "native-tls"
+        ))]
         let transport = transport_builder
             .build_https()
             .map_err(|e| format!("Failed to build HTTPS transport: {e:?}"))?;
+        #[cfg(not(any(
+            feature = "hyper-rustls-native-roots",
+            feature = "hyper-rustls-webpki-roots",
+            feature = "native-tls"
+        )))]
+        let transport = transport_builder
+            .build_http()
+            .map_err(|e| format!("Failed to build HTTP transport: {e:?}"))?;
 
         Ok(Box::new(
             client_builder
diff --git a/eventsource-client/Cargo.toml b/eventsource-client/Cargo.toml
@@ -20,7 +20,7 @@ tokio = { version = "1.17.0", features = ["time"] }
 rand = "0.8.5"
 base64 = "0.22.1"
 
-launchdarkly-sdk-transport = { git = "https://github.com/launchdarkly/rust-sdk-transport.git", branch = "main" }
+launchdarkly-sdk-transport = { version = "0.1.0" }
 
 [dev-dependencies]
 env_logger = "0.10.0"
@@ -38,4 +38,6 @@ required-features = ["hyper"]
 [features]
 default = ["hyper"]
 hyper = ["launchdarkly-sdk-transport/hyper"]
-hyper-rustls = ["hyper", "launchdarkly-sdk-transport/hyper-rustls"]
+native-tls = ["hyper", "launchdarkly-sdk-transport/native-tls"]
+hyper-rustls-native-roots = ["hyper", "launchdarkly-sdk-transport/hyper-rustls-native-roots"]
+hyper-rustls-webpki-roots = ["hyper", "launchdarkly-sdk-transport/hyper-rustls-webpki-roots"]
diff --git a/eventsource-client/README.md b/eventsource-client/README.md
@@ -9,31 +9,26 @@ This library provides a complete SSE protocol implementation with a built-in HTT
 [Server-Sent Events]: https://html.spec.whatwg.org/multipage/server-sent-events.html
 [EventSource]: https://developer.mozilla.org/en-US/docs/Web/API/EventSource
 
-## Requirements
-
-* Tokio async runtime
-* Enable the `hyper` feature for the built-in HTTP transport (enabled by default)
-* Optionally enable `hyper-rustls` for HTTPS support
-
 ## Quick Start
 
 ### 1. Add dependencies
 
 ```toml
 [dependencies]
-eventsource-client = { version = "0.17", features = ["hyper", "hyper-rustls"] }
+eventsource-client = { version = "0.17", features = ["hyper-rustls-native-roots"] }
 futures = "0.3"
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
 ```
 
 **Features:**
 - `hyper` - Enables the built-in `HyperTransport` for HTTP support (enabled by default)
-- `hyper-rustls` - Adds HTTPS support via rustls (optional)
+- `hyper-rustls-native-roots`, `hyper-rustls-webpki-roots`, or `native-tls` - Adds HTTPS support via rustls (optional)
 
 ### 2. Use the client
 
 ```rust
-use eventsource_client::{ClientBuilder, HyperTransport, SSE};
+use eventsource_client::{ClientBuilder, SSE};
+use launchdarkly_sdk_transport::HyperTransport;
 use futures::TryStreamExt;
 use std::time::Duration;
 
@@ -71,28 +66,30 @@ The `tail` example demonstrates a complete SSE client using the built-in `HyperT
 
 **Run with HTTP:**
 ```bash
-cargo run --example tail --features hyper -- http://sse.dev/test "Bearer token"
+cargo run --example tail --features hyper -- http://live-test-scores.herokuapp.com/scores "Bearer token"
 ```
 
 **Run with HTTPS:**
 ```bash
-cargo run --example tail --features hyper,hyper-rustls -- https://sse.dev/test "Bearer token"
+cargo run --example tail --features hyper-rustls-native-roots -- https://live-test-scores.herokuapp.com/scores "Bearer token"
+cargo run --example tail --features hyper-rustls-webpki-roots -- https://live-test-scores.herokuapp.com/scores "Bearer token"
+cargo run --example tail --features native-tls -- https://live-test-scores.herokuapp.com/scores "Bearer token"
 ```
 
 The example shows:
 - Creating a `HyperTransport` with custom timeouts
 - Building an SSE client with authentication headers
 - Configuring automatic reconnection with exponential backoff
 - Handling different SSE event types (events, comments, connection status)
-- Proper error handling for HTTPS URLs without the `hyper-rustls` feature
+- Proper error handling for HTTPS URLs without the `hyper-rustls-native-roots` feature
 
 See [`examples/tail.rs`](https://github.com/launchdarkly/rust-eventsource-client/tree/main/eventsource-client/examples/tail.rs) for the complete implementation.
 
 ## Features
 
 * **Built-in HTTP transport** - Production-ready `HyperTransport` powered by hyper v1
 * **Configurable timeouts** - Connect, read, and write timeout support
-* **HTTPS support** - Optional rustls integration via the `hyper-rustls` feature
+* **HTTPS support** - Optional rustls integration via the `hyper-rustls-*` or `native-tls` features
 * **Pluggable transport** - Use a custom HTTP client if needed (reqwest, etc.)
 * **Tokio-based streaming** - Efficient async/await support
 * **Custom headers** - Full control over HTTP requests
@@ -106,20 +103,16 @@ See [`examples/tail.rs`](https://github.com/launchdarkly/rust-eventsource-client
 While the built-in `HyperTransport` works for most use cases, you can implement the `HttpTransport` trait to use your own HTTP client:
 
 ```rust
-use eventsource_client::{HttpTransport, ByteStream, TransportError};
-use std::pin::Pin;
-use std::future::Future;
+use launchdarkly_sdk_transport::{HttpTransport, Request, ResponseFuture};
+use bytes::Bytes;
 
 #[derive(Clone)]
 struct MyTransport {
     // Your HTTP client here
 }
 
 impl HttpTransport for MyTransport {
-    fn request(
-        &self,
-        request: http::Request<Option<String>>,
-    ) -> Pin<Box<dyn Future<Output = Result<http::Response<ByteStream>, TransportError>> + Send + Sync + 'static>> {
+    fn request(&self, request: Request<Option<Bytes>>) -> ResponseFuture {
         // Implement HTTP request handling
         // See the HttpTransport trait documentation for details
         todo!()
diff --git a/eventsource-client/examples/tail.rs b/eventsource-client/examples/tail.rs
@@ -4,12 +4,14 @@
 //!
 //! To run this example with HTTP support:
 //! ```bash
-//! cargo run --example tail --features hyper -- http://example.com/events "Bearer token"
+//! cargo run --example tail --features hyper -- http://live-test-scores.herokuapp.com/scores "Bearer token"
 //! ```
 //!
 //! To run this example with HTTPS support:
 //! ```bash
-//! cargo run --example tail --features hyper,hyper-rustls -- https://example.com/events "Bearer token"
+//! cargo run --example tail --features hyper-rustls-native-roots -- https://live-test-scores.herokuapp.com/scores "Bearer token"
+//! cargo run --example tail --features hyper-rustls-webpki-roots -- https://live-test-scores.herokuapp.com/scores "Bearer token"
+//! cargo run --example tail --features native-tls -- https://live-test-scores.herokuapp.com/scores "Bearer token"
 //! ```
 
 use futures::{Stream, TryStreamExt};
@@ -27,7 +29,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     if args.len() != 3 {
         eprintln!("Please pass args: <url> <auth_hdr>");
-        eprintln!("Example: cargo run --example tail --features hyper https://sse.dev/test 'Bearer token'");
+        eprintln!("Example: cargo run --example tail --features hyper https://live-test-scores.herokuapp.com/scores 'Bearer token'");
         process::exit(1);
     }
 
@@ -36,15 +38,23 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     // Run the appropriate version based on URL scheme and features
     if url.starts_with("https://") {
-        #[cfg(feature = "hyper-rustls")]
+        #[cfg(any(
+            feature = "hyper-rustls-native-roots",
+            feature = "hyper-rustls-webpki-roots",
+            feature = "native-tls"
+        ))]
         {
             run_with_https(url, auth_header).await?;
         }
-        #[cfg(not(feature = "hyper-rustls"))]
+        #[cfg(not(any(
+            feature = "hyper-rustls-native-roots",
+            feature = "hyper-rustls-webpki-roots",
+            feature = "native-tls"
+        )))]
         {
-            eprintln!("Error: HTTPS URL requires the 'hyper-rustls' feature");
+            eprintln!("Error: HTTPS URL requires the 'hyper-rustls-native-roots', 'hyper-rustls-webpki-roots', or 'native-tls' features");
             eprintln!(
-                "Run with: cargo run --example tail --features hyper,hyper-rustls -- {} '{}'",
+                "Run with: cargo run --example tail --features hyper-rustls-native-roots -- {} '{}'",
                 url, auth_header
             );
             process::exit(1);
@@ -81,7 +91,11 @@ async fn run_with_http(url: &str, auth_header: &str) -> Result<(), Box<dyn std::
     Ok(())
 }
 
-#[cfg(feature = "hyper-rustls")]
+#[cfg(any(
+    feature = "hyper-rustls-native-roots",
+    feature = "hyper-rustls-webpki-roots",
+    feature = "native-tls"
+))]
 async fn run_with_https(url: &str, auth_header: &str) -> Result<(), Box<dyn std::error::Error>> {
     let transport = HyperTransport::builder()
         .connect_timeout(Duration::from_secs(10))
diff --git a/eventsource-client/src/client.rs b/eventsource-client/src/client.rs
@@ -154,7 +154,7 @@ impl ClientBuilder {
     /// use eventsource_client::ClientBuilder;
     ///
     /// let transport = MyTransport::new();
-    /// let client = ClientBuilder::for_url("https://sse.dev/test")
+    /// let client = ClientBuilder::for_url("https://live-test-scores.herokuapp.com/scores")
     ///     .expect("failed to create client builder")
     ///     .build_with_transport(transport);
     /// ```
