Files
orca/docs/development.md
T
Jinjing 3c46ffbefd docs: slim CONTRIBUTING.md to the essentials for getting a PR merged
Move dev-environment reference into docs/development.md and the maintainer
release process into docs/releasing.md.
2026-11-09 01:45:27 -08:00

10 KiB

Orca Development Environment

Reference details for working on Orca locally. Start with CONTRIBUTING.md.

Toolchain and Native Prerequisites

Install Node 24, pnpm, and the Bun version in config/.bun-version. pnpm test runs Vitest on Bun, with Node workers for runtime contracts such as SQLite, native PTYs, socket liveness, and V8 memory behavior. pnpm test:node runs the same suites entirely on Node. Builds and dependency installation still use Node and pnpm.

The server, its workers and its packaged dependencies target Node 24. The compatibility launcher and CLI still target Node 18; the launcher hands off to bundled Node 24 before loading server code. WSL guest programs and host discovery retain their Node 18 minimum. Keep Node 24 APIs and server imports out of these host compatibility paths. Running an unpackaged server directly requires Node 24 or newer.

Use the pnpm version in packageManager in package.json: corepack enable needs Corepack 0.34.5 or newer to start the pinned pnpm (npm install -g corepack@latest). On Windows it writes shims next to node.exe and fails with EPERM outside an elevated shell when Node is in C:\Program Files\nodejs; run npm install -g pnpm@<that version> instead.

pnpm install compiles native modules such as node-pty with node-gyp and loads them in Electron, so a fresh machine also needs:

  • macOS: Xcode Command Line Tools (xcode-select --install).

  • Windows: Python 3 and Visual Studio Build Tools with the "Desktop development with C++" workload.

  • Linux: a C++ toolchain, Python 3, and the libraries Electron loads even on a headless machine, plus xvfb, which the *.electron.test.ts files in pnpm test use when DISPLAY is unset. On Ubuntu 24.04+ and Debian 13+:

    sudo apt-get update && sudo apt-get install -y build-essential python3 xvfb libgtk-3-0 libnss3 libgbm1 libasound2t64
    

    Older releases name the last package libasound2.

pnpm install
pnpm dev

mobile/ is a separate pnpm project with its own lockfile, so the root pnpm install leaves its dependencies uninstalled. pnpm build (build:mobile-web fails without them) and the lint passes that cover mobile/ need them. Install them before building or linting, and again when mobile/pnpm-lock.yaml changes:

pnpm -C mobile install --frozen-lockfile

Dev Profiles and Parallel Instances

pnpm dev in a linked Git worktree uses its own userData profile, renderer port, and remote debugging (CDP) port, so dev instances in different worktrees run side by side. The main checkout keeps the shared orca-dev profile. Ports are derived from the worktree path and move to the next free port when taken: renderer ports start at 15200 and CDP ports at 9333.

On startup the runner prints one stdout line and writes the same JSON to out/dev-instance.json:

ORCA_DEV_INSTANCE {"userData":".../orca-dev-wt/1d3830d4d3","profile":"worktree","rendererPort":15339,"rendererUrl":"http://localhost:15339","cdpPort":9513,"cdpUrl":"http://127.0.0.1:9513","repoRoot":"...","runnerPid":4242}
Option Effect
pnpm dev --shared-profile or ORCA_DEV_PROFILE=shared Use the shared orca-dev profile
pnpm dev --worktree-profile or ORCA_DEV_PROFILE=worktree Use a per-worktree profile, including in the main checkout
ORCA_DEV_USER_DATA_PATH=<dir> Use an explicit profile directory
REMOTE_DEBUGGING_PORT=<port>, ORCA_DEV_RENDERER_PORT=<port> Pin a port
pnpm dev --seed-profile[=<dir>] or ORCA_DEV_SEED_PROFILE=<dir or 1> Seed an empty profile on first launch

Per-worktree profiles live in orca-dev-wt/<hash> next to orca-dev (~/Library/Application Support on macOS, %APPDATA% on Windows, $XDG_CONFIG_HOME or ~/.config on Linux). The automatic storage cleanup removes them once their worktree is gone and nothing still runs from them. config/scripts/development/launch/orca-dev.mjs and the orca-dev terminal wrapper target the profile this checkout's pnpm dev used.

Seeding copies a slim set of state from another profile: projects, workspaces, settings, SSH targets, and the Orca account session. Terminal sessions, PTY leases, automations, caches, logs, and lock files are not copied, and the source profile is only read. The default source is orca-dev, or the installed app's profile when orca-dev is empty. Seed from orca-dev when you need the signed-in account session: dev builds cannot decrypt secrets the installed app encrypted.

pnpm dev:seed-profile [--from=<profile dir>] [--to=<profile dir>] [--reset]
pnpm dev:fresh [--keep] [--seed-from[=<profile dir>]]   # temporary profile, removed on exit

Tests and Dev Server Options

Use a test file or directory when you know the relevant suites. For dependency-based feedback, Vitest can select tests affected by your edits:

pnpm test:changed src/main/runtime --maxWorkers=2
pnpm test --changed=origin/main --maxWorkers=2
pnpm test src/shared/automations/scheduling/automation-cron-input-validation.test.ts --maxWorkers=2

test:changed considers staged, unstaged, and untracked files. --changed=origin/main also includes committed changes since the branch's merge base. Update that ref when you need a newer baseline. Both accept the same path filters and options as pnpm test. When Git reports no changed files at all, the launcher exits before starting Vitest.

Affected tests use Vitest's static import graph. Run suites explicitly for computed dynamic imports, fixture files, subprocess inputs, or other dependencies outside that graph. Local affected tests do not replace CI.

Use pnpm test, not raw vitest: only it keeps the transform cache that makes repeat runs fast.

Most unit files share a worker and its module cache with the files before them. After each file the worker undoes mocks, fake timers, stubs, env, cwd, and leftover timers, listeners, and globals. Files using vi.doMock, vi.resetModules, a DOM environment, or direct globalThis writes keep their own worker. If a file passes alone but fails after others, add // @orca-isolated-worker to it; ORCA_VITEST_ISOLATE_EVERY_FILE=1 isolates every file to confirm a leak.

To reduce main-process rebuild CPU and memory when you do not need its source maps, set ORCA_DEV_MAIN_SOURCEMAPS=0 before pnpm dev. In Bash/zsh:

ORCA_DEV_MAIN_SOURCEMAPS=0 pnpm dev

In PowerShell, use $env:ORCA_DEV_MAIN_SOURCEMAPS='0' before pnpm dev. Remove the variable when debugging the main process with source maps. Renderer and preload settings are unaffected; production builds always keep their hidden main maps.

pnpm dev serves the renderer with Vite's bundled dev mode: a few bundled chunks instead of thousands of module requests, so the first render and full reloads are faster. While a rebuild is pending, a newly opened pop-out, space, or web window may briefly get placeholder HTML. If the renderer misbehaves, set ORCA_DEV_BUNDLED=0 (PowerShell: $env:ORCA_DEV_BUNDLED='0') and report it.

Local installs use pnpm's global virtual store: each package version is one slot under ~/pnpm/store that every worktree links to, instead of a full node_modules per worktree. An existing worktree converts on its next pnpm install, and an older branch without the setting converts back the same way. CI always uses the normal layout. On Windows, pnpm links with junctions when you lack the symlink privilege, so no administrator rights or Developer Mode are needed. Things to know:

  • Keep ~/node_modules (and any other node_modules above the store) out of your home directory. Node resolves upward from the store slot, so a stray one there supplies dependencies the package never declared and hides missing-dependency bugs; pnpm install warns when it finds one.
  • Native addons are never rebuilt in place in a shared slot: each CPU gets its own build beside it (see native-build-entry.cjs), so cross-arch packaging is safe for other worktrees.
  • ORCA_PNPM_GLOBAL_VIRTUAL_STORE=0 opts out. Keep it set in your shell: pnpm run re-checks the install and relinks a worktree whose layout no longer matches.

Ordinary installs include native optional dependencies for the current OS and CPU only. Before a cross-architecture build (including pnpm build:mac, which produces both x64 and arm64 artifacts by default), run pnpm install:release to add the other CPU's variants.

Linux pnpm build, pnpm build:native, and Linux packaging require a running Docker daemon to build the clipboard helper against Ubuntu 20.04 rather than the host's newer libraries. A verified cached helper can be reused without Docker. For native Wayland development, run pnpm build:native before pnpm dev to make text copying available. See the clipboard build guide. macOS and Windows builds do not use this helper or require Docker for it.

Lint and Typecheck

pnpm lint runs independent checks in a bounded pool. Use pnpm lint --maxWorkers=2 --timings to limit concurrent checks and print their durations.

For repeated local typechecks, use pnpm tc (or pnpm tc:node, pnpm tc:web, and pnpm tc:cli). On Apple Silicon macOS and x64/arm64 Linux, these use the pinned tsrs compiler with incremental caches. Keep .cache/typecheck/ between checks; delete it to force a fresh check. Caches are separate for each project, compiler version, and worktree. At most two projects run together, subject to the memory budget. Windows, Intel macOS, and other unsupported platforms use pinned Bun automatically. Pass --compiler=bun to explicitly use Bun, or --compiler=native to use TypeScript. CI uses pnpm typecheck:ci, which explicitly selects Bun and its CI concurrency. Shared tests are checked by the Node project; shared production code is checked in all three environments. Run pnpm tc:node after editing shared tests, or pnpm tc to check everything.