Change defaults

Author: SpecialAro

.env.example

@@ -29,3 +29,12 @@ PORT=3333
 
 # These have defaults hard-coded, but are being overridden
 CACHE_VIEWS=false
+
+# SQLite durability/concurrency notes:
+# - WAL improves concurrent reads/writes for the default SQLite deployment.
+# - FULL is the safer default for production durability.
+# - NORMAL reduces fsync pressure, but may lose the last committed transactions
+#   on sudden power loss or kernel crash.
+DB_SQLITE_JOURNAL_MODE=WAL
+DB_SQLITE_SYNCHRONOUS=FULL
+DB_BUSY_TIMEOUT=5000

README.md

@@ -117,6 +117,9 @@ Ferdium-server's configuration is saved inside an `.env` file. Besides AdonisJS'
 - `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, Ferdium-server can:
   - Show the full Franz recipe library instead of only custom recipes
   - Import Franz accounts
+- `DB_SQLITE_JOURNAL_MODE` (`DELETE`, `TRUNCATE`, `PERSIST`, `MEMORY`, `WAL`, or `OFF`, default: `WAL`): SQLite journal mode. `WAL` improves concurrency for the default single-file deployment.
+- `DB_SQLITE_SYNCHRONOUS` (`OFF`, `NORMAL`, `FULL`, or `EXTRA`, default: `FULL`): SQLite synchronous mode. `FULL` is the safer default for production durability. `NORMAL` reduces write latency but can lose the last committed transactions on sudden power loss.
+- `DB_BUSY_TIMEOUT` (milliseconds, default: `5000`): How long SQLite should wait for a locked database before failing a query.
 </details>
 <details>
 <summary>Importing your Franz/Ferdi account</summary>

config/database.ts

@@ -19,7 +19,33 @@ type SqlitePoolCallback = (
   connection: SqliteConnection,
 ) => void;
 
+const SQLITE_JOURNAL_MODE_VALUES = new Set([
+  'DELETE',
+  'TRUNCATE',
+  'PERSIST',
+  'MEMORY',
+  'WAL',
+  'OFF',
+]);
+const SQLITE_SYNCHRONOUS_VALUES = new Set(['OFF', 'NORMAL', 'FULL', 'EXTRA']);
 const SQLITE_BUSY_TIMEOUT_DEFAULT = 5000;
+const SQLITE_JOURNAL_MODE_DEFAULT = 'WAL';
+const SQLITE_SYNCHRONOUS_DEFAULT = 'FULL';
+
+function getSqlitePragmaValue(
+  envName: string,
+  defaultValue: string,
+  allowedValues: Set<string>,
+) {
+  const configuredValue = Env.get(envName, defaultValue).trim().toUpperCase();
+
+  if (!allowedValues.has(configuredValue)) {
+    return defaultValue;
+  }
+
+  return configuredValue;
+}
+
 const sqliteBusyTimeoutEnv = Env.get(
   'DB_BUSY_TIMEOUT',
   SQLITE_BUSY_TIMEOUT_DEFAULT.toString(),
@@ -29,6 +55,16 @@ const sqliteBusyTimeout =
   Number.isFinite(sqliteBusyTimeoutParsed) && sqliteBusyTimeoutParsed > 0
     ? sqliteBusyTimeoutParsed
     : SQLITE_BUSY_TIMEOUT_DEFAULT;
+const sqliteJournalMode = getSqlitePragmaValue(
+  'DB_SQLITE_JOURNAL_MODE',
+  SQLITE_JOURNAL_MODE_DEFAULT,
+  SQLITE_JOURNAL_MODE_VALUES,
+);
+const sqliteSynchronous = getSqlitePragmaValue(
+  'DB_SQLITE_SYNCHRONOUS',
+  SQLITE_SYNCHRONOUS_DEFAULT,
+  SQLITE_SYNCHRONOUS_VALUES,
+);
 
 function configureSqliteConnection(
   conn: SqliteConnection,
@@ -40,27 +76,30 @@ function configureSqliteConnection(
       return;
     }
 
-    conn.run('PRAGMA journal_mode = WAL', (journalModeError: Error | null) => {
-      if (journalModeError) {
-        cb(journalModeError, conn);
-        return;
-      }
-
-      conn.run(
-        'PRAGMA synchronous = NORMAL',
-        (synchronousError: Error | null) => {
-          if (synchronousError) {
-            cb(synchronousError, conn);
-            return;
-          }
-
-          conn.run(
-            `PRAGMA busy_timeout = ${sqliteBusyTimeout}`,
-            (busyTimeoutError: Error | null) => cb(busyTimeoutError, conn),
-          );
-        },
-      );
-    });
+    conn.run(
+      `PRAGMA journal_mode = ${sqliteJournalMode}`,
+      (journalModeError: Error | null) => {
+        if (journalModeError) {
+          cb(journalModeError, conn);
+          return;
+        }
+
+        conn.run(
+          `PRAGMA synchronous = ${sqliteSynchronous}`,
+          (synchronousError: Error | null) => {
+            if (synchronousError) {
+              cb(synchronousError, conn);
+              return;
+            }
+
+            conn.run(
+              `PRAGMA busy_timeout = ${sqliteBusyTimeout}`,
+              (busyTimeoutError: Error | null) => cb(busyTimeoutError, conn),
+            );
+          },
+        );
+      },
+    );
   });
 }
 

data/.gitignore

@@ -1 +1,4 @@
 ferdium.sqlite
+ferdium.sqlite-shm
+ferdium.sqlite-wal
+ferdium-*.log