* fix(db): eliminate concurrent-read "database is locked"; add node:sqlite backend (#238) WAL + busy_timeout were already enabled, so the issue's suggested fix was a no-op. The real causes, addressed here: - busy_timeout is now set first (before journal_mode) and lowered 120s -> 5s, so open-time pragmas wait out a lock instead of hanging for two minutes. - getCodeGraph no longer opens a second connection to the default project when a tool passes its own projectPath (the in-process lock amplifier). - The wasm fallback (no WAL) gets a bounded read-retry on SQLITE_BUSY. - New: node:sqlite backend, preferred over wasm, so installs whose native better-sqlite3 build fails land on a real-WAL backend instead of no-WAL wasm. - codegraph status / codegraph_status now report the effective journal mode, so a lock report is triageable (wal vs delete). - CLI hard-blocks Node < 20 to actually enforce the engines floor. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * refactor(db)!: node:sqlite is the sole backend; drop better-sqlite3 + wasm Now that distribution will bundle a Node 24 runtime, node:sqlite (real SQLite with WAL + FTS5) is always available. Collapse the three-backend adapter to node:sqlite only and remove the machinery the other two needed: - Remove better-sqlite3 (optionalDependency) and node-sqlite3-wasm (dependency). - Remove WasmDatabaseAdapter, the named->positional param translation, the SQLITE_BUSY read-retry, the wasm fallback banner, the backend env override, and the native/node-sqlite/wasm selection chain. - createDatabase now opens node:sqlite directly, with a clear error pointing at the bundled release / Node 22.5+ when the module is absent. - NodeSqliteAdapter.close() is idempotent and pragma() supports { simple }, to match the better-sqlite3 behavior callers relied on. - status (CLI + MCP) reports the single node:sqlite backend; journal-mode diagnostics and the getCodeGraph single-connection fix are retained. - Tests repointed off better-sqlite3 onto node:sqlite. Net -1044 lines. Running from source now requires Node 22.5+. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(dist): self-contained bundle prototype (vendored Node + install channels) Phase 3 of the node:sqlite migration: ship a vendored Node runtime so CodeGraph runs with no system Node and no native build (node:sqlite is built in). - scripts/build-bundle.sh: build a per-platform archive (official Node + dist + prod deps + launcher). Same recipe per platform; pins Node v24.16.0. - install.sh: curl|sh installer (no Node required) — detects os/arch, pulls the archive from Releases, symlinks onto PATH; re-run to upgrade, --uninstall to remove. The VPS/SSH path. - scripts/npm-shim.js: thin launcher for the npm channel — resolves the per-platform optionalDependency bundle and execs it, so `npm i -g` keeps working and the real work runs on the bundled Node regardless of the user's. - BUNDLING.md: distribution design + release-pipeline TODO (CI matrix, platform packages, code signing, brew, retiring the Node-version gate). Validated end-to-end: darwin-arm64 and linux-x64 bundles both run init + index + status (Backend: node:sqlite, Journal: wal) + FTS query with NO system Node — linux-x64 verified in a clean ubuntu:24.04 amd64 container. Release archives are gitignored; CI will produce and upload them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(dist): add Windows PowerShell installer (install.ps1) The `irm … | iex` one-liner for Windows, mirroring install.sh: detect arch, pull the matching bundle from Releases, extract to %LOCALAPPDATA%\codegraph, add it to user PATH. Re-run to upgrade. (Windows bundle production in build-bundle.sh is still TODO.) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(dist): release workflow + npm packaging; README/CHANGELOG for bundled distro - .github/workflows/release.yml: manually-triggered (workflow_dispatch) release matrix. Builds a self-contained bundle per platform on its own runner (darwin-arm64/x64, linux-x64/arm64), publishes a GitHub Release with all archives, and publishes the npm thin-installer (shim + per-platform packages). Windows targets are TODO (build-bundle.sh is unix-only). - scripts/pack-npm.sh: assemble the npm packages from built bundles — per-platform packages tagged os/cpu + the main shim package with them as optionalDependencies (esbuild pattern). Proven locally: npm-install the tarballs, run via the shim, resolves the bundle and runs on the bundled Node 24 (node:sqlite / WAL). - README: install section now leads with the no-Node one-liners (curl|sh, irm|iex) then npm/npx; "bundled · none required" badge. - CHANGELOG: standout headline for the self-contained release, plus Added/Changed/ Removed for the install channels, node:sqlite backend, and dropped deps. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(dist): Windows bundles + single-trigger release workflow - build-bundle.sh: add win32-x64 / win32-arm64 targets — download Node's Windows zip, bundle node.exe + a .cmd launcher, output a .zip. Verified structurally (PE32+ node.exe, CRLF .cmd, portable node_modules). Since there are no native addons, any target builds on any OS, so the whole matrix builds on one runner. - pack-npm.sh: handle .zip bundles and win32 packages (os: win32, node.exe). - release.yml: simplified to your spec — manual trigger reads the version from package.json, builds all platform bundles, creates the GitHub Release with notes pulled from CHANGELOG.md, and publishes the npm shim + platform packages. - BUNDLING.md: Windows + build-anywhere notes; release pipeline documented. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
140 lines
4.5 KiB
TypeScript
140 lines
4.5 KiB
TypeScript
/**
|
|
* SQLite Adapter
|
|
*
|
|
* Thin wrapper over Node's built-in `node:sqlite` (`DatabaseSync`), exposed
|
|
* through a small better-sqlite3-shaped interface so the rest of the codebase
|
|
* is storage-agnostic.
|
|
*
|
|
* CodeGraph ships with a bundled Node runtime, so `node:sqlite` (real SQLite,
|
|
* with WAL + FTS5) is always available — there is no native build step and no
|
|
* wasm fallback. When run from source instead, it requires Node >= 22.5.
|
|
*/
|
|
|
|
export interface SqliteStatement {
|
|
run(...params: any[]): { changes: number; lastInsertRowid: number | bigint };
|
|
get(...params: any[]): any;
|
|
all(...params: any[]): any[];
|
|
}
|
|
|
|
export interface SqliteDatabase {
|
|
prepare(sql: string): SqliteStatement;
|
|
exec(sql: string): void;
|
|
pragma(str: string, options?: { simple?: boolean }): any;
|
|
transaction<T>(fn: (...args: any[]) => T): (...args: any[]) => T;
|
|
close(): void;
|
|
readonly open: boolean;
|
|
}
|
|
|
|
/**
|
|
* The active SQLite backend. Only one now (`node:sqlite`); kept as a named type
|
|
* so `codegraph status` and the per-instance reporting have a stable shape.
|
|
*/
|
|
export type SqliteBackend = 'node-sqlite';
|
|
|
|
/**
|
|
* Wraps Node's built-in `node:sqlite` (`DatabaseSync`) to match the
|
|
* better-sqlite3 interface the rest of the code expects.
|
|
*
|
|
* node:sqlite is real SQLite compiled into Node, so it supports WAL, FTS5,
|
|
* mmap, and `@named` params natively — the only shims needed are the
|
|
* better-sqlite3 conveniences node:sqlite omits: a `.pragma()` helper, a
|
|
* `.transaction()` helper, and `open` (node:sqlite exposes `isOpen`).
|
|
*/
|
|
class NodeSqliteAdapter implements SqliteDatabase {
|
|
private _db: any;
|
|
|
|
constructor(dbPath: string) {
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
const { DatabaseSync } = require('node:sqlite');
|
|
this._db = new DatabaseSync(dbPath);
|
|
}
|
|
|
|
get open(): boolean {
|
|
return this._db.isOpen;
|
|
}
|
|
|
|
prepare(sql: string): SqliteStatement {
|
|
// node:sqlite matches better-sqlite3's calling convention (variadic
|
|
// positional args, or a single object for @named params), so params forward
|
|
// through unchanged.
|
|
const stmt = this._db.prepare(sql);
|
|
return {
|
|
run(...params: any[]) {
|
|
const r = stmt.run(...params);
|
|
return {
|
|
changes: Number(r?.changes ?? 0),
|
|
lastInsertRowid: r?.lastInsertRowid ?? 0,
|
|
};
|
|
},
|
|
get(...params: any[]) {
|
|
return stmt.get(...params);
|
|
},
|
|
all(...params: any[]) {
|
|
return stmt.all(...params);
|
|
},
|
|
};
|
|
}
|
|
|
|
exec(sql: string): void {
|
|
this._db.exec(sql);
|
|
}
|
|
|
|
pragma(str: string, options?: { simple?: boolean }): any {
|
|
const trimmed = str.trim();
|
|
// Write pragma ("key = value"): node:sqlite is real SQLite, so every pragma
|
|
// (WAL, mmap, synchronous, …) applies as-is.
|
|
if (trimmed.includes('=')) {
|
|
this._db.exec(`PRAGMA ${trimmed}`);
|
|
return;
|
|
}
|
|
// Read pragma. Default: the row object (e.g. { journal_mode: 'wal' }).
|
|
// `{ simple: true }` returns just the single column value, like better-sqlite3.
|
|
const row = this._db.prepare(`PRAGMA ${trimmed}`).get();
|
|
if (options?.simple) {
|
|
return row && typeof row === 'object' ? Object.values(row)[0] : row;
|
|
}
|
|
return row;
|
|
}
|
|
|
|
transaction<T>(fn: (...args: any[]) => T): (...args: any[]) => T {
|
|
return (...args: any[]) => {
|
|
this._db.exec('BEGIN');
|
|
try {
|
|
const result = fn(...args);
|
|
this._db.exec('COMMIT');
|
|
return result;
|
|
} catch (error) {
|
|
this._db.exec('ROLLBACK');
|
|
throw error;
|
|
}
|
|
};
|
|
}
|
|
|
|
close(): void {
|
|
// node:sqlite's DatabaseSync.close() throws if already closed; make it
|
|
// idempotent to match better-sqlite3 (callers may close more than once).
|
|
if (this._db.isOpen) this._db.close();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a database connection backed by `node:sqlite`.
|
|
*
|
|
* Returns the active backend alongside the db so each `DatabaseConnection` can
|
|
* report it per-instance — MCP can open multiple project DBs in one process, so
|
|
* a process-global would race.
|
|
*/
|
|
export function createDatabase(dbPath: string): { db: SqliteDatabase; backend: SqliteBackend } {
|
|
try {
|
|
return { db: new NodeSqliteAdapter(dbPath), backend: 'node-sqlite' };
|
|
} catch (error) {
|
|
const msg = error instanceof Error ? error.message : String(error);
|
|
throw new Error(
|
|
'Failed to open SQLite via the built-in node:sqlite module.\n' +
|
|
'CodeGraph requires node:sqlite (Node.js 22.5+). Install the self-contained\n' +
|
|
'CodeGraph release (it bundles a compatible Node), or run on Node 22.5+.\n' +
|
|
`Underlying error: ${msg}`
|
|
);
|
|
}
|
|
}
|