@autofleet/shtinker 1.1.5-beta.9 → 1.1.6-beta-1

package/dist/audit-logger.js

@@ -18,17 +18,27 @@ const logger_1 = __importDefault(require("./logger"));
 const getAuditContext = () => {
     var _a;
     const currentTrace = (0, zehut_1.getCurrentPayload)();
-    logger_1.default.info('MATAN getAuditContext currentTrace: ', { currentTrace });
     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 isEmpty = (field) => {
+    if ([null, undefined].includes(field)) {
+        return true;
+    }
+    if (Array.isArray(field)) {
+        return field.length === 0;
+    }
+    if (typeof field === 'object' && !(field instanceof Date)) {
+        return Object.keys(field).length === 0;
+    }
+    return false;
+};
+const filterOutEmptyFields = (fields, instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
 const getChangedFields = (instance, options) => {
     // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
     // It's a known issut with sequelize.
-    if (options.returning) {
-        return options.fields;
-    }
-    return instance.changed();
+    const changedProperties = options.returning ? options.fields : instance.changed();
+    return filterOutEmptyFields(changedProperties, instance);
 };
 class AuditLogger {
     constructor(options) {
@@ -41,10 +51,8 @@ class AuditLogger {
             modelType.addHook('afterSave', (instance, options) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const auditContext = getAuditContext();
-                    logger_1.default.info('MATAN auditContext: ', { auditContext });
                     if (auditContext) {
                         const changedProperties = getChangedFields(instance, options);
-                        logger_1.default.info('MATAN changedProperties from shtinker:', { changedProperties });
                         const payload = {
                             entityType: modelName,
                             entityId: instance.id,
@@ -54,8 +62,6 @@ class AuditLogger {
                                 newValue: instance.get(property),
                             })),
                         };
-                        const entityId = instance.id;
-                        logger_1.default.info('MATAN entityId from shtinker:', { entityId });
                         this.sendAuditLogRows(payload);
                     }
                 }
@@ -78,7 +84,6 @@ class AuditLogger {
     sendAuditLogRows(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                logger_1.default.info('MATAN sendAuditLogRows from shtinker: ', { payload });
                 yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_ROWS_QUEUE, payload);
             }
             catch (err) {

package/dist/index.js

@@ -29,6 +29,7 @@ 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 types_1 = require("./types");
 const const_1 = require("./const");
 const audit_api_1 = __importDefault(require("./audit-api"));
 const logger_1 = __importDefault(require("./logger"));
@@ -42,15 +43,18 @@ exports.enableAuditing = enableAuditing;
 const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const currentTrace = (0, zehut_1.getCurrentPayload)();
-        logger_1.default.info('currentTrace: ', { currentTrace });
         if (currentTrace && currentTrace.context && currentTrace.context.get) {
             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: types_1.ActionOrigin.USER }
+                : { performedBy: req.headers['x-af-automation-id'], actionOrigin: types_1.ActionOrigin.AUTOMATION };
             const auditLogContext = {
                 entityType,
                 action,
                 endpoint: req.url,
                 method: req.method,
-                performedBy: user === null || user === void 0 ? void 0 : user.id,
+                performedBy,
+                actionOrigin,
             };
             currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditLogContext);
             yield auditLogger.sendAuditLogContext(auditLogContext);
@@ -65,7 +69,6 @@ exports.setAuditContext = setAuditContext;
 const setRabbitAuditContext = (entityType, action) => (endpoint) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     const currentTrace = (0, zehut_1.getCurrentPayload)();
-    logger_1.default.info('MATAN currentTrace: ', currentTrace);
     if ((_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get) {
         const user = currentTrace.context.get(const_1.USER_CONTEXT_KEY);
         const auditLogContext = {

package/dist/logger.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("winston").Logger;
+declare const _default: import("@autofleet/logger").LoggerInstanceManager;
 export default _default;

package/dist/types.d.ts

@@ -11,6 +11,7 @@ export interface AuditLogContext {
     performedBy: string;
     endpoint: string;
     method: string;
+    actionOrigin?: string;
 }
 export interface AuditLogRow {
     property: string;
@@ -46,3 +47,7 @@ export declare enum EntityType {
     DRIVER = "Driver",
     PRICE_CALCULATION = "PriceCalculation"
 }
+export declare enum ActionOrigin {
+    USER = "user",
+    AUTOMATION = "automation"
+}

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityType = exports.Action = void 0;
+exports.ActionOrigin = exports.EntityType = exports.Action = void 0;
 var Action;
 (function (Action) {
     Action["CREATE"] = "create";
@@ -27,3 +27,8 @@ var EntityType;
     EntityType["DRIVER"] = "Driver";
     EntityType["PRICE_CALCULATION"] = "PriceCalculation";
 })(EntityType = exports.EntityType || (exports.EntityType = {}));
+var ActionOrigin;
+(function (ActionOrigin) {
+    ActionOrigin["USER"] = "user";
+    ActionOrigin["AUTOMATION"] = "automation";
+})(ActionOrigin = exports.ActionOrigin || (exports.ActionOrigin = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/shtinker",
-  "version": "1.1.5-beta.9",
+  "version": "1.1.6-beta-1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -13,10 +13,11 @@
   },
   "dependencies": {
     "@autofleet/errors": "^1.2.2",
-    "@autofleet/logger": "^2.0.5",
+    "@autofleet/logger": "^4.0.6",
     "@autofleet/network": "^1.4.7",
-    "@autofleet/rabbit": "3.2.14-beta.7",
-    "@autofleet/zehut": "3.0.8",
+    "@autofleet/netwrok": "^1.0.0",
+    "@autofleet/rabbit": "^3.2.18",
+    "@autofleet/zehut": "^3.0.10",
     "sequelize-typescript": "^2.1.5"
   },
   "devDependencies": {

package/src/audit-logger.ts

@@ -8,18 +8,30 @@ import logger from './logger';
 
 const getAuditContext = () => {
   const currentTrace = getCurrentTrace();
-  logger.info('MATAN getAuditContext currentTrace: ', { currentTrace });
   const auditContext = currentTrace?.context?.get(AUDIT_LOG_CONTEXT_KEY);
   return auditContext;
 };
 
+const isEmpty = (field) => {
+  if ([null, undefined].includes(field)) {
+    return true;
+  }
+  if (Array.isArray(field)) {
+    return field.length === 0;
+  }
+  if (typeof field === 'object' && !(field instanceof Date)) {
+    return Object.keys(field).length === 0;
+  }
+  return false;
+};
+
+const filterOutEmptyFields = (fields, instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
+
 const getChangedFields = (instance, options) => {
   // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
   // It's a known issut with sequelize.
-  if (options.returning) {
-    return options.fields;
-  }
-  return instance.changed();
+  const changedProperties = options.returning ? options.fields : instance.changed();
+  return filterOutEmptyFields(changedProperties, instance);
 };
 
 class AuditLogger {
@@ -40,10 +52,8 @@ class AuditLogger {
       modelType.addHook('afterSave', async (instance: any, options: any) => {
         try {
           const auditContext = getAuditContext();
-          logger.info('MATAN auditContext: ', { auditContext });
           if (auditContext) {
             const changedProperties = getChangedFields(instance, options);
-            logger.info('MATAN changedProperties from shtinker:', { changedProperties });
             const payload: AuditLogPayload = {
               entityType: modelName,
               entityId: instance.id,
@@ -53,8 +63,6 @@ class AuditLogger {
                 newValue: instance.get(property),
               })),
             };
-            const entityId = instance.id;
-            logger.info('MATAN entityId from shtinker:', { entityId });
             this.sendAuditLogRows(payload);
           }
         } catch (error) {
@@ -74,7 +82,6 @@ class AuditLogger {
 
   async sendAuditLogRows(payload: AuditLogPayload): Promise<void> {
     try {
-      logger.info('MATAN sendAuditLogRows from shtinker: ', { payload });
       await this.rabbit.sendToQueue(AUDIT_LOG_ROWS_QUEUE, payload);
     } catch (err) {
       logger.error('Failed to send audit log rows', err);

package/src/index.ts

@@ -1,6 +1,6 @@
 import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
 import AuditLogger from './audit-logger';
-import { AuditLogContext, AuditLoggerOptions } from './types';
+import { ActionOrigin, AuditLogContext, AuditLoggerOptions } from './types';
 import { AUDIT_LOG_CONTEXT_KEY, USER_CONTEXT_KEY } from './const';
 import addAuditApi from './audit-api';
 import logger from './logger';
@@ -19,15 +19,18 @@ export const setAuditContext = (
 ) => async (req: any, res: any, next: any): Promise<any> => {
   try {
     const currentTrace = getCurrentTrace();
-    logger.info('currentTrace: ', { currentTrace });
     if (currentTrace && currentTrace.context && currentTrace.context.get) {
       const user = currentTrace.context.get(USER_CONTEXT_KEY);
+      const { performedBy, actionOrigin } = user?.id
+        ? { performedBy: user.id, actionOrigin: ActionOrigin.USER }
+        : { performedBy: req.headers['x-af-automation-id'], actionOrigin: ActionOrigin.AUTOMATION };
       const auditLogContext: AuditLogContext = {
         entityType,
         action,
         endpoint: req.url,
         method: req.method,
-        performedBy: user?.id,
+        performedBy,
+        actionOrigin,
       };
       currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);
       await auditLogger.sendAuditLogContext(auditLogContext);
@@ -43,7 +46,6 @@ export const setRabbitAuditContext = (
   action: string,
 ) => async (endpoint: string): Promise<any> => {
   const currentTrace = getCurrentTrace();
-  logger.info('MATAN currentTrace: ', currentTrace);
   if (currentTrace?.context?.get) {
     const user = currentTrace.context.get(USER_CONTEXT_KEY);
     const auditLogContext: AuditLogContext = {

package/src/types.ts

@@ -14,6 +14,7 @@ export interface AuditLogContext {
   performedBy: string;
   endpoint: string;
   method: string;
+  actionOrigin?: string;
 }
 
 export interface AuditLogRow {
@@ -53,3 +54,8 @@ export enum EntityType {
   DRIVER = 'Driver',
   PRICE_CALCULATION = 'PriceCalculation',
 }
+
+export enum ActionOrigin {
+  USER = 'user',
+  AUTOMATION = 'automation',
+}