koa-compress 1.0.8 → 3.1.0

package/HISTORY.md

@@ -1,9 +1,30 @@
 
+3.1.0 / 2020-04-15
+
+ * support no-transform @Pawda
+
+3.0.0 / 2018-04-14
+==================
+
+ * republish 2.1.0 as it switches to async functions
+
+2.1.0 / 2018-04-13 (unpublished)
+==================
+
+ * do not compress if the response is not writable
+ * switch testing frameworks to jest
+ * implement linting
+
+1.0.8 / 2014-09-14
+==================
+
+ * bump compressible
+
 1.0.7 / 2014-05-13
 ==================
 
  * bump bytes
- 
+
 1.0.6 / 2014-04-24
 ==================
 

package/README.md

@@ -1,4 +1,7 @@
-# Koa Compress [![Build Status](https://travis-ci.org/koajs/compress.png)](https://travis-ci.org/koajs/compress)
+# Koa Compress
+
+[![Node.js CI](https://github.com/koajs/compress/workflows/Node.js%20CI/badge.svg?branch=master)](https://github.com/koajs/compress/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster)
+[![codecov](https://codecov.io/gh/koajs/compress/branch/master/graph/badge.svg)](https://codecov.io/gh/koajs/compress)
 
 Compress middleware for Koa
 
@@ -6,9 +9,9 @@ Compress middleware for Koa
 
 ```js
 var compress = require('koa-compress')
-var koa = require('koa')
+var Koa = require('koa')
 
-var app = koa()
+var app = new Koa()
 app.use(compress({
   filter: function (content_type) {
   	return /text/i.test(content_type)
@@ -25,7 +28,7 @@ The options are passed to `zlib`: http://nodejs.org/api/zlib.html#zlib_options
 ### filter
 
 An optional function that checks the response content type to decide whether to compress.
-By default, it uses [compressible](https://github.com/expressjs/compressible).
+By default, it uses [compressible](https://github.com/jshttp/compressible).
 
 ### threshold
 
@@ -34,15 +37,13 @@ Default `1024` bytes or `1kb`.
 
 ## Manually turning compression on and off
 
-You can always enable compression by setting `this.compress = true`.
-You can always disable compression by setting `this.compress = false`.
+You can always enable compression by setting `ctx.compress = true`.
+You can always disable compression by setting `ctx.compress = false`.
 This bypasses the filter check.
 
 ```js
-app.use(function (next) {
-  return function *() {
-    this.compress = true
-    this.body = fs.createReadStream(file)
-  }
+app.use((ctx, next) => {
+  ctx.compress = true
+  ctx.body = fs.createReadStream(file)
 })
 ```

package/index.js

@@ -1,23 +1,30 @@
+'use strict'
+
 /**
  * Module dependencies.
  */
 
-var compressible = require('compressible')
-var isJSON = require('koa-is-json')
-var status = require('statuses')
-var Stream = require('stream')
-var bytes = require('bytes')
-var zlib = require('zlib')
+const compressible = require('compressible')
+const isJSON = require('koa-is-json')
+const status = require('statuses')
+const Stream = require('stream')
+const bytes = require('bytes')
+const zlib = require('zlib')
 
 /**
  * Encoding methods supported.
  */
 
-var encodingMethods = {
+const encodingMethods = {
   gzip: zlib.createGzip,
   deflate: zlib.createDeflate
 }
 
+/**
+* Regex to match no-transform directive in a cache-control header
+*/
+const NO_TRANSFORM_REGEX = /(?:^|,)\s*?no-transform\s*?(?:,|$)/
+
 /**
  * Compress middleware.
  *
@@ -26,47 +33,46 @@ var encodingMethods = {
  * @api public
  */
 
-module.exports = function (options) {
-  options = options || {}
+module.exports = (options = {}) => {
+  let { filter = compressible, threshold = 1024 } = options
+  if (typeof threshold === 'string') threshold = bytes(threshold)
 
-  var filter = options.filter || compressible
+  return async (ctx, next) => {
+    ctx.vary('Accept-Encoding')
 
-  var threshold = !options.threshold ? 1024
-    : typeof options.threshold === 'number' ? options.threshold
-    : typeof options.threshold === 'string' ? bytes(options.threshold)
-    : 1024
+    await next()
 
-  return function* compress(next) {
-    this.vary('Accept-Encoding')
-
-    yield* next
-
-    var body = this.body
+    let { body } = ctx
     if (!body) return
-    if (this.compress === false) return
-    if (this.request.method === 'HEAD') return
-    if (status.empty[this.response.status]) return
-    if (this.response.get('Content-Encoding')) return
+    if (ctx.res.headersSent || !ctx.writable) return
+    if (ctx.compress === false) return
+    if (ctx.request.method === 'HEAD') return
+    if (status.empty[ctx.response.status]) return
+    if (ctx.response.get('Content-Encoding')) return
 
     // forced compression or implied
-    if (!(this.compress === true || filter(this.response.type))) return
+    if (!(ctx.compress === true || filter(ctx.response.type))) return
+
+    // Don't compress for Cache-Control: no-transform
+    // https://tools.ietf.org/html/rfc7234#section-5.2.1.6
+    const cacheControl = ctx.response.get('Cache-Control')
+    if (cacheControl && NO_TRANSFORM_REGEX.test(cacheControl)) return
 
     // identity
-    var encoding = this.acceptsEncodings('gzip', 'deflate', 'identity')
-    if (!encoding) this.throw(406, 'supported encodings: gzip, deflate, identity')
+    const encoding = ctx.acceptsEncodings('gzip', 'deflate', 'identity')
+    if (!encoding) ctx.throw(406, 'supported encodings: gzip, deflate, identity')
     if (encoding === 'identity') return
 
     // json
-    if (isJSON(body)) body = this.body = JSON.stringify(body)
+    if (isJSON(body)) body = ctx.body = JSON.stringify(body)
 
     // threshold
-    if (threshold && this.response.length < threshold) return
+    if (threshold && ctx.response.length < threshold) return
 
-    this.set('Content-Encoding', encoding)
-    this.res.removeHeader('Content-Length')
+    ctx.set('Content-Encoding', encoding)
+    ctx.res.removeHeader('Content-Length')
 
-    var stream =
-    this.body = encodingMethods[encoding](options)
+    const stream = ctx.body = encodingMethods[encoding](options)
 
     if (body instanceof Stream) {
       body.pipe(stream)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koa-compress",
   "description": "Compress middleware for koa",
-  "version": "1.0.8",
+  "version": "3.1.0",
   "author": {
     "name": "Jonathan Ong",
     "email": "me@jongleberry.com",
@@ -11,26 +11,35 @@
   "license": "MIT",
   "repository": "koajs/compress",
   "dependencies": {
-    "statuses": "1",
-    "koa-is-json": "1",
-    "compressible": "2",
-    "bytes": "1"
+    "bytes": "^3.0.0",
+    "compressible": "^2.0.0",
+    "koa-is-json": "^1.0.0",
+    "statuses": "^1.0.0"
   },
   "devDependencies": {
-    "istanbul-harmony": "0",
-    "koa": "0",
-    "mocha": "1",
-    "should": "3",
-    "supertest": "0"
+    "eslint": "^6.0.0",
+    "eslint-config-standard": "^14.1.1",
+    "eslint-plugin-import": "^2.9.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"
   },
   "scripts": {
-    "test": "NODE_ENV=test mocha --harmony-generators --require should --reporter spec",
-    "test-cov": "NODE_ENV=test node --harmony-generators ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- --require should",
-    "test-travis": "NODE_ENV=test node --harmony-generators ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly -- --require should"
+    "eslint": "eslint --ignore-path .gitignore .",
+    "test": "jest --forceExit"
   },
   "files": [
     "index.js",
     "LICENSE",
     "HISTORY.md"
-  ]
+  ],
+  "jest": {
+    "testEnvironment": "node"
+  },
+  "engines": {
+    "node": ">= 8.0.0"
+  }
 }