mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-12 18:06:11 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Runner gives agents tools to change company resources. > - Users need agents to save reusable skills during a task. > - A saved skill needs a visible result that users can inspect and edit. > - This pull request adds `create_skill` and a task feed card linked to Skill Studio. > - Users can open the saved skill from the task and edit the same resource. ## Linked Issues or Issue Description **Subsystem affected** Runner tools, company skill storage, task feed, and Skill Studio. **Problem or motivation** The Runner has no dedicated tool to create a company skill. A user cannot follow a creation result from the task feed to the saved skill. **Proposed solution** Add a company-scoped `create_skill` tool. Save the skill with the existing company policy. Add one creation card to the task. Open a named sidebar tab from that card. Let the user open the same skill in Skill Studio. **Alternatives considered** An agent can write a local file, but that file is not a company skill. A second document copy in the task would become stale after a Studio edit. The sidebar therefore reads the saved skill directly. **Roadmap alignment** This extends the shipped Skills Manager, Skill Studio, and Skills Store milestone. The maintainer requested and approved this scope. Search found no duplicate `create_skill` PR or issue. Related UI validation work: #8715. This PR does not change that validation display. ## What Changed - Add the real Runner tool, its contract, and its mock implementation. - Validate the complete SKILL.md and derive company, task, agent, and run identity from authentication. - Apply the existing company skill policy. Do not assign the skill to an agent. - Make keyed retries return one skill and one creation event. Reject conflicting retries. - Make concurrent file creation safe. Never replace an existing published skill during creation. - Add a creation card, a named sidebar tab, and an Open in Skill Studio action. - Show saved Studio edits when the user returns to the task. - Add storage, policy, mode, retry, UI, and Product E2E tests. Document the tool. - Fix deleted-name reuse, onboarding panel persistence, immediate feed refresh, and mock validation parity from review. - Serialize Studio file edits and renames with skill deletion and recreation. Reject stale editor requests before they can change a replacement skill. - Generate the standalone mock parser and validator from the production contract. Use portable UUIDs so the browser scenario bundle builds. ## Verification - All latest-head PR checks pass on `145dd76a5`, including all server shards, browser E2E, Runner verification, build, typecheck, and release dry run. Greptile: 5/5 with no open findings. An interrupted CI runner was retried successfully. - `pnpm -r typecheck`: passed. - `pnpm build`: passed. - `pnpm check:token-gates`: passed. - Review regressions: 73 storage tests, 6 real API tests, 63 UI tests, and 61 semantic runtime tests passed. Parser synchronization passed. - CI exposed existing fire-and-forget Sentry test races. Reproduced the resumption race locally, then synchronized the related sweep and finalizer assertions on the actual report; all 27 tests across the three affected files pass. - Runner scenario browser build and strict content-security-policy check: passed. - Runner suite: 2,012 tests passed; 10 skipped. - `pnpm test:run`: the general-server batch had 12,416 passes and two failures. The old tool-count assertion was fixed; all 16 authority tests then passed. The chat webhook test had a socket error; it passed four isolated reruns. - Both workspace test groups passed. The isolated route suites completed. Two socket failures in the initial route batches passed on individual reruns; all remaining 61 files passed. - Product E2E `create-skill-studio`: passed with local Codex and local ACPX Claude. - Manual browser test: submit a task, observe the real tool call and creation card, open the sidebar, edit in Studio, save, and return. The task reached Done. The saved second revision and sidebar tab survived a server restart. - The new companion headless Runner Eval passed. Companion coverage PR: https://github.com/paperclipai/paperclip-evals/pull/23. Daytona was not run because no immutable runner image was configured. ## Risks - Database writes and local file writes cannot share one transaction. Recovery accepts only an exact file-for-file retry after a database rollback. Conflicting files remain untouched. - The sidebar displays the current skill. The feed card remains the historical creation receipt. - No database migration, dependency, or workflow change is included. - Remote Daytona behavior still needs a run with a configured immutable image. ## Model Used OpenAI GPT-6 (`gpt-6-astra`) handled design, integration, review, and browser verification. OpenAI `gpt-5.6-luna` assisted with bounded implementation and eval work. Both used code execution and tool access. The host 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) - [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>
265 lines
8.6 KiB
TypeScript
265 lines
8.6 KiB
TypeScript
import { describe, it, expect } from "vitest";
|
|
import { runnerMatrix, runnerSuites } from "./catalog.js";
|
|
import { parseRunnerSelectors, selectRunnerExecutions } from "./selectors.js";
|
|
import { everydayTasks, productionStoryProfile } from "./everyday-cases.js";
|
|
import {
|
|
isStoryWorkspaceDeferral,
|
|
storyLifecycleChecks,
|
|
storyRepliesConsumed,
|
|
storyParentFinishedAfterChildren,
|
|
type StoryRun,
|
|
} from "./everyday-observations.js";
|
|
|
|
describe("manual everyday workflow catalog", () => {
|
|
it("is discoverable and explicitly selected without changing scheduled --all", () => {
|
|
const all = selectRunnerExecutions(parseRunnerSelectors(["--all"]));
|
|
expect(all.some((e) => e.suite.id === "everyday-workflows")).toBe(false);
|
|
const selected = selectRunnerExecutions(
|
|
parseRunnerSelectors(["--suite", "everyday-workflows"]),
|
|
);
|
|
expect(selected).toHaveLength(35);
|
|
expect(selected.every((e) => e.profile.generation === "native")).toBe(true);
|
|
expect(
|
|
selectRunnerExecutions(
|
|
parseRunnerSelectors(["--profile", "runner-codex"]),
|
|
).some((e) => e.suite.id === "everyday-workflows"),
|
|
).toBe(false);
|
|
const listed = selectRunnerExecutions(parseRunnerSelectors(["--list"]));
|
|
expect(listed.some((e) => e.suite.id === "everyday-workflows")).toBe(true);
|
|
});
|
|
it("does not schedule arbitrary runner-crash probes as model evals", () => {
|
|
const selected = selectRunnerExecutions(
|
|
parseRunnerSelectors(["--suite", "everyday-workflows"]),
|
|
);
|
|
expect(selected.some((e) => e.task.id.startsWith("recover-runner"))).toBe(false);
|
|
for (const id of ["recover-runner", "recover-runner-safe", "recover-runner-uncertain"])
|
|
expect(() => selectRunnerExecutions(parseRunnerSelectors([
|
|
"--id", `everyday-workflows.runner-codex.local.${id}`,
|
|
]))).toThrow();
|
|
expect(selected.some((e) => e.task.id === "recover-controller")).toBe(true);
|
|
expect(selected.some((e) => e.task.id === "stop-redirect")).toBe(true);
|
|
});
|
|
it("keeps ordinary prompts free of completion/API instructions", () => {
|
|
for (const task of everydayTasks)
|
|
expect(task.buildPrompt("sample")).not.toMatch(
|
|
/finish_task|paperclip_finish|PATCH|mark .*done|idempotencyKey/i,
|
|
);
|
|
const profile = runnerSuites.find((s) => s.id === "everyday-workflows")!
|
|
.profiles[0]!;
|
|
const value = productionStoryProfile(profile).buildAgent({
|
|
environmentId: "env",
|
|
environmentFixtureId: "local",
|
|
workspacePath: "/tmp/test",
|
|
secretRefs: {
|
|
OPENAI_API_KEY: {
|
|
type: "secret_ref",
|
|
secretId: "secret",
|
|
version: "latest",
|
|
},
|
|
},
|
|
executionId: "case",
|
|
});
|
|
expect(JSON.stringify(value.instructionsBundle)).not.toMatch(
|
|
/fixture|mark .*done|finish_task|api\/issues/i,
|
|
);
|
|
});
|
|
it("does not claim unsupported remote crash/hiring coverage", () => {
|
|
const remote = runnerMatrix.filter(
|
|
(e) =>
|
|
e.suite.id === "everyday-workflows" && e.environment.id === "daytona",
|
|
);
|
|
expect(remote).toHaveLength(8);
|
|
expect(new Set(remote.map((e) => e.task.id))).toEqual(
|
|
new Set(["build-revise", "delegate-feedback", "recover-controller", "create-skill-studio"]),
|
|
);
|
|
});
|
|
});
|
|
|
|
describe("lifecycle oracle calibrated failures", () => {
|
|
const parent = {
|
|
id: "parent",
|
|
companyId: "company",
|
|
title: "Project",
|
|
status: "done",
|
|
assigneeAgentId: "lead",
|
|
};
|
|
const run: StoryRun = {
|
|
id: "run",
|
|
companyId: "company",
|
|
agentId: "lead",
|
|
status: "succeeded",
|
|
runtimeMode: "native",
|
|
runnerInstanceId: "runner",
|
|
contextSnapshot: { issueId: "parent" },
|
|
};
|
|
const score = (
|
|
runs: StoryRun[],
|
|
issues = [parent],
|
|
allowedInterruptedRuns: string[] = [],
|
|
) =>
|
|
storyLifecycleChecks({
|
|
issues,
|
|
runs,
|
|
parentId: parent.id,
|
|
leadId: "lead",
|
|
allowedInterruptedRuns,
|
|
});
|
|
it("accepts successful owned native work", () =>
|
|
expect(score([run]).every((c) => c.passed)).toBe(true));
|
|
it.each([
|
|
["legacy execution", { ...run, runtimeMode: "legacy" }, "native-runtime"],
|
|
[
|
|
"no runner identity",
|
|
{ ...run, runnerInstanceId: null },
|
|
"native-runtime",
|
|
],
|
|
["worker on parent", { ...run, agentId: "worker" }, "parent-owned-by-lead"],
|
|
["crash without recovery", { ...run, status: "failed" }, "successful-runs"],
|
|
["unsettled run", { ...run, status: "running" }, "settled"],
|
|
] as const)("rejects %s", (_label, bad, id) =>
|
|
expect(score([bad]).find((c) => c.id === id)?.passed).toBe(false),
|
|
);
|
|
it("does not exempt unrelated failures because another run was intentionally stopped", () => {
|
|
const checks = score(
|
|
[
|
|
{ ...run, status: "cancelled" },
|
|
{ ...run, id: "other", status: "failed" },
|
|
],
|
|
[parent],
|
|
["run"],
|
|
);
|
|
expect(checks.find((c) => c.id === "successful-runs")?.passed).toBe(false);
|
|
});
|
|
it("excludes a proven pre-dispatch workspace deferral without hiding executed failures", () => {
|
|
const deferred: StoryRun = {
|
|
id: "deferred",
|
|
companyId: "company",
|
|
agentId: "lead",
|
|
status: "cancelled",
|
|
errorCode: "workspace_busy",
|
|
resultJson: {
|
|
executionRecovery: {
|
|
kind: "workspace_wait",
|
|
providerWorkStarted: false,
|
|
},
|
|
},
|
|
};
|
|
expect(score([run, deferred]).every((c) => c.passed)).toBe(true);
|
|
expect(
|
|
score([run, { ...deferred, processPid: 123 }]).every((c) => c.passed),
|
|
).toBe(false);
|
|
expect(
|
|
score([run, { ...deferred, resultJson: {} }]).every((c) => c.passed),
|
|
).toBe(false);
|
|
});
|
|
it("rejects a finished answer left in review", () =>
|
|
expect(
|
|
score([run], [{ ...parent, status: "in_review" }]).find(
|
|
(c) => c.id === "tasks-done",
|
|
)?.passed,
|
|
).toBe(false));
|
|
});
|
|
|
|
describe("reply completion boundary", () => {
|
|
const run: StoryRun = {
|
|
id: "old",
|
|
companyId: "company",
|
|
agentId: "lead",
|
|
status: "succeeded",
|
|
runnerProfileJson: {
|
|
nativeExecutionInput: { task: { prompt: "Original task" } },
|
|
},
|
|
};
|
|
it("does not accept Done from the first run while a later request is still queued", () => {
|
|
expect(storyRepliesConsumed([run], ["later-comment"])).toBe(false);
|
|
const next = {
|
|
...run,
|
|
id: "new",
|
|
runnerProfileJson: {
|
|
nativeExecutionInput: { task: { prompt: "User reply later-comment" } },
|
|
},
|
|
};
|
|
expect(
|
|
storyRepliesConsumed(
|
|
[run, { ...next, status: "running" }],
|
|
["later-comment"],
|
|
),
|
|
).toBe(false);
|
|
expect(storyRepliesConsumed([run, next], ["later-comment"])).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("delegation completion order", () => {
|
|
it("rejects a parent closed before its worker finishes", () => {
|
|
const base: StoryRun = {
|
|
id: "lead-run",
|
|
companyId: "company",
|
|
agentId: "lead",
|
|
status: "succeeded",
|
|
nativeIssueId: "parent",
|
|
finishedAt: "2026-09-14T12:00:00Z",
|
|
};
|
|
const child = {
|
|
...base,
|
|
id: "worker-run",
|
|
agentId: "worker",
|
|
nativeIssueId: "child",
|
|
finishedAt: "2026-09-14T12:01:00Z",
|
|
};
|
|
expect(
|
|
storyParentFinishedAfterChildren([base, child], "parent", "lead", [
|
|
"child",
|
|
]),
|
|
).toBe(false);
|
|
expect(
|
|
storyParentFinishedAfterChildren(
|
|
[{ ...base, finishedAt: "2026-09-14T12:02:00Z" }, child],
|
|
"parent",
|
|
"lead",
|
|
["child"],
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
storyParentFinishedAfterChildren([base], "parent", "lead", ["child"]),
|
|
).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("cancelled queued workspace retry", () => {
|
|
const queued: StoryRun = {
|
|
id: "retry",
|
|
companyId: "company",
|
|
agentId: "agent",
|
|
status: "cancelled",
|
|
runtimeMode: "legacy",
|
|
runtimeModeResolvedAt: null,
|
|
startedAt: null,
|
|
retryOfRunId: "workspace-deferral",
|
|
scheduledRetryReason: "workspace_busy",
|
|
errorCode: "cancelled",
|
|
lastOutputSeq: 0,
|
|
resultJson: {
|
|
startupCancellation: {
|
|
requestedAt: "2026-09-14T19:10:23.057Z",
|
|
beforeNativeSelection: false,
|
|
},
|
|
},
|
|
};
|
|
it("does not mistake an unstarted cancelled retry for provider execution", () => {
|
|
expect(isStoryWorkspaceDeferral(queued)).toBe(true);
|
|
});
|
|
it.each([
|
|
{ startedAt: "2026-09-14T19:10:22Z" },
|
|
{ processPid: 42 },
|
|
{ runnerInstanceId: "runner" },
|
|
{ nativeSessionId: "session" },
|
|
{ lastOutputSeq: 1 },
|
|
{ usageJson: { outputTokens: 1 } },
|
|
{ runtimeModeResolvedAt: "2026-09-14T19:10:22Z" },
|
|
{ scheduledRetryReason: "other" },
|
|
{ resultJson: null },
|
|
])("retains a contradictory or unproven cancellation %j", (change) => {
|
|
expect(isStoryWorkspaceDeferral({ ...queued, ...change })).toBe(false);
|
|
});
|
|
});
|