Skip to content

Commit af21ae6

Browse files
author
David Frank
committed
basic refactor done
1 parent 93a983d commit af21ae6

File tree

7 files changed

+372
-46
lines changed

7 files changed

+372
-46
lines changed

‎LIMITS.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22
Known limits
33
============
44

5-
**As of 1.x release**
5+
*As of 1.x release*
66

7-
- Topics such as cross-origin, CSP, mixed content are ignored, given our server-side context.
7+
- Topics such as cross-origin, content security policy, mixed content, service workers are ignored, given our server-side context.
88

99
- Url input must be an absolute url, using either `http` or `https` as scheme.
1010

11-
- Doesn't export `Headers`, `Body`, `Request`, `Response` classes yet, as we currenly use a much simpler implementation.
11+
- On the upside, there are no forbidden headers, and `res.url` contains the final url when following redirects.
1212

13-
- For convenience, `res.body()` is a transform stream instead of byte stream, so decoding can be handled independently.
13+
- For convenience, `res.body` is a transform stream, so decoding can be handled independently.
1414

15-
- Similarly, `options.body` can either be a string or a readable stream.
15+
- Similarly, `req.body` can either be a string or a readable stream.
1616

17-
- For convenience, maximum redirect count (`options.follow`) and request timeout (`options.timeout`) are adjustable.
18-
19-
- There is currently no built-in caching support, as server-side requirement varies greatly between use-cases.
17+
- There is currently no built-in caching, as server-side caching varies by use-cases.

‎README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ A light-weight module that brings `window.fetch` to node.js
1212

1313
I really like the notion of Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch): it bridges the API gap between client-side and server-side http requests, so developers have less to worry about.
1414

15-
But I think the term [isomorphic](http://isomorphic.net/) is generally misleading: it gives developers a false sense of security that their javascript code will run happily on both controlled server environment as well as uncontrollable user browsers. When the latter is only true for a small subset of modern browsers, not to mention quirks in native implementation.
15+
But I think the term [isomorphic](http://isomorphic.net/) is generally misleading: it gives developers a false sense of security that their javascript code will run happily on both controlled server environment as well as uncontrollable user browsers. When the latter is only true for a subset of modern browsers, not to mention quirks in native implementation.
1616

1717
Instead of implementing `XMLHttpRequest` in node to run browser-specific [fetch polyfill](https://github.com/github/fetch), why not go from node's `http` to `fetch` API directly? Node has native stream support, browserify build targets (browsers) don't, so underneath they are going to be vastly different anyway.
1818

19-
IMHO, it's safer to be aware of javascript runtime's strength and weakness, than to assume they are a unified platform under a singular spec.
20-
21-
Hence `node-fetch`, minimal code for a `window.fetch` compatible API.
19+
Hence `node-fetch`, minimal code for a `window.fetch` compatible API on node.js runtime.
2220

2321

2422
# Features
@@ -28,11 +26,11 @@ Hence `node-fetch`, minimal code for a `window.fetch` compatible API.
2826
- Use native promise, but allow substituting it with [insert your favorite promise library].
2927

3028

31-
# Difference to client-side fetch
32-
33-
- This module is WIP, see [Known limits](https://github.com/bitinn/node-fetch/blob/master/LIMITS.md) for details.
29+
# Difference from client-side fetch
3430

35-
(If you spot a missing feature that `window.fetch` offers, feel free to open an issue. Pull requests are welcomed too!)
31+
- See [Known limits](https://github.com/bitinn/node-fetch/blob/master/LIMITS.md) for details.
32+
- If you happen to use a missing feature that `window.fetch` offers, feel free to open an issue.
33+
- Pull requests are welcomed too!
3634

3735

3836
# Install

‎index.js

+78-27
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
/**
33
* index.js
44
*
5-
* export fetch
5+
* a request API compatible with window.fetch
66
*/
77

88
var parse = require('url').parse;
@@ -12,29 +12,35 @@ var https = require('https');
1212
var zlib = require('zlib');
1313
var stream = require('stream');
1414

15+
var Response = require('./lib/response');
16+
var Headers = require('./lib/headers');
17+
1518
module.exports = Fetch;
1619

1720
/**
18-
* Create an instance of Decent
21+
* Fetch class
1922
*
2023
* @param String url Absolute url
2124
* @param Object opts Fetch options
2225
* @return Promise
2326
*/
2427
function Fetch(url, opts) {
2528

29+
// allow call as function
2630
if (!(this instanceof Fetch))
2731
return new Fetch(url, opts);
2832

33+
// allow custom promise
2934
if (!Fetch.Promise) {
3035
throw new Error('native promise missing, set Fetch.Promise to your favorite alternative');
3136
}
3237

38+
Response.Promise = Fetch.Promise;
39+
3340
var self = this;
3441

42+
// wrap http.request into fetch
3543
return new Fetch.Promise(function(resolve, reject) {
36-
opts = opts || {};
37-
3844
var uri = parse(url);
3945

4046
if (!uri.protocol || !uri.hostname) {
@@ -47,37 +53,73 @@ function Fetch(url, opts) {
4753
return;
4854
}
4955

50-
// TODO: detect type and decode data
51-
5256
var request;
5357
if (uri.protocol === 'https:') {
5458
request = https.request;
5559
} else {
5660
request = http.request;
5761
}
5862

59-
// avoid side-effect on input
63+
opts = opts || {};
64+
65+
// avoid side-effect on input options
6066
var options = {
6167
hostname: uri.hostname
6268
, port: uri.port
63-
, method: opts.method
64-
, path: uri.path
65-
, headers: opts.headers || {}
69+
, path: uri.path || '/'
6670
, auth: uri.auth
71+
, method: opts.method || 'GET'
72+
, headers: opts.headers || {}
6773
, follow: opts.follow || 20
6874
, counter: opts.counter || 0
69-
, agent: opts.agent
75+
, timeout: opts.timeout || 0
76+
, compress: opts.compress || true
77+
, size: opts.size || 0
7078
, body: opts.body
71-
, timeout: opts.timeout
79+
, agent: opts.agent
7280
};
7381

82+
// normalize headers
83+
var headers = new Headers(options.headers);
84+
85+
if (options.compress) {
86+
headers.set('accept-encoding', 'gzip,deflate');
87+
}
88+
89+
if (!headers.has('user-agent')) {
90+
headers.set('user-agent', 'node-fetch/1.0 (+https://github.com/bitinn/node-fetch)');
91+
}
92+
93+
if (!headers.has('connection')) {
94+
headers.set('connection', 'close');
95+
}
96+
97+
if (!headers.has('accept')) {
98+
headers.set('accept', '*/*');
99+
}
100+
101+
options.headers = headers.raw();
102+
103+
// send request
74104
var req = request(options);
105+
var started = false;
106+
107+
req.on('socket', function(socket) {
108+
if (!started && options.timeout) {
109+
started = true;
110+
setTimeout(function() {
111+
req.abort();
112+
reject(new Error('network timeout at: ' + uri.href));
113+
}, options.timeout);
114+
}
115+
});
75116

76117
req.on('error', function(err) {
77118
reject(new Error('request to ' + uri.href + ' failed, reason: ' + err.message));
78119
});
79120

80121
req.on('response', function(res) {
122+
// handle redirect
81123
if (self.isRedirect(res.statusCode)) {
82124
if (options.counter >= options.follow) {
83125
reject(Error('maximum redirect reached at: ' + uri.href));
@@ -87,19 +129,35 @@ function Fetch(url, opts) {
87129
reject(Error('redirect location header missing at: ' + uri.href));
88130
}
89131

90-
return Fetch(resolve(uri.href, res.headers.location), options);
132+
resolve(Fetch(resolve(uri.href, res.headers.location), options));
133+
return;
91134
}
92135

93-
var output = {
94-
status: res.statusCode
95-
, headers: res.headers
96-
, body: res.pipe(new stream.PassThrough())
97-
, url: uri.href
98-
};
136+
// handle compression
137+
var body = res.pipe(new stream.PassThrough());
138+
var headers = new Headers(res.headers);
139+
140+
if (headers.has('content-encoding')) {
141+
var name = headers.get('content-encoding');
142+
143+
if (name == 'gzip' || name == 'x-gzip') {
144+
body = body.pipe(zlib.createGunzip());
145+
} else if (name == 'deflate' || name == 'x-deflate') {
146+
body = body.pipe(zlib.createInflate());
147+
}
148+
}
149+
150+
// response object
151+
var output = new Response(body, {
152+
url: uri.href
153+
, status: res.statusCode
154+
, headers: headers
155+
});
99156

100157
resolve(output);
101158
});
102159

160+
// accept string or readable stream as body
103161
if (typeof options.body === 'string') {
104162
req.write(options.body);
105163
req.end();
@@ -108,19 +166,12 @@ function Fetch(url, opts) {
108166
} else {
109167
req.end();
110168
}
111-
112-
if (options.timeout) {
113-
setTimeout(function() {
114-
req.abort();
115-
reject(new Error('network timeout at: ' + uri.href));
116-
}, options.timeout);
117-
}
118169
});
119170

120171
};
121172

122173
/**
123-
* Create an instance of Decent
174+
* Redirect code matching
124175
*
125176
* @param Number code Status code
126177
* @return Boolean

‎lib/headers.js

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
2+
/**
3+
* headers.js
4+
*
5+
* Headers class offers convenient helpers
6+
*/
7+
8+
module.exports = Headers;
9+
10+
/**
11+
* Headers class
12+
*
13+
* @param Object headers Response headers
14+
* @return Void
15+
*/
16+
function Headers(headers) {
17+
18+
var self = this;
19+
this._headers = {};
20+
21+
for (var prop in headers) {
22+
if (headers.hasOwnProperty(prop)) {
23+
if (typeof headers[prop] === 'string') {
24+
this.set(prop, headers[prop]);
25+
} else if (headers[prop].length > 0) {
26+
headers[prop].forEach(function(item) {
27+
self.append(prop, item);
28+
});
29+
}
30+
}
31+
}
32+
33+
}
34+
35+
/**
36+
* Return first header value given name
37+
*
38+
* @param String name Header name
39+
* @return Mixed
40+
*/
41+
Headers.prototype.get = function(name) {
42+
var list = this._headers[name.toLowerCase()];
43+
return list ? list[0] : null;
44+
};
45+
46+
/**
47+
* Return all header values given name
48+
*
49+
* @param String name Header name
50+
* @return Array
51+
*/
52+
Headers.prototype.getAll = function(name) {
53+
if (!this.has(name)) {
54+
return [];
55+
}
56+
57+
return this._headers[name.toLowerCase()];
58+
};
59+
60+
/**
61+
* Overwrite header values given name
62+
*
63+
* @param String name Header name
64+
* @param String value Header value
65+
* @return Void
66+
*/
67+
Headers.prototype.set = function(name, value) {
68+
this._headers[name.toLowerCase()] = [value];
69+
};
70+
71+
/**
72+
* Append a value onto existing header
73+
*
74+
* @param String name Header name
75+
* @param String value Header value
76+
* @return Void
77+
*/
78+
Headers.prototype.append = function(name, value) {
79+
if (!this.has(name)) {
80+
this.set(name, value);
81+
return;
82+
}
83+
84+
this._headers[name.toLowerCase()].push(value);
85+
};
86+
87+
/**
88+
* Check for header name existence
89+
*
90+
* @param String name Header name
91+
* @return Boolean
92+
*/
93+
Headers.prototype.has = function(name) {
94+
return this._headers.hasOwnProperty(name.toLowerCase());
95+
};
96+
97+
/**
98+
* Delete all header values given name
99+
*
100+
* @param String name Header name
101+
* @return Void
102+
*/
103+
Headers.prototype['delete'] = function(name) {
104+
delete this._headers[name.toLowerCase()];
105+
};
106+
107+
/**
108+
* Return raw headers (non-spec api)
109+
*
110+
* @return Object
111+
*/
112+
Headers.prototype.raw = function() {
113+
return this._headers;
114+
};

0 commit comments

Comments
 (0)