mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 06:15:21 +02:00
## Thinking Path > - Paperclip manages AI agents and their work. > - Workspace isolation keeps task checkouts separate. > - Managed hosts can enable isolation and hide its experimental toggles. > - Project, task, and routine forms still expose choices that override that policy. > - This pull request adds an operator visibility key for those controls. > - Workspace access stays available, and execution keeps its existing policy. ## Linked Issues or Issue Description **What existing behavior does this improve?** Operator control over workspace isolation settings in the UI. This follows the settings list cleanup in #13905. **Current behavior** Hiding the experimental isolation toggles leaves project policy editors, task selectors, routine and pipeline overrides, recovery actions, and workspace configuration visible. **Proposed behavior** Set `PAPERCLIP_HIDDEN_SETTINGS=workspaces.isolation` to hide these controls. Keep workspace navigation, status, files, and runtime access. Hide experimental toggles separately. Instances that do not set this key keep their controls. **Reason and benefit** Users on managed hosts should use the host's isolation default. A hidden form must not submit a stale draft that overrides it. ## What Changed - Add the UI-only `workspaces.isolation` key to the shared visibility registry. - Hide project workspace policy, task and subtask selectors, routine and pipeline overrides, and isolated re-issue actions. - Hide the workspace Configuration tab and redirect direct links to workspace issues. - Omit hidden new-task and routine overrides. Keep explicit task/subtask workspace launch context, saved policies, and automatic branch values for workspace routine runs. - Wait for the health visibility policy before showing controls. Keep workspace access and all execution APIs available. - Document the key and test visibility, form payloads, deep links, and unchanged workspace access. ## Verification - All 52 CI checks pass on `50cc770d33` (two expected skips). The branch is mergeable. Greptile is 5/5 with no unresolved comments. - `pnpm -r typecheck` passed. - `pnpm build` passed. - `pnpm check:token-gates` passed. - Targeted UI checks passed: 346 tests across 14 suites, including hidden project/task controls, stale task drafts, routine branch defaults, recovery actions, configuration deep links, and workspace access. - Shared settings-visibility tests passed: 11 tests. - `pnpm test:run` was run and stopped after reproducing five failures in unchanged server tests: two `chat-channels.integration` cases (linked-request provenance and direct external-chat finals) and three `company-skills-service` cases (runtime refresh, concurrent download, and explicit update). The earlier local run for #13905 showed the same failures. The full local suite is not claimed green. Targeted UI/shared checks pass. All PR CI shards, including the affected chat and skills suites, pass. - Reviewed the diff for secrets, private links, and run artifacts. ## Risks This key changes UI visibility only. It does not reject API calls or change feature values. Operators must enable isolation and its default through their existing policy mechanism. Older app versions ignore the new key until upgraded. Removing the key restores the controls. No schema changes. ## Model Used OpenAI GPT-6 (Codex), with reasoning, repository tools, and test execution. ## 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 linked existing issues or described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal ticket id - [x] I have run tests locally; targeted checks pass (full-suite limitation documented above) - [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>
387 lines
14 KiB
TypeScript
387 lines
14 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { ExecutionWorkspace, Project } from "@paperclipai/shared";
|
|
import { act, type ReactNode } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { ExecutionWorkspaceDetail } from "./ExecutionWorkspaceDetail";
|
|
|
|
(globalThis as typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
const mockExecutionWorkspacesApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
update: vi.fn(),
|
|
listWorkspaceOperations: vi.fn(),
|
|
controlRuntimeCommands: vi.fn(),
|
|
}));
|
|
const mockProjectsApi = vi.hoisted(() => ({ get: vi.fn() }));
|
|
const mockIssuesApi = vi.hoisted(() => ({ get: vi.fn(), list: vi.fn() }));
|
|
const mockAgentsApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockHeartbeatsApi = vi.hoisted(() => ({ liveRunsForCompany: vi.fn() }));
|
|
const mockRoutinesApi = vi.hoisted(() => ({ list: vi.fn(), get: vi.fn(), run: vi.fn() }));
|
|
const mockNavigate = vi.hoisted(() => vi.fn());
|
|
const mockSetBreadcrumbs = vi.hoisted(() => vi.fn());
|
|
const mockUsePluginSlots = vi.hoisted(() => vi.fn());
|
|
const mockPluginSlotOutlet = vi.hoisted(() => vi.fn());
|
|
const mockPluginSlotMount = vi.hoisted(() => vi.fn());
|
|
const mockSummarySlotCard = vi.hoisted(() => vi.fn());
|
|
const mockPluginSlotState = vi.hoisted(() => ({
|
|
slots: [] as unknown[],
|
|
isLoading: false,
|
|
errorMessage: null as string | null,
|
|
}));
|
|
const mockRouteLocation = vi.hoisted(() => ({
|
|
pathname: "/execution-workspaces/workspace-1/issues",
|
|
search: "",
|
|
}));
|
|
|
|
vi.mock("../api/execution-workspaces", () => ({ executionWorkspacesApi: mockExecutionWorkspacesApi }));
|
|
vi.mock("../api/projects", () => ({ projectsApi: mockProjectsApi }));
|
|
vi.mock("../api/issues", () => ({ issuesApi: mockIssuesApi }));
|
|
vi.mock("../api/agents", () => ({ agentsApi: mockAgentsApi }));
|
|
vi.mock("../api/heartbeats", () => ({ heartbeatsApi: mockHeartbeatsApi }));
|
|
vi.mock("../api/routines", () => ({ routinesApi: mockRoutinesApi }));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, to, className }: { children?: ReactNode; to: string; className?: string }) => (
|
|
<a href={to} className={className}>{children}</a>
|
|
),
|
|
Navigate: ({ to }: { to: string }) => <div data-testid="navigate">{to}</div>,
|
|
useLocation: () => ({ ...mockRouteLocation, hash: "", state: null }),
|
|
useNavigate: () => mockNavigate,
|
|
useParams: () => ({ workspaceId: "workspace-1" }),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
companies: [{ id: "company-1", issuePrefix: "PAP" }],
|
|
selectedCompanyId: "company-1",
|
|
setSelectedCompanyId: vi.fn(),
|
|
}),
|
|
}));
|
|
vi.mock("../context/BreadcrumbContext", () => ({ useBreadcrumbs: () => ({ setBreadcrumbs: mockSetBreadcrumbs }) }));
|
|
vi.mock("../context/ToastContext", () => ({ useToastActions: () => ({ pushToast: vi.fn() }) }));
|
|
|
|
vi.mock("@/plugins/slots", () => ({
|
|
PluginSlotMount: (props: unknown) => {
|
|
mockPluginSlotMount(props);
|
|
return <div data-testid="plugin-slot-mount" />;
|
|
},
|
|
PluginSlotOutlet: (props: unknown) => {
|
|
mockPluginSlotOutlet(props);
|
|
return <div data-testid="plugin-slot-outlet" />;
|
|
},
|
|
usePluginSlots: (filters: unknown) => {
|
|
mockUsePluginSlots(filters);
|
|
const entityType = (filters as { entityType?: string }).entityType;
|
|
return {
|
|
slots: entityType === "execution_workspace" ? mockPluginSlotState.slots : [],
|
|
isLoading: mockPluginSlotState.isLoading,
|
|
errorMessage: mockPluginSlotState.errorMessage,
|
|
};
|
|
},
|
|
}));
|
|
|
|
vi.mock("../components/IssuesList", () => ({
|
|
IssuesList: () => <div data-testid="issues-list" />,
|
|
}));
|
|
vi.mock("../components/SummarySlotCard", () => ({
|
|
SummarySlotCard: (props: unknown) => {
|
|
mockSummarySlotCard(props);
|
|
return <div data-testid="summary-slot-card" />;
|
|
},
|
|
}));
|
|
vi.mock("../components/ExecutionWorkspaceCloseDialog", () => ({
|
|
ExecutionWorkspaceCloseDialog: () => null,
|
|
}));
|
|
vi.mock("../components/RoutineRunVariablesDialog", () => ({
|
|
RoutineRunVariablesDialog: () => null,
|
|
}));
|
|
vi.mock("../components/WorkspaceRuntimeControls", () => ({
|
|
buildWorkspaceRuntimeControlSections: () => [],
|
|
buildWorkspaceServiceControlEntries: () => [],
|
|
resolveWorkspaceServiceControlRequests: () => [],
|
|
WorkspaceRuntimeControls: () => <div data-testid="runtime-controls" />,
|
|
}));
|
|
vi.mock("../components/WorkspaceServiceControlBar", () => ({
|
|
WorkspaceServiceControlBar: () => <div data-testid="service-control-bar" />,
|
|
}));
|
|
vi.mock("../components/PageTabBar", () => ({
|
|
PageTabBar: ({ items }: { items: Array<{ value: string; label: string }> }) => (
|
|
<div data-testid="page-tab-bar">
|
|
{items.map((item) => (
|
|
<button key={item.value} data-tab-value={item.value} type="button">{item.label}</button>
|
|
))}
|
|
</div>
|
|
),
|
|
}));
|
|
vi.mock("../components/CopyText", () => ({ CopyText: () => null }));
|
|
|
|
function workspace(overrides: Partial<ExecutionWorkspace> = {}): ExecutionWorkspace {
|
|
const now = new Date("2026-05-01T00:00:00Z");
|
|
return {
|
|
id: "workspace-1",
|
|
companyId: "company-1",
|
|
projectId: "project-1",
|
|
projectWorkspaceId: null,
|
|
sourceIssueId: null,
|
|
mode: "local",
|
|
strategyType: "local_worktree",
|
|
name: "Diff worktree",
|
|
status: "active",
|
|
cwd: "/tmp/workspace-1",
|
|
repoUrl: null,
|
|
baseRef: null,
|
|
branchName: null,
|
|
providerType: "local",
|
|
providerRef: null,
|
|
derivedFromExecutionWorkspaceId: null,
|
|
lastUsedAt: now,
|
|
openedAt: now,
|
|
closedAt: null,
|
|
cleanupEligibleAt: null,
|
|
cleanupReason: null,
|
|
config: null,
|
|
metadata: null,
|
|
runtimeServices: [],
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
...overrides,
|
|
} as ExecutionWorkspace;
|
|
}
|
|
|
|
function project(overrides: Partial<Project> = {}): Project {
|
|
const now = new Date("2026-05-01T00:00:00Z");
|
|
return {
|
|
id: "project-1",
|
|
companyId: "company-1",
|
|
urlKey: "project-1",
|
|
goalId: null,
|
|
goalIds: [],
|
|
goals: [],
|
|
name: "Test Project",
|
|
description: null,
|
|
status: "in_progress",
|
|
leadAgentId: null,
|
|
targetDate: null,
|
|
color: "#14b8a6",
|
|
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-1",
|
|
effectiveLocalFolder: "/tmp/project-1",
|
|
origin: "managed_checkout",
|
|
},
|
|
workspaces: [],
|
|
primaryWorkspace: null,
|
|
managedByPlugin: null,
|
|
archivedAt: null,
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function pluginSlot(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
id: "changes-tab",
|
|
type: "detailTab",
|
|
displayName: "Changes",
|
|
exportName: "ExecutionWorkspaceChangesTab",
|
|
entityTypes: ["execution_workspace"],
|
|
pluginId: "plugin-1",
|
|
pluginKey: "paperclip.workspace-diff",
|
|
pluginDisplayName: "Workspace Changes",
|
|
pluginVersion: "0.1.0",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
async function flush() {
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
}
|
|
|
|
describe("ExecutionWorkspaceDetail plugin slots", () => {
|
|
let root: Root | null = null;
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
mockExecutionWorkspacesApi.get.mockResolvedValue(workspace());
|
|
mockExecutionWorkspacesApi.listWorkspaceOperations.mockResolvedValue([]);
|
|
mockProjectsApi.get.mockResolvedValue(project());
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
mockAgentsApi.list.mockResolvedValue([]);
|
|
mockRoutinesApi.list.mockResolvedValue([]);
|
|
mockHeartbeatsApi.liveRunsForCompany.mockResolvedValue([]);
|
|
mockPluginSlotState.slots = [];
|
|
mockPluginSlotState.isLoading = false;
|
|
mockPluginSlotState.errorMessage = null;
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root?.unmount());
|
|
root = null;
|
|
container.remove();
|
|
vi.clearAllMocks();
|
|
mockRouteLocation.pathname = "/execution-workspaces/workspace-1/issues";
|
|
mockRouteLocation.search = "";
|
|
});
|
|
|
|
async function render(hiddenSettings: string[] = []) {
|
|
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
queryClient.setQueryData(queryKeys.health, { hiddenSettings });
|
|
await act(async () => {
|
|
root = createRoot(container);
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<ExecutionWorkspaceDetail />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await act(async () => {
|
|
await flush();
|
|
});
|
|
}
|
|
|
|
it("redirects a hidden configuration deep link to the workspace", async () => {
|
|
mockRouteLocation.pathname = "/execution-workspaces/workspace-1/configuration";
|
|
await render(["workspaces.isolation"]);
|
|
expect(container.querySelector('[data-testid="navigate"]')?.textContent).toBe("/execution-workspaces/workspace-1/issues");
|
|
expect(container.textContent).not.toContain("Workspace settings");
|
|
});
|
|
|
|
it("hides configuration while keeping workspace access", async () => {
|
|
await render(["workspaces.isolation"]);
|
|
expect(container.textContent).not.toContain("Configuration");
|
|
expect(container.textContent).toContain("Services");
|
|
});
|
|
|
|
it("scopes the plugin detail-tab discovery to execution_workspace and the workspace's company", async () => {
|
|
await render();
|
|
|
|
const enabledDetailTabFilters = mockUsePluginSlots.mock.calls
|
|
.map(([filters]) => filters as { slotTypes: string[]; entityType: string; companyId: string | null; enabled?: boolean })
|
|
.filter((filters) => filters.slotTypes.includes("detailTab") && filters.enabled !== false);
|
|
|
|
expect(enabledDetailTabFilters.length).toBeGreaterThan(0);
|
|
for (const filters of enabledDetailTabFilters) {
|
|
expect(filters.entityType).toBe("execution_workspace");
|
|
expect(filters.companyId).toBe("company-1");
|
|
}
|
|
});
|
|
|
|
it("mounts a toolbar PluginSlotOutlet with execution_workspace context", async () => {
|
|
await render();
|
|
|
|
const outletCalls = mockPluginSlotOutlet.mock.calls.map(([props]) => props as {
|
|
slotTypes: string[];
|
|
entityType: string;
|
|
context: { entityId: string; entityType: string; companyId: string; projectId: string };
|
|
});
|
|
const toolbarOutlet = outletCalls.find((props) => props.slotTypes.includes("toolbarButton"));
|
|
expect(toolbarOutlet).toBeDefined();
|
|
expect(toolbarOutlet?.entityType).toBe("execution_workspace");
|
|
expect(toolbarOutlet?.context).toMatchObject({
|
|
entityId: "workspace-1",
|
|
entityType: "execution_workspace",
|
|
companyId: "company-1",
|
|
projectId: "project-1",
|
|
});
|
|
});
|
|
|
|
it("shows a summary scoped to the execution workspace above tasks", async () => {
|
|
mockExecutionWorkspacesApi.get.mockResolvedValue(workspace({ projectWorkspaceId: "project-workspace-1" }));
|
|
|
|
await render();
|
|
|
|
expect(mockSummarySlotCard).toHaveBeenCalledWith(expect.objectContaining({
|
|
companyId: "company-1",
|
|
scopeKind: "execution_workspace",
|
|
scopeId: "workspace-1",
|
|
title: "Workspace summary",
|
|
}));
|
|
const summary = container.querySelector('[data-testid="summary-slot-card"]');
|
|
const issues = container.querySelector('[data-testid="issues-list"]');
|
|
expect(summary).not.toBeNull();
|
|
expect(issues).not.toBeNull();
|
|
if (!summary || !issues) throw new Error("Expected summary and issues list to render");
|
|
expect(summary.compareDocumentPosition(issues) & Node.DOCUMENT_POSITION_FOLLOWING).not.toBe(0);
|
|
});
|
|
|
|
it("shows an isolated summary for standalone execution workspaces", async () => {
|
|
await render();
|
|
|
|
expect(mockSummarySlotCard).toHaveBeenCalledWith(expect.objectContaining({
|
|
companyId: "company-1",
|
|
scopeKind: "execution_workspace",
|
|
scopeId: "workspace-1",
|
|
}));
|
|
expect(container.querySelector('[data-testid="summary-slot-card"]')).not.toBeNull();
|
|
});
|
|
|
|
it("does not show a workspace access status card", async () => {
|
|
await render();
|
|
|
|
expect(container.querySelector('[data-testid="workspace-access-card"]')).toBeNull();
|
|
expect(container.textContent).not.toContain("Workspace is not running");
|
|
expect(container.textContent).not.toContain("Open workspace");
|
|
});
|
|
|
|
it("does not mount plugin slots scoped to other entity types", async () => {
|
|
await render();
|
|
|
|
const outletCalls = mockPluginSlotOutlet.mock.calls.map(([props]) => props as { entityType: string });
|
|
for (const props of outletCalls) {
|
|
expect(props.entityType).toBe("execution_workspace");
|
|
}
|
|
});
|
|
|
|
it("shows a missing plugin placeholder instead of routines for stale plugin tab URLs", async () => {
|
|
mockRouteLocation.pathname = "/execution-workspaces/workspace-1";
|
|
mockRouteLocation.search = "?tab=plugin%3Amissing%3Aslot";
|
|
|
|
await render();
|
|
|
|
expect(container.textContent).toContain("Workspace plugin tab is not available.");
|
|
expect(container.querySelector('a[href="/execution-workspaces/workspace-1/issues"]')?.textContent).toBe("Back to tasks");
|
|
expect(container.textContent).not.toContain("Workspace routines");
|
|
expect(container.querySelector('[data-testid="plugin-slot-mount"]')).toBeNull();
|
|
});
|
|
|
|
it("orders execution workspace plugin tabs against built-in tabs by slot order", async () => {
|
|
mockPluginSlotState.slots = [
|
|
pluginSlot({ id: "default-tab", displayName: "Default" }),
|
|
pluginSlot({ id: "changes-tab", displayName: "Changes", order: 25 }),
|
|
pluginSlot({ id: "inspect-tab", displayName: "Inspect", order: 50 }),
|
|
];
|
|
|
|
await render();
|
|
|
|
const tabLabels = Array.from(container.querySelectorAll("[data-tab-value]")).map((tab) => tab.textContent);
|
|
expect(tabLabels).toEqual([
|
|
"Tasks",
|
|
"Services",
|
|
"Changes",
|
|
"Configuration",
|
|
"Runtime logs",
|
|
"Inspect",
|
|
"Routines",
|
|
"Default",
|
|
]);
|
|
});
|
|
});
|