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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
use super::http_client_inner::{HttpClientInner, SendJob};
use crate::api::http::{
    HttpClientConfig, HttpRequestMethod, HttpRequestOptions, HttpRequestTrait, HttpResponseResult,
    HttpRetryPolicy, RetryOn,
};
use crate::api::retry::{Backoff, RetryEvent, RetrySchedule, RetrySetting};
use crate::error::{ErrorKind, NetError};
use async_trait::async_trait;
use bytes::Bytes;
use http::Method;
use reqwest::StatusCode;
use std::io::{Read, Write};
use std::net::{TcpListener, TcpStream};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{mpsc, Arc, Mutex};
use std::thread;
use std::time::Duration;
use tokio::time::Instant;

fn failure(message: &str) -> NetError {
    NetError::with_source(ErrorKind::Internal, std::io::Error::other(message))
}

fn start_server<F>(
    expected: usize,
    handler: F,
) -> Result<(String, thread::JoinHandle<()>), NetError>
where
    F: Fn(TcpStream, usize) + Send + 'static,
{
    let listener = TcpListener::bind(("127.0.0.1", 0)).map_err(NetError::from)?;
    let address = listener.local_addr().map_err(NetError::from)?;
    let thread = thread::Builder::new()
        .name("http-worker-test-server".to_owned())
        .spawn(move || {
            for (index, stream) in listener.incoming().take(expected).enumerate() {
                match stream {
                    Ok(stream) => handler(stream, index),
                    Err(_) => break,
                }
            }
        })
        .map_err(NetError::from)?;
    Ok((format!("http://{address}/test"), thread))
}

fn respond(mut stream: TcpStream, status: &str, body: &str) {
    let mut request = [0_u8; 1024];
    let _ = stream.read(&mut request);
    write_response(stream, status, body);
}

fn write_response(mut stream: TcpStream, status: &str, body: &str) {
    let response = format!(
        "HTTP/1.1 {status}\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{body}",
        body.len()
    );
    let _ = stream.write_all(response.as_bytes());
}

fn read_request_body(stream: &mut TcpStream) -> Vec<u8> {
    let mut request = Vec::new();
    let mut chunk = [0_u8; 1024];
    let header_end = loop {
        let read = match stream.read(&mut chunk) {
            Ok(read) => read,
            Err(_) => return Vec::new(),
        };
        if read == 0 {
            return Vec::new();
        }
        request.extend_from_slice(&chunk[..read]);
        if let Some(index) = request.windows(4).position(|window| window == b"\r\n\r\n") {
            break index + 4;
        }
    };
    let content_length = request[..header_end]
        .split(|byte| *byte == b'\n')
        .find_map(|line| {
            let line = match line.strip_suffix(b"\r") {
                Some(stripped) => stripped,
                None => line,
            };
            let separator = line.iter().position(|byte| *byte == b':')?;
            let name = line.get(..separator)?;
            let value = line.get(separator.saturating_add(1)..)?;
            if !name.eq_ignore_ascii_case(b"content-length") {
                return None;
            }
            std::str::from_utf8(value)
                .ok()
                .map(str::trim)
                .and_then(|value| value.parse::<usize>().ok())
        })
        .map_or(0, |value| value);
    let mut body = request
        .get(header_end..)
        .map_or_else(Vec::new, ToOwned::to_owned);
    while body.len() < content_length {
        let read = match stream.read(&mut chunk) {
            Ok(read) => read,
            Err(_) => break,
        };
        if read == 0 {
            break;
        }
        body.extend_from_slice(&chunk[..read]);
    }
    body.truncate(content_length);
    body
}

struct CallbackRequest {
    callback: mpsc::Sender<(thread::ThreadId, bool, HttpResponseResult)>,
}

struct BodyCountingRequest {
    calls: Arc<AtomicUsize>,
    callback: mpsc::Sender<HttpResponseResult>,
    method: Method,
}

#[async_trait]
impl HttpRequestTrait for BodyCountingRequest {
    fn get_path(&self) -> String {
        "/test".to_owned()
    }

    fn get_method(&self) -> HttpRequestMethod {
        self.method.clone().into()
    }

    fn get_req_body(&self) -> Bytes {
        self.calls.fetch_add(1, Ordering::SeqCst);
        Bytes::from_static(b"replayable")
    }

    async fn deal_with_response(self: Box<Self>, result: HttpResponseResult) {
        let _ = self.callback.send(result);
    }
}

#[async_trait]
impl HttpRequestTrait for CallbackRequest {
    fn get_path(&self) -> String {
        "/test".to_owned()
    }

    fn get_method(&self) -> HttpRequestMethod {
        HttpRequestMethod::GET
    }

    async fn deal_with_response(self: Box<Self>, result: HttpResponseResult) {
        let _ = self.callback.send((
            thread::current().id(),
            tokio::runtime::Handle::try_current().is_ok(),
            result,
        ));
    }
}

#[tokio::test]
async fn callback_runs_on_dedicated_runtime_thread() -> Result<(), NetError> {
    let (url, server) = start_server(1, |stream, _| respond(stream, "200 OK", "ok"))?;
    let config = HttpClientConfig::new(url)?;
    let worker = HttpClientInner::new("http-worker-test".to_owned(), config)?;
    let caller_thread = thread::current().id();
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(CallbackRequest {
            callback: callback_tx,
        }),
        options: HttpRequestOptions::default(),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();
    let (callback_thread, has_runtime, result) = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("callback timeout"))?;
    if callback_thread == caller_thread || !has_runtime {
        return Err(failure("callback did not run on its runtime thread"));
    }
    let response = match result {
        Ok(response) => response,
        Err(error) => return Err(error),
    };
    if response.status != StatusCode::OK || response.body.as_ref() != b"ok" {
        return Err(failure("unexpected HTTP response"));
    }
    worker.shutdown_and_join().await?;
    server
        .join()
        .map_err(|_| failure("test server thread failed"))?;
    Ok(())
}

#[tokio::test]
async fn retry_budget_delivers_only_the_final_response() -> Result<(), NetError> {
    let counter = Arc::new(AtomicUsize::new(0));
    let server_counter = Arc::clone(&counter);
    let (url, server) = start_server(3, move |stream, _| {
        let index = server_counter.fetch_add(1, Ordering::SeqCst);
        if index < 2 {
            respond(stream, "503 Service Unavailable", "retry");
        } else {
            respond(stream, "200 OK", "success");
        }
    })?;
    let worker = HttpClientInner::new("http-worker-retry".to_owned(), HttpClientConfig::new(url)?)?;
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(CallbackRequest {
            callback: callback_tx,
        }),
        options: HttpRequestOptions::default().with_retry_setting(RetrySetting::Policy(
            HttpRetryPolicy::builder()
                .schedule(RetrySchedule::builder().max_attempts(3).build()?)
                .retry_on(RetryOn::standard())
                .build()?,
        )),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();
    let (_, _, result) = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("retry callback timeout"))?;
    let response = match result {
        Ok(response) => response,
        Err(error) => return Err(error),
    };
    if response.status != StatusCode::OK || response.attempts != 3 {
        return Err(failure("retry result was not the final attempt"));
    }
    if callback_rx.try_recv().is_ok() {
        return Err(failure("callback was invoked more than once"));
    }
    worker.shutdown_and_join().await?;
    server
        .join()
        .map_err(|_| failure("test server thread failed"))?;
    Ok(())
}

#[tokio::test]
async fn retry_keeps_admission_permit_until_terminal_callback() -> Result<(), NetError> {
    let responses = Arc::new(AtomicUsize::new(0));
    let server_responses = Arc::clone(&responses);
    let (url, server) = start_server(2, move |stream, _| {
        let index = server_responses.fetch_add(1, Ordering::SeqCst);
        if index == 0 {
            respond(stream, "503 Service Unavailable", "retry");
        } else {
            respond(stream, "200 OK", "done");
        }
    })?;
    let config = HttpClientConfig::new(url)?.with_request_queue_capacity(1)?;
    let worker = HttpClientInner::new("http-worker-quota".to_owned(), config)?;
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    let policy = HttpRetryPolicy::builder()
        .schedule(
            RetrySchedule::builder()
                .max_attempts(2)
                .backoff(Backoff::constant(Duration::from_millis(200)))
                .build()?,
        )
        .retry_on(RetryOn::standard())
        .build()
        .map_err(|_| failure("quota policy was rejected"))?;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(CallbackRequest {
            callback: callback_tx,
        }),
        options: HttpRequestOptions::default().with_retry_setting(RetrySetting::Policy(policy)),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();

    let admission_error = match worker.try_acquire_permit() {
        Ok(permit) => {
            drop(permit);
            return Err(failure("retry released the admission permit early"));
        }
        Err(error) => error,
    };
    if admission_error.kind() != ErrorKind::QueueFull {
        return Err(failure("quota exhaustion returned the wrong error"));
    }

    let (_, _, result) = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("quota retry callback timeout"))?;
    let response = match result {
        Ok(response) => response,
        Err(error) => return Err(error),
    };
    if response.status != StatusCode::OK || response.attempts != 2 {
        return Err(failure("quota retry did not reach its terminal response"));
    }

    let release_deadline = Instant::now() + Duration::from_secs(2);
    loop {
        match worker.try_acquire_permit() {
            Ok(permit) => {
                drop(permit);
                break;
            }
            Err(error) if error.kind() == ErrorKind::QueueFull => {
                if Instant::now() >= release_deadline {
                    return Err(failure("terminal callback did not release quota"));
                }
                thread::sleep(Duration::from_millis(10));
            }
            Err(error) => return Err(error),
        }
    }
    worker.shutdown_and_join().await?;
    server
        .join()
        .map_err(|_| failure("quota server thread failed"))?;
    Ok(())
}

#[tokio::test]
async fn request_body_provider_is_materialized_once_per_attempt() -> Result<(), NetError> {
    let calls = Arc::new(AtomicUsize::new(0));
    let bodies = Arc::new(Mutex::new(Vec::<Vec<u8>>::new()));
    let server_counter = Arc::new(AtomicUsize::new(0));
    let server_counter_for_thread = Arc::clone(&server_counter);
    let bodies_for_server = Arc::clone(&bodies);
    let (url, server) = start_server(2, move |mut stream, _| {
        let request_body = read_request_body(&mut stream);
        if let Ok(mut stored) = bodies_for_server.lock() {
            stored.push(request_body);
        }
        let index = server_counter_for_thread.fetch_add(1, Ordering::SeqCst);
        if index == 0 {
            write_response(stream, "503 Service Unavailable", "retry");
        } else {
            write_response(stream, "200 OK", "success");
        }
    })?;
    let worker = HttpClientInner::new(
        "http-worker-body-provider".to_owned(),
        HttpClientConfig::new(url)?,
    )?;
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(BodyCountingRequest {
            calls: Arc::clone(&calls),
            callback: callback_tx,
            method: Method::POST,
        }),
        options: HttpRequestOptions::default().with_retry_setting(RetrySetting::Policy(
            HttpRetryPolicy::builder()
                .schedule(RetrySchedule::builder().max_attempts(2).build()?)
                .retry_on(RetryOn::standard())
                .safety(crate::api::http::RequestSafety::IdempotentByContract)
                .build()?,
        )),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();
    let result = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("body provider callback timeout"))?;
    let response = match result {
        Ok(response) => response,
        Err(error) => return Err(error),
    };
    if response.status != StatusCode::OK || response.attempts != 2 {
        return Err(failure("body provider retry did not complete"));
    }
    if calls.load(Ordering::SeqCst) != 2 {
        return Err(failure("body provider was not called once per attempt"));
    }
    let captured = bodies
        .lock()
        .map_err(|_| failure("request body capture lock was poisoned"))?;
    if captured.len() != 2
        || captured[0] != b"replayable"
        || captured[1] != b"replayable"
        || captured[0] != captured[1]
    {
        return Err(failure("request body bytes changed between attempts"));
    }
    worker.shutdown_and_join().await?;
    server
        .join()
        .map_err(|_| failure("body provider server thread failed"))?;
    Ok(())
}

#[tokio::test]
async fn non_replayable_body_stops_before_a_second_send() -> Result<(), NetError> {
    let calls = Arc::new(AtomicUsize::new(0));
    let (url, server) = start_server(1, |stream, _| {
        respond(stream, "503 Service Unavailable", "retry")
    })?;
    let worker = HttpClientInner::new(
        "http-worker-one-shot-body".to_owned(),
        HttpClientConfig::new(url)?,
    )?;
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(BodyCountingRequest {
            calls: Arc::clone(&calls),
            callback: callback_tx,
            method: Method::GET,
        }),
        options: HttpRequestOptions::default()
            .with_retry_setting(RetrySetting::Policy(
                HttpRetryPolicy::builder()
                    .schedule(RetrySchedule::builder().max_attempts(2).build()?)
                    .retry_on(RetryOn::standard())
                    .safety(crate::api::http::RequestSafety::IdempotentByContract)
                    .build()?,
            ))
            .with_replayable_body(false),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();
    let result = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("one-shot body callback timeout"))?;
    let response = result?;
    if response.status != StatusCode::SERVICE_UNAVAILABLE
        || response.retry_report().is_none_or(|report| {
            report.stop_reason != Some(crate::api::retry::RetryStopReason::UnsafeToReplay)
        })
    {
        return Err(failure(
            "one-shot body must retain its final response and safety stop report",
        ));
    }
    if calls.load(Ordering::SeqCst) != 1 {
        return Err(failure("one-shot body provider was called more than once"));
    }
    worker.shutdown_and_join().await?;
    server
        .join()
        .map_err(|_| failure("one-shot body server thread failed"))?;
    Ok(())
}

#[tokio::test]
async fn cancelled_request_emits_one_terminal_retry_event() -> Result<(), NetError> {
    let events = Arc::new(Mutex::new(Vec::<RetryEvent>::new()));
    let observed = Arc::clone(&events);
    let policy = HttpRetryPolicy::builder()
        .schedule(RetrySchedule::builder().max_attempts(2).build()?)
        .retry_on(RetryOn::standard())
        .observer(move |event: &RetryEvent| {
            if let Ok(mut stored) = observed.lock() {
                stored.push(event.clone());
            }
        })
        .build()
        .map_err(|_| failure("observer policy was rejected"))?;
    let worker = HttpClientInner::new(
        "http-worker-observer-cancel".to_owned(),
        HttpClientConfig::new("http://127.0.0.1:1")?,
    )?;
    let (callback_tx, callback_rx) = mpsc::channel();
    let (registered, registration) = worker.register_request(None)?;
    let request_id = registered.id;
    let control = registered.control;
    worker.cancel(request_id)?;
    worker.submit(SendJob {
        inline_result: false,
        completion: None,
        request: Box::new(CallbackRequest {
            callback: callback_tx,
        }),
        options: HttpRequestOptions::default().with_retry_setting(RetrySetting::Policy(policy)),
        request_id,
        control,
        registry: worker.registry(),
        permit: Arc::new(worker.try_acquire_permit()?),
        operation_start: Instant::now(),
    })?;
    registration.commit();
    let (_, _, result) = callback_rx
        .recv_timeout(Duration::from_secs(5))
        .map_err(|_| failure("observer cancellation callback timeout"))?;
    if !matches!(result, Err(ref error) if error.kind() == ErrorKind::Cancelled) {
        return Err(failure("cancelled request returned the wrong result"));
    }
    let stored = events
        .lock()
        .map_err(|_| failure("observer event lock was poisoned"))?;
    let terminal_count = stored
        .iter()
        .filter(|event| matches!(event, RetryEvent::Completed(_)))
        .count();
    if terminal_count != 1 {
        return Err(failure(
            "cancelled request emitted an invalid terminal event count",
        ));
    }
    worker.shutdown_and_join().await?;
    Ok(())
}