@app-vitals/agent-admin 0.0.1 → 0.1.1

package/src/agent-deletion.integration.test.ts

@@ -0,0 +1,323 @@
+/**
+ * admin/src/agent-deletion.integration.test.ts
+ * Integration tests for deleteAgentFully() against a real PostgreSQL DB.
+ *
+ * Unlike agent-deletion.unit.test.ts (fully-mocked Prisma double), this suite
+ * passes a REAL PrismaClient for the DB-touching parts of the orchestration —
+ * proving the Agent row and every child row actually cascade-delete together
+ * (or don't, on failure) against the real schema's `onDelete: Cascade` FKs.
+ * The non-DB dependencies (provisioner/taskStore/chatService/slack/decrypt)
+ * are hand-written no-op stubs — they are not the thing under test here.
+ *
+ * Requires DATABASE_URL_ADMIN_TEST to be set; skips otherwise.
+ */
+
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
+import type { PrismaClient } from "../prisma/client/client.ts";
+import {
+  type DeleteAgentFullyDeps,
+  deleteAgentFully,
+} from "./agent-deletion.ts";
+import { createAdminPrismaClient } from "./prisma-client.ts";
+
+const TEST_DB = process.env.DATABASE_URL_ADMIN_TEST;
+
+const describeOrSkip = TEST_DB ? describe : describe.skip;
+
+function makePrisma(): PrismaClient {
+  // TEST_DB is guaranteed set — the describe block is skipped otherwise.
+  return createAdminPrismaClient(TEST_DB as string);
+}
+
+async function createAgent(
+  prisma: PrismaClient,
+  name = "Test Agent",
+): Promise<string> {
+  const agent = await prisma.agent.create({ data: { name } });
+  return agent.id;
+}
+
+/**
+ * Populate one row in every child model that carries (directly or
+ * transitively) an agentId FK, so a single "full-fixture" agent exercises the
+ * entire cascade — including the two-hop Agent → AgentCronJob → AgentCronRun
+ * path.
+ */
+async function seedFullFixture(
+  prisma: PrismaClient,
+  agentId: string,
+): Promise<void> {
+  await prisma.agentEnv.create({
+    data: { agentId, key: "GH_TOKEN", value: "encrypted-value", secret: true },
+  });
+  await prisma.agentToken.create({
+    data: { agentId, token: "a".repeat(64), label: "CI Token" },
+  });
+  const cronJob = await prisma.agentCronJob.create({
+    data: {
+      agentId,
+      schedule: "0 9 * * *",
+      prompt: "Good morning",
+      channel: "C123456",
+    },
+  });
+  await prisma.agentCronRun.create({
+    data: {
+      cronId: cronJob.id,
+      agentId,
+      startedAt: new Date(),
+      completedAt: new Date(),
+      skipped: false,
+      outcome: "success",
+    },
+  });
+  await prisma.agentTool.create({
+    data: { agentId, pattern: "Read" },
+  });
+  await prisma.agentPlugin.create({
+    data: { agentId, name: "@shipwright/plugin" },
+  });
+  await prisma.agentMember.create({
+    data: { agentId, email: "member@example.com" },
+  });
+  await prisma.agentChatTokenUsageDailyByModel.create({
+    data: {
+      agentId,
+      date: "2026-07-14",
+      model: "claude-sonnet-4-5",
+      inputTokens: 100,
+      outputTokens: 50,
+    },
+  });
+}
+
+interface FixtureCounts {
+  agent: number;
+  agentEnv: number;
+  agentToken: number;
+  agentCronJob: number;
+  agentCronRun: number;
+  agentTool: number;
+  agentPlugin: number;
+  agentMember: number;
+  agentChatTokenUsageDailyByModel: number;
+}
+
+async function countFixtureRows(
+  prisma: PrismaClient,
+  agentId: string,
+): Promise<FixtureCounts> {
+  const where = { where: { agentId } };
+  return {
+    agent: (await prisma.agent.findUnique({ where: { id: agentId } })) ? 1 : 0,
+    agentEnv: await prisma.agentEnv.count(where),
+    agentToken: await prisma.agentToken.count(where),
+    agentCronJob: await prisma.agentCronJob.count(where),
+    agentCronRun: await prisma.agentCronRun.count(where),
+    agentTool: await prisma.agentTool.count(where),
+    agentPlugin: await prisma.agentPlugin.count(where),
+    agentMember: await prisma.agentMember.count(where),
+    agentChatTokenUsageDailyByModel:
+      await prisma.agentChatTokenUsageDailyByModel.count(where),
+  };
+}
+
+const ALL_ZERO: FixtureCounts = {
+  agent: 0,
+  agentEnv: 0,
+  agentToken: 0,
+  agentCronJob: 0,
+  agentCronRun: 0,
+  agentTool: 0,
+  agentPlugin: 0,
+  agentMember: 0,
+  agentChatTokenUsageDailyByModel: 0,
+};
+
+const ALL_ONE: FixtureCounts = {
+  agent: 1,
+  agentEnv: 1,
+  agentToken: 1,
+  agentCronJob: 1,
+  agentCronRun: 1,
+  agentTool: 1,
+  agentPlugin: 1,
+  agentMember: 1,
+  agentChatTokenUsageDailyByModel: 1,
+};
+
+/** Hand-written no-op stub deps — everything succeeds. Not the thing under test. */
+function makeSucceedingDeps(prisma: PrismaClient): DeleteAgentFullyDeps {
+  return {
+    prisma,
+    provisioner: {
+      deprovision: async () => {
+        // no-op: real k8s deprovision is out of scope for this DB-cascade test
+      },
+    },
+    serviceIntegrations: [
+      {
+        name: "task-store",
+        listTokensForAgent: async () => [],
+        revokeToken: async () => {
+          // no-op
+        },
+      },
+    ],
+    chatService: {
+      listTokensForAgent: async () => [],
+      revokeToken: async () => {
+        // no-op
+      },
+      deleteThreadsForAgent: async () => ({ deleted: 0 }),
+    },
+    slack: {
+      deleteApp: async () => {
+        // no-op
+      },
+    },
+    decrypt: (value) => value,
+  };
+}
+
+describeOrSkip("deleteAgentFully (integration)", () => {
+  let prisma: PrismaClient;
+
+  beforeEach(async () => {
+    prisma = makePrisma();
+    // FK-safe order: children before parents.
+    await prisma.agentCronRun.deleteMany();
+    await prisma.agentCronJob.deleteMany();
+    await prisma.agentToken.deleteMany();
+    await prisma.agentTool.deleteMany();
+    await prisma.agentPlugin.deleteMany();
+    await prisma.agentMember.deleteMany();
+    await prisma.agentChatTokenUsageDailyByModel.deleteMany();
+    await prisma.agentEnv.deleteMany();
+    await prisma.agent.deleteMany();
+  });
+
+  afterEach(async () => {
+    await prisma.$disconnect();
+  });
+
+  it("deletes the Agent row and cascades every child row on full success", async () => {
+    const agentId = await createAgent(prisma);
+    await seedFullFixture(prisma, agentId);
+
+    // Sanity: the fixture is fully seeded before we call the function under test.
+    expect(await countFixtureRows(prisma, agentId)).toEqual(ALL_ONE);
+
+    const deps = makeSucceedingDeps(prisma);
+    const result = await deleteAgentFully(agentId, deps, {
+      xoxpToken: "xoxp-user",
+    });
+
+    expect(result.agentDeleted).toBe(true);
+    expect(result.failed).toEqual([]);
+
+    // Every row for this agentId — including the transitively-cascaded
+    // AgentCronRun via AgentCronJob — must now be gone.
+    expect(await countFixtureRows(prisma, agentId)).toEqual(ALL_ZERO);
+  });
+
+  it("does not delete the Agent row (or cascade anything) if an automatable step fails", async () => {
+    const agentId = await createAgent(prisma);
+    await seedFullFixture(prisma, agentId);
+
+    expect(await countFixtureRows(prisma, agentId)).toEqual(ALL_ONE);
+
+    const deps = makeSucceedingDeps(prisma);
+    deps.provisioner = {
+      deprovision: async () => {
+        throw new Error("k8s deprovision failed");
+      },
+    };
+
+    const result = await deleteAgentFully(agentId, deps, {
+      xoxpToken: "xoxp-user",
+    });
+
+    expect(result.agentDeleted).toBe(false);
+    expect(result.failed).toEqual([
+      { step: "k8s", error: "k8s deprovision failed" },
+    ]);
+
+    // Nothing was cascaded: the Agent row is deliberately left in place, and
+    // so is every child row — proving the row-deleted-last rollback-safety
+    // guarantee holds against a real DB, not just the in-memory unit double.
+    expect(await countFixtureRows(prisma, agentId)).toEqual(ALL_ONE);
+  });
+
+  it("cascades AgentCronRun via its parent AgentCronJob on success, but leaves it intact on failure", async () => {
+    // Targeted check on the trickiest FK path — the two-hop
+    // Agent -> AgentCronJob -> AgentCronRun cascade — in isolation from the
+    // rest of the fixture.
+    const successAgentId = await createAgent(prisma, "Cascade Success Agent");
+    const successCron = await prisma.agentCronJob.create({
+      data: {
+        agentId: successAgentId,
+        schedule: "0 9 * * *",
+        prompt: "Good morning",
+        channel: "C1",
+      },
+    });
+    const successRun = await prisma.agentCronRun.create({
+      data: {
+        cronId: successCron.id,
+        agentId: successAgentId,
+        startedAt: new Date(),
+        completedAt: new Date(),
+        skipped: false,
+        outcome: "success",
+      },
+    });
+
+    const successResult = await deleteAgentFully(
+      successAgentId,
+      makeSucceedingDeps(prisma),
+    );
+    expect(successResult.agentDeleted).toBe(true);
+    expect(
+      await prisma.agentCronRun.findUnique({ where: { id: successRun.id } }),
+    ).toBeNull();
+    expect(
+      await prisma.agentCronJob.findUnique({ where: { id: successCron.id } }),
+    ).toBeNull();
+
+    const failAgentId = await createAgent(prisma, "Cascade Failure Agent");
+    const failCron = await prisma.agentCronJob.create({
+      data: {
+        agentId: failAgentId,
+        schedule: "0 9 * * *",
+        prompt: "Good morning",
+        channel: "C1",
+      },
+    });
+    const failRun = await prisma.agentCronRun.create({
+      data: {
+        cronId: failCron.id,
+        agentId: failAgentId,
+        startedAt: new Date(),
+        completedAt: new Date(),
+        skipped: false,
+        outcome: "success",
+      },
+    });
+
+    const deps = makeSucceedingDeps(prisma);
+    deps.provisioner = {
+      deprovision: async () => {
+        throw new Error("k8s deprovision failed");
+      },
+    };
+    const failResult = await deleteAgentFully(failAgentId, deps);
+    expect(failResult.agentDeleted).toBe(false);
+    expect(
+      await prisma.agentCronRun.findUnique({ where: { id: failRun.id } }),
+    ).not.toBeNull();
+    expect(
+      await prisma.agentCronJob.findUnique({ where: { id: failCron.id } }),
+    ).not.toBeNull();
+  });
+});

package/src/agent-deletion.ts

@@ -0,0 +1,329 @@
+/**
+ * admin/src/agent-deletion.ts
+ *
+ * `deleteAgentFully()` — the single shared orchestration both agent-delete entry
+ * points (DELETE /agents/:id and the admin-ui "danger zone") are wired into.
+ * Previously each caller independently ran
+ * `provisioner.deprovision()` + `prisma.agent.delete()` with no shared cleanup,
+ * so any fix to one drifted from the other. This module centralizes the full
+ * teardown so there is one place to fix.
+ *
+ * ── Critical ordering ──────────────────────────────────────────────────────
+ * The Agent DB row is deleted LAST, and only once every automatable cleanup
+ * step has succeeded. This makes the whole operation IDEMPOTENT and RETRYABLE:
+ * a caller can re-invoke `deleteAgentFully` after a partial failure and it only
+ * re-attempts what didn't finish, because every underlying step is itself
+ * individually idempotent:
+ *   - K8s deprovision swallows 404 (agent-provisioner.ts deprovision()).
+ *   - Token revoke on an already-revoked token is a no-op (token-service).
+ *   - Thread delete tolerates 404 (chat-service deleteThreadsForAgent()).
+ *
+ * The Agent row is the retry anchor: while it still exists, a retry re-reads it
+ * and re-runs the remaining cleanup; once it's deleted, the operation is done.
+ *
+ * Steps, in order:
+ *   1. Read the Agent row + its AgentEnv rows.
+ *   2. K8s deprovision (Deployment + Secret + PVC).
+ *      Then, only for an agent with a per-agent Anthropic identity, remove it:
+ *      archive the federation rule, then the Anthropic service account, then
+ *      delete the K8s ServiceAccount (Anthropic refuses to archive a service
+ *      account while a live rule references it). A failure keeps the row and
+ *      adds the leftover pieces to the manual-steps checklist.
+ *   3. Revoke task-store token(s).
+ *   4. Revoke chat-service token(s) + delete chat threads.
+ *   5. (Optional) Delete the Slack app, gated on a supplied user token.
+ *   6. Build the secret checklist (always included, never blocks).
+ *   7. If every automatable step succeeded → delete the Agent row.
+ *   8. Otherwise → leave the Agent row in place so the caller can retry.
+ *
+ * Out of scope (decided during planning): no mutation of task-store Task rows
+ * for the deleted agent — tasks keep their historical assignment.
+ */
+
+import {
+  buildManualStepsChecklist,
+  type LeftoverIdentity,
+  type ManualStep,
+} from "./agent-deletion-checklist.ts";
+import type { AgentProvisioner } from "./agent-provisioner.ts";
+import type { ChatServiceProvisioningClient } from "./chat-service-provisioning-client.ts";
+import { NotFoundError } from "./errors.ts";
+import type { DeletionServiceIntegration } from "./service-integration.ts";
+import type { SlackProvisioningClient } from "./slack-provisioning-client.ts";
+
+// ─── Step identifiers ─────────────────────────────────────────────────────────
+
+/**
+ * Stable identifiers for each automatable cleanup step. Used both in the
+ * `completed` list and to tag entries in the `failed` array so a caller (or a
+ * test) can tell exactly which dependency broke.
+ */
+type DeleteAgentStep =
+  | "k8s"
+  | "anthropic-identity"
+  | `${string}-tokens`
+  | "chat-service-tokens-and-threads"
+  | "slack-app";
+
+/** A step that threw, with its error message for the caller to log/surface. */
+interface FailedStep {
+  step: DeleteAgentStep;
+  error: string;
+}
+
+// ─── Result ────────────────────────────────────────────────────────────────────
+
+interface DeleteAgentResult {
+  /**
+   * True only when every automatable step succeeded AND the Agent row was
+   * deleted. False when any step failed (the row is left in place for retry).
+   */
+  agentDeleted: boolean;
+  /** Steps that completed successfully, in execution order. */
+  completed: DeleteAgentStep[];
+  /**
+   * Steps that failed. Empty when `agentDeleted` is true. A failed step does
+   * NOT abort the remaining steps — they are still attempted so a single retry
+   * makes maximum forward progress.
+   */
+  failed: FailedStep[];
+  /**
+   * Operator-facing manual reminders (hand-pasted secrets with no automated
+   * revocation, plus an optional Slack-app entry when a token wasn't supplied).
+   * Always populated; never blocks the delete.
+   */
+  manualStepsRequired: ManualStep[];
+}
+
+// ─── Dependencies (DI boundary) ─────────────────────────────────────────────────
+
+/**
+ * Minimal Prisma surface this orchestration needs: read the Agent row, read its
+ * AgentEnv rows, and delete the Agent row (cascades child rows). Typed as a
+ * structural shape rather than `Pick<PrismaClient, ...>` so tests can inject a
+ * tiny in-memory double without pulling in the generated client.
+ */
+interface DeleteAgentPrisma {
+  agent: {
+    findUnique(args: {
+      where: { id: string };
+      select: {
+        id: true;
+        name: true;
+        anthropicFederationRuleId: true;
+        anthropicServiceAccountId: true;
+        k8sServiceAccountName: true;
+      };
+    }): Promise<({ id: string; name: string } & LeftoverIdentity) | null>;
+    delete(args: { where: { id: string } }): Promise<unknown>;
+  };
+  agentEnv: {
+    findMany(args: {
+      where: { agentId: string };
+      select: { key: true; value: true; secret: true };
+    }): Promise<{ key: string; value: string; secret: boolean }[]>;
+  };
+}
+
+export interface DeleteAgentFullyDeps {
+  prisma: DeleteAgentPrisma;
+  provisioner: Pick<
+    AgentProvisioner,
+    "deprovision" | "removeAnthropicIdentity"
+  >;
+  /**
+   * Optional service integrations (e.g. task-store, registered by the coding
+   * extension), each cleaned up as its own `${name}-tokens` step, in list
+   * order, before the built-in chat-service step.
+   */
+  serviceIntegrations: DeletionServiceIntegration[];
+  chatService: Pick<
+    ChatServiceProvisioningClient,
+    "listTokensForAgent" | "revokeToken" | "deleteThreadsForAgent"
+  >;
+  slack: Pick<SlackProvisioningClient, "deleteApp">;
+  /**
+   * Decrypt a stored AgentEnv value. AgentEnv values are AES-256-GCM encrypted
+   * at rest; only the SLACK_APP_ID value is decrypted here (to pass to the
+   * Slack delete call). Injected so the orchestration stays free of concrete
+   * crypto and is trivially unit-testable.
+   */
+  decrypt(value: string): string;
+}
+
+interface DeleteAgentFullyOpts {
+  /**
+   * Slack user token (xoxp-) authorizing the Slack app deletion. Supplied
+   * per-request (same UX as the sync-manifest flow) — when omitted, a Slack app
+   * (if present) is NOT auto-deleted and instead becomes a manual checklist
+   * entry. Its absence is never a failure.
+   */
+  xoxpToken?: string;
+}
+
+// ─── Orchestration ──────────────────────────────────────────────────────────────
+
+const errMessage = (err: unknown): string =>
+  err instanceof Error ? err.message : String(err);
+
+/**
+ * Fully delete an agent: tear down its workload and external state, then delete
+ * the Agent DB row LAST (only if every automatable step succeeded).
+ *
+ * Idempotent and retryable — see the module header. Throws `NotFoundError` only
+ * when the Agent row is genuinely absent at the start of the call: that means
+ * either the id was never valid, or a prior call already completed the delete.
+ * Treating a missing row as an error (rather than a silent success) keeps retry
+ * semantics honest — the caller asked to delete something that isn't there. A
+ * caller that races two deletes can catch it; the common retry-after-partial
+ * path always still sees the row (it's deleted last) and proceeds normally.
+ */
+export async function deleteAgentFully(
+  agentId: string,
+  deps: DeleteAgentFullyDeps,
+  opts: DeleteAgentFullyOpts = {},
+): Promise<DeleteAgentResult> {
+  // ── Step 1: read the Agent row + its AgentEnv rows ──────────────────────────
+  const agentSelect = {
+    id: true,
+    name: true,
+    anthropicFederationRuleId: true,
+    anthropicServiceAccountId: true,
+    k8sServiceAccountName: true,
+  } as const;
+  const agent = await deps.prisma.agent.findUnique({
+    where: { id: agentId },
+    select: agentSelect,
+  });
+  if (!agent) {
+    throw new NotFoundError(`agent ${agentId} not found`);
+  }
+  const envRows = await deps.prisma.agentEnv.findMany({
+    where: { agentId },
+    select: { key: true, value: true, secret: true },
+  });
+
+  const completed: DeleteAgentStep[] = [];
+  const failed: FailedStep[] = [];
+
+  const runStep = async (
+    step: DeleteAgentStep,
+    fn: () => Promise<void>,
+  ): Promise<void> => {
+    try {
+      await fn();
+      completed.push(step);
+    } catch (err) {
+      failed.push({ step, error: errMessage(err) });
+    }
+  };
+
+  // ── Step 2: K8s deprovision (Deployment + Secret + PVC) ─────────────────────
+  await runStep("k8s", async () => {
+    await deps.provisioner.deprovision(agentId, { slug: agent.name });
+  });
+
+  // ── Step 2b: remove the per-agent Anthropic identity ────────────────────────
+  // Runs after k8s so the pods are gone before their identity is pulled. Only
+  // present when the agent has a saved identity piece: agents without one (and
+  // shared/no-federation mode) get no step and behave exactly as before. The
+  // provisioner removes rule → Anthropic service account → K8s ServiceAccount
+  // and throws at the first failure.
+  const hasIdentity = Boolean(
+    agent.anthropicFederationRuleId ||
+      agent.anthropicServiceAccountId ||
+      agent.k8sServiceAccountName,
+  );
+  if (hasIdentity) {
+    await runStep("anthropic-identity", async () => {
+      if (!deps.provisioner.removeAnthropicIdentity) {
+        throw new Error(
+          "the provisioner cannot remove a per-agent Anthropic identity",
+        );
+      }
+      await deps.provisioner.removeAnthropicIdentity(agentId);
+    });
+  }
+
+  // ── Step 3: revoke each service integration's token(s) (e.g. task-store) ───
+  for (const integration of deps.serviceIntegrations) {
+    await runStep(`${integration.name}-tokens`, async () => {
+      await revokeAllTokens(integration, agentId);
+    });
+  }
+
+  // ── Step 4: revoke chat-service token(s) + delete chat threads ──────────────
+  await runStep("chat-service-tokens-and-threads", async () => {
+    await revokeAllTokens(deps.chatService, agentId);
+    await deps.chatService.deleteThreadsForAgent(agentId);
+  });
+
+  // ── Step 5: (optional) delete the Slack app ─────────────────────────────────
+  // Only present when the agent stores a SLACK_APP_ID. Gated on a supplied user
+  // token: with one we auto-delete (a real cleanup step that can fail); without
+  // one it's an expected manual gap that adds a checklist entry, not a failure.
+  const slackAppIdRow = envRows.find((r) => r.key === "SLACK_APP_ID");
+  const manualSlackSteps: ManualStep[] = [];
+  if (slackAppIdRow) {
+    const slackAppId = deps.decrypt(slackAppIdRow.value);
+    if (opts.xoxpToken) {
+      await runStep("slack-app", async () => {
+        await deps.slack.deleteApp(opts.xoxpToken as string, slackAppId);
+      });
+    } else {
+      manualSlackSteps.push({
+        key: "SLACK_APP_ID",
+        message: `Slack app ${slackAppId} was not deleted automatically — no Slack user token was supplied. Delete it manually at api.slack.com/apps or retry with a token.`,
+      });
+    }
+  }
+
+  // ── Step 6: build the secret checklist (always included) ────────────────────
+  // When the identity step failed, re-read the IDs so the checklist lists only
+  // what is actually still live (the provisioner clears each ID as it goes).
+  let leftoverIdentity: LeftoverIdentity | undefined;
+  if (failed.some((f) => f.step === "anthropic-identity")) {
+    leftoverIdentity =
+      (await deps.prisma.agent.findUnique({
+        where: { id: agentId },
+        select: agentSelect,
+      })) ?? agent;
+  }
+  const manualStepsRequired = [
+    ...buildManualStepsChecklist(envRows, leftoverIdentity),
+    ...manualSlackSteps,
+  ];
+
+  // ── Steps 7/8: delete the Agent row LAST, only if nothing failed ────────────
+  if (failed.length === 0) {
+    await deps.prisma.agent.delete({ where: { id: agentId } });
+    return { agentDeleted: true, completed, failed, manualStepsRequired };
+  }
+
+  return { agentDeleted: false, completed, failed, manualStepsRequired };
+}
+
+/**
+ * List every token scoped to the agent and revoke each. Revocation is
+ * individually idempotent (already-revoked / 404 is a no-op), so one failure
+ * mid-loop doesn't abort the rest — we attempt every token, then re-throw the
+ * first error so the enclosing step is recorded as failed for retry.
+ */
+async function revokeAllTokens(
+  client: Pick<
+    DeletionServiceIntegration,
+    "listTokensForAgent" | "revokeToken"
+  >,
+  agentId: string,
+): Promise<void> {
+  const tokens = await client.listTokensForAgent(agentId);
+  let firstError: unknown;
+  for (const token of tokens) {
+    try {
+      await client.revokeToken(token.id);
+    } catch (err) {
+      if (firstError === undefined) firstError = err;
+    }
+  }
+  if (firstError !== undefined) throw firstError;
+}