Add request id to the app logs for easy log tracking

Author: vas3a

package.json

@@ -36,6 +36,7 @@
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.2.0",
     "lodash": "^4.17.21",
+    "nanoid": "^5.1.5",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "trolleyhq": "^1.1.0",

pnpm-lock.yaml

@@ -3,6 +3,7 @@ import { HealthCheckController } from './health-check/healthCheck.controller';
 import { GlobalProvidersModule } from 'src/shared/global/globalProviders.module';
 import { APP_GUARD } from '@nestjs/core';
 import { TokenValidatorMiddleware } from 'src/core/auth/middleware/tokenValidator.middleware';
+import { CreateRequestStoreMiddleware } from 'src/core/request/createRequestStore.middleware';
 import { AuthGuard, RolesGuard } from 'src/core/auth/guards';
 import { TopcoderModule } from 'src/shared/topcoder/topcoder.module';
 import { OriginRepository } from './repository/origin.repo';
@@ -48,5 +49,6 @@ import { WithdrawalModule } from './withdrawal/withdrawal.module';
 export class ApiModule implements NestModule {
   configure(consumer: MiddlewareConsumer) {
     consumer.apply(TokenValidatorMiddleware).forRoutes('*');
+    consumer.apply(CreateRequestStoreMiddleware).forRoutes('*');
   }
 }

src/api/api.module.ts

@@ -0,0 +1,14 @@
+import { Injectable, NestMiddleware } from '@nestjs/common';
+import { Response, NextFunction } from 'express';
+import { RequestMetadata, saveStore } from './requestStore';
+
+@Injectable()
+export class CreateRequestStoreMiddleware implements NestMiddleware {
+  constructor() {}
+
+  use(req: any, res: Response, next: NextFunction) {
+    const requestMetaData = new RequestMetadata({});
+
+    saveStore(requestMetaData, next);
+  }
+}

src/core/request/createRequestStore.middleware.ts

@@ -0,0 +1,39 @@
+import { AsyncLocalStorage } from 'async_hooks';
+import { NextFunction } from 'express';
+import { nanoid } from 'nanoid';
+
+// Class for storing request specific metadata
+export class RequestMetadata {
+  requestId: string;
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-object-type
+  constructor(params: { requestId?: string }) {
+    this.requestId = params.requestId ?? nanoid(11);
+  }
+}
+
+// Create a AsyncLocalStorage of type RequestMetaData for storing request specific data
+const asyncStorage = new AsyncLocalStorage<RequestMetadata>();
+
+// Gets the RequestMetadada object associated with the current request
+export function getStore(): RequestMetadata {
+  let store = asyncStorage.getStore();
+  if (store === undefined) {
+    store = new RequestMetadata({
+      requestId: '',
+    });
+  }
+
+  return store;
+}
+
+// For use in middleware
+// Saves RequestMetadata for the current request
+export function saveStore(
+  requestMetaData: RequestMetadata,
+  next: NextFunction,
+) {
+  asyncStorage.run(requestMetaData, () => {
+    next();
+  });
+}

src/core/request/requestStore.ts

@@ -1,7 +1,12 @@
 import { Logger as NestLogger } from '@nestjs/common';
 import stringify from 'json-stringify-safe';
+import { getStore } from 'src/core/request/requestStore';
 
 export class Logger extends NestLogger {
+  private get store() {
+    return getStore();
+  }
+
   log(...messages: any[]): void {
     super.log(this.formatMessages(messages));
   }
@@ -19,7 +24,10 @@ export class Logger extends NestLogger {
   }
 
   private formatMessages(messages: any[]): string {
-    return messages
+    const requestIdPrefix = this.store.requestId
+      ? [`{${this.store.requestId}}`]
+      : [];
+    return [...requestIdPrefix, ...messages]
       .map((msg) =>
         typeof msg === 'object' ? stringify(msg, null, 2) : String(msg),
       )