dist_lock 0.0.1

Distributed lock
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

use chrono::Utc;

use gethostname::gethostname;

use redis::Value;

use crate::core::LockConfig;
use crate::core::LockState;
use crate::core::Lockable;
use crate::error::LockResult;

const KEY_PREFIX: &str = "dist_lock";

#[derive(Debug)]
pub struct RedisDriver<'a, T> {
	key: String,
	transport: &'a T,
}

impl<'a, T> RedisDriver<'a, T> {
	pub fn new(lock_name: &String, transport: &'a T) -> Self {
		RedisDriver { key: format!("{}:{}", KEY_PREFIX, lock_name), transport }
	}

	#[inline(always)]
	fn build_value() -> String {
		format!("{},{}", Utc::now().timestamp_millis(), gethostname().to_string_lossy())
	}
}

macro_rules! impl_lockable_redis {
	($client:ty,
		$conn_fn_name: ident,
		$query_fn_name: ident,
		$($async: ident)?,
		$($await: tt)*
	) => {
		#[cfg_attr(any(feature = "tokio", feature = "async-std"), async_trait::async_trait)]
		impl<'a> Lockable for RedisDriver<'a, $client> {
			$($async)? fn acquire_lock(&self, config: &LockConfig) -> LockResult<LockState> {
				let mut conn = self.transport.$conn_fn_name()$($await)*?;
				let value: Value = redis::cmd("SET")
					.arg(&self.key)
					.arg(Self::build_value())
					.arg("NX")
					.arg("PX")
					.arg(config.max_lock.num_milliseconds() as usize)
					.$query_fn_name(&mut conn)$($await)*?;
				Ok(LockState::new(matches!(value, Value::Okay), Utc::now()))
			}

			$($async)? fn release_lock(
				&self,
				config: &LockConfig,
				state: &LockState,
			) -> LockResult<LockState> {
				let until = config.lock_at_least_until(state.locked_at);
				let mut conn = self.transport.$conn_fn_name()$($await)*?;
				let remaining = (until - Utc::now()).num_milliseconds();
				if remaining > 0 {
					redis::cmd("SET")
						.arg(&self.key)
						.arg(Self::build_value())
						.arg("XX")
						.arg("PX")
						.arg(remaining)
						.$query_fn_name(&mut conn)$($await)*?;
				} else {
					redis::cmd("DEL").arg(&self.key).$query_fn_name(&mut conn)$($await)*?;
				}

				Ok(LockState::unlock())
			}

			$($async)? fn extend_lock(&self, config: &LockConfig) -> LockResult<LockState> {
				let mut conn = self.transport.$conn_fn_name()$($await)*?;
				let value: Value = redis::cmd("SET")
					.arg(&self.key)
					.arg(Self::build_value())
					.arg("XX")
					.arg("PX")
					.arg(config.max_lock.num_milliseconds() as usize)
					.$query_fn_name(&mut conn)$($await)*?;
				Ok(LockState::new(matches!(value, Value::Okay), Utc::now()))
			}
		}
	}
}

#[cfg(any(feature = "tokio", feature = "async-std"))]
impl_lockable_redis!(::redis::cluster::ClusterClient, get_async_connection, query_async, async, .await);
#[cfg(any(feature = "tokio", feature = "async-std"))]
impl_lockable_redis!(::redis::Client, get_async_connection, query_async, async, .await);

#[cfg(not(any(feature = "tokio", feature = "async-std")))]
impl_lockable_redis!(::redis::Client, get_connection, query,,);
#[cfg(not(any(feature = "tokio", feature = "async-std")))]
impl_lockable_redis!(::redis::cluster::ClusterClient, get_connection, query,,);

#[cfg(feature = "r2d2")]
impl_lockable_redis!(::r2d2::Pool<::redis::cluster::ClusterClient> , get, query,,);
#[cfg(feature = "r2d2")]
impl_lockable_redis!(::r2d2::Pool<::redis::Client> , get, query,,);