mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
## Thinking Path > - Paperclip is a control plane for autonomous AI companies where work must stay observable, governable, and recoverable. > - The task/heartbeat subsystem owns agent execution continuity, issue state transitions, and visible recovery behavior. > - Waiting on an external service is not the same as being blocked when the assignee still owns a future check. > - The gap was that agents had no first-class one-shot monitor state for external-service waits, so recovery could look stalled or require ad hoc comments. > - This pull request adds bounded issue monitors that can wake the owner, clear exhausted waits, and produce explicit recovery behavior. > - It also surfaces monitor status in the board UI and documents when to use monitors versus `blocked`. > - The benefit is clearer liveness semantics for asynchronous waits without weakening single-assignee task ownership. ## What Changed - Added issue monitor fields, shared types, validators, constants, and an idempotent `0075` migration for scheduled monitor state. - Added server-side monitor scheduling, dispatch, recovery bounds, activity logging, and external-ref redaction. - Added board/agent route coverage for monitor permissions and child monitor scheduling. - Added issue detail/property UI for monitor state, a monitor activity card, and Storybook stories for review surfaces. - Documented monitor semantics and recovery policy behavior in `doc/execution-semantics.md`. - Addressed Greptile review feedback by preserving monitor state in skipped-stage builders and making board monitor saves send `scheduledBy: "board"`. ## Verification - `pnpm install --frozen-lockfile` - `pnpm run preflight:workspace-links && pnpm exec vitest run server/src/__tests__/issue-execution-policy-routes.test.ts server/src/__tests__/issue-execution-policy.test.ts server/src/__tests__/issue-monitor-scheduler.test.ts server/src/__tests__/recovery-classifiers.test.ts ui/src/components/IssueMonitorActivityCard.test.tsx ui/src/components/IssueProperties.test.tsx ui/src/lib/activity-format.test.ts` - First run passed 5 files and failed to collect 2 server suites because the worktree was missing the optional `acpx/runtime` dependency. - After `pnpm install --frozen-lockfile`, reran the 2 failed suites successfully. - `pnpm exec vitest run server/src/__tests__/issue-monitor-scheduler.test.ts server/src/__tests__/recovery-classifiers.test.ts` - `pnpm --filter @paperclipai/shared typecheck && pnpm --filter @paperclipai/db typecheck && pnpm --filter @paperclipai/server typecheck && pnpm --filter @paperclipai/ui typecheck` - `pnpm exec vitest run server/src/__tests__/issue-execution-policy.test.ts ui/src/components/IssueProperties.test.tsx` - `pnpm --filter @paperclipai/server typecheck && pnpm --filter @paperclipai/ui typecheck` - `pnpm exec vitest run ui/src/components/IssueMonitorActivityCard.test.tsx ui/src/components/IssueProperties.test.tsx` - `pnpm --filter @paperclipai/ui typecheck` - Storybook screenshot captured from `http://127.0.0.1:6006/iframe.html?viewMode=story&id=product-issue-monitor-surfaces--monitor-surfaces` with Playwright. ## Screenshots  ## Risks - Medium: this changes heartbeat recovery behavior for scheduled external-service waits, so regressions could affect wake timing or recovery issue creation. - Migration risk is reduced by using `IF NOT EXISTS` for the new issue monitor columns and index. - External monitor references are treated as secret-adjacent and are intentionally omitted from visible activity/wake payloads. > 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, GPT-5 coding agent with repository tool use and terminal 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots or Storybook review surfaces - [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>
97 lines
3.6 KiB
TypeScript
97 lines
3.6 KiB
TypeScript
import type { IssueExecutionPolicy, IssueExecutionStageParticipant, IssueExecutionStagePrincipal } from "@paperclipai/shared";
|
|
import { parseAssigneeValue } from "./assignees";
|
|
|
|
type StageType = "review" | "approval";
|
|
|
|
function newId() {
|
|
if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
|
|
return crypto.randomUUID();
|
|
}
|
|
return `stage-${Math.random().toString(36).slice(2)}`;
|
|
}
|
|
|
|
function principalKey(principal: IssueExecutionStagePrincipal | IssueExecutionStageParticipant) {
|
|
return principal.type === "agent" ? `agent:${principal.agentId}` : `user:${principal.userId}`;
|
|
}
|
|
|
|
export function principalFromSelectionValue(value: string): IssueExecutionStagePrincipal | null {
|
|
const selection = parseAssigneeValue(value);
|
|
if (selection.assigneeAgentId) {
|
|
return { type: "agent", agentId: selection.assigneeAgentId, userId: null };
|
|
}
|
|
if (selection.assigneeUserId) {
|
|
return { type: "user", userId: selection.assigneeUserId, agentId: null };
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export function selectionValueFromPrincipal(principal: IssueExecutionStagePrincipal | IssueExecutionStageParticipant): string {
|
|
return principal.type === "agent" ? `agent:${principal.agentId}` : `user:${principal.userId}`;
|
|
}
|
|
|
|
export function stageParticipantValues(policy: IssueExecutionPolicy | null | undefined, stageType: StageType): string[] {
|
|
const stage = policy?.stages.find((candidate) => candidate.type === stageType);
|
|
return stage?.participants.map((participant) => selectionValueFromPrincipal(participant)) ?? [];
|
|
}
|
|
|
|
function mergeParticipants(
|
|
existing: IssueExecutionStageParticipant[] | undefined,
|
|
values: string[],
|
|
): IssueExecutionStageParticipant[] {
|
|
const existingByKey = new Map((existing ?? []).map((participant) => [principalKey(participant), participant]));
|
|
const participants: IssueExecutionStageParticipant[] = [];
|
|
for (const value of values) {
|
|
const principal = principalFromSelectionValue(value);
|
|
if (!principal) continue;
|
|
const key = principalKey(principal);
|
|
const previous = existingByKey.get(key);
|
|
participants.push({
|
|
id: previous?.id ?? newId(),
|
|
type: principal.type,
|
|
agentId: principal.type === "agent" ? principal.agentId ?? null : null,
|
|
userId: principal.type === "user" ? principal.userId ?? null : null,
|
|
});
|
|
}
|
|
return participants;
|
|
}
|
|
|
|
export function buildExecutionPolicy(input: {
|
|
existingPolicy?: IssueExecutionPolicy | null;
|
|
reviewerValues: string[];
|
|
approverValues: string[];
|
|
}): IssueExecutionPolicy | null {
|
|
const mode = input.existingPolicy?.mode ?? "normal";
|
|
const stages: IssueExecutionPolicy["stages"] = [];
|
|
const monitor = input.existingPolicy?.monitor ?? null;
|
|
|
|
const existingReviewStage = input.existingPolicy?.stages.find((stage) => stage.type === "review");
|
|
const reviewParticipants = mergeParticipants(existingReviewStage?.participants, input.reviewerValues);
|
|
if (reviewParticipants.length > 0) {
|
|
stages.push({
|
|
id: existingReviewStage?.id ?? newId(),
|
|
type: "review" as const,
|
|
approvalsNeeded: 1 as const,
|
|
participants: reviewParticipants,
|
|
});
|
|
}
|
|
|
|
const existingApprovalStage = input.existingPolicy?.stages.find((stage) => stage.type === "approval");
|
|
const approvalParticipants = mergeParticipants(existingApprovalStage?.participants, input.approverValues);
|
|
if (approvalParticipants.length > 0) {
|
|
stages.push({
|
|
id: existingApprovalStage?.id ?? newId(),
|
|
type: "approval" as const,
|
|
approvalsNeeded: 1 as const,
|
|
participants: approvalParticipants,
|
|
});
|
|
}
|
|
|
|
if (stages.length === 0 && !monitor) return null;
|
|
|
|
return {
|
|
mode,
|
|
commentRequired: true,
|
|
stages,
|
|
...(monitor ? { monitor } : {}),
|
|
};
|
|
}
|