@autofleet/shtinker 1.2.0-beta.5 → 1.2.1-beta

package/dist/audit-logger.js

@@ -13,10 +13,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const zehut_1 = require("@autofleet/zehut");
-const lodash_1 = require("lodash");
 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)();
@@ -36,41 +34,17 @@ const isEmpty = (field) => {
     return false;
 };
 const filterOutEmptyFields = (fields, instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
-const getChangedFieldsRows = (instance, options) => {
+const getChangedFields = (instance, options) => {
     // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
-    // It's a known issue with sequelize.
-    const changedFields = options.returning ? options.fields : instance.changed();
-    // Filter customFields - we'll handle them later
-    const filteredChangedFields = filterOutEmptyFields(changedFields.filter((field) => field !== CUSTOM_FIELDS_PROPERTY), instance);
-    return filteredChangedFields.map((property) => ({
-        property,
-        previousValue: instance.previous(property),
-        newValue: instance.get(property),
-    }));
-};
-const getChangedCustomFieldsRows = (instance) => {
-    const customFieldsChanged = instance.changed().includes(CUSTOM_FIELDS_PROPERTY);
-    if (!customFieldsChanged) {
-        return [];
-    }
-    const customFields = instance.get(CUSTOM_FIELDS_PROPERTY);
-    const previousCustomFields = instance.previous(CUSTOM_FIELDS_PROPERTY);
-    const changedCustomFields = Object.keys(customFields).filter((field) => {
-        const newValue = customFields === null || customFields === void 0 ? void 0 : customFields[field];
-        const oldValue = previousCustomFields === null || previousCustomFields === void 0 ? void 0 : previousCustomFields[field];
-        return (!isEmpty(newValue) || !isEmpty(oldValue)) && !(0, lodash_1.isEqual)(newValue, oldValue);
-    });
-    return changedCustomFields.map((changedCustomField) => ({
-        property: `customFields.${changedCustomField}`,
-        previousValue: previousCustomFields === null || previousCustomFields === void 0 ? void 0 : previousCustomFields[changedCustomField],
-        newValue: customFields === null || customFields === void 0 ? void 0 : customFields[changedCustomField],
-    }));
+    // It's a known issut with sequelize.
+    const changedProperties = options.returning ? options.fields : instance.changed();
+    return filterOutEmptyFields(changedProperties, instance);
 };
 class AuditLogger {
     constructor(options) {
         this.rabbit = options.rabbit;
         this.sequelize = options.sequelize;
-        this.logger = options.logger || logger_1.default;
+        this.logger = options.logger;
     }
     registerHooks() {
         Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
@@ -78,18 +52,21 @@ class AuditLogger {
                 try {
                     const auditContext = getAuditContext();
                     if (auditContext) {
-                        const changedFieldsRows = getChangedFieldsRows(instance, options);
-                        const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);
+                        const changedProperties = getChangedFields(instance, options);
                         const payload = {
                             entityType: modelName,
                             entityId: instance.id,
-                            rows: [...changedFieldsRows, ...changedCustomFieldsRows],
+                            rows: changedProperties.map((property) => ({
+                                property,
+                                previousValue: instance.previous(property),
+                                newValue: instance.get(property),
+                            })),
                         };
                         this.sendAuditLogRows(payload);
                     }
                 }
                 catch (error) {
-                    this.logger.error('Failed to send audit log rows', error);
+                    logger_1.default.error('Failed to send audit log rows', error);
                 }
             }));
         });
@@ -100,7 +77,7 @@ class AuditLogger {
                 yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_CONTEXT_QUEUE, context);
             }
             catch (err) {
-                this.logger.error('Failed to send audit log context', err);
+                logger_1.default.error('Failed to send audit log context', err);
             }
         });
     }
@@ -110,7 +87,7 @@ class AuditLogger {
                 yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_ROWS_QUEUE, payload);
             }
             catch (err) {
-                this.logger.error('Failed to send audit log rows', err);
+                logger_1.default.error('Failed to send audit log rows', err);
             }
         });
     }

package/dist/index.d.ts

@@ -2,7 +2,10 @@ import AuditLogger from './audit-logger';
 import { AuditLoggerOptions } from './types';
 export declare const enableAuditing: (options: AuditLoggerOptions) => void;
 export declare const setAuditContext: (entityType: string, action: string) => (req: any, res: any, next: any) => Promise<any>;
-export declare const setRabbitAuditContext: (entityType: string, action: string) => (endpoint: string) => Promise<any>;
+export declare const setRabbitAuditContext: (entityType: string, action: string) => (endpoint: string, { userId, automationId }: {
+    userId: any;
+    automationId: any;
+}) => Promise<any>;
 export * from './types';
 export * from './const';
 export default AuditLogger;

package/dist/index.js

@@ -29,32 +29,32 @@ 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"));
 let auditLogger;
 const enableAuditing = (options) => {
-    if (process.env.DISABLE_AUDIT_LOGS !== 'true') {
-        auditLogger = new audit_logger_1.default(options);
-        (0, audit_api_1.default)(options);
-        auditLogger.registerHooks();
-    }
+    auditLogger = new audit_logger_1.default(options);
+    (0, audit_api_1.default)(options);
+    auditLogger.registerHooks();
 };
 exports.enableAuditing = enableAuditing;
 const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        if (process.env.DISABLE_AUDIT_LOGS === 'true') {
-            return next();
-        }
         const currentTrace = (0, zehut_1.getCurrentPayload)();
         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);
@@ -66,20 +66,20 @@ const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(vo
     return next();
 });
 exports.setAuditContext = setAuditContext;
-const setRabbitAuditContext = (entityType, action) => (endpoint) => __awaiter(void 0, void 0, void 0, function* () {
+const setRabbitAuditContext = (entityType, action) => (endpoint, { userId, automationId }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
-    if (process.env.DISABLE_AUDIT_LOGS === 'true') {
-        return;
-    }
+    console.log({ automationId });
     const currentTrace = (0, zehut_1.getCurrentPayload)();
+    const user = currentTrace.context.get(const_1.USER_CONTEXT_KEY);
+    const contextAutomationId = currentTrace.context.get('x-af-automation-id');
     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 = {
             entityType,
             action,
             endpoint,
             method: 'rabbit',
-            performedBy: user === null || user === void 0 ? void 0 : user.id,
+            performedBy: (user === null || user === void 0 ? void 0 : user.id) || contextAutomationId,
+            actionOrigin: userId ? types_1.ActionOrigin.USER : types_1.ActionOrigin.AUTOMATION,
         };
         currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditLogContext);
         yield auditLogger.sendAuditLogContext(auditLogContext);

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.2.0-beta.5",
+  "version": "1.2.1-beta",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -15,7 +15,7 @@
     "@autofleet/errors": "^1.2.2",
     "@autofleet/logger": "^4.0.6",
     "@autofleet/network": "^1.4.7",
-    "@autofleet/rabbit": "^3.2.18",
+    "@autofleet/rabbit": "^3.2.22",
     "lodash": "^4.17.21",
     "sequelize-typescript": "^2.1.5"
   },
@@ -35,7 +35,7 @@
     "typescript": "^4.9.5"
   },
   "peerDependencies": {
-    "@autofleet/zehut": "^3.x | ^3.1.0-beta.1"
+    "@autofleet/zehut": "^3.x"
   },
   "author": "Autofleet",
   "license": "ISC"

package/src/const.ts

@@ -2,3 +2,4 @@ export const AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';
 export const AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';
 export const AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';
 export const USER_CONTEXT_KEY = 'userObject';
+export const AUTOMATION_ID_HEADER = 'x-af-automation-id';

package/src/index.ts

@@ -1,7 +1,7 @@
 import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
 import AuditLogger from './audit-logger';
-import { AuditLogContext, AuditLoggerOptions } from './types';
-import { AUDIT_LOG_CONTEXT_KEY, USER_CONTEXT_KEY } from './const';
+import { ActionOrigin, AuditLogContext, AuditLoggerOptions } from './types';
+import { AUDIT_LOG_CONTEXT_KEY, AUTOMATION_ID_HEADER, USER_CONTEXT_KEY } from './const';
 import addAuditApi from './audit-api';
 import logger from './logger';
 
@@ -23,15 +23,20 @@ export const setAuditContext = (
     if (process.env.DISABLE_AUDIT_LOGS === 'true') {
       return next();
     }
+    logger.info('shtinker automation context', { contextData: req.headers[AUTOMATION_ID_HEADER] });
     const currentTrace = getCurrentTrace();
     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[AUTOMATION_ID_HEADER] ?? null, actionOrigin: req.headers[AUTOMATION_ID_HEADER] ? ActionOrigin.AUTOMATION : null };
       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);
@@ -45,19 +50,22 @@ export const setAuditContext = (
 export const setRabbitAuditContext = (
   entityType: string,
   action: string,
-) => async (endpoint: string): Promise<any> => {
+) => async (endpoint: string, { userId, automationId }:{ userId:string; automationId:string; }): Promise<any> => {
   if (process.env.DISABLE_AUDIT_LOGS === 'true') {
     return;
   }
   const currentTrace = getCurrentTrace();
   if (currentTrace?.context?.get) {
-    const user = currentTrace.context.get(USER_CONTEXT_KEY);
+    const { performedBy, actionOrigin } = userId
+      ? { performedBy: userId, actionOrigin: ActionOrigin.USER }
+      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };
     const auditLogContext: AuditLogContext = {
       entityType,
       action,
       endpoint,
       method: 'rabbit',
-      performedBy: user?.id,
+      performedBy,
+      actionOrigin,
     };
     currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);
     await auditLogger.sendAuditLogContext(auditLogContext);

package/src/types.ts

@@ -14,6 +14,7 @@ export interface AuditLogContext {
   performedBy: string;
   endpoint: string;
   method: string;
+  actionOrigin?: string;
 }
 
 export interface AuditLogRow {
@@ -45,6 +46,7 @@ export enum Action {
   UPSERT = 'upsert',
   JOIN = 'join',
   MOVE = 'move',
+  REOPTIMIZATION = 'reoptimization',
 }
 
 export enum EntityType {
@@ -53,3 +55,8 @@ export enum EntityType {
   DRIVER = 'Driver',
   PRICE_CALCULATION = 'PriceCalculation',
 }
+
+export const enum ActionOrigin {
+  USER = 'user',
+  AUTOMATION = 'automation',
+}