@fastify/compress 7.0.1 → 7.0.3

package/test/regression/issue-288.test.js

@@ -0,0 +1,62 @@
+'use strict'
+
+const { test } = require('tap')
+const Fastify = require('fastify')
+const fastifyCompress = require('../..')
+const { request } = require('node:http')
+
+function fetch (url) {
+  return new Promise(function (resolve, reject) {
+    request(url, function (response) {
+      // we need to use Buffer.concat to prevent wrong utf8 handling
+      let body = Buffer.from('')
+      response.on('data', function (chunk) {
+        body = Buffer.concat([body, Buffer.from(chunk, 'utf-8')])
+      })
+      response.once('error', reject)
+      response.once('end', function () {
+        resolve(body.toString())
+      })
+    })
+      .once('error', reject)
+      .end()
+  })
+}
+
+test('should not corrupt the file content', async (t) => {
+  t.plan(2)
+
+  // provide 2 byte unicode content
+  const twoByteUnicodeContent = new Array(5_000)
+    .fill('0')
+    .map(() => {
+      const random = new Array(10).fill('A').join('🍃')
+      return random + '- FASTIFY COMPRESS,🍃 FASTIFY COMPRESS'
+    })
+    .join('\n')
+  const fastify = new Fastify()
+  t.teardown(() => fastify.close())
+
+  fastify.register(async (instance, opts) => {
+    await fastify.register(fastifyCompress)
+    // compression
+    instance.get('/compress', async (req, reply) => {
+      return twoByteUnicodeContent
+    })
+  })
+
+  // no compression
+  fastify.get('/no-compress', async (req, reply) => {
+    return twoByteUnicodeContent
+  })
+
+  const address = await fastify.listen({ port: 0, host: '127.0.0.1' })
+
+  const [body1, body2] = await Promise.all([
+    fetch(`${address}/compress`),
+    fetch(`${address}/no-compress`)
+  ])
+
+  t.equal(body1, body2)
+  t.equal(body1, twoByteUnicodeContent)
+})

package/test/routes-compress.test.js

@@ -8,7 +8,7 @@ const compressPlugin = require('../index')
 
 test('When using routes `compress` settings :', async (t) => {
   t.test('it should compress data using the route custom provided `createDeflate` method', async (t) => {
-    t.plan(10)
+    t.plan(12)
 
     let usedCustomGlobal = false
     let usedCustom = false
@@ -44,6 +44,7 @@ test('When using routes `compress` settings :', async (t) => {
 
       const file = readFileSync('./package.json', 'utf8')
       const payload = zlib.inflateSync(response.rawPayload)
+      t.equal(response.headers.vary, 'accept-encoding')
       t.equal(response.headers['content-encoding'], 'deflate')
       t.notOk(response.headers['content-length'], 'no content length')
       t.equal(payload.toString('utf-8'), file)
@@ -64,13 +65,14 @@ test('When using routes `compress` settings :', async (t) => {
 
     const file = readFileSync('./package.json', 'utf8')
     const payload = zlib.inflateSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'deflate')
     t.notOk(response.headers['content-length'], 'no content length')
     t.equal(payload.toString('utf-8'), file)
   })
 
   t.test('it should compress data using the route custom provided `createGzip` method', async (t) => {
-    t.plan(8)
+    t.plan(10)
 
     let usedCustomGlobal = false
     let usedCustom = false
@@ -104,6 +106,7 @@ test('When using routes `compress` settings :', async (t) => {
 
       const file = readFileSync('./package.json', 'utf8')
       const payload = zlib.gunzipSync(response.rawPayload)
+      t.equal(response.headers.vary, 'accept-encoding')
       t.equal(response.headers['content-encoding'], 'gzip')
       t.equal(payload.toString('utf-8'), file)
 
@@ -123,12 +126,13 @@ test('When using routes `compress` settings :', async (t) => {
 
     const file = readFileSync('./package.json', 'utf8')
     const payload = zlib.gunzipSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'gzip')
     t.equal(payload.toString('utf-8'), file)
   })
 
   t.test('it should not compress data when `global` is `false` unless `compress` routes settings have been set up', async (t) => {
-    t.plan(9)
+    t.plan(12)
 
     let usedCustom = false
     const customZlib = { createGzip: () => (usedCustom = true) && zlib.createGzip() }
@@ -165,8 +169,8 @@ test('When using routes `compress` settings :', async (t) => {
       }
     }).then((response) => {
       t.equal(usedCustom, false)
-
-      t.equal(response.headers['content-encoding'], undefined)
+      t.notOk(response.headers.vary)
+      t.notOk(response.headers['content-encoding'])
       t.equal(response.rawPayload.toString('utf-8'), JSON.stringify({ foo: 1 }))
 
       usedCustom = false
@@ -183,6 +187,7 @@ test('When using routes `compress` settings :', async (t) => {
 
       const file = readFileSync('./package.json', 'utf8')
       const payload = zlib.gunzipSync(response.rawPayload)
+      t.equal(response.headers.vary, 'accept-encoding')
       t.equal(response.headers['content-encoding'], 'gzip')
       t.equal(payload.toString('utf-8'), file)
     })
@@ -195,12 +200,13 @@ test('When using routes `compress` settings :', async (t) => {
       }
     })
     const payload = zlib.gunzipSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'gzip')
     t.equal(payload.toString('utf-8'), JSON.stringify({ foo: 1 }))
   })
 
   t.test('it should not compress data when route `compress` option is set to `false`', async (t) => {
-    t.plan(2)
+    t.plan(3)
 
     const content = { message: 'Hello World!' }
 
@@ -220,7 +226,8 @@ test('When using routes `compress` settings :', async (t) => {
         'accept-encoding': 'gzip'
       }
     })
-    t.equal(response.headers['content-encoding'], undefined)
+    t.notOk(response.headers.vary)
+    t.notOk(response.headers['content-encoding'])
     t.equal(response.rawPayload.toString('utf-8'), JSON.stringify(content))
   })
 
@@ -244,7 +251,7 @@ test('When using routes `compress` settings :', async (t) => {
 
 test('When `compress.removeContentLengthHeader` is `false`, it should not remove `Content-Length` header :', async (t) => {
   t.test('using `reply.compress()`', async (t) => {
-    t.plan(3)
+    t.plan(4)
 
     const fastify = Fastify()
     await fastify.register(compressPlugin, { global: true })
@@ -273,13 +280,14 @@ test('When `compress.removeContentLengthHeader` is `false`, it should not remove
     })
     const file = readFileSync('./package.json', 'utf8')
     const payload = zlib.inflateSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'deflate')
     t.equal(response.headers['content-length'], payload.length.toString())
     t.equal(payload.toString('utf-8'), file)
   })
 
   t.test('using `onSend` hook', async (t) => {
-    t.plan(3)
+    t.plan(4)
 
     const fastify = Fastify()
     await fastify.register(compressPlugin, { global: true })
@@ -308,6 +316,7 @@ test('When `compress.removeContentLengthHeader` is `false`, it should not remove
     })
     const file = readFileSync('./package.json', 'utf8')
     const payload = zlib.inflateSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'deflate')
     t.equal(response.headers['content-length'], payload.length.toString())
     t.equal(payload.toString('utf-8'), file)
@@ -316,7 +325,7 @@ test('When `compress.removeContentLengthHeader` is `false`, it should not remove
 
 test('When using the old routes `{ config: compress }` option :', async (t) => {
   t.test('it should compress data using the route custom provided `createGzip` method', async (t) => {
-    t.plan(8)
+    t.plan(10)
 
     let usedCustomGlobal = false
     let usedCustom = false
@@ -354,6 +363,7 @@ test('When using the old routes `{ config: compress }` option :', async (t) => {
 
       const file = readFileSync('./package.json', 'utf8')
       const payload = zlib.gunzipSync(response.rawPayload)
+      t.equal(response.headers.vary, 'accept-encoding')
       t.equal(response.headers['content-encoding'], 'gzip')
       t.equal(payload.toString('utf-8'), file)
 
@@ -373,6 +383,7 @@ test('When using the old routes `{ config: compress }` option :', async (t) => {
 
     const file = readFileSync('./package.json', 'utf8')
     const payload = zlib.gunzipSync(response.rawPayload)
+    t.equal(response.headers.vary, 'accept-encoding')
     t.equal(response.headers['content-encoding'], 'gzip')
     t.equal(payload.toString('utf-8'), file)
   })

package/test/utils.test.js

@@ -4,7 +4,7 @@ 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')
+const { isStream, isDeflate, isGzip, intoAsyncIterator } = require('../lib/utils')
 
 test('isStream() utility should be able to detect Streams', async (t) => {
   t.plan(12)
@@ -61,3 +61,45 @@ test('isGzip() utility should be able to detect gzip compressed Buffer', async (
   t.equal(isGzip(undefined), false)
   t.equal(isGzip(''), false)
 })
+
+test('intoAsyncIterator() utility should handle different data', async (t) => {
+  t.plan(8)
+
+  const buf = Buffer.from('foo')
+  const str = 'foo'
+  const arr = [str, str]
+  const arrayBuffer = new ArrayBuffer(8)
+  const typedArray = new Int32Array(arrayBuffer)
+  const asyncIterator = (async function * () {
+    yield str
+  })()
+  const obj = {}
+
+  for await (const buffer of intoAsyncIterator(buf)) {
+    t.equal(buffer, buf)
+  }
+
+  for await (const string of intoAsyncIterator(str)) {
+    t.equal(string, str)
+  }
+
+  for await (const chunk of intoAsyncIterator(arr)) {
+    t.equal(chunk, str)
+  }
+
+  for await (const chunk of intoAsyncIterator(arrayBuffer)) {
+    t.equal(chunk.toString(), Buffer.from(arrayBuffer).toString())
+  }
+
+  for await (const chunk of intoAsyncIterator(typedArray)) {
+    t.equal(chunk.toString(), Buffer.from(typedArray).toString())
+  }
+
+  for await (const chunk of intoAsyncIterator(asyncIterator)) {
+    t.equal(chunk, str)
+  }
+
+  for await (const chunk of intoAsyncIterator(obj)) {
+    t.equal(chunk, obj)
+  }
+})

package/types/index.d.ts

@@ -2,13 +2,12 @@ import {
   FastifyPluginCallback,
   FastifyReply,
   FastifyRequest,
+  RouteOptions as FastifyRouteOptions,
   RawServerBase,
-  RawServerDefault,
-  RouteOptions as FastifyRouteOptions
-} from 'fastify'
-import { Input, InputObject } from 'into-stream'
-import { Stream } from 'stream'
-import { BrotliOptions, ZlibOptions } from 'zlib'
+  RawServerDefault
+} from 'fastify';
+import { Stream } from 'stream';
+import { BrotliOptions, ZlibOptions } from 'zlib';
 
 declare module 'fastify' {
   export interface FastifyContextConfig {
@@ -26,7 +25,7 @@ declare module 'fastify' {
   }
 
   interface FastifyReply {
-    compress(input: Stream | Input | InputObject): void;
+    compress(input: Stream | Input): void;
   }
 
   export interface RouteOptions {
@@ -61,6 +60,14 @@ type EncodingToken = 'br' | 'deflate' | 'gzip' | 'identity';
 
 type CompressibleContentTypeFunction = (contentType: string) => boolean;
 
+type Input =
+  | Buffer
+  | NodeJS.TypedArray
+  | ArrayBuffer
+  | string
+  | Iterable<Buffer | string>
+  | AsyncIterable<Buffer | string>;
+
 declare namespace fastifyCompress {
 
   export interface FastifyCompressOptions {