Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 138 additions & 42 deletions src/data_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use std::collections::{hash_map, HashMap};
use std::collections::HashMap;
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand DownExpand Up@@ -83,34 +83,38 @@ where

pub(crate) async fn insert_or_update(&self, object: SO) -> Result<bool, Error> {
let _guard = self.mutation_lock.lock().await;
let (updated, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
match locked_objects.entry(object.id()) {
hash_map::Entry::Occupied(mut e) => {
let update = object.to_update();
let updated = e.get_mut().update(update);
let data_to_persist =
if updated { Some(Self::encode_object(e.get())) } else { None };
(updated, data_to_persist)
},
hash_map::Entry::Vacant(e) => {
let data_to_persist = Self::encode_object(&object);
e.insert(object);
(true, Some(data_to_persist))
},

let id = object.id();
let data_to_persist = {
let locked_objects = self.objects.lock().expect("lock");
if let Some(existing_object) = locked_objects.get(&id) {
let mut updated_object = existing_object.clone();
let updated = updated_object.update(object.to_update());
if updated {
Some(updated_object)
} else {
None
}
} else {
Some(object)
}
};

if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
match data_to_persist {
Some(updated_object) => {
self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(true)
},
None => Ok(false),
}
Ok(updated)
}

pub(crate) async fn remove(&self, id: &SO::Id) -> Result<(), Error> {
let _guard = self.mutation_lock.lock().await;
let removed = { self.objects.lock().expect("lock").remove(id).is_some() };
if removed {
let should_remove = { self.objects.lock().expect("lock").contains_key(id) };
if should_remove {
let store_key = id.encode_to_hex_str();
KVStore::remove(
&*self.kv_store,
Expand All@@ -131,45 +135,46 @@ where
);
Error::PersistenceFailed
})?;
self.objects.lock().expect("lock").remove(id);
}
Ok(())
}

/// Returns the current in-memory object for `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn get(&self, id: &SO::Id) -> Option<SO> {
self.objects.lock().expect("lock").get(id).cloned()
}

pub(crate) async fn update(&self, update: SO::Update) -> Result<DataStoreUpdateResult, Error> {
let _guard = self.mutation_lock.lock().await;
let (res, data_to_persist) = {
let mut locked_objects = self.objects.lock().expect("lock");
if let Some(object) = locked_objects.get_mut(&update.id()) {
let updated = object.update(update);
if updated {
(DataStoreUpdateResult::Updated, Some(Self::encode_object(object)))
} else {
(DataStoreUpdateResult::Unchanged, None)
}
} else {
(DataStoreUpdateResult::NotFound, None)
let id = update.id();
let updated_object = {
let locked_objects = self.objects.lock().expect("lock");
let Some(object) = locked_objects.get(&id) else {
return Ok(DataStoreUpdateResult::NotFound);
};
let mut updated_object = object.clone();
if !updated_object.update(update) {
return Ok(DataStoreUpdateResult::Unchanged);
}
updated_object
};
if let Some((store_key, data)) = data_to_persist {
self.persist_encoded(store_key, data).await?;
}
Ok(res)

self.persist(&updated_object).await?;
let mut locked_objects = self.objects.lock().expect("lock");
locked_objects.insert(id, updated_object);
Ok(DataStoreUpdateResult::Updated)
}

/// Returns in-memory objects matching `f`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn list_filter<F: FnMut(&&SO) -> bool>(&self, f: F) -> Vec<SO> {
self.objects.lock().expect("lock").values().filter(f).cloned().collect::<Vec<SO>>()
}
Expand DownExpand Up@@ -209,8 +214,8 @@ where
/// Returns whether the in-memory store contains `id`.
///
/// The async mutation lock serializes writers, but this synchronous reader cannot wait on it.
/// Until store reads are async, callers may temporarily see in-memory state that is either
/// still being persisted or has not yet caught up to a write in progress.
/// Until store reads are async, callers may temporarily see in-memory state that has not yet
/// caught up to a write in progress.
pub(crate) fn contains_key(&self, id: &SO::Id) -> bool {
self.objects.lock().expect("lock").contains_key(id)
}
Expand All@@ -219,6 +224,7 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::io;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand DownExpand Up@@ -281,6 +287,46 @@ mod tests {
(2, data, required),
});

struct FailingStore;

impl KVStore for FailingStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str,
) -> impl std::future::Future<Output = Result<Vec<u8>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "read failed")) }
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "write failed")) }
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl std::future::Future<Output = Result<(), io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "remove failed")) }
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl std::future::Future<Output = Result<Vec<String>, io::Error>> + 'static + Send {
async { Err(io::Error::new(io::ErrorKind::Other, "list failed")) }
}
}

fn new_failing_data_store(objects: Vec<TestObject>) -> DataStore<TestObject, Arc<TestLogger>> {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(FailingStore));
let logger = Arc::new(TestLogger::new());
DataStore::new(
objects,
"datastore_test_primary".to_string(),
"datastore_test_secondary".to_string(),
store,
logger,
)
}

#[tokio::test]
async fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(DynStoreWrapper(InMemoryStore::new()));
Expand DownExpand Up@@ -346,4 +392,54 @@ mod tests {
new_iou_object.data[0] += 1;
assert_eq!(Ok(true), data_store.insert_or_update(new_iou_object).await);
}

#[tokio::test]
async fn insert_or_update_does_not_mutate_memory_if_persist_fails() {
let existing_id = TestObjectId { id: [42u8; 4] };
let existing_object = TestObject { id: existing_id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![existing_object]);

let updated_object = TestObject { id: existing_id, data: [24u8; 3] };
assert_eq!(
Err(Error::PersistenceFailed),
data_store.insert_or_update(updated_object).await
);
assert_eq!(Some(existing_object), data_store.get(&existing_id));

let new_id = TestObjectId { id: [55u8; 4] };
let new_object = TestObject { id: new_id, data: [34u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.insert_or_update(new_object).await);
assert!(data_store.get(&new_id).is_none());
}

#[tokio::test]
async fn insert_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![]);

assert_eq!(Err(Error::PersistenceFailed), data_store.insert(object).await);
assert!(data_store.get(&id).is_none());
}

#[tokio::test]
async fn update_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

let update = TestObjectUpdate { id, data: [24u8; 3] };
assert_eq!(Err(Error::PersistenceFailed), data_store.update(update).await);
assert_eq!(Some(object), data_store.get(&id));
}

#[tokio::test]
async fn remove_does_not_mutate_memory_if_persist_fails() {
let id = TestObjectId { id: [42u8; 4] };
let object = TestObject { id, data: [23u8; 3] };
let data_store = new_failing_data_store(vec![object]);

assert_eq!(Err(Error::PersistenceFailed), data_store.remove(&id).await);
assert_eq!(Some(object), data_store.get(&id));
}
}
Loading