vstorage 0.6.0

Common API for various icalendar/vcard storages.
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
// Copyright 2023-2026 Hugo Osvaldo Barrera
//
// SPDX-License-Identifier: EUPL-1.2

mod common;

use std::sync::Arc;
use tempfile::tempdir;
use vstorage::ItemKind;
use vstorage::base::{CreateItemOptions, Storage};
use vstorage::sync::OneWaySync;
use vstorage::sync::declare::OnEmpty;
use vstorage::sync::plan::Plan;
use vstorage::sync::{
    declare::{StoragePair, SyncedCollection},
    execute::Executor,
    status::StatusDatabase,
};
use vstorage::vdir::VdirStorage;

use common::minimal_icalendar_with_uid;

#[tokio::test]
async fn test_onewaysync_deletes_item_only_on_b() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_data = minimal_icalendar_with_uid("test-item-uid", "Event on B only")?.into();
    storage_b
        .create_item(
            collection_b.href(),
            &item_data,
            CreateItemOptions::default(),
        )
        .await?;

    let items_b_before = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_before.len(), 1, "B should have 1 item before sync");

    let items_a_before = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_before.len(), 0, "A should be empty before sync");

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    let plan = Plan::new(pair, Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 0, "B should be empty after sync");

    let items_a_after = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after.len(), 0, "A should still be empty after sync");

    Ok(())
}

#[tokio::test]
async fn test_onewaysync_uploads_item_from_a_to_b() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_uid = "test-item-uid";
    let item_data = minimal_icalendar_with_uid(item_uid, "Event on A only")?.into();
    storage_a
        .create_item(
            collection_a.href(),
            &item_data,
            CreateItemOptions::default(),
        )
        .await?;

    let items_a_before = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_before.len(), 1, "A should have 1 item before sync");

    let items_b_before = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_before.len(), 0, "B should be empty before sync");

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    let plan = Plan::new(pair, Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 1, "B should have 1 item after sync");

    let item_b = &items_b_after[0];
    assert_eq!(
        item_b.item.ident(),
        item_uid,
        "Item should have matching UID"
    );
    assert!(
        item_b.item.as_str().contains("Event on A only"),
        "Item should have correct content"
    );

    let items_a_after = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after.len(), 1, "A should have 1 item after sync");

    Ok(())
}

#[tokio::test]
async fn test_onewaysync_updates_b_when_a_changes() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_uid = "test-item-uid";
    let item_a = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();
    let item_b = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();

    storage_a
        .create_item(collection_a.href(), &item_a, CreateItemOptions::default())
        .await?;

    storage_b
        .create_item(collection_b.href(), &item_b, CreateItemOptions::default())
        .await?;

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    let plan = Plan::new(pair.clone(), Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_a = storage_a.get_all_items(collection_a.href()).await?;
    let item_a_version = &items_a[0];

    let updated_item_a = minimal_icalendar_with_uid(item_uid, "Modified Event on A")?.into();
    storage_a
        .update_item(&item_a_version.href, &item_a_version.etag, &updated_item_a)
        .await?;

    // Second sync should update B
    let plan = Plan::new(pair, Some(status.clone())).await?;

    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 1, "B should have 1 item");

    let item_b_after = &items_b_after[0];
    assert!(
        item_b_after.item.as_str().contains("Modified Event on A"),
        "B should have updated content from A"
    );

    Ok(())
}

#[tokio::test]
async fn test_onewaysync_reverts_changes_on_b() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_uid = "test-item-uid";
    let item_a = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();
    let item_b = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();

    storage_a
        .create_item(collection_a.href(), &item_a, CreateItemOptions::default())
        .await?;

    storage_b
        .create_item(collection_b.href(), &item_b, CreateItemOptions::default())
        .await?;

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    let plan = Plan::new(pair.clone(), Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_b = storage_b.get_all_items(collection_b.href()).await?;
    let item_b_version = &items_b[0];

    let updated_item_b = minimal_icalendar_with_uid(item_uid, "Modified Event on B")?.into();
    storage_b
        .update_item(&item_b_version.href, &item_b_version.etag, &updated_item_b)
        .await?;

    let plan = Plan::new(pair, Some(status.clone())).await?;

    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_a_after = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after.len(), 1, "A should have 1 item");

    let item_a_after = &items_a_after[0];
    assert!(
        item_a_after.item.as_str().contains("Original Event"),
        "A should have original content (unchanged)"
    );

    // Verify B was overwritten with A's content (A is source of truth)
    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 1, "B should have 1 item");

    let item_b_after = &items_b_after[0];
    assert!(
        item_b_after.item.as_str().contains("Original Event"),
        "B should have been overwritten with A's original content"
    );

    Ok(())
}

#[tokio::test]
async fn test_onewaysync_deletes_from_b_when_deleted_from_a() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_uid = "test-item-uid";
    let item_a = minimal_icalendar_with_uid(item_uid, "Test Event")?.into();
    let item_b = minimal_icalendar_with_uid(item_uid, "Test Event")?.into();

    let item_a_version = storage_a
        .create_item(collection_a.href(), &item_a, CreateItemOptions::default())
        .await?;

    storage_b
        .create_item(collection_b.href(), &item_b, CreateItemOptions::default())
        .await?;

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .on_empty(OnEmpty::Sync) // We're emptying a collection.
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    let plan = Plan::new(pair.clone(), Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    storage_a
        .delete_item(&item_a_version.href, &item_a_version.etag)
        .await?;

    let items_a_after_delete = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after_delete.len(), 0, "A should now be empty");

    let plan = Plan::new(pair, Some(status.clone())).await?;

    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 0, "B should be empty after sync");

    Ok(())
}

#[tokio::test]
async fn test_onewaysync_recreates_item_on_b_after_deletion() -> anyhow::Result<()> {
    let dir_a = tempdir()?;
    let dir_b = tempdir()?;

    let storage_a = Arc::new(
        VdirStorage::builder(dir_a.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let storage_b = Arc::new(
        VdirStorage::builder(dir_b.path().to_path_buf().try_into().unwrap())
            .unwrap()
            .build(ItemKind::Calendar),
    );

    let collection_name = "test-calendar";

    let collection_a = storage_a.create_collection(collection_name).await?;
    let collection_b = storage_b.create_collection(collection_name).await?;

    let item_uid = "test-item-uid";
    let item_a = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();
    let item_b = minimal_icalendar_with_uid(item_uid, "Original Event")?.into();

    storage_a
        .create_item(collection_a.href(), &item_a, CreateItemOptions::default())
        .await?;

    let item_b_version = storage_b
        .create_item(collection_b.href(), &item_b, CreateItemOptions::default())
        .await?;

    let status = Arc::new(StatusDatabase::open_or_create(":memory:")?);

    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));

    // First sync to establish sync state.
    let plan = Plan::new(pair, Some(status.clone())).await?;

    let on_error = |err| panic!("Sync error: {:?}", err);
    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    storage_b
        .delete_item(&item_b_version.href, &item_b_version.etag)
        .await?;

    let items_b_after_delete = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(
        items_b_after_delete.len(),
        0,
        "B should be empty after deletion"
    );

    let items_a_after_delete = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after_delete.len(), 1, "A should still have item");

    // Second sync should recreate item on B from A.
    let pair = StoragePair::new(storage_a.clone(), storage_b.clone())
        .with_mode(Arc::new(OneWaySync))
        .on_empty(OnEmpty::Sync)
        .with_mapping(SyncedCollection::direct(collection_name.parse().unwrap()));
    let plan = Plan::new(pair, Some(status.clone())).await?;

    Executor::new(on_error)
        .execute_stream(storage_a.clone(), storage_b.clone(), plan, &status)
        .await?
        .unwrap();

    let items_a_after = storage_a.get_all_items(collection_a.href()).await?;
    assert_eq!(items_a_after.len(), 1, "A should still have 1 item");

    let items_b_after = storage_b.get_all_items(collection_b.href()).await?;
    assert_eq!(items_b_after.len(), 1, "B should have 1 item recreated");

    let item_b_after = &items_b_after[0];
    assert_eq!(item_b_after.item.ident(), item_uid);
    assert!(item_b_after.item.as_str().contains("Original Event"));

    Ok(())
}