mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-06 23:20:53 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent work often ends with a Markdown or plain-text file. > - Task attachments currently open outside the task panel. > - Users need to inspect those files while keeping the task conversation in view. > - This pull request opens text attachments in task tabs and adds rendered, raw, and download controls. > - The same controls work in the mobile task drawer. ## Linked Issues or Issue Description **What happened?** Opening a text attachment did not put its content in a task tab. Markdown files had no in-task rendered/raw toggle. **Expected behavior** Open Markdown and text attachments in one reusable task tab. Show Markdown as rendered content or raw text. Download the original file. **Steps to reproduce** 1. Upload a Markdown file and a plain-text file to a task comment. 2. Open each attachment from the task conversation or artifact list. 3. Switch Markdown between Rendered and Raw. Download both files. 4. Repeat at a mobile viewport width. Related work: #14193 controls artifact tab arrival. This change adds text attachment content tabs. ## What Changed - Route text attachment opens from conversation and artifact cards into task tabs. - Add a text attachment panel with accessible Rendered, Raw, and Download controls. - Preserve ordinary links for other file types. - Support the selected attachment in the mobile drawer. - Keep text-tab actions on the current rich artifact cards, including CSV previews. - Render attachment image references and diagram source without loading media URLs. - Add browser regression tests, component tests, Storybook examples, and usage documentation. ## Verification - Full workspace typecheck, production build, Storybook build, and UI token gates pass locally. - All 6,960 UI tests pass. The additional media regression passes against the real Markdown renderer and fails before the fix. CSV coverage verifies direct downloads and text tabs after preview. - Both desktop and mobile browser cases pass locally. They check rendered/raw Markdown, literal plain text, reusable tabs, review controls, and exact original download bytes. The local fixture used a separate database port because an existing socket occupied the default range. - The full CI test matrix passes on `82be5efbef26927b237a031725bb3d7fa79f637f`. The duplicate local `pnpm test:run` was stopped after this CI result; it did not complete locally. - Greptile is 5/5 on the final commit. All review threads are resolved, and the security scan passes. - All 54 final-head checks pass, including the canary dry run. The two optional Storybook jobs are skipped. ## Risks - Text attachment links now open in the task panel. Other content types keep their existing link behavior. - File display still depends on the existing authenticated attachment route. There are no API or database changes. - Raw text is displayed as text, including strings that look like HTML. Rendered Markdown keeps media references inert. ## Model Used OpenAI Codex, based on GPT-6, with code execution, browser testing, and subagent tool use. The runtime does not expose an exact serving model variant or context-window size. Recovered earlier implementation changes were reviewed and tested; their exact model metadata is unavailable. ## 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>
104 lines
5.1 KiB
TypeScript
104 lines
5.1 KiB
TypeScript
import { useState } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import { Code2, Download, Eye } from "lucide-react";
|
|
import { issuesApi } from "@/api/issues";
|
|
import { Button } from "@/components/ui/button";
|
|
import { MarkdownBody } from "@/components/MarkdownBody";
|
|
import { attachmentDownloadPath, isMarkdownAttachment, isTextAttachment } from "@/lib/issue-attachments";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
|
|
export const TEXT_PREVIEW_MAX_BYTES = 512 * 1024;
|
|
|
|
/** Bound the actual response, not just producer-supplied attachment metadata. */
|
|
export async function readTextPreview(response: Response) {
|
|
if (!response.ok) throw new Error(`Could not load file (${response.status}).`);
|
|
if (!response.body) throw new Error("The file response is empty.");
|
|
const reader = response.body.getReader();
|
|
const decoder = new TextDecoder("utf-8", { fatal: true });
|
|
let bytes = 0;
|
|
let text = "";
|
|
try {
|
|
while (true) {
|
|
const chunk = await reader.read();
|
|
if (chunk.done) break;
|
|
bytes += chunk.value.byteLength;
|
|
if (bytes > TEXT_PREVIEW_MAX_BYTES) throw new Error("This file is too large to preview. Download it instead.");
|
|
text += decoder.decode(chunk.value, { stream: true });
|
|
}
|
|
text += decoder.decode();
|
|
if (text.includes("\0")) throw new Error("This file contains binary data. Download it instead.");
|
|
return text;
|
|
} finally {
|
|
await reader.cancel();
|
|
reader.releaseLock();
|
|
}
|
|
}
|
|
|
|
export function TextAttachmentPreview({ title, text, markdown, downloadUrl }: {
|
|
title: string;
|
|
text: string;
|
|
markdown: boolean;
|
|
downloadUrl: string;
|
|
}) {
|
|
const [raw, setRaw] = useState(false);
|
|
return (
|
|
<div className="flex h-full min-h-0 flex-col">
|
|
<header className="flex items-center gap-2 border-b border-border px-3 py-2">
|
|
<h2 className="min-w-0 flex-1 truncate text-sm font-medium" title={title}>{title}</h2>
|
|
{markdown ? (
|
|
<div className="flex gap-1" role="group" aria-label="Markdown view">
|
|
<Button size="icon-sm" variant={raw ? "ghost" : "secondary"} aria-label="Rendered" title="Rendered" aria-pressed={!raw} onClick={() => setRaw(false)}>
|
|
<Eye aria-hidden />
|
|
</Button>
|
|
<Button size="icon-sm" variant={raw ? "secondary" : "ghost"} aria-label="Raw" title="Raw" aria-pressed={raw} onClick={() => setRaw(true)}>
|
|
<Code2 aria-hidden />
|
|
</Button>
|
|
</div>
|
|
) : null}
|
|
<Button asChild variant="ghost" size="icon-sm">
|
|
<a href={downloadUrl} download aria-label={`Download ${title}`} title={`Download ${title}`}><Download aria-hidden /></a>
|
|
</Button>
|
|
</header>
|
|
<div className="min-h-0 flex-1 overflow-auto p-4">
|
|
{text.length === 0 ? <p className="text-sm text-muted-foreground">File is empty.</p>
|
|
: markdown && !raw ? <MarkdownBody mediaMode="reference">{text}</MarkdownBody>
|
|
: <pre className="whitespace-pre-wrap break-words font-mono text-sm" aria-label={`${title} raw text`}>{text}</pre>}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function TaskAttachmentPanel({ issueId, attachmentId }: { issueId: string; attachmentId: string }) {
|
|
const attachments = useQuery({
|
|
queryKey: queryKeys.issues.attachments(issueId),
|
|
queryFn: () => issuesApi.listAttachments(issueId),
|
|
});
|
|
// Re-resolve against this task's authorized attachment list; never trust persisted URLs.
|
|
const attachment = attachments.data?.find((item) => item.id === attachmentId);
|
|
const eligible = attachment && isTextAttachment(attachment) && attachment.byteSize <= TEXT_PREVIEW_MAX_BYTES;
|
|
const content = useQuery({
|
|
queryKey: ["task-text-attachment", issueId, attachmentId],
|
|
queryFn: async ({ signal }) => readTextPreview(await fetch(
|
|
`/api/attachments/${encodeURIComponent(attachmentId)}/content`,
|
|
{ signal, credentials: "same-origin" },
|
|
)),
|
|
enabled: Boolean(eligible),
|
|
retry: false,
|
|
});
|
|
if (attachments.isLoading) return <p className="p-4 text-sm" role="status">Loading file…</p>;
|
|
if (attachments.isError) return <div className="p-4" role="alert">Could not load attachment details. <Button onClick={() => void attachments.refetch()}>Retry</Button></div>;
|
|
if (!attachment) return <p className="p-4 text-sm" role="status">File no longer available. Close this tab or choose another file.</p>;
|
|
const downloadUrl = attachmentDownloadPath(attachment);
|
|
if (!eligible || content.isError) {
|
|
return (
|
|
<div className="space-y-3 p-4" role="alert">
|
|
<p className="text-sm">{content.isError ? "Could not preview this file. Retry or download it." : "This file is too large or is not supported for text preview. Download it instead."}</p>
|
|
{eligible ? <Button onClick={() => void content.refetch()}>Retry</Button> : null}
|
|
<Button asChild variant="outline"><a href={downloadUrl} download>Download file</a></Button>
|
|
</div>
|
|
);
|
|
}
|
|
if (content.data === undefined) return <p className="p-4 text-sm" role="status">Loading file…</p>;
|
|
return <TextAttachmentPreview title={attachment.originalFilename ?? attachment.id} text={content.data} markdown={isMarkdownAttachment(attachment)} downloadUrl={downloadUrl} />;
|
|
}
|