reductstore 1.19.0

ReductStore is a time series database designed specifically for storing and managing large amounts of blob data.
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
// Copyright 2023-2026 ReductSoftware UG
// Licensed under the Business Source License 1.1

use super::{normalize_entry_name, settings_for_entry, Bucket};
use crate::core::file_cache::FILE_CACHE;
use crate::storage::engine::{check_entry_name_convention, ReadOnlyMode};
use crate::storage::entry::Entry;
use reduct_base::conflict;
use reduct_base::error::ReductError;
use reduct_base::not_found;
use std::sync::Arc;

impl Bucket {
    async fn rebuild_entries_from_fs(
        &self,
        settings: &reduct_base::msg::bucket_api::BucketSettings,
    ) -> Result<(), ReductError> {
        self.folder_keeper.reload().await?;

        let mut rebuilt_entries = std::collections::BTreeMap::new();
        let mut task_set = Vec::new();
        for entry_path in self.folder_keeper.list_folders().await? {
            let entry_name = normalize_entry_name(
                entry_path
                    .strip_prefix(&self.path)
                    .unwrap_or(entry_path.as_path()),
            );
            task_set.push(Entry::restore(
                entry_path,
                entry_name.clone(),
                self.name.clone(),
                settings_for_entry(&entry_name, settings),
                self.cfg.clone(),
            ));
        }

        for task in task_set {
            if let Some(entry) = task.await? {
                rebuilt_entries.insert(entry.name().to_string(), Arc::new(entry));
            }
        }

        *self.entries.write().await? = rebuilt_entries;
        Ok(())
    }

    pub async fn rename_entry(&self, old_name: &str, new_name: &str) -> Result<(), ReductError> {
        self.check_mode()?;
        self.ensure_not_deleting().await?;

        let new_path = self.path.join(new_name);
        let bucket_name = self.name.clone();
        let settings = self.settings().await?;
        let folder_keeper = self.folder_keeper.clone();

        check_entry_name_convention(&new_name)?;
        if new_name == old_name || new_name.starts_with(&format!("{old_name}/")) {
            return Err(conflict!(
                "Entry '{}' already exists in bucket '{}'",
                new_name,
                bucket_name
            ));
        }

        let affected_children: Vec<(String, Arc<Entry>)> = {
            let entries_guard = self.entries.read().await?;
            entries_guard
                .iter()
                .filter(|(entry_name, _)| Self::entry_with_descendants(old_name, entry_name))
                .map(|(entry_name, entry)| (entry_name.clone(), Arc::clone(entry)))
                .collect()
        };

        if affected_children.is_empty() {
            return Err(not_found!(
                "Entry '{}' not found in bucket '{}'",
                old_name,
                bucket_name
            ));
        }

        if FILE_CACHE.try_exists(&new_path).await? {
            return Err(conflict!(
                "Entry '{}' already exists in bucket '{}'",
                new_name,
                bucket_name
            ));
        }

        // Create missing target parent entries so renames like `a/b -> c/b` work
        // even when `c` does not exist yet.
        if let Some((target_parent, _)) = new_name.rsplit_once('/') {
            if !target_parent.is_empty() {
                let _ = self.get_or_create_entry(target_parent).await?;
            }
        }

        let renamed_children: Vec<(String, String, Arc<Entry>)> = affected_children
            .into_iter()
            .map(|(entry_name, entry)| {
                (
                    entry_name.clone(),
                    format!("{}{}", new_name, &entry_name[old_name.len()..]),
                    entry,
                )
            })
            .collect();

        let old_entry_names: Vec<String> = renamed_children
            .iter()
            .map(|(old_entry_name, _, _)| old_entry_name.clone())
            .collect();
        {
            let entries_guard = self.entries.read().await?;
            for (_, new_entry_name, _) in &renamed_children {
                if entries_guard.contains_key(new_entry_name)
                    && !old_entry_names.iter().any(|name| name == new_entry_name)
                {
                    return Err(conflict!(
                        "Entry '{}' already exists in bucket '{}'",
                        new_entry_name,
                        bucket_name
                    ));
                }
            }
        }

        for (_, _, entry) in &renamed_children {
            entry.ensure_not_deleting().await?;
            entry.compact().await?;
        }

        folder_keeper.rename_folder(old_name, new_name).await?;

        if let Err(err) = self.rebuild_entries_from_fs(&settings).await {
            log::error!(
                "Failed to rebuild bucket '{}' entries after renaming '{}' to '{}': {}. Rolling back.",
                bucket_name,
                old_name,
                new_name,
                err
            );

            folder_keeper.rename_folder(new_name, old_name).await?;
            // recovery can also fail, but we should try to restore the previous state as much as possible
            self.rebuild_entries_from_fs(&settings).await?;
            return Err(err);
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cfg::Cfg;
    use crate::core::file_cache::FILE_CACHE;
    use prost::bytes::Bytes;
    use reduct_base::error::ErrorCode;
    use reduct_base::error::ReductError;
    use reduct_base::internal_server_error;
    use reduct_base::io::ReadRecord;
    use reduct_base::msg::bucket_api::{BucketSettings, QuotaType};
    use reduct_base::unprocessable_entity;
    use reduct_base::Labels;
    use rstest::{fixture, rstest};
    use std::path::PathBuf;
    use std::time::Duration;
    use tempfile::tempdir;
    use tokio::time::sleep;

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test-1", 1, b"test").await.unwrap();

        bucket.rename_entry("test-1", "test-2").await.unwrap();
        assert_eq!(
            bucket.get_entry("test-1").await.err(),
            Some(ReductError::not_found(
                "Entry 'test-1' not found in bucket 'test'"
            ))
        );
        assert_eq!(
            bucket
                .get_entry("test-2")
                .await
                .unwrap()
                .upgrade()
                .unwrap()
                .name(),
            "test-2"
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_not_found(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        assert_eq!(
            bucket.rename_entry("test-1", "test-2").await.err(),
            Some(not_found!("Entry 'test-1' not found in bucket 'test'"))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_already_exists(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test-1", 1, b"test").await.unwrap();
        write(&bucket, "test-2", 1, b"test").await.unwrap();

        assert_eq!(
            bucket.rename_entry("test-1", "test-2").await.err(),
            Some(conflict!("Entry 'test-2' already exists in bucket 'test'"))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_same_name_conflict(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test-1", 1, b"test").await.unwrap();

        assert_eq!(
            bucket.rename_entry("test-1", "test-1").await.err(),
            Some(conflict!("Entry 'test-1' already exists in bucket 'test'"))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_to_descendant_conflict(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "a/b", 1, b"test").await.unwrap();

        assert_eq!(
            bucket.rename_entry("a", "a/c").await.err(),
            Some(conflict!("Entry 'a/c' already exists in bucket 'test'"))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_conflict_with_existing_child_key(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "old/child", 1, b"test").await.unwrap();
        let old_child = bucket
            .get_entry("old/child")
            .await
            .unwrap()
            .upgrade()
            .unwrap();

        bucket
            .entries
            .write()
            .await
            .unwrap()
            .insert("new/child".to_string(), old_child);

        assert_eq!(
            bucket.rename_entry("old", "new").await.err(),
            Some(conflict!(
                "Entry 'new/child' already exists in bucket 'test'"
            ))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_entry_rolls_back_when_rebuild_fails(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test-1", 1, b"test").await.unwrap();

        let entries_guard = bucket.entries.read().await.unwrap();
        let bucket_for_rename = bucket.clone();
        let handle =
            tokio::spawn(async move { bucket_for_rename.rename_entry("test-1", "test-2").await });

        sleep(Duration::from_millis(5300)).await;
        drop(entries_guard);

        let err = handle.await.unwrap().err().unwrap();
        assert_eq!(err.status(), ErrorCode::InternalServerError);
        assert!(err
            .message()
            .contains("Failed to acquire async write lock within timeout"));

        assert!(bucket.get_entry("test-1").await.is_ok());
        assert!(bucket.get_entry("test-2").await.is_err());
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_invalid_name(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        assert_eq!(
            bucket.rename_entry("test-1", "test-2$").await.err(),
            Some(unprocessable_entity!(
                "Entry name can contain only letters, digits and [-,_,/] symbols or end with '/$meta'"
            ))
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_with_wal_segment(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test/a", 1, b"test").await.unwrap();
        bucket.rename_entry("test/a", "test/wal").await.unwrap();
        assert!(bucket.get_entry("test/a").await.is_err());
        assert_eq!(
            bucket
                .get_entry("test/wal")
                .await
                .unwrap()
                .upgrade()
                .unwrap()
                .name(),
            "test/wal"
        );
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_moves_meta_entry(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test/a", 1, b"data").await.unwrap();
        write_meta(&bucket, "test/a/$meta", 1, b"meta")
            .await
            .unwrap();

        bucket.rename_entry("test/a", "test/b").await.unwrap();

        assert!(bucket.get_entry("test/a").await.is_err());
        assert!(bucket.get_entry("test/a/$meta").await.is_err());
        assert!(bucket.get_entry("test/b").await.is_ok());
        assert!(bucket.get_entry("test/b/$meta").await.is_ok());
    }

    #[rstest]
    #[tokio::test]
    async fn test_rename_parent_renames_children(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "a/b/c", 1, b"test").await.unwrap();
        write_meta(&bucket, "a/b/c/$meta", 2, b"meta")
            .await
            .unwrap();

        bucket.rename_entry("a", "renamed").await.unwrap();

        assert!(bucket.get_entry("a").await.is_err());
        assert!(bucket.get_entry("a/b").await.is_err());
        assert!(bucket.get_entry("a/b/c").await.is_err());
        assert!(bucket.get_entry("a/b/c/$meta").await.is_err());

        assert!(bucket.get_entry("renamed").await.is_ok());
        assert!(bucket.get_entry("renamed/b").await.is_ok());
        assert!(bucket.get_entry("renamed/b/c").await.is_ok());
        assert!(bucket.get_entry("renamed/b/c/$meta").await.is_ok());
    }

    #[rstest]
    #[tokio::test(flavor = "multi_thread")]
    async fn test_rename_creates_missing_target_parent_path(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "a/b", 1, b"test").await.unwrap();

        bucket.rename_entry("a/b", "c/b").await.unwrap();

        assert!(bucket.get_entry("a/b").await.is_err());
        assert!(bucket.get_entry("a").await.is_ok());
        assert!(bucket.get_entry("c").await.is_ok());
        assert!(bucket.get_entry("c/b").await.is_ok());

        let mut reader = bucket.begin_read("c/b", 1).await.unwrap();
        assert_eq!(reader.read_chunk().unwrap().unwrap(), Bytes::from("test"));
    }

    #[rstest]
    #[tokio::test(flavor = "multi_thread")]
    async fn test_rename_entry_persisted(#[future] bucket: Arc<Bucket>) {
        let bucket = bucket.await;
        write(&bucket, "test-1", 1, b"test").await.unwrap();
        bucket.sync_fs().await.unwrap();
        bucket.rename_entry("test-1", "test-2").await.unwrap();

        let bucket = Bucket::restore(bucket.path.clone(), Cfg::default())
            .await
            .unwrap();
        assert_eq!(
            bucket.get_entry("test-1").await.err(),
            Some(ReductError::not_found(
                "Entry 'test-1' not found in bucket 'test'"
            ))
        );

        let mut reader = bucket.begin_read("test-2", 1).await.unwrap();
        assert_eq!(reader.read_chunk().unwrap().unwrap(), Bytes::from("test"));
    }

    async fn write(
        bucket: &Arc<Bucket>,
        entry_name: &str,
        time: u64,
        content: &'static [u8],
    ) -> Result<(), ReductError> {
        let mut sender = bucket
            .begin_write(
                entry_name,
                time,
                content.len() as u64,
                "".to_string(),
                Labels::new(),
            )
            .await?;
        sender
            .send(Ok(Some(Bytes::from(content))))
            .await
            .map_err(|e| internal_server_error!("Failed to send data: {}", e))?;
        sender
            .send(Ok(None))
            .await
            .map_err(|e| internal_server_error!("Failed to sync channel: {}", e))?;
        Ok(())
    }

    async fn write_meta(
        bucket: &Arc<Bucket>,
        entry_name: &str,
        time: u64,
        content: &'static [u8],
    ) -> Result<(), ReductError> {
        let mut sender = bucket
            .begin_write(
                entry_name,
                time,
                content.len() as u64,
                "".to_string(),
                Labels::from_iter([("key".to_string(), "default".to_string())]),
            )
            .await?;
        sender
            .send(Ok(Some(Bytes::from(content))))
            .await
            .map_err(|e| internal_server_error!("Failed to send data: {}", e))?;
        sender
            .send(Ok(None))
            .await
            .map_err(|e| internal_server_error!("Failed to sync channel: {}", e))?;
        Ok(())
    }

    #[fixture]
    pub fn settings() -> BucketSettings {
        BucketSettings {
            max_block_size: Some(100),
            quota_type: Some(QuotaType::FIFO),
            quota_size: Some(1000),
            max_block_records: Some(100),
        }
    }

    #[fixture]
    pub fn path() -> PathBuf {
        tempdir().unwrap().keep()
    }

    #[fixture]
    pub async fn bucket(settings: BucketSettings, path: PathBuf) -> Arc<Bucket> {
        FILE_CACHE.create_dir_all(&path.join("test")).await.unwrap();
        Arc::new(
            Bucket::try_build("test", &path, settings, Cfg::default())
                .await
                .unwrap(),
        )
    }
}