akd 0.7.7

An implementation of an auditable key directory
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

// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// This source code is licensed under both the MIT license found in the
// LICENSE-MIT file in the root directory of this source tree and the Apache
// License, Version 2.0 found in the LICENSE-APACHE file in the root directory
// of this source tree.

//! Caching tests

use super::*;
use std::time::Duration;

use crate::storage::types::{ValueState, ValueStateKey};
use crate::storage::DbRecord;
use crate::{AkdLabel, AkdValue, NodeLabel};

#[tokio::test]
async fn test_cache_put_and_expires() {
    let cache = TimedCache::new(
        Some(Duration::from_millis(10)),
        None,
        Some(Duration::from_millis(50)),
    );

    let value_state = DbRecord::ValueState(ValueState {
        epoch: 1,
        version: 1,
        label: NodeLabel {
            label_len: 1,
            label_val: [0u8; 32],
        },
        plaintext_val: AkdValue::from_utf8_str("some value"),
        username: AkdLabel::from_utf8_str("user"),
    });
    let key = ValueStateKey(AkdLabel::from_utf8_str("user").0.to_vec(), 1);
    cache.put(&value_state).await;

    let got = cache.hit_test::<ValueState>(&key).await;
    assert!(got.is_some());
    assert_eq!(Some(value_state), got);

    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
    let got = cache.hit_test::<ValueState>(&key).await;
    assert_eq!(None, got);
}

#[tokio::test]
async fn test_cache_overwrite() {
    let cache = TimedCache::new(Some(Duration::from_millis(1000)), None, None);

    let value_state = ValueState {
        epoch: 1,
        version: 1,
        label: NodeLabel {
            label_len: 1,
            label_val: [0u8; 32],
        },
        plaintext_val: AkdValue::from_utf8_str("some value"),
        username: AkdLabel::from_utf8_str("user"),
    };
    let key = ValueStateKey(AkdLabel::from_utf8_str("user").0.to_vec(), 1);

    let value_state_2 = ValueState {
        epoch: 1,
        version: 2,
        label: NodeLabel {
            label_len: 2,
            label_val: [0u8; 32],
        },
        plaintext_val: AkdValue::from_utf8_str("some value"),
        username: AkdLabel::from_utf8_str("user"),
    };
    cache.put(&DbRecord::ValueState(value_state)).await;
    cache
        .put(&DbRecord::ValueState(value_state_2.clone()))
        .await;

    let got = cache.hit_test::<ValueState>(&key).await;
    assert_eq!(Some(DbRecord::ValueState(value_state_2)), got);
}

#[tokio::test]
async fn test_cache_memory_pressure() {
    let cache = TimedCache::new(
        Some(Duration::from_millis(1000)),
        Some(10),
        Some(Duration::from_millis(50)),
    );

    let value_state = DbRecord::ValueState(ValueState {
        epoch: 1,
        version: 1,
        label: NodeLabel {
            label_len: 1,
            label_val: [0u8; 32],
        },
        plaintext_val: AkdValue::from_utf8_str("some value"),
        username: AkdLabel::from_utf8_str("user"),
    });
    let key = ValueStateKey(AkdLabel::from_utf8_str("user").0.to_vec(), 1);
    cache.put(&value_state).await;

    // we only do an "automated" clean every 50ms in test, which is when memory pressure is evaluated.
    // 100ms will make sure the clean op will run on the next `hit_test` op
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
    // This get should return none, even though the cache expiration time is 1s. This is because
    // we should exceed 10 bytes of storage utilization so the cache should clean the item.
    let got = cache.hit_test::<ValueState>(&key).await;
    assert_eq!(None, got);
}

#[tokio::test]
async fn test_many_memory_pressure() {
    let cache = TimedCache::new(
        Some(Duration::from_millis(1000)),
        Some(1024 * 5),
        Some(Duration::from_millis(50)),
    );

    let value_states = (1..100)
        .map(|i| ValueState {
            epoch: i as u64,
            version: i as u64,
            label: NodeLabel {
                label_len: 1,
                label_val: [0u8; 32],
            },
            plaintext_val: AkdValue::from_utf8_str("test"),
            username: AkdLabel::from_utf8_str("user"),
        })
        .map(DbRecord::ValueState)
        .collect::<Vec<_>>();

    cache.batch_put(&value_states).await;

    // we only do an "automated" clean every 50ms in test, which is when memory pressure is evaluated.
    // 100ms will make sure the clean op will run on the next `hit_test` op
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    let all = cache.get_all().await;
    assert!(all.len() < 99);
}