@oneuptime/common 10.0.67 → 10.0.68

package/build/dist/Server/Services/AuditLogService.js

@@ -0,0 +1,402 @@
+import AnalyticsDatabaseService from "./AnalyticsDatabaseService";
+import ProjectService from "./ProjectService";
+import { IsBillingEnabled, IsEnterpriseEdition } from "../EnvironmentConfig";
+import logger from "../Utils/Logger";
+import AuditLog from "../../Models/AnalyticsModels/AuditLog";
+import AuditLogAction from "../../Types/AuditLog/AuditLogAction";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+import { getColumnAccessControlForAllColumns } from "../../Types/Database/AccessControl/ColumnAccessControl";
+import ObjectID from "../../Types/ObjectID";
+import UserType from "../../Types/UserType";
+import UserService from "./UserService";
+import OneUptimeDate from "../../Types/Date";
+const PROJECT_SETTINGS_CACHE_TTL_MS = 60 * 1000;
+const USER_CACHE_TTL_MS = 5 * 60 * 1000;
+const SKIPPED_FIELDS = new Set([
+    "_id",
+    "id",
+    "createdAt",
+    "updatedAt",
+    "deletedAt",
+    "version",
+    "slug",
+]);
+const NAME_CANDIDATE_FIELDS = [
+    "name",
+    "title",
+    "displayName",
+];
+export class AuditLogService extends AnalyticsDatabaseService {
+    constructor(clickhouseDatabase) {
+        super({ modelType: AuditLog, database: clickhouseDatabase });
+        this.projectSettingsCache = new Map();
+        this.userCache = new Map();
+    }
+    invalidateProjectSettings(projectId) {
+        this.projectSettingsCache.delete(projectId.toString());
+    }
+    async recordCreate(data) {
+        var _a;
+        try {
+            const projectId = this.resolveProjectId(data.model, data.createdItem, data.props);
+            if (!projectId) {
+                return;
+            }
+            const settings = await this.getProjectSettings(projectId);
+            if (!this.isEligible(settings, data.props)) {
+                return;
+            }
+            const redactedFields = this.getRedactedFields(data.model);
+            const changes = this.buildSnapshotChanges({
+                model: data.createdItem,
+                redactedFields,
+                valueKey: "newValue",
+            });
+            await this.insert({
+                projectId,
+                resourceType: this.getResourceType(data.model),
+                resourceId: (_a = data.createdItem.id) !== null && _a !== void 0 ? _a : null,
+                resourceName: this.getResourceName(data.createdItem),
+                action: AuditLogAction.Create,
+                changes,
+                props: data.props,
+                retentionInDays: settings.retentionInDays,
+            });
+        }
+        catch (err) {
+            logger.warn("AuditLog: failed to record create event");
+            logger.warn(err);
+        }
+    }
+    async recordUpdate(data) {
+        try {
+            const projectId = this.resolveProjectId(data.model, data.before, data.props);
+            if (!projectId) {
+                return;
+            }
+            const settings = await this.getProjectSettings(projectId);
+            if (!this.isEligible(settings, data.props)) {
+                return;
+            }
+            const redactedFields = this.getRedactedFields(data.model);
+            const changes = this.buildUpdateDiff({
+                before: data.before,
+                updatedFields: data.updatedFields,
+                redactedFields,
+            });
+            if (changes.length === 0) {
+                return;
+            }
+            await this.insert({
+                projectId,
+                resourceType: this.getResourceType(data.model),
+                resourceId: data.itemId,
+                resourceName: this.getResourceName(data.before),
+                action: AuditLogAction.Update,
+                changes,
+                props: data.props,
+                retentionInDays: settings.retentionInDays,
+            });
+        }
+        catch (err) {
+            logger.warn("AuditLog: failed to record update event");
+            logger.warn(err);
+        }
+    }
+    async recordDelete(data) {
+        try {
+            const projectId = this.resolveProjectId(data.model, data.deletedItem, data.props);
+            if (!projectId) {
+                return;
+            }
+            const settings = await this.getProjectSettings(projectId);
+            if (!this.isEligible(settings, data.props)) {
+                return;
+            }
+            const redactedFields = this.getRedactedFields(data.model);
+            const changes = this.buildSnapshotChanges({
+                model: data.deletedItem,
+                redactedFields,
+                valueKey: "oldValue",
+            });
+            await this.insert({
+                projectId,
+                resourceType: this.getResourceType(data.model),
+                resourceId: data.itemId,
+                resourceName: this.getResourceName(data.deletedItem),
+                action: AuditLogAction.Delete,
+                changes,
+                props: data.props,
+                retentionInDays: settings.retentionInDays,
+            });
+        }
+        catch (err) {
+            logger.warn("AuditLog: failed to record delete event");
+            logger.warn(err);
+        }
+    }
+    async insert(params) {
+        const auditLog = new AuditLog();
+        auditLog.projectId = params.projectId;
+        auditLog.resourceType = params.resourceType;
+        if (params.resourceId) {
+            auditLog.resourceId = params.resourceId;
+        }
+        if (params.resourceName) {
+            auditLog.resourceName = params.resourceName;
+        }
+        auditLog.action = params.action;
+        const actor = await this.resolveActor(params.props);
+        if (actor.userId) {
+            auditLog.userId = actor.userId;
+        }
+        if (actor.userName) {
+            auditLog.userName = actor.userName;
+        }
+        if (actor.userEmail) {
+            auditLog.userEmail = actor.userEmail;
+        }
+        if (actor.userType) {
+            auditLog.userType = actor.userType;
+        }
+        auditLog.changes = params.changes;
+        auditLog.retentionDate = this.computeRetentionDate(params.retentionInDays);
+        await this.create({
+            data: auditLog,
+            props: { isRoot: true },
+        });
+    }
+    computeRetentionDate(retentionInDays) {
+        const days = Math.max(1, Math.min(retentionInDays || 7, 180));
+        return OneUptimeDate.addRemoveDays(OneUptimeDate.getCurrentDate(), days);
+    }
+    isEligible(settings, _props) {
+        if (!settings) {
+            return false;
+        }
+        if (!settings.enableAuditLogs) {
+            return false;
+        }
+        if (IsEnterpriseEdition) {
+            return true;
+        }
+        if (IsBillingEnabled) {
+            return settings.planName === PlanType.Enterprise;
+        }
+        /*
+         * Neither enterprise edition nor billing is enabled — audit logs are not
+         * available on the free self-hosted build.
+         */
+        return false;
+    }
+    async getProjectSettings(projectId) {
+        var _a;
+        const key = projectId.toString();
+        const now = Date.now();
+        const cached = this.projectSettingsCache.get(key);
+        if (cached && cached.expiresAt > now) {
+            return cached;
+        }
+        const project = await ProjectService.findOneById({
+            id: projectId,
+            select: {
+                _id: true,
+                enableAuditLogs: true,
+                auditLogsRetentionInDays: true,
+                planName: true,
+            },
+            props: { isRoot: true },
+        });
+        if (!project) {
+            return null;
+        }
+        const settings = {
+            enableAuditLogs: Boolean(project.enableAuditLogs),
+            retentionInDays: (_a = project.auditLogsRetentionInDays) !== null && _a !== void 0 ? _a : 7,
+            planName: project.planName,
+            expiresAt: now + PROJECT_SETTINGS_CACHE_TTL_MS,
+        };
+        this.projectSettingsCache.set(key, settings);
+        return settings;
+    }
+    async resolveActor(props) {
+        var _a, _b;
+        const userType = props.userType
+            ? String(props.userType)
+            : props.isRoot
+                ? "System"
+                : null;
+        if (!props.userId) {
+            return {
+                userId: null,
+                userName: null,
+                userEmail: null,
+                userType,
+            };
+        }
+        // API-key actions don't have a user record to look up.
+        if (props.userType === UserType.API) {
+            return {
+                userId: props.userId,
+                userName: null,
+                userEmail: null,
+                userType,
+            };
+        }
+        const cached = await this.getUserInfo(props.userId);
+        return {
+            userId: props.userId,
+            userName: (_a = cached === null || cached === void 0 ? void 0 : cached.name) !== null && _a !== void 0 ? _a : null,
+            userEmail: (_b = cached === null || cached === void 0 ? void 0 : cached.email) !== null && _b !== void 0 ? _b : null,
+            userType,
+        };
+    }
+    async getUserInfo(userId) {
+        var _a, _b, _c, _d;
+        const key = userId.toString();
+        const now = Date.now();
+        const cached = this.userCache.get(key);
+        if (cached && cached.expiresAt > now) {
+            return { name: cached.name, email: cached.email };
+        }
+        const user = await UserService.findOneById({
+            id: userId,
+            select: { _id: true, name: true, email: true },
+            props: { isRoot: true },
+        });
+        const name = (_b = (_a = user === null || user === void 0 ? void 0 : user.name) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : null;
+        const email = (_d = (_c = user === null || user === void 0 ? void 0 : user.email) === null || _c === void 0 ? void 0 : _c.toString()) !== null && _d !== void 0 ? _d : null;
+        this.userCache.set(key, {
+            name,
+            email,
+            expiresAt: now + USER_CACHE_TTL_MS,
+        });
+        return { name, email };
+    }
+    resolveProjectId(model, item, props) {
+        if (props.tenantId) {
+            return props.tenantId;
+        }
+        const tenantColumn = model.getTenantColumn();
+        if (!tenantColumn) {
+            return undefined;
+        }
+        const value = item.getValue(tenantColumn);
+        return value !== null && value !== void 0 ? value : undefined;
+    }
+    getRedactedFields(model) {
+        const redacted = new Set();
+        const allAccessControl = getColumnAccessControlForAllColumns(model);
+        for (const key of Object.keys(allAccessControl)) {
+            const ac = allAccessControl[key];
+            if (ac && Array.isArray(ac.read) && ac.read.length === 0) {
+                redacted.add(key);
+            }
+        }
+        return redacted;
+    }
+    buildSnapshotChanges(data) {
+        const changes = [];
+        const columns = data.model.getTableColumns().columns;
+        for (const column of columns) {
+            if (SKIPPED_FIELDS.has(column)) {
+                continue;
+            }
+            if (data.redactedFields.has(column)) {
+                continue;
+            }
+            const value = data.model[column];
+            if (value === undefined) {
+                continue;
+            }
+            changes.push({
+                field: column,
+                [data.valueKey]: this.serializeValue(value),
+            });
+        }
+        return changes;
+    }
+    buildUpdateDiff(data) {
+        const changes = [];
+        for (const field of Object.keys(data.updatedFields)) {
+            if (SKIPPED_FIELDS.has(field)) {
+                continue;
+            }
+            if (data.redactedFields.has(field)) {
+                continue;
+            }
+            const newValue = data.updatedFields[field];
+            const oldValue = data.before[field];
+            if (this.areValuesEqual(oldValue, newValue)) {
+                continue;
+            }
+            changes.push({
+                field,
+                oldValue: this.serializeValue(oldValue),
+                newValue: this.serializeValue(newValue),
+            });
+        }
+        return changes;
+    }
+    areValuesEqual(a, b) {
+        if (a === b) {
+            return true;
+        }
+        if (a === null || a === undefined) {
+            return b === null || b === undefined;
+        }
+        if (b === null || b === undefined) {
+            return false;
+        }
+        try {
+            return JSON.stringify(a) === JSON.stringify(b);
+        }
+        catch (_a) {
+            return false;
+        }
+    }
+    serializeValue(value) {
+        if (value === null || value === undefined) {
+            return null;
+        }
+        if (value instanceof ObjectID) {
+            return value.toString();
+        }
+        if (value instanceof Date) {
+            return value.toISOString();
+        }
+        if (typeof value === "string" ||
+            typeof value === "number" ||
+            typeof value === "boolean") {
+            return value;
+        }
+        try {
+            return JSON.parse(JSON.stringify(value));
+        }
+        catch (_a) {
+            return String(value);
+        }
+    }
+    getResourceType(model) {
+        if (model.singularName) {
+            return model.singularName;
+        }
+        return model.constructor
+            .name;
+    }
+    getResourceName(item) {
+        for (const field of NAME_CANDIDATE_FIELDS) {
+            const columns = item.getTableColumns().columns;
+            if (!columns.includes(field)) {
+                continue;
+            }
+            const value = item[field];
+            if (typeof value === "string" && value.length > 0) {
+                return value;
+            }
+        }
+        return null;
+    }
+}
+export default new AuditLogService();
+//# sourceMappingURL=AuditLogService.js.map

package/build/dist/Server/Services/AuditLogService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogService.js","sourceRoot":"","sources":["../../../../Server/Services/AuditLogService.ts"],"names":[],"mappings":"AACA,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,QAAQ,MAAM,uCAAuC,CAAC;AAI7D,OAAO,cAAc,MAAM,qCAAqC,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,mCAAmC,EAAE,MAAM,wDAAwD,CAAC;AAE7G,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,MAAM,6BAA6B,GAAW,EAAE,GAAG,IAAI,CAAC;AACxD,MAAM,iBAAiB,GAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAEhD,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAS;IAC1D,KAAK;IACL,IAAI;IACJ,WAAW;IACX,WAAW;IACX,WAAW;IACX,SAAS;IACT,MAAM;CACP,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAA0B;IACnD,MAAM;IACN,OAAO;IACP,aAAa;CACd,CAAC;AAeF,MAAM,OAAO,eAAgB,SAAQ,wBAAkC;IAIrE,YAAmB,kBAAmD;QACpE,KAAK,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAJvD,yBAAoB,GAAuC,IAAI,GAAG,EAAE,CAAC;QACrE,cAAS,GAA4B,IAAI,GAAG,EAAE,CAAC;IAIvD,CAAC;IAEM,yBAAyB,CAAC,SAAmB;QAClD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,YAAY,CAA2B,IAInD;;QACC,IAAI,CAAC;YACH,MAAM,SAAS,GAAyB,IAAI,CAAC,gBAAgB,CAC3D,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,KAAK,CACX,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAE3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAAgB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,OAAO,GAAc,IAAI,CAAC,oBAAoB,CAAC;gBACnD,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,cAAc;gBACd,QAAQ,EAAE,UAAU;aACrB,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,MAAM,CAAC;gBAChB,SAAS;gBACT,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC9C,UAAU,EAAE,MAAA,IAAI,CAAC,WAAW,CAAC,EAAE,mCAAI,IAAI;gBACvC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC;gBACpD,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,OAAO;gBACP,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,eAAe,EAAE,QAAS,CAAC,eAAe;aAC3C,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CAA2B,IAMnD;QACC,IAAI,CAAC;YACH,MAAM,SAAS,GAAyB,IAAI,CAAC,gBAAgB,CAC3D,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,KAAK,CACX,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAE3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAAgB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,OAAO,GAAc,IAAI,CAAC,eAAe,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,cAAc;aACf,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,MAAM,IAAI,CAAC,MAAM,CAAC;gBAChB,SAAS;gBACT,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC9C,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC/C,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,OAAO;gBACP,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,eAAe,EAAE,QAAS,CAAC,eAAe;aAC3C,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CAA2B,IAKnD;QACC,IAAI,CAAC;YACH,MAAM,SAAS,GAAyB,IAAI,CAAC,gBAAgB,CAC3D,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,KAAK,CACX,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAE3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAAgB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,OAAO,GAAc,IAAI,CAAC,oBAAoB,CAAC;gBACnD,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,cAAc;gBACd,QAAQ,EAAE,UAAU;aACrB,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,MAAM,CAAC;gBAChB,SAAS;gBACT,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC9C,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC;gBACpD,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,OAAO;gBACP,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,eAAe,EAAE,QAAS,CAAC,eAAe;aAC3C,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,MASpB;QACC,MAAM,QAAQ,GAAa,IAAI,QAAQ,EAAE,CAAC;QAC1C,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACtC,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC5C,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QAC1C,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC9C,CAAC;QACD,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAEhC,MAAM,KAAK,GAKP,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE1C,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QACjC,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,QAAQ,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QACrC,CAAC;QAED,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAClC,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAE3E,MAAM,IAAI,CAAC,MAAM,CAAC;YAChB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAEO,oBAAoB,CAAC,eAAuB;QAClD,MAAM,IAAI,GAAW,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACtE,OAAO,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAEO,UAAU,CAChB,QAAsC,EACtC,MAAsC;QAEtC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,mBAAmB,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC,QAAQ,KAAK,QAAQ,CAAC,UAAU,CAAC;QACnD,CAAC;QAED;;;WAGG;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,SAAmB;;QAEnB,MAAM,GAAG,GAAW,SAAS,CAAC,QAAQ,EAAE,CAAC;QACzC,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,MAAM,GACV,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC;YACrC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,OAAO,GAAmB,MAAM,cAAc,CAAC,WAAW,CAAC;YAC/D,EAAE,EAAE,SAAS;YACb,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,eAAe,EAAE,IAAI;gBACrB,wBAAwB,EAAE,IAAI;gBAC9B,QAAQ,EAAE,IAAI;aACf;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAA0B;YACtC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;YACjD,eAAe,EAAE,MAAA,OAAO,CAAC,wBAAwB,mCAAI,CAAC;YACtD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,SAAS,EAAE,GAAG,GAAG,6BAA6B;SAC/C,CAAC;QAEF,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,KAAqC;;QAM9D,MAAM,QAAQ,GAAkB,KAAK,CAAC,QAAQ;YAC5C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YACxB,CAAC,CAAC,KAAK,CAAC,MAAM;gBACZ,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,IAAI,CAAC;QAEX,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClB,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,IAAI;gBACf,QAAQ;aACT,CAAC;QACJ,CAAC;QAED,uDAAuD;QACvD,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpC,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,IAAI;gBACf,QAAQ;aACT,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GACV,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvC,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,QAAQ,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,IAAI;YAC9B,SAAS,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,IAAI;YAChC,QAAQ;SACT,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,MAAgB;;QAEhB,MAAM,GAAG,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,MAAM,GAA2B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE/D,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC;YACrC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,GAAgB,MAAM,WAAW,CAAC,WAAW,CAAC;YACtD,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;YAC9C,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAkB,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,0CAAE,QAAQ,EAAE,mCAAI,IAAI,CAAC;QAC3D,MAAM,KAAK,GAAkB,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,QAAQ,EAAE,mCAAI,IAAI,CAAC;QAE7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE;YACtB,IAAI;YACJ,KAAK;YACL,SAAS,EAAE,GAAG,GAAG,iBAAiB;SACnC,CAAC,CAAC;QAEH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACzB,CAAC;IAEO,gBAAgB,CACtB,KAAa,EACb,IAAY,EACZ,KAAqC;QAErC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO,KAAK,CAAC,QAAQ,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAkB,KAAK,CAAC,eAAe,EAAE,CAAC;QAC5D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,KAAK,GAAyB,IAAI,CAAC,QAAQ,CAAW,YAAY,CAAC,CAAC;QAC1E,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,SAAS,CAAC;IAC5B,CAAC;IAEO,iBAAiB,CACvB,KAAa;QAEb,MAAM,QAAQ,GAAgB,IAAI,GAAG,EAAU,CAAC;QAChD,MAAM,gBAAgB,GACpB,mCAAmC,CAAC,KAAK,CAExC,CAAC;QAEJ,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAChD,MAAM,EAAE,GAAqC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACnE,IAAI,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzD,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,oBAAoB,CAA2B,IAItD;QACC,MAAM,OAAO,GAAc,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAkB,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC;QAEpE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,SAAS;YACX,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,SAAS;YACX,CAAC;YAED,MAAM,KAAK,GAAa,IAAI,CAAC,KAA4C,CACvE,MAAM,CACP,CAAC;YAEF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YAED,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;aAC9B,CAAC,CAAC;QACnB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,eAAe,CAA2B,IAIjD;QACC,MAAM,OAAO,GAAc,EAAE,CAAC;QAE9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACpD,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,SAAS;YACX,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAY,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,QAAQ,GACZ,IAAI,CAAC,MACN,CAAC,KAAK,CAAC,CAAC;YAET,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC5C,SAAS;YACX,CAAC;YAED,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK;gBACL,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACvC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;aAC1B,CAAC,CAAC;QACnB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,cAAc,CAAC,CAAU,EAAE,CAAU;QAC3C,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,KAAc;QACnC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,CAAC;QACD,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,EAC1B,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3C,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,eAAe,CAA2B,KAAa;QAC7D,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC,YAAY,CAAC;QAC5B,CAAC;QACD,OAAQ,KAAsD,CAAC,WAAW;aACvE,IAAI,CAAC;IACV,CAAC;IAEO,eAAe,CACrB,IAAY;QAEZ,KAAK,MAAM,KAAK,IAAI,qBAAqB,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAkB,IAAI,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAa,IAA2C,CACjE,KAAK,CACN,CAAC;YACF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,eAAe,IAAI,eAAe,EAAE,CAAC"}

package/build/dist/Server/Services/DatabaseService.js

@@ -25,6 +25,7 @@ import ModelPermission from "../Types/Database/Permissions/Index";
 import QueryHelper from "../Types/Database/QueryHelper";
 import Encryption from "../Utils/Encryption";
 import logger from "../Utils/Logger";
+import AuditLogService from "./AuditLogService";
 import BaseService from "./BaseService";
 import BaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import { WorkflowRoute } from "../../ServiceRoute";
@@ -464,7 +465,7 @@ class DatabaseService extends BaseService {
         }
     }
     async create(createBy) {
-        var _a;
+        var _a, _b;
         const onCreate = createBy.props.ignoreHooks
             ? { createBy, carryForward: [] }
             : await this._onBeforeCreate(createBy);
@@ -514,6 +515,14 @@ class DatabaseService extends BaseService {
             if (tenantId) {
                 await this.onTriggerRealtime(createBy.data.id, tenantId, ModelEventType.Create);
             }
+            if (!createBy.props.ignoreHooks &&
+                ((_b = this.getModel().enableAuditLogOn) === null || _b === void 0 ? void 0 : _b.create)) {
+                await AuditLogService.recordCreate({
+                    model: this.getModel(),
+                    createdItem: createBy.data,
+                    props: createBy.props,
+                });
+            }
             return createBy.data;
         }
         catch (error) {
@@ -720,7 +729,7 @@ class DatabaseService extends BaseService {
         }
     }
     async _deleteBy(deleteBy) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         try {
             if (this.doNotAllowDelete && !deleteBy.props.isRoot) {
                 throw new BadDataException("Delete not allowed");
@@ -741,6 +750,16 @@ class DatabaseService extends BaseService {
             if (this.getModel().getTenantColumn()) {
                 select[this.getModel().getTenantColumn()] = true;
             }
+            /*
+             * If audit logging on delete is enabled, fetch all scalar columns so we
+             * can record a full snapshot of the record before it is deleted.
+             */
+            if ((_a = this.getModel().enableAuditLogOn) === null || _a === void 0 ? void 0 : _a.delete) {
+                const allColumns = this.getModel().getTableColumns().columns;
+                for (const columnName of allColumns) {
+                    select[columnName] = true;
+                }
+            }
             const items = await this._findBy({
                 query: beforeDeleteBy.query,
                 skip: beforeDeleteBy.skip.toNumber(),
@@ -780,10 +799,10 @@ class DatabaseService extends BaseService {
                     (await this.getRepository().delete(query)).affected || 0;
             }
             // hit workflow.
-            if (((_a = this.getModel().enableWorkflowOn) === null || _a === void 0 ? void 0 : _a.delete) &&
+            if (((_b = this.getModel().enableWorkflowOn) === null || _b === void 0 ? void 0 : _b.delete) &&
                 (deleteBy.props.tenantId || this.getModel().getTenantColumn())) {
                 for (const item of items) {
-                    if ((_b = this.getModel().enableWorkflowOn) === null || _b === void 0 ? void 0 : _b.create) {
+                    if ((_c = this.getModel().enableWorkflowOn) === null || _c === void 0 ? void 0 : _c.create) {
                         let tenantId = deleteBy.props.tenantId;
                         if (!tenantId && this.getModel().getTenantColumn()) {
                             tenantId = item.getValue(this.getModel().getTenantColumn());
@@ -800,6 +819,18 @@ class DatabaseService extends BaseService {
                     return new ObjectID(i._id);
                 }));
             }
+            if (((_d = this.getModel().enableAuditLogOn) === null || _d === void 0 ? void 0 : _d.delete) && items.length > 0) {
+                for (const item of items) {
+                    if (item.id) {
+                        await AuditLogService.recordDelete({
+                            model: this.getModel(),
+                            deletedItem: item,
+                            itemId: item.id,
+                            props: deleteBy.props,
+                        });
+                    }
+                }
+            }
             return numberOfDocsAffected;
         }
         catch (error) {
@@ -986,7 +1017,7 @@ class DatabaseService extends BaseService {
         });
     }
     async _updateBy(updateBy) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         try {
             const onUpdate = updateBy.props.ignoreHooks
                 ? { updateBy, carryForward: [] }
@@ -1018,6 +1049,24 @@ class DatabaseService extends BaseService {
                 selectColumns[this.getModel().getTenantColumn().toString()] =
                     true;
             }
+            /*
+             * When audit logging on update is enabled, ensure the resource's display
+             * name is loaded on the `before` snapshot so the audit entry records the
+             * human-readable resource name even when the update doesn't touch it.
+             */
+            if ((_a = this.getModel().enableAuditLogOn) === null || _a === void 0 ? void 0 : _a.update) {
+                const nameCandidates = [
+                    "name",
+                    "title",
+                    "displayName",
+                ];
+                const modelColumns = this.getModel().getTableColumns().columns;
+                for (const candidate of nameCandidates) {
+                    if (modelColumns.includes(candidate)) {
+                        selectColumns[candidate] = true;
+                    }
+                }
+            }
             const items = await this._findBy({
                 query: beforeUpdateBy.query,
                 skip: updateBy.skip.toNumber(),
@@ -1028,14 +1077,14 @@ class DatabaseService extends BaseService {
             for (const item of items) {
                 const updatedItem = Object.assign({ _id: item._id }, data);
                 logger.debug("Updated Item", {
-                    projectId: (_a = updateBy.props.tenantId) === null || _a === void 0 ? void 0 : _a.toString(),
+                    projectId: (_b = updateBy.props.tenantId) === null || _b === void 0 ? void 0 : _b.toString(),
                 });
                 logger.debug(JSON.stringify(updatedItem, null, 2), {
-                    projectId: (_b = updateBy.props.tenantId) === null || _b === void 0 ? void 0 : _b.toString(),
+                    projectId: (_c = updateBy.props.tenantId) === null || _c === void 0 ? void 0 : _c.toString(),
                 });
                 await this.getRepository().save(updatedItem);
                 // hit workflow.
-                if (((_c = this.getModel().enableWorkflowOn) === null || _c === void 0 ? void 0 : _c.update) &&
+                if (((_d = this.getModel().enableWorkflowOn) === null || _d === void 0 ? void 0 : _d.update) &&
                     // Only trigger workflow if there's a change in values
                     !this.hasSameValues({ item, updatedItem })) {
                     let tenantId = updateBy.props.tenantId;
@@ -1049,6 +1098,17 @@ class DatabaseService extends BaseService {
                         await this.onTriggerRealtime(item.id, tenantId, ModelEventType.Update);
                     }
                 }
+                if (((_e = this.getModel().enableAuditLogOn) === null || _e === void 0 ? void 0 : _e.update) &&
+                    !this.hasSameValues({ item, updatedItem }) &&
+                    item.id) {
+                    await AuditLogService.recordUpdate({
+                        model: this.getModel(),
+                        before: item,
+                        updatedFields: data,
+                        itemId: item.id,
+                        props: updateBy.props,
+                    });
+                }
             }
             /*
              * Cant Update relations.