refactor(sqlite): Add trait method for the VACUUM operation

Signed-off-by: Kévin Commaille <[email protected]>

Author: zecakeh

crates/matrix-sdk-sqlite/src/event_cache_store.rs

@@ -36,8 +36,6 @@ use matrix_sdk_store_encryption::StoreCipher;
 use ruma::{time::SystemTime, MilliSecondsSinceUnixEpoch, MxcUri, RoomId};
 use rusqlite::{params_from_iter, OptionalExtension, Transaction, TransactionBehavior};
 use tokio::fs;
-#[cfg(not(test))]
-use tracing::warn;
 use tracing::{debug, trace};
 
 use crate::{
@@ -959,19 +957,10 @@ impl EventCacheStoreMedia for SqliteEventCacheStore {
             })
             .await?;
 
-        // If we removed media, use the VACUUM command to defragment the
-        // database and free space on the filesystem.
+        // If we removed media, defragment the database and free space on the
+        // filesystem.
         if removed {
-            if let Err(error) = conn.execute("VACUUM", ()).await {
-                // Since this is an optimisation step, do not propagate the error
-                // but log it.
-                #[cfg(not(test))]
-                warn!("Failed to vacuum database: {error}");
-
-                // We want to know if there is an error with this step during tests.
-                #[cfg(test)]
-                return Err(error.into());
-            }
+            conn.vacuum().await?;
         }
 
         Ok(())

crates/matrix-sdk-sqlite/src/state_store.rs

@@ -336,7 +336,7 @@ impl SqliteStateStore {
             // Defragment the DB and optimize its size on the filesystem.
             // This should have been run in the migration for version 7, to reduce the size
             // of the DB as we removed the media cache.
-            conn.execute_batch("VACUUM").await?;
+            conn.vacuum().await?;
             conn.set_kv("version", vec![12]).await?;
         }
 

crates/matrix-sdk-sqlite/src/utils.rs

@@ -22,6 +22,8 @@ use matrix_sdk_store_encryption::StoreCipher;
 use ruma::time::SystemTime;
 use rusqlite::{limits::Limit, OptionalExtension, Params, Row, Statement, Transaction};
 use serde::{de::DeserializeOwned, Serialize};
+#[cfg(not(test))]
+use tracing::warn;
 
 use crate::{
     error::{Error, Result},
@@ -136,6 +138,24 @@ pub(crate) trait SqliteAsyncConnExt {
         self.execute_batch("PRAGMA journal_size_limit = 10000000;").await.map_err(Error::from)?;
         Ok(())
     }
+
+    /// Defragment the database and free space on the filesystem.
+    ///
+    /// Only returns an error in tests, otherwise the error is only logged.
+    async fn vacuum(&self) -> Result<()> {
+        if let Err(error) = self.execute_batch("VACUUM").await {
+            // Since this is an optimisation step, do not propagate the error
+            // but log it.
+            #[cfg(not(test))]
+            warn!("Failed to vacuum database: {error}");
+
+            // We want to know if there is an error with this step during tests.
+            #[cfg(test)]
+            return Err(error.into());
+        }
+
+        Ok(())
+    }
 }
 
 #[async_trait]