mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 03:08:10 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to coordinate AI agents, issues, approvals, comments, and work products. > - The involved subsystem is issue context: markdown links, issue properties, related work, lists, filters, inbox/sidebar status, and plugin-provided external context. > - The gap is that URLs to external systems currently remain mostly plain links, so humans and agents must manually open them to understand status, identity, and liveness. > - This matters because external work objects such as GitHub issues and pull requests are part of the operational state of a Paperclip company. > - The implementation keeps core provider-neutral: shared contracts, storage, sync, routes, and UI surfaces live in core while providers can contribute detection and status resolution. > - This pull request adds the external object reference foundation, GitHub provider support, issue-surface rendering, filters, sidebar/list/inbox signals, and test/story coverage. > - The benefit is that linked external work becomes inspectable Paperclip context without hardcoding every provider directly into the UI. ## Linked Issues or Issue Description No public GitHub issue exists for this work. Feature request: - Problem: URLs in Paperclip issues, comments, documents, and related surfaces do not expose provider status or object identity inline. - Proposed behavior: detect supported external object URLs, persist normalized references, refresh provider status, and render concise status-aware links across issue surfaces. - Users affected: board users, agents, and maintainers who triage issues containing external work links. - Acceptance: external object references are company-scoped, provider-extensible, visible in key issue surfaces, filterable where relevant, and covered by focused shared/server/UI tests. Related PR search: - No open duplicate PRs found for `external object references`. - Closed related prior attempt: #4556. ## What Changed - Added shared external-object contracts, validators, status/liveness helpers, and plugin protocol declarations. - Added database schema and additive migrations for external objects, source mentions, and display metadata. - Added server services/routes for detecting, syncing, summarizing, refreshing, and resolving external objects across issues, documents, comments, projects, and plugins. - Added a GitHub external-object provider plus plugin SDK authoring docs. - Wired UI presentation across markdown links, comments, issue chat, documents, properties, related work, issue rows, filters, inbox/sidebar badges, and Storybook stories. - Rebasing cleanup: moved the branch onto current `master`, repaired stale worktree provision config, hardened environment-sensitive tests/mocks, and removed committed screenshot artifacts from the PR branch to keep the reviewable file set below tool limits. ## Verification - `pnpm exec vitest run packages/shared/src/external-objects.test.ts server/src/__tests__/external-object-routes.test.ts server/src/__tests__/external-objects-service.test.ts ui/src/components/ExternalObjectPill.test.tsx ui/src/lib/external-objects.test.ts` passed after rebasing: 5 files, 56 tests. - Historical branch verification before this PR creation included `pnpm test:run`, `pnpm -r typecheck`, and `pnpm build`; this PR body does not claim those were rerun after the final rebase. ## Risks - Medium: this adds a new cross-surface sync path on issue/document/comment writes. The implementation uses safe sync wrappers so external-object failures warn instead of blocking core mutations. - Medium: the migrations introduce new tables and indexes. They are additive and company-scoped. - Medium: provider-specific URL parsing can miss or misclassify edge cases. Shared canonicalization tests and provider tests cover current GitHub shapes. - Low: UI badge/filter behavior could add visual noise for object-heavy issues; component tests and Storybook stories cover the intended surfaces. > Roadmap checked: `ROADMAP.md` references the plugin system as the current extension path and does not list a duplicate core feature. Related long-range docs discuss external references, work products, preview URLs, and plugin extension points; this PR implements the scoped external-object reference foundation. ## Model Used OpenAI Codex, GPT-5 coding-agent runtime, with shell and GitHub CLI tool use. Reasoning mode: medium. Exact deployed runtime model ID and context window were not exposed in the environment. ## 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>
460 lines
13 KiB
TypeScript
460 lines
13 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import type { ReactNode } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import { MemoryRouter } from "react-router-dom";
|
|
import type { Agent, Approval } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { CommentThread } from "./CommentThread";
|
|
|
|
vi.mock("./MarkdownBody", () => ({
|
|
MarkdownBody: ({
|
|
children,
|
|
className,
|
|
externalReferences,
|
|
}: {
|
|
children: ReactNode;
|
|
className?: string;
|
|
externalReferences?: Record<string, unknown>;
|
|
}) => (
|
|
<div
|
|
className={className}
|
|
data-testid="markdown-body"
|
|
data-external-reference-keys={externalReferences ? Object.keys(externalReferences).join(",") : ""}
|
|
>
|
|
{children}
|
|
</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./MarkdownEditor", () => ({
|
|
MarkdownEditor: ({ value, onChange, placeholder }: {
|
|
value: string;
|
|
onChange: (value: string) => void;
|
|
placeholder?: string;
|
|
}) => (
|
|
<textarea
|
|
aria-label="Comment editor"
|
|
value={value}
|
|
placeholder={placeholder}
|
|
onChange={(event) => onChange(event.target.value)}
|
|
/>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./InlineEntitySelector", () => ({
|
|
InlineEntitySelector: () => null,
|
|
}));
|
|
|
|
vi.mock("./ApprovalCard", () => ({
|
|
ApprovalCard: ({
|
|
approval,
|
|
onApprove,
|
|
onReject,
|
|
}: {
|
|
approval: Approval;
|
|
onApprove?: () => void;
|
|
onReject?: () => void;
|
|
}) => (
|
|
<div>
|
|
<div>{approval.type}</div>
|
|
<div>{String(approval.payload.title ?? "")}</div>
|
|
{onApprove ? <button type="button" onClick={onApprove}>Approve</button> : null}
|
|
{onReject ? <button type="button" onClick={onReject}>Reject</button> : null}
|
|
</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("@/plugins/slots", () => ({
|
|
PluginSlotOutlet: () => null,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
describe("CommentThread", () => {
|
|
let container: HTMLDivElement;
|
|
let writeTextMock: ReturnType<typeof vi.fn<(text: string) => Promise<void>>>;
|
|
let execCommandMock: ReturnType<typeof vi.fn<typeof document.execCommand>>;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
vi.useFakeTimers();
|
|
vi.setSystemTime(new Date("2026-03-11T12:00:00.000Z"));
|
|
writeTextMock = vi.fn<(text: string) => Promise<void>>(async () => {});
|
|
execCommandMock = vi.fn<typeof document.execCommand>(() => true);
|
|
Object.assign(navigator, {
|
|
clipboard: {
|
|
writeText: writeTextMock,
|
|
},
|
|
});
|
|
Object.defineProperty(window, "isSecureContext", {
|
|
value: true,
|
|
configurable: true,
|
|
});
|
|
document.execCommand = execCommandMock;
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.useRealTimers();
|
|
container.remove();
|
|
});
|
|
|
|
it("renders historical runs as timeline rows using the finished time", () => {
|
|
const root = createRoot(container);
|
|
const agent: Agent = {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "CodexCoder",
|
|
urlKey: "codexcoder",
|
|
role: "engineer",
|
|
title: null,
|
|
icon: "code",
|
|
status: "active",
|
|
reportsTo: null,
|
|
capabilities: null,
|
|
adapterType: "process",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
budgetMonthlyCents: 0,
|
|
spentMonthlyCents: 0,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
permissions: { canCreateAgents: false },
|
|
lastHeartbeatAt: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-03-11T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T00:00:00.000Z"),
|
|
};
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[]}
|
|
linkedRuns={[{
|
|
runId: "run-12345678abcd",
|
|
status: "succeeded",
|
|
agentId: "agent-1",
|
|
createdAt: "2026-03-11T07:00:00.000Z",
|
|
startedAt: "2026-03-11T08:00:00.000Z",
|
|
finishedAt: "2026-03-11T10:00:00.000Z",
|
|
}]}
|
|
agentMap={new Map([["agent-1", agent]])}
|
|
onAdd={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
const runRow = container.querySelector("#run-run-12345678abcd") as HTMLDivElement | null;
|
|
expect(runRow).not.toBeNull();
|
|
expect(runRow?.className).toContain("py-1.5");
|
|
expect(runRow?.className).toContain("items-center");
|
|
expect(runRow?.className).not.toContain("border");
|
|
expect(container.textContent).toContain("CodexCoder");
|
|
expect(container.textContent).toContain("succeeded");
|
|
expect(container.textContent).toContain("2h ago");
|
|
expect(container.textContent).not.toContain("4h ago");
|
|
const runLink = container.querySelector('a[href="/agents/agent-1/runs/run-12345678abcd"]') as HTMLAnchorElement | null;
|
|
expect(runLink?.textContent).toContain("run-1234");
|
|
expect(runLink?.className).toContain("rounded-md");
|
|
expect(runLink?.className).toContain("px-2");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("replaces the composer with a warning when comments are disabled", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[]}
|
|
composerDisabledReason="Workspace is closed."
|
|
onAdd={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).toContain("Workspace is closed.");
|
|
expect(container.querySelector('textarea[aria-label="Comment editor"]')).toBeNull();
|
|
expect(container.textContent).not.toContain("Comment");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("shows follow-up badges on explicit follow-up comments and timeline rows", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[{
|
|
id: "comment-1",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
authorAgentId: null,
|
|
authorUserId: "local-board",
|
|
body: "Please continue validation.",
|
|
authorType: "user",
|
|
presentation: null,
|
|
metadata: null,
|
|
followUpRequested: true,
|
|
createdAt: new Date("2026-03-11T10:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T10:00:00.000Z"),
|
|
}]}
|
|
timelineEvents={[{
|
|
id: "event-1",
|
|
actorType: "agent",
|
|
actorId: "agent-1",
|
|
createdAt: new Date("2026-03-11T10:00:00.000Z"),
|
|
commentId: "comment-1",
|
|
followUpRequested: true,
|
|
}]}
|
|
onAdd={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).toContain("Follow-up");
|
|
expect(container.textContent).toContain("requested follow-up");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("hides the reopen control and infers reopen for closed agent-assigned issues", async () => {
|
|
const root = createRoot(container);
|
|
const onAdd = vi.fn(async () => {});
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[]}
|
|
issueStatus="done"
|
|
currentAssigneeValue="agent:agent-1"
|
|
onAdd={onAdd}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).not.toContain("Re-open");
|
|
|
|
const editor = container.querySelector('textarea[aria-label="Comment editor"]') as HTMLTextAreaElement | null;
|
|
const submitButton = Array.from(container.querySelectorAll("button")).find(
|
|
(element) => element.textContent === "Comment",
|
|
) as HTMLButtonElement | undefined;
|
|
expect(editor).not.toBeNull();
|
|
expect(submitButton).toBeDefined();
|
|
|
|
act(() => {
|
|
const valueSetter = Object.getOwnPropertyDescriptor(
|
|
window.HTMLTextAreaElement.prototype,
|
|
"value",
|
|
)?.set;
|
|
valueSetter?.call(editor, "Please pick this back up");
|
|
editor?.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
await act(async () => {
|
|
submitButton?.click();
|
|
});
|
|
|
|
expect(onAdd).toHaveBeenCalledWith("Please pick this back up", true, undefined);
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders linked approvals inline in the timeline", () => {
|
|
const root = createRoot(container);
|
|
const agent: Agent = {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "CodexCoder",
|
|
urlKey: "codexcoder",
|
|
role: "engineer",
|
|
title: null,
|
|
icon: "code",
|
|
status: "active",
|
|
reportsTo: null,
|
|
capabilities: null,
|
|
adapterType: "process",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
budgetMonthlyCents: 0,
|
|
spentMonthlyCents: 0,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
permissions: { canCreateAgents: false },
|
|
lastHeartbeatAt: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-03-11T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T00:00:00.000Z"),
|
|
};
|
|
const approval: Approval = {
|
|
id: "approval-1",
|
|
companyId: "company-1",
|
|
type: "request_board_approval",
|
|
requestedByAgentId: "agent-1",
|
|
requestedByUserId: null,
|
|
status: "pending",
|
|
payload: {
|
|
title: "Approve hosting spend",
|
|
text: "Estimated monthly cost is $42.",
|
|
},
|
|
decisionNote: null,
|
|
decidedByUserId: null,
|
|
decidedAt: null,
|
|
createdAt: new Date("2026-03-11T09:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T09:00:00.000Z"),
|
|
};
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[]}
|
|
linkedApprovals={[approval]}
|
|
agentMap={new Map([["agent-1", agent]])}
|
|
onAdd={async () => {}}
|
|
onApproveApproval={async () => {}}
|
|
onRejectApproval={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
const approvalRow = container.querySelector("#approval-approval-1") as HTMLDivElement | null;
|
|
expect(approvalRow).not.toBeNull();
|
|
expect(container.textContent).toContain("request_board_approval");
|
|
expect(container.textContent).toContain("Approve hosting spend");
|
|
expect(container.textContent).toContain("Approve");
|
|
expect(container.textContent).toContain("Reject");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("uses a larger copy control with feedback and a clipboard fallback", async () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[{
|
|
id: "comment-1",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
authorAgentId: null,
|
|
authorUserId: "user-1",
|
|
body: "Hello from the comment body",
|
|
authorType: "user",
|
|
presentation: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-03-11T11:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T11:00:00.000Z"),
|
|
}]}
|
|
onAdd={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
const copyButton = Array.from(container.querySelectorAll("button")).find(
|
|
(element) => element.getAttribute("aria-label") === "Copy comment as markdown",
|
|
) as HTMLButtonElement | undefined;
|
|
|
|
expect(copyButton).toBeDefined();
|
|
expect(copyButton?.className).toContain("min-h-8");
|
|
expect(copyButton?.textContent).toContain("Copy");
|
|
|
|
Object.defineProperty(window, "isSecureContext", {
|
|
value: false,
|
|
configurable: true,
|
|
});
|
|
|
|
await act(async () => {
|
|
copyButton?.click();
|
|
});
|
|
|
|
expect(writeTextMock).not.toHaveBeenCalled();
|
|
expect(execCommandMock).toHaveBeenCalledWith("copy");
|
|
expect(copyButton?.textContent).toContain("Copied");
|
|
|
|
act(() => {
|
|
vi.advanceTimersByTime(1500);
|
|
});
|
|
|
|
expect(copyButton?.textContent).toContain("Copy");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("passes externalReferences to MarkdownBody for comment bodies", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<MemoryRouter>
|
|
<CommentThread
|
|
comments={[{
|
|
id: "comment-ref",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
authorAgentId: null,
|
|
authorUserId: "user-1",
|
|
authorType: "user",
|
|
presentation: null,
|
|
metadata: null,
|
|
body: "See https://github.com/example/repo/pull/42 for context.",
|
|
createdAt: new Date("2026-03-11T11:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T11:00:00.000Z"),
|
|
}]}
|
|
externalReferences={{
|
|
"https://github.com/example/repo/pull/42": {
|
|
providerKey: "github",
|
|
objectType: "pull_request",
|
|
statusCategory: "open",
|
|
liveness: "fresh",
|
|
statusLabel: "Open",
|
|
displayTitle: "PR #42",
|
|
},
|
|
}}
|
|
onAdd={async () => {}}
|
|
/>
|
|
</MemoryRouter>,
|
|
);
|
|
});
|
|
|
|
const commentRow = container.querySelector("#comment-comment-ref") as HTMLDivElement | null;
|
|
expect(commentRow).not.toBeNull();
|
|
const markdownBody = commentRow?.querySelector('[data-testid="markdown-body"]') as HTMLElement | null;
|
|
expect(markdownBody?.getAttribute("data-external-reference-keys"))
|
|
.toContain("https://github.com/example/repo/pull/42");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|