lukechilds
/
got
mirror of https://github.com/lukechilds/got.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Add Promise API 

* Base logic moved into event-emitter and all APIs wrapped around it
* read-all-stream combined into one place - less code duplication
* Unzip stream now inherits all properties and function from response and returned instead of response

Closes #66
http2
Vsevolod Strukchinsky 10 years ago
parent
63d95b6316
commit
04dbc4b728
9 changed files with 323 additions and 243 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 342
      index.js
  2. 2
      package.json
  3. 21
      readme.md
  4. 22
      test/test-helpers.js
  5. 36
      test/test-http.js
  6. 7
      test/test-json.js
  7. 26
      test/test-post.js
  8. 20
      test/test-redirects.js
  9. 90
      test/test-stream.js

342
index.js
View File

@ -1,4 +1,5 @@
'use strict';
var EventEmitter = require('events').EventEmitter;
var http = require('http');
var https = require('https');
var urlLib = require('url');
@ -14,6 +15,7 @@ var prependHttp = require('prepend-http');
var lowercaseKeys = require('lowercase-keys');
var isRedirect = require('is-redirect');
var NestedErrorStacks = require('nested-error-stacks');
var pinkiePromise = require('pinkie-promise');
function GotError(message, nested) {
NestedErrorStacks.call(this, message, nested);
@ -23,196 +25,157 @@ function GotError(message, nested) {
util.inherits(GotError, NestedErrorStacks);
GotError.prototype.name = 'GotError';
function got(url, opts, cb) {
if (typeof url !== 'string' && typeof url !== 'object') {
throw new GotError('Parameter `url` must be a string or object, not ' + typeof url);
}
if (typeof opts === 'function') {
cb = opts;
opts = {};
}
opts = objectAssign(
{protocol: 'http:'},
typeof url === 'string' ? urlLib.parse(prependHttp(url)) : url,
opts
);
opts.headers = objectAssign({
'user-agent': 'https://github.com/sindresorhus/got',
'accept-encoding': 'gzip,deflate'
}, lowercaseKeys(opts.headers));
if (opts.pathname) {
opts.path = opts.pathname;
}
if (opts.query) {
if (typeof opts.query !== 'string') {
opts.query = querystring.stringify(opts.query);
}
function requestAsEventEmitter(opts) {
opts = opts || {};
opts.path = opts.pathname + '?' + opts.query;
delete opts.query;
}
var encoding = opts.encoding;
var body = opts.body;
var json = opts.json;
var timeout = opts.timeout;
var proxy;
var ee = new EventEmitter();
var redirectCount = 0;
delete opts.encoding;
delete opts.body;
delete opts.json;
delete opts.timeout;
if (json) {
opts.headers.accept = opts.headers.accept || 'application/json';
}
if (body) {
if (typeof body !== 'string' && !Buffer.isBuffer(body) && !isStream.readable(body)) {
throw new GotError('options.body must be a ReadableStream, string or Buffer');
}
opts.method = opts.method || 'POST';
if (!opts.headers['content-length'] && !opts.headers['transfer-encoding'] && !isStream.readable(body)) {
var length = typeof body === 'string' ? Buffer.byteLength(body) : body.length;
opts.headers['content-length'] = length;
}
}
opts.method = opts.method || 'GET';
// returns a proxy stream to the response
// if no callback has been provided
if (!cb) {
proxy = duplexify();
// forward errors on the stream
cb = function (err, data, response) {
proxy.emit('error', err, data, response);
};
}
if (proxy && json) {
throw new GotError('got can not be used as stream when options.json is used');
}
function get(opts, cb) {
function get(opts) {
var fn = opts.protocol === 'https:' ? https : http;
var url = urlLib.format(opts);
var req = fn.request(opts, function (response) {
var statusCode = response.statusCode;
var res = response;
// auto-redirect only for GET and HEAD methods
var req = fn.request(opts, function (res) {
var statusCode = res.statusCode;
if (isRedirect(statusCode) && 'location' in res.headers && (opts.method === 'GET' || opts.method === 'HEAD')) {
// discard response
res.resume();
if (++redirectCount > 10) {
cb(new GotError('Redirected 10 times. Aborting.'), undefined, res);
ee.emit('error', new GotError('Redirected 10 times. Aborting.'), undefined, res);
return;
}
var redirectUrl = urlLib.resolve(url, res.headers.location);
var redirectOpts = objectAssign({}, opts, urlLib.parse(redirectUrl));
if (opts.agent === infinityAgent.http.globalAgent && redirectOpts.protocol === 'https:' && opts.protocol === 'http:') {
redirectOpts.agent = undefined;
}
if (proxy) {
proxy.emit('redirect', res, redirectOpts);
}
ee.emit('redirect', res, redirectOpts);
get(redirectOpts, cb);
get(redirectOpts);
return;
}
if (proxy) {
proxy.emit('response', res);
}
if (['gzip', 'deflate'].indexOf(res.headers['content-encoding']) !== -1) {
res = res.pipe(zlib.createUnzip());
var unzip = zlib.createUnzip();
unzip.httpVersion = res.httpVersion;
unzip.headers = res.headers;
unzip.rawHeaders = res.rawHeaders;
unzip.trailers = res.trailers;
unzip.rawTrailers = res.rawTrailers;
unzip.setTimeout = res.setTimeout.bind(res);
unzip.statusCode = res.statusCode;
unzip.statusMessage = res.statusMessage;
unzip.socket = res.socket;
res = res.pipe(unzip);
}
if (statusCode < 200 || statusCode > 299) {
readAllStream(res, encoding, function (err, data) {
err = new GotError(opts.method + ' ' + url + ' response code is ' + statusCode + ' (' + http.STATUS_CODES[statusCode] + ')', err);
err.code = statusCode;
ee.emit('response', res);
}).once('error', function (err) {
ee.emit('error', new GotError('Request to ' + url + ' failed', err));
});
if (data && json) {
try {
data = JSON.parse(data);
} catch (e) {
err = new GotError('Parsing ' + url + ' response failed', new GotError(e.message, err));
}
}
if (opts.timeout) {
timedOut(req, opts.timeout);
}
ee.emit('request', req);
}
setImmediate(get, opts); // quirk to attach event listeners
return ee;
}
cb(err, data, response);
});
function asCallback(opts, cb) {
var ee = requestAsEventEmitter(opts);
var url = urlLib.format(opts);
ee.on('request', function (req) {
if (isStream.readable(opts.body)) {
opts.body.pipe(req);
opts.body = undefined;
return;
}
req.end(opts.body);
});
ee.on('response', function (res) {
readAllStream(res, opts.encoding, function (err, data) {
if (err) {
cb(new GotError('Reading ' + url + ' response failed', err), null, res);
return;
}
// pipe the response to the proxy if in proxy mode
if (proxy) {
proxy.setReadable(res);
return;
var statusCode = res.statusCode;
if (statusCode < 200 || statusCode > 299) {
err = new GotError(opts.method + ' ' + url + ' response code is ' + statusCode + ' (' + http.STATUS_CODES[statusCode] + ')', err);
err.code = statusCode;
}
readAllStream(res, encoding, function (err, data) {
if (err) {
err = new GotError('Reading ' + url + ' response failed', err);
} else if (json && statusCode !== 204) {
// only parse json if the option is enabled, and the response
// is not a 204 (empty reponse)
try {
data = JSON.parse(data);
} catch (e) {
err = new GotError('Parsing ' + url + ' response failed', e);
}
if (opts.json && statusCode !== 204) {
try {
data = JSON.parse(data);
} catch (e) {
err = new GotError('Parsing ' + url + ' response failed', new GotError(e.message, err));
}
}
cb(err, data, response);
});
}).once('error', function (err) {
cb(new GotError('Request to ' + url + ' failed', err));
cb(err, data, res);
});
});
if (timeout) {
timedOut(req, timeout);
}
ee.on('error', cb);
}
if (!proxy) {
if (isStream.readable(body)) {
body.pipe(req);
} else {
req.end(body);
}
function asPromise(opts) {
var resolve, reject;
var promise = new pinkiePromise(function (_resolve, _reject) {
resolve = _resolve;
reject = _reject;
});
var cb = function (err, data, response) {
response.body = data;
if (err) {
err.response = response;
reject(err);
return;
}
if (body) {
proxy.write = function () {
throw new Error('got\'s stream is not writable when options.body is used');
};
resolve(response);
};
if (isStream.readable(body)) {
body.pipe(req);
} else {
req.end(body);
}
asCallback(opts, cb);
return promise;
}
function asStream(opts) {
var proxy = duplexify();
if (opts.json) {
throw new GotError('got can not be used as stream when options.json is used');
}
if (opts.body) {
proxy.write = function () {
throw new Error('got\'s stream is not writable when options.body is used');
};
}
var ee = requestAsEventEmitter(opts);
ee.on('request', function (req) {
proxy.emit('request', req);
if (isStream.readable(opts.body)) {
opts.body.pipe(req);
return;
}
if (opts.body) {
req.end(opts.body);
return;
}
@ -222,13 +185,88 @@ function got(url, opts, cb) {
}
req.end();
}
});
ee.on('response', function (res) {
proxy.setReadable(res);
proxy.emit('response', res);
});
get(opts, cb);
ee.on('redirect', proxy.emit.bind(proxy, 'redirect'));
return proxy;
}
function normalizeArguments(url, opts) {
if (typeof url !== 'string' && typeof url !== 'object') {
throw new GotError('Parameter `url` must be a string or object, not ' + typeof url);
}
opts = objectAssign(
{
protocol: 'http:'
},
typeof url === 'string' ? urlLib.parse(prependHttp(url)) : url,
opts
);
opts.headers = objectAssign({
'user-agent': 'https://github.com/sindresorhus/got',
'accept-encoding': 'gzip,deflate'
}, lowercaseKeys(opts.headers));
if (opts.pathname) {
opts.path = opts.pathname;
}
var query = opts.query;
if (query) {
if (typeof query !== 'string') {
opts.query = querystring.stringify(query);
}
opts.path = opts.pathname + '?' + opts.query;
delete opts.query;
}
if (opts.json) {
opts.headers.accept = opts.headers.accept || 'application/json';
}
var body = opts.body;
if (body) {
if (typeof body !== 'string' && !Buffer.isBuffer(body) && !isStream.readable(body)) {
throw new GotError('options.body must be a ReadableStream, string or Buffer');
}
opts.method = opts.method || 'POST';
if (!opts.headers['content-length'] && !opts.headers['transfer-encoding'] && !isStream.readable(body)) {
var length = typeof body === 'string' ? Buffer.byteLength(body) : body.length;
opts.headers['content-length'] = length;
}
}
opts.method = opts.method || 'GET';
return opts;
}
function got(url, opts, cb) {
if (typeof opts === 'function') {
cb = opts;
opts = {};
}
opts = normalizeArguments(url, opts);
if (cb) {
return asCallback(opts, cb);
}
return asPromise(opts);
}
[
'get',
'post',
@ -247,4 +285,8 @@ function got(url, opts, cb) {
};
});
got.stream = function (url, opts) {
return asStream(normalizeArguments(url, opts));
};
module.exports = got;

2
package.json
View File

@ -43,12 +43,12 @@
],
"dependencies": {
"duplexify": "^3.2.0",
"infinity-agent": "^2.0.0",
"is-redirect": "^1.0.0",
"is-stream": "^1.0.0",
"lowercase-keys": "^1.0.0",
"nested-error-stacks": "^1.0.0",
"object-assign": "^3.0.0",
"pinkie-promise": "^1.0.0",
"prepend-http": "^1.0.0",
"read-all-stream": "^3.0.0",
"timed-out": "^2.0.0"

21
readme.md
View File

@ -35,12 +35,18 @@ got('todomvc.com', function (err, data, res) {
//=> <!doctype html> ...
});
// Promise mode
got('todomvc.com')
.then(function (res) {
console.log(res.body);
})
.catch(console.error);
// Stream mode
got('todomvc.com').pipe(fs.createWriteStream('index.html'));
got.stream('todomvc.com').pipe(fs.createWriteStream('index.html'));
// For POST, PUT and PATCH methods got returns a WritableStream
fs.createReadStream('index.html').pipe(got.post('todomvc.com'));
// For POST, PUT and PATCH methods got.stream returns a WritableStream
fs.createReadStream('index.html').pipe(got.stream('todomvc.com', {method: 'POST'}));
```
### API
@ -104,6 +110,8 @@ Milliseconds after which the request will be aborted and an error event with `ET
##### callback(error, data, response)
Function to be called, when error or data recieved. If omitted - Promise will be returned.
###### error
`Error` object with HTTP status code as `code` property.
@ -118,6 +126,10 @@ The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage)
When in stream mode, you can listen for events:
##### .on('request', request)
`request` event to get the request object of the request.
##### .on('response', response)
`response` event to get the response object of the final request.
@ -130,9 +142,6 @@ When in stream mode, you can listen for events:
`error` event emitted in case of protocol error (like `ENOTFOUND` etc.) or status error (4xx or 5xx). Second argument is body of server response in case of status error. Third argument is response object.
###### response
The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage).
#### got.get(url, [options], [callback])
#### got.post(url, [options], [callback])

22
test/test-helpers.js
View File

@ -8,13 +8,18 @@ s.on('/', function (req, res) {
res.end('ok');
});
s.on('/404', function (req, res) {
res.statusCode = 404;
res.end('not found');
});
test('setup', function (t) {
s.listen(s.port, function () {
t.end();
});
});
test('callback mode', {timeout: 1000}, function (t) {
test('callback mode', function (t) {
got.get(s.url, function (err, data) {
t.error(err);
t.equal(data, 'ok');
@ -22,11 +27,18 @@ test('callback mode', {timeout: 1000}, function (t) {
});
});
test('stream mode', {timeout: 1000}, function (t) {
test('promise mode', function (t) {
t.plan(2);
got.get(s.url)
.on('data', function (data) {
t.equal(data.toString(), 'ok');
t.end();
.then(function (res) {
t.equal(res.body, 'ok');
});
got.get(s.url + '/404')
.catch(function (err) {
t.equal(err.message, 'GET http://localhost:6767/404 response code is 404 (Not Found)');
t.equal(err.response.body, 'not found');
});
});

36
test/test-http.js
View File

@ -70,39 +70,11 @@ test('buffer on encoding === null', function (t) {
});
});
test('stream mode', function (t) {
got(s.url)
.on('data', function (data) {
t.equal(data.toString(), 'ok');
t.end();
});
});
test('emit response object to stream', function (t) {
got(s.url)
.on('response', function (res) {
t.ok(res);
t.ok(res.headers);
t.end();
});
});
test('proxy errors to the stream', function (t) {
got(s.url + '/404')
.on('error', function (err, data, res) {
t.equal(err.code, 404);
t.equal(data, 'not');
t.ok(res);
t.end();
});
});
test('timeout option', function (t) {
got(s.url + '/404', {timeout: 1})
.on('error', function (err) {
t.equal(err.code, 'ETIMEDOUT');
t.end();
});
got(s.url + '/404', {timeout: 1}, function (err) {
t.equal(err.code, 'ETIMEDOUT');
t.end();
});
});
test('query option', function (t) {

7
test/test-json.js
View File

@ -33,13 +33,6 @@ test('setup', function (t) {
});
});
test('json option can not be used in stream mode', function (t) {
t.throws(function () {
got(s.url, {json: true});
}, 'got can not be used as stream when options.json is used');
t.end();
});
test('json option should parse response', function (t) {
got(s.url, {json: true}, function (err, json) {
t.error(err);

26
test/test-post.js
View File

@ -67,32 +67,6 @@ test('works with empty post response', function (t) {
});
});
test('return readable stream', function (t) {
got.post(s.url, {body: from2Array(['wow'])})
.on('data', function (data) {
t.equal(data.toString(), 'wow');
t.end();
});
});
test('return writeable stream', function (t) {
got.post(s.url)
.on('data', function (data) {
t.equal(data.toString(), 'wow');
t.end();
})
.end('wow');
});
test('throws on write to stream with body specified', function (t) {
t.throws(function () {
got(s.url, {body: 'wow'}).write('wow');
});
// wait for request to end
setTimeout(t.end.bind(t), 10);
});
test('post have content-length header to string', function (t) {
t.plan(5);

20
test/test-redirects.js
View File

@ -4,6 +4,10 @@ var got = require('../');
var server = require('./server.js');
var s = server.createServer();
s.on('/', function (req, res) {
res.end('reached');
});
s.on('/finite', function (req, res) {
res.writeHead(302, {
location: s.url + '/'
@ -32,10 +36,6 @@ s.on('/relativeQuery?bang', function (req, res) {
res.end();
});
s.on('/', function (req, res) {
res.end('reached');
});
test('setup', function (t) {
s.listen(s.port, function () {
t.end();
@ -90,18 +90,6 @@ test('redirect only GET and HEAD requests', function (t) {
});
});
test('redirect event', function (t) {
got(s.url + '/endless')
.on('redirect', function (res, opts) {
t.equal(res.headers.location, s.url + '/endless');
opts.path = '/';
})
.on('data', function (data) {
t.equal(data.toString(), 'reached');
t.end();
});
});
test('cleanup', function (t) {
s.close();
t.end();

90
test/test-stream.js
View File

@ -0,0 +1,90 @@
'use strict';
var test = require('tap').test;
var from2Array = require('from2-array');
var got = require('../');
var server = require('./server.js');
var s = server.createServer();
s.on('/', function (req, res) {
res.end('ok');
});
s.on('/post', function (req, res) {
req.pipe(res);
});
s.on('/redirect', function (req, res) {
res.writeHead(302, {
location: s.url
});
res.end();
});
test('setup', function (t) {
s.listen(s.port, function () {
t.end();
});
});
test('json option can not be used in stream mode', function (t) {
t.throws(function () {
got.stream(s.url, {json: true});
}, 'got can not be used as stream when options.json is used');
t.end();
});
test('return readable stream', function (t) {
got.stream(s.url)
.on('data', function (data) {
t.equal(data.toString(), 'ok');
t.end();
});
});
test('return writeable stream', function (t) {
t.plan(1);
got.stream(s.url + '/post', {method: 'POST'})
.on('data', function (data) {
t.equal(data.toString(), 'wow');
})
.end('wow');
});
test('throws on write to stream with body specified', function (t) {
t.throws(function () {
got.stream(s.url, {body: 'wow'}).write('wow');
}, 'got\'s stream is not writable when options.body is used');
// wait for request to end
setTimeout(t.end.bind(t), 10);
});
test('request event', function (t) {
got.stream(s.url)
.on('request', function (req) {
t.ok(req);
t.end();
});
});
test('redirect event', function (t) {
got.stream(s.url + '/redirect')
.on('redirect', function (res, opts) {
t.equal(res.headers.location, s.url);
t.end();
});
});
test('response event', function (t) {
got.stream(s.url)
.on('response', function (res) {
t.equal(res.statusCode, 200);
t.end();
});
});
test('cleanup', function (t) {
s.close();
t.end();
});
Write Preview
Loading…
Cancel
Save