Merge branch 'v2' of github.com:expressjs/compression into fernandolguevara/master

Author: bjohansebas

README.md

@@ -196,7 +196,8 @@ function shouldCompress (req, res) {
 ### res.flush
 
 This module adds a `res.flush()` method to force the partially-compressed
-response to be flushed to the client.
+response to be flushed to the client. This function accepts a callback which gets
+invoked when the response has been flushed to the client
 
 ## Examples
 

index.js

@@ -14,10 +14,12 @@
  * @private
  */
 
+var { finished } = require('node:stream')
 var Negotiator = require('negotiator')
 var bytes = require('bytes')
 var compressible = require('compressible')
 var debug = require('debug')('compression')
+const isFinished = require('on-finished').isFinished
 var onHeaders = require('on-headers')
 var vary = require('vary')
 var zlib = require('zlib')
@@ -81,9 +83,9 @@ function compression (options) {
     var _write = res.write
 
     // flush
-    res.flush = function flush () {
+    res.flush = function flush (cb) {
       if (stream) {
-        stream.flush()
+        stream.flush(cb)
       }
     }
 
@@ -276,7 +278,12 @@ function compression (options) {
       })
 
       stream.on('data', function onStreamData (chunk) {
+        if (isFinished(res)) {
+          debug('response finished')
+          return
+        }
         if (_write.call(res, chunk) === false) {
+          debug('pausing compression stream')
           stream.pause()
         }
       })
@@ -288,6 +295,15 @@ function compression (options) {
       _on.call(res, 'drain', function onResponseDrain () {
         stream.resume()
       })
+
+      // In case the stream is paused when the response finishes (e.g.  because
+      // the client cuts the connection), its `drain` event may not get emitted.
+      // The following handler is here to ensure that the stream gets resumed so
+      // it ends up emitting its `end` event and calling the original
+      // `res.end()`.
+      finished(res, function onResponseFinished () {
+        stream.resume()
+      })
     })
 
     next()

package.json

@@ -14,6 +14,7 @@
     "compressible": "^2.0.18",
     "debug": "^2.6.9",
     "negotiator": "^0.6.4",
+    "on-finished": "^2.4.1",
     "on-headers": "^1.0.2",
     "vary": "^1.1.2"
   },
@@ -26,7 +27,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
     "eslint-plugin-standard": "^4.1.0",
-    "mocha": "^9.2.2",
+    "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "supertest": "^6.2.3"
   },
@@ -40,7 +41,7 @@
   },
   "scripts": {
     "lint": "eslint .",
-    "test": "mocha --check-leaks --reporter spec",
+    "test": "mocha --check-leaks --exit --reporter spec",
     "test-ci": "nyc --reporter=lcov --reporter=text npm test",
     "test-cov": "nyc --reporter=html --reporter=text npm test"
   }