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
/*use std::fmt::Debug;
use autonomi::client::payment::PaymentOption;
use autonomi::pointer::PointerTarget;
use autonomi::{Pointer, PointerAddress, SecretKey};
use log::{debug, info, warn};
use mockall::mock;
use mockall_double::double;
use crate::client::cache_item::CacheItem;
#[double]
use crate::client::CachingClient;
use crate::client::{POINTER_CACHE_KEY, POINTER_CHECK_CACHE_KEY};
use crate::client::command::Command;
use crate::client::command::pointer::check_pointer_command::CheckPointerCommand;
use crate::client::command::pointer::get_pointer_command::GetPointerCommand;
use crate::controller::StoreType;
use crate::client::command::pointer::create_pointer_command::CreatePointerCommand;
use crate::client::command::pointer::update_pointer_command::UpdatePointerCommand;
use crate::error::GetError;
use crate::error::pointer_error::PointerError;
#[derive(Debug, Clone)]
pub struct PointerCachingClient {
caching_client: CachingClient,
}
mock! {
#[derive(Debug)]
pub PointerCachingClient {
pub fn new(caching_client: CachingClient) -> Self;
pub async fn pointer_create(
&self,
owner: &SecretKey,
target: PointerTarget,
counter: Option<u64>,
payment_option: PaymentOption,
store_type: StoreType,
) -> Result<PointerAddress, PointerError>;
pub async fn pointer_update(
&self,
owner: &SecretKey,
target: PointerTarget,
counter: Option<u64>,
store_type: StoreType,
) -> Result<(), PointerError>;
pub async fn pointer_get(&self, address: &PointerAddress) -> Result<Pointer, PointerError>;
pub async fn pointer_update_ttl(&self, address: &PointerAddress, ttl_override: u64) -> Result<Pointer, PointerError>;
pub async fn pointer_check_existence(&self, address: &PointerAddress) -> Result<bool, PointerError>;
}
impl Clone for PointerCachingClient {
fn clone(&self) -> Self;
}
}
impl PointerCachingClient {
pub fn new(caching_client: CachingClient) -> Self {
Self { caching_client }
}
pub async fn pointer_create(
&self,
owner: &SecretKey,
target: PointerTarget,
counter: Option<u64>,
payment_option: PaymentOption,
store_type: StoreType,
) -> Result<PointerAddress, PointerError> {
let pointer = self.cache_pointer(owner, &target, counter, store_type.clone());
if store_type == StoreType::Network {
let command = Box::new(
CreatePointerCommand::new(self.caching_client.get_client_harness().clone(), owner.clone(), target, counter, payment_option)
);
self.caching_client.send_create_command(command).await?;
}
Ok(pointer.address())
}
pub async fn pointer_update(
&self,
owner: &SecretKey,
target: PointerTarget,
counter: Option<u64>,
store_type: StoreType,
) -> Result<(), PointerError> {
self.cache_pointer(owner, &target, counter, store_type.clone());
if store_type == StoreType::Network {
let command = Box::new(
UpdatePointerCommand::new(self.caching_client.get_client_harness().clone(), owner.clone(), target, counter)
);
self.caching_client.send_update_command(command).await?;
}
Ok(())
}
fn cache_pointer(&self, owner: &SecretKey, target: &PointerTarget, counter: Option<u64>, store_type: StoreType) -> Pointer {
let pointer = Pointer::new(owner, counter.unwrap_or(0), target.clone());
let ttl = if store_type != StoreType::Network { u64::MAX } else { self.caching_client.get_ant_tp_config().cached_mutable_ttl };
let cache_item = CacheItem::new(Some(pointer.clone()), ttl);
match rmp_serde::to_vec(&cache_item) {
Ok(serialised_cache_item) => {
info!("updating cache with pointer at address {}[{}] to target [{}] and TTL [{}]", POINTER_CACHE_KEY, pointer.address().to_hex(), target.to_hex(), ttl);
if store_type == StoreType::Disk {
self.caching_client.get_hybrid_cache().insert(format!("{}{}", POINTER_CACHE_KEY, pointer.address().to_hex()), serialised_cache_item);
} else {
self.caching_client.get_hybrid_cache().memory().insert(format!("{}{}", POINTER_CACHE_KEY, pointer.address().to_hex()), serialised_cache_item);
}
},
Err(e) => {
warn!("Failed to serialize pointer for [{}]: {}", pointer.address().to_hex(), e.to_string());
}
}
pointer
}
pub async fn pointer_get(&self, address: &PointerAddress) -> Result<Pointer, PointerError> {
let cache_item = self.get_cache_item(address).await?;
match cache_item.item {
Some(_) => {
info!("retrieved pointer for [{}] from hybrid cache", address.to_hex());
if cache_item.has_expired() {
let command = GetPointerCommand::new(self.caching_client.get_client_harness().clone(), self.caching_client.get_hybrid_cache().clone(), address.clone(), self.caching_client.get_ant_tp_config().cached_mutable_ttl);
tokio::spawn(async move {
let _ = command.execute().await;
});
}
Ok(cache_item.item.unwrap())
}
None => {
info!("negative cache for pointer for [{}] from hybrid cache", address.to_hex());
Err(PointerError::GetError(GetError::RecordNotFound(format!("Failed to retrieve pointer for [{}] from network", address.to_hex()))))
}
}
}
pub async fn pointer_update_ttl(&self, address: &PointerAddress, ttl_override: u64) -> Result<Pointer, PointerError> {
let cache_item = self.get_cache_item(address).await?;
match cache_item.item {
Some(_) => {
let updated_cache_item = CacheItem::new(Some(cache_item.item.clone().unwrap()), ttl_override);
match rmp_serde::to_vec(&updated_cache_item) {
Ok(serialized_cache_item) => {
self.caching_client.get_hybrid_cache().insert(
format!("{}{}", POINTER_CACHE_KEY, address.to_hex()),
serialized_cache_item
);
},
Err(e) => {
warn!("Failed to update TTL for pointer [{}] in hybrid cache: {}", address.to_hex(), e.to_string());
},
}
Ok(cache_item.item.unwrap())
}
None => {
info!("negative cache for pointer for [{}] from hybrid cache", address.to_hex());
Err(PointerError::GetError(GetError::RecordNotFound(format!("Failed to retrieve pointer for [{}] from network", address.to_hex()))))
}
}
}
async fn get_cache_item(&self, address: &PointerAddress) -> Result<CacheItem<Pointer>, PointerError> {
let local_address = address.clone();
let local_ant_tp_config = self.caching_client.get_ant_tp_config().clone();
let cache_entry = self.caching_client.get_hybrid_cache().get_ref().get_or_fetch(&format!("{}{}", POINTER_CACHE_KEY, local_address.to_hex()), {
let client = self.caching_client.get_client_harness().get_ref().lock().await.get_client().await?;
|| async move {
match client.pointer_get(&local_address).await {
Ok(pointer) => {
debug!("found pointer [{}] for address [{}]", hex::encode(pointer.target().to_hex()), local_address.to_hex());
let cache_item = CacheItem::new(Some(pointer.clone()), local_ant_tp_config.cached_mutable_ttl);
match rmp_serde::to_vec(&cache_item) {
Ok(cache_item) => Ok(cache_item),
Err(e) => Err(anyhow::anyhow!(format!("Failed to serialize pointer for [{}]: {}", local_address.to_hex(), e.to_string())))
}
},
Err(e) => {
// store negative cache to avoid repeated lookups
debug!("failed to find pointer for address [{}]: {}", local_address.to_hex(), e);
let cache_item: CacheItem<Pointer> = CacheItem::new(None, local_ant_tp_config.cached_mutable_ttl * 10);
match rmp_serde::to_vec(&cache_item) {
Ok(cache_item) => Ok(cache_item),
Err(e) => Err(anyhow::anyhow!(format!("Failed to serialize pointer for [{}]: {}", local_address.to_hex(), e.to_string())))
}
}
}
}
}).await?;
match rmp_serde::from_slice(cache_entry.value()) {
Ok(cache_item) => Ok(cache_item),
Err(e) => Err(PointerError::GetError(GetError::RecordNotFound(format!("Failed to deserialize pointer for [{}]: {}", local_address.to_hex(), e.to_string()))))
}
}
pub async fn pointer_check_existence(&self, address: &PointerAddress) -> Result<bool, PointerError> {
let local_address = address.clone();
let local_ant_tp_config = self.caching_client.get_ant_tp_config().clone();
let cache_entry = self.caching_client.get_hybrid_cache().get_ref().get_or_fetch(&format!("{}{}", POINTER_CHECK_CACHE_KEY, local_address.to_hex()), {
let client = self.caching_client.get_client_harness().get_ref().lock().await.get_client().await?;
|| async move {
match client.pointer_check_existence(&local_address).await {
Ok(_) => {
debug!("pointer exists for address [{}]", local_address.to_hex());
let cache_item = CacheItem::new(Some(true), local_ant_tp_config.cached_mutable_ttl);
match rmp_serde::to_vec(&cache_item) {
Ok(cache_item) => Ok(cache_item),
Err(e) => Err(anyhow::anyhow!(format!("Failed to serialize pointer for [{}]: {}", local_address.to_hex(), e.to_string())))
}
},
Err(e) => {
// store negative cache to avoid repeated lookups
debug!("failed to find pointer exists for address [{}]: {}", local_address.to_hex(), e);
let cache_item: CacheItem<Pointer> = CacheItem::new(None, local_ant_tp_config.cached_mutable_ttl * 10);
match rmp_serde::to_vec(&cache_item) {
Ok(cache_item) => Ok(cache_item),
Err(e) => Err(anyhow::anyhow!(format!("Failed to serialize pointer for [{}]: {}", local_address.to_hex(), e.to_string())))
}
}
}
}
}).await?;
let cache_item: CacheItem<bool> = rmp_serde::from_slice(cache_entry.value())?;
match cache_item.item {
Some(_) => {
info!("retrieved pointer check existence for [{}] from hybrid cache", address.to_hex());
if cache_item.has_expired() {
let command = CheckPointerCommand::new(self.caching_client.get_client_harness().clone(), self.caching_client.get_hybrid_cache().clone(), address.clone(), self.caching_client.get_ant_tp_config().cached_mutable_ttl);
tokio::spawn(async move {
let _ = command.execute().await;
});
}
Ok(cache_item.item.unwrap())
}
None => {
info!("negative cache for pointer for [{}] from hybrid cache", address.to_hex());
Err(PointerError::GetError(GetError::RecordNotFound(format!("Failed to pointer check existence for [{}] from network", local_address.to_hex()))))
}
}
}
}*/