mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 02:40:39 +09:00
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>
This commit is contained in:
Dotta
GitHub
parent
1fe1067361
commit
a3de1d764d
60 changed files with 2216 additions and 151 deletions
|
|
@ -8,11 +8,13 @@ import type { Db } from "@paperclipai/db";
|
|||
import {
|
||||
AGENT_DEFAULT_MAX_CONCURRENT_RUNS,
|
||||
ISSUE_CONTINUATION_SUMMARY_DOCUMENT_KEY,
|
||||
MODEL_PROFILE_KEYS,
|
||||
isEnvironmentDriverSupportedForAdapter,
|
||||
type BillingType,
|
||||
type EnvironmentLeaseStatus,
|
||||
type ExecutionWorkspace,
|
||||
type ExecutionWorkspaceConfig,
|
||||
type ModelProfileKey,
|
||||
type RunLivenessState,
|
||||
} from "@paperclipai/shared";
|
||||
import {
|
||||
|
|
@ -38,8 +40,14 @@ import { conflict, HttpError, notFound } from "../errors.js";
|
|||
import { logger } from "../middleware/logger.js";
|
||||
import { publishLiveEvent } from "./live-events.js";
|
||||
import { getRunLogStore, type RunLogHandle } from "./run-log-store.js";
|
||||
import { getServerAdapter, runningProcesses } from "../adapters/index.js";
|
||||
import type { AdapterExecutionResult, AdapterInvocationMeta, AdapterSessionCodec, UsageSummary } from "../adapters/index.js";
|
||||
import { getServerAdapter, listAdapterModelProfiles, runningProcesses } from "../adapters/index.js";
|
||||
import type {
|
||||
AdapterExecutionResult,
|
||||
AdapterInvocationMeta,
|
||||
AdapterModelProfileDefinition,
|
||||
AdapterSessionCodec,
|
||||
UsageSummary,
|
||||
} from "../adapters/index.js";
|
||||
import { createLocalAgentJwt } from "../agent-auth-jwt.js";
|
||||
import { parseObject, asBoolean, asNumber, appendWithByteCap, MAX_EXCERPT_BYTES } from "../adapters/utils.js";
|
||||
import { costService } from "./costs.js";
|
||||
|
|
@ -879,10 +887,23 @@ type SessionCompactionDecision = {
|
|||
};
|
||||
|
||||
interface ParsedIssueAssigneeAdapterOverrides {
|
||||
modelProfile: ModelProfileKey | null;
|
||||
adapterConfig: Record<string, unknown> | null;
|
||||
useProjectWorkspace: boolean | null;
|
||||
}
|
||||
|
||||
type ModelProfileRequestSource = "issue_override" | "wake_context";
|
||||
type AppliedModelProfileConfigSource = "agent_runtime" | "adapter_default";
|
||||
|
||||
export interface ModelProfileApplication {
|
||||
requested: ModelProfileKey | null;
|
||||
requestedBy: ModelProfileRequestSource | null;
|
||||
applied: ModelProfileKey | null;
|
||||
configSource: AppliedModelProfileConfigSource | null;
|
||||
fallbackReason: string | null;
|
||||
adapterConfig: Record<string, unknown> | null;
|
||||
}
|
||||
|
||||
export type ResolvedWorkspaceForRun = {
|
||||
cwd: string;
|
||||
source: "project_primary" | "task_session" | "agent_home";
|
||||
|
|
@ -917,6 +938,147 @@ function readNonEmptyString(value: unknown): string | null {
|
|||
return typeof value === "string" && value.trim().length > 0 ? value : null;
|
||||
}
|
||||
|
||||
function readModelProfileKey(value: unknown): ModelProfileKey | null {
|
||||
return MODEL_PROFILE_KEYS.includes(value as ModelProfileKey)
|
||||
? (value as ModelProfileKey)
|
||||
: null;
|
||||
}
|
||||
|
||||
function readContextModelProfile(
|
||||
contextSnapshot: Record<string, unknown> | null | undefined,
|
||||
): ModelProfileKey | null {
|
||||
return readModelProfileKey(contextSnapshot?.modelProfile);
|
||||
}
|
||||
|
||||
export function normalizeModelProfileWakeContext(input: {
|
||||
contextSnapshot: Record<string, unknown>;
|
||||
payload: Record<string, unknown> | null | undefined;
|
||||
}): Record<string, unknown> {
|
||||
const modelProfileFromPayload = readModelProfileKey(input.payload?.modelProfile);
|
||||
if (!readContextModelProfile(input.contextSnapshot) && modelProfileFromPayload) {
|
||||
input.contextSnapshot.modelProfile = modelProfileFromPayload;
|
||||
}
|
||||
return input.contextSnapshot;
|
||||
}
|
||||
|
||||
function readAgentRuntimeModelProfile(
|
||||
runtimeConfig: unknown,
|
||||
key: ModelProfileKey,
|
||||
): { enabled: boolean; adapterConfig: Record<string, unknown>; configured: boolean } {
|
||||
const modelProfiles = parseObject(parseObject(runtimeConfig).modelProfiles);
|
||||
const profile = parseObject(modelProfiles[key]);
|
||||
if (Object.keys(profile).length === 0) {
|
||||
return { enabled: true, adapterConfig: {}, configured: false };
|
||||
}
|
||||
|
||||
return {
|
||||
enabled: profile.enabled !== false,
|
||||
adapterConfig: parseObject(profile.adapterConfig),
|
||||
configured: true,
|
||||
};
|
||||
}
|
||||
|
||||
export function resolveModelProfileApplication(input: {
|
||||
adapterModelProfiles: AdapterModelProfileDefinition[];
|
||||
agentRuntimeConfig: unknown;
|
||||
issueModelProfile: ModelProfileKey | null | undefined;
|
||||
contextSnapshot: Record<string, unknown> | null | undefined;
|
||||
profileResolutionFallbackReason?: string | null;
|
||||
}): ModelProfileApplication {
|
||||
const issueModelProfile = input.issueModelProfile ?? null;
|
||||
const contextModelProfile = readContextModelProfile(input.contextSnapshot);
|
||||
const requested = issueModelProfile ?? contextModelProfile;
|
||||
const requestedBy: ModelProfileRequestSource | null = issueModelProfile
|
||||
? "issue_override"
|
||||
: contextModelProfile
|
||||
? "wake_context"
|
||||
: null;
|
||||
|
||||
if (!requested) {
|
||||
return {
|
||||
requested: null,
|
||||
requestedBy: null,
|
||||
applied: null,
|
||||
configSource: null,
|
||||
fallbackReason: null,
|
||||
adapterConfig: null,
|
||||
};
|
||||
}
|
||||
|
||||
const adapterProfile = input.adapterModelProfiles.find((profile) => profile.key === requested) ?? null;
|
||||
if (!adapterProfile) {
|
||||
return {
|
||||
requested,
|
||||
requestedBy,
|
||||
applied: null,
|
||||
configSource: null,
|
||||
fallbackReason: input.profileResolutionFallbackReason ?? "adapter_profile_not_supported",
|
||||
adapterConfig: null,
|
||||
};
|
||||
}
|
||||
|
||||
const runtimeProfile = readAgentRuntimeModelProfile(input.agentRuntimeConfig, requested);
|
||||
if (!runtimeProfile.enabled) {
|
||||
return {
|
||||
requested,
|
||||
requestedBy,
|
||||
applied: null,
|
||||
configSource: null,
|
||||
fallbackReason: "agent_runtime_profile_disabled",
|
||||
adapterConfig: null,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
requested,
|
||||
requestedBy,
|
||||
applied: requested,
|
||||
configSource: runtimeProfile.configured ? "agent_runtime" : "adapter_default",
|
||||
fallbackReason: null,
|
||||
adapterConfig: {
|
||||
...parseObject(adapterProfile.adapterConfig),
|
||||
...runtimeProfile.adapterConfig,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function mergeModelProfileAdapterConfig(input: {
|
||||
baseConfig: Record<string, unknown>;
|
||||
modelProfile: ModelProfileApplication;
|
||||
issueAdapterConfig: Record<string, unknown> | null | undefined;
|
||||
}): Record<string, unknown> {
|
||||
return {
|
||||
...input.baseConfig,
|
||||
...(input.modelProfile.adapterConfig ?? {}),
|
||||
...(input.issueAdapterConfig ?? {}),
|
||||
};
|
||||
}
|
||||
|
||||
function modelProfileRunMetadata(
|
||||
modelProfile: ModelProfileApplication,
|
||||
): Record<string, unknown> | null {
|
||||
if (!modelProfile.requested) return null;
|
||||
return {
|
||||
requested: modelProfile.requested,
|
||||
requestedBy: modelProfile.requestedBy,
|
||||
applied: modelProfile.applied,
|
||||
configSource: modelProfile.configSource,
|
||||
fallbackReason: modelProfile.fallbackReason,
|
||||
};
|
||||
}
|
||||
|
||||
function mergeModelProfileRunMetadata(
|
||||
resultJson: Record<string, unknown> | null,
|
||||
modelProfile: ModelProfileApplication,
|
||||
): Record<string, unknown> | null {
|
||||
const metadata = modelProfileRunMetadata(modelProfile);
|
||||
if (!metadata) return resultJson;
|
||||
return {
|
||||
...(resultJson ?? {}),
|
||||
modelProfile: metadata,
|
||||
};
|
||||
}
|
||||
|
||||
export function summarizeHeartbeatRunContextSnapshot(
|
||||
contextSnapshot: Record<string, unknown> | null | undefined,
|
||||
): Record<string, unknown> | null {
|
||||
|
|
@ -930,6 +1092,7 @@ export function summarizeHeartbeatRunContextSnapshot(
|
|||
"wakeReason",
|
||||
"wakeSource",
|
||||
"wakeTriggerDetail",
|
||||
"modelProfile",
|
||||
] as const;
|
||||
|
||||
for (const key of allowedKeys) {
|
||||
|
|
@ -1259,6 +1422,9 @@ function parseIssueAssigneeAdapterOverrides(
|
|||
raw: unknown,
|
||||
): ParsedIssueAssigneeAdapterOverrides | null {
|
||||
const parsed = parseObject(raw);
|
||||
const modelProfile = MODEL_PROFILE_KEYS.includes(parsed.modelProfile as ModelProfileKey)
|
||||
? parsed.modelProfile as ModelProfileKey
|
||||
: null;
|
||||
const parsedAdapterConfig = parseObject(parsed.adapterConfig);
|
||||
const adapterConfig =
|
||||
Object.keys(parsedAdapterConfig).length > 0 ? parsedAdapterConfig : null;
|
||||
|
|
@ -1266,8 +1432,9 @@ function parseIssueAssigneeAdapterOverrides(
|
|||
typeof parsed.useProjectWorkspace === "boolean"
|
||||
? parsed.useProjectWorkspace
|
||||
: null;
|
||||
if (!adapterConfig && useProjectWorkspace === null) return null;
|
||||
if (!modelProfile && !adapterConfig && useProjectWorkspace === null) return null;
|
||||
return {
|
||||
modelProfile,
|
||||
adapterConfig,
|
||||
useProjectWorkspace,
|
||||
};
|
||||
|
|
@ -1551,6 +1718,7 @@ function enrichWakeContextSnapshot(input: {
|
|||
if (!readNonEmptyString(contextSnapshot["wakeTriggerDetail"]) && triggerDetail) {
|
||||
contextSnapshot.wakeTriggerDetail = triggerDetail;
|
||||
}
|
||||
normalizeModelProfileWakeContext({ contextSnapshot, payload });
|
||||
|
||||
return {
|
||||
contextSnapshot,
|
||||
|
|
@ -4964,9 +5132,42 @@ export function heartbeatService(db: Db, options: HeartbeatServiceOptions = {})
|
|||
workspaceConfig: existingExecutionWorkspace?.config ?? null,
|
||||
mode: effectiveExecutionWorkspaceMode,
|
||||
});
|
||||
const mergedConfig = issueAssigneeOverrides?.adapterConfig
|
||||
? { ...persistedWorkspaceManagedConfig, ...issueAssigneeOverrides.adapterConfig }
|
||||
: persistedWorkspaceManagedConfig;
|
||||
let adapterModelProfiles: AdapterModelProfileDefinition[] = [];
|
||||
let profileResolutionFallbackReason: string | null = null;
|
||||
try {
|
||||
adapterModelProfiles = await listAdapterModelProfiles(agent.adapterType);
|
||||
} catch (error) {
|
||||
profileResolutionFallbackReason = "adapter_profile_resolution_failed";
|
||||
logger.warn(
|
||||
{
|
||||
err: error,
|
||||
companyId: agent.companyId,
|
||||
agentId: agent.id,
|
||||
adapterType: agent.adapterType,
|
||||
runId: run.id,
|
||||
},
|
||||
"Failed to resolve adapter model profiles; falling back to primary adapter config",
|
||||
);
|
||||
}
|
||||
const modelProfileApplication = resolveModelProfileApplication({
|
||||
adapterModelProfiles,
|
||||
agentRuntimeConfig: agent.runtimeConfig,
|
||||
issueModelProfile: issueAssigneeOverrides?.modelProfile ?? null,
|
||||
contextSnapshot: context,
|
||||
profileResolutionFallbackReason,
|
||||
});
|
||||
const modelProfileMetadata = modelProfileRunMetadata(modelProfileApplication);
|
||||
if (modelProfileMetadata) {
|
||||
context.paperclipModelProfile = modelProfileMetadata;
|
||||
if (modelProfileApplication.requested) context.modelProfile = modelProfileApplication.requested;
|
||||
} else {
|
||||
delete context.paperclipModelProfile;
|
||||
}
|
||||
const mergedConfig = mergeModelProfileAdapterConfig({
|
||||
baseConfig: persistedWorkspaceManagedConfig,
|
||||
modelProfile: modelProfileApplication,
|
||||
issueAdapterConfig: issueAssigneeOverrides?.adapterConfig ?? null,
|
||||
});
|
||||
const configSnapshot = buildExecutionWorkspaceConfigSnapshot(mergedConfig, selectedEnvironmentId);
|
||||
const executionRunConfig = stripWorkspaceRuntimeFromExecutionRunConfig(mergedConfig);
|
||||
const { resolvedConfig, secretKeys } = await resolveExecutionRunAdapterConfig({
|
||||
|
|
@ -5527,12 +5728,16 @@ export function heartbeatService(db: Db, options: HeartbeatServiceOptions = {})
|
|||
if (key in meta.env) meta.env[key] = "***REDACTED***";
|
||||
}
|
||||
}
|
||||
const modelProfileMetadata = modelProfileRunMetadata(modelProfileApplication);
|
||||
await appendRunEvent(currentRun, seq++, {
|
||||
eventType: "adapter.invoke",
|
||||
stream: "system",
|
||||
level: "info",
|
||||
message: "adapter invocation",
|
||||
payload: meta as unknown as Record<string, unknown>,
|
||||
payload: {
|
||||
...(meta as unknown as Record<string, unknown>),
|
||||
...(modelProfileMetadata ? { modelProfile: modelProfileMetadata } : {}),
|
||||
},
|
||||
});
|
||||
};
|
||||
|
||||
|
|
@ -5715,11 +5920,14 @@ export function heartbeatService(db: Db, options: HeartbeatServiceOptions = {})
|
|||
|
||||
const persistedResultJson = mergeHeartbeatRunResultJson(
|
||||
mergeRunStopMetadataForAgent(agent, outcome, {
|
||||
resultJson: mergeAdapterRecoveryMetadata({
|
||||
resultJson: adapterResult.resultJson ?? null,
|
||||
errorFamily: adapterResult.errorFamily ?? null,
|
||||
retryNotBefore: adapterResult.retryNotBefore ?? null,
|
||||
}),
|
||||
resultJson: mergeModelProfileRunMetadata(
|
||||
mergeAdapterRecoveryMetadata({
|
||||
resultJson: adapterResult.resultJson ?? null,
|
||||
errorFamily: adapterResult.errorFamily ?? null,
|
||||
retryNotBefore: adapterResult.retryNotBefore ?? null,
|
||||
}),
|
||||
modelProfileApplication,
|
||||
),
|
||||
errorCode: runErrorCode,
|
||||
errorMessage: runErrorMessage,
|
||||
}),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue