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
use std::{
collections::HashMap,
sync::{Arc, Mutex},
};
use automerge::{Automerge, ReadDoc};
use futures::{Stream, StreamExt, channel::oneshot};
use samod_core::{AutomergeUrl, DocumentChanged, DocumentId};
use crate::{
ConnectionId, Stopped, actor_task::ActorTask, doc_actor_inner::DocActorInner,
peer_connection_info::PeerDocState, unbounded::UnboundedSender,
};
/// The state of a single [`automerge`] document the [`Repo`](crate::Repo) is managing
///
/// [`DocHandle`]s are obtained using [`Repo::create`](crate::Repo::create) or
/// [`Repo::find`](crate::Repo::find)
///
/// Each `DocHandle` wraps an underlying `automerge::Automerge` instance in order to
/// capture local changes made to the document and publish them to any connected peers;
/// and to listen for remote changes made to the document and notify the local process.
///
/// To make local changes to a document you use [`DocHandle::with_document`] whilst
/// remote changes can be listened for using [`DocHandle::changes`].
///
/// You can also broadcast ephemeral messages to other peers using
/// [`DocHandle::broadcast`] and listen for ephemeral messages sent by other
/// peers using [`DocHandle::ephemera`].
#[derive(Clone)]
pub struct DocHandle {
inner: Arc<Mutex<DocActorInner>>,
document_id: DocumentId,
task_dispatcher: DocTaskDispatcher,
}
#[derive(Clone)]
pub(crate) enum DocTaskDispatcher {
Async(UnboundedSender<ActorTask>),
#[cfg(feature = "threadpool")]
Threadpool(Arc<rayon::ThreadPool>),
}
impl DocTaskDispatcher {
fn dispatch(
&self,
_inner: Arc<Mutex<DocActorInner>>,
task: ActorTask,
) -> Result<(), ActorTask> {
match self {
DocTaskDispatcher::Async(tx) => tx.unbounded_send(task),
#[cfg(feature = "threadpool")]
DocTaskDispatcher::Threadpool(threadpool) => {
threadpool.spawn(move || {
let mut guard = _inner.lock().unwrap();
guard.handle_task(task);
});
Ok(())
}
}
}
}
impl std::fmt::Debug for DocHandle {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("DocHandle")
.field("document_id", &self.document_id)
.finish()
}
}
impl DocHandle {
pub(crate) fn new(
doc_id: DocumentId,
inner: Arc<Mutex<DocActorInner>>,
task_dispatcher: DocTaskDispatcher,
) -> Self {
Self {
document_id: doc_id,
inner,
task_dispatcher,
}
}
/// The ID of this document
pub fn document_id(&self) -> &DocumentId {
&self.document_id
}
/// The URL of this document in a format compatible with the JS `automerge-repo` library
pub fn url(&self) -> AutomergeUrl {
AutomergeUrl::from(self.document_id())
}
/// Make a change to the underlying `automerge::Automerge` document
///
/// Note that this method blocks the current thread until the document is
/// available. There are two major reasons that the document might be
/// unavailable:
///
/// * Another caller is currently calling `with_document` and doing something
/// which takes a long time
/// * We are receiving a sync message which is taking a long time to process
///
/// This means it's probably best to run calls to this method inside
/// `spawn_blocking` or similar constructions
pub fn with_document<F, R>(&self, f: F) -> R
where
F: FnOnce(&mut Automerge) -> R,
{
self.inner.lock().unwrap().with_document(f)
}
/// Make a change to the underlying `automerge::Automerge` document without
/// blocking the calling task.
///
/// This queues the work on the document actor and resolves when the actor
/// has applied the change. If you created this repo using
/// [`ConcurrencyConfig::ThreadPool`] then the closure runs on the
/// threadpool and doesn't block the current async task. Otherwise, the
/// closure runs in the document actor task, so long-running closures can
/// still occupy an executor worker; use threadpool concurrency for
/// CPU-heavy document work.
pub fn with_document_async<F, R>(
&self,
f: F,
) -> impl Future<Output = Result<R, Stopped>> + Send + 'static
where
F: FnOnce(&mut Automerge) -> R + Send + 'static,
R: Send + 'static,
{
let inner = self.inner.clone();
let dispatcher = self.task_dispatcher.clone();
async move {
let (tx, rx) = oneshot::channel();
let task = ActorTask::WithDocument(Box::new(move |inner| {
let result = inner.with_document(f);
let _ = tx.send(result);
}));
dispatcher.dispatch(inner, task).map_err(|_| Stopped)?;
rx.await.map_err(|_| Stopped)
}
}
/// Listen to ephemeral messages sent by other peers to this document
pub fn ephemera(&self) -> impl Stream<Item = Vec<u8>> + 'static {
self.inner.lock().unwrap().create_ephemera_listener()
}
/// Listen for changes to the document
pub fn changes(&self) -> impl Stream<Item = DocumentChanged> + 'static {
self.inner.lock().unwrap().create_change_listener()
}
/// Send an ephemeral message which will be broadcast to all other peers who have this document open
///
/// Note that whilst you can send any binary payload, the JS implementation
/// will only process payloads which are valid CBOR
pub fn broadcast(&self, message: Vec<u8>) {
self.inner
.lock()
.unwrap()
.broadcast_ephemeral_message(message);
}
/// Get the current state of all peers connected to this document, and a stream of changes to that set
///
/// The returned stream will receive updates in the form of a map from
/// connection IDs which have changed to the new state for that connection
pub fn peers(
&self,
) -> (
HashMap<ConnectionId, PeerDocState>,
impl Stream<Item = HashMap<ConnectionId, PeerDocState>> + 'static + use<>,
) {
self.inner.lock().unwrap().peers()
}
/// Wait for a connection to have said they have everything we have
pub fn they_have_our_changes(&self, conn: ConnectionId) -> impl Future<Output = ()> + 'static {
let inner = self.inner.clone();
async move {
let mut state_changes = {
let mut inner = inner.lock().unwrap();
let local_heads = inner.document().get_heads();
let (current, state_changes) = inner.peers();
if (current
.get(&conn)
.map(|c| c.shared_heads == Some(local_heads)))
.unwrap_or(false)
{
return;
}
state_changes
};
while let Some(changes) = state_changes.next().await {
let Some(change) = changes.get(&conn) else {
continue;
};
let local_heads = inner.lock().unwrap().document().get_heads();
if change.shared_heads == Some(local_heads) {
break;
}
}
}
}
pub fn we_have_their_changes(&self, conn: ConnectionId) -> impl Future<Output = ()> + 'static {
let inner = self.inner.clone();
async move {
let mut state_changes = {
let mut inner = inner.lock().unwrap();
let (current, state_changes) = inner.peers();
if let Some(their_heads) = current.get(&conn).and_then(|c| c.their_heads.as_ref())
&& their_heads
.iter()
.all(|h| inner.document().get_change_by_hash(h).is_some())
{
return;
}
state_changes
};
while let Some(changes) = state_changes.next().await {
let Some(change) = changes.get(&conn) else {
continue;
};
let Some(their_heads) = change.their_heads.as_ref() else {
continue;
};
{
let inner = inner.lock().unwrap();
if their_heads
.iter()
.all(|h| inner.document().get_change_by_hash(h).is_some())
{
return;
}
}
}
}
}
}