@fastify/compress 6.4.0 → 7.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Set default behavior to automatically convert line endings
+* text=auto eol=lf

package/.taprc

@@ -1,6 +1,2 @@
-ts: false
-jsx: false
-flow: false
-coverage: true
-check-coverage: true
-100: true
+files:
+  - test/**/*.test.js

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

@@ -1,15 +1,16 @@
 'use strict'
 
+const zlib = require('node:zlib')
+const { inherits, format } = require('node:util')
+
 const fp = require('fastify-plugin')
-const zlib = require('zlib')
+const encodingNegotiator = require('@fastify/accept-negotiator')
 const pump = require('pump')
 const mimedb = require('mime-db')
 const intoStream = require('into-stream')
 const peek = require('peek-stream')
 const { Minipass } = require('minipass')
 const pumpify = require('pumpify')
-const encodingNegotiator = require('@fastify/accept-negotiator')
-const { inherits, format } = require('util')
 
 const { isStream, isGzip, isDeflate } = require('./lib/utils')
 
@@ -50,12 +51,12 @@ function fastifyCompress (fastify, opts, next) {
   // add onSend hook onto each route as needed
   fastify.addHook('onRoute', (routeOptions) => {
     // If route config.compress has been set it takes precedence over compress
-    if (routeOptions.config && typeof routeOptions.config.compress !== 'undefined') {
+    if (routeOptions.config?.compress !== undefined) {
       routeOptions.compress = routeOptions.config.compress
     }
 
     // Manage compression options
-    if (typeof routeOptions.compress !== 'undefined') {
+    if (routeOptions.compress !== undefined) {
       if (typeof routeOptions.compress === 'object') {
         const mergedCompressParams = Object.assign(
           {}, globalCompressParams, processCompressParams(routeOptions.compress)
@@ -79,12 +80,12 @@ function fastifyCompress (fastify, opts, next) {
     }
 
     // If route config.decompress has been set it takes precedence over compress
-    if (routeOptions.config && typeof routeOptions.config.decompress !== 'undefined') {
+    if (routeOptions.config?.decompress !== undefined) {
       routeOptions.decompress = routeOptions.config.decompress
     }
 
     // Manage decompression options
-    if (typeof routeOptions.decompress !== 'undefined') {
+    if (routeOptions.decompress !== undefined) {
       if (typeof routeOptions.decompress === 'object') {
         // if the current endpoint has a custom compress configuration ...
         const mergedDecompressParams = Object.assign(
@@ -107,7 +108,7 @@ function fastifyCompress (fastify, opts, next) {
   next()
 }
 
-const defaultCompressibleTypes = /^text\/(?!event-stream)|(\+|\/)json(;|$)|(\+|\/)text(;|$)|(\+|\/)xml(;|$)|octet-stream(;|$)/
+const defaultCompressibleTypes = /^text\/(?!event-stream)|(?:\+|\/)json(?:;|$)|(?:\+|\/)text(?:;|$)|(?:\+|\/)xml(?:;|$)|octet-stream(?:;|$)/u
 
 function processCompressParams (opts) {
   /* istanbul ignore next */
@@ -116,7 +117,12 @@ function processCompressParams (opts) {
   }
 
   const params = {
-    global: (typeof opts.global === 'boolean') ? opts.global : true
+    global: (typeof opts.global === 'boolean') ? opts.global : true,
+    /**
+     * Default of 4 as 11 has a heavy impact on performance.
+     * @see {@link https://blog.cloudflare.com/this-is-brotli-from-origin#testing}
+     */
+    brotliOptions: { [zlib.constants.BROTLI_PARAM_QUALITY]: 4, ...opts.brotliOptions }
   }
 
   params.removeContentLengthHeader = typeof opts.removeContentLengthHeader === 'boolean' ? opts.removeContentLengthHeader : true
@@ -452,6 +458,8 @@ function onDecompressError (request, params, encoding, error) {
   Object.assign(error, errorPayload)
 }
 
+const gzipAlias = /\*|x-gzip/gu
+
 function getEncodingHeader (encodings, request) {
   let header = request.headers['accept-encoding']
   if (header != null) {
@@ -459,7 +467,7 @@ function getEncodingHeader (encodings, request) {
       // consider the no-preference token as gzip for downstream compat
       // and x-gzip as an alias of gzip
       // ref.: [HTTP/1.1 RFC 7230 section 4.2.3](https://datatracker.ietf.org/doc/html/rfc7230#section-4.2.3)
-      .replace(/\*|x-gzip/g, 'gzip')
+      .replace(gzipAlias, 'gzip')
     return encodingNegotiator.negotiate(header, encodings)
   } else {
     return undefined

package/package.json

@@ -1,44 +1,42 @@
 {
   "name": "@fastify/compress",
-  "version": "6.4.0",
+  "version": "7.0.0",
   "description": "Fastify compression utils",
   "main": "index.js",
+  "type": "commonjs",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@fastify/accept-negotiator": "^1.0.0",
-    "fastify-plugin": "^4.0.0",
+    "@fastify/accept-negotiator": "^1.1.0",
+    "fastify-plugin": "^4.5.0",
     "into-stream": "^6.0.0",
-    "mime-db": "^1.51.0",
-    "minipass": "^6.0.0",
+    "mime-db": "^1.52.0",
+    "minipass": "^7.0.2",
     "peek-stream": "^1.1.3",
     "pump": "^3.0.0",
     "pumpify": "^2.0.1"
   },
   "devDependencies": {
     "@fastify/pre-commit": "^2.0.2",
-    "@types/node": "^20.1.0",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
-    "adm-zip": "^0.5.9",
-    "fastify": "^4.0.0-rc.2",
+    "@types/node": "^20.4.2",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "adm-zip": "^0.5.10",
+    "fastify": "^4.19.2",
     "jsonstream": "^1.0.3",
-    "standard": "^17.0.0",
-    "tap": "^16.0.0",
-    "tsd": "^0.28.0",
-    "typescript": "^5.0.2"
+    "standard": "^17.1.0",
+    "tap": "^16.3.7",
+    "tsd": "^0.30.0",
+    "typescript": "^5.1.6"
   },
   "scripts": {
-    "coverage": "npm run unit -- --cov",
-    "coverage-report": "npm run coverage -- --coverage-report=lcov",
+    "coverage": "npm run test:unit -- --coverage-report=html",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
-    "lint:typescript": "npm run lint:fix -- --parser @typescript-eslint/parser --plugin typescript test/types/*.ts",
-    "lint:types": "npm run lint:fix -- --parser @typescript-eslint/parser --plugin typescript *.d.ts",
-    "test": "npm run lint && npm run unit && npm run test:typescript",
+    "lint:fix:typescript": "npm run lint:fix -- --parser @typescript-eslint/parser --plugin @typescript-eslint/eslint-plugin \"**/*.d.ts\"",
+    "test": "npm run test:unit && npm run test:typescript",
     "test:typescript": "tsd",
-    "unit": "tap -J test/*.test.js",
-    "unit:report": "npm run unit -- --cov --coverage-report=html",
-    "unit:verbose": "npm run unit -- -Rspec"
+    "test:unit": "tap",
+    "test:unit:verbose": "npm run test:unit -- -Rspec"
   },
   "keywords": [
     "fastify",

package/test/global-compress.test.js

@@ -1,14 +1,14 @@
 'use strict'
 
 const { test } = require('tap')
-const { createReadStream, readFile, readFileSync } = require('fs')
-const { Readable, Writable, PassThrough } = require('stream')
-const zlib = require('zlib')
+const { createReadStream, readFile, readFileSync } = require('node:fs')
+const { Readable, Writable, PassThrough } = require('node:stream')
+const zlib = require('node:zlib')
 const AdmZip = require('adm-zip')
 const JSONStream = require('jsonstream')
 const Fastify = require('fastify')
 const compressPlugin = require('../index')
-const { once } = require('events')
+const { once } = require('node:events')
 
 test('When `global` is not set, it is `true` by default :', async (t) => {
   t.test('it should compress Buffer data using brotli when `Accept-Encoding` request header is `br`', async (t) => {
@@ -766,7 +766,7 @@ test('It should not compress :', async (t) => {
       t.plan(2)
 
       const fastify = Fastify()
-      await fastify.register(compressPlugin, { customTypes: /x-user-header$/ })
+      await fastify.register(compressPlugin, { customTypes: /x-user-header$/u })
 
       fastify.get('/', (request, reply) => {
         reply
@@ -1101,7 +1101,7 @@ test('It should not compress :', async (t) => {
       t.plan(2)
 
       const fastify = Fastify()
-      await fastify.register(compressPlugin, { customTypes: /x-user-header$/ })
+      await fastify.register(compressPlugin, { customTypes: /x-user-header$/u })
 
       fastify.get('/', (request, reply) => {
         reply
@@ -1442,7 +1442,7 @@ test('It should not double-compress :', async (t) => {
     })
     const payload = zlib.brotliDecompressSync(response.rawPayload)
     t.equal(response.headers['content-encoding'], 'br')
-    t.equal(response.headers['content-length'], response.rawPayload.length)
+    t.equal(response.headers['content-length'], response.rawPayload.length.toString())
     t.equal(payload.toString('utf-8'), file)
   })
 
@@ -1472,7 +1472,7 @@ test('It should not double-compress :', async (t) => {
     })
     const payload = zlib.inflateSync(response.rawPayload)
     t.equal(response.headers['content-encoding'], 'deflate')
-    t.equal(response.headers['content-length'], response.rawPayload.length)
+    t.equal(response.headers['content-length'], response.rawPayload.length.toString())
     t.equal(payload.toString('utf-8'), file)
   })
 
@@ -1502,7 +1502,7 @@ test('It should not double-compress :', async (t) => {
     })
     const payload = zlib.gunzipSync(response.rawPayload)
     t.equal(response.headers['content-encoding'], 'gzip')
-    t.equal(response.headers['content-length'], response.rawPayload.length)
+    t.equal(response.headers['content-length'], response.rawPayload.length.toString())
     t.equal(payload.toString('utf-8'), file)
   })
 })
@@ -2445,7 +2445,7 @@ test('`Accept-Encoding` request header values :', async (t) => {
 test('It should compress data if `customTypes` is set and matches `Content-Type` reply header value', async (t) => {
   t.plan(2)
   const fastify = Fastify()
-  await fastify.register(compressPlugin, { customTypes: /x-user-header$/ })
+  await fastify.register(compressPlugin, { customTypes: /x-user-header$/u })
 
   fastify.get('/', (request, reply) => {
     reply

package/test/global-decompress.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
 const { test } = require('tap')
-const { createReadStream } = require('fs')
-const path = require('path')
-const zlib = require('zlib')
+const { createReadStream } = require('node:fs')
+const path = require('node:path')
+const zlib = require('node:zlib')
 const pump = require('pump')
 const Fastify = require('fastify')
 const compressPlugin = require('../index')

package/test/routes-compress.test.js

@@ -1,8 +1,8 @@
 'use strict'
 
 const { test } = require('tap')
-const { createReadStream, readFile, readFileSync } = require('fs')
-const zlib = require('zlib')
+const { createReadStream, readFile, readFileSync } = require('node:fs')
+const zlib = require('node:zlib')
 const Fastify = require('fastify')
 const compressPlugin = require('../index')
 

package/test/routes-decompress.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
 const { test } = require('tap')
-const { createReadStream } = require('fs')
-const path = require('path')
-const zlib = require('zlib')
+const { createReadStream } = require('node:fs')
+const path = require('node:path')
+const zlib = require('node:zlib')
 const pump = require('pump')
 const Fastify = require('fastify')
 const compressPlugin = require('../index')

package/test/utils.test.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const { createReadStream } = require('fs')
-const { Socket } = require('net')
-const { Duplex, PassThrough, Readable, Stream, Transform, Writable } = require('stream')
+const { createReadStream } = require('node:fs')
+const { Socket } = require('node:net')
+const { Duplex, PassThrough, Readable, Stream, Transform, Writable } = require('node:stream')
 const { test } = require('tap')
 const { isStream, isDeflate, isGzip } = require('../lib/utils')