[bun:sqlite] Support sqlite3_file_control, better closing behavior, implement Disposable

[Jarred-Sumner]

What does this PR do?

You can now manage the lifetime of a Database instance in bun:sqlite via the using keyword:

import { Database } from "bun:sqlite";

{
  using db = new Database("mydb.sqlite");
  using query = db.query("select 'Hello world' as message;");
  console.log(query.get()); // => { message: "Hello world" }
}

Database#fileControl lets you use the sqlite3_file_control API

For example:

import { Database } from "bun:sqlite";

const db = new Database();
// Ensure WAL mode is NOT persistent
// this prevents wal files from lingering after the database is closed
db.fileControl(SQL.constants.SQLITE_FCNTL_PERSIST_WAL, 0);

Automatically closing databases when the Database object GC'd was not implemented correctly before (bun would only automatically close the database before process exit). This has now been fixed

database.close(true) will now throw an error if the database has any pending resources associated with it.

Fixes #2537

How did you verify your code works?

Tests

[github-actions]

❌ @Jarred-Sumner 5 files with test failures on linux-x64-baseline:

• test/integration/next-pages/test/dev-server.test.ts 1 failing
• test/integration/next-pages/test/next-build.test.ts 1 failing
• test/js/node/child_process/child_process-node.test.js 1 failing
• test/js/node/http2/node-http2.test.js 2 failing
• test/js/node/watch/fs.watchFile.test.ts 1 failing

View test output

^{#d71158f4b3921a5900fbfe9cecc5d92152768a7b}

[github-actions]

❌ @Jarred-Sumner 4 files with test failures on linux-x64:

• test/integration/next-pages/test/dev-server.test.ts 1 failing
• test/integration/next-pages/test/next-build.test.ts 1 failing
• test/js/node/http2/node-http2.test.js 1 failing
• test/js/node/watch/fs.watchFile.test.ts 2 failing

View test output

^{#d71158f4b3921a5900fbfe9cecc5d92152768a7b}

[github-actions]

❌ @Jarred-Sumner 2 files with test failures on bun-darwin-aarch64:

• test/js/bun/http/serve.test.ts 2 failing
• test/js/node/http2/node-http2.test.js 2 failing

View test output

^{#d71158f4b3921a5900fbfe9cecc5d92152768a7b}

[github-actions]

❌ @Jarred-Sumner 8 files with test failures on bun-windows-x86_64-haswell

• test\cli\install\bunx.test.ts 1 failing
• test\cli\install\registry\bun-install-registry.test.ts 15 failing
• test\integration\next-pages\test\dev-server-ssr-100.test.ts 1 failing
• test\integration\next-pages\test\dev-server.test.ts 1 failing
• test\integration\next-pages\test\next-build.test.ts 1 failing
• test\js\bun\shell\bunshell.test.ts 2 failing
• test\js\node\dns\node-dns.test.js 2 failing
• test\js\node\http2\node-http2.test.js 2 failing

View test output

^{#d71158f4b3921a5900fbfe9cecc5d92152768a7b}

[github-actions]

❌ @Jarred-Sumner 5 files with test failures on bun-darwin-x64:

• test/js/bun/shell/leak.test.ts SIGTERM
• test/js/bun/spawn/spawn.test.ts 1 failing
• test/js/bun/test/test-test.test.ts 1 failing
• test/js/web/fetch/fetch.tls.test.ts 1 failing
• test/js/web/workers/worker.test.ts 1 failing

View test output

^{#d71158f4b3921a5900fbfe9cecc5d92152768a7b}

[pekeler]

This doesn't work well for me in 1.1.4. Typescript doesn't know about the SQLITE_FCNTL_* constants, the fileControl() function, the close() parameter, and is complaining about the db not having a dispose() method when using 'using'.

[gvilums]

@pekeler this might be an issue with our type declarations - have you tried running the code and seeing if it works?

[pekeler]

@gvilums the code works for simple use cases (ignoring the type errors). In scenarios where the DB is used for a bit more than one simple query, db.close(true); produces a database is locked error. I do keep track of all my prepared statements and make sure they're finalized before closing the DB, so something doesn't feel right.

[gvilums]

Hm, that does indeed sound like something is going wrong in bun. Could you open an issue for this?

[pekeler]

@gvilums I have so far failed to create a simple project to reproduce this issue. However, I also noticed that db.close(true) doesn't work after running migrations and created an issue with a simple project that reproduces the issue here #11418. Hopefully the underlying cause is the same.