mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-06 14:02:36 +01:00
## Thinking Path > - Paperclip manages AI agents and their work. > - Users choose a harness during agent setup. > - Claude, Codex, and OpenCode already receive their qualified Runner default. > - Pi has a qualified native integration but new Pi agents still use the direct adapter. > - This change gives new Pi agents the native default on supported targets. > - Saved agents keep their runner and compatible settings. Legacy remains available in Advanced. ## Linked Issues or Issue Description Refs #17120, #14921, #14922, #14923, #14924, and #14956. Related generic default work: #15422. This PR is the separate Pi follow-up to the merged OpenCode change. **Current behavior** Choosing Pi for a new agent saves the direct Pi adapter. The native Pi integration remains behind the generic experimental flag. **Proposed behavior** Default new Pi agents to ACPX Pi on macOS ARM64/x64 and GNU/Linux x64 with supported glibc. Keep unsupported targets and explicit Legacy selections on the direct adapter. Require an explicit provider/model before test or hire. Permit model-free inactive setup drafts. **Reason and benefit** Users choose Pi once and receive its qualified runner. Saved agents retain their identity and settings. Conversions reject unsupported legacy thinking and launch settings instead of dropping them. ## What Changed - Add Pi to the shared platform/default contract and server creation selection. - Admit native Pi without the generic experimental flag. - Preserve provider models, credentials, workspace settings, exact thinking, and saved native policies. - Add Pi runner controls, branding, setup resume, onboarding, built-in configuration, and import handling. - Add managed Pi OpenRouter routing and matching native provider API-key accounts. Keep subscription and custom gateway exclusions. Clear alternate credentials and reject custom Pi provider overrides. - Keep Pi draft models empty instead of applying Claude's default model. - Verify setup against the pinned Pi runtime. For native Pi on the official OpenRouter route, reverify the API key live without requiring a global Legacy Pi CLI. - Match Pi’s bounded controller close window to its native snapshot cleanup and lifetime verification, preserving explicit caller deadlines and the mandatory drain/suspension proof. - Bind Pi sidecars to the package that owns the pinned native assets, including source and vendored server layouts. Other providers retain their existing package authority. - Keep protocol-owned finish/block tools out of the ACPX forwarded catalog. The trusted bridge installs these tools itself; the complete Rust authorization catalog and terminal receipt ledger remain intact. This fixes actual Pi session startup and applies to other ACPX consumers. - Advance Copilot’s shared-source attestation to v58 because it pins the shared files touched by Pi. Preserve immutable v57 bytes and historical decoding; Pi’s own release identity is unchanged. - Add regression coverage and update the paired maps and developer documentation. ## Verification - Passed: full repository typecheck and full production build on final head656d304783, including the generated attestation repair. - Passed: focused shared/server/UI suites covering default selection, platform fallback, conversion preservation, inactive drafts, managed account compatibility, credential isolation, OpenRouter routing/model IDs, exact thinking controls, and saved-account selection. Relevant batches include 375 server/conversion tests, 267 account/routing tests, and 110 UI setup/account tests. - Passed: 179 attestation, historical-profile, qualified-profile, and native-execution contract tests after CI identified stale Copilot source hashes. The identity generator check passes; the only delta after the passing Pi browser run is this Copilot attestation/history repair. - Passed: 145 managed-account tests, including actual service preparation and API-key adoption/rejection for native Pi without the Legacy CLI; 6 pinned-installation probe tests. - Red then green: an actual task failed session.open because its 54-operation catalog included the bridge-owned terminal tools. The regression with those tools failed before the filter; all 399 Rust library tests pass after it. The full product retry exposed an additional package-authority mismatch. Four authority tests failed before that repair; 11 authority checks and 14 installation/asset checks pass afterward. Direct real Pi session initialization with the corrected package root and catalog succeeds. No model prompt was sent by that diagnostic. - Red then green: real Pi posted Hello from Pi but its controller closed before native cleanup could finish. The cleanup-budget test failed with the old default and passes with the bounded Pi window. All 46 selected suspension, drain, and package-authority tests pass after building their native fixture. - Passed: token gates, paired map checks, Rust formatting, and git diff --check. - Passed real browser acceptance on macOS ARM64, generic native runner flag disabled, sourcea433748a12(Pi code unchanged afterward): the UI selects Paperclip Runner by default, retains Pi and the selected model/account, and verifies the pinned runtime plus live OpenRouter key. A fresh UI-created task, assigned to the UI-created native Pi agent, posted exactly `Hello from Pi` and reached Done without retry or restart. The native run and workspace finalization succeeded; the response and Done persisted after Reload. - Evidence: 8 preserved browser attempts, including the final passing 18-step journey with all screenshots. Prior failures remain recorded. The earlier failed checkpoint run recovered on server restart; that recovery is separate from the fresh final task’s clean success. - Preserved browser failures: missing account control/inherited Claude draft model; incompatible managed-account/model-prefix handling; generic npm probe for Pi; Legacy CLI hello check; duplicate terminal tools and wrong provider-package authority at actual native session.open; a real Hello from Pi comment followed by premature checkpoint cleanup timeout. Each failure has retained screenshots/logs and a corresponding focused repair. The fresh final task proves these repairs end to end. - The exact Runner Vitest shard was also run locally after the attestation fix: the stale-hash failure is gone; 1,833 tests passed, 10 skipped, and two Codex retained-control settlement scenarios failed with `native_cleanup_maintenance_unproven` during terminal ACK/suspension replay. Both scenarios passed in an isolated rerun (2/2), and the same 19-test file passed in the preceding Linux CI run. The precise full-shard timing cause is not established. These Codex scenarios are outside the changed Pi paths; the original local failures are retained; no complete local Runner-shard pass is claimed. The corresponding Runner shard now passes on the final head in hosted Linux CI. All 60 final-head check runs are now terminal and clean (55 successful, 1 neutral, 4 skipped), and the legacy Snyk status is successful. - Local full repository tests were attempted but not completed: provisioning briefly confused a workspace symlink, then a later run was stopped before browser-driven repairs. No full local-suite pass is claimed. Final-head hosted CI is green and fresh Greptile review is 5/5 with all review threads resolved; earlier jobs canceled by runner shutdown are not counted as a pass. ## Risks - Pi cleanup has a finite 45-second default window, accounting for the native 30-second snapshot cleanup and 5-second lifetime fence. Other providers and explicit caller deadlines retain their prior behavior. - Pi requires explicit operator setup with `paperclipai runtime setup pi` on the execution host. This PR does not add automatic downloads. - Linux ARM64, Windows, musl, and unqualified targets retain Legacy. - Legacy thinking levels minimal, medium, and xhigh cannot be translated exactly. Native max thinking, warm lifecycle, or restricted permissions cannot be dropped during a return to Legacy. - Copilot’s bound profile advances to v58 with exact current launch admission; v57 remains decodable for recovery. No historical identity is rewritten. - Existing agents and immutable run descriptors are not migrated. Cloud Pi availability is unchanged. ## Model Used OpenAI GPT-6 through Codex with reasoning, code editing, command execution, and browser use. The exact serving model ID and context-window size are not exposed in this session. ## 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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
109 lines
6.1 KiB
TypeScript
109 lines
6.1 KiB
TypeScript
// @vitest-environment jsdom
|
|
import { act } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, expect, it, vi } from "vitest";
|
|
import type { AiConnectionBinding, AiManagedConnectionSummary } from "@paperclipai/shared";
|
|
import { aiConnectionsApi } from "@/api/ai-connections";
|
|
import { agentsApi } from "@/api/agents";
|
|
import { useConnectionModels } from "./useConnectionModels";
|
|
|
|
vi.mock("@/api/ai-connections", () => ({ aiConnectionsApi: { list: vi.fn() } }));
|
|
vi.mock("@/api/agents", () => ({ agentsApi: { adapterModels: vi.fn() } }));
|
|
|
|
const binding: AiConnectionBinding = { provider: "openrouter", method: "api_key", mode: "shared", connectionId: "router", grantId: "grant" };
|
|
const account: AiManagedConnectionSummary = {
|
|
id: "router", grantId: "grant", companyId: "company", provider: "openrouter", method: "api_key",
|
|
name: "Company OpenRouter", ownership: "shared", isDefault: false, status: "connected",
|
|
routing: { kind: "openrouter", protocol: "chat", auth: "bearer", models: [] },
|
|
};
|
|
const catalog = [
|
|
{ id: "openrouter/z-ai/glm-5", label: "Z.AI GLM" },
|
|
{ id: "openrouter/anthropic/claude-sonnet-4.5", label: "Claude Sonnet" },
|
|
{ id: "openrouter/openrouter/auto", label: "Auto Router" },
|
|
];
|
|
let root: Root;
|
|
let client: QueryClient;
|
|
let result: ReturnType<typeof useConnectionModels>;
|
|
let render: (value: AiConnectionBinding | undefined) => Promise<void>;
|
|
|
|
beforeEach(() => {
|
|
vi.mocked(agentsApi.adapterModels).mockResolvedValue(catalog);
|
|
vi.mocked(aiConnectionsApi.list).mockResolvedValue({ currentUserId: "you", connections: [account], canManageConnections: true });
|
|
});
|
|
afterEach(async () => {
|
|
await act(async () => root?.unmount());
|
|
client?.clear();
|
|
vi.resetAllMocks();
|
|
});
|
|
|
|
async function mount(accounts: AiManagedConnectionSummary[] = [account], harness = "opencode_local", value: AiConnectionBinding | undefined = binding) {
|
|
client = new QueryClient({ defaultOptions: { queries: { retry: false, staleTime: Infinity } } });
|
|
client.setQueryData(["ai-connections", "company"], { currentUserId: "you", connections: accounts });
|
|
root = createRoot(document.createElement("div"));
|
|
function Probe({ value }: { value: AiConnectionBinding | undefined }) {
|
|
result = useConnectionModels("company", value, harness);
|
|
return null;
|
|
}
|
|
render = async next => { await act(async () => root.render(<QueryClientProvider client={client}><Probe value={next} /></QueryClientProvider>)); };
|
|
await render(value);
|
|
}
|
|
|
|
it.each(["opencode_local", "pi_local", "codex_local", "claude_local", "hermes_local"])("automatically discovers an empty OpenRouter connection's models for %s", async harness => {
|
|
await mount([account], harness);
|
|
await vi.waitFor(() => expect(result?.models).toHaveLength(3));
|
|
expect(agentsApi.adapterModels).toHaveBeenCalledWith("company", "opencode_local", { provider: "openrouter" });
|
|
expect(result?.models.map(m => m.id)).toEqual(catalog.map(m => ["opencode_local", "pi_local"].includes(harness) ? m.id : m.id.slice("openrouter/".length)));
|
|
expect(result?.models.map(m => m.label)).toEqual(catalog.map(m => m.label));
|
|
expect(result?.resolveModel("anthropic/custom-model")).toBe(["opencode_local", "pi_local"].includes(harness) ? "openrouter/anthropic/custom-model" : "anthropic/custom-model");
|
|
});
|
|
|
|
it("also discovers models for legacy OpenRouter connections without routing metadata", async () => {
|
|
await mount([{ ...account, routing: undefined }]);
|
|
await vi.waitFor(() => expect(result?.models).toEqual(catalog));
|
|
});
|
|
|
|
it("preserves an explicit connection model list instead of replacing it with the public catalog", async () => {
|
|
await mount([{ ...account, routing: { ...account.routing!, models: [{ id: "company/model", label: "Approved model" }] } }]);
|
|
expect(result?.models).toEqual([{ id: "openrouter/company/model", label: "Approved model" }]);
|
|
expect(agentsApi.adapterModels).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not reuse public OpenRouter models after switching to a custom gateway", async () => {
|
|
const gateway: AiManagedConnectionSummary = { ...account, id: "gateway", grantId: "gateway-grant", provider: "openai", routing: { kind: "gateway", protocol: "chat", auth: "bearer", baseUrl: "https://example.com/v1", models: [] } };
|
|
await mount([account, gateway]);
|
|
await vi.waitFor(() => expect(result?.models).toEqual(catalog));
|
|
await render({ provider: "openai", method: "api_key", mode: "shared", connectionId: gateway.id, grantId: gateway.grantId });
|
|
expect(result?.models).toEqual([]);
|
|
expect(result?.resolveModel("private-model")).toBe("paperclip/private-model");
|
|
expect(result?.refreshModels).toBeUndefined();
|
|
});
|
|
|
|
it("leaves native model discovery alone", async () => {
|
|
await mount([], "codex_local", { provider: "openai", method: "subscription", mode: "responsible_user" });
|
|
expect(result).toBeUndefined();
|
|
expect(agentsApi.adapterModels).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("only uses the current person's default connection models", async () => {
|
|
await mount([
|
|
{ ...account, ownership: "personal", ownerUserId: "someone-else", isDefault: true, routing: { ...account.routing!, models: [{ id: "other/private-model" }] } },
|
|
{ ...account, ownership: "personal", ownerUserId: "you", isDefault: true },
|
|
], "opencode_local", { provider: "openrouter", method: "api_key", mode: "responsible_user" });
|
|
await vi.waitFor(() => expect(result?.models).toEqual(catalog));
|
|
});
|
|
|
|
it("exposes loading and allows retry after a catalog failure", async () => {
|
|
let reject!: (error: Error) => void;
|
|
vi.mocked(agentsApi.adapterModels).mockReturnValueOnce(new Promise((_, rejectPromise) => { reject = rejectPromise; }));
|
|
await mount();
|
|
expect(result?.isLoading).toBe(true);
|
|
await act(async () => reject(new Error("Catalog unavailable")));
|
|
await vi.waitFor(() => expect(result?.error?.message).toBe("Catalog unavailable"));
|
|
expect(result?.isLoading).toBe(false);
|
|
expect(result?.resolveModel("manual/model")).toBe("openrouter/manual/model");
|
|
await act(async () => { await result?.refreshModels?.(); });
|
|
await vi.waitFor(() => expect(result?.models).toEqual(catalog));
|
|
expect(result?.error).toBeNull();
|
|
});
|