Merge pull request #32 from tobinbradley/compress-types-option

make compressibleTypes user settable so custom types can be compressed

Author: delvedor

README.md

@@ -66,6 +66,14 @@ fastify.register(
   { threshold: 2048 }
 )
 ```
+### customTypes
+[mime-db](https://github.com/jshttp/mime-db) is used to determine if a `Content-Type` should be compressed. You can compress additional content types via regular expression.
+```javascript
+fastify.register(
+  require('fastify-compress'),
+  { customTypes: /x-protobuf$/ }
+)
+```
 ### Brotli
 Brotli compression is not enabled by default, if you need it we recommend to install [`iltorb`](https://www.npmjs.com/package/iltorb) and pass it as option.
 ```javascript

index.js

@@ -5,7 +5,6 @@ const zlib = require('zlib')
 const pump = require('pump')
 const sts = require('string-to-stream')
 const mimedb = require('mime-db')
-const compressibleTypes = /^text\/|\+json$|\+text$|\+xml$/
 
 function compressPlugin (fastify, opts, next) {
   fastify.decorateReply('compress', compress)
@@ -15,6 +14,7 @@ function compressPlugin (fastify, opts, next) {
   }
 
   const threshold = typeof opts.threshold === 'number' ? opts.threshold : 1024
+  const compressibleTypes = opts.customTypes instanceof RegExp ? opts.customTypes : /^text\/|\+json$|\+text$|\+xml$/
   const compressStream = {
     gzip: zlib.createGzip,
     deflate: zlib.createDeflate
@@ -40,7 +40,7 @@ function compressPlugin (fastify, opts, next) {
     }
 
     var type = this.getHeader('Content-Type') || 'application/json'
-    if (shouldCompress(type) === false) {
+    if (shouldCompress(type, compressibleTypes) === false) {
       return this.send(payload)
     }
 
@@ -86,7 +86,7 @@ function compressPlugin (fastify, opts, next) {
     }
 
     var type = reply.getHeader('Content-Type') || 'application/json'
-    if (shouldCompress(type) === false) {
+    if (shouldCompress(type, compressibleTypes) === false) {
       return next()
     }
 
@@ -150,7 +150,7 @@ function getEncodingHeader (supportedEncodings, request) {
   return null
 }
 
-function shouldCompress (type) {
+function shouldCompress (type, compressibleTypes) {
   if (compressibleTypes.test(type)) return true
   var data = mimedb[type.split(';', 1)[0].trim().toLowerCase()]
   if (data === undefined) return false

test.js

@@ -801,3 +801,71 @@ test('onSend hook should remove content-length', t => {
     t.strictEqual(payload.toString('utf-8'), file)
   })
 })
+
+test('Should compress if customTypes is set and matches content type', t => {
+  t.plan(3)
+  const fastify = Fastify()
+  fastify.register(compressPlugin, { customTypes: /x-user-header$/ })
+
+  fastify.get('/', (req, reply) => {
+    reply.type('application/x-user-header').send(createReadStream('./package.json'))
+  })
+
+  fastify.inject({
+    url: '/',
+    method: 'GET',
+    headers: {
+      'accept-encoding': 'gzip'
+    }
+  }, (err, res) => {
+    t.error(err)
+    t.strictEqual(res.headers['content-encoding'], 'gzip')
+    const file = readFileSync('./package.json', 'utf8')
+    const payload = zlib.gunzipSync(res.rawPayload)
+    t.strictEqual(payload.toString('utf-8'), file)
+  })
+})
+
+test('Should not compress if customTypes is set and does not match content type or mime-db', t => {
+  t.plan(3)
+  const fastify = Fastify()
+  fastify.register(compressPlugin, { customTypes: /x-user-header$/ })
+
+  fastify.get('/', (req, reply) => {
+    reply.type('application/x-other-type').send(createReadStream('./package.json'))
+  })
+
+  fastify.inject({
+    url: '/',
+    method: 'GET',
+    headers: {
+      'accept-encoding': 'gzip'
+    }
+  }, (err, res) => {
+    t.error(err)
+    t.notOk(res.headers['content-encoding'])
+    t.strictEqual(res.statusCode, 200)
+  })
+})
+
+test('Should not apply customTypes if value passed is not RegExp', t => {
+  t.plan(3)
+  const fastify = Fastify()
+  fastify.register(compressPlugin, { customTypes: 'x-user-header' })
+
+  fastify.get('/', (req, reply) => {
+    reply.type('application/x-user-header').send(createReadStream('./package.json'))
+  })
+
+  fastify.inject({
+    url: '/',
+    method: 'GET',
+    headers: {
+      'accept-encoding': 'gzip'
+    }
+  }, (err, res) => {
+    t.error(err)
+    t.notOk(res.headers['content-encoding'])
+    t.strictEqual(res.statusCode, 200)
+  })
+})