2026-04-09 17:50:14 +00:00
|
|
|
// @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: {},
|
|
|
|
|
runtime: {},
|
|
|
|
|
...patch,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
describe("buildAgentUpdatePatch", () => {
|
|
|
|
|
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,
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
Add cheap model profiles for local adapters (#4881)
## Thinking Path
> - Paperclip is a control plane for autonomous AI companies, where
adapters are the boundary between the board, agents, and execution
runtimes.
> - Local adapters currently expose a primary runtime configuration, but
operators often need a cheaper model lane for routine or low-risk work.
> - That cheap lane has to stay adapter-owned: runtime profile settings
should not mutate the primary adapter config or bypass existing
auth/secret mediation.
> - Issue creation also needs an ergonomic way to request primary,
cheap, or custom model behavior for a selected assignee.
> - This pull request adds a first-class `cheap` model profile contract
across adapter capabilities, heartbeat config resolution, agent
configuration, and issue creation.
> - The benefit is cheaper task execution can be configured and
requested explicitly while preserving adapter boundaries, secret
handling, and audit visibility.
## What Changed
- Added adapter model-profile capability metadata and a `cheap` profile
contract for supported local adapters.
- Applied `runtimeConfig.modelProfiles.cheap.adapterConfig` during
heartbeat config resolution, including requested/applied/fallback run
metadata.
- Added agent configuration UI for cheap model profile settings without
writing those settings into primary `adapterConfig`.
- Added New Issue assignee model lane controls for Primary / Cheap /
Custom and request payload handling.
- Added run ledger profile badges and Storybook stories for the new
cheap-lane UI states.
- Added tests for validators, heartbeat model profile application,
permission/secret mediation, UI payload helpers, and run ledger
rendering.
- Added committed UI verification screenshots under
`docs/pr-screenshots/pap-2837/`.
- Addressed Greptile review feedback around cheap-profile defaults,
shared profile types, and fallback test data.
## Verification
Local:
- `pnpm exec vitest run packages/shared/src/validators/issue.test.ts
server/src/__tests__/adapter-registry.test.ts
server/src/__tests__/agent-permissions-routes.test.ts
server/src/__tests__/heartbeat-model-profile.test.ts
ui/src/components/IssueRunLedger.test.tsx
ui/src/lib/agent-config-patch.test.ts
ui/src/lib/issue-assignee-overrides.test.ts
ui/src/lib/new-agent-runtime-config.test.ts` — passed, 8 files / 103
tests.
- `pnpm exec vitest run ui/src/lib/new-agent-runtime-config.test.ts
ui/src/components/IssueRunLedger.test.tsx` — passed after
Greptile/rebase follow-up, 2 files / 17 tests.
- `pnpm --filter @paperclipai/ui typecheck` — passed after
Greptile/rebase follow-up.
- `pnpm -r typecheck` — passed.
- `pnpm build` — passed.
- `pnpm test:run` — did not complete successfully in this local
worktree: it stopped in pre-existing `@paperclipai/adapter-utils`
sandbox/SSH fixture suites outside this PR diff. Failures were 5s local
timeouts plus `git init -b` unsupported by this machine's Git 2.21.0.
The branch-specific targeted suites above passed.
- Branch was fetched/rebased onto `public-gh/master`; `git rev-list
--left-right --count public-gh/master...HEAD` reports `0 9`.
Remote PR checks on latest head
`e30bf399146451c86cee98ed528d51d33fa5af5a`:
- `policy` — passed.
- `verify` — passed.
- `e2e` — passed.
- `Greptile Review` — passed, confidence score 5/5; Greptile review
threads resolved.
- `security/snyk (cryppadotta)` — passed.
Screenshots:
- [New issue cheap lane
desktop](https://github.com/paperclipai/paperclip/blob/PAP-2837-plan-cheap-model-for-adapters-that-can-support-it/docs/pr-screenshots/pap-2837/newissue-cheap-desktop.png)
- [New issue custom lane
desktop](https://github.com/paperclipai/paperclip/blob/PAP-2837-plan-cheap-model-for-adapters-that-can-support-it/docs/pr-screenshots/pap-2837/newissue-custom-desktop.png)
- [New issue unsupported adapter
desktop](https://github.com/paperclipai/paperclip/blob/PAP-2837-plan-cheap-model-for-adapters-that-can-support-it/docs/pr-screenshots/pap-2837/newissue-unsupported-desktop.png)
- [Run ledger model profile badges
desktop](https://github.com/paperclipai/paperclip/blob/PAP-2837-plan-cheap-model-for-adapters-that-can-support-it/docs/pr-screenshots/pap-2837/runledger-profile-badges-desktop.png)
- Mobile variants are also in `docs/pr-screenshots/pap-2837/`.
## Risks
- Medium: heartbeat config mediation now merges runtime model profiles
into adapter configs, so adapter secret normalization and host-command
restrictions must keep covering nested config paths.
- Medium: the UI adds another issue creation choice; unsupported
adapters must keep hiding the cheap lane and preserve primary behavior.
- Low migration risk: no database migration is included.
> 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 coding agent using GPT-5-class reasoning with repo tool use
and command execution. Exact served model/context window was not exposed
by the runtime.
## 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
- [ ] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
2026-04-30 15:32:04 -05:00
|
|
|
it("writes the cheap profile under runtimeConfig.modelProfiles, never on primary adapterConfig", () => {
|
|
|
|
|
const patch = buildAgentUpdatePatch(
|
|
|
|
|
makeAgent(),
|
|
|
|
|
makeOverlay({
|
|
|
|
|
modelProfiles: {
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
adapterConfig: { model: "claude-haiku-4-5" },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(patch).toEqual({
|
|
|
|
|
runtimeConfig: {
|
|
|
|
|
heartbeat: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
intervalSec: 300,
|
|
|
|
|
},
|
|
|
|
|
modelProfiles: {
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
adapterConfig: { model: "claude-haiku-4-5" },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
// The primary adapterConfig is untouched.
|
|
|
|
|
expect(patch.adapterConfig).toBeUndefined();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("merges cheap profile changes onto existing runtimeConfig.modelProfiles state", () => {
|
|
|
|
|
const agent = makeAgent();
|
|
|
|
|
agent.runtimeConfig = {
|
|
|
|
|
heartbeat: { enabled: true, intervalSec: 300 },
|
|
|
|
|
modelProfiles: {
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: false,
|
|
|
|
|
adapterConfig: { model: "old-cheap" },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const patch = buildAgentUpdatePatch(
|
|
|
|
|
agent,
|
|
|
|
|
makeOverlay({
|
|
|
|
|
modelProfiles: {
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect((patch.runtimeConfig as Record<string, unknown>).modelProfiles).toEqual({
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
adapterConfig: { model: "old-cheap" },
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("clears the cheap profile when the overlay marks it cleared", () => {
|
|
|
|
|
const agent = makeAgent();
|
|
|
|
|
agent.runtimeConfig = {
|
|
|
|
|
heartbeat: { enabled: true, intervalSec: 300 },
|
|
|
|
|
modelProfiles: {
|
|
|
|
|
cheap: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
adapterConfig: { model: "claude-haiku-4-5" },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const patch = buildAgentUpdatePatch(
|
|
|
|
|
agent,
|
|
|
|
|
makeOverlay({
|
|
|
|
|
modelProfiles: { cheap: { cleared: true } },
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(patch.runtimeConfig).toEqual({
|
|
|
|
|
heartbeat: { enabled: true, intervalSec: 300 },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2026-04-09 17:50:14 +00:00
|
|
|
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,
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
});
|