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
//! Error handling for the Supabase client

use std::collections::HashMap;
use thiserror::Error;

/// Result type alias for Supabase operations
#[allow(clippy::result_large_err)]
pub type Result<T> = std::result::Result<T, Error>;

/// Platform-specific error context
#[derive(Debug, Clone)]
pub enum PlatformContext {
    /// Native platform (tokio runtime)
    Native {
        /// Operating system information
        os_info: Option<String>,
        /// Available system resources
        system_resources: Option<String>,
    },
    /// WebAssembly platform
    Wasm {
        /// Browser information
        user_agent: Option<String>,
        /// Available Web APIs
        available_apis: Vec<String>,
        /// CORS status
        cors_enabled: bool,
    },
}

/// HTTP error details
#[derive(Debug, Clone)]
pub struct HttpErrorContext {
    /// HTTP status code
    pub status_code: Option<u16>,
    /// Response headers
    pub headers: Option<HashMap<String, String>>,
    /// Response body (if available)
    pub response_body: Option<String>,
    /// Request URL
    pub url: Option<String>,
    /// Request method
    pub method: Option<String>,
}

/// Retry information for failed requests
#[derive(Debug, Clone)]
pub struct RetryInfo {
    /// Number of attempts made
    pub attempts: u32,
    /// Whether the error is retryable
    pub retryable: bool,
    /// Suggested retry delay in seconds
    pub retry_after: Option<u64>,
}

/// Enhanced error context
#[derive(Debug, Clone)]
pub struct ErrorContext {
    /// Platform-specific context
    pub platform: Option<PlatformContext>,
    /// HTTP error details
    pub http: Option<HttpErrorContext>,
    /// Retry information
    pub retry: Option<RetryInfo>,
    /// Additional metadata
    pub metadata: HashMap<String, String>,
    /// Error timestamp
    pub timestamp: chrono::DateTime<chrono::Utc>,
}

impl Default for ErrorContext {
    fn default() -> Self {
        Self {
            platform: None,
            http: None,
            retry: None,
            metadata: HashMap::new(),
            timestamp: chrono::Utc::now(),
        }
    }
}

/// Main error type for Supabase operations
#[derive(Error, Debug)]
pub enum Error {
    /// HTTP request errors with enhanced context
    #[error("HTTP request failed: {message}")]
    Http {
        message: String,
        #[source]
        source: Option<reqwest::Error>,
        context: ErrorContext,
    },

    /// JSON serialization/deserialization errors
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    /// URL parsing errors
    #[error("URL parse error: {0}")]
    UrlParse(#[from] url::ParseError),

    /// JWT token errors
    #[cfg(feature = "auth")]
    #[error("JWT error: {0}")]
    Jwt(#[from] jsonwebtoken::errors::Error),

    /// Authentication errors with enhanced context
    #[error("Authentication error: {message}")]
    Auth {
        message: String,
        context: ErrorContext,
    },

    /// Database operation errors with enhanced context
    #[error("Database error: {message}")]
    Database {
        message: String,
        context: ErrorContext,
    },

    /// Storage operation errors with enhanced context
    #[error("Storage error: {message}")]
    Storage {
        message: String,
        context: ErrorContext,
    },

    /// Realtime connection errors with enhanced context
    #[error("Realtime error: {message}")]
    Realtime {
        message: String,
        context: ErrorContext,
    },

    /// Configuration errors
    #[error("Configuration error: {message}")]
    Config { message: String },

    /// Invalid input errors
    #[error("Invalid input: {message}")]
    InvalidInput { message: String },

    /// Network errors with enhanced context
    #[error("Network error: {message}")]
    Network {
        message: String,
        context: ErrorContext,
    },

    /// Rate limiting errors with retry information
    #[error("Rate limit exceeded: {message}")]
    RateLimit {
        message: String,
        context: ErrorContext,
    },

    /// Permission denied errors with enhanced context
    #[error("Permission denied: {message}")]
    PermissionDenied {
        message: String,
        context: ErrorContext,
    },

    /// Resource not found errors with enhanced context
    #[error("Not found: {message}")]
    NotFound {
        message: String,
        context: ErrorContext,
    },

    /// Generic errors
    #[error("{message}")]
    Generic { message: String },

    /// Functions errors with enhanced context
    #[error("Functions error: {message}")]
    Functions {
        message: String,
        context: ErrorContext,
    },

    /// Platform-specific error
    #[error("Platform error: {message}")]
    Platform {
        message: String,
        context: ErrorContext,
    },

    /// Cryptographic error
    #[error("Crypto error: {message}")]
    Crypto {
        message: String,
        context: ErrorContext,
    },
}

impl Error {
    /// Create an authentication error with enhanced context
    pub fn auth<S: Into<String>>(message: S) -> Self {
        Self::Auth {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create an authentication error with custom context
    pub fn auth_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Auth {
            message: message.into(),
            context,
        }
    }

    /// Create a database error with enhanced context
    pub fn database<S: Into<String>>(message: S) -> Self {
        Self::Database {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a database error with custom context
    pub fn database_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Database {
            message: message.into(),
            context,
        }
    }

    /// Create a storage error with enhanced context
    pub fn storage<S: Into<String>>(message: S) -> Self {
        Self::Storage {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a storage error with custom context
    pub fn storage_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Storage {
            message: message.into(),
            context,
        }
    }

    /// Create a realtime error with enhanced context
    pub fn realtime<S: Into<String>>(message: S) -> Self {
        Self::Realtime {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a realtime error with custom context
    pub fn realtime_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Realtime {
            message: message.into(),
            context,
        }
    }

    /// Create a functions error with enhanced context
    pub fn functions<S: Into<String>>(message: S) -> Self {
        Self::Functions {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a functions error with custom context
    pub fn functions_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Functions {
            message: message.into(),
            context,
        }
    }

    /// Create a network error with enhanced context
    pub fn network<S: Into<String>>(message: S) -> Self {
        Self::Network {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a rate limit error with retry information
    pub fn rate_limit<S: Into<String>>(message: S, retry_after: Option<u64>) -> Self {
        let context = ErrorContext {
            retry: Some(RetryInfo {
                attempts: 0,
                retryable: true,
                retry_after,
            }),
            ..Default::default()
        };

        Self::RateLimit {
            message: message.into(),
            context,
        }
    }

    /// Create a permission denied error with enhanced context
    pub fn permission_denied<S: Into<String>>(message: S) -> Self {
        Self::PermissionDenied {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a not found error with enhanced context
    pub fn not_found<S: Into<String>>(message: S) -> Self {
        Self::NotFound {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a configuration error
    pub fn config<S: Into<String>>(message: S) -> Self {
        Self::Config {
            message: message.into(),
        }
    }

    /// Create an invalid input error
    pub fn invalid_input<S: Into<String>>(message: S) -> Self {
        Self::InvalidInput {
            message: message.into(),
        }
    }

    /// Create a generic error
    pub fn generic<S: Into<String>>(message: S) -> Self {
        Self::Generic {
            message: message.into(),
        }
    }

    /// Get error context if available
    pub fn context(&self) -> Option<&ErrorContext> {
        match self {
            Error::Http { context, .. } => Some(context),
            Error::Auth { context, .. } => Some(context),
            Error::Database { context, .. } => Some(context),
            Error::Storage { context, .. } => Some(context),
            Error::Realtime { context, .. } => Some(context),
            Error::Network { context, .. } => Some(context),
            Error::RateLimit { context, .. } => Some(context),
            Error::PermissionDenied { context, .. } => Some(context),
            Error::NotFound { context, .. } => Some(context),
            Error::Functions { context, .. } => Some(context),
            _ => None,
        }
    }

    /// Check if error is retryable
    pub fn is_retryable(&self) -> bool {
        self.context()
            .and_then(|ctx| ctx.retry.as_ref())
            .map(|retry| retry.retryable)
            .unwrap_or(false)
    }

    /// Get retry delay in seconds
    pub fn retry_after(&self) -> Option<u64> {
        self.context()
            .and_then(|ctx| ctx.retry.as_ref())
            .and_then(|retry| retry.retry_after)
    }

    /// Get HTTP status code if available
    pub fn status_code(&self) -> Option<u16> {
        self.context()
            .and_then(|ctx| ctx.http.as_ref())
            .and_then(|http| http.status_code)
    }

    /// Create a platform error
    pub fn platform<S: Into<String>>(message: S) -> Self {
        Self::Platform {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a platform error with context
    pub fn platform_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Platform {
            message: message.into(),
            context,
        }
    }

    /// Create a cryptographic error
    pub fn crypto<S: Into<String>>(message: S) -> Self {
        Self::Crypto {
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    /// Create a cryptographic error with context
    pub fn crypto_with_context<S: Into<String>>(message: S, context: ErrorContext) -> Self {
        Self::Crypto {
            message: message.into(),
            context,
        }
    }
}

/// Detect current platform context
pub fn detect_platform_context() -> PlatformContext {
    #[cfg(all(target_arch = "wasm32", feature = "wasm"))]
    {
        PlatformContext::Wasm {
            user_agent: web_sys::window().and_then(|window| window.navigator().user_agent().ok()),
            available_apis: detect_available_web_apis(),
            cors_enabled: true, // Assume CORS is enabled for simplicity
        }
    }

    #[cfg(all(target_arch = "wasm32", not(feature = "wasm")))]
    {
        PlatformContext::Wasm {
            user_agent: None,
            available_apis: Vec::new(),
            cors_enabled: true,
        }
    }

    #[cfg(not(target_arch = "wasm32"))]
    {
        PlatformContext::Native {
            os_info: Some(format!(
                "{} {}",
                std::env::consts::OS,
                std::env::consts::ARCH
            )),
            system_resources: None, // Could be enhanced with system info
        }
    }
}

/// Detect available Web APIs in WASM environment
#[cfg(all(target_arch = "wasm32", feature = "wasm"))]
#[allow(dead_code)]
fn detect_available_web_apis() -> Vec<String> {
    let mut apis = Vec::new();

    if let Some(window) = web_sys::window() {
        // Check for common Web APIs
        if window.local_storage().is_ok() {
            apis.push("localStorage".to_string());
        }
        if window.session_storage().is_ok() {
            apis.push("sessionStorage".to_string());
        }
        apis.push("fetch".to_string()); // Fetch API is generally available
    }

    apis
}

#[cfg(not(target_arch = "wasm32"))]
#[allow(dead_code)]
fn detect_available_web_apis() -> Vec<String> {
    Vec::new()
}

impl From<reqwest::Error> for Error {
    fn from(err: reqwest::Error) -> Self {
        let mut context = ErrorContext::default();

        // Add HTTP context if available
        if let Some(status) = err.status() {
            context.http = Some(HttpErrorContext {
                status_code: Some(status.as_u16()),
                headers: None,
                response_body: None,
                url: err.url().map(|u| u.to_string()),
                method: None,
            });

            // Determine if error is retryable
            let retryable = match status.as_u16() {
                500..=599 | 429 | 408 => true, // Server errors, rate limit, timeout
                _ => false,
            };

            context.retry = Some(RetryInfo {
                attempts: 0,
                retryable,
                retry_after: None,
            });
        }

        // Add platform context
        context.platform = Some(detect_platform_context());

        Error::Http {
            message: err.to_string(),
            source: Some(err),
            context,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_error_creation() {
        let error = Error::auth("test message");
        assert_eq!(error.to_string(), "Authentication error: test message");
    }

    #[test]
    fn test_database_error() {
        let error = Error::database("query failed");
        assert_eq!(error.to_string(), "Database error: query failed");
    }

    #[test]
    fn test_error_context() {
        let error = Error::auth("test message");
        assert!(error.context().is_some());
        if let Some(context) = error.context() {
            assert!(context.timestamp <= chrono::Utc::now());
        }
    }
}