Add caching (#406)

Closes #136.

Author: maxbeatty

README.md

@@ -47,6 +47,9 @@ COOKIE_PASS=password-should-be-32-characters
 # MYSQL_PORT=3306
 # LOGGLY_TOKEN=
 # LOGGLY_SUBDOMAIN=
+# REDIS_HOST=
+# REDIS_PORT=
+# REDIS_PASSWORD=
 ```
 
 ### Start

config.js

@@ -1,6 +1,12 @@
 require('dotenv').config();
 const Joi = require('joi');
 
+const prodOptional = {
+  is: 'production',
+  then: Joi.string().required(),
+  otherwise: Joi.string().optional()
+};
+
 const envSchema = Joi.object().keys({
   SCHEME: Joi.string().valid('http', 'https').optional().default('http'),
   NODE_ENV: Joi.string().required(),
@@ -17,16 +23,15 @@ const envSchema = Joi.object().keys({
   MYSQL_USER: Joi.string().required(),
   MYSQL_PASSWORD: Joi.string().required(),
   MYSQL_DATABASE: Joi.string().required(),
-  LOGGLY_TOKEN: Joi.string().when('NODE_ENV', {
+  LOGGLY_TOKEN: Joi.string().when('NODE_ENV', prodOptional),
+  LOGGLY_SUBDOMAIN: Joi.string().when('NODE_ENV', prodOptional),
+  REDIS_HOST: Joi.string().when('NODE_ENV', prodOptional),
+  REDIS_PORT: Joi.number().when('NODE_ENV', {
     is: 'production',
-    then: Joi.string().required(),
-    otherwise: Joi.string().optional()
+    then: Joi.number().required(),
+    otherwise: Joi.number().optional()
   }),
-  LOGGLY_SUBDOMAIN: Joi.string().when('NODE_ENV', {
-    is: 'production',
-    then: Joi.string().required(),
-    otherwise: Joi.string().optional()
-  })
+  REDIS_PASSWORD: Joi.string().when('NODE_ENV', prodOptional)
 }).unknown(true); // allow other keys in process.env not defined here
 
 const result = Joi.validate(process.env, envSchema);
@@ -83,6 +88,11 @@ var config = {
   loggly: {
     token: result.value.LOGGLY_TOKEN,
     subdomain: result.value.LOGGLY_SUBDOMAIN
+  },
+  cache: {
+    host: result.value.REDIS_HOST,
+    port: result.value.REDIS_PORT,
+    password: result.value.REDIS_PASSWORD
   }
 };
 

manifest.js

@@ -145,6 +145,17 @@ var manifest = {
         }
       }
     },
+    {
+      plugin: {
+        register: './server/lib/cache',
+        options: {
+          host: config.get('/cache/host'),
+          port: config.get('/cache/port'),
+          password: config.get('/cache/password'),
+          partition: 'jsperf'
+        }
+      }
+    },
     { plugin: './server/repositories/comments' },
     { plugin: './server/repositories/pages' },
     { plugin: './server/repositories/tests' },

package-lock.json

@@ -34,6 +34,8 @@
     "bell": "^8.4.0",
     "blipp": "2.3.0",
     "boom": "5.1.0",
+    "catbox": "^7.1.4",
+    "catbox-redis": "^3.0.1",
     "confidence": "3.0.2",
     "dotenv": "^4.0.0",
     "glue": "4.1.0",

package.json

@@ -0,0 +1,30 @@
+const Catbox = require('catbox');
+const CatboxRedis = require('catbox-redis');
+
+exports.register = function (server, options, next) {
+  if (options.host && options.host.length > 0) {
+    server.log('info', 'connecting to redis cache');
+    const client = new Catbox.Client(CatboxRedis, {
+      partition: options.partition,
+      host: options.host,
+      port: options.port,
+      password: options.password
+    });
+
+    server.expose('get', client.get.bind(client));
+    server.expose('set', client.set.bind(client));
+    server.expose('drop', client.drop.bind(client));
+
+    client.start(next);
+  } else {
+    server.log('info', 'no redis config provided. caching disabled');
+    server.expose('get', (key, callback) => { callback(null, null); });
+    server.expose('set', (key, value, ttl, callback) => { callback(null); });
+    server.expose('drop', () => {});
+    next();
+  }
+};
+
+exports.register.attributes = {
+  name: 'cache'
+};

server/lib/cache.js

@@ -25,16 +25,42 @@ exports.register = function (server, options, next) {
           slug: 'browse'
         }
       };
+      const key = {
+        segment: 'browse',
+        id: 'browse'
+      };
 
-      pagesRepo.getLatestVisible(250)
-        .then(function (rows) {
-          context.pages = rows;
-          reply.view('browse/index', context);
-        })
-        .catch(function () {
-          context.genError = 'Sorry. Could not find tests to browse.';
+      server.plugins.cache.get(key, (err, cached) => {
+        if (err) {
+          reply(err);
+        } else if (cached) {
+          server.log('debug', 'cache hit on /browse');
+          // massage data for template
+          cached.item.forEach(r => {
+            r.published = new Date(r.published);
+            r.updated = new Date(r.updated);
+          });
+          context.pages = cached.item;
           reply.view('browse/index', context);
-        });
+        } else {
+          server.log('debug', 'cache miss on /browse');
+          pagesRepo.getLatestVisible(250)
+            .then(function (rows) {
+              context.pages = rows;
+              server.plugins.cache.set(key, rows, 60000, (err) => {
+                if (err) {
+                  throw err;
+                } else {
+                  reply.view('browse/index', context);
+                }
+              });
+            })
+            .catch(function () {
+              context.genError = 'Sorry. Could not find tests to browse.';
+              reply.view('browse/index', context);
+            });
+        }
+      });
     }
   });
 
@@ -116,5 +142,5 @@ exports.register = function (server, options, next) {
 
 exports.register.attributes = {
   name: 'web/browse',
-  dependencies: ['repositories/pages']
+  dependencies: ['repositories/pages', 'cache']
 };

server/web/browse/index.js

@@ -19,11 +19,23 @@ MockRepo.register.attributes = {
   name: 'repositories/pages'
 };
 
+const MockCache = {
+  register: (server, options, next) => {
+    server.expose('get', (key, cb) => { cb(null, null); });
+    server.expose('set', (key, val, ttl, cb) => { cb(null); });
+    next();
+  }
+};
+
+MockCache.register.attributes = {
+  name: 'cache'
+};
+
 const lab = exports.lab = Lab.script();
 let request, server, getLatestVisibleStub, getLatestVisibleForAuthorStub;
 
 lab.beforeEach(function (done) {
-  const plugins = [ MockRepo, BrowsePlugin ];
+  const plugins = [ MockRepo, MockCache, BrowsePlugin ];
   server = new Hapi.Server();
   server.connection();
   server.register(require('vision'), () => {
@@ -78,6 +90,51 @@ lab.experiment('browse', function () {
         done();
       });
     });
+
+    lab.test('it responds with error from cache get', (done) => {
+      const testErr = new Error('testing get');
+      sinon.stub(server.plugins.cache, 'get').callsArgWith(1, testErr);
+
+      server.inject(request, function (response) {
+        Code.expect(response.statusCode).to.equal(500);
+
+        done();
+      });
+    });
+
+    lab.test('it responds with items from cache get', (done) => {
+      sinon.stub(server.plugins.cache, 'get').callsArgWith(1, null, {
+        item: [
+          {
+            url: 'test',
+            title: 'Test',
+            testCount: 2,
+            revisionCount: 1,
+            updated: new Date().toISOString(),
+            published: new Date().toISOString()
+          }
+        ]
+      });
+
+      server.inject(request, function (response) {
+        Code.expect(response.statusCode).to.equal(200);
+
+        done();
+      });
+    });
+
+    lab.test('it responds with generic error when cache set errors', (done) => {
+      getLatestVisibleStub.returns(Promise.resolve([]));
+      const testErr = new Error('testing set');
+      sinon.stub(server.plugins.cache, 'set').callsArgWith(3, testErr);
+
+      server.inject(request, function (response) {
+        Code.expect(response.statusCode).to.equal(200);
+        Code.expect(response.result).to.contain('Sorry. Could not find tests to browse.');
+
+        done();
+      });
+    });
   });
 
   lab.experiment('atom', function () {