refactor: Rename EventCacheStoreLock::lock to lock_unchecked.

We are about to introduce a lock which checks if it's been poisoned. To
not break the current API semantics, `lock` is renamed `lock_unchecked`
if poisoning isn't check/doesn't raise an error.

Author: Hywan

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

@@ -80,7 +80,10 @@ impl EventCacheStoreLock {
     }
 
     /// Acquire a spin lock (see [`CrossProcessStoreLock::spin_lock`]).
-    pub async fn lock(&self) -> Result<EventCacheStoreLockGuard<'_>, LockStoreError> {
+    ///
+    /// It doesn't check whether the lock has been poisoned or not.
+    /// A lock has been poisoned if it's been acquired from another holder.
+    pub async fn lock_unchecked(&self) -> Result<EventCacheStoreLockGuard<'_>, LockStoreError> {
         let cross_process_lock_guard = self.cross_process_lock.spin_lock(None).await?;
 
         Ok(EventCacheStoreLockGuard { cross_process_lock_guard, store: self.store.deref() })

crates/matrix-sdk/src/media.rs

@@ -393,8 +393,13 @@ impl Media {
     ) -> Result<Vec<u8>> {
         // Read from the cache.
         if use_cache {
-            if let Some(content) =
-                self.client.event_cache_store().lock().await?.get_media_content(request).await?
+            if let Some(content) = self
+                .client
+                .event_cache_store()
+                .lock_unchecked()
+                .await?
+                .get_media_content(request)
+                .await?
             {
                 return Ok(content);
             }
@@ -497,7 +502,7 @@ impl Media {
         if use_cache {
             self.client
                 .event_cache_store()
-                .lock()
+                .lock_unchecked()
                 .await?
                 .add_media_content(request, content.clone())
                 .await?;
@@ -512,7 +517,13 @@ impl Media {
     ///
     /// * `request` - The `MediaRequest` of the content.
     pub async fn remove_media_content(&self, request: &MediaRequestParameters) -> Result<()> {
-        Ok(self.client.event_cache_store().lock().await?.remove_media_content(request).await?)
+        Ok(self
+            .client
+            .event_cache_store()
+            .lock_unchecked()
+            .await?
+            .remove_media_content(request)
+            .await?)
     }
 
     /// Delete all the media content corresponding to the given
@@ -522,7 +533,13 @@ impl Media {
     ///
     /// * `uri` - The `MxcUri` of the files.
     pub async fn remove_media_content_for_uri(&self, uri: &MxcUri) -> Result<()> {
-        Ok(self.client.event_cache_store().lock().await?.remove_media_content_for_uri(uri).await?)
+        Ok(self
+            .client
+            .event_cache_store()
+            .lock_unchecked()
+            .await?
+            .remove_media_content_for_uri(uri)
+            .await?)
     }
 
     /// Get the file of the given media event content.

crates/matrix-sdk/src/room/mod.rs

@@ -1988,7 +1988,7 @@ impl Room {
             .await?;
 
         if store_in_cache {
-            let cache_store_lock_guard = self.client.event_cache_store().lock().await?;
+            let cache_store_lock_guard = self.client.event_cache_store().lock_unchecked().await?;
 
             // A failure to cache shouldn't prevent the whole upload from finishing
             // properly, so only log errors during caching.

crates/matrix-sdk/src/send_queue.rs

@@ -706,7 +706,7 @@ impl RoomSendQueue {
                     let data = room
                         .client()
                         .event_cache_store()
-                        .lock()
+                        .lock_unchecked()
                         .await?
                         .get_media_content(&cache_key)
                         .await?

crates/matrix-sdk/src/send_queue/upload.rs

@@ -167,7 +167,7 @@ impl RoomSendQueue {
             let client = room.client();
             let cache_store = client
                 .event_cache_store()
-                .lock()
+                .lock_unchecked()
                 .await
                 .map_err(RoomSendQueueStorageError::LockError)?;
 
@@ -301,7 +301,7 @@ impl QueueStorage {
 
             let cache_store = client
                 .event_cache_store()
-                .lock()
+                .lock_unchecked()
                 .await
                 .map_err(RoomSendQueueStorageError::LockError)?;
 
@@ -530,7 +530,7 @@ impl QueueStorage {
         // At this point, all the requests and dependent requests have been cleaned up.
         // Perform the final step: empty the cache from the local items.
         {
-            let event_cache = client.event_cache_store().lock().await?;
+            let event_cache = client.event_cache_store().lock_unchecked().await?;
             event_cache
                 .remove_media_content_for_uri(&make_local_uri(&handles.upload_file_txn))
                 .await?;