mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-11 05:11:49 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Conversations must use the same tasks, controls, and execution history. > - Users need an ongoing chat with an agent without managing task properties. > - Agents should clarify and plan work, then hand execution to assigned project tasks. > - This pull request combines the reviewed Agent Chat stack for one squash merge. > - The benefit is persistent conversation with normal task governance and shared UI. ## Linked Issues or Issue Description **Subsystem affected** Task lifecycle, agent runtime tools, shared task UI, and browser/paid runner tests. **Problem or motivation** Users need one persistent conversation with each agent. A separate chat store or renderer would duplicate task behavior and bypass existing controls. **Proposed solution** Use a task-backed chat per company, user, and agent. Reuse the task composer and transcript. Clarify and plan in chat, then create assigned project tasks with the relevant plan. Keep Agent Chat behind its own disabled-by-default experimental setting. **Roadmap alignment** This implements the task-backed direction in [CEO Chat](https://github.com/paperclipai/paperclip/blob/master/ROADMAP.md#-ceo-chat). Related proposals: #2504 and #9693. Related request: #7981. The maintainer requested one squash merge of the complete stack. Consolidates the reviewed runtime [#13281](https://github.com/paperclipai/paperclip/pull/13281), backend [#13282](https://github.com/paperclipai/paperclip/pull/13282), and UI [#13283](https://github.com/paperclipai/paperclip/pull/13283) layers with this PR's E2E coverage. All four layers passed CI and received Greptile 5/5 before consolidation. This PR targets master and includes the complete feature. ## What Changed - Add personal canonical chat tasks with ordinary company visibility, immutable identity, idempotent first sends, and an idle waiting state. - Process `/new` in queue order. Preserve history, release a chat pause, and fence old provider context and delayed writes. - Keep chat lifecycle rules across recovery, finalization, assignment, task lists, and rollups. - Support research and plan revision in chat. Hand plans to ordinary assigned project tasks before execution starts. Reject new chat subtasks. - Add repository-aware project creation and discovery tools, including multiple repository IDs and GitHub URLs, authorization, idempotency, and durable project-created cards. - Reuse task UI components for chat, with starred/recent agent navigation and a separate `enableAgentChat` experimental flag. - Add deterministic browser tests and 24 paid chat cells across four Codex/Claude profiles, with validated reports and screenshots. - Integrate current master recovery, controller lease, queued-message, and task UI changes. Gate chat interruption and deferred promotion on ownership/feature policy. Guarantee lease renewal and active controls are stopped even if teardown fails. - Preserve master's migration 0273 and generate chat migration 0274 with idempotent replay for development databases. ## Verification - Prior exact heads of all four PRs passed Linux CI, including build, typecheck, general/serialized tests, and browser E2E. Each had Greptile 5/5 and no unresolved findings. - Integrated local verification passed: full repository typecheck and production build, Storybook build, token gates, 340 focused UI tests, all 20 deterministic chat browser tests, two migration replay tests, 88 focused chat/queue/native/controller tests, and provider/session regressions including real lease expiry. These include the three lifecycle regressions for the final admission/teardown fixes; server typecheck also passes. Current head `1268eda16cc2af892055917e7292f068820be135` has Greptile 5/5 with no unresolved findings and passing security scans. All final-head CI gates passed: build, full Runner verification, typecheck/release registry, canary, all general/serialized test shards, and all browser E2E shards ([CI run](https://github.com/paperclipai/paperclip/actions/runs/34696739927)). Local PostgreSQL startup contention required serialized retries; skipped fixtures do not count as passing coverage. - The earlier paid campaign passed all 24 chat cells and retained 32 screenshots: [report](https://d1p6rlowie26tp.cloudfront.net/runner-e2e/campaigns/gha-34648511170-1/index.html?report=agent-chat#suite-agent-chat). It tested `abacbdfd2f660709ec37312cdb758284c8399d04`; it is prior evidence, not a paid run of this integrated head. - Manual check: enable Agent Chat in Experimental settings, open an agent, clarify and revise a plan, then hand off to an assigned project task. Stop a reply, send `/new`, and verify fresh context with retained history. Disable the setting and verify agent shortcuts/new chat turns are blocked. ## Risks - Queue/session integration can affect retries and delayed writes. Tests cover ownership, cancellation, reset boundaries, idle recovery, and ordinary task behavior. - Migration 0274 adds conversation fields and constraints. Replay is idempotent and preserves existing development chat history. - This combines the previously reviewed stack at the maintainer's request. Agent Chat remains off by default and is separate from Conference Room. ## Model Used OpenAI Codex, GPT-6 Astra (`gpt-6-astra`), with reasoning, code execution, browser tools, and parallel review. The exact context-window size is not exposed in this session. Codex and Claude also ran as test subjects in the linked paid campaign. ## 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>
269 lines
11 KiB
TypeScript
269 lines
11 KiB
TypeScript
import { expect, test } from "vitest";
|
|
|
|
import { buildPrompt } from "./execute.js";
|
|
|
|
function baseContext(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
agent: {
|
|
id: "agent-1",
|
|
name: "Hermes Engineer",
|
|
companyId: "company-1",
|
|
},
|
|
runId: "run-1",
|
|
config: {},
|
|
context: {
|
|
issueId: "issue-1",
|
|
paperclipWake: {
|
|
reason: "issue_assigned",
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-3404",
|
|
title: "Plan the Hermes prompt update",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
workMode: "planning",
|
|
},
|
|
checkedOutByHarness: true,
|
|
commentWindow: { requestedCount: 0, includedCount: 0, missingCount: 0 },
|
|
comments: [],
|
|
fallbackFetchNeeded: false,
|
|
},
|
|
paperclipTaskMarkdown: [
|
|
"Paperclip task context:",
|
|
'- Issue: "PAP-3404"',
|
|
'- Title: "Plan the Hermes prompt update"',
|
|
"",
|
|
"Planning mode directive:",
|
|
"Make the plan only. Do not write code or perform implementation work.",
|
|
"",
|
|
"Issue description:",
|
|
"```text",
|
|
"Use the wake payload as runtime authority.",
|
|
"```",
|
|
].join("\n"),
|
|
...overrides,
|
|
},
|
|
} as any;
|
|
}
|
|
|
|
test("renders standard assignment wake with task authority and no backlog discovery guidance", () => {
|
|
const prompt = buildPrompt(baseContext({
|
|
paperclipWake: {
|
|
reason: "issue_assigned",
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-11750",
|
|
title: "Add Hermes prompt rendering regression tests",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
workMode: "standard",
|
|
},
|
|
checkedOutByHarness: true,
|
|
commentWindow: { requestedCount: 0, includedCount: 0, missingCount: 0 },
|
|
comments: [],
|
|
fallbackFetchNeeded: false,
|
|
},
|
|
paperclipTaskMarkdown: [
|
|
"Paperclip task context:",
|
|
'- Issue: "PAP-11750"',
|
|
'- Title: "Add Hermes prompt rendering regression tests"',
|
|
"",
|
|
"Issue description:",
|
|
"```text",
|
|
"Add focused unit tests for assignment wake and custom prompt rendering.",
|
|
"```",
|
|
].join("\n"),
|
|
}), {});
|
|
|
|
expect(prompt).toContain("## Paperclip Wake Payload");
|
|
expect(prompt).toContain("- reason: issue_assigned");
|
|
expect(prompt).toContain("- issue: PAP-11750 Add Hermes prompt rendering regression tests");
|
|
expect(prompt).toContain("- issue work mode: standard");
|
|
expect(prompt).toContain("Paperclip task context:");
|
|
expect(prompt).toContain("Add focused unit tests for assignment wake and custom prompt rendering.");
|
|
expect(prompt).toContain("The harness already checked out this issue for the current run.");
|
|
expect(prompt).toContain("clear final disposition");
|
|
expect(prompt).not.toContain("check for unassigned issues");
|
|
expect(prompt).not.toContain("status=backlog");
|
|
});
|
|
|
|
test("renders scoped planning wake authority before the Hermes default workflow", () => {
|
|
const prompt = buildPrompt(baseContext(), {
|
|
paperclipApiUrl: "http://127.0.0.1:3101/api",
|
|
});
|
|
|
|
expect(prompt).toContain("## Paperclip Wake Payload");
|
|
expect(prompt).toContain("- issue: PAP-3404 Plan the Hermes prompt update");
|
|
expect(prompt).toContain("- planning directive: Make the plan only. Do not write code or perform implementation work.");
|
|
expect(prompt).toContain("- checkout: already claimed by the harness for this run");
|
|
expect(prompt).toContain("The harness already checked out this issue for the current run.");
|
|
expect(prompt).toContain("Issue description:\n```text\nUse the wake payload as runtime authority.\n```");
|
|
expect(prompt).toContain("clear final disposition");
|
|
expect(prompt).toContain("keep `in_progress` only when a live continuation path exists");
|
|
expect(prompt).not.toContain("check for unassigned issues");
|
|
expect(prompt).not.toContain("status=backlog");
|
|
});
|
|
|
|
test("renders resume deltas instead of full scoped-wake boilerplate when continuing a session", () => {
|
|
const prompt = buildPrompt(baseContext({
|
|
paperclipWake: {
|
|
reason: "issue_commented",
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-11750",
|
|
title: "Add Hermes prompt rendering regression tests",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
workMode: "standard",
|
|
},
|
|
latestCommentId: "comment-2",
|
|
commentWindow: { requestedCount: 1, includedCount: 1, missingCount: 0 },
|
|
comments: [{ id: "comment-2", body: "Please add the resume-delta case.", createdAt: "2026-06-23T00:00:00.000Z" }],
|
|
fallbackFetchNeeded: false,
|
|
},
|
|
}), {}, { resumedSession: true });
|
|
|
|
expect(prompt).toContain("## Paperclip Resume Delta");
|
|
expect(prompt).toContain("You are resuming an existing Paperclip session.");
|
|
expect(prompt).toContain("Focus on the new wake delta below");
|
|
expect(prompt).toContain("Please add the resume-delta case.");
|
|
expect(prompt).toContain("- fallback fetch needed: no");
|
|
expect(prompt).not.toContain("Before generic repo exploration or boilerplate heartbeat updates");
|
|
});
|
|
|
|
test("renders comment wake batch guidance without defaulting to a full-thread refetch", () => {
|
|
const prompt = buildPrompt(baseContext({
|
|
wakeCommentId: "comment-1",
|
|
paperclipWake: {
|
|
reason: "issue_commented",
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-3404",
|
|
title: "Plan the Hermes prompt update",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
workMode: "standard",
|
|
},
|
|
latestCommentId: "comment-1",
|
|
commentWindow: { requestedCount: 1, includedCount: 1, missingCount: 0 },
|
|
comments: [{ id: "comment-1", body: "Please tighten the prompt.", createdAt: "2026-06-23T00:00:00.000Z" }],
|
|
fallbackFetchNeeded: false,
|
|
},
|
|
}), {});
|
|
|
|
expect(prompt).toContain("Use this inline wake data first before refetching the issue thread.");
|
|
expect(prompt).toContain("Only fetch the API thread when `fallbackFetchNeeded` is true");
|
|
expect(prompt).toContain("New comments in order:");
|
|
expect(prompt).toContain("Please tighten the prompt.");
|
|
expect(prompt).toContain("- fallback fetch needed: no");
|
|
});
|
|
|
|
test("renders accepted-plan continuation without authorizing implementation on the planning issue", () => {
|
|
const prompt = buildPrompt(baseContext({
|
|
paperclipWake: {
|
|
reason: "issue_commented",
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-3404",
|
|
title: "Plan the Hermes prompt update",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
workMode: "planning",
|
|
},
|
|
interactionKind: "request_confirmation",
|
|
interactionStatus: "accepted",
|
|
commentWindow: { requestedCount: 0, includedCount: 0, missingCount: 0 },
|
|
comments: [],
|
|
fallbackFetchNeeded: false,
|
|
},
|
|
}), {});
|
|
|
|
expect(prompt).toContain("- planning directive: Create child issues from the approved plan only. Do not write code or perform implementation work on the planning issue.");
|
|
expect(prompt).toContain("- accepted-plan continuation: you may create child implementation issues from the approved plan");
|
|
expect(prompt).toContain("must not start implementation work on the planning issue itself");
|
|
expect(prompt).not.toContain("- planning directive: Make the plan only.");
|
|
expect(prompt).not.toContain("Update the plan only");
|
|
});
|
|
|
|
test("keeps authoritative parent and ancestor context from task markdown", () => {
|
|
const prompt = buildPrompt(baseContext({
|
|
paperclipTaskMarkdown: [
|
|
"Paperclip task context:",
|
|
'- Issue: "PAP-3404"',
|
|
"",
|
|
"Authoritative parent / ancestor context:",
|
|
"- Parent: PAP-11724 Optimize prompt traces (in_progress) [medium]",
|
|
"- Ancestor 2: PAP-11721 Fetch raw traces (done) [medium]",
|
|
].join("\n"),
|
|
}), {});
|
|
|
|
expect(prompt).toContain("Authoritative parent / ancestor context:");
|
|
expect(prompt).toContain("- Parent: PAP-11724 Optimize prompt traces (in_progress) [medium]");
|
|
expect(prompt).not.toContain("check the issue body or comments for references");
|
|
});
|
|
|
|
test("renders safe Paperclip API examples from environment variables with multiline update preservation", () => {
|
|
const prompt = buildPrompt(baseContext(), {
|
|
paperclipApiUrl: "http://paperclip.local/api",
|
|
});
|
|
|
|
expect(prompt).toContain("Use `$PAPERCLIP_API_URL`, `$PAPERCLIP_API_KEY`, and `$PAPERCLIP_RUN_ID`");
|
|
expect(prompt).toContain("Displayed command logs may redact secrets");
|
|
expect(prompt).toContain('-H "Authorization: Bearer $PAPERCLIP_API_KEY"');
|
|
expect(prompt).toContain('-H "X-Paperclip-Run-Id: $PAPERCLIP_RUN_ID"');
|
|
expect(prompt).toContain("body=$(cat <<'MD'");
|
|
expect(prompt).toContain("jq -n --arg status done --arg comment \"$body\"");
|
|
expect(prompt).toContain("--data-binary @-");
|
|
expect(prompt).not.toContain("Authorization: Bearer <");
|
|
});
|
|
|
|
test("preserves custom prompt templates while exposing runtime and wake variables", () => {
|
|
const prompt = buildPrompt(baseContext(), {
|
|
paperclipApiUrl: "http://paperclip.local/api",
|
|
promptTemplate: [
|
|
"CUSTOM TEMPLATE",
|
|
"agent={{agent.name}}",
|
|
"api={{paperclipApiUrl}}",
|
|
"keyEnv={{paperclipApiKeyEnv}}",
|
|
"runEnv={{paperclipRunIdEnv}}",
|
|
"wakePrompt={{paperclipWakePrompt}}",
|
|
"task={{paperclipTaskMarkdown}}",
|
|
"wakeJson={{paperclipWakeJson}}",
|
|
"wake={{wakePayloadJson}}",
|
|
].join("\n"),
|
|
});
|
|
|
|
expect(prompt).toContain("CUSTOM TEMPLATE");
|
|
expect(prompt).toContain("agent=Hermes Engineer");
|
|
expect(prompt).toContain("api=http://paperclip.local/api");
|
|
expect(prompt).toContain("keyEnv=PAPERCLIP_API_KEY");
|
|
expect(prompt).toContain("runEnv=PAPERCLIP_RUN_ID");
|
|
expect(prompt).toContain("wakePrompt=## Paperclip Wake Payload");
|
|
expect(prompt).toContain("task=Paperclip task context:");
|
|
expect(prompt).toContain("wakeJson={\"reason\":\"issue_assigned\"");
|
|
expect(prompt).toContain('"reason":"issue_assigned"');
|
|
expect(prompt).toContain("## Paperclip Wake Payload");
|
|
expect(prompt).toContain("Issue description:\n```text\nUse the wake payload as runtime authority.\n```");
|
|
expect(prompt).not.toContain("Paperclip runtime identity:");
|
|
});
|
|
|
|
|
|
test.each([false, true])("conversation prompts preserve the handoff policy (resumed=%s)", (resumedSession) => {
|
|
const directive = "Chat directive: clarify goals and hand the plan off to project tasks.";
|
|
const ctx = baseContext({
|
|
conversationMode: true,
|
|
paperclipTaskMarkdown: directive,
|
|
paperclipTaskMarkdownCompact: directive,
|
|
});
|
|
ctx.context.paperclipWake.interactionKind = "request_confirmation";
|
|
ctx.context.paperclipWake.interactionStatus = "accepted";
|
|
for (const config of [{}, { promptTemplate: "Custom agent instruction." }]) {
|
|
const prompt = buildPrompt(ctx, config, { resumedSession });
|
|
expect(prompt).toContain(directive);
|
|
expect(prompt).not.toContain("Execution contract:");
|
|
expect(prompt).not.toContain("clear final disposition");
|
|
expect(prompt).not.toContain("Create child issues");
|
|
expect(prompt).not.toContain("--arg status done");
|
|
}
|
|
});
|