Merge branch 'SassNinja-feature/custom-cache-key'

Author: idealley

README.md

@@ -115,6 +115,20 @@ both items with id `123` would be saved under the same cache key... thus replaci
 ##### env
 The default environement is production, but it is anoying when running test as the hooks output information to the console. Therefore if you youse this option, you can set `test` as an environement and the hooks will not output anything to the console. if you use `NODE_ENV` it will pick up the `process.env.NODE_ENV` variable. This is useful for CI or CLI.
 
+##### immediateCacheKey
+By default the redis cache key gets determined in `redisAfterHook` based on the path. However if you're doing a lot of query manipulation you might want to set the cache key before anything else to keep its size as small as possible. You can achieve this by setting `immediateCacheKey: true` what will set the cache key in the `redisBeforeHook`. Then your hooks might look similar to:
+
+```js
+{
+  before: {
+    find: [redisBefore({ immediateCacheKey: true }), someQueryManipulation()]
+  },
+  after: {
+    find: [cache(), redisAfter()]
+  }
+}
+```
+
 
 Available routes:
 ```js

lib/library.js

@@ -4,7 +4,8 @@ import { parsePath } from './helpers/path';
 
 const defaults = {
   env: 'production',
-  defaultDuration: 3600 * 24
+  defaultDuration: 3600 * 24,
+  immediateCacheKey: false
 };
 
 export function before(options) { // eslint-disable-line no-unused-vars
@@ -32,6 +33,9 @@ export function before(options) { // eslint-disable-line no-unused-vars
             console.log(`> Expires on ${duration}.`);
           }
         } else {
+          if (options.immediateCacheKey === true) {
+            hook.params.cacheKey = path;
+          }
           resolve(hook);
         }
       });
@@ -49,7 +53,7 @@ export function after(options) { // eslint-disable-line no-unused-vars
       if (!hook.result.cache.cached) {
         const duration = hook.result.cache.duration || options.defaultDuration;
         const client = hook.app.get('redisClient');
-        const path = parsePath(hook, options);
+        const path = hook.params.cacheKey || parsePath(hook, options);
 
         // adding a cache object
         Object.assign(hook.result.cache, {

lib/library.js.map

@@ -72,6 +72,37 @@ describe('Redis After Hook', () => {
     });
   });
 
+  it('caches a route using params.cacheKey instead of params.query', () => {
+    const hook = a();
+    const mock = {
+      params: {
+        query: { foo: 'bar', lorem: 'ipsum' },
+        cacheKey: 'after-cache-key?foo=bar'
+      },
+      id: 'after-cache-key',
+      path: '',
+      result: {
+        _sys: {
+          status: 200
+        },
+        cache: {
+          cached: false
+        }
+      },
+      app: {
+        get: (what) => {
+          return client;
+        }
+      }
+    };
+
+    return hook(mock).then(result => {
+      const data = result.result;
+
+      expect(data.cache.key).to.equal('after-cache-key?foo=bar');
+    });
+  });
+
   it('caches a parent route that returns an array', () => {
     const hook = a();
     const mock = {
@@ -104,6 +135,7 @@ describe('Redis After Hook', () => {
       expect(data.cache.key).to.equal('test-route');
     });
   });
+
   it('caches a parent route with setting to remove path from key...', () => {
     const hook = a();
     const mock = {

lib/library.min.js

@@ -74,6 +74,24 @@ describe('Redis Before Hook', () => {
     ));
   });
 
+  it('sets cacheKey in before hook if immediateCacheKey true', () => {
+    const hook = b({ immediateCacheKey: true });
+    const mock = {
+      params: { query: { foo: 'bar' }},
+      path: '',
+      id: 'before-cache-key',
+      app: {
+        get: (what) => {
+          return client;
+        }
+      }
+    };
+
+    return hook(mock).then(result => {
+      expect(result.params.cacheKey).to.be.equal('before-cache-key?foo=bar');
+    });
+  });
+
   it('retrives a cached object', () => {
     const hook = b();
     const mock = {