@autofleet/shtinker 1.2.0-beta.4 → 1.2.0

package/dist/const.d.ts

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

package/dist/const.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_CONTEXT_KEY = exports.AUDIT_LOG_CONTEXT_KEY = exports.AUDIT_LOG_ROWS_QUEUE = exports.AUDIT_LOG_CONTEXT_QUEUE = void 0;
+exports.AUTOMATION_ID_HEADER = exports.USER_CONTEXT_KEY = exports.AUDIT_LOG_CONTEXT_KEY = exports.AUDIT_LOG_ROWS_QUEUE = exports.AUDIT_LOG_CONTEXT_QUEUE = void 0;
 exports.AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';
 exports.AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';
 exports.AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';
 exports.USER_CONTEXT_KEY = 'userObject';
+exports.AUTOMATION_ID_HEADER = 'x-af-automation-id';

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: string;
+    automationId: string;
+}) => Promise<any>;
 export * from './types';
 export * from './const';
 export default AuditLogger;

package/dist/index.js

@@ -42,6 +42,7 @@ const enableAuditing = (options) => {
 };
 exports.enableAuditing = enableAuditing;
 const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     try {
         if (process.env.DISABLE_AUDIT_LOGS === 'true') {
             return next();
@@ -49,12 +50,16 @@ const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(vo
         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: "user" /* ActionOrigin.USER */ }
+                : { performedBy: (_a = req.headers[const_1.AUTOMATION_ID_HEADER]) !== null && _a !== void 0 ? _a : null, actionOrigin: req.headers[const_1.AUTOMATION_ID_HEADER] ? "automation" /* ActionOrigin.AUTOMATION */ : null };
             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 +71,23 @@ 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* () {
-    var _a;
+const setRabbitAuditContext = (entityType, action) => (endpoint, { userId, automationId }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _b;
     if (process.env.DISABLE_AUDIT_LOGS === 'true') {
         return;
     }
     const currentTrace = (0, zehut_1.getCurrentPayload)();
-    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);
+    if ((_b = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _b === void 0 ? void 0 : _b.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 };
         const auditLogContext = {
             entityType,
             action,
             endpoint,
             method: 'rabbit',
-            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);

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;
@@ -38,7 +39,8 @@ export declare enum Action {
     BULK_UPSERT = "bulk-upsert",
     UPSERT = "upsert",
     JOIN = "join",
-    MOVE = "move"
+    MOVE = "move",
+    REOPTIMIZATION = "reoptimization"
 }
 export declare enum EntityType {
     RIDE = "Ride",
@@ -46,3 +48,7 @@ export declare enum EntityType {
     DRIVER = "Driver",
     PRICE_CALCULATION = "PriceCalculation"
 }
+export declare const enum ActionOrigin {
+    USER = "user",
+    AUTOMATION = "automation"
+}

package/dist/types.js

@@ -19,6 +19,7 @@ var Action;
     Action["UPSERT"] = "upsert";
     Action["JOIN"] = "join";
     Action["MOVE"] = "move";
+    Action["REOPTIMIZATION"] = "reoptimization";
 })(Action = exports.Action || (exports.Action = {}));
 var EntityType;
 (function (EntityType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/shtinker",
-  "version": "1.2.0-beta.4",
+  "version": "1.2.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -15,12 +15,12 @@
     "@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"
   },
   "devDependencies": {
-    "@autofleet/zehut": "^3.1.0-beta.1",
+    "@autofleet/zehut": "^3.0.10",
     "@types/express": "^4.17.17",
     "@types/jest": "^27.0.9",
     "@types/node": "^18.11.19",

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';
 
@@ -26,12 +26,16 @@ export const setAuditContext = (
     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 +49,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',
+}