feat: documentation (#10)

Author: JosemaPereira

app/internal/adapters/auth/jwt.js

@@ -1,6 +1,4 @@
-/**
- * @module Auth/JWT
- */
+/** @module Auth */
 
 import jsonwebtoken from 'jsonwebtoken';
 
@@ -27,6 +25,11 @@ const generateToken = (adminID, expiresIn, secretKey) =>
  */
 const verifyToken = (token, secretKey) => jsonwebtoken.verify(token, secretKey);
 
+/**
+ * @namespace JWT
+ * @memberof module:Auth
+ * @constant
+ */
 export const JWT = {
   generateToken,
   verifyToken,

app/internal/adapters/index.js

@@ -3,6 +3,7 @@ import { AuthRoute, MainRoute, UsersRoute } from './routes';
 
 /**
  * Adapters module containing various adapters.
+ * @namespace
  * @property {object} Auth - Authentication adapter.
  * @property {object} Routes - Routes adapter.
  */

app/internal/adapters/routes/auth.routes.js

@@ -1,14 +1,12 @@
-/**
- * @module Routes/Auth
- */
-
 import express from 'express';
 import { AuthController } from '../../core/controllers';
 
 /**
  * Set up routes related to authentication.
+ * @namespace Auth
  * @function AuthRoute
  * @param {express.Application} app - The Express application.
+ * @memberof module:Routes
  */
 export const AuthRoute = (app) => {
   const router = express.Router();

app/internal/adapters/routes/index.js

@@ -1,3 +1,4 @@
+/** @module Routes */
 export * from './main.routes';
 export * from './users.routes';
 export * from './auth.routes';

app/internal/adapters/routes/main.routes.js

@@ -1,14 +1,12 @@
-/**
- * @module Routes/Main
- */
-
 import express from 'express';
 import { MainController } from '../../core/controllers';
 
 /**
  * Set up main routes.
+ * @namespace Main
  * @function MainRoute
  * @param {express.Application} app - The Express application.
+ * @memberof module:Routes
  */
 export const MainRoute = (app) => {
   const router = express.Router();

app/internal/adapters/routes/users.routes.js

@@ -1,14 +1,12 @@
-/**
- * @module Routes/Users
- */
-
 import express from 'express';
 import { UsersController } from '../../core/controllers';
 
 /**
  * Set up routes related to Users CRUD operations
+ * @namespace Users
  * @function UsersRoute
  * @param {express.Application} app - The Express application.
+ * @memberof module:Routes
  */
 export const UsersRoute = (app) => {
   const router = express.Router();

app/internal/core/controllers/auth.controller.js

@@ -1,7 +1,4 @@
-/**
- * @module Controllers/Auth
- */
-
+/** @module Controllers */
 import { constants } from 'http2';
 import { AuthServices } from '../services';
 
@@ -25,6 +22,11 @@ const getToken = (req, res, next) => {
   }
 };
 
+/**
+ * @namespace AuthController
+ * @memberof module:Controllers
+ * @constant
+ */
 export const AuthController = {
   getToken,
 };

app/internal/core/controllers/main.controller.js

@@ -1,6 +1,4 @@
-/**
- * @module Controllers/Main
- */
+/** @module Controllers */
 
 import { constants } from 'http2';
 import { MainServices } from '../services';
@@ -21,6 +19,10 @@ const healthCheck = (req, res, next) => {
   }
 };
 
+/**
+ * @namespace MainController
+ * @constant
+ */
 export const MainController = {
   healthCheck,
 };

app/internal/core/controllers/users.controller.js

@@ -1,6 +1,3 @@
-/**
- * @module Controllers/Users
- */
 import { constants } from 'http2';
 import { UserServices } from '../services';
 
@@ -68,6 +65,11 @@ const drop = async (req, res, next) => {
   }
 };
 
+/**
+ * @namespace UsersController
+ * @memberof module:Controllers
+ * @constant
+ */
 export const UsersController = {
   getById,
   create,

app/internal/core/middlewares/auth.js renamed to app/internal/core/middlewares/auth.middleware.js

@@ -1,4 +1,4 @@
-export * from './logs';
-export * from './error';
-export * from './configurations';
-export * from './auth';
+export * from './logs.middleware';
+export * from './error.middleware';
+export * from './configurations.middleware';
+export * from './auth.middleware';

app/internal/core/middlewares/configurations.js renamed to app/internal/core/middlewares/configurations.middleware.js

@@ -1 +1 @@
-export * from './users';
+export * from './users.model';

app/internal/core/middlewares/error.js renamed to app/internal/core/middlewares/error.middleware.js

@@ -1,6 +1,4 @@
-/**
- * @module Providers/Config
- */
+/** @module Providers */
 
 /**
  * Default configuration object.
@@ -12,7 +10,10 @@
 
 /**
  * Default configuration for the application.
+ * @namespace defaultConfig
+ * @memberof module:Providers
  * @type {DefaultConfig}
+ * @constant
  */
 export const defaultConfig = {
   auth: {

app/internal/core/middlewares/index.js

@@ -23,6 +23,10 @@
     "sort": true,
     "collapse": true,
     "typedefs": true,
+    "sectionOrder": [
+      "Modules",
+      "Namespaces"
+    ],
     "menu": {
       "Github repo": {
         "href": "https://github.com/wizeline/CA-Microservices-NodeJS",

app/internal/core/middlewares/logs.js renamed to app/internal/core/middlewares/logs.middleware.js

@@ -2,7 +2,7 @@ import { constants } from 'http2';
 import { AuthController } from '../../../app/internal/core/controllers';
 
 describe('AuthController', () => {
-  it('Create token is requested', () => {
+  it('should create token is requested', () => {
     const req = {
       body: {
         adminId: 123,

app/internal/core/models/index.js

@@ -2,7 +2,7 @@ import { constants } from 'http2';
 import { MainController } from '../../../app/internal/core/controllers';
 
 describe('MainController', () => {
-  it('health check is requested', () => {
+  it('should request health check', () => {
     const req = {
       body: {
         admin_id: 123,

app/internal/core/models/users.js renamed to app/internal/core/models/users.model.js

@@ -2,7 +2,7 @@ import { constants } from 'http2';
 import { UsersController } from '../../../app/internal/core/controllers';
 
 describe('UsersController GetByID', () => {
-  it('Get by ID is requested', () => {
+  it('should get by ID', () => {
     const res = { json: jest.fn((x) => x), status: jest.fn((x) => x) };
     const callback = () => null;
 
@@ -12,7 +12,7 @@ describe('UsersController GetByID', () => {
 });
 
 describe('UsersController Create', () => {
-  it('Create is requested', () => {
+  it('should request create', () => {
     const res = { json: jest.fn((x) => x), status: jest.fn((x) => x) };
     const callback = () => null;
 
@@ -22,7 +22,7 @@ describe('UsersController Create', () => {
 });
 
 describe('UsersController Update', () => {
-  it('Update is requested', () => {
+  it('should request an update', () => {
     const res = { json: jest.fn((x) => x), status: jest.fn((x) => x) };
     const callback = () => null;
 
@@ -32,7 +32,7 @@ describe('UsersController Update', () => {
 });
 
 describe('UsersController Delete', () => {
-  it('Delete is requested', () => {
+  it('should request a delete', () => {
     const res = { json: jest.fn((x) => x), status: jest.fn((x) => x) };
     const callback = () => null;
 

app/internal/core/providers/config.provider.js

@@ -0,0 +1,45 @@
+import { Adapters } from '../../../app/internal/adapters';
+import { Auth } from '../../../app/internal/core/middlewares';
+
+const { JWT } = Adapters.Auth;
+
+describe('AuthMiddleware', () => {
+  const req = {
+    headers: {
+      authorization: 'Bearer valid_token',
+    },
+    path: '/users/some-route',
+    defaultConfig: {
+      auth: {
+        secretKey: 'your_secret_key',
+      },
+    },
+  };
+
+  const res = {};
+  const next = jest.fn();
+
+  it('should call next if token is valid and path is in tokenPaths', () => {
+    jest.spyOn(JWT, 'verifyToken').mockReturnValueOnce(true);
+    Auth(req, res, next);
+    expect(next).toHaveBeenCalled();
+  });
+
+  it('should call next if token is not provided', () => {
+    req.headers.authorization = undefined;
+    Auth(req, res, next);
+    expect(next).toHaveBeenCalled();
+  });
+
+  it('should call next if token is "undefined"', () => {
+    req.headers.authorization = 'Bearer undefined';
+    Auth(req, res, next);
+    expect(next).toHaveBeenCalled();
+  });
+
+  it('should call next if path is not in tokenPaths', () => {
+    req.path = '/some-other-route';
+    Auth(req, res, next);
+    expect(next).toHaveBeenCalled();
+  });
+});

jsdoc.json

@@ -0,0 +1,25 @@
+import { constants } from 'http2';
+import { HandlerError } from '../../../app/internal/core/middlewares';
+
+describe('HandlerErrorMiddleware', () => {
+  it('should send a JSON response with the error message and set status code', () => {
+    const errorMessage = 'This is an error message';
+    const errorStatus = constants.HTTP_STATUS_BAD_REQUEST;
+    const res = {
+      json: jest.fn(),
+      status: jest.fn(),
+    };
+    const next = jest.fn();
+
+    HandlerError(
+      { message: errorMessage, status: errorStatus },
+      null,
+      res,
+      next,
+    );
+
+    expect(res.json).toHaveBeenCalledWith({ error: errorMessage });
+    expect(res.status).toHaveBeenCalledWith(errorStatus);
+    expect(next).not.toHaveBeenCalled(); // Ensure next function is not called
+  });
+});

test/functional/controllers/auth.controller.test.js

@@ -0,0 +1,27 @@
+import { Logger } from '../../../app/internal/core/middlewares';
+
+describe('LoggerMiddleware', () => {
+  let req;
+  let res;
+  let next;
+
+  beforeEach(() => {
+    req = {
+      path: '/test',
+    };
+    res = {};
+    next = jest.fn();
+  });
+
+  it('should attach a logger to the request object', () => {
+    Logger(req, res, next);
+    expect(req.logger).toBeDefined();
+    expect(req.logger.info).toBeDefined();
+  });
+
+  it('should call the next function', () => {
+    Logger(req, res, next);
+
+    expect(next).toHaveBeenCalled();
+  });
+});