mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-14 00:26:28 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - A repository project gets its working files from core staging or from a workspace storage plugin > - #20459 reported that an installed storage plugin attached every new repository project, so sandbox agents could not use those projects > - #20587 fixed creation with an **Available in** choice that selects storage > - #20651 then saved an environment on every new project and used it before the agent default to place runs. That solved a problem that did not exist: the project needs storage, not a run environment > - Creation saves the first environment of the chosen group, so a project silently sends every agent's runs to that environment. Project Configuration also shows two controls (Environment and Workspace storage) for one decision > - This pull request removes the project run environment and makes storage the only placement choice a project owns. Storage is fixed at creation > - The benefit is that runs follow the agent again, and project settings show one clear, read-only fact about storage ## Linked Issues or Issue Description Refs #20459. Follow-up to #20587 and #20651. Refs #11644. That issue asks for a project-level run environment override. This pull request removes the override that #20651 added for it, because the override is not necessary to fix #20459. #11644 stays a separate feature request. Related: #18176 (open) repairs placement through the legacy workspace-policy field. This pull request does not restore project placement, so it conflicts with the direction of #18176. ## What Changed - **Remove the project run environment.** Migration `0466` drops `projects.environment_id`. Run placement no longer reads the project. Runs use the agent default, then the instance default, then local execution. The low-trust task sandbox and the enforced sandbox policies keep their precedence. - **Keep the #20651 recovery and binding guards.** A recovered run still uses its admitted environment lease (source `run`). Company-binding checks before admission and during lease creation stay. - **Keep the creation choice.** **Available in** in New Project still selects storage. It still shows only when the environments need more than one storage owner. That can only occur when a storage plugin is installed. `POST /projects` with `environmentId` selects the storage of that environment and does not save the environment. - **Fix storage at creation.** `PATCH /projects/:id` rejects any storage change with `409 project_storage_locked`, from core to a plugin and from a plugin to core. Before, a core project could move to a plugin. - **Drop legacy writes.** Older clients can still send `executionWorkspacePolicy.environmentId`. The service removes it on create and update. - **Simplify Project Configuration.** Remove the Environment and Workspace storage selectors. Show an advisory **Available in** list of the environments that can use the project's storage. Show it when a storage plugin is installed or when the project uses one. When the project's plugin is not installed, show **Storage plugin unavailable**. Without a storage plugin, show nothing. - **Issue workspace card.** Remove the "project default" environment label. - **Shared contract.** Remove `Project.environmentId`, the `environmentId` project field, and `expectedStorageProviderPluginId` from the update schema. The create schema keeps `environmentId` and `expectedStorageProviderPluginId` from #20587. - **Docs and maps.** Update `doc/project-environment-compatibility.md`, `docs/api/goals-and-projects.md`, and the project feature and agent-access maps. - **SDK source pins.** Refresh `tests/runner-e2e/source-sdk-public-inputs.json` for the two shared files. The shared file blobs return to their values before #20651. The refresh also corrects the `pnpm-lock.yaml` pin and `lockSha256`: `master` pins an older lockfile blob than the one it contains. ## Verification - Targeted server suites pass (227 tests): `project-environments`, `project-workspace-provider.integration`, `heartbeat/environment-selection`, `execution-workspace-policy`, `environment-selection-route-guards`, `environment-run-orchestrator`, `openapi-routes`. - Related server suites pass (349 tests): `environment-service`, `environment-routes`, `plugin-workspaces.integration`, `issues-service`. - Targeted UI suites pass: `ProjectProperties.concurrency`, `IssueWorkspaceCard`, `NewProjectDialog`, `NewProjectDialog.managed-sandbox`, `ProjectDetail`. - New tests: - Creation saves storage, not an environment. Core and plugin projects both reject a storage change with `project_storage_locked`. - A legacy policy `environmentId` is dropped on create and update. - A new run follows the agent default for any project. A recovered run keeps its admitted lease after the agent default changes. - Project Configuration has no storage or environment selector. The note is hidden without a plugin. It lists the core or plugin environments for the project's storage. It shows **Storage plugin unavailable** for a removed plugin. - `pnpm --filter @paperclipai/server typecheck`, `pnpm --filter @paperclipai/ui typecheck`, and `pnpm --filter @paperclipai/shared typecheck` pass. - `pnpm --filter @paperclipai/db check:migrations`, `pnpm check:token-gates`, `node scripts/check-maps.mjs`, and `node tests/runner-e2e/source-sdk-public-inputs.mjs <HEAD> --check` pass. - Not run locally: the full `pnpm test:run`, `pnpm build`, and browser suites. CI supplies that coverage. - Manual check: open Project Configuration on an instance with a storage plugin. Confirm that there is no Environment or Workspace storage selector, and that **Available in** lists the environments. ## Risks - **Migration.** `0466` drops `projects.environment_id` and its foreign key. The migration deletes the saved project environments. Apply it before you serve the new revision. An old server revision that reads `projects` fails until it stops. This is the same pattern as earlier drop-column migrations (`0229`, `0289`). - **Behavior change for existing projects.** Projects created after #20651 shipped have a saved environment that overrides the agent. After this change, their runs follow the agent default again. This is the intended fix. Before #20651, a project environment selection was not applied to runs (#11644), so no older behavior is lost. - **No path from core to a plugin.** A core project, including one created before a plugin was installed, cannot move to the plugin. To use plugin storage, create a new project. - **API.** A `PATCH` that sends `environmentId` or `expectedStorageProviderPluginId` no longer has an effect. The schema strips these fields. > 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 - Claude Opus 5.5 (`claude-opus-5-5`) by Anthropic, in Claude Code, with tool use (shell, file edits, test runs). Extended thinking was available. ## 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
199 lines
10 KiB
TypeScript
199 lines
10 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { Project } from "@paperclipai/shared";
|
|
import type { ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { ProjectProperties } from "./ProjectProperties";
|
|
import { TooltipProvider } from "@/components/ui/tooltip";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
|
|
(globalThis as typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function act(callback: () => void) {
|
|
flushSync(() => {
|
|
callback();
|
|
});
|
|
}
|
|
|
|
const noop = vi.hoisted(() => () => undefined);
|
|
|
|
const environmentOptions = vi.hoisted(() => ({ groups: [
|
|
{ storageProviderPluginId: null, environments: [{ id: "local", name: "Local" }, { id: "sandbox", name: "Paperclip Sandbox" }] },
|
|
{ storageProviderPluginId: "provider-one", environments: [{ id: "computer", name: "Agent computers" }] },
|
|
], defaultEnvironmentId: "local", error: null }));
|
|
vi.mock("../api/projects", () => ({ projectsApi: { createWorkspace: vi.fn(), removeWorkspace: vi.fn(), updateWorkspace: vi.fn(),
|
|
environmentOptions: vi.fn(async () => environmentOptions) } }));
|
|
vi.mock("../api/goals", () => ({ goalsApi: { list: vi.fn().mockResolvedValue([]) } }));
|
|
vi.mock("../api/secrets", () => ({ secretsApi: { list: vi.fn().mockResolvedValue([]), listUserSecretDefinitions: vi.fn().mockResolvedValue([]), create: vi.fn() } }));
|
|
vi.mock("../api/environments", () => ({ environmentsApi: { list: vi.fn().mockResolvedValue([]) } }));
|
|
vi.mock("../api/instanceSettings", () => ({ instanceSettingsApi: { getExperimental: vi.fn().mockResolvedValue({ enableIsolatedWorkspaces: true }) } }));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({ companies: [{ id: "company-1", issuePrefix: "PAP" }], selectedCompanyId: "company-1", setSelectedCompanyId: vi.fn() }),
|
|
}));
|
|
|
|
// Heavy children that are unrelated to this control.
|
|
vi.mock("./environment-variables-editor", () => ({ EnvironmentVariablesEditor: () => null }));
|
|
vi.mock("./InlineEditor", () => ({ InlineEditor: ({ value }: { value?: ReactNode }) => <div>{value}</div> }));
|
|
vi.mock("./PathInstructionsModal", () => ({ ChoosePathButton: () => null }));
|
|
|
|
function makeProject(overrides: Partial<Project> = {}): Project {
|
|
return {
|
|
id: "project-1",
|
|
urlKey: "project-1",
|
|
name: "Test project",
|
|
description: "",
|
|
status: "in_progress",
|
|
goalIds: [],
|
|
goals: [],
|
|
env: null,
|
|
codebase: { workspaceId: null, repoUrl: null, repoRef: null, defaultRef: null, repoName: null },
|
|
primaryWorkspace: null,
|
|
workspaces: [],
|
|
executionWorkspacePolicy: { enabled: true, defaultMode: "shared_workspace", allowIssueOverride: true },
|
|
...overrides,
|
|
} as unknown as Project;
|
|
}
|
|
|
|
function primedClient(hiddenSettings: string[] = []) {
|
|
const client = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
client.setQueryData(queryKeys.health, { hiddenSettings });
|
|
client.setQueryData(queryKeys.instance.experimentalSettings, { enableIsolatedWorkspaces: true });
|
|
client.setQueryData(queryKeys.projects.environments("company-1"), environmentOptions);
|
|
return client;
|
|
}
|
|
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root.unmount());
|
|
container.remove();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
function render(project: Project, onFieldUpdate: (field: string, data: Record<string, unknown>) => void, hiddenSettings: string[] = []) {
|
|
act(() => {
|
|
root.render(
|
|
<QueryClientProvider client={primedClient(hiddenSettings)}>
|
|
<TooltipProvider>
|
|
<ProjectProperties project={project} onFieldUpdate={onFieldUpdate} getFieldSaveState={() => "idle"} onArchive={noop} />
|
|
</TooltipProvider>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
}
|
|
|
|
function concurrencySelect(): HTMLSelectElement {
|
|
const el = container.querySelector<HTMLSelectElement>('select[aria-label="Shared workspace concurrency"]');
|
|
if (!el) throw new Error("Shared workspace concurrency select not found");
|
|
return el;
|
|
}
|
|
|
|
describe("ProjectProperties — shared workspace concurrency select", () => {
|
|
it("defaults to Auto when the policy has no sharedWorkspaceConcurrency", () => {
|
|
render(makeProject(), vi.fn());
|
|
expect(concurrencySelect().value).toBe("auto");
|
|
expect(container.textContent).toContain("Concurrent runs on local/SSH runners");
|
|
});
|
|
|
|
it("reflects an existing serialize value and shows its helper text", () => {
|
|
render(
|
|
makeProject({
|
|
executionWorkspacePolicy: { enabled: true, defaultMode: "shared_workspace", sharedWorkspaceConcurrency: "serialize" },
|
|
} as Partial<Project>),
|
|
vi.fn(),
|
|
);
|
|
expect(concurrencySelect().value).toBe("serialize");
|
|
expect(container.textContent).toContain("Sandbox runs take turns in the shared project workspace");
|
|
expect(container.textContent).toContain("Local/SSH folders allow concurrent runs");
|
|
});
|
|
|
|
it("writes the picked value onto executionWorkspacePolicy when changed", () => {
|
|
const onFieldUpdate = vi.fn();
|
|
render(makeProject(), onFieldUpdate);
|
|
const select = concurrencySelect();
|
|
act(() => {
|
|
const setter = Object.getOwnPropertyDescriptor(window.HTMLSelectElement.prototype, "value")!.set!;
|
|
setter.call(select, "allow");
|
|
select.dispatchEvent(new Event("change", { bubbles: true }));
|
|
});
|
|
expect(onFieldUpdate).toHaveBeenCalledWith(
|
|
"execution_workspace_shared_concurrency",
|
|
expect.objectContaining({
|
|
executionWorkspacePolicy: expect.objectContaining({ sharedWorkspaceConcurrency: "allow" }),
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
|
|
it("hides project isolation controls without rewriting its policy", () => {
|
|
const onFieldUpdate = vi.fn();
|
|
render(makeProject(), onFieldUpdate, ["workspaces.isolation"]);
|
|
expect(container.textContent).not.toContain("Execution Workspaces");
|
|
expect(container.textContent).not.toContain("Enable isolated task checkouts");
|
|
expect(container.querySelector('select[aria-label="Shared workspace concurrency"]')).toBeNull();
|
|
expect(onFieldUpdate).not.toHaveBeenCalled();
|
|
});
|
|
|
|
|
|
describe("ProjectProperties — workspace storage availability", () => {
|
|
const inherited = {
|
|
source: "core" as const, pluginId: null, displayName: "Managed storage", error: null,
|
|
effectivePolicy: { enabled: true, defaultMode: "isolated_workspace" as const, storageProviderPluginId: "provider-one", workspaceStrategy: { type: "git_worktree" as const } },
|
|
providers: [{ id: "provider-one", displayName: "Managed storage", isDefault: true }, { id: "provider-two", displayName: "Alternative", isDefault: false }],
|
|
};
|
|
const core = { source: "core" as const, pluginId: null, displayName: "Core / local", error: null, effectivePolicy: null, providers: inherited.providers };
|
|
function note() { return container.querySelector('[data-testid="project-storage-availability"]'); }
|
|
it("offers no storage or environment control", () => {
|
|
render(makeProject({ companyId: "company-1", executionWorkspacePolicy: null, workspaceProvider: core }), vi.fn());
|
|
expect(container.querySelector('select[aria-label="Workspace storage provider"]')).toBeNull();
|
|
expect(container.querySelector('select[id^="project-environment-"]')).toBeNull();
|
|
});
|
|
it("hides the note when no storage plugin is installed", () => {
|
|
render(makeProject({ companyId: "company-1", executionWorkspacePolicy: null, workspaceProvider: { ...core, providers: [] } }), vi.fn());
|
|
expect(note()).toBeNull();
|
|
expect(container.textContent).not.toContain("Available in");
|
|
});
|
|
it("lists the environments that share a core project's storage when a plugin is installed", () => {
|
|
render(makeProject({ companyId: "company-1", executionWorkspacePolicy: null, workspaceProvider: core }), vi.fn());
|
|
expect(note()?.textContent).toContain("Available in");
|
|
expect(note()?.textContent).toContain("Local, Paperclip Sandbox");
|
|
expect(note()?.textContent).not.toContain("Agent computers");
|
|
expect(note()?.textContent).toContain("Core / local workspace storage was chosen when this project was created");
|
|
});
|
|
it("lists the plugin's environments for a plugin-backed project", () => {
|
|
render(makeProject({ companyId: "company-1", executionWorkspacePolicy: { enabled: true, storageProviderPluginId: "provider-one" },
|
|
workspaceProvider: { ...inherited, source: "project" as const, pluginId: "provider-one" } }), vi.fn());
|
|
expect(note()?.textContent).toContain("Agent computers");
|
|
expect(note()?.textContent).not.toContain("Paperclip Sandbox");
|
|
expect(note()?.textContent).toContain("Managed storage workspace storage");
|
|
});
|
|
it("reports an uninstalled storage plugin instead of hiding the note", () => {
|
|
render(makeProject({ companyId: "company-1", executionWorkspacePolicy: { enabled: true, storageProviderPluginId: "provider-one" },
|
|
workspaceProvider: { ...inherited, source: "project" as const, pluginId: "provider-one", displayName: "Unavailable provider",
|
|
providers: [], error: "The workspace storage plugin is unavailable" } }), vi.fn());
|
|
expect(note()?.querySelector('[role="alert"]')?.textContent).toBe("Storage plugin unavailable");
|
|
expect(note()?.querySelectorAll('[role="alert"]')).toHaveLength(1);
|
|
});
|
|
it("does not copy inherited mode, strategy, or provider when another setting changes", () => {
|
|
const onFieldUpdate = vi.fn();
|
|
render(makeProject({ executionWorkspacePolicy: null, workspaceProvider: inherited }), onFieldUpdate);
|
|
act(() => { concurrencySelect().value = "allow"; concurrencySelect().dispatchEvent(new Event("change", { bubbles: true })); });
|
|
expect(onFieldUpdate).toHaveBeenCalledWith("execution_workspace_shared_concurrency", { executionWorkspacePolicy: { enabled: true, sharedWorkspaceConcurrency: "allow" } });
|
|
});
|
|
it("shows a provider configuration error", () => {
|
|
render(makeProject({ workspaceProvider: { ...inherited, error: "The workspace storage plugin is unavailable" } }), vi.fn());
|
|
expect(container.querySelector('[role="alert"]')?.textContent).toContain("unavailable");
|
|
});
|
|
});
|