Merge pull request #7 from restify/rawBody

GH-6: exposes rawBody for all body parser plugins

Author: DonutEspresso

.travis.yml

@@ -3,6 +3,7 @@ language: node_js
 node_js:
    - "0.10"
    - "0.12"
+   - "4"
 notifications:
   webhooks:
     urls:

CHANGES.md

@@ -0,0 +1,3 @@
+# 1.x.x
+
+* NEW: `bodyParser` plugin now saves the raw unparsed body on req.rawBody

lib/plugins/bodyReader.js

@@ -13,6 +13,7 @@ var errors = require('restify-errors');
 
 var BadDigestError = errors.BadDigestError;
 var RequestEntityTooLargeError = errors.RequestEntityTooLargeError;
+var PayloadTooLargeError = errors.PayloadTooLargeError;
 
 var MD5_MSG = 'Content-MD5 \'%s\' didn\'t match \'%s\'';
 
@@ -55,7 +56,7 @@ function createBodyWriter(req) {
  * reads the body of the request.
  * @public
  * @function bodyReader
- * @throws   {BadDigestError | RequestEntityTooLargeError}
+ * @throws   {BadDigestError | PayloadTooLargeError}
  * @param    {Object} options an options object
  * @returns  {Function}
  */
@@ -88,9 +89,19 @@ function bodyReader(options) {
             bodyWriter.end();
 
             if (maxBodySize && bytesReceived > maxBodySize) {
-                var msg = 'Request body size exceeds ' +
-                    maxBodySize;
-                next(new RequestEntityTooLargeError(msg));
+                var msg = 'Request body size exceeds ' + maxBodySize;
+                var err;
+
+                // Between Node 0.12 and 4 http status code messages changed
+                // RequestEntityTooLarge was changed to PayloadTooLarge
+                // this check is to maintain backwards compatibility
+                if (PayloadTooLargeError !== undefined) {
+                    err = new PayloadTooLargeError(msg);
+                } else {
+                    err = new RequestEntityTooLargeError(msg);
+                }
+
+                next(err);
                 return;
             }
 

lib/plugins/fieldedTextBodyParser.js

@@ -23,6 +23,9 @@ function fieldedTextParser(options) {
 
     function parseFieldedText(req, res, next) {
 
+        // save original body on req.rawBody and req._body
+        req.rawBody = req._body = req.body;
+
         var contentType = req.getContentType();
 
         if (contentType !== 'text/csv' &&

lib/plugins/formBodyParser.js

@@ -35,6 +35,9 @@ function urlEncodedBodyParser(options) {
     var override = opts.overrideParams;
 
     function parseUrlEncodedBody(req, res, next) {
+        // save original body on req.rawBody and req._body
+        req.rawBody = req._body = req.body;
+
         if (req.getContentType() !== MIME_TYPE || !req.body) {
             next();
             return;
@@ -55,8 +58,6 @@ function urlEncodedBodyParser(options) {
                 });
             }
 
-            // always save the parsed params to body
-            req.rawBody = req._body = req.body;
             req.body = params;
         } catch (e) {
             next(new errors.InvalidContentError(e.message));

lib/plugins/jsonBodyParser.js

@@ -25,6 +25,9 @@ function jsonBodyParser(options) {
     var override = opts.overrideParams;
 
     function parseJson(req, res, next) {
+        // save original body on req.rawBody and req._body
+        req.rawBody = req._body = req.body;
+
         if (req.getContentType() !== 'application/json' || !req.body) {
             return next();
         }
@@ -64,8 +67,6 @@ function jsonBodyParser(options) {
                 // otherwise, do a wholesale stomp, no need to merge one by one.
                 req.params = params || req.params;
             }
-        } else {
-            req._body = req.body;
         }
 
         req.body = params;

lib/plugins/multipartBodyParser.js

@@ -45,6 +45,9 @@ function multipartBodyParser(options) {
     var override = opts.overrideParams;
 
     function parseMultipartBody(req, res, originalNext) {
+        // save original body on req.rawBody and req._body
+        req.rawBody = req._body = undefined;
+
         var next = once(originalNext);
 
         if (req.getContentType() !== 'multipart/form-data' ||

test/fieldedTextParser.test.js

@@ -34,19 +34,12 @@ var OBJECT_TSV = require(path.join(__dirname, '/files/object-tsv.json'));
 
 describe('fielded text parser', function () {
 
-    before(function (done) {
+    beforeEach(function (done) {
         SERVER = restify.createServer({
             dtrace: helper.dtrace,
             log: helper.getLog('server')
         });
         SERVER.use(plugins.bodyParser());
-        SERVER.post('/data', function respond(req, res, next) {
-            res.send({
-                status: 'okay',
-                parsedReq: req.body
-            });
-            return next();
-        });
         SERVER.listen(PORT, '127.0.0.1', function () {
             CLIENT = restifyClients.createClient({
                 url: 'http://127.0.0.1:' + PORT,
@@ -57,7 +50,7 @@ describe('fielded text parser', function () {
         });
     });
 
-    after(function (done) {
+    afterEach(function (done) {
         CLIENT.close();
         SERVER.close(done);
     });
@@ -70,6 +63,15 @@ describe('fielded text parser', function () {
                 'Content-Type': 'text/csv'
             }
         };
+
+        SERVER.post('/data', function respond(req, res, next) {
+            res.send({
+                status: 'okay',
+                parsedReq: req.body
+            });
+            return next();
+        });
+
         CLIENT.post(options, function (err, req) {
             assert.ifError(err);
             req.on('result', function (errReq, res) {
@@ -99,6 +101,15 @@ describe('fielded text parser', function () {
                 'Content-Type': 'text/tsv'
             }
         };
+
+        SERVER.post('/data', function respond(req, res, next) {
+            res.send({
+                status: 'okay',
+                parsedReq: req.body
+            });
+            return next();
+        });
+
         CLIENT.post(options, function (err, req) {
             assert.ifError(err);
             req.on('result', function (errReq, res) {
@@ -121,5 +132,35 @@ describe('fielded text parser', function () {
         });
     });
 
+    it('plugins-GH-6: should expose rawBody on request', function (done) {
+        var options = {
+            path: '/data',
+            headers: {
+                'Content-Type': 'text/csv'
+            }
+        };
+
+        SERVER.post('/data', function respond(req, res, next) {
+            assert.ok(req.rawBody);
+            res.send();
+            return next();
+        });
+
+        CLIENT.post(options, function (err, req) {
+            assert.ifError(err);
+            req.on('result', function (errReq, res) {
+                assert.ifError(errReq);
+                res.body = '';
+                res.setEncoding('utf8');
+                res.on('data', function (chunk) {
+                    res.body += chunk;
+                });
+                res.on('end', done);
+            });
+            req.write(DATA_TSV);
+            req.end();
+        });
+    });
+
 });
 

test/formBodyParser.test.js

@@ -248,5 +248,34 @@ describe('form body parser', function () {
         client.end();
     });
 
+    it('plugins-GH-6: should expose rawBody', function (done) {
+
+        var input = 'name[first]=alex&name[last]=liu';
+
+        SERVER.use(plugins.bodyParser());
+
+        SERVER.post('/bodyurl2/:id', function (req, res, next) {
+            assert.equal(req.rawBody, input);
+            res.send();
+            next();
+        });
+
+        var opts = {
+            hostname: '127.0.0.1',
+            port: PORT,
+            path: '/bodyurl2/foo',
+            agent: false,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            }
+        };
+        var client = http.request(opts, function (res) {
+            assert.equal(res.statusCode, 200);
+            done();
+        });
+        client.write(input);
+        client.end();
+    });
 });
 

test/jsonBodyParser.test.js

@@ -414,6 +414,26 @@ describe('JSON body parser', function () {
         client.end();
     });
 
+
+    it('plugins-GH-6: should expose rawBody', function (done) {
+
+        var payload = {
+            id: 'bar',
+            name: 'alex'
+        };
+
+        SERVER.use(plugins.jsonBodyParser());
+
+        SERVER.post('/body/:id', function (req, res, next) {
+            assert.equal(req.rawBody, JSON.stringify(payload));
+            assert.equal(req.body.id, 'bar');
+            assert.equal(req.body.name, 'alex');
+            res.send();
+            next();
+        });
+
+        CLIENT.post('/body/foo', payload, done);
+    });
 });