nodejs-quickstart-structure 1.18.1 → 1.19.1

package/templates/mvc/js/src/index.js.ejs

@@ -1,137 +1,137 @@
-const { env } = require('./config/env');
-const express = require('express');
-const cors = require('cors');
-<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>const apiRoutes = require('./routes/api');<%_ } %>
-const healthRoutes = require('./routes/healthRoute');
-<%_ if (communication === 'Kafka') { -%>const { connectKafka, sendMessage } = require('./services/kafkaService');<%_ } -%>
-<%_ if (communication === 'GraphQL') { -%>
-const { ApolloServer } = require('@apollo/server');
-const { expressMiddleware } = require('@as-integrations/express4');
-const { ApolloServerPluginLandingPageLocalDefault } = require('@apollo/server/plugin/landingPage/default');
-const { unwrapResolverError } = require('@apollo/server/errors');
-const { ApiError } = require('./errors/ApiError');
-const { typeDefs, resolvers } = require('./graphql');
-const { gqlContext } = require('./graphql/context');
-<% } %>
-<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-const swaggerUi = require('swagger-ui-express');
-const swaggerSpecs = require('./config/swagger');
-<%_ } -%>
-const setupGracefulShutdown = require('./utils/gracefulShutdown');
-
-const app = express();
-const PORT = env.PORT;
-const logger = require('./utils/logger');
-const morgan = require('morgan');
-const { errorMiddleware } = require('./utils/errorMiddleware');
-
-app.use(cors());
-app.use(express.json());
-app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
-
-<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
-<%_ } -%>
-<%_ if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
-// View Engine Setup
-const path = require('path');
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', '<%= viewEngine.toLowerCase() %>');
-app.use(express.static(path.join(__dirname, '../public')));<%_ } %>
-<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-app.use('/api', apiRoutes);
-<%_ } -%><% if (viewEngine && viewEngine !== 'None') { -%>
-app.get('/', (req, res) => {
-  res.render('index', { 
-    projectName: 'NodeJS Service',
-    architecture: 'MVC',
-    database: '<%= database %>',
-    communication: '<%= communication %>'
-  });
-});
-<% } -%>
-app.use('/health', healthRoutes);
-
-// Start Server Logic
-const startServer = async () => {
-<%_ if (communication === 'GraphQL') { -%>
-    // GraphQL Setup
-    const apolloServer = new ApolloServer({
-      typeDefs,
-      resolvers,
-      plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
-      formatError: (formattedError, error) => {
-        const originalError = unwrapResolverError(error);
-        if (originalError instanceof ApiError) {
-          return {
-            ...formattedError,
-            message: originalError.message,
-            extensions: {
-              ...formattedError.extensions,
-              code: originalError.statusCode.toString(),
-            }
-          };
-        }
-        
-        logger.error(`GraphQL Error: ${formattedError.message}`);
-        if (originalError && originalError.stack && process.env.NODE_ENV === 'development') {
-           logger.error(originalError.stack);
-        }
-        return formattedError;
-      },
-    });
-    await apolloServer.start();
-    app.use('/graphql', expressMiddleware(apolloServer, { context: gqlContext }));
-<%_ } -%>
-    app.use(errorMiddleware);
-    const server = app.listen(PORT, () => {
-        logger.info(`Server running on port ${PORT}`);
-<%_ if (communication === 'Kafka') { -%>
-        connectKafka()
-            .then(async () => {
-                logger.info('Kafka connected');
-            })
-            .catch(err => {
-                logger.error('Failed to connect to Kafka after retries:', err.message);
-            });
-<%_ } -%>
-    });
-
-    setupGracefulShutdown(server);
-};
-
-<%_ if (database !== 'None') { -%>
-// Database Sync
-<%_ if (database !== 'None') { -%>
-<%_ if (database === 'MongoDB') { -%>
-const connectDB = require('./config/database');
-<%_ } else { -%>
-const sequelize = require('./config/database');
-<%_ } -%>
-<%_ } -%>
-const syncDatabase = async () => {
-    let retries = 30;
-    while (retries) {
-        try {
-            <%_ if (database === 'MongoDB') { -%>
-            await connectDB();
-            <%_ } else { -%>
-            await sequelize.sync();
-            <%_ } -%>
-            logger.info('Database synced');
-            // Start Server after DB is ready
-            await startServer();
-            break;
-        } catch (err) {
-            logger.error('Database sync failed:', err);
-            retries -= 1;
-            logger.info(`Retries left: ${retries}. Waiting 5s...`);
-            await new Promise(res => setTimeout(res, 5000));
-        }
-    }
-};
-
-syncDatabase();
-<%_ } else { -%>
-startServer();
+const { env } = require('./config/env');
+const express = require('express');
+const cors = require('cors');
+<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>const apiRoutes = require('./routes/api');<%_ } %>
+const healthRoutes = require('./routes/healthRoute');
+<%_ if (communication === 'Kafka') { -%>const { connectKafka, sendMessage } = require('./services/kafkaService');<%_ } -%>
+<%_ if (communication === 'GraphQL') { -%>
+const { ApolloServer } = require('@apollo/server');
+const { expressMiddleware } = require('@as-integrations/express4');
+const { ApolloServerPluginLandingPageLocalDefault } = require('@apollo/server/plugin/landingPage/default');
+const { unwrapResolverError } = require('@apollo/server/errors');
+const { ApiError } = require('./errors/ApiError');
+const { typeDefs, resolvers } = require('./graphql');
+const { gqlContext } = require('./graphql/context');
+<% } %>
+<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+const swaggerUi = require('swagger-ui-express');
+const swaggerSpecs = require('./config/swagger');
+<%_ } -%>
+const setupGracefulShutdown = require('./utils/gracefulShutdown');
+
+const app = express();
+const PORT = env.PORT;
+const logger = require('./utils/logger');
+const morgan = require('morgan');
+const { errorMiddleware } = require('./utils/errorMiddleware');
+
+app.use(cors());
+app.use(express.json());
+app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
+
+<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
+<%_ } -%>
+<%_ if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
+// View Engine Setup
+const path = require('path');
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', '<%= viewEngine.toLowerCase() %>');
+app.use(express.static(path.join(__dirname, '../public')));<%_ } %>
+<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+app.use('/api', apiRoutes);
+<%_ } -%><% if (viewEngine && viewEngine !== 'None') { -%>
+app.get('/', (req, res) => {
+  res.render('index', { 
+    projectName: 'NodeJS Service',
+    architecture: 'MVC',
+    database: '<%= database %>',
+    communication: '<%= communication %>'
+  });
+});
+<% } -%>
+app.use('/health', healthRoutes);
+
+// Start Server Logic
+const startServer = async () => {
+<%_ if (communication === 'GraphQL') { -%>
+    // GraphQL Setup
+    const apolloServer = new ApolloServer({
+      typeDefs,
+      resolvers,
+      plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
+      formatError: (formattedError, error) => {
+        const originalError = unwrapResolverError(error);
+        if (originalError instanceof ApiError) {
+          return {
+            ...formattedError,
+            message: originalError.message,
+            extensions: {
+              ...formattedError.extensions,
+              code: originalError.statusCode.toString(),
+            }
+          };
+        }
+        
+        logger.error(`GraphQL Error: ${formattedError.message}`);
+        if (originalError && originalError.stack && process.env.NODE_ENV === 'development') {
+           logger.error(originalError.stack);
+        }
+        return formattedError;
+      },
+    });
+    await apolloServer.start();
+    app.use('/graphql', expressMiddleware(apolloServer, { context: gqlContext }));
+<%_ } -%>
+    app.use(errorMiddleware);
+    const server = app.listen(PORT, () => {
+        logger.info(`Server running on port ${PORT}`);
+<%_ if (communication === 'Kafka') { -%>
+        connectKafka()
+            .then(async () => {
+                logger.info('Kafka connected');
+            })
+            .catch(err => {
+                logger.error('Failed to connect to Kafka after retries:', err.message);
+            });
+<%_ } -%>
+    });
+
+    setupGracefulShutdown(server);
+};
+
+<%_ if (database !== 'None') { -%>
+// Database Sync
+<%_ if (database !== 'None') { -%>
+<%_ if (database === 'MongoDB') { -%>
+const connectDB = require('./config/database');
+<%_ } else { -%>
+const sequelize = require('./config/database');
+<%_ } -%>
+<%_ } -%>
+const syncDatabase = async () => {
+    let retries = 30;
+    while (retries) {
+        try {
+            <%_ if (database === 'MongoDB') { -%>
+            await connectDB();
+            <%_ } else { -%>
+            await sequelize.sync();
+            <%_ } -%>
+            logger.info('Database synced');
+            // Start Server after DB is ready
+            await startServer();
+            break;
+        } catch (err) {
+            logger.error('Database sync failed:', err);
+            retries -= 1;
+            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            await new Promise(res => setTimeout(res, 5000));
+        }
+    }
+};
+
+syncDatabase();
+<%_ } else { -%>
+startServer();
 <%_ } -%>

package/templates/mvc/js/src/routes/api.js

@@ -1,8 +1,10 @@
-const express = require('express');
-const router = express.Router();
-const userController = require('../controllers/userController');
-
-router.get('/users', userController.getUsers);
-router.post('/users', userController.createUser);
-
-module.exports = router;
+const express = require('express');
+const router = express.Router();
+const userController = require('../controllers/userController');
+
+router.get('/users', userController.getUsers);
+router.post('/users', userController.createUser);
+router.patch('/users/:id', userController.updateUser);
+router.delete('/users/:id', userController.deleteUser);
+
+module.exports = router;

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

@@ -1,36 +1,41 @@
-const request = require('supertest');
-const express = require('express');
-const router = require('@/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', () => ({
-  getUsers: (...args) => mockGetUsers(...args),
-  createUser: (...args) => mockCreateUser(...args)
-}));
-
-describe('ApiRoutes', () => {
-    let app;
-
-    beforeEach(() => {
-        app = express();
-        app.use(express.json());
-        app.use('/api', router);
-    });
-
-    it('GET /api/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);
-    });
-});
+const request = require('supertest');
+const express = require('express');
+const router = require('@/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' }));
+
+const mockUpdateUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ id: '1', name: 'Updated' }));
+const mockDeleteUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ message: 'User deleted successfully' }));
+
+jest.mock('@/controllers/userController', () => ({
+  getUsers: (...args) => mockGetUsers(...args),
+  createUser: (...args) => mockCreateUser(...args),
+  updateUser: (...args) => mockUpdateUser(...args),
+  deleteUser: (...args) => mockDeleteUser(...args)
+}));
+
+describe('ApiRoutes', () => {
+    let app;
+
+    beforeEach(() => {
+        app = express();
+        app.use(express.json());
+        app.use('/api', router);
+    });
+
+    it('GET /api/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/js/src/utils/errorMessages.js

@@ -0,0 +1,14 @@
+const ERROR_MESSAGES = {
+    USER_NOT_FOUND: 'User not found',
+    RESOURCE_NOT_FOUND: 'Resource not found',
+    INVALID_USER_DATA: 'Invalid user event data',
+    INTERNAL_SERVER_ERROR: 'Internal Server Error',
+    BAD_REQUEST: 'Bad Request',
+    FETCH_USERS_ERROR: 'Error fetching users',
+    CREATE_USER_ERROR: 'Error creating user',
+    UPDATE_USER_ERROR: 'Error updating user',
+    DELETE_USER_ERROR: 'Error deleting user',
+    DATABASE_PING_FAILED: 'Health Check Database Ping Failed',
+};
+
+module.exports = ERROR_MESSAGES;

package/templates/mvc/js/src/utils/errorMiddleware.js

@@ -1,29 +1,29 @@
-const logger = require('./logger');
-const { ApiError } = require('../errors/ApiError');
-const HTTP_STATUS = require('./httpCodes');
-
-// eslint-disable-next-line no-unused-vars
-const errorMiddleware = (err, req, res, next) => {
-  let error = err;
-
-  if (!(error instanceof ApiError)) {
-    const statusCode = err.statusCode || HTTP_STATUS.INTERNAL_SERVER_ERROR;
-    const message = error.message || 'Internal Server Error';
-    error = new ApiError(statusCode, message, false, err.stack);
-  }
-
-  const { statusCode, message } = error;
-
-  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
-    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
-    logger.error(error.stack || 'No stack trace');
-  }
-
-  res.status(statusCode).json({
-    statusCode,
-    message,
-    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
-  });
-};
-
-module.exports = { errorMiddleware };
+const logger = require('./logger');
+const { ApiError } = require('../errors/ApiError');
+const HTTP_STATUS = require('./httpCodes');
+
+// eslint-disable-next-line no-unused-vars
+const errorMiddleware = (err, req, res, next) => {
+  let error = err;
+
+  if (!(error instanceof ApiError)) {
+    const statusCode = err.statusCode || HTTP_STATUS.INTERNAL_SERVER_ERROR;
+    const message = error.message || 'Internal Server Error';
+    error = new ApiError(statusCode, message, false, err.stack);
+  }
+
+  const { statusCode, message } = error;
+
+  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
+    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
+    logger.error(error.stack || 'No stack trace');
+  }
+
+  res.status(statusCode).json({
+    statusCode,
+    message,
+    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
+  });
+};
+
+module.exports = { errorMiddleware };

package/templates/mvc/js/src/utils/httpCodes.js

@@ -1,9 +1,9 @@
-const HTTP_STATUS = {
-    OK: 200,
-    CREATED: 201,
-    BAD_REQUEST: 400,
-    NOT_FOUND: 404,
-    INTERNAL_SERVER_ERROR: 500
-};
-
-module.exports = HTTP_STATUS;
+const HTTP_STATUS = {
+    OK: 200,
+    CREATED: 201,
+    BAD_REQUEST: 400,
+    NOT_FOUND: 404,
+    INTERNAL_SERVER_ERROR: 500
+};
+
+module.exports = HTTP_STATUS;

package/templates/mvc/js/src/utils/logger.js

@@ -1,40 +1,40 @@
-const winston = require('winston');
-require('winston-daily-rotate-file');
-
-const logger = winston.createLogger({
-  level: 'info',
-  format: winston.format.combine(
-    winston.format.timestamp(),
-    winston.format.json()
-  ),
-  defaultMeta: { service: 'user-service' },
-  transports: [
-    new winston.transports.DailyRotateFile({
-      filename: 'logs/error-%DATE%.log',
-      datePattern: 'YYYY-MM-DD',
-      zippedArchive: true,
-      maxSize: '20m',
-      maxFiles: '14d',
-      level: 'error',
-    }),
-    new winston.transports.DailyRotateFile({
-      filename: 'logs/combined-%DATE%.log',
-      datePattern: 'YYYY-MM-DD',
-      zippedArchive: true,
-      maxSize: '20m',
-      maxFiles: '14d',
-    }),
-  ],
-});
-
-//
-// If we're not in production then log to the `console` with the format:
-// `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
-//
-logger.add(new winston.transports.Console({
-  format: process.env.NODE_ENV !== 'production'
-    ? winston.format.simple()
-    : winston.format.json(),
-}));
-
-module.exports = logger;
+const winston = require('winston');
+require('winston-daily-rotate-file');
+
+const logger = winston.createLogger({
+  level: 'info',
+  format: winston.format.combine(
+    winston.format.timestamp(),
+    winston.format.json()
+  ),
+  defaultMeta: { service: 'user-service' },
+  transports: [
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/error-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+      level: 'error',
+    }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/combined-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
+  ],
+});
+
+//
+// If we're not in production then log to the `console` with the format:
+// `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
+//
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
+
+module.exports = logger;