oneiriq-surql 0.2.2

Code-first database toolkit for SurrealDB - schema definitions, migrations, query building, and typed CRUD (Rust port of oneiriq-surql). Published as the `oneiriq-surql` crate; imported as `use surql::...`.
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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
//! Schema diffing engine.
//!
//! Port of `surql/migration/diff.py`. Compares two schema snapshots
//! (code-side vs database-side, or two code versions) and produces a list
//! of [`SchemaDiff`] entries describing every additive, destructive, or
//! modifying schema change.
//!
//! ## Public API
//!
//! The public entrypoints are free functions that operate on slices of
//! schema definitions and return a [`Vec<SchemaDiff>`]:
//!
//! - [`diff_tables`] — compare two sets of [`TableDefinition`]s.
//! - [`diff_fields`] — compare two sets of [`FieldDefinition`]s for a table.
//! - [`diff_indexes`] — compare two sets of [`IndexDefinition`]s for a table.
//! - [`diff_events`] — compare two sets of [`EventDefinition`]s for a table.
//! - [`diff_permissions`] — compare two permission maps for a table.
//! - [`diff_edges`] — compare two sets of [`EdgeDefinition`]s.
//! - [`diff_schemas`] — aggregate diff across full [`SchemaSnapshot`]s.
//!
//! ## Deviation from Python
//!
//! In the Python implementation the per-category diff helpers take a single
//! pair of objects (`old`, `new`). The Rust port exposes slice-based
//! signatures that internally compute the pair-wise comparison by name.
//! The old pair-wise helpers are preserved as `diff_*_pair` functions for
//! callers that want the fine-grained semantics (for example the migration
//! generator). Functions that render SurrealQL require an explicit `table`
//! parameter because the field / index / event / permission slices do not
//! carry table context on their own.
//!
//! ## Expression normalisation
//!
//! Field expressions (`assertion`, `default`, `value`) are compared using
//! whitespace-normalised equality so that cosmetic reformatting by the
//! database server does not produce spurious diffs.

use std::collections::{BTreeMap, BTreeSet};

use serde::{Deserialize, Serialize};

use crate::error::{Result, SurqlError};
use crate::migration::models::{DiffOperation, SchemaDiff};
use crate::schema::edge::{EdgeDefinition, EdgeMode};
use crate::schema::fields::FieldDefinition;
use crate::schema::table::{
    EventDefinition, HnswDistanceType, IndexDefinition, IndexType, MTreeDistanceType,
    MTreeVectorType, TableDefinition,
};

/// Full schema snapshot passed to [`diff_schemas`].
///
/// Pairs table definitions with edge definitions to support a single-call
/// diff across all objects in a schema. Order is preserved as supplied but
/// comparisons are name-based so the input order does not affect output.
///
/// ## Examples
///
/// ```
/// use surql::migration::diff::SchemaSnapshot;
/// use surql::schema::table::table_schema;
///
/// let snapshot = SchemaSnapshot {
///     tables: vec![table_schema("user")],
///     edges: vec![],
/// };
/// assert_eq!(snapshot.tables.len(), 1);
/// ```
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct SchemaSnapshot {
    /// All tables known to this snapshot (in discovery order).
    #[serde(default)]
    pub tables: Vec<TableDefinition>,
    /// All edges known to this snapshot (in discovery order).
    #[serde(default)]
    pub edges: Vec<EdgeDefinition>,
}

impl SchemaSnapshot {
    /// Construct an empty snapshot.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Convenience constructor from two iterators.
    pub fn from_parts<T, E>(tables: T, edges: E) -> Self
    where
        T: IntoIterator<Item = TableDefinition>,
        E: IntoIterator<Item = EdgeDefinition>,
    {
        Self {
            tables: tables.into_iter().collect(),
            edges: edges.into_iter().collect(),
        }
    }
}

/// Regex characters treated as safe in a default-value expression.
///
/// Preserved verbatim from the Python implementation to keep the validation
/// behaviour identical across runtimes.
const SAFE_DEFAULT_PATTERN: &str = concat!(
    r"^(",
    r"[a-zA-Z_][a-zA-Z0-9_]*(?:::[a-zA-Z_][a-zA-Z0-9_]*)*\([^;]*\)",
    r"|-?\d+(?:\.\d+)?",
    r"|true|false",
    r"|NONE|NULL",
    r"|'(?:[^'\\]|\\.)*'",
    r"|\$[a-zA-Z_][a-zA-Z0-9_]*",
    r")$",
);

fn safe_default_regex() -> &'static regex::Regex {
    static RE: std::sync::OnceLock<regex::Regex> = std::sync::OnceLock::new();
    RE.get_or_init(|| regex::Regex::new(SAFE_DEFAULT_PATTERN).expect("valid regex"))
}

/// Validate that an event expression has no injection patterns.
///
/// Mirrors `_validate_event_expression` in Python: rejects statement
/// separators (`;`) and SQL comments (`--`).
///
/// # Errors
///
/// Returns [`SurqlError::Validation`] when the expression contains a
/// banned pattern.
pub fn validate_event_expression(expr: &str, label: &str) -> Result<()> {
    let stripped = expr.trim();
    if stripped.contains("; ") || stripped.contains(";--") || stripped.ends_with(';') {
        return Err(SurqlError::Validation {
            reason: format!(
                "Unsafe event {label}: {expr:?}. Event {label}s must not contain statement separators."
            ),
        });
    }
    if stripped.contains("--") {
        return Err(SurqlError::Validation {
            reason: format!(
                "Unsafe event {label}: {expr:?}. Event {label}s must not contain SQL comments."
            ),
        });
    }
    Ok(())
}

/// Validate that a default-value expression is one of the allowlisted forms.
///
/// # Errors
///
/// Returns [`SurqlError::Validation`] when the expression does not match
/// the safe-default pattern.
pub fn validate_default_value(default: &str) -> Result<()> {
    if !safe_default_regex().is_match(default.trim()) {
        return Err(SurqlError::Validation {
            reason: format!(
                "Unsafe default value expression: {default:?}. \
                 Defaults must be function calls, literals, or parameter references."
            ),
        });
    }
    Ok(())
}

/// Normalise whitespace in an expression for semantic equality comparison.
///
/// Collapses runs of whitespace to a single space and trims the ends. Used
/// when comparing field expressions — a database server may reformat
/// expressions when echoing them back.
#[must_use]
pub fn normalize_expression(expr: &str) -> String {
    let mut out = String::with_capacity(expr.len());
    let mut in_space = false;
    for ch in expr.trim().chars() {
        if ch.is_whitespace() {
            if !in_space {
                out.push(' ');
                in_space = true;
            }
        } else {
            out.push(ch);
            in_space = false;
        }
    }
    out
}

fn expr_eq(a: Option<&str>, b: Option<&str>) -> bool {
    match (a, b) {
        (None, None) => true,
        (Some(x), Some(y)) => normalize_expression(x) == normalize_expression(y),
        _ => false,
    }
}

// ---------------------------------------------------------------------------
// Public slice-based API
// ---------------------------------------------------------------------------

/// Compare two slices of tables and produce every required schema change.
///
/// Tables present in `code` but not in `db` are added (with all contained
/// fields/indexes/events/permissions). Tables present in `db` but not in
/// `code` are dropped. Tables present in both are recursively compared.
///
/// ## Examples
///
/// ```
/// use surql::migration::diff::diff_tables;
/// use surql::schema::table::table_schema;
///
/// let code = vec![table_schema("user")];
/// let db: Vec<_> = vec![];
/// let diffs = diff_tables(&code, &db);
/// assert_eq!(diffs.len(), 1);
/// ```
#[must_use]
pub fn diff_tables(code: &[TableDefinition], db: &[TableDefinition]) -> Vec<SchemaDiff> {
    let code_map = index_by_name(code, |t| t.name.as_str());
    let db_map = index_by_name(db, |t| t.name.as_str());
    let mut out: Vec<SchemaDiff> = Vec::new();

    // Added tables — present in code, absent in db.
    for name in sorted_keys(&code_map) {
        if !db_map.contains_key(name) {
            out.extend(generate_add_table_diffs(code_map[name]));
        }
    }
    // Dropped tables — present in db, absent in code.
    for name in sorted_keys(&db_map) {
        if !code_map.contains_key(name) {
            out.extend(generate_drop_table_diffs(db_map[name]));
        }
    }
    // Modified tables — present in both, diff recursively.
    for name in sorted_keys(&code_map) {
        if let Some(db_table) = db_map.get(name) {
            let code_table = code_map[name];
            out.extend(diff_table_pair_inner(code_table, db_table));
        }
    }
    out
}

/// Compare two field slices for the named table.
///
/// Added fields appear first (in `code` order), followed by dropped fields
/// (in `db` order), followed by modified fields (in `code` order).
///
/// ## Examples
///
/// ```
/// use surql::migration::diff::diff_fields;
/// use surql::schema::fields::{FieldDefinition, FieldType};
///
/// let code = vec![FieldDefinition::new("email", FieldType::String)];
/// let db: Vec<FieldDefinition> = vec![];
/// let diffs = diff_fields("user", &code, &db);
/// assert_eq!(diffs.len(), 1);
/// ```
#[must_use]
pub fn diff_fields(
    table: &str,
    code: &[FieldDefinition],
    db: &[FieldDefinition],
) -> Vec<SchemaDiff> {
    let code_map = index_by_name(code, |f| f.name.as_str());
    let db_map = index_by_name(db, |f| f.name.as_str());
    let mut out: Vec<SchemaDiff> = Vec::new();

    for f in code {
        if !db_map.contains_key(f.name.as_str()) {
            out.push(generate_add_field_diff(table, f));
        }
    }
    for f in db {
        if !code_map.contains_key(f.name.as_str()) {
            out.push(generate_drop_field_diff(table, f));
        }
    }
    for f in code {
        if let Some(db_field) = db_map.get(f.name.as_str()) {
            if !fields_equal(f, db_field) {
                out.push(generate_modify_field_diff(table, db_field, f));
            }
        }
    }
    out
}

/// Compare two index slices for the named table.
#[must_use]
pub fn diff_indexes(
    table: &str,
    code: &[IndexDefinition],
    db: &[IndexDefinition],
) -> Vec<SchemaDiff> {
    let code_map = index_by_name(code, |i| i.name.as_str());
    let db_map = index_by_name(db, |i| i.name.as_str());
    let mut out: Vec<SchemaDiff> = Vec::new();

    for idx in code {
        if !db_map.contains_key(idx.name.as_str()) {
            out.push(generate_add_index_diff(table, idx));
        }
    }
    for idx in db {
        if !code_map.contains_key(idx.name.as_str()) {
            out.push(generate_drop_index_diff(table, idx));
        }
    }
    out
}

/// Compare two event slices for the named table.
#[must_use]
pub fn diff_events(
    table: &str,
    code: &[EventDefinition],
    db: &[EventDefinition],
) -> Vec<SchemaDiff> {
    let code_map = index_by_name(code, |e| e.name.as_str());
    let db_map = index_by_name(db, |e| e.name.as_str());
    let mut out: Vec<SchemaDiff> = Vec::new();

    for ev in code {
        if !db_map.contains_key(ev.name.as_str()) {
            out.push(generate_add_event_diff(table, ev));
        }
    }
    for ev in db {
        if !code_map.contains_key(ev.name.as_str()) {
            out.push(generate_drop_event_diff(table, ev));
        }
    }
    out
}

/// Compare two permission maps for the named table.
///
/// Emits at most one [`SchemaDiff`] describing the delta. If the maps are
/// equal, returns an empty vector.
#[must_use]
pub fn diff_permissions(
    table: &str,
    code: Option<&BTreeMap<String, String>>,
    db: Option<&BTreeMap<String, String>>,
) -> Vec<SchemaDiff> {
    if permissions_equal(code, db) {
        return Vec::new();
    }
    vec![generate_modify_permissions_diff(table, code, db)]
}

/// Compare two edge slices.
///
/// Same high-level behaviour as [`diff_tables`]: added edges produce add
/// diffs for the edge and all of its contained objects; dropped edges
/// produce drop diffs; edges present in both are recursively compared on
/// fields/indexes/events/permissions.
#[must_use]
pub fn diff_edges(code: &[EdgeDefinition], db: &[EdgeDefinition]) -> Vec<SchemaDiff> {
    let code_map = index_by_name(code, |e| e.name.as_str());
    let db_map = index_by_name(db, |e| e.name.as_str());
    let mut out: Vec<SchemaDiff> = Vec::new();

    for name in sorted_keys(&code_map) {
        if !db_map.contains_key(name) {
            out.extend(generate_add_edge_diffs(code_map[name]));
        }
    }
    for name in sorted_keys(&db_map) {
        if !code_map.contains_key(name) {
            out.extend(generate_drop_edge_diffs(db_map[name]));
        }
    }
    for name in sorted_keys(&code_map) {
        if let Some(db_edge) = db_map.get(name) {
            let code_edge = code_map[name];
            out.extend(diff_edge_pair_inner(code_edge, db_edge));
        }
    }
    out
}

/// Diff two complete snapshots and return every change required to make
/// `db` look like `code`.
///
/// The returned diffs are ordered: tables first, then edges.
#[must_use]
pub fn diff_schemas(code: &SchemaSnapshot, db: &SchemaSnapshot) -> Vec<SchemaDiff> {
    let mut out = diff_tables(&code.tables, &db.tables);
    out.extend(diff_edges(&code.edges, &db.edges));
    out
}

// ---------------------------------------------------------------------------
// Pair-wise helpers (preserved for migration-generator callers and tests)
// ---------------------------------------------------------------------------

/// Compare a single pair of tables, handling add/drop/modify.
///
/// Matches the semantics of the Python `diff_tables(old, new)` helper: pass
/// `None` for "table does not exist on that side".
#[must_use]
pub fn diff_table_pair(
    code: Option<&TableDefinition>,
    db: Option<&TableDefinition>,
) -> Vec<SchemaDiff> {
    match (code, db) {
        (Some(code), None) => generate_add_table_diffs(code),
        (None, Some(db)) => generate_drop_table_diffs(db),
        (Some(code), Some(db)) => diff_table_pair_inner(code, db),
        (None, None) => Vec::new(),
    }
}

/// Compare a single pair of edges, handling add/drop/modify.
#[must_use]
pub fn diff_edge_pair(
    code: Option<&EdgeDefinition>,
    db: Option<&EdgeDefinition>,
) -> Vec<SchemaDiff> {
    match (code, db) {
        (Some(code), None) => generate_add_edge_diffs(code),
        (None, Some(db)) => generate_drop_edge_diffs(db),
        (Some(code), Some(db)) => diff_edge_pair_inner(code, db),
        (None, None) => Vec::new(),
    }
}

fn diff_table_pair_inner(code: &TableDefinition, db: &TableDefinition) -> Vec<SchemaDiff> {
    let mut out = diff_fields(&code.name, &code.fields, &db.fields);
    out.extend(diff_indexes(&code.name, &code.indexes, &db.indexes));
    out.extend(diff_events(&code.name, &code.events, &db.events));
    out.extend(diff_permissions(
        &code.name,
        code.permissions.as_ref(),
        db.permissions.as_ref(),
    ));
    out
}

fn diff_edge_pair_inner(code: &EdgeDefinition, db: &EdgeDefinition) -> Vec<SchemaDiff> {
    let mut out = diff_fields(&code.name, &code.fields, &db.fields);
    out.extend(diff_indexes(&code.name, &code.indexes, &db.indexes));
    out.extend(diff_events(&code.name, &code.events, &db.events));
    out.extend(diff_permissions(
        &code.name,
        code.permissions.as_ref(),
        db.permissions.as_ref(),
    ));
    out
}

// ---------------------------------------------------------------------------
// Generator helpers (pure functions, rendered into SurrealQL text)
// ---------------------------------------------------------------------------

fn generate_add_table_diffs(table: &TableDefinition) -> Vec<SchemaDiff> {
    let forward_sql = format!("DEFINE TABLE {} {};", table.name, table.mode.as_str());
    let backward_sql = format!("REMOVE TABLE {};", table.name);
    let mut out = vec![SchemaDiff {
        operation: DiffOperation::AddTable,
        table: table.name.clone(),
        field: None,
        index: None,
        event: None,
        description: format!("Add table {}", table.name),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }];
    for field in &table.fields {
        out.push(generate_add_field_diff(&table.name, field));
    }
    for idx in &table.indexes {
        out.push(generate_add_index_diff(&table.name, idx));
    }
    for ev in &table.events {
        out.push(generate_add_event_diff(&table.name, ev));
    }
    if let Some(perms) = table.permissions.as_ref() {
        if !perms.is_empty() {
            out.push(generate_modify_permissions_diff(
                &table.name,
                Some(perms),
                None,
            ));
        }
    }
    out
}

fn generate_drop_table_diffs(table: &TableDefinition) -> Vec<SchemaDiff> {
    vec![SchemaDiff {
        operation: DiffOperation::DropTable,
        table: table.name.clone(),
        field: None,
        index: None,
        event: None,
        description: format!("Drop table {}", table.name),
        forward_sql: format!("REMOVE TABLE {};", table.name),
        backward_sql: format!("DEFINE TABLE {} {};", table.name, table.mode.as_str()),
        details: BTreeMap::new(),
    }]
}

fn generate_add_field_diff(table: &str, field: &FieldDefinition) -> SchemaDiff {
    let mut forward_sql = field_to_sql(table, field);
    if let Some(default) = field.default.as_deref() {
        // Best-effort backfill: failures to validate default surface as a
        // skipped backfill rather than a panic (matches conservative Python
        // path — though Python raises, Rust returns a safe render because
        // this function is infallible by contract).
        if validate_default_value(default).is_ok() {
            let backfill = format!(
                "UPDATE {table} SET {name} = {default} WHERE {name} IS NONE;",
                name = field.name,
            );
            forward_sql.push('\n');
            forward_sql.push_str(&backfill);
        }
    }
    let backward_sql = format!("REMOVE FIELD {} ON TABLE {};", field.name, table);
    let mut details = BTreeMap::new();
    details.insert(
        "type".to_string(),
        serde_json::Value::String(field.field_type.as_str().into()),
    );
    SchemaDiff {
        operation: DiffOperation::AddField,
        table: table.to_string(),
        field: Some(field.name.clone()),
        index: None,
        event: None,
        description: format!("Add field {} to {}", field.name, table),
        forward_sql,
        backward_sql,
        details,
    }
}

fn generate_drop_field_diff(table: &str, field: &FieldDefinition) -> SchemaDiff {
    let forward_sql = format!("REMOVE FIELD {} ON TABLE {};", field.name, table);
    let backward_sql = field_to_sql(table, field);
    SchemaDiff {
        operation: DiffOperation::DropField,
        table: table.to_string(),
        field: Some(field.name.clone()),
        index: None,
        event: None,
        description: format!("Drop field {} from {}", field.name, table),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_modify_field_diff(
    table: &str,
    old_field: &FieldDefinition,
    new_field: &FieldDefinition,
) -> SchemaDiff {
    let forward_sql = field_to_sql(table, new_field);
    let backward_sql = field_to_sql(table, old_field);
    let mut details = BTreeMap::new();
    details.insert(
        "old_type".into(),
        serde_json::Value::String(old_field.field_type.as_str().into()),
    );
    details.insert(
        "new_type".into(),
        serde_json::Value::String(new_field.field_type.as_str().into()),
    );
    SchemaDiff {
        operation: DiffOperation::ModifyField,
        table: table.to_string(),
        field: Some(new_field.name.clone()),
        index: None,
        event: None,
        description: format!("Modify field {} in {}", new_field.name, table),
        forward_sql,
        backward_sql,
        details,
    }
}

fn generate_add_index_diff(table: &str, idx: &IndexDefinition) -> SchemaDiff {
    let forward_sql = match idx.index_type {
        IndexType::Mtree => mtree_index_to_sql(table, idx),
        IndexType::Hnsw => hnsw_index_to_sql(table, idx),
        _ => {
            let columns = idx.columns.join(", ");
            let mut sql = format!(
                "DEFINE INDEX {name} ON TABLE {table} COLUMNS {columns}",
                name = idx.name
            );
            if idx.index_type.as_str() != "INDEX" {
                sql.push(' ');
                sql.push_str(idx.index_type.as_str());
            }
            sql.push(';');
            sql
        }
    };
    let backward_sql = format!("REMOVE INDEX {} ON TABLE {};", idx.name, table);
    SchemaDiff {
        operation: DiffOperation::AddIndex,
        table: table.to_string(),
        field: None,
        index: Some(idx.name.clone()),
        event: None,
        description: format!("Add index {} to {}", idx.name, table),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_drop_index_diff(table: &str, idx: &IndexDefinition) -> SchemaDiff {
    let forward_sql = format!("REMOVE INDEX {} ON TABLE {};", idx.name, table);
    let backward_sql = match idx.index_type {
        IndexType::Mtree => mtree_index_to_sql(table, idx),
        IndexType::Hnsw => hnsw_index_to_sql(table, idx),
        _ => {
            let columns = idx.columns.join(", ");
            format!(
                "DEFINE INDEX {name} ON TABLE {table} COLUMNS {columns};",
                name = idx.name
            )
        }
    };
    SchemaDiff {
        operation: DiffOperation::DropIndex,
        table: table.to_string(),
        field: None,
        index: Some(idx.name.clone()),
        event: None,
        description: format!("Drop index {} from {}", idx.name, table),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_add_event_diff(table: &str, ev: &EventDefinition) -> SchemaDiff {
    // Best-effort validation; on failure we still emit the diff so callers
    // can surface the unsafe SQL via dry-run, matching the "infallible diff
    // constructor" contract of this module.
    let _ = validate_event_expression(&ev.condition, "condition");
    let _ = validate_event_expression(&ev.action, "action");
    let forward_sql = format!(
        "DEFINE EVENT {name} ON TABLE {table} WHEN {cond} THEN {{ {act} }};",
        name = ev.name,
        cond = ev.condition,
        act = ev.action,
    );
    let backward_sql = format!("REMOVE EVENT {} ON TABLE {};", ev.name, table);
    SchemaDiff {
        operation: DiffOperation::AddEvent,
        table: table.to_string(),
        field: None,
        index: None,
        event: Some(ev.name.clone()),
        description: format!("Add event {} to {}", ev.name, table),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_drop_event_diff(table: &str, ev: &EventDefinition) -> SchemaDiff {
    let _ = validate_event_expression(&ev.condition, "condition");
    let _ = validate_event_expression(&ev.action, "action");
    let forward_sql = format!("REMOVE EVENT {} ON TABLE {};", ev.name, table);
    let backward_sql = format!(
        "DEFINE EVENT {name} ON TABLE {table} WHEN {cond} THEN {{ {act} }};",
        name = ev.name,
        cond = ev.condition,
        act = ev.action,
    );
    SchemaDiff {
        operation: DiffOperation::DropEvent,
        table: table.to_string(),
        field: None,
        index: None,
        event: Some(ev.name.clone()),
        description: format!("Drop event {} from {}", ev.name, table),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_modify_permissions_diff(
    table: &str,
    new_permissions: Option<&BTreeMap<String, String>>,
    old_permissions: Option<&BTreeMap<String, String>>,
) -> SchemaDiff {
    let forward_sql = render_permission_statements(table, new_permissions);
    let backward_sql = render_permission_statements(table, old_permissions);
    SchemaDiff {
        operation: DiffOperation::ModifyPermissions,
        table: table.to_string(),
        field: None,
        index: None,
        event: None,
        description: format!("Modify permissions for {table}"),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }
}

fn generate_add_edge_diffs(edge: &EdgeDefinition) -> Vec<SchemaDiff> {
    let mut forward_sql = match edge.mode {
        EdgeMode::Relation => {
            let mut s = format!("DEFINE TABLE {} TYPE RELATION", edge.name);
            if let Some(from) = edge.from_table.as_deref() {
                s.push_str(" FROM ");
                s.push_str(from);
            }
            if let Some(to) = edge.to_table.as_deref() {
                s.push_str(" TO ");
                s.push_str(to);
            }
            s
        }
        EdgeMode::Schemafull => format!("DEFINE TABLE {} SCHEMAFULL", edge.name),
        EdgeMode::Schemaless => format!("DEFINE TABLE {} SCHEMALESS", edge.name),
    };
    forward_sql.push(';');
    let backward_sql = format!("REMOVE TABLE {};", edge.name);

    let mut out = vec![SchemaDiff {
        operation: DiffOperation::AddTable,
        table: edge.name.clone(),
        field: None,
        index: None,
        event: None,
        description: format!("Add edge {}", edge.name),
        forward_sql,
        backward_sql,
        details: BTreeMap::new(),
    }];
    for field in &edge.fields {
        out.push(generate_add_field_diff(&edge.name, field));
    }
    for idx in &edge.indexes {
        out.push(generate_add_index_diff(&edge.name, idx));
    }
    for ev in &edge.events {
        out.push(generate_add_event_diff(&edge.name, ev));
    }
    if let Some(perms) = edge.permissions.as_ref() {
        if !perms.is_empty() {
            out.push(generate_modify_permissions_diff(
                &edge.name,
                Some(perms),
                None,
            ));
        }
    }
    out
}

fn generate_drop_edge_diffs(edge: &EdgeDefinition) -> Vec<SchemaDiff> {
    vec![SchemaDiff {
        operation: DiffOperation::DropTable,
        table: edge.name.clone(),
        field: None,
        index: None,
        event: None,
        description: format!("Drop edge {}", edge.name),
        forward_sql: format!("REMOVE TABLE {};", edge.name),
        backward_sql: String::new(),
        details: BTreeMap::new(),
    }]
}

fn render_permission_statements(table: &str, perms: Option<&BTreeMap<String, String>>) -> String {
    let Some(perms) = perms else {
        return String::new();
    };
    if perms.is_empty() {
        return String::new();
    }
    let mut parts: Vec<String> = Vec::with_capacity(perms.len());
    for (action, condition) in perms {
        parts.push(format!(
            "DEFINE FIELD PERMISSIONS FOR {} ON TABLE {table} WHERE {condition};",
            action.to_uppercase()
        ));
    }
    parts.join(" ")
}

fn field_to_sql(table: &str, field: &FieldDefinition) -> String {
    let mut sql = format!(
        "DEFINE FIELD {name} ON TABLE {table} TYPE {ty}",
        name = field.name,
        ty = field.field_type.as_str(),
    );
    if let Some(a) = field.assertion.as_deref() {
        sql.push_str(" ASSERT ");
        sql.push_str(a);
    }
    if let Some(d) = field.default.as_deref() {
        sql.push_str(" DEFAULT ");
        sql.push_str(d);
    }
    if let Some(v) = field.value.as_deref() {
        sql.push_str(" VALUE ");
        sql.push_str(v);
    }
    if field.readonly {
        sql.push_str(" READONLY");
    }
    if field.flexible {
        sql.push_str(" FLEXIBLE");
    }
    sql.push(';');
    sql
}

fn fields_equal(a: &FieldDefinition, b: &FieldDefinition) -> bool {
    a.name == b.name
        && a.field_type == b.field_type
        && a.readonly == b.readonly
        && a.flexible == b.flexible
        && expr_eq(a.assertion.as_deref(), b.assertion.as_deref())
        && expr_eq(a.default.as_deref(), b.default.as_deref())
        && expr_eq(a.value.as_deref(), b.value.as_deref())
}

fn permissions_equal(
    a: Option<&BTreeMap<String, String>>,
    b: Option<&BTreeMap<String, String>>,
) -> bool {
    match (a, b) {
        (None, None) => true,
        (Some(x), Some(y)) => {
            if x.len() != y.len() {
                return false;
            }
            for (k, vx) in x {
                let Some(vy) = y.get(k) else { return false };
                if normalize_expression(vx) != normalize_expression(vy) {
                    return false;
                }
            }
            true
        }
        (Some(m), None) | (None, Some(m)) => m.is_empty(),
    }
}

fn mtree_index_to_sql(table: &str, idx: &IndexDefinition) -> String {
    let field = idx.columns.first().map_or("", String::as_str);
    let dim = idx.dimension.unwrap_or(0);
    let distance = idx.distance.unwrap_or(MTreeDistanceType::Euclidean);
    let vtype = idx.vector_type.unwrap_or(MTreeVectorType::F64);
    let mut sql = format!(
        "DEFINE INDEX {name} ON TABLE {table} COLUMNS {field} MTREE DIMENSION {dim}",
        name = idx.name,
    );
    sql.push_str(" DIST ");
    sql.push_str(distance.as_str());
    sql.push_str(" TYPE ");
    sql.push_str(vtype.as_str());
    sql.push(';');
    sql
}

fn hnsw_index_to_sql(table: &str, idx: &IndexDefinition) -> String {
    let field = idx.columns.first().map_or("", String::as_str);
    let dim = idx.dimension.unwrap_or(0);
    let distance = idx.hnsw_distance.unwrap_or(HnswDistanceType::Euclidean);
    let vtype = idx.vector_type.unwrap_or(MTreeVectorType::F64);
    let mut sql = format!(
        "DEFINE INDEX {name} ON TABLE {table} COLUMNS {field} HNSW DIMENSION {dim}",
        name = idx.name,
    );
    sql.push_str(" DIST ");
    sql.push_str(distance.as_str());
    sql.push_str(" TYPE ");
    sql.push_str(vtype.as_str());
    if let Some(efc) = idx.efc {
        use std::fmt::Write as _;
        let _ = write!(sql, " EFC {efc}");
    }
    if let Some(m) = idx.m {
        use std::fmt::Write as _;
        let _ = write!(sql, " M {m}");
    }
    sql.push(';');
    sql
}

fn index_by_name<'a, T, F>(items: &'a [T], key: F) -> BTreeMap<&'a str, &'a T>
where
    F: Fn(&'a T) -> &'a str,
{
    let mut map = BTreeMap::new();
    for item in items {
        map.insert(key(item), item);
    }
    map
}

fn sorted_keys<'a, V>(map: &'a BTreeMap<&'a str, V>) -> Vec<&'a str> {
    // BTreeMap iterates in key order already, so we just need to collect
    // the keys into a concrete vector to avoid holding the borrow across
    // the map while iterating mutably elsewhere.
    let mut keys: Vec<&str> = map.keys().copied().collect();
    keys.sort_unstable();
    // dedupe is not needed — a BTreeMap cannot have duplicates — but keep
    // a stable Vec<&str> interface.
    let set: BTreeSet<&str> = keys.into_iter().collect();
    set.into_iter().collect()
}

// Silence clippy::missing_fields_in_debug warnings from older toolchains:
// all public types here derive Debug explicitly.

#[cfg(test)]
mod tests {
    use super::*;
    use crate::schema::edge::{EdgeDefinition, EdgeMode};
    use crate::schema::fields::{FieldDefinition, FieldType};
    use crate::schema::table::{
        event, hnsw_index, index, mtree_index, table_schema, unique_index, HnswDistanceType,
        IndexDefinition, IndexType, MTreeDistanceType, MTreeVectorType, TableMode,
    };

    fn tbl(name: &str) -> TableDefinition {
        table_schema(name)
    }

    fn f(name: &str, ty: FieldType) -> FieldDefinition {
        FieldDefinition::new(name, ty)
    }

    // ----- normalize_expression -----

    #[test]
    fn normalize_expression_collapses_runs_of_whitespace() {
        assert_eq!(normalize_expression("a   b\tc\n d"), "a b c d");
    }

    #[test]
    fn normalize_expression_trims_edges() {
        assert_eq!(normalize_expression("  hello world  "), "hello world");
    }

    #[test]
    fn normalize_expression_empty_is_empty() {
        assert_eq!(normalize_expression("   "), "");
    }

    // ----- validate_event_expression -----

    #[test]
    fn validate_event_expression_allows_safe() {
        assert!(validate_event_expression("$event = \"CREATE\"", "condition").is_ok());
        assert!(validate_event_expression("$before.a != $after.a", "condition").is_ok());
        assert!(validate_event_expression("true", "condition").is_ok());
        assert!(validate_event_expression("CREATE log SET u = 1", "action").is_ok());
    }

    #[test]
    fn validate_event_expression_rejects_statement_separator() {
        assert!(validate_event_expression("a; DROP b", "condition").is_err());
    }

    #[test]
    fn validate_event_expression_rejects_trailing_semicolon() {
        assert!(validate_event_expression("a;", "condition").is_err());
    }

    #[test]
    fn validate_event_expression_rejects_comment() {
        assert!(validate_event_expression("a -- b", "condition").is_err());
    }

    #[test]
    fn validate_event_expression_rejects_semicolon_comment() {
        assert!(validate_event_expression("a;--b", "condition").is_err());
    }

    // ----- validate_default_value -----

    #[test]
    fn validate_default_value_accepts_literals() {
        assert!(validate_default_value("42").is_ok());
        assert!(validate_default_value("-1").is_ok());
        assert!(validate_default_value("3.14").is_ok());
        assert!(validate_default_value("true").is_ok());
        assert!(validate_default_value("false").is_ok());
        assert!(validate_default_value("NONE").is_ok());
        assert!(validate_default_value("NULL").is_ok());
        assert!(validate_default_value("'hello'").is_ok());
        assert!(validate_default_value("time::now()").is_ok());
        assert!(validate_default_value("$auth").is_ok());
    }

    #[test]
    fn validate_default_value_rejects_unsafe() {
        assert!(validate_default_value("a; DROP TABLE u").is_err());
        assert!(validate_default_value("SELECT * FROM u").is_err());
    }

    // ----- diff_tables: ADD -----

    #[test]
    fn diff_tables_adds_new_table() {
        let code = vec![tbl("user")];
        let db: Vec<TableDefinition> = vec![];
        let diffs = diff_tables(&code, &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::AddTable);
        assert_eq!(diffs[0].table, "user");
        assert!(diffs[0].forward_sql.starts_with("DEFINE TABLE user"));
        assert_eq!(diffs[0].backward_sql, "REMOVE TABLE user;");
    }

    #[test]
    fn diff_tables_adds_new_table_with_field_and_index() {
        let code_table = tbl("user")
            .with_fields([f("email", FieldType::String)])
            .with_indexes([unique_index("email_idx", ["email"])]);
        let diffs = diff_tables(&[code_table], &[]);
        // 1 table + 1 field + 1 index = 3 diffs.
        assert_eq!(diffs.len(), 3);
        assert_eq!(diffs[0].operation, DiffOperation::AddTable);
        assert!(diffs.iter().any(|d| d.operation == DiffOperation::AddField));
        assert!(diffs.iter().any(|d| d.operation == DiffOperation::AddIndex));
    }

    #[test]
    fn diff_tables_adds_table_with_event_and_perms() {
        let code_table = tbl("user")
            .with_events([event("on_upd", "true", "RETURN 1")])
            .with_permissions([("select", "true")]);
        let diffs = diff_tables(&[code_table], &[]);
        // table + event + perms
        assert_eq!(diffs.len(), 3);
        assert!(diffs.iter().any(|d| d.operation == DiffOperation::AddEvent));
        assert!(diffs
            .iter()
            .any(|d| d.operation == DiffOperation::ModifyPermissions));
    }

    // ----- diff_tables: DROP -----

    #[test]
    fn diff_tables_drops_missing_table() {
        let db = vec![tbl("old").with_mode(TableMode::Schemaless)];
        let diffs = diff_tables(&[], &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropTable);
        assert_eq!(diffs[0].forward_sql, "REMOVE TABLE old;");
        assert_eq!(diffs[0].backward_sql, "DEFINE TABLE old SCHEMALESS;");
    }

    // ----- diff_tables: MODIFY (no-op when identical) -----

    #[test]
    fn diff_tables_identical_produces_no_diff() {
        let a = tbl("user").with_fields([f("email", FieldType::String)]);
        let diffs = diff_tables(std::slice::from_ref(&a), std::slice::from_ref(&a));
        assert!(diffs.is_empty());
    }

    // ----- diff_fields: ADD / DROP / MODIFY -----

    #[test]
    fn diff_fields_detects_added() {
        let code = vec![f("email", FieldType::String)];
        let diffs = diff_fields("user", &code, &[]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::AddField);
        assert_eq!(diffs[0].field.as_deref(), Some("email"));
        assert!(diffs[0].forward_sql.contains("DEFINE FIELD email"));
        assert!(diffs[0].backward_sql.contains("REMOVE FIELD email"));
    }

    #[test]
    fn diff_fields_detects_dropped() {
        let db = vec![f("old", FieldType::String)];
        let diffs = diff_fields("user", &[], &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropField);
        assert!(diffs[0].forward_sql.contains("REMOVE FIELD old"));
        assert!(diffs[0].backward_sql.contains("DEFINE FIELD old"));
    }

    #[test]
    fn diff_fields_detects_modified_type() {
        let code = vec![f("age", FieldType::Int)];
        let db = vec![f("age", FieldType::String)];
        let diffs = diff_fields("user", &code, &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::ModifyField);
        assert_eq!(
            diffs[0].details.get("old_type"),
            Some(&serde_json::json!("string"))
        );
        assert_eq!(
            diffs[0].details.get("new_type"),
            Some(&serde_json::json!("int"))
        );
    }

    #[test]
    fn diff_fields_identical_yields_nothing() {
        let a = vec![f("x", FieldType::Int)];
        assert!(diff_fields("t", &a, &a).is_empty());
    }

    #[test]
    fn diff_fields_whitespace_different_assertion_is_not_a_diff() {
        let code = vec![f("x", FieldType::Int).with_assertion("$value  > 0")];
        let db = vec![f("x", FieldType::Int).with_assertion("$value > 0")];
        assert!(diff_fields("t", &code, &db).is_empty());
    }

    #[test]
    fn diff_fields_modify_detects_assertion_semantic_change() {
        let code = vec![f("x", FieldType::Int).with_assertion("$value > 0")];
        let db = vec![f("x", FieldType::Int).with_assertion("$value >= 0")];
        let diffs = diff_fields("t", &code, &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::ModifyField);
    }

    #[test]
    fn diff_fields_add_with_default_emits_backfill() {
        let code = vec![f("age", FieldType::Int).with_default("0")];
        let diffs = diff_fields("user", &code, &[]);
        assert!(diffs[0].forward_sql.contains("DEFAULT 0"));
        assert!(diffs[0]
            .forward_sql
            .contains("UPDATE user SET age = 0 WHERE age IS NONE;"));
    }

    #[test]
    fn diff_fields_add_with_unsafe_default_skips_backfill() {
        let code = vec![f("age", FieldType::Int).with_default("DROP TABLE x")];
        let diffs = diff_fields("user", &code, &[]);
        assert!(!diffs[0].forward_sql.contains("UPDATE"));
    }

    #[test]
    fn diff_fields_readonly_toggle_is_a_modify() {
        let code = vec![f("x", FieldType::Int).readonly(true)];
        let db = vec![f("x", FieldType::Int)];
        let diffs = diff_fields("t", &code, &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::ModifyField);
    }

    // ----- diff_indexes -----

    #[test]
    fn diff_indexes_detects_added_standard() {
        let code = vec![index("title_idx", ["title"])];
        let diffs = diff_indexes("post", &code, &[]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::AddIndex);
        assert_eq!(
            diffs[0].forward_sql,
            "DEFINE INDEX title_idx ON TABLE post COLUMNS title;"
        );
    }

    #[test]
    fn diff_indexes_detects_added_unique() {
        let code = vec![unique_index("email_idx", ["email"])];
        let diffs = diff_indexes("user", &code, &[]);
        assert!(diffs[0].forward_sql.contains("UNIQUE"));
    }

    #[test]
    fn diff_indexes_detects_dropped() {
        let db = vec![index("old_idx", ["x"])];
        let diffs = diff_indexes("t", &[], &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropIndex);
        assert!(diffs[0].forward_sql.contains("REMOVE INDEX old_idx"));
        assert!(diffs[0].backward_sql.contains("DEFINE INDEX old_idx"));
    }

    #[test]
    fn diff_indexes_identical_yields_nothing() {
        let a = vec![index("x", ["a"])];
        assert!(diff_indexes("t", &a, &a).is_empty());
    }

    #[test]
    fn diff_indexes_added_mtree() {
        let idx = mtree_index(
            "e_idx",
            "embedding",
            1536,
            MTreeDistanceType::Cosine,
            MTreeVectorType::F32,
        );
        let diffs = diff_indexes("doc", &[idx], &[]);
        assert_eq!(diffs.len(), 1);
        assert!(diffs[0].forward_sql.contains("MTREE DIMENSION 1536"));
        assert!(diffs[0].forward_sql.contains("DIST COSINE"));
        assert!(diffs[0].forward_sql.contains("TYPE F32"));
    }

    #[test]
    fn diff_indexes_dropped_mtree_recreates_in_backward() {
        let idx = mtree_index(
            "e_idx",
            "embedding",
            8,
            MTreeDistanceType::Euclidean,
            MTreeVectorType::F64,
        );
        let diffs = diff_indexes("doc", &[], &[idx]);
        assert!(diffs[0].forward_sql.starts_with("REMOVE INDEX e_idx"));
        assert!(diffs[0].backward_sql.contains("MTREE DIMENSION 8"));
    }

    #[test]
    fn diff_indexes_added_hnsw() {
        let idx = hnsw_index(
            "h_idx",
            "v",
            64,
            HnswDistanceType::Cosine,
            MTreeVectorType::F32,
            Some(200),
            Some(16),
        );
        let diffs = diff_indexes("doc", &[idx], &[]);
        let sql = &diffs[0].forward_sql;
        assert!(sql.contains("HNSW DIMENSION 64"));
        assert!(sql.contains("DIST COSINE"));
        assert!(sql.contains("EFC 200"));
        assert!(sql.contains("M 16"));
    }

    #[test]
    fn diff_indexes_added_hnsw_without_tuning() {
        let idx = hnsw_index(
            "h_idx",
            "v",
            64,
            HnswDistanceType::Euclidean,
            MTreeVectorType::F64,
            None,
            None,
        );
        let diffs = diff_indexes("doc", &[idx], &[]);
        let sql = &diffs[0].forward_sql;
        assert!(!sql.contains("EFC"));
    }

    #[test]
    fn diff_indexes_search_index_emits_search_keyword() {
        let idx = IndexDefinition::new("s_idx", ["body"]).with_type(IndexType::Search);
        let diffs = diff_indexes("post", &[idx], &[]);
        assert!(diffs[0].forward_sql.contains("SEARCH"));
    }

    // ----- diff_events -----

    #[test]
    fn diff_events_detects_added() {
        let ev = event("on_upd", "true", "RETURN 1");
        let diffs = diff_events("t", &[ev], &[]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::AddEvent);
        assert_eq!(diffs[0].event.as_deref(), Some("on_upd"));
        assert!(diffs[0].forward_sql.contains("DEFINE EVENT on_upd"));
    }

    #[test]
    fn diff_events_detects_dropped() {
        let ev = event("on_upd", "true", "RETURN 1");
        let diffs = diff_events("t", &[], &[ev]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropEvent);
        assert!(diffs[0].forward_sql.starts_with("REMOVE EVENT on_upd"));
    }

    #[test]
    fn diff_events_identical_yields_nothing() {
        let ev = event("on_upd", "true", "RETURN 1");
        let a = vec![ev];
        assert!(diff_events("t", &a, &a).is_empty());
    }

    // ----- diff_permissions -----

    #[test]
    fn diff_permissions_added() {
        let mut new_perms = BTreeMap::new();
        new_perms.insert("select".into(), "true".into());
        let diffs = diff_permissions("t", Some(&new_perms), None);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::ModifyPermissions);
        assert!(diffs[0].forward_sql.contains("FOR SELECT"));
        assert_eq!(diffs[0].backward_sql, "");
    }

    #[test]
    fn diff_permissions_removed_roundtrip() {
        let mut old_perms = BTreeMap::new();
        old_perms.insert("select".into(), "$auth.id = id".into());
        let diffs = diff_permissions("t", None, Some(&old_perms));
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].forward_sql, "");
        assert!(diffs[0].backward_sql.contains("$auth.id = id"));
    }

    #[test]
    fn diff_permissions_modified_carries_old_in_backward() {
        let mut old_perms = BTreeMap::new();
        old_perms.insert("select".into(), "$auth.id = id".into());
        let mut new_perms = BTreeMap::new();
        new_perms.insert("select".into(), "true".into());

        let diffs = diff_permissions("t", Some(&new_perms), Some(&old_perms));
        assert_eq!(diffs.len(), 1);
        assert!(diffs[0].forward_sql.contains("true"));
        assert!(diffs[0].backward_sql.contains("$auth.id = id"));
    }

    #[test]
    fn diff_permissions_identical_yields_nothing() {
        let mut p = BTreeMap::new();
        p.insert("select".into(), "true".into());
        assert!(diff_permissions("t", Some(&p), Some(&p)).is_empty());
    }

    #[test]
    fn diff_permissions_whitespace_variance_is_equal() {
        let mut code = BTreeMap::new();
        code.insert("select".into(), "$auth.id  =  id".into());
        let mut db = BTreeMap::new();
        db.insert("select".into(), "$auth.id = id".into());
        assert!(diff_permissions("t", Some(&code), Some(&db)).is_empty());
    }

    #[test]
    fn diff_permissions_none_and_empty_are_equal() {
        let empty: BTreeMap<String, String> = BTreeMap::new();
        assert!(diff_permissions("t", Some(&empty), None).is_empty());
        assert!(diff_permissions("t", None, Some(&empty)).is_empty());
    }

    // ----- diff_edges: ADD / DROP / MODIFY -----

    fn relation_edge(name: &str) -> EdgeDefinition {
        EdgeDefinition::new(name)
            .with_mode(EdgeMode::Relation)
            .with_from_table("user")
            .with_to_table("post")
    }

    #[test]
    fn diff_edges_detects_added_relation() {
        let code = vec![relation_edge("likes")];
        let diffs = diff_edges(&code, &[]);
        assert!(!diffs.is_empty());
        assert_eq!(diffs[0].operation, DiffOperation::AddTable);
        assert!(diffs[0].forward_sql.contains("TYPE RELATION"));
        assert!(diffs[0].forward_sql.contains("FROM user"));
        assert!(diffs[0].forward_sql.contains("TO post"));
    }

    #[test]
    fn diff_edges_detects_added_schemafull() {
        let code = vec![EdgeDefinition::new("rel").with_mode(EdgeMode::Schemafull)];
        let diffs = diff_edges(&code, &[]);
        assert_eq!(diffs.len(), 1);
        assert!(diffs[0].forward_sql.contains("SCHEMAFULL"));
    }

    #[test]
    fn diff_edges_detects_dropped() {
        let db = vec![relation_edge("likes")];
        let diffs = diff_edges(&[], &db);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropTable);
        assert!(diffs[0].forward_sql.starts_with("REMOVE TABLE likes"));
    }

    #[test]
    fn diff_edges_field_added() {
        let old = relation_edge("likes");
        let new = relation_edge("likes").with_fields([f("weight", FieldType::Int)]);
        let diffs = diff_edges(&[new], &[old]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::AddField);
        assert_eq!(diffs[0].field.as_deref(), Some("weight"));
    }

    #[test]
    fn diff_edges_field_removed() {
        let old = relation_edge("likes").with_fields([f("weight", FieldType::Int)]);
        let new = relation_edge("likes");
        let diffs = diff_edges(&[new], &[old]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::DropField);
    }

    #[test]
    fn diff_edges_field_modified() {
        let old = relation_edge("likes").with_fields([f("weight", FieldType::Int)]);
        let new = relation_edge("likes").with_fields([f("weight", FieldType::Float)]);
        let diffs = diff_edges(&[new], &[old]);
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].operation, DiffOperation::ModifyField);
    }

    #[test]
    fn diff_edges_index_and_event_and_perms() {
        let old = relation_edge("likes");
        let new = relation_edge("likes")
            .with_indexes([index("w_idx", ["weight"])])
            .with_events([event("on_like", "true", "RETURN 1")])
            .with_permissions([("select", "true")]);
        let diffs = diff_edges(&[new], &[old]);
        let ops: BTreeSet<DiffOperation> = diffs.iter().map(|d| d.operation).collect();
        assert!(ops.contains(&DiffOperation::AddIndex));
        assert!(ops.contains(&DiffOperation::AddEvent));
        assert!(ops.contains(&DiffOperation::ModifyPermissions));
    }

    #[test]
    fn diff_edges_identical_yields_nothing() {
        let e = relation_edge("likes").with_fields([f("weight", FieldType::Int)]);
        assert!(diff_edges(std::slice::from_ref(&e), std::slice::from_ref(&e)).is_empty());
    }

    // ----- diff_schemas aggregator -----

    #[test]
    fn diff_schemas_empty_snapshots_are_equal() {
        let a = SchemaSnapshot::default();
        let b = SchemaSnapshot::default();
        assert!(diff_schemas(&a, &b).is_empty());
    }

    #[test]
    fn diff_schemas_add_tables_and_edges() {
        let code = SchemaSnapshot::from_parts([tbl("user")], [relation_edge("likes")]);
        let db = SchemaSnapshot::default();
        let diffs = diff_schemas(&code, &db);
        let ops: Vec<DiffOperation> = diffs.iter().map(|d| d.operation).collect();
        // At least one AddTable for the user table and one AddTable for the edge.
        assert!(
            ops.iter()
                .filter(|o| **o == DiffOperation::AddTable)
                .count()
                >= 2
        );
    }

    #[test]
    fn diff_schemas_drops_removed_items() {
        let code = SchemaSnapshot::default();
        let db = SchemaSnapshot::from_parts([tbl("old")], [relation_edge("old_rel")]);
        let diffs = diff_schemas(&code, &db);
        let drops = diffs
            .iter()
            .filter(|d| d.operation == DiffOperation::DropTable)
            .count();
        assert_eq!(drops, 2);
    }

    #[test]
    fn diff_schemas_handles_mixed_add_drop_modify() {
        let shared = tbl("user").with_fields([f("email", FieldType::String)]);
        let shared_modified = tbl("user").with_fields([f("email", FieldType::Int)]);
        let code = SchemaSnapshot::from_parts([tbl("new"), shared_modified], []);
        let db = SchemaSnapshot::from_parts([shared, tbl("obsolete")], []);
        let diffs = diff_schemas(&code, &db);
        let ops: BTreeSet<DiffOperation> = diffs.iter().map(|d| d.operation).collect();
        assert!(ops.contains(&DiffOperation::AddTable));
        assert!(ops.contains(&DiffOperation::DropTable));
        assert!(ops.contains(&DiffOperation::ModifyField));
    }

    // ----- pair-wise helpers -----

    #[test]
    fn diff_table_pair_add_is_same_as_slice_form() {
        let t = tbl("user");
        let pair = diff_table_pair(Some(&t), None);
        let slice = diff_tables(std::slice::from_ref(&t), &[]);
        assert_eq!(pair, slice);
    }

    #[test]
    fn diff_table_pair_drop_is_same_as_slice_form() {
        let t = tbl("user");
        let pair = diff_table_pair(None, Some(&t));
        let slice = diff_tables(&[], std::slice::from_ref(&t));
        assert_eq!(pair, slice);
    }

    #[test]
    fn diff_table_pair_none_none_is_empty() {
        assert!(diff_table_pair(None, None).is_empty());
    }

    #[test]
    fn diff_edge_pair_none_none_is_empty() {
        assert!(diff_edge_pair(None, None).is_empty());
    }

    #[test]
    fn diff_edge_pair_add_matches_slice_form() {
        let e = relation_edge("likes");
        let pair = diff_edge_pair(Some(&e), None);
        let slice = diff_edges(std::slice::from_ref(&e), &[]);
        assert_eq!(pair, slice);
    }

    // ----- round-trip & details shape -----

    #[test]
    fn modify_field_details_contains_both_types() {
        let code = vec![f("n", FieldType::Int)];
        let db = vec![f("n", FieldType::Float)];
        let diffs = diff_fields("t", &code, &db);
        assert_eq!(diffs.len(), 1);
        let d = &diffs[0];
        assert_eq!(d.details.get("old_type"), Some(&serde_json::json!("float")));
        assert_eq!(d.details.get("new_type"), Some(&serde_json::json!("int")));
    }

    #[test]
    fn add_field_details_contains_type() {
        let code = vec![f("age", FieldType::Int)];
        let diffs = diff_fields("u", &code, &[]);
        assert_eq!(
            diffs[0].details.get("type"),
            Some(&serde_json::json!("int"))
        );
    }

    #[test]
    fn diff_permissions_multiple_entries_render_space_separated() {
        let mut code = BTreeMap::new();
        code.insert("select".into(), "true".into());
        code.insert("create".into(), "true".into());
        let diffs = diff_permissions("t", Some(&code), None);
        let fwd = &diffs[0].forward_sql;
        // Two separate DEFINE FIELD PERMISSIONS statements.
        assert_eq!(fwd.matches("DEFINE FIELD PERMISSIONS").count(), 2);
    }

    #[test]
    fn event_action_is_wrapped_in_braces() {
        let ev = event("e", "true", "RETURN 1");
        let diffs = diff_events("t", &[ev], &[]);
        assert!(diffs[0].forward_sql.contains("THEN { RETURN 1 }"));
    }

    #[test]
    fn modify_field_preserves_name_as_context() {
        let code = vec![f("email", FieldType::String)];
        let db = vec![f("email", FieldType::Int)];
        let diffs = diff_fields("user", &code, &db);
        assert_eq!(diffs[0].table, "user");
        assert_eq!(diffs[0].field.as_deref(), Some("email"));
    }

    // ----- snapshot round-trip -----

    #[test]
    fn snapshot_serde_roundtrip() {
        let snap = SchemaSnapshot::from_parts([tbl("user")], [relation_edge("likes")]);
        let j = serde_json::to_string(&snap).unwrap();
        let back: SchemaSnapshot = serde_json::from_str(&j).unwrap();
        assert_eq!(snap, back);
    }

    #[test]
    fn snapshot_default_is_empty() {
        let s = SchemaSnapshot::default();
        assert!(s.tables.is_empty());
        assert!(s.edges.is_empty());
    }

    #[test]
    fn snapshot_new_matches_default() {
        assert_eq!(SchemaSnapshot::new(), SchemaSnapshot::default());
    }

    // ----- sorted_keys / index_by_name are tested indirectly via diff_* -----

    #[test]
    fn diff_tables_sort_stable_across_multiple_adds_drops() {
        let code = vec![tbl("a"), tbl("c")];
        let db = vec![tbl("b"), tbl("d")];
        let diffs = diff_tables(&code, &db);
        let adds: Vec<&str> = diffs
            .iter()
            .filter(|d| d.operation == DiffOperation::AddTable)
            .map(|d| d.table.as_str())
            .collect();
        let drops: Vec<&str> = diffs
            .iter()
            .filter(|d| d.operation == DiffOperation::DropTable)
            .map(|d| d.table.as_str())
            .collect();
        assert_eq!(adds, vec!["a", "c"]);
        assert_eq!(drops, vec!["b", "d"]);
    }

    #[test]
    fn field_expr_comparison_treats_value_whitespace() {
        let a = vec![f("x", FieldType::String).with_value("a  +  b")];
        let b = vec![f("x", FieldType::String).with_value("a + b")];
        assert!(diff_fields("t", &a, &b).is_empty());
    }

    #[test]
    fn field_expr_comparison_treats_default_whitespace() {
        let a = vec![f("x", FieldType::Int).with_default("42  ")];
        let b = vec![f("x", FieldType::Int).with_default("42")];
        assert!(diff_fields("t", &a, &b).is_empty());
    }
}