mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators need a way to inspect files and work products created by agents across a company without opening each issue one by one. > - The existing issue detail surfaces already show attachments and outputs, but there was no company-level artifacts index or search-result affordance for artifact-like records. > - The backend needed a company-scoped artifacts projection API that preserves issue/run attribution and safe links back to source records. > - The UI needed a first-class Artifacts page, sidebar entry, reusable artifact cards, and deep-link handling that keeps company prefixes intact. > - This pull request adds the company artifacts API and page, then wires artifacts into search and issue output surfaces. > - The benefit is a single place to browse, filter, and open generated work products and attachments while preserving company boundaries. ## Linked Issues or Issue Description Fixes #7622. Feature request fields: - Problem/motivation: company operators need a consolidated artifacts surface for attachments and work products produced by agents. - Proposed solution: add a company-scoped artifacts projection endpoint, a board Artifacts route, reusable cards, sidebar navigation, and artifact search integration. - Alternatives considered: keep artifact discovery only on individual issue pages; that forces operators to know the source issue before finding generated outputs. - Roadmap alignment: checked `ROADMAP.md`; this is a focused board UI/API improvement and does not duplicate a listed roadmap item. ## What Changed - Added shared artifact types and validators. - Added a company-scoped artifact projection service/API with tests for attachment/work-product attribution. - Added Artifacts board UI route, API client, sidebar link, cards, filters, and storybook coverage. - Added artifact result handling to company search and issue output/deep-link flows. - Rebased the branch onto the latest `public-gh/master` state and resolved the route-test conflict by preserving both upstream team-catalog coverage and artifact route coverage. - Fixed a local Sidebar test helper so it no longer depends on a runtime-undefined `React.act` export in this dependency install. ## Verification - `pnpm --filter @paperclipai/ui exec vitest run src/components/artifacts/ArtifactCard.test.tsx src/api/artifacts.test.ts src/lib/company-routes.test.ts` - `pnpm --filter @paperclipai/ui exec vitest run src/pages/Artifacts.test.tsx src/pages/Search.test.tsx src/components/Sidebar.test.tsx` - `pnpm exec vitest run server/src/__tests__/company-artifacts-service.test.ts server/src/__tests__/company-search-service.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts` - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows/*`. - Duplicate search: no open PRs or issues found for `artifact page ArtifactCard` in `paperclipai/paperclip`. Screenshots are intentionally omitted per the internal task instruction not to add design screenshots or images to this PR unless they are specifically part of the work. I also attempted browser capture in this runner, but `agent-browser` failed to launch Chrome and Playwright Chromium is missing `libatk-1.0.so.0`. ## Risks - Low-to-medium risk: this adds a new API projection and UI surface, so attribution/link regressions could affect artifact navigation. - Company scoping is covered in the new service/API tests. - No database migrations are included. - No lockfile or workflow changes are 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, GPT-5 coding agent with tool use and local command execution. Exact hosted model identifier is not exposed in this 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 - [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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots (intentionally omitted per task instruction; browser capture unavailable in this runner) - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] 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>
374 lines
13 KiB
TypeScript
374 lines
13 KiB
TypeScript
import { useMemo, useState, type DragEvent, type ReactNode } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import type { IssueAttachment } from "@paperclipai/shared";
|
|
import { Download, ExternalLink, FileText, Paperclip, Trash2 } from "lucide-react";
|
|
import { Button } from "@/components/ui/button";
|
|
import { FoldCurtain } from "./FoldCurtain";
|
|
import { MarkdownBody } from "./MarkdownBody";
|
|
import { OutputFileTile } from "./issue-output/OutputFileTile";
|
|
import { OutputVideoPlayer } from "./issue-output/OutputVideoPlayer";
|
|
import { formatBytes } from "@/lib/issue-output";
|
|
import {
|
|
attachmentDownloadPath,
|
|
attachmentFilename,
|
|
attachmentOpenPath,
|
|
isImageAttachment,
|
|
isMarkdownAttachment,
|
|
isVideoAttachment,
|
|
} from "@/lib/issue-attachments";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { cn } from "@/lib/utils";
|
|
|
|
interface IssueAttachmentsSectionProps {
|
|
attachments: IssueAttachment[];
|
|
uploadButton?: ReactNode;
|
|
error?: string | null;
|
|
dragActive?: boolean;
|
|
deletePending?: boolean;
|
|
onDelete: (attachmentId: string) => void;
|
|
onImageClick: (attachment: IssueAttachment) => void;
|
|
onDragEnter?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDragOver?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDragLeave?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDrop?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
}
|
|
|
|
async function fetchAttachmentText(attachment: IssueAttachment) {
|
|
const response = await fetch(attachment.contentPath, {
|
|
headers: { Accept: "text/markdown,text/plain;q=0.9,*/*;q=0.1" },
|
|
});
|
|
if (!response.ok) {
|
|
throw new Error(`Unable to load attachment preview (${response.status})`);
|
|
}
|
|
return response.text();
|
|
}
|
|
|
|
function AttachmentActions({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<div className="flex shrink-0 items-center gap-1">
|
|
<Button asChild variant="ghost" size="icon-sm" title="Open in new tab">
|
|
<a href={attachmentOpenPath(attachment)} target="_blank" rel="noreferrer" aria-label={`Open ${filename}`}>
|
|
<ExternalLink className="h-4 w-4" />
|
|
</a>
|
|
</Button>
|
|
<Button asChild variant="ghost" size="icon-sm" title="Download">
|
|
<a href={attachmentDownloadPath(attachment)} aria-label={`Download ${filename}`}>
|
|
<Download className="h-4 w-4" />
|
|
</a>
|
|
</Button>
|
|
<Button
|
|
variant="ghost"
|
|
size="icon-sm"
|
|
title="Delete attachment"
|
|
className="text-muted-foreground hover:text-destructive"
|
|
onClick={() => onDelete(attachment.id)}
|
|
disabled={deletePending}
|
|
>
|
|
<Trash2 className="h-4 w-4" />
|
|
</Button>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function AttachmentMeta({ attachment }: { attachment: IssueAttachment }) {
|
|
return (
|
|
<p className="mt-0.5 text-[11px] text-muted-foreground">
|
|
Attachment · {attachment.contentType} · {formatBytes(attachment.byteSize)}
|
|
</p>
|
|
);
|
|
}
|
|
|
|
function MarkdownAttachmentCard({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
const { data, isLoading, error } = useQuery({
|
|
queryKey: queryKeys.issues.attachmentPreview(attachment.id),
|
|
queryFn: () => fetchAttachmentText(attachment),
|
|
});
|
|
|
|
return (
|
|
<div id={`attachment-${attachment.id}`} className="scroll-mt-20 rounded-lg border border-border p-3">
|
|
<div className="flex items-start justify-between gap-3">
|
|
<div className="min-w-0">
|
|
<div className="flex min-w-0 items-center gap-2">
|
|
<FileText className="h-4 w-4 shrink-0 text-muted-foreground" />
|
|
<span className="truncate text-sm font-medium" title={filename}>{filename}</span>
|
|
</div>
|
|
<AttachmentMeta attachment={attachment} />
|
|
</div>
|
|
<AttachmentActions attachment={attachment} onDelete={onDelete} deletePending={deletePending} />
|
|
</div>
|
|
<div className="mt-3 rounded-md hover:bg-accent/10">
|
|
{isLoading ? (
|
|
<p className="px-1 py-2 text-xs text-muted-foreground">Loading preview...</p>
|
|
) : error ? (
|
|
<p className="px-1 py-2 text-xs text-destructive">Could not load markdown preview.</p>
|
|
) : (
|
|
<FoldCurtain>
|
|
<MarkdownBody className="paperclip-edit-in-place-content min-h-[220px] text-[15px] leading-7" softBreaks={false}>
|
|
{data ?? ""}
|
|
</MarkdownBody>
|
|
</FoldCurtain>
|
|
)}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function VideoAttachmentCard({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<div id={`attachment-${attachment.id}`} className="scroll-mt-20 overflow-hidden rounded-md border border-border bg-card">
|
|
<OutputVideoPlayer src={attachment.contentPath} title={filename} />
|
|
<div className="flex flex-col gap-2 p-3 md:flex-row md:items-center md:justify-between">
|
|
<div className="min-w-0">
|
|
<p className="break-words text-sm font-semibold text-foreground">{filename}</p>
|
|
<AttachmentMeta attachment={attachment} />
|
|
</div>
|
|
<AttachmentActions attachment={attachment} onDelete={onDelete} deletePending={deletePending} />
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function GenericAttachmentRow({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<div id={`attachment-${attachment.id}`} className="flex scroll-mt-20 items-center gap-2.5 rounded-md border border-border bg-card p-2">
|
|
<OutputFileTile contentType={attachment.contentType} />
|
|
<div className="min-w-0 flex-1">
|
|
<a
|
|
href={attachmentOpenPath(attachment)}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
className="block truncate text-sm font-medium text-foreground hover:underline"
|
|
title={filename}
|
|
>
|
|
{filename}
|
|
</a>
|
|
<p className="truncate text-[11px] text-muted-foreground">
|
|
Attachment · {attachment.contentType} · {formatBytes(attachment.byteSize)}
|
|
</p>
|
|
</div>
|
|
<AttachmentActions attachment={attachment} onDelete={onDelete} deletePending={deletePending} />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function IssueAttachmentsSection({
|
|
attachments,
|
|
uploadButton,
|
|
error,
|
|
dragActive = false,
|
|
deletePending = false,
|
|
onDelete,
|
|
onImageClick,
|
|
onDragEnter,
|
|
onDragOver,
|
|
onDragLeave,
|
|
onDrop,
|
|
}: IssueAttachmentsSectionProps) {
|
|
const [confirmDeleteId, setConfirmDeleteId] = useState<string | null>(null);
|
|
const { imageAttachments, markdownAttachments, videoAttachments, genericAttachments } = useMemo(() => {
|
|
const images: IssueAttachment[] = [];
|
|
const markdown: IssueAttachment[] = [];
|
|
const videos: IssueAttachment[] = [];
|
|
const generic: IssueAttachment[] = [];
|
|
|
|
for (const attachment of attachments) {
|
|
if (isImageAttachment(attachment)) images.push(attachment);
|
|
else if (isMarkdownAttachment(attachment)) markdown.push(attachment);
|
|
else if (isVideoAttachment(attachment)) videos.push(attachment);
|
|
else generic.push(attachment);
|
|
}
|
|
|
|
return {
|
|
imageAttachments: images,
|
|
markdownAttachments: markdown,
|
|
videoAttachments: videos,
|
|
genericAttachments: generic,
|
|
};
|
|
}, [attachments]);
|
|
|
|
const requestDelete = (attachmentId: string) => setConfirmDeleteId(attachmentId);
|
|
const confirmDelete = (attachmentId: string) => {
|
|
onDelete(attachmentId);
|
|
setConfirmDeleteId(null);
|
|
};
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
"space-y-3 rounded-lg transition-colors",
|
|
dragActive && "bg-primary/5",
|
|
)}
|
|
onDragEnter={onDragEnter}
|
|
onDragOver={onDragOver}
|
|
onDragLeave={onDragLeave}
|
|
onDrop={onDrop}
|
|
>
|
|
<div className="flex items-center justify-between gap-2">
|
|
<div className="flex items-center gap-2">
|
|
<Paperclip className="h-3.5 w-3.5 text-muted-foreground" aria-hidden="true" />
|
|
<h3 className="text-sm font-medium text-muted-foreground">Attachments</h3>
|
|
<span className="text-xs text-muted-foreground">{attachments.length}</span>
|
|
</div>
|
|
{uploadButton}
|
|
</div>
|
|
|
|
{error && (
|
|
<p className="text-xs text-destructive">{error}</p>
|
|
)}
|
|
|
|
{imageAttachments.length > 0 && (
|
|
<div className="grid grid-cols-4 gap-2">
|
|
{imageAttachments.map((attachment) => (
|
|
<div
|
|
key={attachment.id}
|
|
id={`attachment-${attachment.id}`}
|
|
className="group relative aspect-square cursor-pointer scroll-mt-20 overflow-hidden rounded-lg border border-border bg-accent/10"
|
|
onClick={() => onImageClick(attachment)}
|
|
>
|
|
<img
|
|
src={attachment.contentPath}
|
|
alt={attachment.originalFilename ?? "attachment"}
|
|
className="h-full w-full object-cover"
|
|
loading="lazy"
|
|
/>
|
|
<div className="absolute inset-0 bg-black/0 transition-colors group-hover:bg-black/30" />
|
|
{confirmDeleteId === attachment.id ? (
|
|
<div
|
|
className="absolute inset-0 flex flex-col items-center justify-center gap-1.5 bg-black/60"
|
|
onClick={(event) => event.stopPropagation()}
|
|
>
|
|
<p className="text-xs font-medium text-white">Delete?</p>
|
|
<div className="flex gap-1.5">
|
|
<button
|
|
type="button"
|
|
className="rounded bg-destructive px-2 py-0.5 text-xs text-white hover:bg-destructive/80"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
confirmDelete(attachment.id);
|
|
}}
|
|
disabled={deletePending}
|
|
>
|
|
Yes
|
|
</button>
|
|
<button
|
|
type="button"
|
|
className="rounded bg-muted px-2 py-0.5 text-xs hover:bg-muted/80"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
setConfirmDeleteId(null);
|
|
}}
|
|
>
|
|
No
|
|
</button>
|
|
</div>
|
|
</div>
|
|
) : (
|
|
<button
|
|
type="button"
|
|
className="absolute right-1.5 top-1.5 rounded-md bg-black/50 p-1 text-white opacity-0 transition-opacity hover:bg-destructive group-hover:opacity-100"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
requestDelete(attachment.id);
|
|
}}
|
|
title="Delete attachment"
|
|
>
|
|
<Trash2 className="h-3.5 w-3.5" />
|
|
</button>
|
|
)}
|
|
</div>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{markdownAttachments.length > 0 && (
|
|
<div className="space-y-3">
|
|
{markdownAttachments.map((attachment) => (
|
|
<MarkdownAttachmentCard
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={requestDelete}
|
|
deletePending={deletePending}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{videoAttachments.length > 0 && (
|
|
<div className="space-y-3">
|
|
{videoAttachments.map((attachment) => (
|
|
<VideoAttachmentCard
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={requestDelete}
|
|
deletePending={deletePending}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{genericAttachments.length > 0 && (
|
|
<div className="space-y-2">
|
|
{genericAttachments.map((attachment) => (
|
|
<GenericAttachmentRow
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={requestDelete}
|
|
deletePending={deletePending}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{confirmDeleteId && !imageAttachments.some((attachment) => attachment.id === confirmDeleteId) ? (
|
|
<div className="flex items-center justify-between gap-3 rounded-md border border-destructive/20 bg-destructive/5 px-4 py-3">
|
|
<p className="text-sm font-medium text-destructive">Delete this attachment? This cannot be undone.</p>
|
|
<div className="flex shrink-0 items-center gap-2">
|
|
<Button variant="ghost" size="sm" onClick={() => setConfirmDeleteId(null)} disabled={deletePending}>
|
|
Cancel
|
|
</Button>
|
|
<Button variant="destructive" size="sm" onClick={() => confirmDelete(confirmDeleteId)} disabled={deletePending}>
|
|
{deletePending ? "Deleting..." : "Delete"}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
) : null}
|
|
</div>
|
|
);
|
|
}
|