fraiseql-db 2.3.0

Database abstraction layer for FraiseQL v2
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
#![allow(clippy::unwrap_used)] // Reason: test code, panics are acceptable

use serde_json::json;
use sqlx::Executor as _;

use super::*;

/// Create an in-memory adapter and seed a `v_user` table with N rows.
async fn setup_user_table(n: usize) -> SqliteAdapter {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");
    adapter
        .pool
        .execute("CREATE TABLE \"v_user\" (id INTEGER PRIMARY KEY, data TEXT)")
        .await
        .expect("Failed to create v_user");
    for i in 1..=n {
        let row = format!(
            r#"INSERT INTO "v_user" (data) VALUES ('{{"id":{i},"name":"user{i}","age":{age},"active":{active},"score":{score},"deleted_at":null}}')"#,
            age = 20 + i,
            active = if i % 2 == 0 { "true" } else { "false" },
            score = i * 10,
        );
        adapter.pool.execute(row.as_str()).await.expect("Failed to insert row");
    }
    adapter
}

#[tokio::test]
async fn test_in_memory_adapter_creation() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    let metrics = adapter.pool_metrics();
    assert!(metrics.total_connections > 0);
    assert_eq!(adapter.database_type(), DatabaseType::SQLite);
}

#[tokio::test]
async fn test_health_check() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    adapter.health_check().await.expect("Health check failed");
}

#[tokio::test]
async fn test_raw_query() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    // Create a test table
    sqlx::query("CREATE TABLE test_table (id INTEGER PRIMARY KEY, data TEXT)")
        .execute(&adapter.pool)
        .await
        .expect("Failed to create table");

    // Insert test data
    sqlx::query("INSERT INTO test_table (data) VALUES ('{\"name\": \"test\"}')")
        .execute(&adapter.pool)
        .await
        .expect("Failed to insert data");

    // Query the data
    let results = adapter
        .execute_raw_query("SELECT * FROM test_table")
        .await
        .expect("Failed to execute query");

    assert_eq!(results.len(), 1);
    assert!(results[0].contains_key("id"));
    assert!(results[0].contains_key("data"));
}

#[tokio::test]
async fn test_parameterized_limit_only() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    // Create test table
    sqlx::query("CREATE TABLE \"v_user\" (id INTEGER PRIMARY KEY, data TEXT)")
        .execute(&adapter.pool)
        .await
        .expect("Failed to create table");

    // Insert test data
    for i in 1..=5 {
        sqlx::query(&format!(
            "INSERT INTO \"v_user\" (data) VALUES ('{{\"id\": {}, \"name\": \"user{}\"}}') ",
            i, i
        ))
        .execute(&adapter.pool)
        .await
        .expect("Failed to insert data");
    }

    let results = adapter
        .execute_where_query("v_user", None, Some(2), None, None)
        .await
        .expect("Failed to execute query");

    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn test_parameterized_offset_only() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    // Create test table
    sqlx::query("CREATE TABLE \"v_user\" (id INTEGER PRIMARY KEY, data TEXT)")
        .execute(&adapter.pool)
        .await
        .expect("Failed to create table");

    // Insert test data
    for i in 1..=5 {
        sqlx::query(&format!(
            "INSERT INTO \"v_user\" (data) VALUES ('{{\"id\": {}, \"name\": \"user{}\"}}') ",
            i, i
        ))
        .execute(&adapter.pool)
        .await
        .expect("Failed to insert data");
    }

    let results = adapter
        .execute_where_query("v_user", None, None, Some(2), None)
        .await
        .expect("Failed to execute query");

    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_parameterized_limit_and_offset() {
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    // Create test table
    sqlx::query("CREATE TABLE \"v_user\" (id INTEGER PRIMARY KEY, data TEXT)")
        .execute(&adapter.pool)
        .await
        .expect("Failed to create table");

    // Insert test data
    for i in 1..=5 {
        sqlx::query(&format!(
            "INSERT INTO \"v_user\" (data) VALUES ('{{\"id\": {}, \"name\": \"user{}\"}}') ",
            i, i
        ))
        .execute(&adapter.pool)
        .await
        .expect("Failed to insert data");
    }

    let results = adapter
        .execute_where_query("v_user", None, Some(2), Some(1), None)
        .await
        .expect("Failed to execute query");

    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn test_function_call_returns_unsupported_error() {
    // Primary enforcement is at compile time: `SqliteAdapter` does not implement
    // `SupportsMutations`, so the mutation executor won't accept it as a type parameter.
    // This test verifies the runtime fallback for the rare case where
    // `execute_function_call` is called directly on the `DatabaseAdapter` trait object.
    let adapter = SqliteAdapter::in_memory().await.expect("Failed to create SQLite adapter");

    let err = adapter
        .execute_function_call("fn_create_user", &[json!("alice")])
        .await
        .expect_err("Expected Unsupported error");

    assert!(
        matches!(err, FraiseQLError::Unsupported { .. }),
        "Expected Unsupported error, got: {err:?}"
    );
    assert!(
        err.to_string().contains("fn_create_user"),
        "Error message should name the function"
    );
}

// ── WHERE operator matrix ─────────────────────────────────────────────────

#[tokio::test]
async fn test_where_eq_operator() {
    let adapter = setup_user_table(5).await;
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::Eq,
        value:    json!("user3"),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].as_value()["name"], "user3");
}

#[tokio::test]
async fn test_where_neq_operator() {
    let adapter = setup_user_table(3).await;
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::Neq,
        value:    json!("user1"),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn test_where_gt_operator() {
    let adapter = setup_user_table(5).await;
    // age = 20+i, so age > 23 → users 4 and 5
    let clause = WhereClause::Field {
        path:     vec!["age".to_string()],
        operator: crate::where_clause::WhereOperator::Gt,
        value:    json!(23),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn test_where_gte_operator() {
    let adapter = setup_user_table(5).await;
    // age >= 23 → users 3, 4, 5
    let clause = WhereClause::Field {
        path:     vec!["age".to_string()],
        operator: crate::where_clause::WhereOperator::Gte,
        value:    json!(23),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_where_lt_operator() {
    let adapter = setup_user_table(5).await;
    // age < 23 → users 1 and 2
    let clause = WhereClause::Field {
        path:     vec!["age".to_string()],
        operator: crate::where_clause::WhereOperator::Lt,
        value:    json!(23),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 2);
}

#[tokio::test]
async fn test_where_lte_operator() {
    let adapter = setup_user_table(5).await;
    // age <= 23 → users 1, 2, 3
    let clause = WhereClause::Field {
        path:     vec!["age".to_string()],
        operator: crate::where_clause::WhereOperator::Lte,
        value:    json!(23),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_where_in_operator() {
    let adapter = setup_user_table(5).await;
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::In,
        value:    json!(["user1", "user3", "user5"]),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_where_not_in_operator() {
    let adapter = setup_user_table(5).await;
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::Nin,
        value:    json!(["user1", "user2"]),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_where_like_operator() {
    let adapter = setup_user_table(5).await;
    // name LIKE 'user%' matches all 5
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::Like,
        value:    json!("user%"),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 5);
}

#[tokio::test]
async fn test_where_is_null_operator() {
    let adapter = setup_user_table(3).await;
    // deleted_at is null for all rows (seeded as null)
    let clause = WhereClause::Field {
        path:     vec!["deleted_at".to_string()],
        operator: crate::where_clause::WhereOperator::IsNull,
        value:    json!(true),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_where_is_not_null_operator() {
    let adapter = setup_user_table(3).await;
    // deleted_at is null → IS NOT NULL returns 0 rows
    let clause = WhereClause::Field {
        path:     vec!["deleted_at".to_string()],
        operator: crate::where_clause::WhereOperator::IsNull,
        value:    json!(false),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 0);
}

#[tokio::test]
async fn test_where_multiple_conditions_and() {
    let adapter = setup_user_table(5).await;
    // name = "user2" AND age = 22
    let clause = WhereClause::And(vec![
        WhereClause::Field {
            path:     vec!["name".to_string()],
            operator: crate::where_clause::WhereOperator::Eq,
            value:    json!("user2"),
        },
        WhereClause::Field {
            path:     vec!["age".to_string()],
            operator: crate::where_clause::WhereOperator::Eq,
            value:    json!(22),
        },
    ]);
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].as_value()["name"], "user2");
}

#[tokio::test]
async fn test_where_multiple_conditions_or() {
    let adapter = setup_user_table(5).await;
    // name = "user1" OR name = "user5"
    let clause = WhereClause::Or(vec![
        WhereClause::Field {
            path:     vec!["name".to_string()],
            operator: crate::where_clause::WhereOperator::Eq,
            value:    json!("user1"),
        },
        WhereClause::Field {
            path:     vec!["name".to_string()],
            operator: crate::where_clause::WhereOperator::Eq,
            value:    json!("user5"),
        },
    ]);
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert_eq!(results.len(), 2);
}

// ── Error paths ───────────────────────────────────────────────────────────

#[tokio::test]
async fn test_empty_result_set() {
    let adapter = setup_user_table(3).await;
    let clause = WhereClause::Field {
        path:     vec!["name".to_string()],
        operator: crate::where_clause::WhereOperator::Eq,
        value:    json!("nonexistent"),
    };
    let results = adapter
        .execute_where_query("v_user", Some(&clause), None, None, None)
        .await
        .unwrap();
    assert!(results.is_empty());
}

#[tokio::test]
async fn test_invalid_raw_query_returns_error() {
    let adapter = SqliteAdapter::in_memory().await.unwrap();
    let err = adapter
        .execute_raw_query("SELECT * FROM nonexistent_table_xyz")
        .await
        .expect_err("Expected database error");
    assert!(matches!(err, FraiseQLError::Database { .. }));
}

// ── Pool metrics ──────────────────────────────────────────────────────────

#[tokio::test]
async fn test_pool_metrics_when_idle() {
    let adapter = SqliteAdapter::in_memory().await.unwrap();
    let metrics = adapter.pool_metrics();
    // Idle connections should be ≤ total
    assert!(metrics.idle_connections <= metrics.total_connections);
    assert_eq!(metrics.waiting_requests, 0);
}

// ── explain_query ─────────────────────────────────────────────────────────

#[tokio::test]
async fn test_explain_query_returns_plan() {
    let adapter = setup_user_table(3).await;
    let result = adapter
        .explain_query("SELECT data FROM \"v_user\"", &[])
        .await
        .expect("explain_query should succeed");
    // EXPLAIN QUERY PLAN returns at least one step
    assert!(result.as_array().is_some_and(|a| !a.is_empty()));
}

// ── Projection ────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_projection_filters_fields() {
    use crate::types::SqlProjectionHint;

    let adapter = setup_user_table(3).await;
    let projection = SqlProjectionHint {
        database:                    crate::DatabaseType::SQLite,
        projection_template:         "json_object('name', json_extract(data, '$.name')) AS data"
            .to_string(),
        estimated_reduction_percent: 50,
    };
    let results = adapter
        .execute_with_projection("v_user", Some(&projection), None, None, None, None)
        .await
        .expect("execute_with_projection should succeed");
    assert_eq!(results.len(), 3);
    // Only 'name' key is present; 'age' should be absent
    for row in &results {
        assert!(row.as_value().get("name").is_some());
        assert!(row.as_value().get("age").is_none());
    }
}