-
-
Notifications
You must be signed in to change notification settings - Fork 88
/
workspace.rs
425 lines (368 loc) · 13 KB
/
workspace.rs
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
use super::{plugins::setup_plugin, *};
use serde::{ser::SerializeMap, Serialize, Serializer};
use std::{
panic::{catch_unwind, AssertUnwindSafe},
sync::{Arc, RwLock},
};
use y_sync::{
awareness::{Awareness, Event, Subscription as AwarenessSubscription},
sync::{DefaultProtocol, Error, Message, MessageReader, Protocol, SyncMessage},
};
use yrs::{
types::{map::MapEvent, ToJson},
updates::{
decoder::{Decode, DecoderV1},
encoder::{Encode, Encoder, EncoderV1},
},
Doc, Map, MapRef, Observable, ReadTxn, StateVector, Subscription, Transact, TransactionMut,
Update, UpdateEvent, UpdateSubscription,
};
static PROTOCOL: DefaultProtocol = DefaultProtocol;
use super::PluginMap;
use plugins::PluginImpl;
pub type MapSubscription = Subscription<Arc<dyn Fn(&TransactionMut, &MapEvent)>>;
pub struct Workspace {
id: String,
awareness: Arc<RwLock<Awareness>>,
pub(crate) blocks: MapRef,
pub(crate) updated: MapRef,
pub(crate) metadata: MapRef,
/// We store plugins so that their ownership is tied to [Workspace].
/// This enables us to properly manage lifetimes of observers which will subscribe
/// into events that the [Workspace] experiences, like block updates.
///
/// Public just for the crate as we experiment with the plugins interface.
/// See [plugins].
pub(super) plugins: PluginMap,
}
unsafe impl Send for Workspace {}
unsafe impl Sync for Workspace {}
impl Workspace {
pub fn new<S: AsRef<str>>(id: S) -> Self {
let doc = Doc::new();
Self::from_doc(doc, id)
}
pub fn from_doc<S: AsRef<str>>(doc: Doc, id: S) -> Workspace {
let blocks = doc.get_or_insert_map("blocks");
let updated = doc.get_or_insert_map("updated");
let metadata = doc.get_or_insert_map("space:meta");
setup_plugin(Self {
id: id.as_ref().to_string(),
awareness: Arc::new(RwLock::new(Awareness::new(doc))),
blocks,
updated,
metadata,
plugins: Default::default(),
})
}
fn from_raw<S: AsRef<str>>(
id: S,
awareness: Arc<RwLock<Awareness>>,
blocks: MapRef,
updated: MapRef,
metadata: MapRef,
) -> Workspace {
setup_plugin(Self {
id: id.as_ref().to_string(),
awareness,
blocks,
updated,
metadata,
plugins: Default::default(),
})
}
/// Allow the plugin to run any necessary updates it could have flagged via observers.
/// See [plugins].
pub(super) fn update_plugin<P: PluginImpl>(&self) -> Result<(), Box<dyn std::error::Error>> {
self.plugins.update_plugin::<P>(self)
}
/// See [plugins].
pub(super) fn with_plugin<P: PluginImpl, T>(&self, cb: impl Fn(&P) -> T) -> Option<T> {
self.plugins.with_plugin::<P, T>(cb)
}
#[cfg(feature = "workspace-search")]
pub fn search<S: AsRef<str>>(
&self,
options: S,
) -> Result<SearchResults, Box<dyn std::error::Error>> {
use plugins::IndexingPluginImpl;
// refresh index if doc has update
self.update_plugin::<IndexingPluginImpl>()?;
let options = options.as_ref();
self.with_plugin::<IndexingPluginImpl, Result<SearchResults, Box<dyn std::error::Error>>>(
|search_plugin| search_plugin.search(options),
)
.expect("text search was set up by default")
}
pub fn search_result(&self, query: String) -> String {
match self.search(&query) {
Ok(list) => serde_json::to_string(&list).unwrap(),
Err(_) => "".to_string(),
}
}
pub fn with_trx<T>(&self, f: impl FnOnce(WorkspaceTransaction) -> T) -> T {
let doc = self.doc();
let trx = WorkspaceTransaction {
trx: doc.transact_mut(),
ws: self,
};
f(trx)
}
pub fn try_with_trx<T>(&self, f: impl FnOnce(WorkspaceTransaction) -> T) -> Option<T> {
match self.doc().try_transact_mut() {
Ok(trx) => {
let trx = WorkspaceTransaction { trx, ws: self };
Some(f(trx))
}
Err(e) => {
info!("try_with_trx error: {}", e);
None
}
}
}
pub fn id(&self) -> String {
self.id.clone()
}
pub fn metadata(&self) -> WorkspaceMetadata {
(&self.doc().transact(), self.metadata.clone()).into()
}
pub fn client_id(&self) -> u64 {
self.doc().client_id()
}
// get a block if exists
pub fn get<T, S>(&self, trx: &T, block_id: S) -> Option<Block>
where
T: ReadTxn,
S: AsRef<str>,
{
Block::from(trx, self, block_id, self.client_id())
}
pub fn block_count(&self) -> u32 {
self.blocks.len(&self.doc().transact())
}
#[inline]
pub fn blocks<T, R>(&self, trx: &T, cb: impl Fn(Box<dyn Iterator<Item = Block> + '_>) -> R) -> R
where
T: ReadTxn,
{
let iterator =
self.blocks
.iter(trx)
.zip(self.updated.iter(trx))
.map(|((id, block), (_, updated))| {
Block::from_raw_parts(
trx,
id.to_owned(),
&self.doc(),
block.to_ymap().unwrap(),
updated.to_yarray().unwrap(),
self.client_id(),
)
});
cb(Box::new(iterator))
}
pub fn get_blocks_by_flavour<T>(&self, trx: &T, flavour: &str) -> Vec<Block>
where
T: ReadTxn,
{
self.blocks(trx, |blocks| {
blocks
.filter(|block| block.flavor(trx) == flavour)
.collect::<Vec<_>>()
})
}
pub fn observe_metadata(
&mut self,
f: impl Fn(&TransactionMut, &MapEvent) + 'static,
) -> MapSubscription {
self.metadata.observe(f)
}
pub fn on_awareness_update(
&mut self,
f: impl Fn(&Awareness, &Event) + 'static,
) -> AwarenessSubscription<Event> {
self.awareness.write().unwrap().on_update(f)
}
/// Check if the block exists in this workspace's blocks.
pub fn exists<T>(&self, trx: &T, block_id: &str) -> bool
where
T: ReadTxn,
{
self.blocks.contains_key(trx, block_id.as_ref())
}
/// Subscribe to update events.
pub fn observe(
&mut self,
f: impl Fn(&TransactionMut, &UpdateEvent) + 'static,
) -> Option<UpdateSubscription> {
let doc = self.awareness.read().unwrap().doc().clone();
match catch_unwind(AssertUnwindSafe(move || {
doc.observe_update_v1(move |trx, evt| {
if let Err(e) = catch_unwind(AssertUnwindSafe(|| f(trx, evt))) {
error!("panic in observe callback: {:?}", e);
}
})
.ok()
})) {
Ok(sub) => sub,
Err(e) => {
error!("panic in observe callback: {:?}", e);
None
}
}
}
pub fn doc(&self) -> Doc {
self.awareness.read().unwrap().doc().clone()
}
pub fn sync_migration(&self) -> Vec<u8> {
self.doc()
.transact()
.encode_state_as_update_v1(&StateVector::default())
}
pub fn sync_init_message(&self) -> Result<Vec<u8>, Error> {
let mut encoder = EncoderV1::new();
PROTOCOL.start(&self.awareness.read().unwrap(), &mut encoder)?;
Ok(encoder.to_vec())
}
pub fn sync_handle_message(
awareness: &mut Awareness,
msg: Message,
) -> Result<Option<Message>, Error> {
trace!("processing message: {:?}", msg);
match msg {
Message::Sync(msg) => match msg {
SyncMessage::SyncStep1(sv) => PROTOCOL.handle_sync_step1(awareness, sv),
SyncMessage::SyncStep2(update) => {
PROTOCOL.handle_sync_step2(awareness, Update::decode_v1(&update)?)
}
SyncMessage::Update(update) => {
let mut txn = awareness.doc().transact_mut();
txn.apply_update(Update::decode_v1(&update)?);
txn.commit();
trace!("changed_parent_types: {:?}", txn.changed_parent_types());
trace!("before_state: {:?}", txn.before_state());
trace!("after_state: {:?}", txn.after_state());
let update = txn.encode_update_v1();
Ok(Some(Message::Sync(SyncMessage::Update(update))))
}
},
Message::Auth(reason) => PROTOCOL.handle_auth(awareness, reason),
Message::AwarenessQuery => PROTOCOL.handle_awareness_query(awareness),
Message::Awareness(update) => PROTOCOL.handle_awareness_update(awareness, update),
Message::Custom(tag, data) => PROTOCOL.missing_handle(awareness, tag, data),
}
}
pub fn sync_decode_message(&mut self, binary: &[u8]) -> Vec<Vec<u8>> {
let mut decoder = DecoderV1::from(binary);
let mut result = vec![];
for msg in MessageReader::new(&mut decoder) {
if let Ok(msg) = msg {
let mut awareness = self.awareness.write().unwrap();
if let Ok(Ok(Some(msg))) = catch_unwind(AssertUnwindSafe(|| {
Self::sync_handle_message(&mut awareness, msg)
})) {
result.push(msg.encode_v1());
}
}
}
result
}
}
impl Serialize for Workspace {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let doc = self.doc();
let trx = doc.transact();
let mut map = serializer.serialize_map(Some(2))?;
map.serialize_entry("blocks", &self.blocks.to_json(&trx))?;
map.serialize_entry("updated", &self.updated.to_json(&trx))?;
map.end()
}
}
impl Clone for Workspace {
fn clone(&self) -> Self {
Self::from_raw(
&self.id,
self.awareness.clone(),
self.blocks.clone(),
self.updated.clone(),
self.metadata.clone(),
)
}
}
#[cfg(test)]
mod test {
use super::*;
use log::info;
use yrs::{updates::decoder::Decode, Doc, StateVector, Update};
#[test]
fn doc_load_test() {
let workspace = Workspace::new("test");
workspace.with_trx(|mut t| {
let block = t.create("test", "text");
block.set(&mut t.trx, "test", "test");
});
let doc = workspace.doc();
let new_doc = {
let update = doc
.transact()
.encode_state_as_update_v1(&StateVector::default());
let doc = Doc::default();
{
let mut trx = doc.transact_mut();
match Update::decode_v1(&update) {
Ok(update) => trx.apply_update(update),
Err(err) => info!("failed to decode update: {:?}", err),
}
trx.commit();
}
doc
};
assert_json_diff::assert_json_eq!(
doc.get_or_insert_map("blocks").to_json(&doc.transact()),
new_doc.get_or_insert_map("blocks").to_json(&doc.transact())
);
assert_json_diff::assert_json_eq!(
doc.get_or_insert_map("updated").to_json(&doc.transact()),
new_doc
.get_or_insert_map("updated")
.to_json(&doc.transact())
);
}
#[test]
fn workspace() {
let workspace = Workspace::new("test");
workspace.with_trx(|t| {
assert_eq!(workspace.id(), "test");
assert_eq!(workspace.blocks.len(&t.trx), 0);
assert_eq!(workspace.updated.len(&t.trx), 0);
});
workspace.with_trx(|mut t| {
let block = t.create("block", "text");
assert_eq!(workspace.blocks.len(&t.trx), 1);
assert_eq!(workspace.updated.len(&t.trx), 1);
assert_eq!(block.id(), "block");
assert_eq!(block.flavor(&t.trx), "text");
assert_eq!(
workspace.get(&t.trx, "block").map(|b| b.id()),
Some("block".to_owned())
);
assert_eq!(workspace.exists(&t.trx, "block"), true);
assert_eq!(t.remove("block"), true);
assert_eq!(workspace.blocks.len(&t.trx), 0);
assert_eq!(workspace.updated.len(&t.trx), 0);
assert_eq!(workspace.get(&t.trx, "block"), None);
assert_eq!(workspace.exists(&t.trx, "block"), false);
});
workspace.with_trx(|mut t| {
Block::new(&mut t.trx, &workspace, "test", "test", 1);
let vec = workspace.get_blocks_by_flavour(&t.trx, "test");
assert_eq!(vec.len(), 1);
});
let doc = Doc::with_client_id(123);
let workspace = Workspace::from_doc(doc, "test");
assert_eq!(workspace.client_id(), 123);
}
}