Bug 1972112 - Add run_maintenance for autofill / logins

Adding `run_maintenance` for autofill/logins.

I didn't split this up or add metrics like we did for places because I
highly doubt we're going to have performances issues with these
functions. The places metrics are fine and needs to do more work then
these components (the prune step and places DBs are larger in general).

Author: bendk

components/autofill/src/autofill.udl

@@ -127,6 +127,13 @@ interface Store {
     [Throws=AutofillApiError, Self=ByArc]
     void scrub_encrypted_data();
 
+    /// Run maintenance on the DB
+    ///
+    /// This is intended to be run during idle time and will take steps / to clean up / shrink the
+    /// database.
+    [Throws=AutofillApiError]
+    void run_maintenance();
+
     [Self=ByArc]
     void register_with_sync_manager();
 };

components/autofill/src/db/store.rs

@@ -11,7 +11,7 @@ use rusqlite::{
     types::{FromSql, ToSql},
     Connection,
 };
-use sql_support::{self, ConnExt};
+use sql_support::{self, run_maintenance, ConnExt};
 use std::path::Path;
 use std::sync::{Arc, Mutex, Weak};
 use sync15::engine::{SyncEngine, SyncEngineId};
@@ -162,6 +162,13 @@ impl Store {
         Ok(())
     }
 
+    #[handle_error(Error)]
+    pub fn run_maintenance(&self) -> ApiResult<()> {
+        let conn = self.db.lock().unwrap();
+        run_maintenance(&conn)?;
+        Ok(())
+    }
+
     // This allows the embedding app to say "make this instance available to
     // the sync manager". The implementation is more like "offer to sync mgr"
     // (thereby avoiding us needing to link with the sync manager) but

components/logins/src/logins.udl

@@ -244,6 +244,13 @@ interface LoginStore {
     [Throws=LoginsApiError]
     string? get_checkpoint();
 
+    /// Run maintenance on the DB
+    ///
+    /// This is intended to be run during idle time and will take steps / to clean up / shrink the
+    /// database.
+    [Throws=LoginsApiError]
+    void run_maintenance();
+
     [Self=ByArc]
     void register_with_sync_manager();
 };

components/logins/src/store.rs

@@ -8,6 +8,7 @@ use crate::login::{BulkResultEntry, EncryptedLogin, Login, LoginEntry, LoginEntr
 use crate::schema;
 use crate::LoginsSyncEngine;
 use parking_lot::Mutex;
+use sql_support::run_maintenance;
 use std::path::Path;
 use std::sync::{Arc, Weak};
 use sync15::{
@@ -276,6 +277,13 @@ impl LoginStore {
         self.db.lock().get_meta(schema::CHECKPOINT_KEY)
     }
 
+    #[handle_error(Error)]
+    pub fn run_maintenance(&self) -> ApiResult<()> {
+        let conn = self.db.lock();
+        run_maintenance(&conn)?;
+        Ok(())
+    }
+
     // This allows the embedding app to say "make this instance available to
     // the sync manager". The implementation is more like "offer to sync mgr"
     // (thereby avoiding us needing to link with the sync manager) but

components/support/sql/src/lib.rs

@@ -20,13 +20,15 @@ pub mod debug_tools {
 
 mod each_chunk;
 mod lazy;
+mod maintenance;
 mod maybe_cached;
 pub mod open_database;
 mod repeat;
 
 pub use conn_ext::*;
 pub use each_chunk::*;
 pub use lazy::*;
+pub use maintenance::run_maintenance;
 pub use maybe_cached::*;
 pub use repeat::*;
 

components/support/sql/src/maintenance.rs

@@ -0,0 +1,34 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+use crate::ConnExt;
+use rusqlite::{Connection, Result};
+
+/// Run maintenance on the DB
+///
+/// `run_maintenance()` is intended to be run during idle time and will take steps to clean up /
+/// shrink the database.
+pub fn run_maintenance(conn: &Connection) -> Result<()> {
+    vacuum(conn)?;
+    conn.execute_one("PRAGMA optimize")?;
+    conn.execute_one("PRAGMA wal_checkpoint(PASSIVE)")?;
+    Ok(())
+}
+
+/// Run vacuum on the DB
+fn vacuum(conn: &Connection) -> Result<()> {
+    let auto_vacuum_setting: u32 = conn.query_one("PRAGMA auto_vacuum")?;
+    if auto_vacuum_setting == 2 {
+        // Ideally, we run an incremental vacuum to delete 2 pages
+        conn.execute_one("PRAGMA incremental_vacuum(2)")?;
+    } else {
+        // If auto_vacuum=incremental isn't set, configure it and run a full vacuum.
+        error_support::warn!(
+            "run_maintenance_vacuum: Need to run a full vacuum to set auto_vacuum=incremental"
+        );
+        conn.execute_one("PRAGMA auto_vacuum=incremental")?;
+        conn.execute_one("VACUUM")?;
+    }
+    Ok(())
+}