Self-contained distribution: bundle Node + node:sqlite, drop better-sqlite3/wasm (closes #238) (#282)
* 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>
This commit is contained in:
co-authored by
Claude Opus 4.7
parent
b8aec39abd
commit
ac52fd76c0
@@ -1,59 +1,18 @@
|
||||
/**
|
||||
* SQLite backend visibility tests
|
||||
* SQLite backend reporting.
|
||||
*
|
||||
* Pins the WASM-fallback banner content + the per-instance backend
|
||||
* tracking. Closes the visibility gap behind issue #138.
|
||||
* node:sqlite (Node's built-in real SQLite) is the sole backend. Pin that
|
||||
* DatabaseConnection / CodeGraph report it and come up in WAL.
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import * as os from 'os';
|
||||
import {
|
||||
buildWasmFallbackBanner,
|
||||
WASM_FALLBACK_FIX_RECIPE,
|
||||
} from '../src/db/sqlite-adapter';
|
||||
import { DatabaseConnection } from '../src/db';
|
||||
import { CodeGraph } from '../src';
|
||||
|
||||
describe('buildWasmFallbackBanner — fix-recipe content', () => {
|
||||
it('includes the macOS / Linux / cross-platform fix commands', () => {
|
||||
const banner = buildWasmFallbackBanner();
|
||||
expect(banner).toContain('WASM SQLite fallback active');
|
||||
expect(banner).toContain('5-10x slower');
|
||||
expect(banner).toContain('xcode-select --install');
|
||||
expect(banner).toContain('apt install build-essential');
|
||||
expect(banner).toContain('npm rebuild better-sqlite3');
|
||||
expect(banner).toContain('npm install better-sqlite3 --save');
|
||||
expect(banner).toContain('codegraph status');
|
||||
});
|
||||
|
||||
it('appends the native load error when one is provided', () => {
|
||||
const banner = buildWasmFallbackBanner(
|
||||
"Cannot find module 'better-sqlite3'"
|
||||
);
|
||||
expect(banner).toContain(
|
||||
"Native load error: Cannot find module 'better-sqlite3'"
|
||||
);
|
||||
});
|
||||
|
||||
it('omits the load-error block when no error is supplied', () => {
|
||||
const banner = buildWasmFallbackBanner();
|
||||
expect(banner).not.toContain('Native load error:');
|
||||
});
|
||||
});
|
||||
|
||||
describe('WASM_FALLBACK_FIX_RECIPE — single source of truth', () => {
|
||||
it('mentions the three recovery commands', () => {
|
||||
expect(WASM_FALLBACK_FIX_RECIPE).toContain('xcode-select --install');
|
||||
expect(WASM_FALLBACK_FIX_RECIPE).toContain('npm rebuild better-sqlite3');
|
||||
expect(WASM_FALLBACK_FIX_RECIPE).toContain(
|
||||
'npm install better-sqlite3 --save'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('DatabaseConnection — per-instance backend reporting', () => {
|
||||
describe('DatabaseConnection — backend reporting', () => {
|
||||
let dir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
@@ -66,11 +25,10 @@ describe('DatabaseConnection — per-instance backend reporting', () => {
|
||||
}
|
||||
});
|
||||
|
||||
it('reports a concrete backend (native or wasm) for an initialized DB', () => {
|
||||
const dbPath = path.join(dir, 'test.db');
|
||||
const conn = DatabaseConnection.initialize(dbPath);
|
||||
const backend = conn.getBackend();
|
||||
expect(['native', 'wasm']).toContain(backend);
|
||||
it('reports the node-sqlite backend in WAL for an initialized DB', () => {
|
||||
const conn = DatabaseConnection.initialize(path.join(dir, 'test.db'));
|
||||
expect(conn.getBackend()).toBe('node-sqlite');
|
||||
expect(conn.getJournalMode()).toBe('wal');
|
||||
conn.close();
|
||||
});
|
||||
|
||||
@@ -78,7 +36,7 @@ describe('DatabaseConnection — per-instance backend reporting', () => {
|
||||
fs.writeFileSync(path.join(dir, 'x.ts'), `export function x(): void {}\n`);
|
||||
const cg = await CodeGraph.init(dir, { index: true });
|
||||
try {
|
||||
expect(['native', 'wasm']).toContain(cg.getBackend());
|
||||
expect(cg.getBackend()).toBe('node-sqlite');
|
||||
} finally {
|
||||
cg.destroy();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user