@autofleet/shtinker 1.2.3-beta.5 → 1.2.3

package/dist/audit-logger.d.ts

@@ -1,4 +1,5 @@
 import { AuditLogPayload, AuditLoggerOptions, AuditLogContext } from './types';
+export declare const isEntityIdRequired: (action: string) => boolean;
 declare class AuditLogger {
     private rabbit;
     private sequelize;

package/dist/audit-logger.js

@@ -12,11 +12,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEntityIdRequired = void 0;
 const zehut_1 = require("@autofleet/zehut");
 const lodash_1 = require("lodash");
+const types_1 = require("./types");
 const const_1 = require("./const");
 const logger_1 = __importDefault(require("./logger"));
 const CUSTOM_FIELDS_PROPERTY = 'customFields';
+const getAuditContext = () => {
+    var _a;
+    const currentTrace = (0, zehut_1.getCurrentPayload)();
+    const auditContext = (_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get(const_1.AUDIT_LOG_CONTEXT_KEY);
+    return auditContext;
+};
+const ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {
+    [types_1.Action.BULK_CREATE]: types_1.Action.BULK_CREATE,
+    [types_1.Action.BULK_EDIT]: types_1.Action.BULK_EDIT,
+    [types_1.Action.BULK_ASSIGN]: types_1.Action.BULK_ASSIGN,
+    [types_1.Action.BULK_DISPATCH]: types_1.Action.BULK_DISPATCH,
+    [types_1.Action.BULK_UPSERT]: types_1.Action.BULK_UPSERT,
+};
 const isEmpty = (field) => {
     if ([null, undefined].includes(field)) {
         return true;
@@ -29,6 +44,8 @@ const isEmpty = (field) => {
     }
     return false;
 };
+const isEntityIdRequired = (action) => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];
+exports.isEntityIdRequired = isEntityIdRequired;
 const filterOutEmptyFields = (fields, instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
 const getChangedFieldsRows = (instance, options) => {
     // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
@@ -69,14 +86,11 @@ class AuditLogger {
     registerHooks() {
         Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
             modelType.addHook('afterSave', (instance, options) => __awaiter(this, void 0, void 0, function* () {
-                var _a;
                 try {
-                    const currentTrace = (0, zehut_1.getCurrentPayload)();
-                    const auditContext = (_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get(const_1.AUDIT_LOG_CONTEXT_KEY);
+                    const auditContext = getAuditContext();
                     if (auditContext) {
-                        if (!auditContext.action.includes('bulk')) {
+                        if ((0, exports.isEntityIdRequired)(auditContext.action)) {
                             auditContext.entityId = instance.id;
-                            currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditContext);
                         }
                         const changedFieldsRows = getChangedFieldsRows(instance, options);
                         const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Request, Response, NextFunction } from 'express';
+import type { Request, Response, NextFunction } from 'express';
 import AuditLogger from './audit-logger';
 import { AuditLoggerOptions } from './types';
 export declare const enableAuditing: (options: AuditLoggerOptions) => void;

package/dist/index.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -28,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setRabbitAuditContext = exports.setAuditContext = exports.enableAuditing = void 0;
 const zehut_1 = require("@autofleet/zehut");
-const audit_logger_1 = __importDefault(require("./audit-logger"));
+const audit_logger_1 = __importStar(require("./audit-logger"));
 const const_1 = require("./const");
 const audit_api_1 = __importDefault(require("./audit-api"));
 const logger_1 = __importDefault(require("./logger"));
@@ -42,16 +54,16 @@ const enableAuditing = (options) => {
 };
 exports.enableAuditing = enableAuditing;
 const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d;
+    var _a, _b;
     try {
         const currentTrace = (0, zehut_1.getCurrentPayload)();
         if (process.env.DISABLE_AUDIT_LOGS === 'true' || !((_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get)) {
             return next();
         }
-        const user = (_c = (_b = currentTrace.context).get) === null || _c === void 0 ? void 0 : _c.call(_b, const_1.USER_CONTEXT_KEY);
+        const user = currentTrace.context.get(const_1.USER_CONTEXT_KEY);
         const { performedBy, actionOrigin } = (user === null || user === void 0 ? void 0 : user.id)
             ? { performedBy: user.id, actionOrigin: "user" /* ActionOrigin.USER */ }
-            : { performedBy: (_d = req.headers[const_1.AUTOMATION_ID_HEADER]) !== null && _d !== void 0 ? _d : null, actionOrigin: req.headers[const_1.AUTOMATION_ID_HEADER] ? "automation" /* ActionOrigin.AUTOMATION */ : null };
+            : { performedBy: (_b = req.headers[const_1.AUTOMATION_ID_HEADER]) !== null && _b !== void 0 ? _b : null, actionOrigin: req.headers[const_1.AUTOMATION_ID_HEADER] ? "automation" /* ActionOrigin.AUTOMATION */ : null };
         const auditLogContext = {
             entityType,
             action,
@@ -67,7 +79,7 @@ const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(vo
             res.off('error', sendAuditLogContextEvent);
             yield auditLogger.sendAuditLogContext(auditLogContext);
         });
-        if (action.includes('bulk')) { // if it's a bulk action, we don't want to wait for the response to add the entity id
+        if (!(0, audit_logger_1.isEntityIdRequired)(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id
             yield auditLogger.sendAuditLogContext(auditLogContext);
         }
         else {
@@ -83,12 +95,12 @@ const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(vo
 });
 exports.setAuditContext = setAuditContext;
 const setRabbitAuditContext = (entityType, action) => (endpoint, { userId, automationId }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _e;
+    var _c;
     if (process.env.DISABLE_AUDIT_LOGS === 'true') {
         return;
     }
     const currentTrace = (0, zehut_1.getCurrentPayload)();
-    if ((_e = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _e === void 0 ? void 0 : _e.get) {
+    if ((_c = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _c === void 0 ? void 0 : _c.get) {
         const { performedBy, actionOrigin } = userId
             ? { performedBy: userId, actionOrigin: "user" /* ActionOrigin.USER */ }
             : { performedBy: automationId !== null && automationId !== void 0 ? automationId : null, actionOrigin: automationId ? "automation" /* ActionOrigin.AUTOMATION */ : null };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/shtinker",
-  "version": "1.2.3-beta.5",
+  "version": "1.2.3",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -35,7 +35,7 @@
     "typescript": "^4.9.5"
   },
   "peerDependencies": {
-    "@autofleet/zehut": "3.1.2-beta.5"
+    "@autofleet/zehut": "^3.x"
   },
   "author": "Autofleet",
   "license": "ISC"

package/src/audit-logger.ts

@@ -1,14 +1,28 @@
 import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
 import { Sequelize } from 'sequelize';
 import { isEqual } from 'lodash';
-
-import { AuditLogPayload, AuditLoggerOptions, AuditLogContext } from './types';
+import {
+  AuditLogPayload, AuditLoggerOptions, AuditLogContext, Action,
+} from './types';
 import { AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUDIT_LOG_CONTEXT_KEY } from './const';
-
 import logger from './logger';
 
 const CUSTOM_FIELDS_PROPERTY = 'customFields';
 
+const getAuditContext = () => {
+  const currentTrace = getCurrentTrace();
+  const auditContext = currentTrace?.context?.get(AUDIT_LOG_CONTEXT_KEY);
+  return auditContext;
+};
+
+const ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {
+  [Action.BULK_CREATE]: Action.BULK_CREATE,
+  [Action.BULK_EDIT]: Action.BULK_EDIT,
+  [Action.BULK_ASSIGN]: Action.BULK_ASSIGN,
+  [Action.BULK_DISPATCH]: Action.BULK_DISPATCH,
+  [Action.BULK_UPSERT]: Action.BULK_UPSERT,
+};
+
 const isEmpty = (field) => {
   if ([null, undefined].includes(field)) {
     return true;
@@ -22,6 +36,8 @@ const isEmpty = (field) => {
   return false;
 };
 
+export const isEntityIdRequired = (action: string): boolean => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];
+
 const filterOutEmptyFields = (fields: string[], instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
 
 const getChangedFieldsRows = (instance, options) => {
@@ -74,12 +90,10 @@ class AuditLogger {
     Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
       modelType.addHook('afterSave', async (instance: any, options: any) => {
         try {
-          const currentTrace = getCurrentTrace();
-          const auditContext = currentTrace?.context?.get(AUDIT_LOG_CONTEXT_KEY);
+          const auditContext = getAuditContext();
           if (auditContext) {
-            if (!auditContext.action.includes('bulk')) {
+            if (isEntityIdRequired(auditContext.action)) {
               auditContext.entityId = instance.id;
-              currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditContext);
             }
             const changedFieldsRows = getChangedFieldsRows(instance, options);
             const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);

package/src/index.ts

@@ -1,6 +1,6 @@
 import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
-import { Request, Response, NextFunction } from 'express';
-import AuditLogger from './audit-logger';
+import type { Request, Response, NextFunction } from 'express';
+import AuditLogger, { isEntityIdRequired } from './audit-logger';
 import { ActionOrigin, AuditLogContext, AuditLoggerOptions } from './types';
 import { AUDIT_LOG_CONTEXT_KEY, AUTOMATION_ID_HEADER, USER_CONTEXT_KEY } from './const';
 import addAuditApi from './audit-api';
@@ -25,7 +25,7 @@ export const setAuditContext = (
     if (process.env.DISABLE_AUDIT_LOGS === 'true' || !currentTrace?.context?.get) {
       return next();
     }
-    const user = currentTrace.context.get?.(USER_CONTEXT_KEY);
+    const user = currentTrace.context.get(USER_CONTEXT_KEY);
     const { performedBy, actionOrigin } = user?.id
       ? { performedBy: user.id, actionOrigin: ActionOrigin.USER }
       : { performedBy: req.headers[AUTOMATION_ID_HEADER] ?? null, actionOrigin: req.headers[AUTOMATION_ID_HEADER] ? ActionOrigin.AUTOMATION : null };
@@ -46,7 +46,7 @@ export const setAuditContext = (
       res.off('error', sendAuditLogContextEvent);
       await auditLogger.sendAuditLogContext(auditLogContext);
     };
-    if (action.includes('bulk')) { // if it's a bulk action, we don't want to wait for the response to add the entity id
+    if (!isEntityIdRequired(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id
       await auditLogger.sendAuditLogContext(auditLogContext);
     } else {
       res.once('finish', sendAuditLogContextEvent);