Can not open database with OPFSCoopSyncVFS

[elwin212]

Hi, thanks for the great project!
I’ve been trying to use OPFSCoopSyncVFS and have been following the example here.
However, I keep getting an error when opening the database.
I'm running in a worker context and using Comlink to communicate with the web worker and Vite. I’m able to successfully use AccessHandlePoolVFS to persist data in the browser, but I just can’t seem to get the OPFSCoopSyncVFS working.

// according to doc, OPFSCoopSyncVFS is synchronous
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';
import { OPFSCoopSyncVFS } from 'wa-sqlite/src/examples/OPFSCoopSyncVFS.js';

async initSQLite(): Promise<boolean> {
  try {
    const factory = await SQLiteESMFactory();
    const sqlite3 = SQLite.Factory(factory);
    const vfs = await OPFSCoopSyncVFS.create("hello", factory);
    if(!vfs || !sqlite3){
    throw new Error("Something went wrong");
  }
  
  sqlite3.vfs_register(vfs, true);
  const db = await sqlite3.open_v2("test");
  //const db = await sqlite3.open_v2("test", SQLite.SQLITE_OPEN_CREATE | SQLite.SQLITE_OPEN_READWRITE, "hello",);    // this is not working as well
  await sqlite3.exec(db, "CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY, value TEXT)");
  await sqlite3.close(db);
  return true;
  }
  catch (error) {
    console.error("Error init database:", error);
    return false;
  }
}

The error message looks like this:

Error init databaser: SQLiteError: sqlite3_open_v2
    at check (sqlite-api.js:921:11)
    at Object.open_v2 (sqlite-api.js:570:7

After doing some debugging, I logged the OPFSCoopSyncVFS instance and noticed that lastError shows:
Error: File /%E0%B2%80 not found at OPFSCoopSyncVFS.jOpen.
The zName it pass to the xOpen method is ಀ which is %E0%B2%80.
No matter what file name I pass in, I always get the same error message.
When I inspect the file system I can see it create .ahp-random-string but it didn't create files like the wa-sqlite example such as hello / hello-journal / hello-wal.

Also, when I log the flags in the jOpen method, it's an Proxy(DataView) not the number.

Any guidance on how to get this working would be much appreciated!

[rscalderon]

Facing the same issue

[rhashimoto]

@elwin212 The code you provided is invalid: "SQLite" is not defined. When I fixed that it worked fine for me. Perhaps your problem has something to do with Vite, or some other build/deploy step?

[elwin212]

Hi @rhashimoto, sorry for the late reply! I realized the issue was that I was using this npm package, and I saw in one of your threads that you mentioned you did not publish to npm.
After I forked your repo and used it directly, everything worked great! Thank you for your response and the amazing work.

One thing I’d like to ask:
After initializing the database, I ran the following query:

await sqlite3.exec(db, `
      PRAGMA journal_mode = WAL;  
      PRAGMA mmap_size = 268435456;
    `);

Then, to verify the config, I ran:

await sqlite3.exec(db, `
      PRAGMA journal_mode;
      PRAGMA mmap_size;
    `);

But the result I got was:

PRAGMA journal_mode: delete
PRAGMA mmap_size: 0

Is there any limitation for sqlite-wasm to set these configs?

[rhashimoto]

The browser platform does not support mmap.

SQLite WAL requires a VFS that supports shared memory. Although the browser platform does have a shared memory API, no one to my knowledge has succeeded in using it in a way that enables SQLite WAL.

[elwin212]

I see! Thanks for the clarification!

[hyperknot]

@elwin212 @rscalderon here is how to correctly use OPFSCoopSyncVFS with Vite. Put this in a worker.

import * as SQLite from 'wa-sqlite'
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs'
import { OPFSCoopSyncVFS } from 'wa-sqlite/src/examples/OPFSCoopSyncVFS'

let sqlite3: SQLiteAPI
let db: number

const wasm = await SQLiteESMFactory()
sqlite3 = SQLite.Factory(wasm)

const vfs = await OPFSCoopSyncVFS.create('vfs', wasm)
sqlite3.vfs_register(vfs, true)

db = await sqlite3.open_v2('db.sqlite') 

[elwin212]

Hi @hyperknot, yes I am running in the worker!