feat(gzip): add opts.gzip convenience opt

Author: zkat

README.md

@@ -214,6 +214,15 @@ packages.
 See also [`opts.retry`](#opts-retry) to provide all retry options as a single
 object.
 
+##### <a name="opts-gzip"></a> `opts.gzip`
+
+* Type: Boolean
+* Default: false
+
+If true, `npm-registry-fetch` will set the `Content-Encoding` header to `gzip`
+and use `zlib.gzip()` or `zlib.createGzip()` to gzip-encode
+[`opts.body`](#opts-body).
+
 ##### <a name="opts-headers"></a> `opts.headers`
 
 * Type: Object

config.js

@@ -18,6 +18,7 @@ module.exports = figgyPudding({
   'fetch-retry-maxtimeout': {},
   'fetch-retry-mintimeout': {},
   'gid': {},
+  'gzip': {},
   'headers': {},
   'https-proxy': {},
   'integrity': {},
@@ -56,7 +57,7 @@ module.exports = figgyPudding({
   'prefer-online': {},
   'projectScope': {},
   'project-scope': 'projectScope',
-  'Promise': {},
+  'Promise': {default: () => Promise},
   'proxy': {},
   'query': {},
   'refer': {},

index.js

@@ -9,6 +9,7 @@ const fetch = require('make-fetch-happen')
 const npa = require('npm-package-arg')
 const qs = require('querystring')
 const url = require('url')
+const zlib = require('zlib')
 
 module.exports = regFetch
 function regFetch (uri, opts) {
@@ -38,6 +39,18 @@ function regFetch (uri, opts) {
   } else if (body && !headers['content-type']) {
     headers['content-type'] = 'application/octet-stream'
   }
+  if (opts.gzip) {
+    headers['content-encoding'] = 'gzip'
+    if (bodyIsStream) {
+      const gz = zlib.createGzip()
+      body.on('error', err => gz.emit('error', err))
+      body = body.pipe(gz)
+    } else {
+      body = new opts.Promise((resolve, reject) => {
+        zlib.gzip(body, (err, gz) => err ? reject(err) : resolve(gz))
+      })
+    }
+  }
   if (opts.get('query')) {
     let q = opts.get('query')
     if (typeof q === 'string') {
@@ -51,7 +64,7 @@ function regFetch (uri, opts) {
     )
     uri = url.format(parsed)
   }
-  return fetch(uri, {
+  return opts.Promise.resolve(body).then(body => fetch(uri, {
     agent: opts.get('agent'),
     algorithms: opts.get('algorithms'),
     body,
@@ -82,7 +95,7 @@ function regFetch (uri, opts) {
     gid: opts.get('gid')
   }).then(res => checkResponse(
     opts.get('method') || 'GET', res, registry, startTime, opts
-  ))
+  )))
 }
 
 module.exports.json = fetchJSON

test/index.js

@@ -8,6 +8,7 @@ const silentLog = require('../silentlog.js')
 const ssri = require('ssri')
 const test = require('tap').test
 const tnock = require('./util/tnock.js')
+const zlib = require('zlib')
 
 const fetch = require('../index.js')
 
@@ -117,6 +118,98 @@ test('stream body param', t => {
     .then(json => t.deepEqual(json, {hello: 'world'}))
 })
 
+test('JSON body param', t => {
+  tnock(t, OPTS.registry)
+    .matchHeader('content-type', ctype => {
+      t.equal(ctype[0], 'application/json', 'content-type automatically set')
+      return ctype[0] === 'application/json'
+    })
+    .matchHeader('content-encoding', enc => {
+      t.equal(enc[0], 'gzip', 'content-encoding automatically set')
+      return enc[0] === 'gzip'
+    })
+    .post('/hello')
+    // NOTE: can't really test the body itself here because nock freaks out.
+    .reply(200)
+  const opts = Object.assign({
+    method: 'POST',
+    body: {hello: 'world'},
+    gzip: true
+  }, OPTS)
+  return fetch('/hello', opts)
+    .then(res => {
+      t.equal(res.status, 200, 'request succeeded')
+    })
+})
+
+test('gzip + buffer body param', t => {
+  tnock(t, OPTS.registry)
+    .matchHeader('content-type', ctype => {
+      t.equal(ctype[0], 'application/octet-stream', 'content-type automatically set')
+      return ctype[0] === 'application/octet-stream'
+    })
+    .matchHeader('content-encoding', enc => {
+      t.equal(enc[0], 'gzip', 'content-encoding automatically set')
+      return enc[0] === 'gzip'
+    })
+    .post('/hello')
+    .reply(200, (uri, reqBody) => {
+      reqBody = zlib.gunzipSync(Buffer.from(reqBody, 'hex'))
+      t.deepEqual(
+        Buffer.from(reqBody, 'utf8').toString('utf8'),
+        'hello',
+        'got the JSON version of the body'
+      )
+      return reqBody
+    })
+  const opts = Object.assign({
+    method: 'POST',
+    body: Buffer.from('hello', 'utf8'),
+    gzip: true
+  }, OPTS)
+  return fetch('/hello', opts)
+    .then(res => {
+      t.equal(res.status, 200)
+      return res.buffer()
+    })
+    .then(buf =>
+      t.deepEqual(buf, Buffer.from('hello', 'utf8'), 'got response')
+    )
+})
+
+test('gzip + stream body param', t => {
+  tnock(t, OPTS.registry)
+    .matchHeader('content-type', ctype => {
+      t.equal(ctype[0], 'application/octet-stream', 'content-type automatically set')
+      return ctype[0] === 'application/octet-stream'
+    })
+    .matchHeader('content-encoding', enc => {
+      t.equal(enc[0], 'gzip', 'content-encoding automatically set')
+      return enc[0] === 'gzip'
+    })
+    .post('/hello')
+    .reply(200, (uri, reqBody) => {
+      reqBody = zlib.gunzipSync(Buffer.from(reqBody, 'hex'))
+      t.deepEqual(JSON.parse(reqBody.toString('utf8')), {
+        hello: 'world'
+      }, 'got the stringified version of the body')
+      return reqBody
+    })
+  const stream = new PassThrough()
+  setImmediate(() => stream.end(JSON.stringify({hello: 'world'})))
+  const opts = Object.assign({
+    method: 'POST',
+    body: stream,
+    gzip: true
+  }, OPTS)
+  return fetch('/hello', opts)
+    .then(res => {
+      t.equal(res.status, 200)
+      return res.json()
+    })
+    .then(json => t.deepEqual(json, {hello: 'world'}))
+})
+
 test('query strings', t => {
   tnock(t, OPTS.registry)
     .get('/hello?hi=there&who=wor%20ld')