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
#![warn(missing_docs)]
#![warn(missing_crate_level_docs)]
#![warn(missing_doc_code_examples)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]

//! A persister targetting `LocalStorage` in the browser.
//!
//! ```rust,no_run
//! # use automerge_persistent_localstorage::{LocalStoragePersister, LocalStoragePersisterError};
//! # use automerge_persistent::PersistentAutomerge;
//! # fn main() -> Result<(), LocalStoragePersisterError> {
//! let storage = web_sys::window()
//!     .unwrap()
//!     .local_storage()
//!     .map_err(LocalStoragePersisterError::StorageError)?
//!     .unwrap();
//!
//! let persister = LocalStoragePersister::new(storage, "document".to_owned(), "changes".to_owned(), "sync-states".to_owned())?;
//! let doc = PersistentAutomerge::load(persister).unwrap();
//! # Ok(())
//! # }
//! ```

use std::collections::HashMap;

use automerge::ActorId;
use automerge_persistent::{Persister, StoredSizes};
use base64::Engine;

/// Persist changes and documents in to `LocalStorage`.
///
/// While aimed at `LocalStorage`, it accepts any storage that  conforms to the [`web_sys::Storage`]
/// API.
///
/// Since `LocalStorage` is limited we store changes in a JSON map in one key.
#[derive(Debug)]
pub struct LocalStoragePersister {
    storage: web_sys::Storage,
    changes: HashMap<String, Vec<u8>>,
    /// Base64 encoded peer_ids are used for the keys so they can be serialized to json.
    sync_states: HashMap<String, Vec<u8>>,
    document_key: String,
    changes_key: String,
    sync_states_key: String,
    sizes: StoredSizes,
}

/// Possible errors from persisting.
#[derive(Debug, thiserror::Error)]
pub enum LocalStoragePersisterError {
    /// Serde failure, converting the change/document into JSON.
    #[error(transparent)]
    SerdeError(#[from] serde_json::Error),
    /// An underlying storage error.
    #[error("storage error {0:?}")]
    StorageError(wasm_bindgen::JsValue),
}

impl LocalStoragePersister {
    /// Construct a new `LocalStoragePersister`.
    pub fn new(
        storage: web_sys::Storage,
        document_key: String,
        changes_key: String,
        sync_states_key: String,
    ) -> Result<Self, LocalStoragePersisterError> {
        let changes = if let Some(stored) = storage
            .get_item(&changes_key)
            .map_err(LocalStoragePersisterError::StorageError)?
        {
            serde_json::from_str(&stored)?
        } else {
            HashMap::new()
        };
        let sync_states = if let Some(stored) = storage
            .get_item(&sync_states_key)
            .map_err(LocalStoragePersisterError::StorageError)?
        {
            serde_json::from_str(&stored)?
        } else {
            HashMap::new()
        };
        let document = if let Some(doc_string) = storage
            .get_item(&document_key)
            .map_err(LocalStoragePersisterError::StorageError)?
        {
            let doc = serde_json::from_str::<Vec<u8>>(&doc_string)?;
            Some(doc)
        } else {
            None
        };
        let sizes = StoredSizes {
            changes: changes.values().map(Vec::len).sum::<usize>() as u64,
            document: document.unwrap_or_default().len() as u64,
            sync_states: sync_states.values().map(Vec::len).sum::<usize>() as u64,
        };
        Ok(Self {
            storage,
            changes,
            sync_states,
            document_key,
            changes_key,
            sync_states_key,
            sizes,
        })
    }
}

impl Persister for LocalStoragePersister {
    type Error = LocalStoragePersisterError;

    fn get_changes(&self) -> Result<Vec<Vec<u8>>, Self::Error> {
        Ok(self.changes.values().cloned().collect())
    }

    fn insert_changes(&mut self, changes: Vec<(ActorId, u64, Vec<u8>)>) -> Result<(), Self::Error> {
        for (a, s, c) in changes {
            let key = make_key(&a, s);

            self.sizes.changes += c.len() as u64;
            if let Some(old) = self.changes.insert(key, c) {
                self.sizes.changes -= old.len() as u64;
            }
        }
        self.storage
            .set_item(&self.changes_key, &serde_json::to_string(&self.changes)?)
            .map_err(LocalStoragePersisterError::StorageError)?;
        Ok(())
    }

    fn remove_changes(&mut self, changes: Vec<(&ActorId, u64)>) -> Result<(), Self::Error> {
        let mut some_removal = false;
        for (a, s) in changes {
            let key = make_key(a, s);
            if let Some(old) = self.changes.remove(&key) {
                self.sizes.changes -= old.len() as u64;
                some_removal = true;
            }
        }

        if some_removal {
            let s = serde_json::to_string(&self.changes)?;
            self.storage
                .set_item(&self.changes_key, &s)
                .map_err(LocalStoragePersisterError::StorageError)?;
        }
        Ok(())
    }

    fn get_document(&self) -> Result<Option<Vec<u8>>, Self::Error> {
        if let Some(doc_string) = self
            .storage
            .get_item(&self.document_key)
            .map_err(LocalStoragePersisterError::StorageError)?
        {
            let doc = serde_json::from_str(&doc_string)?;
            Ok(Some(doc))
        } else {
            Ok(None)
        }
    }

    fn set_document(&mut self, data: Vec<u8>) -> Result<(), Self::Error> {
        self.sizes.document = data.len() as u64;
        let data = serde_json::to_string(&data)?;
        self.storage
            .set_item(&self.document_key, &data)
            .map_err(LocalStoragePersisterError::StorageError)?;
        Ok(())
    }

    fn get_sync_state(&self, peer_id: &[u8]) -> Result<Option<Vec<u8>>, Self::Error> {
        let peer_id = base64::engine::general_purpose::STANDARD.encode(peer_id);
        Ok(self.sync_states.get(&peer_id).cloned())
    }

    fn set_sync_state(&mut self, peer_id: Vec<u8>, sync_state: Vec<u8>) -> Result<(), Self::Error> {
        self.sizes.sync_states += sync_state.len() as u64;
        let peer_id = base64::engine::general_purpose::STANDARD.encode(peer_id);
        if let Some(old) = self.sync_states.insert(peer_id, sync_state) {
            self.sizes.sync_states -= old.len() as u64;
        }
        self.storage
            .set_item(
                &self.sync_states_key,
                &serde_json::to_string(&self.sync_states)?,
            )
            .map_err(LocalStoragePersisterError::StorageError)?;
        Ok(())
    }

    fn remove_sync_states(&mut self, peer_ids: &[&[u8]]) -> Result<(), Self::Error> {
        for peer_id in peer_ids {
            let peer_id = base64::engine::general_purpose::STANDARD.encode(peer_id);
            if let Some(old) = self.sync_states.remove(&peer_id) {
                self.sizes.sync_states -= old.len() as u64;
            }
        }
        self.storage
            .set_item(
                &self.sync_states_key,
                &serde_json::to_string(&self.sync_states)?,
            )
            .map_err(LocalStoragePersisterError::StorageError)?;
        Ok(())
    }

    fn get_peer_ids(&self) -> Result<Vec<Vec<u8>>, Self::Error> {
        Ok(self
            .sync_states
            .keys()
            .map(|key| {
                base64::engine::general_purpose::STANDARD
                    .decode(key)
                    .expect("Failed to base64 decode they peer_id")
            })
            .collect())
    }

    fn sizes(&self) -> StoredSizes {
        self.sizes.clone()
    }

    fn flush(&mut self) -> Result<usize, Self::Error> {
        Ok(0)
    }
}

/// Make a key from the `actor_id` and `sequence_number`.
///
/// Converts the `actor_id` to a string and appends the `sequence_number`.
fn make_key(actor_id: &ActorId, seq: u64) -> String {
    let mut key = actor_id.to_hex_string();
    key.push_str(&seq.to_string());
    key
}