nodedb 0.2.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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

// SPDX-License-Identifier: BUSL-1.1

//! Append-only enforcement: reject UPDATE and DELETE on append-only collections.

use crate::bridge::envelope::ErrorCode;
use crate::bridge::physical_plan::EnforcementOptions;

/// Check whether an UPDATE is allowed on this collection.
///
/// For append-only collections, UPDATEs are unconditionally rejected.
/// `old_value` being `Some` means the document already exists (UPDATE case).
pub fn check_point_put(
    collection: &str,
    opts: &EnforcementOptions,
    old_value: &Option<Vec<u8>>,
) -> Result<(), ErrorCode> {
    if opts.append_only && old_value.is_some() {
        return Err(ErrorCode::AppendOnlyViolation {
            collection: collection.to_string(),
        });
    }
    Ok(())
}

/// Check whether a DELETE is allowed on this collection.
///
/// For append-only collections, DELETEs are unconditionally rejected.
pub fn check_point_delete(collection: &str, opts: &EnforcementOptions) -> Result<(), ErrorCode> {
    if opts.append_only {
        return Err(ErrorCode::AppendOnlyViolation {
            collection: collection.to_string(),
        });
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    fn opts(append_only: bool) -> EnforcementOptions {
        EnforcementOptions {
            append_only,
            ..Default::default()
        }
    }

    #[test]
    fn insert_allowed_on_append_only() {
        assert!(check_point_put("ledger", &opts(true), &None).is_ok());
    }

    #[test]
    fn update_rejected_on_append_only() {
        let old = Some(vec![1, 2, 3]);
        assert!(check_point_put("ledger", &opts(true), &old).is_err());
    }

    #[test]
    fn update_allowed_when_not_append_only() {
        let old = Some(vec![1, 2, 3]);
        assert!(check_point_put("ledger", &opts(false), &old).is_ok());
    }

    #[test]
    fn delete_rejected_on_append_only() {
        assert!(check_point_delete("ledger", &opts(true)).is_err());
    }

    #[test]
    fn delete_allowed_when_not_append_only() {
        assert!(check_point_delete("ledger", &opts(false)).is_ok());
    }
}