mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-15 10:06:03 +00:00
* refactor(sessions): migrate runtime storage to sqlite * test(sessions): fix sqlite CI regressions * test(sessions): align remaining sqlite fixtures * fix(codex): require sqlite trajectory recorder * test(sessions): align orphan recovery sqlite fixture * test(sessions): align sqlite rebase fixtures * fix(sessions): finish current-main integration of the sqlite flip Resolve the whole-store SDK removal across its owner boundary: drop the loadSessionStore re-export and the registry whole-store wrappers, wire hasTrackedActiveSessionRun into gateway chat, complete the preserveLockedHarnessIds cleanup contract, flip the codex thread-history import to storePath targets, and port remaining main-side tests from file-store helpers to session accessor reads. * chore: drop committed pebbles log, revert plugin-inspector bump, refresh generated docs Remove the 1.8k-line .pebbles/events.jsonl work log from the branch, restore the plugin-inspector advisory lane to main's pinned 0.3.10 so the supply-chain bump gets its own review, and regenerate docs_map, the plugin SDK API baseline, and the export-surface ratchet for the merged tree. * feat(sessions): keep archived transcripts by default with zstd cold storage Codex-style retention: deleting or resetting a session archives its transcript as a zstd-compressed JSONL artifact (plain when the runtime lacks node:zlib zstd) and keeps it until the disk budget evicts oldest first. resetArchiveRetention now governs both deleted and reset archives and defaults to keep; maxDiskBytes defaults to 2gb so retention stays bounded, with archives evicted before live sessions. The cron reaper follows the same knob instead of deleting archives on its own timer. * fix(state): converge agent DB migration lineages and bound database growth Merge coherence: run both structure-gated legacy memory-schema repairs (flip-lineage drop, main-lineage identity rebuild) before the flip migration so pre-flip v1/v2 and pre-merge flip v1/v4 databases all converge, and hoist foreign_keys=OFF outside the schema transaction where the pragma was silently ignored and the v1 sessions rebuild cascade-deleted session_entries. Growth guards: fresh agent DBs enable auto_vacuum=INCREMENTAL, WAL maintenance releases freed pages in bounded passes (never a blocking full VACUUM), and doctor reports state/agent DB bloat from freelist stats. * fix(codex): resolve the store path for thread-history import via the SDK The supervision catalog passed the legacy sessionFile locator to the storePath-targeted transcript mirror; resolve the agent store path with the session-store SDK helper instead of a runtime-object seam so test fakes and headless callers need no extra surface. Drop the obsolete missing-session-id preprocessing case: sessions rows are NOT NULL on session_id and upsert repairs id-less patches at write time. * fix(sessions): fail safe on malformed disk-budget config and doctor stat errors A malformed explicit maxDiskBytes disables the budget instead of falling back to the destructive 2gb default the user never chose, and the doctor bloat check skips databases whose paths stat-fail instead of aborting doctor. * fix(sessions): complete sqlite conflict translations * test(sqlite): align hardening checks with maintenance * test(sessions): inspect compressed transcript archives * fix(tests): await session seeds and drop unused helpers flagged by CI lint The five unawaited writeSessionStoreSeed calls raced their SQLite seeds against the assertions, failing compact shards; the bloat probe drops a useless initializer and the merged tests drop now-unused helpers. * test(sessions): type legacy proof events directly * test(sessions): align hardening contracts * perf(sessions): read usage transcript sizes from SQL aggregates Usage/cost scans walked every session and materialized every transcript event just to re-stringify it for a byte estimate — the #86718 stall class reborn on the DB. readTranscriptStatsSync sums stored JSON bytes in SQLite without loading a single row. * fix(sessions): re-root foreign-root transcript paths onto the current sessions dir Restored backups, moved OPENCLAW_STATE_DIR, and rehearsal copies carry absolute sessionFile paths from the old root; the containment fallback kept those foreign paths, so migration read (and would archive) files in the original root and reported local copies missing. Re-root the canonical agents/<id>/sessions suffix onto the current dir when the file exists there; genuine cross-root layouts still fall through unchanged. * test(agents): seed harness admission through sqlite * fix(sqlite): close agent db on pragma setup failure * fix(doctor): compact and retrofit incremental auto-vacuum after session import The migration is the sanctioned offline window: post-import compact reclaims import churn and applies auto_vacuum=INCREMENTAL to databases created before the fresh-DB pragma existed, so runtime maintenance can release pages in bounded passes on every install. --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
78 lines
3.5 KiB
Markdown
78 lines
3.5 KiB
Markdown
---
|
|
summary: "Developer workflow for OpenClaw agent runtime: build, test, and live validation"
|
|
title: "OpenClaw agent runtime workflow"
|
|
read_when:
|
|
- Working on OpenClaw agent runtime code or tests
|
|
- Running agent-runtime lint, typecheck, and live test flows
|
|
---
|
|
|
|
Developer workflow for the agent runtime (`src/agents/`) in the OpenClaw repo.
|
|
|
|
## Type checking and linting
|
|
|
|
- Default local gate: `pnpm check` (typecheck, lint, policy guards)
|
|
- Build gate: `pnpm build` when the change can affect build output, packaging, or lazy-loading/module boundaries
|
|
- Full pre-push gate: `pnpm build && pnpm check && pnpm check:test-types && pnpm test`
|
|
|
|
## Running Agent Runtime Tests
|
|
|
|
Run the agent runtime unit suites:
|
|
|
|
```bash
|
|
pnpm test \
|
|
"src/agents/agent-*.test.ts" \
|
|
"src/agents/embedded-agent-*.test.ts" \
|
|
"src/agents/agent-hooks/**/*.test.ts"
|
|
```
|
|
|
|
The first glob also covers the `agent-tools*`, `agent-settings`, and
|
|
`agent-tool-definition-adapter*` suites.
|
|
|
|
Live tests are excluded from the unit config; run them through the live
|
|
wrapper (sets `OPENCLAW_LIVE_TEST=1` and needs provider credentials):
|
|
|
|
```bash
|
|
pnpm test:live src/agents/embedded-agent-runner-extraparams.live.test.ts
|
|
```
|
|
|
|
## Manual testing
|
|
|
|
- Run the Gateway in dev mode (skips channel connections via `OPENCLAW_SKIP_CHANNELS=1`): `pnpm gateway:dev`
|
|
- Trigger one agent turn through the Gateway: `pnpm openclaw agent --message "Hello" --thinking low`
|
|
- Use the TUI for interactive debugging: `pnpm tui`
|
|
|
|
For tool call behavior, prompt for a `read` or `exec` action so you can watch
|
|
tool streaming and payload handling.
|
|
|
|
## Clean slate reset
|
|
|
|
State lives in the OpenClaw state directory: `~/.openclaw` by default, or
|
|
`$OPENCLAW_STATE_DIR` when set. Paths relative to that directory:
|
|
|
|
| Path | Holds |
|
|
| ---------------------------------------------- | ------------------------------------------------------------------ |
|
|
| `openclaw.json` | Config |
|
|
| `state/openclaw.sqlite` | Shared runtime state database |
|
|
| `agents/<agentId>/agent/openclaw-agent.sqlite` | Per-agent model auth profiles (API keys + OAuth) and runtime state |
|
|
| `credentials/` | Provider/channel credentials outside the auth profile store |
|
|
| `agents/<agentId>/sessions/` | Transcript history and legacy session migration sources |
|
|
| `sessions/` | Legacy single-agent session store (old installs only) |
|
|
| `workspace/` | Default agent workspace (extra agents use `workspace-<agentId>`) |
|
|
|
|
Delete those paths for a full reset. Narrower resets:
|
|
|
|
- Sessions only: do not delete `agents/<agentId>/agent/openclaw-agent.sqlite`; session rows live there alongside other per-agent state. Use `/new` or `/reset` to start a fresh session for one chat, and `openclaw sessions cleanup` for session maintenance.
|
|
- Keep auth: leave `agents/<agentId>/agent/openclaw-agent.sqlite` and `credentials/` in place.
|
|
|
|
Legacy `auth-profiles.json` files are no longer read at runtime;
|
|
`openclaw doctor --fix` imports them into the SQLite store.
|
|
|
|
## References
|
|
|
|
- [Testing](/help/testing)
|
|
- [Getting Started](/start/getting-started)
|
|
|
|
## Related
|
|
|
|
- [OpenClaw agent runtime architecture](/agent-runtime-architecture)
|