open-net 0.3.5

A cross-platform async networking library for Rust with HTTP and WebSocket clients, network status monitoring, configurable retries, WebSocket reconnection and heartbeats, and managed client lifecycles. Reuse common networking infrastructure across applications to avoid repeated implementation and debugging, helping save development time and AI coding tokens.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use super::*;
use crate::module::ws_client::test_support::{check, check_eq, TestResult};
use crate::ws::{AttemptId, ClientId, CycleId, SessionId};
use std::sync::atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering};
use std::time::Duration;

const DEADLINE: Duration = Duration::from_secs(5);

fn attempt() -> crate::Result<HandshakeAttempt> {
    let counter = AtomicU64::new(0);
    Ok(HandshakeAttempt {
        client_id: ClientId::allocate(&counter)?,
        session_id: SessionId::allocate(&counter)?,
        cycle_id: CycleId::allocate(&counter)?,
        attempt_id: AttemptId::allocate(&counter)?,
        metadata: Arc::new(crate::Metadata::from([(
            "META_KEY".to_owned(),
            "META_VALUE".to_owned(),
        )])),
    })
}

#[test]
fn headers_are_owned_and_default_debug_does_not_expose_credentials() -> TestResult {
    let mut headers = http::HeaderMap::new();
    headers.try_insert(http::header::AUTHORIZATION, "Bearer HEADER_SECRET".parse()?)?;
    let mut snapshot = HandshakeHeaders::new(headers);
    check!(snapshot.credential_version.is_none())?;
    snapshot.credential_version = Some("VERSION_SECRET".to_owned());
    let cloned = snapshot.clone();
    drop(snapshot);
    check_eq!(
        cloned
            .headers
            .get(http::header::AUTHORIZATION)
            .ok_or("missing owned header")?
            .to_str()?,
        "Bearer HEADER_SECRET"
    )?;
    let provider =
        HandshakeProvider::new(|_| async { Ok(HandshakeHeaders::new(http::HeaderMap::new())) });
    let blocking =
        HandshakeProvider::blocking(|_| Ok(HandshakeHeaders::new(http::HeaderMap::new())));
    let debug = format!("{cloned:?} {provider:?} {blocking:?}");
    for hidden in ["HEADER_SECRET", "VERSION_SECRET", "authorization"] {
        check!(!debug.contains(hidden))?;
    }
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn async_provider_uses_the_callers_runtime_without_consuming_blocking_quota() -> TestResult {
    let caller = std::thread::current().id();
    let (sent, mut received) = tokio::sync::mpsc::unbounded_channel();
    let provider = HandshakeProvider::new(move |attempt| {
        let sent = sent.clone();
        let constructed = std::thread::current().id();
        async move {
            tokio::task::yield_now().await;
            sent.send((
                constructed,
                std::thread::current().id(),
                tokio::runtime::Handle::try_current().is_ok(),
                attempt.attempt_id,
            ))?;
            Ok(HandshakeHeaders::new(http::HeaderMap::new()))
        }
    });
    let attempt = attempt()?;
    let id = attempt.attempt_id;
    let slots = Arc::new(Semaphore::new(0));
    provider.provide(attempt, slots.clone()).await?;
    let (construction, poll, runtime, observed_id) = received.try_recv()?;
    check_eq!(construction, caller)?;
    check_eq!(poll, caller)?;
    check!(runtime)?;
    check_eq!(observed_id, id)?;
    check_eq!(slots.available_permits(), 0)?;
    Ok(())
}

#[test]
fn blocking_provider_runs_without_a_caller_runtime_on_the_existing_named_thread() -> TestResult {
    let caller = std::thread::current().id();
    let (sent, received) = std::sync::mpsc::channel();
    let provider = HandshakeProvider::blocking(move |_| {
        let thread = std::thread::current();
        sent.send((
            thread.id(),
            thread.name().map(str::to_owned),
            tokio::runtime::Handle::try_current().is_ok(),
        ))?;
        Ok(HandshakeHeaders::new(http::HeaderMap::new()))
    });
    futures::executor::block_on(provider.provide(attempt()?, Arc::new(Semaphore::new(1))))?;
    let (thread, name, runtime) = received.recv_timeout(DEADLINE)?;
    check!(thread != caller)?;
    check_eq!(name.as_deref(), Some("open-net-ws-context-provider"))?;
    check!(!runtime)?;
    Ok(())
}

#[tokio::test]
async fn blocking_quota_rejection_is_immediate_and_does_not_call_user_code() -> TestResult {
    let calls = Arc::new(AtomicUsize::new(0));
    let seen = calls.clone();
    let provider = HandshakeProvider::blocking(move |_| {
        seen.fetch_add(1, Ordering::SeqCst);
        Ok(HandshakeHeaders::new(http::HeaderMap::new()))
    });
    let error = provider
        .provide(attempt()?, Arc::new(Semaphore::new(0)))
        .await
        .err()
        .ok_or("full blocking quota was accepted")?;
    check_eq!(error.kind(), crate::error::ErrorKind::ResourceExhausted)?;
    check_eq!(
        error.context().stage,
        Some(crate::error::ErrorStage::Provider)
    )?;
    check_eq!(calls.load(Ordering::SeqCst), 0)?;
    Ok(())
}

/// Test probe that verifies prompt release of a captured handshake callback by
/// counting its destructions.
struct DropProbe(
    /// Counts how many times the probe has been dropped.
    Arc<AtomicUsize>,
);
impl Drop for DropProbe {
    fn drop(&mut self) {
        self.0.fetch_add(1, Ordering::SeqCst);
    }
}

#[tokio::test(start_paused = true)]
async fn cancellation_and_timeout_drop_async_provider_futures_in_place() -> TestResult {
    for timeout in [false, true] {
        let drops = Arc::new(AtomicUsize::new(0));
        let capture = drops.clone();
        let provider = HandshakeProvider::new(move |_| {
            let probe = DropProbe(capture.clone());
            async move {
                let _probe = probe;
                std::future::pending::<std::result::Result<HandshakeHeaders, crate::BoxError>>()
                    .await
            }
        });
        let mut pending = Box::pin(provider.provide(attempt()?, Arc::new(Semaphore::new(0))));
        check!(futures::poll!(&mut pending).is_pending())?;
        check_eq!(drops.load(Ordering::SeqCst), 0)?;
        if timeout {
            check!(tokio::time::timeout(Duration::from_secs(1), pending)
                .await
                .is_err())?;
        } else {
            drop(pending);
        }
        check_eq!(
            drops.load(Ordering::SeqCst),
            1,
            "cancelled async provider remained detached"
        )?;
    }
    Ok(())
}

#[tokio::test]
async fn application_errors_keep_their_original_source_and_provider_stage() -> TestResult {
    let provider = HandshakeProvider::new(|_| async {
        Err(Box::new(std::io::Error::new(
            std::io::ErrorKind::PermissionDenied,
            "SOURCE_SECRET",
        )) as crate::BoxError)
    });
    let attempt = attempt()?;
    let identity = (attempt.client_id, attempt.session_id, attempt.attempt_id);
    let error = provider
        .provide(attempt, Arc::new(Semaphore::new(0)))
        .await
        .err()
        .ok_or("provider error disappeared")?;
    check_eq!(error.kind(), crate::error::ErrorKind::ProviderFailed)?;
    check_eq!(
        error.context().stage,
        Some(crate::error::ErrorStage::Provider)
    )?;
    check_eq!(error.context().client_id, Some(identity.0))?;
    check_eq!(error.context().session_id, Some(identity.1))?;
    check_eq!(error.context().attempt_id, Some(identity.2))?;
    let source = std::error::Error::source(&error)
        .ok_or("missing application source")?
        .downcast_ref::<std::io::Error>()
        .ok_or("application source type changed")?;
    check_eq!(source.kind(), std::io::ErrorKind::PermissionDenied)?;
    check!(!format!("{error:?} {error}").contains("SOURCE_SECRET"))?;
    Ok(())
}

#[test]
fn sdk_managed_headers_are_rejected_without_echoing_values() -> TestResult {
    for name in [
        "Host",
        "Connection",
        "Upgrade",
        "Sec-WebSocket-Key",
        "Sec-WebSocket-Version",
    ] {
        let mut headers = HeaderMap::new();
        headers.try_insert(
            http::HeaderName::from_bytes(name.as_bytes())?,
            "HEADER_SECRET".parse()?,
        )?;
        let error = validate_headers(&headers)
            .err()
            .ok_or("SDK-managed header accepted")?;
        check_eq!(error.kind(), ErrorKind::InvalidInput)?;
        check_eq!(error.context().stage, Some(ErrorStage::RequestBuild))?;
        check_eq!(
            error.config_error().ok_or("missing field error")?.field(),
            "headers"
        )?;
        check!(!format!("{error:?} {error}").contains("HEADER_SECRET"))?;
    }
    let mut headers = HeaderMap::new();
    headers.try_insert(http::header::AUTHORIZATION, "Bearer allowed".parse()?)?;
    headers.try_insert(http::header::SEC_WEBSOCKET_PROTOCOL, "app-v1".parse()?)?;
    validate_headers(&headers)?;
    check_eq!(headers.len(), 2)?;
    Ok(())
}

#[test]
fn caught_constructor_and_blocking_outcomes_preserve_sources_and_retire_payloads() -> TestResult {
    let drops = Arc::new(AtomicUsize::new(0));
    let error = caught::<ProviderFuture>(Err(Box::new(DropProbe(drops.clone()))))
        .err()
        .ok_or("caught constructor failure returned a future")?;
    check_eq!(error.kind(), ErrorKind::CallbackPanicked)?;
    check_eq!(error.context().stage, Some(ErrorStage::Provider))?;
    let error = resolve_provider_outcome(Err(Box::new(DropProbe(drops.clone()))))
        .err()
        .ok_or("caught blocking failure returned headers")?;
    check_eq!(error.kind(), ErrorKind::CallbackPanicked)?;
    check_eq!(drops.load(Ordering::SeqCst), 2)?;
    let output = resolve_provider_outcome(Ok(Ok(HandshakeHeaders::new(HeaderMap::new()))))?;
    check!(output.headers.is_empty())?;
    let source = std::io::Error::from(std::io::ErrorKind::ConnectionReset);
    let error = resolve_provider_outcome(Ok(Err(Box::new(source))))
        .err()
        .ok_or("application failure was lost")?;
    check_eq!(error.kind(), ErrorKind::ProviderFailed)?;
    check_eq!(error.io_kind(), Some(std::io::ErrorKind::ConnectionReset))?;
    Ok(())
}

#[test]
fn caught_poll_outcome_destroys_the_future_and_payload_once() -> TestResult {
    let future_drops = Arc::new(AtomicUsize::new(0));
    let payload_drops = Arc::new(AtomicUsize::new(0));
    let probe = DropProbe(future_drops.clone());
    let mut future = GuardedFuture::new(Box::pin(async move {
        let _probe = probe;
        std::future::pending::<ProviderOutput>().await
    }));
    let error = match future.complete_poll(Err(Box::new(DropProbe(payload_drops.clone())))) {
        Poll::Ready(Err(error)) => error,
        _ => return Err("caught poll failure was not terminal".into()),
    };
    check_eq!(error.kind(), ErrorKind::CallbackPanicked)?;
    check_eq!(error.context().stage, Some(ErrorStage::Provider))?;
    check_eq!(future_drops.load(Ordering::SeqCst), 1)?;
    check_eq!(payload_drops.load(Ordering::SeqCst), 1)?;
    drop(future);
    check_eq!(future_drops.load(Ordering::SeqCst), 1)?;
    Ok(())
}

#[test]
fn rejected_thread_creation_preserves_os_source_and_releases_unstarted_quota() -> TestResult {
    let calls = Arc::new(AtomicUsize::new(0));
    let seen = calls.clone();
    let provider = HandshakeProvider::blocking(move |_| {
        seen.fetch_add(1, Ordering::SeqCst);
        Ok(HandshakeHeaders::new(HeaderMap::new()))
    });
    let ProviderKind::Blocking(callback) = provider.inner else {
        return Err("blocking constructor returned an async provider".into());
    };
    let slots = Arc::new(Semaphore::new(1));
    let error = futures::executor::block_on(run_blocking_with_spawn(
        callback,
        attempt()?,
        slots.clone(),
        |job| {
            drop(job);
            Err(std::io::Error::new(
                std::io::ErrorKind::PermissionDenied,
                "SPAWN_SECRET",
            ))
        },
    ))
    .err()
    .ok_or("thread creation failure was ignored")?;
    check_eq!(error.kind(), ErrorKind::RuntimeUnavailable)?;
    check_eq!(error.context().stage, Some(ErrorStage::Provider))?;
    check_eq!(error.io_kind(), Some(std::io::ErrorKind::PermissionDenied))?;
    check_eq!(calls.load(Ordering::SeqCst), 0)?;
    check_eq!(slots.available_permits(), 1)?;
    check!(!format!("{error:?} {error}").contains("SPAWN_SECRET"))?;
    Ok(())
}

/// Test probe that reports handshake execution permits on drop to verify the
/// resource-release order.
struct ObservedDrop {
    /// Semaphore used to read the remaining blocking-handshake permits.
    slots: Arc<Semaphore>,
    /// Channel used to report the probe label and currently available permits
    /// to the test thread.
    sent: std::sync::mpsc::Sender<(&'static str, usize)>,
    /// Static label distinguishing the resource under observation.
    label: &'static str,
}
impl std::fmt::Debug for ObservedDrop {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("ObservedDrop")
    }
}
impl std::fmt::Display for ObservedDrop {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("provider source probe")
    }
}
impl std::error::Error for ObservedDrop {}
impl Drop for ObservedDrop {
    fn drop(&mut self) {
        let _ = self.sent.send((self.label, self.slots.available_permits()));
    }
}

#[tokio::test]
async fn cancelled_blocking_calls_hold_quota_through_capture_and_unreceived_source_cleanup(
) -> TestResult {
    for timeout in [false, true] {
        let slots = Arc::new(Semaphore::new(1));
        let (release, wait) = std::sync::mpsc::channel::<()>();
        let wait = std::sync::Mutex::new(wait);
        let (entered, mut entry) = tokio::sync::mpsc::unbounded_channel();
        let (observed, observations) = std::sync::mpsc::channel();
        let capture = ObservedDrop {
            slots: slots.clone(),
            sent: observed.clone(),
            label: "capture",
        };
        let source_slots = slots.clone();
        let provider = HandshakeProvider::blocking(move |_| {
            let _capture = &capture;
            entered.send(())?;
            wait.lock()
                .map_err(|_| std::io::Error::other("test release lock poisoned"))?
                .recv_timeout(DEADLINE)?;
            Err(Box::new(ObservedDrop {
                slots: source_slots.clone(),
                sent: observed.clone(),
                label: "source",
            }) as BoxError)
        });
        let mut pending = Box::pin(provider.provide(attempt()?, slots.clone()));
        check!(futures::poll!(&mut pending).is_pending())?;
        tokio::time::timeout(DEADLINE, entry.recv())
            .await?
            .ok_or("blocking provider never entered")?;
        check_eq!(slots.available_permits(), 0)?;
        if timeout {
            check!(tokio::time::timeout(Duration::from_millis(5), pending)
                .await
                .is_err())?;
        } else {
            drop(pending);
        }
        drop(provider);
        check_eq!(
            slots.available_permits(),
            0,
            "cancelled waiter prematurely released the real closure slot"
        )?;
        check!(observations.try_recv().is_err())?;
        release.send(())?;
        check_eq!(observations.recv_timeout(DEADLINE)?, ("capture", 0))?;
        check_eq!(observations.recv_timeout(DEADLINE)?, ("source", 0))?;
        let permit = tokio::time::timeout(DEADLINE, slots.clone().acquire_owned()).await??;
        drop(permit);
        check_eq!(slots.available_permits(), 1)?;
    }
    Ok(())
}

#[test]
fn engine_retirement_tracks_cancelled_blocking_provider_until_real_exit() -> TestResult {
    use crate::common::retirement::{ExecutionScope, ThreadRegistry};
    let threads = Arc::new(ThreadRegistry::new());
    let (entered, started) = std::sync::mpsc::channel();
    let (release, released) = std::sync::mpsc::channel::<()>();
    let released = std::sync::Mutex::new(released);
    let provider = HandshakeProvider::blocking(move |_| {
        entered.send(ExecutionScope::is_current())?;
        released
            .lock()
            .map_err(|_| std::io::Error::other("test release lock poisoned"))?
            .recv_timeout(DEADLINE)?;
        Ok(HandshakeHeaders::new(HeaderMap::new()))
    });
    let mut pending = Box::pin(provider.provide_with_threads(
        attempt()?,
        Arc::new(Semaphore::new(1)),
        threads.clone(),
    ));
    futures::executor::block_on(async { check!(futures::poll!(&mut pending).is_pending()) })?;
    check!(started.recv_timeout(DEADLINE)?)?;
    drop(pending);
    let (joining, joining_started) = std::sync::mpsc::channel();
    let (done, finished) = std::sync::mpsc::channel();
    let cleanup = std::thread::spawn(move || {
        let _ = joining.send(());
        let _ = done.send(threads.seal_and_join());
    });
    joining_started.recv_timeout(DEADLINE)?;
    check!(matches!(
        finished.recv_timeout(Duration::from_millis(30)),
        Err(std::sync::mpsc::RecvTimeoutError::Timeout)
    ))?;
    release.send(())?;
    check!(finished.recv_timeout(DEADLINE)?.is_ok())?;
    cleanup
        .join()
        .map_err(|_| "provider cleanup thread panicked")?;
    Ok(())
}

#[tokio::test]
async fn async_provider_constructor_poll_and_drop_enter_execution_scope() -> TestResult {
    use crate::common::retirement::ExecutionScope;
    struct ScopedDrop(Arc<AtomicBool>);
    impl Drop for ScopedDrop {
        fn drop(&mut self) {
            self.0.store(ExecutionScope::is_current(), Ordering::SeqCst);
        }
    }
    let dropped = Arc::new(AtomicBool::new(false));
    let dropped_in_provider = dropped.clone();
    let constructed = Arc::new(AtomicBool::new(false));
    let constructed_in_provider = constructed.clone();
    let provider = HandshakeProvider::new(move |_| {
        constructed_in_provider.store(ExecutionScope::is_current(), Ordering::SeqCst);
        let on_drop = ScopedDrop(dropped_in_provider.clone());
        async move {
            let _on_drop = on_drop;
            check!(ExecutionScope::is_current())?;
            std::future::pending::<ProviderOutput>().await
        }
    });
    let mut pending = Box::pin(provider.provide(attempt()?, Arc::new(Semaphore::new(1))));
    check!(futures::poll!(&mut pending).is_pending())?;
    check!(constructed.load(Ordering::SeqCst))?;
    check!(!ExecutionScope::is_current())?;
    drop(pending);
    check!(dropped.load(Ordering::SeqCst))?;
    check!(!ExecutionScope::is_current())?;
    Ok(())
}

#[tokio::test]
async fn credential_version_validation_counts_utf8_bytes_for_both_provider_modes() -> TestResult {
    for blocking in [false, true] {
        for (version, accepted) in [
            ("é".repeat(128), true),
            (format!("{}é", "界".repeat(85)), false),
        ] {
            let expected = version.clone();
            let provider = if blocking {
                HandshakeProvider::blocking(move |_| {
                    Ok(HandshakeHeaders {
                        headers: http::HeaderMap::new(),
                        credential_version: Some(version.clone()),
                    })
                })
            } else {
                HandshakeProvider::new(move |_| {
                    let version = version.clone();
                    async move {
                        Ok(HandshakeHeaders {
                            headers: http::HeaderMap::new(),
                            credential_version: Some(version),
                        })
                    }
                })
            };
            let result = provider
                .provide(attempt()?, Arc::new(Semaphore::new(1)))
                .await;
            if accepted {
                check_eq!(
                    result?.credential_version.as_deref(),
                    Some(expected.as_str())
                )?;
            } else {
                let error = result
                    .err()
                    .ok_or("oversized credential version accepted")?;
                check_eq!(error.kind(), crate::error::ErrorKind::InvalidConfig)?;
                check_eq!(
                    error.context().stage,
                    Some(crate::error::ErrorStage::Provider)
                )?;
                check_eq!(
                    error.config_error().ok_or("missing ConfigError")?.field(),
                    "credential_version"
                )?;
            }
        }
    }
    Ok(())
}