mirror of
https://git.coolaj86.com/coolaj86/request.js
synced 2025-04-21 14:50:37 +00:00
Compare commits
17 Commits
Author | SHA1 | Date | |
---|---|---|---|
bb30d5acf6 | |||
5b539deb7b | |||
0a2e7afa76 | |||
ba60df7eab | |||
bc4f6e59c0 | |||
3842ee1d61 | |||
9518cb970b | |||
2e9a643c0f | |||
dcd41a33d0 | |||
5f5e0b6066 | |||
ed2bab931f | |||
a95d003ed5 | |||
5149bc9dcb | |||
95a12a8285 | |||
9395ec96e3 | |||
3574e35635 | |||
508f1ce591 |
22
.jshintrc
Normal file
22
.jshintrc
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"browser": true,
|
||||||
|
"node": true,
|
||||||
|
"esversion": 11,
|
||||||
|
"curly": true,
|
||||||
|
"sub": true,
|
||||||
|
"bitwise": true,
|
||||||
|
"eqeqeq": true,
|
||||||
|
"forin": true,
|
||||||
|
"freeze": true,
|
||||||
|
"immed": true,
|
||||||
|
"latedef": "nofunc",
|
||||||
|
"nonbsp": true,
|
||||||
|
"nonew": true,
|
||||||
|
"plusplus": true,
|
||||||
|
"undef": true,
|
||||||
|
"unused": "vars",
|
||||||
|
"strict": true,
|
||||||
|
"maxdepth": 3,
|
||||||
|
"maxstatements": 100,
|
||||||
|
"maxcomplexity": 40
|
||||||
|
}
|
6
CHANGELOG.md
Normal file
6
CHANGELOG.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
# CHANGELOG
|
||||||
|
|
||||||
|
## v1.8.0
|
||||||
|
|
||||||
|
- add `resp.ok` - same as WHATWG fetch `resp.ok = (resp.statusCode >= 200 && resp.statusCode < 300)`
|
||||||
|
- add `resp.stream.body()` to populate `resp.body` rather than (or perhaps in addition to) continuing to stream (useful for error handling)
|
65
EXTRA.md
Normal file
65
EXTRA.md
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
# Extra
|
||||||
|
|
||||||
|
There are some niche features of @root/request which are beyond the request.js
|
||||||
|
compatibility.
|
||||||
|
|
||||||
|
## async/await & Promises
|
||||||
|
|
||||||
|
The differences in async support are explained in [README.md](/README.md), up near the top.
|
||||||
|
|
||||||
|
If you're familiar with Promises (and async/await), then it's pretty self-explanatory.
|
||||||
|
|
||||||
|
## ok
|
||||||
|
|
||||||
|
Just like WHATWG `fetch`, we have `resp.ok`:
|
||||||
|
|
||||||
|
```js
|
||||||
|
let resp = await request({
|
||||||
|
url: 'https://example.com'
|
||||||
|
}).then(mustOk);
|
||||||
|
```
|
||||||
|
|
||||||
|
```js
|
||||||
|
function mustOk(resp) {
|
||||||
|
if (!resp.ok) {
|
||||||
|
// handle error
|
||||||
|
throw new Error('BAD RESPONSE');
|
||||||
|
}
|
||||||
|
return resp;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## streams
|
||||||
|
|
||||||
|
The differences in stream support are explained in [README.md](/README.md), up near the top.
|
||||||
|
|
||||||
|
## userAgent
|
||||||
|
|
||||||
|
There's a default User-Agent string describing the version of @root/request, node.js, and the OS.
|
||||||
|
|
||||||
|
Add to the default User-Agent
|
||||||
|
|
||||||
|
```js
|
||||||
|
request({
|
||||||
|
// ...
|
||||||
|
userAgent: 'my-package/1.0' // add to agent
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace the default User-Agent
|
||||||
|
|
||||||
|
```js
|
||||||
|
request({
|
||||||
|
// ...
|
||||||
|
headers: { 'User-Agent': 'replace/0.0' }
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Disable the default User-Agent:
|
||||||
|
|
||||||
|
```js
|
||||||
|
request({
|
||||||
|
// ...
|
||||||
|
headers: { 'User-Agent': false }
|
||||||
|
});
|
||||||
|
```
|
114
README.md
114
README.md
@ -1,4 +1,4 @@
|
|||||||
# [µRequest](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
|
# [@root/request](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
|
||||||
|
|
||||||
> Minimalist HTTP client
|
> Minimalist HTTP client
|
||||||
|
|
||||||
@ -10,15 +10,17 @@ Written from scratch, with zero-dependencies.
|
|||||||
|
|
||||||
## Super simple to use
|
## Super simple to use
|
||||||
|
|
||||||
µRequest is designed to be a drop-in replacement for request. It supports HTTPS and follows redirects by default.
|
@root/request is designed to be a drop-in replacement for request. It also supports Promises and async/await by default, enhanced stream support, and a few other things as mentioned below.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save @root/request
|
npm install --save @root/request
|
||||||
|
|
||||||
|
# or npm install git+ssh://git@git.therootcompany.com/request.js
|
||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
var request = require('@root/request');
|
var request = require('@root/request');
|
||||||
request('http://www.google.com', function(error, response, body) {
|
request('http://www.google.com', function (error, response, body) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
||||||
console.log('body:', body); // Print the HTML for the Google homepage.
|
console.log('body:', body); // Print the HTML for the Google homepage.
|
||||||
@ -31,26 +33,114 @@ request('http://www.google.com', function(error, response, body) {
|
|||||||
var request = require('@root/request');
|
var request = require('@root/request');
|
||||||
|
|
||||||
request('http://www.google.com')
|
request('http://www.google.com')
|
||||||
.then(function(response) {
|
.then(function (response) {
|
||||||
console.log('statusCode:', response.statusCode); // Print the response status code if a response was received
|
console.log('statusCode:', response.statusCode); // Print the response status code if a response was received
|
||||||
console.log('body:', response.body); // Print the HTML for the Google homepage.
|
console.log('body:', response.body); // Print the HTML for the Google homepage.
|
||||||
})
|
})
|
||||||
.catch(function(error) {
|
.catch(function (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Streaming**
|
||||||
|
|
||||||
|
In order to keep this library lightweight, performant, and keep the code easy to
|
||||||
|
read, the streaming behavior is **_slightly different_** from that of
|
||||||
|
`request.js`.
|
||||||
|
|
||||||
|
```diff
|
||||||
|
-var request = require('request');
|
||||||
|
+var request = require('@root/request');
|
||||||
|
|
||||||
|
-var stream = request({ url, headers });
|
||||||
|
+var stream = await request({ url, headers });
|
||||||
|
|
||||||
|
let attachment = await new MailgunAPI.Attachment({
|
||||||
|
data: stream
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
var request = require('@root/request');
|
||||||
|
|
||||||
|
var resp = await request({
|
||||||
|
url: 'http://www.google.com',
|
||||||
|
stream: true // true | 'filename.ext' | stream.Writable
|
||||||
|
});
|
||||||
|
|
||||||
|
// 'resp' itself is a ReadableStream
|
||||||
|
resp.on('data', function () {
|
||||||
|
// got some data
|
||||||
|
});
|
||||||
|
|
||||||
|
resp.on('end', function () {
|
||||||
|
// the data has ended
|
||||||
|
});
|
||||||
|
|
||||||
|
// 'resp.stream' is a Promise that is resolved when the read stream is destroyed
|
||||||
|
await resp.stream; // returns `undefined`
|
||||||
|
console.log('Done');
|
||||||
|
```
|
||||||
|
|
||||||
|
The difference is that we don't add an extra layer of stream abstraction.
|
||||||
|
You must use the response from await, a Promise, or the callback.
|
||||||
|
|
||||||
|
You can also give a file path:
|
||||||
|
|
||||||
|
```js
|
||||||
|
request({
|
||||||
|
url: 'http://www.google.com',
|
||||||
|
stream: '/tmp/google-index.html'
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Which is equivalent to passing a write stream for the file:
|
||||||
|
|
||||||
|
```js
|
||||||
|
request({
|
||||||
|
url: 'http://www.google.com',
|
||||||
|
stream: fs.createWriteStream('/tmp/google-index.html')
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Also, `await resp.stream.body()` can be used to get back the full body (the same as if you didn't use the `stream` option:
|
||||||
|
|
||||||
|
```js
|
||||||
|
let resp = await request({
|
||||||
|
url: 'http://www.google.com',
|
||||||
|
stream: true
|
||||||
|
});
|
||||||
|
if (!resp.ok) {
|
||||||
|
await resp.stream.body();
|
||||||
|
console.error(resp.body);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
|
- [Extra Features](/EXTRA.md)
|
||||||
- [Forms](#forms)
|
- [Forms](#forms)
|
||||||
- [HTTP Authentication](#http-authentication)
|
- [HTTP Authentication](#http-authentication)
|
||||||
- [Custom HTTP Headers](#custom-http-headers)
|
- [Custom HTTP Headers](#custom-http-headers)
|
||||||
- [Unix Domain Sockets](#unix-domain-sockets)
|
- [Unix Domain Sockets](#unix-domain-sockets)
|
||||||
- [**All Available Options**](#requestoptions-callback)
|
- [**All Available Options**](#requestoptions-callback)
|
||||||
|
|
||||||
|
## Extra Features
|
||||||
|
|
||||||
|
The following are features that the original `request` did not have, but have been added for convenience in `@root/request`.
|
||||||
|
|
||||||
|
- Support for `async`/`await` & `Promise`s (as explained above)
|
||||||
|
- `request({ userAgent: 'my-api/1.1' })` (for building API clients)
|
||||||
|
- `resp.ok` (just like `fetch`)
|
||||||
|
- `resp.stream` (see above)
|
||||||
|
|
||||||
|
See [EXTRA.md](/EXTRA.md)
|
||||||
|
|
||||||
## Forms
|
## Forms
|
||||||
|
|
||||||
`urequest` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
|
`@root/request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
|
||||||
|
|
||||||
<!-- For `multipart/related` refer to the `multipart` API. -->
|
<!-- For `multipart/related` refer to the `multipart` API. -->
|
||||||
|
|
||||||
@ -63,7 +153,7 @@ request.post('http://service.com/upload', { form: { key: 'value' } });
|
|||||||
// or
|
// or
|
||||||
request.post(
|
request.post(
|
||||||
{ url: 'http://service.com/upload', form: { key: 'value' } },
|
{ url: 'http://service.com/upload', form: { key: 'value' } },
|
||||||
function(err, httpResponse, body) {
|
function (err, httpResponse, body) {
|
||||||
/* ... */
|
/* ... */
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
@ -76,12 +166,12 @@ request.post('http://service.com/upload').form({key:'value'})
|
|||||||
|
|
||||||
#### multipart/form-data (Multipart Form Uploads)
|
#### multipart/form-data (Multipart Form Uploads)
|
||||||
|
|
||||||
For `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.
|
For `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data/tree/v2.5.1) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.
|
||||||
|
|
||||||
To use `form-data`, you must install it separately:
|
To use `form-data`, you must install it separately:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save form-data@2
|
npm install --save form-data@2.x
|
||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
@ -190,7 +280,7 @@ var username = 'username',
|
|||||||
password = 'password',
|
password = 'password',
|
||||||
url = 'http://' + username + ':' + password + '@some.server.com';
|
url = 'http://' + username + ':' + password + '@some.server.com';
|
||||||
|
|
||||||
request({ url: url }, function(error, response, body) {
|
request({ url: url }, function (error, response, body) {
|
||||||
// Do more stuff with 'body' here
|
// Do more stuff with 'body' here
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
@ -245,7 +335,7 @@ request(options, callback);
|
|||||||
|
|
||||||
## UNIX Domain Sockets
|
## UNIX Domain Sockets
|
||||||
|
|
||||||
`urequest` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
|
`@root/request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
/* Pattern */ 'http://unix:SOCKET:PATH';
|
/* Pattern */ 'http://unix:SOCKET:PATH';
|
||||||
@ -361,7 +451,7 @@ These HTTP method convenience functions act just like `request()` but with a def
|
|||||||
|
|
||||||
There are at least <!--three--> two ways to debug the operation of `request`:
|
There are at least <!--three--> two ways to debug the operation of `request`:
|
||||||
|
|
||||||
1. Launch the node process like `NODE_DEBUG=urequest node script.js`
|
1. Launch the node process like `NODE_DEBUG=@root/request node script.js`
|
||||||
(`lib,request,otherlib` works too).
|
(`lib,request,otherlib` works too).
|
||||||
|
|
||||||
2. Set `require('@root/request').debug = true` at any time (this does the same thing
|
2. Set `require('@root/request').debug = true` at any time (this does the same thing
|
||||||
|
@ -5,11 +5,9 @@ var request = require('../');
|
|||||||
|
|
||||||
// will redirect to https://www.github.com and then https://github.com
|
// will redirect to https://www.github.com and then https://github.com
|
||||||
//request('http://www.github.com', function (error, response, body) {
|
//request('http://www.github.com', function (error, response, body) {
|
||||||
request({ uri: { protocol: 'http:', hostname: 'www.github.com' } }, function(
|
request(
|
||||||
error,
|
{ uri: { protocol: 'http:', hostname: 'www.github.com' } },
|
||||||
response,
|
function (error, response, body) {
|
||||||
body
|
|
||||||
) {
|
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
return;
|
return;
|
||||||
@ -17,4 +15,5 @@ request({ uri: { protocol: 'http:', hostname: 'www.github.com' } }, function(
|
|||||||
console.log('statusCode:', response.statusCode); // The final statusCode
|
console.log('statusCode:', response.statusCode); // The final statusCode
|
||||||
console.log('Final href:', response.request.uri.href); // The final URI
|
console.log('Final href:', response.request.uri.href); // The final URI
|
||||||
console.log('Body Length:', body.length); // body length
|
console.log('Body Length:', body.length); // body length
|
||||||
});
|
}
|
||||||
|
);
|
||||||
|
@ -20,7 +20,7 @@ request(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
function(error, response, body) {
|
function (error, response, body) {
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
return;
|
return;
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
//var request = require('urequest');
|
//var request = require('urequest');
|
||||||
var request = require('../');
|
var request = require('../');
|
||||||
request('https://www.google.com', function(error, response, body) {
|
request('https://www.google.com', function (error, response, body) {
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
return;
|
return;
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
//var request = require('urequest');
|
//var request = require('urequest');
|
||||||
var request = require('../');
|
var request = require('../');
|
||||||
request('http://www.google.com', function(error, response, body) {
|
request('http://www.google.com', function (error, response, body) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
||||||
console.log('body:', body); // Print the HTML for the Google homepage.
|
console.log('body:', body); // Print the HTML for the Google homepage.
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
//var request = require('urequest');
|
//var request = require('urequest');
|
||||||
var request = require('../');
|
var request = require('../');
|
||||||
request('https://www.google.com', function(error, response, body) {
|
request('https://www.google.com', function (error, response, body) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
|
||||||
console.log('body:', body); // Print the HTML for the Google homepage.
|
console.log('body:', body); // Print the HTML for the Google homepage.
|
||||||
|
@ -4,11 +4,9 @@
|
|||||||
var request = require('../');
|
var request = require('../');
|
||||||
|
|
||||||
// would normally redirect to https://www.github.com and then https://github.com
|
// would normally redirect to https://www.github.com and then https://github.com
|
||||||
request({ uri: 'https://www.github.com', followRedirect: false }, function(
|
request(
|
||||||
error,
|
{ uri: 'https://www.github.com', followRedirect: false },
|
||||||
response,
|
function (error, response, body) {
|
||||||
body
|
|
||||||
) {
|
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
return;
|
return;
|
||||||
@ -17,4 +15,5 @@ request({ uri: 'https://www.github.com', followRedirect: false }, function(
|
|||||||
console.log('statusCode:', response.statusCode); // Should be 301 or 302
|
console.log('statusCode:', response.statusCode); // Should be 301 or 302
|
||||||
console.log('Location:', response.headers.location); // The redirect
|
console.log('Location:', response.headers.location); // The redirect
|
||||||
console.log('Body:', body || JSON.stringify(body));
|
console.log('Body:', body || JSON.stringify(body));
|
||||||
});
|
}
|
||||||
|
);
|
||||||
|
@ -3,13 +3,13 @@
|
|||||||
var request = require('../');
|
var request = require('../');
|
||||||
request({
|
request({
|
||||||
url: 'https://postb.in/1588134650162-6019286897499?hello=world'
|
url: 'https://postb.in/1588134650162-6019286897499?hello=world'
|
||||||
//headers: { 'user-agent': false }
|
//headers: { 'user-agent': false } // remove
|
||||||
//headers: { 'user-agent': 'test/1.0' }
|
//headers: { 'user-agent': 'test/1.0' } // overwrite
|
||||||
//userAgent: 'test/1.1' // not presently implemented
|
//userAgent: 'test/1.1' // add to the default
|
||||||
})
|
})
|
||||||
.then(function(resp) {
|
.then(function (resp) {
|
||||||
console.log(resp.body);
|
console.log(resp.body);
|
||||||
})
|
})
|
||||||
.catch(function(err) {
|
.catch(function (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
});
|
});
|
||||||
|
27
examples/stream-to-file.js
Normal file
27
examples/stream-to-file.js
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
var request = require('../');
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
var tpath = '/tmp/google-index.html';
|
||||||
|
var resp = await request({
|
||||||
|
url: 'https://google.com',
|
||||||
|
encoding: null,
|
||||||
|
stream: tpath
|
||||||
|
});
|
||||||
|
console.log('[Response Headers]');
|
||||||
|
console.log(resp.toJSON().headers);
|
||||||
|
|
||||||
|
//console.error(resp.headers, resp.body.byteLength);
|
||||||
|
await resp.stream;
|
||||||
|
console.log('[Response Body] written to', tpath);
|
||||||
|
}
|
||||||
|
|
||||||
|
main()
|
||||||
|
.then(function () {
|
||||||
|
console.log('Pass');
|
||||||
|
})
|
||||||
|
.catch(function (e) {
|
||||||
|
console.error('Fail');
|
||||||
|
console.error(e.stack);
|
||||||
|
});
|
34
examples/stream.js
Normal file
34
examples/stream.js
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
var request = require('../');
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
var tpath = '/tmp/google-index.html';
|
||||||
|
var resp = await request({
|
||||||
|
url: 'https://google.com',
|
||||||
|
encoding: null,
|
||||||
|
stream: true
|
||||||
|
});
|
||||||
|
console.log('[Response Headers]');
|
||||||
|
console.log(resp.toJSON().headers);
|
||||||
|
|
||||||
|
resp.on('data', function (chunk) {
|
||||||
|
console.log('[Data]', chunk.byteLength);
|
||||||
|
});
|
||||||
|
resp.on('end', function (chunk) {
|
||||||
|
console.log('[End]');
|
||||||
|
});
|
||||||
|
|
||||||
|
//console.error(resp.headers, resp.body.byteLength);
|
||||||
|
await resp.stream;
|
||||||
|
console.log('[Close]');
|
||||||
|
}
|
||||||
|
|
||||||
|
main()
|
||||||
|
.then(function () {
|
||||||
|
console.log('Pass');
|
||||||
|
})
|
||||||
|
.catch(function (e) {
|
||||||
|
console.error('Fail');
|
||||||
|
console.error(e.stack);
|
||||||
|
});
|
@ -14,7 +14,7 @@ request(
|
|||||||
headers: { 'X-Foo': 'Bar' },
|
headers: { 'X-Foo': 'Bar' },
|
||||||
form: { foo: 'bar', baz: 'qux' }
|
form: { foo: 'bar', baz: 'qux' }
|
||||||
},
|
},
|
||||||
function(error, response, body) {
|
function (error, response, body) {
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log('error:', error); // Print the error if one occurred
|
console.log('error:', error); // Print the error if one occurred
|
||||||
return;
|
return;
|
||||||
|
226
index.js
226
index.js
@ -5,6 +5,7 @@ var https = require('https');
|
|||||||
var url = require('url');
|
var url = require('url');
|
||||||
var os = require('os');
|
var os = require('os');
|
||||||
var pkg = require('./package.json');
|
var pkg = require('./package.json');
|
||||||
|
var fs = require('fs'); // only for streams
|
||||||
|
|
||||||
function debug() {
|
function debug() {
|
||||||
if (module.exports.debug) {
|
if (module.exports.debug) {
|
||||||
@ -13,7 +14,7 @@ function debug() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function mergeOrDelete(defaults, updates) {
|
function mergeOrDelete(defaults, updates) {
|
||||||
Object.keys(defaults).forEach(function(key) {
|
Object.keys(defaults).forEach(function (key) {
|
||||||
if (!(key in updates)) {
|
if (!(key in updates)) {
|
||||||
updates[key] = defaults[key];
|
updates[key] = defaults[key];
|
||||||
return;
|
return;
|
||||||
@ -37,7 +38,7 @@ function mergeOrDelete(defaults, updates) {
|
|||||||
// retrieves an existing header, case-sensitive
|
// retrieves an existing header, case-sensitive
|
||||||
function getHeaderName(reqOpts, header) {
|
function getHeaderName(reqOpts, header) {
|
||||||
var headerNames = {};
|
var headerNames = {};
|
||||||
Object.keys(reqOpts.headers).forEach(function(casedName) {
|
Object.keys(reqOpts.headers).forEach(function (casedName) {
|
||||||
headerNames[casedName.toLowerCase()] = casedName;
|
headerNames[casedName.toLowerCase()] = casedName;
|
||||||
});
|
});
|
||||||
// returns the key, which in erroneous cases could be an empty string
|
// returns the key, which in erroneous cases could be an empty string
|
||||||
@ -49,11 +50,11 @@ function hasHeader(reqOpts, header) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function toJSONifier(keys) {
|
function toJSONifier(keys) {
|
||||||
return function() {
|
return function () {
|
||||||
var obj = {};
|
var obj = {};
|
||||||
var me = this;
|
var me = this;
|
||||||
|
|
||||||
keys.forEach(function(key) {
|
keys.forEach(function (key) {
|
||||||
if (me[key] && 'function' === typeof me[key].toJSON) {
|
if (me[key] && 'function' === typeof me[key].toJSON) {
|
||||||
obj[key] = me[key].toJSON();
|
obj[key] = me[key].toJSON();
|
||||||
} else {
|
} else {
|
||||||
@ -65,6 +66,102 @@ function toJSONifier(keys) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function setupPipe(resp, opts) {
|
||||||
|
// make the response await-able
|
||||||
|
var resolve;
|
||||||
|
var reject;
|
||||||
|
var p = new Promise(function (_resolve, _reject) {
|
||||||
|
resolve = _resolve;
|
||||||
|
reject = _reject;
|
||||||
|
});
|
||||||
|
|
||||||
|
// or an existing write stream
|
||||||
|
if ('function' === typeof opts.stream.pipe) {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug('[@root/request] stream piped');
|
||||||
|
}
|
||||||
|
resp.pipe(opts.stream);
|
||||||
|
}
|
||||||
|
resp.once('error', function (e) {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'error'");
|
||||||
|
console.error(e.stack);
|
||||||
|
}
|
||||||
|
resp.destroy();
|
||||||
|
if ('function' === opts.stream.destroy) {
|
||||||
|
opts.stream.destroy(e);
|
||||||
|
}
|
||||||
|
reject(e);
|
||||||
|
});
|
||||||
|
resp.once('end', function () {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'end'");
|
||||||
|
}
|
||||||
|
if ('function' === opts.stream.destroy) {
|
||||||
|
opts.stream.end();
|
||||||
|
// this will close the stream (i.e. sync to disk)
|
||||||
|
opts.stream.destroy();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
resp.once('close', function () {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'close'");
|
||||||
|
}
|
||||||
|
resolve();
|
||||||
|
});
|
||||||
|
return p;
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleResponse(resp, opts, cb) {
|
||||||
|
// body can be buffer, string, or json
|
||||||
|
if (null === opts.encoding) {
|
||||||
|
resp._body = [];
|
||||||
|
} else {
|
||||||
|
resp.body = '';
|
||||||
|
}
|
||||||
|
resp._bodyLength = 0;
|
||||||
|
resp.on('readable', function () {
|
||||||
|
var chunk;
|
||||||
|
while ((chunk = resp.read())) {
|
||||||
|
if ('string' === typeof resp.body) {
|
||||||
|
resp.body += chunk.toString(opts.encoding);
|
||||||
|
} else {
|
||||||
|
resp._body.push(chunk);
|
||||||
|
resp._bodyLength += chunk.length;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
resp.once('end', function () {
|
||||||
|
if ('string' !== typeof resp.body) {
|
||||||
|
if (1 === resp._body.length) {
|
||||||
|
resp.body = resp._body[0];
|
||||||
|
} else {
|
||||||
|
resp.body = Buffer.concat(resp._body, resp._bodyLength);
|
||||||
|
}
|
||||||
|
resp._body = null;
|
||||||
|
}
|
||||||
|
if (opts.json && 'string' === typeof resp.body) {
|
||||||
|
// TODO I would parse based on Content-Type
|
||||||
|
// but request.js doesn't do that.
|
||||||
|
try {
|
||||||
|
resp.body = JSON.parse(resp.body);
|
||||||
|
} catch (e) {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
debug('\n[urequest] resp.toJSON():');
|
||||||
|
if (module.exports.debug) {
|
||||||
|
debug(resp.toJSON());
|
||||||
|
}
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug('[@root/request] Response Body:');
|
||||||
|
console.debug(resp.body);
|
||||||
|
}
|
||||||
|
cb(null, resp, resp.body);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
function setDefaults(defs) {
|
function setDefaults(defs) {
|
||||||
defs = defs || {};
|
defs = defs || {};
|
||||||
|
|
||||||
@ -75,10 +172,23 @@ function setDefaults(defs) {
|
|||||||
var req;
|
var req;
|
||||||
var finalOpts = {};
|
var finalOpts = {};
|
||||||
|
|
||||||
|
// allow specifying a file
|
||||||
|
if ('string' === typeof opts.stream) {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug('[@root/request] creating file write stream');
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
opts.stream = fs.createWriteStream(opts.stream);
|
||||||
|
} catch (e) {
|
||||||
|
cb(e);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function onResponse(resp) {
|
function onResponse(resp) {
|
||||||
var followRedirect;
|
var followRedirect;
|
||||||
|
|
||||||
Object.keys(defs).forEach(function(key) {
|
Object.keys(defs).forEach(function (key) {
|
||||||
if (key in opts && 'undefined' !== typeof opts[key]) {
|
if (key in opts && 'undefined' !== typeof opts[key]) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@ -86,9 +196,16 @@ function setDefaults(defs) {
|
|||||||
});
|
});
|
||||||
followRedirect = opts.followRedirect;
|
followRedirect = opts.followRedirect;
|
||||||
|
|
||||||
|
// copied from WHATWG fetch
|
||||||
|
resp.ok = false;
|
||||||
|
if (resp.statusCode >= 200 && resp.statusCode < 300) {
|
||||||
|
resp.ok = true;
|
||||||
|
}
|
||||||
|
|
||||||
resp.toJSON = toJSONifier([
|
resp.toJSON = toJSONifier([
|
||||||
'statusCode',
|
'statusCode',
|
||||||
'body',
|
'body',
|
||||||
|
'ok',
|
||||||
'headers',
|
'headers',
|
||||||
'request'
|
'request'
|
||||||
]);
|
]);
|
||||||
@ -140,47 +257,20 @@ function setDefaults(defs) {
|
|||||||
return urequestHelper(opts, cb);
|
return urequestHelper(opts, cb);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (null === opts.encoding) {
|
|
||||||
resp._body = [];
|
if (opts.stream) {
|
||||||
} else {
|
resp.stream = setupPipe(resp, opts);
|
||||||
resp.body = '';
|
// can be string, buffer, or json... why not an async function too?
|
||||||
}
|
resp.stream.body = async function () {
|
||||||
resp._bodyLength = 0;
|
handleResponse(resp, opts, cb);
|
||||||
resp.on('data', function(chunk) {
|
await resp.stream;
|
||||||
if ('string' === typeof resp.body) {
|
return resp.body;
|
||||||
resp.body += chunk.toString(opts.encoding);
|
};
|
||||||
} else {
|
cb(null, resp);
|
||||||
resp._body.push(chunk);
|
return;
|
||||||
resp._bodyLength += chunk.length;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
resp.on('end', function() {
|
|
||||||
if ('string' !== typeof resp.body) {
|
|
||||||
if (1 === resp._body.length) {
|
|
||||||
resp.body = resp._body[0];
|
|
||||||
} else {
|
|
||||||
resp.body = Buffer.concat(resp._body, resp._bodyLength);
|
|
||||||
}
|
|
||||||
resp._body = null;
|
|
||||||
}
|
|
||||||
if (opts.json && 'string' === typeof resp.body) {
|
|
||||||
// TODO I would parse based on Content-Type
|
|
||||||
// but request.js doesn't do that.
|
|
||||||
try {
|
|
||||||
resp.body = JSON.parse(resp.body);
|
|
||||||
} catch (e) {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
debug('\n[urequest] resp.toJSON():');
|
handleResponse(resp, opts, cb);
|
||||||
debug(resp.toJSON());
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug('[@root/request] Response Body:');
|
|
||||||
console.debug(resp.body);
|
|
||||||
}
|
|
||||||
cb(null, resp, resp.body);
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var _body;
|
var _body;
|
||||||
@ -190,7 +280,7 @@ function setDefaults(defs) {
|
|||||||
var requester;
|
var requester;
|
||||||
|
|
||||||
if (opts.body) {
|
if (opts.body) {
|
||||||
if (true === opts.json) {
|
if (true === opts.json && 'string' !== typeof opts.body) {
|
||||||
_body = JSON.stringify(opts.body);
|
_body = JSON.stringify(opts.body);
|
||||||
} else {
|
} else {
|
||||||
_body = opts.body;
|
_body = opts.body;
|
||||||
@ -199,12 +289,12 @@ function setDefaults(defs) {
|
|||||||
_body = JSON.stringify(opts.json);
|
_body = JSON.stringify(opts.json);
|
||||||
} else if (opts.form) {
|
} else if (opts.form) {
|
||||||
_body = Object.keys(opts.form)
|
_body = Object.keys(opts.form)
|
||||||
.filter(function(key) {
|
.filter(function (key) {
|
||||||
if ('undefined' !== typeof opts.form[key]) {
|
if ('undefined' !== typeof opts.form[key]) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
.map(function(key) {
|
.map(function (key) {
|
||||||
return (
|
return (
|
||||||
encodeURIComponent(key) +
|
encodeURIComponent(key) +
|
||||||
'=' +
|
'=' +
|
||||||
@ -218,7 +308,7 @@ function setDefaults(defs) {
|
|||||||
_body = Buffer.from(_body);
|
_body = Buffer.from(_body);
|
||||||
}
|
}
|
||||||
|
|
||||||
Object.keys(opts.uri).forEach(function(key) {
|
Object.keys(opts.uri).forEach(function (key) {
|
||||||
finalOpts[key] = opts.uri[key];
|
finalOpts[key] = opts.uri[key];
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -233,8 +323,10 @@ function setDefaults(defs) {
|
|||||||
'createConnection',
|
'createConnection',
|
||||||
'timeout',
|
'timeout',
|
||||||
'setHost'
|
'setHost'
|
||||||
].forEach(function(key) {
|
].forEach(function (key) {
|
||||||
finalOpts[key] = opts.uri[key];
|
if (key in opts) {
|
||||||
|
finalOpts[key] = opts[key];
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
finalOpts.method = opts.method;
|
finalOpts.method = opts.method;
|
||||||
@ -299,7 +391,7 @@ function setDefaults(defs) {
|
|||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
form = new MyFormData();
|
form = new MyFormData();
|
||||||
Object.keys(opts.formData).forEach(function(key) {
|
Object.keys(opts.formData).forEach(function (key) {
|
||||||
function add(key, data, opts) {
|
function add(key, data, opts) {
|
||||||
if (data.value) {
|
if (data.value) {
|
||||||
opts = data.options;
|
opts = data.options;
|
||||||
@ -308,7 +400,7 @@ function setDefaults(defs) {
|
|||||||
form.append(key, data, opts);
|
form.append(key, data, opts);
|
||||||
}
|
}
|
||||||
if (Array.isArray(opts.formData[key])) {
|
if (Array.isArray(opts.formData[key])) {
|
||||||
opts.formData[key].forEach(function(data) {
|
opts.formData[key].forEach(function (data) {
|
||||||
add(key, data);
|
add(key, data);
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
@ -320,7 +412,7 @@ function setDefaults(defs) {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
formHeaders = form.getHeaders();
|
formHeaders = form.getHeaders();
|
||||||
Object.keys(formHeaders).forEach(function(header) {
|
Object.keys(formHeaders).forEach(function (header) {
|
||||||
finalOpts.headers[header] = formHeaders[header];
|
finalOpts.headers[header] = formHeaders[header];
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -346,7 +438,7 @@ function setDefaults(defs) {
|
|||||||
debug(formHeaders);
|
debug(formHeaders);
|
||||||
// generally uploads don't use Chunked Encoding (some systems have issues with it)
|
// generally uploads don't use Chunked Encoding (some systems have issues with it)
|
||||||
// and I don't want to do the work to calculate the content-lengths. This seems to work.
|
// and I don't want to do the work to calculate the content-lengths. This seems to work.
|
||||||
req = form.submit(finalOpts, function(err, resp) {
|
req = form.submit(finalOpts, function (err, resp) {
|
||||||
if (err) {
|
if (err) {
|
||||||
cb(err);
|
cb(err);
|
||||||
return;
|
return;
|
||||||
@ -372,7 +464,7 @@ function setDefaults(defs) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
req = requester.request(finalOpts, onResponse);
|
req = requester.request(finalOpts, onResponse);
|
||||||
req.on('error', cb);
|
req.once('error', cb);
|
||||||
|
|
||||||
if (_body) {
|
if (_body) {
|
||||||
debug("\n[urequest] '" + finalOpts.method + "' (request) body");
|
debug("\n[urequest] '" + finalOpts.method + "' (request) body");
|
||||||
@ -380,7 +472,7 @@ function setDefaults(defs) {
|
|||||||
if ('function' === typeof _body.pipe) {
|
if ('function' === typeof _body.pipe) {
|
||||||
// used for chunked encoding
|
// used for chunked encoding
|
||||||
_body.pipe(req);
|
_body.pipe(req);
|
||||||
_body.on('error', function(err) {
|
_body.once('error', function (err) {
|
||||||
// https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
|
// https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
|
||||||
// if the Readable stream emits an error during processing,
|
// if the Readable stream emits an error during processing,
|
||||||
// the Writable destination is not closed automatically
|
// the Writable destination is not closed automatically
|
||||||
@ -427,7 +519,7 @@ function setDefaults(defs) {
|
|||||||
opts = { url: opts };
|
opts = { url: opts };
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports._keys.forEach(function(key) {
|
module.exports._keys.forEach(function (key) {
|
||||||
if (key in opts && 'undefined' !== typeof opts[key]) {
|
if (key in opts && 'undefined' !== typeof opts[key]) {
|
||||||
reqOpts[key] = opts[key];
|
reqOpts[key] = opts[key];
|
||||||
} else if (key in defs) {
|
} else if (key in defs) {
|
||||||
@ -489,14 +581,14 @@ function setDefaults(defs) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function smartPromisify(fn) {
|
function smartPromisify(fn) {
|
||||||
return function(opts) {
|
return function (opts) {
|
||||||
var cb;
|
var cb;
|
||||||
if ('function' === typeof arguments[1]) {
|
if ('function' === typeof arguments[1]) {
|
||||||
cb = Array.prototype.slice.call(arguments)[1];
|
cb = Array.prototype.slice.call(arguments)[1];
|
||||||
return fn(opts, cb);
|
return fn(opts, cb);
|
||||||
}
|
}
|
||||||
return new Promise(function(resolve, reject) {
|
return new Promise(function (resolve, reject) {
|
||||||
fn(opts, function(err, resp) {
|
fn(opts, function (err, resp) {
|
||||||
if (err) {
|
if (err) {
|
||||||
err._response = resp;
|
err._response = resp;
|
||||||
reject(err);
|
reject(err);
|
||||||
@ -510,13 +602,13 @@ function setDefaults(defs) {
|
|||||||
|
|
||||||
var smartUrequest = smartPromisify(urequest);
|
var smartUrequest = smartPromisify(urequest);
|
||||||
|
|
||||||
smartUrequest.defaults = function(_defs) {
|
smartUrequest.defaults = function (_defs) {
|
||||||
_defs = mergeOrDelete(defs, _defs);
|
_defs = mergeOrDelete(defs, _defs);
|
||||||
return setDefaults(_defs);
|
return setDefaults(_defs);
|
||||||
};
|
};
|
||||||
['get', 'put', 'post', 'patch', 'delete', 'head', 'options'].forEach(
|
['get', 'put', 'post', 'patch', 'delete', 'head', 'options'].forEach(
|
||||||
function(method) {
|
function (method) {
|
||||||
smartUrequest[method] = smartPromisify(function(obj, cb) {
|
smartUrequest[method] = smartPromisify(function (obj, cb) {
|
||||||
if ('string' === typeof obj) {
|
if ('string' === typeof obj) {
|
||||||
obj = { url: obj };
|
obj = { url: obj };
|
||||||
}
|
}
|
||||||
@ -568,7 +660,8 @@ var _defaults = {
|
|||||||
followOriginalHttpMethod: false,
|
followOriginalHttpMethod: false,
|
||||||
maxRedirects: 10,
|
maxRedirects: 10,
|
||||||
removeRefererHeader: false,
|
removeRefererHeader: false,
|
||||||
//, encoding: undefined
|
// encoding: undefined,
|
||||||
|
// stream: false, // TODO allow a stream?
|
||||||
gzip: false
|
gzip: false
|
||||||
//, body: undefined
|
//, body: undefined
|
||||||
//, json: undefined
|
//, json: undefined
|
||||||
@ -577,13 +670,14 @@ module.exports = setDefaults(_defaults);
|
|||||||
|
|
||||||
module.exports._keys = Object.keys(_defaults).concat([
|
module.exports._keys = Object.keys(_defaults).concat([
|
||||||
'encoding',
|
'encoding',
|
||||||
|
'stream',
|
||||||
'body',
|
'body',
|
||||||
'json',
|
'json',
|
||||||
'form',
|
'form',
|
||||||
'auth',
|
'auth',
|
||||||
'formData',
|
'formData',
|
||||||
'FormData'
|
'FormData',
|
||||||
//'userAgent'
|
'userAgent' // non-standard for request.js
|
||||||
]);
|
]);
|
||||||
module.exports.debug =
|
module.exports.debug =
|
||||||
-1 !== (process.env.NODE_DEBUG || '').split(/\s+/g).indexOf('urequest');
|
-1 !== (process.env.NODE_DEBUG || '').split(/\s+/g).indexOf('urequest');
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "@root/request",
|
"name": "@root/request",
|
||||||
"version": "1.5.0",
|
"version": "1.8.2",
|
||||||
"lockfileVersion": 1
|
"lockfileVersion": 1
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@root/request",
|
"name": "@root/request",
|
||||||
"version": "1.6.0",
|
"version": "1.8.2",
|
||||||
"description": "A lightweight, zero-dependency drop-in replacement for request",
|
"description": "A lightweight, zero-dependency drop-in replacement for request",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"files": [
|
"files": [
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
var net = require('net');
|
var net = require('net');
|
||||||
var server = net.createServer(function(socket) {
|
var server = net.createServer(function (socket) {
|
||||||
socket.on('data', function(chunk) {
|
socket.on('data', function (chunk) {
|
||||||
console.info(chunk.toString('utf8'));
|
console.info(chunk.toString('utf8'));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
server.listen(3007, function() {
|
server.listen(3007, function () {
|
||||||
console.info('Listening on', this.address());
|
console.info('Listening on', this.address());
|
||||||
});
|
});
|
||||||
|
Loading…
x
Reference in New Issue
Block a user