/* * This file is part of a proprietary work. * * Copyright (c) 2025 Fossorial, Inc. * All rights reserved. * * This file is licensed under the Fossorial Commercial License. * You may not use this file except in compliance with the License. * Unauthorized use, copying, modification, or distribution is strictly prohibited. * * This file is not licensed under the AGPLv3. */ import { actionAuditLog, db } from "@server/db"; import { registry } from "@server/openApi"; import { NextFunction } from "express"; import { Request, Response } from "express"; import { eq, gt, lt, and, count, desc } from "drizzle-orm"; import { OpenAPITags } from "@server/openApi"; import { z } from "zod"; import createHttpError from "http-errors"; import HttpCode from "@server/types/HttpCode"; import { fromError } from "zod-validation-error"; import { QueryActionAuditLogResponse } from "@server/routers/auditLogs/types"; import response from "@server/lib/response"; import logger from "@server/logger"; import { getSevenDaysAgo } from "@app/lib/getSevenDaysAgo"; export const queryActionAuditLogsQuery = z.object({ // iso string just validate its a parseable date timeStart: z .string() .refine((val) => !isNaN(Date.parse(val)), { error: "timeStart must be a valid ISO date string" }) .transform((val) => Math.floor(new Date(val).getTime() / 1000)) .prefault(() => getSevenDaysAgo().toISOString()) .openapi({ type: "string", format: "date-time", description: "Start time as ISO date string (defaults to 7 days ago)" }), timeEnd: z .string() .refine((val) => !isNaN(Date.parse(val)), { error: "timeEnd must be a valid ISO date string" }) .transform((val) => Math.floor(new Date(val).getTime() / 1000)) .optional() .prefault(() => new Date().toISOString()) .openapi({ type: "string", format: "date-time", description: "End time as ISO date string (defaults to current time)" }), action: z.string().optional(), actorType: z.string().optional(), actorId: z.string().optional(), actor: z.string().optional(), limit: z .string() .optional() .default("1000") .transform(Number) .pipe(z.int().positive()), offset: z .string() .optional() .default("0") .transform(Number) .pipe(z.int().nonnegative()) }); export const queryActionAuditLogsParams = z.object({ orgId: z.string() }); export const queryActionAuditLogsCombined = queryActionAuditLogsQuery.merge( queryActionAuditLogsParams ); type Q = z.infer; function getWhere(data: Q) { return and( gt(actionAuditLog.timestamp, data.timeStart), lt(actionAuditLog.timestamp, data.timeEnd), eq(actionAuditLog.orgId, data.orgId), data.actor ? eq(actionAuditLog.actor, data.actor) : undefined, data.actorType ? eq(actionAuditLog.actorType, data.actorType) : undefined, data.actorId ? eq(actionAuditLog.actorId, data.actorId) : undefined, data.action ? eq(actionAuditLog.action, data.action) : undefined ); } export function queryAction(data: Q) { return db .select({ orgId: actionAuditLog.orgId, action: actionAuditLog.action, actorType: actionAuditLog.actorType, metadata: actionAuditLog.metadata, actorId: actionAuditLog.actorId, timestamp: actionAuditLog.timestamp, actor: actionAuditLog.actor }) .from(actionAuditLog) .where(getWhere(data)) .orderBy(desc(actionAuditLog.timestamp), desc(actionAuditLog.id)); } export function countActionQuery(data: Q) { const countQuery = db .select({ count: count() }) .from(actionAuditLog) .where(getWhere(data)); return countQuery; } async function queryUniqueFilterAttributes( timeStart: number, timeEnd: number, orgId: string ) { const baseConditions = and( gt(actionAuditLog.timestamp, timeStart), lt(actionAuditLog.timestamp, timeEnd), eq(actionAuditLog.orgId, orgId) ); // Get unique actors const uniqueActors = await db .selectDistinct({ actor: actionAuditLog.actor }) .from(actionAuditLog) .where(baseConditions); const uniqueActions = await db .selectDistinct({ action: actionAuditLog.action }) .from(actionAuditLog) .where(baseConditions); return { actors: uniqueActors .map((row) => row.actor) .filter((actor): actor is string => actor !== null), actions: uniqueActions .map((row) => row.action) .filter((action): action is string => action !== null) }; } registry.registerPath({ method: "get", path: "/org/{orgId}/logs/action", description: "Query the action audit log for an organization", tags: [OpenAPITags.Org], request: { query: queryActionAuditLogsQuery, params: queryActionAuditLogsParams }, responses: {} }); export async function queryActionAuditLogs( req: Request, res: Response, next: NextFunction ): Promise { try { const parsedQuery = queryActionAuditLogsQuery.safeParse(req.query); if (!parsedQuery.success) { return next( createHttpError( HttpCode.BAD_REQUEST, fromError(parsedQuery.error) ) ); } const parsedParams = queryActionAuditLogsParams.safeParse(req.params); if (!parsedParams.success) { return next( createHttpError( HttpCode.BAD_REQUEST, fromError(parsedParams.error) ) ); } const data = { ...parsedQuery.data, ...parsedParams.data }; const baseQuery = queryAction(data); const log = await baseQuery.limit(data.limit).offset(data.offset); const totalCountResult = await countActionQuery(data); const totalCount = totalCountResult[0].count; const filterAttributes = await queryUniqueFilterAttributes( data.timeStart, data.timeEnd, data.orgId ); return response(res, { data: { log: log, pagination: { total: totalCount, limit: data.limit, offset: data.offset }, filterAttributes }, success: true, error: false, message: "Action audit logs retrieved successfully", status: HttpCode.OK }); } catch (error) { logger.error(error); return next( createHttpError(HttpCode.INTERNAL_SERVER_ERROR, "An error occurred") ); } }