d6d7a7cea6
## Thinking Path > - Paperclip is the control plane for autonomous AI companies. > - Routines are the scheduled/recurring work surface that keeps a company operating without manual kicks. > - Operators need routine edits to be auditable and recoverable, especially when routines control assignments, prompts, triggers, and webhook secrets. > - Documents already have revision-style safety, but routines did not have equivalent history or restore semantics. > - This pull request adds append-only routine revisions across the database, shared contracts, server routes, and board UI. > - The benefit is safer routine iteration: users can inspect history, compare changes, restore older definitions, and avoid overwriting newer edits. ## What Changed - Added `routine_revisions` storage, latest revision pointers on routines, shared types, validators, and API docs for routine revision history. - Added server service/route support for listing routine revisions, conflict-aware routine saves, and append-only restore operations. - Added a History tab on routine detail with revision preview, structured change summaries, description line diffs, dirty-edit blocking, restore confirmation, and restored webhook secret surfacing. - Extracted the line diff helper from `DocumentDiffModal` into `ui/src/lib/line-diff.ts` for reuse. - Rebased the branch onto current `public-gh/master` and renumbered the routine revision migration to `0077_unusual_karnak` after upstream `0076_useful_elektra`. - Made the `0077` routine revision migration idempotent so installs that already applied the branch-local `0076_unusual_karnak` can safely advance. - Updated the plugin SDK test harness routine fixture with the new revision fields required by the shared `Routine` contract. ## Verification - `pnpm --filter @paperclipai/db run check:migrations` passed. - `pnpm exec vitest run --project @paperclipai/shared packages/shared/src/validators/routine.test.ts` passed. - `pnpm exec vitest run --project @paperclipai/ui ui/src/lib/line-diff.test.ts ui/src/components/RoutineHistoryTab.test.tsx ui/src/lib/workspace-routines.test.ts ui/src/pages/Routines.test.tsx` passed. - `pnpm exec vitest run --project @paperclipai/server server/src/__tests__/routines-service.test.ts --pool=forks --poolOptions.forks.isolate=true` passed. - `pnpm exec vitest run --project @paperclipai/server server/src/__tests__/routines-routes.test.ts --pool=forks --poolOptions.forks.isolate=true` passed. - `pnpm --filter @paperclipai/plugin-sdk typecheck` passed after updating the SDK test harness fixture. - `pnpm --filter @paperclipai/plugin-sdk build` passed; this refreshed local generated SDK output needed by plugin example typechecks. - `pnpm -r typecheck` passed. ## Risks - Medium migration risk: this adds routine revision storage and backfills existing routines. The migration is ordered after upstream `0076` and uses `IF NOT EXISTS` / duplicate-object guards to tolerate earlier branch-local migration application. - Restore behavior intentionally appends a new revision instead of mutating history; callers expecting an in-place rollback need to follow the new latest revision pointer. - Restoring webhook triggers recreates webhook secret material, so users must copy newly surfaced secrets after restore. - Conflict-aware saves now reject stale routine edits when the client sends an older `baseRevisionId`. > 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-based coding agent, with shell/tool use in a local git worktree. Exact context-window size is not exposed in this runtime. ## 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 - [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 Screenshots: not attached in this draft PR; the new UI flow is covered by component tests listed above. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
161 lines
6.3 KiB
TypeScript
161 lines
6.3 KiB
TypeScript
import { z } from "zod";
|
|
import {
|
|
ISSUE_PRIORITIES,
|
|
ROUTINE_CATCH_UP_POLICIES,
|
|
ROUTINE_CONCURRENCY_POLICIES,
|
|
ROUTINE_STATUSES,
|
|
ROUTINE_TRIGGER_KINDS,
|
|
ROUTINE_TRIGGER_SIGNING_MODES,
|
|
ROUTINE_VARIABLE_TYPES,
|
|
} from "../constants.js";
|
|
import {
|
|
ISSUE_EXECUTION_WORKSPACE_PREFERENCES,
|
|
issueExecutionWorkspaceSettingsSchema,
|
|
} from "./issue.js";
|
|
|
|
const routineVariableValueSchema = z.union([z.string(), z.number().finite(), z.boolean()]);
|
|
|
|
export const routineVariableSchema = z.object({
|
|
name: z.string().trim().regex(/^[A-Za-z][A-Za-z0-9_]*$/),
|
|
label: z.string().trim().max(120).optional().nullable(),
|
|
type: z.enum(ROUTINE_VARIABLE_TYPES).optional().default("text"),
|
|
defaultValue: routineVariableValueSchema.optional().nullable(),
|
|
required: z.boolean().optional().default(true),
|
|
options: z.array(z.string().trim().min(1).max(120)).max(50).optional().default([]),
|
|
}).superRefine((value, ctx) => {
|
|
if (value.type === "select" && value.options.length === 0) {
|
|
ctx.addIssue({
|
|
code: z.ZodIssueCode.custom,
|
|
path: ["options"],
|
|
message: "Select variables require at least one option",
|
|
});
|
|
}
|
|
if (value.type !== "select" && value.options.length > 0) {
|
|
ctx.addIssue({
|
|
code: z.ZodIssueCode.custom,
|
|
path: ["options"],
|
|
message: "Only select variables can define options",
|
|
});
|
|
}
|
|
if (value.type === "select" && value.defaultValue != null) {
|
|
if (typeof value.defaultValue !== "string" || !value.options.includes(value.defaultValue)) {
|
|
ctx.addIssue({
|
|
code: z.ZodIssueCode.custom,
|
|
path: ["defaultValue"],
|
|
message: "Select variable defaults must match one of the allowed options",
|
|
});
|
|
}
|
|
}
|
|
});
|
|
|
|
export const createRoutineSchema = z.object({
|
|
projectId: z.string().uuid().optional().nullable(),
|
|
goalId: z.string().uuid().optional().nullable(),
|
|
parentIssueId: z.string().uuid().optional().nullable(),
|
|
title: z.string().trim().min(1).max(200),
|
|
description: z.string().optional().nullable(),
|
|
assigneeAgentId: z.string().uuid().optional().nullable(),
|
|
priority: z.enum(ISSUE_PRIORITIES).optional().default("medium"),
|
|
status: z.enum(ROUTINE_STATUSES).optional().default("active"),
|
|
concurrencyPolicy: z.enum(ROUTINE_CONCURRENCY_POLICIES).optional().default("coalesce_if_active"),
|
|
catchUpPolicy: z.enum(ROUTINE_CATCH_UP_POLICIES).optional().default("skip_missed"),
|
|
variables: z.array(routineVariableSchema).optional().default([]),
|
|
});
|
|
|
|
export type CreateRoutine = z.infer<typeof createRoutineSchema>;
|
|
|
|
export const updateRoutineSchema = createRoutineSchema.partial().extend({
|
|
baseRevisionId: z.string().uuid().optional().nullable(),
|
|
});
|
|
export type UpdateRoutine = z.infer<typeof updateRoutineSchema>;
|
|
|
|
export const routineRevisionSnapshotRoutineV1Schema = z.object({
|
|
id: z.string().uuid(),
|
|
companyId: z.string().uuid(),
|
|
projectId: z.string().uuid().nullable(),
|
|
goalId: z.string().uuid().nullable(),
|
|
parentIssueId: z.string().uuid().nullable(),
|
|
title: z.string().trim().min(1).max(200),
|
|
description: z.string().nullable(),
|
|
assigneeAgentId: z.string().uuid().nullable(),
|
|
priority: z.enum(ISSUE_PRIORITIES),
|
|
status: z.enum(ROUTINE_STATUSES),
|
|
concurrencyPolicy: z.enum(ROUTINE_CONCURRENCY_POLICIES),
|
|
catchUpPolicy: z.enum(ROUTINE_CATCH_UP_POLICIES),
|
|
variables: z.array(routineVariableSchema),
|
|
}).strict();
|
|
|
|
export const routineRevisionSnapshotTriggerV1Schema = z.object({
|
|
id: z.string().uuid(),
|
|
kind: z.enum(ROUTINE_TRIGGER_KINDS),
|
|
label: z.string().nullable(),
|
|
enabled: z.boolean(),
|
|
cronExpression: z.string().nullable(),
|
|
timezone: z.string().nullable(),
|
|
publicId: z.string().nullable(),
|
|
signingMode: z.enum(ROUTINE_TRIGGER_SIGNING_MODES).nullable(),
|
|
replayWindowSec: z.number().int().min(30).max(86_400).nullable(),
|
|
}).strict();
|
|
|
|
export const routineRevisionSnapshotV1Schema = z.object({
|
|
version: z.literal(1),
|
|
routine: routineRevisionSnapshotRoutineV1Schema,
|
|
triggers: z.array(routineRevisionSnapshotTriggerV1Schema),
|
|
}).strict();
|
|
|
|
export const routineRevisionSnapshotSchema = routineRevisionSnapshotV1Schema;
|
|
export type RoutineRevisionSnapshotV1 = z.infer<typeof routineRevisionSnapshotV1Schema>;
|
|
export type RoutineRevisionSnapshot = z.infer<typeof routineRevisionSnapshotSchema>;
|
|
|
|
const baseTriggerSchema = z.object({
|
|
label: z.string().trim().max(120).optional().nullable(),
|
|
enabled: z.boolean().optional().default(true),
|
|
});
|
|
|
|
export const createRoutineTriggerSchema = z.discriminatedUnion("kind", [
|
|
baseTriggerSchema.extend({
|
|
kind: z.literal("schedule"),
|
|
cronExpression: z.string().trim().min(1),
|
|
timezone: z.string().trim().min(1).default("UTC"),
|
|
}),
|
|
baseTriggerSchema.extend({
|
|
kind: z.literal("webhook"),
|
|
signingMode: z.enum(ROUTINE_TRIGGER_SIGNING_MODES).optional().default("bearer"),
|
|
replayWindowSec: z.number().int().min(30).max(86_400).optional().default(300),
|
|
}),
|
|
baseTriggerSchema.extend({
|
|
kind: z.literal("api"),
|
|
}),
|
|
]);
|
|
|
|
export type CreateRoutineTrigger = z.infer<typeof createRoutineTriggerSchema>;
|
|
|
|
export const updateRoutineTriggerSchema = z.object({
|
|
label: z.string().trim().max(120).optional().nullable(),
|
|
enabled: z.boolean().optional(),
|
|
cronExpression: z.string().trim().min(1).optional().nullable(),
|
|
timezone: z.string().trim().min(1).optional().nullable(),
|
|
signingMode: z.enum(ROUTINE_TRIGGER_SIGNING_MODES).optional().nullable(),
|
|
replayWindowSec: z.number().int().min(30).max(86_400).optional().nullable(),
|
|
});
|
|
|
|
export type UpdateRoutineTrigger = z.infer<typeof updateRoutineTriggerSchema>;
|
|
|
|
export const runRoutineSchema = z.object({
|
|
triggerId: z.string().uuid().optional().nullable(),
|
|
payload: z.record(z.unknown()).optional().nullable(),
|
|
variables: z.record(routineVariableValueSchema).optional().nullable(),
|
|
projectId: z.string().uuid().optional().nullable(),
|
|
assigneeAgentId: z.string().uuid().optional().nullable(),
|
|
idempotencyKey: z.string().trim().max(255).optional().nullable(),
|
|
source: z.enum(["manual", "api"]).optional().default("manual"),
|
|
executionWorkspaceId: z.string().uuid().optional().nullable(),
|
|
executionWorkspacePreference: z.enum(ISSUE_EXECUTION_WORKSPACE_PREFERENCES).optional().nullable(),
|
|
executionWorkspaceSettings: issueExecutionWorkspaceSettingsSchema.optional().nullable(),
|
|
});
|
|
|
|
export type RunRoutine = z.infer<typeof runRoutineSchema>;
|
|
|
|
export const rotateRoutineTriggerSecretSchema = z.object({});
|
|
export type RotateRoutineTriggerSecret = z.infer<typeof rotateRoutineTriggerSecretSchema>;
|