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>
471 lines
13 KiB
TypeScript
471 lines
13 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const companyId = "22222222-2222-4222-8222-222222222222";
|
|
const agentId = "11111111-1111-4111-8111-111111111111";
|
|
const routineId = "33333333-3333-4333-8333-333333333333";
|
|
const projectId = "44444444-4444-4444-8444-444444444444";
|
|
const otherAgentId = "55555555-5555-4555-8555-555555555555";
|
|
const revisionId = "77777777-7777-4777-8777-777777777777";
|
|
|
|
const routine = {
|
|
id: routineId,
|
|
companyId,
|
|
projectId,
|
|
goalId: null,
|
|
parentIssueId: null,
|
|
title: "Daily routine",
|
|
description: null,
|
|
assigneeAgentId: agentId,
|
|
priority: "medium",
|
|
status: "active",
|
|
concurrencyPolicy: "coalesce_if_active",
|
|
catchUpPolicy: "skip_missed",
|
|
variables: [],
|
|
latestRevisionId: revisionId,
|
|
latestRevisionNumber: 1,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
updatedByAgentId: null,
|
|
updatedByUserId: null,
|
|
lastTriggeredAt: null,
|
|
lastEnqueuedAt: null,
|
|
createdAt: new Date("2026-03-20T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-20T00:00:00.000Z"),
|
|
};
|
|
|
|
const revision = {
|
|
id: revisionId,
|
|
companyId,
|
|
routineId,
|
|
revisionNumber: 1,
|
|
title: "Daily routine",
|
|
description: null,
|
|
snapshot: {
|
|
version: 1,
|
|
routine: {
|
|
id: routineId,
|
|
companyId,
|
|
projectId,
|
|
goalId: null,
|
|
parentIssueId: null,
|
|
title: "Daily routine",
|
|
description: null,
|
|
assigneeAgentId: agentId,
|
|
priority: "medium",
|
|
status: "active",
|
|
concurrencyPolicy: "coalesce_if_active",
|
|
catchUpPolicy: "skip_missed",
|
|
variables: [],
|
|
},
|
|
triggers: [],
|
|
},
|
|
changeSummary: "Created routine",
|
|
restoredFromRevisionId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: "board-user",
|
|
createdByRunId: null,
|
|
createdAt: new Date("2026-03-20T00:00:00.000Z"),
|
|
};
|
|
const pausedRoutine = {
|
|
...routine,
|
|
status: "paused",
|
|
};
|
|
const trigger = {
|
|
id: "66666666-6666-4666-8666-666666666666",
|
|
companyId,
|
|
routineId,
|
|
kind: "schedule",
|
|
label: "weekday",
|
|
enabled: false,
|
|
cronExpression: "0 10 * * 1-5",
|
|
timezone: "UTC",
|
|
nextRunAt: null,
|
|
lastFiredAt: null,
|
|
publicId: null,
|
|
secretId: null,
|
|
signingMode: null,
|
|
replayWindowSec: null,
|
|
lastRotatedAt: null,
|
|
lastResult: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
updatedByAgentId: null,
|
|
updatedByUserId: null,
|
|
createdAt: new Date("2026-03-20T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-20T00:00:00.000Z"),
|
|
};
|
|
|
|
const mockRoutineService = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
get: vi.fn(),
|
|
getDetail: vi.fn(),
|
|
update: vi.fn(),
|
|
create: vi.fn(),
|
|
listRevisions: vi.fn(),
|
|
restoreRevision: vi.fn(),
|
|
listRuns: vi.fn(),
|
|
createTrigger: vi.fn(),
|
|
getTrigger: vi.fn(),
|
|
updateTrigger: vi.fn(),
|
|
deleteTrigger: vi.fn(),
|
|
rotateTriggerSecret: vi.fn(),
|
|
runRoutine: vi.fn(),
|
|
firePublicTrigger: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessService = vi.hoisted(() => ({
|
|
canUser: vi.fn(),
|
|
}));
|
|
|
|
const mockLogActivity = vi.hoisted(() => vi.fn());
|
|
const mockTrackRoutineCreated = vi.hoisted(() => vi.fn());
|
|
const mockGetTelemetryClient = vi.hoisted(() => vi.fn());
|
|
|
|
function registerModuleMocks() {
|
|
vi.doMock("../routes/authz.js", async () => vi.importActual("../routes/authz.js"));
|
|
|
|
vi.doMock("@paperclipai/shared/telemetry", () => ({
|
|
trackRoutineCreated: mockTrackRoutineCreated,
|
|
trackErrorHandlerCrash: vi.fn(),
|
|
}));
|
|
|
|
vi.doMock("../telemetry.js", () => ({
|
|
getTelemetryClient: mockGetTelemetryClient,
|
|
}));
|
|
|
|
vi.doMock("../services/access.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
}));
|
|
|
|
vi.doMock("../services/routines.js", () => ({
|
|
routineService: () => mockRoutineService,
|
|
}));
|
|
|
|
vi.doMock("../services/activity-log.js", () => ({
|
|
logActivity: mockLogActivity,
|
|
}));
|
|
|
|
vi.doMock("../services/index.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
logActivity: mockLogActivity,
|
|
routineService: () => mockRoutineService,
|
|
}));
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>) {
|
|
const [{ errorHandler }, { routineRoutes }] = await Promise.all([
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
vi.importActual<typeof import("../routes/routines.js")>("../routes/routines.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api", routineRoutes({} as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("routine routes", () => {
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("@paperclipai/shared/telemetry");
|
|
vi.doUnmock("../telemetry.js");
|
|
vi.doUnmock("../services/access.js");
|
|
vi.doUnmock("../services/index.js");
|
|
vi.doUnmock("../services/activity-log.js");
|
|
vi.doUnmock("../services/routines.js");
|
|
vi.doUnmock("../routes/routines.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerModuleMocks();
|
|
vi.clearAllMocks();
|
|
mockGetTelemetryClient.mockReturnValue({ track: vi.fn() });
|
|
mockRoutineService.list.mockResolvedValue([routine]);
|
|
mockRoutineService.create.mockResolvedValue(routine);
|
|
mockRoutineService.get.mockResolvedValue(routine);
|
|
mockRoutineService.getTrigger.mockResolvedValue(trigger);
|
|
mockRoutineService.update.mockResolvedValue({ ...routine, assigneeAgentId: otherAgentId });
|
|
mockRoutineService.listRevisions.mockResolvedValue([revision]);
|
|
mockRoutineService.restoreRevision.mockResolvedValue({
|
|
routine,
|
|
revision: { ...revision, revisionNumber: 2, restoredFromRevisionId: revision.id },
|
|
restoredFromRevisionId: revision.id,
|
|
restoredFromRevisionNumber: revision.revisionNumber,
|
|
secretMaterials: [],
|
|
});
|
|
mockRoutineService.runRoutine.mockResolvedValue({
|
|
id: "run-1",
|
|
source: "manual",
|
|
status: "issue_created",
|
|
});
|
|
mockAccessService.canUser.mockResolvedValue(false);
|
|
mockLogActivity.mockResolvedValue(undefined);
|
|
});
|
|
|
|
it("passes project filters to the routine list service", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.get(`/api/companies/${companyId}/routines`)
|
|
.query({ projectId });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockRoutineService.list).toHaveBeenCalledWith(companyId, { projectId });
|
|
});
|
|
|
|
it("lists routine revisions for a board member in newest-first service order", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app).get(`/api/routines/${routineId}/revisions`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockRoutineService.listRevisions).toHaveBeenCalledWith(routineId);
|
|
expect(res.body[0]).toMatchObject({ id: revisionId, revisionNumber: 1 });
|
|
});
|
|
|
|
it("blocks routine revision reads across company scope", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["99999999-9999-4999-8999-999999999999"],
|
|
});
|
|
|
|
const res = await request(app).get(`/api/routines/${routineId}/revisions`);
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockRoutineService.listRevisions).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires an assigned agent for routine revision history access", async () => {
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: otherAgentId,
|
|
companyId,
|
|
});
|
|
|
|
const res = await request(app).get(`/api/routines/${routineId}/revisions`);
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockRoutineService.listRevisions).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("restores routine revisions with existing routine-management permissions", async () => {
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
runId: "88888888-8888-4888-8888-888888888888",
|
|
});
|
|
|
|
const res = await request(app).post(`/api/routines/${routineId}/revisions/${revisionId}/restore`).send({});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockRoutineService.restoreRevision).toHaveBeenCalledWith(routineId, revisionId, {
|
|
agentId,
|
|
userId: null,
|
|
runId: "88888888-8888-4888-8888-888888888888",
|
|
});
|
|
expect(mockLogActivity).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({
|
|
action: "routine.revision_restored",
|
|
entityId: routineId,
|
|
runId: "88888888-8888-4888-8888-888888888888",
|
|
}));
|
|
});
|
|
|
|
it("requires tasks:assign permission for non-admin board routine creation", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/companies/${companyId}/routines`)
|
|
.send({
|
|
projectId,
|
|
title: "Daily routine",
|
|
assigneeAgentId: agentId,
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires tasks:assign permission to retarget a routine assignee", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch(`/api/routines/${routineId}`)
|
|
.send({
|
|
assigneeAgentId: otherAgentId,
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires tasks:assign permission to reactivate a routine", async () => {
|
|
mockRoutineService.get.mockResolvedValue(pausedRoutine);
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch(`/api/routines/${routineId}`)
|
|
.send({
|
|
status: "active",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.update).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires tasks:assign permission to create a trigger", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/routines/${routineId}/triggers`)
|
|
.send({
|
|
kind: "schedule",
|
|
cronExpression: "0 10 * * *",
|
|
timezone: "UTC",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.createTrigger).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires tasks:assign permission to update a trigger", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.patch(`/api/routine-triggers/${trigger.id}`)
|
|
.send({
|
|
enabled: true,
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.updateTrigger).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires tasks:assign permission to manually run a routine", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/routines/${routineId}/run`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("tasks:assign");
|
|
expect(mockRoutineService.runRoutine).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("passes the board actor through when manually running a routine", async () => {
|
|
mockAccessService.canUser.mockResolvedValue(true);
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/routines/${routineId}/run`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(202);
|
|
expect(mockRoutineService.runRoutine).toHaveBeenCalledWith(routineId, {
|
|
source: "manual",
|
|
}, {
|
|
agentId: null,
|
|
userId: "board-user",
|
|
});
|
|
});
|
|
|
|
it("allows routine creation when the board user has tasks:assign", async () => {
|
|
mockAccessService.canUser.mockResolvedValue(true);
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyId],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/companies/${companyId}/routines`)
|
|
.send({
|
|
projectId,
|
|
title: "Daily routine",
|
|
assigneeAgentId: agentId,
|
|
});
|
|
|
|
expect(res.status).toBe(201);
|
|
expect(mockRoutineService.create).toHaveBeenCalledWith(companyId, expect.objectContaining({
|
|
projectId,
|
|
title: "Daily routine",
|
|
assigneeAgentId: agentId,
|
|
}), {
|
|
agentId: null,
|
|
userId: "board-user",
|
|
runId: null,
|
|
});
|
|
expect(mockTrackRoutineCreated).toHaveBeenCalledWith(expect.anything());
|
|
});
|
|
});
|