fraiseql-wire 2.2.1

Streaming JSON query engine for Postgres 17
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
//! Integration tests for WHERE operators and query modifiers
//!
//! These tests verify that all operators work correctly with actual PostgreSQL data.
//! Uses testcontainers to automatically spin up PostgreSQL with test data.

mod common;

use common::connect_test_client;
use futures::StreamExt;
use serde_json::Value;

/// Helper to collect all results from a stream
async fn collect_results(
    mut stream: fraiseql_wire::stream::QueryStream<Value>,
    limit: Option<usize>,
) -> Result<Vec<Value>, Box<dyn std::error::Error>> {
    let mut results = Vec::new();
    while let Some(result) = stream.next().await {
        let json = result?;
        results.push(json);
        if let Some(max) = limit {
            if results.len() >= max {
                break;
            }
        }
    }
    Ok(results)
}

// ============================================================================
// JSONB Field Filtering Tests
// ============================================================================

#[tokio::test]
async fn test_operator_jsonb_eq_string() {
    let client = connect_test_client().await.expect("connect");

    // Filter projects where status = 'active' (JSONB text field)
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text = 'active'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} active projects", data.len());

    // Verify all results have status = 'active'
    for value in data {
        assert_eq!(
            value["status"].as_str(),
            Some("active"),
            "All returned projects should have status='active'"
        );
    }
}

#[tokio::test]
async fn test_operator_jsonb_neq() {
    let client = connect_test_client().await.expect("connect");

    // Filter projects where status != 'active'
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text != 'active'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} non-active projects", data.len());

    // Verify none have status = 'active'
    for value in data {
        assert_ne!(
            value["status"].as_str(),
            Some("active"),
            "No returned project should have status='active'"
        );
    }
}

#[tokio::test]
async fn test_operator_jsonb_in() {
    let client = connect_test_client().await.expect("connect");

    // Filter projects where status IN ('active', 'paused')
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text IN ('active', 'paused')")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!(
        "Found {} projects with status in (active, paused)",
        data.len()
    );

    // Verify all results have one of the specified statuses
    for value in data {
        let status = value["status"].as_str().expect("status field");
        assert!(
            status == "active" || status == "paused",
            "All results should have status in (active, paused)"
        );
    }
}

#[tokio::test]
async fn test_operator_jsonb_contains() {
    let client = connect_test_client().await.expect("connect");

    // Filter projects where name contains 'Project'
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'name')::text LIKE '%Project%'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} projects with 'Project' in name", data.len());

    // Verify all results have 'Project' in their name
    for value in data {
        let name = value["name"].as_str().expect("name field");
        assert!(
            name.contains("Project"),
            "All results should have 'Project' in name"
        );
    }
}

// ============================================================================
// Direct Column Filtering Tests
// ============================================================================

#[tokio::test]
async fn test_operator_direct_column_timestamp() {
    let client = connect_test_client().await.expect("connect");

    // Note: v_user view only exposes id and data columns
    // So we filter on JSONB created_at instead of direct column
    let results = client
        .query::<Value>("test.v_user")
        .where_sql("(data->>'created_at')::timestamp > '2024-01-02'::timestamp")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} users created after 2024-01-02", data.len());

    // Verify the query executes correctly (result can be empty or populated)
    let _ = data.len(); // Result is used in println above
}

// ============================================================================
// Mixed Filter Tests (JSONB + Direct Columns)
// ============================================================================

#[tokio::test]
async fn test_mixed_filters_jsonb_and_direct() {
    let client = connect_test_client().await.expect("connect");

    // Filter: JSONB status = 'active' AND JSONB name contains 'Project'
    // (Demonstrates mixed JSONB filters in single WHERE clause)
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text = 'active'")
        .where_sql("(data->>'name')::text LIKE '%Project%'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} projects (active + contain 'Project')", data.len());

    // Verify results match both conditions
    for value in data {
        assert_eq!(
            value["status"].as_str(),
            Some("active"),
            "All results should have status='active'"
        );
        let name = value["name"].as_str().expect("name");
        assert!(
            name.contains("Project"),
            "All results should contain 'Project' in name"
        );
    }
}

// ============================================================================
// LIMIT Tests
// ============================================================================

#[tokio::test]
async fn test_limit_clause() {
    let client = connect_test_client().await.expect("connect");

    // Get first 2 projects
    let results = client
        .query::<Value>("test.v_project")
        .limit(2)
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("LIMIT 2: Got {} results", data.len());

    assert!(data.len() <= 2, "LIMIT 2 should return at most 2 results");
}

// ============================================================================
// OFFSET Tests
// ============================================================================

#[tokio::test]
async fn test_offset_clause() {
    let client = connect_test_client().await.expect("connect");

    // Get projects with OFFSET 2 (skip first 2)
    let results = client
        .query::<Value>("test.v_project")
        .offset(2)
        .limit(10)
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("OFFSET 2 LIMIT 10: Got {} results", data.len());

    // With 5 projects and offset 2, should get at most 3
    assert!(
        data.len() <= 3,
        "OFFSET 2 with 5 total projects should return at most 3"
    );
}

// ============================================================================
// ORDER BY Tests
// ============================================================================

#[tokio::test]
async fn test_order_by_jsonb_field() {
    let client = connect_test_client().await.expect("connect");

    // Order by JSONB field (name)
    let results = client
        .query::<Value>("test.v_project")
        .order_by("(data->>'name')::text ASC")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Ordered by name: Got {} results", data.len());

    // Verify ordering (simple check - just verify we got results)
    if data.len() > 1 {
        let first_name = data[0]["name"].as_str().expect("name");
        let second_name = data[1]["name"].as_str().expect("name");
        assert!(
            first_name <= second_name,
            "Results should be ordered by name ASC"
        );
    }
}

#[tokio::test]
async fn test_order_by_jsonb_field_multiple() {
    let client = connect_test_client().await.expect("connect");

    // Order by multiple JSONB fields
    let results = client
        .query::<Value>("test.v_project")
        .order_by("(data->>'status')::text ASC, (data->>'name')::text DESC")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!(
        "Ordered by status ASC, name DESC: Got {} results",
        data.len()
    );

    // Just verify we got results
    assert!(!data.is_empty(), "Should get results when ordering");
}

// ============================================================================
// Array Length Operator Tests
// ============================================================================

#[tokio::test]
async fn test_operator_array_length() {
    let client = connect_test_client().await.expect("connect");

    // Filter users where roles array has exactly 2 elements
    // For JSONB arrays, use json_array_length() function
    let results = client
        .query::<Value>("test.v_user")
        .where_sql("jsonb_array_length(data->'roles') = 2")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} users with 2 roles", data.len());

    // Verify all have exactly 2 roles
    for value in data {
        let roles = value["roles"].as_array().expect("roles array");
        assert_eq!(roles.len(), 2, "All results should have exactly 2 roles");
    }
}

#[tokio::test]
async fn test_operator_array_length_gt() {
    let client = connect_test_client().await.expect("connect");

    // Filter users where roles array has more than 1 element
    let results = client
        .query::<Value>("test.v_user")
        .where_sql("jsonb_array_length(data->'roles') > 1")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} users with > 1 role", data.len());

    // Verify all have more than 1 role
    for value in data {
        let roles = value["roles"].as_array().expect("roles array");
        assert!(roles.len() > 1, "All results should have more than 1 role");
    }
}

// ============================================================================
// Pagination Tests (LIMIT + OFFSET)
// ============================================================================

#[tokio::test]
async fn test_pagination_full_cycle() {
    let client1 = connect_test_client().await.expect("connect");

    // Get first page: LIMIT 2 OFFSET 0
    let results1 = client1
        .query::<Value>("test.v_project")
        .limit(2)
        .offset(0)
        .order_by("(data->>'name')::text ASC")
        .execute()
        .await
        .expect("query");

    let page1 = collect_results(results1, None).await.expect("collect");
    println!("Page 1 (LIMIT 2 OFFSET 0): {} items", page1.len());

    // Get second page: LIMIT 2 OFFSET 2
    let client2 = connect_test_client().await.expect("connect");
    let results2 = client2
        .query::<Value>("test.v_project")
        .limit(2)
        .offset(2)
        .order_by("(data->>'name')::text ASC")
        .execute()
        .await
        .expect("query");

    let page2 = collect_results(results2, None).await.expect("collect");
    println!("Page 2 (LIMIT 2 OFFSET 2): {} items", page2.len());

    // Verify pages are different (if we have enough data)
    if !page1.is_empty() && !page2.is_empty() {
        assert_ne!(
            page1[0], page2[0],
            "First page and second page should contain different results"
        );
    }
}

// ============================================================================
// Complex Filter Combinations
// ============================================================================

#[tokio::test]
async fn test_complex_filters_with_ordering_and_pagination() {
    let client = connect_test_client().await.expect("connect");

    // Filter: status = active, order by name, limit results
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text = 'active'")
        .order_by("(data->>'name')::text ASC")
        .limit(10)
        .offset(0)
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Complex filter: Got {} results", data.len());

    // Verify all have status = 'active'
    for value in data {
        assert_eq!(
            value["status"].as_str(),
            Some("active"),
            "All results should have status='active'"
        );
    }
}

// ============================================================================
// Collation Tests
// ============================================================================

#[tokio::test]
async fn test_order_by_with_collation_c() {
    let client = connect_test_client().await.expect("connect");

    // Order by with binary collation (C)
    let results = client
        .query::<Value>("test.v_project")
        .order_by("(data->>'name')::text COLLATE \"C\" ASC")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Ordered with C collation: Got {} results", data.len());

    assert!(!data.is_empty(), "Should get results with collation");
}

// ============================================================================
// String Operator Tests (Like, Ilike)
// ============================================================================

#[tokio::test]
async fn test_operator_like_pattern() {
    let client = connect_test_client().await.expect("connect");

    // Use LIKE pattern matching on name
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'name')::text LIKE 'A%'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} projects starting with 'A'", data.len());

    // Verify all match pattern
    for value in data {
        let name = value["name"].as_str().expect("name");
        assert!(name.starts_with('A'), "All results should start with 'A'");
    }
}

#[tokio::test]
async fn test_operator_ilike_case_insensitive() {
    let client = connect_test_client().await.expect("connect");

    // Use ILIKE for case-insensitive matching
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'name')::text ILIKE 'a%'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!(
        "Found {} projects matching 'a%' (case-insensitive)",
        data.len()
    );

    // Verify all match pattern (case-insensitive)
    for value in data {
        let name = value["name"].as_str().expect("name");
        assert!(
            name.to_lowercase().starts_with('a'),
            "All results should start with 'a' (case-insensitive)"
        );
    }
}

// ============================================================================
// Streaming and Performance Tests
// ============================================================================

#[tokio::test]
async fn test_streaming_large_result_set() {
    let client = connect_test_client().await.expect("connect");

    // Stream all projects
    let mut stream = client
        .query::<Value>("test.v_project")
        .chunk_size(2) // Small chunk size to test batching
        .execute()
        .await
        .expect("query");

    let mut count = 0;
    while let Some(result) = stream.next().await {
        let _json = result.expect("item");
        count += 1;
    }

    println!("Streamed {} items in chunks of 2", count);
    assert!(count > 0, "Should stream some items");
}

// ============================================================================
// NULL Handling Tests
// ============================================================================

#[tokio::test]
async fn test_operator_is_null() {
    let client = connect_test_client().await.expect("connect");

    // Filter for rows where a JSONB field might be null
    // (This test verifies the SQL generation is correct)
    let results = client
        .query::<Value>("test.v_user")
        // Most users should have a website field, so this should return few/zero
        .where_sql("(data->'profile'->>'website') IS NULL")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} users with NULL website", data.len());

    // Just verify the query executes correctly (result can be empty)
    assert!(!data.is_empty() || data.is_empty(), "Query should execute");
}

// ============================================================================
// Sanity Checks
// ============================================================================

#[tokio::test]
async fn test_query_without_filters() {
    let client = connect_test_client().await.expect("connect");

    // Get all projects
    let results = client
        .query::<Value>("test.v_project")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Found {} total projects", data.len());

    assert!(!data.is_empty(), "Should find some projects");
}

#[tokio::test]
async fn test_query_with_empty_result() {
    let client = connect_test_client().await.expect("connect");

    // Query that should return no results
    let results = client
        .query::<Value>("test.v_project")
        .where_sql("(data->>'status')::text = 'nonexistent_status'")
        .execute()
        .await
        .expect("query");

    let data = collect_results(results, None).await.expect("collect");
    println!("Empty result set: {} items", data.len());

    assert_eq!(data.len(), 0, "Should return empty result set");
}