fix(request): request headers array (nodejs#1807)

* fix(request): request headers arry

* Add more tests specific to request

* Allow all primitive types

* Object and not array

* Check values in array

Author: jd-carroll

lib/core/request.js

@@ -271,8 +271,17 @@ class Request {
   }
 }
 
+function processHeaderValue (key, val) {
+  if (val && (typeof val === 'object' && !Array.isArray(val))) {
+    throw new InvalidArgumentError(`invalid ${key} header`)
+  } else if (headerCharRegex.exec(val) !== null) {
+    throw new InvalidArgumentError(`invalid ${key} header`)
+  }
+  return `${key}: ${val}\r\n`
+}
+
 function processHeader (request, key, val) {
-  if (val && typeof val === 'object') {
+  if (val && (typeof val === 'object' && !Array.isArray(val))) {
     throw new InvalidArgumentError(`invalid ${key} header`)
   } else if (val === undefined) {
     return
@@ -329,10 +338,14 @@ function processHeader (request, key, val) {
     throw new NotSupportedError('expect header not supported')
   } else if (tokenRegExp.exec(key) === null) {
     throw new InvalidArgumentError('invalid header key')
-  } else if (headerCharRegex.exec(val) !== null) {
-    throw new InvalidArgumentError(`invalid ${key} header`)
   } else {
-    request.headers += `${key}: ${val}\r\n`
+    if (Array.isArray(val)) {
+      for (let i = 0; i < val.length; i++) {
+        request.headers += processHeaderValue(key, val[i])
+      }
+    } else {
+      request.headers += processHeaderValue(key, val)
+    }
   }
 }
 

test/headers-as-array.js

@@ -25,6 +25,69 @@ test('handle headers as array', (t) => {
   })
 })
 
+test('handle multi-valued headers as array', (t) => {
+  t.plan(1)
+  const headers = ['a', '1', 'b', '2', 'c', '3', 'd', '4', 'd', '5']
+
+  const server = createServer((req, res) => {
+    t.match(req.headers, { a: '1', b: '2', c: '3', d: '4, 5' })
+    res.end()
+  })
+  t.teardown(server.close.bind(server))
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`)
+    t.teardown(client.destroy.bind(client))
+
+    client.request({
+      path: '/',
+      method: 'GET',
+      headers
+    }, () => {})
+  })
+})
+
+test('handle headers with array', (t) => {
+  t.plan(1)
+  const headers = { a: '1', b: '2', c: '3', d: ['4'] }
+
+  const server = createServer((req, res) => {
+    t.match(req.headers, { a: '1', b: '2', c: '3', d: '4' })
+    res.end()
+  })
+  t.teardown(server.close.bind(server))
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`)
+    t.teardown(client.destroy.bind(client))
+
+    client.request({
+      path: '/',
+      method: 'GET',
+      headers
+    }, () => {})
+  })
+})
+
+test('handle multi-valued headers', (t) => {
+  t.plan(1)
+  const headers = { a: '1', b: '2', c: '3', d: ['4', '5'] }
+
+  const server = createServer((req, res) => {
+    t.match(req.headers, { a: '1', b: '2', c: '3', d: '4, 5' })
+    res.end()
+  })
+  t.teardown(server.close.bind(server))
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`)
+    t.teardown(client.destroy.bind(client))
+
+    client.request({
+      path: '/',
+      method: 'GET',
+      headers
+    }, () => {})
+  })
+})
+
 test('fail if headers array is odd', (t) => {
   t.plan(2)
   const headers = ['a', '1', 'b', '2', 'c', '3', 'd']

test/node-fetch/main.js

@@ -185,6 +185,30 @@ describe('node-fetch', () => {
     })
   })
 
+  it('should send request with custom headers array', () => {
+    const url = `${base}inspect`
+    const options = {
+      headers: { 'x-custom-header': ['abc'] }
+    }
+    return fetch(url, options).then(res => {
+      return res.json()
+    }).then(res => {
+      expect(res.headers['x-custom-header']).to.equal('abc')
+    })
+  })
+
+  it('should send request with multi-valued headers', () => {
+    const url = `${base}inspect`
+    const options = {
+      headers: { 'x-custom-header': ['abc', '123'] }
+    }
+    return fetch(url, options).then(res => {
+      return res.json()
+    }).then(res => {
+      expect(res.headers['x-custom-header']).to.equal('abc,123')
+    })
+  })
+
   it('should accept headers instance', () => {
     const url = `${base}inspect`
     const options = {