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.blobConstructor) {
105
body = new global.Blob(self._body.map(function (buffer) {
106
return toArrayBuffer(buffer)
107
}), {
108
type: (headersObj['content-type'] || {}).value || ''
109
})
110
} else {
111
// get utf8 string
112
body = Buffer.concat(self._body).toString()
113
}
114
}
115
116
// create flattened list of headers
117
var headersList = []
118
Object.keys(headersObj).forEach(function (keyName) {
119
var name = headersObj[keyName].name
120
var value = headersObj[keyName].value
121
if (Array.isArray(value)) {
122
value.forEach(function (v) {
123
headersList.push([name, v])
124
})
125
} else {
126
headersList.push([name, value])
127
}
128
})
130
if (self._mode === 'fetch') {
131
var signal = null
132
if (capability.abortController) {
133
var controller = new AbortController()
134
signal = controller.signal
135
self._fetchAbortController = controller
136
137
if ('requestTimeout' in opts && opts.requestTimeout !== 0) {
138
global.setTimeout(function () {
139
self.emit('requestTimeout')
140
if (self._fetchAbortController)
141
self._fetchAbortController.abort()
142
}, opts.requestTimeout)
143
}
144
}
145
146
global.fetch(self._opts.url, {
147
method: self._opts.method,
148
headers: headersList,
149
body: body || undefined,
150
mode: 'cors',
151
credentials: opts.withCredentials ? 'include' : 'same-origin',
152
signal: signal
153
}).then(function (response) {
154
self._fetchResponse = response
155
self._connect()
156
}, function (reason) {
157
self.emit('error', reason)
158
})
159
} else {
160
var xhr = self._xhr = new global.XMLHttpRequest()
161
try {
162
xhr.open(self._opts.method, self._opts.url, true)
163
} catch (err) {
164
process.nextTick(function () {
165
self.emit('error', err)
166
})
167
return
168
}
169
170
// Can't set responseType on really old browsers
171
if ('responseType' in xhr)
172
xhr.responseType = self._mode.split(':')[0]
173
174
if ('withCredentials' in xhr)
175
xhr.withCredentials = !!opts.withCredentials
176
177
if (self._mode === 'text' && 'overrideMimeType' in xhr)
178
xhr.overrideMimeType('text/plain; charset=x-user-defined')
179
180
if ('requestTimeout' in opts) {
181
xhr.timeout = opts.requestTimeout
182
xhr.ontimeout = function () {
183
self.emit('requestTimeout')
184
}
185
}
186
187
headersList.forEach(function (header) {
188
xhr.setRequestHeader(header[0], header[1])
189
})
190
191
self._response = null
192
xhr.onreadystatechange = function () {
193
switch (xhr.readyState) {
194
case rStates.LOADING:
195
case rStates.DONE:
196
self._onXHRProgress()
197
break
198
}
199
}
200
// Necessary for streaming in Firefox, since xhr.response is ONLY defined
201
// in onprogress, not in onreadystatechange with xhr.readyState = 3
202
if (self._mode === 'moz-chunked-arraybuffer') {
203
xhr.onprogress = function () {
204
self._onXHRProgress()
205
}
206
}
208
xhr.onerror = function () {
209
if (self._destroyed)
210
return
211
self.emit('error', new Error('XHR error'))
212
}
213
214
try {
215
xhr.send(body)
216
} catch (err) {
217
process.nextTick(function () {
218
self.emit('error', err)
219
})
220
return
221
}
222
}
223
}
224
226
* Checks if xhr.status is readable and non-zero, indicating no error.
227
* Even though the spec says it should be available in readyState 3,
228
* accessing it throws an exception in IE8
229
*/
230
function statusValid (xhr) {
231
try {
232
var status = xhr.status
233
return (status !== null && status !== 0)
234
} catch (e) {
235
return false
236
}
237
}
238
239
ClientRequest.prototype._onXHRProgress = function () {
240
var self = this
241
242
if (!statusValid(self._xhr) || self._destroyed)
243
return
244
245
if (!self._response)
246
self._connect()
247
248
self._response._onXHRProgress()
249
}
250
251
ClientRequest.prototype._connect = function () {
252
var self = this
253
254
if (self._destroyed)
255
return
256
257
self._response = new IncomingMessage(self._xhr, self._fetchResponse, self._mode)
258
self._response.on('error', function(err) {
259
self.emit('error', err)
260
})
261
262
self.emit('response', self._response)
263
}
264
265
ClientRequest.prototype._write = function (chunk, encoding, cb) {
266
var self = this
267
268
self._body.push(chunk)
269
cb()
270
}
271
272
ClientRequest.prototype.abort = ClientRequest.prototype.destroy = function () {
273
var self = this
274
self._destroyed = true
275
if (self._response)
276
self._response._destroyed = true
277
if (self._xhr)
278
self._xhr.abort()
279
else if (self._fetchAbortController)
280
self._fetchAbortController.abort()
281
}
282
283
ClientRequest.prototype.end = function (data, encoding, cb) {
284
var self = this
285
if (typeof data === 'function') {
286
cb = data
287
data = undefined
288
}
289
290
stream.Writable.prototype.end.call(self, data, encoding, cb)
291
}
292
293
ClientRequest.prototype.flushHeaders = function () {}
294
ClientRequest.prototype.setTimeout = function () {}
295
ClientRequest.prototype.setNoDelay = function () {}
296
ClientRequest.prototype.setSocketKeepAlive = function () {}
297
298
// Taken from http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader%28%29-method
299
var unsafeHeaders = [
300
'accept-charset',
301
'accept-encoding',
302
'access-control-request-headers',
303
'access-control-request-method',
304
'connection',
305
'content-length',
306
'cookie',
307
'cookie2',
308
'date',
309
'dnt',
310
'expect',
311
'host',
312
'keep-alive',
313
'origin',
314
'referer',
315
'te',
316
'trailer',
317
'transfer-encoding',
318
'upgrade',
319
'user-agent',
320
'via'