Files
paperclip/scripts/dev-runner-options.ts
DottaandPaperclip 6524d2b67f fix(dev): honor --data-dir isolation (#12193)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The development runner starts the local API, UI, and embedded
PostgreSQL services.
> - Developers need separate data roots when they run more than one
local checkout.
> - The runner forwarded `--data-dir` to a child process that did not
use it.
> - The migration check and server therefore continued to use the
default Paperclip home.
> - This pull request applies the data root before worktree setup and
migration checks.
> - The benefit is an isolated database and state root for each
requested development run.

## Linked Issues or Issue Description

Refs #7466

## What Changed

- Parse and consume `--data-dir`, `--data-dir=<path>`, and `-d` in the
development runner.
- Set isolated default home, config, and context paths before worktree
setup and migration checks.
- Keep explicit config and context paths unchanged.
- Include the normalized data root in the local service identity.
- Let `dev:list` and `dev:stop` select the matching isolated service
registry.
- Keep explicit option environments independent of ambient process
instance values.
- Add regression tests and development documentation.

## Verification

- `PAPERCLIP_INSTANCE_ID=ambient-test-instance pnpm exec vitest run
server/src/__tests__/dev-runner-options.test.ts` passes with 8 tests.
- `pnpm --filter @paperclipai/server typecheck` passes.
- `pnpm --filter @paperclipai/adapter-utils build` passes.
- `pnpm -r typecheck` passes.
- `pnpm build` passes.
- `pnpm dev:list --data-dir ./tmp/dev-service-review-fixture` selects
the isolated registry.
- A live run of `pnpm dev --data-dir ./tmp/data-dir-pr-smoke` became
healthy on port 3101 while another checkout used port 3100.
- The live run used `./tmp/data-dir-pr-smoke/instances/default/db` on a
separate PostgreSQL port.
- The latest-head Linux CI matrix passes, including build, typecheck,
canary, all general and serialized test shards, and all e2e shards.
- `pnpm test:run` was attempted on macOS. Current `master` has unrelated
workspace path failures because `/tmp` resolves to `/private/tmp`. The
focused regression suite passes, and the full Linux matrix is green.

## Risks

- Risk is low. The change only affects development runs that pass
`--data-dir` and matching service-management commands.
- Explicit `PAPERCLIP_CONFIG` and `PAPERCLIP_CONTEXT` values still take
priority.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- OpenAI Codex with `gpt-5.6-sol` produced this change. The run used
tool-enabled reasoning and code execution. The runtime did not expose
its context window size.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-08-26 09:08:31 -05:00

75 lines
2.0 KiB
TypeScript

import path from "node:path";
import {
DEFAULT_PAPERCLIP_INSTANCE_ID,
expandHomePrefix,
resolvePaperclipConfigPathForInstance,
resolvePaperclipInstanceId,
} from "../packages/shared/src/home-paths.ts";
export interface AppliedDevRunnerOptions {
forwardedArgs: string[];
dataDir: string | null;
}
function requireOptionValue(
args: string[],
index: number,
option: string,
): string {
const value = args[index + 1]?.trim();
if (!value || value.startsWith("-")) {
throw new Error(`${option} requires a value`);
}
return value;
}
export function applyDevRunnerOptions(
args: string[],
env: NodeJS.ProcessEnv = process.env,
cwd: string = process.cwd(),
): AppliedDevRunnerOptions {
const forwardedArgs: string[] = [];
let dataDirRaw: string | null = null;
for (let index = 0; index < args.length; index += 1) {
const arg = args[index];
if (arg === "--data-dir" || arg === "-d") {
dataDirRaw = requireOptionValue(args, index, arg);
index += 1;
continue;
}
if (arg.startsWith("--data-dir=")) {
const value = arg.slice("--data-dir=".length).trim();
if (!value) throw new Error("--data-dir requires a value");
dataDirRaw = value;
continue;
}
forwardedArgs.push(arg);
}
if (!dataDirRaw) {
return { forwardedArgs, dataDir: null };
}
const dataDir = path.resolve(cwd, expandHomePrefix(dataDirRaw));
const hasExplicitConfig = Boolean(env.PAPERCLIP_CONFIG?.trim());
const hasExplicitContext = Boolean(env.PAPERCLIP_CONTEXT?.trim());
env.PAPERCLIP_HOME = dataDir;
if (!hasExplicitConfig) {
const instanceId = resolvePaperclipInstanceId(
env.PAPERCLIP_INSTANCE_ID ?? DEFAULT_PAPERCLIP_INSTANCE_ID,
);
env.PAPERCLIP_INSTANCE_ID = instanceId;
env.PAPERCLIP_CONFIG = resolvePaperclipConfigPathForInstance({
homeDir: dataDir,
instanceId,
});
}
if (!hasExplicitContext) {
env.PAPERCLIP_CONTEXT = path.resolve(dataDir, "context.json");
}
return { forwardedArgs, dataDir };
}