mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
Add routine revision history and restore flow (#5285)
## 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>
This commit is contained in:
parent
9578dc3da7
commit
d6d7a7cea6
27 changed files with 19593 additions and 238 deletions
140
packages/db/src/migrations/0077_unusual_karnak.sql
Normal file
140
packages/db/src/migrations/0077_unusual_karnak.sql
Normal file
|
|
@ -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;
|
||||
16355
packages/db/src/migrations/meta/0077_snapshot.json
Normal file
16355
packages/db/src/migrations/meta/0077_snapshot.json
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -540,6 +540,13 @@
|
|||
"when": 1777675301279,
|
||||
"tag": "0076_useful_elektra",
|
||||
"breakpoints": true
|
||||
},
|
||||
{
|
||||
"idx": 77,
|
||||
"version": "7",
|
||||
"when": 1777933347806,
|
||||
"tag": "0077_unusual_karnak",
|
||||
"breakpoints": true
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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";
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue