refactor(common): Rename store_locks to cross_process_lock.

Author: Hywan

bindings/matrix-sdk-ffi/src/platform.rs

@@ -274,7 +274,7 @@ enum LogTarget {
     MatrixSdkBaseResponseProcessors,
 
     // SDK common modules.
-    MatrixSdkCommonStoreLocks,
+    MatrixSdkCommonCrossProcessLock,
 
     // SDK modules.
     MatrixSdk,
@@ -302,7 +302,7 @@ impl LogTarget {
             LogTarget::MatrixSdkBaseSlidingSync => "matrix_sdk_base::sliding_sync",
             LogTarget::MatrixSdkBaseStoreAmbiguityMap => "matrix_sdk_base::store::ambiguity_map",
             LogTarget::MatrixSdkBaseResponseProcessors => "matrix_sdk_base::response_processors",
-            LogTarget::MatrixSdkCommonStoreLocks => "matrix_sdk_common::store_locks",
+            LogTarget::MatrixSdkCommonCrossProcessLock => "matrix_sdk_common::cross_process_lock",
             LogTarget::MatrixSdk => "matrix_sdk",
             LogTarget::MatrixSdkClient => "matrix_sdk::client",
             LogTarget::MatrixSdkCrypto => "matrix_sdk_crypto",
@@ -335,18 +335,18 @@ const DEFAULT_TARGET_LOG_LEVELS: &[(LogTarget, LogLevel)] = &[
     (LogTarget::MatrixSdkEventCache, LogLevel::Info),
     (LogTarget::MatrixSdkBaseEventCache, LogLevel::Info),
     (LogTarget::MatrixSdkEventCacheStore, LogLevel::Info),
-    (LogTarget::MatrixSdkCommonStoreLocks, LogLevel::Warn),
+    (LogTarget::MatrixSdkCommonCrossProcessLock, LogLevel::Warn),
     (LogTarget::MatrixSdkBaseStoreAmbiguityMap, LogLevel::Warn),
     (LogTarget::MatrixSdkUiNotificationClient, LogLevel::Info),
     (LogTarget::MatrixSdkBaseResponseProcessors, LogLevel::Debug),
 ];
 
 const IMMUTABLE_LOG_TARGETS: &[LogTarget] = &[
-    LogTarget::Hyper,                          // Too verbose
-    LogTarget::MatrixSdk,                      // Too generic
-    LogTarget::MatrixSdkFfi,                   // Too verbose
-    LogTarget::MatrixSdkCommonStoreLocks,      // Too verbose
-    LogTarget::MatrixSdkBaseStoreAmbiguityMap, // Too verbose
+    LogTarget::Hyper,                           // Too verbose
+    LogTarget::MatrixSdk,                       // Too generic
+    LogTarget::MatrixSdkFfi,                    // Too verbose
+    LogTarget::MatrixSdkCommonCrossProcessLock, // Too verbose
+    LogTarget::MatrixSdkBaseStoreAmbiguityMap,  // Too verbose
 ];
 
 /// A log pack can be used to set the trace log level for a group of multiple
@@ -723,7 +723,7 @@ mod tests {
             matrix_sdk::event_cache=info,
             matrix_sdk_base::event_cache=info,
             matrix_sdk_sqlite::event_cache_store=info,
-            matrix_sdk_common::store_locks=warn,
+            matrix_sdk_common::cross_process_lock=warn,
             matrix_sdk_base::store::ambiguity_map=warn,
             matrix_sdk_ui::notification_client=info,
             matrix_sdk_base::response_processors=debug,
@@ -767,7 +767,7 @@ mod tests {
             matrix_sdk::event_cache=trace,
             matrix_sdk_base::event_cache=trace,
             matrix_sdk_sqlite::event_cache_store=trace,
-            matrix_sdk_common::store_locks=warn,
+            matrix_sdk_common::cross_process_lock=warn,
             matrix_sdk_base::store::ambiguity_map=warn,
             matrix_sdk_ui::notification_client=trace,
             matrix_sdk_base::response_processors=trace,
@@ -812,7 +812,7 @@ mod tests {
             matrix_sdk::event_cache=trace,
             matrix_sdk_base::event_cache=trace,
             matrix_sdk_sqlite::event_cache_store=trace,
-            matrix_sdk_common::store_locks=warn,
+            matrix_sdk_common::cross_process_lock=warn,
             matrix_sdk_base::store::ambiguity_map=warn,
             matrix_sdk_ui::notification_client=info,
             matrix_sdk_base::response_processors=debug,

crates/matrix-sdk-base/src/error.rs

@@ -15,7 +15,7 @@
 
 //! Error conditions.
 
-use matrix_sdk_common::store_locks::LockStoreError;
+use matrix_sdk_common::cross_process_lock::LockStoreError;
 #[cfg(feature = "e2e-encryption")]
 use matrix_sdk_crypto::{CryptoStoreError, MegolmError, OlmError};
 use thiserror::Error;

crates/matrix-sdk-base/src/event_cache/store/memory_store.rs

@@ -19,11 +19,11 @@ use std::{
 
 use async_trait::async_trait;
 use matrix_sdk_common::{
+    cross_process_lock::memory_store_helper::try_take_leased_lock,
     linked_chunk::{
         ChunkIdentifier, ChunkIdentifierGenerator, ChunkMetadata, LinkedChunkId, Position,
         RawChunk, Update, relational::RelationalLinkedChunk,
     },
-    store_locks::memory_store_helper::try_take_leased_lock,
 };
 use ruma::{EventId, OwnedEventId, RoomId, events::relation::RelationType, time::Instant};
 use tracing::error;

crates/matrix-sdk-base/src/event_cache/store/mod.rs

@@ -27,7 +27,7 @@ pub mod integration_tests;
 mod memory_store;
 mod traits;
 
-use matrix_sdk_common::store_locks::{
+use matrix_sdk_common::cross_process_lock::{
     CrossProcessLock, CrossProcessLockGuard, LockStoreError, TryLock,
 };
 pub use matrix_sdk_store_encryption::Error as StoreEncryptionError;

crates/matrix-sdk-base/src/media/store/memory_store.rs

@@ -20,7 +20,7 @@ use std::{
 
 use async_trait::async_trait;
 use matrix_sdk_common::{
-    ring_buffer::RingBuffer, store_locks::memory_store_helper::try_take_leased_lock,
+    cross_process_lock::memory_store_helper::try_take_leased_lock, ring_buffer::RingBuffer,
 };
 use ruma::{
     MxcUri, OwnedMxcUri,

crates/matrix-sdk-base/src/media/store/mod.rs

@@ -31,7 +31,7 @@ pub mod integration_tests;
 use std::fmt;
 use std::{ops::Deref, sync::Arc};
 
-use matrix_sdk_common::store_locks::{
+use matrix_sdk_common::cross_process_lock::{
     CrossProcessLock, CrossProcessLockGuard, LockStoreError, TryLock,
 };
 use matrix_sdk_store_encryption::Error as StoreEncryptionError;

crates/matrix-sdk-base/src/store/mod.rs

@@ -791,7 +791,7 @@ impl StoreConfig {
     /// Create a new default `StoreConfig`.
     ///
     /// To learn more about `cross_process_store_locks_holder_name`, please read
-    /// [`CrossProcessLock::new`](matrix_sdk_common::store_locks::CrossProcessLock::new).
+    /// [`CrossProcessLock::new`](matrix_sdk_common::cross_process_lock::CrossProcessLock::new).
     #[must_use]
     pub fn new(cross_process_store_locks_holder_name: String) -> Self {
         Self {

crates/matrix-sdk-common/src/store_locks.rs renamed to crates/matrix-sdk-common/src/cross_process_lock.rs

@@ -24,6 +24,7 @@ use futures_core::Future;
 #[doc(no_inline)]
 pub use ruma;
 
+pub mod cross_process_lock;
 pub mod debug;
 pub mod deserialized_responses;
 pub mod executor;
@@ -33,7 +34,6 @@ pub mod locks;
 pub mod ring_buffer;
 pub mod serde_helpers;
 pub mod sleep;
-pub mod store_locks;
 pub mod stream;
 pub mod timeout;
 pub mod tracing_timer;
@@ -45,8 +45,8 @@ pub mod ttl_cache;
 #[cfg(all(target_family = "wasm", not(tarpaulin_include)))]
 pub mod js_tracing;
 
+pub use cross_process_lock::LEASE_DURATION_MS;
 use ruma::{RoomVersionId, room_version_rules::RoomVersionRules};
-pub use store_locks::LEASE_DURATION_MS;
 
 /// Alias for `Send` on non-wasm, empty trait (implemented by everything) on
 /// wasm.

crates/matrix-sdk-common/src/lib.rs

@@ -2,7 +2,7 @@ use std::{future, ops::Deref, sync::Arc};
 
 use futures_core::Stream;
 use futures_util::StreamExt;
-use matrix_sdk_common::store_locks::CrossProcessLock;
+use matrix_sdk_common::cross_process_lock::CrossProcessLock;
 use ruma::{DeviceId, OwnedDeviceId, OwnedUserId, UserId};
 use tokio::sync::{broadcast, Mutex};
 use tokio_stream::wrappers::{errors::BroadcastStreamRecvError, BroadcastStream};