Removed snappy and protobuf from the main library and moved them

into independent modules.

README.md

@@ -97,6 +97,24 @@ looked up in the cache.
  * Otherwise the response is cached and the Vary headers for the URL endpoint are stored
    the response is returned to the caller.  
 
+# Support for snappy compression and/or protobuf serialization
+
+Snappy compression and protobuf serialization of cached data is supported. However
+in tests, it is generally slower than JSON and no compression, so it's disabled
+by default.
+
+To enable it, use one of both of the `serializer` and/or `compressor` options:
+```js
+var httpRequestCache = new RequestHttpCache({
+  backend: 'redis',
+  serializer: require('request-http-cache-protobuf-serializer'),
+  compressor: require('request-http-cache-snappy-compressor')
+});
+```
+
+You will need to require the respective modules as these are no longer shipped
+with `request-http-cache`.
+
 # TODO
 
  * Support for `If-Modified-Since` conditional responses (currently only uses ETags)

lib/redis-backend.js

@@ -13,6 +13,8 @@ var RESPONSE_TIME_KEY = "rt";
 var URL_KEY = "u";
 var DEFAULT_TTL = 86400;
 
+var JSONBSerializer = require('./jsonb-serializer');
+var NullCompressor = require('./null-compressor');
 
 function bufferToString(buffer) {
   if (!buffer) return null;
@@ -34,26 +36,8 @@ function RedisBackend(options) {
 
   this.ttl = options.ttl || DEFAULT_TTL;
 
-  /* Choose a serializer */
-  var Serializer;
-
-  if (options.serializer === 'protobuf') {
-    Serializer = require('./protobuf-serializer');
-  } else {
-    Serializer = require('./jsonb-serializer');
-  }
-  this.serializer = new Serializer();
-
-  /* Choose a compressor */
-  var Compressor;
-
-  if (options.serializer === 'snappy') {
-    Compressor = require('./snappy-compressor');
-  } else {
-    Compressor = require('./null-compressor');
-  }
-  this.compressor = new Compressor();
-
+  this.serializer = options.serializer && new options.serializer() || new JSONBSerializer();
+  this.compressor = options.compressor && new options.compressor() || new NullCompressor();
 }
 
 RedisBackend.prototype = {

package.json

@@ -30,6 +30,8 @@
     "mocha": "^2.1.0",
     "nock": "^0.59.1",
     "request": "^2.53.0",
+    "request-http-cache-protobuf-serializer": "^0.1.1",
+    "request-http-cache-snappy-compressor": "^0.1.1",
     "sinon": "^1.13.0",
     "speedy": "^0.1.1"
   },
@@ -38,9 +40,7 @@
     "json-buffer": "^2.0.11",
     "lodash": "^3.3.1",
     "lru-cache": "^2.5.0",
-    "protobuf": "^0.11.0",
     "redis": "^0.12.1",
-    "snappy": "^3.0.8",
     "wreck": "^5.2.0"
   }
 }

test/perf/redis-jsonb-snappy.js

@@ -0,0 +1,31 @@
+var speedy = require('speedy');
+
+var RequestHttpCache = require('../..');
+var request = require('request');
+
+var httpRequestCache = new RequestHttpCache({
+  backend: 'redis',
+  compressor: require('request-http-cache-snappy-compressor'), 
+  redisPrefix: 'hc:' + Date.now() + ":"
+});
+
+
+function makeRequest(token, callback) {
+  httpRequestCache.extension({
+    method: 'GET',
+    url: 'https://api.github.com/user/repos?per_page=100',
+    headers: {
+      Authorization: 'token ' + token,
+      'User-Agent': 'request-http-cache-test/1.0',
+    },
+    json: true
+  }, callback, request);
+}
+
+makeRequest(process.env.GITHUB_TOKEN_1, function() {
+  setTimeout(function() {
+    speedy.run(function(done) {
+      makeRequest(process.env.GITHUB_TOKEN_1, done);
+    });
+  }, 500);
+});

test/perf/redis-protobuf-snappy.js

@@ -0,0 +1,32 @@
+var speedy = require('speedy');
+
+var RequestHttpCache = require('../..');
+var request = require('request');
+
+var httpRequestCache = new RequestHttpCache({
+  backend: 'redis',
+  serializer: require('request-http-cache-protobuf-serializer'), 
+  compressor: require('request-http-cache-snappy-compressor'),
+  redisPrefix: 'hc:' + Date.now() + ":"
+});
+
+
+function makeRequest(token, callback) {
+  httpRequestCache.extension({
+    method: 'GET',
+    url: 'https://api.github.com/user/repos?per_page=100',
+    headers: {
+      Authorization: 'token ' + token,
+      'User-Agent': 'request-http-cache-test/1.0',
+    },
+    json: true
+  }, callback, request);
+}
+
+makeRequest(process.env.GITHUB_TOKEN_1, function() {
+  setTimeout(function() {
+    speedy.run(function(done) {
+      makeRequest(process.env.GITHUB_TOKEN_1, done);
+    });
+  }, 500);
+});

test/perf/redis-protobuf.js

@@ -0,0 +1,31 @@
+var speedy = require('speedy');
+
+var RequestHttpCache = require('../..');
+var request = require('request');
+
+var httpRequestCache = new RequestHttpCache({
+  backend: 'redis',
+  serializer: require('request-http-cache-protobuf-serializer'),
+  redisPrefix: 'hc:' + Date.now() + ":"
+});
+
+
+function makeRequest(token, callback) {
+  httpRequestCache.extension({
+    method: 'GET',
+    url: 'https://api.github.com/user/repos?per_page=100',
+    headers: {
+      Authorization: 'token ' + token,
+      'User-Agent': 'request-http-cache-test/1.0',
+    },
+    json: true
+  }, callback, request);
+}
+
+makeRequest(process.env.GITHUB_TOKEN_1, function() {
+  setTimeout(function() {
+    speedy.run(function(done) {
+      makeRequest(process.env.GITHUB_TOKEN_1, done);
+    });
+  }, 500);
+});