request.js
1
var capability = require('./capability')
2
var inherits = require('inherits')
3
var response = require('./response')
4
var stream = require('readable-stream')
5
var toArrayBuffer = require('to-arraybuffer')
6
7
var IncomingMessage = response.IncomingMessage
8
var rStates = response.readyStates
9
10
function decideMode (preferBinary, useFetch) {
11
if (capability.fetch && useFetch) {
12
return 'fetch'
13
} else if (capability.mozchunkedarraybuffer) {
14
return 'moz-chunked-arraybuffer'
15
} else if (capability.msstream) {
16
return 'ms-stream'
17
} else if (capability.arraybuffer && preferBinary) {
18
return 'arraybuffer'
19
} else if (capability.vbArray && preferBinary) {
20
return 'text:vbarray'
21
} else {
22
return 'text'
23
}
24
}
25
26
var ClientRequest = module.exports = function (opts) {
27
var self = this
28
stream.Writable.call(self)
29
30
self._opts = opts
31
self._body = []
32
self._headers = {}
33
if (opts.auth)
34
self.setHeader('Authorization', 'Basic ' + new Buffer(opts.auth).toString('base64'))
35
Object.keys(opts.headers).forEach(function (name) {
36
self.setHeader(name, opts.headers[name])
37
})
38
39
var preferBinary
40
var useFetch = true
41
if (opts.mode === 'disable-fetch' || ('requestTimeout' in opts && !capability.abortController)) {
42
// If the use of XHR should be preferred. Not typically needed.
43
useFetch = false
44
preferBinary = true
45
} else if (opts.mode === 'prefer-streaming') {
46
// If streaming is a high priority but binary compatibility and
47
// the accuracy of the 'content-type' header aren't
48
preferBinary = false
49
} else if (opts.mode === 'allow-wrong-content-type') {
50
// If streaming is more important than preserving the 'content-type' header
51
preferBinary = !capability.overrideMimeType
52
} else if (!opts.mode || opts.mode === 'default' || opts.mode === 'prefer-fast') {
53
// Use binary if text streaming may corrupt data or the content-type header, or for speed
54
preferBinary = true
55
} else {
56
throw new Error('Invalid value for opts.mode')
57
}
58
self._mode = decideMode(preferBinary, useFetch)
60
self.on('finish', function () {
61
self._onFinish()
62
})
63
}
64
65
inherits(ClientRequest, stream.Writable)
66
67
ClientRequest.prototype.setHeader = function (name, value) {
68
var self = this
69
var lowerName = name.toLowerCase()
70
// This check is not necessary, but it prevents warnings from browsers about setting unsafe
71
// headers. To be honest I'm not entirely sure hiding these warnings is a good thing, but
72
// http-browserify did it, so I will too.
73
if (unsafeHeaders.indexOf(lowerName) !== -1)
74
return
75
76
self._headers[lowerName] = {
77
name: name,
78
value: value
79
}
80
}
81
82
ClientRequest.prototype.getHeader = function (name) {
83
var header = this._headers[name.toLowerCase()]
84
if (header)
85
return header.value
86
return null
87
}
88
89
ClientRequest.prototype.removeHeader = function (name) {
90
var self = this
91
delete self._headers[name.toLowerCase()]
92
}
93
94
ClientRequest.prototype._onFinish = function () {
95
var self = this
96
97
if (self._destroyed)
98
return
99
var opts = self._opts
100
101
var headersObj = self._headers
102
var body = null
103
if (opts.method !== 'GET' && opts.method !== 'HEAD') {
104
if (capability.arraybuffer) {
105
body = toArrayBuffer(Buffer.concat(self._body))
106
} else if (capability.blobConstructor) {
107
body = new global.Blob(self._body.map(function (buffer) {
108
return toArrayBuffer(buffer)
109
}), {
110
type: (headersObj['content-type'] || {}).value || ''
111
})
112
} else {
113
// get utf8 string
114
body = Buffer.concat(self._body).toString()
115
}
116
}
117
118
// create flattened list of headers
119
var headersList = []
120
Object.keys(headersObj).forEach(function (keyName) {
121
var name = headersObj[keyName].name
122
var value = headersObj[keyName].value
123
if (Array.isArray(value)) {
124
value.forEach(function (v) {
125
headersList.push([name, v])
126
})
127
} else {
128
headersList.push([name, value])
129
}
130
})
132
if (self._mode === 'fetch') {
133
var signal = null
134
var fetchTimer = null
135
if (capability.abortController) {
136
var controller = new AbortController()
137
signal = controller.signal
138
self._fetchAbortController = controller
139
140
if ('requestTimeout' in opts && opts.requestTimeout !== 0) {
141
fetchTimer = global.setTimeout(function () {
142
self.emit('requestTimeout')
143
if (self._fetchAbortController)
144
self._fetchAbortController.abort()
145
}, opts.requestTimeout)
146
}
147
}
148
149
global.fetch(self._opts.url, {
150
method: self._opts.method,
151
headers: headersList,
152
body: body || undefined,
153
mode: 'cors',
154
credentials: opts.withCredentials ? 'include' : 'same-origin',
155
signal: signal
156
}).then(function (response) {
157
global.clearTimeout(fetchTimer)
158
self._fetchResponse = response
159
self._connect()
160
}, function (reason) {
161
global.clearTimeout(fetchTimer)
162
self.emit('error', reason)
163
})
164
} else {
165
var xhr = self._xhr = new global.XMLHttpRequest()
166
try {
167
xhr.open(self._opts.method, self._opts.url, true)
168
} catch (err) {
169
process.nextTick(function () {
170
self.emit('error', err)
171
})
172
return
173
}
174
175
// Can't set responseType on really old browsers
176
if ('responseType' in xhr)
177
xhr.responseType = self._mode.split(':')[0]
178
179
if ('withCredentials' in xhr)
180
xhr.withCredentials = !!opts.withCredentials
181
182
if (self._mode === 'text' && 'overrideMimeType' in xhr)
183
xhr.overrideMimeType('text/plain; charset=x-user-defined')
184
185
if ('requestTimeout' in opts) {
186
xhr.timeout = opts.requestTimeout
187
xhr.ontimeout = function () {
188
self.emit('requestTimeout')
189
}
190
}
191
192
headersList.forEach(function (header) {
193
xhr.setRequestHeader(header[0], header[1])
194
})
195
196
self._response = null
197
xhr.onreadystatechange = function () {
198
switch (xhr.readyState) {
199
case rStates.LOADING:
200
case rStates.DONE:
201
self._onXHRProgress()
202
break
203
}
204
}
205
// Necessary for streaming in Firefox, since xhr.response is ONLY defined
206
// in onprogress, not in onreadystatechange with xhr.readyState = 3
207
if (self._mode === 'moz-chunked-arraybuffer') {
208
xhr.onprogress = function () {
209
self._onXHRProgress()
210
}
211
}
213
xhr.onerror = function () {
214
if (self._destroyed)
215
return
216
self.emit('error', new Error('XHR error'))
217
}
218
219
try {
220
xhr.send(body)
221
} catch (err) {
222
process.nextTick(function () {
223
self.emit('error', err)
224
})
225
return
226
}
227
}
228
}
229
231
* Checks if xhr.status is readable and non-zero, indicating no error.
232
* Even though the spec says it should be available in readyState 3,
233
* accessing it throws an exception in IE8
234
*/
235
function statusValid (xhr) {
236
try {
237
var status = xhr.status
238
return (status !== null && status !== 0)
239
} catch (e) {
240
return false
241
}
242
}
243
244
ClientRequest.prototype._onXHRProgress = function () {
245
var self = this
246
247
if (!statusValid(self._xhr) || self._destroyed)
248
return
249
250
if (!self._response)
251
self._connect()
252
253
self._response._onXHRProgress()
254
}
255
256
ClientRequest.prototype._connect = function () {
257
var self = this
258
259
if (self._destroyed)
260
return
261
262
self._response = new IncomingMessage(self._xhr, self._fetchResponse, self._mode)
263
self._response.on('error', function(err) {
264
self.emit('error', err)
265
})
266
267
self.emit('response', self._response)
268
}
269
270
ClientRequest.prototype._write = function (chunk, encoding, cb) {
271
var self = this
272
273
self._body.push(chunk)
274
cb()
275
}
276
277
ClientRequest.prototype.abort = ClientRequest.prototype.destroy = function () {
278
var self = this
279
self._destroyed = true
280
if (self._response)
281
self._response._destroyed = true
282
if (self._xhr)
283
self._xhr.abort()
284
else if (self._fetchAbortController)
285
self._fetchAbortController.abort()
286
}
287
288
ClientRequest.prototype.end = function (data, encoding, cb) {
289
var self = this
290
if (typeof data === 'function') {
291
cb = data
292
data = undefined
293
}
294
295
stream.Writable.prototype.end.call(self, data, encoding, cb)
296
}
297
298
ClientRequest.prototype.flushHeaders = function () {}
299
ClientRequest.prototype.setTimeout = function () {}
300
ClientRequest.prototype.setNoDelay = function () {}
301
ClientRequest.prototype.setSocketKeepAlive = function () {}
302
303
// Taken from http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader%28%29-method
304
var unsafeHeaders = [
305
'accept-charset',
306
'accept-encoding',
307
'access-control-request-headers',
308
'access-control-request-method',
309
'connection',
310
'content-length',
311
'cookie',
312
'cookie2',
313
'date',
314
'dnt',
315
'expect',
316
'host',
317
'keep-alive',
318
'origin',
319
'referer',
320
'te',
321
'trailer',
322
'transfer-encoding',
323
'upgrade',
324
'user-agent',
325
'via'