ac52fd76c0
* 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>
73 lines
3.5 KiB
Markdown
73 lines
3.5 KiB
Markdown
# Distribution: self-contained bundles
|
|
|
|
CodeGraph ships a **vendored Node runtime** alongside the app. Because Node 22.5+
|
|
has a built-in real SQLite (`node:sqlite`, with WAL + FTS5), bundling Node means:
|
|
|
|
- **No native build** — `better-sqlite3` is gone, so there are zero native addons
|
|
to compile or rebuild.
|
|
- **No wasm fallback** — and therefore no more `database is locked` (issue #238).
|
|
- **No Node-version dependence** — the app always runs on the bundled Node,
|
|
whatever the user has (or doesn't have) installed.
|
|
|
|
## What's in a bundle
|
|
|
|
Built by [`scripts/build-bundle.sh`](scripts/build-bundle.sh) — one archive per
|
|
platform, identical recipe (only the Node download differs):
|
|
|
|
```
|
|
codegraph-<target>/
|
|
node | node.exe # official Node runtime for <target>
|
|
lib/
|
|
dist/ # compiled app (+ tree-sitter .wasm grammars, schema.sql)
|
|
node_modules/ # production deps only (pure JS / wasm — portable)
|
|
bin/
|
|
codegraph | codegraph.cmd # launcher → runs the bundled Node with the app
|
|
```
|
|
|
|
Targets: `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`, `win32-x64`,
|
|
`win32-arm64`. Unix targets produce `.tar.gz` (shell launcher); Windows produces
|
|
`.zip` (`node.exe` + a `.cmd` launcher).
|
|
|
|
```bash
|
|
scripts/build-bundle.sh linux-x64 # -> release/codegraph-linux-x64.tar.gz
|
|
scripts/build-bundle.sh win32-x64 # -> release/codegraph-win32-x64.zip
|
|
```
|
|
|
|
Because dropping better-sqlite3 left **zero native addons**, building a bundle is
|
|
pure file-packaging — **any** target builds on **any** OS (the whole matrix builds
|
|
on one Linux runner). Cross-compilation isn't a concern; only *run-testing* a
|
|
bundle needs the target platform (or emulation, e.g. `docker run --platform
|
|
linux/amd64`).
|
|
|
|
## Install channels (all deliver the same bundle)
|
|
|
|
1. **`curl | sh`** ([`install.sh`](install.sh)) — no Node required; ideal for a
|
|
fresh Linux VPS over SSH. Detects os/arch, pulls the archive from GitHub
|
|
Releases, symlinks `codegraph` onto PATH. Re-run to upgrade; `--uninstall` to
|
|
remove.
|
|
2. **npm** ([`scripts/npm-shim.js`](scripts/npm-shim.js)) — preserves
|
|
`npm i -g @colbymchenry/codegraph`. The main package is a tiny shim; the
|
|
bundles ship as per-platform `optionalDependencies`
|
|
(`@colbymchenry/codegraph-<target>` with `os`/`cpu`), so npm installs only the
|
|
matching one. The shim — run by the user's Node — execs the bundle, so the
|
|
real work runs on the bundled Node 24. Works even on old Node.
|
|
3. **Windows** ([`install.ps1`](install.ps1)) — `irm … | iex`; same flow as
|
|
install.sh (detect arch, pull the `.zip` from Releases, add to PATH).
|
|
4. **Homebrew / Scoop** — TODO (tap + cask pointing at the Release archives).
|
|
|
|
## Release pipeline
|
|
|
|
[`.github/workflows/release.yml`](.github/workflows/release.yml) — manually
|
|
triggered. Reads the version from `package.json`, builds every platform bundle on
|
|
one runner, creates the GitHub Release (notes from `CHANGELOG.md`), and publishes
|
|
the npm shim + per-platform packages. Requires the `NPM_TOKEN` repo secret.
|
|
|
|
Still TODO:
|
|
- **Code signing** — the main gap for "download & run": macOS Gatekeeper needs a
|
|
Developer ID + notarization; Windows needs Authenticode. Homebrew softens the
|
|
macOS case (handles quarantine).
|
|
- Retire the now-vestigial Node-version gate in `src/bin/codegraph.ts` — the
|
|
bundle always runs Node 24, and the npm shim does no tree-sitter work.
|
|
- Re-wire `npm uninstall` cleanup (the agent-config `preuninstall`) through the
|
|
shim — the generated main package doesn't carry it.
|