Skip to content

fix: keep undeclared columns out of the audit diff #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Romsik788 wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −42
Open

fix: keep undeclared columns out of the audit diff #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 25 additions & 40 deletions index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type {
import dayjs from 'dayjs'
import utc from 'dayjs/plugin/utc.js';

import { AdminForthPlugin, AllowedActionsEnum, AdminForthSortDirections, AdminForthDataTypes, HttpExtra, ActionCheckSource, Filters, afLogger, } from "adminforth";
import { AdminForthPlugin, AllowedActionsEnum, AdminForthSortDirections, AdminForthDataTypes, HttpExtra, ActionCheckSource, Filters, afLogger, isBackendOnly, stripBackendOnly } from "adminforth";
import { PluginOptions } from "./types.js";

dayjs.extend(utc);
Expand Down Expand Up @@ -99,12 +99,19 @@ export default class AuditLogPlugin extends AdminForthPlugin {
const recordId = data?.[recordIdFieldName] || oldRecord?.[recordIdFieldName];
const connector = this.adminforth.connectors[resource.dataSource];

const newRecord = action == AllowedActionsEnum.delete ? {} : (await connector.getRecordByPrimaryKey(resource, recordId)) || {};
if (action !== AllowedActionsEnum.delete) {
oldRecord = oldRecord ? JSON.parse(JSON.stringify(oldRecord)) : {};
} else {
oldRecord = data
}
const columnAccessCtx = {
adminUser: user,
resource,
meta: { pk: recordId, requestBody: extra?.body },
source: ActionCheckSource.ShowRequest,
adminforth: this.adminforth,
};

const rawNewRecord = action == AllowedActionsEnum.delete ? {} : (await connector.getRecordByPrimaryKey(resource, recordId)) || {};
const rawOldRecord = action == AllowedActionsEnum.delete ? data : (oldRecord || {});
// stripBackendOnly drops backendOnly values too, so the masking below compares the raw records
const newRecord = await stripBackendOnly({ ...rawNewRecord }, columnAccessCtx);
oldRecord = await stripBackendOnly({ ...rawOldRecord }, columnAccessCtx);

if (action !== AllowedActionsEnum.delete) {
const columnsNamesList = resource.columns.map((c) => c.name);
Expand All @@ -116,39 +123,17 @@ export default class AuditLogPlugin extends AdminForthPlugin {
});
}

const checks = await Promise.all(
resource.columns.map(async (c) => {
if (typeof c.backendOnly === "function") {
const result = await c.backendOnly({
adminUser: user,
resource,
meta: {},
source: ActionCheckSource.ShowRequest,
adminforth: this.adminforth,
});
return { col: c, result };
}
return { col: c, result: c.backendOnly ?? false };
})
);

const backendOnlyColumns = checks
.filter(({ result }) => result === true)
.map(({ col }) => col);

backendOnlyColumns.forEach((c) => {
if (JSON.stringify(oldRecord[c.name]) != JSON.stringify(newRecord[c.name])) {
if (action !== AllowedActionsEnum.delete) {
newRecord[c.name] = '<hidden value after>'
}
if (action !== AllowedActionsEnum.create) {
oldRecord[c.name] = '<hidden value before>'
}
} else {
delete oldRecord[c.name];
delete newRecord[c.name];
}
});
for (const c of resource.columns) {
if (!(await isBackendOnly(c, columnAccessCtx)) || JSON.stringify(rawOldRecord[c.name]) == JSON.stringify(rawNewRecord[c.name])) {
continue;
}
if (action !== AllowedActionsEnum.delete) {
newRecord[c.name] = '<hidden value after>'
}
if (action !== AllowedActionsEnum.create) {
oldRecord[c.name] = '<hidden value before>'
}
}

const { country, clientIp } = await this.getIpAndCountry(extra?.headers || {});

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"build": "tsc && rsync -av --exclude 'node_modules' custom dist/"
},
"peerDependencies": {
"adminforth": "^3.7.1"
"adminforth": "^3.18.0"
},
"release": {
"plugins": [
Expand Down Expand Up @@ -63,7 +63,7 @@
},
"devDependencies": {
"@types/node": "^22.10.7",
"adminforth": "^3.7.1",
"adminforth": "^3.18.0",
"semantic-release": "^24.2.1",
"semantic-release-slack-bot": "^4.0.2",
"typescript": "^5.7.3"
Expand Down