feat(enterprise): add audit log export endpoint (CSV/JSON)

This commit is contained in:
SnapOtter
2026-06-13 16:45:11 +08:00
parent c6f9a29687
commit 913dd6bbe1
5 changed files with 233 additions and 0 deletions
@@ -0,0 +1,140 @@
import { and, desc, eq, gte, lte } from "drizzle-orm";
import type { FastifyInstance, FastifyReply, FastifyRequest } from "fastify";
import { z } from "zod";
import { db, schema } from "../../db/index.js";
import { requirePermission } from "../../permissions.js";
const querySchema = z.object({
format: z.enum(["csv", "json"]).default("json"),
from: z.string().datetime({ offset: true }).optional(),
to: z.string().datetime({ offset: true }).optional(),
action: z.string().optional(),
actorId: z.string().optional(),
targetType: z.string().optional(),
targetId: z.string().optional(),
});
function escapeCsvField(value: string): string {
if (value.includes(",") || value.includes('"') || value.includes("\n")) {
return `"${value.replace(/"/g, '""')}"`;
}
return value;
}
export async function registerAuditExport(app: FastifyInstance): Promise<void> {
app.get(
"/api/v1/enterprise/audit/export",
async (
request: FastifyRequest<{
Querystring: {
format?: string;
from?: string;
to?: string;
action?: string;
actorId?: string;
targetType?: string;
targetId?: string;
};
}>,
reply: FastifyReply,
) => {
const user = await requirePermission("audit:read")(request, reply);
if (!user) return;
// Check enterprise feature gate
let featureEnabled = false;
try {
const { isFeatureEnabled } = await import("@snapotter/enterprise");
featureEnabled = isFeatureEnabled("audit_export");
} catch {
// Enterprise package not available
}
if (!featureEnabled) {
return reply
.status(403)
.send({ error: "Audit export requires an enterprise license with the audit_export feature" });
}
const parsed = querySchema.safeParse(request.query);
if (!parsed.success) {
return reply.status(400).send({ error: "Invalid query parameters", details: parsed.error.issues });
}
const { format, from, to, action, actorId, targetType, targetId } = parsed.data;
// Build filter conditions
const conditions = [];
if (from) {
conditions.push(gte(schema.auditLog.createdAt, new Date(from)));
}
if (to) {
conditions.push(lte(schema.auditLog.createdAt, new Date(to)));
}
if (action) {
conditions.push(eq(schema.auditLog.action, action));
}
if (actorId) {
conditions.push(eq(schema.auditLog.actorId, actorId));
}
if (targetType) {
conditions.push(eq(schema.auditLog.targetType, targetType));
}
if (targetId) {
conditions.push(eq(schema.auditLog.targetId, targetId));
}
const where = conditions.length > 0 ? and(...conditions) : undefined;
const entries = await db
.select()
.from(schema.auditLog)
.where(where)
.orderBy(desc(schema.auditLog.createdAt));
const rows = entries.map((e) => ({
id: e.id,
actorId: e.actorId ?? "",
actorUsername: e.actorUsername,
action: e.action,
targetType: e.targetType ?? "",
targetId: e.targetId ?? "",
details: e.details ? JSON.stringify(e.details) : "",
ipAddress: e.ipAddress ?? "",
requestId: e.requestId ?? "",
createdAt: e.createdAt.toISOString(),
}));
if (format === "csv") {
const headers = [
"id",
"actorId",
"actorUsername",
"action",
"targetType",
"targetId",
"details",
"ipAddress",
"requestId",
"createdAt",
];
const csvLines = [headers.join(",")];
for (const row of rows) {
csvLines.push(
headers.map((h) => escapeCsvField(String(row[h as keyof typeof row]))).join(","),
);
}
return reply
.header("Content-Type", "text/csv")
.header("Content-Disposition", 'attachment; filename="audit-export.csv"')
.send(csvLines.join("\n"));
}
// JSON format
return reply
.header("Content-Type", "application/json")
.header("Content-Disposition", 'attachment; filename="audit-export.json"')
.send(JSON.stringify(rows));
},
);
app.log.info("Enterprise audit export route registered");
}
+6
View File
@@ -0,0 +1,6 @@
import type { FastifyInstance } from "fastify";
import { registerAuditExport } from "./audit-export.js";
export async function registerEnterpriseRoutes(app: FastifyInstance) {
await registerAuditExport(app);
}