feat: update to SQLite 3.53.1

Author: birtles

.changeset/hot-sloths-agree.md

@@ -0,0 +1,8 @@
+---
+"@birchill/nice-sqlite-wasm": minor
+---
+
+Update to SQLite 3.53.1
+
+BREAKING CHANGE: Rather than overriding `locateFile` to load the WASM file, use
+the `emscriptenLocateFile` option instead.

README.md

@@ -5,9 +5,8 @@ It's "nice" because:
 
 - It removes the "opfs" VFS and worker parts of the JS bindings making for a
   smaller bundle size.
-- It allows overriding the `locateFile` function so that you can provide a
-  custom path for the WASM module (e.g. in order to support cache-busting
-  filenames) or even a `Response` object (e.g. so you can abort the download).
+- It allows returning a `Response` object (e.g. so you can abort the download)
+  from `emscriptenLocateFile`.
 - It fixes some warnings that otherwise might occur at build or run-time
   (e.g. the COOP/COEP header warning which is only relevant to the "opfs" VFS
   and a warning about dependencies based on expressions).
@@ -85,8 +84,8 @@ export default defineConfig((env) => {
 Then in your worker code:
 
 ```js
-import wasmUrl from '@birchill/nice-sqlite-wasm/sqlite3.wasm?url';
-import sqlite3InitModule from '@birchill/nice-sqlite-wasm';
+import wasmUrl from "@birchill/nice-sqlite-wasm/sqlite3.wasm?url";
+import sqlite3InitModule from "@birchill/nice-sqlite-wasm";
 ```
 
 Then when you initialize SQLite:
@@ -96,8 +95,8 @@ const sqlite = await sqlite3InitModule({
   // Override SQLite's locateFile implementation which wants to resolve
   // the SQLite WASM binary relative to the source directory instead of
   // the asset name assigned by rspack.
-  locateFile: (file) => {
-    if (file === 'sqlite3.wasm') {
+  emscriptenLocateFile: (file) => {
+    if (file === "sqlite3.wasm") {
       // Since we strip the query string in our `assetModuleFilename`
       // option in rspack.config.js we don't need to worry about dropping
       // it here.
@@ -109,7 +108,7 @@ const sqlite = await sqlite3InitModule({
       //
       // instead.
       return fetch(wasmUrl, {
-        credentials: 'same-origin',
+        credentials: "same-origin",
         // If you want to make the fetch abortable...
         signal: abortController.signal,
       });
@@ -120,8 +119,8 @@ const sqlite = await sqlite3InitModule({
 });
 ```
 
-You can also just return `wasmUrl` from `locateFile` if don't need to control
-the fetch yourself.
+You can also just return `wasmUrl` from `emscriptenLocateFile` if don't need to
+control the fetch yourself.
 
 ### vite
 
@@ -132,10 +131,10 @@ module docs](https://github.com/sqlite/sqlite-wasm/#usage-with-vite):
 
 ```js
 // vitest.config.js
-import { defineConfig } from 'vite';
+import { defineConfig } from "vite";
 
 export default defineConfig({
-  optimizeDeps: { exclude: ['@birchill/nice-sqlite-wasm'] },
+  optimizeDeps: { exclude: ["@birchill/nice-sqlite-wasm"] },
 });
 ```
 
@@ -194,11 +193,10 @@ Then update the table below.
 
 #### Current patches
 
-| Patch name                               | Purpose                                                                                                                                     |
-| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `0001-locatefile-nullish-coalesce.patch` | Allow a user-provided `locateFile` function to be used (rather than clobbered).                                                             |
-| `0002-hardcode-locatefile-path.patch`    | Hardcodes the path used in the default `locateFile` implementation so that bundlers don't complain about dependencies based on expressions. |
-| `0003-locatefile-with-response.patch`    | Allows a user-provided `locateFile` function to return a `Response` or a `Promise<Response>`.                                               |
+| Patch name                            | Purpose                                                                                                                                     |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| `0001-hardcode-locatefile-path.patch` | Hardcodes the path used in the default `locateFile` implementation so that bundlers don't complain about dependencies based on expressions. |
+| `0002-locatefile-with-response.patch` | Allows a user-provided `emscriptenLocateFile` function to return a `Response` or a `Promise<Response>`.                                     |
 
 ### Building the WASM module
 

…ches/0002-hardcode-locatefile-path.patch …ches/0001-hardcode-locatefile-path.patchpatches/0002-hardcode-locatefile-path.patch renamed to patches/0001-hardcode-locatefile-path.patch patches/0002-hardcode-locatefile-path.patch renamed to patches/0001-hardcode-locatefile-path.patch

@@ -1,10 +1,10 @@
 diff --git a/ext/wasm/api/pre-js.c-pp.js b/ext/wasm/api/pre-js.c-pp.js
-index b2c3147..da399df 100644
+index fbb48f9..da314b9 100644
 --- a/ext/wasm/api/pre-js.c-pp.js
 +++ b/ext/wasm/api/pre-js.c-pp.js
-@@ -48,7 +48,17 @@
-   */
-   Module['locateFile'] ??= function(path, prefix) {
+@@ -81,7 +81,17 @@
+       return this.emscriptenLocateFile(path, prefix);
+     }
  //#if target:es6-module
 -    return new URL(path, import.meta.url).href;
 +    // Bundlers like rspack will complain if we pass a variable to the URL()

patches/0001-locatefile-nullish-coalesce.patch

@@ -1,8 +1,8 @@
 diff --git a/ext/wasm/api/pre-js.c-pp.js b/ext/wasm/api/pre-js.c-pp.js
-index da399df..9ec48b3 100644
+index da314b9..b047b28 100644
 --- a/ext/wasm/api/pre-js.c-pp.js
 +++ b/ext/wasm/api/pre-js.c-pp.js
-@@ -101,7 +101,9 @@
+@@ -140,7 +140,9 @@
            ? "" : scriptDirectory)
      );
      sims.debugModule("instantiateWasm() uri =", uri, "sIMS =",this);
@@ -13,7 +13,7 @@ index da399df..9ec48b3 100644
      const finalThen = (arg)=>{
        arg.imports = imports;
        sims.instantiateWasm = arg /* used by sqlite3-api-prologue.c-pp.js */;
-@@ -110,10 +112,10 @@
+@@ -149,10 +151,10 @@
      const loadWasm = WebAssembly.instantiateStreaming
            ? async ()=>
            WebAssembly

…ches/0003-locatefile-with-response.patch …ches/0002-locatefile-with-response.patchpatches/0003-locatefile-with-response.patch renamed to patches/0002-locatefile-with-response.patch patches/0003-locatefile-with-response.patch renamed to patches/0002-locatefile-with-response.patch

@@ -5,15 +5,15 @@ import {
   mkdirSync,
   openSync,
   rmSync,
-} from 'node:fs';
-import { execFileSync } from 'node:child_process';
-import path from 'node:path';
+} from "node:fs";
+import { execFileSync } from "node:child_process";
+import path from "node:path";
 
-const WORK_DIR = path.resolve('work');
-const SQLITE_DIR = path.join(WORK_DIR, 'sqlite-src');
-const EXT_WASM = path.join(SQLITE_DIR, 'ext', 'wasm');
-const DIST_DIR = path.resolve('dist');
-const SRC_DIR = path.resolve('src');
+const WORK_DIR = path.resolve("work");
+const SQLITE_DIR = path.join(WORK_DIR, "sqlite-src");
+const EXT_WASM = path.join(SQLITE_DIR, "ext", "wasm");
+const DIST_DIR = path.resolve("dist");
+const SRC_DIR = path.resolve("src");
 
 // 1) Clean dist
 if (existsSync(DIST_DIR)) {
@@ -22,74 +22,73 @@ if (existsSync(DIST_DIR)) {
 mkdirSync(DIST_DIR, { recursive: true });
 
 // 2) Build
-console.log('Building SQLite...');
-execFileSync(path.join(SQLITE_DIR, 'configure'), ['--enable-all'], {
+console.log("Building SQLite...");
+execFileSync(path.join(SQLITE_DIR, "configure"), ["--enable-all"], {
   // It's important to set the current working directory to the SQLite source
   // directory or else it will treat it as an out-of-tree build and not look for
   // EMSDK.
   cwd: SQLITE_DIR,
-  stdio: 'inherit',
+  stdio: "inherit",
 });
-execFileSync('make', ['-C', SQLITE_DIR, 'clean'], { stdio: 'inherit' });
-execFileSync('make', ['-C', SQLITE_DIR, 'sqlite3.c'], { stdio: 'inherit' });
+execFileSync("make", ["-C", SQLITE_DIR, "clean"], { stdio: "inherit" });
+execFileSync("make", ["-C", SQLITE_DIR, "sqlite3.c"], { stdio: "inherit" });
 
-console.log('Building WASM target...');
-execFileSync('make', ['-C', EXT_WASM, 'clean'], { stdio: 'inherit' });
+console.log("Building WASM target...");
+execFileSync("make", ["-C", EXT_WASM, "clean"], { stdio: "inherit" });
 execFileSync(
-  'make',
+  "make",
   [
-    '-C',
+    "-C",
     EXT_WASM,
-    'b-esm',
-    'emcc_opt=-Oz',
-    'c-pp.D.esm=-Dtarget:es6-module',
-    'sqlite3-api.jses=$(sqlite3-license-version.js) ' +
-      '$(dir.api)/sqlite3-api-prologue.js ' +
-      '$(dir.common)/whwasmutil.js ' +
-      '$(dir.jacc)/jaccwabyt.js ' +
-      '$(dir.api)/sqlite3-api-glue.c-pp.js ' +
-      '$(sqlite3-api-build-version.js) ' +
-      '$(dir.api)/sqlite3-api-oo1.c-pp.js ' +
+    "b-esm",
+    "emcc_opt=-Oz",
+    "c-pp.D.esm=-Dtarget:es6-module",
+    "sqlite3-api.jses=$(sqlite3-license-version.js) " +
+      "$(dir.api)/sqlite3-api-prologue.js " +
+      "$(dir.common)/whwasmutil.js " +
+      "$(dir.jacc)/jaccwabyt.js " +
+      "$(dir.api)/sqlite3-api-glue.c-pp.js " +
+      "$(sqlite3-api-build-version.js) " +
+      "$(dir.api)/sqlite3-api-oo1.c-pp.js " +
       // Omit $(dir.api)/sqlite3-api-worker1.c-pp.js
-      '$(dir.api)/sqlite3-vfs-helper.c-pp.js ' +
-      '$(dir.api)/sqlite3-vtab-helper.c-pp.js ' +
+      "$(dir.api)/sqlite3-vfs-helper.c-pp.js " +
+      "$(dir.api)/sqlite3-vtab-helper.c-pp.js " +
       // Omit $(dir.api)/sqlite3-vfs-opfs.c-pp.js
-      '$(dir.api)/sqlite3-vfs-opfs-sahpool.c-pp.js ' +
-      '$(dir.api)/sqlite3-api-cleanup.js',
+      "$(dir.api)/sqlite3-vfs-opfs-sahpool.c-pp.js",
   ],
-  { stdio: 'inherit' }
+  { stdio: "inherit" },
 );
 
 // 3) Strip comments
-console.log('Building tool to strip comments...');
-execFileSync('make', ['-C', EXT_WASM, 't-stripccomments'], {
-  stdio: 'inherit',
+console.log("Building tool to strip comments...");
+execFileSync("make", ["-C", EXT_WASM, "t-stripccomments"], {
+  stdio: "inherit",
 });
-console.log('Stripping C comments from output...');
-const inFd = openSync(path.join(EXT_WASM, 'jswasm', 'sqlite3.mjs'), 'r');
-const apiFileOut = path.join(EXT_WASM, 'jswasm', 'sqlite3-stripped.mjs');
-const outFd = openSync(apiFileOut, 'w');
+console.log("Stripping C comments from output...");
+const inFd = openSync(path.join(EXT_WASM, "jswasm", "sqlite3.mjs"), "r");
+const apiFileOut = path.join(EXT_WASM, "jswasm", "sqlite3-stripped.mjs");
+const outFd = openSync(apiFileOut, "w");
 try {
-  execFileSync(path.join(SQLITE_DIR, 'tool', 'stripccomments'), ['-k', '-k'], {
+  execFileSync(path.join(SQLITE_DIR, "tool", "stripccomments"), ["-k", "-k"], {
     cwd: SQLITE_DIR,
-    stdio: [inFd, outFd, 'inherit'],
+    stdio: [inFd, outFd, "inherit"],
   });
 } finally {
   closeSync(inFd);
   closeSync(outFd);
 }
 
 // 4) Format output
-console.log('Formatting output with oxfmt...');
-execFileSync('pnpm', ['oxfmt', apiFileOut], { stdio: 'inherit' });
+console.log("Formatting output with oxfmt...");
+execFileSync("pnpm", ["oxfmt", apiFileOut], { stdio: "inherit" });
 
 // 5) Copy output to dist
-const wasmModule = path.join(EXT_WASM, 'jswasm', 'esm', 'sqlite3.wasm');
-cpSync(wasmModule, path.join(DIST_DIR, 'sqlite3.wasm'));
-cpSync(apiFileOut, path.join(DIST_DIR, 'sqlite3.js'));
-const types = path.join(SRC_DIR, 'sqlite3.d.ts');
-cpSync(types, path.join(DIST_DIR, 'sqlite3.d.ts'));
-const revFile = path.join(WORK_DIR, 'sqlite-rev.txt');
-cpSync(revFile, path.join(DIST_DIR, 'sqlite-rev.txt'));
+const wasmModule = path.join(EXT_WASM, "jswasm", "esm", "sqlite3.wasm");
+cpSync(wasmModule, path.join(DIST_DIR, "sqlite3.wasm"));
+cpSync(apiFileOut, path.join(DIST_DIR, "sqlite3.js"));
+const types = path.join(SRC_DIR, "sqlite3.d.ts");
+cpSync(types, path.join(DIST_DIR, "sqlite3.d.ts"));
+const revFile = path.join(WORK_DIR, "sqlite-rev.txt");
+cpSync(revFile, path.join(DIST_DIR, "sqlite-rev.txt"));
 
-console.log('Build complete: dist/sqlite3.{js,wasm,d.ts}');
+console.log("Build complete: dist/sqlite3.{js,wasm,d.ts}");

scripts/build.js

@@ -1 +1 @@
-version-3.51.3
+version-3.53.1

sqlite-revision.txt

@@ -2241,7 +2241,7 @@ declare type Sqlite3Static = {
 };
 
 declare type InitOptions = {
-  locateFile?: (
+  emscriptenLocateFile?: (
     path: string,
     prefix: string,
   ) => string | Response | Promise<Response>;
@@ -7622,7 +7622,7 @@ declare type CAPI = {
   sqlite3_js_db_export: (
     db: Database | WasmPointer,
     schema?: string | WasmPointer,
-  ) => Uint8Array<ArrayBuffer>;
+  ) => Uint8Array;
 
   /**
    * Given a `sqlite3*` and a database name (JS string or WASM C-string pointer,