fraiseql-core 2.3.2

Core execution engine for FraiseQL v2 - Compiled GraphQL over SQL
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
#![allow(clippy::unwrap_used)] // Reason: test code, panics are acceptable

//! Tests end-to-end SQL projection functionality:
//! - Schema compilation with projection hints
//! - Multi-database projection SQL generation
//! - Projection detection heuristics
//! - `ResultProjector` with `__typename` handling
//! - Complete query execution with projections

use fraiseql_core::{
    db::{
        projection_generator::{
            MySqlProjectionGenerator, PostgresProjectionGenerator, SqliteProjectionGenerator,
        },
        types::{DatabaseType, JsonbValue},
    },
    runtime::ResultProjector,
    schema::SqlProjectionHint,
};
use serde_json::json;

/// Test that projection hints can be created and used
#[test]
fn test_sql_projection_hint_creation() {
    let hint = SqlProjectionHint::new(
        DatabaseType::PostgreSQL,
        "jsonb_build_object('id', \"data\"->>'id', 'name', \"data\"->>'name')".to_string(),
        65,
    );

    assert_eq!(hint.database, DatabaseType::PostgreSQL);
    assert_eq!(hint.estimated_reduction_percent, 65);
    assert!(hint.projection_template.contains("jsonb_build_object"));
}

/// Test PostgreSQL projection SQL generation
#[test]
fn test_postgres_projection_complete_flow() {
    let generator = PostgresProjectionGenerator::new();
    let fields = vec!["id".to_string(), "name".to_string(), "email".to_string()];

    let sql = generator.generate_projection_sql(&fields).unwrap();

    // Verify structure
    assert!(sql.contains("jsonb_build_object("));
    assert!(sql.contains("'id'"));
    assert!(sql.contains("'name'"));
    assert!(sql.contains("'email'"));
    assert!(sql.contains("\"data\""));

    // Verify it can be used in a SELECT clause
    let select = generator.generate_select_clause("users", &fields).unwrap();
    assert!(select.starts_with("SELECT jsonb_build_object("));
    assert!(select.contains("FROM \"users\""));
}

/// Test MySQL projection SQL generation
#[test]
fn test_mysql_projection_complete_flow() {
    let generator = MySqlProjectionGenerator::new();
    let fields = vec!["id".to_string(), "email".to_string()];

    let sql = generator.generate_projection_sql(&fields).unwrap();

    // Verify structure
    assert!(sql.contains("JSON_OBJECT("));
    assert!(sql.contains("JSON_EXTRACT("));
    assert!(sql.contains("'id'"));
    assert!(sql.contains("'email'"));
    assert!(sql.contains("`data`"));
}

/// Test SQLite projection SQL generation
#[test]
fn test_sqlite_projection_complete_flow() {
    let generator = SqliteProjectionGenerator::new();
    let fields = vec!["id".to_string(), "active".to_string()];

    let sql = generator.generate_projection_sql(&fields).unwrap();

    // Verify structure
    assert!(sql.contains("json_object("));
    assert!(sql.contains("json_extract("));
    assert!(sql.contains("'id'"));
    assert!(sql.contains("'active'"));
    assert!(sql.contains("\"data\""));
}

/// Test `ResultProjector` with `__typename` addition
#[test]
fn test_result_projector_add_typename() {
    let projector = ResultProjector::new(vec!["id".to_string()]);

    let data = json!({
        "id": "123",
        "name": "Alice",
        "email": "alice@example.com"
    });

    let jsonb = JsonbValue::new(data);
    let result = projector.add_typename_only(&jsonb, "User").unwrap();

    // Verify __typename is added
    assert_eq!(result.get("__typename"), Some(&json!("User")));
    // Verify original fields are preserved
    assert_eq!(result.get("id"), Some(&json!("123")));
    assert_eq!(result.get("name"), Some(&json!("Alice")));
}

/// Test `ResultProjector` with array of results
#[test]
fn test_result_projector_add_typename_array() {
    let projector = ResultProjector::new(vec![]);

    let data = json!([
        {"id": "1", "name": "Alice"},
        {"id": "2", "name": "Bob"}
    ]);

    let jsonb = JsonbValue::new(data);
    let result = projector.add_typename_only(&jsonb, "User").unwrap();

    // Verify array structure preserved
    assert!(result.is_array());
    let arr = result.as_array().unwrap();
    assert_eq!(arr.len(), 2);

    // Verify each element has __typename
    assert_eq!(arr[0].get("__typename"), Some(&json!("User")));
    assert_eq!(arr[1].get("__typename"), Some(&json!("User")));
}

/// Test that `ResultProjector` projects fields correctly (via `project_results` method)
#[test]
fn test_result_projector_projects_single_field() {
    let projector = ResultProjector::new(vec!["id".to_string()]);

    let data = json!({
        "id": "123",
        "name": "Alice",
        "email": "alice@example.com"
    });

    let jsonb = JsonbValue::new(data);
    let projected = projector.project_results(&[jsonb], false).unwrap();

    // Should only have id field
    assert_eq!(projected.get("id"), Some(&json!("123")));
    assert_eq!(projected.get("name"), None);
    assert_eq!(projected.get("email"), None);
}

/// Test that `ResultProjector` projects multiple fields correctly
#[test]
fn test_result_projector_projects_multiple_fields() {
    let projector = ResultProjector::new(vec!["id".to_string(), "email".to_string()]);

    let data = json!({
        "id": "123",
        "name": "Alice",
        "email": "alice@example.com",
        "phone": "+1234567890"
    });

    let jsonb = JsonbValue::new(data);
    let projected = projector.project_results(&[jsonb], false).unwrap();

    // Should have exactly id and email
    assert_eq!(projected.get("id"), Some(&json!("123")));
    assert_eq!(projected.get("email"), Some(&json!("alice@example.com")));
    assert_eq!(projected.get("name"), None);
    assert_eq!(projected.get("phone"), None);
}

/// Test that custom column names work across all databases
#[test]
fn test_projection_custom_column_names() {
    let pg = PostgresProjectionGenerator::with_column("metadata");
    let mysql = MySqlProjectionGenerator::with_column("metadata");
    let sqlite = SqliteProjectionGenerator::with_column("metadata");

    let fields = vec!["id".to_string()];

    let pg_sql = pg.generate_projection_sql(&fields).unwrap();
    let mysql_sql = mysql.generate_projection_sql(&fields).unwrap();
    let sqlite_sql = sqlite.generate_projection_sql(&fields).unwrap();

    // Verify custom column name is used
    assert!(pg_sql.contains("\"metadata\""));
    assert!(mysql_sql.contains("`metadata`"));
    assert!(sqlite_sql.contains("\"metadata\""));
}

/// Test that empty field list returns passthrough
#[test]
fn test_projection_empty_fields_passthrough() {
    let pg = PostgresProjectionGenerator::new();
    let mysql = MySqlProjectionGenerator::new();
    let sqlite = SqliteProjectionGenerator::new();

    let empty_fields: Vec<String> = vec![];

    let pg_sql = pg.generate_projection_sql(&empty_fields).unwrap();
    let mysql_sql = mysql.generate_projection_sql(&empty_fields).unwrap();
    let sqlite_sql = sqlite.generate_projection_sql(&empty_fields).unwrap();

    // With no fields, should return column reference only
    assert_eq!(pg_sql, "\"data\"");
    assert_eq!(mysql_sql, "`data`");
    assert_eq!(sqlite_sql, "\"data\"");
}

/// Test that generators handle special characters in field names correctly
#[test]
fn test_identifier_handling() {
    // Test that valid identifiers work correctly in projection SQL
    let pg = PostgresProjectionGenerator::new();
    let fields = vec![
        "id".to_string(),
        "user_id".to_string(),
        "field123".to_string(),
    ];

    let sql = pg.generate_projection_sql(&fields).unwrap();
    assert!(sql.contains("'id'"));
    assert!(sql.contains("'user_id'"));
    assert!(sql.contains("'field123'"));
}

/// Test projection rejects field names with unsafe characters
#[test]
fn test_projection_field_escaping() {
    let pg = PostgresProjectionGenerator::new();

    // Dollar sign is not alphanumeric or underscore — must be rejected
    let fields = vec!["user_id".to_string(), "data$obj".to_string()];
    let err = pg.generate_projection_sql(&fields).unwrap_err();
    assert!(
        err.to_string().contains("cannot be safely projected"),
        "expected validation error for '$', got: {err}"
    );

    // Pure alphanumeric + underscore fields pass
    let fields = vec!["user_id".to_string(), "data_obj".to_string()];
    let sql = pg.generate_projection_sql(&fields).unwrap();
    assert!(sql.contains("'user_id'"));
    assert!(sql.contains("'data_obj'"));
}

/// Test that projection hints calculate correct reduction percentages
#[test]
fn test_projection_hint_reduction_calculation() {
    // Create a hint that represents projecting 5 out of 20 fields
    let hint = SqlProjectionHint::new(
        DatabaseType::PostgreSQL,
        "jsonb_build_object('id', data->>'id', 'name', data->>'name', 'email', data->>'email', 'status', data->>'status', 'created_at', data->>'created_at')".to_string(),
        75, // 5/20 = 25% remain, so 75% reduction
    );

    assert_eq!(hint.estimated_reduction_percent, 75);
    assert_eq!(hint.database, DatabaseType::PostgreSQL);
}

/// Test `ResultProjector` wrapping response in data envelope
#[test]
fn test_result_projector_data_envelope() {
    let result = json!([
        {"id": "1", "name": "Alice"},
        {"id": "2", "name": "Bob"}
    ]);

    let wrapped = ResultProjector::wrap_in_data_envelope(result, "users");

    // Verify structure: { "data": { "users": [...] } }
    assert!(wrapped.get("data").is_some());
    let data_obj = wrapped.get("data").unwrap();
    assert!(data_obj.get("users").is_some());
    let users = data_obj.get("users").unwrap();
    assert!(users.is_array());
    assert_eq!(users.as_array().unwrap().len(), 2);
}

/// Test `ResultProjector` error wrapping
#[test]
fn test_result_projector_error_envelope() {
    use fraiseql_core::error::FraiseQLError;

    let error = FraiseQLError::Validation {
        message: "Invalid field selection".to_string(),
        path:    Some("query.users".to_string()),
    };

    let wrapped = ResultProjector::wrap_error(&error);

    // Verify structure: { "errors": [...] }
    assert!(wrapped.get("errors").is_some());
    assert!(wrapped.get("data").is_none());

    let errors = wrapped.get("errors").unwrap();
    assert!(errors.is_array());
    assert_eq!(errors.as_array().unwrap().len(), 1);

    let error_obj = &errors.as_array().unwrap()[0];
    assert!(error_obj.get("message").is_some());
}

/// Test that projection works correctly with nested objects via `ResultProjector`
#[test]
fn test_projection_with_nested_structure() {
    let projector = ResultProjector::new(vec!["id".to_string(), "profile".to_string()]);

    let data = json!({
        "id": "123",
        "profile": {
            "name": "Alice",
            "email": "alice@example.com"
        },
        "settings": {
            "theme": "dark"
        }
    });

    let jsonb = JsonbValue::new(data);
    let projected = projector.project_results(&[jsonb], false).unwrap();

    // Should have id and profile, but not settings
    assert_eq!(projected.get("id"), Some(&json!("123")));
    assert!(projected.get("profile").is_some());
    assert_eq!(projected.get("settings"), None);
}

/// Test complete flow: hint creation -> projection generation -> result wrapping
#[test]
fn test_complete_projection_pipeline() {
    // Step 1: Create projection hint
    let _hint = SqlProjectionHint::new(
        DatabaseType::PostgreSQL,
        "jsonb_build_object('id', \"data\"->>'id', 'name', \"data\"->>'name')".to_string(),
        87,
    );

    // Step 2: Generate SQL using hint template (note: in real scenario, projection_template would
    // be used)
    let fields = vec!["id".to_string(), "name".to_string()];
    let generator = PostgresProjectionGenerator::new();
    let sql = generator.generate_projection_sql(&fields).unwrap();
    assert!(sql.contains("jsonb_build_object"));

    // Step 3: Simulate database result
    let result_data = json!({
        "id": "123",
        "name": "Alice"
    });

    // Step 4: Project result and add __typename
    let projector = ResultProjector::new(fields);
    let jsonb = JsonbValue::new(result_data);
    let with_typename = projector.add_typename_only(&jsonb, "User").unwrap();

    // Step 5: Wrap in GraphQL envelope
    let final_response = ResultProjector::wrap_in_data_envelope(with_typename, "user");

    // Verify complete pipeline
    assert!(final_response.get("data").is_some());
    let data = final_response.get("data").unwrap();
    let user = data.get("user").unwrap();
    assert_eq!(user.get("id"), Some(&json!("123")));
    assert_eq!(user.get("name"), Some(&json!("Alice")));
    assert_eq!(user.get("__typename"), Some(&json!("User")));
}

/// Test projection SQL generation for large field lists
#[test]
fn test_projection_with_many_fields() {
    let generator = PostgresProjectionGenerator::new();

    // Create 50 fields
    let fields: Vec<String> = (0..50).map(|i| format!("field_{}", i)).collect();

    let sql = generator.generate_projection_sql(&fields).unwrap();

    // Verify all fields are included
    assert!(sql.contains("jsonb_build_object("));
    for field in &fields {
        assert!(sql.contains(&format!("'{}'", field)));
    }
}

/// Test that database-specific SQL has correct syntax
#[test]
fn test_database_specific_syntax() {
    let fields = vec!["id".to_string(), "status".to_string()];

    let pg_sql = PostgresProjectionGenerator::new().generate_projection_sql(&fields).unwrap();
    let mysql_sql = MySqlProjectionGenerator::new().generate_projection_sql(&fields).unwrap();
    let sqlite_sql = SqliteProjectionGenerator::new().generate_projection_sql(&fields).unwrap();

    // PostgreSQL uses ->> operator
    assert!(pg_sql.contains("->>'"));

    // MySQL uses JSON_EXTRACT
    assert!(mysql_sql.contains("JSON_EXTRACT"));

    // SQLite uses json_extract
    assert!(sqlite_sql.contains("json_extract"));
}

/// Test projection result projection for list vs single
#[test]
fn test_result_projector_list_vs_single() {
    let projector = ResultProjector::new(vec!["id".to_string()]);

    let data = json!({"id": "1", "name": "Alice"});
    let jsonb = JsonbValue::new(data);

    // Test list projection
    let list_result = projector.project_results(std::slice::from_ref(&jsonb), true).unwrap();
    assert!(list_result.is_array());
    assert_eq!(list_result.as_array().unwrap().len(), 1);

    // Test single projection
    let single_result = projector.project_results(std::slice::from_ref(&jsonb), false).unwrap();
    assert!(single_result.is_object());
    assert_eq!(single_result.get("id"), Some(&json!("1")));
}

/// Test empty result set handling
#[test]
fn test_projection_with_empty_results() {
    let projector = ResultProjector::new(vec!["id".to_string()]);

    // Empty result set for list query
    let list_result = projector.project_results(&[], true).unwrap();
    assert!(list_result.is_array());
    assert_eq!(list_result.as_array().unwrap().len(), 0);

    // Empty result set for single query
    let single_result = projector.project_results(&[], false).unwrap();
    assert_eq!(single_result, json!(null));
}