forked from farhoodlabs/paperclip
e89076148a
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - That operator experience depends not just on issue chat, but also on how workspaces, inbox groups, and navigation state behave over long-running sessions > - The current branch included a separate cluster of workspace-runtime controls, inbox grouping, sidebar ordering, and worktree lifecycle fixes > - Those changes cross server, shared contracts, database state, and UI navigation, but they still form one coherent operator workflow area > - This pull request isolates the workspace/runtime and navigation ergonomics work into one standalone branch > - The benefit is better workspace recovery and navigation persistence without forcing reviewers through the unrelated issue-detail/chat work ## What Changed - Improved execution workspace and project workspace controls, request wiring, layout, and JSON editor ergonomics - Hardened linked worktree reuse/startup behavior and documented the `worktree repair` flow for recovering linked worktrees safely - Added inbox workspace grouping, mobile collapse, archive undo, keyboard navigation, shared group-header styling, and persisted collapsed-group behavior - Added persistent sidebar order preferences with the supporting DB migration, shared/server contracts, routes, services, hooks, and UI integration - Scoped issue-list preferences by context and added targeted UI/server tests for workspace controls, inbox behavior, sidebar preferences, and worktree validation ## Verification - `pnpm vitest run server/src/__tests__/sidebar-preferences-routes.test.ts ui/src/pages/Inbox.test.tsx ui/src/components/ProjectWorkspaceSummaryCard.test.tsx ui/src/components/WorkspaceRuntimeControls.test.tsx ui/src/api/workspace-runtime-control.test.ts` - `server/src/__tests__/workspace-runtime.test.ts` was attempted, but the embedded Postgres suite self-skipped/hung on this host after reporting an init-script issue, so it is not counted as a local pass here ## Risks - Medium: this branch includes migration-backed preference storage plus worktree/runtime behavior, so merge review should pay attention to state persistence and worktree recovery semantics - The sidebar preference migration is standalone, but it should still be watched for conflicts if another migration lands first ## Model Used - OpenAI Codex coding agent (GPT-5-class runtime in Codex CLI; exact deployed model ID is not exposed in this environment), reasoning enabled, tool use and local code execution 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) - [ ] 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 - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
270 lines
8.5 KiB
TypeScript
270 lines
8.5 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import type { WorkspaceRuntimeService } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import {
|
|
buildWorkspaceRuntimeControlItems,
|
|
buildWorkspaceRuntimeControlSections,
|
|
WorkspaceRuntimeControls,
|
|
} from "./WorkspaceRuntimeControls";
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function createRuntimeService(overrides: Partial<WorkspaceRuntimeService> = {}): WorkspaceRuntimeService {
|
|
return {
|
|
id: overrides.id ?? "service-1",
|
|
companyId: overrides.companyId ?? "company-1",
|
|
projectId: overrides.projectId ?? "project-1",
|
|
projectWorkspaceId: overrides.projectWorkspaceId ?? "workspace-1",
|
|
executionWorkspaceId: overrides.executionWorkspaceId ?? null,
|
|
issueId: overrides.issueId ?? null,
|
|
scopeType: overrides.scopeType ?? "project_workspace",
|
|
scopeId: overrides.scopeId ?? "workspace-1",
|
|
serviceName: overrides.serviceName ?? "web",
|
|
status: overrides.status ?? "stopped",
|
|
lifecycle: overrides.lifecycle ?? "shared",
|
|
reuseKey: overrides.reuseKey ?? null,
|
|
command: overrides.command ?? "pnpm dev",
|
|
cwd: overrides.cwd ?? "/repo",
|
|
port: overrides.port ?? null,
|
|
url: overrides.url ?? null,
|
|
provider: overrides.provider ?? "local_process",
|
|
providerRef: overrides.providerRef ?? null,
|
|
ownerAgentId: overrides.ownerAgentId ?? null,
|
|
startedByRunId: overrides.startedByRunId ?? null,
|
|
lastUsedAt: overrides.lastUsedAt ?? new Date("2026-04-12T00:00:00.000Z"),
|
|
startedAt: overrides.startedAt ?? new Date("2026-04-12T00:00:00.000Z"),
|
|
stoppedAt: overrides.stoppedAt ?? null,
|
|
stopPolicy: overrides.stopPolicy ?? null,
|
|
healthStatus: overrides.healthStatus ?? "unknown",
|
|
configIndex: overrides.configIndex ?? null,
|
|
createdAt: overrides.createdAt ?? new Date("2026-04-12T00:00:00.000Z"),
|
|
updatedAt: overrides.updatedAt ?? new Date("2026-04-12T00:00:00.000Z"),
|
|
};
|
|
}
|
|
|
|
describe("buildWorkspaceRuntimeControlSections", () => {
|
|
it("separates service and job commands while matching running services", () => {
|
|
const sections = buildWorkspaceRuntimeControlSections({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
{ id: "db-migrate", name: "db:migrate", kind: "job", command: "pnpm db:migrate" },
|
|
],
|
|
},
|
|
runtimeServices: [
|
|
createRuntimeService({ id: "service-web", serviceName: "web", status: "running" }),
|
|
],
|
|
canStartServices: true,
|
|
canRunJobs: true,
|
|
});
|
|
|
|
expect(sections.services).toHaveLength(1);
|
|
expect(sections.jobs).toHaveLength(1);
|
|
expect(sections.services[0]).toMatchObject({
|
|
title: "web",
|
|
statusLabel: "running",
|
|
workspaceCommandId: "web",
|
|
runtimeServiceId: "service-web",
|
|
});
|
|
expect(sections.jobs[0]).toMatchObject({
|
|
title: "db:migrate",
|
|
statusLabel: "run once",
|
|
workspaceCommandId: "db-migrate",
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("buildWorkspaceRuntimeControlItems", () => {
|
|
it("keeps the legacy flat export shape for stale importers", () => {
|
|
const items = buildWorkspaceRuntimeControlItems({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
{ id: "db-migrate", name: "db:migrate", kind: "job", command: "pnpm db:migrate" },
|
|
],
|
|
},
|
|
runtimeServices: [
|
|
createRuntimeService({ id: "service-web", serviceName: "web", status: "running" }),
|
|
],
|
|
canStartServices: true,
|
|
canRunJobs: true,
|
|
});
|
|
|
|
expect(items).toHaveLength(1);
|
|
expect(items[0]).toMatchObject({
|
|
title: "web",
|
|
status: "running",
|
|
statusLabel: "running",
|
|
runtimeServiceId: "service-web",
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("WorkspaceRuntimeControls", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
document.body.innerHTML = "";
|
|
});
|
|
|
|
it("renders service and job actions distinctly", () => {
|
|
const sections = buildWorkspaceRuntimeControlSections({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
{ id: "db-migrate", name: "db:migrate", kind: "job", command: "pnpm db:migrate" },
|
|
],
|
|
},
|
|
runtimeServices: [
|
|
createRuntimeService({ id: "service-web", serviceName: "web", status: "running" }),
|
|
],
|
|
canStartServices: true,
|
|
canRunJobs: true,
|
|
});
|
|
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(
|
|
<WorkspaceRuntimeControls
|
|
sections={sections}
|
|
onAction={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
const buttons = Array.from(container.querySelectorAll("button")).map((button) => button.textContent?.trim());
|
|
expect(buttons).toEqual(["Stop", "Restart", "Run"]);
|
|
expect(container.textContent).toContain("Services");
|
|
expect(container.textContent).toContain("Jobs");
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("shows disabled actions when local command prerequisites are missing", () => {
|
|
const sections = buildWorkspaceRuntimeControlSections({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
{ id: "db-migrate", name: "db:migrate", kind: "job", command: "pnpm db:migrate" },
|
|
],
|
|
},
|
|
runtimeServices: [],
|
|
canStartServices: false,
|
|
canRunJobs: false,
|
|
});
|
|
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(
|
|
<WorkspaceRuntimeControls
|
|
sections={sections}
|
|
disabledHint="Add a workspace path first."
|
|
onAction={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
const buttons = Array.from(container.querySelectorAll("button"));
|
|
expect(buttons.every((button) => button.hasAttribute("disabled"))).toBe(true);
|
|
expect(container.textContent).toContain("Add a workspace path first.");
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("hides the disabled hint once services can already run", () => {
|
|
const sections = buildWorkspaceRuntimeControlSections({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
],
|
|
},
|
|
runtimeServices: [
|
|
createRuntimeService({ id: "service-web", serviceName: "web", status: "running" }),
|
|
],
|
|
canStartServices: true,
|
|
});
|
|
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(
|
|
<WorkspaceRuntimeControls
|
|
sections={sections}
|
|
disabledHint="Add runtime settings first."
|
|
onAction={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).not.toContain("Add runtime settings first.");
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("hides the health badge for stopped services", () => {
|
|
const sections = buildWorkspaceRuntimeControlSections({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
],
|
|
},
|
|
runtimeServices: [
|
|
createRuntimeService({ id: "service-web", serviceName: "web", status: "stopped", healthStatus: "unknown" }),
|
|
],
|
|
canStartServices: true,
|
|
});
|
|
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(
|
|
<WorkspaceRuntimeControls
|
|
sections={sections}
|
|
onAction={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).not.toContain("unknown");
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("accepts the legacy items prop without crashing", () => {
|
|
const items = buildWorkspaceRuntimeControlItems({
|
|
runtimeConfig: {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
],
|
|
},
|
|
runtimeServices: [],
|
|
canStartServices: false,
|
|
});
|
|
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(
|
|
<WorkspaceRuntimeControls
|
|
items={items}
|
|
emptyMessage="No runtime services have been started yet."
|
|
disabledHint="Add runtime settings first."
|
|
onAction={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).toContain("Services");
|
|
expect(container.textContent).toContain("Add runtime settings first.");
|
|
expect(Array.from(container.querySelectorAll("button")).map((button) => button.textContent?.trim())).toEqual(["Start"]);
|
|
|
|
act(() => root.unmount());
|
|
});
|
|
});
|