saku-sync 0.4.0

Sync engine for the saku ecosystem
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

pub mod backend;
pub mod conflict;
pub mod error;
pub mod hash;
pub mod merkle;
pub mod state_db;
pub mod sync_engine;

#[cfg(feature = "server")]
pub mod config;

#[cfg(feature = "server")]
pub mod kv_sync;

pub use error::SyncError;
pub use sync_engine::{SyncConfig, SyncEngine, SyncOutcome, TrackedFile};

use backend::local_fs::LocalFsSyncBackend;
use std::path::Path;

/// Convenience function: build a `SyncEngine<LocalFsSyncBackend>`, run `sync()`,
/// and return the outcome. Intended for Phase 3 testing with a local directory
/// acting as the "remote".
pub fn try_flush_if_online(
    store_path: &Path,
    passphrase: &[u8],
    backend_root: &Path,
) -> Result<SyncOutcome, SyncError> {
    let backend = LocalFsSyncBackend::new(backend_root);

    // Build tracked files list — for now we only track the tdo store.json
    let store_path = store_path.to_path_buf();
    let tracked = vec![TrackedFile {
        file_key: "tdo/store.json".to_string(),
        tool: "tdo".to_string(),
        relative_path: "store.json".to_string(),
        local_path: store_path,
    }];

    let db_path = saku_storage::device::saku_data_dir()
        .map_err(SyncError::DeviceId)?
        .join("sync.db");

    let config = SyncConfig {
        db_path,
        passphrase: passphrase.to_vec(),
        tracked_files: tracked,
    };

    let mut engine = SyncEngine::new(config, backend)?;
    engine.sync()
}

/// Convenience function: build a `SyncEngine<ServerSyncBackend>`, run `sync()`,
/// and return the outcome. Used when the server feature is enabled and configured.
#[cfg(feature = "server")]
pub fn try_flush_if_online_server(
    store_path: &std::path::Path,
    passphrase: &[u8],
    server_url: &str,
    device_id: &str,
) -> Result<SyncOutcome, SyncError> {
    let backend = backend::server::ServerSyncBackend::new(server_url, device_id)?;

    let tracked = vec![TrackedFile {
        file_key: "tdo/store.json".to_string(),
        tool: "tdo".to_string(),
        relative_path: "store.json".to_string(),
        local_path: store_path.to_path_buf(),
    }];

    let db_path = saku_storage::device::saku_data_dir()
        .map_err(SyncError::DeviceId)?
        .join("sync.db");

    let config = SyncConfig {
        db_path,
        passphrase: passphrase.to_vec(),
        tracked_files: tracked,
    };

    let mut engine = SyncEngine::new(config, backend)?;
    engine.sync()
}

/// Convenience function: run per-entry KV sync against the server.
///
/// Loads the store from disk, pulls remote changes (paginated), merges via LWW,
/// pushes dirty entries, and saves the DirtyTracker sidecar.
#[cfg(feature = "server")]
pub fn try_kv_sync_server(
    store_path: &std::path::Path,
    passphrase: &[u8],
    server_url: &str,
    tool: &str,
) -> Result<kv_sync::KvSyncOutcome, SyncError> {
    let config = kv_sync::KvSyncConfig {
        server_url: server_url.to_string(),
        tool: tool.to_string(),
        passphrase: passphrase.to_vec(),
        store_path: store_path.to_path_buf(),
    };
    kv_sync::sync_kv(&config)
}