Fixes and restructuring.

rkistner · rkistner · commit 50cc7f2f5a18 · 2024-08-16T12:02:44.000+02:00
diff --git a/.env b/.env
@@ -1,2 +0,0 @@
-NODE_OPTIONS='--experimental-sqlite'
-TS_NODE_TRANSPILE_ONLY=true
diff --git a/packages/sqlite-js-api/test/tsconfig.json b/packages/sqlite-js-api/test/tsconfig.json
@@ -4,5 +4,6 @@
     "lib": ["ES2022", "DOM"],
     "noEmit": true
   },
-  "include": ["src"]
+  "include": ["src"],
+  "references": [{ "path": "../" }]
 }
diff --git a/packages/sqlite-js-api/tsconfig.json b/packages/sqlite-js-api/tsconfig.json
@@ -1,4 +1,13 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": ["src"]
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": ["src"],
+  "references": [
+    { "path": "../sqlite-js-driver" },
+    { "path": "../sqlite-js-driver-tests" },
+    { "path": "../sqlite-js-better-sqlite3" }
+  ]
 }
diff --git a/packages/sqlite-js-better-sqlite3/src/worker-driver.ts b/packages/sqlite-js-better-sqlite3/src/worker-driver.ts
@@ -11,7 +11,7 @@ export function betterSqliteAsyncPool(
   return new ReadWriteConnectionPool({
     async openConnection(options) {
       return new WorkerDriverConnection(
-        import.meta.resolve('./better-sqlite3-worker.js'),
+        new URL(import.meta.resolve('./better-sqlite3-worker.js')),
         path,
         {
           ...poolOptions,
diff --git a/packages/sqlite-js-better-sqlite3/test/tsconfig.json b/packages/sqlite-js-better-sqlite3/test/tsconfig.json
@@ -4,5 +4,6 @@
     "lib": ["ES2022", "DOM"],
     "noEmit": true
   },
-  "include": ["src"]
+  "include": ["src"],
+  "references": [{ "path": "../" }]
 }
diff --git a/packages/sqlite-js-better-sqlite3/tsconfig.json b/packages/sqlite-js-better-sqlite3/tsconfig.json
@@ -1,4 +1,12 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": ["src"]
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": ["src"],
+  "references": [
+    { "path": "../sqlite-js-driver" },
+    { "path": "../sqlite-js-driver-tests" }
+  ]
 }
diff --git a/packages/sqlite-js-driver-tests/package.json b/packages/sqlite-js-driver-tests/package.json
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "build": "tsc -b",
-    "test": "tsc -b ./test/tsconfig.json && mocha"
+    "test": "tsc -b ./test/tsconfig.json && NODE_OPTIONS=\"--experimental-sqlite --disable-warning=ExperimentalWarning\" mocha"
   },
   "keywords": [],
   "author": "",
diff --git a/packages/sqlite-js-driver-tests/test/src/node-sqlite-async.test.ts b/packages/sqlite-js-driver-tests/test/src/node-sqlite-async.test.ts
@@ -2,7 +2,7 @@ import { nodeSqliteAsyncPool } from '@powersync/sqlite-js-driver/node';
 import { describeDriverTests } from '../../lib/index.js';
 
 describeDriverTests(
-  'node:sqlite',
+  'node:sqlite worker',
   { getColumns: false, rawResults: false, allowsMissingParameters: true },
   nodeSqliteAsyncPool
 );
diff --git a/packages/sqlite-js-driver-tests/test/src/node-sqlite-sync.test.ts b/packages/sqlite-js-driver-tests/test/src/node-sqlite-sync.test.ts
@@ -5,7 +5,7 @@ import { test, isMocha } from '../../lib/test.js';
 
 if (isMocha) {
   describeDriverTests(
-    'node:sqlite',
+    'node:sqlite direct',
     { getColumns: false, rawResults: false, allowsMissingParameters: true },
     nodeSqlitePool
   );
diff --git a/packages/sqlite-js-driver-tests/test/tsconfig.json b/packages/sqlite-js-driver-tests/test/tsconfig.json
@@ -1,7 +1,9 @@
 {
   "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
-    "lib": ["ES2022", "DOM"]
+    "lib": ["ES2022", "DOM"],
+    "outDir": "lib"
   },
-  "include": ["src"]
+  "include": ["src"],
+  "references": [{ "path": "../" }]
 }
diff --git a/packages/sqlite-js-driver-tests/tsconfig.json b/packages/sqlite-js-driver-tests/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "lib": ["ES2022", "DOM"]
+    "lib": ["ES2022", "DOM"],
+    "outDir": "lib",
+    "rootDir": "src"
   },
-  "include": ["src"]
+  "include": ["src"],
+  "references": [{ "path": "../sqlite-js-driver" }]
 }
diff --git a/packages/sqlite-js-driver/src/node/node-sqlite-driver.ts b/packages/sqlite-js-driver/src/node/node-sqlite-driver.ts
@@ -31,11 +31,12 @@ import {
   SqliteRun,
   SqliteStep
 } from '../worker_threads/async-commands.js';
+import { loadNodeSqlite } from './node-sqlite.js';
 
 export function nodeSqlitePool(path: string): SqliteDriverConnectionPool {
   return new ReadWriteConnectionPool({
     async openConnection(options) {
-      const sqlite = await import('node:sqlite' as any);
+      const sqlite = await loadNodeSqlite();
       const db = new sqlite.DatabaseSync(path);
       return new NodeSqliteConnection(db, {
         readonly: options?.readonly,
diff --git a/packages/sqlite-js-driver/src/node/node-sqlite-worker-driver.ts b/packages/sqlite-js-driver/src/node/node-sqlite-worker-driver.ts
@@ -6,11 +6,18 @@ export function nodeSqliteAsyncPool(path: string): SqliteDriverConnectionPool {
   return new ReadWriteConnectionPool({
     async openConnection(options) {
       const con = new WorkerDriverConnection(
-        import.meta.resolve('./node-sqlite-worker.js'),
+        new URL(import.meta.resolve('./node-sqlite-worker.js')),
         path,
         {
           readonly: options?.readonly ?? false,
-          name: options?.name
+          name: options?.name,
+          workerOptions: {
+            env: {
+              ...process.env,
+              NODE_OPTIONS:
+                '--experimental-sqlite --disable-warning=ExperimentalWarning'
+            }
+          }
         }
       );
 
diff --git a/packages/sqlite-js-driver/src/node/node-sqlite.ts b/packages/sqlite-js-driver/src/node/node-sqlite.ts
@@ -21,5 +21,30 @@ export declare class StatementSync {
 }
 
 export async function loadNodeSqlite() {
-  return await import('node:sqlite' as any);
+  try {
+    return await import('node:sqlite' as any);
+  } catch (e: any) {
+    if (!isNodeVersionAtLeast('22.5.0')) {
+      throw new Error(`${e.message}\nNode >= 22.5.0 is required`);
+    }
+    if (!process.env.NODE_OPTIONS?.includes('--experimental-sqlite')) {
+      throw new Error(`${e.message}\nUse NODE_OPTIONS=--experimental-sqlite`);
+    }
+    throw e;
+  }
+}
+
+function isNodeVersionAtLeast(requiredVersion: string) {
+  const currentVersion = process.version.slice(1).split('.').map(Number);
+  const [requiredMajor, requiredMinor, requiredPatch] = requiredVersion
+    .split('.')
+    .map(Number);
+
+  return (
+    currentVersion[0] > requiredMajor ||
+    (currentVersion[0] === requiredMajor &&
+      (currentVersion[1] > requiredMinor ||
+        (currentVersion[1] === requiredMinor &&
+          currentVersion[2] >= requiredPatch)))
+  );
 }
diff --git a/packages/sqlite-js-driver/src/worker_threads/worker-driver.ts b/packages/sqlite-js-driver/src/worker_threads/worker-driver.ts
@@ -18,14 +18,14 @@ import {
   InferCommandResult,
   isErrorResponse,
   SqliteCommand,
-  SqliteCommandResponse,
   SqliteCommandType,
   SqliteDriverError
 } from './async-commands.js';
 
 export interface WorkerDriverConnectionOptions {
   name?: string;
   readonly?: boolean;
+  workerOptions?: worker_threads.WorkerOptions;
 }
 
 /**
@@ -42,11 +42,14 @@ export class WorkerDriverConnection implements SqliteDriverConnection {
   buffer: CommandQueueItem[] = [];
 
   constructor(
-    workerPath: string,
+    workerPath: string | URL,
     path: string,
     options?: WorkerDriverConnectionOptions
   ) {
-    const worker = new worker_threads.Worker(workerPath);
+    const worker = new worker_threads.Worker(
+      workerPath,
+      options?.workerOptions
+    );
     this.post('open', { path, options });
     worker.addListener('error', (err) => {
       console.error('worker error', err);
diff --git a/packages/sqlite-js-driver/tsconfig.json b/packages/sqlite-js-driver/tsconfig.json
@@ -1,4 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
   "include": ["src"]
 }
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -6,7 +6,6 @@
     "strict": true,
     "module": "Node16",
     "moduleResolution": "Node16",
-    "outDir": "lib",
     "sourceMap": true,
     "declaration": true
   }

Original file line number	Diff line number	Diff line change
`@@ -1,2 +0,0 @@`
`1`		`-NODE_OPTIONS='--experimental-sqlite'`
`2`		`-TS_NODE_TRANSPILE_ONLY=true`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@`
`4`	`4`	`"lib": ["ES2022", "DOM"],`
`5`	`5`	`"noEmit": true`
`6`	`6`	`},`
`7`		`- "include": ["src"]`
	`7`	`+ "include": ["src"],`
	`8`	`+ "references": [{ "path": "../" }]`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export function betterSqliteAsyncPool(`
`11`	`11`	`return new ReadWriteConnectionPool({`
`12`	`12`	`async openConnection(options) {`
`13`	`13`	`return new WorkerDriverConnection(`
`14`		`- import.meta.resolve('./better-sqlite3-worker.js'),`
	`14`	`+ new URL(import.meta.resolve('./better-sqlite3-worker.js')),`
`15`	`15`	`path,`
`16`	`16`	`{`
`17`	`17`	`...poolOptions,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,12 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../tsconfig.base.json",`
`3`		`- "include": ["src"]`
	`3`	`+ "compilerOptions": {`
	`4`	`+ "outDir": "lib",`
	`5`	`+ "rootDir": "src"`
	`6`	`+ },`
	`7`	`+ "include": ["src"],`
	`8`	`+ "references": [`
	`9`	`+ { "path": "../sqlite-js-driver" },`
	`10`	`+ { "path": "../sqlite-js-driver-tests" }`
	`11`	`+ ]`
`4`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../../tsconfig.base.json",`
`3`	`3`	`"compilerOptions": {`
`4`		`- "lib": ["ES2022", "DOM"]`
	`4`	`+ "lib": ["ES2022", "DOM"],`
	`5`	`+ "outDir": "lib"`
`5`	`6`	`},`
`6`		`- "include": ["src"]`
	`7`	`+ "include": ["src"],`
	`8`	`+ "references": [{ "path": "../" }]`
`7`	`9`	`}`