forge-openclaw-plugin 0.2.20 → 0.2.21

package/dist/server/repositories/diagnostic-logs.js

@@ -0,0 +1,243 @@
+import { randomUUID } from "node:crypto";
+import { Buffer } from "node:buffer";
+import { getDatabase } from "../db.js";
+import { createDiagnosticLogSchema, diagnosticLogEntrySchema } from "../types.js";
+const MAX_LOG_ENTRIES = 5_000;
+export const DIAGNOSTIC_LOG_RETENTION_DAYS = 14;
+export const DIAGNOSTIC_LOG_RETENTION_SWEEP_INTERVAL_MS = 15 * 60 * 1000;
+const MAX_STRING_LENGTH = 4_000;
+const MAX_ARRAY_ITEMS = 24;
+const MAX_OBJECT_KEYS = 40;
+const MAX_DEPTH = 4;
+let nextRetentionSweepAt = 0;
+function nowIso() {
+    return new Date().toISOString();
+}
+function sanitizeDiagnosticValue(value, depth = 0) {
+    if (value === null ||
+        typeof value === "boolean" ||
+        typeof value === "number") {
+        return value;
+    }
+    if (typeof value === "string") {
+        return value.length > MAX_STRING_LENGTH
+            ? `${value.slice(0, MAX_STRING_LENGTH)}…`
+            : value;
+    }
+    if (typeof value === "bigint") {
+        return value.toString();
+    }
+    if (typeof value === "function" || typeof value === "symbol") {
+        return String(value);
+    }
+    if (value instanceof Date) {
+        return value.toISOString();
+    }
+    if (value instanceof Error) {
+        return {
+            name: value.name,
+            message: value.message,
+            stack: typeof value.stack === "string"
+                ? sanitizeDiagnosticValue(value.stack, depth + 1)
+                : null
+        };
+    }
+    if (Buffer.isBuffer(value)) {
+        return {
+            type: "Buffer",
+            bytes: value.byteLength
+        };
+    }
+    if (depth >= MAX_DEPTH) {
+        if (Array.isArray(value)) {
+            return `[Array(${value.length})]`;
+        }
+        return "[Object]";
+    }
+    if (Array.isArray(value)) {
+        return value
+            .slice(0, MAX_ARRAY_ITEMS)
+            .map((entry) => sanitizeDiagnosticValue(entry, depth + 1));
+    }
+    if (value && typeof value === "object") {
+        const entries = Object.entries(value).slice(0, MAX_OBJECT_KEYS);
+        return Object.fromEntries(entries.map(([key, entry]) => [
+            key,
+            sanitizeDiagnosticValue(entry, depth + 1)
+        ]));
+    }
+    return String(value);
+}
+function sanitizeDetails(details) {
+    if (!details) {
+        return {};
+    }
+    return Object.fromEntries(Object.entries(details).map(([key, value]) => [
+        key,
+        sanitizeDiagnosticValue(value)
+    ]));
+}
+function mapRow(row) {
+    return diagnosticLogEntrySchema.parse({
+        id: row.id,
+        level: row.level,
+        source: row.source,
+        scope: row.scope,
+        eventKey: row.event_key,
+        message: row.message,
+        route: row.route,
+        functionName: row.function_name,
+        requestId: row.request_id,
+        entityType: row.entity_type,
+        entityId: row.entity_id,
+        jobId: row.job_id,
+        details: JSON.parse(row.details_json),
+        createdAt: row.created_at
+    });
+}
+function pruneDiagnosticLogs() {
+    const expiredBefore = new Date(Date.now() - DIAGNOSTIC_LOG_RETENTION_DAYS * 24 * 60 * 60 * 1_000).toISOString();
+    const expiredResult = getDatabase()
+        .prepare(`DELETE FROM diagnostic_logs
+       WHERE created_at < ?`)
+        .run(expiredBefore);
+    const overflowResult = getDatabase().prepare(`DELETE FROM diagnostic_logs
+     WHERE id IN (
+       SELECT id
+       FROM diagnostic_logs
+       ORDER BY created_at DESC
+       LIMIT -1 OFFSET ?
+     )`).run(MAX_LOG_ENTRIES);
+    return (expiredResult.changes ?? 0) + (overflowResult.changes ?? 0);
+}
+function checkpointDiagnosticLogStore() {
+    getDatabase().exec("PRAGMA wal_checkpoint(TRUNCATE);");
+}
+export function enforceDiagnosticLogRetention(options = {}) {
+    const now = options.now ?? new Date();
+    const startedAt = now.getTime();
+    if (!options.force && startedAt < nextRetentionSweepAt) {
+        return { prunedCount: 0, ran: false };
+    }
+    nextRetentionSweepAt =
+        startedAt + DIAGNOSTIC_LOG_RETENTION_SWEEP_INTERVAL_MS;
+    const prunedCount = pruneDiagnosticLogs();
+    if (prunedCount > 0) {
+        checkpointDiagnosticLogStore();
+    }
+    return {
+        prunedCount,
+        ran: true
+    };
+}
+export function recordDiagnosticLog(input, now = new Date()) {
+    const parsed = createDiagnosticLogSchema.parse(input);
+    const entry = diagnosticLogEntrySchema.parse({
+        id: `diag_${randomUUID().replaceAll("-", "").slice(0, 10)}`,
+        level: parsed.level,
+        source: parsed.source ?? "server",
+        scope: parsed.scope,
+        eventKey: parsed.eventKey,
+        message: parsed.message,
+        route: parsed.route ?? null,
+        functionName: parsed.functionName ?? null,
+        requestId: parsed.requestId ?? null,
+        entityType: parsed.entityType ?? null,
+        entityId: parsed.entityId ?? null,
+        jobId: parsed.jobId ?? null,
+        details: sanitizeDetails(parsed.details),
+        createdAt: now.toISOString()
+    });
+    getDatabase().prepare(`INSERT INTO diagnostic_logs (
+      id, level, source, scope, event_key, message, route, function_name,
+      request_id, entity_type, entity_id, job_id, details_json, created_at
+    ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`).run(entry.id, entry.level, entry.source, entry.scope, entry.eventKey, entry.message, entry.route, entry.functionName, entry.requestId, entry.entityType, entry.entityId, entry.jobId, JSON.stringify(entry.details), entry.createdAt);
+    enforceDiagnosticLogRetention({ now });
+    return entry;
+}
+export function listDiagnosticLogs(filters = {}) {
+    enforceDiagnosticLogRetention();
+    const whereClauses = [];
+    const params = [];
+    if (filters.level) {
+        whereClauses.push("level = ?");
+        params.push(filters.level);
+    }
+    if (filters.source) {
+        whereClauses.push("source = ?");
+        params.push(filters.source);
+    }
+    if (filters.scope) {
+        whereClauses.push("scope = ?");
+        params.push(filters.scope);
+    }
+    if (filters.route) {
+        whereClauses.push("route = ?");
+        params.push(filters.route);
+    }
+    if (filters.entityType) {
+        whereClauses.push("entity_type = ?");
+        params.push(filters.entityType);
+    }
+    if (filters.entityId) {
+        whereClauses.push("entity_id = ?");
+        params.push(filters.entityId);
+    }
+    if (filters.jobId) {
+        whereClauses.push("job_id = ?");
+        params.push(filters.jobId);
+    }
+    if (filters.search) {
+        whereClauses.push("(message LIKE ? OR scope LIKE ? OR event_key LIKE ? OR IFNULL(route, '') LIKE ? OR details_json LIKE ?)");
+        const term = `%${filters.search}%`;
+        params.push(term, term, term, term, term);
+    }
+    if (filters.beforeCreatedAt && filters.beforeId) {
+        whereClauses.push("(created_at < ? OR (created_at = ? AND id < ?))");
+        params.push(filters.beforeCreatedAt, filters.beforeCreatedAt, filters.beforeId);
+    }
+    const whereSql = whereClauses.length > 0 ? `WHERE ${whereClauses.join(" AND ")}` : "";
+    const limit = filters.limit ?? 200;
+    const rows = getDatabase()
+        .prepare(`SELECT id, level, source, scope, event_key, message, route, function_name,
+              request_id, entity_type, entity_id, job_id, details_json, created_at
+       FROM diagnostic_logs
+       ${whereSql}
+       ORDER BY created_at DESC, id DESC
+       LIMIT ?`)
+        .all(...params, limit);
+    const logs = rows.map(mapRow);
+    const tail = rows.at(-1) ?? null;
+    return {
+        logs,
+        nextCursor: rows.length >= limit && tail
+            ? {
+                beforeCreatedAt: tail.created_at,
+                beforeId: tail.id
+            }
+            : null
+    };
+}
+export function normalizeDiagnosticSource(value) {
+    return value === "ui" ||
+        value === "openclaw" ||
+        value === "agent" ||
+        value === "system" ||
+        value === "server"
+        ? value
+        : "server";
+}
+export function serializeDiagnosticError(error) {
+    return sanitizeDiagnosticValue(error);
+}
+export function createDiagnosticMessage(input) {
+    const method = input.method?.toUpperCase() || "CALL";
+    const route = input.route || "unknown-route";
+    if (typeof input.statusCode === "number") {
+        return `${method} ${route} -> ${input.statusCode}`;
+    }
+    return `${method} ${route}`;
+}
+export function createDiagnosticTimestamp() {
+    return nowIso();
+}