* feat(agent): telemetry completeness + durability, CI gates, commit_method provenance Quick wins from the "Building AI systems that ship" audit: - mcp.tool_called gains errorMessage (message_sv, truncated 500 chars) on all failure exits; new mcp.skill_loaded event on every gnubok_load_skill (all tiers) so atom usage is finally measurable - event_log: (event_type, created_at) index; cleanup cron keeps mcp.*/agent.* telemetry 180 days (delivery events stay 30) - CI: lint ratchet (npm run check:lint — 60 legacy errors baselined, fails only on NEW errors) and a pg-real coverage gate (migrations touching trigger/RPC/RLS/DEFERRABLE require a *.pg.test.ts change; escape hatch: -- pg-test: covered-by/skip) - journal_entries.commit_method CHECK widened with 'api_key'/'agent'; the MCP approve path records 'api_key' truthfully instead of 'user_accept' (agent_first_vision §8 P0-1). 'agent' is reserved — ALL MCP traffic (incl. claude.ai OAuth, whose access_token is a minted API key) authenticates as api_key today Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(import): derive opening balances from prior-year #UB when SIE lacks #IB (#675) SIE files exported without #IB 0 rows (only #UB -1) previously imported with zero opening balances. getEffectiveOpeningBalances() now derives IB from prior-year UB for balance-sheet accounts when explicit #IB is absent, surfaces the derivation as an info issue in the import preview, and excludes share-capital vouchers from opening-balance detection. Detection regexes are shared between parser and importer so the two checks cannot drift. 507 lib/import tests pass. (Authored in a parallel session in this checkout; included per request.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(review): address PR #677 bot findings — RoPA entry, execFileSync, gate scope note Triage of the compliance-swarm + Greptile findings: Applied: - .compliance/ropa.yaml: new mcp.telemetry processing activity declaring the 180-day mcp.*/agent.* retention, lawful basis, data categories, and the no-args/no-results minimisation (ISO A.8.10, GDPR Art.5(1)(c) — the retention split is now formally documented, referenced from the cron) - check-pg-test-coverage.mjs: execFileSync with argv array — no shell, so a hostile base-ref can't inject (ASVS V13.2.1); verified an injection attempt exits 2 without executing - check-pg-test-coverage.mjs: documented the PR-level (not per-migration) scope of the gate so reviewers know to check coverage per migration when a PR carries several risky migrations (Greptile P2) Acknowledged, no change: - errorMessage PII risk: messages are domain-mapped strings; event_log already persists far richer delivery payloads under the same RLS; now declared in ropa.yaml - cron error envelope: errorResponse maps to the canonical safe envelope and the endpoint is CRON_SECRET-gated - two-pass delete "partial state": TTL deletes are idempotent — the next daily run sweeps whatever a failed pass left behind - skill_loaded actorLabel/sessionId: mirrors the pre-existing mcp.tool_called payload; sessionId is the join key the analytics exist for Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
204 lines
7.1 KiB
TypeScript
204 lines
7.1 KiB
TypeScript
import { eventBus } from '@/lib/events/bus'
|
|
import type { CoreEventType } from '@/lib/events/types'
|
|
import { createServiceClientNoCookies } from '@/lib/auth/api-keys'
|
|
import { createLogger } from '@/lib/logger'
|
|
|
|
const log = createLogger('event-log')
|
|
|
|
/**
|
|
* Event types persisted to the event_log table for external automation platforms.
|
|
* Excludes noise events that are always followed by an actionable event.
|
|
*/
|
|
const PERSISTED_EVENT_TYPES: CoreEventType[] = [
|
|
'journal_entry.committed',
|
|
'journal_entry.reversed',
|
|
'journal_entry.corrected',
|
|
'document.uploaded',
|
|
'document.accessed',
|
|
'document.deleted',
|
|
'invoice.created',
|
|
'invoice.sent',
|
|
'credit_note.created',
|
|
'transaction.synced',
|
|
'transaction.categorized',
|
|
'transaction.reconciled',
|
|
'period.locked',
|
|
'period.year_closed',
|
|
'customer.created',
|
|
'supplier.created',
|
|
'receipt.matched',
|
|
'receipt.confirmed',
|
|
'supplier_invoice.registered',
|
|
'supplier_invoice.approved',
|
|
'supplier_invoice.paid',
|
|
'supplier_invoice.credited',
|
|
'invoice.match_confirmed',
|
|
'supplier_invoice.match_confirmed',
|
|
'supplier_invoice.confirmed',
|
|
// MCP telemetry — every tool invocation, tools/list call, and resources/read.
|
|
// Lightweight metadata only. mcp.*/agent.* rows are retained 180 days by the
|
|
// cleanup cron (error-rate trends need more than the 30-day delivery window).
|
|
'mcp.tool_called',
|
|
'mcp.tools_list_called',
|
|
'mcp.resource_read',
|
|
// Workflow lifecycle + next-hint follow-through (Phase 3A). Tells us where
|
|
// agents stall, which skills actually drive completion, and whether the
|
|
// next-field rollout is paying off.
|
|
'mcp.workflow_started',
|
|
'mcp.workflow_completed',
|
|
'mcp.next_hint_followed',
|
|
// Every successful gnubok_load_skill, all tiers — which atoms agents
|
|
// actually load. Joined against mcp.tool_called error rates to measure
|
|
// whether a loaded atom helps or hurts.
|
|
'mcp.skill_loaded',
|
|
// Agent self-reported feedback — surfaces "this tool was missing", "this
|
|
// description was wrong", etc. Quarterly review → roadmap.
|
|
'agent.feedback',
|
|
// Bank connection consent lifecycle — required audit trail per ASVS V16
|
|
// and GDPR Art.30 (records of processing) for PSD2 consent decisions.
|
|
'bank_connection.consent_granted',
|
|
'bank_connection.account_selection_changed',
|
|
'bank_connection.revoked',
|
|
'bank_connection.cash_account_mirror_failed',
|
|
]
|
|
|
|
// Excluded (with reasoning):
|
|
// - journal_entry.drafted: always followed by .committed
|
|
// - receipt.extracted: intermediate AI step; .matched/.confirmed are actionable
|
|
// - supplier_invoice.received: inbox receipt; .confirmed is actionable
|
|
// - supplier_invoice.extracted: intermediate AI step
|
|
|
|
/**
|
|
* Extract the primary entity ID from an event payload.
|
|
*/
|
|
function extractEntityId(payload: Record<string, unknown>): string | null {
|
|
// Try common entity shapes in priority order
|
|
const entityKeys = [
|
|
'entry', 'invoice', 'transaction', 'customer', 'supplier', 'receipt',
|
|
'supplierInvoice', 'creditNote', 'period', 'document', 'inboxItem',
|
|
] as const
|
|
|
|
for (const key of entityKeys) {
|
|
const entity = payload[key]
|
|
if (entity && typeof entity === 'object' && 'id' in entity) {
|
|
const id = (entity as Record<string, unknown>).id
|
|
if (typeof id === 'string') return id
|
|
}
|
|
}
|
|
|
|
// Flat-string ID fields on events that don't carry a full entity object.
|
|
// Bank connection events fall into this category — the connection lives in
|
|
// an extension table, so we record its id directly.
|
|
if (typeof payload.connectionId === 'string') {
|
|
return payload.connectionId
|
|
}
|
|
|
|
// For journal_entry.corrected: use the corrected entry's ID
|
|
if ('corrected' in payload) {
|
|
const corrected = payload.corrected
|
|
if (corrected && typeof corrected === 'object' && 'id' in corrected) {
|
|
const id = (corrected as Record<string, unknown>).id
|
|
if (typeof id === 'string') return id
|
|
}
|
|
}
|
|
|
|
// For journal_entry.reversed: use the reversal entry's ID
|
|
if ('reversalEntry' in payload) {
|
|
const reversalEntry = payload.reversalEntry
|
|
if (reversalEntry && typeof reversalEntry === 'object' && 'id' in reversalEntry) {
|
|
const id = (reversalEntry as Record<string, unknown>).id
|
|
if (typeof id === 'string') return id
|
|
}
|
|
}
|
|
|
|
return null
|
|
}
|
|
|
|
/**
|
|
* Strip userId and companyId from payload (each stored in its own column) and
|
|
* return clean data for the JSONB blob.
|
|
*/
|
|
function stripMetaFields(payload: Record<string, unknown>): Record<string, unknown> {
|
|
const { userId: _userId, companyId: _companyId, ...data } = payload
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Persist a single event to the event_log table.
|
|
*/
|
|
async function persistEvent(
|
|
eventType: string,
|
|
userId: string,
|
|
companyId: string,
|
|
entityId: string | null,
|
|
data: Record<string, unknown>
|
|
): Promise<void> {
|
|
const supabase = createServiceClientNoCookies()
|
|
|
|
const { error } = await supabase
|
|
.from('event_log')
|
|
.insert({
|
|
user_id: userId,
|
|
company_id: companyId,
|
|
event_type: eventType,
|
|
entity_id: entityId,
|
|
data,
|
|
})
|
|
|
|
if (error) {
|
|
log.error(`Failed to persist event ${eventType}:`, error.message)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register event log handlers on the event bus.
|
|
* Persists events to the event_log table for external automation platforms.
|
|
* Returns an array of unsubscribe functions.
|
|
*/
|
|
export function registerEventLogHandler(): (() => void)[] {
|
|
return PERSISTED_EVENT_TYPES.map((eventType) =>
|
|
eventBus.on(eventType, async (payload) => {
|
|
try {
|
|
const rawPayload = payload as Record<string, unknown>
|
|
const userId = rawPayload.userId as string
|
|
const companyId = rawPayload.companyId
|
|
|
|
// All persisted event payloads mandate companyId in TypeScript; this guard
|
|
// protects against any caller that bypasses the type system. Writing NULL
|
|
// would make the row invisible to the company_id-scoped SELECT RLS policy.
|
|
if (typeof companyId !== 'string' || companyId.length === 0) {
|
|
log.error(`Event ${eventType} missing companyId; skipping persistence`)
|
|
return
|
|
}
|
|
|
|
// transaction.synced carries an array — batch insert
|
|
if (eventType === 'transaction.synced' && Array.isArray(rawPayload.transactions)) {
|
|
const transactions = rawPayload.transactions as Array<Record<string, unknown>>
|
|
if (transactions.length === 0) return
|
|
|
|
const rows = transactions.map(tx => ({
|
|
user_id: userId,
|
|
company_id: companyId,
|
|
event_type: eventType,
|
|
entity_id: typeof tx.id === 'string' ? tx.id : null,
|
|
data: { transaction: tx },
|
|
}))
|
|
|
|
const supabase = createServiceClientNoCookies()
|
|
const { error } = await supabase.from('event_log').insert(rows)
|
|
if (error) {
|
|
log.error(`Failed to persist batch transaction.synced:`, error.message)
|
|
}
|
|
return
|
|
}
|
|
|
|
const entityId = extractEntityId(rawPayload)
|
|
const data = stripMetaFields(rawPayload)
|
|
await persistEvent(eventType, userId, companyId, entityId, data)
|
|
} catch (err) {
|
|
log.error(`Event log handler error for ${eventType}:`, err)
|
|
}
|
|
})
|
|
)
|
|
}
|