Better log (#175)

* chore(): @myunisoft/redis#3.3.1

* feature(customLogger): add requestId in log info

* test(): update ut

Author: Rossb0b

package-lock.json

@@ -32,7 +32,7 @@
     "validation"
   ],
   "dependencies": {
-    "@myunisoft/redis": "github:MyUnisoft/redis#v3.2.6",
+    "@myunisoft/redis": "github:MyUnisoft/redis#v3.3.1",
     "ajv": "^8.12.0",
     "pino-pretty": "^10.2.3",
     "ts-pattern": "^4.3.0"

package.json

@@ -7,14 +7,17 @@ import { EventOptions, Events, GenericEvent } from "../types";
 
 // CONSTANTS
 const ajv = new Ajv();
-const kCustomKey = "scope";
+const kScopeKey = "scope";
+const kMetadataKey = "metadata";
+const kOriginKey = "origin";
 const kScopeKeys = Object.freeze({
   eventTransactionId: "event-id",
   transactionId: "t-id",
   schemaId: "s",
   firmId: "f",
   accountingFolderId: "acf",
-  persPhysiqueId: "p"
+  persPhysiqueId: "p",
+  requestId: "req-id"
 });
 
 export type OperationFunctions = Record<string, any>;
@@ -72,12 +75,20 @@ function* mapped<
       continue;
     }
 
-    if (!event[kCustomKey] || !event[kCustomKey][key]) {
+    const originExist = event[kMetadataKey] && event[kMetadataKey][kOriginKey];
+
+    if (!event[kScopeKey] || !event[kScopeKey][key]) {
+      if (originExist && event[kMetadataKey][kOriginKey][key]) {
+        yield `${formattedKey}:${logValueFallback(event[kMetadataKey][kOriginKey][key])}`;
+
+        continue;
+      }
+
       yield `${formattedKey}:none`;
 
       continue;
     }
 
-    yield `${formattedKey}:${logValueFallback(event[kCustomKey][key])}`;
+    yield `${formattedKey}:${logValueFallback(event[kScopeKey][key])}`;
   }
 }

src/utils/index.ts

@@ -8,7 +8,8 @@ import {
   closeRedis,
   Channel,
   closeAllRedis,
-  clearAllKeys
+  clearAllKeys,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 import Ajv from "ajv";
@@ -17,7 +18,6 @@ import Ajv from "ajv";
 import { Dispatcher, EventOptions, Events } from "../../../../src/index";
 import * as EventsSchemas from "../../schema/index";
 import { Transaction, TransactionStore } from "../../../../src/class/store/transaction.class";
-import { IncomerStore } from "../../../../src/class/store/incomer.class";
 
 // Internal Dependencies Mocks
 const logger = Logger.pino({
@@ -47,6 +47,8 @@ describe("Dispatcher", () => {
       port: Number(process.env.REDIS_PORT),
       host: process.env.REDIS_HOST
     });
+
+    await getRedis()!.flushall();
   });
 
   afterAll(async() => {

test/UT/class/eventManagement/dispatcher.spec.ts

@@ -6,7 +6,8 @@ import {
   initRedis,
   closeAllRedis,
   clearAllKeys,
-  Channel
+  Channel,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 
@@ -81,6 +82,8 @@ describe("Publishing/exploiting a custom event", () => {
       host: process.env.REDIS_HOST
     } as any);
 
+    await getRedis()!.flushall();
+
     await initRedis({
       port: process.env.REDIS_PORT,
       host: process.env.REDIS_HOST
@@ -259,7 +262,12 @@ describe("Publishing/exploiting a custom event", () => {
       },
       metadata: {
         agent: "jest",
-        createdAt: Date.now()
+        createdAt: Date.now(),
+        origin: {
+          endpoint: "/foo",
+          method: "POST",
+          requestId: "1"
+        }
       }
     };
 

test/UT/class/eventManagement/events.spec.ts

@@ -4,7 +4,8 @@ import { randomUUID } from "node:crypto";
 // Import Third-party Dependencies
 import {
   initRedis,
-  closeAllRedis
+  closeAllRedis,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 
@@ -25,6 +26,8 @@ beforeAll(async() => {
     port: Number(process.env.REDIS_PORT),
     host: process.env.REDIS_HOST
   }, "subscriber");
+
+  await getRedis()!.flushall();
 });
 
 afterAll(async() => {

test/UT/class/eventManagement/externals.spec.ts

@@ -6,7 +6,8 @@ import {
   initRedis,
   clearAllKeys,
   Channel,
-  closeAllRedis
+  closeAllRedis,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 
@@ -36,6 +37,8 @@ describe("Publishing/exploiting a custom event & inactive incomer", () => {
       host: process.env.REDIS_HOST
     } as any);
 
+    await getRedis()!.flushall();
+
     await initRedis({
       port: process.env.REDIS_PORT,
       host: process.env.REDIS_HOST

test/UT/class/eventManagement/handle-inactive-no-backup.spec.ts

@@ -7,7 +7,8 @@ import {
   initRedis,
   clearAllKeys,
   Channel,
-  closeAllRedis
+  closeAllRedis,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 
@@ -37,6 +38,8 @@ describe("Publishing/exploiting a custom event & inactive incomer", () => {
       host: process.env.REDIS_HOST
     } as any);
 
+    await getRedis()!.flushall();
+
     await initRedis({
       port: process.env.REDIS_PORT,
       host: process.env.REDIS_HOST

test/UT/class/eventManagement/handle-inactive-with-backup.spec.ts

@@ -4,7 +4,8 @@ import timers from "node:timers/promises";
 // Import Third-party Dependencies
 import {
   initRedis,
-  closeAllRedis
+  closeAllRedis,
+  getRedis
 } from "@myunisoft/redis";
 
 // Import Internal Dependencies
@@ -33,6 +34,8 @@ describe("Init Incomer without Dispatcher alive", () => {
       host: process.env.REDIS_HOST
     } as any);
 
+    await getRedis()!.flushall();
+
     await initRedis({
       port: process.env.REDIS_PORT,
       host: process.env.REDIS_HOST

test/UT/class/eventManagement/incomer.spec.ts

@@ -6,7 +6,8 @@ import timers from "timers/promises";
 import {
   initRedis,
   clearAllKeys,
-  closeAllRedis
+  closeAllRedis,
+  getRedis
 } from "@myunisoft/redis";
 import * as Logger from "pino";
 
@@ -33,6 +34,8 @@ describe("Ping", () => {
       host: process.env.REDIS_HOST
     } as any);
 
+    await getRedis()!.flushall();
+
     await initRedis({
       port: process.env.REDIS_PORT,
       host: process.env.REDIS_HOST