mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-19 01:46:15 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to manage AI-agent companies and their work. > - Artifacts and documents are first-class outputs, but users need a personal way to keep important documents easy to find. > - Existing resource memberships already model per-user starred projects and agents with company scoping and activity logging. > - Documents lacked the equivalent membership model, route, and artifact filtering behavior. > - The shared membership contract also needs to remain safe for existing UI project/agent mutation helpers when documents become a recognized resource type. > - This pull request extends the existing resource-membership system with per-user document stars and a starred artifacts view. > - The benefit is a company-scoped, idempotent server foundation for a dedicated starred-documents experience without weakening authorization or artifact filtering semantics. ## Linked Issues or Issue Description ### Problem / Motivation Board users cannot star individual documents, and the company artifacts API cannot return only the current user's starred documents. ### Proposed Solution Add company/user-scoped document memberships, a board-only document star route, document membership data in the shared contract, and a `starred=true` artifacts filter. ### Alternatives Considered A document column was rejected because stars are per-user; a separate star API was rejected because projects and agents already use resource memberships. ### Roadmap Alignment This extends the existing Artifacts & Work Products roadmap area and does not duplicate another open pull request found in the repository search. ## What Changed - Added the `document_memberships` schema and migration with company/user/document uniqueness and starred ordering. - Extended shared resource-membership and artifact-query contracts for documents and `starred=true`. - Added company-scoped document star/unstar service and board-only route behavior with activity logging. - Added starred document artifact filtering, including user-authored documents, document kinds, cursor ordering, and incompatible-kind handling. - Preserved idempotency under concurrent star requests and synchronized UI membership defaults/helpers with the expanded contract. - Added focused shared, route, service, and UI regression coverage. ## Verification - `pnpm exec vitest run packages/shared/src/resource-memberships.test.ts server/src/__tests__/company-artifacts-service.test.ts server/src/__tests__/resource-memberships-routes.test.ts` - `pnpm exec vitest run ui/src/components/SidebarAgents.test.tsx ui/src/components/SidebarProjects.test.tsx ui/src/components/SidebarStarredProjects.test.tsx` - `pnpm --filter @paperclipai/db check:migrations` - `pnpm -r typecheck` - `pnpm test:run` - `pnpm build` ## Risks - The migration adds a new membership table and non-concurrent indexes; migration safety gates pass with the repository's established policy. - The starred artifacts query intentionally returns only documents and relaxes the normal agent-authored/system-kind predicates for documents the current user explicitly starred. - Document membership mutations remain board-user-only; agent callers receive no document-star capability. > 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 CLI; runtime model ID and context-window size were not exposed to this session. Reasoning, repository tool use, code execution, and test execution were enabled. ## 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>
217 lines
7.0 KiB
TypeScript
217 lines
7.0 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import type { ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { Project, ResourceMemberships } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { SidebarStarredProjects } from "./SidebarStarredProjects";
|
|
import { TooltipProvider } from "@/components/ui/tooltip";
|
|
|
|
const mockProjectsApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockResourceMembershipsApi = vi.hoisted(() => ({ listMine: vi.fn(), updateProject: vi.fn() }));
|
|
const mockPushToast = vi.hoisted(() => vi.fn());
|
|
const mockSetSidebarOpen = vi.hoisted(() => vi.fn());
|
|
const mockSidebarState = vi.hoisted(() => ({ isMobile: false, collapsed: false, peeking: false }));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
NavLink: ({ children, className, to, ...props }: {
|
|
children: ReactNode;
|
|
className?: string | ((state: { isActive: boolean }) => string);
|
|
to: string;
|
|
}) => (
|
|
<a href={to} className={typeof className === "function" ? className({ isActive: false }) : className} {...props}>
|
|
{children}
|
|
</a>
|
|
),
|
|
useLocation: () => ({ pathname: "/PAP/dashboard", search: "", hash: "", state: null }),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({ selectedCompanyId: "company-1", selectedCompany: { id: "company-1", issuePrefix: "PAP" } }),
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => ({
|
|
isMobile: mockSidebarState.isMobile,
|
|
setSidebarOpen: mockSetSidebarOpen,
|
|
collapsed: mockSidebarState.collapsed,
|
|
peeking: mockSidebarState.peeking,
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/ToastContext", () => ({
|
|
useToastActions: () => ({ pushToast: mockPushToast }),
|
|
}));
|
|
|
|
vi.mock("../api/projects", () => ({ projectsApi: mockProjectsApi }));
|
|
vi.mock("../api/resourceMemberships", () => ({ resourceMembershipsApi: mockResourceMembershipsApi }));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> = undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
await result;
|
|
}
|
|
|
|
function makeProject(overrides: Partial<Project>): Project {
|
|
return {
|
|
id: "project-a",
|
|
companyId: "company-1",
|
|
urlKey: "alpha",
|
|
goalId: null,
|
|
goalIds: [],
|
|
goals: [],
|
|
name: "Alpha",
|
|
description: null,
|
|
status: "in_progress",
|
|
leadAgentId: null,
|
|
targetDate: null,
|
|
color: "#ef4444",
|
|
icon: null,
|
|
env: null,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
executionWorkspacePolicy: null,
|
|
codebase: {
|
|
workspaceId: null,
|
|
repoUrl: null,
|
|
repoRef: null,
|
|
defaultRef: null,
|
|
repoName: null,
|
|
localFolder: null,
|
|
managedFolder: "/tmp/project-a",
|
|
effectiveLocalFolder: "/tmp/project-a",
|
|
origin: "local_folder",
|
|
},
|
|
workspaces: [],
|
|
primaryWorkspace: null,
|
|
managedByPlugin: null,
|
|
archivedAt: null,
|
|
createdAt: new Date("2026-01-01T00:00:00Z"),
|
|
updatedAt: new Date("2026-01-01T00:00:00Z"),
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
async function flushReact() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
|
|
function projectLinkLabels(container: HTMLElement) {
|
|
return Array.from(container.querySelectorAll('a[href$="/issues"]'))
|
|
.map((anchor) => anchor.textContent?.trim())
|
|
.filter(Boolean);
|
|
}
|
|
|
|
function projectLink(container: HTMLElement, projectRef: string) {
|
|
return container.querySelector(`a[href="/projects/${projectRef}/issues"]`) as HTMLAnchorElement | null;
|
|
}
|
|
|
|
describe("SidebarStarredProjects", () => {
|
|
let container: HTMLDivElement;
|
|
let root: ReturnType<typeof createRoot> | null;
|
|
let queryClient: QueryClient;
|
|
let memberships: ResourceMemberships;
|
|
|
|
beforeEach(() => {
|
|
mockSidebarState.isMobile = false;
|
|
mockSidebarState.collapsed = false;
|
|
mockSidebarState.peeking = false;
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = null;
|
|
queryClient = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false } } });
|
|
memberships = {
|
|
projectMemberships: {},
|
|
agentMemberships: {},
|
|
starredProjectIds: [],
|
|
starredAgentIds: [],
|
|
starredDocumentIds: [],
|
|
projectStarredAt: {},
|
|
agentStarredAt: {},
|
|
documentStarredAt: {},
|
|
updatedAt: null,
|
|
};
|
|
mockResourceMembershipsApi.listMine.mockImplementation(() => Promise.resolve(memberships));
|
|
mockProjectsApi.list.mockResolvedValue([]);
|
|
});
|
|
|
|
afterEach(async () => {
|
|
if (root) await act(async () => root?.unmount());
|
|
queryClient.clear();
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
async function render() {
|
|
root = createRoot(container);
|
|
await act(async () => {
|
|
root?.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<TooltipProvider>
|
|
<SidebarStarredProjects />
|
|
</TooltipProvider>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
}
|
|
|
|
it("renders only starred projects returned by the default active project list", async () => {
|
|
mockProjectsApi.list.mockResolvedValue([
|
|
makeProject({ id: "project-a", name: "Alpha", urlKey: "alpha" }),
|
|
makeProject({ id: "project-b", name: "Bravo", urlKey: "bravo" }),
|
|
]);
|
|
memberships = { ...memberships, starredProjectIds: ["project-b", "project-c"] };
|
|
|
|
await render();
|
|
|
|
// project-c is starred but absent because the default project list is server-filtered.
|
|
expect(projectLinkLabels(container)).toEqual(["Bravo"]);
|
|
expect(document.body.querySelector('button[aria-label="Unstar Bravo"]')).not.toBeNull();
|
|
});
|
|
|
|
it("keeps starred projects indented only outside the collapsed rail", async () => {
|
|
mockProjectsApi.list.mockResolvedValue([
|
|
makeProject({ id: "project-a", name: "Alpha", urlKey: "alpha" }),
|
|
]);
|
|
memberships = { ...memberships, starredProjectIds: ["project-a"] };
|
|
|
|
await render();
|
|
|
|
expect(projectLink(container, "alpha")?.className).toContain("pl-6");
|
|
|
|
await act(async () => root?.unmount());
|
|
root = null;
|
|
container.innerHTML = "";
|
|
queryClient = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false } } });
|
|
mockSidebarState.collapsed = true;
|
|
|
|
await render();
|
|
|
|
const railProjectLink = projectLink(container, "alpha");
|
|
expect(railProjectLink?.className).not.toContain("pl-6");
|
|
const nameSpan = Array.from(container.querySelectorAll("span")).find((el) => el.textContent === "Alpha");
|
|
expect(nameSpan?.className).toContain("w-0");
|
|
});
|
|
|
|
it("renders nothing when no projects are starred", async () => {
|
|
mockProjectsApi.list.mockResolvedValue([makeProject({ id: "project-a", name: "Alpha" })]);
|
|
|
|
await render();
|
|
|
|
expect(container.textContent).not.toContain("No starred projects yet");
|
|
expect(projectLinkLabels(container)).toEqual([]);
|
|
});
|
|
});
|