pywatt_sdk 0.5.3

Standardized SDK for building PyWatt modules in Rust
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
597
598
599
600
use async_trait::async_trait;
#[cfg(not(feature = "integration_tests"))]
use sqlx::Sqlite;
use sqlx::{Row, SqlitePool, sqlite::SqlitePoolOptions};
use std::path::Path;
use std::sync::Arc;
use std::time::Duration;

use crate::data::database::{
    DatabaseConfig, DatabaseConnection, DatabaseError, DatabaseResult, DatabaseRow,
    DatabaseTransaction, DatabaseType, DatabaseValue,
};

/// SQLite implementation of the database connection interface
pub struct SqliteConnection {
    pool: Arc<SqlitePool>,
}

impl SqliteConnection {
    /// Create a new SQLite connection from a configuration
    pub async fn connect(config: &DatabaseConfig) -> DatabaseResult<Self> {
        let database_url = build_sqlite_connection_string(config)?;

        // Ensure the directory exists if file-based
        if config.database != ":memory:" && !config.database.starts_with("file:") {
            if let Some(parent) = Path::new(&config.database).parent() {
                std::fs::create_dir_all(parent).map_err(|e| {
                    DatabaseError::Connection(format!(
                        "Failed to create directory for SQLite database: {}",
                        e
                    ))
                })?;
            }
        }

        let pool_options = SqlitePoolOptions::new()
            .max_connections(config.pool.max_connections)
            .min_connections(config.pool.min_connections)
            .idle_timeout(Duration::from_secs(config.pool.idle_timeout_seconds))
            .max_lifetime(Duration::from_secs(config.pool.max_lifetime_seconds))
            .acquire_timeout(Duration::from_secs(config.pool.acquire_timeout_seconds));

        let pool = pool_options
            .connect(&database_url)
            .await
            .map_err(|e| DatabaseError::Connection(e.to_string()))?;

        // Enable foreign keys by default
        sqlx::query("PRAGMA foreign_keys = ON;")
            .execute(&pool)
            .await
            .map_err(|e| {
                DatabaseError::Configuration(format!("Failed to enable foreign keys: {}", e))
            })?;

        Ok(Self {
            pool: Arc::new(pool),
        })
    }
}

/// Convert a DatabaseConfig to a SQLite connection string
fn build_sqlite_connection_string(config: &DatabaseConfig) -> DatabaseResult<String> {
    let database = &config.database;

    // Create a connection string
    // In SQLite, the database is a file path or a special name like ":memory:"
    let mut connection_string = if database == ":memory:" {
        // SQLite in-memory database needs special syntax
        "sqlite::memory:".to_string()
    } else {
        // Normal file paths
        format!("sqlite:{}", database)
    };

    // Add any extra parameters
    let mut param_added = false;
    for (key, value) in &config.extra_params {
        if !param_added {
            connection_string.push('?');
            param_added = true;
        } else {
            connection_string.push('&');
        }
        connection_string.push_str(&format!("{}={}", key, value));
    }

    Ok(connection_string)
}

// Note: SQLite adapter doesn't use parameter binding like this anymore
// The function is kept for potential future implementation
// The current implementation directly uses the query methods without parameters
fn _convert_params(_params: &[DatabaseValue]) -> Vec<sqlx::sqlite::SqliteArguments<'_>> {
    // This function is not used anymore as newer SQLite versions
    // handle parameters differently
    vec![]
}

/// SQLite implementation of the database row interface
pub struct SqliteRow {
    row: sqlx::sqlite::SqliteRow,
}

impl DatabaseRow for SqliteRow {
    fn get_string(&self, column: &str) -> DatabaseResult<String> {
        self.row.try_get(column).map_err(|e| {
            DatabaseError::Query(format!("Failed to get string column {}: {}", column, e))
        })
    }

    fn get_i64(&self, column: &str) -> DatabaseResult<i64> {
        self.row.try_get(column).map_err(|e| {
            DatabaseError::Query(format!("Failed to get i64 column {}: {}", column, e))
        })
    }

    fn get_f64(&self, column: &str) -> DatabaseResult<f64> {
        self.row.try_get(column).map_err(|e| {
            DatabaseError::Query(format!("Failed to get f64 column {}: {}", column, e))
        })
    }

    fn get_bool(&self, column: &str) -> DatabaseResult<bool> {
        self.row.try_get(column).map_err(|e| {
            DatabaseError::Query(format!("Failed to get bool column {}: {}", column, e))
        })
    }

    fn get_bytes(&self, column: &str) -> DatabaseResult<Vec<u8>> {
        self.row.try_get(column).map_err(|e| {
            DatabaseError::Query(format!("Failed to get bytes column {}: {}", column, e))
        })
    }

    fn try_get_string(&self, column: &str) -> DatabaseResult<Option<String>> {
        match self.row.try_get(column) {
            Ok(value) => Ok(Some(value)),
            Err(sqlx::Error::ColumnNotFound(_)) => Ok(None),
            Err(sqlx::Error::TypeNotFound { .. }) => Ok(None),
            Err(e) => Err(DatabaseError::Query(format!(
                "Failed to get string column {}: {}",
                column, e
            ))),
        }
    }

    fn try_get_i64(&self, column: &str) -> DatabaseResult<Option<i64>> {
        match self.row.try_get(column) {
            Ok(value) => Ok(Some(value)),
            Err(sqlx::Error::ColumnNotFound(_)) => Ok(None),
            Err(sqlx::Error::TypeNotFound { .. }) => Ok(None),
            Err(e) => Err(DatabaseError::Query(format!(
                "Failed to get i64 column {}: {}",
                column, e
            ))),
        }
    }

    fn try_get_f64(&self, column: &str) -> DatabaseResult<Option<f64>> {
        match self.row.try_get(column) {
            Ok(value) => Ok(Some(value)),
            Err(sqlx::Error::ColumnNotFound(_)) => Ok(None),
            Err(sqlx::Error::TypeNotFound { .. }) => Ok(None),
            Err(e) => Err(DatabaseError::Query(format!(
                "Failed to get f64 column {}: {}",
                column, e
            ))),
        }
    }

    fn try_get_bool(&self, column: &str) -> DatabaseResult<Option<bool>> {
        match self.row.try_get(column) {
            Ok(value) => Ok(Some(value)),
            Err(sqlx::Error::ColumnNotFound(_)) => Ok(None),
            Err(sqlx::Error::TypeNotFound { .. }) => Ok(None),
            Err(e) => Err(DatabaseError::Query(format!(
                "Failed to get bool column {}: {}",
                column, e
            ))),
        }
    }

    fn try_get_bytes(&self, column: &str) -> DatabaseResult<Option<Vec<u8>>> {
        match self.row.try_get(column) {
            Ok(value) => Ok(Some(value)),
            Err(sqlx::Error::ColumnNotFound(_)) => Ok(None),
            Err(sqlx::Error::TypeNotFound { .. }) => Ok(None),
            Err(e) => Err(DatabaseError::Query(format!(
                "Failed to get bytes column {}: {}",
                column, e
            ))),
        }
    }
}

// Define separate transaction implementations for regular use and integration tests
#[cfg(not(feature = "integration_tests"))]
mod transaction_impl {
    use super::*;

    /// SQLite implementation of the database transaction interface
    pub struct SqliteTransaction {
        // Normal implementation - keep a real SQLite transaction
        pub(crate) transaction: sqlx::Transaction<'static, Sqlite>,
    }

    // Declare SqliteTransaction as Send + Sync
    // This is safe because we properly manage access to transaction
    unsafe impl Send for SqliteTransaction {}
    unsafe impl Sync for SqliteTransaction {}

    #[async_trait]
    impl DatabaseTransaction for SqliteTransaction {
        async fn execute(&mut self, query: &str, params: &[DatabaseValue]) -> DatabaseResult<u64> {
            // Build a query with proper parameter binding
            let mut query_builder = sqlx::query(query);

            // Add parameters
            for param in params {
                match param {
                    DatabaseValue::Null => {
                        query_builder = query_builder.bind(None::<String>);
                    }
                    DatabaseValue::Boolean(b) => {
                        query_builder = query_builder.bind(b);
                    }
                    DatabaseValue::Integer(i) => {
                        query_builder = query_builder.bind(i);
                    }
                    DatabaseValue::Float(f) => {
                        query_builder = query_builder.bind(f);
                    }
                    DatabaseValue::Text(s) => {
                        query_builder = query_builder.bind(s);
                    }
                    DatabaseValue::Blob(b) => {
                        query_builder = query_builder.bind(b.clone());
                    }
                    DatabaseValue::Array(_) => {
                        // SQLite doesn't have array type, return error
                        return Err(DatabaseError::Query(
                            "SQLite doesn't support array parameters".to_string(),
                        ));
                    }
                }
            }

            // Execute with parameters
            let result = query_builder
                .execute(self.transaction.as_mut())
                .await
                .map_err(|e| DatabaseError::Query(e.to_string()))?;

            Ok(result.rows_affected())
        }

        async fn query(
            &mut self,
            query: &str,
            params: &[DatabaseValue],
        ) -> DatabaseResult<Vec<Box<dyn DatabaseRow>>> {
            // Build a query with proper parameter binding
            let mut query_builder = sqlx::query(query);

            // Add parameters
            for param in params {
                match param {
                    DatabaseValue::Null => {
                        query_builder = query_builder.bind(None::<String>);
                    }
                    DatabaseValue::Boolean(b) => {
                        query_builder = query_builder.bind(b);
                    }
                    DatabaseValue::Integer(i) => {
                        query_builder = query_builder.bind(i);
                    }
                    DatabaseValue::Float(f) => {
                        query_builder = query_builder.bind(f);
                    }
                    DatabaseValue::Text(s) => {
                        query_builder = query_builder.bind(s);
                    }
                    DatabaseValue::Blob(b) => {
                        query_builder = query_builder.bind(b.clone());
                    }
                    DatabaseValue::Array(_) => {
                        // SQLite doesn't have array type, return error
                        return Err(DatabaseError::Query(
                            "SQLite doesn't support array parameters".to_string(),
                        ));
                    }
                }
            }

            // Execute with parameters
            let rows = query_builder
                .fetch_all(self.transaction.as_mut())
                .await
                .map_err(|e| DatabaseError::Query(e.to_string()))?;

            Ok(rows
                .into_iter()
                .map(|row| Box::new(SqliteRow { row }) as Box<dyn DatabaseRow>)
                .collect())
        }

        async fn query_one(
            &mut self,
            query: &str,
            params: &[DatabaseValue],
        ) -> DatabaseResult<Option<Box<dyn DatabaseRow>>> {
            // Build a query with proper parameter binding
            let mut query_builder = sqlx::query(query);

            // Add parameters
            for param in params {
                match param {
                    DatabaseValue::Null => {
                        query_builder = query_builder.bind(None::<String>);
                    }
                    DatabaseValue::Boolean(b) => {
                        query_builder = query_builder.bind(b);
                    }
                    DatabaseValue::Integer(i) => {
                        query_builder = query_builder.bind(i);
                    }
                    DatabaseValue::Float(f) => {
                        query_builder = query_builder.bind(f);
                    }
                    DatabaseValue::Text(s) => {
                        query_builder = query_builder.bind(s);
                    }
                    DatabaseValue::Blob(b) => {
                        query_builder = query_builder.bind(b.clone());
                    }
                    DatabaseValue::Array(_) => {
                        // SQLite doesn't have array type, return error
                        return Err(DatabaseError::Query(
                            "SQLite doesn't support array parameters".to_string(),
                        ));
                    }
                }
            }

            // Execute with parameters
            let row = query_builder
                .fetch_optional(self.transaction.as_mut())
                .await
                .map_err(|e| DatabaseError::Query(e.to_string()))?;

            Ok(row.map(|r| Box::new(SqliteRow { row: r }) as Box<dyn DatabaseRow>))
        }

        async fn commit(self: Box<Self>) -> DatabaseResult<()> {
            self.transaction.commit().await.map_err(|e| {
                DatabaseError::Transaction(format!("Failed to commit transaction: {}", e))
            })
        }

        async fn rollback(self: Box<Self>) -> DatabaseResult<()> {
            self.transaction.rollback().await.map_err(|e| {
                DatabaseError::Transaction(format!("Failed to rollback transaction: {}", e))
            })
        }
    }
}

// For integration tests, provide a mock implementation that delegates to the connection
#[cfg(feature = "integration_tests")]
mod transaction_impl {
    use super::*;

    /// Mock SQLite transaction for integration tests
    pub struct SqliteTransaction {
        /// Store the connection to delegate operations to
        pub(crate) connection: Arc<SqliteConnection>,
    }

    #[async_trait]
    impl DatabaseTransaction for SqliteTransaction {
        async fn execute(&mut self, query: &str, params: &[DatabaseValue]) -> DatabaseResult<u64> {
            // Simply delegate to the connection
            self.connection.execute(query, params).await
        }

        async fn query(
            &mut self,
            query: &str,
            params: &[DatabaseValue],
        ) -> DatabaseResult<Vec<Box<dyn DatabaseRow>>> {
            // Simply delegate to the connection
            self.connection.query(query, params).await
        }

        async fn query_one(
            &mut self,
            query: &str,
            params: &[DatabaseValue],
        ) -> DatabaseResult<Option<Box<dyn DatabaseRow>>> {
            // Simply delegate to the connection
            self.connection.query_one(query, params).await
        }

        async fn commit(self: Box<Self>) -> DatabaseResult<()> {
            // No-op for integration tests
            Ok(())
        }

        async fn rollback(self: Box<Self>) -> DatabaseResult<()> {
            // No-op for integration tests
            Ok(())
        }
    }
}

// Re-export the implementation
pub use transaction_impl::SqliteTransaction;

#[async_trait]
impl DatabaseConnection for SqliteConnection {
    async fn execute(&self, query: &str, params: &[DatabaseValue]) -> DatabaseResult<u64> {
        // Build a query with proper parameter binding
        let mut query_builder = sqlx::query(query);

        // Add parameters
        for param in params {
            match param {
                DatabaseValue::Null => {
                    query_builder = query_builder.bind(None::<String>);
                }
                DatabaseValue::Boolean(b) => {
                    query_builder = query_builder.bind(b);
                }
                DatabaseValue::Integer(i) => {
                    query_builder = query_builder.bind(i);
                }
                DatabaseValue::Float(f) => {
                    query_builder = query_builder.bind(f);
                }
                DatabaseValue::Text(s) => {
                    query_builder = query_builder.bind(s);
                }
                DatabaseValue::Blob(b) => {
                    query_builder = query_builder.bind(b.clone());
                }
                DatabaseValue::Array(_) => {
                    // SQLite doesn't have array type, return error
                    return Err(DatabaseError::Query(
                        "SQLite doesn't support array parameters".to_string(),
                    ));
                }
            }
        }

        // Execute with parameters
        let result = query_builder
            .execute(&*self.pool)
            .await
            .map_err(|e| DatabaseError::Query(e.to_string()))?;

        Ok(result.rows_affected())
    }

    async fn query(
        &self,
        query: &str,
        params: &[DatabaseValue],
    ) -> DatabaseResult<Vec<Box<dyn DatabaseRow>>> {
        // Build a query with proper parameter binding
        let mut query_builder = sqlx::query(query);

        // Add parameters
        for param in params {
            match param {
                DatabaseValue::Null => {
                    query_builder = query_builder.bind(None::<String>);
                }
                DatabaseValue::Boolean(b) => {
                    query_builder = query_builder.bind(b);
                }
                DatabaseValue::Integer(i) => {
                    query_builder = query_builder.bind(i);
                }
                DatabaseValue::Float(f) => {
                    query_builder = query_builder.bind(f);
                }
                DatabaseValue::Text(s) => {
                    query_builder = query_builder.bind(s);
                }
                DatabaseValue::Blob(b) => {
                    query_builder = query_builder.bind(b.clone());
                }
                DatabaseValue::Array(_) => {
                    // SQLite doesn't have array type, return error
                    return Err(DatabaseError::Query(
                        "SQLite doesn't support array parameters".to_string(),
                    ));
                }
            }
        }

        // Execute with parameters
        let rows = query_builder
            .fetch_all(&*self.pool)
            .await
            .map_err(|e| DatabaseError::Query(e.to_string()))?;

        Ok(rows
            .into_iter()
            .map(|row| Box::new(SqliteRow { row }) as Box<dyn DatabaseRow>)
            .collect())
    }

    async fn query_one(
        &self,
        query: &str,
        params: &[DatabaseValue],
    ) -> DatabaseResult<Option<Box<dyn DatabaseRow>>> {
        // Build a query with proper parameter binding
        let mut query_builder = sqlx::query(query);

        // Add parameters
        for param in params {
            match param {
                DatabaseValue::Null => {
                    query_builder = query_builder.bind(None::<String>);
                }
                DatabaseValue::Boolean(b) => {
                    query_builder = query_builder.bind(b);
                }
                DatabaseValue::Integer(i) => {
                    query_builder = query_builder.bind(i);
                }
                DatabaseValue::Float(f) => {
                    query_builder = query_builder.bind(f);
                }
                DatabaseValue::Text(s) => {
                    query_builder = query_builder.bind(s);
                }
                DatabaseValue::Blob(b) => {
                    query_builder = query_builder.bind(b.clone());
                }
                DatabaseValue::Array(_) => {
                    // SQLite doesn't have array type, return error
                    return Err(DatabaseError::Query(
                        "SQLite doesn't support array parameters".to_string(),
                    ));
                }
            }
        }

        // Execute with parameters
        let row = query_builder
            .fetch_optional(&*self.pool)
            .await
            .map_err(|e| DatabaseError::Query(e.to_string()))?;

        Ok(row.map(|r| Box::new(SqliteRow { row: r }) as Box<dyn DatabaseRow>))
    }

    async fn begin_transaction(&self) -> DatabaseResult<Box<dyn DatabaseTransaction>> {
        #[cfg(not(feature = "integration_tests"))]
        {
            let transaction = self.pool.begin().await.map_err(|e| {
                DatabaseError::Transaction(format!("Failed to begin transaction: {}", e))
            })?;

            Ok(Box::new(SqliteTransaction { transaction }) as Box<dyn DatabaseTransaction>)
        }

        #[cfg(feature = "integration_tests")]
        {
            // For integration tests, return a mock transaction that delegates to the connection
            Ok(Box::new(SqliteTransaction {
                connection: Arc::new(Self {
                    pool: Arc::clone(&self.pool),
                }),
            }) as Box<dyn DatabaseTransaction>)
        }
    }

    fn get_database_type(&self) -> DatabaseType {
        DatabaseType::Sqlite
    }

    async fn ping(&self) -> DatabaseResult<()> {
        sqlx::query("SELECT 1")
            .execute(&*self.pool)
            .await
            .map_err(|e| DatabaseError::Connection(format!("Failed to ping database: {}", e)))?;

        Ok(())
    }

    async fn close(&self) -> DatabaseResult<()> {
        self.pool.close().await;
        Ok(())
    }
}