Add routine revision schema and contracts

Co-Authored-By: Paperclip <noreply@paperclip.ing>

packages/db/src/migrations/0077_unusual_karnak.sql

@@ -0,0 +1,140 @@
+CREATE TABLE IF NOT EXISTS "routine_revisions" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"company_id" uuid NOT NULL,
+	"routine_id" uuid NOT NULL,
+	"revision_number" integer NOT NULL,
+	"title" text NOT NULL,
+	"description" text,
+	"snapshot" jsonb NOT NULL,
+	"change_summary" text,
+	"restored_from_revision_id" uuid,
+	"created_by_agent_id" uuid,
+	"created_by_user_id" text,
+	"created_by_run_id" uuid,
+	"created_at" timestamp with time zone DEFAULT now() NOT NULL
+);
+--> statement-breakpoint
+ALTER TABLE "routines" ADD COLUMN IF NOT EXISTS "latest_revision_id" uuid;--> statement-breakpoint
+ALTER TABLE "routines" ADD COLUMN IF NOT EXISTS "latest_revision_number" integer DEFAULT 1 NOT NULL;--> statement-breakpoint
+DO $$ BEGIN
+	ALTER TABLE "routine_revisions" ADD CONSTRAINT "routine_revisions_company_id_companies_id_fk" FOREIGN KEY ("company_id") REFERENCES "public"."companies"("id") ON DELETE cascade ON UPDATE no action;
+EXCEPTION
+	WHEN duplicate_object THEN NULL;
+END $$;
+--> statement-breakpoint
+DO $$ BEGIN
+	ALTER TABLE "routine_revisions" ADD CONSTRAINT "routine_revisions_routine_id_routines_id_fk" FOREIGN KEY ("routine_id") REFERENCES "public"."routines"("id") ON DELETE cascade ON UPDATE no action;
+EXCEPTION
+	WHEN duplicate_object THEN NULL;
+END $$;
+--> statement-breakpoint
+DO $$ BEGIN
+	ALTER TABLE "routine_revisions" ADD CONSTRAINT "routine_revisions_restored_from_revision_id_routine_revisions_id_fk" FOREIGN KEY ("restored_from_revision_id") REFERENCES "public"."routine_revisions"("id") ON DELETE set null ON UPDATE no action;
+EXCEPTION
+	WHEN duplicate_object THEN NULL;
+END $$;
+--> statement-breakpoint
+DO $$ BEGIN
+	ALTER TABLE "routine_revisions" ADD CONSTRAINT "routine_revisions_created_by_agent_id_agents_id_fk" FOREIGN KEY ("created_by_agent_id") REFERENCES "public"."agents"("id") ON DELETE set null ON UPDATE no action;
+EXCEPTION
+	WHEN duplicate_object THEN NULL;
+END $$;
+--> statement-breakpoint
+DO $$ BEGIN
+	ALTER TABLE "routine_revisions" ADD CONSTRAINT "routine_revisions_created_by_run_id_heartbeat_runs_id_fk" FOREIGN KEY ("created_by_run_id") REFERENCES "public"."heartbeat_runs"("id") ON DELETE set null ON UPDATE no action;
+EXCEPTION
+	WHEN duplicate_object THEN NULL;
+END $$;
+--> statement-breakpoint
+CREATE UNIQUE INDEX IF NOT EXISTS "routine_revisions_routine_revision_uq" ON "routine_revisions" USING btree ("routine_id","revision_number");--> statement-breakpoint
+CREATE INDEX IF NOT EXISTS "routine_revisions_company_routine_created_idx" ON "routine_revisions" USING btree ("company_id","routine_id","created_at");
+--> statement-breakpoint
+WITH inserted_revisions AS (
+	INSERT INTO "routine_revisions" (
+		"id",
+		"company_id",
+		"routine_id",
+		"revision_number",
+		"title",
+		"description",
+		"snapshot",
+		"change_summary",
+		"created_by_agent_id",
+		"created_by_user_id",
+		"created_at"
+	)
+	SELECT
+		gen_random_uuid(),
+		r."company_id",
+		r."id",
+		1,
+		r."title",
+		r."description",
+		jsonb_build_object(
+			'version', 1,
+			'routine', jsonb_build_object(
+				'id', r."id",
+				'companyId', r."company_id",
+				'projectId', r."project_id",
+				'goalId', r."goal_id",
+				'parentIssueId', r."parent_issue_id",
+				'title', r."title",
+				'description', r."description",
+				'assigneeAgentId', r."assignee_agent_id",
+				'priority', r."priority",
+				'status', r."status",
+				'concurrencyPolicy', r."concurrency_policy",
+				'catchUpPolicy', r."catch_up_policy",
+				'variables', coalesce(r."variables", '[]'::jsonb)
+			),
+			'triggers', coalesce(
+				(
+					SELECT jsonb_agg(
+						jsonb_build_object(
+							'id', rt."id",
+							'kind', rt."kind",
+							'label', rt."label",
+							'enabled', rt."enabled",
+							'cronExpression', rt."cron_expression",
+							'timezone', rt."timezone",
+							'publicId', rt."public_id",
+							'signingMode', rt."signing_mode",
+							'replayWindowSec', rt."replay_window_sec"
+						)
+						ORDER BY rt."created_at", rt."id"
+					)
+					FROM "routine_triggers" rt
+					WHERE rt."routine_id" = r."id"
+						AND rt."company_id" = r."company_id"
+				),
+				'[]'::jsonb
+			)
+		),
+		'Initial routine revision backfill',
+		r."created_by_agent_id",
+		r."created_by_user_id",
+		r."created_at"
+	FROM "routines" r
+	WHERE NOT EXISTS (
+		SELECT 1
+		FROM "routine_revisions" rr
+		WHERE rr."routine_id" = r."id"
+			AND rr."revision_number" = 1
+	)
+	RETURNING "id", "routine_id"
+)
+UPDATE "routines" r
+SET
+	"latest_revision_id" = inserted_revisions."id",
+	"latest_revision_number" = 1
+FROM inserted_revisions
+WHERE r."id" = inserted_revisions."routine_id";
+--> statement-breakpoint
+UPDATE "routines" r
+SET
+	"latest_revision_id" = rr."id",
+	"latest_revision_number" = rr."revision_number"
+FROM "routine_revisions" rr
+WHERE rr."routine_id" = r."id"
+	AND rr."revision_number" = 1
+	AND r."latest_revision_id" IS NULL;

packages/db/src/migrations/meta/_journal.json

@@ -540,6 +540,13 @@
       "when": 1777675301279,
       "tag": "0076_useful_elektra",
       "breakpoints": true
+    },
+    {
+      "idx": 77,
+      "version": "7",
+      "when": 1777933347806,
+      "tag": "0077_unusual_karnak",
+      "breakpoints": true
     }
   ]
 }

packages/db/src/schema/index.ts

@@ -31,7 +31,7 @@ export { goals } from "./goals.js";
 export { issues } from "./issues.js";
 export { issueReferenceMentions } from "./issue_reference_mentions.js";
 export { issueRelations } from "./issue_relations.js";
-export { routines, routineTriggers, routineRuns } from "./routines.js";
+export { routines, routineRevisions, routineTriggers, routineRuns } from "./routines.js";
 export { issueWorkProducts } from "./issue_work_products.js";
 export { labels } from "./labels.js";
 export { issueLabels } from "./issue_labels.js";

packages/db/src/schema/routines.ts

@@ -1,4 +1,5 @@
 import {
+  type AnyPgColumn,
   boolean,
   index,
   integer,
@@ -15,7 +16,8 @@ import { companySecrets } from "./company_secrets.js";
 import { issues } from "./issues.js";
 import { projects } from "./projects.js";
 import { goals } from "./goals.js";
-import type { RoutineVariable } from "@paperclipai/shared";
+import { heartbeatRuns } from "./heartbeat_runs.js";
+import type { RoutineRevisionSnapshotV1, RoutineVariable } from "@paperclipai/shared";
 
 export const routines = pgTable(
   "routines",
@@ -33,6 +35,8 @@ export const routines = pgTable(
     concurrencyPolicy: text("concurrency_policy").notNull().default("coalesce_if_active"),
     catchUpPolicy: text("catch_up_policy").notNull().default("skip_missed"),
     variables: jsonb("variables").$type<RoutineVariable[]>().notNull().default([]),
+    latestRevisionId: uuid("latest_revision_id"),
+    latestRevisionNumber: integer("latest_revision_number").notNull().default(1),
     createdByAgentId: uuid("created_by_agent_id").references(() => agents.id, { onDelete: "set null" }),
     createdByUserId: text("created_by_user_id"),
     updatedByAgentId: uuid("updated_by_agent_id").references(() => agents.id, { onDelete: "set null" }),
@@ -49,6 +53,39 @@ export const routines = pgTable(
   }),
 );
 
+export const routineRevisions = pgTable(
+  "routine_revisions",
+  {
+    id: uuid("id").primaryKey().defaultRandom(),
+    companyId: uuid("company_id").notNull().references(() => companies.id, { onDelete: "cascade" }),
+    routineId: uuid("routine_id").notNull().references(() => routines.id, { onDelete: "cascade" }),
+    revisionNumber: integer("revision_number").notNull(),
+    title: text("title").notNull(),
+    description: text("description"),
+    snapshot: jsonb("snapshot").$type<RoutineRevisionSnapshotV1>().notNull(),
+    changeSummary: text("change_summary"),
+    restoredFromRevisionId: uuid("restored_from_revision_id").references(
+      (): AnyPgColumn => routineRevisions.id,
+      { onDelete: "set null" },
+    ),
+    createdByAgentId: uuid("created_by_agent_id").references(() => agents.id, { onDelete: "set null" }),
+    createdByUserId: text("created_by_user_id"),
+    createdByRunId: uuid("created_by_run_id").references(() => heartbeatRuns.id, { onDelete: "set null" }),
+    createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
+  },
+  (table) => ({
+    routineRevisionUq: uniqueIndex("routine_revisions_routine_revision_uq").on(
+      table.routineId,
+      table.revisionNumber,
+    ),
+    companyRoutineCreatedIdx: index("routine_revisions_company_routine_created_idx").on(
+      table.companyId,
+      table.routineId,
+      table.createdAt,
+    ),
+  }),
+);
+
 export const routineTriggers = pgTable(
   "routine_triggers",
   {

packages/shared/src/index.ts

@@ -501,6 +501,11 @@ export type {
   RoutineManagedByPlugin,
   RoutineVariable,
   RoutineVariableDefaultValue,
+  RoutineRevisionSnapshotRoutineV1,
+  RoutineRevisionSnapshotTriggerV1,
+  RoutineRevisionSnapshotV1,
+  RoutineRevisionSnapshot,
+  RoutineRevision,
   RoutineTrigger,
   RoutineRun,
   RoutineTriggerSecretMaterial,
@@ -781,6 +786,10 @@ export {
   routineVariableSchema,
   runRoutineSchema,
   rotateRoutineTriggerSecretSchema,
+  routineRevisionSnapshotRoutineV1Schema,
+  routineRevisionSnapshotTriggerV1Schema,
+  routineRevisionSnapshotV1Schema,
+  routineRevisionSnapshotSchema,
   type CreateSecret,
   type RotateSecret,
   type UpdateSecret,

packages/shared/src/types/index.ts

@@ -224,6 +224,11 @@ export type {
   RoutineManagedByPlugin,
   RoutineVariable,
   RoutineVariableDefaultValue,
+  RoutineRevisionSnapshotRoutineV1,
+  RoutineRevisionSnapshotTriggerV1,
+  RoutineRevisionSnapshotV1,
+  RoutineRevisionSnapshot,
+  RoutineRevision,
   RoutineTrigger,
   RoutineRun,
   RoutineTriggerSecretMaterial,

packages/shared/src/types/routine.ts

@@ -1,4 +1,13 @@
-import type { IssueOriginKind, RoutineVariableType } from "../constants.js";
+import type {
+  IssueOriginKind,
+  IssuePriority,
+  RoutineCatchUpPolicy,
+  RoutineConcurrencyPolicy,
+  RoutineStatus,
+  RoutineTriggerKind,
+  RoutineTriggerSigningMode,
+  RoutineVariableType,
+} from "../constants.js";
 
 export interface RoutineProjectSummary {
   id: string;
@@ -50,6 +59,8 @@ export interface Routine {
   concurrencyPolicy: string;
   catchUpPolicy: string;
   variables: RoutineVariable[];
+  latestRevisionId: string | null;
+  latestRevisionNumber: number;
   createdByAgentId: string | null;
   createdByUserId: string | null;
   updatedByAgentId: string | null;
@@ -73,6 +84,58 @@ export interface RoutineManagedByPlugin {
   updatedAt: Date;
 }
 
+export interface RoutineRevisionSnapshotRoutineV1 {
+  id: string;
+  companyId: string;
+  projectId: string | null;
+  goalId: string | null;
+  parentIssueId: string | null;
+  title: string;
+  description: string | null;
+  assigneeAgentId: string | null;
+  priority: IssuePriority;
+  status: RoutineStatus;
+  concurrencyPolicy: RoutineConcurrencyPolicy;
+  catchUpPolicy: RoutineCatchUpPolicy;
+  variables: RoutineVariable[];
+}
+
+export interface RoutineRevisionSnapshotTriggerV1 {
+  id: string;
+  kind: RoutineTriggerKind;
+  label: string | null;
+  enabled: boolean;
+  cronExpression: string | null;
+  timezone: string | null;
+  publicId: string | null;
+  signingMode: RoutineTriggerSigningMode | null;
+  replayWindowSec: number | null;
+}
+
+export interface RoutineRevisionSnapshotV1 {
+  version: 1;
+  routine: RoutineRevisionSnapshotRoutineV1;
+  triggers: RoutineRevisionSnapshotTriggerV1[];
+}
+
+export type RoutineRevisionSnapshot = RoutineRevisionSnapshotV1;
+
+export interface RoutineRevision {
+  id: string;
+  companyId: string;
+  routineId: string;
+  revisionNumber: number;
+  title: string;
+  description: string | null;
+  snapshot: RoutineRevisionSnapshot;
+  changeSummary: string | null;
+  restoredFromRevisionId: string | null;
+  createdByAgentId: string | null;
+  createdByUserId: string | null;
+  createdByRunId: string | null;
+  createdAt: Date;
+}
+
 export interface RoutineTrigger {
   id: string;
   companyId: string;

packages/shared/src/validators/index.ts

@@ -278,6 +278,10 @@ export {
   createRoutineTriggerSchema,
   updateRoutineTriggerSchema,
   routineVariableSchema,
+  routineRevisionSnapshotRoutineV1Schema,
+  routineRevisionSnapshotTriggerV1Schema,
+  routineRevisionSnapshotV1Schema,
+  routineRevisionSnapshotSchema,
   runRoutineSchema,
   rotateRoutineTriggerSecretSchema,
   type CreateRoutine,

packages/shared/src/validators/routine.test.ts

@@ -0,0 +1,86 @@
+import { describe, expect, it } from "vitest";
+import {
+  routineRevisionSnapshotV1Schema,
+  updateRoutineSchema,
+} from "./routine.js";
+
+const routineId = "11111111-1111-4111-8111-111111111111";
+const companyId = "22222222-2222-4222-8222-222222222222";
+const triggerId = "33333333-3333-4333-8333-333333333333";
+const baseRevisionId = "44444444-4444-4444-8444-444444444444";
+
+describe("routine validators", () => {
+  it("accepts versioned routine revision snapshots with safe trigger metadata", () => {
+    const parsed = routineRevisionSnapshotV1Schema.parse({
+      version: 1,
+      routine: {
+        id: routineId,
+        companyId,
+        projectId: null,
+        goalId: null,
+        parentIssueId: null,
+        title: "Daily triage",
+        description: null,
+        assigneeAgentId: null,
+        priority: "medium",
+        status: "active",
+        concurrencyPolicy: "coalesce_if_active",
+        catchUpPolicy: "skip_missed",
+        variables: [],
+      },
+      triggers: [{
+        id: triggerId,
+        kind: "webhook",
+        label: "Inbound",
+        enabled: true,
+        cronExpression: null,
+        timezone: null,
+        publicId: "routine_webhook_123",
+        signingMode: "bearer",
+        replayWindowSec: 300,
+      }],
+    });
+
+    expect(parsed.triggers[0]?.publicId).toBe("routine_webhook_123");
+  });
+
+  it("rejects secret-bearing trigger fields in routine revision snapshots", () => {
+    expect(() => routineRevisionSnapshotV1Schema.parse({
+      version: 1,
+      routine: {
+        id: routineId,
+        companyId,
+        projectId: null,
+        goalId: null,
+        parentIssueId: null,
+        title: "Daily triage",
+        description: null,
+        assigneeAgentId: null,
+        priority: "medium",
+        status: "active",
+        concurrencyPolicy: "coalesce_if_active",
+        catchUpPolicy: "skip_missed",
+        variables: [],
+      },
+      triggers: [{
+        id: triggerId,
+        kind: "webhook",
+        label: "Inbound",
+        enabled: true,
+        cronExpression: null,
+        timezone: null,
+        publicId: "routine_webhook_123",
+        signingMode: "bearer",
+        replayWindowSec: 300,
+        secretId: "55555555-5555-4555-8555-555555555555",
+      }],
+    })).toThrow();
+  });
+
+  it("accepts optional base revision ids on routine updates", () => {
+    expect(updateRoutineSchema.parse({
+      title: "Daily triage",
+      baseRevisionId,
+    }).baseRevisionId).toBe(baseRevisionId);
+  });
+});

packages/shared/src/validators/routine.ts

@@ -4,6 +4,7 @@ import {
   ROUTINE_CATCH_UP_POLICIES,
   ROUTINE_CONCURRENCY_POLICIES,
   ROUTINE_STATUSES,
+  ROUTINE_TRIGGER_KINDS,
   ROUTINE_TRIGGER_SIGNING_MODES,
   ROUTINE_VARIABLE_TYPES,
 } from "../constants.js";
@@ -63,9 +64,49 @@ export const createRoutineSchema = z.object({
 
 export type CreateRoutine = z.infer<typeof createRoutineSchema>;
 
-export const updateRoutineSchema = createRoutineSchema.partial();
+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),

ui/src/lib/workspace-routines.test.ts

@@ -20,6 +20,8 @@ function createRoutine(overrides: Partial<RoutineListItem> = {}): RoutineListIte
     concurrencyPolicy: "coalesce_if_active",
     catchUpPolicy: "skip_missed",
     variables: [],
+    latestRevisionId: null,
+    latestRevisionNumber: 1,
     createdByAgentId: null,
     createdByUserId: null,
     updatedByAgentId: null,

ui/src/pages/Routines.test.tsx

@@ -247,6 +247,8 @@ function createRoutine(overrides: Partial<RoutineListItem>): RoutineListItem {
     concurrencyPolicy: "coalesce_if_active",
     catchUpPolicy: "skip_missed",
     variables: [],
+    latestRevisionId: null,
+    latestRevisionNumber: 1,
     createdByAgentId: null,
     createdByUserId: null,
     updatedByAgentId: null,