Support Brotli decompression

Summary

This library doesn’t seem to support a br content type

Expected Behavior

When receiving a Brotli-compressed response, the library should be able to decompress it exactly the same way as a gzip response

Current Behavior

It doesn’t make any attempt to decode it.

Context

This is causing problems in higher level apps, i.e. Postman: postmanlabs/postman-app-support#4091

[flyweight]

For those of you that are waiting on this, here is a temporary workaround (with fallback to gzip where brotli isn’t available from the server):

Required Modules

https://www.npmjs.com/package/iltorb https://www.npmjs.com/package/patch-package

Diff for patch-package

$ cat patches/request+2.87.0.patch 
patch-package
--- a/node_modules/request/request.js
+++ b/node_modules/request/request.js
@@ -379,8 +379,12 @@ Request.prototype.init = function (options) {
     )
   }
 
+  if (typeof self.brotliDecompress !== 'function') {
+    delete self.brotliDecompress
+  }
+
   if (self.gzip && !self.hasHeader('accept-encoding')) {
-    self.setHeader('accept-encoding', 'gzip, deflate')
+    self.setHeader('accept-encoding', `${self.brotliDecompress ? 'br, ' : ''}gzip, deflate`)
   }
 
   if (self.uri.auth && !self.hasHeader('authorization')) {
@@ -1027,7 +1031,10 @@ Request.prototype.onRequestResponse = function (response) {
         finishFlush: zlib.Z_SYNC_FLUSH
       }
 
-      if (contentEncoding === 'gzip') {
+      if (contentEncoding === 'br') {
+        responseContent = self.brotliDecompress()
+        response.pipe(responseContent)
+      } else if (contentEncoding === 'gzip') {
         responseContent = zlib.createGunzip(zlibOptions)
         response.pipe(responseContent)
       } else if (contentEncoding === 'deflate') {

Example Usage

const { decompressStream } = require('iltorb')
const request = require('request')

request({
  uri: 'https://www.google.com',
  gzip: true,
  brotliDecompress: decompressStream,
  headers: {
    'user-agent': 'curl/7.47.0'
  }
})

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.