Skip to content

Commit 92794df

Browse files
committed
chore(build): lint raw TcpStream::connect
Signed-off-by: Eric Curtin <[email protected]>
1 parent dbc0517 commit 92794df

44 files changed

Lines changed: 275 additions & 135 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎AGENTS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ ocsf_emit!(event);
168168
`openshell_core::net::set_tcp_nodelay_best_effort` on an accepted or
169169
already-connected stream, or `openshell_core::net::connect_tcp_nodelay_best_effort`
170170
when dialing.
171+
- Clippy rejects raw `TcpStream::connect` (`clippy.toml`). Dial with
172+
`openshell_core::net::connect_tcp_nodelay_best_effort`, or
173+
`connect_std_tcp_nodelay_best_effort` on blocking threads. The lint does not
174+
cover accepted sockets, so keep setting nodelay on those by hand.
171175
- This applies to loopback/localhost TCP too — the delayed-ACK stall is a timer
172176
behavior, not wire latency.
173177
- You should skip it for unix domain sockets (no Nagle). It's not critical for

‎clippy.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
disallowed-methods = [
2+
{ path = "tokio::net::TcpStream::connect", reason = "use openshell_core::net::connect_tcp_nodelay_best_effort so Nagle is disabled on the dialed stream" },
3+
{ path = "std::net::TcpStream::connect", reason = "use openshell_core::net::connect_std_tcp_nodelay_best_effort so Nagle is disabled on the dialed stream" },
4+
]

‎crates/openshell-cli/src/auth.rs‎

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,9 @@ mod tests {
540540
));
541541

542542
// Simulate a browser XHR POST.
543-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
543+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
544+
.await
545+
.unwrap();
544546
let body = r#"{"token":"test-jwt-123","code":"ABC-1234"}"#;
545547
let request = format!(
546548
"POST /callback HTTP/1.1\r\n\
@@ -571,7 +573,9 @@ mod tests {
571573
TEST_GATEWAY.to_string(),
572574
));
573575

574-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
576+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
577+
.await
578+
.unwrap();
575579
let body = r#"{"token":"jwt","code":"ABC-1234"}"#;
576580
let request = format!(
577581
"POST /callback HTTP/1.1\r\n\
@@ -616,7 +620,9 @@ mod tests {
616620
TEST_GATEWAY.to_string(),
617621
));
618622

619-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
623+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
624+
.await
625+
.unwrap();
620626
let body = r#"{"token":"jwt","code":"ABC-1234"}"#;
621627
let request = format!(
622628
"POST /callback HTTP/1.1\r\n\
@@ -663,7 +669,9 @@ mod tests {
663669
));
664670

665671
// POST without Origin header.
666-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
672+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
673+
.await
674+
.unwrap();
667675
let body = r#"{"token":"jwt","code":"ABC-1234"}"#;
668676
let request = format!(
669677
"POST /callback HTTP/1.1\r\n\
@@ -707,7 +715,9 @@ mod tests {
707715
TEST_GATEWAY.to_string(),
708716
));
709717

710-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
718+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
719+
.await
720+
.unwrap();
711721
let body = r#"{"token":"test-jwt","code":"WRONG-CODE"}"#;
712722
let request = format!(
713723
"POST /callback HTTP/1.1\r\n\
@@ -755,7 +765,9 @@ mod tests {
755765
));
756766

757767
// POST with no body.
758-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
768+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
769+
.await
770+
.unwrap();
759771
let request = format!(
760772
"POST /callback HTTP/1.1\r\n\
761773
Host: 127.0.0.1\r\n\
@@ -792,7 +804,9 @@ mod tests {
792804
));
793805

794806
// Send OPTIONS preflight with correct origin.
795-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
807+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
808+
.await
809+
.unwrap();
796810
let preflight = format!(
797811
"OPTIONS /callback HTTP/1.1\r\n\
798812
Host: 127.0.0.1\r\n\
@@ -816,7 +830,9 @@ mod tests {
816830
);
817831

818832
// Now send the actual POST — the server should still be listening.
819-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
833+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
834+
.await
835+
.unwrap();
820836
let body = r#"{"token":"jwt-after-preflight","code":"ABC-1234"}"#;
821837
let request = format!(
822838
"POST /callback HTTP/1.1\r\n\
@@ -847,7 +863,9 @@ mod tests {
847863
TEST_GATEWAY.to_string(),
848864
));
849865

850-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
866+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
867+
.await
868+
.unwrap();
851869
let body = r#"{"token":"fragmented-jwt","code":"ABC-1234"}"#;
852870
let headers = format!(
853871
"POST /callback HTTP/1.1\r\n\
@@ -880,7 +898,9 @@ mod tests {
880898
TEST_GATEWAY.to_string(),
881899
));
882900

883-
let mut stream = tokio::net::TcpStream::connect(addr).await.unwrap();
901+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(addr)
902+
.await
903+
.unwrap();
884904
let request = format!(
885905
"GET /callback?token=jwt&code=ABC-1234 HTTP/1.1\r\n\
886906
Host: 127.0.0.1\r\n\

‎crates/openshell-cli/src/callback.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,13 +236,13 @@ mod tests {
236236
IpAddr::V6("::1".parse::<Ipv6Addr>().expect("v6")),
237237
addr.port(),
238238
);
239-
let stream = tokio::net::TcpStream::connect(v6)
239+
let stream = openshell_core::net::connect_tcp_nodelay_best_effort(v6)
240240
.await
241241
.expect("[::1] callback must be reachable");
242242
drop(stream);
243243

244244
let v4 = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), addr.port());
245-
let refused = tokio::net::TcpStream::connect(v4).await;
245+
let refused = openshell_core::net::connect_tcp_nodelay_best_effort(v4).await;
246246
assert!(refused.is_err(), "IPv4 loopback must not reach a ::1 bind");
247247
})
248248
.await;

‎crates/openshell-cli/src/ssh.rs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ use std::process::{Command, ExitStatus, Stdio};
3434
use std::sync::OnceLock;
3535
use std::time::{Duration, Instant};
3636
use tokio::io::AsyncWriteExt;
37-
use tokio::net::TcpStream;
3837
use tokio::process::{Child, Command as TokioCommand};
3938
use tokio_stream::wrappers::ReceiverStream;
4039
use tonic::Code;
@@ -920,7 +919,7 @@ where
920919
async fn probe_forward_listener(spec: &ForwardSpec) -> std::result::Result<(), String> {
921920
match tokio::time::timeout(
922921
FORWARD_LISTENER_CONNECT_TIMEOUT,
923-
TcpStream::connect((forward_probe_host(spec), spec.port)),
922+
openshell_core::net::connect_tcp_nodelay_best_effort((forward_probe_host(spec), spec.port)),
924923
)
925924
.await
926925
{

‎crates/openshell-cli/tests/sandbox_create_lifecycle_integration.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4117,7 +4117,7 @@ async fn echo_through_local_forward<T>(
41174117
!forward.is_finished(),
41184118
"service forward exited before the local listener opened"
41194119
);
4120-
match tokio::net::TcpStream::connect(("127.0.0.1", port)).await {
4120+
match openshell_core::net::connect_tcp_nodelay_best_effort(("127.0.0.1", port)).await {
41214121
Ok(stream) => break stream,
41224122
Err(err) => {
41234123
assert!(

‎crates/openshell-core/src/net.rs‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
//!
1717
1818
use ipnet::{IpNet, Ipv4Net, Ipv6Net};
19-
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
19+
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
2020
use tokio::net::TcpStream;
2121

2222
/// Check if a hostname is a known cloud metadata hostname that resolves to an
@@ -296,16 +296,35 @@ pub fn set_tcp_nodelay_best_effort(stream: &TcpStream) {
296296
}
297297
}
298298

299-
/// Connect to `addrs`, then enable `TCP_NODELAY` on a best-effort basis, propagating
299+
/// Connect to `addr`, then enable `TCP_NODELAY` on a best-effort basis, propagating
300300
/// any errors from `TcpStream::connect`.
301301
///
302302
/// The returned stream is not *guaranteed* to have `TCP_NODELAY` set.
303-
pub async fn connect_tcp_nodelay_best_effort(addrs: &[SocketAddr]) -> std::io::Result<TcpStream> {
304-
let stream = TcpStream::connect(addrs).await?;
303+
pub async fn connect_tcp_nodelay_best_effort(
304+
addr: impl tokio::net::ToSocketAddrs,
305+
) -> std::io::Result<TcpStream> {
306+
#[allow(clippy::disallowed_methods, reason = "the one sanctioned async dial")]
307+
let stream = TcpStream::connect(addr).await?;
305308
set_tcp_nodelay_best_effort(&stream);
306309
Ok(stream)
307310
}
308311

312+
/// Blocking counterpart of [`connect_tcp_nodelay_best_effort`] for threads that
313+
/// cannot use the async helper, such as a `setns` worker.
314+
pub fn connect_std_tcp_nodelay_best_effort(
315+
addr: impl std::net::ToSocketAddrs,
316+
) -> std::io::Result<std::net::TcpStream> {
317+
#[allow(
318+
clippy::disallowed_methods,
319+
reason = "the one sanctioned blocking dial"
320+
)]
321+
let stream = std::net::TcpStream::connect(addr)?;
322+
if let Err(e) = stream.set_nodelay(true) {
323+
tracing::debug!(error = %e, "failed to set TCP_NODELAY");
324+
}
325+
Ok(stream)
326+
}
327+
309328
#[cfg(test)]
310329
mod tests {
311330
use super::*;
@@ -735,6 +754,7 @@ mod tests {
735754
.await
736755
.expect("bind");
737756
let addr = listener.local_addr().expect("local addr");
757+
#[allow(clippy::disallowed_methods, reason = "needs a stream without nodelay")]
738758
let stream = TcpStream::connect(addr).await.expect("connect");
739759

740760
set_tcp_nodelay_best_effort(&stream);
@@ -748,7 +768,7 @@ mod tests {
748768
.expect("bind");
749769
let addr = listener.local_addr().expect("local addr");
750770

751-
let stream = connect_tcp_nodelay_best_effort(&[addr])
771+
let stream = connect_tcp_nodelay_best_effort(addr)
752772
.await
753773
.expect("connect");
754774
assert!(stream.nodelay().expect("query TCP_NODELAY"));

‎crates/openshell-sandbox-backend/src/runtime.rs‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2699,13 +2699,14 @@ async fn connect_boundary_using_connector(
26992699
authority,
27002700
addresses,
27012701
} => {
2702-
let stream = openshell_core::net::connect_tcp_nodelay_best_effort(addresses)
2703-
.await
2704-
.map_err(|error| {
2705-
BackendError::Unavailable(format!(
2706-
"connect to boundary TLS endpoint {authority}: {error}"
2707-
))
2708-
})?;
2702+
let stream =
2703+
openshell_core::net::connect_tcp_nodelay_best_effort(addresses.as_slice())
2704+
.await
2705+
.map_err(|error| {
2706+
BackendError::Unavailable(format!(
2707+
"connect to boundary TLS endpoint {authority}: {error}"
2708+
))
2709+
})?;
27092710
enable_boundary_tcp_keepalive(&stream);
27102711
Box::new(stream)
27112712
}
@@ -3559,7 +3560,9 @@ mod tests {
35593560
async fn boundary_tcp_connections_enable_keepalive() {
35603561
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
35613562
let address = listener.local_addr().unwrap();
3562-
let connected = tokio::spawn(async move { tokio::net::TcpStream::connect(address).await });
3563+
let connected = tokio::spawn(async move {
3564+
openshell_core::net::connect_tcp_nodelay_best_effort(address).await
3565+
});
35633566
let (_server, _) = listener.accept().await.unwrap();
35643567
let client = connected.await.unwrap().unwrap();
35653568

@@ -4585,7 +4588,9 @@ mod tests {
45854588
let address = listener.local_addr().unwrap();
45864589
let connector = Arc::new(ReverseTestConnector(listener));
45874590
let server = tokio::spawn(async move {
4588-
let stream = tokio::net::TcpStream::connect(address).await.unwrap();
4591+
let stream = openshell_core::net::connect_tcp_nodelay_best_effort(address)
4592+
.await
4593+
.unwrap();
45894594
let stream = tokio_rustls::TlsAcceptor::from(certificate.server_config)
45904595
.accept(stream)
45914596
.await
@@ -4619,7 +4624,9 @@ mod tests {
46194624
let address = listener.local_addr().unwrap();
46204625
let connector = ReverseTestConnector(listener);
46214626
let server = tokio::spawn(async move {
4622-
let stream = tokio::net::TcpStream::connect(address).await.unwrap();
4627+
let stream = openshell_core::net::connect_tcp_nodelay_best_effort(address)
4628+
.await
4629+
.unwrap();
46234630
let _ = tokio_rustls::TlsAcceptor::from(server_certificate.server_config)
46244631
.accept(stream)
46254632
.await;
@@ -4645,7 +4652,7 @@ mod tests {
46454652
let server_name =
46464653
rustls::pki_types::ServerName::try_from(certificate.client_tls.server_name.clone())
46474654
.expect("server name");
4648-
let stream = tokio::net::TcpStream::connect(address)
4655+
let stream = openshell_core::net::connect_tcp_nodelay_best_effort(address)
46494656
.await
46504657
.expect("connect to TLS test server");
46514658

‎crates/openshell-sandbox-backend/src/runtime/test_support.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@ impl super::BoundaryTransportConnector for Connector {
680680
_: &w::SandboxRuntimeDescriptor,
681681
) -> Result<BoundaryDuplexStream, BackendError> {
682682
Ok(Box::new(
683-
openshell_core::net::connect_tcp_nodelay_best_effort(&[self.address])
683+
openshell_core::net::connect_tcp_nodelay_best_effort(self.address)
684684
.await
685685
.map_err(|e| BackendError::Unavailable(e.to_string()))?,
686686
))

‎crates/openshell-sandbox-backend/src/runtime_routed.rs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ mod tests {
590590
route: &str,
591591
identity: &SandboxTlsMaterial,
592592
) -> std::io::Result<tokio_rustls::server::TlsStream<tokio::net::TcpStream>> {
593-
let mut stream = tokio::net::TcpStream::connect(router).await?;
593+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(router).await?;
594594
stream
595595
.write_all(&encode_route_preface(route).unwrap())
596596
.await?;
@@ -599,7 +599,9 @@ mod tests {
599599

600600
/// A redirect-aware runtime: negotiate `route` with the router.
601601
async fn negotiate(router: SocketAddr, route: &str) -> (tokio::net::TcpStream, RouteReply) {
602-
let mut stream = tokio::net::TcpStream::connect(router).await.unwrap();
602+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(router)
603+
.await
604+
.unwrap();
603605
let reply = negotiate_route(&mut stream, route).await.unwrap();
604606
(stream, reply)
605607
}
@@ -756,7 +758,9 @@ mod tests {
756758
);
757759

758760
// A version 1 runtime cannot follow a redirect and gets no reply.
759-
let mut stream = tokio::net::TcpStream::connect(address).await.unwrap();
761+
let mut stream = openshell_core::net::connect_tcp_nodelay_best_effort(address)
762+
.await
763+
.unwrap();
760764
stream
761765
.write_all(&encode_route_preface(&elsewhere).unwrap())
762766
.await

0 commit comments

Comments
 (0)