lix 0.12.3

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
use crate::support;
use std::collections::BTreeSet;

use lix::{CreateBranchOptions, ExecuteResult, MergeBranchOptions, SwitchBranchOptions, Value};
use lix::{engine::Engine, session::SessionContext};
use serde_json::json;

simulation_test!(engine_new_rejects_uninitialized_storage, |sim| async move {
    match Engine::new(sim.uninitialized_storage()).await {
        Ok(_) => panic!("uninitialized storage should not create an engine"),
        Err(error) => assert_eq!(error.code, "LIX_ERROR_NOT_INITIALIZED"),
    }
});

simulation_test!(
    engine_initialize_seeds_repository_bootstrap_state,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session_at("ffffffff-ffff-7fff-bfff-ffffffffffff")
                .await
                .expect("initialized storage should open global session"),
            &engine,
        );
        let main_session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("initialized storage should open main session"),
            &engine,
        );

        let branch_result = session
            .execute(
                "SELECT id, name, hidden \
             FROM lix_branch_descriptor \
             ORDER BY id",
                &[],
            )
            .await
            .expect("branch descriptors should be readable");
        let branch_rows = branch_result;
        assert_eq!(branch_rows.len(), 2);
        let branch_values = branch_rows
            .rows()
            .iter()
            .map(|row| row.values().to_vec())
            .collect::<Vec<_>>();
        assert!(branch_values.contains(&vec![
            Value::Text("ffffffff-ffff-7fff-bfff-ffffffffffff".to_string()),
            Value::Text("global".to_string()),
            Value::Boolean(true),
        ]));
        assert!(branch_values.contains(&vec![
            Value::Text(sim.main_branch_id().to_string()),
            Value::Text("main".to_string()),
            Value::Boolean(false),
        ]));

        let lix_id_result = session
            .execute("SELECT value FROM lix_key_value WHERE key = 'lix_id'", &[])
            .await
            .expect("lix_id key value should be readable");
        assert_single_json(lix_id_result, &format!("\"{}\"", sim.lix_id()));

        let refs_result = session
            .execute(
                "SELECT id, commit_id, lixcol_untracked \
             FROM lix_branch_ref \
             ORDER BY id",
                &[],
            )
            .await
            .expect("branch refs should be readable");
        let ref_rows = refs_result;
        assert_eq!(ref_rows.len(), 2);
        let ref_values = ref_rows
            .rows()
            .iter()
            .map(|row| row.values().to_vec())
            .collect::<Vec<_>>();
        assert!(ref_values.contains(&vec![
            Value::Text("ffffffff-ffff-7fff-bfff-ffffffffffff".to_string()),
            Value::Text(sim.initial_commit_id().to_string()),
            Value::Boolean(true),
        ]));
        assert!(ref_values.contains(&vec![
            Value::Text(sim.main_branch_id().to_string()),
            Value::Text(sim.initial_commit_id().to_string()),
            Value::Boolean(true),
        ]));

        drop(main_session);
        drop(session);
        drop(engine);
    }
);

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

        let uuid_result = session
            .execute("SELECT uuidv7()", &[])
            .await
            .expect("session should expose uuidv7 UDF");
        let uuid_rows = uuid_result;
        assert_eq!(uuid_rows.len(), 1);
        let Value::Text(uuid) = &uuid_rows.rows()[0].values()[0] else {
            panic!("uuidv7 should return text");
        };
        assert!(
            !uuid.is_empty(),
            "uuidv7 should return a non-empty UUID"
        );

        let insert_result = session
            .execute(
                "INSERT INTO lix_key_value (key, value) VALUES ('sql2-key', 'sql2-value')",
                &[],
            )
            .await
            .expect("session insert should succeed");
        assert_eq!(insert_result, ExecuteResult::from_rows_affected(1));

        let result = session
            .execute(
                "SELECT key, value FROM lix_key_value WHERE key = 'sql2-key'",
                &[],
            )
            .await
            .expect("session read should succeed");
        let row_set = result;
        assert_eq!(row_set.len(), 1);
        assert_eq!(
            row_set.rows()[0].values(),
            &[
                Value::Text("sql2-key".to_string()),
                Value::Jsonb(json!("sql2-value").into()),
            ]
        );
    }
);

simulation_test!(
    failed_write_validation_does_not_poison_session_transaction,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = engine
            .open_session()
            .await
            .expect("storage should open a session");

        register_poison_task_schema(&session).await;

        let error = session
            .execute(
                "INSERT INTO poison_task (id, title) VALUES ('bad-task', 'missing meta')",
                &[],
            )
            .await
            .expect_err("schema validation should reject missing required field");
        assert_eq!(error.code, "LIX_ERROR_SCHEMA_VALIDATION");

        assert_single_integer(
            session
                .execute("SELECT 1 AS ok", &[])
                .await
                .expect("read after failed write should succeed"),
            1,
        );

        let insert_result = session
            .execute(
                "INSERT INTO poison_task (id, title, meta) \
                 VALUES ('good-task', 'valid', CAST('{\"priority\":\"high\"}' AS JSONB))",
                &[],
            )
            .await
            .expect("valid write after failed write should succeed");
        assert_eq!(insert_result, ExecuteResult::from_rows_affected(1));
    }
);

simulation_test!(
    session_close_is_idempotent_and_rejects_later_operations,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = engine
            .open_session()
            .await
            .expect("storage should open a session");

        session.close().await.expect("first close should succeed");
        session.close().await.expect("second close should succeed");
        assert!(session.is_closed());

        assert_closed(
            session
                .execute("SELECT value FROM lix_key_value WHERE key = 'lix_id'", &[])
                .await
                .expect_err("execute after close should fail"),
        );
        assert_closed(
            session
                .active_branch_id()
                .await
                .expect_err("active_branch_id after close should fail"),
        );
        assert_closed(
            session
                .create_branch(CreateBranchOptions {
                    id: Some("01930000-0000-7000-8000-000000000005".to_string()),
                    name: "Closed".to_string(),
                    from_commit_id: None,
                })
                .await
                .expect_err("create_branch after close should fail"),
        );
        match session
            .switch_branch(SwitchBranchOptions {
                branch_id: sim.main_branch_id().to_string(),
            })
            .await
        {
            Ok(_) => panic!("switch_branch after close should fail"),
            Err(error) => assert_closed(error),
        }
        assert_closed(
            session
                .merge_branch(MergeBranchOptions {
                    source_branch_id: sim.main_branch_id().to_string(),
                })
                .await
                .expect_err("merge_branch after close should fail"),
        );
    }
);

async fn register_poison_task_schema(session: &SessionContext) {
    let schema = json!({
        "$schema": "https://lix.dev/schema-v1.json",
        "key": "poison_task",
        "columns": [
            { "name": "id", "type": "text", "nullable": false },
            { "name": "title", "type": "text", "nullable": false },
            { "name": "meta", "type": "jsonb", "nullable": false },
        ],
        "primary_key": ["id"],
    });

    session
        .execute(
            "INSERT INTO lix_registered_schema (value) VALUES (CAST($1 AS JSONB))",
            &[Value::Text(schema.to_string())],
        )
        .await
        .expect("schema registration should succeed");
}

simulation_test!(
    session_close_state_is_shared_with_cloned_session,
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = engine
            .open_session()
            .await
            .expect("storage should open a session");
        let cloned_session = session.clone();
        session
            .switch_branch(SwitchBranchOptions {
                branch_id: sim.main_branch_id().to_string(),
            })
            .await
            .expect("switch_branch should succeed before close");
        session.close().await.expect("close should succeed");

        assert_closed(
            cloned_session
                .active_branch_id()
                .await
                .expect_err("cloned session should observe closed state"),
        );
    }
);

simulation_test!(
    session_execute_persists_deterministic_function_sequence_across_sessions,
    options = support::simulation_test::engine::SimulationOptions {
        deterministic: false,
    },
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open first session"),
            &engine,
        );

        let mode_result = session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_global, lixcol_untracked) \
                 VALUES ('lix_deterministic_mode', \
                 '{\"enabled\":true}'::jsonb, true, true)",
                &[],
            )
            .await
            .expect("deterministic mode insert should succeed");
        assert_eq!(mode_result, ExecuteResult::from_rows_affected(1));

        assert_single_text(
            session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("first deterministic uuid should succeed"),
            "01920000-0000-7000-8000-000000000000",
        );
        assert_single_text(
            session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("second deterministic uuid should succeed"),
            "01920000-0000-7000-8000-000000000001",
        );

        let second_session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open second session"),
            &engine,
        );
        assert_single_text(
            second_session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("third deterministic uuid should succeed"),
            "01920000-0000-7000-8000-000000000002",
        );
        let write_result = second_session
            .execute(
                "INSERT INTO lix_key_value (key, value) \
					 VALUES ('det-write', 'ok')",
                &[],
            )
            .await
            .expect("deterministic write should succeed");
        assert_eq!(write_result, ExecuteResult::from_rows_affected(1));
        assert_single_text(
            second_session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("uuid after deterministic write should continue"),
            // The tracked write consumes deterministic values for row and
            // commit metadata, including the branch-ref ChangeRecord ID. The
            // commit's own change id is no longer among them — it is derived
            // from the commit id — so the write draws one fewer value than it
            // used to.
            "01920000-0000-7000-8000-000000000008",
        );
    }
);

simulation_test!(
    session_execute_does_not_persist_deterministic_sequence_after_failed_statement,
    options = support::simulation_test::engine::SimulationOptions {
        deterministic: false,
    },
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open a session"),
            &engine,
        );

        let mode_result = session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_global, lixcol_untracked) \
                 VALUES ('lix_deterministic_mode', \
                 CAST('{\"enabled\":true}' AS JSONB), true, true)",
                &[],
            )
            .await
            .expect("deterministic mode insert should succeed");
        assert_eq!(mode_result, ExecuteResult::from_rows_affected(1));

        let failed_read = session
            .execute("SELECT uuidv7() FROM missing_engine_table", &[])
            .await;
        assert!(
            failed_read.is_err(),
            "missing table query should fail before persisting deterministic sequence"
        );
        assert_single_text(
            session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("first deterministic uuid should still start at zero"),
            "01920000-0000-7000-8000-000000000000",
        );

        let failed_write = session
            .execute(
                "INSERT INTO missing_engine_table VALUES (uuidv7())",
                &[],
            )
            .await;
        assert!(
            failed_write.is_err(),
            "failed write should not persist deterministic sequence"
        );
        assert_single_text(
            session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("second deterministic uuid should continue after last success"),
            "01920000-0000-7000-8000-000000000001",
        );
    }
);

simulation_test!(
    concurrent_sessions_do_not_duplicate_deterministic_runtime_values,
    options = support::simulation_test::engine::SimulationOptions {
        deterministic: false,
    },
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open first session"),
            &engine,
        );
        session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_global, lixcol_untracked) \
                 VALUES ('lix_deterministic_mode', \
                 CAST('{\"enabled\":true}' AS JSONB), true, true)",
                &[],
            )
            .await
            .expect("deterministic mode insert should succeed");

        let second_session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open second session"),
            &engine,
        );

        let (first, second) = tokio::join!(
            session.execute("SELECT uuidv7()", &[]),
            second_session.execute("SELECT uuidv7()", &[])
        );
        let values = BTreeSet::from([
            single_text(first.expect("first deterministic uuid should succeed")),
            single_text(second.expect("second deterministic uuid should succeed")),
        ]);
        assert_eq!(
            values,
            BTreeSet::from([
                "01920000-0000-7000-8000-000000000000".to_string(),
                "01920000-0000-7000-8000-000000000001".to_string(),
            ])
        );

        assert_single_text(
            session
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("third deterministic uuid should continue"),
            "01920000-0000-7000-8000-000000000002",
        );
    }
);

simulation_test!(
    explicit_transaction_runtime_read_blocks_concurrent_sequence_read,
    options = support::simulation_test::engine::SimulationOptions {
        deterministic: false,
    },
    |sim| async move {
        let engine = sim.boot_engine().await;
        let session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open first session"),
            &engine,
        );
        session
            .execute(
                "INSERT INTO lix_key_value (key, value, lixcol_global, lixcol_untracked) \
                 VALUES ('lix_deterministic_mode', \
                 CAST('{\"enabled\":true}' AS JSONB), true, true)",
                &[],
            )
            .await
            .expect("deterministic mode insert should succeed");
        let second_session = sim.wrap_session(
            engine
                .open_session()
                .await
                .expect("storage should open second session"),
            &engine,
        );

        let mut transaction = session
            .begin_transaction()
            .await
            .expect("transaction should begin");
        assert_single_text(
            transaction
                .execute("SELECT uuidv7()", &[])
                .await
                .expect("transaction deterministic uuid should succeed"),
            "01920000-0000-7000-8000-000000000000",
        );

        let concurrent_read = second_session.execute("SELECT uuidv7()", &[]);
        let commit_after_yield = async {
            tokio::task::yield_now().await;
            transaction
                .commit()
                .await
                .expect("transaction should commit");
        };
        let ((), second_result) = tokio::join!(commit_after_yield, concurrent_read);
        assert_single_text(
            second_result.expect("concurrent deterministic uuid should succeed"),
            "01920000-0000-7000-8000-000000000001",
        );
    }
);

fn assert_single_text(result: ExecuteResult, expected: &str) {
    let row_set = result;
    assert_eq!(row_set.len(), 1);
    assert_eq!(
        row_set.rows()[0].values(),
        &[Value::Text(expected.to_string())]
    );
}

fn single_text(result: ExecuteResult) -> String {
    let row_set = result;
    assert_eq!(row_set.len(), 1);
    match &row_set.rows()[0].values()[0] {
        Value::Text(value) => value.clone(),
        other => panic!("expected a text result, got {other:?}"),
    }
}

fn assert_single_integer(result: ExecuteResult, expected: i64) {
    let row_set = result;
    assert_eq!(row_set.len(), 1);
    assert_eq!(row_set.rows()[0].values(), &[Value::Integer(expected)]);
}

fn assert_single_json(result: ExecuteResult, expected: &str) {
    let row_set = result;
    assert_eq!(row_set.len(), 1);
    let expected_json = serde_json::from_str::<serde_json::Value>(expected)
        .expect("expected JSON value should parse");
    assert_eq!(
        row_set.rows()[0].values(),
        &[Value::Jsonb(expected_json.into())]
    );
}

fn assert_closed(error: lix::LixError) {
    assert_eq!(error.code, lix::LixError::CODE_CLOSED);
    assert_eq!(error.message, "Lix handle is closed");
    assert_eq!(
        error.hint.as_deref(),
        Some("Open a new Lix handle before calling this method.")
    );
}