-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
179 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| // Copyright (C) 2024 Quickwit, Inc. | ||
| // | ||
| // Quickwit is offered under the AGPL v3.0 and as commercial software. | ||
| // For commercial licensing, contact us at [email protected]. | ||
| // | ||
| // AGPL: | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as | ||
| // published by the Free Software Foundation, either version 3 of the | ||
| // License, or (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| use std::fmt::Debug; | ||
| use std::hash::Hash; | ||
| use std::num::NonZeroUsize; | ||
| use std::time::{Duration, Instant}; | ||
|
|
||
| use lru::LruCache; | ||
|
|
||
| /// A map that keeps track of a cooldown deadline for each of its keys. | ||
| /// | ||
| /// Internally it uses an [`LruCache`] to prune the oldest entries when the | ||
| /// capacity is reached. If the capacity is reached but the oldest entry is not | ||
| /// outdated, the capacity is extended (2x). | ||
| pub struct CooldownMap<K>(LruCache<K, Instant>); | ||
|
|
||
| #[derive(Debug, PartialEq)] | ||
| pub enum CooldownStatus { | ||
| Ready, | ||
| InCooldown, | ||
| } | ||
|
|
||
| impl<K: Hash + Eq> CooldownMap<K> { | ||
| pub fn new(capacity: NonZeroUsize) -> Self { | ||
| Self(LruCache::new(capacity)) | ||
| } | ||
|
|
||
| /// Updates the deadline for the given key if it isn't currently in cooldown. | ||
| /// | ||
| /// The status returned is the one before the update (after an update, the | ||
| /// status is always `InCooldown`). | ||
| pub fn update(&mut self, key: K, cooldown_interval: Duration) -> CooldownStatus { | ||
| let deadline_opt = self.0.get_mut(&key); | ||
| let now = Instant::now(); | ||
| if let Some(deadline) = deadline_opt { | ||
| if *deadline > now { | ||
| CooldownStatus::InCooldown | ||
| } else { | ||
| *deadline = now + cooldown_interval; | ||
| CooldownStatus::Ready | ||
| } | ||
| } else { | ||
| let capacity: usize = self.0.cap().into(); | ||
| if self.0.len() == capacity { | ||
| if let Some((_, deadline)) = self.0.peek_lru() { | ||
| if *deadline > now { | ||
| // the oldest entry is not outdated, grow the LRU | ||
| self.0.resize(NonZeroUsize::new(capacity * 2).unwrap()); | ||
| } | ||
| } | ||
| } | ||
| self.0.push(key, now + cooldown_interval); | ||
| CooldownStatus::Ready | ||
| } | ||
| } | ||
| } | ||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_cooldown_map_resize() { | ||
| let mut cooldown_map = CooldownMap::new(NonZeroUsize::new(2).unwrap()); | ||
| let cooldown_interval = Duration::from_secs(1); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key1", cooldown_interval), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key1", cooldown_interval), | ||
| CooldownStatus::InCooldown | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key2", cooldown_interval), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key2", cooldown_interval), | ||
| CooldownStatus::InCooldown | ||
| ); | ||
| // Hitting the capacity, the map should grow transparently | ||
| assert_eq!( | ||
| cooldown_map.update("test_key3", cooldown_interval), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key1", cooldown_interval), | ||
| CooldownStatus::InCooldown | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key2", cooldown_interval), | ||
| CooldownStatus::InCooldown | ||
| ); | ||
| assert_eq!(cooldown_map.0.cap(), NonZeroUsize::new(4).unwrap()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_cooldown_map_expired() { | ||
| let mut cooldown_map = CooldownMap::new(NonZeroUsize::new(2).unwrap()); | ||
| let cooldown_interval_short = Duration::from_millis(100); | ||
| let cooldown_interval_long = Duration::from_secs(5); | ||
|
|
||
| assert_eq!( | ||
| cooldown_map.update("test_key_short", cooldown_interval_short), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key_long", cooldown_interval_long), | ||
| CooldownStatus::Ready | ||
| ); | ||
|
|
||
| std::thread::sleep(cooldown_interval_short.mul_f32(1.1)); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key_short", cooldown_interval_short), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key_long", cooldown_interval_long), | ||
| CooldownStatus::InCooldown | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_cooldown_map_eviction() { | ||
| let mut cooldown_map = CooldownMap::new(NonZeroUsize::new(2).unwrap()); | ||
| let cooldown_interval_short = Duration::from_millis(100); | ||
| let cooldown_interval_long = Duration::from_secs(5); | ||
|
|
||
| assert_eq!( | ||
| cooldown_map.update("test_key_short", cooldown_interval_short), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key_long_1", cooldown_interval_long), | ||
| CooldownStatus::Ready | ||
| ); | ||
|
|
||
| // after the cooldown period `test_key_short` should be evicted when adding a new key | ||
| std::thread::sleep(cooldown_interval_short.mul_f32(1.1)); | ||
| assert_eq!(cooldown_map.0.len(), 2); | ||
| assert_eq!( | ||
| cooldown_map.update("test_key_long_2", cooldown_interval_long), | ||
| CooldownStatus::Ready | ||
| ); | ||
| assert_eq!(cooldown_map.0.len(), 2); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters