/
stream.ts
439 lines (349 loc) 路 11.1 KB
/
stream.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
import {promisify} from 'util';
import fs = require('fs');
import {PassThrough as PassThroughStream} from 'stream';
import stream = require('stream');
import test from 'ava';
import {Handler} from 'express';
import toReadableStream = require('to-readable-stream');
import getStream = require('get-stream');
import pEvent = require('p-event');
import FormData = require('form-data');
import is from '@sindresorhus/is';
import got, {RequestError} from '../source';
import withServer from './helpers/with-server';
const pStreamPipeline = promisify(stream.pipeline);
const defaultHandler: Handler = (_request, response) => {
response.writeHead(200, {
unicorn: 'rainbow',
'content-encoding': 'gzip'
});
response.end(Buffer.from('H4sIAAAAAAAA/8vPBgBH3dx5AgAAAA==', 'base64')); // 'ok'
};
const redirectHandler: Handler = (_request, response) => {
response.writeHead(302, {
location: '/'
});
response.end();
};
const postHandler: Handler = async (request, response) => {
await pStreamPipeline(request, response);
};
const errorHandler: Handler = (_request, response) => {
response.statusCode = 404;
response.end();
};
const headersHandler: Handler = (request, response) => {
response.end(JSON.stringify(request.headers));
};
const infiniteHandler: Handler = (_request, response) => {
response.write('foobar');
};
test('`options.responseType` is ignored', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
await t.notThrowsAsync(getStream(got.stream({responseType: 'json'})));
});
test('returns readable stream', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
const data = await getStream(got.stream(''));
t.is(data, 'ok');
});
test('returns writeable stream', withServer, async (t, server, got) => {
server.post('/', postHandler);
const stream = got.stream.post('');
const promise = getStream(stream);
stream.end('wow');
t.is(await promise, 'wow');
});
test('throws on write if body is specified', withServer, (t, server, got) => {
server.post('/', postHandler);
const streams = [
got.stream.post({body: 'wow'}),
got.stream.post({json: {}}),
got.stream.post({form: {}})
];
for (const stream of streams) {
t.throws(() => {
stream.end('wow');
}, {
message: 'The payload has been already provided'
});
stream.destroy();
}
});
test('does not throw if using stream and passing a json option', withServer, async (t, server, got) => {
server.post('/', postHandler);
await t.notThrowsAsync(getStream(got.stream.post({json: {}})));
});
test('does not throw if using stream and passing a form option', withServer, async (t, server, got) => {
server.post('/', postHandler);
await t.notThrowsAsync(getStream(got.stream.post({form: {}})));
});
test('throws on write if no payload method is present', withServer, (t, server, got) => {
server.post('/', postHandler);
const stream = got.stream.get('');
t.throws(() => {
stream.end('wow');
}, {
message: 'The payload has been already provided'
});
stream.destroy();
});
test('has request event', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
const stream = got.stream('');
const request = await pEvent(stream, 'request');
t.truthy(request);
t.is(request.method, 'GET');
await getStream(stream);
});
test('has redirect event', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.get('/redirect', redirectHandler);
const stream = got.stream('redirect');
const {headers} = await pEvent(stream, 'redirect');
t.is(headers.location, '/');
await getStream(stream);
});
test('has response event', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
const {statusCode} = await pEvent(got.stream(''), 'response');
t.is(statusCode, 200);
});
test('has error event', withServer, async (t, server, got) => {
server.get('/', errorHandler);
const stream = got.stream('');
await t.throwsAsync(pEvent(stream, 'response'), {
instanceOf: got.HTTPError,
message: 'Response code 404 (Not Found)'
});
});
test('has error event #2', async t => {
const stream = got.stream('http://doesntexist');
await t.throwsAsync(pEvent(stream, 'response'), {code: 'ENOTFOUND'});
});
test('has response event if `options.throwHttpErrors` is false', withServer, async (t, server, got) => {
server.get('/', errorHandler);
const {statusCode} = await pEvent(got.stream({throwHttpErrors: false}), 'response');
t.is(statusCode, 404);
});
test('accepts `options.body` as a Stream', withServer, async (t, server, got) => {
server.post('/', postHandler);
const stream = got.stream.post({body: toReadableStream('wow')});
t.is(await getStream(stream), 'wow');
});
test('redirect response contains old url', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.get('/redirect', redirectHandler);
const {requestUrl} = await pEvent(got.stream('redirect'), 'response');
t.is(requestUrl, `${server.url}/redirect`);
});
test('check for pipe method', withServer, (t, server, got) => {
server.get('/', defaultHandler);
const stream = got.stream('');
t.true(is.function_(stream.pipe));
t.true(is.function_(stream.on('foobar', () => {}).pipe));
stream.destroy();
});
test('piping works', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
t.is(await getStream(got.stream('')), 'ok');
t.is(await getStream(got.stream('').on('foobar', () => {})), 'ok');
});
test('proxying headers works', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.get('/proxy', async (_request, response) => {
await pStreamPipeline(
got.stream(''),
response
);
});
const {headers, body} = await got('proxy');
t.is(headers.unicorn, 'rainbow');
t.is(headers['content-encoding'], undefined);
t.is(body, 'ok');
});
test('piping server request to Got proxies also headers', withServer, async (t, server, got) => {
server.get('/', headersHandler);
server.get('/proxy', async (request, response) => {
await pStreamPipeline(
request,
got.stream(''),
response
);
});
const {foo}: {foo: string} = await got('proxy', {
headers: {
foo: 'bar'
}
}).json();
t.is(foo, 'bar');
});
test('skips proxying headers after server has sent them already', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.get('/proxy', async (_request, response) => {
response.writeHead(200);
await pStreamPipeline(
got.stream(''),
response
);
});
const {headers} = await got('proxy');
t.is(headers.unicorn, undefined);
});
test('throws when trying to proxy through a closed stream', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
const stream = got.stream('');
const promise = getStream(stream);
stream.once('data', () => {
t.throws(() => {
stream.pipe(new PassThroughStream());
}, {
message: 'Failed to pipe. The response has been emitted already.'
});
});
await promise;
});
test('proxies `content-encoding` header when `options.decompress` is false', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.get('/proxy', async (_request, response) => {
await pStreamPipeline(
got.stream({decompress: false}),
response
);
});
const {headers} = await got('proxy');
t.is(headers.unicorn, 'rainbow');
t.is(headers['content-encoding'], 'gzip');
});
{
const nodejsMajorVersion = Number(process.versions.node.split('.')[0]);
const testFn = nodejsMajorVersion < 14 ? test.failing : test;
testFn('destroying got.stream() destroys the request - `request` event', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
const stream = got.stream('');
const request = await pEvent(stream, 'request');
stream.destroy();
t.truthy(request.destroyed);
});
testFn('destroying got.stream() destroys the request - `response` event', withServer, async (t, server, got) => {
server.get('/', (_request, response) => {
response.write('hello');
});
const stream = got.stream('');
const request = await pEvent(stream, 'request');
await pEvent(stream, 'response');
stream.destroy();
t.truthy(request.destroyed);
});
}
test('piping to got.stream.put()', withServer, async (t, server, got) => {
server.get('/', defaultHandler);
server.put('/post', postHandler);
await t.notThrowsAsync(async () => {
await getStream(
stream.pipeline(
got.stream(''),
got.stream.put('post'),
() => {}
)
);
});
});
test('no unhandled body stream errors', async t => {
const form = new FormData();
form.append('upload', fs.createReadStream('/bin/sh'));
await t.throwsAsync(got.post(`https://offlinesite${Date.now()}.com`, {
form
}), {
code: 'ENOTFOUND'
});
});
test('works with pipeline', async t => {
await t.throwsAsync(pStreamPipeline(
new stream.Readable({
read() {
this.push(null);
}
}),
got.stream.put('http://localhost:7777')
), {
instanceOf: RequestError,
message: 'connect ECONNREFUSED 127.0.0.1:7777'
});
});
test('errors have body', withServer, async (t, server, got) => {
server.get('/', (_request, response) => {
response.setHeader('set-cookie', 'foo=bar');
response.end('yay');
});
const error = await t.throwsAsync<RequestError>(getStream(got.stream('', {
cookieJar: {
setCookie: async (_, __) => {
throw new Error('snap');
},
getCookieString: async _ => ''
}
})));
t.is(error.message, 'snap');
t.is(error.response?.body, 'yay');
});
test('pipe can send modified headers', withServer, async (t, server, got) => {
server.get('/foobar', (_request, response) => {
response.setHeader('foo', 'bar');
response.end();
});
server.get('/', (_request, response) => {
got.stream('foobar').on('response', response => {
response.headers.foo = 'boo';
}).pipe(response);
});
const {headers} = await got('');
t.is(headers.foo, 'boo');
});
test('the socket is alive on a successful pipeline', withServer, async (t, server, got) => {
const payload = 'ok';
server.get('/', (_request, response) => {
response.end(payload);
});
const gotStream = got.stream('');
t.is(gotStream.socket, undefined);
const receiver = new stream.PassThrough();
await promisify(stream.pipeline)(gotStream, receiver);
t.is(await getStream(receiver), payload);
t.truthy(gotStream.socket);
t.false(gotStream.socket!.destroyed);
});
test('async iterator works', withServer, async (t, server, got) => {
const payload = 'ok';
server.get('/', (_request, response) => {
response.end(payload);
});
const gotStream = got.stream('');
const chunks = [];
for await (const chunk of gotStream) {
chunks.push(chunk);
}
t.is(Buffer.concat(chunks).toString(), payload);
});
if (process.versions.node.split('.')[0] <= '12') {
test('does not emit end event on error', withServer, async (t, server, got) => {
server.get('/', infiniteHandler);
await t.notThrowsAsync(new Promise((resolve, reject) => {
got.stream({
timeout: 100,
hooks: {
beforeError: [
async error => {
await new Promise(resolve => {
setTimeout(resolve, 50);
});
return error;
}
]
}
}).once('end', () => {
reject(new Error('Stream has ended before erroring'));
}).once('error', resolve).resume();
}));
});
}