amnesia 0.2.0 

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

use super::{Driver, Error as CacheError};
use async_trait::async_trait;
use ensemble::{types::DateTime, Model};
use std::time::Duration;

#[derive(Debug, Model)]
#[ensemble(table = "cache")]
struct CacheEntry {
	#[model(primary)]
	pub key: String,
	pub value: Vec<u8>,
	pub expiration: Option<DateTime>,
}

#[allow(clippy::module_name_repetitions)]
#[derive(Debug, Default)]
/// A driver that stores cache entries in a database.
pub struct DatabaseDriver;

impl DatabaseDriver {
	#[must_use]
	pub const fn new() -> Self {
		Self
	}
}

fn map_db_err(e: ensemble::Error) -> CacheError {
	CacheError::Other(Box::new(e))
}

#[async_trait]
impl Driver for DatabaseDriver {
	async fn get(&self, key: &str) -> Result<Option<Vec<u8>>, CacheError> {
		let Some(entry) = CacheEntry::query()
			.r#where("key", '=', key)
			.where_group(|query| {
				query
					.where_null("expiration")
					.or_where("expiration", '>', DateTime::now())
			})
			.first::<CacheEntry>()
			.await
			.map_err(map_db_err)?
		else {
			return Ok(None);
		};

		Ok(Some(entry.value))
	}

	async fn has(&self, key: &str) -> Result<bool, CacheError> {
		let count = CacheEntry::query()
			.r#where("key", '=', key)
			.where_null("expiration")
			.or_where("expiration", '>', DateTime::now())
			.count()
			.await
			.map_err(map_db_err)?;

		Ok(count != 0)
	}

	async fn put(
		&self,
		key: &str,
		value: Vec<u8>,
		duration: Option<Duration>,
	) -> Result<(), CacheError> {
		let expiration = duration.map(|duration| DateTime::now() + duration);

		// TODO: This should be a single query.
		CacheEntry::query()
			.r#where("key", '=', key)
			.delete()
			.await
			.map_err(map_db_err)?;

		CacheEntry::create(CacheEntry {
			value,
			expiration,
			key: key.to_string(),
		})
		.await
		.map_err(map_db_err)?;

		Ok(())
	}

	async fn forget(&self, key: &str) -> Result<(), CacheError> {
		CacheEntry::query()
			.r#where("key", '=', key)
			.delete()
			.await
			.map_err(map_db_err)?;

		Ok(())
	}

	async fn flush(&self) -> Result<(), CacheError> {
		CacheEntry::query().delete().await.map_err(map_db_err)?;

		Ok(())
	}
}

#[cfg(test)]
mod tests {
	use std::env;

	use super::*;
	use crate::Cache;

	#[tokio::test]
	async fn test_database_driver() {
		ensemble::setup(&env::var("DATABASE_URL").expect("DATABASE_URL not set")).unwrap();

		let cache = Cache::new(DatabaseDriver::new());

		assert_eq!(cache.get::<String>("foo").await.unwrap(), None);
		assert!(!cache.has("foo").await.unwrap());

		cache
			.put("foo", &"bar".to_string(), Duration::from_secs(10))
			.await
			.unwrap();

		assert_eq!(cache.get("foo").await.unwrap(), Some("bar".to_string()));
		assert!(cache.has("foo").await.unwrap());

		cache.forget("foo").await.unwrap();

		assert_eq!(cache.get::<String>("foo").await.unwrap(), None);
		assert!(!cache.has("foo").await.unwrap());

		cache
			.put("foo", &"bar".to_string(), Duration::from_secs(1))
			.await
			.unwrap();
	}
}