Files
PaperClipAI/server/src/services/dashboard.ts
T
Andrii Furmanets 61ecc93033 fix: count a recovered shutdown interrupt as recovered (#15031)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The dashboard success rate counts recovered runs as successes
> - A run is recovered when a later retry in its chain succeeds
> - The summary puts `failed` and `timed_out` into recovered
> - An `interrupted` run, including `server_shutdown_interrupted`, falls
through to other
> - The success rate stays down after the retry succeeds
> - This pull request counts a recovered interrupt in recovered, not in
other
> - The benefit is that a shutdown that was retried successfully no
longer looks like a failed day

## Linked Issues or Issue Description

No open issue covers this. I searched open and closed issues and pull
requests.

**What happened?**

`dashboardService.summary` puts only `failed` and `timed_out` into the
recovered bucket. An `interrupted` run, including
`server_shutdown_interrupted`, goes to other even when `recovered` is
set. The success rate uses `succeeded + recovered`, so the day stays low
after a successful retry.

**Expected behavior**

When the recovered flag is set, count `interrupted` in recovered. An
interrupt with no successful retry stays in other.

**Steps to reproduce**

1. Record an interrupted run with error code
`server_shutdown_interrupted`.
2. Record a succeeded retry of that run.
3. Open the dashboard summary for that day.
4. Observe that the interrupt is in other and the success rate does not
include it.

**Paperclip version or commit**

master at 215586d127

**Deployment mode**

Local dev (pnpm dev)

## What Changed

- When a run is recovered, count status `interrupted` in the recovered
bucket.
- Leave an unrecovered interrupt in other.
- Add a service test for a recovered shutdown and a stranded shutdown.

## Verification

- `pnpm exec vitest run src/__tests__/dashboard-service.test.ts --config
vitest.config.ts` in `server`
- Result: 1 file passed, 5 tests passed

## Risks

- Low risk. Unrecovered interrupts stay in other. Failed and timed-out
runs keep the same buckets.

## Model Used

- No model runtime is part of this change.

## 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
- [ ] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [ ] I will address all Greptile and reviewer comments before
requesting merge
2026-10-26 20:52:47 -07:00

223 lines
8.5 KiB
TypeScript

import { and, eq, gte, lte, sql } from "drizzle-orm";
import type { Db } from "@paperclipai/db";
import { agents, approvals, companies, costEvents, heartbeatRuns, issues } from "@paperclipai/db";
import { notFound } from "../errors.js";
import { budgetService } from "./budgets.js";
import { executionIssueCondition } from "./issue-visibility.js";
import { retryIdempotentDatabaseOperation } from "../database-retry.js";
const DASHBOARD_RUN_ACTIVITY_DAYS = 14;
function formatUtcDateKey(date: Date): string {
return date.toISOString().slice(0, 10);
}
export function getUtcMonthStart(date: Date): Date {
return new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), 1));
}
function getRecentUtcDateKeys(now: Date, days: number): string[] {
const todayUtc = Date.UTC(now.getUTCFullYear(), now.getUTCMonth(), now.getUTCDate());
return Array.from({ length: days }, (_, index) => {
const dayOffset = index - (days - 1);
return formatUtcDateKey(new Date(todayUtc + dayOffset * 24 * 60 * 60 * 1000));
});
}
export function dashboardService(db: Db) {
const budgets = budgetService(db);
return {
summary: async (companyId: string) => {
// This lookup only reads the company row. Rebuild it after a transient
// disconnect; do not replay the later summary or budget workflows.
const company = await retryIdempotentDatabaseOperation(() => db
.select()
.from(companies)
.where(eq(companies.id, companyId))
.then((rows) => rows[0] ?? null));
if (!company) throw notFound("Company not found");
const agentRows = await retryIdempotentDatabaseOperation(() => db
.select({ status: agents.status, count: sql<number>`count(*)` })
.from(agents)
.where(eq(agents.companyId, companyId))
.groupBy(agents.status));
const taskRows = await retryIdempotentDatabaseOperation(() => db
.select({ status: issues.status, count: sql<number>`count(*)` })
.from(issues)
.where(and(eq(issues.companyId, companyId), executionIssueCondition()))
.groupBy(issues.status));
const pendingApprovals = await retryIdempotentDatabaseOperation(() => db
.select({ count: sql<number>`count(*)` })
.from(approvals)
.where(and(eq(approvals.companyId, companyId), eq(approvals.status, "pending")))
.then((rows) => Number(rows[0]?.count ?? 0)));
const agentCounts: Record<string, number> = {
active: 0,
running: 0,
paused: 0,
error: 0,
};
for (const row of agentRows) {
const count = Number(row.count);
// "idle" agents are operational — count them as active
const bucket = row.status === "idle" ? "active" : row.status;
agentCounts[bucket] = (agentCounts[bucket] ?? 0) + count;
}
const taskCounts: Record<string, number> = {
open: 0,
inProgress: 0,
blocked: 0,
done: 0,
};
for (const row of taskRows) {
const count = Number(row.count);
if (row.status === "in_progress") taskCounts.inProgress += count;
if (row.status === "blocked") taskCounts.blocked += count;
if (row.status === "done") taskCounts.done += count;
if (row.status !== "done" && row.status !== "cancelled") taskCounts.open += count;
}
const now = new Date();
const monthStart = getUtcMonthStart(now);
const runActivityDays = getRecentUtcDateKeys(now, DASHBOARD_RUN_ACTIVITY_DAYS);
const runActivityStart = new Date(`${runActivityDays[0]}T00:00:00.000Z`);
const [{ monthSpend }] = await retryIdempotentDatabaseOperation(() => db
.select({
monthSpend: sql<number>`coalesce(sum(${costEvents.costCents}), 0)::double precision`,
})
.from(costEvents)
.where(
and(
eq(costEvents.companyId, companyId),
gte(costEvents.occurredAt, monthStart),
lte(costEvents.occurredAt, now),
),
));
const monthSpendCents = Number(monthSpend);
// Per-day run breakdown. A run is "recovered" when its retry chain later
// succeeded (recovered_runs = all ancestors of a succeeded retry), so a
// restart-killed or shutdown-interrupted run whose retry succeeded is
// pulled out of the headline failure count. error_code is carried through
// so a failure spike can be attributed to an error class (e.g. process_lost,
// provider_quota).
// Both recursive arms are bounded to the chart window: a retry is always
// created after the run it retries, so ancestors of an out-of-window
// child are themselves out of window and invisible to the membership
// test below. Unbounded, the seed walks every run the company ever had.
const runActivityRows = (await retryIdempotentDatabaseOperation(() => db.execute(sql`
WITH RECURSIVE recovered_runs(id) AS (
SELECT parent.id
FROM ${heartbeatRuns} AS child
JOIN ${heartbeatRuns} AS parent ON parent.id = child.retry_of_run_id
WHERE child.company_id = ${companyId}
AND child.status = 'succeeded'
AND child.created_at >= ${runActivityStart.toISOString()}::timestamptz
UNION
SELECT parent.id
FROM recovered_runs rr
JOIN ${heartbeatRuns} AS child ON child.id = rr.id
JOIN ${heartbeatRuns} AS parent ON parent.id = child.retry_of_run_id
WHERE child.created_at >= ${runActivityStart.toISOString()}::timestamptz
)
SELECT
to_char(run.created_at AT TIME ZONE 'UTC', 'YYYY-MM-DD') AS date,
run.status AS status,
run.error_code AS error_code,
(run.id IN (SELECT id FROM recovered_runs)) AS recovered,
count(*)::double precision AS count
FROM ${heartbeatRuns} AS run
WHERE run.company_id = ${companyId}
AND run.created_at >= ${runActivityStart.toISOString()}::timestamptz
GROUP BY date, run.status, run.error_code, recovered
`))) as unknown as Iterable<{
date: string;
status: string;
error_code: string | null;
recovered: boolean | string;
count: number | string;
}>;
const runActivity = new Map(
runActivityDays.map((date) => [
date,
{
date,
succeeded: 0,
failed: 0,
recovered: 0,
other: 0,
total: 0,
failedByErrorCode: {} as Record<string, number>,
},
]),
);
for (const row of runActivityRows) {
const bucket = runActivity.get(String(row.date));
if (!bucket) continue;
const count = Number(row.count);
const status = String(row.status);
// Postgres booleans can arrive as JS boolean or "t"/"true" depending on driver.
const recovered = row.recovered === true || row.recovered === "t" || row.recovered === "true";
if (status === "succeeded") {
bucket.succeeded += count;
} else if (
status === "failed" ||
status === "timed_out" ||
(recovered && status === "interrupted")
) {
if (recovered) {
bucket.recovered += count;
} else {
bucket.failed += count;
const code =
typeof row.error_code === "string" && row.error_code.length > 0
? row.error_code
: "unknown";
bucket.failedByErrorCode[code] = (bucket.failedByErrorCode[code] ?? 0) + count;
}
} else {
bucket.other += count;
}
bucket.total += count;
}
const utilization =
company.budgetMonthlyCents > 0
? (monthSpendCents / company.budgetMonthlyCents) * 100
: 0;
const budgetOverview = await budgets.overview(companyId);
return {
companyId,
agents: {
active: agentCounts.active,
running: agentCounts.running,
paused: agentCounts.paused,
error: agentCounts.error,
},
tasks: taskCounts,
costs: {
monthSpendCents,
monthBudgetCents: company.budgetMonthlyCents,
monthUtilizationPercent: Number(utilization.toFixed(2)),
},
pendingApprovals,
budgets: {
activeIncidents: budgetOverview.activeIncidents.length,
pendingApprovals: budgetOverview.pendingApprovalCount,
pausedAgents: budgetOverview.pausedAgentCount,
pausedProjects: budgetOverview.pausedProjectCount,
},
runActivity: Array.from(runActivity.values()),
};
},
};
}