#102 into [email protected] 🐘 add logger support

.eslintrc.js

@@ -16,11 +16,13 @@ module.exports = {
         '@typescript-eslint/no-unsafe-enum-comparison': 'off',
         '@typescript-eslint/no-var-requires': 'off',
         '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-namespace': ['error', { allowDeclarations: true }],
         'no-underscore-dangle': 'off',
         'no-restricted-syntax': 'off',
         'no-continue': 'off',
         'promise/always-return': ['error', { ignoreLastCallback: true }],
-        'arrow-body-style': ['error', 'as-needed']
+        'arrow-body-style': ['error', 'as-needed'],
+        'no-console': ['warn', { allow: ['info', 'dir', 'error'] }]
       }
     }
   ]

src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.ts

@@ -126,9 +126,7 @@ export const createGraphQLRoutes = ({
       });
     });
 
-    if (!matchedRouteConfig) {
-      return next();
-    }
+    if (!matchedRouteConfig) return next();
 
     if (matchedRouteConfig.interceptors?.request) {
       await callRequestInterceptor({

src/core/middlewares/cookieParseMiddleware/helpers/parseCookie/parseCookie.ts

@@ -1,4 +1,4 @@
-type Cookies = Record<string, string>;
+import type { Cookies } from '@/utils/types';
 
 export const parseCookie = (cookieHeader: string) => {
   if (!cookieHeader) return {};

src/core/middlewares/index.ts

@@ -4,5 +4,7 @@ export * from './destroyerMiddleware/destroyerMiddleware';
 export * from './errorMiddleware/errorMiddleware';
 export * from './noCorsMiddleware/noCorsMiddleware';
 export * from './notFoundMiddleware/notFoundMiddleware';
+export * from './requestInfoMiddleware/requestInfoMiddleware';
 export * from './requestInterceptorMiddleware/requestInterceptorMiddleware';
+export * from './responseInterceptorsMiddleware/responseInterceptorsMiddleware';
 export * from './staticMiddleware/staticMiddleware';

src/core/middlewares/notFoundMiddleware/notFoundMiddleware.ts

@@ -53,17 +53,19 @@ export const notFoundMiddleware = (
       });
     }
 
+    response.status(404);
+
     const isRequestSupportHtml =
       request.headers.accept?.includes('text/html') || request.headers.accept?.includes('*/*');
     if (isRequestSupportHtml) {
-      response.status(404).render('pages/404', {
+      response.render('pages/404', {
         restRequestSuggestions,
         graphqlRequestSuggestions
       });
       return;
     }
 
-    response.status(404).json({
+    response.json({
       message: 'Request or page not found. Similar requests in data',
       data: {
         restRequestSuggestions,

src/core/middlewares/requestInfoMiddleware/requestInfoMiddleware.ts

@@ -0,0 +1,47 @@
+import type { Express } from 'express';
+
+import { getGraphQLInput, parseQuery } from '@/utils/helpers';
+import type { GraphQLEntity, GraphQLOperationName, GraphQLOperationType } from '@/utils/types';
+
+declare global {
+  namespace Express {
+    export interface Request {
+      id: number;
+      timestamp: number;
+      graphQL: {
+        operationType: GraphQLOperationType;
+        operationName: GraphQLOperationName;
+        variables?: GraphQLEntity<'variables'>;
+      } | null;
+      context: any;
+    }
+  }
+}
+
+export const requestInfoMiddleware = (server: Express) => {
+  let requestId = 0;
+
+  server.use((request, _response, next) => {
+    requestId += 1;
+    request.id = requestId;
+
+    request.timestamp = Date.now();
+
+    const graphQLInput = getGraphQLInput(request);
+    const graphQLQuery = parseQuery(graphQLInput.query ?? '');
+    const isValidGraphQLRequest =
+      graphQLInput &&
+      graphQLInput.query &&
+      graphQLQuery?.operationType &&
+      graphQLQuery.operationName;
+    request.graphQL = isValidGraphQLRequest
+      ? {
+          operationType: graphQLQuery.operationType as GraphQLOperationType,
+          operationName: graphQLQuery.operationName as GraphQLOperationName,
+          variables: graphQLInput.variables
+        }
+      : null;
+
+    return next();
+  });
+};

src/core/middlewares/responseInterceptorsMiddleware/responseInterceptorsMiddleware.ts

@@ -0,0 +1,29 @@
+import type { Express } from 'express';
+
+import { asyncHandler, callResponseInterceptors } from '@/utils/helpers';
+import type { ResponseInterceptor } from '@/utils/types';
+
+interface ResponseInterceptorsMiddlewareParams {
+  server: Express;
+  interceptors: {
+    routeInterceptor?: ResponseInterceptor;
+    requestInterceptor?: ResponseInterceptor;
+    apiInterceptor?: ResponseInterceptor;
+    serverInterceptor?: ResponseInterceptor;
+  };
+  path?: string;
+}
+
+export const responseInterceptorsMiddleware = ({
+  server,
+  interceptors,
+  path = '*'
+}: ResponseInterceptorsMiddlewareParams) => {
+  server.use(
+    path,
+    asyncHandler(async (request, response, next) => {
+      await callResponseInterceptors({ request, response, interceptors, data: null });
+      return next();
+    })
+  );
+};

src/core/rest/createRestRoutes/createRestRoutes.ts

@@ -98,9 +98,7 @@ export const createRestRoutes = ({
           });
         });
 
-        if (!matchedRouteConfig) {
-          return next();
-        }
+        if (!matchedRouteConfig) return next();
 
         if (matchedRouteConfig.interceptors?.request) {
           await callRequestInterceptor({

src/server/createDatabaseMockServer/createDatabaseMockServer.ts

@@ -9,6 +9,7 @@ import {
   errorMiddleware,
   noCorsMiddleware,
   notFoundMiddleware,
+  requestInfoMiddleware,
   requestInterceptorMiddleware,
   staticMiddleware
 } from '@/core/middlewares';
@@ -32,6 +33,8 @@ export const createDatabaseMockServer = (
 
   server.use(bodyParser.text());
 
+  requestInfoMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = databaseMockServerConfig.interceptors?.request;

src/server/createGraphQLMockServer/createGraphQLMockServer.ts

@@ -10,6 +10,7 @@ import {
   errorMiddleware,
   noCorsMiddleware,
   notFoundMiddleware,
+  requestInfoMiddleware,
   requestInterceptorMiddleware,
   staticMiddleware
 } from '@/core/middlewares';
@@ -33,6 +34,8 @@ export const createGraphQLMockServer = (
 
   server.use(bodyParser.text());
 
+  requestInfoMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = graphqlMockServerConfig.interceptors?.request;

src/server/createMockServer/createMockServer.ts

@@ -10,6 +10,7 @@ import {
   errorMiddleware,
   noCorsMiddleware,
   notFoundMiddleware,
+  requestInfoMiddleware,
   requestInterceptorMiddleware,
   staticMiddleware
 } from '@/core/middlewares';
@@ -34,6 +35,8 @@ export const createMockServer = (
 
   server.use(bodyParser.text());
 
+  requestInfoMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = mockServerConfig.interceptors?.request;

src/server/createRestMockServer/createRestMockServer.ts

@@ -9,6 +9,7 @@ import {
   errorMiddleware,
   noCorsMiddleware,
   notFoundMiddleware,
+  requestInfoMiddleware,
   requestInterceptorMiddleware,
   staticMiddleware
 } from '@/core/middlewares';
@@ -33,6 +34,8 @@ export const createRestMockServer = (
 
   server.use(bodyParser.text());
 
+  requestInfoMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = restMockServerConfig.interceptors?.request;

src/server/startDatabaseMockServer/startDatabaseMockServer.ts

@@ -11,7 +11,7 @@ export const startDatabaseMockServer = (databaseMockServerConfig: DatabaseMockSe
   const port = databaseMockServerConfig.port ?? DEFAULT.PORT;
 
   const server = mockServer.listen(port, () => {
-    console.log(color.green(`🎉 Database Mock Server is running at http://localhost:${port}`));
+    console.info(color.green(`🎉 Database Mock Server is running at http://localhost:${port}`));
   });
 
   // ✅ important: add destroy method for closing keep-alive connections after server shutdown

src/server/startGraphQLMockServer/startGraphQLMockServer.ts

@@ -11,7 +11,7 @@ export const startGraphQLMockServer = (graphQLMockServerConfig: GraphQLMockServe
   const port = graphQLMockServerConfig.port ?? DEFAULT.PORT;
 
   const server = mockServer.listen(port, () => {
-    console.log(color.green(`🎉 GraphQL Mock Server is running at http://localhost:${port}`));
+    console.info(color.green(`🎉 GraphQL Mock Server is running at http://localhost:${port}`));
   });
 
   // ✅ important: add destroy method for closing keep-alive connections after server shutdown

src/server/startMockServer/startMockServer.ts

@@ -11,7 +11,7 @@ export const startMockServer = (mockServerConfig: MockServerConfig) => {
   const port = mockServerConfig.port ?? DEFAULT.PORT;
 
   const server = mockServer.listen(port, () => {
-    console.log(color.green(`🎉 Mock Server is running at http://localhost:${port}`));
+    console.info(color.green(`🎉 Mock Server is running at http://localhost:${port}`));
   });
 
   // ✅ important: add destroy method for closing keep-alive connections after server shutdown

src/server/startRestMockServer/startRestMockServer.ts

@@ -11,7 +11,7 @@ export const startRestMockServer = (restMockServerConfig: RestMockServerConfig)
   const port = restMockServerConfig.port ?? DEFAULT.PORT;
 
   const server = mockServer.listen(port, () => {
-    console.log(color.green(`🎉 Rest Mock Server is running at http://localhost:${port}`));
+    console.info(color.green(`🎉 Rest Mock Server is running at http://localhost:${port}`));
   });
 
   // ✅ important: add destroy method for closing keep-alive connections after server shutdown