@fastify/compress 8.3.1 → 9.1.0

package/.c8rc

@@ -1,14 +1,10 @@
 {
   "all": true,
-  "exclude": [
-    "test/",
-    "coverage/",
-    "types/"
-  ],
+  "exclude": ["test/", "coverage/", "types/", "eslint.config.js"],
   "clean": true,
   "check-coverage": true,
   "branches": 100,
   "lines": 100,
   "functions": 100,
   "statements": 100
-}
+}

package/.github/dependabot.yml

@@ -2,12 +2,52 @@ version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
     schedule:
-      interval: "monthly"
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    allow:
+      - dependency-name: "*"
+        update-types:
+          - "version-update:semver-major"
     open-pull-requests-limit: 10
 
   - package-ecosystem: "npm"
     directory: "/"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
     schedule:
-      interval: "monthly"
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    versioning-strategy: "increase-if-necessary"
+    allow:
+      - dependency-name: "*"
+        update-types:
+          - "version-update:semver-major"
+    ignore:
+      # TODO: remove ignore until neostandard support ESLint 10
+      - dependency-name: "eslint"
+      - dependency-name: "neostandard"
+      - dependency-name: "@stylistic/*"
     open-pull-requests-limit: 10
+    groups:
+      # Production dependencies with breaking changes
+      dependencies:
+        dependency-type: "production"
+      # ESLint related dependencies
+      dev-dependencies-eslint:
+        patterns:
+          - "eslint"
+          - "neostandard"
+          - "@stylistic/*"
+      # TypeScript related dependencies
+      dev-dependencies-typescript:
+        patterns:
+          - "@types/*"
+          - "tstyche"
+          - "typescript"

package/.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
     permissions:
       contents: write
       pull-requests: write
-    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v6
     with:
       license-check: true
       lint: true

package/.github/workflows/lock-threads.yml

@@ -0,0 +1,19 @@
+name: Lock Threads
+
+on:
+  schedule:
+    - cron: '0 0 1 * *'
+  workflow_dispatch:
+
+concurrency:
+  group: lock
+
+permissions:
+  contents: read
+
+jobs:
+  lock-threads:
+    permissions:
+      issues: write
+      pull-requests: write
+    uses: fastify/workflows/.github/workflows/lock-threads.yml@v6

package/LICENSE

@@ -1,8 +1,6 @@
 MIT License
 
-Copyright (c) 2017-present The Fastify team
-
-The Fastify team members are listed at https://github.com/fastify/fastify#team.
+Copyright (c) 2017-present The Fastify team <https://github.com/fastify/fastify#team>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -396,9 +396,8 @@ await fastify.register(
 
 ## Acknowledgments
 
-Past sponsors:
-
-- [LetzDoIt](http://www.letzdoitapp.com/)
+Past sp
+- LetzDoIt
 
 ## License
 

package/index.js

@@ -2,17 +2,24 @@
 
 const zlib = require('node:zlib')
 const { inherits, format } = require('node:util')
+const { pipeline, compose } = require('node:stream')
 
 const fp = require('fastify-plugin')
 const encodingNegotiator = require('@fastify/accept-negotiator')
-const pump = require('pump')
 const mimedb = require('mime-db')
-const peek = require('peek-stream')
 const { Minipass } = require('minipass')
-const pumpify = require('pumpify')
 const { Readable } = require('readable-stream')
 
-const { isStream, isGzip, isDeflate, intoAsyncIterator, isWebReadableStream, isFetchResponse, webStreamToNodeReadable } = require('./lib/utils')
+const {
+  isStream,
+  isGzip,
+  isDeflate,
+  intoAsyncIterator,
+  isWebReadableStream,
+  isFetchResponse,
+  webStreamToNodeReadable,
+  createPeekTransform
+} = require('./lib/utils')
 
 const InvalidRequestEncodingError = createError('FST_CP_ERR_INVALID_CONTENT_ENCODING', 'Unsupported Content-Encoding: %s', 415)
 const InvalidRequestCompressedPayloadError = createError('FST_CP_ERR_INVALID_CONTENT', 'Could not decompress the request payload using the provided encoding', 400)
@@ -50,11 +57,6 @@ 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?.compress !== undefined) {
-      routeOptions.compress = routeOptions.config.compress
-    }
-
     // Manage compression options
     if (routeOptions.compress !== undefined) {
       if (typeof routeOptions.compress === 'object') {
@@ -79,11 +81,6 @@ function fastifyCompress (fastify, opts, next) {
       buildRouteCompress(fastify, globalCompressParams, routeOptions, true)
     }
 
-    // If route config.decompress has been set it takes precedence over compress
-    if (routeOptions.config?.decompress !== undefined) {
-      routeOptions.decompress = routeOptions.config.decompress
-    }
-
     // Manage decompression options
     if (routeOptions.decompress !== undefined) {
       if (typeof routeOptions.decompress === 'object') {
@@ -269,6 +266,9 @@ function buildRouteCompress (_fastify, params, routeOptions, decorateOnly) {
     const noCompress =
       // don't compress on x-no-compression header
       (req.headers['x-no-compression'] !== undefined) ||
+      // don't compress partial content: Content-Range describes unencoded byte offsets
+      (reply.statusCode === 206) ||
+      (reply.getHeader('Content-Range') !== undefined) ||
       // don't compress if not one of the indicated compressible types
       (shouldCompress(reply.getHeader('Content-Type') || 'application/json', params.compressibleTypes) === false) ||
       // don't compress on missing or identity `accept-encoding` header
@@ -289,7 +289,7 @@ function buildRouteCompress (_fastify, params, routeOptions, decorateOnly) {
         encoding === undefined
           ? reply.removeHeader('Content-Encoding')
           : reply.header('Content-Encoding', 'identity')
-        pump(stream, payload = unzipStream(params.uncompressStream), onEnd.bind(reply))
+        pipeline(stream, payload = unzipStream(params.uncompressStream), onEnd.bind(reply))
       }
       return next(null, payload)
     }
@@ -316,7 +316,7 @@ function buildRouteCompress (_fastify, params, routeOptions, decorateOnly) {
     }
 
     stream = zipStream(params.compressStream, encoding)
-    pump(payload, stream, onEnd.bind(reply))
+    pipeline(payload, stream, onEnd.bind(reply))
     next(null, stream)
   }
 }
@@ -378,7 +378,10 @@ function buildRouteDecompress (_fastify, params, routeOptions) {
     raw.on('data', trackEncodedLength.bind(decompresser))
     raw.on('end', removeEncodedLengthTracking)
 
-    next(null, pump(raw, decompresser))
+    pipeline(raw, decompresser, () => {
+      // Cleanup callback - decompression errors are handled by decompresser's error handler
+    })
+    next(null, decompresser)
   }
 }
 
@@ -415,7 +418,7 @@ function compress (params) {
         encoding === undefined
           ? this.removeHeader('Content-Encoding')
           : this.header('Content-Encoding', 'identity')
-        pump(stream, payload = unzipStream(params.uncompressStream), onEnd.bind(this))
+        pipeline(stream, payload = unzipStream(params.uncompressStream), onEnd.bind(this))
       }
       return this.send(payload)
     }
@@ -446,7 +449,7 @@ function compress (params) {
     }
 
     stream = zipStream(params.compressStream, encoding)
-    pump(payload, stream, onEnd.bind(this))
+    pipeline(payload, stream, onEnd.bind(this))
     return this.send(stream)
   }
 }
@@ -464,7 +467,17 @@ function setVaryHeader (reply) {
 }
 
 function onEnd (err) {
-  if (err) this.log.error(err)
+  // Client disconnection during streaming is expected and handled by Fastify.
+  // Do not log "premature close" errors at error level since they are not
+  // actual errors - they occur when clients disconnect mid-response.
+  // Node's native stream.pipeline emits ERR_STREAM_PREMATURE_CLOSE with the
+  // message 'Premature close', while the legacy pump/end-of-stream packages
+  // emit 'premature close' without a code, so both variants are checked.
+  // See: https://github.com/fastify/fastify-compress/issues/382
+  // See: https://github.com/fastify/fastify-compress/issues/410
+  if (err && err.code !== 'ERR_STREAM_PREMATURE_CLOSE' && err.message !== 'premature close') {
+    this.log.error(err)
+  }
 }
 
 function trackEncodedLength (chunk) {
@@ -549,26 +562,26 @@ function maybeUnzip (payload, serialize) {
 }
 
 function zipStream (deflate, encoding) {
-  return peek({ newline: false, maxBuffer: 10 }, function (data, swap) {
+  return createPeekTransform(function (data) {
     switch (isCompressed(data)) {
-      case 1: return swap(null, new Minipass())
-      case 2: return swap(null, new Minipass())
+      case 1: return new Minipass()
+      case 2: return new Minipass()
     }
-    return swap(null, deflate[encoding]())
+    return deflate[encoding]()
   })
 }
 
 function unzipStream (inflate, maxRecursion) {
   if (!(maxRecursion >= 0)) maxRecursion = 3
-  return peek({ newline: false, maxBuffer: 10 }, function (data, swap) {
+  return createPeekTransform(function (data) {
     // This path is never taken, when `maxRecursion` < 0 it is automatically set back to 3
     /* c8 ignore next */
-    if (maxRecursion < 0) return swap(new Error('Maximum recursion reached'))
+    if (maxRecursion < 0) throw new Error('Maximum recursion reached')
     switch (isCompressed(data)) {
-      case 1: return swap(null, pumpify(inflate.gzip(), unzipStream(inflate, maxRecursion - 1)))
-      case 2: return swap(null, pumpify(inflate.deflate(), unzipStream(inflate, maxRecursion - 1)))
+      case 1: return compose(inflate.gzip(), unzipStream(inflate, maxRecursion - 1))
+      case 2: return compose(inflate.deflate(), unzipStream(inflate, maxRecursion - 1))
     }
-    return swap(null, new Minipass())
+    return new Minipass()
   })
 }
 

package/lib/utils.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { Readable: NodeReadable } = require('node:stream')
+const { Transform } = require('readable-stream')
 
 // https://datatracker.ietf.org/doc/html/rfc8878#section-3.1.1
 function isZstd (buffer) {
@@ -104,4 +105,92 @@ async function * intoAsyncIterator (payload) {
   yield payload
 }
 
-module.exports = { isZstd, isGzip, isDeflate, isStream, intoAsyncIterator, isWebReadableStream, isFetchResponse, webStreamToNodeReadable }
+function createPeekTransform (swapStream, peekSize = 10) {
+  const buffers = []
+  let bufferSize = 0
+  let downstream = null
+  let flushCallback = null
+
+  const _transform = new Transform({
+    transform (chunk, encoding, callback) {
+      // when downstream already selected, directly passthrough
+      if (downstream !== null) return downstream.write(chunk, encoding, callback)
+
+      bufferSize += chunk.length
+      buffers.push(chunk)
+
+      // read more data when buffer size smaller than peeksize
+      if (bufferSize < peekSize) return callback()
+
+      wireDownStream(callback)
+    },
+    flush (callback) {
+      // used in "end" event to notify the transform finished flush
+      flushCallback = callback
+      if (downstream !== null) {
+        // all data should be flushed to downstream already
+        // we end the stream
+        downstream.end()
+      } else {
+        // flush internal buffers and end the downstream
+        wireDownStream((error) => {
+          if (error) {
+            flushCallback = null
+            callback(error)
+          } else {
+            downstream.end()
+          }
+        })
+      }
+    }
+  })
+
+  function onData (chunk) {
+    _transform.push(chunk)
+  }
+
+  function onError (error) {
+    _transform.destroy(error)
+  }
+
+  function onEnd () {
+    flushCallback && flushCallback()
+    // cleanup
+    downstream.off('data', onData)
+    downstream.off('error', onError)
+    downstream.off('end', onEnd)
+    downstream = null
+    flushCallback = null
+
+    _transform.push(null)
+  }
+
+  function wireDownStream (callback) {
+    const data = Buffer.concat(buffers)
+    try {
+      downstream = swapStream(data.subarray(0, peekSize))
+      downstream.on('data', onData)
+      downstream.on('error', onError)
+      downstream.on('end', onEnd)
+      downstream.write(data, callback)
+      // cleanup
+      buffers.length = 0
+    } catch (error) {
+      callback(error)
+    }
+  }
+
+  return _transform
+}
+
+module.exports = {
+  isZstd,
+  isGzip,
+  isDeflate,
+  isStream,
+  intoAsyncIterator,
+  isWebReadableStream,
+  isFetchResponse,
+  webStreamToNodeReadable,
+  createPeekTransform
+}

package/package.json

@@ -1,36 +1,33 @@
 {
   "name": "@fastify/compress",
-  "version": "8.3.1",
+  "version": "9.1.0",
   "description": "Fastify compression utils",
   "main": "index.js",
   "type": "commonjs",
   "types": "types/index.d.ts",
   "dependencies": {
     "@fastify/accept-negotiator": "^2.0.0",
-    "fastify-plugin": "^5.0.0",
+    "fastify-plugin": "^6.0.0",
     "mime-db": "^1.52.0",
     "minipass": "^7.0.4",
-    "peek-stream": "^1.1.3",
-    "pump": "^3.0.0",
-    "pumpify": "^2.0.1",
     "readable-stream": "^4.5.2"
   },
   "devDependencies": {
-    "@types/node": "^24.0.8",
+    "@types/node": "^26.0.1",
     "adm-zip": "^0.5.12",
-    "c8": "^10.1.2",
+    "c8": "^11.0.0",
     "eslint": "^9.17.0",
     "fastify": "^5.0.0",
     "jsonstream": "^1.0.3",
-    "neostandard": "^0.12.0",
-    "tsd": "^0.33.0",
-    "typescript": "~5.9.2"
+    "neostandard": "^0.13.0",
+    "tstyche": "^7.1.0",
+    "typescript": "~6.0.2"
   },
   "scripts": {
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
-    "test:typescript": "tsd",
+    "test:typescript": "tstyche",
     "test:unit": "node --test",
     "test:coverage": "c8 node --test && c8 report --reporter=html",
     "test:unit:verbose": "npm run test:unit -- -Rspec"
@@ -43,7 +40,7 @@
     "brotli",
     "zstd"
   ],
-  "author": "Tomas Della Vedova - @delvedor (http://delved.org)",
+  "author": "Tomas Della Vedova - @delvedor (https://delvedor.dev)",
   "contributors": [
     {
       "name": "Matteo Collina",
@@ -82,9 +79,6 @@
     "type": "git",
     "url": "git+https://github.com/fastify/fastify-compress.git"
   },
-  "tsd": {
-    "directory": "types"
-  },
   "publishConfig": {
     "access": "public"
   }

package/test/global-compress.test.js

@@ -682,6 +682,41 @@ describe('When a custom `zlib` option is provided, it should compress data :`',
     t.assert.equal(response.headers['content-encoding'], 'gzip')
     t.assert.equal(payload.toString('utf-8'), file)
   })
+
+  test('using the custom `createZstdCompress()` method', async (t) => {
+    if (typeof zlib.createZstdCompress !== 'function') {
+      t.skip('zstd not supported in this Node.js version')
+      return
+    }
+    t.plan(4)
+
+    let usedCustom = false
+    const customZlib = { createZstdCompress: () => (usedCustom = true) && zlib.createZstdCompress() }
+
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, { global: true, zlib: customZlib })
+
+    fastify.get('/', (_request, reply) => {
+      reply
+        .type('text/plain')
+        .compress(createReadStream('./package.json'))
+    })
+
+    const response = await fastify.inject({
+      url: '/',
+      method: 'GET',
+      headers: {
+        'accept-encoding': 'zstd'
+      }
+    })
+    t.assert.equal(usedCustom, true)
+
+    const file = readFileSync('./package.json', 'utf8')
+    const payload = zlib.zstdDecompressSync(response.rawPayload)
+    t.assert.equal(response.headers.vary, 'accept-encoding')
+    t.assert.equal(response.headers['content-encoding'], 'zstd')
+    t.assert.equal(payload.toString('utf-8'), file)
+  })
 })
 
 describe('When a malformed custom `zlib` option is provided, it should compress data :', async () => {
@@ -765,6 +800,37 @@ describe('When a malformed custom `zlib` option is provided, it should compress
     const payload = zlib.gunzipSync(response.rawPayload)
     t.assert.equal(payload.toString('utf-8'), 'hello')
   })
+
+  test('using the fallback default Node.js core `zlib.createZstdCompress()` method', async (t) => {
+    if (typeof zlib.createZstdCompress !== 'function') {
+      t.skip('zstd not supported in this Node.js version')
+      return
+    }
+    t.plan(1)
+
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, {
+      global: true,
+      threshold: 0,
+      zlib: true // will trigger a fallback on the default zlib.createZstdCompress
+    })
+
+    fastify.get('/', (_request, reply) => {
+      reply
+        .type('text/plain')
+        .compress('hello')
+    })
+
+    const response = await fastify.inject({
+      url: '/',
+      method: 'GET',
+      headers: {
+        'accept-encoding': 'zstd'
+      }
+    })
+    const payload = zlib.zstdDecompressSync(response.rawPayload)
+    t.assert.equal(payload.toString('utf-8'), 'hello')
+  })
 })
 
 describe('When `inflateIfDeflated` is `true` and `X-No-Compression` request header is `true` :', async () => {
@@ -3548,3 +3614,56 @@ test('It should demonstrate globalDecompression controls decompression independe
   t.assert.equal(response.statusCode, 400)
   t.assert.ok(response.body.includes('Content-Length') || response.body.includes('Bad Request'))
 })
+
+describe('Range Responses', () => {
+  test('it should not compress 206 Partial Content responses', async (t) => {
+    t.plan(4)
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, { threshold: 0 })
+
+    fastify.get('/partial', (request, reply) => {
+      reply
+        .status(206)
+        .header('Content-Type', 'text/plain')
+        .header('Content-Range', 'bytes 0-4/12')
+        .header('Content-Length', '5')
+        .send('hello')
+    })
+
+    const response = await fastify.inject({
+      url: '/partial',
+      method: 'GET',
+      headers: { 'accept-encoding': 'gzip' }
+    })
+
+    t.assert.equal(response.statusCode, 206)
+    t.assert.equal(response.headers['content-encoding'], undefined)
+    t.assert.equal(response.headers['content-range'], 'bytes 0-4/12')
+    t.assert.equal(response.body, 'hello')
+  })
+
+  test('it should not compress responses carrying a Content-Range header', async (t) => {
+    t.plan(4)
+    const fastify = Fastify()
+    await fastify.register(compressPlugin, { threshold: 0 })
+
+    fastify.get('/content-range', (request, reply) => {
+      reply
+        .header('Content-Type', 'text/plain')
+        .header('Content-Range', 'bytes 0-4/12')
+        .header('Content-Length', '5')
+        .send('hello')
+    })
+
+    const response = await fastify.inject({
+      url: '/content-range',
+      method: 'GET',
+      headers: { 'accept-encoding': 'gzip' }
+    })
+
+    t.assert.equal(response.statusCode, 200)
+    t.assert.equal(response.headers['content-encoding'], undefined)
+    t.assert.equal(response.headers['content-range'], 'bytes 0-4/12')
+    t.assert.equal(response.body, 'hello')
+  })
+})

package/test/global-decompress.test.js

@@ -2,9 +2,9 @@
 
 const { test, describe } = require('node:test')
 const { createReadStream } = require('node:fs')
+const { pipeline } = require('node:stream')
 const path = require('node:path')
 const zlib = require('node:zlib')
-const pump = require('pump')
 const Fastify = require('fastify')
 const compressPlugin = require('../index')
 
@@ -12,7 +12,9 @@ function createPayload (compressor) {
   let payload = createReadStream(path.resolve(__dirname, '../package.json'))
 
   if (compressor) {
-    payload = pump(payload, compressor())
+    const compressed = compressor()
+    pipeline(payload, compressed, () => {})
+    payload = compressed
   }
 
   return payload