@autofleet/shtinker 0.0.1

package/dist/const.d.ts

@@ -0,0 +1,3 @@
+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";

package/dist/const.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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';

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { AuditLoggerOptions } from './types';
+declare class AuditLogger {
+    private rabbit;
+    private sequelize;
+    constructor(options: AuditLoggerOptions);
+    enableAuditLogging(): void;
+    setAuditingContext: (entityType: string, entityId: string, action: string) => (req: any, res: any, next: any) => Promise<void>;
+}
+export default AuditLogger;

package/dist/index.js

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const zehut_1 = require("@autofleet/zehut");
+const const_1 = require("./const");
+const getAuditingContext = () => {
+    var _a;
+    const currentTrace = (0, zehut_1.getCurrentPayload)();
+    const auditingContext = (_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 auditingContext;
+};
+class AuditLogger {
+    constructor(options) {
+        this.setAuditingContext = (entityType, entityId, action) => (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            const currentTrace = (0, zehut_1.getCurrentPayload)();
+            if (currentTrace) {
+                const user = currentTrace.context.get('userObject');
+                const auditLogContext = {
+                    entityType,
+                    entityId,
+                    action,
+                    endpoint: req.url,
+                    method: req.method,
+                    performedBy: user.id,
+                };
+                currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditLogContext);
+                yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_CONTEXT_QUEUE, auditLogContext);
+                next();
+            }
+        });
+        this.rabbit = options.rabbit;
+        this.sequelize = options.sequelize;
+    }
+    enableAuditLogging() {
+        Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
+            modelType.addHook('afterSave', (instance) => __awaiter(this, void 0, void 0, function* () {
+                const auditingContext = getAuditingContext();
+                if (auditingContext) {
+                    const changedProperties = instance.changed();
+                    const payload = {
+                        entityType: modelName,
+                        entityId: instance.id,
+                        rows: changedProperties.map((property) => ({
+                            property,
+                            previousValue: instance.previousValue(property),
+                            newValue: instance.get(property),
+                        })),
+                    };
+                    yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_ROWS_QUEUE, payload);
+                }
+            }));
+        });
+    }
+}
+exports.default = AuditLogger;

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+import { Sequelize } from 'sequelize-typescript';
+import RabbitMq from '@autofleet/rabbit';
+export type AuditLoggerOptions = {
+    rabbit: RabbitMq;
+    sequelize: Sequelize;
+};
+export interface AuditLogContext {
+    entityType: string;
+    entityId: string;
+    action: string;
+    performedBy: string;
+    endpoint: string;
+    method: string;
+}
+export interface AuditLogRow {
+    property: string;
+    previousValue: any;
+    newValue: any;
+}
+export interface AuditLogPayload {
+    entityType: string;
+    entityId: string;
+    rows: AuditLogRow;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@autofleet/shtinker",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "ts-node src/index.ts",
+    "build": "rm -rf dist && tsc",
+    "linter": "./node_modules/.bin/eslint .",
+    "test": "jest --forceExit",
+    "coverage": "jest --coverage --forceExit && rm -rf ./coverage",
+    "dev": "nodemon"
+  },
+  "dependencies": {
+    "@autofleet/logger": "^2.0.5",
+    "@autofleet/rabbit": "^2.4.1",
+    "@autofleet/zehut": "^2.0.4",
+    "sequelize-typescript": "^2.1.5"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.9",
+    "@types/node": "^18.11.19",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "eslint": "^7.13.0",
+    "eslint-config-airbnb-typescript": "^12.0.0",
+    "eslint-plugin-import": "^2.22.1",
+    "jest": "^27.0.5",
+    "ts-jest": "^27.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "author": "Autofleet",
+  "license": "ISC"
+}

package/src/const.ts

@@ -0,0 +1,3 @@
+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';

package/src/index.ts

@@ -0,0 +1,61 @@
+import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
+import { AuditLogPayload, AuditLoggerOptions, AuditLogContext } from './types';
+import { AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUDIT_LOG_CONTEXT_KEY } from './const';
+
+const getAuditingContext = () => {
+  const currentTrace = getCurrentTrace();
+  const auditingContext = currentTrace?.context?.get(AUDIT_LOG_CONTEXT_KEY);
+  return auditingContext;
+};
+
+class AuditLogger {
+  private rabbit;
+
+  private sequelize;
+
+  constructor(options: AuditLoggerOptions) {
+    this.rabbit = options.rabbit;
+    this.sequelize = options.sequelize;
+  }
+
+  enableAuditLogging(): void {
+    Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
+      modelType.addHook('afterSave', async (instance: any) => {
+        const auditingContext = getAuditingContext();
+        if (auditingContext) {
+          const changedProperties = instance.changed();
+          const payload: AuditLogPayload = {
+            entityType: modelName,
+            entityId: instance.id,
+            rows: changedProperties.map((property: string) => ({
+              property,
+              previousValue: instance.previousValue(property),
+              newValue: instance.get(property),
+            })),
+          };
+          await this.rabbit.sendToQueue(AUDIT_LOG_ROWS_QUEUE, payload);
+        }
+      });
+    });
+  }
+
+  setAuditingContext = (entityType: string, entityId: string, action: string) => async (req: any, res: any, next: any) => {
+    const currentTrace = getCurrentTrace();
+    if (currentTrace) {
+      const user = currentTrace.context.get('userObject');
+      const auditLogContext: AuditLogContext = {
+        entityType,
+        entityId,
+        action,
+        endpoint: req.url,
+        method: req.method,
+        performedBy: user.id,
+      };
+      currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);
+      await this.rabbit.sendToQueue(AUDIT_LOG_CONTEXT_QUEUE, auditLogContext);
+      next();
+    }
+  }
+}
+
+export default AuditLogger;

package/src/types.ts

@@ -0,0 +1,27 @@
+import { Sequelize } from 'sequelize-typescript';
+import RabbitMq from '@autofleet/rabbit';
+
+export type AuditLoggerOptions = {
+  rabbit: RabbitMq;
+  sequelize: Sequelize;
+};
+
+export interface AuditLogContext {
+  entityType: string;
+  entityId: string;
+  action: string;
+  performedBy: string;
+  endpoint: string;
+  method: string;
+}
+export interface AuditLogRow {
+  property: string;
+  previousValue: any;
+  newValue: any;
+}
+
+export interface AuditLogPayload {
+  entityType: string;
+  entityId: string;
+  rows: AuditLogRow;
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}