lix 0.12.1

Embeddable version control for apps and AI agents.
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
use lix::LixError;
use lix::Value;
use serde_json::json;

simulation_test!(
    metadata_rejects_invalid_json_on_lix_file_writes,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("main session should open"),
            &engine,
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "INSERT INTO lix_file (id, path, lixcol_metadata) \
                     VALUES ('6d657461-6461-8461-8d66-696c652d6900', '/6d657461-6461-8461-8d66-696c652d6900.txt', '{bad')",
                    &[],
                )
                .await
                .expect_err("invalid file metadata should be rejected on INSERT"),
        );

        session
            .execute(
                "INSERT INTO lix_file (id, path) \
                 VALUES ('6d657461-6461-8461-8d66-696c652d7500', '/6d657461-6461-8461-8d66-696c652d7500.txt')",
                &[],
            )
            .await
            .expect("file insert should succeed");

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_file \
                     SET lixcol_metadata = '{bad' \
                     WHERE id = '6d657461-6461-8461-8d66-696c652d7500'",
                    &[],
                )
                .await
                .expect_err("invalid file metadata should be rejected on UPDATE"),
        );
    }
);

simulation_test!(
    metadata_rejects_invalid_json_on_lix_directory_writes,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("main session should open"),
            &engine,
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "INSERT INTO lix_directory (id, path, lixcol_metadata) \
                     VALUES ('6d657461-6461-8461-8d64-69722d696e00', '/6d657461-6461-8461-8d64-69722d696e00', '{bad')",
                    &[],
                )
                .await
                .expect_err("invalid directory metadata should be rejected on INSERT"),
        );

        session
            .execute(
                "INSERT INTO lix_directory (id, path) \
                 VALUES ('6d657461-6461-8461-8d64-69722d757000', '/6d657461-6461-8461-8d64-69722d757000')",
                &[],
            )
            .await
            .expect("directory insert should succeed");

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_directory \
                     SET lixcol_metadata = '{bad' \
                     WHERE id = '6d657461-6461-8461-8d64-69722d757000'",
                    &[],
                )
                .await
                .expect_err("invalid directory metadata should be rejected on UPDATE"),
        );
    }
);

simulation_test!(
    metadata_narrow_filesystem_projections_keep_descriptor_rows,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("main session should open"),
            &engine,
        );

        let file_metadata = json!({"source": "66696c65-2d6e-8172-826f-770000000000"});
        session
            .execute(
                "INSERT INTO lix_file (id, path, lixcol_metadata) \
                 VALUES ('6d657461-6461-8461-8d6e-6172726f7700', '/6d657461-6461-8461-8d6e-6172726f7700.txt', $1)",
                &[Value::Jsonb(file_metadata.clone().into())],
            )
            .await
            .expect("file insert should succeed");

        let file_result = session
            .execute(
                "SELECT id, lixcol_metadata \
                 FROM lix_file \
                 WHERE id = '6d657461-6461-8461-8d6e-6172726f7700'",
                &[],
            )
            .await
            .expect("narrow file metadata read should succeed");
        assert_metadata_value(file_result, "lixcol_metadata", &file_metadata);

        let directory_metadata = json!({"source": "64697265-6374-8f72-892d-6e6172726f00"});
        session
            .execute(
                "INSERT INTO lix_directory (id, path, lixcol_metadata) \
                 VALUES ('6d657461-6461-8461-8d6e-6172726f7700', '/6d657461-6461-8461-8d6e-6172726f7700', $1)",
                &[Value::Jsonb(directory_metadata.clone().into())],
            )
            .await
            .expect("directory insert should succeed");

        let directory_result = session
            .execute(
                "SELECT path, lixcol_metadata \
                 FROM lix_directory \
                 WHERE id = '6d657461-6461-8461-8d6e-6172726f7700'",
                &[],
            )
            .await
            .expect("narrow directory metadata read should succeed");
        assert_metadata_value(directory_result, "lixcol_metadata", &directory_metadata);
    }
);

simulation_test!(
    metadata_rejects_invalid_json_on_typed_row_writes,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("main session should open"),
            &engine,
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                     VALUES ('metadata-row-insert', 'value', '{bad')",
                    &[],
                )
                .await
                .expect_err("invalid typed row metadata should be rejected on INSERT"),
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                     VALUES ('metadata-row-json-null-insert', 'value', CAST('null' AS JSONB))",
                    &[],
                )
                .await
                .expect_err("JSON null typed row metadata should be rejected on INSERT"),
        );

        session
            .execute(
                    "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                     VALUES ('metadata-row-lix-json-sql-null-insert', 'value', CAST(NULL AS JSONB))",
                    &[],
                )
                .await
                .expect("CAST(NULL AS JSONB) is SQL NULL metadata");

        session
            .execute(
                "INSERT INTO lix_key_value (key, value) \
                 VALUES ('metadata-row-json-null-value', CAST(NULL AS JSONB))",
                &[],
            )
            .await
            .expect("CAST(NULL AS JSONB) should be accepted for JSON row columns");
        assert_metadata_null(
            session
                .execute(
                    "SELECT value \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-json-null-value'",
                    &[],
                )
                .await
                .expect("JSON null row value should read"),
            "value",
        );

        session
            .execute(
                "INSERT INTO lix_key_value (key, value) \
                 VALUES ('metadata-row-json-string-value', CAST('\"{\\\"source\\\":\\\"json-string\\\"}\"' AS JSONB))",
                &[],
            )
            .await
            .expect("JSON string row value should be accepted");
        assert_metadata_value(
            session
                .execute(
                    "SELECT value \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-json-string-value'",
                    &[],
                )
                .await
                .expect("JSON string row value should read"),
            "value",
            &json!("{\"source\":\"json-string\"}"),
        );

        session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                 VALUES ('metadata-row-sql-null-insert', 'value', NULL)",
                &[],
            )
            .await
            .expect("SQL NULL typed row metadata should be accepted on INSERT");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-sql-null-insert'",
                    &[],
                )
                .await
                .expect("SQL NULL insert metadata should read as NULL"),
            "lixcol_metadata",
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                     VALUES ('metadata-row-json-null-param-insert', 'value', $1)",
                    &[Value::Jsonb(json!(null).into())],
                )
                .await
                .expect_err("JSON null parameter metadata should be rejected on INSERT"),
        );

        session
            .execute(
                "INSERT INTO lix_key_value (key, value) \
                 VALUES ('metadata-row-update', NULL)",
                &[],
            )
            .await
            .expect("typed row insert should succeed");

        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = lixcol_metadata \
                 WHERE key = 'metadata-row-update'",
                &[],
            )
            .await
            .expect("metadata column SQL NULL should be preserved on UPDATE");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("metadata column SQL NULL should read as NULL"),
            "lixcol_metadata",
        );

        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = CAST('{}' AS JSONB) -> 'missing' \
                 WHERE key = 'metadata-row-update'",
                &[],
            )
            .await
            .expect("metadata expression SQL NULL should be accepted on UPDATE");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("metadata expression SQL NULL should read as NULL"),
            "lixcol_metadata",
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = CAST('{\"m\":null}' AS JSONB) -> 'm' \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect_err("JSON null from lix_json_get should be rejected as metadata"),
        );

        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = CAST('{\"m\":null}' AS JSONB) ->> 'm' \
                 WHERE key = 'metadata-row-update'",
                &[],
            )
            .await
            .expect("JSON null from lix_json_get_text should be accepted as SQL NULL metadata");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("lix_json_get_text JSON null metadata assignment should read as NULL"),
            "lixcol_metadata",
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect_err("visible JSON null column should be rejected as metadata"),
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = CAST('{\"m\":\"{\\\"source\\\":\\\"json-string\\\"}\"}' AS JSONB) -> 'm' \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect_err("JSON string from lix_json_get should not be reparsed as metadata text"),
        );

        session
            .execute(
                "INSERT INTO lix_key_value (key, value) \
                 VALUES ('{\"source\":\"from-key\"}', 'metadata-source')",
                &[],
            )
            .await
            .expect("typed row insert with JSON-shaped string key should succeed");
        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = key \
                 WHERE key = '{\"source\":\"from-key\"}'",
                &[],
            )
            .await
            .expect("SQL text visible column should be parsed as metadata text");
        assert_metadata_value(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = '{\"source\":\"from-key\"}'",
                    &[],
                )
                .await
                .expect("metadata from SQL text column should read as JSON"),
            "lixcol_metadata",
            &json!({"source": "from-key"}),
        );

        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = CAST('\"{\\\"m\\\":{\\\"source\\\":\\\"json-string-root\\\"}}\"' AS JSONB) -> 'm' \
                 WHERE key = 'metadata-row-update'",
                &[],
            )
            .await
            .expect("JSON string root should not be reparsed by lix_json_get");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("metadata should remain NULL when JSON string root is not reparsed"),
            "lixcol_metadata",
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = '{bad' \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect_err("invalid typed row metadata should be rejected on UPDATE"),
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = CAST('null' AS JSONB) \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect_err("JSON null typed row metadata should be rejected on UPDATE"),
        );

        session
            .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = CAST(NULL AS JSONB) \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("CAST(NULL AS JSONB) is SQL NULL metadata on UPDATE");

        session
            .execute(
                "UPDATE lix_key_value \
                 SET lixcol_metadata = $1 \
                 WHERE key = 'metadata-row-update'",
                &[Value::Null],
            )
            .await
            .expect("SQL NULL parameter metadata should be accepted on UPDATE");
        assert_metadata_null(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-row-update'",
                    &[],
                )
                .await
                .expect("SQL NULL parameter update metadata should read as NULL"),
            "lixcol_metadata",
        );

        assert_invalid_metadata_error(
            session
                .execute(
                    "UPDATE lix_key_value \
                     SET lixcol_metadata = $1 \
                     WHERE key = 'metadata-row-update'",
                    &[Value::Jsonb(json!(null).into())],
                )
                .await
                .expect_err("JSON null parameter metadata should be rejected on UPDATE"),
        );
    }
);

simulation_test!(
    valid_object_metadata_survives_live_change_and_history_reads,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("main session should open"),
            &engine,
        );
        let expected = json!({
            "source": "metadata-regression",
            "nested": {"ok": true}
        });

        session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_metadata) \
                 VALUES (\
                 'metadata-valid-object', \
                 'value', \
                 '{\"source\":\"metadata-regression\",\"nested\":{\"ok\":true}}'\
                 )",
                &[],
            )
            .await
            .expect("valid object metadata should write");
        let commit_id = engine
            .load_branch_head_commit_id(sim.main_branch_id())
            .await
            .expect("head commit should load")
            .expect("head commit should exist");

        assert_metadata_value(
            session
                .execute(
                    "SELECT lixcol_metadata \
                     FROM lix_key_value \
                     WHERE key = 'metadata-valid-object'",
                    &[],
                )
                .await
                .expect("typed row metadata should read"),
            "lixcol_metadata",
            &expected,
        );

        assert_metadata_value(
            session
                .execute(
                    "SELECT metadata \
                     FROM lix_change \
                     WHERE row_pk = CAST('[\"metadata-valid-object\"]' AS JSONB) \
                       AND schema_key = 'lix_key_value'",
                    &[],
                )
                .await
                .expect("lix_change metadata should read"),
            "metadata",
            &expected,
        );

        assert_metadata_value(
            session
                .execute(
                    &format!(
                        "SELECT lixcol_metadata \
                         FROM lix_key_value_history('{commit_id}') \
                           WHERE key = 'metadata-valid-object'"
                    ),
                    &[],
                )
                .await
                .expect("typed history metadata should read"),
            "lixcol_metadata",
            &expected,
        );
    }
);

fn assert_invalid_metadata_error(error: LixError) {
    assert!(
        matches!(
            error.code.as_str(),
            "LIX_ERROR_INVALID_JSON"
                | LixError::CODE_SCHEMA_VALIDATION
                | LixError::CODE_INVALID_PARAM
        ),
        "expected invalid metadata public error, got {error:?}"
    );
    assert!(
        error.message.contains("metadata") && error.message.contains("JSON"),
        "error should identify metadata JSON, got {error:?}"
    );
}

fn assert_metadata_value(result: lix::ExecuteResult, column: &str, expected: &serde_json::Value) {
    assert_eq!(result.len(), 1, "expected one metadata row");
    let value = result.rows()[0]
        .get::<Value>(column)
        .unwrap_or_else(|_| panic!("{column} should be present"));
    assert_eq!(value, Value::Jsonb(expected.clone().into()));
}

fn assert_metadata_null(result: lix::ExecuteResult, column: &str) {
    assert_eq!(result.len(), 1, "expected one metadata row");
    let value = result.rows()[0]
        .get::<Value>(column)
        .unwrap_or_else(|_| panic!("{column} should be present"));
    assert_eq!(value, Value::Null);
}