feat(better-sqlite3): record queries made through better-sqlite3

[evlawler]

Applications that use better-sqlite3, directly or through Drizzle, record no SQL events. This adds a hook for it next to the sqlite3, mysql, pg and Prisma hooks.

What is recorded

• Database.exec and Database.pragma
• Statement.run, get, all and iterate, with the statement's source as the SQL
• Statements inside transaction(), including the BEGIN and COMMIT that better-sqlite3 prepares itself
• A statement that throws is recorded as an exception and rethrown

Where this departs from the sqlite3 hook

• better-sqlite3 does not export Statement. The Statement prototype is patched the first time prepare() returns one, not at module load.
• iterate() returns rows lazily. Its return event is emitted when the iterator is exhausted, returned early, or throws. The hook returns a plain iterator that forwards to the native one, because the native iterator's methods cannot be called through a Proxy receiver.
• Everything is synchronous, so there is no async context capture.

Test

• test/betterSqlite3: a fixture that runs each method, one statement twice, a transaction, an early break out of iterate(), and a caught unique violation. Snapshot test in test/betterSqlite3.test.ts.
• The fixture pins better-sqlite3 ^11.10, the last major with prebuilt binaries for Node 18, which CI runs.

Not covered

• ESM imports. The hook applies when the module is loaded with require. An import Database from "better-sqlite3" in an ESM application is not hooked. The other driver hooks have the same limit.
• Whether pragma() should be recorded at all is a judgement call. It is included because PRAGMA statements change behavior and are cheap to record.

This was run against one real application, promptfoo, where it recorded the Drizzle inserts and selects that were previously missing.

Written by Claude in a Claude Code session for Elizabeth Lawler. The commit carries Claude as author.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EgK3BVLCovf26kotqTnkau

---

Generated by Claude Code

[Copilot]

🟡 Changes recommended

Four unresolved moderate issues remain in the better-sqlite3 hook.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds CommonJS instrumentation for better-sqlite3, covering queries, pragmas, transactions, iteration, and exceptions.

Changes:

• Adds the better-sqlite3 require hook.
• Adds fixture, integration, and snapshot coverage.
• Registers the fixture workspace and dependency lock entries.

File summaries

File	Description
yarn.lock	Locks fixture dependencies.
test/betterSqlite3/package.json	Adds the fixture dependency.
test/betterSqlite3/index.js	Exercises supported database operations.
test/betterSqlite3/appmap.yml	Configures the fixture.
test/betterSqlite3.test.ts	Adds integration coverage.
test/__snapshots__/betterSqlite3.test.ts.snap	Records expected events.
src/requireHook.ts	Registers the new hook.
src/hooks/betterSqlite3.ts	Implements SQL instrumentation.
package.json	Registers the test workspace.

Review details

Suppressed comments (2)

src/hooks/betterSqlite3.ts:172

• The lazy iterator has a separate exception path here, but the fixture only verifies an exception from run() (test/betterSqlite3/index.js:35-40). Add an integration case that makes iterator.next() throw, verifies the error is rethrown, and snapshots the resulting SQL exception event so this forwarding logic cannot regress unnoticed.

          } catch (exn: unknown) {
            finish(exn ?? new Error("iteration failed"));
            throw exn;

src/hooks/betterSqlite3.ts:56

• The private transaction controller does not use Database.prototype.prepare; it calls the native database's prepare to create the transaction statements before the returned transaction function runs. On a fresh database, before.run() therefore executes before any user db.prepare() can patch this shared Statement prototype, so BEGIN is not recorded (and other controller statements can likewise be missed when the callback does not prepare a statement). The fixture masks this by preparing insert first; initialize the Statement prototype before transaction setup and add a fresh-database regression test.

function patchStatementPrototype(statement: object) {
  const proto: unknown = Object.getPrototypeOf(statement);
  if (proto === null || typeof proto !== "object" || patchedStatementPrototypes.has(proto)) return;
  patchedStatementPrototypes.add(proto);

• Files reviewed: 8/9 changed files
• Comments generated: 2
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/appmap-node@237 -D

commit: 54116ee

[Copilot]

Copilot review overview

🟡 Changes recommended

The new hook and fixtures appear likely to fail the repo’s ESLint/Prettier checks (unbound-method + formatting), which would block CI.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 · 2

Open (3)

• Suppress unbound-method lint errors for wrapped prototype methods · New
• Wrap long for-of headers for Prettier · New
• Reformat line to satisfy Prettier · New

Resolved since last review (2)

• native.return() is not guaranteed to succeed: better-sqlite3 checks that the database is not busy…
• This hook runs after every require, including cache hits (requireHook.ts calls it…

[appmap-releasebot]

🎉 This PR is included in version 2.27.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀