supabase-lib-rs 0.5.3

A comprehensive, production-ready Rust client library for Supabase with full cross-platform support (native + WASM)
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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
//! WebSocket abstraction for cross-platform compatibility
//!
//! This module provides WebSocket implementations for both native and WASM targets.
//! The abstractions allow the realtime module to work seamlessly across platforms.
//!
//! ## Platform Support
//!
//! - **Native**: Uses `tokio-tungstenite` with full TLS support
//! - **WASM**: Uses browser's `WebSocket` API through `web-sys`
//!
//! ## Usage
//!
//! This module is primarily used internally by the realtime module, but can be
//! used directly if needed:
//!
//! ```rust,ignore
//! use supabase::websocket::{create_websocket, WebSocketConnection};
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let mut ws = create_websocket();
//! ws.connect("wss://example.com/websocket").await?;
//!
//! // Send a message
//! ws.send("Hello, WebSocket!").await?;
//!
//! // Receive messages
//! if let Some(message) = ws.receive().await? {
//!     println!("Received: {}", message);
//! }
//!
//! ws.close().await?;
//! # Ok(())
//! # }
//! ```

#[cfg(feature = "realtime")]
use crate::error::{Error, Result};

/// Cross-platform WebSocket trait for native targets
///
/// This trait defines the interface for WebSocket connections on native platforms
/// where `Send + Sync` bounds are required for multi-threading.
#[cfg(all(feature = "realtime", not(target_arch = "wasm32")))]
#[async_trait::async_trait]
pub trait WebSocketConnection: Send + Sync {
    /// Connect to a WebSocket server
    ///
    /// # Examples
    /// ```rust,ignore
    /// # use supabase::websocket::{create_websocket, WebSocketConnection};
    /// # async fn example() -> supabase::Result<()> {
    /// let mut ws = create_websocket();
    /// ws.connect("wss://echo.websocket.org").await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn connect(&mut self, url: &str) -> Result<()>;

    /// Send a text message through the WebSocket
    ///
    /// # Examples
    /// ```rust,ignore
    /// # use supabase::websocket::{create_websocket, WebSocketConnection};
    /// # async fn example() -> supabase::Result<()> {
    /// let mut ws = create_websocket();
    /// ws.connect("wss://echo.websocket.org").await?;
    /// ws.send("Hello, server!").await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn send(&mut self, message: &str) -> Result<()>;

    /// Receive a text message from the WebSocket
    ///
    /// Returns `Ok(Some(message))` if a message was received,
    /// `Ok(None)` if no message is available, or an error.
    ///
    /// # Examples
    /// ```rust,ignore
    /// # use supabase::websocket::{create_websocket, WebSocketConnection};
    /// # async fn example() -> supabase::Result<()> {
    /// let mut ws = create_websocket();
    /// ws.connect("wss://echo.websocket.org").await?;
    ///
    /// if let Some(message) = ws.receive().await? {
    ///     println!("Got message: {}", message);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    async fn receive(&mut self) -> Result<Option<String>>;

    /// Close the WebSocket connection
    ///
    /// # Examples
    /// ```rust,ignore
    /// # use supabase::websocket::{create_websocket, WebSocketConnection};
    /// # async fn example() -> supabase::Result<()> {
    /// let mut ws = create_websocket();
    /// ws.connect("wss://echo.websocket.org").await?;
    /// // ... do work ...
    /// ws.close().await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn close(&mut self) -> Result<()>;

    /// Check if the WebSocket is currently connected
    ///
    /// # Examples
    /// ```rust,ignore
    /// # use supabase::websocket::{create_websocket, WebSocketConnection};
    /// # async fn example() -> supabase::Result<()> {
    /// let mut ws = create_websocket();
    /// assert!(!ws.is_connected()); // Not connected initially
    ///
    /// ws.connect("wss://echo.websocket.org").await?;
    /// assert!(ws.is_connected()); // Now connected
    /// # Ok(())
    /// # }
    /// ```
    fn is_connected(&self) -> bool;
}

/// Cross-platform WebSocket trait for WASM targets
///
/// This trait is the same as the native version but without `Send + Sync` bounds
/// since WASM runs in a single-threaded environment.
#[cfg(all(feature = "realtime", target_arch = "wasm32"))]
#[async_trait::async_trait(?Send)]
pub trait WebSocketConnection {
    /// Connect to a WebSocket server
    async fn connect(&mut self, url: &str) -> Result<()>;
    /// Send a text message through the WebSocket
    async fn send(&mut self, message: &str) -> Result<()>;
    /// Receive a text message from the WebSocket
    async fn receive(&mut self) -> Result<Option<String>>;
    /// Close the WebSocket connection
    async fn close(&mut self) -> Result<()>;
    /// Check if the WebSocket is currently connected
    fn is_connected(&self) -> bool;
}

/// Native WebSocket implementation using tokio-tungstenite
///
/// This implementation provides full-featured WebSocket support for native platforms
/// including automatic TLS handling, connection management, and message processing.
///
/// ## Features
///
/// - Automatic TLS/SSL support for `wss://` URLs
/// - Connection state management
/// - Proper error handling and recovery
/// - Thread-safe operations
///
/// ## Example
///
/// ```rust,ignore
/// use supabase::websocket::NativeWebSocket;
/// use supabase::websocket::WebSocketConnection;
///
/// # async fn example() -> supabase::Result<()> {
/// let mut ws = NativeWebSocket::new();
/// ws.connect("wss://echo.websocket.org").await?;
///
/// ws.send("Hello from Rust!").await?;
/// if let Some(response) = ws.receive().await? {
///     println!("Server replied: {}", response);
/// }
///
/// ws.close().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(all(feature = "realtime", not(target_arch = "wasm32")))]
pub struct NativeWebSocket {
    connection: Option<
        tokio_tungstenite::WebSocketStream<
            tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>,
        >,
    >,
    is_connected: std::sync::Arc<std::sync::atomic::AtomicBool>,
}

#[cfg(all(feature = "realtime", not(target_arch = "wasm32")))]
impl NativeWebSocket {
    /// Create a new NativeWebSocket instance
    ///
    /// # Examples
    /// ```rust,ignore
    /// use supabase::websocket::NativeWebSocket;
    ///
    /// let websocket = NativeWebSocket::new();
    /// ```
    pub fn new() -> Self {
        Self {
            connection: None,
            is_connected: std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false)),
        }
    }
}

#[cfg(all(feature = "realtime", not(target_arch = "wasm32")))]
#[async_trait::async_trait]
impl WebSocketConnection for NativeWebSocket {
    async fn connect(&mut self, url: &str) -> Result<()> {
        use std::sync::atomic::Ordering;
        use tokio_tungstenite::connect_async;

        tracing::debug!("Connecting to WebSocket: {}", url);

        let (ws_stream, _) = connect_async(url)
            .await
            .map_err(|e| Error::network(format!("WebSocket connection failed: {}", e)))?;

        self.connection = Some(ws_stream);
        self.is_connected.store(true, Ordering::SeqCst);

        tracing::info!("Connected to WebSocket successfully");
        Ok(())
    }

    async fn send(&mut self, message: &str) -> Result<()> {
        use futures_util::SinkExt;
        use tokio_tungstenite::tungstenite::Message;

        if let Some(ref mut ws) = self.connection {
            ws.send(Message::Text(message.to_string()))
                .await
                .map_err(|e| Error::network(format!("Failed to send WebSocket message: {}", e)))?;

            tracing::debug!("Sent WebSocket message: {}", message);
            Ok(())
        } else {
            Err(Error::network("WebSocket not connected"))
        }
    }

    async fn receive(&mut self) -> Result<Option<String>> {
        use futures_util::StreamExt;
        use std::sync::atomic::Ordering;
        use tokio_tungstenite::tungstenite::Message;

        if let Some(ref mut ws) = self.connection {
            match ws.next().await {
                Some(Ok(Message::Text(text))) => {
                    tracing::debug!("Received WebSocket message: {}", text);
                    Ok(Some(text))
                }
                Some(Ok(Message::Close(_))) => {
                    tracing::info!("WebSocket connection closed by remote");
                    self.is_connected.store(false, Ordering::SeqCst);
                    Ok(None)
                }
                Some(Err(e)) => {
                    tracing::error!("WebSocket error: {}", e);
                    self.is_connected.store(false, Ordering::SeqCst);
                    Err(Error::network(format!("WebSocket error: {}", e)))
                }
                None => Ok(None),
                _ => Ok(None), // Other message types (binary, ping, pong, etc.)
            }
        } else {
            Err(Error::network("WebSocket not connected"))
        }
    }

    async fn close(&mut self) -> Result<()> {
        use std::sync::atomic::Ordering;

        if let Some(ref mut ws) = self.connection {
            let _ = ws.close(None).await;
        }
        self.connection = None;
        self.is_connected.store(false, Ordering::SeqCst);

        tracing::info!("WebSocket connection closed");
        Ok(())
    }

    fn is_connected(&self) -> bool {
        use std::sync::atomic::Ordering;
        self.is_connected.load(Ordering::SeqCst)
    }
}

/// WASM WebSocket implementation using web-sys
///
/// This implementation provides WebSocket support for WASM targets using the
/// browser's native WebSocket API. Messages are queued internally and can be
/// retrieved using the `receive()` method.
///
/// ## Features
///
/// - Browser-native WebSocket support
/// - Automatic message queuing
/// - Event-driven architecture with callbacks
/// - Error handling through browser events
///
/// ## Example
///
/// ```rust,ignore
/// # #[cfg(target_arch = "wasm32")]
/// # async fn example() -> supabase::Result<()> {
/// use supabase::websocket::{WasmWebSocket, WebSocketConnection};
///
/// let mut ws = WasmWebSocket::new();
/// ws.connect("wss://echo.websocket.org").await?;
///
/// ws.send("Hello from WASM!").await?;
/// if let Some(response) = ws.receive().await? {
///     web_sys::console::log_1(&format!("Got: {}", response).into());
/// }
///
/// ws.close().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(all(feature = "realtime", target_arch = "wasm32"))]
pub struct WasmWebSocket {
    websocket: Option<web_sys::WebSocket>,
    is_connected: std::sync::Arc<std::sync::atomic::AtomicBool>,
    message_queue: std::rc::Rc<std::cell::RefCell<Vec<String>>>,
}

#[cfg(all(feature = "realtime", target_arch = "wasm32"))]
impl WasmWebSocket {
    /// Create a new WasmWebSocket instance
    ///
    /// # Examples
    /// ```rust,ignore
    /// # #[cfg(target_arch = "wasm32")]
    /// # {
    /// use supabase::websocket::WasmWebSocket;
    ///
    /// let websocket = WasmWebSocket::new();
    /// # }
    /// ```
    pub fn new() -> Self {
        Self {
            websocket: None,
            is_connected: std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false)),
            message_queue: std::rc::Rc::new(std::cell::RefCell::new(Vec::new())),
        }
    }
}

#[cfg(all(feature = "realtime", target_arch = "wasm32"))]
#[async_trait::async_trait(?Send)]
impl WebSocketConnection for WasmWebSocket {
    async fn connect(&mut self, url: &str) -> Result<()> {
        use std::sync::atomic::Ordering;
        use wasm_bindgen::{prelude::*, JsCast};
        use web_sys::{CloseEvent, ErrorEvent, MessageEvent, WebSocket};

        web_sys::console::log_1(&format!("Connecting to WebSocket: {}", url).into());

        let websocket = WebSocket::new(url)
            .map_err(|e| Error::network(format!("Failed to create WebSocket: {:?}", e)))?;

        let is_connected = std::sync::Arc::clone(&self.is_connected);
        let message_queue = std::rc::Rc::clone(&self.message_queue);

        // Setup onopen callback
        let onopen_callback = {
            let is_connected = std::sync::Arc::clone(&is_connected);
            Closure::wrap(Box::new(move |_event: web_sys::Event| {
                web_sys::console::log_1(&"WebSocket connection opened".into());
                is_connected.store(true, Ordering::SeqCst);
            }) as Box<dyn FnMut(_)>)
        };
        websocket.set_onopen(Some(onopen_callback.as_ref().unchecked_ref()));
        onopen_callback.forget();

        // Setup onmessage callback
        let onmessage_callback = {
            let message_queue = std::rc::Rc::clone(&message_queue);
            Closure::wrap(Box::new(move |event: MessageEvent| {
                if let Ok(text) = event.data().dyn_into::<js_sys::JsString>() {
                    let message = String::from(text);
                    web_sys::console::log_1(
                        &format!("Received WebSocket message: {}", message).into(),
                    );
                    message_queue.borrow_mut().push(message);
                }
            }) as Box<dyn FnMut(_)>)
        };
        websocket.set_onmessage(Some(onmessage_callback.as_ref().unchecked_ref()));
        onmessage_callback.forget();

        // Setup onerror callback
        let onerror_callback = {
            let is_connected = std::sync::Arc::clone(&is_connected);
            Closure::wrap(Box::new(move |event: ErrorEvent| {
                web_sys::console::log_1(&format!("WebSocket error: {:?}", event).into());
                is_connected.store(false, Ordering::SeqCst);
            }) as Box<dyn FnMut(_)>)
        };
        websocket.set_onerror(Some(onerror_callback.as_ref().unchecked_ref()));
        onerror_callback.forget();

        // Setup onclose callback
        let onclose_callback = {
            let is_connected = std::sync::Arc::clone(&is_connected);
            Closure::wrap(Box::new(move |event: CloseEvent| {
                web_sys::console::log_1(
                    &format!("WebSocket connection closed: {}", event.reason()).into(),
                );
                is_connected.store(false, Ordering::SeqCst);
            }) as Box<dyn FnMut(_)>)
        };
        websocket.set_onclose(Some(onclose_callback.as_ref().unchecked_ref()));
        onclose_callback.forget();

        self.websocket = Some(websocket);

        // Wait for connection to open (with timeout)
        let start_time = js_sys::Date::now();
        let timeout_ms = 5000.0; // 5 second timeout

        while !self.is_connected.load(Ordering::SeqCst)
            && (js_sys::Date::now() - start_time) < timeout_ms
        {
            // Simple delay using Promise
            let promise = js_sys::Promise::resolve(&wasm_bindgen::JsValue::NULL);
            wasm_bindgen_futures::JsFuture::from(promise)
                .await
                .map_err(|e| Error::network(format!("Promise error: {:?}", e)))?;

            // Add a small delay
            let delay_promise = js_sys::Promise::new(&mut |resolve, _| {
                web_sys::window()
                    .unwrap()
                    .set_timeout_with_callback_and_timeout_and_arguments_0(&resolve, 10)
                    .unwrap();
            });
            wasm_bindgen_futures::JsFuture::from(delay_promise)
                .await
                .map_err(|e| Error::network(format!("Timeout error: {:?}", e)))?;
        }

        if !self.is_connected.load(Ordering::SeqCst) {
            return Err(Error::network("WebSocket connection timeout"));
        }

        web_sys::console::log_1(&"WebSocket connected successfully".into());
        Ok(())
    }

    async fn send(&mut self, message: &str) -> Result<()> {
        if let Some(ref websocket) = self.websocket {
            websocket.send_with_str(message).map_err(|e| {
                Error::network(format!("Failed to send WebSocket message: {:?}", e))
            })?;

            web_sys::console::log_1(&format!("Sent WebSocket message: {}", message).into());
            Ok(())
        } else {
            Err(Error::network("WebSocket not connected"))
        }
    }

    async fn receive(&mut self) -> Result<Option<String>> {
        let mut queue = self.message_queue.borrow_mut();
        if !queue.is_empty() {
            Ok(Some(queue.remove(0)))
        } else {
            Ok(None)
        }
    }

    async fn close(&mut self) -> Result<()> {
        use std::sync::atomic::Ordering;

        if let Some(ref websocket) = self.websocket {
            websocket.close().ok();
        }
        self.websocket = None;
        self.is_connected.store(false, Ordering::SeqCst);
        self.message_queue.borrow_mut().clear();

        web_sys::console::log_1(&"WebSocket connection closed".into());
        Ok(())
    }

    fn is_connected(&self) -> bool {
        use std::sync::atomic::Ordering;
        self.is_connected.load(Ordering::SeqCst)
    }
}

/// Factory function to create appropriate WebSocket implementation
///
/// This function automatically creates the correct WebSocket implementation
/// based on the target platform:
///
/// - **Native targets**: Returns `NativeWebSocket`
/// - **WASM targets**: Returns `WasmWebSocket`
///
/// # Examples
///
/// ```rust,ignore
/// use supabase::websocket::{create_websocket, WebSocketConnection};
///
/// # async fn example() -> supabase::Result<()> {
/// // Automatically creates the right WebSocket for your platform
/// let mut ws = create_websocket();
/// ws.connect("wss://echo.websocket.org").await?;
///
/// // Works the same on both native and WASM
/// ws.send("Hello!").await?;
/// if let Some(msg) = ws.receive().await? {
///     println!("Received: {}", msg); // Native
///     // web_sys::console::log_1(&msg.into()); // WASM
/// }
///
/// ws.close().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "realtime")]
pub fn create_websocket() -> Box<dyn WebSocketConnection> {
    #[cfg(not(target_arch = "wasm32"))]
    {
        Box::new(NativeWebSocket::new())
    }

    #[cfg(target_arch = "wasm32")]
    {
        Box::new(WasmWebSocket::new())
    }
}

#[cfg(all(test, feature = "realtime"))]
mod tests {
    use super::*;

    #[cfg(not(target_arch = "wasm32"))]
    #[test]
    fn test_native_websocket_creation() {
        let ws = NativeWebSocket::new();
        assert!(!ws.is_connected());
    }

    #[cfg(target_arch = "wasm32")]
    #[test]
    fn test_wasm_websocket_creation() {
        let ws = WasmWebSocket::new();
        assert!(!ws.is_connected());
    }

    #[test]
    fn test_create_websocket() {
        let ws = create_websocket();
        assert!(!ws.is_connected());
    }

    #[cfg(not(target_arch = "wasm32"))]
    #[tokio::test]
    async fn test_websocket_error_handling() {
        let mut ws = NativeWebSocket::new();

        // Should fail when not connected
        let result = ws.send("test").await;
        assert!(result.is_err());

        let result = ws.receive().await;
        assert!(result.is_err());
    }

    #[cfg(target_arch = "wasm32")]
    #[wasm_bindgen_test::wasm_bindgen_test]
    async fn test_wasm_websocket_error_handling() {
        let mut ws = WasmWebSocket::new();

        // Should fail when not connected
        let result = ws.send("test").await;
        assert!(result.is_err());

        // Should return None when no messages
        let result = ws.receive().await;
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), None);
    }

    #[cfg(not(target_arch = "wasm32"))]
    #[tokio::test]
    async fn test_websocket_state_management() {
        let mut ws = NativeWebSocket::new();
        assert!(!ws.is_connected());

        // After close, should not be connected
        ws.close().await.unwrap();
        assert!(!ws.is_connected());
    }
}