koa-compress 4.0.0 → 5.1.0

package/HISTORY.md

@@ -1,4 +1,9 @@
 
+4.0.1 / 2020-04-29
+==================
+
+ * fix issue with state being preserved between requests
+
 4.0.0 / 2020-04-27
 ==================
 
@@ -8,6 +13,7 @@
  * added compression disabling option: set `options.br = false`
 
 3.1.0 / 2020-04-15
+==================
 
  * support no-transform @Pawda
 

package/README.md

@@ -18,15 +18,20 @@ app.use(compress({
   },
   threshold: 2048,
   gzip: {
-    flush: require('zlib').Z_SYNC_FLUSH
+    flush: require('zlib').constants.Z_SYNC_FLUSH
   },
   deflate: {
-    flush: require('zlib').Z_SYNC_FLUSH,
+    flush: require('zlib').constants.Z_SYNC_FLUSH,
   },
   br: false // disable brotli
 }))
 ```
 
+## Maintainers
+
+- Lead: @jonathanong [@jongleberry](https://twitter.com/jongleberry)
+- Team: @koajs/compress
+
 ## Options
 
 ### filter\<Function\>
@@ -51,9 +56,20 @@ The current encodings are, in order of preference: `br`, `gzip`, `deflate`.
 Setting `options[encoding] = {}` will pass those options to the encoding function.
 Setting `options[encoding] = false` will disable that encoding.
 
-### options.br
+#### options<span></span>.br
+
+[Brotli compression](https://en.wikipedia.org/wiki/Brotli) is supported in node v11.7.0+, which includes it natively.
+As of v5.1.0, the default quality level is 4 for performance reasons.
+
+### options.defaultEncoding\<String\>
+
+An optional string, which specifies what encoders to use for requests without
+[Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding).
+Default `identity`.
 
-[Brotli compression](https://en.wikipedia.org/wiki/Brotli) is supported in node v11.7.0+, which includes it natively. 
+The standard dictates to treat such requests as `*` meaning that all compressions are permissible,
+yet it causes very practical problems when debugging servers with manual tools like `curl`, `wget`, and so on.
+If you want to enable the standard behavior, just set `defaultEncoding` to `*`.
 
 ## Manually turning compression on and off
 

package/lib/encodings.js

@@ -21,6 +21,14 @@ Encodings.encodingMethods = {
   br: zlib.createBrotliCompress
 }
 
+Encodings.encodingMethodDefaultOptions = {
+  gzip: {},
+  deflate: {},
+  br: {
+    [zlib.constants.BROTLI_PARAM_QUALITY]: 4
+  }
+}
+
 // how we treat `Accept-Encoding: *`
 Encodings.wildcardAcceptEncoding = ['gzip', 'deflate']
 // our preferred encodings

package/lib/index.js

@@ -26,16 +26,27 @@ const NO_TRANSFORM_REGEX = /(?:^|,)\s*?no-transform\s*?(?:,|$)/
  */
 
 module.exports = (options = {}) => {
-  let { filter = compressible, threshold = 1024 } = options
+  let { filter = compressible, threshold = 1024, defaultEncoding = 'identity' } = options
   if (typeof threshold === 'string') threshold = bytes(threshold)
 
   // `options.br = false` would remove it as a preferred encoding
   const preferredEncodings = Encodings.preferredEncodings.filter((encoding) => options[encoding] !== false && options[encoding] !== null)
-  const encodings = new Encodings({
-    preferredEncodings
+  const encodingOptions = {}
+  preferredEncodings.forEach((encoding) => {
+    encodingOptions[encoding] = {
+      ...Encodings.encodingMethodDefaultOptions[encoding],
+      ...(options[encoding] || {})
+    }
+  })
+
+  Object.assign(compressMiddleware, {
+    preferredEncodings,
+    encodingOptions
   })
 
-  return async (ctx, next) => {
+  return compressMiddleware
+
+  async function compressMiddleware (ctx, next) {
     ctx.vary('Accept-Encoding')
 
     await next()
@@ -61,7 +72,10 @@ module.exports = (options = {}) => {
     if (threshold && ctx.response.length < threshold) return
 
     // get the preferred content encoding
-    encodings.parseAcceptEncoding(ctx.request.headers['accept-encoding'] || undefined)
+    const encodings = new Encodings({
+      preferredEncodings
+    })
+    encodings.parseAcceptEncoding(ctx.request.headers['accept-encoding'] || defaultEncoding)
     const encoding = encodings.getPreferredContentEncoding()
 
     // identity === no compression
@@ -76,7 +90,7 @@ module.exports = (options = {}) => {
     ctx.res.removeHeader('Content-Length')
 
     const compress = Encodings.encodingMethods[encoding]
-    const stream = ctx.body = compress(options[encoding])
+    const stream = ctx.body = compress(encodingOptions[encoding])
 
     if (body instanceof Stream) {
       body.pipe(stream)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koa-compress",
   "description": "Compress middleware for koa",
-  "version": "4.0.0",
+  "version": "5.1.0",
   "author": {
     "name": "Jonathan Ong",
     "email": "me@jongleberry.com",
@@ -13,24 +13,24 @@
   "dependencies": {
     "bytes": "^3.0.0",
     "compressible": "^2.0.0",
-    "http-errors": "^1.7.3",
+    "http-errors": "^1.8.0",
     "koa-is-json": "^1.0.0",
-    "statuses": "^2.0.0"
+    "statuses": "^2.0.1"
   },
   "devDependencies": {
-    "eslint": "^6.0.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.9.0",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.24.0",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^4.0.0",
-    "eslint-plugin-standard": "^4.0.1",
-    "jest": "^25.3.0",
-    "koa": "^2.0.1",
-    "supertest": "^4.0.2"
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "jest": "^27.0.6",
+    "koa": "^2.13.1",
+    "supertest": "^6.1.6"
   },
   "scripts": {
     "eslint": "eslint --ignore-path .gitignore .",
-    "test": "jest --forceExit"
+    "test": "jest"
   },
   "files": [
     "lib",