mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 23:43:16 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent execution must preserve usage so Paperclip can price work and enforce budgets. > - Remote Runner execution can outlive its web receiver. > - The receiver previously acknowledged Runner events before its later usage recorder saved the accounting receipt. > - This pull request saves required native usage receipts before that transport acknowledgement. > - A replacement receiver can accept the same retained report and create one ledger charge. ## Linked Issues or Issue Description **What happened?** Native remote Runner usage could leave its durable outbox before the web receiver saved its accounting receipt. The later recorder required a local receipt directory. A replacement web receiver could lose the only remaining report when the database write failed. **Expected behavior** The Runner retains unaccepted structured usage. Postgres owns accepted receipts. Repeated delivery preserves one receipt for each source report and one charge for the run. Missing usage keeps accounting pending. **Steps to reproduce** 1. Start a supported built-in native remote Runner. 2. Make the receipt database insert fail after the provider reports usage. 3. Replace the web receiver and its local directory. 4. Reconnect the same Runner and inspect the saved receipt and ledger. **Paperclip version or commit** The initial investigation used `ebd05e9f4c88c66af7473db86bbaacfd1544aa0a`. **Deployment mode** A web server with a remote native Runner and shared Postgres. Related work: #18327 owns output logs and provider traces. This change has no dependency on its S3 export path. #18031 covers interrupted Codex receipt recovery. #18005 covers legacy spool reads. #17516 covers Codex stop-boundary retention. ## What Changed - Add native producer receipt delivery through the existing Runner callback before transport acknowledgement. - Reuse `run_usage_receipts`, stable source sequences, and deterministic report identities. Reject conflicting replay and retry a lost commit response with the same receipt. - Restore per-turn usage from structured receipt facts. Preserve provider turns that share one PRP envelope turn. - Bind retained warm transport callbacks to the current run authority epoch, allowing old attachment control acknowledgements while preserving accounting ownership. - Persist Codex session baselines and cumulative totals in the existing provider checkpoint. Mark qualified whole-run deltas, preserve them across resume/restart/attachment, and leave old unmarked reports incomplete and unpriced. - Normalize the bounded final usage tail before the terminal event. Retain later increases for explicit reconciliation, block further attachment, and fail an affected successor without changing its baseline. - Complete runs from the accepted immutable receipt and its exact saved rate-card amount; preserve existing live-budget enforcement. - Skip the local receipt recorder for supported built-in native remote Runner execution. Keep local, legacy, and external Dot/Muse behavior unchanged. - Keep pricing, reservations, ledger settlement, source fencing, and budget holds with their existing owners. - Put the actual Runner integration test in the existing Rust-cached native test lane. Build before opening Postgres and give cold compilation its own bounded budget. ## Verification - Fresh Greptile review is 5/5 on `e7376a50c8162770da1d581ecf25c8cffac64520`, with no unresolved findings. Parent and independent peer review approved the final changes. - Real PostgreSQL 18.6 and a real Rust Runner exercise failed receipt insertion, receiver-directory loss, replay from the same producer, and exactly one 25-cent ledger charge. The actual accounting spool path stays absent. Optional logs/traces are disabled. The provider is controlled; no paid request is made and the fixture never pre-saves the expected receipt. - Producer checks passed 32 usage/provider tests,37 terminal controls, corrected completion, all 3 previously failing exit cases, and both full transport goal-continuation cases. Rejected active-goal completion retains its 120-token tail before failure. Baseline 100→successor150→33 duplicate old snapshots→old120 retains explicit incomplete reconciliation evidence and positive budget exposure. - Heartbeat executor checks passed 982/982. PostgreSQL tests preserve exact 1.002 USD pricing, the 100.2-cent ledger amount, budget holds, source takeover, partial/final receipts, cost-only corrections, equal rate-card replay, and stale-completion interleaving. Newer incomplete usage remains pending rather than settling an older snapshot. - Runtime replay and strict usage-schema checks passed 2/2; generated contracts and Rust formatting pass. Test-partition contracts passed 32/32. - [Final combined-head evidence](https://github.com/paperclipai/paperclip/pull/18354#issuecomment-6531526158) records full workspace typecheck/build and 41/41 accounting tests against all five cloud PR heads, including this final accounting commit. It includes commands and evidence limits. - Exact-head CI is green: 53successful checks, 6intentional skips, and the legacy Snyk status passed. Typecheck, build, Runner, server, browser, and aggregate gates pass. Runner Vitest1/2 initially failed an unchanged mocked Antigravity login fixture; its focused case passed locally, then one unchanged job retry passed 131 files/1995 tests, including all 11 Antigravity tests. The initial failed attempt remains recorded in CI. Initial local attempts exposed the host SysV semaphore limit and corrected harness path, IPC readiness, and queue-counter defects. A temporary test loader selected an existing POSIX-semaphore PostgreSQL 18.6 build without changing repository dependencies. An optional expanded debug provider run was interrupted at its unrelated 8192-turn rollover stress case; no full-file local pass is claimed. Required failure cases were run directly, and the full Runner CI remains required. ## Risks - The guarantee covers built-in native remote Runner execution. Local native execution, legacy adapters, external Dot/Muse execution, and server-originated model calls retain their existing contracts. - This does not provide traffic switching or general web-server failover. The existing controller identity, checkpoint, and generation gates still apply. - The receipt JSON gains optional structured producer facts. No schema migration or accounting S3 spool is added. Text output and raw trace payloads are excluded. - Codex accounting authority requires a Runner artifact built from this provider baseline implementation and qualified by digest. Update receivers and strict usage-schema readers before releasing that Runner; PRP does not negotiate this payload field. Existing unmarked Codex reports remain pending/unpriced. No deployed Runner artifact is claimed fixed. - Usage arriving beyond the bounded terminal tail may require manual reconciliation or a fresh session. Its evidence remains in the existing producer checkpoint/outbox; no adjustment ledger or recurring scan is added. ## Model Used OpenAI `gpt-6.1-sol` assisted with the implementation, tests, and documentation through code execution and repository tools. The context window size is unavailable. ## 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>
423 lines
28 KiB
TypeScript
423 lines
28 KiB
TypeScript
import { beginIdleTrackedWork } from "./task-admission.js";
|
|
import { priceAnthropicReceipt } from "./anthropic-pricing.js";
|
|
import { priceCodexReceipt } from "./codex-pricing.js";
|
|
import { randomUUID } from "node:crypto";
|
|
import { promises as fs } from "node:fs";
|
|
import path from "node:path";
|
|
import { z } from "zod";
|
|
import { and, eq, isNull, sql } from "drizzle-orm";
|
|
import { heartbeatRuns, runUsageReceipts, type Db } from "@paperclipai/db";
|
|
import type { AdapterExecutionResult, AdapterUsageCheckpoint } from "@paperclipai/adapter-utils";
|
|
import { compareCents, normalizeCents, pricingProvenanceSchema, usdToUnits } from "@paperclipai/shared";
|
|
import { idleAccountingSpoolPath, registerIdleSpoolDirectory } from "./idle-local-work.js";
|
|
import { conflict, notFound } from "../errors.js";
|
|
import { logger } from "../middleware/logger.js";
|
|
import { receiptFingerprint } from "./receipt-fingerprint.js";
|
|
import { withAccountingTransaction } from "./accounting-transaction.js";
|
|
import { ensureDurableDirectory, syncDirectory } from "../lib/durable-directory.js";
|
|
import { DELIVERY_QUEUES, notifyDeliveryWork } from "./delivery-work-notifications.js";
|
|
import { knownRunCostCents } from "./budget-exposure.js";
|
|
import { createLiveRunUsageProjection, liveRunUsageCostCents } from "./budget-live-usage.js";
|
|
import { budgetServiceInTransaction } from "./budgets.js";
|
|
|
|
const token = z.number().int().nonnegative().max(2_147_483_647);
|
|
const price = z.number().finite().nonnegative().nullable().optional();
|
|
const usage = z.object({ inputTokens: token, outputTokens: token, cachedInputTokens: token.optional(), cacheWriteTokens: token.optional() });
|
|
const checkpointSchema = z.object({
|
|
attemptId: z.string().uuid().optional(), usage: usage.optional(),
|
|
usageByModel: z.array(z.object({ model: z.string().min(1).max(250), usage, costUsd: z.number().finite().nonnegative() })).max(500).optional(),
|
|
usageBasis: z.enum(["per_run", "session_cumulative"]).nullable().optional(),
|
|
provider: z.string().max(250).nullable().optional(), biller: z.string().max(250).nullable().optional(),
|
|
model: z.string().max(250).nullable().optional(), billingType: z.string().max(100).nullable().optional(),
|
|
costUsd: price, cacheAdjustedCostUsd: price,
|
|
costStatus: z.enum(["reported", "estimated", "unpriced"]).optional(),
|
|
pricingContext: z.object({ serviceTier: z.string().max(50).optional(), contextTier: z.enum(["short", "long"]).optional() }).optional(),
|
|
pricingProvenance: pricingProvenanceSchema.optional(),
|
|
costUsdExact: z.string().max(160).refine(value => { try { return !value.startsWith("-") && usdToUnits(value) >= 0n; } catch { return false; } }, "Invalid exact USD amount").nullable().optional(),
|
|
providerRequestId: z.string().max(250).nullable().optional(), complete: z.boolean(),
|
|
});
|
|
const envelopeSchema = z.object({
|
|
schema: z.literal("paperclip/accounting-receipt/v1"), id: z.string().uuid(), companyId: z.string().uuid(),
|
|
runId: z.string().uuid(), sourceId: z.string().uuid(), sequence: z.number().int().positive(), receivedAt: z.iso.datetime(),
|
|
adapterType: z.string().max(100), receipt: checkpointSchema,
|
|
producerEvent: z.object({ sourceEventId: z.string(), turnId: z.string().optional(), providerTurnId: z.string().optional(),
|
|
eventType: z.string(), usage: z.record(z.string(), z.unknown()).optional() }).optional(),
|
|
// Derived by the recorder, not a provider's final charge. Keeping it in the
|
|
// fsynced envelope preserves known partial attempts through database replay.
|
|
liveCostCents: z.string().max(160).refine(value => {
|
|
try { return compareCents(value, 0) >= 0; } catch { return false; }
|
|
}, "Invalid live cost").transform(normalizeCents).nullable().optional(),
|
|
});
|
|
export type UsageReceiptEnvelope = z.infer<typeof envelopeSchema>;
|
|
export const usageReceiptSpoolPath = idleAccountingSpoolPath;
|
|
|
|
export async function spoolUsageReceipt(envelope: UsageReceiptEnvelope, directory = usageReceiptSpoolPath()) {
|
|
registerIdleSpoolDirectory(directory);
|
|
const parsed = envelopeSchema.parse(envelope);
|
|
await ensureDurableDirectory(directory);
|
|
const target = path.join(directory, `${parsed.id}.json`);
|
|
const temporary = `${target}.${randomUUID()}.tmp`;
|
|
const handle = await fs.open(temporary, "wx", 0o600);
|
|
try {
|
|
try { await handle.writeFile(JSON.stringify(parsed)); await handle.sync(); }
|
|
finally { await handle.close(); }
|
|
await fs.rename(temporary, target); await syncDirectory(directory);
|
|
} catch (error) { await fs.rm(temporary, { force: true }); throw error; }
|
|
return target;
|
|
}
|
|
|
|
export async function persistUsageReceipt(db: Db, raw: UsageReceiptEnvelope) {
|
|
const envelope = envelopeSchema.parse(raw);
|
|
const hash = receiptFingerprint(envelope);
|
|
return withAccountingTransaction(db, envelope.companyId, async (tx, publications) => {
|
|
const [run] = await tx.select({
|
|
id: heartbeatRuns.id, agentId: heartbeatRuns.agentId, status: heartbeatRuns.status,
|
|
usageJson: heartbeatRuns.usageJson, costAccountedAt: heartbeatRuns.costAccountedAt,
|
|
}).from(heartbeatRuns).where(and(eq(heartbeatRuns.id, envelope.runId), eq(heartbeatRuns.companyId, envelope.companyId))).for("update");
|
|
if (!run) throw notFound("Accounting run not found");
|
|
const [existing] = await tx.select().from(runUsageReceipts).where(and(eq(runUsageReceipts.companyId, envelope.companyId), eq(runUsageReceipts.runId, envelope.runId), eq(runUsageReceipts.sourceId, envelope.sourceId), eq(runUsageReceipts.sequence, envelope.sequence)));
|
|
if (existing && existing.receiptHash !== hash) throw conflict("Conflicting usage checkpoint replay");
|
|
if (!existing && run.costAccountedAt && envelope.producerEvent) {
|
|
const previous = run.usageJson ?? {};
|
|
const [saved] = await tx.select({ receiptJson: runUsageReceipts.receiptJson }).from(runUsageReceipts).where(and(
|
|
eq(runUsageReceipts.companyId, envelope.companyId), eq(runUsageReceipts.runId, envelope.runId),
|
|
sql`${runUsageReceipts.id}::text = ${previous.accountingReceiptId ?? null}`));
|
|
const accepted = saved ? envelopeSchema.parse(saved.receiptJson).receipt : undefined;
|
|
const monetaryAmount = (receipt: UsageReceiptEnvelope["receipt"] | undefined) => {
|
|
const value = receipt?.cacheAdjustedCostUsd ?? receipt?.costUsdExact ?? receipt?.costUsd;
|
|
return value == null ? null : usdToUnits(value);
|
|
};
|
|
const incomingMoney = monetaryAmount(envelope.receipt);
|
|
const authoritativeMoney = incomingMoney !== null && envelope.receipt.pricingProvenance?.source !== "rate_card";
|
|
const authoritativeProvenance = envelope.receipt.pricingProvenance
|
|
&& !["rate_card", "unknown"].includes(envelope.receipt.pricingProvenance.source);
|
|
if ((envelope.producerEvent.eventType === "usage.reported" && (!envelope.receipt.usage || !accepted))
|
|
|| Object.entries(envelope.receipt.usage ?? {}).some(([key, value]) => previous[key] !== value)
|
|
|| (authoritativeMoney && incomingMoney !== monetaryAmount(accepted))
|
|
|| (authoritativeProvenance && receiptFingerprint(envelope.receipt.pricingProvenance) !== receiptFingerprint(accepted?.pricingProvenance ?? null))) {
|
|
throw conflict("native_usage_after_finalization_requires_reconciliation");
|
|
}
|
|
}
|
|
if (!existing) await tx.insert(runUsageReceipts).values({
|
|
id: envelope.id, companyId: envelope.companyId, runId: envelope.runId, sourceId: envelope.sourceId,
|
|
sequence: envelope.sequence, receiptHash: hash, receiptJson: envelope, complete: envelope.receipt.complete, receivedAt: new Date(envelope.receivedAt),
|
|
});
|
|
const previous = run.usageJson ?? {};
|
|
// A restarted/replaced controller owns a fresh source. Old spool files
|
|
// remain auditable but cannot overwrite its snapshots or acknowledged work.
|
|
if (run.costAccountedAt || previous.accountingReceiptSourceId !== envelope.sourceId || Number(previous.accountingReceiptSequence ?? 0) >= envelope.sequence) return;
|
|
const receipt = envelope.receipt;
|
|
const billingType = receipt.billingType === "api" ? "metered_api" : receipt.billingType === "subscription" ? "subscription_included" : receipt.billingType ?? "unknown";
|
|
const oldProjection = previous.budgetExposure && typeof previous.budgetExposure === "object"
|
|
? previous.budgetExposure as Record<string, unknown> : {};
|
|
const canonicalProjection = typeof oldProjection.sourceId === "string" && typeof oldProjection.sequence === "number";
|
|
let previousCost = canonicalProjection ? null : knownRunCostCents(previous);
|
|
if (typeof oldProjection.costCents === "string") {
|
|
try {
|
|
const projected = normalizeCents(oldProjection.costCents);
|
|
if (compareCents(projected, 0) >= 0 && (canonicalProjection || compareCents(projected, previousCost ?? "0") > 0)) previousCost = projected;
|
|
} catch { /* Older malformed projections are not billing evidence. */ }
|
|
}
|
|
const reportedCost = envelope.liveCostCents !== undefined ? envelope.liveCostCents
|
|
: liveRunUsageCostCents({ ...receipt, billingType } as AdapterUsageCheckpoint);
|
|
const observedCost = reportedCost === null ? previousCost
|
|
: !receipt.complete && previousCost !== null && compareCents(previousCost, reportedCost) > 0 ? previousCost : reportedCost;
|
|
// Running checkpoints cannot settle yet. Their terminal transition owns
|
|
// the accounting wake; only a late receipt needs to reactivate that worker.
|
|
if (!["queued", "running"].includes(run.status)) await notifyDeliveryWork(tx, DELIVERY_QUEUES.accounting, envelope.companyId);
|
|
await tx.update(heartbeatRuns).set({
|
|
costAccountingPending: true,
|
|
accountingLastError: previous.accountingCaptureFailed === true ? "usage_capture_failed" : null,
|
|
usageJson: { ...previous, ...receipt.usage,
|
|
provider: receipt.provider ?? "unknown", biller: receipt.biller ?? receipt.provider ?? "unknown", model: receipt.model ?? "unknown", billingType,
|
|
costUsd: receipt.costUsd ?? null, costUsdExact: receipt.costUsdExact ?? null, cacheAdjustedCostUsd: receipt.cacheAdjustedCostUsd ?? null,
|
|
usageByModel: receipt.usageByModel ?? null, usageSource: receipt.usageBasis ?? "per_run", providerRequestId: receipt.providerRequestId ?? null,
|
|
accountingReceiptReady: previous.accountingCaptureFailed !== true && receipt.complete && receipt.usageBasis !== "session_cumulative", accountingReceiptId: envelope.id,
|
|
accountingReceiptSequence: envelope.sequence, accountingReceiptReceivedAt: envelope.receivedAt,
|
|
costStatus: receipt.costStatus ?? null,
|
|
budgetExposure: { sourceId: envelope.sourceId, sequence: envelope.sequence, costCents: observedCost },
|
|
pricingProvenance: receipt.pricingProvenance ?? { source: receipt.costUsd != null || receipt.costUsdExact != null ? "provider_reported" : "unknown", version: "accounting-receipt/v1" },
|
|
},
|
|
}).where(and(eq(heartbeatRuns.id, run.id), isNull(heartbeatRuns.costAccountedAt)));
|
|
if (observedCost !== null && compareCents(observedCost, previousCost ?? "0") !== 0) {
|
|
const scope = previous.ledgerScope && typeof previous.ledgerScope === "object" ? previous.ledgerScope as Record<string, unknown> : {};
|
|
await budgetServiceInTransaction(tx, publications).evaluateAffectedScopes(envelope.companyId, run.agentId,
|
|
typeof scope.projectId === "string" ? scope.projectId : null);
|
|
}
|
|
});
|
|
}
|
|
|
|
export async function replayUsageReceipts(db: Db, directory = usageReceiptSpoolPath(), limit = 100) {
|
|
let files: string[];
|
|
try { files = (await fs.readdir(directory)).filter(name => name.endsWith(".json")).sort(); }
|
|
catch (error) { if ((error as NodeJS.ErrnoException).code === "ENOENT") return { replayed: 0, failed: 0 }; throw error; }
|
|
let replayed = 0, failed = 0;
|
|
for (const name of files.slice(0, limit)) {
|
|
const file = path.join(directory, name);
|
|
try {
|
|
const info = await fs.lstat(file);
|
|
if (!info.isFile() || info.size > 1024 * 1024) throw new Error("Invalid accounting spool entry");
|
|
await persistUsageReceipt(db, envelopeSchema.parse(JSON.parse(await fs.readFile(file, "utf8"))));
|
|
await fs.rm(file, { force: true }); replayed++;
|
|
} catch (error) {
|
|
failed++;
|
|
// Rotate failures behind fresh entries without discarding the evidence.
|
|
await fs.rename(file, path.join(directory, `retry-${Date.now()}-${randomUUID()}.json`)).catch(() => undefined);
|
|
logger.error({ err: error, receiptFile: name }, "Accounting spool receipt remains pending");
|
|
}
|
|
}
|
|
return { replayed, failed };
|
|
}
|
|
|
|
type ReceiptIdentity = { companyId: unknown; runId: unknown } | null;
|
|
export type UsageReceiptIndex = Map<string, ReceiptIdentity>;
|
|
function receiptIdentity(raw: unknown): ReceiptIdentity {
|
|
return raw && typeof raw === "object" && "companyId" in raw && "runId" in raw
|
|
? { companyId: raw.companyId, runId: raw.runId } : null;
|
|
}
|
|
|
|
/** Build once per recovery batch, before acquiring any accounting lock.
|
|
* Spool publications are immutable, uniquely named files. Cache identities,
|
|
* never receipt contents: matching evidence is revalidated during settlement. */
|
|
export async function indexPendingUsageReceipts(directory = usageReceiptSpoolPath()): Promise<UsageReceiptIndex> {
|
|
const index: UsageReceiptIndex = new Map();
|
|
let names: string[];
|
|
try { names = await fs.readdir(directory); }
|
|
// Indexing is only an optimization. The locked drain reports missing or
|
|
// unreadable storage through the existing per-run recovery error path.
|
|
catch { return index; }
|
|
for (const name of names.filter(name => name.endsWith(".json"))) {
|
|
const file = path.join(directory, name);
|
|
try {
|
|
const info = await fs.lstat(file);
|
|
if (!info.isFile() || info.size > 1024 * 1024) { index.set(file, null); continue; }
|
|
index.set(file, receiptIdentity(JSON.parse(await fs.readFile(file, "utf8"))));
|
|
} catch (error) {
|
|
if (error instanceof SyntaxError) index.set(file, null);
|
|
// Unreadable or concurrently moved entries remain unknown and are
|
|
// checked again under the lock, preserving per-run failure reporting.
|
|
}
|
|
}
|
|
return index;
|
|
}
|
|
|
|
export async function recoverPendingRunUsageReceipts(db: Db, input: { companyId: string; runId: string }, directory = usageReceiptSpoolPath(), options: { retainFiles?: boolean; index?: UsageReceiptIndex } = {}) {
|
|
// The bounded sweep may not reach this run. Its durable evidence must
|
|
// reach the journal before source replacement or ledger acknowledgement.
|
|
// A failed save aborts the operation so recovery can retry.
|
|
const recovered = new Set<string>();
|
|
// A concurrent failed replay can rename a file after releasing its company
|
|
// lock. Rescan disappearing paths rather than certify an incomplete scan.
|
|
for (let scan = 0; scan < 3; scan++) {
|
|
let names: string[];
|
|
try { names = await fs.readdir(directory); }
|
|
catch (error) { if ((error as NodeJS.ErrnoException).code === "ENOENT") return [...recovered]; throw error; }
|
|
let moved = false;
|
|
for (const name of names.filter(name => name.endsWith(".json"))) {
|
|
const file = path.join(directory, name);
|
|
if (recovered.has(file)) continue;
|
|
const indexed = options.index?.get(file);
|
|
if (indexed !== undefined && (indexed?.companyId !== input.companyId || indexed?.runId !== input.runId)) continue;
|
|
let raw: unknown;
|
|
try {
|
|
const info = await fs.lstat(file);
|
|
if (!info.isFile() || info.size > 1024 * 1024) continue;
|
|
raw = JSON.parse(await fs.readFile(file, "utf8"));
|
|
} catch (error) {
|
|
// The background replayer can move/remove a file while we scan. Invalid
|
|
// JSON remains on disk for its normal recovery/error reporting path.
|
|
if ((error as NodeJS.ErrnoException).code === "ENOENT") { moved = true; continue; }
|
|
if (error instanceof SyntaxError) continue;
|
|
throw error;
|
|
}
|
|
const identity = receiptIdentity(raw);
|
|
options.index?.set(file, identity);
|
|
if (identity?.companyId !== input.companyId || identity?.runId !== input.runId) continue;
|
|
await persistUsageReceipt(db, envelopeSchema.parse(raw));
|
|
// Settlement uses the caller's transaction: deleting before its commit
|
|
// would lose the only durable evidence if the later ledger write fails.
|
|
recovered.add(file);
|
|
if (!options.retainFiles) await fs.rm(file, { force: true });
|
|
}
|
|
if (!moved) return [...recovered];
|
|
}
|
|
throw new Error("Accounting spool changed during recovery; retry required");
|
|
}
|
|
|
|
export async function createRunUsageRecorder(db: Db, input: { companyId: string; runId: string; adapterType: string }, directory = usageReceiptSpoolPath()) {
|
|
registerIdleSpoolDirectory(directory);
|
|
const sourceId = randomUUID();
|
|
// Verify durable storage before starting paid work, including a directory
|
|
// sync. The database binding fences checkpoints from replaced controllers.
|
|
await ensureDurableDirectory(directory);
|
|
const probe = await fs.open(path.join(directory, `${sourceId}.probe`), "wx", 0o600);
|
|
try { await probe.sync(); } finally { await probe.close(); await fs.rm(path.join(directory, `${sourceId}.probe`)); }
|
|
await syncDirectory(directory);
|
|
await recoverPendingRunUsageReceipts(db, input, directory);
|
|
const bound = await db.update(heartbeatRuns).set({ usageJson: sql`coalesce(${heartbeatRuns.usageJson}, '{}'::jsonb) || ${JSON.stringify({ accountingReceiptSourceId: sourceId, accountingReceiptSequence: 0, accountingReceiptReady: false })}::jsonb` })
|
|
.where(and(eq(heartbeatRuns.id, input.runId), eq(heartbeatRuns.companyId, input.companyId), isNull(heartbeatRuns.costAccountedAt))).returning({ id: heartbeatRuns.id, runtimeMode: heartbeatRuns.runtimeMode, usageJson: heartbeatRuns.usageJson });
|
|
if (bound.length !== 1) throw conflict("Run cannot accept a new usage recorder");
|
|
let sequence = 0;
|
|
let currentAttempt = "default";
|
|
const attempts = new Map<string, AdapterUsageCheckpoint>();
|
|
let initialLiveUsage: Parameters<typeof createLiveRunUsageProjection>[0];
|
|
// Native run deltas retain their baseline across same-run recovery. Restore
|
|
// the previous snapshot as the same attempt, never add it a second time.
|
|
// An empty final result must not erase the last durable observation.
|
|
const priorReceiptId = bound[0].usageJson?.accountingReceiptId;
|
|
if (bound[0].runtimeMode === "native" && typeof priorReceiptId === "string") {
|
|
const [previous] = await db.select().from(runUsageReceipts).where(and(
|
|
eq(runUsageReceipts.id, priorReceiptId), eq(runUsageReceipts.runId, input.runId), eq(runUsageReceipts.companyId, input.companyId),
|
|
));
|
|
if (previous) {
|
|
const restored = envelopeSchema.parse(previous.receiptJson);
|
|
const receipt = restored.receipt as AdapterUsageCheckpoint;
|
|
attempts.set("default", receipt);
|
|
initialLiveUsage = { receipt, costCents: restored.liveCostCents };
|
|
}
|
|
}
|
|
const projectLiveUsage = createLiveRunUsageProjection(initialLiveUsage);
|
|
let chain = Promise.resolve();
|
|
let captureFailed = bound[0].usageJson?.accountingCaptureFailed === true;
|
|
let finishFailedCapture: (() => void) | undefined;
|
|
async function persistFailure() {
|
|
if (!captureFailed) return;
|
|
const persisted = await withAccountingTransaction(db, input.companyId, async tx => {
|
|
const rows = await tx.update(heartbeatRuns).set({
|
|
costAccountingPending: true, accountingLastError: "usage_capture_failed",
|
|
usageJson: sql`coalesce(${heartbeatRuns.usageJson}, '{}'::jsonb) || '{"accountingCaptureFailed":true,"accountingReceiptReady":false}'::jsonb`,
|
|
}).where(and(eq(heartbeatRuns.id, input.runId), eq(heartbeatRuns.companyId, input.companyId),
|
|
isNull(heartbeatRuns.costAccountedAt), sql`${heartbeatRuns.usageJson}->>'accountingReceiptSourceId' = ${sourceId}`)).returning({ id: heartbeatRuns.id });
|
|
return rows.length === 1;
|
|
});
|
|
if (persisted) { finishFailedCapture?.(); finishFailedCapture = undefined; }
|
|
}
|
|
function enqueue(action: () => Promise<AdapterUsageCheckpoint>) {
|
|
const finishQueuedCapture = beginIdleTrackedWork();
|
|
const result = chain.then(action).catch(async error => {
|
|
captureFailed = true;
|
|
finishFailedCapture ??= beginIdleTrackedWork();
|
|
// Persist before exposing rejection: the adapter's flush may throw before
|
|
// complete(), and failure finalization must not settle an older receipt.
|
|
try { await persistFailure(); }
|
|
catch (failure) { logger.error({ err: failure, runId: input.runId }, "Usage capture failure fence requires retry before finalization"); }
|
|
throw error;
|
|
});
|
|
chain = result.then(() => undefined, () => undefined).finally(finishQueuedCapture);
|
|
return result;
|
|
}
|
|
async function capture(raw: AdapterUsageCheckpoint) {
|
|
const parsed = checkpointSchema.parse(raw) as AdapterUsageCheckpoint;
|
|
const attempt = parsed.attemptId ?? currentAttempt;
|
|
if (!attempts.has(attempt)) currentAttempt = attempt;
|
|
const previous = attempts.get(attempt);
|
|
const priced = priceAnthropicReceipt(priceCodexReceipt({ ...parsed, usage: parsed.usage ?? previous?.usage,
|
|
complete: parsed.complete && !(previous?.usage && !parsed.usage) }));
|
|
priced.pricingProvenance ??= {
|
|
source: priced.costUsd != null || priced.costUsdExact != null || priced.cacheAdjustedCostUsd != null ? "provider_reported" : "unknown",
|
|
version: "accounting-receipt/v1",
|
|
};
|
|
attempts.set(attempt, priced);
|
|
const liveCostCents = projectLiveUsage(attempt, priced);
|
|
const parts = [...attempts.values()];
|
|
const latest = attempts.get(currentAttempt)!;
|
|
const receipt: AdapterUsageCheckpoint = { ...latest, complete: latest.complete && !captureFailed, usage: {
|
|
inputTokens: parts.reduce((sum, item) => sum + (item.usage?.inputTokens ?? 0), 0),
|
|
cachedInputTokens: parts.reduce((sum, item) => sum + (item.usage?.cachedInputTokens ?? 0), 0),
|
|
...(parts.some(item => item.usage?.cacheWriteTokens !== undefined) ? { cacheWriteTokens: parts.reduce((sum, item) => sum + (item.usage?.cacheWriteTokens ?? 0), 0) } : {}),
|
|
outputTokens: parts.reduce((sum, item) => sum + (item.usage?.outputTokens ?? 0), 0),
|
|
} };
|
|
if (parts.length > 1) {
|
|
let total = 0n, priced = true;
|
|
for (const part of parts) {
|
|
const subscription = ["subscription", "subscription_included"].includes(part.billingType ?? "");
|
|
const cost = subscription ? 0 : part.cacheAdjustedCostUsd ?? part.costUsdExact ?? part.costUsd;
|
|
if (cost == null || (!subscription && part.costStatus === "unpriced")) priced = false;
|
|
if (cost != null) total += usdToUnits(cost);
|
|
}
|
|
if (new Set(parts.map(part => part.billingType ?? "unknown")).size > 1) receipt.billingType = "unknown";
|
|
const decimal = `${total / 1_000_000_000n}.${String(total % 1_000_000_000n).padStart(9, "0")}`;
|
|
receipt.costUsdExact = decimal;
|
|
receipt.costUsd = Number(decimal);
|
|
receipt.cacheAdjustedCostUsd = null;
|
|
// A rejected resume can report a complete, explicit zero before the
|
|
// successful retry. It contributes neither spend nor tokens and must
|
|
// not discard the successful attempt's known model attribution.
|
|
const attributed = parts.filter(part => {
|
|
const cost = part.cacheAdjustedCostUsd ?? part.costUsdExact ?? part.costUsd;
|
|
return !part.complete || part.costStatus === "unpriced" || cost == null || usdToUnits(cost) !== 0n
|
|
|| Object.values(part.usage ?? {}).some(value => (value ?? 0) !== 0);
|
|
});
|
|
receipt.usageByModel = attributed.length === 1 ? attributed[0].usageByModel : undefined;
|
|
receipt.costStatus = priced && parts.some(part => part.costStatus === "estimated") ? "estimated" : priced ? "reported" : "unpriced";
|
|
receipt.pricingProvenance = { source: receipt.costStatus === "estimated" ? "rate_card" : "unknown", version: "per-attempt/v1", evidence: "Sum of attempted-run receipts; component prices are retained in the immutable receipt journal." };
|
|
// Every attempted provider must supply a final receipt before the total
|
|
// can be considered complete, even if a later attempt succeeded.
|
|
receipt.complete = !captureFailed && parts.every(part => part.complete);
|
|
}
|
|
const envelope: UsageReceiptEnvelope = { schema: "paperclip/accounting-receipt/v1", id: randomUUID(), ...input, sourceId, sequence: ++sequence, receivedAt: new Date().toISOString(), receipt, liveCostCents };
|
|
const file = await spoolUsageReceipt(envelope, directory);
|
|
try { await persistUsageReceipt(db, envelope); await fs.rm(file, { force: true }); }
|
|
catch (error) {
|
|
// The fsynced receipt is durable even when the DB transaction failed.
|
|
// Wake the owned spool recovery path; never certify that failed write as free.
|
|
const { wakeCostAccountingWork } = await import("./budget-enforcement-worker.js");
|
|
wakeCostAccountingWork(db);
|
|
logger.warn({ err: error, runId: input.runId, receiptId: envelope.id }, "Usage receipt is durable on disk; database replay pending");
|
|
}
|
|
return receipt;
|
|
}
|
|
return {
|
|
capture: (receipt: AdapterUsageCheckpoint) => enqueue(() => capture(receipt)),
|
|
// Retry a transient database failure before heartbeat can mark the run
|
|
// terminal. A failed retry must propagate and leave finalization pending.
|
|
persistFailure: async () => { await chain; await persistFailure(); },
|
|
complete: (result: AdapterExecutionResult) => enqueue(async () => {
|
|
const final = checkpointSchema.parse({ ...result, complete: result.usageComplete !== false }) as AdapterUsageCheckpoint;
|
|
const previous = attempts.get(currentAttempt);
|
|
// A bounded stdout tail can lose a terminal record already saved from the
|
|
// full stream. Keep that stronger evidence, but never hide additional
|
|
// usage/charges or certify a snapshot inherited from a replaced recorder.
|
|
if (sequence > 0 && previous?.complete && result.usageComplete === false) {
|
|
const moreTokens = (["inputTokens", "cachedInputTokens", "cacheWriteTokens", "outputTokens"] as const)
|
|
.some(key => (final.usage?.[key] ?? 0) > (previous.usage?.[key] ?? 0));
|
|
const finalPrice = final.cacheAdjustedCostUsd ?? final.costUsdExact ?? final.costUsd;
|
|
const previousPrice = previous.cacheAdjustedCostUsd ?? previous.costUsdExact ?? previous.costUsd;
|
|
const moreCost = finalPrice != null && (previousPrice == null || usdToUnits(finalPrice) > usdToUnits(previousPrice));
|
|
if (!moreTokens && !moreCost) return capture(previous);
|
|
}
|
|
return capture(final);
|
|
}),
|
|
};
|
|
}
|
|
|
|
export async function readAcceptedRunUsageCheckpoint(db: Db, input: { companyId: string; runId: string }): Promise<AdapterUsageCheckpoint | undefined> {
|
|
const [run] = await db.select({ usageJson: heartbeatRuns.usageJson }).from(heartbeatRuns).where(and(
|
|
eq(heartbeatRuns.companyId, input.companyId), eq(heartbeatRuns.id, input.runId)));
|
|
const state = run?.usageJson;
|
|
if (typeof state?.accountingReceiptId !== "string") return undefined;
|
|
const [saved] = await db.select({ receiptJson: runUsageReceipts.receiptJson }).from(runUsageReceipts).where(and(
|
|
eq(runUsageReceipts.companyId, input.companyId), eq(runUsageReceipts.runId, input.runId),
|
|
sql`${runUsageReceipts.id}::text = ${state.accountingReceiptId}`));
|
|
if (!saved) return undefined;
|
|
const receipt = envelopeSchema.parse(saved.receiptJson);
|
|
if (receipt.sourceId !== state.accountingReceiptSourceId || receipt.sequence !== state.accountingReceiptSequence) return undefined;
|
|
return { ...receipt.receipt, complete: receipt.receipt.complete && state.accountingReceiptReady === true } as AdapterUsageCheckpoint;
|
|
}
|
|
|
|
const producerAccountingProjectionFields = [
|
|
"accountingReceiptOwner", "accountingReceiptSourceId", "accountingReceiptSequence", "accountingReceiptReady",
|
|
"accountingReceiptId", "accountingReceiptReceivedAt", "accountingCaptureFailed",
|
|
"inputTokens", "outputTokens", "cachedInputTokens", "cacheWriteTokens",
|
|
"provider", "biller", "model", "billingType", "usageSource", "providerRequestId", "usageByModel",
|
|
"costUsd", "costUsdExact", "cacheAdjustedCostUsd", "costStatus", "pricingProvenance", "budgetExposure",
|
|
];
|
|
|
|
export function preserveAcceptedRunUsageProjectionSql(patch: Record<string, unknown>) {
|
|
const fields = sql.join(producerAccountingProjectionFields.map(field => sql`${field}`), sql`, `);
|
|
return sql`case when ${heartbeatRuns.usageJson}->>'accountingReceiptOwner' = 'native_producer'
|
|
then ${JSON.stringify(patch)}::jsonb || (select coalesce(jsonb_object_agg(key, value), '{}'::jsonb)
|
|
from jsonb_each(coalesce(${heartbeatRuns.usageJson}, '{}'::jsonb)) where key in (${fields}))
|
|
else ${JSON.stringify(patch)}::jsonb end`;
|
|
}
|