Merge pull request #3 from vibhasfl/feature/adding-fileupload

Added fileupload using multer

Author: vibhasfl

.env.sample

@@ -12,4 +12,5 @@ MYSQL_USERNAME='root'
 MYSQL_PASSWORD='root'
 MYSQL_DATABASE='testdb'
 USE_MONGODB='true'
-USE_MYSQL='true'
+USE_MYSQL='true'
+FILE_UPLOAD_SIZE_IN_BYTES=1000000

README.md

@@ -26,7 +26,9 @@ Nodejs boilerplate with express,Mongoose,Mysql,JWT,ES6,ES7,ES8 support to develo
 - 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
+- Added support for databases like [mysql](https://github.com/mysqljs/mysql) and [mongoDB](https://github.com/Automattic/mongoose) with 
+async await
+- Fileupload using [multer](https://github.com/expressjs/multer)
 ## Getting Started
 1. Clone repository
 ``` 

package.json

@@ -15,6 +15,7 @@
     "joi": "^14.3.1",
     "jsonwebtoken": "^8.4.0",
     "mongoose": "^5.4.10",
+    "multer": "^1.4.1",
     "mysql": "^2.16.0"
   },
   "devDependencies": {

server/app.js

@@ -14,7 +14,7 @@ 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', '/api/users/testmysqlroute' ], requestProperty: 'auth' }))
+app.use(jwt({ secret: secretCallback }).unless({ path: [ '/api/health-check', '/api/users', '/api/auth/login', '/api/users/testmysqlroute', '/api/fileupload' ], requestProperty: 'auth' }))
 app.use('/api', Router)
 
 // Handle 404

server/config/errorHandler.js

@@ -1,6 +1,5 @@
 import { httpStatus } from '../utils/httpStatus'
 import debug from 'debug'
-import { AppError } from '../utils/appError'
 
 const log = debug('app')
 
@@ -10,7 +9,7 @@ const log = debug('app')
 const errorHandler = (err, req, res, next) => {
   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 })
+  if (err.name === 'AppError') return res.status(err.status).json({ error: err.message, stack: process.env.APP_ENVIROMENT === 'dev' ? err.stack : undefined })
 
   if (err.name === 'UnauthorizedError') return res.status(httpStatus.UNAUTHORIZED).json({ error: err.message })
 

server/config/routes.js

@@ -1,10 +1,17 @@
 import express from 'express'
 import { userRoutes } from '../modules/users/user.routes'
 import { authRoutes } from '../modules/auth/auth.routes'
+import { upload } from '../utils/upload'
+import { httpStatus } from '../utils/httpStatus'
 const Router = express.Router()
 
 Router.all('/health-check', (req, res) => res.json({ message: 'OK' }))
 Router.use('/users', userRoutes)
 Router.use('/auth', authRoutes)
 
+Router.post('/fileupload', upload.single('avatar'), (req, res) => {
+  if (!req.file) return res.status(httpStatus.UNPROCESSABLE_ENTITY).json({ error: 'Please select file' })
+  return res.json({ data: req.file })
+})
+
 export { Router }

server/utils/appError.js

@@ -2,6 +2,6 @@ export class AppError extends Error {
   constructor (message, status) {
     super(message)
     this.status = status
-    Error.captureStackTrace(this, AppError)
+    this.name = 'AppError'
   }
 }

server/utils/upload.js

@@ -0,0 +1,28 @@
+import multer from 'multer'
+import crypto from 'crypto'
+import { AppError } from './appError'
+import { httpStatus } from './httpStatus'
+
+// Ref : https://www.npmjs.com/package/multer
+
+const storage = multer.diskStorage({
+  // Note : You can set your own upload path Ref : https://www.npmjs.com/package/multer#diskstorage
+  // destination: function (req, file, cb) {},
+  filename: function (req, file, cb) {
+    crypto.randomBytes(16, function (err, raw) {
+      if (err) cb(err)
+      cb(null, raw.toString('hex') + Date.now() + '.' + file.originalname.split('.').pop().trim())
+    })
+  }
+})
+
+const limits = { fileSize: parseInt(process.env.FILE_UPLOAD_SIZE_IN_BYTES) || 1000000 }
+
+const fileFilter = function (req, file, cb) {
+  if (![ 'image/png', 'image/jpg', 'image/jpeg' ].includes(file.mimetype)) {
+    return cb(new AppError('Only jpg,jpeg,png formats are allowed', httpStatus.UNPROCESSABLE_ENTITY))
+  }
+  cb(null, true)
+}
+
+export const upload = multer({ storage, limits, fileFilter })