1f70fd9a22
## Thinking Path > - Paperclip orchestrates AI agents across isolated execution workspaces; the local cwd is the only persistence boundary between runs. > - Workspace lifecycle (worktree_prepare → execute → workspace_finalize) and the wake/accept flow are what guarantee that dependent issues see a consistent worktree. > - PAPA-380 / PAPA-431 / PAPA-432 / PAPA-440 surfaced three holes in that contract: silent env reuse across assignees, dependent wakes firing before finalize, and `issue.interaction.accept` advancing before finalize landed. > - PAPA-441 / PAPA-442 then needed to document the "no remote git" contract and prevent future adapter/runtime code from quietly reintroducing `git push` as a backdoor sync. > - This pull request lands those server fixes, the static `check-no-git-push` enforcement, the AUTHORING.md cross-link, and the Cody-review follow-ups on the PAPA-430 thread. > - The benefit is that finalize is a real barrier — board accepts, dependent wakes, and operator-set env all respect it — and adapter code can't bypass it via raw `git push`. ## What Changed - **server (PAPA-380, PAPA-431):** `execution-workspace-policy` refuses silent env reuse when the assignee's resolved env disagrees with the workspace it would inherit. The inheritance protection is now scoped to the actual inheritance signal — explicit issue-level `environmentId` is honored even when the agent's default env is `null`. - **server (PAPA-432):** `heartbeat.ts` gates dependent wakes on `listUnfinalizedExecutionWorkspaceIds`, and writes a `workspace_finalize` row on the succeeded path. Write failures now surface instead of being swallowed so dependents aren't silently stranded behind a missing row. - **server (PAPA-440):** `issue-thread-interactions.acceptInteraction` adds a workspace_finalize precondition for `request_confirmation` (not `suggest_tasks`). Accept returns 409 if finalize hasn't succeeded for the latest workspace operation. - **ci (PAPA-442):** new `scripts/check-no-git-push.mjs` static check scans `packages/adapters/`, `packages/adapter-utils/`, `server/src/`, and `cli/src/` for any `git push` invocation (string or args-array). Wired into the `policy` PR job and `test:release-registry`. Operators can opt in per-call with `// paperclip:allow-git-push: <reason>`. Release scripts are out of scope by design. - **docs (PAPA-441):** `AUTHORING.md` documents the no-remote-git contract and cross-links the static check so adapter authors learn the rule and the enforcement together. - **review follow-up (PAPA-430, Cody):** three fixes — env resolver bug, accept-gate scope (request_confirmation only), and finalize record write on the succeeded path. ## Verification - `pnpm exec vitest run server/src/__tests__/execution-workspace-policy.test.ts server/src/__tests__/issue-thread-interactions-service.test.ts` → 33/33 pass - `node scripts/check-no-git-push.test.mjs` → check covers string form, args-array form, comment exclusions, and per-line allow-comment. - Manual: server compiles; the policy job runs the check in <1s before heavier jobs. ## Risks - **Behavioral shift in accept:** boards accepting `request_confirmation` while finalize is in-flight now get 409s. This is intentional — they can retry — but it changes timing on a hot path. `suggest_tasks` is unaffected. - **Workspace policy:** the env-reuse refusal is a new error path. Issues that previously silently reused an env from a different-assignee workspace will now fail-loud; the resolver still honors explicit issue-level `executionWorkspaceSettings.environmentId`. - **CI rule:** any future legitimate `git push` in scoped dirs must be marked with the allow-comment, which is the intended ergonomic. ## Model Used - Claude Opus 4.7 (`claude-opus-4-7`, extended thinking), via Claude Code in the Paperclip executor adapter. ## 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 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 (N/A — server/CI/docs only) - [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 Closes related issues: PAPA-430, PAPA-380, PAPA-431, PAPA-432, PAPA-440, PAPA-441, PAPA-442 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
335 lines
14 KiB
TypeScript
335 lines
14 KiB
TypeScript
import type {
|
|
ExecutionWorkspaceMode,
|
|
ExecutionWorkspaceStrategy,
|
|
IssueExecutionWorkspaceSettings,
|
|
ProjectExecutionWorkspaceDefaultMode,
|
|
ProjectExecutionWorkspacePolicy,
|
|
} from "@paperclipai/shared";
|
|
import { asString, parseObject } from "../adapters/utils.js";
|
|
|
|
type ParsedExecutionWorkspaceMode = Exclude<ExecutionWorkspaceMode, "inherit" | "reuse_existing">;
|
|
|
|
function cloneRecord(value: Record<string, unknown> | null | undefined): Record<string, unknown> | null {
|
|
if (!value) return null;
|
|
return { ...value };
|
|
}
|
|
|
|
function parseExecutionWorkspaceStrategy(raw: unknown): ExecutionWorkspaceStrategy | null {
|
|
const parsed = parseObject(raw);
|
|
const type = asString(parsed.type, "");
|
|
if (type !== "project_primary" && type !== "git_worktree" && type !== "adapter_managed" && type !== "cloud_sandbox") {
|
|
return null;
|
|
}
|
|
return {
|
|
type,
|
|
...(typeof parsed.baseRef === "string" ? { baseRef: parsed.baseRef } : {}),
|
|
...(typeof parsed.branchTemplate === "string" ? { branchTemplate: parsed.branchTemplate } : {}),
|
|
...(typeof parsed.worktreeParentDir === "string" ? { worktreeParentDir: parsed.worktreeParentDir } : {}),
|
|
...(typeof parsed.provisionCommand === "string" ? { provisionCommand: parsed.provisionCommand } : {}),
|
|
...(typeof parsed.teardownCommand === "string" ? { teardownCommand: parsed.teardownCommand } : {}),
|
|
};
|
|
}
|
|
|
|
export function parseProjectExecutionWorkspacePolicy(raw: unknown): ProjectExecutionWorkspacePolicy | null {
|
|
const parsed = parseObject(raw);
|
|
if (Object.keys(parsed).length === 0) return null;
|
|
const enabled = typeof parsed.enabled === "boolean" ? parsed.enabled : false;
|
|
const workspaceStrategy = parseExecutionWorkspaceStrategy(parsed.workspaceStrategy);
|
|
const defaultMode = asString(parsed.defaultMode, "");
|
|
const defaultProjectWorkspaceId =
|
|
typeof parsed.defaultProjectWorkspaceId === "string" ? parsed.defaultProjectWorkspaceId : undefined;
|
|
const environmentId = typeof parsed.environmentId === "string" ? parsed.environmentId : undefined;
|
|
const allowIssueOverride =
|
|
typeof parsed.allowIssueOverride === "boolean" ? parsed.allowIssueOverride : undefined;
|
|
const normalizedDefaultMode = (() => {
|
|
if (
|
|
defaultMode === "shared_workspace" ||
|
|
defaultMode === "isolated_workspace" ||
|
|
defaultMode === "operator_branch" ||
|
|
defaultMode === "adapter_default"
|
|
) {
|
|
return defaultMode as ProjectExecutionWorkspaceDefaultMode;
|
|
}
|
|
if (defaultMode === "project_primary") return "shared_workspace";
|
|
if (defaultMode === "isolated") return "isolated_workspace";
|
|
return undefined;
|
|
})();
|
|
return {
|
|
enabled,
|
|
...(normalizedDefaultMode ? { defaultMode: normalizedDefaultMode } : {}),
|
|
...(allowIssueOverride !== undefined ? { allowIssueOverride } : {}),
|
|
...(defaultProjectWorkspaceId ? { defaultProjectWorkspaceId } : {}),
|
|
...(environmentId !== undefined ? { environmentId } : {}),
|
|
...(workspaceStrategy ? { workspaceStrategy } : {}),
|
|
...(parsed.workspaceRuntime && typeof parsed.workspaceRuntime === "object" && !Array.isArray(parsed.workspaceRuntime)
|
|
? { workspaceRuntime: { ...(parsed.workspaceRuntime as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.branchPolicy && typeof parsed.branchPolicy === "object" && !Array.isArray(parsed.branchPolicy)
|
|
? { branchPolicy: { ...(parsed.branchPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.pullRequestPolicy && typeof parsed.pullRequestPolicy === "object" && !Array.isArray(parsed.pullRequestPolicy)
|
|
? { pullRequestPolicy: { ...(parsed.pullRequestPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.runtimePolicy && typeof parsed.runtimePolicy === "object" && !Array.isArray(parsed.runtimePolicy)
|
|
? { runtimePolicy: { ...(parsed.runtimePolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.cleanupPolicy && typeof parsed.cleanupPolicy === "object" && !Array.isArray(parsed.cleanupPolicy)
|
|
? { cleanupPolicy: { ...(parsed.cleanupPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
};
|
|
}
|
|
|
|
export function gateProjectExecutionWorkspacePolicy(
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null,
|
|
isolatedWorkspacesEnabled: boolean,
|
|
): ProjectExecutionWorkspacePolicy | null {
|
|
if (!isolatedWorkspacesEnabled) return null;
|
|
return projectPolicy;
|
|
}
|
|
|
|
export function parseIssueExecutionWorkspaceSettings(raw: unknown): IssueExecutionWorkspaceSettings | null {
|
|
const parsed = parseObject(raw);
|
|
if (Object.keys(parsed).length === 0) return null;
|
|
const workspaceStrategy = parseExecutionWorkspaceStrategy(parsed.workspaceStrategy);
|
|
const mode = asString(parsed.mode, "");
|
|
const normalizedMode = (() => {
|
|
if (
|
|
mode === "inherit" ||
|
|
mode === "shared_workspace" ||
|
|
mode === "isolated_workspace" ||
|
|
mode === "operator_branch" ||
|
|
mode === "reuse_existing" ||
|
|
mode === "agent_default"
|
|
) {
|
|
return mode;
|
|
}
|
|
if (mode === "project_primary") return "shared_workspace";
|
|
if (mode === "isolated") return "isolated_workspace";
|
|
return "";
|
|
})();
|
|
return {
|
|
...(normalizedMode
|
|
? { mode: normalizedMode as IssueExecutionWorkspaceSettings["mode"] }
|
|
: {}),
|
|
...(typeof parsed.environmentId === "string" ? { environmentId: parsed.environmentId } : {}),
|
|
...(workspaceStrategy ? { workspaceStrategy } : {}),
|
|
...(parsed.workspaceRuntime && typeof parsed.workspaceRuntime === "object" && !Array.isArray(parsed.workspaceRuntime)
|
|
? { workspaceRuntime: { ...(parsed.workspaceRuntime as Record<string, unknown>) } }
|
|
: {}),
|
|
};
|
|
}
|
|
|
|
export type ExecutionWorkspaceEnvironmentSource =
|
|
| "workspace"
|
|
| "issue"
|
|
| "project"
|
|
| "agent"
|
|
| "default";
|
|
|
|
export type ExecutionWorkspaceEnvironmentConflict = {
|
|
reason: "reused_workspace_environment_mismatch";
|
|
workspaceEnvironmentId: string;
|
|
assigneeIntendedEnvironmentId: string;
|
|
assigneeIntendedSource: Exclude<ExecutionWorkspaceEnvironmentSource, "workspace">;
|
|
};
|
|
|
|
export type ExecutionWorkspaceEnvironmentResolution = {
|
|
environmentId: string;
|
|
source: ExecutionWorkspaceEnvironmentSource;
|
|
conflict: ExecutionWorkspaceEnvironmentConflict | null;
|
|
};
|
|
|
|
function resolveAssigneeIntendedExecutionWorkspaceEnvironment(input: {
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
agentDefaultEnvironmentId: string | null;
|
|
defaultEnvironmentId: string;
|
|
}): {
|
|
environmentId: string;
|
|
source: Exclude<ExecutionWorkspaceEnvironmentSource, "workspace">;
|
|
} {
|
|
// Explicit issue-level env override always wins, even for null-default
|
|
// (local-only) agents. An operator who deliberately set
|
|
// `executionWorkspaceSettings.environmentId` on this specific issue (see the
|
|
// issues-service contract preserved in issues.ts:4243) chose that env for
|
|
// this assignment and should not be silently downgraded to the local default
|
|
// (PAPA-430 review fix). Inherited issue envs from
|
|
// `inheritExecutionWorkspaceFromIssueId` are stripped before this point in
|
|
// `resolveExecutionWorkspaceEnvironmentId`.
|
|
if (input.issueSettings?.environmentId !== undefined) {
|
|
return {
|
|
environmentId: input.issueSettings.environmentId ?? input.defaultEnvironmentId,
|
|
source: "issue",
|
|
};
|
|
}
|
|
// A null defaultEnvironmentId on the agent means it is deliberately scoped to
|
|
// the local default (e.g. Manual QA today). Project policy must not promote
|
|
// such an agent off of local — only an explicit issue-level override above
|
|
// can move the assignee away from the local default.
|
|
if (input.agentDefaultEnvironmentId === null) {
|
|
return { environmentId: input.defaultEnvironmentId, source: "default" };
|
|
}
|
|
if (input.projectPolicy?.environmentId !== undefined) {
|
|
return {
|
|
environmentId: input.projectPolicy.environmentId ?? input.defaultEnvironmentId,
|
|
source: "project",
|
|
};
|
|
}
|
|
return { environmentId: input.agentDefaultEnvironmentId, source: "agent" };
|
|
}
|
|
|
|
export function resolveExecutionWorkspaceEnvironmentId(input: {
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
workspaceConfig: { environmentId?: string | null } | null;
|
|
agentDefaultEnvironmentId: string | null;
|
|
defaultEnvironmentId: string;
|
|
}): ExecutionWorkspaceEnvironmentResolution {
|
|
// PAPA-431 companion: when the assignee has no explicit defaultEnvironmentId
|
|
// (deliberately local-only, e.g. Manual QA) AND the issue settings env exactly
|
|
// matches the reused workspace env, treat the issue env as a promoted artifact
|
|
// from `inheritExecutionWorkspaceFromIssueId` rather than a deliberate
|
|
// operator choice. Strip it so the resolver falls back to the local default
|
|
// and the workspace-vs-intended conflict check forces a fresh realization.
|
|
// A genuine operator override (via PATCH on the issue) reaches this code path
|
|
// either with no reused workspace (workspaceConfig === null) or against a
|
|
// workspace whose persisted env does not match the new override; both keep
|
|
// the issue setting in place.
|
|
const inheritedIssueEnvOnNullDefaultAssignee =
|
|
input.agentDefaultEnvironmentId === null &&
|
|
input.workspaceConfig?.environmentId !== undefined &&
|
|
input.workspaceConfig?.environmentId !== null &&
|
|
input.issueSettings?.environmentId !== undefined &&
|
|
input.issueSettings.environmentId === input.workspaceConfig.environmentId;
|
|
let issueSettingsForResolution = input.issueSettings;
|
|
if (inheritedIssueEnvOnNullDefaultAssignee && input.issueSettings) {
|
|
const { environmentId: _droppedInheritedEnv, ...rest } = input.issueSettings;
|
|
void _droppedInheritedEnv;
|
|
issueSettingsForResolution = rest as IssueExecutionWorkspaceSettings;
|
|
}
|
|
|
|
const assigneeIntended = resolveAssigneeIntendedExecutionWorkspaceEnvironment({
|
|
projectPolicy: input.projectPolicy,
|
|
issueSettings: issueSettingsForResolution,
|
|
agentDefaultEnvironmentId: input.agentDefaultEnvironmentId,
|
|
defaultEnvironmentId: input.defaultEnvironmentId,
|
|
});
|
|
|
|
if (input.workspaceConfig?.environmentId !== undefined) {
|
|
const workspaceEnvironmentId =
|
|
input.workspaceConfig.environmentId ?? input.defaultEnvironmentId;
|
|
// PAPA-380 / PAPA-431: a reused workspace's persisted environmentId must
|
|
// never silently shadow the current assignee's environment identity.
|
|
// When they disagree, refuse the silent reuse: return the assignee's
|
|
// intended env and surface a conflict signal so the caller forces a fresh
|
|
// workspace realization (or otherwise alerts the operator) instead of
|
|
// running the agent on someone else's environment.
|
|
if (workspaceEnvironmentId !== assigneeIntended.environmentId) {
|
|
return {
|
|
environmentId: assigneeIntended.environmentId,
|
|
source: assigneeIntended.source,
|
|
conflict: {
|
|
reason: "reused_workspace_environment_mismatch",
|
|
workspaceEnvironmentId,
|
|
assigneeIntendedEnvironmentId: assigneeIntended.environmentId,
|
|
assigneeIntendedSource: assigneeIntended.source,
|
|
},
|
|
};
|
|
}
|
|
return { environmentId: workspaceEnvironmentId, source: "workspace", conflict: null };
|
|
}
|
|
return { environmentId: assigneeIntended.environmentId, source: assigneeIntended.source, conflict: null };
|
|
}
|
|
|
|
export function defaultIssueExecutionWorkspaceSettingsForProject(
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null,
|
|
): IssueExecutionWorkspaceSettings | null {
|
|
if (!projectPolicy?.enabled) return null;
|
|
return {
|
|
mode:
|
|
projectPolicy.defaultMode === "isolated_workspace"
|
|
? "isolated_workspace"
|
|
: projectPolicy.defaultMode === "operator_branch"
|
|
? "operator_branch"
|
|
: projectPolicy.defaultMode === "adapter_default"
|
|
? "agent_default"
|
|
: "shared_workspace",
|
|
};
|
|
}
|
|
|
|
export function issueExecutionWorkspaceModeForPersistedWorkspace(
|
|
mode: string | null | undefined,
|
|
): IssueExecutionWorkspaceSettings["mode"] {
|
|
if (mode === null || mode === undefined) {
|
|
return "agent_default";
|
|
}
|
|
if (mode === "isolated_workspace" || mode === "operator_branch" || mode === "shared_workspace") {
|
|
return mode;
|
|
}
|
|
if (mode === "adapter_managed" || mode === "cloud_sandbox") {
|
|
return "agent_default";
|
|
}
|
|
return "shared_workspace";
|
|
}
|
|
|
|
export function resolveExecutionWorkspaceMode(input: {
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
legacyUseProjectWorkspace: boolean | null;
|
|
}): ParsedExecutionWorkspaceMode {
|
|
const issueMode = input.issueSettings?.mode;
|
|
if (issueMode && issueMode !== "inherit" && issueMode !== "reuse_existing") {
|
|
return issueMode;
|
|
}
|
|
if (input.projectPolicy?.enabled) {
|
|
if (input.projectPolicy.defaultMode === "isolated_workspace") return "isolated_workspace";
|
|
if (input.projectPolicy.defaultMode === "operator_branch") return "operator_branch";
|
|
if (input.projectPolicy.defaultMode === "adapter_default") return "agent_default";
|
|
return "shared_workspace";
|
|
}
|
|
if (input.legacyUseProjectWorkspace === false) {
|
|
return "agent_default";
|
|
}
|
|
return "shared_workspace";
|
|
}
|
|
|
|
export function buildExecutionWorkspaceAdapterConfig(input: {
|
|
agentConfig: Record<string, unknown>;
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
mode: ParsedExecutionWorkspaceMode;
|
|
legacyUseProjectWorkspace: boolean | null;
|
|
}): Record<string, unknown> {
|
|
const nextConfig = { ...input.agentConfig };
|
|
const projectHasPolicy = Boolean(input.projectPolicy?.enabled);
|
|
const issueHasWorkspaceOverrides = Boolean(
|
|
input.issueSettings?.mode ||
|
|
input.issueSettings?.workspaceStrategy ||
|
|
input.issueSettings?.workspaceRuntime,
|
|
);
|
|
const hasWorkspaceControl = projectHasPolicy || issueHasWorkspaceOverrides || input.legacyUseProjectWorkspace === false;
|
|
|
|
if (hasWorkspaceControl) {
|
|
if (input.mode === "isolated_workspace") {
|
|
const strategy =
|
|
input.issueSettings?.workspaceStrategy ??
|
|
input.projectPolicy?.workspaceStrategy ??
|
|
parseExecutionWorkspaceStrategy(nextConfig.workspaceStrategy) ??
|
|
({ type: "git_worktree" } satisfies ExecutionWorkspaceStrategy);
|
|
nextConfig.workspaceStrategy = strategy as unknown as Record<string, unknown>;
|
|
} else {
|
|
delete nextConfig.workspaceStrategy;
|
|
}
|
|
|
|
if (input.mode === "agent_default") {
|
|
delete nextConfig.workspaceRuntime;
|
|
} else if (input.issueSettings?.workspaceRuntime) {
|
|
nextConfig.workspaceRuntime = cloneRecord(input.issueSettings.workspaceRuntime) ?? undefined;
|
|
} else if (input.projectPolicy?.workspaceRuntime) {
|
|
nextConfig.workspaceRuntime = cloneRecord(input.projectPolicy.workspaceRuntime) ?? undefined;
|
|
}
|
|
}
|
|
|
|
return nextConfig;
|
|
}
|