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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
use std::{
    cell::{RefCell, RefMut},
    collections::{hash_map::Entry, HashMap},
    rc::Rc,
};

use audi::{Listener, ListenerSet, ListenerWithState};
use futures::{
    channel::mpsc::{channel, Receiver, Sender},
    future::join_all,
    stream, Future, Stream, StreamExt,
};
use litl::impl_debug_as_litl;
use log::LogID;
use mofo::Mofo;
use serde::Serialize;
use serde_derive::{Deserialize, Serialize};
use tracing::{debug, debug_span, trace, warn};
use tracing::{info_span, Instrument};

mod blob;
mod causal_set;
mod log;
mod object;
mod set;
mod storage;
mod telepathic;

use crate::log::LogState;
pub use blob::{BlobDiff, BlobID, BlobState};
pub use object::{Diff, ObjectID, ObjectState, WriteAccess};
use object::{ObjectError, StateInfo};
use set::{SetDiff, SetState};
pub use set::{SetItem, SetItemID};
pub use storage::{MemoryStorageBackend, ShardedStorageBackend, StorageBackend};
use telepathic::{ApplyDiffErrorFor, ApplyDiffSuccess, Telepathic, TelepathicDiff};

pub type ApplyDiffError = ApplyDiffErrorFor<ObjectError>;

struct NodeInner {
    objects: HashMap<ObjectID, Rc<RefCell<ObjectState>>>,
    local_listeners: HashMap<ObjectID, ListenerSet<Diff>>,
    remotes: ListenerSet<UpdateMessage, RemoteState>,
    background: Mofo,
    storage: Box<dyn StorageBackend>,
}

impl NodeInner {
    fn load_object(&mut self, id: ObjectID) -> impl Future<Output = Rc<RefCell<ObjectState>>> {
        let mut needs_to_be_loaded = false;
        let object = self.objects.entry(id).or_insert_with(|| {
            needs_to_be_loaded = true;

            match id {
                ObjectID::Log(id) => Rc::new(RefCell::new(ObjectState::Log(Box::new(
                    LogState::new_empty(id),
                )))),
                ObjectID::Set(id) => Rc::new(RefCell::new(ObjectState::Set(Box::new(
                    SetState::new_empty(id),
                )))),
                ObjectID::Blob(id) => Rc::new(RefCell::new(ObjectState::Blob(Box::new(
                    BlobState::new_empty(id),
                )))),
            }
        });

        let object = Rc::clone(object);
        let storage = self.storage.clone_ref();

        async move {
            if needs_to_be_loaded {
                ObjectState::load(id, storage)
                    .for_each(|diff| {
                        let object = Rc::clone(&object);
                        async move {
                            let mut object = object.borrow_mut();
                            object.try_apply_diff(diff).unwrap();
                        }
                    })
                    .await;
                object
            } else {
                object
            }
        }
    }

    fn get_object(&self, id: &ObjectID) -> Option<Rc<RefCell<ObjectState>>> {
        self.objects.get(id).cloned()
    }
}

#[derive(Clone)]
pub struct Node(Rc<RefCell<NodeInner>>);

impl Node {
    pub fn new(background: Mofo) -> Self {
        Self(Rc::new(RefCell::new(NodeInner {
            objects: HashMap::new(),
            local_listeners: HashMap::new(),
            remotes: ListenerSet::new(),
            background,
            storage: Box::new(MemoryStorageBackend::new()),
        })))
    }

    pub async fn create_log<M: Serialize>(&self, meta: Option<M>) -> (ObjectID, WriteAccess) {
        let (log_id, write_access, stored_fut) = self.create_log_sync(meta);

        stored_fut.await;

        (log_id, write_access)
    }

    pub fn create_log_sync<M: Serialize>(&self, meta: Option<M>) -> (ObjectID, WriteAccess, impl Future<Output = ()>) {
        let (log, write_access) = LogState::new(meta);
        let log_id = log.id;

        let as_initial_diff = log.state_as_initial_diff().unwrap();

        match (*self.0).borrow_mut().objects.entry(ObjectID::Log(log.id)) {
            Entry::Occupied(_) => unreachable!("Log for given ID already exists"),
            Entry::Vacant(entry) => {
                entry.insert(Rc::new(RefCell::new(ObjectState::Log(Box::new(log)))))
            }
        };

        let stored_fut = LogState::store(as_initial_diff, self.0.borrow().storage.clone_ref());

        (ObjectID::Log(log_id),  WriteAccess::Log(write_access), stored_fut)
    }

    pub async fn create_set<M: Serialize>(&self, meta: Option<M>) -> (ObjectID, WriteAccess) {
        let (set, write_access) = SetState::new(meta);
        let set_id = set.id;

        let as_initial_diff = set.state_as_initial_diff().unwrap();

        match (*self.0).borrow_mut().objects.entry(ObjectID::Set(set.id)) {
            Entry::Occupied(_) => unreachable!("Set for given ID already exists"),
            Entry::Vacant(entry) => {
                entry.insert(Rc::new(RefCell::new(ObjectState::Set(Box::new(set)))))
            }
        };

        SetState::store(as_initial_diff, self.0.borrow().storage.clone_ref()).await;

        (ObjectID::Set(set_id), WriteAccess::Set(write_access))
    }

    pub async fn create_blob<D: Serialize>(&self, data: D) -> ObjectID {
        let blob = BlobState::new(data);
        let id = blob.id();

        let as_initial_diff = blob.state_as_initial_diff().unwrap();

        (*self.0).borrow_mut().objects.insert(
            ObjectID::Blob(id),
            Rc::new(RefCell::new(ObjectState::Blob(Box::new(blob)))),
        );

        let storage = self.0.borrow().storage.clone_ref();

        BlobState::store(as_initial_diff, storage).await;

        ObjectID::Blob(id)
    }

    pub fn diff_for_log_append(
        &self,
        id: ObjectID,
        write_access: &WriteAccess,
        append: &[u8],
    ) -> Diff {
        if append.is_empty() {
            panic!("Empty append")
        }
        match write_access {
            WriteAccess::Log(log_access) => {
                let self_ref = (*self.0).borrow_mut();

                let log = self_ref
                    .get_object(&id)
                    .expect("Expected log to be created or loaded before appending");
                let log = RefMut::map((*log).borrow_mut(), |object| match object {
                    ObjectState::Log(log) => log,
                    _ => unreachable!("Expected log to be log"),
                });

                Diff::Log(log.diff_for_new_append(append, log_access))
            }
            _ => panic!("Tried to append to log with set write access"),
        }
    }
    pub async fn append_to_log(&self, id: ObjectID, write_access: &WriteAccess, append: &[u8]) {
        let diff = self.diff_for_log_append(id, write_access, append);
        self.apply_new_diff(diff).await;
    }

    pub async fn insert_into_set(
        &self,
        id: ObjectID,
        write_access: &WriteAccess,
        set_item: SetItem,
    ) -> Result<SetItemID, ApplyDiffError> {
        match write_access {
            WriteAccess::Set(set_access) => {
                let item_id = set_item.id();

                let diff = SetDiff {
                    id: id.expect_set(),
                    header: None,
                    new_items: vec![set_access.0.sign(set_item)],
                };

                self.apply_new_diff(Diff::Set(diff)).await;

                Ok(item_id)
            }
            _ => panic!("Tried to insert into set with log write access"),
        }
    }

    pub async fn apply_new_diff(&self, diff: Diff) {
        let span = info_span!(
            "Caro::apply_new_diff",
            object_id = format!("{:?}", diff.id())
        );
        let span_id = span.id();

        async {
            let object_id = diff.id();

            let listeners = {
                let self_ref = (*self.0).borrow_mut();
                let object = self_ref
                    .get_object(&diff.id())
                    .expect("Expected object to be created or loaded before applying diff");

                let result = (*object)
                    .borrow_mut()
                    .try_apply_diff(diff.clone())
                    .expect("New diffs should always be valid");

                ObjectState::store(result.effective_diff, self_ref.storage.clone_ref()).await;

                debug_assert!(match (&diff, (*object).borrow().state_as_initial_diff()) {
                    (Diff::Set(set_diff), Some(Diff::Set(all_items))) => set_diff.new_items.iter().all(|i| all_items.new_items.contains(i)),
                    _ => true
                }, "Expected new set items to be connected and show up in state - make sure they were inserted into the correct set.");

                self_ref.local_listeners.get(&diff.id()).cloned()
            };

            if let Some(listeners) = listeners {
                listeners.broadcast(diff).instrument(info_span!(parent: span_id.clone(), "Caro::local_listener_broadcast", object_id = format!("{:?}", object_id))).await;
            }

            self.sync_object_with_remotes(object_id, span_id.clone()).await;
        }.instrument(span).await;
    }

    pub async fn sync_object_with_remotes(&self, id: ObjectID, parent_span: Option<tracing::Id>) {
        let (object, remotes) = {
            let self_ref = (*self.0).borrow_mut();

            let object = self_ref
                .get_object(&id)
                .expect("Expected object to be created or loaded before syncing");

            let remotes = self_ref.remotes.clone();

            (object, remotes)
        };

        remotes
            .broadcast_filter_map(|remote| {
                let optimistic_state_info_entry = remote.optimistic_state_info.entry(id);

                match (optimistic_state_info_entry, remote.mode) {
                    (entry @ Entry::Occupied(_), _)
                    | (entry @ Entry::Vacant(_), RemoteMode::SyncEverything) => {
                        let optimistic_state = entry.or_default();

                        let update = (*object)
                            .borrow()
                            .diff_since(optimistic_state.as_ref())
                            .map(UpdateMessage::NewContent);

                        optimistic_state.replace(
                            (*object)
                                .borrow()
                                .state_info()
                                .expect("Should have state info of synced object"),
                        );

                        update
                    }
                    _ => None,
                }
            })
            .instrument(info_span!(
                parent: parent_span,
                "sync_object_with_remotes",
                id = format!("{:?}", id)
            ))
            .await
    }

    pub fn get_object(&self, id: &ObjectID) -> Option<Rc<RefCell<ObjectState>>> {
        (*self.0).borrow().get_object(id)
    }

    pub async fn load_object(&self, id: ObjectID) -> Rc<RefCell<ObjectState>> {
        let loaded = (*self.0).borrow_mut().load_object(id);
        loaded.await
    }

    async fn add_diff_listener(&self, id: ObjectID, listener: Listener<Diff>) {
        let (listeners, loading_object) = {
            let mut self_ref = (*self.0).borrow_mut();
            let listeners = self_ref
                .local_listeners
                .entry(id)
                .or_insert_with(ListenerSet::new)
                .clone();
            let loading_object = self_ref.load_object(id);

            (listeners, loading_object)
        };
        let object = loading_object.await;

        let initial_diff = object.borrow().state_as_initial_diff();
        let is_empty = object.borrow().state_info().is_none();

        listeners.add_with_initial_msg(listener, initial_diff).await;

        if is_empty {
            debug!(object_id = ?id, "Listened to object is empty, syncing with remotes");
            let remotes = (*self.0).borrow().remotes.clone();
            remotes
                .broadcast_filter_map(|remote| {
                    if remote.mode == RemoteMode::SyncEverything {
                        Some(UpdateMessage::StateInfo(StateInfoUpdate {
                            id: object.borrow().id(),
                            state_info: None,
                            needs_full_resync: true,
                        }))
                    } else {
                        None
                    }
                })
                .await;
        }
    }

    pub fn diffs(
        &self,
        id: ObjectID,
        listener_prefix: String,
    ) -> impl Stream<Item = Diff> + 'static {
        let (diffs_tx, diffs_rx) = channel(100);

        let self_clone = self.clone();

        stream::once(async move {
            self_clone
                .add_diff_listener(
                    id,
                    Listener::new(
                        &format!("{}_{:?}", listener_prefix, rand::random::<u64>()),
                        diffs_tx,
                    ),
                )
                .await;

            diffs_rx
        })
        .flatten()
        .boxed_local()
    }

    pub async fn add_remote(&self, remote: Remote) {
        (*self.0).borrow_mut().remotes.add(RemoteState {
            id: remote.id.clone(),
            mode: remote.mode,
            optimistic_state_info: HashMap::new(),
            outgoing: remote.outgoing.clone(),
        });

        let self_rc = self.clone();
        let remotes = (*self.0).borrow().remotes.clone();
        let remote_id = remote.id.clone();

        let receiving = remote.incoming.for_each(move |msg| {
            let self_rc = self_rc.clone();
            let remotes = remotes.clone();
            let remote_id = remote_id.clone();

            async move {
                trace!(remote_id = remote_id, msg = ?msg, "Receiving from remote");

                match msg {
                    UpdateMessage::NewContent(diff) => {
                        self_rc
                            .handle_incoming_diff(diff, &remote_id, remotes)
                            .await;
                    }
                    UpdateMessage::StateInfo(StateInfoUpdate {
                        id,
                        state_info: new_state_info,
                        needs_full_resync,
                    }) => {
                        self_rc
                            .handle_incoming_state_info(
                                id,
                                new_state_info,
                                needs_full_resync,
                                &remote_id,
                                remotes,
                            )
                            .await;
                    }
                }
            }
        });

        if remote.mode == RemoteMode::SyncEverything {
            let remotes = (*self.0).borrow().remotes.clone();
            let remote_id = remote.id.clone();
            #[allow(clippy::needless_collect)]
            let all_state_infoes = (*self.0)
                .borrow()
                .objects
                .iter()
                .map(|(id, obj)| (*id, (**obj).borrow().state_info()))
                .collect::<Vec<_>>();

            let span = debug_span!("Sending all state_infos", remote_id = remote_id);

            join_all(all_state_infoes.into_iter().map(|(id, state_info)| {
                remotes.send_or_remove(
                    &remote_id,
                    UpdateMessage::StateInfo(StateInfoUpdate {
                        id,
                        state_info,
                        needs_full_resync: true,
                    }),
                    span.id(),
                )
            }))
            .instrument(span)
            .await;
        }

        (*self.0)
            .borrow()
            .background
            .add_background_task(Box::pin(receiving));
    }

    async fn handle_incoming_diff(
        &self,
        diff: Diff,
        remote_id: &str,
        remotes: ListenerSet<UpdateMessage, RemoteState>,
    ) {
        let span = info_span!("Caro::handle_incoming_diff", remote_id = remote_id);
        let span_id = span.id();

        async {
            let (apply_result, id, current_state_info) = {
                let object_promise = (*self.0).borrow_mut().load_object(diff.id());
                let object_rc = object_promise.instrument(info_span!(parent: span_id.clone(), "NodeInner::load_object", id = format!("{:?}", diff.id()))).await;
                let mut object = (*object_rc).borrow_mut();

                (
                    info_span!(parent: span_id.clone(), "ObjectState::try_apply_diff", id = format!("{:?}", diff.id())).in_scope(||
                        object.try_apply_diff(diff.clone())
                    ),
                    object.id(),
                    info_span!(parent: span_id.clone(), "ObjectState::state_info", id = format!("{:?}", diff.id())).in_scope(||
                        object.state_info()
                    ),
                )
            };
            match apply_result {
                Ok(ApplyDiffSuccess{new_state_info, effective_diff}) => {
                    if let Some(remote) = remotes.state_of(remote_id) {
                        (*remote)
                            .borrow_mut()
                            .optimistic_state_info
                            .insert(id, Some(new_state_info));
                    }

                    ObjectState::store(effective_diff.clone(), self.0.borrow().storage.clone_ref()).await;

                    let listeners = (*self.0).borrow_mut().local_listeners.get(&id).cloned();

                    if let Some(listeners) = listeners {
                        listeners.broadcast(effective_diff).instrument(info_span!(parent: span_id.clone(), "Caro::local_listener_broadcast", object_id = format!("{:?}", id))).await;
                    }

                    self.sync_object_with_remotes(id, span_id.clone()).await;
                }
                Err(ApplyDiffError::InvalidKnownStateAssumption) => {
                    warn!(state_info = ?current_state_info, diff = ?diff, "Invalid known state assumption");
                    let span = info_span!(parent: span_id.clone(), "reply_invalid_state_assumption", id = format!("{:?}", id));
                    // remote must be mistaken about our state, let them know
                    remotes
                        .send_or_remove(
                            remote_id,
                            UpdateMessage::StateInfo(StateInfoUpdate {
                                id,
                                state_info: current_state_info,
                                needs_full_resync: true
                            }),
                            span.id(),
                        )
                        .instrument(span)
                        .await;
                }
                Err(err) => Err(err).unwrap(),
            }
        }
        .instrument(span)
        .await;
    }

    async fn handle_incoming_state_info(
        &self,
        id: ObjectID,
        new_state_info: Option<StateInfo>,
        needs_full_resync: bool,
        remote_id: &str,
        remotes: ListenerSet<UpdateMessage, RemoteState>,
    ) {
        let span = info_span!("Caro::handle_incoming_state_info", remote_id = remote_id);
        let span_id = span.id();

        async {
            if !needs_full_resync {
                return
            }
        let update_to_respond_with = if let Some(remote) = remotes.state_of(remote_id) {
            (*remote)
                .borrow_mut()
                .optimistic_state_info
                .insert(id, new_state_info.clone());

            if let Some(object) = (*self.0).borrow_mut().objects.get(&id).cloned() {
                let diff = info_span!(parent: span_id.clone(), "ObjectState::diff_since", id = format!("{:?}", id)).in_scope(||
                    (*object).borrow().diff_since(new_state_info.as_ref())
                );
                if let Some(update) = diff {
                    Some(UpdateMessage::NewContent(update))
                } else {
                    let own_state_info = (*object).borrow().state_info();

                    if own_state_info != new_state_info {
                        // TODO: we can still get stuck in an endless loop here if we can't reconcile
                        // compare if we made progress since the last remembered optimistic state_info, only then send again
                        Some(UpdateMessage::StateInfo(StateInfoUpdate {
                            id,
                            state_info: own_state_info,
                            needs_full_resync: true,
                        }))
                    } else {
                        None
                    }
                }
            } else {
                Some(UpdateMessage::StateInfo(StateInfoUpdate {
                    id,
                    state_info: None,
                    // if we have nothing, we only want a resync if the other party has something
                    needs_full_resync: new_state_info.is_some()
                }))
            }
        } else {
            None
        };
        if let Some(update) = update_to_respond_with {
            let remotes = remotes.clone();
            let span = info_span!(parent: span_id.clone(), "reply_with_update");
            remotes.send_or_remove(remote_id, update, span.id()).instrument(span).await;
        }
    }
    .instrument(span)
    .await;
    }
}

#[derive(Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum UpdateMessage {
    NewContent(Diff),
    StateInfo(StateInfoUpdate),
}

#[derive(Clone, Serialize, Deserialize)]
pub struct StateInfoUpdate {
    id: ObjectID,
    state_info: Option<StateInfo>,
    needs_full_resync: bool,
}

impl_debug_as_litl!(UpdateMessage);

pub struct Remote {
    pub id: String,
    pub mode: RemoteMode,
    pub incoming: Receiver<UpdateMessage>,
    pub outgoing: Sender<UpdateMessage>,
}

impl Remote {
    pub fn new_connected_test_pair(node1_name: &str, node2_name: &str) -> (Remote, Remote) {
        let (to_node1, node1_rx) = channel(100);
        let (to_node2, node2_rx) = channel(100);

        (
            Remote {
                id: node1_name.to_string(),
                mode: RemoteMode::ProvideWhatRemoteWants,
                incoming: node2_rx,
                outgoing: to_node1,
            },
            Remote {
                id: node2_name.to_string(),
                mode: RemoteMode::SyncEverything,
                incoming: node1_rx,
                outgoing: to_node2,
            },
        )
    }
}

#[derive(Copy, Clone, PartialEq, Eq)]
pub enum RemoteMode {
    SyncEverything,
    ProvideWhatRemoteWants,
}

struct RemoteState {
    id: String,
    mode: RemoteMode,
    optimistic_state_info: HashMap<ObjectID, Option<StateInfo>>,
    outgoing: Sender<UpdateMessage>,
}

impl ListenerWithState<UpdateMessage> for RemoteState {
    fn id(&self) -> &str {
        &self.id
    }

    fn sender(&self) -> &Sender<UpdateMessage> {
        &self.outgoing
    }
}