feat(bodyParsers): add body parsers middleware option (using express/body-parsers lib or custom handler). #1

ezypeeze · ezypeeze · commit e9cb27372982 · 2018-06-12T13:09:59.000+01:00
diff --git a/lib/module.js b/lib/module.js
@@ -4,6 +4,7 @@ const _    = require('lodash/fp/object');
 const DEFAULT_MODULE_OPTIONS = {
     directory: path.resolve(__dirname, '/api'),
     prefix: '/api',
+    bodyParsers: 'json',
     httpErrors: true,
     debug: process.env.NODE_ENV !== 'production',
     noContentStatusOnEmpty: true,
diff --git a/lib/server_middleware/api.js b/lib/server_middleware/api.js
@@ -1,5 +1,7 @@
-const express = require('express');
-const url     = require('url');
+const express           = require('express');
+const url               = require('url');
+const expressBodyParser = require('body-parser');
+const { DEFAULT_PARSER_OPTIONS }                                                   = require('../utility/body_parser');
 const { getControllerFiles, getControllerMiddleware, controllerMappingServerSide } = require('../utility/controllers');
 
 /**
@@ -52,6 +54,32 @@ function createControllerRouter(controllerFile, options) {
     return router;
 }
 
+/**
+ * Injects body parsers to the API.
+ *
+ * @param options
+ */
+function injectBodyParsers(options) {
+    const parsers = [];
+    if (options.bodyParsers) {
+        (Array.isArray(options.bodyParsers) ? options.bodyParsers : [options.bodyParsers]).forEach(function (parser) {
+            if (typeof parser === 'string' && expressBodyParser.hasOwnProperty(parser)) {
+                parsers.push(expressBodyParser[parser](DEFAULT_PARSER_OPTIONS[parser] || {}));
+            } else if (typeof parser === 'object' && parser.adapter && expressBodyParser.hasOwnProperty(parser.adapter)) {
+                parsers.push(expressBodyParser[parser.adapter](
+                    parser.options && Object.assign({}, DEFAULT_PARSER_OPTIONS[parser.adapter] || {}, parser.options) ||
+                    DEFAULT_PARSER_OPTIONS[parser.adapter] ||
+                    {}
+                ));
+            } else if (typeof parser === 'function') {
+                parsers.push(parser(options));
+            }
+        });
+    }
+
+    return parsers;
+}
+
 /**
  * Inject controllers and api routes.
  *
@@ -89,6 +117,9 @@ function injectAPI(options) {
         next();
     });
 
+    // Request body parsers
+    router.use(...(injectBodyParsers(options)));
+
     // Middleware for all API routes
     if (options.middleware) {
         router.use(...(Array.isArray(options.middleware) ? options.middleware : [options.middleware]));
diff --git a/lib/utility/body_parser.js b/lib/utility/body_parser.js
@@ -0,0 +1,9 @@
+const DEFAULT_PARSER_OPTIONS = {
+    urlencoded: {
+        extended: true // URL-encoded using qs library, which allows rich objects and arrays. (required option)
+    }
+};
+
+module.exports = {
+    DEFAULT_PARSER_OPTIONS
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "body-parser": "^1.18.3",
     "config": "^1.30.0",
     "express": "^4.16.3",
     "lodash": "^4.17.10"
@@ -72,6 +73,7 @@
     "nuxt": "^1.4.0",
     "pre-commit": "^1.2.2",
     "prettier": "^1.12.1",
+    "querystring": "^0.2.0",
     "require-extension-hooks": "^0.3.2",
     "require-extension-hooks-babel": "^0.1.1",
     "require-extension-hooks-vue": "^1.0.0",
diff --git a/tests/api.body.parser.test.js b/tests/api.body.parser.test.js
@@ -0,0 +1,44 @@
+import test from 'ava';
+import qs from 'querystring';
+
+test.before(globalBeforeAll({
+    moduleOptions: {
+        bodyParsers: [
+            'json',
+            {
+                adapter: 'urlencoded'
+            }
+        ]
+    }
+}));
+test.after(globalAfterAll());
+
+test('Test json body parser', async (t) => {
+    const {data} = await api.post('/users', {
+        first_name: 'nuxt',
+        last_name: 'neo'
+    });
+
+    t.true(data.ok);
+    t.is(data.body.first_name, 'nuxt');
+    t.is(data.body.last_name, 'neo');
+});
+
+test('Test uri encoded body parser', async (t) => {
+    const {data} = await api.post(
+        '/users',
+        qs.stringify({
+            first_name: 'nuxt',
+            last_name: 'neo'
+        }),
+        {
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            }
+        }
+    );
+
+    t.true(data.ok);
+    t.is(data.body.first_name, 'nuxt');
+    t.is(data.body.last_name, 'neo');
+});
diff --git a/yarn.lock b/yarn.lock
@@ -1437,6 +1437,21 @@ body-parser@1.18.2:
     raw-body "2.3.2"
     type-is "~1.6.15"
 
+body-parser@^1.18.3:
+  version "1.18.3"
+  resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.18.3.tgz#5b292198ffdd553b3a0f20ded0592b956955c8b4"
+  dependencies:
+    bytes "3.0.0"
+    content-type "~1.0.4"
+    debug "2.6.9"
+    depd "~1.1.2"
+    http-errors "~1.6.3"
+    iconv-lite "0.4.23"
+    on-finished "~2.3.0"
+    qs "6.5.2"
+    raw-body "2.3.3"
+    type-is "~1.6.16"
+
 boolbase@~1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e"
@@ -4297,7 +4312,7 @@ http-errors@1.6.2:
     setprototypeof "1.0.3"
     statuses ">= 1.3.1 < 2"
 
-http-errors@^1.2.8, http-errors@^1.6.1, http-errors@~1.6.1, http-errors@~1.6.2:
+http-errors@1.6.3, http-errors@^1.2.8, http-errors@^1.6.1, http-errors@~1.6.1, http-errors@~1.6.2, http-errors@~1.6.3:
   version "1.6.3"
   resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.3.tgz#8b55680bb4be283a0b5bf4ea2e38580be1d9320d"
   dependencies:
@@ -4341,7 +4356,7 @@ iconv-lite@0.4.19:
   version "0.4.19"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.19.tgz#f7468f60135f5e5dad3399c0a81be9a1603a082b"
 
-iconv-lite@^0.4.17, iconv-lite@^0.4.4, iconv-lite@~0.4.13:
+iconv-lite@0.4.23, iconv-lite@^0.4.17, iconv-lite@^0.4.4, iconv-lite@~0.4.13:
   version "0.4.23"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.23.tgz#297871f63be507adcfbfca715d0cd0eed84e9a63"
   dependencies:
@@ -7258,7 +7273,7 @@ qs@6.5.1:
   version "6.5.1"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.1.tgz#349cdf6eef89ec45c12d7d5eb3fc0c870343a6d8"
 
-qs@~6.5.1:
+qs@6.5.2, qs@~6.5.1:
   version "6.5.2"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36"
 
@@ -7315,6 +7330,15 @@ raw-body@2.3.2:
     iconv-lite "0.4.19"
     unpipe "1.0.0"
 
+raw-body@2.3.3:
+  version "2.3.3"
+  resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.3.3.tgz#1b324ece6b5706e153855bc1148c65bb7f6ea0c3"
+  dependencies:
+    bytes "3.0.0"
+    http-errors "1.6.3"
+    iconv-lite "0.4.23"
+    unpipe "1.0.0"
+
 rc@^1.0.1, rc@^1.1.6, rc@^1.1.7:
   version "1.2.7"
   resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.7.tgz#8a10ca30d588d00464360372b890d06dacd02297"
