mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-13 13:38:01 +02:00
## Thinking Path > - Paperclip manages agents that use different model providers and adapters. > - Paperclip must keep agent execution rules clear and predictable. > - The cheap-model profile added a second execution mode across adapters, task recovery, APIs, and the UI. > - That mode increased configuration and recovery complexity. > - This pull request removes the cheap-model profile as a product feature. > - The benefit is one model-selection path for normal work and recovery work. ## Linked Issues or Issue Description **What existing behavior does this improve?** This change simplifies model selection across agent configuration, task execution, recovery, and adapter capabilities. **Current behavior** Paperclip exposes cheap-model profiles in adapter metadata, agent runtime configuration, task overrides, recovery rules, APIs, and the board UI. Recovery work can select a different model profile from the agent's configured model. **Proposed behavior** Paperclip uses the agent's configured model for normal work and recovery work. Status-only recovery stays limited to coordination work. The API rejects legacy model-profile configuration. A migration removes stored model-profile values from existing agent, issue, and historical revision records. **Reason and benefit** One model path reduces configuration, API, UI, and recovery complexity. It also prevents status recovery from becoming a separate product-level model-routing feature. **Breaking changes** This change removes model-profile fields and adapter capability metadata. Existing stored model-profile values are removed by an idempotent migration. The validators reject new legacy profile values with clear errors. ## What Changed - Removed model-profile types, adapter capabilities, API fields, and model selection logic. - Removed cheap-model controls from agent and task UI surfaces. - Kept status-only recovery limited to coordination context while normal continuations use the configured agent model. - Added an idempotent migration that removes stored model-profile values from agents, issues, and configuration revisions without changing issue update timestamps. - Updated tests and product documentation for the single-model behavior. ## Verification - `pnpm check:token-gates` passes. - `pnpm -r typecheck` passes. - `pnpm build` passes. - `pnpm test:run` completed with 5,607 passing tests and 8 environment-sensitive failures in unrelated fixed-port and database-deadlock suites. The same failures repeated in an isolated rerun. CI is the final clean-room result. ## Risks - This is an intentional breaking change for clients that send model-profile fields. - The migration changes legacy agent, issue, and configuration-revision JSON. It is idempotent and preserves unrelated fields and issue update timestamps. - The change is cross-cutting because the removed feature existed in adapters, shared contracts, the server, plugins, and the UI. > 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`. Reasoning and tool use were enabled. The runtime did not expose the 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) - [ ] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [ ] 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>
177 lines
4.3 KiB
TypeScript
177 lines
4.3 KiB
TypeScript
// @vitest-environment node
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
import type { Agent } from "@paperclipai/shared";
|
|
import { buildAgentUpdatePatch, type AgentConfigOverlay } from "./agent-config-patch";
|
|
|
|
function makeAgent(): Agent {
|
|
return {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Agent",
|
|
role: "engineer",
|
|
title: "Engineer",
|
|
icon: null,
|
|
status: "active",
|
|
reportsTo: null,
|
|
capabilities: null,
|
|
adapterType: "claude_local",
|
|
adapterConfig: {
|
|
model: "claude-sonnet-4-6",
|
|
env: {
|
|
OPENAI_API_KEY: {
|
|
type: "plain",
|
|
value: "secret",
|
|
},
|
|
},
|
|
promptTemplate: "Work the issue.",
|
|
},
|
|
runtimeConfig: {
|
|
heartbeat: {
|
|
enabled: true,
|
|
intervalSec: 300,
|
|
},
|
|
},
|
|
budgetMonthlyCents: 0,
|
|
spentMonthlyCents: 0,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
lastHeartbeatAt: null,
|
|
createdAt: new Date("2026-01-01T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-01-01T00:00:00.000Z"),
|
|
urlKey: "agent",
|
|
permissions: {
|
|
canCreateAgents: false,
|
|
},
|
|
metadata: null,
|
|
};
|
|
}
|
|
|
|
function makeOverlay(patch?: Partial<AgentConfigOverlay>): AgentConfigOverlay {
|
|
return {
|
|
identity: {},
|
|
adapterConfig: {},
|
|
heartbeat: {},
|
|
debug: {},
|
|
runtime: {},
|
|
...patch,
|
|
};
|
|
}
|
|
|
|
describe("buildAgentUpdatePatch", () => {
|
|
it("merges the agent-scoped provider trace debug setting into runtime config", () => {
|
|
const patch = buildAgentUpdatePatch(
|
|
makeAgent(),
|
|
makeOverlay({ debug: { providerTrace: "raw" } }),
|
|
);
|
|
|
|
expect(patch).toMatchObject({
|
|
runtimeConfig: {
|
|
heartbeat: { enabled: true, intervalSec: 300 },
|
|
debug: { providerTrace: "raw" },
|
|
},
|
|
});
|
|
});
|
|
|
|
it("replaces adapter config and drops env when the last env binding is cleared", () => {
|
|
const patch = buildAgentUpdatePatch(
|
|
makeAgent(),
|
|
makeOverlay({
|
|
adapterConfig: {
|
|
env: undefined,
|
|
},
|
|
}),
|
|
);
|
|
|
|
expect(patch).toEqual({
|
|
adapterConfig: {
|
|
model: "claude-sonnet-4-6",
|
|
promptTemplate: "Work the issue.",
|
|
},
|
|
replaceAdapterConfig: true,
|
|
});
|
|
});
|
|
|
|
it("writes max-turn continuation policy under runtimeConfig.heartbeat", () => {
|
|
const patch = buildAgentUpdatePatch(
|
|
makeAgent(),
|
|
makeOverlay({
|
|
heartbeat: {
|
|
maxTurnContinuation: {
|
|
enabled: true,
|
|
maxAttempts: 3,
|
|
delayMs: 1000,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
expect(patch).toEqual({
|
|
runtimeConfig: {
|
|
heartbeat: {
|
|
enabled: true,
|
|
intervalSec: 300,
|
|
maxTurnContinuation: {
|
|
enabled: true,
|
|
maxAttempts: 3,
|
|
delayMs: 1000,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
it("preserves adapter-agnostic keys when changing adapter types", () => {
|
|
const patch = buildAgentUpdatePatch(
|
|
makeAgent(),
|
|
makeOverlay({
|
|
adapterType: "codex_local",
|
|
adapterConfig: {
|
|
model: "gpt-5.4",
|
|
dangerouslyBypassApprovalsAndSandbox: true,
|
|
},
|
|
}),
|
|
);
|
|
|
|
expect(patch).toEqual({
|
|
adapterType: "codex_local",
|
|
adapterConfig: {
|
|
env: {
|
|
OPENAI_API_KEY: {
|
|
type: "plain",
|
|
value: "secret",
|
|
},
|
|
},
|
|
promptTemplate: "Work the issue.",
|
|
model: "gpt-5.4",
|
|
dangerouslyBypassApprovalsAndSandbox: true,
|
|
},
|
|
replaceAdapterConfig: true,
|
|
});
|
|
});
|
|
|
|
it("preserves paperclip skill-sync selections when changing adapter types", () => {
|
|
// Desired skills are adapter-agnostic (company-level selections) but are
|
|
// persisted inside the per-adapter config under `paperclipSkillSync`. A
|
|
// patch that switches adapters must carry them over instead of wiping the
|
|
// agent's skills.
|
|
const agent = makeAgent();
|
|
agent.adapterConfig = {
|
|
...agent.adapterConfig,
|
|
paperclipSkillSync: { desiredSkills: ["research", "code-review"] },
|
|
};
|
|
|
|
const patch = buildAgentUpdatePatch(
|
|
agent,
|
|
makeOverlay({
|
|
adapterType: "codex_local",
|
|
adapterConfig: { model: "gpt-5.4" },
|
|
}),
|
|
);
|
|
|
|
expect((patch.adapterConfig as Record<string, unknown>).paperclipSkillSync).toEqual({
|
|
desiredSkills: ["research", "code-review"],
|
|
});
|
|
});
|
|
});
|