4693d770aa
## 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>
423 lines
12 KiB
TypeScript
423 lines
12 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import type { ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { MemoryRouter, Route, Routes } from "react-router-dom";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { Search, buildSearchUrl } from "./Search";
|
|
|
|
const companyState = vi.hoisted(() => ({
|
|
selectedCompanyId: "company-1",
|
|
}));
|
|
|
|
const breadcrumbState = vi.hoisted(() => ({
|
|
setBreadcrumbs: vi.fn(),
|
|
}));
|
|
|
|
const dialogState = vi.hoisted(() => ({
|
|
openNewIssue: vi.fn(),
|
|
}));
|
|
|
|
const navigateMock = vi.hoisted(() => vi.fn());
|
|
|
|
const searchApiMock = vi.hoisted(() => ({
|
|
search: vi.fn(),
|
|
}));
|
|
|
|
const agentsApiMock = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
}));
|
|
|
|
const projectsApiMock = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => companyState,
|
|
}));
|
|
|
|
vi.mock("../context/BreadcrumbContext", () => ({
|
|
useBreadcrumbs: () => breadcrumbState,
|
|
}));
|
|
|
|
vi.mock("../context/DialogContext", () => ({
|
|
useDialogActions: () => dialogState,
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => ({ isMobile: false, setSidebarOpen: vi.fn() }),
|
|
}));
|
|
|
|
vi.mock("../api/search", () => ({
|
|
searchApi: searchApiMock,
|
|
}));
|
|
|
|
vi.mock("../api/agents", () => ({
|
|
agentsApi: agentsApiMock,
|
|
}));
|
|
|
|
vi.mock("../api/projects", () => ({
|
|
projectsApi: projectsApiMock,
|
|
}));
|
|
|
|
vi.mock("@/lib/router", async () => {
|
|
const actual = await vi.importActual<typeof import("react-router-dom")>("react-router-dom");
|
|
return {
|
|
...actual,
|
|
useNavigate: () => navigateMock,
|
|
};
|
|
});
|
|
|
|
vi.mock("../components/StatusIcon", () => ({
|
|
StatusIcon: ({ status }: { status: string }) => <span data-status={status} />,
|
|
}));
|
|
|
|
vi.mock("../components/StatusBadge", () => ({
|
|
StatusBadge: ({ status }: { status: string }) => <span data-status-badge={status}>{status}</span>,
|
|
}));
|
|
|
|
vi.mock("../components/Identity", () => ({
|
|
Identity: ({ name }: { name: string }) => <span>{name}</span>,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function flush() {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
}
|
|
|
|
async function waitForAssertion(assertion: () => void, attempts = 50) {
|
|
let lastError: unknown;
|
|
for (let attempt = 0; attempt < attempts; attempt += 1) {
|
|
try {
|
|
assertion();
|
|
return;
|
|
} catch (error) {
|
|
lastError = error;
|
|
await flush();
|
|
}
|
|
}
|
|
throw lastError;
|
|
}
|
|
|
|
function renderSearch(initialPath: string, container: HTMLDivElement, node?: ReactNode) {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
flushSync(() => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<MemoryRouter initialEntries={[initialPath]}>
|
|
<Routes>
|
|
<Route path="/search" element={node ?? <Search />} />
|
|
</Routes>
|
|
</MemoryRouter>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
return { root, queryClient };
|
|
}
|
|
|
|
describe("buildSearchUrl", () => {
|
|
it("writes q and scope when provided", () => {
|
|
expect(buildSearchUrl("http://x/search", "auth flake", "comments")).toBe(
|
|
"/search?q=auth+flake&scope=comments",
|
|
);
|
|
});
|
|
|
|
it("clears q when empty and omits scope when scope=all", () => {
|
|
expect(buildSearchUrl("http://x/search?q=stale&scope=issues", "", "all")).toBe("/search");
|
|
});
|
|
|
|
it("preserves the existing pathname and hash", () => {
|
|
expect(buildSearchUrl("http://x/PAP/search?q=x#anchor", "y", "issues")).toBe(
|
|
"/PAP/search?q=y&scope=issues#anchor",
|
|
);
|
|
});
|
|
});
|
|
|
|
describe("Search page", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
breadcrumbState.setBreadcrumbs.mockReset();
|
|
dialogState.openNewIssue.mockReset();
|
|
navigateMock.mockReset();
|
|
searchApiMock.search.mockReset();
|
|
agentsApiMock.list.mockReset();
|
|
projectsApiMock.list.mockReset();
|
|
agentsApiMock.list.mockResolvedValue([]);
|
|
projectsApiMock.list.mockResolvedValue([]);
|
|
window.localStorage.clear();
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
});
|
|
|
|
it("issues a search request when ?q is in the URL and renders the result", async () => {
|
|
searchApiMock.search.mockResolvedValueOnce({
|
|
query: "auth flake",
|
|
normalizedQuery: "auth flake",
|
|
scope: "all",
|
|
limit: 20,
|
|
offset: 0,
|
|
countsByType: { issue: 1, artifact: 0, agent: 0, project: 0 },
|
|
hasMore: false,
|
|
results: [
|
|
{
|
|
id: "issue-1",
|
|
type: "issue",
|
|
score: 100,
|
|
title: "PAP-3142 Auth middleware flakes",
|
|
href: "/PAP/issues/PAP-3142",
|
|
matchedFields: ["title", "comment"],
|
|
sourceLabel: "Comment",
|
|
snippet: "we hit another flake",
|
|
snippets: [
|
|
{
|
|
field: "title",
|
|
label: "Title",
|
|
text: "Auth middleware flakes",
|
|
highlights: [{ start: 0, end: 4 }],
|
|
},
|
|
{
|
|
field: "comment",
|
|
label: "Comment",
|
|
text: "we hit another flake in the morning batch",
|
|
highlights: [{ start: 16, end: 21 }],
|
|
},
|
|
],
|
|
issue: {
|
|
id: "issue-1",
|
|
identifier: "PAP-3142",
|
|
title: "Auth middleware flakes",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
assigneeAgentId: null,
|
|
assigneeUserId: null,
|
|
projectId: null,
|
|
updatedAt: new Date().toISOString(),
|
|
},
|
|
updatedAt: new Date().toISOString(),
|
|
},
|
|
],
|
|
});
|
|
|
|
const { root } = renderSearch("/search?q=auth+flake", container);
|
|
|
|
await waitForAssertion(() => {
|
|
expect(searchApiMock.search).toHaveBeenCalledWith("company-1", {
|
|
q: "auth flake",
|
|
scope: "all",
|
|
limit: 20,
|
|
});
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(container.textContent).toContain("PAP-3142");
|
|
expect(container.textContent).toContain("Auth middleware flakes");
|
|
expect(container.textContent).toContain("1 result");
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders artifact search results in the company search surface", async () => {
|
|
searchApiMock.search.mockResolvedValueOnce({
|
|
query: "launch brief",
|
|
normalizedQuery: "launch brief",
|
|
scope: "artifacts",
|
|
limit: 20,
|
|
offset: 0,
|
|
countsByType: { issue: 0, artifact: 1, agent: 0, project: 0 },
|
|
hasMore: false,
|
|
results: [
|
|
{
|
|
id: "document:artifact-1",
|
|
type: "artifact",
|
|
score: 140,
|
|
title: "Launch Artifact Brief",
|
|
href: "/PAP/issues/PAP-42#document-brief",
|
|
matchedFields: ["artifact"],
|
|
sourceLabel: "Artifact",
|
|
snippet: "launch brief preview text",
|
|
snippets: [
|
|
{
|
|
field: "artifact",
|
|
label: "Artifact",
|
|
text: "launch brief preview text",
|
|
highlights: [{ start: 0, end: 6 }],
|
|
},
|
|
],
|
|
artifact: {
|
|
id: "document:artifact-1",
|
|
source: "document",
|
|
mediaKind: "document",
|
|
issueId: "issue-42",
|
|
issueIdentifier: "PAP-42",
|
|
issueTitle: "Ship launch artifacts",
|
|
projectId: null,
|
|
projectName: null,
|
|
updatedAt: new Date().toISOString(),
|
|
},
|
|
updatedAt: new Date().toISOString(),
|
|
previewImageUrl: null,
|
|
},
|
|
],
|
|
});
|
|
|
|
const { root } = renderSearch("/search?q=launch+brief&scope=artifacts", container);
|
|
|
|
await waitForAssertion(() => {
|
|
expect(searchApiMock.search).toHaveBeenCalledWith("company-1", {
|
|
q: "launch brief",
|
|
scope: "artifacts",
|
|
limit: 20,
|
|
});
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(container.textContent).toContain("Launch Artifact Brief");
|
|
expect(container.textContent).toContain("PAP-42");
|
|
expect(container.textContent).toContain("launch brief preview text");
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("debounces typing into the input and dispatches a search after the debounce window", async () => {
|
|
searchApiMock.search.mockResolvedValue({
|
|
query: "deflake",
|
|
normalizedQuery: "deflake",
|
|
scope: "all",
|
|
limit: 20,
|
|
offset: 0,
|
|
countsByType: { issue: 0, artifact: 0, agent: 0, project: 0 },
|
|
hasMore: false,
|
|
results: [],
|
|
});
|
|
|
|
const { root } = renderSearch("/search", container);
|
|
|
|
const input = container.querySelector('input[aria-label="Search query"]') as HTMLInputElement;
|
|
expect(input).not.toBeNull();
|
|
|
|
flushSync(() => {
|
|
const nativeSetter = Object.getOwnPropertyDescriptor(
|
|
HTMLInputElement.prototype,
|
|
"value",
|
|
)!.set!;
|
|
nativeSetter.call(input, "deflake");
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
// The debounce hasn't fired yet, so no API call should be made synchronously.
|
|
expect(searchApiMock.search).not.toHaveBeenCalled();
|
|
|
|
await new Promise((resolve) => setTimeout(resolve, 350));
|
|
|
|
await waitForAssertion(() => {
|
|
expect(searchApiMock.search).toHaveBeenCalledWith("company-1", {
|
|
q: "deflake",
|
|
scope: "all",
|
|
limit: 20,
|
|
});
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("auto-redirects an exact identifier match to the issue root, dropping any deep-link suffix", async () => {
|
|
searchApiMock.search.mockResolvedValueOnce({
|
|
query: "PAP-3366",
|
|
normalizedQuery: "pap-3366",
|
|
scope: "all",
|
|
limit: 20,
|
|
offset: 0,
|
|
countsByType: { issue: 1, artifact: 0, agent: 0, project: 0 },
|
|
hasMore: false,
|
|
results: [
|
|
{
|
|
id: "issue-3366",
|
|
type: "issue",
|
|
score: 1300,
|
|
title: "PAP-3366 Continuation summary",
|
|
href: "/PAP/issues/PAP-3366#document-continuation-summary",
|
|
matchedFields: ["identifier", "document"],
|
|
sourceLabel: "Document",
|
|
snippet: "Continuation summary excerpt",
|
|
snippets: [
|
|
{
|
|
field: "document",
|
|
label: "Continuation summary",
|
|
text: "Continuation summary excerpt",
|
|
highlights: [],
|
|
},
|
|
],
|
|
issue: {
|
|
id: "issue-3366",
|
|
identifier: "PAP-3366",
|
|
title: "Continuation summary",
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
assigneeAgentId: null,
|
|
assigneeUserId: null,
|
|
projectId: null,
|
|
updatedAt: new Date().toISOString(),
|
|
},
|
|
updatedAt: new Date().toISOString(),
|
|
},
|
|
],
|
|
});
|
|
|
|
const { root } = renderSearch("/search?q=PAP-3366", container);
|
|
|
|
await waitForAssertion(() => {
|
|
expect(navigateMock).toHaveBeenCalledWith("/PAP/issues/PAP-3366", { replace: true });
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders the no-results state with a Search-all action when scope is non-default", async () => {
|
|
searchApiMock.search.mockResolvedValueOnce({
|
|
query: "ghost",
|
|
normalizedQuery: "ghost",
|
|
scope: "comments",
|
|
limit: 20,
|
|
offset: 0,
|
|
countsByType: { issue: 0, artifact: 0, agent: 0, project: 0 },
|
|
hasMore: false,
|
|
results: [],
|
|
});
|
|
|
|
const { root } = renderSearch("/search?q=ghost&scope=comments", container);
|
|
|
|
await waitForAssertion(() => {
|
|
expect(container.textContent).toContain("No results for");
|
|
expect(container.textContent).toContain("ghost");
|
|
expect(container.textContent).toContain("Search all scopes");
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|