Refactor BetterSqliteDriver.

Author: rkistner

packages/sqlite-js-better-sqlite3/package.json

@@ -9,9 +9,7 @@
     "clean": "tsc -b --clean && tsc -b ./test/tsconfig.json --clean && rm -rf lib test/lib"
   },
   "exports": {
-    ".": "./lib/index.js",
-    "./sync-driver": "./lib/sync-driver.js",
-    "./worker-driver": "./lib/worker-driver.js"
+    ".": "./lib/index.js"
   },
   "keywords": [],
   "author": "",

packages/sqlite-js-better-sqlite3/src/driver.ts

@@ -0,0 +1,84 @@
+import {
+  ReserveConnectionOptions,
+  ReservedConnection,
+  SqliteDriverConnectionPool,
+  UpdateListener
+} from '@powersync/sqlite-js-driver';
+import {
+  ConnectionPoolOptions,
+  LazyConnectionPool,
+  ReadWriteConnectionPool
+} from '@powersync/sqlite-js-driver/util';
+import { WorkerDriverConnection } from '@powersync/sqlite-js-driver/worker_threads';
+import type * as bsqlite from 'better-sqlite3';
+
+export interface BetterSqliteDriverOptions
+  extends ConnectionPoolOptions,
+    bsqlite.Options {
+  /**
+   * Specify a custom path to a worker script, to customize the loading process.
+   */
+  workerPath?: string | URL;
+}
+
+export class BetterSqliteDriver implements SqliteDriverConnectionPool {
+  /**
+   * Opens a single in-process connection.
+   *
+   * Uses blocking I/O.
+   */
+  static openInProcess(
+    path: string,
+    options?: bsqlite.Options
+  ): BetterSqliteDriver {
+    const connection = new LazyConnectionPool(async () => {
+      const { BetterSqliteConnection } = await import('./sync-driver.js');
+      return BetterSqliteConnection.open(path, options);
+    });
+    return new BetterSqliteDriver(connection);
+  }
+
+  /**
+   * Opens a connection pool with non-blocking I/O using worker_threads.
+   */
+  static open(
+    path: string,
+    options?: BetterSqliteDriverOptions
+  ): BetterSqliteDriver {
+    const workerPath =
+      options?.workerPath ?? new URL('./worker.js', import.meta.url);
+
+    const connection = new ReadWriteConnectionPool({
+      async openConnection(connectionOptions) {
+        return new WorkerDriverConnection(workerPath, path, {
+          ...options,
+          readonly: (options?.readonly ?? connectionOptions?.readonly) || false
+        });
+      }
+    });
+    return new BetterSqliteDriver(connection);
+  }
+
+  private constructor(private connection: SqliteDriverConnectionPool) {}
+
+  reserveConnection(
+    options?: ReserveConnectionOptions
+  ): Promise<ReservedConnection> {
+    return this.connection.reserveConnection(options);
+  }
+
+  close(): Promise<void> {
+    return this.connection.close();
+  }
+
+  onUpdate(
+    listener: UpdateListener,
+    options?: { tables?: string[]; batchLimit?: number }
+  ): () => void {
+    return this.connection.onUpdate(listener, options);
+  }
+
+  [Symbol.asyncDispose](): Promise<void> {
+    return this.connection[Symbol.asyncDispose]();
+  }
+}

packages/sqlite-js-better-sqlite3/src/index.ts

@@ -1 +1 @@
-export * from './worker-driver.js';
+export * from './driver.js';

packages/sqlite-js-better-sqlite3/src/sync-driver.ts

@@ -34,20 +34,6 @@ import {
   SqliteStep
 } from '@powersync/sqlite-js-driver/worker_threads';
 
-export function betterSqlitePool(
-  path: string,
-  poolOptions?: bsqlite.Options
-): SqliteDriverConnectionPool {
-  return new ReadWriteConnectionPool({
-    async openConnection(options) {
-      return BetterSqliteConnection.open(path, {
-        ...poolOptions,
-        readonly: (poolOptions?.readonly ?? options?.readonly) || false
-      });
-    }
-  });
-}
-
 interface InternalStatement extends SqliteDriverStatement {
   getColumnsSync(): string[];
   stepSync(n?: number, options?: StepOptions): SqliteStepResult;

packages/sqlite-js-better-sqlite3/src/worker-driver.ts

@@ -1,9 +1,8 @@
-import { betterSqliteAsyncPool } from '../../lib/worker-driver.js';
-
 import { describeDriverTests } from '@powersync/sqlite-js-driver-tests';
+import { BetterSqliteDriver } from '../../lib/index.js';
 
 describeDriverTests(
   'better-sqlite3-async-pool',
   { getColumns: true, rawResults: true, allowsMissingParameters: false },
-  betterSqliteAsyncPool
+  (path) => BetterSqliteDriver.open(path)
 );

packages/sqlite-js-better-sqlite3/test/src/better-sqlite3-async.test.ts

@@ -1,8 +1,8 @@
-import { betterSqlitePool } from '../../lib/sync-driver.js';
+import { BetterSqliteDriver } from '../../lib/index.js';
 import { describeDriverTests } from '@powersync/sqlite-js-driver-tests';
 
 describeDriverTests(
   'better-sqlite3',
   { getColumns: true, rawResults: true, allowsMissingParameters: false },
-  betterSqlitePool
+  (path) => BetterSqliteDriver.openInProcess(path)
 );