mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-09 16:02:36 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The restart chaos harness (`tests/restart-chaos/`) restarts the control plane during real agent tasks and grades each task on rules R1–R6 > - One known product bug (RC-06) leaves a completed run "awaiting accounting". The company hard stop then refuses all new work, so one stuck row fails every later task in the wave > - That masks every other restart bug in the wave. Waves also had no record of what they spent > - This pull request adds an opt-in RC-06 mask, records wave spend, and lets a replay keep or add the mask > - The benefit is that chaos waves can find new restart bugs while RC-06 is open, and stay inside a known spend ## Linked Issues or Issue Description Refs #19477 (the Phase 1 harness this extends). **What existing behavior does this improve?** Restart chaos waves. One stuck accounting row (RC-06) hard-stops the isolated Chaos Lab company. All later tasks then rest blocked "over budget", and a Retry is refused with "Company cannot start work while completed runs await accounting". Two waves went 2/6 and 0/6 for this one reason. **Subsystem affected** Test harness only: `tests/restart-chaos/` (config, seed, scheduler, ledger, supervisor, main, README). **Current behavior** - No way to see past RC-06 without disabling the budget. - Wave spend is not recorded. - `--replay` rejected any mask flag, and it was not documented that the saved plan carries the mask. **Proposed behavior** - `--rc06-masked` keeps the budget amount and turns off only the hard stop on the isolated company. Masked tasks are labeled in the ledger and summary. - Each wave records its spend. - A replay keeps the source plan's masks and may add the RC-06 mask. ## What Changed - `--rc06-masked` (wave mode): after the company is created, the seed upserts the company budget policy with the same amount and `hardStopEnabled: false`. It writes `seed_mask_rc06` to the timeline. The plan stores `options.masks = ["rc06"]`. - The accounting gate in `budgets.ts` (`observedBlocks`) applies only when `hardStopEnabled` is true, so the mask lifts it. No product code changes. - Ledger lines carry `masks`. `SUMMARY.md` labels the cell and the latest-wave row `rc06-masked`. - Wave spend: before the sweep, `main.ts` reads `/api/companies/:id/costs/summary?period=all` (each wave owns its company), writes `wave_spend` to the timeline and prints it. If the wave stops early, cleanup records it once, best effort, before the server stops. - Load: #19513 already records `loadAvg1m` on each fault receipt. This branch first added the same value under another name, and the rebase removed it. The README now documents `loadAvg1m` and the load-suspect threshold. - Replay: `--replay <wave>/<task>` keeps the masks saved in the source `plan.json`. `--replay … --rc06-masked` adds the RC-06 mask. A replay never drops a mask. - README documents the flag, spend, load and the replay rule. - New unit tests: replay keeps saved masks and the replay flag adds the mask; the masked seed posts the company policy with the same amount and `hardStopEnabled: false` and records `seed_mask_rc06`, and an unmasked seed makes no policy call. ## Verification - `pnpm exec vitest run --config tests/restart-chaos/vitest.config.ts`: 71/71 pass (after rebase onto master with #19513). - `node scripts/typecheck-test-projects.mjs tests/restart-chaos`: pass. - Live: 4 masked local waves ran with this code (seeds 3307, 4409, 5501, 6619; Codex, ACPX Claude and OpenCode). - `seed_mask_rc06` appeared and no task was blocked by the accounting gate, even though `pendingRunCount` was 1–8 at wave end. - `wave_spend` was recorded each time (38¢–127¢ per wave). - The 1-minute load average was recorded on every fault (15–58). - Before the mask, the same harness gave 2/6 and 0/6, every failure RC-06. With the mask, the waves found other restart failures, all since fixed on master: RC-14, RC-16, RC-20 and RC-21. ## Risks - Low risk. Test harness only, and the mask is opt-in. - A masked wave has no product hard stop. The harness still records spend for each wave, and the operator must watch it. The mask applies only to the isolated, temporary Chaos Lab company. It never touches another instance. - Masked results do not count as RC-06 coverage. The ledger labels them so they are not mixed with unmasked cells. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, via Claude Code with tool use (shell, file edit). Extended reasoning on. ## 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
220 lines
6.8 KiB
TypeScript
220 lines
6.8 KiB
TypeScript
/** Shared types for the control-plane restart chaos harness (plan §5). */
|
||
|
||
export const FAULT_KINDS = ["K1", "K2", "K4", "K6"] as const;
|
||
export type FaultKind = (typeof FAULT_KINDS)[number];
|
||
|
||
export const WORKLOAD_IDS = ["A1", "B1", "B5", "C1"] as const;
|
||
export type WorkloadId = (typeof WORKLOAD_IDS)[number];
|
||
|
||
export const ADAPTER_IDS = ["codex", "claude", "opencode"] as const;
|
||
export type AdapterId = (typeof ADAPTER_IDS)[number];
|
||
|
||
export const TRIGGER_IDS = ["time", "comment", "retry", "queued", "tool"] as const;
|
||
export type TriggerId = (typeof TRIGGER_IDS)[number];
|
||
|
||
export const ENVIRONMENT_KINDS = ["local", "daytona"] as const;
|
||
export type EnvironmentKind = (typeof ENVIRONMENT_KINDS)[number];
|
||
|
||
export interface WaveOptions {
|
||
env: EnvironmentKind;
|
||
adapters: AdapterId[];
|
||
workloads: WorkloadId[];
|
||
faults: FaultKind[];
|
||
triggers?: TriggerId[];
|
||
concurrency: number;
|
||
tasks: number;
|
||
seed: number;
|
||
/** Company budget hard cap in cents; the product hard-stops at this value. */
|
||
budgetCents: number;
|
||
/** Poll interval for the observer, 2–5 s per plan §5. */
|
||
pollMs: number;
|
||
/** `--env daytona`: the immutable runner image (registry/repository@sha256:…). */
|
||
daytonaImage?: string;
|
||
/** `--env daytona`: vCPU per sandbox (see seed.ts chaosDaytonaShape). */
|
||
daytonaCpu?: number;
|
||
/**
|
||
* Known product signatures this wave deliberately masks. "rc06" keeps the
|
||
* company budget amount but disables its hard stop, so a stuck
|
||
* accounting row (RC-06) cannot wedge every later task. Spend is still
|
||
* recorded per wave. Absent on plans written before masks existed.
|
||
*/
|
||
masks?: string[];
|
||
}
|
||
|
||
export interface TaskPlan {
|
||
taskId: string;
|
||
index: number;
|
||
workload: WorkloadId;
|
||
adapter: AdapterId;
|
||
fault: FaultKind;
|
||
/** Fire the fault this long after the task's issue is created. */
|
||
fireAfterMs: number;
|
||
/** Outage hold between stop and restart. 0 for K1/K2. */
|
||
holdMs: number;
|
||
trigger?: TriggerId;
|
||
triggerDelayMs?: number;
|
||
/** C1 only: post the follow-up comment this long after creation. */
|
||
followUpAfterMs: number | null;
|
||
/** Unique marker used by the deterministic T-oracle. */
|
||
nonce: string;
|
||
/**
|
||
* Replay only: every fault that crossed this task in the source wave, with
|
||
* its offset from the task's launch. Replaces the single planned fault.
|
||
*/
|
||
replayFaults?: ScheduledFault[];
|
||
}
|
||
|
||
export interface ScheduledFault {
|
||
kind: FaultKind; holdMs: number;
|
||
atMs: number;
|
||
trigger?: TriggerId;
|
||
delayMs?: number;
|
||
}
|
||
|
||
export interface WavePlan {
|
||
schema: "paperclip.restart-chaos.wave-plan/v1";
|
||
waveId: string;
|
||
seed: number;
|
||
createdAt: string;
|
||
options: WaveOptions;
|
||
tasks: TaskPlan[];
|
||
/** Present when this wave replays one task of an earlier wave. */
|
||
replayOf?: { waveId: string; taskId: string };
|
||
}
|
||
|
||
export type Verdict = "pass" | "fail" | "n/a";
|
||
export interface RuleResult { verdict: Verdict; detail: string }
|
||
export type RuleId = "R1" | "R2" | "R3" | "R4" | "R5" | "R6";
|
||
|
||
export interface RunSample {
|
||
id: string;
|
||
status: string;
|
||
createdAt: string | null;
|
||
startedAt: string | null;
|
||
finishedAt: string | null;
|
||
errorCode: string | null;
|
||
retryOfRunId: string | null;
|
||
wakeCommentIds: string[];
|
||
livenessState: string | null;
|
||
lastEvidenceAt?: string | null;
|
||
}
|
||
|
||
export interface InterruptionSample {
|
||
state: string;
|
||
canRetry: boolean;
|
||
retryWait: boolean;
|
||
workspaceFailure: string | null;
|
||
observedRunId: string | null;
|
||
userAction: string | null;
|
||
}
|
||
|
||
/** One observer poll. Unreachable polls keep only the timestamp. */
|
||
export interface TaskSample {
|
||
at: number;
|
||
reachable: boolean;
|
||
serverReady: boolean;
|
||
issueStatus?: string;
|
||
interruption?: InterruptionSample | null;
|
||
activeRecoveryAction?: boolean;
|
||
/** Owner of the active recovery action; "board" means it waits on a person. */
|
||
recoveryOwner?: string | null;
|
||
executionBlocker?: boolean;
|
||
scheduledRetry?: boolean;
|
||
runs?: RunSample[];
|
||
}
|
||
|
||
export interface RetryAttempt {
|
||
at: number;
|
||
acceptedAt?: number;
|
||
observedRunId: string | null;
|
||
httpStatus: number | null;
|
||
accepted: boolean | null;
|
||
error: string | null;
|
||
}
|
||
|
||
export interface FaultReceipt {
|
||
faultId: string;
|
||
kind: FaultKind;
|
||
/** Task that scheduled the fault; every other running task is also exposed. */
|
||
requestedBy: string;
|
||
signal: "SIGKILL" | "SIGTERM";
|
||
holdMs: number;
|
||
requestedAt: number;
|
||
startedAt: number;
|
||
stoppedAt: number | null;
|
||
restartedAt: number | null;
|
||
healthyAt: number | null;
|
||
readyAt: number | null;
|
||
phases: Array<{ phase: string; at: number }>;
|
||
trigger?: TriggerId;
|
||
triggerDelayMs?: number;
|
||
loadAvg1m?: number;
|
||
crashLoop?: Array<{ pid: number | null; target: string; phase: string; at: number }>;
|
||
serverLogOffsetAtStart: number;
|
||
serverLogOffsetAtReady: number | null;
|
||
error: string | null;
|
||
}
|
||
|
||
export interface OracleArtifacts {
|
||
issueStatus: string | null;
|
||
documents: Record<string, string | null>;
|
||
agentComments: string[];
|
||
files: Record<string, string | null>;
|
||
commands: Record<string, { exitCode: number | null; stdout: string; stderr: string }>;
|
||
workspacePath: string | null;
|
||
/** B5: distinct `.bench/progress` values the harness itself saw while the task was live. */
|
||
benchProgressObserved?: number;
|
||
}
|
||
|
||
export interface OracleResult { verdict: Exclude<Verdict, "n/a">; checks: Array<{ name: string; ok: boolean; detail?: string }> }
|
||
|
||
export interface RestSweep {
|
||
activeRuns: string[];
|
||
runningWorkspaceOperations: string[];
|
||
activeRecoveryAction: boolean;
|
||
/** `--env daytona`: orphaned sandboxes and held leases belonging to this task's runs. */
|
||
daytonaLeaks?: string[];
|
||
error: string | null;
|
||
}
|
||
|
||
export interface TaskRecord {
|
||
plan: TaskPlan;
|
||
issueId: string | null;
|
||
identifier: string | null;
|
||
createdAt: number | null;
|
||
launchError: string | null;
|
||
samples: TaskSample[];
|
||
retry: RetryAttempt | null;
|
||
restAt: number | null;
|
||
finalStatus: string | null;
|
||
deadlineAt: number | null;
|
||
timedOut: boolean;
|
||
followUp: { at: number; postedAt?: number; commentId: string | null; error: string | null; duringRun?: boolean } | null;
|
||
faultIds: string[];
|
||
sweep: RestSweep | null;
|
||
/** Workspace files present just before the first fault that hit this task (R2). */
|
||
preFaultFiles: string[] | null;
|
||
preFaultWorkspacePath?: string;
|
||
lastFaultAt?: number;
|
||
restSnapshotError?: string;
|
||
priorRetries?: RetryAttempt[];
|
||
workspaceMovedTo?: string;
|
||
/** Set when the pre-fault snapshot could not read the workspace; R2 then fails visibly. */
|
||
preFaultSnapshotError?: string | null;
|
||
/** Pre-fault files missing at rest; null when not checked. */
|
||
lostFiles: string[] | null;
|
||
/** B5: distinct bench progress values the observer read during polling. */
|
||
benchProgressSeen?: string[];
|
||
benchFirstSeenAt?: number | null;
|
||
triggerMissed?: TriggerId[];
|
||
}
|
||
|
||
export interface TaskGrade {
|
||
crossed: boolean;
|
||
crossingFaults: string[];
|
||
rules: Record<RuleId, RuleResult>;
|
||
T: OracleResult;
|
||
pass: boolean;
|
||
signature: string | null;
|
||
}
|