websocat 4.0.0-alpha3

Command-line client for web sockets, like netcat/curl/socat for ws://.
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
use std::{
    net::SocketAddr,
    task::{ready, Poll},
};

use futures::FutureExt;
use rhai::{Dynamic, Engine, FnPtr, NativeCallContext};
use tracing::{debug, debug_span, warn, Instrument};

use crate::scenario_executor::{
    scenario::callback_and_continue,
    types::{BufferFlag, Handle, Slot},
    utils1::HandleExt,
};

use super::{
    scenario::ScenarioAccess,
    types::{DatagramSocket, DatagramWrite, Hangup, PacketWrite, Promise, StreamSocket, Task},
    utils1::{ExtractHandleOrFail, RhResult, SimpleErr},
    utils2::{Defragmenter, DefragmenterAddChunkResult},
};

pub struct TriggerableEventTrigger {
    tx: tokio::sync::oneshot::Sender<()>,
}

pub struct TriggerableEvent {
    waiter_part: Option<Hangup>,
    trigger_part: Option<TriggerableEventTrigger>,
}

//@ Create new one-time synchronisation object that allows to trigger a hangup event explicitly from Rhai code.
fn triggerable_event_create() -> Handle<TriggerableEvent> {
    let (tx, rx) = tokio::sync::oneshot::channel();
    let signal = TriggerableEvent {
        waiter_part: Some(Box::pin(async move {
            let _ = rx.await;
        })),
        trigger_part: Some(TriggerableEventTrigger { tx }),
    };
    Some(signal).wrap()
}

//@ Take the waitable part (Hangup) from an object created by `triggerable_event_create`
fn triggerable_event_take_hangup(
    ctx: NativeCallContext,
    h: &mut Handle<TriggerableEvent>,
) -> RhResult<Handle<Hangup>> {
    if let Some(s) = h.lock().unwrap().as_mut() {
        Ok(s.waiter_part.take().wrap())
    } else {
        Err(ctx.err("TriggerableEvent's hangup part is already taken"))
    }
}

//@ Take the activatable part from an object created by `triggerable_event_create`
fn triggerable_event_take_trigger(
    ctx: NativeCallContext,
    h: &mut Handle<TriggerableEvent>,
) -> RhResult<Handle<TriggerableEventTrigger>> {
    if let Some(s) = h.lock().unwrap().as_mut() {
        Ok(s.trigger_part.take().wrap())
    } else {
        Err(ctx.err("TriggerableEvent's trigger part is already taken"))
    }
}

//@ Trigger the activatable part from an object created by `triggerable_event_create`.
//@ This should cause a hangup even on the associated Hangup object.
fn triggerable_event_fire(
    ctx: NativeCallContext,
    h: &mut Handle<TriggerableEventTrigger>,
) -> RhResult<()> {
    if let Some(s) = h.lock().unwrap().take() {
        let _ = s.tx.send(());
        Ok(())
    } else {
        Err(ctx.err("TriggerableEventTrigger is already used"))
    }
}

//@ Create a Task that runs specified Rhai code when scheduled.
fn task_wrap(ctx: NativeCallContext, continuation: FnPtr) -> RhResult<Handle<Task>> {
    let the_scenario = ctx.get_scenario()?;

    let t: Task = Box::pin(async move {
        debug!("task_wrap");
        callback_and_continue::<()>(the_scenario, continuation, ()).await;
        Ok(())
    });
    Ok(Some(t).wrap())
}

//@ Extract IP address from SocketAddr
fn sockaddr_get_ip(sa: &mut SocketAddr) -> String {
    format!("{}", sa.ip())
}

//@ Extract port from SocketAddr
fn sockaddr_get_port(sa: &mut SocketAddr) -> i64 {
    sa.port().into()
}

//@ Build SocketAddr from IP and port
fn make_socket_addr(ctx: NativeCallContext, ip: &str, port: i64) -> RhResult<SocketAddr> {
    if let Ok(ip) = ip.parse() {
        Ok(SocketAddr::new(ip, port as u16))
    } else {
        Err(ctx.err("Failed to parse IP address"))
    }
}

//@ Send some object to named slot in the registry.
//@ Blocks if no receivers yet.
fn registry_send(ctx: NativeCallContext, addr: &str, x: Dynamic) -> RhResult<Handle<Task>> {
    let the_scenario = ctx.get_scenario()?;

    let span = debug_span!("registry_send",%addr);

    let tx = the_scenario.registry.get_sender(addr);

    let t: Task = Box::pin(
        async move {
            debug!("send");
            match tx.send_async(x).await {
                Ok(()) => {
                    debug!("sent");
                }
                Err(_) => {
                    debug!("failed");
                    anyhow::bail!("Failed registry_send");
                }
            }
            Ok(())
        }
        .instrument(span),
    );
    Ok(Some(t).wrap())
}

//@ Receive one object from a named slot in the registry and call `continuation` once for it
fn registry_recv_one(
    ctx: NativeCallContext,
    addr: &str,
    continuation: FnPtr,
) -> RhResult<Handle<Task>> {
    let the_scenario = ctx.get_scenario()?;

    let span = debug_span!("registry_recv_one",%addr);

    let rx = the_scenario.registry.get_receiver(addr);

    let t: Task = Box::pin(
        async move {
            debug!("recv");
            match rx.recv_async().await {
                Ok(x) => {
                    debug!("received");
                    callback_and_continue::<(Dynamic,)>(the_scenario, continuation, (x,)).await;
                }
                Err(_) => {
                    debug!("failed");
                    anyhow::bail!("Failed registry_recv_one");
                }
            }
            Ok(())
        }
        .instrument(span),
    );
    Ok(Some(t).wrap())
}

//@ Receive all objects from a named slot in the registry and call `continuation` for each one
fn registry_recv_all(
    ctx: NativeCallContext,
    addr: &str,
    continuation: FnPtr,
) -> RhResult<Handle<Task>> {
    let the_scenario = ctx.get_scenario()?;

    let span = debug_span!("registry_recv_all",%addr);

    let rx = the_scenario.registry.get_receiver(addr);

    let t: Task = Box::pin(
        async move {
            loop {
                let the_scenario = the_scenario.clone();
                let continuation = continuation.clone();
                debug!("recv");
                match rx.recv_async().await {
                    Ok(x) => {
                        debug!("received");
                        callback_and_continue::<(Dynamic,)>(the_scenario, continuation, (x,)).await;
                    }
                    Err(_) => {
                        debug!("failed");
                        anyhow::bail!("Failed registry_recv_all");
                    }
                }
            }
        }
        .instrument(span),
    );
    Ok(Some(t).wrap())
}

//@ Initialize multiple things in parallel using a array of closures, then call final closure with results of the initialisation
fn init_in_parallel(
    ctx: NativeCallContext,
    //@ Array of functions to call to prepare the `Vec<Dynamic>` for `continuation` below. Each function should have signature like `Fn(Slot) -> Task`.
    initialisers: Vec<Dynamic>,
    continuation: FnPtr,
) -> RhResult<Handle<Task>> {
    let the_scenario = ctx.get_scenario()?;

    let span = debug_span!("init_in_parallel");

    let mut receivers: Vec<Promise> = Vec::with_capacity(initialisers.len());
    let mut results: Vec<Dynamic> = Vec::with_capacity(initialisers.len());
    let mut handles: Vec<tokio::task::JoinHandle<()>> = Vec::with_capacity(initialisers.len());

    for (i, initialiser) in initialisers.into_iter().enumerate() {
        let Some(initialiser): Option<FnPtr> = initialiser.try_cast() else {
            return Err(ctx.err("Non-closure element in array"));
        };

        let the_scenario = the_scenario.clone();
        let (tx, rx) = tokio::sync::oneshot::channel();
        receivers.push(rx);

        let span = debug_span!(parent: &span, "initialiser", i);

        handles.push(tokio::spawn(
            async move {
                debug!("started");
                let tx: Handle<Slot> = Some(tx).wrap();
                callback_and_continue::<(Handle<Slot>,)>(the_scenario, initialiser, (tx,)).await;
            }
            .instrument(span),
        ));
    }
    debug!("started all initialisers");

    let t: Task = Box::pin(
        async move {
            for (i, rx) in receivers.into_iter().enumerate() {
                match rx.await {
                    Ok(x) => {
                        debug!(i, "received");
                        results.push(x);
                    }
                    Err(_) => {
                        debug!(i, "failed, cleaning up");
                        for h in handles {
                            h.abort();
                        }
                        anyhow::bail!("One of init_in_parallel's initialisers failed")
                    }
                }
            }

            callback_and_continue::<(Vec<Dynamic>,)>(the_scenario, continuation, (results,)).await;

            Ok(())
        }
        .instrument(span),
    );
    Ok(Some(t).wrap())
}

//@ Fulfill a Slot with a value, e.g to complete one of initialisers for `init_in_parallel`.
//@
//@ Acts immediately and returns a dummy task just as a convenience (to make Rhai scripts typecheck).
fn slot_send(
    ctx: NativeCallContext,
    slot: &mut Handle<Slot>,
    x: Dynamic,
) -> RhResult<Handle<Task>> {
    let sl = ctx.lutbarm(slot)?;

    if sl.send(x).is_err() {
        return Err(ctx.err("Failed to fulfill a slot"));
    }

    Ok(super::trivials1::dummytask())
}

//@ Take reading part s1 and write part of s2 and make a new socket that routes reads to s1 and writes to s2.
//@
//@ Close notifications (hangup tokens) are combined from s1 and s2.
//@
//@ Write part of s1 and read part of s2 remain in the original sockets which become incomplete (but not null).
fn combine_read_and_write_bytestream(
    ctx: NativeCallContext,
    s1: Handle<StreamSocket>,
    s2: Handle<StreamSocket>,
) -> RhResult<Handle<StreamSocket>> {
    let mut s1 = s1.lock().unwrap();
    let mut s2 = s2.lock().unwrap();

    let (Some(s1), Some(s2)) = (s1.as_mut(), s2.as_mut()) else {
        return Err(ctx.err("Null socket handle"));
    };

    let close: Option<Hangup> = match (s1.close.take(), s2.close.take()) {
        (None, None) => None,
        (None, Some(c)) => Some(c),
        (Some(c), None) => Some(c),
        (Some(a), Some(b)) => Some(Box::pin(futures::future::select(a, b).map(|_| ()))),
    };

    let s = StreamSocket {
        read: s1.read.take(),
        write: s2.write.take(),
        close,
        fd: None,
    };
    debug!(?s, "combine_read_and_write_bytestream");
    Ok(Some(s).wrap())
}

//@ Take reading part s1 and write part of s2 and make a new socket that routes reads to s1 and writes to s2.
//@
//@ Close notifications (hangup tokens) are combined from s1 and s2.
//@
//@ Write part of s1 and read part of s2 remain in the original sockets which become incomplete (but not null).
fn combine_read_and_write_datagram(
    ctx: NativeCallContext,
    s1: Handle<DatagramSocket>,
    s2: Handle<DatagramSocket>,
) -> RhResult<Handle<DatagramSocket>> {
    let mut s1 = s1.lock().unwrap();
    let mut s2 = s2.lock().unwrap();

    let (Some(s1), Some(s2)) = (s1.as_mut(), s2.as_mut()) else {
        return Err(ctx.err("Null socket handle"));
    };

    let close: Option<Hangup> = match (s1.close.take(), s2.close.take()) {
        (None, None) => None,
        (None, Some(c)) => Some(c),
        (Some(c), None) => Some(c),
        (Some(a), Some(b)) => Some(Box::pin(futures::future::select(a, b).map(|_| ()))),
    };

    let s = DatagramSocket {
        read: s1.read.take(),
        write: s2.write.take(),
        close,
        fd: None,
    };
    debug!(?s, "combine_read_and_write_bytestream");
    Ok(Some(s).wrap())
}

struct DefragmentWrites {
    inner: DatagramWrite,
    defragmenter: Defragmenter,
}

impl PacketWrite for DefragmentWrites {
    fn poll_write(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buf: &mut [u8],
        flags: super::types::BufferFlags,
    ) -> Poll<std::io::Result<()>> {
        let this = self.get_mut();

        match this.defragmenter.add_chunk(buf, flags) {
            DefragmenterAddChunkResult::DontSendYet => Poll::Ready(Ok(())),
            DefragmenterAddChunkResult::Continunous(newbuf) => {
                let ret = ready!(this.inner.snk.as_mut().poll_write(
                    cx,
                    newbuf,
                    flags - BufferFlag::NonFinalChunk
                ));
                this.defragmenter.clear();
                Poll::Ready(ret)
            }
            DefragmenterAddChunkResult::SizeLimitExceeded(_) => {
                warn!("Too large datagram");
                Poll::Ready(Err(std::io::ErrorKind::InvalidData.into()))
            }
        }
    }
}

const fn default_max_send_datagram_size() -> usize {
    655360
}

//@ Buffer up fragments of messages written to this overlay and only issue complete writes to inner socket.
fn defragment_writes(
    ctx: NativeCallContext,
    opts: Dynamic,
    inner: Handle<DatagramSocket>,
) -> RhResult<Handle<DatagramSocket>> {
    #[derive(serde::Deserialize)]
    struct Opts {
        //@ Defragmenter buffer limit
        #[serde(default = "default_max_send_datagram_size")]
        max_send_datagram_size: usize,
    }
    let opts: Opts = rhai::serde::from_dynamic(&opts)?;
    let mut s = ctx.lutbar(inner)?;

    if let Some(w) = s.write.take() {
        s.write = Some(DatagramWrite {
            snk: Box::pin(DefragmentWrites {
                inner: w,
                defragmenter: Defragmenter::new(opts.max_send_datagram_size),
            }),
        });
    } else {
        warn!("defragment_writers is used on an incomplete socket without a writing part");
    }
    debug!(?s, "defragment_writes");
    let h = Some(s).wrap();
    Ok(h)
}

pub fn register(engine: &mut Engine) {
    engine.register_fn("triggerable_event_create", triggerable_event_create);
    engine.register_fn("take_hangup", triggerable_event_take_hangup);
    engine.register_fn("take_trigger", triggerable_event_take_trigger);
    engine.register_fn("fire", triggerable_event_fire);
    engine.register_fn("task_wrap", task_wrap);
    engine.register_fn("get_ip", sockaddr_get_ip);
    engine.register_fn("get_port", sockaddr_get_port);
    engine.register_fn("make_socket_addr", make_socket_addr);
    engine.register_fn("registry_send", registry_send);
    engine.register_fn("registry_recv_one", registry_recv_one);
    engine.register_fn("registry_recv_all", registry_recv_all);
    engine.register_fn("init_in_parallel", init_in_parallel);
    engine.register_fn("send", slot_send);
    engine.register_fn(
        "combine_read_and_write_bytestream",
        combine_read_and_write_bytestream,
    );
    engine.register_fn(
        "combine_read_and_write_datagram",
        combine_read_and_write_datagram,
    );
    engine.register_fn("defragment_writes", defragment_writes);
}