lb-rs 26.10.22

The rust library for interacting with your lockbook.
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

use db_rs::View;
pub use tokio::sync::broadcast::{self, Receiver, Sender};
use tracing::*;
use uuid::Uuid;

use crate::io::CoreV5;
use crate::{Lb, LbErrKind};

#[derive(Clone)]
pub struct EventSubs {
    tx: Sender<Event>,
}

#[derive(Clone, Debug)]
pub enum Event {
    /// A metadata for a given id or it's descendants changed. The id returned
    /// may be deleted. Updates to document contents will not cause this
    /// message to be sent (unless a document was deleted).
    MetadataChanged(Actor),

    /// The contents of this document have changed either by this lb
    /// library or as a result of sync
    DocumentWritten(Uuid, Actor),

    /// Changes from another process have been applied to our local views.
    /// Cached metadata and document contents may need to be reloaded.
    IpcChangesApplied,

    PendingSharesChanged,

    Sync(SyncIncrement),

    StatusUpdated,

    UserSignedIn,
}

#[derive(Debug, Clone, PartialEq)]
pub enum Actor {
    /// A write initiated locally. The id identifies the writer (e.g. a
    /// workspace instance) so subscribers can tell their own writes apart
    /// from writes by other workspaces or tools sharing this lb.
    User(Option<Uuid>),
    Sync,
}

impl Default for EventSubs {
    fn default() -> Self {
        let (tx, _) = broadcast::channel::<Event>(10000);
        Self { tx }
    }
}

impl EventSubs {
    pub(crate) fn pending_shares_changed(&self) {
        self.queue(Event::PendingSharesChanged);
    }

    pub(crate) fn meta_changed(&self, actor: Actor) {
        self.queue(Event::MetadataChanged(actor));
    }

    pub(crate) fn doc_written(&self, id: Uuid, actor: Actor) {
        self.queue(Event::DocumentWritten(id, actor));
    }

    pub(crate) fn sync_update(&self, s: SyncIncrement) {
        self.queue(Event::Sync(s));
    }

    pub(crate) fn status_updated(&self) {
        self.queue(Event::StatusUpdated);
    }

    /// executed after root and account are created
    pub(crate) fn signed_in(&self) {
        self.queue(Event::UserSignedIn);
    }

    fn queue(&self, evt: Event) {
        if let Err(e) = self.tx.send(evt.clone()) {
            error!(?evt, ?e, "could not queue");
        }
    }
}

impl Lb {
    pub(crate) async fn notify_catch_up(&self, db: &CoreV5, previous_seq: u64) {
        if db.account.last_modified() > previous_seq && self.get_account().is_err() {
            if let Some(account) = db.account.as_ref() {
                self.keychain.cache_account(account.clone()).await.unwrap();
                self.events.signed_in();
            }
        }

        let changed = [
            db.account.last_modified(),
            db.root.last_modified(),
            db.base_metadata.last_modified(),
            db.local_metadata.last_modified(),
            db.pub_key_lookup.last_modified(),
            db.pinned_files.last_modified(),
            db.last_synced.last_modified(),
        ]
        .into_iter()
        .any(|seq| seq > previous_seq);

        // Read activity is deliberately excluded: reloading documents records
        // more reads, which must not trigger reloads in the other process.
        if changed {
            self.events.queue(Event::IpcChangesApplied);
        }
    }

    pub fn subscribe(&self) -> Receiver<Event> {
        self.events.tx.subscribe()
    }
}

#[derive(Debug, Clone)]
pub enum SyncIncrement {
    SyncStarted,
    PullingDocument(Uuid, bool),
    PushingDocument(Uuid, bool),
    SyncFinished(Option<LbErrKind>),
}