Merge pull request #11 from jkyberneees/improve-performance-for-large-files

Improve performance for large files

Author: jkyberneees

demos/basic.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const middleware = require('./../index')()
 const service = require('restana')()
 service.use(middleware)

demos/memory-store.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const CacheManager = require('cache-manager')
 const middleware = require('./../index')({
   stores: [CacheManager.caching({ store: 'memory', max: 2000, ttl: 30 })]

demos/redis-store.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const CacheManager = require('cache-manager')
 const redisStore = require('cache-manager-ioredis')
 const redisCache = CacheManager.caching({

get-keys.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const matcher = require('matcher')
 
 const getKeys = (cache, pattern) => new Promise((resolve) => {

index.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const CacheManager = require('cache-manager')
 const iu = require('middleware-if-unless')()
 const { parse: cacheControl } = require('@tusbar/cache-control')
@@ -11,6 +13,7 @@ const X_CACHE_HIT = 'x-cache-hit'
 const CACHE_ETAG = 'etag'
 const CACHE_CONTROL = 'cache-control'
 const CACHE_IF_NONE_MATCH = 'if-none-match'
+const DATA_POSTFIX = '-d'
 
 const middleware = (opts) => async (req, res, next) => {
   try {
@@ -30,43 +33,54 @@ const middleware = (opts) => async (req, res, next) => {
     // ref cache key on req object
     req.cacheKey = key
 
-    // try to retrieve cached response
-    const cached = await get(mcache, key)
+    // try to retrieve cached response metadata
+    const metadata = await get(mcache, key)
 
-    if (cached) {
+    if (metadata) {
       // respond from cache if there is a hit
-      let { status, headers, data } = JSON.parse(cached)
+      const { status, headers, encoding } = JSON.parse(metadata)
 
       // pre-checking If-None-Match header
       if (req.headers[CACHE_IF_NONE_MATCH] && req.headers[CACHE_IF_NONE_MATCH] === headers[CACHE_ETAG]) {
         res.setHeader('content-length', '0')
         res.statusCode = 304
         res.end()
 
-        return // exit because client cache state matches
-      }
-
-      if (typeof data === 'object' && data.type === 'Buffer') {
-        data = Buffer.from(data.data)
-      }
-      headers[X_CACHE_HIT] = '1'
+        return
+      } else {
+        // try to retrieve cached response data
+        const payload = await get(mcache, key + DATA_POSTFIX)
+        if (payload) {
+          let { data } = JSON.parse(payload)
+          if (typeof data === 'object' && data.type === 'Buffer') {
+            data = Buffer.from(data.data)
+          }
+          headers[X_CACHE_HIT] = '1'
 
-      // set cached response headers
-      Object.keys(headers).forEach(header => res.setHeader(header, headers[header]))
+          // set cached response headers
+          Object.keys(headers).forEach(header => res.setHeader(header, headers[header]))
 
-      // send cached payload
-      req.cacheHit = true
-      res.statusCode = status
-      res.end(data)
+          // send cached payload
+          req.cacheHit = true
+          res.statusCode = status
+          res.end(data, encoding)
 
-      return
+          return
+        }
+      }
     }
 
     onEnd(res, (payload) => {
       if (payload.headers[X_CACHE_EXPIRE]) {
         // support service level expiration
         const keysPattern = payload.headers[X_CACHE_EXPIRE].replace(/\s/g, '')
-        const patterns = keysPattern.split(',')
+        const patterns = keysPattern.split(',').map(pattern =>
+          pattern.endsWith('*') ? pattern : [pattern, pattern + DATA_POSTFIX])
+          .reduce((acc, item) => {
+            acc.push(...item)
+
+            return acc
+          }, [])
         // delete keys on all cache tiers
         patterns.forEach(pattern => opts.stores.forEach(store => getKeys(store, pattern).then(keys => mcache.del(keys))))
       } else if (payload.headers[X_CACHE_TIMEOUT] || payload.headers[CACHE_CONTROL]) {
@@ -92,7 +106,10 @@ const middleware = (opts) => async (req, res, next) => {
           payload.headers[CACHE_ETAG] = Math.random().toString(36).substring(2, 16)
         }
 
-        // cache response
+        // cache response data
+        mcache.set(req.cacheKey + DATA_POSTFIX, JSON.stringify({ data: payload.data }), { ttl })
+        delete payload.data
+        // cache response metadata
         mcache.set(req.cacheKey, JSON.stringify(payload), { ttl })
       }
     })

package.json

@@ -15,6 +15,12 @@
     "cache",
     "middleware"
   ],
+  "files": [
+    "index.js",
+    "get-keys.js",
+    "README.md",
+    "LICENSE"
+  ],
   "author": "Rolando Santamaria Maso <kyberneees@gmail.com>",
   "license": "MIT",
   "bugs": {

test/get-keys.test.js

@@ -1,3 +1,5 @@
+'use strict'
+
 /* global describe, it */
 
 const getKeys = require('./../get-keys')

test/smoke.test.js

@@ -1,3 +1,5 @@
+'use strict'
+
 /* global describe, it */
 const got = require('got')
 const expect = require('chai').expect
@@ -116,14 +118,14 @@ describe('cache middleware', () => {
     expect(res.body).to.equal('world')
     expect(res.headers['x-cache-hit']).to.equal('1')
     expect(res.headers['cache-control']).to.equal('no-cache')
-    expect(res.headers['etag']).to.equal('1')
+    expect(res.headers.etag).to.equal('1')
   })
 
   it('cache hit (buffer) - Etag', async () => {
     const res = await got('http://localhost:3000/cache-buffer')
     expect(res.body).to.equal('world')
     expect(res.headers['x-cache-hit']).to.equal('1')
-    expect(res.headers['etag']).to.equal('1')
+    expect(res.headers.etag).to.equal('1')
   })
 
   it('cache hit (buffer) - If-None-Match', async () => {