refactor: replace std lib rwlock with parking_lot rwlock

pace-rs · Feb 26, 2024 · 1660411 · 1660411
1 parent e5d9585
commit 1660411
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 39 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/core/Cargo.toml b/crates/core/Cargo.toml
@@ -33,6 +33,7 @@ itertools = "0.12.1"
 log = "0.4.20"
 merge = "0.1.0"
 miette = { version = "7.1.0", features = ["fancy"] }
+parking_lot = { version = "0.12.1", features = ["deadlock_detection"] }
 rayon = "1.8.1"
 rusqlite = { version = "0.31.0", features = ["bundled", "chrono", "uuid"], optional = true }
 serde = "1.0.197"

diff --git a/crates/core/src/error.rs b/crates/core/src/error.rs
@@ -104,8 +104,6 @@ pub enum ActivityLogErrorKind {
     NoActivityToHold,
     /// Failed to unwrap Arc
     ArcUnwrapFailed,
-    /// RwLock locking failed, it has been poisoned
-    RwLockHasBeenPoisoned,
     /// There are no unfinished activities to end
     NoUnfinishedActivities,
     /// There is no cache to sync

diff --git a/crates/core/src/storage/in_memory.rs b/crates/core/src/storage/in_memory.rs
@@ -1,7 +1,6 @@
-use std::{
-    collections::BTreeMap,
-    sync::{Arc, RwLock},
-};
+use std::{collections::BTreeMap, sync::Arc};
+
+use parking_lot::RwLock;
 
 use merge::Merge;
 use rayon::prelude::{IntoParallelRefIterator, ParallelIterator};
@@ -67,9 +66,7 @@ impl InMemoryActivityStorage {
     ///
     /// Returns an error if the mutex has been poisoned
     pub fn get_activity_log(&self) -> PaceResult<ActivityLog> {
-        let Ok(activity_log) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activity_log = self.log.read();
 
         Ok(activity_log.clone())
     }
@@ -95,9 +92,7 @@ impl SyncStorage for InMemoryActivityStorage {
 
 impl ActivityReadOps for InMemoryActivityStorage {
     fn read_activity(&self, activity_id: ActivityGuid) -> PaceResult<ActivityItem> {
-        let Ok(activities) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activities = self.log.read();
 
         let activity = activities
             .get(&activity_id)
@@ -110,9 +105,7 @@ impl ActivityReadOps for InMemoryActivityStorage {
     }
 
     fn list_activities(&self, filter: ActivityFilter) -> PaceOptResult<FilteredActivities> {
-        let Ok(activity_log) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activity_log = self.log.read();
 
         let filtered = activity_log
             .par_iter()
@@ -153,9 +146,7 @@ impl ActivityReadOps for InMemoryActivityStorage {
 
 impl ActivityWriteOps for InMemoryActivityStorage {
     fn create_activity(&self, activity: Activity) -> PaceResult<ActivityItem> {
-        let Ok(activities) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activities = self.log.read();
 
         let activity_item = ActivityItem::from(activity.clone());
 
@@ -172,9 +163,7 @@ impl ActivityWriteOps for InMemoryActivityStorage {
 
         drop(activities);
 
-        let Ok(mut activities) = self.log.write() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let mut activities = self.log.write();
 
         // We don't check for None here, because we know that the ID was not existing in the list of
         // activities.
@@ -193,9 +182,7 @@ impl ActivityWriteOps for InMemoryActivityStorage {
         updated_activity: Activity,
         _update_opts: UpdateOptions,
     ) -> PaceResult<ActivityItem> {
-        let Ok(activities) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activities = self.log.read();
 
         let original_activity = activities
             .get(&activity_id)
@@ -204,9 +191,7 @@ impl ActivityWriteOps for InMemoryActivityStorage {
 
         drop(activities);
 
-        let Ok(mut activities) = self.log.write() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let mut activities = self.log.write();
 
         let _ = activities.entry(activity_id).and_modify(|activity| {
             activity.merge(updated_activity);
@@ -222,9 +207,7 @@ impl ActivityWriteOps for InMemoryActivityStorage {
         activity_id: ActivityGuid,
         _delete_opts: DeleteOptions,
     ) -> PaceResult<ActivityItem> {
-        let Ok(mut activities) = self.log.write() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let mut activities = self.log.write();
 
         let activity = activities
             .remove(&activity_id)
@@ -242,9 +225,7 @@ impl ActivityStateManagement for InMemoryActivityStorage {
         activity_id: ActivityGuid,
         end_opts: EndOptions,
     ) -> PaceResult<ActivityItem> {
-        let Ok(mut activities) = self.log.write() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let mut activities = self.log.write();
 
         let _ = activities.entry(activity_id).and_modify(|activity| {
             match calculate_duration(activity.begin(), *end_opts.end_time()) {
@@ -281,9 +262,7 @@ impl ActivityStateManagement for InMemoryActivityStorage {
         &self,
         end_opts: EndOptions,
     ) -> PaceOptResult<Vec<ActivityItem>> {
-        let Ok(activities) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activities = self.log.read();
 
         let active_activities = activities
             .par_iter()
@@ -504,9 +483,7 @@ impl ActivityQuerying for InMemoryActivityStorage {
     }
 
     fn list_activities_by_id(&self) -> PaceOptResult<BTreeMap<ActivityGuid, Activity>> {
-        let Ok(activities) = self.log.read() else {
-            return Err(ActivityLogErrorKind::RwLockHasBeenPoisoned.into());
-        };
+        let activities = self.log.read();
 
         let activities_by_id = activities.activities().clone();