Merge pull request #4 from jkyberneees/introducing-middlewares

Introducing middlewares

Author: jkyberneees

Dockerfile

@@ -7,6 +7,7 @@ COPY package.json .
 COPY package-lock.json .
 COPY index.js .
 COPY server.js .
+COPY middlewares.js .
 COPY config ./config
 COPY dist ./dist
 

README.md

@@ -53,3 +53,19 @@ Allowed `logsFormat` values are described at: https://www.npmjs.com/package/morg
 
 ## Cache support
 Caching is provided by the module: https://www.npmjs.com/package/http-cache-middleware
+
+## Custom middlewares
+You can also introduce other features such as authentication, security protections, etc... by using custom middlewares.  
+You can just replace the `middlewares.js` file by your own configuration.  
+
+Default:
+```js 
+// custom middlewares set
+// this file is intended to be overwritten by final images
+const helmet = require('helmet')
+
+module.exports = [
+  helmet
+]
+```
+> Please note that the `helmet` middleware enabled by default. See more details here: https://www.npmjs.com/package/helmet

middlewares.js

@@ -0,0 +1,7 @@
+// custom middlewares set
+// this file is intended to be overwritten by final images
+const helmet = require('helmet')
+
+module.exports = [
+  helmet
+]

package-lock.json

@@ -1,11 +1,11 @@
 {
   "name": "restana-static",
-  "version": "1.0.3",
-  "description": " Efficiently serve static files using Node.js and Docker containers.",
+  "version": "1.1.0",
+  "description": "Efficiently serve static files using Node.js and Docker containers.",
   "main": "index.js",
   "scripts": {
     "test": "mocha tests/*.test.js",
-    "start": "node server.js"
+    "start": "node index.js"
   },
   "repository": {
     "type": "git",
@@ -26,6 +26,7 @@
   "homepage": "https://github.com/jkyberneees/restana-static#readme",
   "dependencies": {
     "config": "^3.3.1",
+    "helmet": "^3.22.0",
     "http-cache-middleware": "^1.3.5",
     "morgan": "^1.10.0",
     "restana": "^4.3.4",

package.json

@@ -3,6 +3,7 @@ const files = require('serve-static')
 const path = require('path')
 const cache = require('http-cache-middleware')
 const morgan = require('morgan')
+const middlewares = require('./middlewares')
 
 module.exports = () => {
   // configuration
@@ -19,7 +20,7 @@ module.exports = () => {
     'dist/'
   const port = PORT || config.get('port') ||
     3000
-  const cacheEnabled = isCacheEnabled(CACHE_ENABLED, config)
+  const cacheEnabled = isEnabled(CACHE_ENABLED, 'cacheEnabled', config)
   const cacheControlHeaderValue = CACHE_CONTROL_HEADER_VALUE || config.get('cacheControlHeaderValue') ||
     'public, no-cache, max-age=604800'
   const defaultFile = DEFALUT_FILE || config.get('defaultFile') ||
@@ -47,6 +48,13 @@ module.exports = () => {
 
     return next()
   })
+
+  // supporting custom middlewares
+  for (const middleware of middlewares) {
+    server.use(middleware())
+  }
+
+  // supporting cache
   if (cacheEnabled) {
     server.use(cache())
   }
@@ -58,11 +66,11 @@ module.exports = () => {
   }
 }
 
-function isCacheEnabled (env, config) {
+function isEnabled (env, configKey, config) {
   if (env !== undefined) {
     if (env === 'true') return true
     else return false
   } else {
-    return config.get('cacheEnabled') || true
+    return config.get(configKey) || true
   }
 }