@stamhoofd/backend 2.56.0 → 2.57.0

package/src/services/AuditLogService.ts

@@ -1,8 +1,8 @@
-import { ArrayDecoder, AutoEncoder, AutoEncoderPatchType, BooleanDecoder, DateDecoder, EnumDecoder, Field, IntegerDecoder, isPatchableArray, PatchableArray, StringDecoder } from '@simonbackx/simple-encoding';
-import { AuditLog, Group, Member, Registration } from '@stamhoofd/models';
-import { Address, AuditLogPatchItem, AuditLogReplacement, AuditLogReplacementType, AuditLogType, BooleanStatus, FinancialSupportSettings, MemberDetails, Parent, ParentTypeHelper, Platform, PlatformConfig } from '@stamhoofd/structures';
+import { AutoEncoder, AutoEncoderPatchType } from '@simonbackx/simple-encoding';
+import { AuditLog, Group, Member, Organization, Registration, Event } from '@stamhoofd/models';
+import { AuditLogReplacement, AuditLogReplacementType, AuditLogType, GroupType, MemberDetails, OrganizationMetaData, OrganizationPrivateMetaData, PlatformConfig, PlatformPrivateConfig } from '@stamhoofd/structures';
 import { Context } from '../helpers/Context';
-import { Formatter } from '@stamhoofd/utility';
+import { explainPatch } from './explainPatch';
 
 export type MemberAddedAuditOptions = {
     type: AuditLogType.MemberAdded;
@@ -24,42 +24,87 @@ export type MemberRegisteredAuditOptions = {
 };
 
 export type PlatformConfigChangeAuditOptions = {
-    type: AuditLogType.PlatformSettingChanged;
+    type: AuditLogType.PlatformSettingsChanged;
+} & ({
+    oldConfig: PlatformPrivateConfig;
+    patch: PlatformPrivateConfig | AutoEncoderPatchType<PlatformPrivateConfig>;
+} | {
     oldConfig: PlatformConfig;
     patch: PlatformConfig | AutoEncoderPatchType<PlatformConfig>;
+});
+
+export type OrganizationConfigChangeAuditOptions = {
+    type: AuditLogType.OrganizationSettingsChanged;
+    organization: Organization;
+} & ({
+    oldMeta: OrganizationMetaData;
+    patch: OrganizationMetaData | AutoEncoderPatchType<OrganizationMetaData>;
+} | {
+    oldMeta: OrganizationPrivateMetaData;
+    patch: OrganizationPrivateMetaData | AutoEncoderPatchType<OrganizationPrivateMetaData>;
+});
+
+export type EventAuditOptions = {
+    type: AuditLogType.EventAdded | AuditLogType.EventEdited | AuditLogType.EventDeleted;
+    event: Event;
+    oldData?: AutoEncoder;
+    patch?: AutoEncoder | AutoEncoderPatchType<AutoEncoder>;
 };
 
-export type AuditLogOptions = MemberAddedAuditOptions | MemberEditedAuditOptions | MemberRegisteredAuditOptions | PlatformConfigChangeAuditOptions;
+export type GroupAuditOptions = {
+    type: AuditLogType.GroupAdded | AuditLogType.GroupEdited | AuditLogType.GroupDeleted;
+    group: Group;
+    oldData?: AutoEncoder;
+    patch?: AutoEncoder | AutoEncoderPatchType<AutoEncoder>;
+};
+
+export type AuditLogOptions = GroupAuditOptions | EventAuditOptions | MemberAddedAuditOptions | MemberEditedAuditOptions | MemberRegisteredAuditOptions | PlatformConfigChangeAuditOptions | OrganizationConfigChangeAuditOptions;
 
 export const AuditLogService = {
     async log(options: AuditLogOptions) {
-        const userId = Context.optionalAuth?.user?.id ?? null;
-        const organizationId = Context.organization?.id ?? null;
+        try {
+            const userId = Context.optionalAuth?.user?.id ?? null;
+            const organizationId = Context.organization?.id ?? null;
 
-        const model = new AuditLog();
+            const model = new AuditLog();
 
-        model.type = options.type;
-        model.userId = userId;
-        model.organizationId = organizationId;
+            model.type = options.type;
+            model.userId = userId;
+            model.organizationId = organizationId;
 
-        if (options.type === AuditLogType.MemberRegistered) {
-            this.fillForMemberRegistered(model, options);
-        }
-        else if (options.type === AuditLogType.MemberUnregistered) {
-            this.fillForMemberRegistered(model, options);
-        }
-        else if (options.type === AuditLogType.MemberEdited) {
-            this.fillForMemberEdited(model, options);
-        }
-        else if (options.type === AuditLogType.MemberAdded) {
-            this.fillForMemberAdded(model, options);
+            if (options.type === AuditLogType.MemberRegistered) {
+                this.fillForMemberRegistered(model, options);
+            }
+            else if (options.type === AuditLogType.MemberUnregistered) {
+                this.fillForMemberRegistered(model, options);
+            }
+            else if (options.type === AuditLogType.MemberEdited) {
+                this.fillForMemberEdited(model, options);
+            }
+            else if (options.type === AuditLogType.MemberAdded) {
+                this.fillForMemberAdded(model, options);
+            }
+            else if (options.type === AuditLogType.PlatformSettingsChanged) {
+                this.fillForPlatformConfig(model, options);
+            }
+            else if (options.type === AuditLogType.OrganizationSettingsChanged) {
+                this.fillForOrganizationConfig(model, options);
+            }
+            else if (options.type === AuditLogType.EventAdded || options.type === AuditLogType.EventEdited || options.type === AuditLogType.EventDeleted) {
+                this.fillForEvent(model, options);
+            }
+            else if (options.type === AuditLogType.GroupAdded || options.type === AuditLogType.GroupEdited || options.type === AuditLogType.GroupDeleted) {
+                this.fillForGroup(model, options);
+            }
+
+            // In the future we might group these saves together in one query to improve performance
+            await model.save();
+
+            console.log('Audit log', model.id, options);
         }
-        else if (options.type === AuditLogType.PlatformSettingChanged) {
-            this.fillForPlatformConfig(model, options);
+        catch (e) {
+            console.error('Failed to save log', options, e);
         }
-
-        // In the future we might group these saves together in one query to improve performance
-        await model.save();
     },
 
     fillForMemberRegistered(model: AuditLog, options: MemberRegisteredAuditOptions) {
@@ -116,566 +161,72 @@ export const AuditLogService = {
     fillForPlatformConfig(model: AuditLog, options: PlatformConfigChangeAuditOptions) {
         model.objectId = null;
 
-        let word = 'Platforminstellingen';
-        let c = 2;
-        let id: string | null = null;
-
-        const changedProps = Object.keys(options.patch).filter((prop) => {
-            return !prop.startsWith('_') && options.patch[prop] && (!(options.patch[prop] instanceof PatchableArray) || options.patch[prop].changes.length > 0);
-        });
-
-        if (changedProps.length === 1) {
-            const prop = changedProps[0] as keyof PlatformConfig;
-            id = prop;
-
-            switch (prop) {
-                case 'financialSupport':
-                    word = options.oldConfig.financialSupport?.title || FinancialSupportSettings.defaultTitle;
-                    c = 2;
-                    break;
-
-                case 'dataPermission':
-                    word = 'De instellingen voor toestemming gegevensverzameling';
-                    c = 2;
-                    break;
-
-                case 'tags':
-                    word = 'De hierarchie';
-                    c = 1;
-                    break;
-
-                case 'premiseTypes':
-                    word = 'De soorten lokalen';
-                    c = 2;
-                    break;
-
-                case 'recordsConfiguration':
-                    word = 'De persoonsgegevens van leden';
-                    c = 2;
-                    break;
-
-                case 'defaultAgeGroups':
-                    word = 'De standaard leeftijdsgroepen';
-                    c = 2;
-                    break;
-
-                case 'responsibilities':
-                    word = 'De functies van leden';
-                    c = 2;
-                    break;
-
-                case 'membershipTypes':
-                    word = 'De aansluitingen en verzekeringen';
-                    c = 2;
-                    break;
-
-                case 'eventTypes':
-                    word = 'De soorten activiteiten';
-                    c = 2;
-                    break;
-
-                case 'featureFlags':
-                    word = 'Feature flags';
-                    c = 2;
-                    break;
-
-                case 'coverPhoto':
-                    word = 'De omslagfoto';
-                    c = 2;
-                    break;
-
-                case 'expandLogo':
-                case 'squareLogo':
-                case 'horizontalLogo':
-                    word = 'Het logo';
-                    c = 1;
-                    break;
-
-                case 'squareLogoDark':
-                case 'horizontalLogoDark':
-                    word = 'Het logo in donkere modus';
-                    c = 1;
-                    break;
-
-                case 'logoDocuments':
-                    word = 'Het logo op documenten';
-                    c = 1;
-                    break;
-
-                case 'privacy':
-                    word = 'Privacyinstellingen';
-                    c = 2;
-                    break;
-
-                case 'color':
-                    word = 'De huisstijkleur';
-                    c = 1;
-                    break;
-
-                case 'name':
-                    word = 'De naam van het platform';
-                    c = 1;
-                    break;
-            }
-        }
+        // Generate changes list
+        model.patchList = explainPatch(options.oldConfig, options.patch);
+    },
 
-        console.log('changedProps', changedProps, options.patch);
+    fillForOrganizationConfig(model: AuditLog, options: OrganizationConfigChangeAuditOptions) {
+        model.objectId = options.organization.id;
+        model.organizationId = options.organization.id;
 
         model.replacements = new Map([
             ['o', AuditLogReplacement.create({
-                id: id ?? undefined,
-                value: word,
-                count: c,
+                id: options.organization.id,
+                value: options.organization.name,
+                type: AuditLogReplacementType.Organization,
             })],
         ]);
 
         // Generate changes list
-        model.patchList = explainPatch(options.oldConfig, options.patch);
+        model.patchList = explainPatch(options.oldMeta, options.patch);
     },
-};
-
-export type PatchExplainer = {
-    key: string;
-    handler: (oldValue: unknown, value: unknown) => AuditLogPatchItem[];
-};
-
-function createStringChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if ((typeof oldValue !== 'string' && oldValue !== null) || (typeof value !== 'string' && value !== null)) {
-            return [];
-        }
-        if (oldValue === value) {
-            return [];
-        }
-        return [
-            AuditLogPatchItem.create({
-                key: key,
-                oldValue: oldValue ?? undefined,
-                value: value ?? undefined,
-            }),
-        ];
-    };
-}
-
-function createIntegerChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if ((typeof oldValue !== 'number' && oldValue !== null) || (typeof value !== 'number' && value !== null)) {
-            return [];
-        }
-        if (oldValue === value) {
-            return [];
-        }
-        return [
-            AuditLogPatchItem.create({
-                key: key,
-                oldValue: oldValue !== null ? Formatter.integer(oldValue) : undefined,
-                value: value !== null ? Formatter.integer(value) : undefined,
-            }),
-        ];
-    };
-}
-
-function createDateChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if ((!(oldValue instanceof Date) && oldValue !== null) || (!(value instanceof Date)) && value !== null) {
-            return [];
-        }
-
-        if (oldValue?.getTime() === value?.getTime()) {
-            return [];
-        }
-        return [
-            AuditLogPatchItem.create({
-                key: key,
-                oldValue: oldValue ? Formatter.dateNumber(oldValue, true) : undefined,
-                value: value ? Formatter.dateNumber(value, true) : undefined,
-            }),
-        ];
-    };
-}
-
-function createBooleanChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if (typeof oldValue !== 'boolean' && oldValue !== null) {
-            return [];
-        }
 
-        if (typeof value !== 'boolean' && value !== null) {
-            return [];
-        }
-
-        if (oldValue === value) {
-            return [];
-        }
+    fillForEvent(model: AuditLog, options: EventAuditOptions) {
+        model.objectId = options.event.id;
 
-        return [
-            AuditLogPatchItem.create({
-                key: key,
-                oldValue: oldValue === true ? 'Aangevinkt' : (oldValue === false ? 'Uitgevinkt' : undefined),
-                value: value === true ? 'Aangevinkt' : (value === false ? 'Uitgevinkt' : undefined),
-            }),
-        ];
-    };
-}
-
-function getAutoEncoderName(autoEncoder: unknown) {
-    if (typeof autoEncoder === 'string') {
-        return autoEncoder;
-    }
-
-    if (autoEncoder instanceof Parent) {
-        return autoEncoder.name + ` (${ParentTypeHelper.getName(autoEncoder.type)})`;
-    }
-
-    if (autoEncoder instanceof Address) {
-        return autoEncoder.shortString();
-    }
-
-    if (typeof autoEncoder === 'object' && autoEncoder !== null && 'name' in autoEncoder && typeof autoEncoder.name === 'string') {
-        return autoEncoder.name;
-    }
-    return null;
-}
-
-function createArrayChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if (!isPatchableArray(value)) {
-            // Not supported
-            return [];
+        if (options.patch) {
+            // Generate changes list
+            model.patchList = explainPatch(options.oldData ?? null, options.patch);
         }
-        if (!Array.isArray(oldValue)) {
-            // Not supported
-            return [];
-        }
-
-        const items: AuditLogPatchItem[] = [];
-        const createdIdSet = new Set<string>();
-
-        const keySingular = key.replace(/ies$/, 'y').replace(/s$/, '');
-
-        for (const { put } of value.getPuts()) {
-            if (!(put instanceof AutoEncoder)) {
-                // Not supported
-                continue;
-            }
-
-            // Little hack: detect PUT/DELETE behaviour:
-            let original = 'id' in put ? oldValue.find(v => v.id === put.id) : null;
-            if (original && !(original instanceof AutoEncoder)) {
-                // Not supported
-                original = null;
-            }
 
-            // Added a new parent
-            if (!original) {
-                items.push(
-                    AuditLogPatchItem.create({
-                        key: keySingular,
-                        value: getAutoEncoderName(put) || keySingular,
-                    }),
-                );
-            }
-
-            if ('id' in put && typeof put.id === 'string') {
-                createdIdSet.add(put.id);
-            }
-
-            items.push(
-                ...explainPatch(
-                    original ?? null,
-                    put,
-                ).map((i) => {
-                    i.name = getAutoEncoderName(put) || keySingular;
-                    return i;
-                }),
-            );
-        }
-
-        for (const patch of value.getPatches()) {
-            const original = oldValue.find(v => v.id === patch.id);
-            if (!original) {
-                // Not supported
-                continue;
-            }
-            if (!(original instanceof AutoEncoder)) {
-                // Not supported
-                continue;
-            }
-
-            items.push(
-                ...explainPatch(
-                    original,
-                    patch,
-                ).map((i) => {
-                    i.name = getAutoEncoderName(original) || keySingular;
-                    return i;
-                }),
-            );
-        }
-
-        for (const id of value.getDeletes()) {
-            if (typeof id !== 'string') {
-                continue;
-            }
-            const original = oldValue.find(v => v.id === id);
-            if (!original) {
-                // Not supported
-                continue;
-            }
-            if (!(original instanceof AutoEncoder)) {
-                // Not supported
-                continue;
-            }
-
-            if (createdIdSet.has(id)) {
-                // DELETE + PUT happened
-                continue;
-            }
-
-            items.push(
-                AuditLogPatchItem.create({
-                    key: keySingular,
-                    value: undefined,
-                    oldValue: getAutoEncoderName(original) || keySingular,
-                }),
-            );
-        }
-
-        if (value.getMoves().length > 0) {
-            items.push(
-                AuditLogPatchItem.create({
-                    key: '_order',
-                }),
-            );
-        }
-        return items;
-    };
-}
-
-function createSimpleArrayChangeHandler(key: string) {
-    return (oldValue: unknown, value: unknown) => {
-        if (!Array.isArray(oldValue)) {
-            // Not supported
-            return [];
-        }
-        const keySingular = key.replace(/ies$/, 'y').replace(/s$/, '');
-
-        if (Array.isArray(value)) {
-            if (!value.every(v => typeof v === 'string')) {
-                // Not supported
-                return [];
-            }
-            if (!oldValue.every(v => typeof v === 'string')) {
-                // Not supported
-                return [];
-            }
-
-            // Simple change
-            const valueStr = (value as string[]).join(', ');
-            const oldValueStr = (oldValue as string[]).join(', ');
-
-            if (valueStr === oldValueStr) {
-                return [];
-            }
-
-            return [
-                AuditLogPatchItem.create({
-                    key: keySingular,
-                    oldValue: oldValue.length ? oldValueStr : undefined,
-                    value: value.length ? valueStr : undefined,
-                }),
-            ];
-        }
-
-        if (!isPatchableArray(value)) {
-            // Not supported
-            return [];
-        }
-
-        const items: AuditLogPatchItem[] = [];
-        const createdIdSet = new Set<string>();
-
-        for (const { put } of value.getPuts()) {
-            if (typeof put !== 'string') {
-                // Not supported
-                continue;
-            }
-
-            // Little hack: detect PUT/DELETE behaviour:
-            const original = oldValue.find(v => v === put);
-
-            // Added a new parent
-            if (!original) {
-                items.push(
-                    AuditLogPatchItem.create({
-                        key: keySingular,
-                        value: put,
-                    }),
-                );
-            }
-            createdIdSet.add(put);
-        }
-
-        for (const id of value.getDeletes()) {
-            if (typeof id !== 'string') {
-                continue;
-            }
-
-            if (createdIdSet.has(id)) {
-                // DELETE + PUT happened
-                continue;
-            }
-
-            const original = oldValue.find(v => v === id);
-            if (!original || typeof original !== 'string') {
-                // Not supported
-                continue;
-            }
+        model.replacements = new Map([
+            ['e', AuditLogReplacement.create({
+                id: options.event.id,
+                value: options.event.name,
+                type: AuditLogReplacementType.Event,
+            })],
+        ]);
+    },
 
-            items.push(
-                AuditLogPatchItem.create({
-                    key: keySingular,
-                    value: undefined,
-                    oldValue: original,
-                }),
-            );
-        }
+    fillForGroup(model: AuditLog, options: GroupAuditOptions) {
+        model.objectId = options.group.id;
 
-        if (value.getMoves().length > 0) {
-            items.push(
-                AuditLogPatchItem.create({
-                    key: '_order',
-                }),
-            );
+        if (options.patch) {
+            // Generate changes list
+            model.patchList = explainPatch(options.oldData ?? null, options.patch);
         }
-        return items;
-    };
-}
-
-function getExplainerForField(field: Field<any>) {
-    if (field.decoder === StringDecoder || field.decoder instanceof EnumDecoder) {
-        return createStringChangeHandler(field.property);
-    }
-
-    if (field.decoder === DateDecoder) {
-        return createDateChangeHandler(field.property);
-    }
-
-    if (field.decoder === BooleanDecoder) {
-        return createBooleanChangeHandler(field.property);
-    }
-
-    if (field.decoder === IntegerDecoder) {
-        return createIntegerChangeHandler(field.property);
-    }
-
-    if (field.decoder instanceof ArrayDecoder && field.decoder.decoder === StringDecoder) {
-        return createSimpleArrayChangeHandler(field.property);
-    }
-
-    if (field.decoder instanceof ArrayDecoder) {
-        return createArrayChangeHandler(field.property);
-    }
-
-    if (field.decoder === BooleanStatus) {
-        return (oldValue: unknown, value: unknown) => {
-            if (value === undefined) {
-                return [];
-            }
-
-            const wasTrueOld = oldValue instanceof BooleanStatus ? oldValue.value : null;
-            const isTrue = value instanceof BooleanStatus ? value.value : null;
 
-            if (wasTrueOld === isTrue) {
-                return [];
-            }
-
-            return [
-                AuditLogPatchItem.create({
-                    key: field.property,
-                    oldValue: wasTrueOld === true ? 'Aangevinkt' : (wasTrueOld === false ? 'Uitgevinkt' : undefined),
-                    value: isTrue === true ? 'Aangevinkt' : (isTrue === false ? 'Uitgevinkt' : undefined),
-                }),
-            ];
-        };
-    }
-
-    if ((field.decoder as any).prototype instanceof AutoEncoder || field.decoder === AutoEncoder) {
-        return (oldValue: unknown, value: unknown) => {
-            if (!(value instanceof AutoEncoder) && value !== null) {
-                return [];
-            }
-
-            if (oldValue === value) {
-                return [];
-            }
-
-            if (!oldValue && getAutoEncoderName(value as AutoEncoder)) {
-                // Simplify addition
-                return [
-                    AuditLogPatchItem.create({
-                        key: field.property,
-                        value: getAutoEncoderName(value as AutoEncoder) || field.property,
-                    }),
-                ];
-            }
-
-            if (value === null) {
-                return [
-                    AuditLogPatchItem.create({
-                        key: field.property,
-                        oldValue: getAutoEncoderName(oldValue as AutoEncoder) || field.property,
-                    }),
-                ];
+        if (options.group.type === GroupType.WaitingList) {
+            // Change event type
+            switch (options.type) {
+                case AuditLogType.GroupAdded:
+                    model.type = AuditLogType.WaitingListAdded;
+                    break;
+                case AuditLogType.GroupEdited:
+                    model.type = AuditLogType.WaitingListEdited;
+                    break;
+                case AuditLogType.GroupDeleted:
+                    model.type = AuditLogType.WaitingListDeleted;
+                    break;
             }
-
-            return explainPatch(oldValue as AutoEncoder | null, value).map((i) => {
-                i.key = field.property + '.' + i.key;
-                return i;
-            });
-        };
-    }
-
-    // Simple addition/delete/change detection
-    return (oldValue: unknown, value: unknown) => {
-        if (value === undefined) {
-            return [];
-        }
-
-        if (oldValue === value) {
-            return [];
-        }
-
-        return [
-            AuditLogPatchItem.create({
-                key: field.property,
-            }),
-        ];
-    };
-}
-
-function explainPatch<T extends AutoEncoder>(original: T | null, patch: AutoEncoderPatchType<T> | T): AuditLogPatchItem[] {
-    const items: AuditLogPatchItem[] = [];
-
-    for (const key in patch) {
-        const field = original ? original.static.fields.find(f => f.property === key) : patch.static.fields.find(f => f.property === key);
-        if (!field) {
-            continue;
-        }
-
-        const oldValue = original?.[key] ?? null;
-        const value = patch[key];
-
-        if (patch.isPut() && key === 'id') {
-            continue;
-        }
-
-        const handler = getExplainerForField(field);
-        if (!handler) {
-            continue;
         }
 
-        items.push(...handler(oldValue, value));
-    }
-    return items;
-}
+        model.replacements = new Map([
+            ['g', AuditLogReplacement.create({
+                id: options.group.id,
+                value: options.group.settings.name,
+                type: AuditLogReplacementType.Group,
+            })],
+        ]);
+    },
+};