Files
PaperClipAI/server/src/services/decision-retention.ts
T
0a09e4d975 feat(decisions): add desk workflow and retention (#10672)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The Decisions desk shows work that needs a human decision
> - The queue foundation can group and rank decision work
> - Operators also need a focused daily view and a safe way to handle
old work
> - This pull request adds the desk controls, the aging shelf, and
reversible retention
> - It also binds bulk archive decisions to the exact reviewed item set
> - The benefit is a smaller daily queue without lost or orphaned work

## Linked Issues or Issue Description

**Subsystem affected**

Cross-cutting: server, UI, database, and shared contracts.

**Problem or motivation**

Decision work can grow into one large company list. Operators need quick
queue and date controls. Old items also need a safe retention path that
does not delete work.

**Proposed solution**

Add queue and date controls to the Decisions desk. Compute the aging
shelf on the server. Archive idle items after 90 days unless an operator
keeps them. Keep archived items searchable and revivable. Notify origin
agents in one batch per sweep. Bind bulk archive proposals to a signed,
exact item manifest.

**Alternatives considered**

Client-only aging can drift across browsers and source kinds. Deleting
old rows removes audit and recovery paths. An unsigned dynamic bulk
query can archive items that the reviewer did not inspect.

**Roadmap alignment**

This work supports the Work Queues and decision-memory directions in
`ROADMAP.md`. It extends the Decisions and attention-feed foundation
from #10651. Related earlier work includes #9380, #10010, and #10474.

## What Changed

- Added the queue rail, date chips, decide split, triage strip, queue
page, and aging shelf UI.
- Added server-owned shelf state with per-queue retention overrides.
- Added reversible retention state, archive history, and an idempotent
notification outbox.
- Added the 90-day archive sweeper, Keep exemption, archived feed query,
and revive actions.
- Added one origin-agent notification per agent and sweep.
- Added signed bulk archive proposals with exact-set and version checks.
- Persisted queue-exclusion reasons atomically and kept cross-domain
source resolution per-item until it has an exact-set transaction
contract.
- Added API contracts, OpenAPI entries, migration coverage, focused
tests, and Storybook screens.

## Verification

- `pnpm -r typecheck`
- `pnpm test:run` (server: 329 files and 3,453 tests passed; UI: 408
files and 3,362 tests passed)
- `env -u AWS_ACCESS_KEY_ID -u AWS_SECRET_ACCESS_KEY pnpm exec vitest
run cli/src/__tests__/secrets.test.ts`
- `pnpm build`
- `pnpm check:token-gates`
- Focused retention, attention, decisions, migration replay, startup,
and UI API tests.
- Complete queue snapshot regression with 51 items across the normal
50-item page boundary.

The unmodified CLI test reports one warning assertion in this runtime
because the harness injects static AWS credential variables. The
isolated test passes when those two variables are removed.

## Risks

- The migration adds retention and notification outbox tables. It uses
idempotent table, index, and foreign-key creation.
- Retention runs on the heartbeat scheduler interval. Compare-and-set
version checks prevent stale archive writes.
- Bulk archive acceptance fails closed when authority, activity,
version, or the reviewed set changes.
- Archive is reversible and does not delete source records.

> 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 with `gpt-5.6-sol`. The model used tool calls, code
execution, database migration generation, and test execution. The
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 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 not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] 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: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-08-02 10:47:03 -05:00

483 lines
20 KiB
TypeScript

import { createHash } from "node:crypto";
import { and, asc, eq, inArray, isNotNull, isNull, lte, ne, or, sql } from "drizzle-orm";
import type { Db } from "@paperclipai/db";
import {
agents,
approvals,
decisionArchiveNotificationOutbox,
decisionRetention,
decisions,
heartbeatRuns,
issueApprovals,
issueRecoveryActions,
issueThreadInteractions,
issues,
} from "@paperclipai/db";
import type {
AttentionArchiveManifestEntry,
AttentionItem,
AttentionSourceKind,
} from "@paperclipai/shared";
import { conflict, notFound, unprocessable } from "../errors.js";
import { logActivity } from "./activity-log.js";
import type { AuthorizationActor } from "./authorization.js";
import {
canReadDecisionSource,
type DecisionMutationActor,
} from "./decision-queues.js";
export const DEFAULT_DECISION_SHELF_DAYS = 30;
export const DEFAULT_DECISION_ARCHIVE_DAYS = 90;
const DAY_MS = 86_400_000;
export type DecisionRetentionState = typeof decisionRetention.$inferSelect;
export type ArchiveNotificationBatch = {
companyId: string;
agentId: string;
items: Array<{
sourceKind: AttentionSourceKind;
sourceId: string;
archiveVersion: number;
issueId: string;
}>;
};
function sourceKey(sourceKind: string, sourceId: string) {
return `${sourceKind}:${sourceId}`;
}
function canonicalManifest(manifest: readonly AttentionArchiveManifestEntry[]) {
return [...manifest].sort((left, right) => {
const leftKey = `${left.companyId}:${left.sourceKind}:${left.sourceId}`;
const rightKey = `${right.companyId}:${right.sourceKind}:${right.sourceId}`;
return leftKey.localeCompare(rightKey);
}).map((entry) => ({
companyId: entry.companyId,
sourceKind: entry.sourceKind,
sourceId: entry.sourceId,
expectedVersion: entry.expectedVersion,
activityAt: entry.activityAt,
reason: entry.reason,
}));
}
export function hashAttentionArchiveManifest(manifest: readonly AttentionArchiveManifestEntry[]) {
return createHash("sha256").update(JSON.stringify(canonicalManifest(manifest))).digest("hex");
}
function archiveActorColumns(actor: DecisionMutationActor) {
return {
archivedByType: actor.actorType,
archivedByAgentId: actor.agentId,
archivedByUserId: actor.userId,
archivedByRunId: actor.runId,
};
}
async function resolveOrigin(
db: Db,
companyId: string,
sourceKind: AttentionSourceKind,
sourceId: string,
) {
let originAgentId: string | null = null;
let originIssueId: string | null = null;
if (sourceKind === "approval") {
const row = await db.select({ agentId: approvals.requestedByAgentId, issueId: issueApprovals.issueId })
.from(approvals)
.leftJoin(issueApprovals, and(eq(issueApprovals.companyId, companyId), eq(issueApprovals.approvalId, approvals.id)))
.where(and(eq(approvals.companyId, companyId), eq(approvals.id, sourceId)))
.then((rows) => rows[0] ?? null);
originAgentId = row?.agentId ?? null;
originIssueId = row?.issueId ?? null;
} else if (sourceKind === "decision") {
const row = await db.select({ agentId: decisions.originAgentId, issueId: decisions.originIssueId })
.from(decisions).where(and(eq(decisions.companyId, companyId), eq(decisions.id, sourceId)))
.then((rows) => rows[0] ?? null);
originAgentId = row?.agentId ?? null;
originIssueId = row?.issueId ?? null;
} else if (sourceKind === "issue_thread_interaction") {
const row = await db.select({ agentId: issueThreadInteractions.createdByAgentId, issueId: issueThreadInteractions.issueId })
.from(issueThreadInteractions)
.where(and(eq(issueThreadInteractions.companyId, companyId), eq(issueThreadInteractions.id, sourceId)))
.then((rows) => rows[0] ?? null);
originAgentId = row?.agentId ?? null;
originIssueId = row?.issueId ?? null;
} else if (sourceKind === "failed_run") {
const row = await db.select({ agentId: heartbeatRuns.agentId, context: heartbeatRuns.contextSnapshot })
.from(heartbeatRuns).where(and(eq(heartbeatRuns.companyId, companyId), eq(heartbeatRuns.id, sourceId)))
.then((rows) => rows[0] ?? null);
const context = row?.context && typeof row.context === "object" ? row.context as Record<string, unknown> : {};
originAgentId = row?.agentId ?? null;
originIssueId = typeof context.issueId === "string" ? context.issueId : typeof context.taskId === "string" ? context.taskId : null;
} else {
const issueId = sourceKind === "recovery_action"
? await db.select({ issueId: issueRecoveryActions.sourceIssueId }).from(issueRecoveryActions)
.where(and(eq(issueRecoveryActions.companyId, companyId), eq(issueRecoveryActions.id, sourceId)))
.then((rows) => rows[0]?.issueId ?? null)
: (["productivity_review", "blocker_attention", "review"] as string[]).includes(sourceKind) ? sourceId : null;
if (issueId) {
const row = await db.select({ agentId: issues.createdByAgentId, issueId: issues.id }).from(issues)
.where(and(eq(issues.companyId, companyId), eq(issues.id, issueId)))
.then((rows) => rows[0] ?? null);
originAgentId = row?.agentId ?? null;
originIssueId = row?.issueId ?? null;
}
}
if (!originAgentId || !originIssueId) return null;
const activeAgent = await db.select({ id: agents.id }).from(agents)
.where(and(eq(agents.companyId, companyId), eq(agents.id, originAgentId), eq(agents.status, "active")))
.then((rows) => rows[0] ?? null);
return activeAgent ? { originAgentId, originIssueId } : null;
}
export function decisionRetentionService(
db: Db,
options: { notifyOriginAgent?: (batch: ArchiveNotificationBatch) => Promise<unknown> } = {},
) {
async function syncItems(companyId: string, items: readonly AttentionItem[]) {
if (items.length === 0) return new Map<string, DecisionRetentionState>();
const unique = [...new Map(items.map((item) => [itemSourceKey(item), item])).values()];
await db.insert(decisionRetention).values(unique.map((item) => ({
companyId,
sourceKind: item.sourceKind,
sourceId: item.subject.id,
sourceActivityAt: new Date(item.activityAt),
}))).onConflictDoNothing({
target: [decisionRetention.companyId, decisionRetention.sourceKind, decisionRetention.sourceId],
});
let rows = await db.select().from(decisionRetention).where(and(
eq(decisionRetention.companyId, companyId),
inArray(decisionRetention.sourceId, unique.map((item) => item.subject.id)),
));
const byKey = new Map(rows.map((row) => [sourceKey(row.sourceKind, row.sourceId), row]));
for (const item of unique) {
const key = itemSourceKey(item);
const row = byKey.get(key);
const activityAt = new Date(item.activityAt);
if (!row || row.sourceActivityAt.getTime() === activityAt.getTime()) continue;
const updated = await db.update(decisionRetention).set({
sourceActivityAt: activityAt,
version: sql`${decisionRetention.version} + 1`,
updatedAt: new Date(),
}).where(and(
eq(decisionRetention.id, row.id),
ne(decisionRetention.sourceActivityAt, activityAt),
)).returning().then((values) => values[0] ?? null);
if (updated) byKey.set(key, updated);
}
rows = [...byKey.values()];
return new Map(rows.map((row) => [sourceKey(row.sourceKind, row.sourceId), row]));
}
function itemSourceKey(item: AttentionItem) {
return sourceKey(item.sourceKind, item.subject.id);
}
async function getState(companyId: string, sourceKind: AttentionSourceKind, sourceId: string) {
return db.select().from(decisionRetention).where(and(
eq(decisionRetention.companyId, companyId),
eq(decisionRetention.sourceKind, sourceKind),
eq(decisionRetention.sourceId, sourceId),
)).then((rows) => rows[0] ?? null);
}
async function setKeep(input: {
companyId: string;
sourceKind: AttentionSourceKind;
sourceId: string;
keep: boolean;
authActor: AuthorizationActor;
actor: DecisionMutationActor;
}) {
if (!(await canReadDecisionSource(db, input.authActor, input.companyId, input.sourceKind, input.sourceId))) {
throw notFound("Attention source not found");
}
const updated = await db.update(decisionRetention).set({
keep: input.keep,
version: sql`${decisionRetention.version} + 1`,
updatedAt: new Date(),
}).where(and(
eq(decisionRetention.companyId, input.companyId),
eq(decisionRetention.sourceKind, input.sourceKind),
eq(decisionRetention.sourceId, input.sourceId),
)).returning().then((rows) => rows[0] ?? null);
if (!updated) throw notFound("Attention source not found");
await logActivity(db, {
companyId: input.companyId,
actorType: input.actor.actorType,
actorId: input.actor.actorId,
agentId: input.actor.agentId,
runId: input.actor.runId,
agentApiKeyId: input.actor.agentApiKeyId,
responsibleUserIdOverride: input.actor.responsibleUserId,
action: "decision_retention.keep_updated",
entityType: "attention_source",
entityId: input.sourceId,
details: { sourceKind: input.sourceKind, keep: input.keep },
});
return updated;
}
async function changeArchived(input: {
companyId: string;
sourceKind: AttentionSourceKind;
sourceId: string;
archived: boolean;
authActor: AuthorizationActor;
actor: DecisionMutationActor;
}) {
if (!(await canReadDecisionSource(db, input.authActor, input.companyId, input.sourceKind, input.sourceId))) {
throw notFound("Attention source not found");
}
const now = new Date();
const updated = await db.update(decisionRetention).set(input.archived ? {
archivedAt: now,
archivedReason: "manual",
...archiveActorColumns(input.actor),
archiveVersion: sql`${decisionRetention.archiveVersion} + 1`,
version: sql`${decisionRetention.version} + 1`,
updatedAt: now,
} : {
archivedAt: null,
archivedReason: null,
archivedByType: null,
archivedByAgentId: null,
archivedByUserId: null,
archivedByRunId: null,
version: sql`${decisionRetention.version} + 1`,
updatedAt: now,
}).where(and(
eq(decisionRetention.companyId, input.companyId),
eq(decisionRetention.sourceKind, input.sourceKind),
eq(decisionRetention.sourceId, input.sourceId),
input.archived ? isNull(decisionRetention.archivedAt) : isNotNull(decisionRetention.archivedAt),
)).returning().then((rows) => rows[0] ?? null);
if (!updated) {
const current = await getState(input.companyId, input.sourceKind, input.sourceId);
if (!current) throw notFound("Attention source not found");
return current;
}
await logActivity(db, {
companyId: input.companyId,
actorType: input.actor.actorType,
actorId: input.actor.actorId,
agentId: input.actor.agentId,
runId: input.actor.runId,
agentApiKeyId: input.actor.agentApiKeyId,
responsibleUserIdOverride: input.actor.responsibleUserId,
action: input.archived ? "decision_retention.archived" : "decision_retention.revived",
entityType: "attention_source",
entityId: input.sourceId,
details: { sourceKind: input.sourceKind },
});
return updated;
}
async function archiveReviewedManifest(input: {
companyId: string;
manifest: AttentionArchiveManifestEntry[];
originActor: AuthorizationActor;
decidingActor: AuthorizationActor;
decidedByUserId: string;
}) {
const keys = input.manifest.map((entry) => sourceKey(entry.sourceKind, entry.sourceId));
if (new Set(keys).size !== keys.length || input.manifest.some((entry) => entry.companyId !== input.companyId)) {
throw unprocessable("Archive manifest must contain one exact company-scoped set");
}
return db.transaction(async (tx) => {
const txDb = tx as unknown as Db;
for (const entry of input.manifest) {
const kind = entry.sourceKind as AttentionSourceKind;
if (!(await canReadDecisionSource(txDb, input.originActor, input.companyId, kind, entry.sourceId))
|| !(await canReadDecisionSource(txDb, input.decidingActor, input.companyId, kind, entry.sourceId))) {
throw conflict("archive_proposal_authority_changed", { code: "archive_proposal_authority_changed" });
}
await txDb.execute(sql`select pg_advisory_xact_lock(hashtextextended(${`decision-retention:${input.companyId}:${entry.sourceKind}:${entry.sourceId}`}, 0))`);
const state = await txDb.select().from(decisionRetention).where(and(
eq(decisionRetention.companyId, input.companyId),
eq(decisionRetention.sourceKind, entry.sourceKind),
eq(decisionRetention.sourceId, entry.sourceId),
)).then((rows) => rows[0] ?? null);
if (!state || state.version !== entry.expectedVersion || state.sourceActivityAt.toISOString() !== entry.activityAt || state.archivedAt) {
throw conflict("archive_proposal_stale", { code: "archive_proposal_stale" });
}
}
const now = new Date();
for (const entry of input.manifest) {
const archived = await txDb.update(decisionRetention).set({
archivedAt: now,
archivedReason: "accepted_proposal",
archivedByType: "user",
archivedByAgentId: null,
archivedByUserId: input.decidedByUserId,
archivedByRunId: null,
archiveVersion: sql`${decisionRetention.archiveVersion} + 1`,
version: sql`${decisionRetention.version} + 1`,
updatedAt: now,
}).where(and(
eq(decisionRetention.companyId, input.companyId),
eq(decisionRetention.sourceKind, entry.sourceKind),
eq(decisionRetention.sourceId, entry.sourceId),
eq(decisionRetention.version, entry.expectedVersion),
isNull(decisionRetention.archivedAt),
)).returning({ id: decisionRetention.id });
if (archived.length !== 1) {
throw conflict("archive_proposal_stale", { code: "archive_proposal_stale" });
}
await logActivity(txDb, {
companyId: input.companyId,
actorType: "system",
actorId: "decision-archive-proposal",
responsibleUserIdOverride: input.decidedByUserId,
action: "decision_retention.archived",
entityType: "attention_source",
entityId: entry.sourceId,
details: { sourceKind: entry.sourceKind, reason: "accepted_proposal" },
});
}
return { archived: input.manifest.length };
});
}
async function autoArchive(input: { companyId: string; items: AttentionItem[]; now?: Date }) {
const now = input.now ?? new Date();
const cutoff = new Date(now.getTime() - DEFAULT_DECISION_ARCHIVE_DAYS * DAY_MS);
const candidates = input.items.filter((item) => new Date(item.activityAt) <= cutoff && !item.keep && !item.archivedAt);
let archived = 0;
await db.transaction(async (tx) => {
const txDb = tx as unknown as Db;
for (const item of candidates) {
const updated = await txDb.update(decisionRetention).set({
archivedAt: now,
archivedReason: "idle_ttl",
archivedByType: "system",
archivedByAgentId: null,
archivedByUserId: null,
archivedByRunId: null,
archiveVersion: sql`${decisionRetention.archiveVersion} + 1`,
version: sql`${decisionRetention.version} + 1`,
updatedAt: now,
}).where(and(
eq(decisionRetention.companyId, input.companyId),
eq(decisionRetention.sourceKind, item.sourceKind),
eq(decisionRetention.sourceId, item.subject.id),
eq(decisionRetention.version, item.retentionVersion),
eq(decisionRetention.keep, false),
isNull(decisionRetention.archivedAt),
lte(decisionRetention.sourceActivityAt, cutoff),
)).returning().then((rows) => rows[0] ?? null);
if (!updated) continue;
archived += 1;
const origin = await resolveOrigin(txDb, input.companyId, item.sourceKind, item.subject.id);
if (origin) {
await txDb.insert(decisionArchiveNotificationOutbox).values({
companyId: input.companyId,
sourceKind: item.sourceKind,
sourceId: item.subject.id,
archiveVersion: updated.archiveVersion,
originAgentId: origin.originAgentId,
originIssueId: origin.originIssueId,
}).onConflictDoNothing();
}
await logActivity(txDb, {
companyId: input.companyId,
actorType: "system",
actorId: "decision-retention-sweeper",
action: "decision_retention.auto_archived",
entityType: "attention_source",
entityId: item.subject.id,
details: { sourceKind: item.sourceKind, archiveVersion: updated.archiveVersion },
});
}
});
return archived;
}
async function deliverNotifications(limit = 500) {
if (!options.notifyOriginAgent) return { notifiedAgents: 0, delivered: 0 };
const claimAt = new Date();
const staleClaimAt = new Date(claimAt.getTime() - 5 * 60_000);
await db.update(decisionArchiveNotificationOutbox).set({ status: "pending", updatedAt: claimAt })
.where(and(
eq(decisionArchiveNotificationOutbox.status, "delivering"),
or(isNull(decisionArchiveNotificationOutbox.lastAttemptAt), lte(decisionArchiveNotificationOutbox.lastAttemptAt, staleClaimAt)),
));
const rows = await db.transaction(async (tx) => {
const pendingIds = await tx.select({ id: decisionArchiveNotificationOutbox.id })
.from(decisionArchiveNotificationOutbox)
.where(eq(decisionArchiveNotificationOutbox.status, "pending"))
.orderBy(asc(decisionArchiveNotificationOutbox.createdAt), asc(decisionArchiveNotificationOutbox.id))
.limit(limit)
.then((values) => values.map((value) => value.id));
if (pendingIds.length === 0) return [];
return tx.update(decisionArchiveNotificationOutbox).set({
status: "delivering",
lastAttemptAt: claimAt,
attemptCount: sql`${decisionArchiveNotificationOutbox.attemptCount} + 1`,
updatedAt: claimAt,
}).where(and(
inArray(decisionArchiveNotificationOutbox.id, pendingIds),
eq(decisionArchiveNotificationOutbox.status, "pending"),
)).returning();
});
const groups = new Map<string, typeof rows>();
for (const row of rows) {
const key = `${row.companyId}:${row.originAgentId}`;
const grouped = groups.get(key) ?? [];
grouped.push(row);
groups.set(key, grouped);
}
let notifiedAgents = 0;
let delivered = 0;
for (const grouped of groups.values()) {
const first = grouped[0]!;
try {
await options.notifyOriginAgent({
companyId: first.companyId,
agentId: first.originAgentId,
items: grouped.map((row) => ({
sourceKind: row.sourceKind as AttentionSourceKind,
sourceId: row.sourceId,
archiveVersion: row.archiveVersion,
issueId: row.originIssueId,
})),
});
const deliveredAt = new Date();
await db.update(decisionArchiveNotificationOutbox).set({
status: "delivered",
deliveredAt,
lastAttemptAt: deliveredAt,
updatedAt: deliveredAt,
}).where(and(
inArray(decisionArchiveNotificationOutbox.id, grouped.map((row) => row.id)),
eq(decisionArchiveNotificationOutbox.status, "delivering"),
));
notifiedAgents += 1;
delivered += grouped.length;
} catch {
await db.update(decisionArchiveNotificationOutbox).set({
status: "pending",
lastAttemptAt: new Date(),
updatedAt: new Date(),
}).where(and(
inArray(decisionArchiveNotificationOutbox.id, grouped.map((row) => row.id)),
eq(decisionArchiveNotificationOutbox.status, "delivering"),
));
}
}
return { notifiedAgents, delivered };
}
return {
syncItems,
getState,
setKeep,
archive: (input: Omit<Parameters<typeof changeArchived>[0], "archived">) => changeArchived({ ...input, archived: true }),
revive: (input: Omit<Parameters<typeof changeArchived>[0], "archived">) => changeArchived({ ...input, archived: false }),
archiveReviewedManifest,
autoArchive,
deliverNotifications,
};
}