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 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
#![crate_name = "pond_cache"]
use std::hash::{DefaultHasher, Hash, Hasher};
use std::path::PathBuf;
use chrono::{DateTime, Duration, Utc};
use rusqlite::Connection;
use serde::de::DeserializeOwned;
use serde::Serialize;
pub use rusqlite::Error;
/// Pond cache struct
pub struct Cache<T> {
path: PathBuf,
ttl: Duration,
data: std::marker::PhantomData<T>,
}
#[derive(Debug)]
struct CacheEntry<T>
where
T: Serialize + DeserializeOwned + Clone,
{
key: u32,
value: T,
expiration: DateTime<Utc>,
}
impl<T: Serialize + DeserializeOwned + Clone> Cache<T> {
/// Create a new cache with a default time-to-live of 10 minutes
///
/// # Arguments
/// * `path` - Path to the SQLite database file
///
/// # Returns
/// A new cache instance
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
///
/// let cache: Cache<String> = Cache::new(PathBuf::from("cache.db")).expect("Failed to create cache");
/// ```
pub fn new(path: PathBuf) -> Result<Self, Error> {
Self::with_time_to_live(path, Duration::minutes(10))
}
/// Create a new cache with a custom time-to-live
///
/// # Arguments
/// * `path` - Path to the SQLite database file
/// * `ttl` - Time-to-live for cache entries
///
/// # Returns
/// A new cache instance
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
/// use chrono::Duration;
///
/// let cache: Cache<String> = Cache::with_time_to_live(PathBuf::from("cache.db"), Duration::minutes(5)).expect("Failed to create cache");
/// ```
pub fn with_time_to_live(path: PathBuf, ttl: Duration) -> Result<Self, Error> {
let db = Connection::open(path.as_path())?;
db.execute(
"CREATE TABLE IF NOT EXISTS items (
id TEXT PRIMARY KEY,
expires TEXT NOT NULL,
data BLOB NOT NULL
)",
(),
)?;
db.close().expect("Failed to close database connection");
Ok(Self {
path,
ttl,
data: std::marker::PhantomData,
})
}
/// Retrieve a value from the cache
///
/// # Arguments
/// * `key` - Key to retrieve the value for
///
/// # Returns
/// The value associated with the key, if it exists and has not expired
/// If the value does not exist or has expired, returns `None`
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
///
/// let cache: Cache<String> = Cache::new(PathBuf::from("cache.db")).expect("Failed to create cache");
/// let key = "key";
/// let value: Option<String> = cache.get(key).expect("Failed to get value");
/// ```
pub fn get<K: Hash>(&self, key: K) -> Result<Option<T>, Error> {
let db = Connection::open(self.path.as_path())?;
let mut stmt = db.prepare(
"SELECT id, expires, data
FROM items
WHERE id = ?1",
)?;
let mut hasher = DefaultHasher::new();
let hash = {
key.hash(&mut hasher);
hasher.finish() as u32
};
let mut rows = stmt.query([hash]).unwrap();
let Some(row) = rows.next().unwrap() else {
return Ok(None);
};
let expires: DateTime<Utc> = row
.get::<usize, String>(1)
.map(|expires_string| {
DateTime::parse_from_rfc3339(&expires_string)
.unwrap()
.with_timezone(&Utc)
})
.unwrap();
let data: Vec<u8> = row.get(2).unwrap();
drop(rows);
drop(stmt);
db.close().expect("Failed to close database connection");
let data: T = bitcode::deserialize(&data).unwrap();
if expires < Utc::now() {
Ok(None)
} else {
Ok(Some(data))
}
}
/// Store a value in the cache
/// The value will be stored with the cache's time-to-live
/// If the value already exists, it will be replaced
///
/// # Arguments
/// * `key` - Key to store the value under
/// * `value` - Value to store
///
/// # Returns
/// Ok if the value was stored successfully
/// Err if the value could not be stored
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
///
/// let cache: Cache<String> = Cache::new(PathBuf::from("cache.db")).expect("Failed to create cache");
/// let key = "key";
/// let value = String::from("value");
/// cache.store(key, value).expect("Failed to store value");
/// ```
pub fn store<K: Hash>(&self, key: K, value: T) -> Result<(), Error> {
self.store_with_expiration(key, value, Utc::now() + self.ttl)
}
/// Store a value in the cache with a custom expiration time
/// If the value already exists, it will be replaced
///
/// # Arguments
/// * `key` - Key to store the value under
/// * `value` - Value to store
/// * `expiration` - Expiration time for the value
///
/// # Returns
/// Ok if the value was stored successfully
/// Err if the value could not be stored
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
/// use chrono::{Duration, Utc};
///
/// let cache: Cache<String> = Cache::new(PathBuf::from("cache.db")).expect("Failed to create cache");
/// let key = "key";
/// let value = String::from("value");
/// let expiration = Utc::now() + Duration::minutes(5);
///
/// cache.store_with_expiration(key, value, expiration).expect("Failed to store value");
/// ```
pub fn store_with_expiration<K: Hash>(
&self,
key: K,
value: T,
expiration: DateTime<Utc>,
) -> Result<(), Error> {
let mut hasher = DefaultHasher::new();
let hash = {
key.hash(&mut hasher);
hasher.finish() as u32
};
let value = CacheEntry {
key: hash,
value,
expiration,
};
let db = Connection::open(self.path.as_path())?;
db.execute(
"INSERT OR REPLACE INTO items (id, expires, data) VALUES (?1, ?2, ?3);",
(
&value.key.to_string(),
&value.expiration.to_rfc3339(),
&bitcode::serialize(&value.value).unwrap(),
),
)?;
db.close().expect("Failed to close database connection");
Ok(())
}
/// Clean up the cache by removing expired entries
/// This method should be called periodically to prevent the cache from growing indefinitely
///
/// # Returns
/// Ok if the cache was cleaned successfully
/// Err if the cache could not be cleaned
///
/// # Errors
/// Returns an error if the database connection cannot be established
///
/// # Example
/// ```rust
/// use pond_cache::Cache;
/// use std::path::PathBuf;
///
/// let cache: Cache<String> = Cache::new(PathBuf::from("cache.db")).expect("Failed to create cache");
/// cache.clean().expect("Failed to clean cache");
/// ```
pub fn clean(&self) -> Result<(), Error> {
let db = Connection::open(self.path.as_path())?;
db.execute(
"DELETE FROM items WHERE expires < ?1;",
(&Utc::now().to_rfc3339(),),
)?;
db.close().expect("Failed to close database connection");
Ok(())
}
}
#[cfg(test)]
mod tests {
use serde::Deserialize;
use serde::Serialize;
use uuid::Uuid;
use super::*;
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
struct User {
id: Uuid,
name: String,
}
fn store_manual(
path: PathBuf,
key: String,
value: Vec<u8>,
expires: DateTime<Utc>,
) -> Result<(), Error> {
let mut hasher = DefaultHasher::new();
let hash = {
key.hash(&mut hasher);
hasher.finish() as u32
};
let db = Connection::open(path.as_path()).unwrap();
db.execute(
"INSERT OR REPLACE INTO items (id, expires, data) VALUES (?1, ?2, ?3);",
(hash, &expires.to_rfc3339(), &value),
)
.unwrap();
db.close().unwrap();
Ok(())
}
fn get_manual<T: Serialize + DeserializeOwned + Clone>(
path: PathBuf,
key: String,
) -> Result<Option<CacheEntry<T>>, Error> {
let db = Connection::open(path.as_path())?;
let mut stmt = db.prepare(
"SELECT id, expires, data
FROM items
WHERE id = ?1",
)?;
let mut hasher = DefaultHasher::new();
let hash = {
key.hash(&mut hasher);
hasher.finish() as u32
};
let mut rows = stmt.query([hash]).unwrap();
let Some(row) = rows.next().unwrap() else {
return Ok(None);
};
let expires: DateTime<Utc> = row
.get::<usize, String>(1)
.map(|expires_string| {
DateTime::parse_from_rfc3339(&expires_string)
.unwrap()
.with_timezone(&Utc)
})
.unwrap();
let data: Vec<u8> = row.get(2).unwrap();
drop(rows);
drop(stmt);
db.close().expect("Failed to close database connection");
let data: T = bitcode::deserialize(&data).unwrap();
Ok(Some(CacheEntry {
key: hash,
value: data,
expiration: expires,
}))
}
#[test]
fn test_new() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache: Cache<String> = Cache::new(filename.clone()).unwrap();
assert_eq!(cache.path, filename);
assert_eq!(cache.ttl, Duration::minutes(10));
}
#[test]
fn test_load_existing() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let _: Cache<String> = Cache::new(filename.clone()).unwrap();
let _: Cache<String> = Cache::new(filename).unwrap();
}
#[test]
fn test_time_to_live() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache: Cache<String> =
Cache::with_time_to_live(filename.clone(), Duration::minutes(5)).unwrap();
assert_eq!(cache.path, filename);
assert_eq!(cache.ttl, Duration::minutes(5));
}
#[test]
fn test_store_get() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache = Cache::new(filename).unwrap();
let key = Uuid::new_v4();
let value = String::from("Hello, world!");
cache.store(key, value.clone()).unwrap();
let result: Option<_> = cache.get(key).unwrap();
assert_eq!(result, Some(value));
}
#[test]
fn test_store_get_struct() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache = Cache::new(filename).unwrap();
let key = Uuid::new_v4();
let value = User {
id: Uuid::new_v4(),
name: String::from("Alice"),
};
cache.store(key, value.clone()).unwrap();
let result: Option<_> = cache.get(key).unwrap();
assert_eq!(result, Some(value));
}
#[test]
fn test_store_existing() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache = Cache::new(filename).unwrap();
let key = Uuid::new_v4();
let value = String::from("Hello, world!");
cache.store(key, value).unwrap();
let value = String::from("Hello, world! 2");
cache.store(key, value.clone()).unwrap();
let result: Option<_> = cache.get(key).unwrap();
assert_eq!(result, Some(value));
}
#[test]
fn test_get_expired() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache = Cache::new(filename.clone()).unwrap();
let key = Uuid::new_v4();
let value = String::from("Hello, world!");
store_manual(
filename,
key.to_string(),
bitcode::serialize(&value).unwrap(),
Utc::now() - Duration::minutes(5),
)
.unwrap();
let result: Option<String> = cache.get(key).unwrap();
assert_eq!(result, None);
}
#[test]
fn test_get_nonexistent() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache = Cache::new(filename).unwrap();
let key = Uuid::new_v4();
let result: Option<String> = cache.get(key).unwrap();
assert_eq!(result, None);
}
#[test]
fn test_invalid_path() {
let cache: Result<Cache<String>, Error> =
Cache::new(PathBuf::from("invalid/path/db.sqlite"));
assert!(cache.is_err());
}
#[test]
fn test_clean() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache: Cache<String> =
Cache::with_time_to_live(filename.clone(), Duration::minutes(5)).unwrap();
let key = Uuid::new_v4().to_string();
let value = String::from("Hello, world!");
store_manual(
filename.clone(),
key.clone(),
bitcode::serialize(&value).unwrap(),
Utc::now() - Duration::minutes(5),
)
.unwrap();
let result: Option<CacheEntry<String>> = get_manual(filename.clone(), key.clone()).unwrap();
if let Some(result) = result {
assert_eq!(result.value, value);
} else {
panic!("Expected result to be Some");
}
cache.clean().unwrap();
let result: Option<CacheEntry<String>> = get_manual(filename, key).unwrap();
assert!(result.is_none());
}
#[test]
fn test_clean_leaves_unexpired() {
let filename = std::env::temp_dir().join(format!(
"pond-test-{}-{}.sqlite",
Uuid::new_v4(),
rand::random::<u8>()
));
let cache: Cache<String> =
Cache::with_time_to_live(filename.clone(), Duration::minutes(5)).unwrap();
let key = Uuid::new_v4().to_string();
let value = String::from("Hello, world!");
store_manual(
filename.clone(),
key.clone(),
bitcode::serialize(&value).unwrap(),
Utc::now() + Duration::minutes(15),
)
.unwrap();
let result: Option<CacheEntry<String>> = get_manual(filename.clone(), key.clone()).unwrap();
if let Some(result) = result {
assert_eq!(result.value, value);
} else {
panic!("Expected result to be Some");
}
cache.clean().unwrap();
let result: Option<CacheEntry<String>> = get_manual(filename, key).unwrap();
if let Some(result) = result {
assert_eq!(result.value, value);
} else {
panic!("Expected result to be Some");
}
}
}