refactor(sqlite): prefer bun sqlite on bun and clarify op export limits

Author: miccy

packages/nodejs/src/Sqlite.ts

@@ -61,43 +61,58 @@ interface BunSqliteModule {
 const isReaderSql = (sql: string): boolean =>
   /^\s*(select|pragma|with|explain|values)\b/i.test(sql);
 
+const createBetterDb = (filename: string): DbLike => {
+  const BetterSQLite = require("better-sqlite3") as BetterSqliteConstructor;
+  const db = new BetterSQLite(filename);
+
+  return {
+    prepare: (sql) => {
+      const statement = db.prepare(sql);
+      return {
+        reader: statement.reader,
+        all: (...parameters) => statement.all(parameters),
+        run: (...parameters) => statement.run(parameters),
+      };
+    },
+    serialize: () => db.serialize(),
+    close: () => db.close(),
+  };
+};
+
+const createBunDb = (filename: string): DbLike => {
+  const { Database } = require("bun:sqlite") as BunSqliteModule;
+  const db = new Database(filename);
+
+  return {
+    prepare: (sql) => {
+      const statement = db.prepare(sql);
+      return {
+        reader: isReaderSql(sql),
+        all: (...parameters) => statement.all(...parameters),
+        run: (...parameters) => statement.run(...parameters),
+      };
+    },
+    serialize: () => db.serialize(),
+    close: () => db.close(),
+  };
+};
+
 const createDb = (filename: string): DbLike => {
-  try {
-    const BetterSQLite = require("better-sqlite3") as BetterSqliteConstructor;
-    const db = new BetterSQLite(filename);
-
-    return {
-      prepare: (sql) => {
-        const statement = db.prepare(sql);
-        return {
-          reader: statement.reader,
-          all: (...parameters) => statement.all(parameters),
-          run: (...parameters) => statement.run(parameters),
-        };
-      },
-      serialize: () => db.serialize(),
-      close: () => db.close(),
-    };
-  } catch (error) {
-    const hasBunRuntime = (globalThis as Record<string, unknown>).Bun != null;
-    if (!hasBunRuntime) throw error;
-
-    const { Database } = require("bun:sqlite") as BunSqliteModule;
-    const db = new Database(filename);
-
-    return {
-      prepare: (sql) => {
-        const statement = db.prepare(sql);
-        return {
-          reader: isReaderSql(sql),
-          all: (...parameters) => statement.all(...parameters),
-          run: (...parameters) => statement.run(...parameters),
-        };
-      },
-      serialize: () => db.serialize(),
-      close: () => db.close(),
-    };
+  const hasBunRuntime = (globalThis as Record<string, unknown>).Bun != null;
+
+  if (hasBunRuntime) {
+    try {
+      return createBunDb(filename);
+    } catch (bunError) {
+      try {
+        return createBetterDb(filename);
+      } catch {
+        throw bunError;
+      }
+    }
   }
+
+  return createBetterDb(filename);
 };
 
 export const createBetterSqliteDriver: CreateSqliteDriver =

packages/react-native/src/exports/bare-op-sqlite.ts

@@ -4,6 +4,8 @@
  *
  * Use this with bare React Native projects (not Expo) that use
  * `@op-engineering/op-sqlite`.
+ *
+ * Note: this flavor does not support Evolu `export()`.
  */
 
 import type { ReloadApp } from "@evolu/common";

packages/react-native/src/exports/expo-op-sqlite.ts

@@ -4,6 +4,9 @@
  *
  * Use this with Expo projects that use `@op-engineering/op-sqlite` for better
  * performance.
+ *
+ * Note: this flavor does not support Evolu `export()`. Use `expo-sqlite`
+ * flavor when database export bytes are required.
  */
 
 import { createExpoDeps } from "../createExpoDeps.js";

packages/react-native/src/sqlite-drivers/createOpSqliteDriver.ts

@@ -22,6 +22,13 @@ export const createOpSqliteDriver: CreateSqliteDriver =
           },
     );
     let isDisposed = false;
+    const getDbPath = (): string | null => {
+      try {
+        return db.getDbPath();
+      } catch {
+        return null;
+      }
+    };
 
     const cache = createPreparedStatementsCache<PreparedStatement>(
       (sql) => db.prepareStatement(sql),
@@ -44,10 +51,14 @@ export const createOpSqliteDriver: CreateSqliteDriver =
         return { rows: rows as Array<SqliteRow>, changes: rowsAffected };
       },
 
-      // FIXME: op-sqlite does not expose binary, but a path to the database file
-      // another react native dependency would be needed to implement this
       export: () => {
-        throw new Error("TODO: Not implemented yet");
+        const dbPath = getDbPath();
+        const pathSuffix = dbPath ? ` Database path: ${dbPath}.` : "";
+        throw new Error(
+          "Evolu export() is not supported with @op-engineering/op-sqlite because the driver does not expose database bytes." +
+            pathSuffix +
+            " Use @evolu/react-native/expo-sqlite when export is required.",
+        );
       },
 
       [Symbol.dispose]: () => {