Merge #400: Integrate bitreq crate into CI tests

tcharding · tcharding · commit 81224df8d291 · 2025-11-03T12:32:20.000+11:00
3497da8 Remove bitreq README.md MSRV and test badges (Jamil Lambert, PhD) 9fd5af7 Remove bitreq github workflows (Jamil Lambert, PhD) df90f00 Add bitreq to list of crates to test (Jamil Lambert, PhD) 8f30a45 Add testvars.sh to bitreq (Jamil Lambert, PhD) 921652d Remove std attribute from no-std example (Jamil Lambert, PhD) f97b8c6 Remove trailing whitespaces from no-std example (Jamil Lambert, PhD) cf0e5a5 Replace LazyLock with OnceLock (Jamil Lambert, PhD) de4ece5 Make proxy std only (Jamil Lambert, PhD) Pull request description: `bitreq` was developed as a standalone repo with its own `.github/workflow` directory that had workflows to test and lint it. It's now a leaf crate in `corepc` and test and lint workflows in its own subdirectory are not run. It is not included in CI tests and contains some issues that cause CI tests to fail. Fix the CI errors, integrate into CI and remove redundant workflow files and badges: - Add `std` to the `proxy` feature since it only works with `std`. - Replace `LazyLock` which is only in stable rustc from 1.80. Use `OnceLock` instead which is stable from 1.70. - Remove trailing white spaces from the `no-std` example. - Remove `std` attribute from `no-std.rs`. The example is broken and commented out, but still causes a compile failure in `no-std` since the attribute made the module empty. The example was left in so that it can be fixed and used later rather than just deleting it. - Add `test_vars.sh` to integrate `bitreq` into the CI tests. - Add `bitreq` to the list of crates to test. - Remove the workflow files in the `bitreq` subdirectory, these are no longer run now it is part of the `corepc` workspace and not its own repo. - Remove the broken `README.md` badges. Closes #397 ACKs for top commit: oleonardolima: cACK 3497da8 tcharding: ACK 3497da8 Tree-SHA512: 850a222d9d427393680e9d49c9b61b8c64dc1efd09d85a2e27b2a9b68576f4a8b5fa40cf4e1df640c0e9032b4f1dec21f28692ae96340425e1028943f4ae6637
diff --git a/bitreq/.github/workflows/lint.yml b/bitreq/.github/workflows/lint.yml
diff --git a/bitreq/.github/workflows/msrv.yml b/bitreq/.github/workflows/msrv.yml
diff --git a/bitreq/.github/workflows/unit-tests.yml b/bitreq/.github/workflows/unit-tests.yml
diff --git a/bitreq/Cargo.toml b/bitreq/Cargo.toml
@@ -50,7 +50,7 @@ https = ["https-rustls"]
 https-rustls = ["rustls", "webpki-roots", "rustls-webpki"]
 https-rustls-probe = ["rustls", "rustls-native-certs"]
 json-using-serde = ["serde", "serde_json"]
-proxy = ["base64"]
+proxy = ["base64", "std"]
 async = ["tokio", "std"]
 async-https = ["async", "https-rustls", "tokio-rustls"]
 
diff --git a/bitreq/README.md b/bitreq/README.md
@@ -1,8 +1,6 @@
 # bitreq - forked from minreq
 [![Crates.io](https://img.shields.io/crates/d/bitreq.svg)](https://crates.io/crates/bitreq)
 [![Documentation](https://docs.rs/bitreq/badge.svg)](https://docs.rs/bitreq)
-![Unit tests](https://github.com/tcharding/bitreq/actions/workflows/unit-tests.yml/badge.svg)
-![MSRV](https://github.com/tcharding/bitreq/actions/workflows/msrv.yml/badge.svg)
 
 This crate is a fork for the very nice
 [minreq](https://github.com/neonmoe/minreq). I chose to fork and
diff --git a/bitreq/contrib/test_vars.sh b/bitreq/contrib/test_vars.sh
@@ -0,0 +1,14 @@
+# No shebang, this file should not be executed.
+# shellcheck disable=SC2148
+#
+# disable verify unused vars, despite the fact that they are used when sourced
+# shellcheck disable=SC2034
+
+# Test all these features with "std" enabled.
+FEATURES_WITH_STD="log https https-rustls proxy async async-https"
+
+# Test all these features without "std" enabled.
+FEATURES_WITHOUT_STD="log https https-rustls"
+
+# Run these examples.
+EXAMPLES=""
diff --git a/bitreq/examples/no-std.rs b/bitreq/examples/no-std.rs
@@ -1,7 +1,5 @@
 //! This is a simple example to demonstrate the usage of this library.
 
-#![cfg(feature = "std")]
-
 const _RESPONSE: &str = r#"<!doctype html>
 <html>
 <head>
@@ -16,7 +14,7 @@ const _RESPONSE: &str = r#"<!doctype html>
         margin: 0;
         padding: 0;
         font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
-        
+
     }
     div {
         width: 600px;
@@ -36,7 +34,7 @@ const _RESPONSE: &str = r#"<!doctype html>
             width: auto;
         }
     }
-    </style>    
+    </style>
 </head>
 
 <body>
diff --git a/bitreq/src/connection/rustls_stream.rs b/bitreq/src/connection/rustls_stream.rs
@@ -5,6 +5,7 @@ use alloc::sync::Arc;
 use core::convert::TryFrom;
 use std::io::{self, Write};
 use std::net::TcpStream;
+use std::sync::OnceLock;
 
 use rustls::{self, ClientConfig, ClientConnection, RootCertStore, ServerName, StreamOwned};
 #[cfg(feature = "rustls-webpki")]
@@ -15,8 +16,9 @@ use crate::Error;
 
 pub type SecuredStream = StreamOwned<ClientConnection, TcpStream>;
 
-#[allow(clippy::incompatible_msrv)] // We only guarantee MSRV for a subset of features.
-static CONFIG: std::sync::LazyLock<Arc<ClientConfig>> = std::sync::LazyLock::new(|| {
+static CONFIG: OnceLock<Arc<ClientConfig>> = OnceLock::new();
+
+fn build_client_config() -> Arc<ClientConfig> {
     let mut root_certificates = RootCertStore::empty();
 
     // Try to load native certs
@@ -44,7 +46,7 @@ static CONFIG: std::sync::LazyLock<Arc<ClientConfig>> = std::sync::LazyLock::new
         .with_root_certificates(root_certificates)
         .with_no_client_auth();
     Arc::new(config)
-});
+}
 
 pub fn create_secured_stream(conn: &Connection) -> Result<HttpStream, Error> {
     // Rustls setup
@@ -54,8 +56,8 @@ pub fn create_secured_stream(conn: &Connection) -> Result<HttpStream, Error> {
         Ok(result) => result,
         Err(err) => return Err(Error::IoError(io::Error::new(io::ErrorKind::Other, err))),
     };
-    let sess =
-        ClientConnection::new(CONFIG.clone(), dns_name).map_err(Error::RustlsCreateConnection)?;
+    let sess = ClientConnection::new(CONFIG.get_or_init(build_client_config).clone(), dns_name)
+        .map_err(Error::RustlsCreateConnection)?;
 
     // Connect
     #[cfg(feature = "log")]
diff --git a/contrib/crates.sh b/contrib/crates.sh
@@ -2,4 +2,4 @@
 # shellcheck disable=SC2148
 
 # Crates in this workspace to test.
-CRATES=("types" "client" "jsonrpc")
+CRATES=("bitreq" "client" "jsonrpc" "types")
