oxedyne/fe2o3/fe2o3_o3db_sync/tests/ns_sweep.rs
6.4 KiB, 1 run
created by r1870400018:75881, which is this file's identity for as long as the history lasts, whatever it is later renamed to
download · who wrote it · its history
| 1 | //! Retiring old and orphaned entries from the Ozone path namespace (`ns`), R1f3. |
| 2 | //! |
| 3 | //! A key-range delete takes the entries of one directory whose names fall in a half-open range, |
| 4 | //! values and subtrees alike; a TTL sweep, on a fake clock, deletes the journals older than seven |
| 5 | //! days and keeps the younger, a directory aged by the newest entry under it; and the orphan |
| 6 | //! sweep deletes a value no index reaches while a live value and another space's orphan stay. |
| 7 | //! |
| 8 | //! Each test opens its own store under `~/.cache/lane-daimond-runner/r1f3-db/`. |
| 9 | //! |
| 10 | //! [Written with AI entirely](https://need2know.ai/entirely-ai/code)\ |
| 11 | //! Anthropic Claude |
| 12 | |
| 13 | use oxedyne_fe2o3_core::prelude::*; |
| 14 | use oxedyne_fe2o3_hash::{ |
| 15 | csum::ChecksumScheme, |
| 16 | hash::HashScheme, |
| 17 | }; |
| 18 | use oxedyne_fe2o3_o3db_sync::{ |
| 19 | O3db, |
| 20 | data::core::RestSchemesInput, |
| 21 | comm::response::Wait, |
| 22 | ns::{ |
| 23 | self, |
| 24 | Ns, |
| 25 | }, |
| 26 | test::{ |
| 27 | hooks::{ |
| 28 | self, |
| 29 | NsTear, |
| 30 | }, |
| 31 | setup::{ |
| 32 | self, |
| 33 | Uid, |
| 34 | UID_LEN, |
| 35 | }, |
| 36 | }, |
| 37 | }; |
| 38 | |
| 39 | use std::{ |
| 40 | path::PathBuf, |
| 41 | sync::Arc, |
| 42 | }; |
| 43 | |
| 44 | |
| 45 | type Db = O3db<{ UID_LEN }, Uid, (), HashScheme, HashScheme, ChecksumScheme>; |
| 46 | type TestNs = Ns<{ UID_LEN }, Uid, (), HashScheme, HashScheme, ChecksumScheme>; |
| 47 | |
| 48 | const DAY_MS: u64 = 24 * 60 * 60 * 1000; |
| 49 | const NOW_MS: u64 = 1_800_000_000_000; // the fake clock: no test reads the wall clock |
| 50 | |
| 51 | fn fresh_dir(name: &str) -> Outcome<PathBuf> { |
| 52 | let home = match std::env::var_os("HOME") { |
| 53 | Some(h) => PathBuf::from(h), |
| 54 | None => return Err(err!("HOME is not set."; Test, Missing)), |
| 55 | }; |
| 56 | let dir = home.join(".cache/lane-daimond-runner/r1f3-db").join(name); |
| 57 | let _ = std::fs::remove_dir_all(&dir); |
| 58 | res!(std::fs::create_dir_all(&dir)); |
| 59 | Ok(res!(dir.canonicalize())) |
| 60 | } |
| 61 | |
| 62 | fn open(db_root: &PathBuf) -> Outcome<Arc<Db>> { |
| 63 | let schms_input = RestSchemesInput::new( |
| 64 | None::<()>, |
| 65 | None::<HashScheme>, |
| 66 | None::<HashScheme>, |
| 67 | Some(ChecksumScheme::new_crc32()), |
| 68 | ); |
| 69 | let mut cfg = res!(setup::default_cfg()); |
| 70 | cfg.zone_overrides = Default::default(); |
| 71 | Ok(Arc::new(res!(setup::start_db(db_root.clone(), Some(cfg), schms_input, None, false, true)))) |
| 72 | } |
| 73 | |
| 74 | fn wrap(outcome: Outcome<()>) -> Outcome<()> { |
| 75 | log_finish_wait!(); |
| 76 | outcome |
| 77 | } |
| 78 | |
| 79 | fn names(ns: &TestNs, dir: &str) -> Outcome<Vec<String>> { |
| 80 | match res!(ns.list(dir)) { |
| 81 | Some(entries) => Ok(entries.into_iter().map(|(n, _)| n).collect()), |
| 82 | None => Ok(Vec::new()), |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | #[test] |
| 87 | fn ns_sweep_key_range_delete() -> Outcome<()> { |
| 88 | log_set_level!("warn"); |
| 89 | wrap(key_range()) |
| 90 | } |
| 91 | |
| 92 | fn key_range() -> Outcome<()> { |
| 93 | let root = res!(fresh_dir("range")); |
| 94 | let db = res!(open(&root)); |
| 95 | let ns = res!(TestNs::new(db.clone(), Uid::default(), "t")); |
| 96 | res!(ns.put("j/a", b"a")); |
| 97 | res!(ns.put("j/b", b"b")); |
| 98 | res!(ns.put("j/c/x", b"x")); |
| 99 | res!(ns.put("j/c/y", b"y")); |
| 100 | res!(ns.put("j/d", b"d")); |
| 101 | res!(ns.put("k/b", b"other dir")); |
| 102 | // [b, d): b, and c with its two values. |
| 103 | assert_eq!(res!(ns.delete_range("j", "b", "d")), 3); |
| 104 | assert_eq!(res!(names(&ns, "j")), vec!["a".to_string(), "d".to_string()]); |
| 105 | assert_eq!(res!(ns.get("j/c/x")), None); |
| 106 | assert_eq!(res!(ns.stat("j/c")), None); |
| 107 | assert_eq!(res!(ns.get("k/b")), Some(b"other dir".to_vec())); |
| 108 | // An empty range, and a range over a missing directory, delete nothing. |
| 109 | assert_eq!(res!(ns.delete_range("j", "d", "d")), 0); |
| 110 | assert_eq!(res!(ns.delete_range("none", "a", "z")), 0); |
| 111 | // The range never reaches the remains of what it deleted. |
| 112 | assert_eq!(res!(ns::orphans(&ns, Wait::default())), ns::Orphans::default()); |
| 113 | res!(db.close()); |
| 114 | Ok(()) |
| 115 | } |
| 116 | |
| 117 | #[test] |
| 118 | fn ns_sweep_ttl_on_a_fake_clock() -> Outcome<()> { |
| 119 | log_set_level!("warn"); |
| 120 | wrap(ttl()) |
| 121 | } |
| 122 | |
| 123 | fn ttl() -> Outcome<()> { |
| 124 | let root = res!(fresh_dir("ttl")); |
| 125 | let db = res!(open(&root)); |
| 126 | let ns = res!(TestNs::new(db.clone(), Uid::default(), "runner")); |
| 127 | let week = 7 * DAY_MS; |
| 128 | res!(ns.put_at("journals/old", b"o", NOW_MS - 8 * DAY_MS)); |
| 129 | res!(ns.put_at("journals/edge", b"e", NOW_MS - week)); // exactly 7 days: expired |
| 130 | res!(ns.put_at("journals/young", b"y", NOW_MS - 6 * DAY_MS)); |
| 131 | res!(ns.put_at("journals/future", b"f", NOW_MS + DAY_MS)); // a clock step back: kept |
| 132 | // A run journal as a directory: made 9 days ago, its last round written 1 day ago, so kept. |
| 133 | res!(ns.put_at("journals/run1/r0", b"0", NOW_MS - 9 * DAY_MS)); |
| 134 | res!(ns.put_at("journals/run1/r1", b"1", NOW_MS - DAY_MS)); |
| 135 | // A directory wholly older than 7 days goes, with everything under it. |
| 136 | res!(ns.put_at("journals/run2/r0", b"0", NOW_MS - 10 * DAY_MS)); |
| 137 | res!(ns.put_at("journals/run2/r1", b"1", NOW_MS - 8 * DAY_MS)); |
| 138 | assert_eq!(res!(ns.sweep_expired("journals", week, NOW_MS)), 4); |
| 139 | let mut left = res!(names(&ns, "journals")); |
| 140 | left.sort(); |
| 141 | assert_eq!(left, vec!["future".to_string(), "run1".to_string(), "young".to_string()]); |
| 142 | assert_eq!(res!(ns.get("journals/run2/r1")), None); |
| 143 | assert_eq!(res!(ns.get("journals/run1/r0")), Some(b"0".to_vec())); |
| 144 | // A second sweep at the same instant finds nothing; `young` goes the moment it turns 7 days. |
| 145 | assert_eq!(res!(ns.sweep_expired("journals", week, NOW_MS)), 0); |
| 146 | assert_eq!(res!(ns.sweep_expired("journals", week, NOW_MS + DAY_MS - 1)), 0); |
| 147 | assert_eq!(res!(ns.sweep_expired("journals", week, NOW_MS + DAY_MS)), 1); |
| 148 | assert_eq!(res!(ns.get("journals/young")), None); |
| 149 | assert_eq!(res!(ns::orphans(&ns, Wait::default())), ns::Orphans::default()); |
| 150 | res!(db.close()); |
| 151 | Ok(()) |
| 152 | } |
| 153 | |
| 154 | #[test] |
| 155 | fn ns_sweep_deletes_an_orphan_value() -> Outcome<()> { |
| 156 | log_set_level!("warn"); |
| 157 | wrap(orphan()) |
| 158 | } |
| 159 | |
| 160 | fn orphan() -> Outcome<()> { |
| 161 | let root = res!(fresh_dir("orphan")); |
| 162 | let db = res!(open(&root)); |
| 163 | let ns = res!(TestNs::new(db.clone(), Uid::default(), "t")); |
| 164 | res!(ns.put("o/kept", b"k")); |
| 165 | hooks::set_ns_tear(NsTear::Top(0)); |
| 166 | res!(ns.put("o/lost", b"l")); // a value, no entry |
| 167 | let other = res!(TestNs::new(db.clone(), Uid::default(), "u")); |
| 168 | hooks::set_ns_tear(NsTear::Top(0)); |
| 169 | res!(other.put("elsewhere", b"e")); // another space's orphan, not this sweep's |
| 170 | let swept = res!(ns::sweep_orphans(&ns, Wait::default())); |
| 171 | assert_eq!(swept.values, vec!["o/lost".to_string()]); |
| 172 | assert!(swept.dirs.is_empty()); |
| 173 | assert!(!res!(db.api().contains_wait(&ns.value_key("o/lost"), None))); |
| 174 | assert_eq!(res!(ns.get("o/kept")), Some(b"k".to_vec())); |
| 175 | assert_eq!(res!(ns::orphans(&ns, Wait::default())), ns::Orphans::default()); |
| 176 | assert_eq!(res!(ns::orphans(&other, Wait::default())).values, vec!["elsewhere".to_string()]); |
| 177 | // A put at the swept key makes it live again, and the next sweep leaves it. |
| 178 | res!(ns.put("o/lost", b"back")); |
| 179 | assert_eq!(res!(ns::sweep_orphans(&ns, Wait::default())), ns::Orphans::default()); |
| 180 | assert_eq!(res!(ns.get("o/lost")), Some(b"back".to_vec())); |
| 181 | res!(db.close()); |
| 182 | Ok(()) |
| 183 | } |