mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 18:10:39 +09:00
## Thinking Path
> - Paperclip orchestrates AI-agent companies and needs secrets handling
to work across local development, hosted operators, and governed agent
execution.
> - The affected subsystem is the company-scoped secrets control plane:
database schema, server services/routes, CLI workflows, and the Secrets
settings UI.
> - The gap was that secrets were local-only and operators could not
manage provider vaults or import existing remote references without
exposing plaintext.
> - This branch adds provider vault configuration plus an AWS Secrets
Manager remote-import path while preserving company boundaries, binding
context, and audit trails.
> - I kept the PR to a single branch PR, removed unrelated
lockfile/package drift, rebased the full branch onto the current
`public-gh/master`, and addressed fresh Greptile findings.
> - The benefit is a reviewable implementation of provider-backed
secrets with focused tests covering provider selection, import
conflicts, deleted secret reuse, rotation guards, and AWS signing
behavior.
## What Changed
- Added provider vault support for company secrets, including provider
config storage, default vault handling, health checks, binding usage,
access events, and remote import preview/commit.
- Added an AWS Secrets Manager provider using SigV4 request signing,
bounded request timeouts, namespace guardrails, cached runtime
credential resolution, and external-reference linking without plaintext
reads.
- Added Secrets UI surfaces for vault management and remote import, plus
CLI/API documentation for setup and operations.
- Stabilized routine webhook secret binding paths and SSH
environment-driver fixture bindings discovered during verification.
- Addressed Greptile and CI findings: no lockfile/package drift,
monotonic migration metadata, disabled-vault default races, soft-deleted
secret hiding/recreate behavior, remove behavior with disabled vaults,
soft-deleted external-reference re-import, non-active rotation guards,
managed-secret soft deletion through PATCH, and per-call AWS SDK
credential client churn.
- Rebased this branch onto `public-gh/master` at `0e1a5828` and
force-pushed with lease to keep this as the single PR for the branch.
## Verification
- `git fetch public-gh master`
- `git rebase public-gh/master`
- `git diff --name-only public-gh/master...HEAD | grep
'^pnpm-lock\.yaml$' || true` confirmed `pnpm-lock.yaml` is not in the PR
diff.
- Confirmed migration ordering: master ends at `0081_optimal_dormammu`;
this PR adds `0082_dry_vision` and
`0083_company_secret_provider_configs`.
- Inspected migrations for repeat safety: new tables/indexes use `IF NOT
EXISTS`; foreign keys are guarded by `DO $$ ... IF NOT EXISTS`; column
additions use `ADD COLUMN IF NOT EXISTS`.
- `pnpm -r typecheck` passed before the Greptile follow-up commits.
- `pnpm test:run` ran the full stable Vitest path before the Greptile
follow-up commits; it completed with 3 timing-related failures under
parallel load: `codex-local-execute.test.ts`,
`cursor-local-execute.test.ts`, and `environment-service.test.ts`.
- `pnpm --filter @paperclipai/server exec vitest run
src/__tests__/codex-local-execute.test.ts
src/__tests__/cursor-local-execute.test.ts
src/__tests__/environment-service.test.ts` passed on targeted rerun
(`24/24`).
- `pnpm build` passed before the Greptile follow-up commits. Vite
reported existing chunk-size/dynamic-import warnings.
- After Greptile follow-up commits: `pnpm --filter @paperclipai/server
exec vitest run src/__tests__/secrets-service.test.ts` passed (`26/26`).
- After Greptile follow-up commits: `pnpm --filter @paperclipai/server
exec vitest run src/__tests__/aws-secrets-manager-provider.test.ts
src/__tests__/secrets-service.test.ts` passed (`39/39`).
- After Greptile follow-up commits: `pnpm --filter @paperclipai/server
typecheck` passed.
- Captured Storybook screenshots from `ui/storybook-static` for visual
review.
- Latest PR checks on `5ca3a5cf`: `policy`, serialized server suites
1/4-4/4, `Canary Dry Run`, `e2e`, `security/snyk`, and `Greptile Review`
pass; aggregate `verify` is still registering the completed child
checks.
- Greptile review loop continued through the latest requested pass; all
Greptile review threads are resolved and the latest `Greptile Review`
check on `5ca3a5cf` passed with 0 comments added.
## Screenshots
Before: the provider-vault and remote-import surfaces did not exist on
`master`; these are after-state screenshots from the Storybook fixtures.



## Risks
- Migration risk: this adds new secret provider tables and extends
existing secret rows. The migrations were checked for monotonic ordering
and idempotent guards, but reviewers should still inspect upgrade
behavior carefully.
- Provider risk: AWS support uses direct SigV4 requests. Automated tests
cover signing, request timeouts, vault-config selection, namespace
guardrails, pending-version archival, sanitized provider errors, and
service-level cleanup paths. A real-vault AWS smoke test remains
deployment validation for an operator with AWS credentials rather than
an unverified merge blocker in this local branch.
- UI risk: the Secrets page and import dialog are large new surfaces;
screenshots are included above for reviewer inspection.
- Verification risk: the full local stable test command hit
parallel-load timing failures, although the exact failed files passed
when rerun directly.
- Operational risk: remote import intentionally avoids plaintext reads;
operators must understand that imported external references resolve at
runtime and may fail if AWS permissions change.
> 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 coding agent with local shell/tool use in the
Paperclip worktree. Exact context-window size was not exposed by the
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
- [ ] 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
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
239 lines
7.8 KiB
TypeScript
239 lines
7.8 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import type { ComponentProps, ReactNode } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { IssueRetryNowOutcome, IssueScheduledRetry } from "@paperclipai/shared";
|
|
import { IssueScheduledRetryCard } from "./IssueScheduledRetryCard";
|
|
import { ToastProvider } from "../context/ToastContext";
|
|
|
|
const retryNowMock = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, to, ...props }: { children: ReactNode; to: string } & ComponentProps<"a">) => (
|
|
<a href={to} {...props}>{children}</a>
|
|
),
|
|
}));
|
|
|
|
vi.mock("../api/issues", () => ({
|
|
issuesApi: {
|
|
retryScheduledRetryNow: retryNowMock,
|
|
},
|
|
}));
|
|
|
|
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
let dateNowSpy: ReturnType<typeof vi.spyOn> | null = null;
|
|
|
|
const SYSTEM_NOW = new Date("2026-04-18T20:00:00.000Z").getTime();
|
|
|
|
const baseRetry: IssueScheduledRetry = {
|
|
runId: "run-00000000",
|
|
status: "scheduled_retry",
|
|
agentId: "agent-1",
|
|
agentName: "ClaudeCoder",
|
|
retryOfRunId: "run-prev-1234567",
|
|
scheduledRetryAt: "2026-04-18T20:15:00.000Z",
|
|
scheduledRetryAttempt: 4,
|
|
scheduledRetryReason: "transient_failure",
|
|
retryExhaustedReason: null,
|
|
error: "Upstream provider rate limited",
|
|
errorCode: "rate_limited",
|
|
};
|
|
|
|
function buildRetryResponse(outcome: IssueRetryNowOutcome) {
|
|
return {
|
|
outcome,
|
|
message:
|
|
outcome === "promoted"
|
|
? "Promoted scheduled retry"
|
|
: outcome === "already_promoted"
|
|
? "Scheduled retry already promoted"
|
|
: outcome === "no_scheduled_retry"
|
|
? "No scheduled retry"
|
|
: "Promotion suppressed by gate",
|
|
scheduledRetry:
|
|
outcome === "promoted" || outcome === "already_promoted"
|
|
? { ...baseRetry, status: "queued" as const }
|
|
: null,
|
|
};
|
|
}
|
|
|
|
async function waitForUi(assertion: () => void) {
|
|
await vi.waitFor(async () => {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
});
|
|
assertion();
|
|
});
|
|
}
|
|
|
|
async function waitForRetryButtonText(expected: string) {
|
|
for (let i = 0; i < 20; i += 1) {
|
|
if ((getRetryNowButton()?.textContent ?? "").includes(expected)) return;
|
|
// eslint-disable-next-line no-await-in-loop
|
|
await act(async () => {
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
expect(getRetryNowButton()!.textContent ?? "").toContain(expected);
|
|
}
|
|
|
|
function renderWithProviders(ui: ReactNode) {
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false }, mutations: { retry: false } },
|
|
});
|
|
act(() => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<ToastProvider>{ui}</ToastProvider>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
}
|
|
|
|
beforeEach(() => {
|
|
dateNowSpy = vi.spyOn(Date, "now").mockReturnValue(SYSTEM_NOW);
|
|
retryNowMock.mockReset();
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root.unmount());
|
|
container.remove();
|
|
dateNowSpy?.mockRestore();
|
|
});
|
|
|
|
function getCard() {
|
|
return container.querySelector('[data-testid="issue-scheduled-retry-card"]');
|
|
}
|
|
|
|
function getRetryNowButton() {
|
|
return container.querySelector<HTMLButtonElement>(
|
|
'[data-testid="issue-scheduled-retry-card-retry-now"]',
|
|
);
|
|
}
|
|
|
|
describe("IssueScheduledRetryCard", () => {
|
|
it("renders nothing when there is no scheduled retry", () => {
|
|
renderWithProviders(<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={null} />);
|
|
expect(getCard()).toBeNull();
|
|
});
|
|
|
|
it("renders nothing when status is not scheduled_retry", () => {
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard
|
|
issueId="issue-1"
|
|
scheduledRetry={{ ...baseRetry, status: "queued" }}
|
|
/>,
|
|
);
|
|
expect(getCard()).toBeNull();
|
|
});
|
|
|
|
it("shows attempt count, reason, absolute and relative timestamps", () => {
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={baseRetry} />,
|
|
);
|
|
const card = getCard();
|
|
expect(card).not.toBeNull();
|
|
const text = card!.textContent ?? "";
|
|
expect(text).toContain("Retry scheduled");
|
|
expect(text).toContain("Attempt 4");
|
|
expect(text).toContain("Transient failure");
|
|
expect(text).toContain("Automatic retry in 15m");
|
|
expect(text).toContain("run-prev");
|
|
});
|
|
|
|
it("uses continuation copy for max-turn continuations", () => {
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard
|
|
issueId="issue-1"
|
|
scheduledRetry={{ ...baseRetry, scheduledRetryReason: "max_turns_continuation" }}
|
|
/>,
|
|
);
|
|
const text = getCard()?.textContent ?? "";
|
|
expect(text).toContain("Continuation scheduled");
|
|
expect(text).toContain("Automatic continuation");
|
|
expect(text).toContain("Pulls continuation forward immediately");
|
|
});
|
|
|
|
it("uses 'due now' label when scheduledRetryAt is at the current time", () => {
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard
|
|
issueId="issue-1"
|
|
scheduledRetry={{ ...baseRetry, scheduledRetryAt: "2026-04-18T20:00:10.000Z" }}
|
|
/>,
|
|
);
|
|
const text = getCard()?.textContent ?? "";
|
|
expect(text).toContain("Automatic retry due now");
|
|
});
|
|
|
|
it("invokes retry-now and shows promoted state on success", async () => {
|
|
retryNowMock.mockResolvedValue(buildRetryResponse("promoted"));
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={baseRetry} />,
|
|
);
|
|
const button = getRetryNowButton();
|
|
expect(button).not.toBeNull();
|
|
|
|
act(() => {
|
|
button!.click();
|
|
});
|
|
await waitForRetryButtonText("Promoted");
|
|
expect(retryNowMock).toHaveBeenCalledWith("issue-1");
|
|
const finalButton = getRetryNowButton();
|
|
expect(finalButton!.textContent ?? "").toContain("Promoted");
|
|
expect(finalButton!.disabled).toBe(true);
|
|
});
|
|
|
|
it("shows already promoted state when backend reports duplicate click", async () => {
|
|
retryNowMock.mockResolvedValue(buildRetryResponse("already_promoted"));
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={baseRetry} />,
|
|
);
|
|
act(() => {
|
|
getRetryNowButton()!.click();
|
|
});
|
|
await waitForRetryButtonText("Already promoted");
|
|
expect(getRetryNowButton()!.textContent ?? "").toContain("Already promoted");
|
|
expect(container.querySelector('[data-testid="issue-scheduled-retry-error-band"]')).toBeNull();
|
|
});
|
|
|
|
it("renders an inline error band on backend failure", async () => {
|
|
retryNowMock.mockRejectedValue(new Error("Server error"));
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={baseRetry} />,
|
|
);
|
|
act(() => {
|
|
getRetryNowButton()!.click();
|
|
});
|
|
await waitForUi(() => {
|
|
const band = container.querySelector('[data-testid="issue-scheduled-retry-error-band"]');
|
|
expect(band).not.toBeNull();
|
|
expect((band?.textContent ?? "")).toContain("Server error");
|
|
expect(getRetryNowButton()!.disabled).toBe(false);
|
|
});
|
|
});
|
|
|
|
it("surfaces gate-suppressed outcome via the inline error band", async () => {
|
|
retryNowMock.mockResolvedValue(buildRetryResponse("gate_suppressed"));
|
|
renderWithProviders(
|
|
<IssueScheduledRetryCard issueId="issue-1" scheduledRetry={baseRetry} />,
|
|
);
|
|
act(() => {
|
|
getRetryNowButton()!.click();
|
|
});
|
|
await waitForUi(() => {
|
|
const band = container.querySelector('[data-testid="issue-scheduled-retry-error-band"]');
|
|
expect(band).not.toBeNull();
|
|
expect((band?.textContent ?? "")).toContain("Promotion suppressed");
|
|
expect(getRetryNowButton()!.disabled).toBe(false);
|
|
});
|
|
});
|
|
});
|