nodejs-quickstart-structure 1.13.0 → 1.14.0

package/templates/mvc/ts/src/controllers/userController.spec.ts.ejs

@@ -0,0 +1,185 @@
+<% if (communication !== 'GraphQL') { -%>
+import { Request, Response, NextFunction } from 'express';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+<% } -%>
+import { UserController } from '@/controllers/userController';
+import User from '@/models/User';
+<%_ if (caching === 'Redis') { -%>
+import cacheService from '@/config/redisClient';
+<%_ } else if (caching === 'Memory Cache') { -%>
+import cacheService from '@/config/memoryCache';
+<%_ } -%>
+
+// Mock dependencies
+jest.mock('@/models/User');
+<%_ if (caching === 'Redis') { -%>
+jest.mock('@/config/redisClient', () => ({
+    getOrSet: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } else if (caching === 'Memory Cache') { -%>
+jest.mock('@/config/memoryCache', () => ({
+    getOrSet: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } -%>
+jest.mock('@/utils/logger');
+
+describe('UserController', () => {
+    let userController: UserController;
+<% if (communication !== 'GraphQL') { -%>
+    let mockRequest: Partial<Request>;
+    let mockResponse: Partial<Response>;
+    let mockNext: NextFunction;
+<% } -%>
+
+    beforeEach(() => {
+        userController = new UserController();
+<% if (communication !== 'GraphQL') { -%>
+        mockRequest = {};
+        mockResponse = {
+            json: jest.fn(),
+            status: jest.fn().mockReturnThis(),
+        };
+        mockNext = jest.fn();
+<% } -%>
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    describe('getUsers', () => {
+        it('should return successfully (Happy Path)', async () => {
+            // Arrange
+            const usersMock = [{ id: '1', name: 'Test', email: 'test@example.com' }];
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            (cacheService.getOrSet as jest.Mock).mockResolvedValue(usersMock);
+<%_ } else { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
+            (User.find as jest.Mock).mockResolvedValue(usersMock);
+<%_ } else { -%>
+            (User.findAll as jest.Mock).mockResolvedValue(usersMock);
+<%_ } -%>
+<%_ } -%>
+
+            // Act
+<% if (communication === 'GraphQL') { -%>
+            const result = await userController.getUsers();
+
+            // Assert
+            expect(result).toEqual(usersMock);
+<% } else { -%>
+            await userController.getUsers(mockRequest as Request, mockResponse as Response, mockNext);
+
+            // Assert
+            expect(mockResponse.json).toHaveBeenCalledWith(usersMock);
+<% } -%>
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            expect(cacheService.getOrSet).toHaveBeenCalled();
+<%_ } else { -%>
+<%_ if (database === 'MongoDB') { -%>
+            expect(User.find).toHaveBeenCalled();
+<%_ } else if (database === 'None') { -%>
+            // No DB mock logic
+<%_ } else { -%>
+            expect(User.findAll).toHaveBeenCalled();
+<%_ } -%>
+<%_ } -%>
+        });
+
+        it('should handle errors correctly (Error Handling)', async () => {
+            // Arrange
+            const error = new Error('Database Error');
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            (cacheService.getOrSet as jest.Mock).mockRejectedValue(error);
+<%_ } else { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
+            (User.find as jest.Mock).mockRejectedValue(error);
+<%_ } else { -%>
+            (User.findAll as jest.Mock).mockRejectedValue(error);
+<%_ } -%>
+<%_ } -%>
+
+            // Act & Assert
+<% if (communication === 'GraphQL') { -%>
+            await expect(userController.getUsers()).rejects.toThrow(error);
+<% } else { -%>
+            await userController.getUsers(mockRequest as Request, mockResponse as Response, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<% } -%>
+        });
+    });
+
+    describe('createUser', () => {
+        it('should successfully create a new user (Happy Path)', async () => {
+            // Arrange
+            const payload = { name: 'Alice', email: 'alice@example.com' };
+<% if (communication === 'GraphQL') { -%>
+            const dataArg = payload;
+<% } else { -%>
+            mockRequest.body = payload;
+<% } -%>
+            
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
+            const expectedUser = { id: '1', ...payload };
+            (User.create as jest.Mock).mockResolvedValue(expectedUser);
+            <%_ if (database === 'None') { -%>User.mockData = [expectedUser];<%_ } -%>
+<%_ } else { -%>
+            const expectedUser = { id: '1', ...payload };
+            (User.create as jest.Mock).mockResolvedValue(expectedUser);
+<%_ } -%>
+
+            // Act
+<% if (communication === 'GraphQL') { -%>
+            const result = await userController.createUser(dataArg);
+
+            // Assert
+<%_ if (database === 'None') { -%>
+            expect(result.name).toBe(payload.name);
+            expect(result.email).toBe(payload.email);
+            expect(User.mockData.length).toBe(1);
+<%_ } else { -%>
+            expect(result).toEqual(expectedUser);
+            expect(User.create).toHaveBeenCalledWith(payload);
+<%_ } -%>
+<% } else { -%>
+            await userController.createUser(mockRequest as Request, mockResponse as Response, mockNext);
+
+            // Assert
+            expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.CREATED);
+<%_ if (database === 'None') { -%>
+            expect(mockResponse.json).toHaveBeenCalled();
+            expect(User.mockData.length).toBe(1);
+<%_ } else { -%>
+            expect(mockResponse.json).toHaveBeenCalledWith(expectedUser);
+            expect(User.create).toHaveBeenCalledWith(payload);
+<%_ } -%>
+<% } -%>
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            expect(cacheService.del).toHaveBeenCalledWith('users:all');
+<%_ } -%>
+        });
+
+        it('should handle errors when creation fails (Error Handling)', async () => {
+            // Arrange
+            const error = new Error('Creation Error');
+            const payload = { name: 'Bob', email: 'bob@example.com' };
+<% if (communication === 'GraphQL') { -%>
+            const dataArg = payload;
+<% } else { -%>
+            mockRequest.body = payload;
+<% } -%>
+
+            (User.create as jest.Mock).mockRejectedValue(error);
+
+            // Act & Assert
+<% if (communication === 'GraphQL') { -%>
+            await expect(userController.createUser(dataArg)).rejects.toThrow(error);
+<% } else { -%>
+            await userController.createUser(mockRequest as Request, mockResponse as Response, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<% } -%>
+        });
+    });
+});

package/templates/mvc/ts/src/controllers/userController.ts.ejs

@@ -16,19 +16,15 @@ export class UserController {
         try {
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
             const users = await cacheService.getOrSet('users:all', async () => {
-<%_ if (database === 'MongoDB') { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
                 return await User.find();
-<%_ } else if (database === 'None') { -%>
-                return User.mockData;
 <%_ } else { -%>
                 return await User.findAll();
 <%_ } -%>
             }, 60);
 <%_ } else { -%>
-<%_ if (database === 'MongoDB') { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
             const users = await User.find();
-<%_ } else if (database === 'None') { -%>
-            const users = User.mockData;
 <%_ } else { -%>
             const users = await User.findAll();
 <%_ } -%>
@@ -43,20 +39,11 @@ export class UserController {
     async createUser(data: { name: string, email: string }) {
         try {
             const { name, email } = data;
-<%_ if (database === 'None') { -%>
-            const newUser = { id: String(User.mockData.length + 1), name, email };
-            User.mockData.push(newUser);
-<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
-            await cacheService.del('users:all');
-<%_ } -%>
-            return newUser;
-<%_ } else { -%>
             const user = await User.create({ name, email });
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
             await cacheService.del('users:all');
 <%_ } -%>
             return user;
-<%_ } -%>
         } catch (error) {
             logger.error('Error creating user:', error);
             throw error;
@@ -67,19 +54,15 @@ export class UserController {
         try {
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
             const users = await cacheService.getOrSet('users:all', async () => {
-<%_ if (database === 'MongoDB') { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
                 return await User.find();
-<%_ } else if (database === 'None') { -%>
-                return User.mockData;
 <%_ } else { -%>
                 return await User.findAll();
 <%_ } -%>
             }, 60);
 <%_ } else { -%>
-<%_ if (database === 'MongoDB') { -%>
+<%_ if (database === 'MongoDB' || database === 'None') { -%>
             const users = await User.find();
-<%_ } else if (database === 'None') { -%>
-            const users = User.mockData;
 <%_ } else { -%>
             const users = await User.findAll();
 <%_ } -%>
@@ -94,20 +77,11 @@ export class UserController {
     async createUser(req: Request, res: Response, next: NextFunction) {
         try {
             const { name, email } = req.body;
-<%_ if (database === 'None') { -%>
-            const newUser = { id: String(User.mockData.length + 1), name, email };
-            User.mockData.push(newUser);
-<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
-            await cacheService.del('users:all');
-<%_ } -%>
-            res.status(HTTP_STATUS.CREATED).json(newUser);
-<%_ } else { -%>
             const user = await User.create({ name, email });
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
             await cacheService.del('users:all');
 <%_ } -%>
             res.status(HTTP_STATUS.CREATED).json(user);
-<%_ } -%>
         } catch (error) {
             logger.error('Error creating user:', error);
             next(error);
@@ -115,4 +89,3 @@ export class UserController {
     }
 <% } -%>
 }
-

package/templates/mvc/ts/src/errors/BadRequestError.spec.ts.ejs

@@ -0,0 +1,21 @@
+import { BadRequestError } from '@/errors/BadRequestError';
+import { ApiError } from '@/errors/ApiError';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+
+describe('BadRequestError', () => {
+    it('should extend ApiError', () => {
+        const error = new BadRequestError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Bad request"', () => {
+        const error = new BadRequestError();
+        expect(error.message).toBe('Bad request');
+        expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new BadRequestError('Custom bad request');
+        expect(error.message).toBe('Custom bad request');
+    });
+});

package/templates/mvc/ts/src/errors/BadRequestError.ts

@@ -1,4 +1,4 @@
-import { ApiError } from './ApiError';
+import { ApiError } from '@/errors/ApiError';
 import { HTTP_STATUS } from '@/utils/httpCodes';
 
 export class BadRequestError extends ApiError {

package/templates/mvc/ts/src/errors/NotFoundError.spec.ts.ejs

@@ -0,0 +1,21 @@
+import { NotFoundError } from '@/errors/NotFoundError';
+import { ApiError } from '@/errors/ApiError';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+
+describe('NotFoundError', () => {
+    it('should extend ApiError', () => {
+        const error = new NotFoundError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Resource not found"', () => {
+        const error = new NotFoundError();
+        expect(error.message).toBe('Resource not found');
+        expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new NotFoundError('User not found');
+        expect(error.message).toBe('User not found');
+    });
+});

package/templates/mvc/ts/src/errors/NotFoundError.ts

@@ -1,4 +1,4 @@
-import { ApiError } from './ApiError';
+import { ApiError } from '@/errors/ApiError';
 import { HTTP_STATUS } from '@/utils/httpCodes';
 
 export class NotFoundError extends ApiError {

package/templates/mvc/ts/src/graphql/context.spec.ts.ejs

@@ -0,0 +1,30 @@
+import { gqlContext } from '@/graphql/context';
+import { Request } from 'express';
+import { resolvers } from '@/graphql/resolvers';
+import { typeDefs } from '@/graphql/typeDefs';
+
+describe('GraphQL Context', () => {
+  it('should exercise GraphQL index entry points', () => {
+    expect(resolvers).toBeDefined();
+    expect(typeDefs).toBeDefined();
+  });
+  it('should return context with token when authorization header is present', async () => {
+    const mockRequest = {
+      headers: {
+        authorization: 'Bearer token123',
+      },
+    } as Request;
+
+    const context = await gqlContext({ req: mockRequest });
+    expect(context).toEqual({ token: 'Bearer token123' });
+  });
+
+  it('should return context with empty token when authorization header is missing', async () => {
+    const mockRequest = {
+      headers: {},
+    } as Request;
+
+    const context = await gqlContext({ req: mockRequest });
+    expect(context).toEqual({ token: '' });
+  });
+});

package/templates/mvc/ts/src/graphql/resolvers/user.resolvers.spec.ts.ejs

@@ -0,0 +1,51 @@
+import { userResolvers } from '@/graphql/resolvers/user.resolvers';
+
+const mockGetUsers = jest.fn().mockResolvedValue([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
+const mockCreateUser = jest.fn().mockResolvedValue({ id: '1', name: 'Jane', email: 'jane@example.com' });
+
+jest.mock('@/controllers/userController', () => {
+  return {
+    UserController: jest.fn().mockImplementation(() => ({
+      getUsers: (...args: unknown[]) => mockGetUsers(...args),
+      createUser: (...args: unknown[]) => mockCreateUser(...args)
+    }))
+  };
+});
+
+describe('User Resolvers', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('Query.getAllUsers', () => {
+    it('should return all users', async () => {
+      const result = await userResolvers.Query.getAllUsers();
+      expect(result).toEqual([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
+      expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('Mutation.createUser', () => {
+    it('should create and return a new user', async () => {
+      const result = await userResolvers.Mutation.createUser(null, { name: 'Jane', email: 'jane@example.com' });
+      expect(result).toEqual({ id: '1', name: 'Jane', email: 'jane@example.com' });
+      expect(mockCreateUser).toHaveBeenCalledWith({ name: 'Jane', email: 'jane@example.com' });
+      expect(mockCreateUser).toHaveBeenCalledTimes(1);
+    });
+  });
+<%_ if (database === 'MongoDB') { -%>
+  describe('User.id', () => {
+    it('should return parent.id if available', () => {
+      const parent = { id: '123' };
+      const result = userResolvers.User.id(parent as { id?: string; _id?: unknown });
+      expect(result).toBe('123');
+    });
+
+    it('should fallback to parent._id if id is not available', () => {
+      const parent = { _id: '456' };
+      const result = userResolvers.User.id(parent as { id?: string; _id?: unknown });
+      expect(result).toBe('456');
+    });
+  });
+<%_ } -%>
+});

package/templates/mvc/ts/src/routes/api.spec.ts.ejs

@@ -0,0 +1,40 @@
+import request from 'supertest';
+import express, { Express } from 'express';
+import router from '@/routes/api';
+
+const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
+const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
+
+jest.mock('@/controllers/userController', () => {
+  return {
+    UserController: jest.fn().mockImplementation(() => ({
+      getUsers: (...args: unknown[]) => mockGetUsers(...args),
+      createUser: (...args: unknown[]) => mockCreateUser(...args)
+    }))
+  };
+});
+
+describe('ApiRoutes', () => {
+    let app: Express;
+
+    beforeEach(() => {
+        app = express();
+        app.use(express.json());
+        app.use('/api', router);
+    });
+
+    it('GET /users should call controller.getUsers', async () => {
+        await request(app)
+            .get('/api/users');
+
+        expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+
+    it('POST /api/users should call controller.createUser', async () => {
+        await request(app)
+            .post('/api/users')
+            .send({ name: 'Test', email: 'test@example.com' });
+
+        expect(mockCreateUser).toHaveBeenCalledTimes(1);
+    });
+});

package/templates/mvc/ts/src/utils/errorMiddleware.ts.ejs

@@ -3,8 +3,7 @@ import logger from '@/utils/logger';
 import { ApiError } from '@/errors/ApiError';
 import { HTTP_STATUS } from '@/utils/httpCodes';
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const errorMiddleware = (err: Error, req: Request, res: Response, next: unknown) => {
+export const errorMiddleware = (err: Error, req: Request, res: Response, _next: unknown) => {
   let error = err;
 
   if (!(error instanceof ApiError)) {

package/templates/mvc/ts/src/utils/logger.spec.ts.ejs

@@ -0,0 +1,64 @@
+jest.mock('winston-daily-rotate-file');
+jest.mock('winston', () => {
+    const mockLogger = {
+        add: jest.fn(),
+        info: jest.fn(),
+        error: jest.fn(),
+        warn: jest.fn()
+    };
+    const format = {
+        combine: jest.fn(),
+        timestamp: jest.fn(),
+        json: jest.fn(),
+        simple: jest.fn()
+    };
+    const transports = {
+        Console: jest.fn(),
+        DailyRotateFile: jest.fn()
+    };
+    return {
+        format,
+        transports,
+        createLogger: jest.fn().mockReturnValue(mockLogger)
+    };
+});
+
+<% if (architecture === 'MVC') { -%>
+import logger from '@/utils/logger';
+<% } else { -%>
+import logger from '@/infrastructure/log/logger';
+<% } -%>
+
+describe('Logger', () => {
+    it('should export a logger instance', () => {
+        expect(logger).toBeDefined();
+    });
+
+    it('should have info method', () => {
+        expect(typeof logger.info).toBe('function');
+    });
+
+    it('should have error method', () => {
+        expect(typeof logger.error).toBe('function');
+    });
+
+    it('should call info', () => {
+        logger.info('test message');
+        expect(logger.info).toHaveBeenCalledWith('test message');
+    });
+
+    it('should call error', () => {
+        logger.error('test error');
+        expect(logger.error).toHaveBeenCalledWith('test error');
+    });
+
+    it('should use JSON format in production environment', () => {
+        const winston = require('winston');
+        jest.resetModules();
+        process.env.NODE_ENV = 'production';
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        require('<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>');
+        expect(winston.format.json).toHaveBeenCalled();
+        process.env.NODE_ENV = 'test';
+    });
+});