Merge pull request #2 from vibhasfl/feature/adding-mysql-support

Feature/adding mysql support

Author: vibhasfl

README.md

@@ -1,13 +1,14 @@
 # express-mongoose-es8-rest-api
 
 ## Description
-Nodejs boilerplate with express,Mongoose,ES8,Jwt to develop rest api
+Nodejs boilerplate with express,Mongoose,Mysql,ES8,Jwt to develop rest api
 
 [![specification](https://img.shields.io/badge/ES8/ECMASCRIPT-2017-yellow.svg)](https://www.ecma-international.org/ecma-262/8.0/index.html)
 ![node version](https://img.shields.io/badge/node-%3E%3D%208.10.0-brightgreen.svg)
 [![express](https://img.shields.io/badge/express-4.x-orange.svg)](https://github.com/expressjs/express)
 [![mongoose](https://img.shields.io/badge/mongoose-5.4.12-red.svg)](https://mongoosejs.com/)
 [![jsonwebtoken](https://img.shields.io/badge/jsonwebtoken-8.4.0-green.svg)](https://github.com/auth0/node-jsonwebtoken)
+[![mysql](https://img.shields.io/badge/mysql-2.16-blue.svg)](https://github.com/mysqljs/mysql)
 [![code style](https://img.shields.io/badge/eslint--config--standard-%5E12.0.0-blue.svg)](https://github.com/standard/eslint-config-standard)
 ![Dependencies](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)
 
@@ -25,7 +26,7 @@ Nodejs boilerplate with express,Mongoose,ES8,Jwt to develop rest api
 - Manage enviroment via [dotenv](https://github.com/rolodato/dotenv-safe)
 - Code coverage with [istanbul](https://github.com/istanbuljs/nyc)
 - uses [helmet](https://github.com/helmetjs/helmet) to secure api endpoints which adds necessary security headers
-
+- Added support for databases like [mysql](https://github.com/mysqljs/mysql) and [mongoDB](https://github.com/Automattic/mongoose) with async await
 ## Getting Started
 1. Clone repository
 ``` 

index.js

@@ -1,7 +1,20 @@
+import debug from 'debug'
 require('dotenv').load()
+const log = debug('app')
 
-let unusedEnvVars = [ 'MONGO_HOSTNAME', 'MONGO_PORT', 'MONGO_DATABASE' ].filter((i) => !process.env[i])
-if (unusedEnvVars.length) throw new Error('Required ENV variables are not set: [' + unusedEnvVars.join(', ') + ']')
+let applicationEnvVars = [ 'APP_ENVIROMENT', 'PORT', 'USE_MONGODB', 'USE_MYSQL' ]
+let mysqlEnvVars = [ 'MYSQL_HOSTNAME', 'MYSQL_PORT', 'MYSQL_USERNAME', 'MYSQL_DATABASE', 'MYSQL_PASSWORD' ]
+let mongoEnvVars = [ 'MONGO_HOSTNAME', 'MONGO_PORT', 'MONGO_DATABASE' ]
+
+if (process.env.USE_MONGODB) applicationEnvVars = [ ...applicationEnvVars, ...mongoEnvVars ]
+if (process.env.USE_MYSQL) applicationEnvVars = [ ...applicationEnvVars, ...mysqlEnvVars ]
+
+let unusedEnvVars = applicationEnvVars.filter((i) => !process.env[i])
+
+if (unusedEnvVars.length) {
+  log('Required ENV variables are not set: [' + unusedEnvVars.join(', ') + ']')
+  process.exit(1)
+}
 
 const { app } = require('./server/app.js')
 

package.json

@@ -14,7 +14,8 @@
     "helmet": "^3.15.1",
     "joi": "^14.3.1",
     "jsonwebtoken": "^8.4.0",
-    "mongoose": "^5.4.10"
+    "mongoose": "^5.4.10",
+    "mysql": "^2.16.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.2.3",

server/app.js

@@ -8,19 +8,22 @@ import helmet from 'helmet'
 import { httpStatus } from './utils/httpStatus'
 import { AppError } from './utils/appError'
 import { secretCallback } from './utils/secretCallback'
+import { connectMysql } from './config/mysqlconnect'
+
 const app = express()
 
 app.use(bodyParser.json())
 app.use(helmet())
-app.use(jwt({ secret: secretCallback }).unless({ path: [ '/api/health-check', '/api/users', '/api/auth/login' ], requestProperty: 'auth' }))
+app.use(jwt({ secret: secretCallback }).unless({ path: [ '/api/health-check', '/api/users', '/api/auth/login', '/api/users/testmysqlroute' ], requestProperty: 'auth' }))
 app.use('/api', Router)
 
 // Handle 404
 app.use(function (req, res, next) {
   throw new AppError('Resource not found', httpStatus.NOT_FOUND)
 })
 
-connectMongo()
+if (process.env.USE_MONGODB === 'true') connectMongo()
+if (process.env.USE_MYSQL === 'true') connectMysql()
 
 app.use(errorHandler)
 

server/config/errorHandler.js

@@ -8,7 +8,7 @@ const log = debug('app')
 // Note : calling next(err) will call this error handler if no other handler id defined.You can handle custom error over here
 
 const errorHandler = (err, req, res, next) => {
-  log(err)
+  log(err.toString())
 
   if (err instanceof AppError) return res.status(err.status).json({ error: err.message, stack: process.env.APP_ENVIROMENT === 'dev' ? err.stack : undefined })
 

server/config/mongoconnect.js

@@ -6,23 +6,23 @@ const log = debug('app')
 mongoose.Promise = Promise
 
 mongoose.connection.on('connected', () => {
-  log('Connection Established')
+  log('MongoDB Connection Established')
 })
 
 mongoose.connection.on('reconnected', () => {
-  log('Connection Reestablished')
+  log('MongoDB Connection Reestablished')
 })
 
 mongoose.connection.on('disconnected', () => {
-  log('Connection Disconnected')
+  log('MongoDB Connection Disconnected')
 })
 
 mongoose.connection.on('close', () => {
-  log('Connection Closed')
+  log('MongoDB Connection Closed')
 })
 
 mongoose.connection.on('error', (error) => {
-  log('ERROR: ' + error)
+  log('MongoDB ERROR: ' + error)
   process.exit(1)
 })
 

server/config/mysqlconnect.js

@@ -0,0 +1,28 @@
+import mysql from 'mysql'
+import debug from 'debug'
+import util from 'util'
+
+const log = debug('app')
+// Note : You can remove mysqldetaillog and use log instead
+const mysqldetaillog = debug('mysqldetaillog')
+
+const pool = mysql.createPool({ host: process.env.MYSQL_HOSTNAME, user: process.env.MYSQL_USERNAME, password: process.env.MYSQL_PASSWORD, database: process.env.MYSQL_DATABASE })
+
+pool.on('connection', (connection) => mysqldetaillog(`Mysql Connection #${connection.threadId} created`))
+pool.on('acquire', (connection) => mysqldetaillog(`Mysql Connection #${connection.threadId} acquired`))
+pool.on('release', (connection) => mysqldetaillog(`Mysql Connection #${connection.threadId} released`))
+
+pool.query = util.promisify(pool.query)
+
+export const connectMysql = () => {
+  pool.getConnection(function (err, connection) {
+    if (err) {
+      log(`Mysql ${err.toString()}`)
+      process.exit(1)
+    }
+    log(`Mysql connection established`)
+    connection.release()
+  })
+}
+
+export { pool }

server/modules/users/user.routes.js

@@ -9,5 +9,6 @@ const userRoutes = express.Router()
 userRoutes.get('/', asyncWrapper(users.index))
 userRoutes.post('/', validate(newuser), asyncWrapper(users.create))
 userRoutes.put('/:id', asyncWrapper(users.update))
+userRoutes.get('/testmysqlroute', asyncWrapper(users.testMysql))
 
 export { userRoutes }

server/modules/users/users.controller.js

@@ -1,5 +1,6 @@
 import { userModel } from './user.model'
 import { httpStatus } from '../../utils/httpStatus'
+import { pool } from '../../config/mysqlconnect'
 const users = {}
 
 users.index = async (req, res) => {
@@ -21,4 +22,8 @@ users.update = async (req, res) => {
   return res.json({ message: 'Record updated' })
 }
 
+users.testMysql = async (req, res) => {
+  let data = await pool.query('Select * from users')
+  return res.json({ data })
+}
 export { users }