expiration callback works... added globalOptions.events object for callbacks

Author: Kevin Whitley

src/apicache.js

@@ -41,6 +41,9 @@ function ApiCache() {
       include: [],
       exclude: [],
     },
+    events: {
+      'expire': undefined
+    },
     headers: {
       // 'cache-control':  'no-cache' // example of header overwrite
     }
@@ -95,16 +98,18 @@ function ApiCache() {
 
   function cacheResponse(key, value, duration) {
     var redis = globalOptions.redisClient
+    var expireCallback = globalOptions.events.expire
+
     if (redis) {
       try {
         redis.hset(key, "response", JSON.stringify(value))
         redis.hset(key, "duration", duration)
-        redis.expire(key, duration/1000)
+        redis.expire(key, duration/1000, expireCallback)
       } catch (err) {
-        console.log('[apicache] error in redis.hset()')
+        debug('[apicache] error in redis.hset()')
       }
     } else {
-      memCache.add(key, value, duration)
+      memCache.add(key, value, duration, expireCallback)
     }
 
     // add automatic cache clearing from duration, includes max limit on setTimeout
@@ -348,7 +353,12 @@ function ApiCache() {
       }
 
       if (opt.appendKey.length > 0) {
-        key += '$$appendKey=' + opt.appendKey.map(function(attr) { return req[attr] }).join('+')
+        var appendKey = req
+
+        for (var i = 0; i < opt.appendKey.length; i++) {
+          appendKey = appendKey[opt.appendKey[i]]
+        }
+        key += '$$appendKey=' + appendKey
       }
 
       // attempt cache hit

src/memory-cache.js

@@ -1,67 +1,59 @@
 function MemoryCache() {
-	this.cache = {}
-	this.size = 0
+  this.cache = {}
+  this.size = 0
 }
 
 MemoryCache.prototype.add = function(key, value, time, timeoutCallback) {
-	var old = this.cache[key]
-	var instance = this
-
-	if (old) {
-		clearTimeout(old.timeout)
-	}
-
-	var entry = {
-		value: value,
-		expire: time + Date.now(),
-		timeout: setTimeout(function() {
-			instance.delete(key)
-			return timeoutCallback && typeof timeoutCallback === 'function' && timeoutCallback(value, key)
-		}, time)
-	}
-
-	this.cache[key] = entry
-	this.size = Object.keys(this.cache).length
-
-	return entry
+  var old = this.cache[key]
+  var instance = this
+
+  var entry = {
+    value: value,
+    expire: time + Date.now(),
+    timeout: setTimeout(function() {
+      instance.delete(key)
+      return timeoutCallback && typeof timeoutCallback === 'function' && timeoutCallback(value, key)
+    }, time)
+  }
+
+  this.cache[key] = entry
+  this.size = Object.keys(this.cache).length
+
+  return entry
 }
 
 MemoryCache.prototype.delete = function(key) {
-	var entry = this.cache[key]
+  var entry = this.cache[key]
 
-	if (entry) {
-		clearTimeout(entry.timeout)
-	}
+  if (entry) {
+    clearTimeout(entry.timeout)
+  }
 
-	delete this.cache[key]
+  delete this.cache[key]
 
-	this.size = Object.keys(this.cache).length
+  this.size = Object.keys(this.cache).length
 
-	return null
+  return null
 }
 
 MemoryCache.prototype.get = function(key) {
-	var entry = this.cache[key]
+  var entry = this.cache[key]
 
-	if (entry && entry.expire < Date.now()) {
-		return this.delete(key)
-	}
-
-	return entry
+  return entry
 }
 
 MemoryCache.prototype.getValue = function(key) {
-	var entry = this.get(key)
+  var entry = this.get(key)
 
-	return entry && entry.value
+  return entry && entry.value
 }
 
 MemoryCache.prototype.clear = function() {
-	Object.keys(this.cache).forEach(function(key) {
-		this.delete(key)
-	}, this)
+  Object.keys(this.cache).forEach(function(key) {
+    this.delete(key)
+  }, this)
 
-	return true
+  return true
 }
 
 module.exports = MemoryCache

test/api/lib/routes.js

@@ -9,6 +9,13 @@ module.exports = function(app) {
     res.json(movies)
   })
 
+  app.get('/api/params/:where', function(req, res) {
+    app.requestsProcessed++
+
+    res.json(movies)
+  })
+
+
   app.get('/api/writeandend', function(req, res) {
     app.requestsProcessed++
 

test/apicache_test.js

@@ -161,6 +161,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: [] },
+        events: { expire: undefined },
         headers: {}
       })
       expect(middleware2.options()).to.eql({
@@ -171,6 +172,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: [] },
+        events: { expire: undefined },
         headers: {}
       })
     })
@@ -184,6 +186,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         defaultDuration: 7200000,
         appendKey: ['bar'],
         statusCodes: { include: [], exclude: ['400'] },
+        events: { expire: undefined },
         headers: {
           'cache-control': 'no-cache'
         }
@@ -192,7 +195,8 @@ describe('.middleware {MIDDLEWARE}', function() {
         debug: false,
         defaultDuration: 1800000,
         appendKey: ['foo'],
-        statusCodes: { include: [], exclude: ['200'] }
+        statusCodes: { include: [], exclude: ['200'] },
+        events: { expire: undefined },
       })
       expect(middleware1.options()).to.eql({
         debug: true,
@@ -202,6 +206,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: ['400'] },
+        events: { expire: undefined },
         headers: {
           'cache-control': 'no-cache'
         }
@@ -214,6 +219,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: ['200'] },
+        events: { expire: undefined },
         headers: {}
       })
     })
@@ -243,6 +249,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: ['400'] },
+        events: { expire: undefined },
         headers: {}
       })
       expect(middleware2.options()).to.eql({
@@ -253,6 +260,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: ['200'] },
+        events: { expire: undefined },
         headers: {}
       })
     })
@@ -291,6 +299,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: [] },
+        events: { expire: undefined },
         headers: {
           'cache-control': 'no-cache'
         }
@@ -303,6 +312,7 @@ describe('.middleware {MIDDLEWARE}', function() {
         jsonp: false,
         redisClient: false,
         statusCodes: { include: [], exclude: [] },
+        events: { expire: undefined },
         headers: {}
       })
     })
@@ -392,22 +402,15 @@ describe('.middleware {MIDDLEWARE}', function() {
       })
 
       it('properly uses appendKey params', function() {
-        var app = mockAPI.create('10 seconds', { appendKey: ['method', 'url'] })
+        var app = mockAPI.create('10 seconds', { appendKey: ['method'] })
 
         return request(app)
           .get('/api/movies')
           .expect(200, movies)
           .then(assertNumRequestsProcessed(app, 1))
           .then(function() {
-            return request(app)
-              .get('/api/movies')
-              .set('Accept', 'application/json')
-              .expect('Content-Type', /json/)
-              .expect(200, movies)
-              .then(function(res) {
-                expect(app.apicache.getIndex().all.length).to.equal(1)
-                expect(app.apicache.getIndex().all[0]).to.equal('/api/movies$$appendKey=GET+/api/movies')
-              })
+            expect(app.apicache.getIndex().all.length).to.equal(1)
+            expect(app.apicache.getIndex().all[0]).to.equal('/api/movies$$appendKey=GET')
           })
       })
 
@@ -583,6 +586,26 @@ describe('.middleware {MIDDLEWARE}', function() {
         }, 25)
       })
 
+      it('executes expiration callback from globalOptions.events.expire upon entry expiration', function(done) {
+        var callbackResponse = undefined
+        var cb = function(a,b) {
+          callbackResponse = b
+        }
+        var app = mockAPI.create(10, { events: { expire: cb }})
+
+        request(app)
+          .get('/api/movies')
+          .end(function(err, res) {
+            expect(app.apicache.getIndex().all.length).to.equal(1)
+            expect(app.apicache.getIndex().all).to.include('/api/movies')
+          })
+
+        setTimeout(function() {
+          expect(app.apicache.getIndex().all).to.have.length(0)
+          expect(callbackResponse).to.equal('/api/movies')
+          done()
+        }, 25)
+      })
     })
   })
 })