mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-09 16:02:36 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - A managed instance gets its instance-level environments from the `PAPERCLIP_MANAGED_CONFIG` document, and #19508 added plugin environment entries to it > - Greptile's Apex review of #19508 arrived after it merged, with three findings > - A credential inside an array nested in an array passed the secret check and the response redaction > - Recovery of an archived environment listened on one worker handle, which a restart replaces, and its attempts were not tracked through idle checks and shutdown > - This pull request closes all three findings > - The benefit is that credentials never pass the check, an environment comes back after any worker restart, and shutdown never cuts off a recovery write ## Linked Issues or Issue Description Refs #19508 (the Apex findings this pull request fixes) **Subsystem affected** Server environments: the managed-config parser, the environment routes' response floor, the managed environment bootstrap, and the plugin worker manager. **Problem or motivation** Greptile's Apex review of #19508 found three problems. (1) `findSecretLikeConfigKey` and `redactSecretLikeConfigKeys` skip array elements that are arrays, so `{"groups":[[{"apiToken":"..."}]]}` passes the boot check and is echoed to restricted readers. (2) Recovery subscribes to `ready` on one worker handle. A restart such as a settings save replaces that handle, so the new worker's `ready` never reaches the listener, and the environment stays archived. (3) A recovery attempt is fire-and-forget. The worker manager's work token ends when the worker replies, but the database write continues, so an idle check or the database shutdown can overlap it. **Proposed solution** Walk arrays at any depth in both functions. Add a manager-wide `onWorkerReady` subscription and use it for recovery. Run every recovery attempt through a controller that tracks it as idle work and that shutdown stops and awaits before the database closes. **Alternatives considered** Re-subscribing on each new handle after a restart. That needs a hook in every restart path. The manager-wide subscription covers all of them in one place. **Roadmap alignment** This only fixes code that #19508 added or touched. It adds no product surface. ## What Changed - `server/src/services/managed-config.ts`: `findSecretLikeConfigKey` walks arrays at any depth (new `findSecretLikeConfigKeyInValue`). This covers sandbox `config` and plugin `driverConfig`. - `server/src/routes/environments.ts`: `redactSecretLikeConfigKeys` walks arrays at any depth (new `redactSecretLikeConfigValue`). - `server/src/services/plugin-worker-manager.ts`: new optional `onWorkerReady(listener)` on `PluginWorkerManager`. It fires on every worker `ready`, including a replacement handle from a restart. A listener error is logged and does not affect the worker. - `server/src/services/managed-environments.ts`: - Sandbox and plugin recovery subscribe through `subscribeWorkerReady`. It prefers `onWorkerReady` and falls back to the handle when the manager has no such method. - New `createManagedEnvironmentRecovery()` controller. Each attempt runs inside `trackIdleWork` for its whole duration. `stop()` removes every `ready` subscription, refuses new attempts, and awaits unfinished ones. - `server/src/index.ts`: creates the controller, passes it to `applyManagedEnvironments`, and awaits `stop()` during shutdown, after the delivery workers stop and before the application teardown and database close. ## Verification - `cd server && npx vitest run src/__tests__/managed-config.test.ts`: a secret-like key in an array nested in an array refuses boot, for plugin `driverConfig` and sandbox `config`. - `npx vitest run src/__tests__/environment-routes.test.ts`: a nested-array credential is removed from the response, and other nested values stay. - `npx vitest run src/services/managed-environments-plugin-entries.test.ts`: - With `onWorkerReady`, recovery never consults the handle. It ignores another plugin's `ready`, re-ensures on this plugin's `ready`, and then unsubscribes. - An attempt counts in `idleWorkSnapshot()` until its ensure settles. `stop()` unsubscribes, waits for the unfinished attempt, and later `ready` events start nothing. - `npx vitest run src/services/managed-environments.test.ts src/__tests__/managed-plugin-environments.test.ts`: pass. - `pnpm --filter @paperclipai/server typecheck` passes. - I did not run the full `pnpm test:run`, `pnpm -r typecheck` or `pnpm build`. CI covers them. ## Risks - The redaction now also walks nested arrays in sandbox config responses. Only credential-shaped keys are removed; other values are unchanged. - The boot check now refuses a document that hides a secret-like key in a nested array. A valid document has no such key. - `onWorkerReady` is optional, so other `PluginWorkerManager` implementations and test fakes keep working. - Shutdown now waits for an unfinished recovery attempt. An attempt is one worker call plus one short transaction. > 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 - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, through Claude Code with tool use (file edits, shell, test runs). ## 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
222 lines
9.1 KiB
TypeScript
222 lines
9.1 KiB
TypeScript
export { companyService } from "./companies.js";
|
|
export { companyArtifactsService } from "./company-artifacts.js";
|
|
export { companySearchService } from "./company-search.js";
|
|
export { companySearchExtractService } from "./company-search-extract.js";
|
|
export { feedbackService } from "./feedback.js";
|
|
export { companySkillService } from "./company-skills.js";
|
|
export { companySkillPolicyService, normalizeSkillPolicySourceType } from "./company-skill-policy.js";
|
|
export { folderService } from "./folders.js";
|
|
export { agentService, deduplicateAgentName } from "./agents.js";
|
|
export {
|
|
builtInAgentService,
|
|
deriveBuiltInAgentStatus,
|
|
getBuiltInAgentDefinition,
|
|
listBuiltInAgentDefinitions,
|
|
reconcileBuiltInAgentsOnStartup,
|
|
validateBuiltInAgentDefinitions,
|
|
type BuiltInAgentDefinition,
|
|
type BuiltInManagedResourceState,
|
|
type BuiltInManagedResourceStockStatus,
|
|
type BuiltInAgentState,
|
|
type BuiltInAgentStatus,
|
|
} from "./built-in-agents.js";
|
|
export { agentInstructionsService, syncInstructionsBundleConfigFromFilePath } from "./agent-instructions.js";
|
|
export { assetService } from "./assets.js";
|
|
export { documentService, extractLegacyPlanBody } from "./documents.js";
|
|
export { artifactReviewDocumentService } from "./artifact-review-documents.js";
|
|
export { statusCardService } from "./status-cards.js";
|
|
export { finalizeStatusCardsForStalledGeneration } from "./status-card-finalization.js";
|
|
export { documentAnnotationService } from "./document-annotations.js";
|
|
export {
|
|
ISSUE_CONTINUATION_SUMMARY_DOCUMENT_KEY,
|
|
buildContinuationSummaryMarkdown,
|
|
getIssueContinuationSummaryDocument,
|
|
refreshIssueContinuationSummary,
|
|
} from "./issue-continuation-summary.js";
|
|
export { projectService } from "./projects.js";
|
|
export {
|
|
clampIssueListLimit,
|
|
ISSUE_LIST_DEFAULT_LIMIT,
|
|
ISSUE_LIST_MAX_LIMIT,
|
|
issueService,
|
|
type IssueFilters,
|
|
} from "./issues.js";
|
|
export { issueThreadInteractionService } from "./issue-thread-interactions.js";
|
|
export { githubConnectionEventService, type GitHubConnectionEventPollResult } from "./github-connection-events.js";
|
|
export {
|
|
assertIssueReviewVerdictActorAllowed,
|
|
type IssueReviewVerdictActor,
|
|
} from "./issue-review-policy.js";
|
|
export { issueTreeControlService } from "./issue-tree-control.js";
|
|
export { issueApprovalService } from "./issue-approvals.js";
|
|
export { issueReferenceService } from "./issue-references.js";
|
|
export { issueRecoveryActionService } from "./issue-recovery-actions.js";
|
|
export {
|
|
stalledReviewDecisionService,
|
|
type DecideStalledReviewInput,
|
|
type StalledReviewDecisionActor,
|
|
} from "./stalled-review-decisions.js";
|
|
export { taskWatchdogService } from "./task-watchdogs.js";
|
|
export {
|
|
issueIsInTaskWatchdogSubtree,
|
|
resolveTaskWatchdogMutationScope,
|
|
taskWatchdogScopeAllowsIssueMutation,
|
|
} from "./task-watchdog-scope.js";
|
|
export {
|
|
createExternalObjectDetectorRegistry,
|
|
createExternalObjectResolverRegistry,
|
|
externalObjectService,
|
|
type ExternalObjectDetector,
|
|
type ExternalObjectResolver,
|
|
type ExternalObjectResolveResult,
|
|
type ExternalObjectResolverSnapshot,
|
|
} from "./external-objects.js";
|
|
export { goalService } from "./goals.js";
|
|
export { activityService, type ActivityFilters } from "./activity.js";
|
|
export { workTimelineService, normalizeTimelineWindow } from "./work-timeline.js";
|
|
export { attentionService } from "./attention.js";
|
|
export { captureDecisionSnapshot, decisionTrainingService } from "./decision-training.js";
|
|
export { decisionService } from "./decisions.js";
|
|
export { decisionRetentionService } from "./decision-retention.js";
|
|
export type {
|
|
WorkTimelineActor,
|
|
WorkTimelineEdge,
|
|
WorkTimelineEvent,
|
|
WorkTimelineQuery,
|
|
WorkTimelineResult,
|
|
WorkTimelineSpan,
|
|
} from "./work-timeline.js";
|
|
export { approvalService } from "./approvals.js";
|
|
export { budgetService } from "./budgets.js";
|
|
export { secretService } from "./secrets.js";
|
|
export { createRunSecretRedactionRegistry } from "./run-secret-redaction.js";
|
|
export { createSecretProposalsService } from "./secret-proposals.js";
|
|
export { googleSheetsRobotEmailFromEnv, toolAccessService } from "./tool-access.js";
|
|
export {
|
|
createVercelConnectClient,
|
|
vercelConnectIntegrationStatus,
|
|
VercelConnectClientError,
|
|
type VercelConnectClient,
|
|
} from "./vercel-connect.js";
|
|
export { smokeLabService } from "./smoke-lab.js";
|
|
export { backfillLegacyToolOAuthTokens } from "./tool-oauth-legacy-backfill.js";
|
|
export { toolAccessPolicyService } from "./tool-access-policy.js";
|
|
export { routineService } from "./routines.js";
|
|
export { costService } from "./costs.js";
|
|
export { financeService } from "./finance.js";
|
|
export { heartbeatService, resolveHeartbeatSchedulingSuppression } from "./heartbeat.js";
|
|
export {
|
|
runnerGoalService,
|
|
applyRunnerGoalPrpEvent,
|
|
blockRunnerGoalRecovery,
|
|
failRunnerGoalAction,
|
|
RunnerGoalActionError,
|
|
RunnerGoalConflictError,
|
|
} from "./runner-goals.js";
|
|
export { classifyIssueGraphLiveness, type IssueLivenessFinding } from "./recovery/index.js";
|
|
export { dashboardService } from "./dashboard.js";
|
|
export { sidebarBadgeService } from "./sidebar-badges.js";
|
|
export { sidebarPreferenceService } from "./sidebar-preferences.js";
|
|
export { resourceMembershipService, type ResourceMembershipPolicyHook } from "./resource-memberships.js";
|
|
export { inboxDismissalService } from "./inbox-dismissals.js";
|
|
export { accessService } from "./access.js";
|
|
export {
|
|
backfillPrincipalAccessCompatibility,
|
|
ensureHumanRoleDefaultGrants,
|
|
insertMissingPrincipalGrants,
|
|
type PrincipalAccessCompatibilityBackfillStats,
|
|
} from "./principal-access-compatibility.js";
|
|
export { authorizationService } from "./authorization.js";
|
|
export { inboxAgentPolicyService } from "./inbox-agent-policy.js";
|
|
export type {
|
|
AuthorizationAction,
|
|
AuthorizationActor,
|
|
AuthorizationDecision,
|
|
AuthorizationResource,
|
|
} from "./authorization.js";
|
|
export { boardAuthService } from "./board-auth.js";
|
|
export { instanceSettingsService, applyManagedExperimentalOverlay } from "./instance-settings.js";
|
|
export {
|
|
getManagedInstanceConfig,
|
|
managedFeatureKeySet,
|
|
parseManagedConfigEnv,
|
|
MANAGED_CONFIG_ENV_KEY,
|
|
type ManagedEnvironmentSpec,
|
|
type ManagedInstanceConfig,
|
|
} from "./managed-config.js";
|
|
export { bootstrapExecutionPolicyFromEnv } from "./execution-policy-bootstrap.js";
|
|
export { applyManagedEnvironments, createManagedEnvironmentRecovery } from "./managed-environments.js";
|
|
export { buildExportFidelityReport, collectExportFidelityCounts } from "./export-fidelity.js";
|
|
export { companyPortabilityService } from "./company-portability.js";
|
|
export { teamsCatalogService } from "./teams-catalog.js";
|
|
export { environmentService } from "./environments.js";
|
|
export {
|
|
applyCustomImageTemplateToSandboxConfig,
|
|
fingerprintEnvironmentSandboxProviderConfig,
|
|
} from "./environment-custom-image-runtime.js";
|
|
export {
|
|
environmentCustomImageService,
|
|
} from "./environment-custom-images.js";
|
|
export {
|
|
environmentCustomImageTerminalConnectionRegistry,
|
|
environmentCustomImageTerminalSessionStore,
|
|
EnvironmentCustomImageTerminalConnectionRegistry,
|
|
EnvironmentCustomImageTerminalSessionStore,
|
|
parseCustomImageSetupSshCommand,
|
|
type EnvironmentCustomImageTerminalConnectionClose,
|
|
type EnvironmentCustomImageTerminalSessionRecord,
|
|
type MintedEnvironmentCustomImageTerminalSession,
|
|
type ParsedCustomImageSetupSshCommand,
|
|
} from "./environment-custom-image-terminal-sessions.js";
|
|
export { executionWorkspaceService } from "./execution-workspaces.js";
|
|
export { workspaceOperationService } from "./workspace-operations.js";
|
|
export {
|
|
workspaceRuntimeLeaseService,
|
|
buildWorkspaceRuntimeLeaseOwnerKey,
|
|
LEASED_WORKSPACE_RUNTIME_ACTIONS,
|
|
WORKSPACE_RUNTIME_ELIGIBLE_ISSUE_STATUSES,
|
|
WORKSPACE_RUNTIME_LEASE_TTL_MS,
|
|
type WorkspaceRuntimeLeaseClaim,
|
|
type WorkspaceRuntimeLeaseOwner,
|
|
type WorkspaceRuntimeLeaseService,
|
|
} from "./workspace-runtime-leases.js";
|
|
export { workspaceFileResourceService } from "./workspace-file-resources.js";
|
|
export {
|
|
createWorkspaceGitOperationScheduler,
|
|
getWorkspaceGitOperationSchedulerSnapshot,
|
|
workspaceGitOperationScheduler,
|
|
type WorkspaceGitSchedulerSnapshot,
|
|
} from "./workspace-git-operation-scheduler.js";
|
|
export {
|
|
enrichWorkProductMetadataWithDiff,
|
|
workProductService,
|
|
} from "./work-products.js";
|
|
export {
|
|
logActivity,
|
|
persistActivity,
|
|
publishActivity,
|
|
type ActivityPublication,
|
|
type LogActivityInput,
|
|
} from "./activity-log.js";
|
|
export { summarySlotService, SUMMARIZER_BUILT_IN_KEY } from "./summary-slots.js";
|
|
export { notifyHireApproved, type NotifyHireApprovedInput } from "./hire-hook.js";
|
|
export { publishLiveEvent, subscribeCompanyLiveEvents } from "./live-events.js";
|
|
export {
|
|
reconcileCodexLocalManagedHomesOnStartup,
|
|
type CodexAuthReconciliationSummary,
|
|
} from "./codex-auth-reconciliation.js";
|
|
export { reconcilePersistedRuntimeServicesOnStartup, restartDesiredRuntimeServicesOnStartup } from "./workspace-runtime.js";
|
|
export { createStorageServiceFromConfig, getStorageService } from "../storage/index.js";
|
|
export {
|
|
managedAgentProfileService,
|
|
CLAUDE_MANAGED_BETA_VERSION,
|
|
type ManagedAgentProfileInput,
|
|
} from "./managed-agent-profiles.js";
|
|
export {
|
|
remoteAgentProfileService,
|
|
type RemoteAgentProfileInput,
|
|
type RemoteAgentService,
|
|
} from "./remote-agent-profiles.js";
|
|
|
|
export { decisionModelService, defineDecisionFeature } from "./decision-models.js";
|