#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.test.ts

@@ -845,8 +845,8 @@ describe('createRestRoutes: interceptors', () => {
       query: 'query GetUsers { users { name } }',
       variables: '{ "key1": "value1", "key2": "value2" }'
     });
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(routeInterceptor).toBeCalledTimes(1);
     expect(requestInterceptor.mock.invocationCallOrder[0]).toBeLessThan(
       routeInterceptor.mock.invocationCallOrder[0]
     );
@@ -857,8 +857,8 @@ describe('createRestRoutes: interceptors', () => {
       query: 'query GetUsers { users { name } }',
       variables: '{ "key3": "value3", "key4": "value4" }'
     });
-    expect(requestInterceptor.mock.calls.length).toBe(2);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
 
     await request(server)
       .post('/')
@@ -867,8 +867,8 @@ describe('createRestRoutes: interceptors', () => {
         query: 'mutation CreateUser($name: String!) { createUser(name: $name) { name } }',
         variables: { key1: 'value1', key2: 'value2' }
       });
-    expect(requestInterceptor.mock.calls.length).toBe(2);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
   });
 
   test('Should call response interceptors in order: route -> request -> server', async () => {
@@ -922,10 +922,10 @@ describe('createRestRoutes: interceptors', () => {
       query: 'query GetUsers { users { name } }',
       variables: '{ "key1": "value1", "key2": "value2" }'
     });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(1);
-    expect(serverInterceptor.mock.calls.length).toBe(1);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(1);
+    expect(serverInterceptor).toBeCalledTimes(1);
     expect(routeInterceptor.mock.invocationCallOrder[0]).toBeLessThan(
       requestInterceptor.mock.invocationCallOrder[0]
     );
@@ -943,10 +943,10 @@ describe('createRestRoutes: interceptors', () => {
         query: 'mutation CreateUser($name: String!) { createUser(name: $name) { name } }',
         variables: { key1: 'value1', key2: 'value2' }
       });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(2);
-    expect(serverInterceptor.mock.calls.length).toBe(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(2);
+    expect(serverInterceptor).toBeCalledTimes(2);
 
     await request(server)
       .post('/')
@@ -955,9 +955,9 @@ describe('createRestRoutes: interceptors', () => {
         query: 'query GetSettings { settings { notifications } }',
         variables: { key1: 'value1', key2: 'value2' }
       });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(2);
-    expect(serverInterceptor.mock.calls.length).toBe(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(2);
+    expect(serverInterceptor).toBeCalledTimes(2);
   });
 });

src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.ts

@@ -27,7 +27,7 @@ import { prepareGraphQLRequestConfigs } from './helpers';
 interface CreateGraphQLRoutesParams {
   router: IRouter;
   graphqlConfig: GraphqlConfig;
-  serverResponseInterceptor?: Interceptors['response'];
+  serverResponseInterceptor?: Interceptors<'graphql'>['response'];
 }
 
 export const createGraphQLRoutes = ({
@@ -126,9 +126,7 @@ export const createGraphQLRoutes = ({
       });
     });
 
-    if (!matchedRouteConfig) {
-      return next();
-    }
+    if (!matchedRouteConfig) return next();
 
     if (matchedRouteConfig.interceptors?.request) {
       await callRequestInterceptor({

src/core/middlewares/contextMiddleware/contextMiddleware.ts

@@ -0,0 +1,44 @@
+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;
+    }
+  }
+}
+
+export const contextMiddleware = (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 ?? '');
+
+    if (graphQLInput.query && graphQLQuery) {
+      request.graphQL = {
+        operationType: graphQLQuery.operationType as GraphQLOperationType,
+        operationName: graphQLQuery.operationName as GraphQLOperationName,
+        variables: graphQLInput.variables
+      };
+      return next();
+    }
+
+    request.graphQL = null;
+    return next();
+  });
+};

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

@@ -1,3 +1,4 @@
+export * from './contextMiddleware/contextMiddleware';
 export * from './cookieParseMiddleware/cookieParseMiddleware';
 export * from './corsMiddleware/corsMiddleware';
 export * from './destroyerMiddleware/destroyerMiddleware';

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/rest/createRestRoutes/createRestRoutes.test.ts

@@ -674,8 +674,8 @@ describe('createRestRoutes: interceptors', () => {
       .post('/users')
       .set('Content-Type', 'application/json')
       .send({ key1: 'value1', key2: 'value2' });
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(routeInterceptor).toBeCalledTimes(1);
     expect(requestInterceptor.mock.invocationCallOrder[0]).toBeLessThan(
       routeInterceptor.mock.invocationCallOrder[0]
     );
@@ -686,15 +686,15 @@ describe('createRestRoutes: interceptors', () => {
       .post('/users')
       .set('Content-Type', 'application/json')
       .send({ key3: 'value3', key4: 'value4' });
-    expect(requestInterceptor.mock.calls.length).toBe(2);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
 
     await request(server)
       .post('/settings')
       .set('Content-Type', 'application/json')
       .send({ key1: 'value1', key2: 'value2' });
-    expect(requestInterceptor.mock.calls.length).toBe(2);
-    expect(routeInterceptor.mock.calls.length).toBe(1);
+    expect(requestInterceptor).toBeCalledTimes(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
   });
 
   test('Should call response interceptors in order: route -> request -> api -> server', async () => {
@@ -748,10 +748,10 @@ describe('createRestRoutes: interceptors', () => {
       .post('/users')
       .set('Content-Type', 'application/json')
       .send({ key1: 'value1', key2: 'value2' });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(1);
-    expect(serverInterceptor.mock.calls.length).toBe(1);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(1);
+    expect(serverInterceptor).toBeCalledTimes(1);
     expect(routeInterceptor.mock.invocationCallOrder[0]).toBeLessThan(
       requestInterceptor.mock.invocationCallOrder[0]
     );
@@ -766,18 +766,18 @@ describe('createRestRoutes: interceptors', () => {
       .post('/settings')
       .set('Content-Type', 'application/json')
       .send({ key1: 'value1', key2: 'value2' });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(2);
-    expect(serverInterceptor.mock.calls.length).toBe(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(2);
+    expect(serverInterceptor).toBeCalledTimes(2);
 
     await request(server)
       .post('/messages')
       .set('Content-Type', 'application/json')
       .send({ key1: 'value1', key2: 'value2' });
-    expect(routeInterceptor.mock.calls.length).toBe(1);
-    expect(requestInterceptor.mock.calls.length).toBe(1);
-    expect(apiInterceptor.mock.calls.length).toBe(2);
-    expect(serverInterceptor.mock.calls.length).toBe(2);
+    expect(routeInterceptor).toBeCalledTimes(1);
+    expect(requestInterceptor).toBeCalledTimes(1);
+    expect(apiInterceptor).toBeCalledTimes(2);
+    expect(serverInterceptor).toBeCalledTimes(2);
   });
 });

src/core/rest/createRestRoutes/createRestRoutes.ts

@@ -27,7 +27,7 @@ import { prepareRestRequestConfigs } from './helpers';
 interface CreateRestRoutesParams {
   router: IRouter;
   restConfig: RestConfig;
-  serverResponseInterceptor?: Interceptors['response'];
+  serverResponseInterceptor?: Interceptors<'rest'>['response'];
 }
 
 export const createRestRoutes = ({
@@ -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

@@ -4,6 +4,7 @@ import express from 'express';
 
 import { createDatabaseRoutes } from '@/core/database';
 import {
+  contextMiddleware,
   cookieParseMiddleware,
   corsMiddleware,
   errorMiddleware,
@@ -32,6 +33,8 @@ export const createDatabaseMockServer = (
 
   server.use(bodyParser.text());
 
+  contextMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = databaseMockServerConfig.interceptors?.request;

src/server/createGraphQLMockServer/createGraphQLMockServer.ts

@@ -5,6 +5,7 @@ import express from 'express';
 import { createDatabaseRoutes } from '@/core/database';
 import { createGraphQLRoutes } from '@/core/graphql';
 import {
+  contextMiddleware,
   cookieParseMiddleware,
   corsMiddleware,
   errorMiddleware,
@@ -33,6 +34,8 @@ export const createGraphQLMockServer = (
 
   server.use(bodyParser.text());
 
+  contextMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = graphqlMockServerConfig.interceptors?.request;

src/server/createMockServer/createMockServer.ts

@@ -5,6 +5,7 @@ import express from 'express';
 import { createDatabaseRoutes } from '@/core/database';
 import { createGraphQLRoutes } from '@/core/graphql';
 import {
+  contextMiddleware,
   cookieParseMiddleware,
   corsMiddleware,
   errorMiddleware,
@@ -34,6 +35,8 @@ export const createMockServer = (
 
   server.use(bodyParser.text());
 
+  contextMiddleware(server);
+
   cookieParseMiddleware(server);
 
   const serverRequestInterceptor = mockServerConfig.interceptors?.request;

src/server/createRestMockServer/createRestMockServer.ts

@@ -4,6 +4,7 @@ import express from 'express';
 
 import { createDatabaseRoutes } from '@/core/database';
 import {
+  contextMiddleware,
   cookieParseMiddleware,
   corsMiddleware,
   errorMiddleware,
@@ -33,6 +34,8 @@ export const createRestMockServer = (
 
   server.use(bodyParser.text());
 
+  contextMiddleware(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