wscall-client 0.1.0

Client SDK for WSCALL
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
use std::collections::HashMap;
use std::future::Future;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::time::Duration;

use futures_util::{SinkExt, StreamExt, future::BoxFuture};
use serde_json::{Value, json};
use tokio::sync::{Mutex, RwLock, mpsc, oneshot};
use tokio::time::{MissedTickBehavior, interval, timeout};
use tokio_tungstenite::{connect_async, tungstenite::Message};
use uuid::Uuid;
use wscall_protocol::{
    EncryptionKind, ErrorPayload, FileAttachment, FrameCodec, PacketBody, PacketEnvelope,
};

use crate::client_types::{ClientError, ClientOutbound, EventMessage};

type EventHandler = Arc<dyn Fn(EventMessage) -> BoxFuture<'static, Value> + Send + Sync>;
type PendingSender = oneshot::Sender<Result<Value, ClientError>>;
type PendingMap = Arc<Mutex<HashMap<String, PendingSender>>>;

const CLIENT_IDLE_TIMEOUT: Duration = Duration::from_secs(45);
const CLIENT_HEARTBEAT_INTERVAL: Duration = Duration::from_secs(15);
const CLIENT_OUTBOUND_QUEUE_CAPACITY: usize = 256;

#[derive(Clone)]
pub struct WscallClient {
    writer: mpsc::Sender<ClientOutbound>,
    pending_api: PendingMap,
    pending_event: PendingMap,
    event_handlers: Arc<RwLock<HashMap<String, Vec<EventHandler>>>>,
    default_timeout: Duration,
    default_encryption: EncryptionKind,
    is_connected: Arc<AtomicBool>,
}

impl WscallClient {
    pub async fn connect(url: &str) -> Result<Self, ClientError> {
        Self::connect_with_settings(url, FrameCodec::plaintext(), EncryptionKind::None).await
    }

    pub async fn connect_with_chacha20(url: &str, key: [u8; 32]) -> Result<Self, ClientError> {
        Self::connect_with_settings(
            url,
            FrameCodec::plaintext().with_chacha20_key(key),
            EncryptionKind::ChaCha20,
        )
        .await
    }

    pub async fn connect_with_aes256(url: &str, key: [u8; 32]) -> Result<Self, ClientError> {
        Self::connect_with_settings(
            url,
            FrameCodec::plaintext().with_aes256_key(key),
            EncryptionKind::Aes256,
        )
        .await
    }

    async fn connect_with_settings(
        url: &str,
        codec: FrameCodec,
        default_encryption: EncryptionKind,
    ) -> Result<Self, ClientError> {
        let (socket, _) = connect_async(url).await?;
        let (mut sink, mut stream) = socket.split();
        let (tx, mut rx) = mpsc::channel::<ClientOutbound>(CLIENT_OUTBOUND_QUEUE_CAPACITY);

        let client = Self {
            writer: tx,
            pending_api: Arc::new(Mutex::new(HashMap::new())),
            pending_event: Arc::new(Mutex::new(HashMap::new())),
            event_handlers: Arc::new(RwLock::new(HashMap::new())),
            default_timeout: Duration::from_secs(10),
            default_encryption,
            is_connected: Arc::new(AtomicBool::new(true)),
        };

        let writer_codec = codec.clone();
        let writer_client = client.clone();
        tokio::spawn(async move {
            while let Some(outbound) = rx.recv().await {
                match outbound {
                    ClientOutbound::Packet(packet) => {
                        let encoded = match writer_codec.encode(&packet) {
                            Ok(encoded) => encoded,
                            Err(error) => {
                                eprintln!("failed to encode outbound frame: {error}");
                                continue;
                            }
                        };

                        if sink.send(Message::Binary(encoded)).await.is_err() {
                            break;
                        }
                    }
                    ClientOutbound::Ping(payload) => {
                        if sink.send(Message::Ping(payload)).await.is_err() {
                            break;
                        }
                    }
                    ClientOutbound::Pong(payload) => {
                        if sink.send(Message::Pong(payload)).await.is_err() {
                            break;
                        }
                    }
                    ClientOutbound::Close => {
                        let _ = sink.send(Message::Close(None)).await;
                        break;
                    }
                }
            }

            writer_client
                .handle_disconnect(ClientError::ConnectionClosed(
                    "writer loop stopped".to_string(),
                ))
                .await;
        });

        let heartbeat_client = client.clone();
        tokio::spawn(async move {
            let mut ticker = interval(CLIENT_HEARTBEAT_INTERVAL);
            ticker.set_missed_tick_behavior(MissedTickBehavior::Delay);
            loop {
                ticker.tick().await;
                if !heartbeat_client.is_connected.load(Ordering::SeqCst) {
                    break;
                }

                if heartbeat_client
                    .writer
                    .send(ClientOutbound::Ping(Vec::new()))
                    .await
                    .is_err()
                {
                    heartbeat_client
                        .handle_disconnect(ClientError::ConnectionClosed(
                            "heartbeat stopped".to_string(),
                        ))
                        .await;
                    break;
                }
            }
        });

        let reader_client = client.clone();
        tokio::spawn(async move {
            loop {
                let next_message = timeout(CLIENT_IDLE_TIMEOUT, stream.next()).await;
                let message = match next_message {
                    Ok(Some(message)) => message,
                    Ok(None) => break,
                    Err(_) => {
                        reader_client
                            .handle_disconnect(ClientError::IdleTimeout)
                            .await;
                        break;
                    }
                };

                match message {
                    Ok(Message::Binary(bytes)) => match codec.decode(&bytes) {
                        Ok(packet) => reader_client.handle_packet(packet).await,
                        Err(error) => eprintln!("failed to decode inbound frame: {error}"),
                    },
                    Ok(Message::Close(_)) => break,
                    Ok(Message::Ping(payload)) => {
                        if reader_client
                            .writer
                            .send(ClientOutbound::Pong(payload.to_vec()))
                            .await
                            .is_err()
                        {
                            break;
                        }
                    }
                    Ok(Message::Pong(_)) | Ok(Message::Text(_)) | Ok(Message::Frame(_)) => {}
                    Err(error) => {
                        eprintln!("client reader stopped: {error}");
                        reader_client
                            .handle_disconnect(ClientError::ConnectionClosed(error.to_string()))
                            .await;
                        break;
                    }
                }
            }

            reader_client
                .handle_disconnect(ClientError::ConnectionClosed(
                    "reader loop stopped".to_string(),
                ))
                .await;
        });

        Ok(client)
    }

    pub async fn on_event<F, Fut>(&self, name: impl Into<String>, handler: F)
    where
        F: Fn(EventMessage) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Value> + Send + 'static,
    {
        let handler = Arc::new(move |event: EventMessage| {
            Box::pin(handler(event)) as BoxFuture<'static, Value>
        });
        self.event_handlers
            .write()
            .await
            .entry(name.into())
            .or_default()
            .push(handler);
    }

    pub async fn call(
        &self,
        route: impl Into<String>,
        params: Value,
        attachments: Vec<FileAttachment>,
    ) -> Result<Value, ClientError> {
        if !self.is_connected.load(Ordering::SeqCst) {
            return Err(ClientError::Disconnected);
        }

        let request_id = Uuid::new_v4().to_string();
        let route = route.into();
        let (tx, rx) = oneshot::channel();
        self.pending_api.lock().await.insert(request_id.clone(), tx);
        if self
            .writer
            .send(ClientOutbound::Packet(PacketEnvelope::with_encryption(
                PacketBody::ApiRequest {
                    request_id: request_id.clone(),
                    route,
                    params,
                    attachments,
                    metadata: json!({ "client_name": "rust-demo" }),
                },
                self.default_encryption,
            )))
            .await
            .is_err()
        {
            self.pending_api.lock().await.remove(&request_id);
            return Err(ClientError::Disconnected);
        }

        match timeout(self.default_timeout, rx).await {
            Ok(result) => result.map_err(|_| ClientError::Disconnected)?,
            Err(_) => {
                self.pending_api.lock().await.remove(&request_id);
                Err(ClientError::Timeout)
            }
        }
    }

    pub async fn send_event(
        &self,
        name: impl Into<String>,
        data: Value,
        attachments: Vec<FileAttachment>,
    ) -> Result<Value, ClientError> {
        if !self.is_connected.load(Ordering::SeqCst) {
            return Err(ClientError::Disconnected);
        }

        let event_id = Uuid::new_v4().to_string();
        let (tx, rx) = oneshot::channel();
        self.pending_event.lock().await.insert(event_id.clone(), tx);
        if self
            .writer
            .send(ClientOutbound::Packet(PacketEnvelope::with_encryption(
                PacketBody::EventEmit {
                    event_id: event_id.clone(),
                    name: name.into(),
                    data,
                    attachments,
                    metadata: json!({ "client_name": "rust-demo" }),
                    expect_ack: true,
                },
                self.default_encryption,
            )))
            .await
            .is_err()
        {
            self.pending_event.lock().await.remove(&event_id);
            return Err(ClientError::Disconnected);
        }

        match timeout(self.default_timeout, rx).await {
            Ok(result) => result.map_err(|_| ClientError::Disconnected)?,
            Err(_) => {
                self.pending_event.lock().await.remove(&event_id);
                Err(ClientError::Timeout)
            }
        }
    }

    pub async fn close(&self) -> Result<(), ClientError> {
        self.is_connected.store(false, Ordering::SeqCst);
        self.writer
            .send(ClientOutbound::Close)
            .await
            .map_err(|_| ClientError::Disconnected)
    }

    async fn handle_packet(&self, packet: PacketEnvelope) {
        match packet.body {
            PacketBody::ApiResponse {
                request_id,
                ok,
                data,
                error,
                ..
            } => {
                if let Some(tx) = self.pending_api.lock().await.remove(&request_id) {
                    let result = if ok {
                        Ok(data)
                    } else {
                        Err(ClientError::Remote(error.unwrap_or_else(|| ErrorPayload {
                            code: "remote_error".to_string(),
                            message: "missing remote error".to_string(),
                            status: 500,
                            details: None,
                        })))
                    };
                    let _ = tx.send(result);
                }
            }
            PacketBody::EventAck {
                event_id,
                ok,
                receipt,
                error,
            } => {
                if let Some(tx) = self.pending_event.lock().await.remove(&event_id) {
                    let result = if ok {
                        Ok(receipt)
                    } else {
                        Err(ClientError::Remote(error.unwrap_or_else(|| ErrorPayload {
                            code: "remote_error".to_string(),
                            message: "missing remote error".to_string(),
                            status: 500,
                            details: None,
                        })))
                    };
                    let _ = tx.send(result);
                }
            }
            PacketBody::EventEmit {
                event_id,
                name,
                data,
                attachments,
                metadata,
                expect_ack,
            } => {
                let event = EventMessage {
                    event_id: event_id.clone(),
                    name: name.clone(),
                    data,
                    attachments,
                    metadata,
                };
                let handlers = self
                    .event_handlers
                    .read()
                    .await
                    .get(&name)
                    .cloned()
                    .unwrap_or_default();

                let mut receipt = json!({ "handled": false });
                for handler in handlers {
                    receipt = handler(event.clone()).await;
                }

                if expect_ack {
                    let _ = self
                        .writer
                        .send(ClientOutbound::Packet(PacketEnvelope::with_encryption(
                            PacketBody::EventAck {
                                event_id,
                                ok: true,
                                receipt,
                                error: None,
                            },
                            self.default_encryption,
                        )))
                        .await;
                }
            }
            PacketBody::ApiRequest { .. } => {}
        }
    }

    async fn handle_disconnect(&self, error: ClientError) {
        if !self.is_connected.swap(false, Ordering::SeqCst) {
            return;
        }

        let reason = match &error {
            ClientError::ConnectionClosed(reason) => reason.clone(),
            ClientError::IdleTimeout => "idle timeout".to_string(),
            ClientError::Disconnected => "disconnected".to_string(),
            other => other.to_string(),
        };

        let pending_api = std::mem::take(&mut *self.pending_api.lock().await);
        for sender in pending_api.into_values() {
            let _ = sender.send(Err(ClientError::ConnectionClosed(reason.clone())));
        }

        let pending_event = std::mem::take(&mut *self.pending_event.lock().await);
        for sender in pending_event.into_values() {
            let _ = sender.send(Err(ClientError::ConnectionClosed(reason.clone())));
        }
    }
}