@fastify/compress 6.5.0 → 7.0.1

package/README.md

@@ -4,7 +4,7 @@
 [![NPM version](https://img.shields.io/npm/v/@fastify/compress.svg?style=flat)](https://www.npmjs.com/package/@fastify/compress)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
-Adds compression utils to [the Fastify `reply` object](https://www.fastify.io/docs/latest/Reference/Reply/#reply) and a hook to decompress requests payloads.
+Adds compression utils to [the Fastify `reply` object](https://fastify.dev/docs/latest/Reference/Reply/#reply) and a hook to decompress requests payloads.
 Supports `gzip`, `deflate`, and `brotli`.
 
 > **Important note:** since `@fastify/compress` version 4.x payloads that are compressed using the `zip` algorithm are not automatically uncompressed anymore. `@fastify/compress` main feature is to provide response compression mechanism to your server, however the `zip` format does not appear in the [IANA maintained Table of Content Encodings](https://www.iana.org/assignments/http-parameters/http-parameters.xml#content-coding) and thus such behavior was out of the scope of this plugin.
@@ -169,7 +169,7 @@ You can tune compression by setting the `brotliOptions` and `zlibOptions` proper
     brotliOptions: {
       params: {
         [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT, // useful for APIs that primarily return text
-        [zlib.constants.BROTLI_PARAM_QUALITY]: 4, // default is 11, max is 11, min is 0
+        [zlib.constants.BROTLI_PARAM_QUALITY]: 4, // default is 4, max is 11, min is 0
       },
     },
     zlibOptions: {

package/index.js

@@ -109,6 +109,13 @@ function fastifyCompress (fastify, opts, next) {
 }
 
 const defaultCompressibleTypes = /^text\/(?!event-stream)|(?:\+|\/)json(?:;|$)|(?:\+|\/)text(?:;|$)|(?:\+|\/)xml(?:;|$)|octet-stream(?:;|$)/u
+const recommendedDefaultBrotliOptions = {
+  params: {
+    // Default of 4 as 11 has a heavy impact on performance.
+    // https://blog.cloudflare.com/this-is-brotli-from-origin#testing
+    [zlib.constants.BROTLI_PARAM_QUALITY]: 4
+  }
+}
 
 function processCompressParams (opts) {
   /* istanbul ignore next */
@@ -121,7 +128,9 @@ function processCompressParams (opts) {
   }
 
   params.removeContentLengthHeader = typeof opts.removeContentLengthHeader === 'boolean' ? opts.removeContentLengthHeader : true
-  params.brotliOptions = opts.brotliOptions
+  params.brotliOptions = params.global
+    ? { ...recommendedDefaultBrotliOptions, ...opts.brotliOptions }
+    : opts.brotliOptions
   params.zlibOptions = opts.zlibOptions
   params.onUnsupportedEncoding = opts.onUnsupportedEncoding
   params.inflateIfDeflated = opts.inflateIfDeflated === true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/compress",
-  "version": "6.5.0",
+  "version": "7.0.1",
   "description": "Fastify compression utils",
   "main": "index.js",
   "type": "commonjs",
@@ -25,7 +25,7 @@
     "jsonstream": "^1.0.3",
     "standard": "^17.1.0",
     "tap": "^16.3.7",
-    "tsd": "^0.29.0",
+    "tsd": "^0.30.0",
     "typescript": "^5.1.6"
   },
   "scripts": {

package/test/global-compress.test.js

@@ -2534,36 +2534,69 @@ test('When `encodings` option is set, it should only use the registered value',
   t.equal(response.statusCode, 200)
 })
 
-test('It should send data compressed according to `brotliOptions`', async (t) => {
-  t.plan(2)
-  const brotliOptions = {
-    params: {
-      [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
-      [zlib.constants.BROTLI_PARAM_QUALITY]: 4
+test('It should send data compressed according to `brotliOptions` :', async (t) => {
+  t.test('when using br encoding', async (t) => {
+    t.plan(3)
+    const brotliOptions = {
+      params: {
+        [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
+        [zlib.constants.BROTLI_PARAM_QUALITY]: 8
+      }
     }
-  }
 
-  const fastify = Fastify()
-  await fastify.register(compressPlugin, { global: true, brotliOptions })
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, { global: true, brotliOptions })
 
-  fastify.get('/', (request, reply) => {
-    reply
-      .type('text/plain')
-      .compress(createReadStream('./package.json'))
+    fastify.get('/', (request, reply) => {
+      reply
+        .type('text/plain')
+        .compress(createReadStream('./package.json'))
+    })
+
+    const response = await fastify.inject({
+      url: '/',
+      method: 'GET',
+      headers: {
+        'accept-encoding': 'br'
+      }
+    })
+
+    const file = readFileSync('./package.json', 'utf8')
+    const payload = zlib.brotliDecompressSync(response.rawPayload, brotliOptions)
+    t.equal(response.headers['content-encoding'], 'br')
+    t.equal(payload.toString('utf-8'), file)
+
+    const compressedPayload = zlib.brotliCompressSync(file, brotliOptions)
+    t.same(response.rawPayload, compressedPayload)
   })
 
-  const response = await fastify.inject({
-    url: '/',
-    method: 'GET',
-    headers: {
-      'accept-encoding': 'br'
+  t.test('default BROTLI_PARAM_QUALITY to be 4', async (t) => {
+    t.plan(1)
+
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, { global: true })
+
+    const file = readFileSync('./package.json', 'utf8')
+    fastify.get('/', (request, reply) => {
+      reply
+        .type('text/plain')
+        .compress(file)
+    })
+
+    const response = await fastify.inject({
+      url: '/',
+      method: 'GET',
+      headers: {
+        'accept-encoding': 'br'
+      }
+    })
+
+    const defaultBrotliOptions = {
+      params: { [zlib.constants.BROTLI_PARAM_QUALITY]: 4 }
     }
+    const compressedPayload = zlib.brotliCompressSync(file, defaultBrotliOptions)
+    t.same(response.rawPayload, compressedPayload)
   })
-
-  const file = readFileSync('./package.json', 'utf8')
-  const payload = zlib.brotliDecompressSync(response.rawPayload, brotliOptions)
-  t.equal(response.headers['content-encoding'], 'br')
-  t.equal(payload.toString('utf-8'), file)
 })
 
 test('It should send data compressed according to `zlibOptions` :', async (t) => {

package/types/index.test-d.ts

@@ -40,7 +40,7 @@ app.get('/test-two', async (request, reply) => {
   expectError(reply.compress())
 })
 
-// Instanciation of an app without global
+// Instantiation of an app without global
 const appWithoutGlobal: FastifyInstance = fastify()
 appWithoutGlobal.register(fastifyCompress, { global: false })
 
@@ -107,11 +107,11 @@ appWithoutGlobal.inject(
     }
   },
   (err) => {
-    expectType<Error>(err)
+    expectType<Error | undefined>(err)
   }
 )
 
-// Instanciation of an app that should trigger a typescript error
+// Instantiation of an app that should trigger a typescript error
 const appThatTriggerAnError = fastify()
 expectError(appThatTriggerAnError.register(fastifyCompress, {
   global: true,