mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 16:35:27 +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>
176 lines
9.4 KiB
TypeScript
176 lines
9.4 KiB
TypeScript
import { mkdtemp, rm, writeFile } from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { tmpdir } from "node:os";
|
|
import { Command } from "commander";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { registerAdapterCommands } from "../commands/client/adapter.js";
|
|
import { registerAssetCommands } from "../commands/client/asset.js";
|
|
import { registerCompanyCommands, resolveExportOutputPath } from "../commands/client/company.js";
|
|
import { registerSkillCommands } from "../commands/client/skill.js";
|
|
|
|
const COMPANY_ID = "22222222-2222-4222-8222-222222222222";
|
|
const SKILL_ID = "33333333-3333-4333-8333-333333333333";
|
|
const ASSET_ID = "44444444-4444-4444-8444-444444444444";
|
|
|
|
function createProgram(): Command {
|
|
const program = new Command();
|
|
program.exitOverride();
|
|
program.configureOutput({ writeOut: () => {}, writeErr: () => {} });
|
|
registerCompanyCommands(program);
|
|
registerAdapterCommands(program);
|
|
registerAssetCommands(program);
|
|
registerSkillCommands(program);
|
|
return program;
|
|
}
|
|
|
|
async function run(args: string[]): Promise<void> {
|
|
await createProgram().parseAsync([
|
|
...args,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
}
|
|
|
|
describe("admin, asset, and skill parity commands", () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
vi.restoreAllMocks();
|
|
delete process.env.PAPERCLIP_API_KEY;
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
vi.spyOn(process.stdout, "write").mockImplementation(() => true);
|
|
tempDir = await mkdtemp(path.join(tmpdir(), "paperclip-cli-parity-"));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
vi.restoreAllMocks();
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it("wraps company management and raw portability endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["company", "stats"]);
|
|
await run(["company", "create", "--payload-json", "{}"]);
|
|
await run(["company", "update", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["company", "branding:update", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["company", "archive", COMPANY_ID]);
|
|
await run(["company", "export:preview", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["company", "export:api", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["company", "import:preview", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["company", "import:apply", COMPANY_ID, "--payload-json", "{}"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["GET", "http://localhost:3100/api/companies/stats"],
|
|
["POST", "http://localhost:3100/api/companies"],
|
|
["PATCH", `http://localhost:3100/api/companies/${COMPANY_ID}`],
|
|
["PATCH", `http://localhost:3100/api/companies/${COMPANY_ID}/branding`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/archive`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/exports/preview`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/exports`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/imports/preview`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/imports/apply`],
|
|
]);
|
|
});
|
|
|
|
it("wraps adapter management and company adapter endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["adapter", "list"]);
|
|
await run(["adapter", "install", "--payload-json", "{\"packageName\":\"adapter\"}"]);
|
|
await run(["adapter", "get", "codex_local"]);
|
|
await run(["adapter", "get", "codex/local"]);
|
|
await run(["adapter", "update", "codex_local", "--payload-json", "{\"disabled\":true}"]);
|
|
await run(["adapter", "override", "codex_local", "--payload-json", "{\"paused\":true}"]);
|
|
await run(["adapter", "reload", "codex_local"]);
|
|
await run(["adapter", "reinstall", "codex_local"]);
|
|
await run(["adapter", "config-schema", "codex_local"]);
|
|
await run(["adapter", "ui-parser", "codex_local"]);
|
|
await run(["adapter", "models", "codex_local", "--company-id", COMPANY_ID, "--refresh", "--environment-id", "env-1"]);
|
|
await run(["adapter", "detect-model", "codex_local", "--company-id", COMPANY_ID]);
|
|
await run(["adapter", "test-environment", "codex_local", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["adapter", "delete", "codex_local"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["GET", "http://localhost:3100/api/adapters"],
|
|
["POST", "http://localhost:3100/api/adapters/install"],
|
|
["GET", "http://localhost:3100/api/adapters/codex_local"],
|
|
["GET", "http://localhost:3100/api/adapters/codex%2Flocal"],
|
|
["PATCH", "http://localhost:3100/api/adapters/codex_local"],
|
|
["PATCH", "http://localhost:3100/api/adapters/codex_local/override"],
|
|
["POST", "http://localhost:3100/api/adapters/codex_local/reload"],
|
|
["POST", "http://localhost:3100/api/adapters/codex_local/reinstall"],
|
|
["GET", "http://localhost:3100/api/adapters/codex_local/config-schema"],
|
|
["GET", "http://localhost:3100/api/adapters/codex_local/ui-parser.js"],
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/adapters/codex_local/models?refresh=true&environmentId=env-1`],
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/adapters/codex_local/detect-model`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/adapters/codex_local/test-environment`],
|
|
["DELETE", "http://localhost:3100/api/adapters/codex_local"],
|
|
]);
|
|
});
|
|
|
|
it("wraps asset upload/download endpoints", async () => {
|
|
const imagePath = path.join(tempDir, "logo.png");
|
|
const outputPath = path.join(tempDir, "asset.bin");
|
|
await writeFile(imagePath, Buffer.from("png"));
|
|
const fetchMock = vi
|
|
.fn()
|
|
.mockImplementationOnce(() => Promise.resolve(jsonResponse({ assetId: ASSET_ID }, { status: 201 })))
|
|
.mockImplementationOnce(() => Promise.resolve(jsonResponse({ assetId: ASSET_ID }, { status: 201 })))
|
|
.mockImplementationOnce(() => Promise.resolve(new Response("asset-bytes")));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["asset", "image:upload", "--company-id", COMPANY_ID, "--file", imagePath, "--namespace", "docs", "--alt", "Logo"]);
|
|
await run(["asset", "logo:upload", "--company-id", COMPANY_ID, "--file", imagePath]);
|
|
await run(["asset", "content", ASSET_ID, "--out", outputPath]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/assets/images`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/logo`],
|
|
["GET", `http://localhost:3100/api/assets/${ASSET_ID}/content`],
|
|
]);
|
|
const firstUpload = fetchMock.mock.calls[0]?.[1]?.body as FormData;
|
|
expect((firstUpload.get("file") as File).type).toBe("image/png");
|
|
});
|
|
|
|
it("rejects portable export paths outside the output directory", async () => {
|
|
expect(() => resolveExportOutputPath(tempDir, "../outside.md")).toThrow("outside output directory");
|
|
});
|
|
|
|
it("wraps company skill endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["skill", "list", "--company-id", COMPANY_ID]);
|
|
await run(["skill", "get", SKILL_ID, "--company-id", COMPANY_ID]);
|
|
await run(["skill", "file", SKILL_ID, "--company-id", COMPANY_ID, "--path", "SKILL.md"]);
|
|
await run(["skill", "create", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["skill", "file:update", SKILL_ID, "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["skill", "import", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["skill", "scan-projects", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["skill", "update-status", SKILL_ID, "--company-id", COMPANY_ID]);
|
|
await run(["skill", "install-update", SKILL_ID, "--company-id", COMPANY_ID]);
|
|
await run(["skill", "delete", SKILL_ID, "--company-id", COMPANY_ID]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/skills`],
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}`],
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}/files?path=SKILL.md`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/skills`],
|
|
["PATCH", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}/files`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/import`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/scan-projects`],
|
|
["GET", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}/update-status`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}/install-update`],
|
|
["DELETE", `http://localhost:3100/api/companies/${COMPANY_ID}/skills/${SKILL_ID}`],
|
|
]);
|
|
});
|
|
});
|
|
|
|
function jsonResponse(body: unknown = { ok: true }, init: ResponseInit = { status: 200 }): Response {
|
|
return new Response(JSON.stringify(body), init);
|
|
}
|