musq 0.0.4

Musq is an asynchronous SQLite toolkit for 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
//! Integration tests for musq.

mod support;

#[cfg(test)]
mod tests {
    use std::result::Result as StdResult;

    use musq::{
        Error, Result as MusqResult, Value, Values, encode::Encode, error::EncodeError, sql,
        sql_as, values,
    };

    use crate::support::connection;

    #[derive(musq::FromRow, Debug, PartialEq)]
    struct User {
        id: i32,
        name: String,
        status: String,
        last_login: String,
    }

    #[tokio::test]
    async fn dynamic_values_workflow() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!(
            "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, status TEXT, last_login TEXT)"
        )?
        .execute(&conn)
        .await?;

        let data: Values =
            values! { "id": 1, "name": "Alice", "status": "active", "last_login": "now" }?;
        sql!("INSERT INTO users {insert:data}")?
            .execute(&conn)
            .await?;

        let mut changes = Values::new();
        changes.insert("name", "Alicia")?;
        changes.insert("status", "inactive")?;
        sql!("UPDATE users SET {set:changes} WHERE id = 1")?
            .execute(&conn)
            .await?;

        let filters: Values = values! { "status": "inactive" }?;
        let user: User =
            sql_as!("SELECT id, name, status, last_login FROM users WHERE {where:filters}")?
                .fetch_one(&conn)
                .await?;
        assert_eq!(user.name, "Alicia");

        let upsert: Values =
            values! { "id": 1, "name": "Alicia", "status": "active", "last_login": "later" }?;
        sql!(
            "INSERT INTO users {insert:upsert} ON CONFLICT(id) DO UPDATE SET {upsert:upsert, exclude: id}"
        )?
        .execute(&conn)
        .await?;

        let user: User = sql_as!("SELECT id, name, status, last_login FROM users WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(user.status, "active");
        assert_eq!(user.last_login, "later");
        Ok(())
    }

    #[tokio::test]
    async fn fluent_builder_insert() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE fb (id INTEGER PRIMARY KEY, name TEXT)")?
            .execute(&conn)
            .await?;

        let vals = Values::new().val("id", 1)?.val("name", "Bob")?;
        sql!("INSERT INTO fb {insert:vals}")?.execute(&conn).await?;

        let row: (i32, String) = sql_as!("SELECT id, name FROM fb")?.fetch_one(&conn).await?;
        assert_eq!(row, (1, "Bob".into()));
        Ok(())
    }

    #[tokio::test]
    async fn where_and_empty_returns_all() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE wa (id INTEGER)")?.execute(&conn).await?;
        for i in 0..3 {
            sql!("INSERT INTO wa VALUES ({})", i)?
                .execute(&conn)
                .await?;
        }
        let empty = Values::new();
        let rows: Vec<(i32,)> = sql_as!("SELECT id FROM wa WHERE {where:empty}")?
            .fetch_all(&conn)
            .await?;
        assert_eq!(rows.len(), 3);
        Ok(())
    }

    #[tokio::test]
    async fn where_and_combined_static() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE wc (id INTEGER, active INTEGER)")?
            .execute(&conn)
            .await?;
        for i in 0..3 {
            let active = if i == 1 { 1 } else { 0 };
            sql!("INSERT INTO wc VALUES ({}, {})", i, active)?
                .execute(&conn)
                .await?;
        }
        let filters: Values = values! { "id": 1 }?;
        let rows: Vec<(i32,)> = sql_as!("SELECT id FROM wc WHERE active = 1 AND {where:filters}")?
            .fetch_all(&conn)
            .await?;
        assert_eq!(rows, vec![(1,)]);
        Ok(())
    }

    #[tokio::test]
    async fn where_with_null_matches_null_rows() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE wn (id INTEGER PRIMARY KEY, parent_id INTEGER)")?
            .execute(&conn)
            .await?;

        sql!("INSERT INTO wn (id, parent_id) VALUES (1, NULL)")?
            .execute(&conn)
            .await?;
        sql!("INSERT INTO wn (id, parent_id) VALUES (2, 1)")?
            .execute(&conn)
            .await?;

        let filters: Values = values! { "parent_id": musq::Null }?;
        let rows: Vec<(i32,)> = sql_as!("SELECT id FROM wn WHERE {where:filters} ORDER BY id ASC")?
            .fetch_all(&conn)
            .await?;
        assert_eq!(rows, vec![(1,)]);
        Ok(())
    }

    #[tokio::test]
    async fn blob_round_trips_as_opaque_bytes() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE bl (id INTEGER PRIMARY KEY, data BLOB)")?
            .execute(&conn)
            .await?;

        let bytes: Vec<u8> = (0..=255_u8).collect();
        let vals: Values = values! { "id": 1, "data": bytes.as_slice() }?;
        sql!("INSERT INTO bl {insert:vals}")?.execute(&conn).await?;

        let row: (Vec<u8>,) = sql_as!("SELECT data FROM bl WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row.0, bytes);
        Ok(())
    }

    #[tokio::test]
    async fn insert_with_expression_mixes_binds_and_expressions() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE ie (a TEXT, b TEXT, c TEXT)")?
            .execute(&conn)
            .await?;

        let expr = sql!("({} || {})", "B1", "B2")?;
        let vals: Values = values! { "a": "A", "b": expr, "c": "C" }?;
        sql!("INSERT INTO ie {insert:vals}")?.execute(&conn).await?;

        let row: (String, String, String) =
            sql_as!("SELECT a, b, c FROM ie")?.fetch_one(&conn).await?;
        assert_eq!(row, ("A".into(), "B1B2".into(), "C".into()));
        Ok(())
    }

    #[test]
    fn insert_expression_rejects_numeric_parameters() -> anyhow::Result<()> {
        let expr = musq::Expr::from(musq::query("(?1)").bind("B"));
        let vals: Values = values! { "a": "A", "b": expr }?;
        let err = sql!("INSERT INTO ie {insert:vals}").expect_err("numeric fragment should fail");
        match err {
            Error::Protocol(msg) => assert!(msg.contains("numeric SQL parameters")),
            other => panic!("expected protocol error, got {other:?}"),
        }
        Ok(())
    }

    #[tokio::test]
    async fn set_with_expression_mixes_binds_and_expressions() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE se (id INTEGER PRIMARY KEY, a TEXT, b TEXT)")?
            .execute(&conn)
            .await?;
        sql!("INSERT INTO se (id, a, b) VALUES (1, 'old', 'old')")?
            .execute(&conn)
            .await?;

        let expr = sql!("({} || {})", "X", "Y")?;
        let changes: Values = values! { "a": expr, "b": "new" }?;
        sql!("UPDATE se SET {set:changes} WHERE id = 1")?
            .execute(&conn)
            .await?;

        let row: (String, String) = sql_as!("SELECT a, b FROM se WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row, ("XY".into(), "new".into()));
        Ok(())
    }

    #[tokio::test]
    async fn set_expression_named_parameter_collision_is_renamed() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE nc (id INTEGER PRIMARY KEY, v TEXT)")?
            .execute(&conn)
            .await?;
        sql!("INSERT INTO nc (id, v) VALUES (1, 'old')")?
            .execute(&conn)
            .await?;

        let expr = sql!("{val}", val = "expr")?;
        let changes: Values = values! { "v": expr }?;
        sql!(
            "UPDATE nc SET {set:changes} WHERE id = 1 AND v != {val}",
            val = "outer"
        )?
        .execute(&conn)
        .await?;

        let row: (String,) = sql_as!("SELECT v FROM nc WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row.0, "expr");
        Ok(())
    }

    #[tokio::test]
    async fn expr_helpers_work_for_now_and_jsonb() -> anyhow::Result<()> {
        use musq::expr;
        let conn = connection().await?;
        sql!("CREATE TABLE ej (id INTEGER PRIMARY KEY, created_at TEXT, data BLOB)")?
            .execute(&conn)
            .await?;

        let vals: Values = values! {
            "id": 1,
            "created_at": expr::now_rfc3339_utc(),
            "data": expr::jsonb(r#"{"a":1}"#),
        }?;
        sql!("INSERT INTO ej {insert:vals}")?.execute(&conn).await?;

        let row: (String, i32) =
            sql_as!("SELECT created_at, json_extract(data, '$.a') AS a FROM ej WHERE id = 1")?
                .fetch_one(&conn)
                .await?;
        assert!(row.0.contains('T') && row.0.ends_with('Z'));
        assert_eq!(row.1, 1);
        Ok(())
    }

    #[tokio::test]
    async fn upsert_set_exclude_key() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE us (id INTEGER PRIMARY KEY, val TEXT)")?
            .execute(&conn)
            .await?;
        let vals: Values = values! { "id": 1, "val": "a" }?;
        sql!("INSERT INTO us {insert:vals}")?.execute(&conn).await?;
        let new_vals: Values = values! { "id": 1, "val": "b" }?;
        sql!(
            "INSERT INTO us {insert:new_vals} \
             ON CONFLICT(id) DO UPDATE SET {upsert:new_vals, exclude: id}"
        )?
        .execute(&conn)
        .await?;
        let row: (String,) = sql_as!("SELECT val FROM us WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row.0, "b");
        Ok(())
    }

    #[tokio::test]
    async fn upsert_with_subset_columns() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE sub (id INTEGER PRIMARY KEY, name TEXT, logins INTEGER)")?
            .execute(&conn)
            .await?;
        let initial: Values = values! { "id": 1, "name": "a", "logins": 1 }?;
        sql!("INSERT INTO sub {insert:initial}")?
            .execute(&conn)
            .await?;
        let up: Values = values! { "id": 1, "logins": 2 }?;
        sql!(
            "INSERT INTO sub {insert:up} \
             ON CONFLICT(id) DO UPDATE SET {upsert:up, exclude: id}"
        )?
        .execute(&conn)
        .await?;
        let row: (String, i32) = sql_as!("SELECT name, logins FROM sub WHERE id = 1")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row, ("a".into(), 2));
        Ok(())
    }

    #[tokio::test]
    async fn insert_update_various_types() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE ty (id INTEGER PRIMARY KEY, b INTEGER, r REAL, bl BLOB, t TEXT)")?
            .execute(&conn)
            .await?;
        let vals: Values = values! {
            "id": 1,
            "b": true,
            "r": 1.23_f64,
            "bl": b"blob".as_slice(),
            "t": Option::<String>::None,
        }?;
        sql!("INSERT INTO ty {insert:vals}")?.execute(&conn).await?;
        let upd: Values = values! { "r": 2.0, "t": Some("hi") }?;
        sql!("UPDATE ty SET {set:upd} WHERE id = 1")?
            .execute(&conn)
            .await?;
        let row: (bool, f64, Vec<u8>, Option<String>) =
            sql_as!("SELECT b, r, bl, t FROM ty WHERE id = 1")?
                .fetch_one(&conn)
                .await?;
        assert_eq!(row, (true, 2.0, b"blob".to_vec(), Some("hi".into())));
        Ok(())
    }

    #[tokio::test]
    async fn empty_values_error() -> anyhow::Result<()> {
        let empty = Values::new();
        assert!(matches!(
            sql!("INSERT INTO t {insert:empty}"),
            Err(Error::Protocol(_))
        ));
        assert!(matches!(
            sql!("UPDATE t SET {set:empty}"),
            Err(Error::Protocol(_))
        ));
        Ok(())
    }

    struct Bad;
    impl Encode for Bad {
        fn encode(&self) -> StdResult<Value, EncodeError> {
            Err(EncodeError::Conversion("bad".into()))
        }
    }

    #[tokio::test]
    async fn values_macro_encode_error() -> anyhow::Result<()> {
        let res: MusqResult<Values> = (|| {
            values! { "b": Bad }
        })();
        assert!(res.is_err());
        Ok(())
    }

    #[tokio::test]
    async fn macro_combination() -> anyhow::Result<()> {
        let conn = connection().await?;
        sql!("CREATE TABLE mix (id INTEGER PRIMARY KEY, name TEXT)")?
            .execute(&conn)
            .await?;
        let table = "mix";
        let vals: Values = values! { "id": 5, "name": "Old" }?;
        sql!("INSERT INTO {ident:table} {insert:vals}")?
            .execute(&conn)
            .await?;
        let changes: Values = values! { "name": "New" }?;
        let id = 5;
        sql!("UPDATE {ident:table} SET {set:changes} WHERE id = {}", id)?
            .execute(&conn)
            .await?;
        let row: (String,) = sql_as!("SELECT name FROM mix WHERE id = 5")?
            .fetch_one(&conn)
            .await?;
        assert_eq!(row.0, "New");
        Ok(())
    }

    #[tokio::test]
    async fn update_set_with_where_named_param() -> anyhow::Result<()> {
        use musq::{Values, sql, sql_as, values};
        let conn = connection().await?;

        sql!(
            "CREATE TABLE flows_repro (
                request_id TEXT PRIMARY KEY,
                response_status INTEGER,
                resource_ip_address_space TEXT
            )"
        )?
        .execute(&conn)
        .await?;

        let req_id_target = "req-123";
        let req_id_other = "req-999";
        sql!("INSERT INTO flows_repro (request_id, response_status, resource_ip_address_space) VALUES ({}, NULL, NULL)", req_id_target)?
            .execute(&conn)
            .await?;
        sql!("INSERT INTO flows_repro (request_id, response_status, resource_ip_address_space) VALUES ({}, NULL, NULL)", req_id_other)?
            .execute(&conn)
            .await?;

        let status_code: i64 = 204;
        let resource_ip_option = Some(String::from("Public"));
        let resource_ip_lower: Option<String> =
            resource_ip_option.as_deref().map(|s| s.to_lowercase());

        // Build the same `changes` map as in your function
        let changes: Values = values! {
            "response_status": status_code,
            "resource_ip_address_space": resource_ip_lower
        }?;

        sql!(
            "UPDATE flows_repro SET {set:changes} WHERE request_id = {request_id}",
            request_id = req_id_target
        )?
        .execute(&conn)
        .await?;

        let updated: (i64, String) = sql_as!(
            "SELECT response_status, resource_ip_address_space FROM flows_repro WHERE request_id = {}",
            req_id_target
        )?
        .fetch_one(&conn)
        .await?;
        assert_eq!(updated, (204, "public".to_string()));

        let untouched: (Option<i64>, Option<String>) = sql_as!(
            "SELECT response_status, resource_ip_address_space FROM flows_repro WHERE request_id = {}",
            req_id_other
        )?
        .fetch_one(&conn)
        .await?;
        assert_eq!(untouched, (None, None));

        Ok(())
    }
}