flickr · ijpiantanida · Aug 5, 2016
diff --git a/lib/bodyHumanReadable.js b/lib/bodyHumanReadable.js
@@ -0,0 +1,38 @@
+var contentTypeParser = require('content-type');
+var humanReadableContentTypes = [
+  'application/javascript',
+  'application/json',
+  'text/css',
+  'text/html',
+  'text/javascript',
+  'text/plain'
+];
+
+/**
+ * Returns whether a request's body is human readable
+ * @param {http.IncomingMessage} req
+ * @returns {Boolean}
+*/
+
+module.exports = function (res) {
+  var contentEncoding = res.headers['content-encoding'];
+  var contentType = res.headers['content-type'];
+  var identityEncoding = !contentEncoding || contentEncoding === 'identity';
+
+  if (!contentType) {
+    return false;
+  }
+  contentType = contentTypeParser.parse(contentType);
+
+  return identityEncoding && isContentTypeHumanReadable(contentType);
+};
+
+/**
+ * Returns whether a content-type is human readable based on a whitelist
+ * @param {content-type} contentType
+ * @returns {Boolean}
+*/
+
+function isContentTypeHumanReadable(contentType) {
+  return humanReadableContentTypes.indexOf(contentType.type) >= 0;
+}
diff --git a/lib/record.js b/lib/record.js
@@ -3,6 +3,7 @@
 
 var Promise = require('bluebird');
 var buffer = require('./buffer');
+var isBodyHumanReadable = require('./bodyHumanReadable');
 var path = require('path');
 var ejs = require('ejs');
 var fs = require('fs');
@@ -28,7 +29,9 @@ var render = ejs.compile(fs.readFileSync(path.resolve(__dirname, '../src/tape.ej
 
 module.exports = function (req, res, filename) {
   return buffer(res).then(function (body) {
-    return render({ req: req, res: res, body: body });
+    var bodyEncoding = isBodyHumanReadable(res) ? 'utf-8' : 'base64';
+
+    return render({ req: req, res: res, body: body, bodyEncoding: bodyEncoding });
   }).then(function (data) {
     return write(filename, data);
   }).then(function () {

diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
   },
   "dependencies": {
     "bluebird": "~3.3.4",
+    "content-type": "~1.0.2",
     "debug": "~2.1.2",
     "ejs": "~2.3.1",
     "incoming-message-hash": "~3.2.1",

diff --git a/src/tape.ejs b/src/tape.ejs
@@ -18,7 +18,7 @@ module.exports = function (req, res) {
   res.setHeader("x-yakbak-tape", path.basename(__filename, ".js"));
 
 <% body.forEach(function (data) { -%>
-  res.write(new Buffer(<%- JSON.stringify(data.toString('base64')) %>, "base64"));
+  res.write(new Buffer(<%- JSON.stringify(data.toString(bodyEncoding)) %>, '<%- bodyEncoding %>'));
 <% }); -%>
   res.end();
 

diff --git a/test/bodyHumanReadable.js b/test/bodyHumanReadable.js
@@ -0,0 +1,103 @@
+// Copyright 2016 Yahoo Inc.
+// Licensed under the terms of the MIT license. Please see LICENSE file in the project root for terms.
+
+/* eslint-env mocha */
+
+var subject = require('../lib/bodyHumanReadable');
+var createServer = require('./helpers/server');
+var assert = require('assert');
+var http = require('http');
+
+describe('bodyHumanReadable', function () {
+  var server, req;
+
+  afterEach(function (done) {
+    server.teardown(done);
+  });
+
+  function makeRequest(requestHandler, test) {
+      server = createServer(function () {
+        req = http.request({
+          host: server.addr,
+          port: server.port
+        });
+        req.setHeader('User-Agent', 'My User Agent/1.0');
+        req.setHeader('Connection', 'close');
+
+        req.on('response', test);
+        req.end();
+      }, requestHandler);
+  }
+
+  describe("when content-type is human readable", function () {
+    it("returns true when content-encoding is not set", function (done) {
+      function requestHandler(request, response) {
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'text/html; charset=utf-8');
+        response.end('<html></html>');
+      }
+
+      makeRequest(requestHandler, function (response) {
+        assert(subject(response));
+        done();
+      });
+    });
+
+    it("returns true when content-encoding is set to identity", function (done) {
+      function requestHandler(request, response) {
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'text/html; charset=utf-8');
+        response.setHeader('Content-Encoding', 'identity');
+        response.end('<html></html>');
+      }
+
+      makeRequest(requestHandler, function (response) {
+        assert(subject(response));
+        done();
+      });
+    });
+
+    it("returns false when content-encoding is set to gzip", function (done) {
+      function requestHandler(request, response) {
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'text/html; charset=utf-8');
+        response.setHeader('Content-Encoding', 'gzip');
+        response.end('ZIP');
+      }
+
+      makeRequest(requestHandler, function (response) {
+        assert(!subject(response));
+        done();
+      });
+    });
+  });
+
+  describe("when content-type is not human readable", function () {
+    it("returns false", function (done) {
+      function requestHandler(request, response) {
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'image/gif');
+        response.end('GIF');
+      }
+
+      makeRequest(requestHandler, function (response) {
+        assert(!subject(response));
+        done();
+      });
+    });
+  });
+
+  describe("when there's no content-type", function () {
+    it('returns false', function (done) {
+      function requestHandler(request, response) {
+        response.statusCode = 304;
+        response.end('OK');
+      }
+
+      makeRequest(requestHandler, function (response) {
+        assert(!subject(response));
+        done();
+      });
+    });
+  });
+});
diff --git a/test/fixtures/index.js b/test/fixtures/index.js
@@ -10,12 +10,18 @@ function read(file) {
 }
 
 /**
- * node >= 1.5.0 sends the content-length whenever possible
- * @see https://github.com/nodejs/node/pull/1062
+ * Returns a fixture based on a sufix and node version
+ * @type {String} sufix
+ * @returns {String}
  */
-
-if (semver.gte(process.version, '1.5.0')) {
-  module.exports = read('v1.5.0');
-} else {
-  module.exports = read('v0.10.x');
-}
+module.exports = function (sufix) {
+  /**
+  * node >= 1.5.0 sends the content-length whenever possible
+  * @see https://github.com/nodejs/node/pull/1062
+  */
+  if (semver.gte(process.version, '1.5.0')) {
+    return read('v1.5.0-' + sufix);
+  } else {
+    return read('v0.10.x-' + sufix);
+  }
+};
diff --git a/test/fixtures/v0.10.x-base64.js b/test/fixtures/v0.10.x-base64.js
@@ -0,0 +1,25 @@
+var path = require("path");
+
+/**
+ * GET /
+ *
+ * host: {addr}:{port}
+ * user-agent: My User Agent/1.0
+ * connection: close
+ */
+
+module.exports = function (req, res) {
+  res.statusCode = 201;
+
+  res.setHeader("content-type", "image/gif");
+  res.setHeader("date", "Sat, 26 Oct 1985 08:20:00 GMT");
+  res.setHeader("connection", "close");
+  res.setHeader("transfer-encoding", "chunked");
+
+  res.setHeader("x-yakbak-tape", path.basename(__filename, ".js"));
+
+  res.write(new Buffer("R0lG", 'base64'));
+  res.end();
+
+  return __filename;
+};
diff --git a/test/fixtures/v0.10.x.js → test/fixtures/v0.10.x-utf8.js b/test/fixtures/v0.10.x.js → test/fixtures/v0.10.x-utf8.js
@@ -18,7 +18,7 @@ module.exports = function (req, res) {
 
   res.setHeader("x-yakbak-tape", path.basename(__filename, ".js"));
 
-  res.write(new Buffer("T0s=", "base64"));
+  res.write(new Buffer("OK", 'utf-8'));
   res.end();
 
   return __filename;

diff --git a/test/fixtures/v1.5.0-base64.js b/test/fixtures/v1.5.0-base64.js
@@ -0,0 +1,25 @@
+var path = require("path");
+
+/**
+ * GET /
+ *
+ * host: {addr}:{port}
+ * user-agent: My User Agent/1.0
+ * connection: close
+ */
+
+module.exports = function (req, res) {
+  res.statusCode = 201;
+
+  res.setHeader("content-type", "image/gif");
+  res.setHeader("date", "Sat, 26 Oct 1985 08:20:00 GMT");
+  res.setHeader("connection", "close");
+  res.setHeader("content-length", "3");
+
+  res.setHeader("x-yakbak-tape", path.basename(__filename, ".js"));
+
+  res.write(new Buffer("R0lG", 'base64'));
+  res.end();
+
+  return __filename;
+};
diff --git a/test/fixtures/v1.5.0.js → test/fixtures/v1.5.0-utf8.js b/test/fixtures/v1.5.0.js → test/fixtures/v1.5.0-utf8.js
@@ -18,7 +18,7 @@ module.exports = function (req, res) {
 
   res.setHeader("x-yakbak-tape", path.basename(__filename, ".js"));
 
-  res.write(new Buffer("T0s=", "base64"));
+  res.write(new Buffer("OK", 'utf-8'));
   res.end();
 
   return __filename;

diff --git a/test/helpers/server.js b/test/helpers/server.js
@@ -6,23 +6,26 @@ var http = require('http');
 /**
  * Creates a test HTTP server.
  * @param {Function} done
+ * @param {Function} reqHandler: an optional callback to customize how to handle the request
  * @returns {http.Server}
  */
 
-module.exports = function createServer(cb) {
+module.exports = function createServer(done, reqHandler) {
 
   var server = http.createServer(function (req, res) {
-    res.statusCode = 201;
-
-    res.setHeader('Content-Type', 'text/html');
-    res.setHeader('Date', 'Sat, 26 Oct 1985 08:20:00 GMT');
-
     req.resume(); // consume the request body, if any
 
     req.on('end', function () {
-      res.end('OK');
+      if (reqHandler) {
+        reqHandler(req, res);
+      } else {
+        res.statusCode = 201;
+
+        res.setHeader('Content-Type', 'text/html');
+        res.setHeader('Date', 'Sat, 26 Oct 1985 08:20:00 GMT');
+        res.end('OK');
+      }
     });
-
   }).on('listening', function () {
     this.addr = 'localhost';
     this.port = this.address().port;
@@ -36,10 +39,10 @@ module.exports = function createServer(cb) {
     this.requests.push(req);
   });
 
-  server.teardown = function (done) {
-    this.close(done);
+  server.teardown = function (doneT) {
+    this.close(doneT);
   };
 
-  return server.listen(cb);
+  return server.listen(done);
 
 };