got 11.3.0 → 11.4.0

package/dist/source/as-promise/core.js

@@ -110,6 +110,9 @@ class PromisableRequest extends core_1.default {
         return mergedOptions;
     }
     async _beforeError(error) {
+        if (this.destroyed) {
+            return;
+        }
         if (!(error instanceof core_1.RequestError)) {
             error = new core_1.RequestError(error.message, error, this);
         }

package/dist/source/as-promise/index.js

@@ -4,13 +4,13 @@ function __export(m) {
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
-const getStream = require("get-stream");
 const PCancelable = require("p-cancelable");
 const calculate_retry_delay_1 = require("./calculate-retry-delay");
 const types_1 = require("./types");
 const core_1 = require("./core");
 exports.PromisableRequest = core_1.default;
 const proxy_events_1 = require("../core/utils/proxy-events");
+const get_buffer_1 = require("../core/utils/get-buffer");
 const proxiedRequestEvents = [
     'request',
     'response',
@@ -52,6 +52,7 @@ function asPromise(options) {
             };
             globalRequest = request;
             const onResponse = async (response) => {
+                var _a;
                 response.retryCount = retryCount;
                 if (response.request.aborted) {
                     // Canceled while downloading - will throw a `CancelError` or `TimeoutError` error
@@ -65,7 +66,7 @@ function asPromise(options) {
                 // Download body
                 let rawBody;
                 try {
-                    rawBody = await getStream.buffer(request);
+                    rawBody = await get_buffer_1.default(request);
                     response.rawBody = rawBody;
                 }
                 catch (_) {
@@ -74,16 +75,23 @@ function asPromise(options) {
                     return;
                 }
                 // Parse body
-                try {
-                    response.body = core_1.parseBody(response, options.responseType, options.parseJson, options.encoding);
-                }
-                catch (error) {
-                    // Fallback to `utf8`
-                    response.body = rawBody.toString();
-                    if (isOk()) {
-                        // TODO: Call `request._beforeError`, see https://github.com/nodejs/node/issues/32995
-                        reject(error);
-                        return;
+                const contentEncoding = ((_a = response.headers['content-encoding']) !== null && _a !== void 0 ? _a : '').toLowerCase();
+                const isCompressed = ['gzip', 'deflate', 'br'].includes(contentEncoding);
+                if (isCompressed && !options.decompress) {
+                    response.body = rawBody;
+                }
+                else {
+                    try {
+                        response.body = core_1.parseBody(response, options.responseType, options.parseJson, options.encoding);
+                    }
+                    catch (error) {
+                        // Fallback to `utf8`
+                        response.body = rawBody.toString();
+                        if (isOk()) {
+                            // TODO: Call `request._beforeError`, see https://github.com/nodejs/node/issues/32995
+                            reject(error);
+                            return;
+                        }
                     }
                 }
                 try {
@@ -127,8 +135,7 @@ function asPromise(options) {
                 globalResponse = response;
                 resolve(options.resolveBodyOnly ? response.body : response);
             };
-            request.once('response', onResponse);
-            request.once('error', async (error) => {
+            const onError = async (error) => {
                 if (promise.isCanceled) {
                     return;
                 }
@@ -185,12 +192,18 @@ function asPromise(options) {
                 if (error instanceof types_1.HTTPError) {
                     // The error will be handled by the `response` event
                     onResponse(request._response);
+                    // Reattach the error handler, because there may be a timeout later.
+                    process.nextTick(() => {
+                        request.once('error', onError);
+                    });
                     return;
                 }
                 // Don't emit the `response` event
                 request.destroy();
                 reject(error);
-            });
+            };
+            request.once('response', onResponse);
+            request.once('error', onError);
             proxy_events_1.default(request, emitter, proxiedRequestEvents);
         };
         makeRequest();

package/dist/source/core/index.d.ts

@@ -90,7 +90,7 @@ export interface Options extends URLOptions {
     cookieJar?: PromiseCookieJar | ToughCookieJar;
     ignoreInvalidCookies?: boolean;
     searchParams?: string | {
-        [key: string]: string | number | boolean | null;
+        [key: string]: string | number | boolean | null | undefined;
     } | URLSearchParams;
     dnsCache?: CacheableLookup | boolean;
     context?: object;
@@ -207,6 +207,7 @@ export interface RequestEvents<T> {
     on<R extends Response, N extends NormalizedOptions>(name: 'redirect', listener: (response: R, nextOptions: N) => void): T;
     on(name: 'uploadProgress' | 'downloadProgress', listener: (progress: Progress) => void): T;
 }
+export declare const setNonEnumerableProperties: (sources: (Options | Defaults | undefined)[], to: Options) => void;
 export declare class RequestError extends Error {
     code?: string;
     stack: string;

package/dist/source/core/index.js

@@ -14,7 +14,6 @@ const decompressResponse = require("decompress-response");
 // @ts-ignore Missing types
 const http2wrapper = require("http2-wrapper");
 const lowercaseKeys = require("lowercase-keys");
-const getStream = require("get-stream");
 const is_1 = require("@sindresorhus/is");
 const get_body_size_1 = require("./utils/get-body-size");
 const is_form_data_1 = require("./utils/is-form-data");
@@ -23,6 +22,7 @@ const timed_out_1 = require("./utils/timed-out");
 const url_to_options_1 = require("./utils/url-to-options");
 const options_to_url_1 = require("./utils/options-to-url");
 const weakable_map_1 = require("./utils/weakable-map");
+const get_buffer_1 = require("./utils/get-buffer");
 const dns_ip_version_1 = require("./utils/dns-ip-version");
 const deprecation_warning_1 = require("../utils/deprecation-warning");
 const kRequest = Symbol('request');
@@ -49,7 +49,7 @@ function validateSearchParameters(searchParameters) {
     // eslint-disable-next-line guard-for-in
     for (const key in searchParameters) {
         const value = searchParameters[key];
-        if (!is_1.default.string(value) && !is_1.default.number(value) && !is_1.default.boolean(value) && !is_1.default.null_(value)) {
+        if (!is_1.default.string(value) && !is_1.default.number(value) && !is_1.default.boolean(value) && !is_1.default.null_(value) && !is_1.default.undefined(value)) {
             throw new TypeError(`The \`searchParams\` value '${String(value)}' must be a string, number, boolean or null`);
         }
     }
@@ -78,7 +78,7 @@ const nonEnumerableProperties = [
     'json',
     'form'
 ];
-const setNonEnumerableProperties = (sources, to) => {
+exports.setNonEnumerableProperties = (sources, to) => {
     // Non enumerable properties shall not be merged
     const properties = {};
     for (const source of sources) {
@@ -297,11 +297,11 @@ class Request extends stream_1.Duplex {
             options = { ...defaults, ...url, ...options };
         }
         else {
-            if (url && options && options.url) {
+            if (url && options && options.url !== undefined) {
                 throw new TypeError('The `url` option is mutually exclusive with the `input` argument');
             }
             options = { ...defaults, ...options };
-            if (url) {
+            if (url !== undefined) {
                 options.url = url;
             }
             if (is_1.default.urlInstance(options.url)) {
@@ -370,10 +370,24 @@ class Request extends stream_1.Duplex {
         // `options.searchParams`
         if ('searchParams' in options) {
             if (options.searchParams && options.searchParams !== (defaults === null || defaults === void 0 ? void 0 : defaults.searchParams)) {
-                if (!is_1.default.string(options.searchParams) && !(options.searchParams instanceof url_1.URLSearchParams)) {
+                let searchParameters;
+                if (is_1.default.string(options.searchParams) || (options.searchParams instanceof url_1.URLSearchParams)) {
+                    searchParameters = new url_1.URLSearchParams(options.searchParams);
+                }
+                else {
                     validateSearchParameters(options.searchParams);
+                    searchParameters = new url_1.URLSearchParams();
+                    // eslint-disable-next-line guard-for-in
+                    for (const key in options.searchParams) {
+                        const value = options.searchParams[key];
+                        if (value === null) {
+                            searchParameters.append(key, '');
+                        }
+                        else if (value !== undefined) {
+                            searchParameters.append(key, value);
+                        }
+                    }
                 }
-                const searchParameters = new url_1.URLSearchParams(options.searchParams);
                 // `normalizeArguments()` is also used to merge options
                 (_a = defaults === null || defaults === void 0 ? void 0 : defaults.searchParams) === null || _a === void 0 ? void 0 : _a.forEach((value, key) => {
                     // Only use default if one isn't already defined
@@ -564,7 +578,7 @@ class Request extends stream_1.Duplex {
         }
         options.maxRedirects = (_d = options.maxRedirects) !== null && _d !== void 0 ? _d : 0;
         // Set non-enumerable properties
-        setNonEnumerableProperties([defaults, rawOptions], options);
+        exports.setNonEnumerableProperties([defaults, rawOptions], options);
         return options;
     }
     _lockWrite() {
@@ -683,7 +697,8 @@ class Request extends stream_1.Duplex {
         response.once('aborted', () => {
             this._beforeError(new ReadError({
                 name: 'Error',
-                message: 'The server aborted the pending request'
+                message: 'The server aborted pending request',
+                code: 'ECONNRESET'
             }, this));
         });
         this.emit('downloadProgress', this.downloadProgress);
@@ -1022,7 +1037,7 @@ class Request extends stream_1.Duplex {
             const { response } = error;
             if (response) {
                 response.setEncoding(this._readableState.encoding);
-                response.rawBody = await getStream.buffer(response);
+                response.rawBody = await get_buffer_1.default(response);
                 response.body = response.rawBody.toString();
             }
         }

package/dist/source/core/utils/get-buffer.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+declare const getBuffer: (stream: Readable) => Promise<Buffer>;
+export default getBuffer;

package/dist/source/core/utils/get-buffer.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// TODO: Update https://github.com/sindresorhus/get-stream
+const getBuffer = async (stream) => {
+    const chunks = [];
+    let length = 0;
+    for await (const chunk of stream) {
+        chunks.push(chunk);
+        length += Buffer.byteLength(chunk);
+    }
+    if (Buffer.isBuffer(chunks[0])) {
+        return Buffer.concat(chunks, length);
+    }
+    return Buffer.from(chunks.join(''));
+};
+exports.default = getBuffer;

package/dist/source/create.js

@@ -67,11 +67,14 @@ const create = (defaults) => {
         const iterateHandlers = (newOptions) => {
             return defaults.handlers[iteration++](newOptions, iteration === defaults.handlers.length ? getPromiseOrStream : iterateHandlers);
         };
+        // TODO: remove this in Got 12
         if (is_1.default.plainObject(url)) {
-            options = {
+            const mergedOptions = {
                 ...url,
                 ...options
             };
+            core_1.setNonEnumerableProperties([url, options], mergedOptions);
+            options = mergedOptions;
             url = undefined;
         }
         try {
@@ -143,7 +146,7 @@ const create = (defaults) => {
         while (numberOfRequests < pagination.requestLimit) {
             // TODO: Throw when result is not an instance of Response
             // eslint-disable-next-line no-await-in-loop
-            const result = (await got('', normalizedOptions));
+            const result = (await got(normalizedOptions));
             // eslint-disable-next-line no-await-in-loop
             const parsed = await pagination.transform(result);
             const current = [];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "11.3.0",
+	"version": "11.4.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -50,7 +50,6 @@
 		"cacheable-lookup": "^5.0.3",
 		"cacheable-request": "^7.0.1",
 		"decompress-response": "^6.0.0",
-		"get-stream": "^5.1.0",
 		"http2-wrapper": "^1.0.0-beta.4.5",
 		"lowercase-keys": "^2.0.0",
 		"p-cancelable": "^2.0.0",
@@ -76,6 +75,7 @@
 		"delay": "^4.3.0",
 		"express": "^4.17.1",
 		"form-data": "^3.0.0",
+		"get-stream": "^5.1.0",
 		"nock": "^12.0.0",
 		"node-fetch": "^2.6.0",
 		"np": "^6.0.0",

package/readme.md

@@ -439,7 +439,7 @@ Default: `'utf8'`
 
 [Encoding](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings) to be used on `setEncoding` of the response data.
 
-To get a [`Buffer`](https://nodejs.org/api/buffer.html), you need to set [`responseType`](#responseType) to `buffer` instead.
+To get a [`Buffer`](https://nodejs.org/api/buffer.html), you need to set [`responseType`](#responseType) to `buffer` instead. Don't set this option to `null`.
 
 **Note:** This doesn't affect streams! Instead, you need to do `got.stream(...).setEncoding(encoding)`.
 
@@ -473,6 +473,12 @@ console.log(searchParams.toString());
 //=> 'key=a&key=b'
 ```
 
+There are some exceptions in regards to `URLSearchParams` behavior:
+
+**Note #1:** `null` values are not stringified, an empty string is used instead.
+
+**Note #2:** `undefined` values are not stringified, the entry is skipped instead.
+
 ###### timeout
 
 Type: `number | object`
@@ -1451,7 +1457,7 @@ Options are deeply merged to a new object. The value of each key is determined a
 	- If the parent property is a plain `object`, the parent value is deeply cloned.
 	- Otherwise, `undefined` is used.
 - If the parent value is an instance of `URLSearchParams`:
-	- If the new value is a `string`, an `object` or an instance of `URLSearchParams`, a new `URLSearchParams` instance is created. The values are merged using [`urlSearchParams.append(key, value)`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/append). The keys defined in the new value override the keys defined in the parent value.
+	- If the new value is a `string`, an `object` or an instance of `URLSearchParams`, a new `URLSearchParams` instance is created. The values are merged using [`urlSearchParams.append(key, value)`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/append). The keys defined in the new value override the keys defined in the parent value. Please note that `null` values point to an empty string and `undefined` values will exclude the entry.
 	- Otherwise, the only available value is `undefined`.
 - If the new property is a plain `object`:
 	- If the parent property is a plain `object` too, both values are merged recursively into a new `object`.
@@ -2107,14 +2113,14 @@ The Electron `net` module is not consistent with the Node.js `http` module. See
 [kbg]: https://badgen.net/github/label-issues/sindresorhus/ky/bug/open?label
 [rbg]: https://badgen.net/github/label-issues/request/request/Needs%20investigation/open?label
 [nbg]: https://badgen.net/github/label-issues/bitinn/node-fetch/bug/open?label
-[abg]: https://badgen.net/github/label-issues/axios/axios/type:bug/open?label
+[abg]: https://badgen.net/github/label-issues/axios/axios/type:confirmed%20bug/open?label
 [sbg]: https://badgen.net/github/label-issues/visionmedia/superagent/Bug/open?label
 
 [g6]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
 [k6]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
 [r6]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A"Needs+investigation"
 [n6]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
-[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Atype:bug
+[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3Aconfirmed+bug%22
 [s6]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3ABug
 
 <!-- DEPENDENTS -->