noatun 0.1.3

Noatun is an in-process, distributed database with materialized view support.
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
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
use crate::cutoff::{Acceptability, CutOffConfig, CutOffDuration, CutOffHashPos, CutOffTime};
use crate::database::MessageInfo;
use crate::disk_abstraction::Disk;
use crate::message_store::OnDiskMessageStore;
use crate::sequence_nr::SequenceNr;
use crate::update_head_tracker::UpdateHeadTracker;
use crate::{
    catch_and_log, dprintln, ContextGuardMut, DatabaseContextData, Message, MessageFrame,
    MessageHeader, MessageId, NoatunTime, Persistence, Target,
};
use anyhow::{bail, Result};
use chrono::{DateTime, Utc};
use std::pin::Pin;
use tracing::{error, info, trace};

pub(crate) struct Projector<MSG: Message> {
    messages: OnDiskMessageStore<MSG>,
    head_tracker: UpdateHeadTracker,
    /// The configured cutoff interval and stride
    cut_off_config: CutOffConfig,
    abort_on_panic: bool,
}

impl<MSG: Message + 'static> Projector<MSG> {
    pub(crate) fn sync_outstanding(&mut self) -> Result<()> {
        self.messages.sync_outstanding()
    }

    pub(crate) fn disable_filesystem_sync(&mut self) {
        self.messages.disable_filesystem_sync()
    }
    pub(crate) fn sync_all(&mut self) -> Result<()> {
        self.messages.sync_all()?;
        self.head_tracker.sync_all()?;
        Ok(())
    }
    pub fn disk_space_used_bytes(&self) -> u64 {
        self.messages.disk_space_used_bytes() + self.head_tracker.disk_space_used_bytes()
    }
    pub(crate) fn advance_cutoff(
        &mut self,
        new_cutoff_at: CutOffTime,
        context: &mut DatabaseContextData,
    ) -> Result<()> {
        let mut prev_cutoff_state = self.messages.prev_cutoff_hash()?;
        let mut cutoff_state = self.messages.current_cutoff_hash()?;

        dprintln!(
            "@{} {:?} Advancing cutoff {} -> {}",
            crate::cur_node(),
            crate::test_elapsed(),
            cutoff_state.before_time.to_noatun_time(),
            new_cutoff_at.to_noatun_time()
        );

        let old_prev_cutoff_index = self
            .messages
            .get_index_at_or_after(prev_cutoff_state.before_time.to_noatun_time())?;

        let old_cutoff_index = self
            .messages
            .get_index_at_or_after(cutoff_state.before_time.to_noatun_time())?;

        assert_eq!(old_cutoff_index, self.messages.cutoff_index());

        let cutoff_index = self
            .messages
            .get_index_at_or_after(new_cutoff_at.to_noatun_time())?;

        assert!(new_cutoff_at > cutoff_state.before_time);
        cutoff_state.before_time = new_cutoff_at;
        prev_cutoff_state.before_time = new_cutoff_at.saturating_sub(self.cut_off_config.stride);

        let messages_slice = self.messages.get_messages_slice()?;

        let mut remove_orders = Vec::new();

        for index_entry in &messages_slice[old_prev_cutoff_index.index()..old_cutoff_index.index()]
        {
            if index_entry.file_offset.is_deleted() {
                continue;
            }
            prev_cutoff_state.apply(index_entry.message, "advance add");
        }

        for index_entry in &messages_slice[old_cutoff_index.index()..cutoff_index.index()] {
            if index_entry.file_offset.is_deleted() {
                continue;
            }
            if let Some((_hdr, children_to_remove)) = self
                .messages
                .read_message_header_and_children(index_entry.message)?
            {
                remove_orders.push((index_entry.message, children_to_remove));
            } else {
                error!("Encountered deleted message in cutoff-processing");
            }
            cutoff_state.apply(index_entry.message, "advance add");
        }

        for (message, children_to_remove) in remove_orders {
            self.messages
                .remove_all_parents_and_some_children(message, &children_to_remove)?;
            for child in children_to_remove {
                self.messages.add_remove_parents_and_children(
                    child,
                    &[],
                    Some(message),
                    &[],
                    None,
                )?;
            }
        }

        let mut must_remove = Vec::new();

        self.messages
            .advance_cutoff_hash(prev_cutoff_state, cutoff_state)?;

        self.messages.set_cutoff_index(cutoff_index);

        dprintln!(
            "advance {:?}..{:?}",
            old_cutoff_index.index(),
            cutoff_index.index()
        );
        context.try_delete_all_that_were_overwritten_by_range(
            old_cutoff_index.index()..cutoff_index.index(),
            &self.messages,
            &mut must_remove,
        )?;

        for index in must_remove {
            self.messages
                .mark_deleted_by_index(index, &mut self.head_tracker)?;
        }

        self.head_tracker
            .remove_before_cutoff(cutoff_state.before_time.to_noatun_time())?;

        Ok(())
    }

    pub fn get_upstream_of(
        &self,
        message_id: impl DoubleEndedIterator<Item = (MessageId, usize)>,
    ) -> Result<impl Iterator<Item = (MessageHeader, /*count*/ usize)> + '_> {
        self.messages.get_upstream_of(message_id)
    }

    pub(crate) fn get_update_heads(&self) -> &[MessageId] {
        self.head_tracker.get_update_heads()
    }
    pub(crate) fn get_messages_after(
        &self,
        message: MessageId,
        count: usize,
    ) -> Result<Vec<MessageId>> {
        self.messages.get_messages_at_or_after(message, count)
    }

    pub fn current_cutoff_hash(&self) -> Result<CutOffHashPos> {
        self.messages.current_cutoff_hash()
    }
    pub fn current_cutoff_time(&self) -> Result<NoatunTime> {
        self.messages.current_cutoff_time()
    }
    pub fn nominal_cutoff_time(&self, now: NoatunTime) -> CutOffTime {
        self.cut_off_config
            .nominal_cutoff(CutOffTime::from_noatun_time(now))
    }

    pub fn is_acceptable_cutoff_hash(
        &self,
        hash: CutOffHashPos,
        now: NoatunTime,
    ) -> Result<Acceptability> {
        self.messages
            .is_acceptable_cutoff_hash(hash, &self.cut_off_config, now)
    }

    pub(crate) fn contains_message(&self, id: MessageId) -> Result<bool> {
        self.messages.contains_message(id)
    }

    pub(crate) fn load_message(&self, id: MessageId) -> Result<MessageFrame<MSG>> {
        self.messages
            .read_message(id)?
            .ok_or_else(|| anyhow::anyhow!("Message not found"))
    }

    pub fn recover(&mut self, now: NoatunTime) -> Result<()> {
        self.head_tracker.clear();
        let cutoff = self.messages.current_cutoff_time()?;
        self.messages.recover(
            |id, parents| self.head_tracker.add_new_update_head(id, parents, cutoff),
            now,
            &self.cut_off_config,
        )
    }
    pub fn get_all_message_ids(&self) -> Result<Vec<MessageId>> {
        self.messages.get_all_message_ids()
    }
    pub fn get_message_children(&self, msg: MessageId) -> Result<Vec<MessageId>> {
        self.messages.get_children_of(msg)
    }
    pub fn get_all_messages(
        &self,
    ) -> Result<impl Iterator<Item = MessageFrame<MSG>> + use<'_, MSG>> {
        self.messages.get_all_messages()
    }

    pub fn get_all_messages_meta<'a>(
        &'a self,
        context: &'a DatabaseContextData,
    ) -> Result<impl Iterator<Item = MessageInfo<MSG>> + use<'a, MSG>> {
        Ok(self
            .messages
            .get_all_messages_with_index()?
            .map(|(seq, msg)| {
                let reads: Vec<SequenceNr> = context
                    .incoming_read_dependencies(seq)
                    .iter(context)
                    .map(|x| **x)
                    .collect();

                let writes: Vec<SequenceNr> = context
                    .overwriter_of(seq)
                    .iter(context)
                    .map(|x| **x)
                    .collect();
                let (live, flags) = context.get_live_values(seq);
                MessageInfo {
                    seq,
                    live,
                    flags,
                    frame: msg,
                    reads,
                    writes,
                }
            }))
    }
    pub fn get_all_messages_with_children(
        &self,
    ) -> Result<Vec<(MessageFrame<MSG>, Vec<MessageId>)>> {
        self.messages.get_all_messages_with_children()
    }

    pub(crate) fn new<D: Disk>(
        s: &mut D,
        target: &Target,
        min_size: usize,
        max_size: usize,
        cutoff_interval: CutOffDuration,
        auto_compact: bool,
    ) -> Result<Projector<MSG>> {
        Ok(Projector {
            messages: OnDiskMessageStore::new(s, target, min_size, max_size, auto_compact)?,
            head_tracker: UpdateHeadTracker::new(s, target)?,
            cut_off_config: CutOffConfig::new(cutoff_interval)?,
            abort_on_panic: false,
        })
    }

    pub fn loaded_existing_db(&self) -> bool {
        self.messages.loaded_existing_db()
    }
    pub fn mark_transmitted(&mut self, message_id: MessageId) -> Result<bool> {
        self.messages.mark_transmitted(message_id)
    }

    pub fn count_messages(&self) -> usize {
        self.messages.count_messages()
    }

    pub(crate) fn compact(&mut self) -> Result<()> {
        self.messages.compact()
    }

    /// Returns true if any of the messages were not previously present
    pub(crate) fn push_messages<'a>(
        &mut self,
        context: &mut DatabaseContextData,
        message: impl Iterator<Item = &'a MessageFrame<MSG>>,
        local: bool,
    ) -> Result<bool> {
        let mut messages: Vec<&MessageFrame<MSG>> = message.collect();
        messages.sort_unstable_by_key(|x| x.id());
        messages.dedup_by_key(|x| x.id());
        trace!("Deduped list to insert: {:?}", messages);

        let cutoff_time = self.messages.current_cutoff_time()?;
        for message in messages.iter_mut() {
            if message.header.id.timestamp() < cutoff_time {
                if !message.header.parents.is_empty() {
                    bail!("Messages with parents cannot be inserted at a timestamp before the cutoff time");
                }
            }
        }

        self.push_sorted_messages(context, messages.into_iter(), local)
    }
    pub(crate) fn push_sorted_messages<'a>(
        &mut self,
        context: &mut DatabaseContextData,
        messages: impl ExactSizeIterator<Item = &'a MessageFrame<MSG>>,
        local: bool,
    ) -> Result<bool> {
        let cutoff = self.current_cutoff_time()?;
        if let Some(mut insert_point) = self.messages.append_many_sorted(
            messages,
            |id, parents| self.head_tracker.add_new_update_head(id, parents, cutoff),
            local,
        )? {
            if let Some(cur_main_db_next_index) = context.next_seqnr().try_index() {
                if insert_point < cur_main_db_next_index {
                    #[cfg(debug_assertions)]
                    if insert_point > 0 {
                        trace!(
                            "checking if insertion point {} exists: {}",
                            insert_point,
                            self.messages.contains_index(insert_point)?
                        );
                        debug_assert!(self.messages.contains_index(insert_point)?);
                    }

                    if self.messages.compact_index_if_needed(false)? {
                        insert_point = 0;
                    }

                    info!("Rewinding to {} after insertion", insert_point);
                    self.rewind(context, SequenceNr::from_index(insert_point))?;
                }
            }

            Ok(true)
        } else {
            Ok(false)
        }
    }
    pub(crate) fn remove_message(
        &mut self,
        message_id: MessageId,
        force: bool,
    ) -> Result<Option<SequenceNr>> {
        self.messages
            .delete_many(std::iter::once(message_id), &mut self.head_tracker, force)
    }
    pub(crate) fn rewind(
        &mut self,
        context: &mut DatabaseContextData,
        point: SequenceNr,
    ) -> Result<()> {
        context.rewind(point);
        Ok(())
    }

    pub fn compact_index(&mut self) -> Result<()> {
        self.messages.compact_index()
    }

    pub(crate) fn set_abort_on_panic(&mut self) {
        self.abort_on_panic = true;
    }

    fn apply_single_message<M: Message>(
        context: &mut DatabaseContextData,
        root: &mut MSG::Root,
        msg: &MessageFrame<MSG>,
        seqnr: SequenceNr,
        must_remove: &mut Vec<SequenceNr>,
        messages: &OnDiskMessageStore<M>,
        abort_on_panic: bool,
    ) -> Result<()> {
        if context.next_seqnr() != seqnr {
            context.set_next_seqnr(seqnr);
        }
        context.clear_wrote_tombstone();
        match msg.payload.persistence() {
            Persistence::UntilOverwritten => {
                context.clear_tainted();
            }
            Persistence::AtLeastUntilCutoff => {
                context.set_tainted();
            }
        }
        let guard = ContextGuardMut::new(context, true);

        catch_and_log(
            || {
                msg.payload.apply(
                    msg.header.id,
                    // Safety: We don't move out of root
                    unsafe { Pin::new_unchecked(root) },
                );
            },
            abort_on_panic,
        );

        drop(guard);

        context.set_next_seqnr(seqnr.successor());
        context.rt_finalize_message(seqnr, must_remove, messages)?;
        Ok(())
    }

    pub(crate) fn apply_preview(
        &mut self,
        time: DateTime<Utc>,
        mut root: Pin<&mut MSG::Root>,
        preview: impl Iterator<Item = MSG>,
    ) -> Result<()> {
        let time = NoatunTime(time.timestamp_millis() as u64);
        catch_and_log(
            || {
                for msg in preview {
                    msg.apply(MessageId::from_parts_for_test(time, 0), root.as_mut());
                }
            },
            false,
        );

        Ok(())
    }

    /// Returns the first index _after_ the given time.
    /// I.e, rewinding to this index will leave only messages at time and before.
    pub(crate) fn get_index_of_time(&mut self, time: NoatunTime) -> Result<usize> {
        let key = MessageId::from_parts_raw(time.as_ms() + 1, [0; 10])?;
        let index = self.messages.get_insertion_point(key)?;
        Ok(index)
    }

    pub(crate) fn apply_missing_messages(
        &mut self,
        root: &mut MSG::Root,
        context: &mut DatabaseContextData,
        max_project_to: Option<NoatunTime>,
        auto_delete: bool,
    ) -> Result<Option<SequenceNr> /*earliest deleted index*/> {
        let first_run = self
            .messages
            .query_by_index(context.next_seqnr().try_index().unwrap())?;

        let max_project_to = match max_project_to {
            None => NoatunTime::MAX,
            Some(max_project_to) => max_project_to,
        };

        let mut must_remove = Vec::new();
        do_run::<MSG>(
            context,
            &self.messages,
            root,
            first_run,
            max_project_to,
            &mut must_remove,
            self.abort_on_panic,
        )?;

        if !auto_delete {
            return Ok(None);
        }
        return remove_stale_messages(self, must_remove);

        /// If returns true, need to finalize before-cutoff-part, then continue at given index
        fn do_run<MSG: Message>(
            context: &mut DatabaseContextData,
            messages: &OnDiskMessageStore<MSG>,
            root: &mut MSG::Root,
            items: impl Iterator<Item = (usize, MessageFrame<MSG>)>,
            max_project_to: NoatunTime,
            must_remove: &mut Vec<SequenceNr>,
            abort_on_panic: bool,
        ) -> Result<()> {
            for (seq, msg) in items {
                if msg.header.id.timestamp() > max_project_to {
                    break;
                }
                let seqnr = SequenceNr::from_index(seq);
                Projector::<MSG>::apply_single_message(
                    context,
                    root,
                    &msg,
                    seqnr,
                    must_remove,
                    messages,
                    abort_on_panic,
                )?;
            }
            Ok(())
        }

        fn remove_stale_messages<MSG: Message>(
            tself: &mut Projector<MSG>,
            must_remove: Vec<SequenceNr>,
        ) -> Result<Option<SequenceNr /*minimum deleted*/>> {
            //let must_remove = context.calculate_stale_messages(&mut tself.messages)?;
            let mut earliest_deleted = None;
            for index in must_remove {
                let was_deleted = tself
                    .messages
                    .mark_deleted_by_index(index, &mut tself.head_tracker)?;
                if was_deleted {
                    earliest_deleted = Some(
                        earliest_deleted
                            .map(|x: SequenceNr| x.min(index))
                            .unwrap_or(index),
                    );
                }
            }
            Ok(earliest_deleted)
        }
    }
}