open-net 0.3.2

A cross-platform async networking library with WebSocket clients and network status monitoring.
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
use crate::common::log::log_def::LogType;
use crate::error::{ErrorKind, ErrorStage, NetError};
use crate::module::ws_client::io_diagnostics::classify_io_error;
use crate::module::ws_client::io_event::IoEvent;
use crate::module::ws_client::read::read_loop_context::ReadLoopContext;
use crate::module::ws_client::session_runtime::SessionRuntime;
use crate::module::ws_client::write::control_message::ControlMessage;
use crate::ws::{
    ConnectionId, IncomingMessage, IncomingOrigin, IncomingPayload, IoEndKind, PeerClose,
    ResponseRoute, ResponseRouting,
};
use futures_util::{Stream, StreamExt};
use std::sync::Arc;
use std::time::SystemTime;
use tokio::sync::mpsc;
use tokio_tungstenite::tungstenite::{Error as WsError, Message};

/// Report the physical reader's terminal result through the bounded worker lane.
async fn send_read_end(io_event_tx: &mpsc::Sender<IoEvent>, generation: u64, error: NetError) {
    send_read_end_classified(io_event_tx, generation, error, IoEndKind::Other).await;
}

async fn send_read_end_classified(
    io_event_tx: &mpsc::Sender<IoEvent>,
    generation: u64,
    error: NetError,
    kind: IoEndKind,
) {
    let error = if error.context().stage.is_none() {
        error.with_stage(ErrorStage::Receive)
    } else {
        error
    };
    crate::log_t!(LogType::WSC; "ws.read.send_read_end_classified", "arg_io_event_tx_present|generation|error_kind|error_stage|kind", true, generation, format!("{:?}", error.kind()), format!("{:?}", error.context().stage), format!("{kind:?}"));
    if matches!(error.kind(), ErrorKind::Closed | ErrorKind::Cancelled) {
        crate::log_s!(LogType::WSC; "ws.read.send_read_end_classified", "state|generation|error_kind", "read_ended", generation, format!("{:?}", error.kind()));
    } else {
        crate::log_e!(LogType::WSC; "ws.read.send_read_end_classified", "arg_io_event_tx_present|generation|error_kind|error_stage|kind", true, generation, format!("{:?}", error.kind()), format!("{:?}", error.context().stage), format!("{kind:?}"));
    }
    if io_event_tx
        .send(IoEvent::ReadEnded {
            generation,
            error,
            kind,
        })
        .await
        .is_err()
    {
        crate::log_s!(LogType::WSC; "ws.read.send_read_end_classified", "state|generation", "worker_event_receiver_closed", generation);
    }
}

/// Decode one physical connection, correlate responses before raw publication,
/// and process protocol control frames independently of user consumption.
pub(crate) async fn run_read_loop<S>(mut read: S, context: ReadLoopContext)
where
    S: Stream<Item = Result<Message, WsError>> + Unpin + Send + 'static,
{
    let ReadLoopContext {
        runtime,
        peer_close,
        control_tx,
        io_event_tx,
        generation,
        cancel,
        heartbeat,
    } = context;
    let connection = ConnectionId::from_allocated(generation);
    let origin = IncomingOrigin::new(runtime.client_id, runtime.id, connection);
    crate::log_t!(LogType::WSC; "ws.read.run_read_loop", "arg_read_present|arg_context_generation|arg_context_session", true, generation, runtime.id.as_u64());
    loop {
        let next = tokio::select! {
            biased;
            _ = cancel.cancelled() => {
                crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation", "read_cancelled", generation);
                return;
            },
            next = read.next() => next,
        };
        let Some(next) = next else {
            crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation", "stream_ended", generation);
            fail_read(
                &runtime,
                &io_event_tx,
                generation,
                NetError::from(ErrorKind::Closed),
                IoEndKind::UnexpectedEof,
            )
            .await;
            return;
        };
        let message = match next {
            Ok(message) => message,
            Err(error) => {
                crate::log_e!(LogType::WSC; "ws.read.run_read_loop", "generation|error", generation, crate::common::log::summary::error(&error));
                let kind = classify_io_error(&error);
                fail_read(&runtime, &io_event_tx, generation, error.into(), kind).await;
                return;
            }
        };
        let received_at = SystemTime::now();
        crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation|message_type|message_bytes", "message_received", generation, match &message { Message::Text(_) => "text", Message::Binary(_) => "binary", Message::Ping(_) => "ping", Message::Pong(_) => "pong", Message::Close(_) => "close", Message::Frame(_) => "frame" }, message.len());
        match message {
            Message::Text(text) => {
                let incoming = IncomingMessage::new(
                    origin,
                    IncomingPayload::Message(crate::ws::Message::text(text.as_str())),
                    received_at,
                );
                if let Err(error) = route_and_publish(&runtime, incoming) {
                    let kind = routing_end_kind(&error);
                    fail_read(&runtime, &io_event_tx, generation, error, kind).await;
                    return;
                }
            }
            Message::Binary(bytes) => {
                let incoming = IncomingMessage::new(
                    origin,
                    IncomingPayload::Message(crate::ws::Message::binary(bytes)),
                    received_at,
                );
                if let Err(error) = route_and_publish(&runtime, incoming) {
                    let kind = routing_end_kind(&error);
                    fail_read(&runtime, &io_event_tx, generation, error, kind).await;
                    return;
                }
            }
            Message::Ping(payload) => {
                if let Err(error) = send_control(&control_tx, ControlMessage::FlushAutomatic) {
                    crate::log_e!(LogType::WSC; "ws.read.run_read_loop", "stage|generation", "automatic_pong_control_failed", generation);
                    fail_read(&runtime, &io_event_tx, generation, error, IoEndKind::Other).await;
                    return;
                }
                let incoming =
                    IncomingMessage::new(origin, IncomingPayload::Ping(payload), received_at);
                if let Err(error) = runtime.messages.publish(incoming) {
                    fail_read(&runtime, &io_event_tx, generation, error, IoEndKind::Other).await;
                    return;
                }
            }
            Message::Pong(payload) => {
                let matched = heartbeat.acknowledge_pong(payload.as_ref());
                crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation|matched", "pong_received", generation, matched);
                let incoming =
                    IncomingMessage::new(origin, IncomingPayload::Pong(payload), received_at);
                if let Err(error) = runtime.messages.publish(incoming) {
                    fail_read(&runtime, &io_event_tx, generation, error, IoEndKind::Other).await;
                    return;
                }
            }
            Message::Close(frame) => {
                let close = match PeerClose::from_frame(frame.as_ref()) {
                    Ok(close) => close,
                    Err(error) => {
                        let kind = routing_end_kind(&error);
                        fail_read(&runtime, &io_event_tx, generation, error, kind).await;
                        return;
                    }
                };
                // Keep the first decoded close even if a later reply write fails.
                let _ = peer_close.set(close.clone());
                let (done_tx, done_rx) = tokio::sync::oneshot::channel();
                if let Err(error) = send_control(&control_tx, ControlMessage::PeerClose(done_tx)) {
                    crate::log_e!(LogType::WSC; "ws.read.run_read_loop", "stage|generation", "peer_close_control_failed", generation);
                    fail_read(&runtime, &io_event_tx, generation, error, IoEndKind::Other).await;
                    return;
                }
                // Observation never delays the automatic close reply. Retain
                // any observation error until the writer has finished flushing.
                let observation = runtime.messages.publish(IncomingMessage::new(
                    origin,
                    IncomingPayload::Close(close),
                    received_at,
                ));
                let reply = tokio::select! {
                    _ = cancel.cancelled() => {
                        crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation", "read_cancelled", generation);
                        return;
                    },
                    result = done_rx => result,
                };
                match reply {
                    Ok(Ok(())) => {}
                    Ok(Err(error)) => {
                        let kind = error.context().io_end.map_or(IoEndKind::Other, |kind| kind);
                        fail_read(&runtime, &io_event_tx, generation, error, kind).await;
                        return;
                    }
                    Err(error) => {
                        fail_read(
                            &runtime,
                            &io_event_tx,
                            generation,
                            NetError::with_source(ErrorKind::Closed, error),
                            IoEndKind::Other,
                        )
                        .await;
                        return;
                    }
                }
                let error = observation
                    .err()
                    .map_or_else(|| NetError::from(ErrorKind::Closed), |error| error);
                fail_read(
                    &runtime,
                    &io_event_tx,
                    generation,
                    error,
                    IoEndKind::PeerClose,
                )
                .await;
                return;
            }
            Message::Frame(_) => {
                crate::log_s!(LogType::WSC; "ws.read.run_read_loop", "state|generation", "raw_frame_ignored", generation);
            }
        }
    }
}

fn route_and_publish(
    runtime: &Arc<SessionRuntime>,
    incoming: IncomingMessage,
) -> crate::Result<()> {
    // The application protocol runs outside every pending/operation table lock.
    match runtime.routing.route(&incoming)? {
        ResponseRoute::Final { request_id } => {
            if runtime.pending.complete_response(&request_id, &incoming)? {
                return Ok(());
            }
        }
        ResponseRoute::Unmatched | ResponseRoute::Intermediate { .. } => {}
    }
    if matches!(runtime.routing, ResponseRouting::Manual) {
        return runtime.messages.publish_with_admission(
            incoming,
            |incoming| runtime.pending.register_dispatch(incoming),
            |incoming| runtime.pending.discard_dispatch(incoming),
        );
    }
    runtime.messages.publish(incoming)
}

fn send_control(
    sender: &mpsc::Sender<ControlMessage>,
    message: ControlMessage,
) -> crate::Result<()> {
    sender.try_send(message).map_err(|error| match error {
        mpsc::error::TrySendError::Full(_) => NetError::from(ErrorKind::ControlOverflow),
        mpsc::error::TrySendError::Closed(_) => NetError::from(ErrorKind::Closed),
    })
}

fn routing_end_kind(error: &NetError) -> IoEndKind {
    match error.kind() {
        ErrorKind::Protocol | ErrorKind::CallbackPanicked => IoEndKind::ProtocolError,
        _ => IoEndKind::Other,
    }
}

async fn fail_read(
    runtime: &Arc<SessionRuntime>,
    events: &mpsc::Sender<IoEvent>,
    generation: u64,
    error: NetError,
    kind: IoEndKind,
) {
    let connection = ConnectionId::from_allocated(generation);
    let mut context = error.context().clone();
    context.client_id = Some(runtime.client_id);
    context.session_id = Some(runtime.id);
    context.connection_id = Some(connection);
    context.io_end = Some(kind);
    if context.stage.is_none() {
        context.stage = Some(ErrorStage::Receive);
    }
    let error = error.with_context(context);
    if let Err(cleanup) = runtime.connection_ended(connection, error.clone()) {
        crate::log_e!(LogType::WSC; "ws.read.fail_read", "stage|arg_runtime_session|arg_events_present|generation|error_kind|error_stage|kind|cleanup_kind", "pending_connection_cleanup_failed", runtime.id.as_u64(), true, generation, format!("{:?}", error.kind()), format!("{:?}", error.context().stage), format!("{kind:?}"), format!("{:?}", cleanup.kind()));
    }
    if kind == IoEndKind::Other {
        send_read_end(events, generation, error).await;
    } else {
        send_read_end_classified(events, generation, error, kind).await;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::module::ws_client::{
        test_support::{check, check_eq, test_error, TestResult},
        v2_test_support as fixture,
    };
    use crate::ws::{ReceiveOptions, ReceiveOverflow, ResponseRouting, WebSocketClientConfig};
    use futures::stream;
    use tokio_util::sync::CancellationToken;

    #[tokio::test]
    async fn source_failure_is_delivered_once_and_releases_subscription_admission() -> TestResult {
        let runtime = fixture::runtime(
            WebSocketClientConfig::default(),
            ResponseRouting::Disabled,
            true,
        )
        .await?;
        let mut messages = runtime.messages.subscribe(ReceiveOptions::default())?;
        runtime
            .messages
            .fail(NetError::from(ErrorKind::CallbackOverflow));
        check!(
            matches!(messages.recv().await, Err(crate::error::ReceiveError::Failed(error)) if error.kind() == ErrorKind::CallbackOverflow)
        )?;
        check!(messages.recv().await?.is_none())?;
        check_eq!(
            runtime
                .messages
                .subscribe(ReceiveOptions::default())
                .err()
                .map(|e| e.kind()),
            Some(ErrorKind::Closed)
        )?;
        Ok(())
    }

    #[tokio::test]
    async fn messages_fan_out_without_payload_copy_and_late_subscribers_do_not_replay() -> TestResult
    {
        let runtime = fixture::runtime(
            WebSocketClientConfig::default(),
            ResponseRouting::Disabled,
            true,
        )
        .await?;
        let mut first = runtime.messages.subscribe(ReceiveOptions::default())?;
        let mut second = runtime.messages.subscribe(ReceiveOptions::default())?;
        route_and_publish(&runtime, fixture::incoming(1, "fanout"))?;
        let mut late = runtime.messages.subscribe(ReceiveOptions::default())?;
        let a = first
            .recv()
            .await?
            .ok_or_else(|| test_error("first recipient missing"))?;
        let b = second
            .recv()
            .await?
            .ok_or_else(|| test_error("second recipient missing"))?;
        check_eq!(a.message(), b.message())?;
        check_eq!(a.received_at(), b.received_at())?;
        check!(late.try_recv().is_err())?;
        Ok(())
    }
    #[tokio::test]
    async fn receive_item_and_byte_limits_fail_fast_and_release_after_consumption() -> TestResult {
        for (items, bytes, body) in [(1, 16, "one"), (4, 4, "1234")] {
            let mut config = WebSocketClientConfig::default();
            config.dispatch.incoming.max_items = items;
            config.dispatch.incoming.max_bytes = bytes;
            let runtime = fixture::runtime(config, ResponseRouting::Disabled, true).await?;
            let mut messages = runtime.messages.subscribe(ReceiveOptions::default())?;
            route_and_publish(&runtime, fixture::incoming(1, body))?;
            check_eq!(
                route_and_publish(&runtime, fixture::incoming(1, "x"))
                    .err()
                    .map(|e| e.kind()),
                Some(ErrorKind::CallbackOverflow)
            )?;
            drop(messages.recv().await?);
            route_and_publish(&runtime, fixture::incoming(1, "x"))?;
        }
        Ok(())
    }
    #[tokio::test]
    async fn fanout_reservation_failure_does_not_partially_deliver() -> TestResult {
        let mut config = WebSocketClientConfig::default();
        config.dispatch.message_deliveries = 1;
        let runtime = fixture::runtime(config, ResponseRouting::Disabled, true).await?;
        let mut first = runtime.messages.subscribe(ReceiveOptions::default())?;
        let second = runtime.messages.subscribe(ReceiveOptions::default())?;
        check!(route_and_publish(&runtime, fixture::incoming(1, "x")).is_err())?;
        check!(first.try_recv().is_err())?;
        drop(second);
        route_and_publish(&runtime, fixture::incoming(1, "x"))?;
        check!(first.recv().await?.is_some())?;
        Ok(())
    }
    #[tokio::test]
    async fn drop_oldest_reports_loss_and_keeps_newest_payload() -> TestResult {
        let runtime = fixture::runtime(
            WebSocketClientConfig::default(),
            ResponseRouting::Disabled,
            true,
        )
        .await?;
        let mut messages = runtime.messages.subscribe(ReceiveOptions {
            max_messages: 1,
            max_bytes: 32,
            overflow: ReceiveOverflow::DropOldest,
            ..Default::default()
        })?;
        route_and_publish(&runtime, fixture::incoming(1, "old"))?;
        route_and_publish(&runtime, fixture::incoming(1, "new"))?;
        check!(matches!(
            messages.recv().await,
            Err(crate::error::ReceiveError::Lagged { .. })
        ))?;
        check_eq!(
            messages
                .recv()
                .await?
                .ok_or_else(|| test_error("latest missing"))?
                .message(),
            Some(&crate::ws::Message::from("new"))
        )?;
        Ok(())
    }
    #[tokio::test]
    async fn ping_requests_automatic_flush_before_control_observation() -> TestResult {
        let runtime = fixture::runtime(
            WebSocketClientConfig::default(),
            ResponseRouting::Disabled,
            true,
        )
        .await?;
        let mut messages = runtime.messages.subscribe(ReceiveOptions {
            include_control_frames: true,
            ..Default::default()
        })?;
        let (controls, mut control_rx) = mpsc::channel(1);
        let (events, _event_rx) = mpsc::channel(2);
        let cancel = CancellationToken::new();
        let read = stream::iter([Ok(Message::Ping(crate::Bytes::from_static(b"probe")))])
            .chain(stream::pending());
        let task = tokio::spawn(run_read_loop(
            read,
            ReadLoopContext {
                runtime,
                peer_close: Arc::new(Default::default()),
                control_tx: controls,
                io_event_tx: events,
                generation: 1,
                cancel: cancel.clone(),
                heartbeat: Arc::new(
                    crate::module::ws_client::heartbeat_state::HeartbeatState::new(1),
                ),
            },
        ));
        check!(matches!(
            fixture::bounded(control_rx.recv()).await?,
            Some(ControlMessage::FlushAutomatic)
        ))?;
        check!(matches!(
            fixture::bounded(messages.recv())
                .await??
                .map(|m| m.payload().clone()),
            Some(IncomingPayload::Ping(_))
        ))?;
        cancel.cancel();
        fixture::bounded(task).await??;
        Ok(())
    }
    #[tokio::test]
    async fn full_control_lane_is_a_typed_read_failure() -> TestResult {
        let runtime = fixture::runtime(
            WebSocketClientConfig::default(),
            ResponseRouting::Disabled,
            true,
        )
        .await?;
        let (controls, _control_rx) = mpsc::channel(1);
        controls.try_send(ControlMessage::FlushAutomatic)?;
        let (events, mut event_rx) = mpsc::channel(2);
        run_read_loop(
            stream::iter([Ok(Message::Ping(crate::Bytes::new()))]),
            ReadLoopContext {
                runtime,
                peer_close: Arc::new(Default::default()),
                control_tx: controls,
                io_event_tx: events,
                generation: 1,
                cancel: CancellationToken::new(),
                heartbeat: Arc::new(
                    crate::module::ws_client::heartbeat_state::HeartbeatState::new(1),
                ),
            },
        )
        .await;
        check!(
            matches!(event_rx.recv().await, Some(IoEvent::ReadEnded { error, .. }) if error.kind() == ErrorKind::ControlOverflow)
        )?;
        Ok(())
    }
}