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
self.emit('error', reason)
162
})
163
} else {
164
var xhr = self._xhr = new global.XMLHttpRequest()
165
try {
166
xhr.open(self._opts.method, self._opts.url, true)
167
} catch (err) {
168
process.nextTick(function () {
169
self.emit('error', err)
170
})
171
return
172
}
173
174
// Can't set responseType on really old browsers
175
if ('responseType' in xhr)
176
xhr.responseType = self._mode.split(':')[0]
177
178
if ('withCredentials' in xhr)
179
xhr.withCredentials = !!opts.withCredentials
180
181
if (self._mode === 'text' && 'overrideMimeType' in xhr)
182
xhr.overrideMimeType('text/plain; charset=x-user-defined')
183
184
if ('requestTimeout' in opts) {
185
xhr.timeout = opts.requestTimeout
186
xhr.ontimeout = function () {
187
self.emit('requestTimeout')
188
}
189
}
190
191
headersList.forEach(function (header) {
192
xhr.setRequestHeader(header[0], header[1])
193
})
194
195
self._response = null
196
xhr.onreadystatechange = function () {
197
switch (xhr.readyState) {
198
case rStates.LOADING:
199
case rStates.DONE:
200
self._onXHRProgress()
201
break
202
}
203
}
204
// Necessary for streaming in Firefox, since xhr.response is ONLY defined
205
// in onprogress, not in onreadystatechange with xhr.readyState = 3
206
if (self._mode === 'moz-chunked-arraybuffer') {
207
xhr.onprogress = function () {
208
self._onXHRProgress()
209
}
210
}
212
xhr.onerror = function () {
213
if (self._destroyed)
214
return
215
self.emit('error', new Error('XHR error'))
216
}
217
218
try {
219
xhr.send(body)
220
} catch (err) {
221
process.nextTick(function () {
222
self.emit('error', err)
223
})
224
return
225
}
226
}
227
}
228
230
* Checks if xhr.status is readable and non-zero, indicating no error.
231
* Even though the spec says it should be available in readyState 3,
232
* accessing it throws an exception in IE8
233
*/
234
function statusValid (xhr) {
235
try {
236
var status = xhr.status
237
return (status !== null && status !== 0)
238
} catch (e) {
239
return false
240
}
241
}
242
243
ClientRequest.prototype._onXHRProgress = function () {
244
var self = this
245
246
if (!statusValid(self._xhr) || self._destroyed)
247
return
248
249
if (!self._response)
250
self._connect()
251
252
self._response._onXHRProgress()
253
}
254
255
ClientRequest.prototype._connect = function () {
256
var self = this
257
258
if (self._destroyed)
259
return
260
261
self._response = new IncomingMessage(self._xhr, self._fetchResponse, self._mode)
262
self._response.on('error', function(err) {
263
self.emit('error', err)
264
})
265
266
self.emit('response', self._response)
267
}
268
269
ClientRequest.prototype._write = function (chunk, encoding, cb) {
270
var self = this
271
272
self._body.push(chunk)
273
cb()
274
}
275
276
ClientRequest.prototype.abort = ClientRequest.prototype.destroy = function () {
277
var self = this
278
self._destroyed = true
279
if (self._response)
280
self._response._destroyed = true
281
if (self._xhr)
282
self._xhr.abort()
283
else if (self._fetchAbortController)
284
self._fetchAbortController.abort()
285
}
286
287
ClientRequest.prototype.end = function (data, encoding, cb) {
288
var self = this
289
if (typeof data === 'function') {
290
cb = data
291
data = undefined
292
}
293
294
stream.Writable.prototype.end.call(self, data, encoding, cb)
295
}
296
297
ClientRequest.prototype.flushHeaders = function () {}
298
ClientRequest.prototype.setTimeout = function () {}
299
ClientRequest.prototype.setNoDelay = function () {}
300
ClientRequest.prototype.setSocketKeepAlive = function () {}
301
302
// Taken from http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader%28%29-method
303
var unsafeHeaders = [
304
'accept-charset',
305
'accept-encoding',
306
'access-control-request-headers',
307
'access-control-request-method',
308
'connection',
309
'content-length',
310
'cookie',
311
'cookie2',
312
'date',
313
'dnt',
314
'expect',
315
'host',
316
'keep-alive',
317
'origin',
318
'referer',
319
'te',
320
'trailer',
321
'transfer-encoding',
322
'upgrade',
323
'user-agent',
324
'via'