mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 19:35:13 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The task lifecycle and recovery subsystems decide when agent work is still productive, stalled, or ready for review. > - Existing recovery paths can observe stopped or incomplete work, but there was no first-class per-task watchdog model with scoped review permissions. > - Watchdog follow-ups also need strict boundaries so recovery/status-only runs cannot mutate approvals or perform deliverable work. > - This pull request adds the task watchdog data model, API/service layer, scheduler/review flow, adapter wake context, UI configuration surfaces, and docs. > - The branch has been rebased onto current `paperclipai/paperclip` `master`; the watchdog migration is now ordered after master's latest migrations as `0104_issue_watchdogs`. > - The benefit is a more explicit task-review loop that preserves Paperclip's single-assignee and governance invariants while making stalled work easier to route. ## Linked Issues or Issue Description No linked GitHub issue. Paperclip task: [PAP-11275](/PAP/issues/PAP-11275). ## Problem or motivation Task recovery needs a first-class watchdog path that can inspect stopped work and create scoped follow-ups without bypassing normal task ownership. Board/UI users need a way to configure watchdogs on tasks and see watchdog-related live work. Recovery/status-only runs must remain limited to status reporting and must not create approvals, link approvals, or submit approval comments. ## Proposed solution Add a task-watchdog data model, scheduler/classifier, scoped mutation guard, adapter wake context, API/UI configuration surfaces, and documentation so watchdog agents can review stopped task subtrees under explicit boundaries. ## Alternatives considered Reuse the existing recovery-action flow only. That would keep stopped-work detection implicit, make per-task watchdog assignment harder to expose in the UI, and would not provide a durable scoped-review issue for stalled task trees. ## Roadmap alignment This is Paperclip control-plane lifecycle infrastructure for task execution and recovery. I checked `ROADMAP.md`; this PR does not duplicate an existing planned core item. ## What Changed - Added issue watchdog schema, migration, shared contracts, validators, CRUD API, and service support. - Added task watchdog scheduler/classifier behavior, scoped mutation enforcement, adapter wake context, and default watchdog mandate guidance. - Added UI surfaces for configuring watchdogs on new/existing tasks, viewing watchdog activity, and exposing the experimental setting. - Added docs for the user-facing task watchdog workflow and implementation semantics. - Gated new-task watchdog setup behind `enableTaskWatchdogs` and blocked cheap status-only recovery runs from approval mutations. - Rebased onto current `master` and renumbered the idempotent watchdog migration from the branch-local `0102_issue_watchdogs` slot to `0104_issue_watchdogs`. - Addressed Greptile feedback by loading watchdog classifier input with a recursive subtree query and centralizing the watchdog origin-kind constant. - Added and updated focused server/UI tests for watchdog routes, scheduler/classifier behavior, scope boundaries, live task visibility, settings, and new issue dialog behavior. ## Verification - `pnpm vitest run server/src/__tests__/task-watchdogs-scheduler.test.ts server/src/__tests__/task-watchdogs-classifier.test.ts` - `pnpm vitest run server/src/__tests__/approval-routes-idempotency.test.ts server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts` - `pnpm vitest run ui/src/components/NewIssueDialog.test.tsx` - `pnpm --filter @paperclipai/server typecheck` - `git diff --check` - Verified the PR diff does not include `pnpm-lock.yaml` or `.github/workflows`. ## Risks - Medium risk: this introduces a new task lifecycle surface touching DB schema, server routes/services, adapter wake context, and UI task configuration. - Watchdog scheduling behavior depends on the new experimental setting and runtime context checks behaving consistently across local and production agents. - The watchdog migration is idempotent (`IF NOT EXISTS` / duplicate-object guards) so users who tried the previous branch-local migration number should not get duplicate-object failures. - CI and the second Greptile pass are pending after the latest review-fix push. > 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-class coding agent in the Paperclip workspace. Exact runtime model id and context window were not exposed to the agent; tool use and local command 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 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 — N/A per Paperclip task instruction: do not add screenshots/images to this PR unless they are specifically part of the work. - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] 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> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
154 lines
7.9 KiB
TypeScript
154 lines
7.9 KiB
TypeScript
import { sql } from "drizzle-orm";
|
|
import {
|
|
type AnyPgColumn,
|
|
pgTable,
|
|
uuid,
|
|
text,
|
|
timestamp,
|
|
integer,
|
|
jsonb,
|
|
index,
|
|
uniqueIndex,
|
|
} from "drizzle-orm/pg-core";
|
|
import { agents } from "./agents.js";
|
|
import { projects } from "./projects.js";
|
|
import { goals } from "./goals.js";
|
|
import { companies } from "./companies.js";
|
|
import { heartbeatRuns } from "./heartbeat_runs.js";
|
|
import { projectWorkspaces } from "./project_workspaces.js";
|
|
import { executionWorkspaces } from "./execution_workspaces.js";
|
|
import type { SourceTrustMetadata } from "@paperclipai/shared";
|
|
|
|
export const issues = pgTable(
|
|
"issues",
|
|
{
|
|
id: uuid("id").primaryKey().defaultRandom(),
|
|
companyId: uuid("company_id").notNull().references(() => companies.id),
|
|
projectId: uuid("project_id").references(() => projects.id),
|
|
projectWorkspaceId: uuid("project_workspace_id").references(() => projectWorkspaces.id, { onDelete: "set null" }),
|
|
goalId: uuid("goal_id").references(() => goals.id),
|
|
parentId: uuid("parent_id").references((): AnyPgColumn => issues.id),
|
|
title: text("title").notNull(),
|
|
description: text("description"),
|
|
status: text("status").notNull().default("backlog"),
|
|
workMode: text("work_mode").notNull().default("standard"),
|
|
priority: text("priority").notNull().default("medium"),
|
|
assigneeAgentId: uuid("assignee_agent_id").references(() => agents.id),
|
|
assigneeUserId: text("assignee_user_id"),
|
|
checkoutRunId: uuid("checkout_run_id").references(() => heartbeatRuns.id, { onDelete: "set null" }),
|
|
executionRunId: uuid("execution_run_id").references(() => heartbeatRuns.id, { onDelete: "set null" }),
|
|
executionAgentNameKey: text("execution_agent_name_key"),
|
|
executionLockedAt: timestamp("execution_locked_at", { withTimezone: true }),
|
|
createdByAgentId: uuid("created_by_agent_id").references(() => agents.id),
|
|
createdByUserId: text("created_by_user_id"),
|
|
issueNumber: integer("issue_number"),
|
|
identifier: text("identifier"),
|
|
originKind: text("origin_kind").notNull().default("manual"),
|
|
originId: text("origin_id"),
|
|
originRunId: text("origin_run_id"),
|
|
originFingerprint: text("origin_fingerprint").notNull().default("default"),
|
|
requestDepth: integer("request_depth").notNull().default(0),
|
|
billingCode: text("billing_code"),
|
|
assigneeAdapterOverrides: jsonb("assignee_adapter_overrides").$type<Record<string, unknown>>(),
|
|
executionPolicy: jsonb("execution_policy").$type<Record<string, unknown>>(),
|
|
executionState: jsonb("execution_state").$type<Record<string, unknown>>(),
|
|
monitorNextCheckAt: timestamp("monitor_next_check_at", { withTimezone: true }),
|
|
monitorWakeRequestedAt: timestamp("monitor_wake_requested_at", { withTimezone: true }),
|
|
monitorLastTriggeredAt: timestamp("monitor_last_triggered_at", { withTimezone: true }),
|
|
monitorAttemptCount: integer("monitor_attempt_count").notNull().default(0),
|
|
monitorNotes: text("monitor_notes"),
|
|
monitorScheduledBy: text("monitor_scheduled_by"),
|
|
executionWorkspaceId: uuid("execution_workspace_id")
|
|
.references((): AnyPgColumn => executionWorkspaces.id, { onDelete: "set null" }),
|
|
executionWorkspacePreference: text("execution_workspace_preference"),
|
|
executionWorkspaceSettings: jsonb("execution_workspace_settings").$type<Record<string, unknown>>(),
|
|
sourceTrust: jsonb("source_trust").$type<SourceTrustMetadata | null>(),
|
|
startedAt: timestamp("started_at", { withTimezone: true }),
|
|
completedAt: timestamp("completed_at", { withTimezone: true }),
|
|
cancelledAt: timestamp("cancelled_at", { withTimezone: true }),
|
|
hiddenAt: timestamp("hidden_at", { withTimezone: true }),
|
|
createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
|
|
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow(),
|
|
},
|
|
(table) => ({
|
|
companyStatusIdx: index("issues_company_status_idx").on(table.companyId, table.status),
|
|
assigneeStatusIdx: index("issues_company_assignee_status_idx").on(
|
|
table.companyId,
|
|
table.assigneeAgentId,
|
|
table.status,
|
|
),
|
|
assigneeUserStatusIdx: index("issues_company_assignee_user_status_idx").on(
|
|
table.companyId,
|
|
table.assigneeUserId,
|
|
table.status,
|
|
),
|
|
parentIdx: index("issues_company_parent_idx").on(table.companyId, table.parentId),
|
|
projectIdx: index("issues_company_project_idx").on(table.companyId, table.projectId),
|
|
originIdx: index("issues_company_origin_idx").on(table.companyId, table.originKind, table.originId),
|
|
projectWorkspaceIdx: index("issues_company_project_workspace_idx").on(table.companyId, table.projectWorkspaceId),
|
|
executionWorkspaceIdx: index("issues_company_execution_workspace_idx").on(table.companyId, table.executionWorkspaceId),
|
|
dueMonitorIdx: index("issues_company_monitor_due_idx").on(table.companyId, table.monitorNextCheckAt),
|
|
identifierIdx: uniqueIndex("issues_identifier_idx").on(table.identifier),
|
|
titleSearchIdx: index("issues_title_search_idx").using("gin", table.title.op("gin_trgm_ops")),
|
|
identifierSearchIdx: index("issues_identifier_search_idx").using("gin", table.identifier.op("gin_trgm_ops")),
|
|
descriptionSearchIdx: index("issues_description_search_idx").using("gin", table.description.op("gin_trgm_ops")),
|
|
openRoutineExecutionIdx: uniqueIndex("issues_open_routine_execution_uq")
|
|
.on(table.companyId, table.originKind, table.originId, table.originFingerprint)
|
|
.where(
|
|
sql`${table.originKind} = 'routine_execution'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.executionRunId} is not null
|
|
and ${table.status} in ('backlog', 'todo', 'in_progress', 'in_review', 'blocked')`,
|
|
),
|
|
activeLivenessRecoveryIncidentIdx: uniqueIndex("issues_active_liveness_recovery_incident_uq")
|
|
.on(table.companyId, table.originKind, table.originId)
|
|
.where(
|
|
sql`${table.originKind} = 'harness_liveness_escalation'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
activeLivenessRecoveryLeafIdx: uniqueIndex("issues_active_liveness_recovery_leaf_uq")
|
|
.on(table.companyId, table.originKind, table.originFingerprint)
|
|
.where(
|
|
sql`${table.originKind} = 'harness_liveness_escalation'
|
|
and ${table.originFingerprint} <> 'default'
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
activeStaleRunEvaluationIdx: uniqueIndex("issues_active_stale_run_evaluation_uq")
|
|
.on(table.companyId, table.originKind, table.originId)
|
|
.where(
|
|
sql`${table.originKind} = 'stale_active_run_evaluation'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
activeTaskWatchdogIdx: uniqueIndex("issues_active_task_watchdog_uq")
|
|
.on(table.companyId, table.originKind, table.originId)
|
|
.where(
|
|
sql`${table.originKind} = 'task_watchdog'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
activeProductivityReviewIdx: uniqueIndex("issues_active_productivity_review_uq")
|
|
.on(table.companyId, table.originKind, table.originId)
|
|
.where(
|
|
sql`${table.originKind} = 'issue_productivity_review'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
activeStrandedIssueRecoveryIdx: uniqueIndex("issues_active_stranded_issue_recovery_uq")
|
|
.on(table.companyId, table.originKind, table.originId)
|
|
.where(
|
|
sql`${table.originKind} = 'stranded_issue_recovery'
|
|
and ${table.originId} is not null
|
|
and ${table.hiddenAt} is null
|
|
and ${table.status} not in ('done', 'cancelled')`,
|
|
),
|
|
}),
|
|
);
|