@fastify/compress 6.0.0 → 6.1.0

package/.github/workflows/ci.yml

@@ -1,45 +1,17 @@
 name: CI
-'on':
+
+on:
   push:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
   pull_request:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
+
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node-version:
-          - 14
-          - 16
-          - 18
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - windows-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install Dependencies
-        run: |
-          npm install --ignore-scripts
-      - name: Run Tests
-        run: |
-          npm test
-  automerge:
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-      contents: write
-    steps:
-      - uses: fastify/github-action-merge-dependabot@v3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    with:
+      lint: true

package/README.md

@@ -2,7 +2,6 @@
 
 ![CI](https://github.com/fastify/fastify-compress/workflows/CI/badge.svg)
 [![NPM version](https://img.shields.io/npm/v/@fastify/compress.svg?style=flat)](https://www.npmjs.com/package/@fastify/compress)
-[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fastify-compress/badge.svg)](https://snyk.io/test/github/fastify/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.

package/index.js

@@ -8,12 +8,10 @@ const intoStream = require('into-stream')
 const peek = require('peek-stream')
 const Minipass = require('minipass')
 const pumpify = require('pumpify')
-const isGzip = require('is-gzip')
-const isDeflate = require('is-deflate')
 const encodingNegotiator = require('encoding-negotiator')
 const { inherits, format } = require('util')
 
-const { isStream } = require('./lib/utils')
+const { isStream, isGzip, isDeflate } = 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)

package/lib/utils.js

@@ -1,7 +1,38 @@
 'use strict'
 
+// https://datatracker.ietf.org/doc/html/rfc1950#section-2
+function isDeflate (buffer) {
+  return (
+    typeof buffer === 'object' &&
+    buffer !== null &&
+    buffer.length > 1 &&
+    // CM = 8 denotes the "deflate" compression method
+    (buffer[0] & 0x0f) === 0x08 &&
+    // CINFO Values of above 7 are not allowed by RFC 1950
+    (buffer[0] & 0x80) === 0 &&
+    // The FCHECK value must be such that CMF and FLG, when viewed as
+    // a 16-bit unsigned integer stored in MSB order (CMF*256 + FLG),
+    // is a multiple of 31.
+    (((buffer[0] << 8) + buffer[1]) % 31) === 0
+  )
+}
+
+// https://datatracker.ietf.org/doc/html/rfc1952#page-6
+function isGzip (buffer) {
+  return (
+    typeof buffer === 'object' &&
+    buffer !== null &&
+    buffer.length > 2 &&
+    // ID1
+    buffer[0] === 0x1f &&
+    // ID2
+    buffer[1] === 0x8b &&
+    buffer[2] === 0x08
+  )
+}
+
 function isStream (stream) {
   return stream !== null && typeof stream === 'object' && typeof stream.pipe === 'function'
 }
 
-module.exports = { isStream }
+module.exports = { isGzip, isDeflate, isStream }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/compress",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Fastify compression utils",
   "main": "index.js",
   "types": "index.d.ts",
@@ -8,15 +8,11 @@
     "encoding-negotiator": "^2.0.1",
     "fastify-plugin": "^3.0.0",
     "into-stream": "^6.0.0",
-    "is-deflate": "^1.0.0",
-    "is-gzip": "^2.0.0",
-    "is-zip": "^1.0.0",
     "mime-db": "^1.51.0",
     "minipass": "^3.1.6",
     "peek-stream": "^1.1.3",
     "pump": "^3.0.0",
-    "pumpify": "^2.0.1",
-    "string-to-stream": "^3.0.1"
+    "pumpify": "^2.0.1"
   },
   "devDependencies": {
     "@types/node": "^17.0.8",
@@ -28,7 +24,7 @@
     "pre-commit": "^1.2.2",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.20.0",
+    "tsd": "^0.21.0",
     "typescript": "^4.5.4"
   },
   "scripts": {
@@ -61,9 +57,6 @@
     "type": "git",
     "url": "git+https://github.com/fastify/fastify-compress.git"
   },
-  "engines": {
-    "node": ">=10.16"
-  },
   "tsd": {
     "directory": "test/types"
   },

package/test/utils.test.js

@@ -4,7 +4,7 @@ const { createReadStream } = require('fs')
 const { Socket } = require('net')
 const { Duplex, PassThrough, Readable, Stream, Transform, Writable } = require('stream')
 const { test } = require('tap')
-const { isStream } = require('../lib/utils')
+const { isStream, isDeflate, isGzip } = require('../lib/utils')
 
 test('isStream() utility should be able to detect Streams', async (t) => {
   t.plan(12)
@@ -25,3 +25,39 @@ test('isStream() utility should be able to detect Streams', async (t) => {
   t.equal(isStream(undefined), false)
   t.equal(isStream(''), false)
 })
+
+test('isDeflate() utility should be able to detect deflate compressed Buffer', async (t) => {
+  t.plan(14)
+
+  t.equal(isDeflate(Buffer.alloc(0)), false)
+  t.equal(isDeflate(Buffer.alloc(0)), false)
+  t.equal(isDeflate(Buffer.from([0x78])), false)
+  t.equal(isDeflate(Buffer.from([0x78, 0x00])), false)
+  t.equal(isDeflate(Buffer.from([0x7a, 0x01])), false)
+  t.equal(isDeflate(Buffer.from([0x88, 0x01])), false)
+  t.equal(isDeflate(Buffer.from([0x78, 0x11])), false)
+  t.equal(isDeflate(Buffer.from([0x78, 0x01])), true)
+  t.equal(isDeflate(Buffer.from([0x78, 0x9c])), true)
+  t.equal(isDeflate(Buffer.from([0x78, 0xda])), true)
+
+  t.equal(isDeflate({}), false)
+  t.equal(isDeflate(null), false)
+  t.equal(isDeflate(undefined), false)
+  t.equal(isDeflate(''), false)
+})
+
+test('isGzip() utility should be able to detect gzip compressed Buffer', async (t) => {
+  t.plan(10)
+
+  t.equal(isGzip(Buffer.alloc(0)), false)
+  t.equal(isGzip(Buffer.alloc(1)), false)
+  t.equal(isGzip(Buffer.alloc(2)), false)
+  t.equal(isGzip(Buffer.from([0x1f, 0x8b])), false)
+  t.equal(isGzip(Buffer.from([0x1f, 0x8b, 0x00])), false)
+  t.equal(isGzip(Buffer.from([0x1f, 0x8b, 0x08])), true)
+
+  t.equal(isGzip({}), false)
+  t.equal(isGzip(null), false)
+  t.equal(isGzip(undefined), false)
+  t.equal(isGzip(''), false)
+})