fix(electron): enable WAL mode for sqlite (#8336)

fix AF-1015
toeverything · Sep 25, 2024 · e839947 · e839947
1 parent e6feb17
commit e839947
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 3 deletions.
diff --git a/packages/frontend/apps/electron/src/helper/db/db-adapter.ts b/packages/frontend/apps/electron/src/helper/db/db-adapter.ts
@@ -141,6 +141,18 @@ export class SQLiteAdapter {
     }
   }
 
+  async checkpoint() {
+    try {
+      if (!this.db) {
+        logger.warn(`${this.path} is not connected`);
+        return;
+      }
+      await this.db.checkpoint();
+    } catch (error) {
+      logger.error('checkpoint', error);
+    }
+  }
+
   async getUpdatesCount(docId?: string) {
     try {
       if (!this.db) {

diff --git a/packages/frontend/apps/electron/src/helper/db/workspace-db-adapter.ts b/packages/frontend/apps/electron/src/helper/db/workspace-db-adapter.ts
@@ -120,6 +120,10 @@ export class WorkspaceSQLiteDB {
     }
     return null;
   };
+
+  async checkpoint() {
+    await this.adapter.checkpoint();
+  }
 }
 
 export async function openWorkspaceDatabase(

diff --git a/packages/frontend/apps/electron/src/helper/dialog/dialog.ts b/packages/frontend/apps/electron/src/helper/dialog/dialog.ts
@@ -77,6 +77,7 @@ export async function saveDBFileAs(
 ): Promise<SaveDBFileResult> {
   try {
     const db = await ensureSQLiteDB('workspace', workspaceId);
+    await db.checkpoint(); // make sure all changes (WAL) are written to db
     const fakedResult = getFakedResult();
 
     const ret =

diff --git a/packages/frontend/apps/electron/src/main/updater/electron-updater.ts b/packages/frontend/apps/electron/src/main/updater/electron-updater.ts
@@ -98,8 +98,6 @@ export const registerUpdater = async () => {
     channel: buildType,
   });
 
-  logger.debug('auto-updater feed config', feedUrl);
-
   autoUpdater.setFeedURL(feedUrl);
 
   // register events for checkForUpdates

diff --git a/packages/frontend/native/index.d.ts b/packages/frontend/native/index.d.ts
@@ -30,6 +30,11 @@ export declare class SqliteConnection {
   get isClose(): boolean
   static validate(path: string): Promise<ValidationResult>
   migrateAddDocId(): Promise<void>
+  /**
+   * Flush the WAL file to the database file.
+   * See https://www.sqlite.org/pragma.html#pragma_wal_checkpoint:~:text=PRAGMA%20schema.wal_checkpoint%3B
+   */
+  checkpoint(): Promise<void>
 }
 
 export interface BlobRow {

diff --git a/packages/frontend/native/src/sqlite/mod.rs b/packages/frontend/native/src/sqlite/mod.rs
@@ -53,7 +53,7 @@ impl SqliteConnection {
     let sqlite_options = SqliteConnectOptions::new()
       .filename(&path)
       .foreign_keys(false)
-      .journal_mode(sqlx::sqlite::SqliteJournalMode::Off);
+      .journal_mode(sqlx::sqlite::SqliteJournalMode::Wal);
     let pool = SqlitePoolOptions::new()
       .max_connections(4)
       .connect_lazy_with(sqlite_options);
@@ -490,6 +490,19 @@ impl SqliteConnection {
     }
   }
 
+  /**
+   * Flush the WAL file to the database file.
+   * See https://www.sqlite.org/pragma.html#pragma_wal_checkpoint:~:text=PRAGMA%20schema.wal_checkpoint%3B
+   */
+  #[napi]
+  pub async fn checkpoint(&self) -> napi::Result<()> {
+    sqlx::query("PRAGMA wal_checkpoint(FULL);")
+      .execute(&self.pool)
+      .await
+      .map_err(anyhow::Error::from)?;
+    Ok(())
+  }
+
   pub async fn migrate_add_doc_id_index(&self) -> napi::Result<()> {
     // ignore errors
     match sqlx::query("CREATE INDEX IF NOT EXISTS idx_doc_id ON updates(doc_id);")