Improve api-rest & elk on backend-javascript

Author: ganatan

backend-javascript/.env.development

@@ -5,7 +5,7 @@ APP_VERSION=1.1.1
 
 # === SERVEUR APPLICATION ===
 HOST=localhost
-PORT=3001
+PORT=3000
 # CORS_ORIGIN=http://localhost:4200
 CORS_ORIGIN=*
 

backend-javascript/src/__tests__/e2e/server.e2e.test.js

@@ -56,9 +56,7 @@ app.use(appRoutes);
 app.use(rootRoutes);
 
 app.use(notFoundHandler);
-
 app.use(responseHandler);
-
 app.use(errorHandler);
 
 export default app;

backend-javascript/src/app.js

@@ -1,19 +1,45 @@
+import os from 'os';
 import logger from './logger.js';
 import { incrementHttpRequests } from '../metrics/metrics.js';
 
 const requestLogger = (req, res, next) => {
+  const startTime = Date.now();
 
   res.on('finish', () => {
     incrementHttpRequests(req.method, req.originalUrl, res.statusCode);
-  });
 
-  logger.info(`[${req.method}] ${req.originalUrl}`, {
-    method: req.method,
-    route: req.originalUrl,
-    correlationId: req.correlationId,
-    ip: req.ip,
-    userAgent: req.headers['user-agent'],
+    const responseTime = Date.now() - startTime;
+    const logLevel = res.statusCode >= 400 ? 'warn' : 'info';
+
+    logger[logLevel](`[${req.method}] ${req.originalUrl} - ${res.statusCode}`, {
+      environment: process.env.NODE_ENV || 'development',
+      hostname: os.hostname(),
+      processId: process.pid,
+      correlationId: req.correlationId,
+      requestId: req.id,
+      sessionId: req.sessionID,
+      userId: req.user?.id,
+      method: req.method,
+      route: req.originalUrl,
+      statusCode: res.statusCode,
+      protocol: req.protocol,
+      httpVersion: req.httpVersion,
+      responseTime: responseTime,
+      contentLength: res.getHeader('content-length') || 0,
+      bodySize: req.headers['content-length'] ? parseInt(req.headers['content-length']) : 0,
+      ip: req.ip,
+      xForwardedFor: req.headers['x-forwarded-for'] || null,
+      userAgent: req.headers['user-agent'],
+      referer: req.headers['referer'] || null,
+      origin: req.headers['origin'] || null,
+      host: req.headers['host'] || null,
+      accept: req.headers['accept'] || null,
+      acceptLanguage: req.headers['accept-language'] || null,
+      query: Object.keys(req.query).length > 0 ? req.query : undefined,
+      timestamp: new Date().toISOString(),
+    });
   });
+
   next();
 };
 

backend-javascript/src/infrastructure/logger/request-logger.js

@@ -22,7 +22,7 @@ describe('notFoundHandler Middleware', () => {
     expect(next).toHaveBeenCalledTimes(1);
     const errorArg = next.mock.calls[0][0];
     expect(errorArg).toBeInstanceOf(Error);
-    expect(errorArg.message).toBe('Resource not found');
+    expect(errorArg.message).toBe('Route not found');
     expect(errorArg.statusCode).toBe(404);
     expect(errorArg.context).toBe('GET /non-existing-route');
     expect(errorArg.details).toEqual(

backend-javascript/src/middlewares/error/__tests__/unit/not-found-handler.test.js

@@ -11,18 +11,31 @@ function errorHandler(err, req, res, next) {
   };
 
   const logMessage = `[${req.method}] ${req.originalUrl} - ${statusCode} ${message}`;
+  let errorStack = err.stack;
+  if (statusCode === 404) {
+    if (err.isTechnical404) {
+      errorStack = 'stack unknown';
+    }
+  }
+
   const logData = {
     method: req.method,
     route: req.originalUrl,
     statusCode: statusCode,
     message: message,
     context: context,
     details: details,
-    stack: err.stack,
+    stack: errorStack,
     correlationId: req.correlationId,
   };
 
-  if (statusCode >= 500 || statusCode === 401 || statusCode === 403 || statusCode === 409) {
+  if (statusCode === 404) {
+    if (err.isTechnical404) {
+      logger.warn('404 unknown route', logData);
+    } else {
+      logger.warn('404 resource not found', logData);
+    }
+  } else if (statusCode >= 500 || statusCode === 401 || statusCode === 403 || statusCode === 409) {
     logger.error(logMessage, logData);
   } else {
     logger.warn(logMessage, logData);
@@ -35,4 +48,3 @@ function errorHandler(err, req, res, next) {
 }
 
 export default errorHandler;
-

backend-javascript/src/middlewares/error/error-handler.js

@@ -1,7 +1,8 @@
 const notFoundHandler = (req, res, next) => {
   if (res.locals.data === undefined) {
-    const error = new Error('Resource not found');
+    const error = new Error('Route not found');
     error.statusCode = 404;
+    error.isTechnical404 = true;
     error.context = `${req.method} ${req.originalUrl}`;
     error.details = {
       path: req.originalUrl,

backend-javascript/src/middlewares/error/not-found-handler.js

@@ -14,33 +14,9 @@ function responseHandler(req, res, next) {
   } else {
     response.data = payload;
   }
-
   res.status(statusCode).json(response);
 
   return next();
 }
 
 export default responseHandler;
-
-// function responseHandler(req, res, next) {
-//   if (res.headersSent) {
-//     return next();
-//   }
-
-//   const statusCode = res.locals.statusCode || 200;
-//   const payload = res.locals.data || null;
-//   const success = statusCode >= 200 && statusCode < 300;
-
-//   const response = { success };
-
-//   if (payload && payload.metadata && payload.data) {
-//     response.metadata = payload.metadata;
-//     response.data = payload.data;
-//   } else {
-//     response.data = payload;
-//   }
-
-//   res.status(statusCode).json(response);
-// }
-
-// export default responseHandler;

backend-javascript/src/middlewares/response/response-handler.js

@@ -52,9 +52,11 @@ class Controller {
       return next();
     } catch (error) {
       if (error.message === ITEM_CONSTANTS.ALREADY_EXISTS) {
+
         return next({ statusCode: HTTP_STATUS.CONFLICT, message: error.message });
       }
       if (error.name === 'ValidationError') {
+
         return next({ statusCode: HTTP_STATUS.BAD_REQUEST, message: error.message });
       }