veilid-core 0.5.3

Core library used to create a Veilid node and operate it as part of an application
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
use crate::tests_crypto::*;

use super::*;

// Mirror of WASM VeilidRoutingContext DHT transaction tests
// Simple test parameters
const SIMPLE_DHT_RECORD_COUNT: usize = 4;
const SIMPLE_DHT_SUBKEY_SIZE: usize = 16;
const SIMPLE_DHT_SUBKEY_COUNT: u32 = 2;

// Full records test parameters
const FULL_DHT_RECORD_COUNT: usize = 4;
const FULL_DHT_SUBKEY_SIZE: usize = 32768;
const FULL_DHT_SUBKEY_COUNT: u32 = 16;

fn make_test_data(record_count: usize, subkey_size: usize) -> Vec<Vec<u8>> {
    (0..record_count)
        .map(|rec| vec![rec as u8; subkey_size])
        .collect()
}

async fn create_dht_records(
    rc: &RoutingContext,
    record_count: usize,
    subkey_count: u32,
) -> Vec<RecordKey> {
    let mut keys = Vec::new();
    for _ in 0..record_count {
        let rec = rc
            .create_dht_record(
                TEST_CRYPTO_KIND,
                DHTSchema::dflt(subkey_count as u16).unwrap(),
                None,
            )
            .await
            .expect("should create DHT record");
        keys.push(rec.key());
    }
    keys
}

async fn delete_dht_records(rc: &RoutingContext, keys: &[RecordKey]) {
    for key in keys {
        rc.delete_dht_record(key.clone())
            .await
            .expect("should delete DHT record");
    }
}

async fn test_create_empty_transaction_and_drop(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");
    drop(tx);

    delete_dht_records(&rc, &keys).await;
}

async fn test_create_empty_transaction_and_rollback(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");
    tx.rollback().await.expect("should rollback");

    delete_dht_records(&rc, &keys).await;
}

async fn test_create_empty_transaction_and_commit(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");
    tx.commit().await.expect("should commit");

    delete_dht_records(&rc, &keys).await;
}

async fn test_transaction_sets_and_rollback(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_SIZE);

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let res = tx
            .set(keys[rec].clone(), 0, data[rec].clone(), None)
            .await
            .expect("set should succeed");
        assert!(res.is_none(), "set should return None");
    }

    tx.rollback().await.expect("should rollback");
    delete_dht_records(&rc, &keys).await;
}

async fn test_transaction_sets_and_commit(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_SIZE);

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let res = tx
            .set(keys[rec].clone(), 0, data[rec].clone(), None)
            .await
            .expect("set should succeed");
        assert!(res.is_none(), "set should return None");
    }

    tx.commit().await.expect("should commit");
    delete_dht_records(&rc, &keys).await;
}

async fn test_transaction_sets_gets_and_commit(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_SIZE);

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    let mut set_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        let d = data[rec].clone();
        set_futs.push(async move { tx.set(key, 0, d, None).await });
    }
    let set_results = futures_util::future::join_all(set_futs).await;
    for res in set_results {
        assert!(
            res.expect("set should succeed").is_none(),
            "set should return None"
        );
    }

    let mut get_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        get_futs.push(async move { tx.get(key, 0).await });
    }
    let get_results = futures_util::future::join_all(get_futs).await;
    for res in get_results {
        assert!(
            res.expect("get should succeed").is_none(),
            "get should return None before commit"
        );
    }

    tx.commit().await.expect("should commit");
    delete_dht_records(&rc, &keys).await;
}

async fn test_transaction_fail_non_transactional_sets(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_SIZE);

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    let mut set_futs = Vec::new();
    for subkey in 0..SIMPLE_DHT_SUBKEY_COUNT {
        for rec in 0..SIMPLE_DHT_RECORD_COUNT {
            let rc = rc.clone();
            let key = keys[rec].clone();
            let d = data[rec].clone();
            set_futs
                .push(async move { rc.set_dht_value(key, subkey as ValueSubkey, d, None).await });
        }
    }
    let set_results = futures_util::future::join_all(set_futs).await;
    let mut had_try_again = false;
    for res in set_results {
        if let Err(e) = res {
            match e {
                VeilidAPIError::TryAgain { .. } => {
                    had_try_again = true;
                }
                _ => panic!("expected TryAgain error, got: {}", e),
            }
        }
    }
    assert!(
        had_try_again,
        "should have gotten at least one TryAgain error"
    );

    tx.rollback().await.expect("should rollback");
    delete_dht_records(&rc, &keys).await;
}

async fn test_transaction_inspect_set_commit_then_get(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(SIMPLE_DHT_RECORD_COUNT, SIMPLE_DHT_SUBKEY_SIZE);

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    let mut inspect_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        inspect_futs.push(async move { tx.inspect(key, None, DHTReportScope::SyncGet).await });
    }
    let inspect_results = futures_util::future::join_all(inspect_futs).await;
    for report in inspect_results {
        let report = report.expect("inspect should succeed");
        assert_eq!(
            report.local_seqs(),
            &vec![ValueSeqNum::NONE; SIMPLE_DHT_SUBKEY_COUNT as usize],
            "local seqs should all be None"
        );
        assert_eq!(
            report.network_seqs(),
            &vec![ValueSeqNum::NONE; SIMPLE_DHT_SUBKEY_COUNT as usize],
            "network seqs should all be None"
        );
    }

    let mut set_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        let d = data[rec].clone();
        set_futs.push(async move { tx.set(key, 1, d, None).await });
    }
    let set_results = futures_util::future::join_all(set_futs).await;
    for res in set_results {
        assert!(
            res.expect("set should succeed").is_none(),
            "set should return None"
        );
    }

    let mut inspect_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        inspect_futs.push(async move { tx.inspect(key, None, DHTReportScope::SyncGet).await });
    }
    let inspect_results = futures_util::future::join_all(inspect_futs).await;
    for report in inspect_results {
        let report = report.expect("inspect should succeed");
        assert_eq!(
            report.local_seqs(),
            &vec![ValueSeqNum::NONE; SIMPLE_DHT_SUBKEY_COUNT as usize],
            "local seqs should still all be None before commit"
        );
        assert_eq!(
            report.network_seqs(),
            &vec![ValueSeqNum::NONE; SIMPLE_DHT_SUBKEY_COUNT as usize],
            "network seqs should still all be None before commit"
        );
    }

    tx.commit().await.expect("should commit");

    let tx2 = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction 2");

    let mut inspect_futs = Vec::new();
    for rec in 0..SIMPLE_DHT_RECORD_COUNT {
        let tx2 = tx2.clone();
        let key = keys[rec].clone();
        inspect_futs.push(async move { tx2.inspect(key, None, DHTReportScope::SyncGet).await });
    }
    let inspect_results = futures_util::future::join_all(inspect_futs).await;
    let expected_local_seqs: Vec<ValueSeqNum> = vec![ValueSeqNum::NONE, ValueSeqNum::ZERO];
    let expected_network_seqs: Vec<ValueSeqNum> = vec![ValueSeqNum::NONE, ValueSeqNum::ZERO];
    for report in inspect_results {
        let report = report.expect("inspect should succeed");
        assert_eq!(
            report.local_seqs(),
            &expected_local_seqs,
            "local seqs should show subkey 1 as seq 0"
        );
        assert_eq!(
            report.network_seqs(),
            &expected_network_seqs,
            "network seqs should show subkey 1 as seq 0"
        );
    }

    let expected = [None, Some(0u32)];
    for subkey in 0..SIMPLE_DHT_SUBKEY_COUNT {
        let mut get_futs = Vec::new();
        for rec in 0..SIMPLE_DHT_RECORD_COUNT {
            let tx2 = tx2.clone();
            let key = keys[rec].clone();
            get_futs.push(async move { (rec, tx2.get(key, subkey as ValueSubkey).await) });
        }
        let get_results = futures_util::future::join_all(get_futs).await;
        for (rec, res) in get_results {
            let val = res.expect("get should succeed");
            if expected[subkey as usize].is_none() {
                assert!(val.is_none(), "subkey {} should be None", subkey);
            } else {
                let val = val.unwrap_or_else(|| {
                    panic!("subkey {} should have data for rec {}", subkey, rec)
                });
                assert_eq!(val.data(), data[rec], "data should match");
                assert_eq!(val.seq(), 0.into(), "seq should be 0");
            }
        }
    }

    tx2.commit().await.expect("should commit tx2");
    delete_dht_records(&rc, &keys).await;
}

async fn test_full_records_inspect_and_gets(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, FULL_DHT_RECORD_COUNT, FULL_DHT_SUBKEY_COUNT).await;

    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");

    let mut inspect_futs = Vec::new();
    for rec in 0..FULL_DHT_RECORD_COUNT {
        let tx = tx.clone();
        let key = keys[rec].clone();
        inspect_futs.push(async move { tx.inspect(key, None, DHTReportScope::SyncGet).await });
    }
    let inspect_results = futures_util::future::join_all(inspect_futs).await;
    let expected_seqs = vec![ValueSeqNum::NONE; FULL_DHT_SUBKEY_COUNT as usize];
    for report in inspect_results {
        let report = report.expect("inspect should succeed");
        assert_eq!(report.local_seqs(), &expected_seqs);
        assert_eq!(report.network_seqs(), &expected_seqs);
    }

    for subkey in 0..FULL_DHT_SUBKEY_COUNT {
        let mut get_futs = Vec::new();
        for rec in 0..FULL_DHT_RECORD_COUNT {
            let tx = tx.clone();
            let key = keys[rec].clone();
            get_futs.push(async move { tx.get(key, subkey as ValueSubkey).await });
        }
        let get_results = futures_util::future::join_all(get_futs).await;
        for res in get_results {
            assert!(
                res.expect("get should succeed").is_none(),
                "should be None for empty record"
            );
        }
    }

    tx.commit().await.expect("should commit");
    delete_dht_records(&rc, &keys).await;
}

async fn test_full_records_fill_commit_then_get(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();
    let keys = create_dht_records(&rc, FULL_DHT_RECORD_COUNT, FULL_DHT_SUBKEY_COUNT).await;
    let data = make_test_data(FULL_DHT_RECORD_COUNT, FULL_DHT_SUBKEY_SIZE);

    let start = std::time::Instant::now();
    let tx = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction");
    info!("begin transaction: {:?}", start.elapsed());

    for subkey in 0..FULL_DHT_SUBKEY_COUNT {
        let start_set = std::time::Instant::now();
        let mut set_futs = Vec::new();
        for rec in 0..FULL_DHT_RECORD_COUNT {
            let tx = tx.clone();
            let key = keys[rec].clone();
            let d = data[rec].clone();
            set_futs.push(async move { tx.set(key, subkey as ValueSubkey, d, None).await });
        }
        let set_results = futures_util::future::join_all(set_futs).await;
        for res in set_results {
            assert!(
                res.expect("set should succeed").is_none(),
                "set should return None"
            );
        }
        info!("set subkey {}: {:?}", subkey, start_set.elapsed());
    }

    let start_commit = std::time::Instant::now();
    tx.commit().await.expect("should commit");
    info!("commit transaction: {:?}", start_commit.elapsed());

    let start_begin2 = std::time::Instant::now();
    let tx2 = api
        .transact_dht_records(keys.clone(), None)
        .await
        .expect("should create transaction 2");
    info!("begin transaction 2: {:?}", start_begin2.elapsed());

    for subkey in 0..FULL_DHT_SUBKEY_COUNT {
        let start_get = std::time::Instant::now();
        let mut get_futs = Vec::new();
        for rec in 0..FULL_DHT_RECORD_COUNT {
            let tx2 = tx2.clone();
            let key = keys[rec].clone();
            let d = data[rec].clone();
            get_futs.push(async move {
                let val = tx2.get(key, subkey as ValueSubkey).await;
                (rec, d, val)
            });
        }
        let get_results = futures_util::future::join_all(get_futs).await;
        for (rec, expected_data, res) in get_results {
            let val = res
                .unwrap_or_else(|e| panic!("get rec={} subkey={} failed: {}", rec, subkey, e))
                .unwrap_or_else(|| panic!("get rec={} subkey={} returned None", rec, subkey));
            assert_eq!(
                val.data(),
                expected_data,
                "data should match for rec={} subkey={}",
                rec,
                subkey
            );
            assert_eq!(
                val.seq(),
                0.into(),
                "seq should be 0 for rec={} subkey={}",
                rec,
                subkey
            );
        }
        info!("get subkey {}: {:?}", subkey, start_get.elapsed());
    }

    let start_rollback = std::time::Instant::now();
    tx2.rollback().await.expect("should rollback tx2");
    info!("rollback transaction 2: {:?}", start_rollback.elapsed());

    delete_dht_records(&rc, &keys).await;
}

pub async fn test_all() {
    let (update_callback, config) = fixture_veilid_core();
    let api = api_startup(update_callback, config)
        .await
        .expect("startup failed");

    let _ = api.attach().await;
    fixture_wait_for_public_internet_ready(&api).await;

    info!("=== Simple transaction tests ===");

    info!("--- test_create_empty_transaction_and_drop ---");
    test_create_empty_transaction_and_drop(api.clone()).await;

    info!("--- test_create_empty_transaction_and_rollback ---");
    test_create_empty_transaction_and_rollback(api.clone()).await;

    info!("--- test_create_empty_transaction_and_commit ---");
    test_create_empty_transaction_and_commit(api.clone()).await;

    info!("--- test_transaction_sets_and_rollback ---");
    test_transaction_sets_and_rollback(api.clone()).await;

    info!("--- test_transaction_sets_and_commit ---");
    test_transaction_sets_and_commit(api.clone()).await;

    info!("--- test_transaction_sets_gets_and_commit ---");
    test_transaction_sets_gets_and_commit(api.clone()).await;

    info!("--- test_transaction_fail_non_transactional_sets ---");
    test_transaction_fail_non_transactional_sets(api.clone()).await;

    info!("--- test_transaction_inspect_set_commit_then_get ---");
    test_transaction_inspect_set_commit_then_get(api.clone()).await;

    info!("=== Full records transaction tests ===");

    info!("--- test_full_records_inspect_and_gets ---");
    test_full_records_inspect_and_gets(api.clone()).await;

    info!("--- test_full_records_fill_commit_then_get ---");
    test_full_records_fill_commit_then_get(api.clone()).await;

    api.shutdown().await;
}