Merge pull request #4 from vibhasfl/feature/s3fileupload

Flexible fileupload to disk and s3

Author: vibhasfl

.env.sample

@@ -13,4 +13,9 @@ MYSQL_PASSWORD='root'
 MYSQL_DATABASE='testdb'
 USE_MONGODB='true'
 USE_MYSQL='true'
-FILE_UPLOAD_SIZE_IN_BYTES=1000000
+FILE_UPLOAD_SIZE_IN_BYTES=1000000
+
+AWS_S3_BUCKET=''
+AWS_S3_FILE_UPLOAD_KEY=''
+AWS_S3_ACCESS_KEY=''
+AWS_S3_SECRET_KEY=''

README.md

@@ -28,7 +28,7 @@ Nodejs boilerplate with express,Mongoose,Mysql,JWT,ES6,ES7,ES8 support to develo
 - 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
-- Fileupload using [multer](https://github.com/expressjs/multer)
+- Flexible fileupload with disk and S3 storage using [multer](https://github.com/expressjs/multer) and [multer-s3](https://github.com/badunk/multer-s3)
 ## Getting Started
 1. Clone repository
 ``` 

package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "private": false,
   "dependencies": {
+    "aws-sdk": "^2.481.0",
     "bcrypt": "^3.0.4",
     "body-parser": "^1.18.3",
     "debug": "^4.1.1",
@@ -16,6 +17,7 @@
     "jsonwebtoken": "^8.4.0",
     "mongoose": "^5.4.10",
     "multer": "^1.4.1",
+    "multer-s3": "^2.9.0",
     "mysql": "^2.16.0"
   },
   "devDependencies": {

server/app.js

@@ -14,7 +14,13 @@ const app = express()
 
 app.use(bodyParser.json())
 app.use(helmet())
-app.use('/api', jwt({ secret: secretCallback }).unless({ path: [ '/api/health-check', '/api/users', '/api/auth/login', '/api/users/testmysqlroute', '/api/fileupload' ], requestProperty: 'auth' }))
+app.use(
+  '/api',
+  jwt({ secret: secretCallback }).unless({
+    path: [ '/api/health-check', '/api/users', '/api/auth/login', '/api/users/testmysqlroute', '/api/fileupload', '/api/s3fileupload' ],
+    requestProperty: 'auth'
+  })
+)
 app.use('/api', Router)
 
 // Handle 404

server/config/routes.js

@@ -1,15 +1,21 @@
 import express from 'express'
+import multer from 'multer'
 import { userRoutes } from '../modules/users/user.routes'
 import { authRoutes } from '../modules/auth/auth.routes'
-import { upload } from '../utils/upload'
 import { httpStatus } from '../utils/httpStatus'
+import { diskStorage, limits, s3Storage, imageFileFilter } from '../utils/fileupload'
 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) => {
+Router.post('/fileupload', multer({ storage: diskStorage, limits, fileFilter: imageFileFilter }).single('avatar'), (req, res) => {
+  if (!req.file) return res.status(httpStatus.UNPROCESSABLE_ENTITY).json({ error: 'Please select file' })
+  return res.json({ data: req.file })
+})
+
+Router.post('/s3fileupload', multer({ storage: s3Storage, limits, fileFilter: imageFileFilter }).single('avatar'), (req, res) => {
   if (!req.file) return res.status(httpStatus.UNPROCESSABLE_ENTITY).json({ error: 'Please select file' })
   return res.json({ data: req.file })
 })

server/utils/upload.js renamed to server/utils/fileupload.js

@@ -1,11 +1,14 @@
 import multer from 'multer'
 import crypto from 'crypto'
+import aws from 'aws-sdk'
+import multerS3 from 'multer-s3'
 import { AppError } from './appError'
 import { httpStatus } from './httpStatus'
 
-// Ref : https://www.npmjs.com/package/multer
+aws.config.update({ accessKeyId: process.env.AWS_S3_ACCESS_KEY, secretAccessKey: process.env.AWS_S3_SECRET_KEY })
+const s3 = new aws.S3()
 
-const storage = multer.diskStorage({
+const diskStorage = 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) {
@@ -18,11 +21,25 @@ const storage = multer.diskStorage({
 
 const limits = { fileSize: parseInt(process.env.FILE_UPLOAD_SIZE_IN_BYTES) || 1000000 }
 
-const fileFilter = function (req, file, cb) {
+const imageFileFilter = 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 })
+const s3Storage = multerS3({
+  s3: s3,
+  bucket: process.env.AWS_S3_BUCKET,
+  metadata: function (req, file, cb) {
+    cb(null, { fieldName: file.fieldname })
+  },
+  key: function (req, file, cb) {
+    return crypto.randomBytes(16, function (err, raw) {
+      if (err) cb(err)
+      cb(null, process.env.AWS_S3_FILE_UPLOAD_KEY + raw.toString('hex') + Date.now() + '.' + file.originalname.split('.').pop().trim())
+    })
+  }
+})
+
+export { diskStorage, limits, imageFileFilter, s3Storage }