mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-03 17:51:58 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Its web server also owns controller admission and user commands. > - A rolling deployment starts a replacement before the old server exits. > - Shared database state alone does not preserve local agent files, browser chunks, or in-process commands. > - This pull request adds an opt-in ephemeral server contract and a local overlap test. > - The benefit is a web server that can relinquish traffic and local files without losing acknowledged work. ## Linked Issues or Issue Description Refs #18403, #18327, #18335, #18341. **Current behavior** The control-plane web server still has local agent-file authority and local command targets. A new container can miss saved bytes or send a command to the wrong process. An existing browser tab also needs chunks from its original build. **Proposed behavior** Eligible servers share only PostgreSQL, object storage and stable secrets. A replacement waits for readiness. The old server drains admitted requests, keeps owner commands available through handoff, and releases controller leases. Explicit maintenance adopts existing files before the volume is removed. **Reason and benefit** This is the application prerequisite for rolling app-only deployments. Schema migrations and permanent multi-replica operation are outside this change. ## What Changed - Store agent-file manifests in PostgreSQL and immutable bytes in S3. Treat local roots as disposable projections. Preserve existing permission checks and edit conflicts. - Add an explicit migration, eligibility and object-retention command to the production runtime bundle. - Add `/api/ready`, admitted-request drain, browser restart signaling and retained immutable UI chunks. - Carry transaction-aware work hints across controllers during handoff and active execution. Keep listeners closed when idle. - Deliver durable Stop and runtime responses to the execution owner. Recheck request lifecycle and access before response dispatch. - Reject local-only configuration in ephemeral mode. Keep the feature disabled for existing installations by default. - Add an isolated PostgreSQL/S3/proxy/browser deployment harness with independent server homes and retained failure evidence. ## Verification - All CI checks pass on `ce17b95019d3cf1cabd357d19b6d37f96782cc5c`: workspace typecheck, build, Runner checks, server/general tests and browser shards. Greptile reviewed the runtime changes at 5/5 with all findings resolved; the final commit updates maps and the plan. - Local targeted checks passed: coordinator 27; Stop/recovery 33; PostgreSQL command delivery 6; route/workspace regressions 8; bootstrap Stop 1; restart recovery 75. PostgreSQL command tests simulate the provider edge. - Local browser proof passed 91 reads and 19 saves; reconnect took 1,013ms. The tab opened Audit from S3 after deletion of A's whole home/build. This uses compiled workspace code and local-trusted auth, not released containers or live agents. - Local workspace typecheck/build passed; current server and runtime bundle passed. The earlier broad local suite was stopped after three hours and is not a passing receipt. Its retained failures and isolated reruns are documented in the plan. - Stacked #18526 adds stricter graceful-exit proof, an unready replacement control, live Runner qualification and a Stop handoff correction. Hosted enablement remains gated on those results and Cloud #1096. No hosted stack has been enabled. ## Risks - Apply migration 0422 before enabling the feature. Existing data must pass each owner's migration and eligibility checks. Do not discard a volume based on a single migration page. - Durable manifests remain authoritative after the opt-in is disabled. Rolling back to a binary that ignores them is unsupported. - Cold directory restoration and complete shutdown timing still need qualification before enabling a hosted stack. - Retained UI assets must cover the supported browser and rollback window. Cleanup is explicit; no new idle maintenance polling is introduced. - This change does not claim production zero downtime or authorize a fleet-wide enablement. ## Model Used OpenAI Codex, GPT-6 family. The exact serving model ID and context-window limit are not exposed in this session. Used reasoning, code editing, shell execution and browser automation. ## 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: Paperclip <noreply@paperclip.ing>
167 lines
7.8 KiB
TypeScript
167 lines
7.8 KiB
TypeScript
import { signalDatabaseWork, subscribeDatabaseWork } from "@paperclipai/db/work-signals";
|
|
|
|
/** Topics for existing durable queues; register intent before their writes. */
|
|
export const DELIVERY_QUEUES = {
|
|
nativeRuntimeResponses: "native-runtime-responses",
|
|
nativeCancellation: "native-cancellation",
|
|
deploymentNotifications: "deployment-notifications",
|
|
liveInvalidations: "live-invalidations",
|
|
nativeProcessSessions: "native-process-sessions",
|
|
nativeQuestionCancellations: "native-question-cancellations",
|
|
activeExecutionRecovery: "active-execution-recovery",
|
|
settledNativeProcesses: "settled-native-processes",
|
|
orphanActiveLeases: "orphan-active-leases",
|
|
legacyShutdownSettlement: "legacy-shutdown-settlement",
|
|
strandedAgentStatus: "stranded-agent-status",
|
|
activeRunSilence: "active-run-silence",
|
|
deferredExecutionReceipts: "deferred-execution-receipts",
|
|
taskRetryReceiptSettlement: "task-retry-receipt-settlement",
|
|
nativeStatusWakeIntents: "native-status-wake-intents",
|
|
orphanBlockers: "orphan-blockers",
|
|
activeRecoveryActions: "active-recovery-actions",
|
|
strandedAssignments: "stranded-assignments",
|
|
resolvedDependencies: "resolved-dependencies",
|
|
taskWatchdogs: "task-watchdogs",
|
|
staleIssueLocks: "stale-issue-locks",
|
|
scheduledRetryDispatch: "scheduled-retry-dispatch",
|
|
queuedRunDispatch: "queued-run-dispatch",
|
|
statusCardEvaluation: "status-card-evaluation",
|
|
runEvidenceMigration: "run-evidence-migration",
|
|
providerTraceRetention: "provider-trace-retention",
|
|
nativeRunnerEvidenceRetention: "native-runner-evidence-retention",
|
|
skillVersionRetention: "skill-version-retention",
|
|
externalObjectRefresh: "external-object-refresh",
|
|
databaseBackups: "database-backups",
|
|
importSpoolCleanup: "import-spool-cleanup",
|
|
externalConversationSettlement: "external-conversation-settlement",
|
|
nativeRecoveryNotices: "native-recovery-notices",
|
|
nativeEnvironmentSettlement: "native-environment-settlement",
|
|
nativeRunProjection: "native-run-projection",
|
|
nativeResultCommit: "native-result-commit",
|
|
nativeWorkspaceFinalization: "native-workspace-finalization",
|
|
retainedNativeSessionCleanup: "retained-native-session-cleanup",
|
|
nativeStatusReassessment: "native-status-reassessment",
|
|
nativeReviewResponse: "native-review-response",
|
|
nativeResponsePresentation: "native-response-presentation",
|
|
nativePendingEffects: "native-pending-effects",
|
|
unsafeWorkspaceExportRecovery: "unsafe-workspace-export-recovery",
|
|
automaticCompletionReviews: "automatic-completion-reviews",
|
|
obsoletePolicyReviews: "obsolete-policy-reviews",
|
|
cancelledWorkspacePreservation: "cancelled-workspace-preservation",
|
|
instructionCollection: "instruction-collection",
|
|
directoryCleanup: "directory-cleanup",
|
|
instructionCommit: "instruction-commit",
|
|
scheduledRetryCancellation: "scheduled-retry-cancellation",
|
|
executionFinalization: "execution-finalization",
|
|
workspaceRecovery: "workspace-recovery",
|
|
executionReplacement: "execution-replacement",
|
|
executionContinuation: "execution-continuation",
|
|
executionStatus: "execution-status",
|
|
executionDisposition: "execution-disposition",
|
|
environmentCleanup: "environment-cleanup",
|
|
approvalQueueSeeding: "approval-queue-seeding",
|
|
attentionRetention: "attention-retention",
|
|
approvalRetention: "approval-retention",
|
|
joinRequestRetention: "join-request-retention",
|
|
decisionTargets: "decision-targets",
|
|
decisionEffectRecovery: "decision-effect-recovery",
|
|
decisionExpiry: "decision-expiry",
|
|
decisionContinuation: "decision-continuation",
|
|
|
|
decisionArchiveDelivery: "decision-archive-delivery",
|
|
toolConnectionHealth: "tool-connection-health",
|
|
toolReviewProjection: "tool-review-projection",
|
|
toolReviewInterruption: "tool-review-interruption",
|
|
toolReviewRecovery: "tool-review-recovery",
|
|
toolReviewExpiry: "tool-review-expiry",
|
|
gatewayCredentialExpiry: "gateway-credential-expiry",
|
|
secretProposalExpiry: "secret-proposal-expiry",
|
|
customImageExpiry: "custom-image-expiry",
|
|
historicalCleanup: "historical-cleanup",
|
|
adapterLoginCleanup: "adapter-login-cleanup",
|
|
setupTokenCleanup: "setup-token-cleanup",
|
|
localLoginCleanup: "local-login-cleanup",
|
|
budgetEnforcement: "budget-enforcement",
|
|
accounting: "cost-accounting",
|
|
taskDrainExpiry: "task-drain-expiry",
|
|
agentLifecycle: "agent-lifecycle",
|
|
chatBoardMessages: "chat-board-messages",
|
|
chatTaskStarts: "chat-task-starts",
|
|
chatReceiptReactions: "chat-receipt-reactions",
|
|
chatSessionStops: "chat-session-stops",
|
|
chatProviderEffects: "chat-provider-effects",
|
|
chatGitHubWebhookRecovery: "chat-github-webhook-recovery",
|
|
chatGitHubIngress: "chat-github-ingress",
|
|
chatGitHubPublications: "chat-github-publications",
|
|
chatGitHubReviewProjection: "chat-github-review-projection",
|
|
chatGitHubReviewChecks: "chat-github-review-checks",
|
|
chatGitHubTerminalResponses: "chat-github-terminal-responses",
|
|
chatGitHubAcknowledgements: "chat-github-acknowledgements",
|
|
chatFailedRunRetries: "chat-failed-run-retries",
|
|
chatTelegramMaintenance: "chat-telegram-maintenance",
|
|
chatReceivers: "chat-receivers",
|
|
voiceSessionRecovery: "voice-session-recovery",
|
|
voiceReports: "voice-call-reports",
|
|
voiceInboundRetention: "voice-inbound-retention",
|
|
voiceInboundCleanup: "voice-inbound-cleanup",
|
|
voiceReplies: "voice-reply-delivery",
|
|
chatTeamsConsentExpiry: "chat-teams-consent-expiry",
|
|
chatTeamsAttemptRecovery: "chat-teams-attempt-recovery",
|
|
chatCommandRegistration: "chat-command-registration",
|
|
chatTelegramSubscriptions: "chat-telegram-subscriptions",
|
|
chatSessionSyncs: "chat-session-syncs",
|
|
chatVerification: "chat-verification",
|
|
chatInbound: "chat-inbound",
|
|
chatPublications: "chat-publications",
|
|
chatNativeProgress: "chat-native-progress",
|
|
chatInboundWakeNotices: "chat-inbound-wake-notices",
|
|
chatInteractionContinuations: "chat-interaction-continuations",
|
|
chatTerminalConfirmations: "chat-terminal-confirmations",
|
|
chatFailedRetryNotices: "chat-failed-retry-notices",
|
|
chatRunMilestones: "chat-run-milestones",
|
|
chatReceipts: "chat-slack-receipts",
|
|
browser: "browser-use",
|
|
email: "email-channels",
|
|
museMaintenance: "muse-maintenance",
|
|
mergedPullRequestConfirmations: "merged-pull-request-confirmations",
|
|
mcpEvents: "mcp-events",
|
|
dotEvents: "dot-events",
|
|
grokDispatch: "grok-dispatch",
|
|
skillSourceSync: "skill-source-sync",
|
|
skillPackages: "skill-packages",
|
|
runtimeAssetRetention: "runtime-asset-retention",
|
|
fastResponse: "fast-responses",
|
|
feedback: "feedback-exports",
|
|
chatCompletion: "chat-completions",
|
|
connection: "connection-continuations",
|
|
connectionEvents: "connection-events",
|
|
connectionContinuity: "connection-continuity",
|
|
gitRestorePoints: "git-restore-points",
|
|
remoteWorkspaceSnapshots: "remote-workspace-snapshots",
|
|
nativeWorkspaceSyncRetention: "native-workspace-sync-retention",
|
|
question: "question-responses",
|
|
pluginSchedules: "plugin-schedules",
|
|
pluginLifecycle: "plugin-resource-lifecycle",
|
|
toolAction: "tool-action-receipts",
|
|
terminalWorkspaces: "terminal-workspaces",
|
|
routineExecutionStatus: "routine-execution-status",
|
|
routineSchedules: "routine-schedules",
|
|
issueMonitors: "issue-monitors",
|
|
agentTimers: "agent-timers",
|
|
caseHandoffs: "case-handoffs",
|
|
nativeHarnessBackupExpiration: "native-harness-backup-expiration",
|
|
nativeCheckpointExpiration: "native-checkpoint-expiration",
|
|
} as const;
|
|
export type DeliveryQueue = typeof DELIVERY_QUEUES[keyof typeof DELIVERY_QUEUES];
|
|
|
|
export async function notifyDeliveryWork(transaction: object, queue: DeliveryQueue, hint?: string): Promise<void> {
|
|
await signalDatabaseWork(transaction, queue, hint);
|
|
}
|
|
// Public delivery notification observers only see settled work. The coordinator
|
|
// uses the lower-level lifecycle subscription to also fence in-flight writes.
|
|
export function subscribeDeliveryWork(owner: object, queue: DeliveryQueue, wake: () => void): () => void {
|
|
return subscribeDatabaseWork(owner, queue, event => {
|
|
if (event === "settled") wake();
|
|
});
|
|
}
|