feat: add reqId for db queries

Author: 7eliassen

src/infrastructure/logging/index.ts

@@ -3,6 +3,7 @@ import * as process from 'process';
 import type { LoggingConfig } from '../config/index.js';
 import appConfig from '../config/index.js';
 import type { FastifyRequest } from 'fastify';
+import { getCurrentReqId } from './reqId.context.js';
 
 const loggerConfig = process.env['NODE_ENV'] === 'production'
   ? {}
@@ -45,13 +46,14 @@ export function getLogger(moduleName: keyof LoggingConfig): pino.Logger {
  */
 export function getRequestLogger(moduleName: keyof LoggingConfig, request?: FastifyRequest): pino.Logger {
   const baseLogger = getLogger(moduleName);
-  
-  if (request && request.id) {
+  const reqId = getCurrentReqId() ?? request?.id;
+
+  if (reqId) {
     return baseLogger.child({
-      reqId: request.id,
+      reqId,
     });
   }
-  
+
   return baseLogger;
 }
 

src/infrastructure/logging/reqId.context.ts

@@ -0,0 +1,23 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+
+/**
+ * Context for storing reqId within asynchronous operations
+ */
+interface RequestContext {
+  reqId?: string;
+}
+
+/**
+ * AsyncLocalStorage for storing request context
+ * Allows tying database logs to the corresponding request
+ */
+export const requestContextStorage = new AsyncLocalStorage<RequestContext>();
+
+/**
+ * Gets the current reqId from the execution context
+ * @returns reqId or undefined if context is not set
+ */
+export function getCurrentReqId(): string | undefined {
+  const context = requestContextStorage.getStore();
+  return context?.reqId;
+}

src/presentation/http/http-api.ts

@@ -9,6 +9,7 @@ import { fastifyOauth2 } from '@fastify/oauth2';
 import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUI from '@fastify/swagger-ui';
 import addUserIdResolver from '@presentation/http/middlewares/common/userIdResolver.js';
+import addReqIdContext from '@presentation/http/middlewares/common/reqIdContext.js';
 import cookie from '@fastify/cookie';
 import { notFound, forbidden, unauthorized, notAcceptable, domainError } from './decorators/index.js';
 import NoteRouter from '@presentation/http/router/note.js';
@@ -324,6 +325,7 @@ export default class HttpApi implements Api {
       throw new Error('Server is not initialized');
     }
 
+    addReqIdContext(this.server);
     addUserIdResolver(this.server, domainServices.authService);
   }
 

src/presentation/http/middlewares/common/reqIdContext.ts

@@ -0,0 +1,18 @@
+import type { FastifyInstance } from 'fastify';
+import { requestContextStorage } from '@infrastructure/logging/reqId.context.js';
+
+/**
+ * Adds middleware to set reqId context at the beginning of each request
+ * @param server - fastify instance
+ */
+export default function addReqIdContext(server: FastifyInstance): void {
+  /**
+   * Sets reqId context for all asynchronous operations within the request
+   * Uses 'onRequest' hook so context is available in all subsequent hooks and handlers
+   */
+  server.addHook('onRequest', (request, _reply, done) => {
+    requestContextStorage.run({ reqId: request.id }, () => {
+      done();
+    });
+  });
+}

src/repository/storage/postgres/orm/sequelize/index.ts

@@ -1,6 +1,6 @@
 import type { DatabaseConfig } from '@infrastructure/config/index.js';
 import { Sequelize } from 'sequelize';
-import { getLogger } from '@infrastructure/logging/index.js';
+import { getLogger, getRequestLogger } from '@infrastructure/logging/index.js';
 
 const databaseLogger = getLogger('database');
 
@@ -28,7 +28,8 @@ export default class SequelizeOrm {
     this.conn = new Sequelize(this.config.dsn, {
       benchmark: true,
       logging: (message, timing) => {
-        databaseLogger.info(
+        const logger = getRequestLogger('database');
+        logger.info(
           { durationMs: timing },
           message
         );