mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-15 03:51:22 +02:00
## Thinking Path > - Paperclip is the open source app that people use to manage AI agents for work. > - Instance settings control optional product features and developer tools. > - The experimental settings page mixed active experiments, internal tools, and old recovery controls. > - Some workspace links also used the selected company instead of the workspace owner. > - These problems made settings hard to scan and could send users to the wrong company route. > - This pull request removes old controls, groups developer settings, and resolves workspace links from workspace data. > - The benefit is a smaller settings surface and correct workspace navigation. ## Linked Issues or Issue Description **What existing behavior does this improve?** This improves the instance experimental settings page, task watchdog controls, dependency wake recovery, and execution workspace routes. **Current behavior** The settings page shows old recovery controls and mixes product experiments with internal developer settings. Task watchdogs require an extra feature flag. Some direct workspace links use the current company prefix instead of the company that owns the workspace. **Proposed behavior** Remove the old task recovery experiment and its unused API surface. Make task watchdog controls available without the removed flag. Put worktree execution and managed environment controls in the developer section. Resolve direct workspace links from the workspace owner and reject a company prefix that does not own the workspace. **Reason and benefit** The smaller settings page is easier to understand. The server keeps only the dependency wake backstop that it still uses. Workspace links open under the correct company route. **Breaking changes** This removes the experimental issue graph recovery preview and run endpoints. It also removes the task watchdog feature flag. Task watchdog data and dependency wake behavior remain available. ## What Changed - Removed the old task watchdog and issue graph recovery feature flags. - Removed the old issue graph recovery preview, run controls, API contracts, and unused recovery implementation. - Kept resolved dependency wakes as the scheduler backstop. - Grouped product experiments and Paperclip developer settings on the instance settings page. - Made task watchdog controls available without an extra experimental flag. - Added owner-aware redirects and company checks for execution workspace routes. - Hid the false stopped-state badge while a workspace has no active runtime state. - Updated focused server and UI tests for the new behavior. ## Verification - `pnpm check:token-gates` - `pnpm -r typecheck` - `pnpm build` - `pnpm test:run` completed with 5,620 passing tests and four failures in unchanged workspace runtime port tests. The same four failures repeat when the two files run alone. - The complete GitHub CI matrix passed, including all server, serialized server, build, canary, and end-to-end jobs. ## Risks - Clients that call the removed experimental recovery endpoints must stop calling them. - The route checks depend on workspace detail access. An unknown or cross-company workspace returns the global not-found page. - There are no database migrations, lockfile changes, workflow changes, or design image changes. > 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 with GPT-5. The exact deployment ID and context window are not exposed. Reasoning, tool use, and code 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>
212 lines
7.3 KiB
TypeScript
212 lines
7.3 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { WorkspaceAccessCard } from "./WorkspaceAccessCard";
|
|
import type { WorkspaceAccessState } from "../lib/workspace-access-state";
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function act(callback: () => void) {
|
|
flushSync(callback);
|
|
}
|
|
|
|
function accessState(overrides: Partial<WorkspaceAccessState> = {}): WorkspaceAccessState {
|
|
return {
|
|
state: "ready",
|
|
title: "Ready",
|
|
description: "Opening the workspace signs you in to the cloned board without a password.",
|
|
action: { kind: "open", label: "Open workspace" },
|
|
handoffAvailable: true,
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("WorkspaceAccessCard", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
document.body.innerHTML = "";
|
|
});
|
|
|
|
function renderCard(props: Partial<Parameters<typeof WorkspaceAccessCard>[0]> = {}) {
|
|
const handlers = {
|
|
onOpen: vi.fn(),
|
|
onStart: vi.fn(),
|
|
onRepair: vi.fn(),
|
|
onViewLogs: vi.fn(),
|
|
};
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<WorkspaceAccessCard access={accessState()} {...handlers} {...props} />);
|
|
});
|
|
const button = container.querySelector("button");
|
|
return { ...handlers, root, button };
|
|
}
|
|
|
|
function findButton(label: string) {
|
|
return Array.from(container.querySelectorAll("button")).find(
|
|
(candidate) => candidate.textContent?.trim() === label,
|
|
);
|
|
}
|
|
|
|
it("renders the ready state and opens without asking for a password", () => {
|
|
const { onOpen, root } = renderCard();
|
|
const card = container.querySelector("[data-testid='workspace-access-card']");
|
|
expect(card?.getAttribute("data-state")).toBe("ready");
|
|
expect(container.textContent).toContain("Ready");
|
|
expect(container.textContent).toContain("single-use login handoff");
|
|
|
|
const button = findButton("Open workspace");
|
|
expect(button).toBeDefined();
|
|
act(() => button!.click());
|
|
expect(onOpen).toHaveBeenCalledTimes(1);
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("keeps a superseded repair failure visible without hiding the open action", () => {
|
|
const { onOpen, onViewLogs, root } = renderCard({
|
|
access: accessState({
|
|
secondaryNotice: {
|
|
title: "Repair failed",
|
|
description: "The repair stopped during managed_restart. The pre-repair backup was kept.",
|
|
action: { kind: "view_logs", label: "View repair log" },
|
|
},
|
|
}),
|
|
});
|
|
|
|
const openButton = findButton("Open workspace");
|
|
const logButton = findButton("View repair log");
|
|
expect(openButton).toBeDefined();
|
|
expect(logButton).toBeDefined();
|
|
expect(container.querySelector("[data-testid='workspace-access-secondary-notice']")?.textContent)
|
|
.toContain("pre-repair backup was kept");
|
|
|
|
act(() => openButton!.click());
|
|
act(() => logButton!.click());
|
|
expect(onOpen).toHaveBeenCalledTimes(1);
|
|
expect(onViewLogs).toHaveBeenCalledTimes(1);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("labels the credential fallback accurately when no handoff is available", () => {
|
|
const { root } = renderCard({
|
|
access: accessState({
|
|
handoffAvailable: false,
|
|
description: "Opening the board will ask for the credentials captured in this snapshot.",
|
|
}),
|
|
});
|
|
expect(container.textContent).toContain("snapshot-local credentials captured");
|
|
expect(container.textContent).not.toContain("single-use login handoff");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("gives provisioning, degraded, and failed states their own safe action", () => {
|
|
const cases = [
|
|
{
|
|
access: accessState({
|
|
state: "provisioning" as const,
|
|
title: "Provisioning database",
|
|
action: { kind: "start" as const, label: "Start workspace" },
|
|
}),
|
|
label: "Start workspace",
|
|
handlerKey: "onStart" as const,
|
|
},
|
|
{
|
|
access: accessState({
|
|
state: "degraded" as const,
|
|
title: "Workspace is degraded",
|
|
action: { kind: "repair" as const, label: "Repair workspace" },
|
|
}),
|
|
label: "Repair workspace",
|
|
handlerKey: "onRepair" as const,
|
|
},
|
|
{
|
|
access: accessState({
|
|
state: "failed" as const,
|
|
title: "Repair failed",
|
|
action: { kind: "view_logs" as const, label: "View repair log" },
|
|
}),
|
|
label: "View repair log",
|
|
handlerKey: "onViewLogs" as const,
|
|
},
|
|
];
|
|
|
|
for (const testCase of cases) {
|
|
const rendered = renderCard({ access: testCase.access });
|
|
expect(container.textContent).toContain(testCase.access.title);
|
|
const button = findButton(testCase.label);
|
|
expect(button).toBeDefined();
|
|
expect(button!.disabled).toBe(false);
|
|
act(() => button!.click());
|
|
expect(rendered[testCase.handlerKey]).toHaveBeenCalledTimes(1);
|
|
act(() => rendered.root.unmount());
|
|
container.innerHTML = "";
|
|
}
|
|
});
|
|
|
|
it("offers nothing clickable while a repair is already running", () => {
|
|
const { root } = renderCard({
|
|
access: accessState({
|
|
state: "repairing",
|
|
title: "Repairing workspace database",
|
|
action: { kind: "wait", label: "Repair in progress" },
|
|
}),
|
|
});
|
|
expect(findButton("Repair in progress")?.disabled).toBe(true);
|
|
expect(
|
|
container.querySelector("[data-testid='workspace-access-badge']")?.textContent,
|
|
).toContain("Repairing");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("does not show a provisioning badge or spinner when the workspace can be started", () => {
|
|
const { root } = renderCard({
|
|
access: accessState({
|
|
state: "stopped",
|
|
title: "Workspace is not running",
|
|
description: "Start the workspace runtime to publish its board.",
|
|
action: { kind: "start", label: "Start workspace" },
|
|
}),
|
|
});
|
|
|
|
const badge = container.querySelector("[data-testid='workspace-access-badge']");
|
|
expect(badge).toBeNull();
|
|
expect(container.querySelector(".animate-spin")).toBeNull();
|
|
expect(findButton("Start workspace")).toBeDefined();
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("always names the state and the cause instead of a bare failure", () => {
|
|
const { root } = renderCard({
|
|
access: accessState({
|
|
state: "failed",
|
|
title: "Database provisioning failed",
|
|
description: "The clone failed during restore. Repairing replaces only the isolated database.",
|
|
action: { kind: "repair", label: "Repair workspace" },
|
|
}),
|
|
errorMessage: "Failed to open the workspace.",
|
|
});
|
|
expect(container.textContent).toContain("Database provisioning failed");
|
|
expect(container.textContent).toContain("failed during restore");
|
|
expect(
|
|
container.querySelector("[data-testid='workspace-access-error']")?.textContent,
|
|
).toContain("Failed to open the workspace.");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("disables the action while the caller reports it busy", () => {
|
|
const { root } = renderCard({ isBusy: true });
|
|
expect(findButton("Open workspace")?.disabled).toBe(true);
|
|
act(() => root.unmount());
|
|
});
|
|
});
|