mirror of
https://github.com/crazy-max/ghaction-upx.git
synced 2025-12-09 22:40:42 -07:00
Update node_modules
This commit is contained in:
92
node_modules/got/errors.js
generated
vendored
Normal file
92
node_modules/got/errors.js
generated
vendored
Normal file
@@ -0,0 +1,92 @@
|
||||
'use strict';
|
||||
const urlLib = require('url');
|
||||
const http = require('http');
|
||||
const PCancelable = require('p-cancelable');
|
||||
const is = require('@sindresorhus/is');
|
||||
|
||||
class GotError extends Error {
|
||||
constructor(message, error, opts) {
|
||||
super(message);
|
||||
Error.captureStackTrace(this, this.constructor);
|
||||
this.name = 'GotError';
|
||||
|
||||
if (!is.undefined(error.code)) {
|
||||
this.code = error.code;
|
||||
}
|
||||
|
||||
Object.assign(this, {
|
||||
host: opts.host,
|
||||
hostname: opts.hostname,
|
||||
method: opts.method,
|
||||
path: opts.path,
|
||||
protocol: opts.protocol,
|
||||
url: opts.href
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
module.exports.GotError = GotError;
|
||||
|
||||
module.exports.CacheError = class extends GotError {
|
||||
constructor(error, opts) {
|
||||
super(error.message, error, opts);
|
||||
this.name = 'CacheError';
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.RequestError = class extends GotError {
|
||||
constructor(error, opts) {
|
||||
super(error.message, error, opts);
|
||||
this.name = 'RequestError';
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.ReadError = class extends GotError {
|
||||
constructor(error, opts) {
|
||||
super(error.message, error, opts);
|
||||
this.name = 'ReadError';
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.ParseError = class extends GotError {
|
||||
constructor(error, statusCode, opts, data) {
|
||||
super(`${error.message} in "${urlLib.format(opts)}": \n${data.slice(0, 77)}...`, error, opts);
|
||||
this.name = 'ParseError';
|
||||
this.statusCode = statusCode;
|
||||
this.statusMessage = http.STATUS_CODES[this.statusCode];
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.HTTPError = class extends GotError {
|
||||
constructor(statusCode, statusMessage, headers, opts) {
|
||||
if (statusMessage) {
|
||||
statusMessage = statusMessage.replace(/\r?\n/g, ' ').trim();
|
||||
} else {
|
||||
statusMessage = http.STATUS_CODES[statusCode];
|
||||
}
|
||||
super(`Response code ${statusCode} (${statusMessage})`, {}, opts);
|
||||
this.name = 'HTTPError';
|
||||
this.statusCode = statusCode;
|
||||
this.statusMessage = statusMessage;
|
||||
this.headers = headers;
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.MaxRedirectsError = class extends GotError {
|
||||
constructor(statusCode, redirectUrls, opts) {
|
||||
super('Redirected 10 times. Aborting.', {}, opts);
|
||||
this.name = 'MaxRedirectsError';
|
||||
this.statusCode = statusCode;
|
||||
this.statusMessage = http.STATUS_CODES[this.statusCode];
|
||||
this.redirectUrls = redirectUrls;
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.UnsupportedProtocolError = class extends GotError {
|
||||
constructor(opts) {
|
||||
super(`Unsupported protocol "${opts.protocol}"`, {}, opts);
|
||||
this.name = 'UnsupportedProtocolError';
|
||||
}
|
||||
};
|
||||
|
||||
module.exports.CancelError = PCancelable.CancelError;
|
||||
675
node_modules/got/index.js
generated
vendored
Normal file
675
node_modules/got/index.js
generated
vendored
Normal file
@@ -0,0 +1,675 @@
|
||||
'use strict';
|
||||
const EventEmitter = require('events');
|
||||
const http = require('http');
|
||||
const https = require('https');
|
||||
const PassThrough = require('stream').PassThrough;
|
||||
const Transform = require('stream').Transform;
|
||||
const urlLib = require('url');
|
||||
const fs = require('fs');
|
||||
const querystring = require('querystring');
|
||||
const CacheableRequest = require('cacheable-request');
|
||||
const duplexer3 = require('duplexer3');
|
||||
const intoStream = require('into-stream');
|
||||
const is = require('@sindresorhus/is');
|
||||
const getStream = require('get-stream');
|
||||
const timedOut = require('timed-out');
|
||||
const urlParseLax = require('url-parse-lax');
|
||||
const urlToOptions = require('url-to-options');
|
||||
const lowercaseKeys = require('lowercase-keys');
|
||||
const decompressResponse = require('decompress-response');
|
||||
const mimicResponse = require('mimic-response');
|
||||
const isRetryAllowed = require('is-retry-allowed');
|
||||
const isURL = require('isurl');
|
||||
const PCancelable = require('p-cancelable');
|
||||
const pTimeout = require('p-timeout');
|
||||
const pify = require('pify');
|
||||
const Buffer = require('safe-buffer').Buffer;
|
||||
const pkg = require('./package.json');
|
||||
const errors = require('./errors');
|
||||
|
||||
const getMethodRedirectCodes = new Set([300, 301, 302, 303, 304, 305, 307, 308]);
|
||||
const allMethodRedirectCodes = new Set([300, 303, 307, 308]);
|
||||
|
||||
const isFormData = body => is.nodeStream(body) && is.function(body.getBoundary);
|
||||
|
||||
const getBodySize = opts => {
|
||||
const body = opts.body;
|
||||
|
||||
if (opts.headers['content-length']) {
|
||||
return Number(opts.headers['content-length']);
|
||||
}
|
||||
|
||||
if (!body && !opts.stream) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (is.string(body)) {
|
||||
return Buffer.byteLength(body);
|
||||
}
|
||||
|
||||
if (isFormData(body)) {
|
||||
return pify(body.getLength.bind(body))();
|
||||
}
|
||||
|
||||
if (body instanceof fs.ReadStream) {
|
||||
return pify(fs.stat)(body.path).then(stat => stat.size);
|
||||
}
|
||||
|
||||
if (is.nodeStream(body) && is.buffer(body._buffer)) {
|
||||
return body._buffer.length;
|
||||
}
|
||||
|
||||
return null;
|
||||
};
|
||||
|
||||
function requestAsEventEmitter(opts) {
|
||||
opts = opts || {};
|
||||
|
||||
const ee = new EventEmitter();
|
||||
const requestUrl = opts.href || urlLib.resolve(urlLib.format(opts), opts.path);
|
||||
const redirects = [];
|
||||
const agents = is.object(opts.agent) ? opts.agent : null;
|
||||
let retryCount = 0;
|
||||
let redirectUrl;
|
||||
let uploadBodySize;
|
||||
let uploaded = 0;
|
||||
|
||||
const get = opts => {
|
||||
if (opts.protocol !== 'http:' && opts.protocol !== 'https:') {
|
||||
ee.emit('error', new got.UnsupportedProtocolError(opts));
|
||||
return;
|
||||
}
|
||||
|
||||
let fn = opts.protocol === 'https:' ? https : http;
|
||||
|
||||
if (agents) {
|
||||
const protocolName = opts.protocol === 'https:' ? 'https' : 'http';
|
||||
opts.agent = agents[protocolName] || opts.agent;
|
||||
}
|
||||
|
||||
if (opts.useElectronNet && process.versions.electron) {
|
||||
const electron = require('electron');
|
||||
fn = electron.net || electron.remote.net;
|
||||
}
|
||||
|
||||
let progressInterval;
|
||||
|
||||
const cacheableRequest = new CacheableRequest(fn.request, opts.cache);
|
||||
const cacheReq = cacheableRequest(opts, res => {
|
||||
clearInterval(progressInterval);
|
||||
|
||||
ee.emit('uploadProgress', {
|
||||
percent: 1,
|
||||
transferred: uploaded,
|
||||
total: uploadBodySize
|
||||
});
|
||||
|
||||
const statusCode = res.statusCode;
|
||||
|
||||
res.url = redirectUrl || requestUrl;
|
||||
res.requestUrl = requestUrl;
|
||||
|
||||
const followRedirect = opts.followRedirect && 'location' in res.headers;
|
||||
const redirectGet = followRedirect && getMethodRedirectCodes.has(statusCode);
|
||||
const redirectAll = followRedirect && allMethodRedirectCodes.has(statusCode);
|
||||
|
||||
if (redirectAll || (redirectGet && (opts.method === 'GET' || opts.method === 'HEAD'))) {
|
||||
res.resume();
|
||||
|
||||
if (statusCode === 303) {
|
||||
// Server responded with "see other", indicating that the resource exists at another location,
|
||||
// and the client should request it from that location via GET or HEAD.
|
||||
opts.method = 'GET';
|
||||
}
|
||||
|
||||
if (redirects.length >= 10) {
|
||||
ee.emit('error', new got.MaxRedirectsError(statusCode, redirects, opts), null, res);
|
||||
return;
|
||||
}
|
||||
|
||||
const bufferString = Buffer.from(res.headers.location, 'binary').toString();
|
||||
|
||||
redirectUrl = urlLib.resolve(urlLib.format(opts), bufferString);
|
||||
|
||||
redirects.push(redirectUrl);
|
||||
|
||||
const redirectOpts = Object.assign({}, opts, urlLib.parse(redirectUrl));
|
||||
|
||||
ee.emit('redirect', res, redirectOpts);
|
||||
|
||||
get(redirectOpts);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
setImmediate(() => {
|
||||
try {
|
||||
getResponse(res, opts, ee, redirects);
|
||||
} catch (e) {
|
||||
ee.emit('error', e);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
cacheReq.on('error', err => {
|
||||
if (err instanceof CacheableRequest.RequestError) {
|
||||
ee.emit('error', new got.RequestError(err, opts));
|
||||
} else {
|
||||
ee.emit('error', new got.CacheError(err, opts));
|
||||
}
|
||||
});
|
||||
|
||||
cacheReq.once('request', req => {
|
||||
let aborted = false;
|
||||
req.once('abort', _ => {
|
||||
aborted = true;
|
||||
});
|
||||
|
||||
req.once('error', err => {
|
||||
clearInterval(progressInterval);
|
||||
|
||||
if (aborted) {
|
||||
return;
|
||||
}
|
||||
|
||||
const backoff = opts.retries(++retryCount, err);
|
||||
|
||||
if (backoff) {
|
||||
setTimeout(get, backoff, opts);
|
||||
return;
|
||||
}
|
||||
|
||||
ee.emit('error', new got.RequestError(err, opts));
|
||||
});
|
||||
|
||||
ee.once('request', req => {
|
||||
ee.emit('uploadProgress', {
|
||||
percent: 0,
|
||||
transferred: 0,
|
||||
total: uploadBodySize
|
||||
});
|
||||
|
||||
const socket = req.connection;
|
||||
if (socket) {
|
||||
// `._connecting` was the old property which was made public in node v6.1.0
|
||||
const isConnecting = socket.connecting === undefined ? socket._connecting : socket.connecting;
|
||||
|
||||
const onSocketConnect = () => {
|
||||
const uploadEventFrequency = 150;
|
||||
|
||||
progressInterval = setInterval(() => {
|
||||
if (socket.destroyed) {
|
||||
clearInterval(progressInterval);
|
||||
return;
|
||||
}
|
||||
|
||||
const lastUploaded = uploaded;
|
||||
const headersSize = req._header ? Buffer.byteLength(req._header) : 0;
|
||||
uploaded = socket.bytesWritten - headersSize;
|
||||
|
||||
// Prevent the known issue of `bytesWritten` being larger than body size
|
||||
if (uploadBodySize && uploaded > uploadBodySize) {
|
||||
uploaded = uploadBodySize;
|
||||
}
|
||||
|
||||
// Don't emit events with unchanged progress and
|
||||
// prevent last event from being emitted, because
|
||||
// it's emitted when `response` is emitted
|
||||
if (uploaded === lastUploaded || uploaded === uploadBodySize) {
|
||||
return;
|
||||
}
|
||||
|
||||
ee.emit('uploadProgress', {
|
||||
percent: uploadBodySize ? uploaded / uploadBodySize : 0,
|
||||
transferred: uploaded,
|
||||
total: uploadBodySize
|
||||
});
|
||||
}, uploadEventFrequency);
|
||||
};
|
||||
|
||||
// Only subscribe to 'connect' event if we're actually connecting a new
|
||||
// socket, otherwise if we're already connected (because this is a
|
||||
// keep-alive connection) do not bother. This is important since we won't
|
||||
// get a 'connect' event for an already connected socket.
|
||||
if (isConnecting) {
|
||||
socket.once('connect', onSocketConnect);
|
||||
} else {
|
||||
onSocketConnect();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if (opts.gotTimeout) {
|
||||
clearInterval(progressInterval);
|
||||
timedOut(req, opts.gotTimeout);
|
||||
}
|
||||
|
||||
setImmediate(() => {
|
||||
ee.emit('request', req);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
setImmediate(() => {
|
||||
Promise.resolve(getBodySize(opts))
|
||||
.then(size => {
|
||||
uploadBodySize = size;
|
||||
|
||||
if (
|
||||
is.undefined(opts.headers['content-length']) &&
|
||||
is.undefined(opts.headers['transfer-encoding']) &&
|
||||
isFormData(opts.body)
|
||||
) {
|
||||
opts.headers['content-length'] = size;
|
||||
}
|
||||
|
||||
get(opts);
|
||||
})
|
||||
.catch(err => {
|
||||
ee.emit('error', err);
|
||||
});
|
||||
});
|
||||
|
||||
return ee;
|
||||
}
|
||||
|
||||
function getResponse(res, opts, ee, redirects) {
|
||||
const downloadBodySize = Number(res.headers['content-length']) || null;
|
||||
let downloaded = 0;
|
||||
|
||||
const progressStream = new Transform({
|
||||
transform(chunk, encoding, callback) {
|
||||
downloaded += chunk.length;
|
||||
|
||||
const percent = downloadBodySize ? downloaded / downloadBodySize : 0;
|
||||
|
||||
// Let flush() be responsible for emitting the last event
|
||||
if (percent < 1) {
|
||||
ee.emit('downloadProgress', {
|
||||
percent,
|
||||
transferred: downloaded,
|
||||
total: downloadBodySize
|
||||
});
|
||||
}
|
||||
|
||||
callback(null, chunk);
|
||||
},
|
||||
|
||||
flush(callback) {
|
||||
ee.emit('downloadProgress', {
|
||||
percent: 1,
|
||||
transferred: downloaded,
|
||||
total: downloadBodySize
|
||||
});
|
||||
|
||||
callback();
|
||||
}
|
||||
});
|
||||
|
||||
mimicResponse(res, progressStream);
|
||||
progressStream.redirectUrls = redirects;
|
||||
|
||||
const response = opts.decompress === true &&
|
||||
is.function(decompressResponse) &&
|
||||
opts.method !== 'HEAD' ? decompressResponse(progressStream) : progressStream;
|
||||
|
||||
if (!opts.decompress && ['gzip', 'deflate'].indexOf(res.headers['content-encoding']) !== -1) {
|
||||
opts.encoding = null;
|
||||
}
|
||||
|
||||
ee.emit('response', response);
|
||||
|
||||
ee.emit('downloadProgress', {
|
||||
percent: 0,
|
||||
transferred: 0,
|
||||
total: downloadBodySize
|
||||
});
|
||||
|
||||
res.pipe(progressStream);
|
||||
}
|
||||
|
||||
function asPromise(opts) {
|
||||
const timeoutFn = requestPromise => opts.gotTimeout && opts.gotTimeout.request ?
|
||||
pTimeout(requestPromise, opts.gotTimeout.request, new got.RequestError({message: 'Request timed out', code: 'ETIMEDOUT'}, opts)) :
|
||||
requestPromise;
|
||||
|
||||
const proxy = new EventEmitter();
|
||||
|
||||
const cancelable = new PCancelable((resolve, reject, onCancel) => {
|
||||
const ee = requestAsEventEmitter(opts);
|
||||
let cancelOnRequest = false;
|
||||
|
||||
onCancel(() => {
|
||||
cancelOnRequest = true;
|
||||
});
|
||||
|
||||
ee.on('request', req => {
|
||||
if (cancelOnRequest) {
|
||||
req.abort();
|
||||
}
|
||||
|
||||
onCancel(() => {
|
||||
req.abort();
|
||||
});
|
||||
|
||||
if (is.nodeStream(opts.body)) {
|
||||
opts.body.pipe(req);
|
||||
opts.body = undefined;
|
||||
return;
|
||||
}
|
||||
|
||||
req.end(opts.body);
|
||||
});
|
||||
|
||||
ee.on('response', res => {
|
||||
const stream = is.null(opts.encoding) ? getStream.buffer(res) : getStream(res, opts);
|
||||
|
||||
stream
|
||||
.catch(err => reject(new got.ReadError(err, opts)))
|
||||
.then(data => {
|
||||
const statusCode = res.statusCode;
|
||||
const limitStatusCode = opts.followRedirect ? 299 : 399;
|
||||
|
||||
res.body = data;
|
||||
|
||||
if (opts.json && res.body) {
|
||||
try {
|
||||
res.body = JSON.parse(res.body);
|
||||
} catch (err) {
|
||||
if (statusCode >= 200 && statusCode < 300) {
|
||||
throw new got.ParseError(err, statusCode, opts, data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (opts.throwHttpErrors && statusCode !== 304 && (statusCode < 200 || statusCode > limitStatusCode)) {
|
||||
throw new got.HTTPError(statusCode, res.statusMessage, res.headers, opts);
|
||||
}
|
||||
|
||||
resolve(res);
|
||||
})
|
||||
.catch(err => {
|
||||
Object.defineProperty(err, 'response', {value: res});
|
||||
reject(err);
|
||||
});
|
||||
});
|
||||
|
||||
ee.once('error', reject);
|
||||
ee.on('redirect', proxy.emit.bind(proxy, 'redirect'));
|
||||
ee.on('uploadProgress', proxy.emit.bind(proxy, 'uploadProgress'));
|
||||
ee.on('downloadProgress', proxy.emit.bind(proxy, 'downloadProgress'));
|
||||
});
|
||||
|
||||
// Preserve backwards-compatibility
|
||||
// TODO: Remove this in the next major version
|
||||
Object.defineProperty(cancelable, 'canceled', {
|
||||
get() {
|
||||
return cancelable.isCanceled;
|
||||
}
|
||||
});
|
||||
|
||||
const promise = timeoutFn(cancelable);
|
||||
|
||||
promise.cancel = cancelable.cancel.bind(cancelable);
|
||||
|
||||
promise.on = (name, fn) => {
|
||||
proxy.on(name, fn);
|
||||
return promise;
|
||||
};
|
||||
|
||||
return promise;
|
||||
}
|
||||
|
||||
function asStream(opts) {
|
||||
opts.stream = true;
|
||||
|
||||
const input = new PassThrough();
|
||||
const output = new PassThrough();
|
||||
const proxy = duplexer3(input, output);
|
||||
let timeout;
|
||||
|
||||
if (opts.gotTimeout && opts.gotTimeout.request) {
|
||||
timeout = setTimeout(() => {
|
||||
proxy.emit('error', new got.RequestError({message: 'Request timed out', code: 'ETIMEDOUT'}, opts));
|
||||
}, opts.gotTimeout.request);
|
||||
}
|
||||
|
||||
if (opts.json) {
|
||||
throw new Error('Got can not be used as a stream when the `json` option is used');
|
||||
}
|
||||
|
||||
if (opts.body) {
|
||||
proxy.write = () => {
|
||||
throw new Error('Got\'s stream is not writable when the `body` option is used');
|
||||
};
|
||||
}
|
||||
|
||||
const ee = requestAsEventEmitter(opts);
|
||||
|
||||
ee.on('request', req => {
|
||||
proxy.emit('request', req);
|
||||
|
||||
if (is.nodeStream(opts.body)) {
|
||||
opts.body.pipe(req);
|
||||
return;
|
||||
}
|
||||
|
||||
if (opts.body) {
|
||||
req.end(opts.body);
|
||||
return;
|
||||
}
|
||||
|
||||
if (opts.method === 'POST' || opts.method === 'PUT' || opts.method === 'PATCH') {
|
||||
input.pipe(req);
|
||||
return;
|
||||
}
|
||||
|
||||
req.end();
|
||||
});
|
||||
|
||||
ee.on('response', res => {
|
||||
clearTimeout(timeout);
|
||||
|
||||
const statusCode = res.statusCode;
|
||||
|
||||
res.on('error', err => {
|
||||
proxy.emit('error', new got.ReadError(err, opts));
|
||||
});
|
||||
|
||||
res.pipe(output);
|
||||
|
||||
if (opts.throwHttpErrors && statusCode !== 304 && (statusCode < 200 || statusCode > 299)) {
|
||||
proxy.emit('error', new got.HTTPError(statusCode, res.statusMessage, res.headers, opts), null, res);
|
||||
return;
|
||||
}
|
||||
|
||||
proxy.emit('response', res);
|
||||
});
|
||||
|
||||
ee.on('error', proxy.emit.bind(proxy, 'error'));
|
||||
ee.on('redirect', proxy.emit.bind(proxy, 'redirect'));
|
||||
ee.on('uploadProgress', proxy.emit.bind(proxy, 'uploadProgress'));
|
||||
ee.on('downloadProgress', proxy.emit.bind(proxy, 'downloadProgress'));
|
||||
|
||||
return proxy;
|
||||
}
|
||||
|
||||
function normalizeArguments(url, opts) {
|
||||
if (!is.string(url) && !is.object(url)) {
|
||||
throw new TypeError(`Parameter \`url\` must be a string or object, not ${is(url)}`);
|
||||
} else if (is.string(url)) {
|
||||
url = url.replace(/^unix:/, 'http://$&');
|
||||
|
||||
try {
|
||||
decodeURI(url);
|
||||
} catch (err) {
|
||||
throw new Error('Parameter `url` must contain valid UTF-8 character sequences');
|
||||
}
|
||||
|
||||
url = urlParseLax(url);
|
||||
if (url.auth) {
|
||||
throw new Error('Basic authentication must be done with the `auth` option');
|
||||
}
|
||||
} else if (isURL.lenient(url)) {
|
||||
url = urlToOptions(url);
|
||||
}
|
||||
|
||||
opts = Object.assign(
|
||||
{
|
||||
path: '',
|
||||
retries: 2,
|
||||
cache: false,
|
||||
decompress: true,
|
||||
useElectronNet: false,
|
||||
throwHttpErrors: true
|
||||
},
|
||||
url,
|
||||
{
|
||||
protocol: url.protocol || 'http:' // Override both null/undefined with default protocol
|
||||
},
|
||||
opts
|
||||
);
|
||||
|
||||
const headers = lowercaseKeys(opts.headers);
|
||||
for (const key of Object.keys(headers)) {
|
||||
if (is.nullOrUndefined(headers[key])) {
|
||||
delete headers[key];
|
||||
}
|
||||
}
|
||||
|
||||
opts.headers = Object.assign({
|
||||
'user-agent': `${pkg.name}/${pkg.version} (https://github.com/sindresorhus/got)`
|
||||
}, headers);
|
||||
|
||||
if (opts.decompress && is.undefined(opts.headers['accept-encoding'])) {
|
||||
opts.headers['accept-encoding'] = 'gzip, deflate';
|
||||
}
|
||||
|
||||
const query = opts.query;
|
||||
|
||||
if (query) {
|
||||
if (!is.string(query)) {
|
||||
opts.query = querystring.stringify(query);
|
||||
}
|
||||
|
||||
opts.path = `${opts.path.split('?')[0]}?${opts.query}`;
|
||||
delete opts.query;
|
||||
}
|
||||
|
||||
if (opts.json && is.undefined(opts.headers.accept)) {
|
||||
opts.headers.accept = 'application/json';
|
||||
}
|
||||
|
||||
const body = opts.body;
|
||||
if (is.nullOrUndefined(body)) {
|
||||
opts.method = (opts.method || 'GET').toUpperCase();
|
||||
} else {
|
||||
const headers = opts.headers;
|
||||
if (!is.nodeStream(body) && !is.string(body) && !is.buffer(body) && !(opts.form || opts.json)) {
|
||||
throw new TypeError('The `body` option must be a stream.Readable, string, Buffer or plain Object');
|
||||
}
|
||||
|
||||
const canBodyBeStringified = is.plainObject(body) || is.array(body);
|
||||
if ((opts.form || opts.json) && !canBodyBeStringified) {
|
||||
throw new TypeError('The `body` option must be a plain Object or Array when the `form` or `json` option is used');
|
||||
}
|
||||
|
||||
if (isFormData(body)) {
|
||||
// Special case for https://github.com/form-data/form-data
|
||||
headers['content-type'] = headers['content-type'] || `multipart/form-data; boundary=${body.getBoundary()}`;
|
||||
} else if (opts.form && canBodyBeStringified) {
|
||||
headers['content-type'] = headers['content-type'] || 'application/x-www-form-urlencoded';
|
||||
opts.body = querystring.stringify(body);
|
||||
} else if (opts.json && canBodyBeStringified) {
|
||||
headers['content-type'] = headers['content-type'] || 'application/json';
|
||||
opts.body = JSON.stringify(body);
|
||||
}
|
||||
|
||||
if (is.undefined(headers['content-length']) && is.undefined(headers['transfer-encoding']) && !is.nodeStream(body)) {
|
||||
const length = is.string(opts.body) ? Buffer.byteLength(opts.body) : opts.body.length;
|
||||
headers['content-length'] = length;
|
||||
}
|
||||
|
||||
// Convert buffer to stream to receive upload progress events
|
||||
// see https://github.com/sindresorhus/got/pull/322
|
||||
if (is.buffer(body)) {
|
||||
opts.body = intoStream(body);
|
||||
opts.body._buffer = body;
|
||||
}
|
||||
|
||||
opts.method = (opts.method || 'POST').toUpperCase();
|
||||
}
|
||||
|
||||
if (opts.hostname === 'unix') {
|
||||
const matches = /(.+?):(.+)/.exec(opts.path);
|
||||
|
||||
if (matches) {
|
||||
opts.socketPath = matches[1];
|
||||
opts.path = matches[2];
|
||||
opts.host = null;
|
||||
}
|
||||
}
|
||||
|
||||
if (!is.function(opts.retries)) {
|
||||
const retries = opts.retries;
|
||||
|
||||
opts.retries = (iter, err) => {
|
||||
if (iter > retries || !isRetryAllowed(err)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
const noise = Math.random() * 100;
|
||||
|
||||
return ((1 << iter) * 1000) + noise;
|
||||
};
|
||||
}
|
||||
|
||||
if (is.undefined(opts.followRedirect)) {
|
||||
opts.followRedirect = true;
|
||||
}
|
||||
|
||||
if (opts.timeout) {
|
||||
if (is.number(opts.timeout)) {
|
||||
opts.gotTimeout = {request: opts.timeout};
|
||||
} else {
|
||||
opts.gotTimeout = opts.timeout;
|
||||
}
|
||||
delete opts.timeout;
|
||||
}
|
||||
|
||||
return opts;
|
||||
}
|
||||
|
||||
function got(url, opts) {
|
||||
try {
|
||||
const normalizedArgs = normalizeArguments(url, opts);
|
||||
|
||||
if (normalizedArgs.stream) {
|
||||
return asStream(normalizedArgs);
|
||||
}
|
||||
|
||||
return asPromise(normalizedArgs);
|
||||
} catch (err) {
|
||||
return Promise.reject(err);
|
||||
}
|
||||
}
|
||||
|
||||
got.stream = (url, opts) => asStream(normalizeArguments(url, opts));
|
||||
|
||||
const methods = [
|
||||
'get',
|
||||
'post',
|
||||
'put',
|
||||
'patch',
|
||||
'head',
|
||||
'delete'
|
||||
];
|
||||
|
||||
for (const method of methods) {
|
||||
got[method] = (url, opts) => got(url, Object.assign({}, opts, {method}));
|
||||
got.stream[method] = (url, opts) => got.stream(url, Object.assign({}, opts, {method}));
|
||||
}
|
||||
|
||||
Object.assign(got, errors);
|
||||
|
||||
module.exports = got;
|
||||
9
node_modules/got/license
generated
vendored
Normal file
9
node_modules/got/license
generated
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
130
node_modules/got/package.json
generated
vendored
Normal file
130
node_modules/got/package.json
generated
vendored
Normal file
@@ -0,0 +1,130 @@
|
||||
{
|
||||
"_args": [
|
||||
[
|
||||
"got@8.3.2",
|
||||
"/home/runner/work/ghaction-upx/ghaction-upx"
|
||||
]
|
||||
],
|
||||
"_from": "got@8.3.2",
|
||||
"_id": "got@8.3.2",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-qjUJ5U/hawxosMryILofZCkm3C84PLJS/0grRIpjAwu+Lkxxj5cxeCU25BG0/3mDSpXKTyZr8oh8wIgLaH0QCw==",
|
||||
"_location": "/got",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "version",
|
||||
"registry": true,
|
||||
"raw": "got@8.3.2",
|
||||
"name": "got",
|
||||
"escapedName": "got",
|
||||
"rawSpec": "8.3.2",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "8.3.2"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/download"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/got/-/got-8.3.2.tgz",
|
||||
"_spec": "8.3.2",
|
||||
"_where": "/home/runner/work/ghaction-upx/ghaction-upx",
|
||||
"ava": {
|
||||
"concurrency": 4
|
||||
},
|
||||
"browser": {
|
||||
"decompress-response": false,
|
||||
"electron": false
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/sindresorhus/got/issues"
|
||||
},
|
||||
"dependencies": {
|
||||
"@sindresorhus/is": "^0.7.0",
|
||||
"cacheable-request": "^2.1.1",
|
||||
"decompress-response": "^3.3.0",
|
||||
"duplexer3": "^0.1.4",
|
||||
"get-stream": "^3.0.0",
|
||||
"into-stream": "^3.1.0",
|
||||
"is-retry-allowed": "^1.1.0",
|
||||
"isurl": "^1.0.0-alpha5",
|
||||
"lowercase-keys": "^1.0.0",
|
||||
"mimic-response": "^1.0.0",
|
||||
"p-cancelable": "^0.4.0",
|
||||
"p-timeout": "^2.0.1",
|
||||
"pify": "^3.0.0",
|
||||
"safe-buffer": "^5.1.1",
|
||||
"timed-out": "^4.0.1",
|
||||
"url-parse-lax": "^3.0.0",
|
||||
"url-to-options": "^1.0.1"
|
||||
},
|
||||
"description": "Simplified HTTP requests",
|
||||
"devDependencies": {
|
||||
"ava": "^0.25.0",
|
||||
"coveralls": "^3.0.0",
|
||||
"form-data": "^2.1.1",
|
||||
"get-port": "^3.0.0",
|
||||
"nyc": "^11.0.2",
|
||||
"p-event": "^1.3.0",
|
||||
"pem": "^1.4.4",
|
||||
"proxyquire": "^1.8.0",
|
||||
"sinon": "^4.0.0",
|
||||
"slow-stream": "0.0.4",
|
||||
"tempfile": "^2.0.0",
|
||||
"tempy": "^0.2.1",
|
||||
"universal-url": "1.0.0-alpha",
|
||||
"xo": "^0.20.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"errors.js"
|
||||
],
|
||||
"homepage": "https://github.com/sindresorhus/got#readme",
|
||||
"keywords": [
|
||||
"http",
|
||||
"https",
|
||||
"get",
|
||||
"got",
|
||||
"url",
|
||||
"uri",
|
||||
"request",
|
||||
"util",
|
||||
"utility",
|
||||
"simple",
|
||||
"curl",
|
||||
"wget",
|
||||
"fetch",
|
||||
"net",
|
||||
"network",
|
||||
"electron"
|
||||
],
|
||||
"license": "MIT",
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
{
|
||||
"name": "Vsevolod Strukchinsky",
|
||||
"email": "floatdrop@gmail.com",
|
||||
"url": "github.com/floatdrop"
|
||||
},
|
||||
{
|
||||
"name": "Alexander Tesfamichael",
|
||||
"email": "alex.tesfamichael@gmail.com",
|
||||
"url": "alextes.me"
|
||||
}
|
||||
],
|
||||
"name": "got",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/sindresorhus/got.git"
|
||||
},
|
||||
"scripts": {
|
||||
"coveralls": "nyc report --reporter=text-lcov | coveralls",
|
||||
"test": "xo && nyc ava"
|
||||
},
|
||||
"version": "8.3.2"
|
||||
}
|
||||
650
node_modules/got/readme.md
generated
vendored
Normal file
650
node_modules/got/readme.md
generated
vendored
Normal file
@@ -0,0 +1,650 @@
|
||||
<div align="center">
|
||||
<br>
|
||||
<br>
|
||||
<img width="360" src="media/logo.svg" alt="Got">
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<p align="center">Huge thanks to <a href="https://moxy.studio"><img src="https://sindresorhus.com/assets/thanks/moxy-logo.svg" width="150"></a> for sponsoring me!
|
||||
</p>
|
||||
<br>
|
||||
<br>
|
||||
</div>
|
||||
|
||||
> Simplified HTTP requests
|
||||
|
||||
[](https://travis-ci.org/sindresorhus/got) [](https://coveralls.io/github/sindresorhus/got?branch=master) [](https://npmjs.com/got)
|
||||
|
||||
A nicer interface to the built-in [`http`](http://nodejs.org/api/http.html) module.
|
||||
|
||||
Created because [`request`](https://github.com/request/request) is bloated *(several megabytes!)*.
|
||||
|
||||
|
||||
## Highlights
|
||||
|
||||
- [Promise & stream API](#api)
|
||||
- [Request cancelation](#aborting-the-request)
|
||||
- [RFC compliant caching](#cache-adapters)
|
||||
- [Follows redirects](#followredirect)
|
||||
- [Retries on network failure](#retries)
|
||||
- [Progress events](#onuploadprogress-progress)
|
||||
- [Handles gzip/deflate](#decompress)
|
||||
- [Timeout handling](#timeout)
|
||||
- [Errors with metadata](#errors)
|
||||
- [JSON mode](#json)
|
||||
- [WHATWG URL support](#url)
|
||||
- [Electron support](#useelectronnet)
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install got
|
||||
```
|
||||
|
||||
<a href="https://www.patreon.com/sindresorhus">
|
||||
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
|
||||
</a>
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const response = await got('sindresorhus.com');
|
||||
console.log(response.body);
|
||||
//=> '<!doctype html> ...'
|
||||
} catch (error) {
|
||||
console.log(error.response.body);
|
||||
//=> 'Internal server error ...'
|
||||
}
|
||||
})();
|
||||
```
|
||||
|
||||
###### Streams
|
||||
|
||||
```js
|
||||
const fs = require('fs');
|
||||
const got = require('got');
|
||||
|
||||
got.stream('sindresorhus.com').pipe(fs.createWriteStream('index.html'));
|
||||
|
||||
// For POST, PUT, and PATCH methods `got.stream` returns a `stream.Writable`
|
||||
fs.createReadStream('index.html').pipe(got.stream.post('sindresorhus.com'));
|
||||
```
|
||||
|
||||
|
||||
### API
|
||||
|
||||
It's a `GET` request by default, but can be changed by using different methods or in the `options`.
|
||||
|
||||
#### got(url, [options])
|
||||
|
||||
Returns a Promise for a `response` object with a `body` property, a `url` property with the request URL or the final URL after redirects, and a `requestUrl` property with the original request URL.
|
||||
|
||||
The response object will normally be a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage), however if returned from the cache it will be a [responselike object](https://github.com/lukechilds/responselike) which behaves in the same way.
|
||||
|
||||
The response will also have a `fromCache` property set with a boolean value.
|
||||
|
||||
##### url
|
||||
|
||||
Type: `string` `Object`
|
||||
|
||||
The URL to request as simple string, a [`http.request` options](https://nodejs.org/api/http.html#http_http_request_options_callback), or a [WHATWG `URL`](https://nodejs.org/api/url.html#url_class_url).
|
||||
|
||||
Properties from `options` will override properties in the parsed `url`.
|
||||
|
||||
If no protocol is specified, it will default to `https`.
|
||||
|
||||
##### options
|
||||
|
||||
Type: `Object`
|
||||
|
||||
Any of the [`http.request`](http://nodejs.org/api/http.html#http_http_request_options_callback) options.
|
||||
|
||||
###### stream
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `false`
|
||||
|
||||
Returns a `Stream` instead of a `Promise`. This is equivalent to calling `got.stream(url, [options])`.
|
||||
|
||||
###### body
|
||||
|
||||
Type: `string` `Buffer` `stream.Readable`
|
||||
|
||||
*This is mutually exclusive with stream mode.*
|
||||
|
||||
Body that will be sent with a `POST` request.
|
||||
|
||||
If present in `options` and `options.method` is not set, `options.method` will be set to `POST`.
|
||||
|
||||
If `content-length` or `transfer-encoding` is not set in `options.headers` and `body` is a string or buffer, `content-length` will be set to the body length.
|
||||
|
||||
###### encoding
|
||||
|
||||
Type: `string` `null`<br>
|
||||
Default: `'utf8'`
|
||||
|
||||
[Encoding](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings) to be used on `setEncoding` of the response data. If `null`, the body is returned as a [`Buffer`](https://nodejs.org/api/buffer.html) (binary data).
|
||||
|
||||
###### form
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `false`
|
||||
|
||||
*This is mutually exclusive with stream mode.*
|
||||
|
||||
If set to `true` and `Content-Type` header is not set, it will be set to `application/x-www-form-urlencoded`.
|
||||
|
||||
`body` must be a plain object or array and will be stringified.
|
||||
|
||||
###### json
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `false`
|
||||
|
||||
*This is mutually exclusive with stream mode.*
|
||||
|
||||
If set to `true` and `Content-Type` header is not set, it will be set to `application/json`.
|
||||
|
||||
Parse response body with `JSON.parse` and set `accept` header to `application/json`. If used in conjunction with the `form` option, the `body` will the stringified as querystring and the response parsed as JSON.
|
||||
|
||||
`body` must be a plain object or array and will be stringified.
|
||||
|
||||
###### query
|
||||
|
||||
Type: `string` `Object`<br>
|
||||
|
||||
Query string object that will be added to the request URL. This will override the query string in `url`.
|
||||
|
||||
###### timeout
|
||||
|
||||
Type: `number` `Object`
|
||||
|
||||
Milliseconds to wait for the server to end the response before aborting request with `ETIMEDOUT` error.
|
||||
|
||||
This also accepts an object with separate `connect`, `socket`, and `request` fields for connection, socket, and entire request timeouts.
|
||||
|
||||
###### retries
|
||||
|
||||
Type: `number` `Function`<br>
|
||||
Default: `2`
|
||||
|
||||
Number of request retries when network errors happens. Delays between retries counts with function `1000 * Math.pow(2, retry) + Math.random() * 100`, where `retry` is attempt number (starts from 0).
|
||||
|
||||
Option accepts `function` with `retry` and `error` arguments. Function must return delay in milliseconds (`0` return value cancels retry).
|
||||
|
||||
**Note:** if `retries` is `number`, `ENOTFOUND` and `ENETUNREACH` error will not be retried (see full list in [`is-retry-allowed`](https://github.com/floatdrop/is-retry-allowed/blob/master/index.js#L12) module).
|
||||
|
||||
###### followRedirect
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Defines if redirect responses should be followed automatically.
|
||||
|
||||
Note that if a `303` is sent by the server in response to any request type (`POST`, `DELETE`, etc.), got will automatically
|
||||
request the resource pointed to in the location header via `GET`. This is in accordance with [the spec](https://tools.ietf.org/html/rfc7231#section-6.4.4).
|
||||
|
||||
###### decompress
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Decompress the response automatically. This will set the `accept-encoding` header to `gzip, deflate` unless you set it yourself.
|
||||
|
||||
If this is disabled, a compressed response is returned as a `Buffer`. This may be useful if you want to handle decompression yourself or stream the raw compressed data.
|
||||
|
||||
###### cache
|
||||
|
||||
Type: `Object`<br>
|
||||
Default: `false`
|
||||
|
||||
[Cache adapter instance](#cache-adapters) for storing cached data.
|
||||
|
||||
###### useElectronNet
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `false`
|
||||
|
||||
When used in Electron, Got will use [`electron.net`](https://electronjs.org/docs/api/net/) instead of the Node.js `http` module. According to the Electron docs, it should be fully compatible, but it's not entirely. See [#315](https://github.com/sindresorhus/got/issues/315).
|
||||
|
||||
###### throwHttpErrors
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Determines if a `got.HTTPError` is thrown for error responses (non-2xx status codes).
|
||||
|
||||
If this is disabled, requests that encounter an error status code will be resolved with the `response` instead of throwing. This may be useful if you are checking for resource availability and are expecting error responses.
|
||||
|
||||
#### Streams
|
||||
|
||||
#### got.stream(url, [options])
|
||||
|
||||
`stream` method will return Duplex stream with additional events:
|
||||
|
||||
##### .on('request', request)
|
||||
|
||||
`request` event to get the request object of the request.
|
||||
|
||||
**Tip**: You can use `request` event to abort request:
|
||||
|
||||
```js
|
||||
got.stream('github.com')
|
||||
.on('request', req => setTimeout(() => req.abort(), 50));
|
||||
```
|
||||
|
||||
##### .on('response', response)
|
||||
|
||||
`response` event to get the response object of the final request.
|
||||
|
||||
##### .on('redirect', response, nextOptions)
|
||||
|
||||
`redirect` event to get the response object of a redirect. The second argument is options for the next request to the redirect location.
|
||||
|
||||
##### .on('uploadProgress', progress)
|
||||
##### .on('downloadProgress', progress)
|
||||
|
||||
Progress events for uploading (sending request) and downloading (receiving response). The `progress` argument is an object like:
|
||||
|
||||
```js
|
||||
{
|
||||
percent: 0.1,
|
||||
transferred: 1024,
|
||||
total: 10240
|
||||
}
|
||||
```
|
||||
|
||||
If it's not possible to retrieve the body size (can happen when streaming), `total` will be `null`.
|
||||
|
||||
**Note**: Progress events can also be used with promises.
|
||||
|
||||
```js
|
||||
(async () => {
|
||||
const response = await got('sindresorhus.com')
|
||||
.on('downloadProgress', progress => {
|
||||
// Report download progress
|
||||
})
|
||||
.on('uploadProgress', progress => {
|
||||
// Report upload progress
|
||||
});
|
||||
|
||||
console.log(response);
|
||||
})();
|
||||
```
|
||||
|
||||
##### .on('error', error, body, response)
|
||||
|
||||
`error` event emitted in case of protocol error (like `ENOTFOUND` etc.) or status error (4xx or 5xx). The second argument is the body of the server response in case of status error. The third argument is response object.
|
||||
|
||||
#### got.get(url, [options])
|
||||
#### got.post(url, [options])
|
||||
#### got.put(url, [options])
|
||||
#### got.patch(url, [options])
|
||||
#### got.head(url, [options])
|
||||
#### got.delete(url, [options])
|
||||
|
||||
Sets `options.method` to the method name and makes a request.
|
||||
|
||||
|
||||
## Errors
|
||||
|
||||
Each error contains (if available) `statusCode`, `statusMessage`, `host`, `hostname`, `method`, `path`, `protocol` and `url` properties to make debugging easier.
|
||||
|
||||
In Promise mode, the `response` is attached to the error.
|
||||
|
||||
#### got.CacheError
|
||||
|
||||
When a cache method fails, for example if the database goes down, or there's a filesystem error.
|
||||
|
||||
#### got.RequestError
|
||||
|
||||
When a request fails. Contains a `code` property with error class code, like `ECONNREFUSED`.
|
||||
|
||||
#### got.ReadError
|
||||
|
||||
When reading from response stream fails.
|
||||
|
||||
#### got.ParseError
|
||||
|
||||
When `json` option is enabled, server response code is 2xx, and `JSON.parse` fails.
|
||||
|
||||
#### got.HTTPError
|
||||
|
||||
When server response code is not 2xx. Includes `statusCode`, `statusMessage`, and `redirectUrls` properties.
|
||||
|
||||
#### got.MaxRedirectsError
|
||||
|
||||
When server redirects you more than 10 times. Includes a `redirectUrls` property, which is an array of the URLs Got was redirected to before giving up.
|
||||
|
||||
#### got.UnsupportedProtocolError
|
||||
|
||||
When given an unsupported protocol.
|
||||
|
||||
#### got.CancelError
|
||||
|
||||
When the request is aborted with `.cancel()`.
|
||||
|
||||
|
||||
## Aborting the request
|
||||
|
||||
The promise returned by Got has a [`.cancel()`](https://github.com/sindresorhus/p-cancelable) method which, when called, aborts the request.
|
||||
|
||||
```js
|
||||
(async () => {
|
||||
const request = got(url, options);
|
||||
|
||||
…
|
||||
|
||||
// In another part of the code
|
||||
if (something) {
|
||||
request.cancel();
|
||||
}
|
||||
|
||||
…
|
||||
|
||||
try {
|
||||
await request;
|
||||
} catch (error) {
|
||||
if (request.isCanceled) { // Or `error instanceof got.CancelError`
|
||||
// Handle cancelation
|
||||
}
|
||||
|
||||
// Handle other errors
|
||||
}
|
||||
})();
|
||||
```
|
||||
|
||||
<a name="cache-adapters"></a>
|
||||
## Cache
|
||||
|
||||
Got implements [RFC 7234](http://httpwg.org/specs/rfc7234.html) compliant HTTP caching which works out of the box in memory or is easily pluggable with a wide range of storage adapters. Fresh cache entries are served directly from cache and stale cache entries are revalidated with `If-None-Match`/`If-Modified-Since` headers. You can read more about the underlying cache behaviour in the `cacheable-request` [documentation](https://github.com/lukechilds/cacheable-request).
|
||||
|
||||
You can use the JavaScript `Map` type as an in memory cache:
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const map = new Map();
|
||||
|
||||
(async () => {
|
||||
let response = await got('sindresorhus.com', {cache: map});
|
||||
console.log(response.fromCache);
|
||||
//=> false
|
||||
|
||||
response = await got('sindresorhus.com', {cache: map});
|
||||
console.log(response.fromCache);
|
||||
//=> true
|
||||
})();
|
||||
```
|
||||
|
||||
Got uses [Keyv](https://github.com/lukechilds/keyv) internally to support a wide range of storage adapters. For something more scalable you could use an [official Keyv storage adapter](https://github.com/lukechilds/keyv#official-storage-adapters):
|
||||
|
||||
```
|
||||
$ npm install @keyv/redis
|
||||
```
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const KeyvRedis = require('@keyv/redis');
|
||||
|
||||
const redis = new KeyvRedis('redis://user:pass@localhost:6379');
|
||||
|
||||
got('sindresorhus.com', {cache: redis});
|
||||
```
|
||||
|
||||
Got supports anything that follows the Map API, so it's easy to write your own storage adapter or use a third-party solution.
|
||||
|
||||
For example, the following are all valid storage adapters:
|
||||
|
||||
```js
|
||||
const storageAdapter = new Map();
|
||||
// or
|
||||
const storageAdapter = require('./my-storage-adapter');
|
||||
// or
|
||||
const QuickLRU = require('quick-lru');
|
||||
const storageAdapter = new QuickLRU({maxSize: 1000});
|
||||
|
||||
got('sindresorhus.com', {cache: storageAdapter});
|
||||
```
|
||||
|
||||
View the [Keyv docs](https://github.com/lukechilds/keyv) for more information on how to use storage adapters.
|
||||
|
||||
|
||||
## Proxies
|
||||
|
||||
You can use the [`tunnel`](https://github.com/koichik/node-tunnel) module with the `agent` option to work with proxies:
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const tunnel = require('tunnel');
|
||||
|
||||
got('sindresorhus.com', {
|
||||
agent: tunnel.httpOverHttp({
|
||||
proxy: {
|
||||
host: 'localhost'
|
||||
}
|
||||
})
|
||||
});
|
||||
```
|
||||
|
||||
If you require different agents for different protocols, you can pass a map of agents to the `agent` option. This is necessary because a request to one protocol might redirect to another. In such a scenario, `got` will switch over to the right protocol agent for you.
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const HttpAgent = require('agentkeepalive');
|
||||
const HttpsAgent = HttpAgent.HttpsAgent;
|
||||
|
||||
got('sindresorhus.com', {
|
||||
agent: {
|
||||
http: new HttpAgent(),
|
||||
https: new HttpsAgent()
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## Cookies
|
||||
|
||||
You can use the [`cookie`](https://github.com/jshttp/cookie) module to include cookies in a request:
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const cookie = require('cookie');
|
||||
|
||||
got('google.com', {
|
||||
headers: {
|
||||
cookie: cookie.serialize('foo', 'bar')
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## Form data
|
||||
|
||||
You can use the [`form-data`](https://github.com/form-data/form-data) module to create POST request with form data:
|
||||
|
||||
```js
|
||||
const fs = require('fs');
|
||||
const got = require('got');
|
||||
const FormData = require('form-data');
|
||||
const form = new FormData();
|
||||
|
||||
form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
|
||||
|
||||
got.post('google.com', {
|
||||
body: form
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## OAuth
|
||||
|
||||
You can use the [`oauth-1.0a`](https://github.com/ddo/oauth-1.0a) module to create a signed OAuth request:
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const crypto = require('crypto');
|
||||
const OAuth = require('oauth-1.0a');
|
||||
|
||||
const oauth = OAuth({
|
||||
consumer: {
|
||||
key: process.env.CONSUMER_KEY,
|
||||
secret: process.env.CONSUMER_SECRET
|
||||
},
|
||||
signature_method: 'HMAC-SHA1',
|
||||
hash_function: (baseString, key) => crypto.createHmac('sha1', key).update(baseString).digest('base64')
|
||||
});
|
||||
|
||||
const token = {
|
||||
key: process.env.ACCESS_TOKEN,
|
||||
secret: process.env.ACCESS_TOKEN_SECRET
|
||||
};
|
||||
|
||||
const url = 'https://api.twitter.com/1.1/statuses/home_timeline.json';
|
||||
|
||||
got(url, {
|
||||
headers: oauth.toHeader(oauth.authorize({url, method: 'GET'}, token)),
|
||||
json: true
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## Unix Domain Sockets
|
||||
|
||||
Requests can also be sent via [unix domain sockets](http://serverfault.com/questions/124517/whats-the-difference-between-unix-socket-and-tcp-ip-socket). Use the following URL scheme: `PROTOCOL://unix:SOCKET:PATH`.
|
||||
|
||||
- `PROTOCOL` - `http` or `https` *(optional)*
|
||||
- `SOCKET` - absolute path to a unix domain socket, e.g. `/var/run/docker.sock`
|
||||
- `PATH` - request path, e.g. `/v2/keys`
|
||||
|
||||
```js
|
||||
got('http://unix:/var/run/docker.sock:/containers/json');
|
||||
|
||||
// or without protocol (http by default)
|
||||
got('unix:/var/run/docker.sock:/containers/json');
|
||||
```
|
||||
|
||||
## AWS
|
||||
|
||||
Requests to AWS services need to have their headers signed. This can be accomplished by using the [`aws4`](https://www.npmjs.com/package/aws4) package. This is an example for querying an ["Elasticsearch Service"](https://aws.amazon.com/elasticsearch-service/) host with a signed request.
|
||||
|
||||
```js
|
||||
const url = require('url');
|
||||
const AWS = require('aws-sdk');
|
||||
const aws4 = require('aws4');
|
||||
const got = require('got');
|
||||
const config = require('./config');
|
||||
|
||||
// Reads keys from the environment or `~/.aws/credentials`. Could be a plain object.
|
||||
const awsConfig = new AWS.Config({ region: config.region });
|
||||
|
||||
function request(uri, options) {
|
||||
const awsOpts = {
|
||||
region: awsConfig.region,
|
||||
headers: {
|
||||
accept: 'application/json',
|
||||
'content-type': 'application/json'
|
||||
},
|
||||
method: 'GET',
|
||||
json: true
|
||||
};
|
||||
|
||||
// We need to parse the URL before passing it to `got` so `aws4` can sign the request
|
||||
const opts = Object.assign(url.parse(uri), awsOpts, options);
|
||||
aws4.sign(opts, awsConfig.credentials);
|
||||
|
||||
return got(opts);
|
||||
}
|
||||
|
||||
request(`https://${config.host}/production/users/1`);
|
||||
|
||||
request(`https://${config.host}/production/`, {
|
||||
// All usual `got` options
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## Testing
|
||||
|
||||
You can test your requests by using the [`nock`](https://github.com/node-nock/nock) module to mock an endpoint:
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const nock = require('nock');
|
||||
|
||||
nock('https://sindresorhus.com')
|
||||
.get('/')
|
||||
.reply(200, 'Hello world!');
|
||||
|
||||
(async () => {
|
||||
const response = await got('sindresorhus.com');
|
||||
console.log(response.body);
|
||||
//=> 'Hello world!'
|
||||
})();
|
||||
```
|
||||
|
||||
If you need real integration tests you can use [`create-test-server`](https://github.com/lukechilds/create-test-server):
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const createTestServer = require('create-test-server');
|
||||
|
||||
(async () => {
|
||||
const server = await createTestServer();
|
||||
server.get('/', 'Hello world!');
|
||||
|
||||
const response = await got(server.url);
|
||||
console.log(response.body);
|
||||
//=> 'Hello world!'
|
||||
|
||||
await server.close();
|
||||
})();
|
||||
```
|
||||
|
||||
|
||||
## Tips
|
||||
|
||||
### User Agent
|
||||
|
||||
It's a good idea to set the `'user-agent'` header so the provider can more easily see how their resource is used. By default, it's the URL to this repo.
|
||||
|
||||
```js
|
||||
const got = require('got');
|
||||
const pkg = require('./package.json');
|
||||
|
||||
got('sindresorhus.com', {
|
||||
headers: {
|
||||
'user-agent': `my-module/${pkg.version} (https://github.com/username/my-module)`
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### 304 Responses
|
||||
|
||||
Bear in mind, if you send an `if-modified-since` header and receive a `304 Not Modified` response, the body will be empty. It's your responsibility to cache and retrieve the body contents.
|
||||
|
||||
|
||||
## Related
|
||||
|
||||
- [gh-got](https://github.com/sindresorhus/gh-got) - Got convenience wrapper to interact with the GitHub API
|
||||
- [gl-got](https://github.com/singapore/gl-got) - Got convenience wrapper to interact with the GitLab API
|
||||
- [travis-got](https://github.com/samverschueren/travis-got) - Got convenience wrapper to interact with the Travis API
|
||||
- [graphql-got](https://github.com/kevva/graphql-got) - Got convenience wrapper to interact with GraphQL
|
||||
- [GotQL](https://github.com/khaosdoctor/gotql) - Got convenience wrapper to interact with GraphQL using JSON-parsed queries instead of strings
|
||||
|
||||
|
||||
## Created by
|
||||
|
||||
[](https://sindresorhus.com) | [](https://github.com/floatdrop) | [](https://github.com/AlexTes) | [](https://github.com/lukechilds)
|
||||
---|---|---|---
|
||||
[Sindre Sorhus](https://sindresorhus.com) | [Vsevolod Strukchinsky](https://github.com/floatdrop) | [Alexander Tesfamichael](https://alextes.me) | [Luke Childs](https://github.com/lukechilds)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user