mirror of
https://github.com/AgentSeal/codeburn.git
synced 2026-08-10 17:14:48 +00:00
4ca2d4824b
vitest's default glob reached the Electron app's specs under app/, which carry their own vitest config and their own jsdom in app/node_modules. From a root install that fails with ERR_MODULE_NOT_FOUND: jsdom, so the command CONTRIBUTING documents and the one RELEASING.md names as the pre-release gate both error out. Move the scoping CI already applies into package.json: test runs tests/ minus the parallelism-sensitive cache-refresh-lock suites, test:locks runs those three serially, test:watch keeps watch mode at the same scope. The first two are byte-identical to the invocations .github/workflows/tests.yml spells out, so the workflow can be pointed at the scripts to stop the two drifting apart again; that edit is left out of this PR so it needs no workflow permissions. test plus test:locks together still cover all 192 files under tests/. Scoping the script changes what a trailing path argument means: vitest ORs positional filters, so 'npm test -- tests/providers/hermes.test.ts' would no longer narrow to that file, it would run the whole suite. Rewrite those to 'npx vitest run <path>' everywhere they appear - four provider guides and the MCP design plan, thirteen lines in all. Also refresh the stale test docs: 42 files/568 tests (now 192 under tests/), the per-directory counts, the line claiming vitest does not run in CI which stopped being true when tests.yml landed, and the provider test-gap list, which still named antigravity and gemini after both gained test files. Record the cache-refresh-lock naming convention in CONTRIBUTING, since the split makes it load-bearing: a lock test that misses the prefix runs under the full worker pool and flakes, and one that matches it but is absent from test:locks never runs at all.
62 lines
3 KiB
Markdown
62 lines
3 KiB
Markdown
# OpenCode
|
|
|
|
OpenCode (sst/opencode).
|
|
|
|
- **Source:** `src/providers/opencode.ts`
|
|
- **Loading:** lazy (`src/providers/index.ts:59-75`)
|
|
- **Test:** `tests/providers/opencode.test.ts` (676 lines, the largest provider test)
|
|
|
|
## Where it reads from
|
|
|
|
Default `~/.local/share/opencode/` or `$XDG_DATA_HOME/opencode/`. The discovery walk picks up `opencode*.db` files (`opencode.ts:71-88`).
|
|
|
|
For renamed/forked OpenCode-compatible builds (e.g. MiMoCode writing
|
|
`~/.local/share/mimocode/mimicode.db` with the same `session`/`message`/`part`
|
|
schema), point CodeBurn at the fork's data directory with two env vars:
|
|
|
|
- `OPENCODE_DATA_DIR` — the **exact** data directory (no `opencode` suffix is
|
|
appended). Example: `OPENCODE_DATA_DIR=$HOME/.local/share/mimocode`. Relocates
|
|
both file-based and SQLite storage.
|
|
- `OPENCODE_DB_PREFIX` — the SQLite filename prefix (default `opencode`,
|
|
matching `opencode*.db`). Example: `OPENCODE_DB_PREFIX=mimicode` discovers
|
|
`mimicode*.db`. Affects SQLite discovery only; file-based storage under
|
|
`<OPENCODE_DATA_DIR>/storage/` is found regardless.
|
|
|
|
Precedence when no `dataDir` argument is passed (the production path):
|
|
`OPENCODE_DATA_DIR` → `$XDG_DATA_HOME/opencode` → `~/.local/share/opencode`.
|
|
|
|
## Storage format
|
|
|
|
SQLite (older builds) or file-based JSON (OpenCode 1.1+, under `storage/`).
|
|
|
|
## Caching
|
|
|
|
None.
|
|
|
|
## Deduplication
|
|
|
|
Per `<sessionId>:<messageId>`.
|
|
|
|
## Quirks
|
|
|
|
- **Schema validation is loud.** When a required table is missing, the parser logs an actionable warning telling the user which table is gone and what version of OpenCode it expects. This is the right behavior; do not silently swallow these.
|
|
- Source paths are encoded as `<dbPath>:<sessionId>`.
|
|
- Discovery only emits root sessions (`parent_id IS NULL`) to avoid double
|
|
counting. Parsing a root session walks the unarchived `session.parent_id`
|
|
subtree, so child and grandchild agent sessions contribute their message,
|
|
token, and tool usage back to the root session.
|
|
- Each message's `parts` are indexed; preserving the order matters for reasoning-token correctness.
|
|
- Tokens are reported across `input`, `output`, `reasoning`, `cache.read`, and `cache.write`. Anthropic semantics.
|
|
- Assistant messages with missing router usage are kept as zero-cost calls
|
|
when their parts contain non-empty text or tool activity. Empty zero-usage
|
|
assistant placeholders are still skipped.
|
|
- External MCP tools are stored as `<server>_<tool>` names (for example
|
|
`clickup_clickup_get_task`). The provider normalizes those to CodeBurn's
|
|
canonical `mcp__<server>__<tool>` names before aggregation so shared MCP
|
|
panels and `optimize` findings count OpenCode usage.
|
|
|
|
## When fixing a bug here
|
|
|
|
1. The 558-line test suite catches a lot. Run `npx vitest run tests/providers/opencode.test.ts` before and after any change.
|
|
2. If the bug is "missing table" warning, do not catch and silence it. Either upgrade the version expectation in the parser or document the breaking schema change.
|
|
3. If the bug is "reasoning tokens off by one", check the parts index ordering.
|