got 12.4.0 → 12.5.0

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

@@ -3,16 +3,12 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-/// <reference types="node" />
 import { Duplex } from 'node:stream';
 import { URL } from 'node:url';
-import { ServerResponse } from 'node:http';
 import type { ClientRequest } from 'node:http';
 import type { Socket } from 'node:net';
-import CacheableRequest from 'cacheable-request';
 import type { Timings } from '@szmarczak/http-timer';
-import type ResponseLike from 'responselike';
-import Options, { type NativeRequestOptions } from './options.js';
+import Options from './options.js';
 import { type PlainResponse, type Response } from './response.js';
 import { RequestError } from './errors.js';
 declare type Error = NodeJS.ErrnoException;
@@ -87,7 +83,6 @@ export declare type RequestEvents<T> = {
     once: GotEventFunction<T>;
     off: GotEventFunction<T>;
 };
-export declare type CacheableRequestFunction = (options: string | URL | NativeRequestOptions, cb?: (response: ServerResponse | ResponseLike) => void) => CacheableRequest.Emitter;
 declare type UrlType = ConstructorParameters<typeof Options>[0];
 declare type OptionsType = ConstructorParameters<typeof Options>[1];
 declare type DefaultsType = ConstructorParameters<typeof Options>[2];

package/dist/source/core/index.js

@@ -4,7 +4,7 @@ import { Duplex } from 'node:stream';
 import { URL, URLSearchParams } from 'node:url';
 import http, { ServerResponse } from 'node:http';
 import timer from '@szmarczak/http-timer';
-import CacheableRequest from 'cacheable-request';
+import CacheableRequest, { CacheError as CacheableCacheError, } from 'cacheable-request';
 import decompressResponse from 'decompress-response';
 import is from '@sindresorhus/is';
 import { buffer as getBuffer } from 'get-stream';
@@ -627,10 +627,10 @@ export default class Request extends Duplex {
             }
             this._request = undefined;
             const updatedOptions = new Options(undefined, undefined, this.options);
-            const shouldBeGet = statusCode === 303 && updatedOptions.method !== 'GET' && updatedOptions.method !== 'HEAD';
-            if (shouldBeGet || updatedOptions.methodRewriting) {
-                // 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.
+            const serverRequestedGet = statusCode === 303 && updatedOptions.method !== 'GET' && updatedOptions.method !== 'HEAD';
+            const canRewrite = statusCode !== 307 && statusCode !== 308;
+            const userRequestedGet = updatedOptions.methodRewriting && canRewrite;
+            if (serverRequestedGet || userRequestedGet) {
                 updatedOptions.method = 'GET';
                 updatedOptions.body = undefined;
                 updatedOptions.json = undefined;
@@ -820,7 +820,7 @@ export default class Request extends Duplex {
     }
     _prepareCache(cache) {
         if (!cacheableStore.has(cache)) {
-            cacheableStore.set(cache, new CacheableRequest(((requestOptions, handler) => {
+            const cacheableRequest = new CacheableRequest(((requestOptions, handler) => {
                 const result = requestOptions._request(requestOptions, handler);
                 // TODO: remove this when `cacheable-request` supports async request functions.
                 if (is.promise(result)) {
@@ -858,7 +858,8 @@ export default class Request extends Duplex {
                     };
                 }
                 return result;
-            }), cache));
+            }), cache);
+            cacheableStore.set(cache, cacheableRequest.request());
         }
     }
     async _createCacheableRequest(url, options) {
@@ -967,7 +968,7 @@ export default class Request extends Duplex {
             }
         }
         catch (error) {
-            if (error instanceof CacheableRequest.CacheError) {
+            if (error instanceof CacheableCacheError) {
                 throw new CacheError(error, this);
             }
             throw error;
@@ -998,7 +999,8 @@ export default class Request extends Duplex {
             return;
         }
         this._request.write(chunk, encoding, (error) => {
-            if (!error) {
+            // The `!destroyed` check is required to prevent `uploadProgress` being emitted after the stream was destroyed
+            if (!error && !this._request.destroyed) {
                 this._uploadedSize += Buffer.byteLength(chunk, encoding);
                 const progress = this.uploadProgress;
                 if (progress.percent < 1) {

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

@@ -20,7 +20,7 @@ import type { RequestOptions as HttpsRequestOptions, Agent as HttpsAgent } from
 import CacheableLookup from 'cacheable-lookup';
 import http2wrapper, { type ClientHttp2Session } from 'http2-wrapper';
 import type { FormDataLike } from 'form-data-encoder';
-import type CacheableRequest from 'cacheable-request';
+import type { StorageAdapter } from 'cacheable-request';
 import type ResponseLike from 'responselike';
 import type { IncomingMessageWithTimings } from '@szmarczak/http-timer';
 import type { CancelableRequest } from '../as-promise/types.js';
@@ -847,7 +847,7 @@ export default class Options {
     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).
+    This is in accordance with [the spec](https://tools.ietf.org/html/rfc7231#section-6.4.4). You can optionally turn on this behavior also for other redirect codes - see `methodRewriting`.
 
     @default true
     */
@@ -867,8 +867,8 @@ export default class Options {
 
     @default false
     */
-    get cache(): string | CacheableRequest.StorageAdapter | boolean | undefined;
-    set cache(value: string | CacheableRequest.StorageAdapter | boolean | undefined);
+    get cache(): string | StorageAdapter | boolean | undefined;
+    set cache(value: string | StorageAdapter | boolean | undefined);
     /**
     Determines if a `got.HTTPError` is thrown for unsuccessful responses.
 
@@ -911,7 +911,7 @@ export default class Options {
     However, the [HTTP/2 specification](https://tools.ietf.org/html/rfc7540#section-8.1.3) says that `An HTTP GET request includes request header fields and no payload body`, therefore when using the HTTP/2 protocol this option will have no effect.
     This option is only meant to interact with non-compliant servers when you have no other choice.
 
-    __Note__: The [RFC 7321](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore __it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)__.
+    __Note__: The [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore __it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)__.
 
     @default false
     */
@@ -927,9 +927,12 @@ export default class Options {
     get headers(): Headers;
     set headers(value: Headers);
     /**
-    Specifies if the redirects should be [rewritten as `GET`](https://tools.ietf.org/html/rfc7231#section-6.4).
+    Specifies if the HTTP request method should be [rewritten as `GET`](https://tools.ietf.org/html/rfc7231#section-6.4) on redirects.
 
-    If `false`, when sending a POST request and receiving a `302`, it will resend the body to the new location using the same HTTP method (`POST` in this case).
+    As the [specification](https://tools.ietf.org/html/rfc7231#section-6.4) prefers to rewrite the HTTP method only on `303` responses, this is Got's default behavior.
+    Setting `methodRewriting` to `true` will also rewrite `301` and `302` responses, as allowed by the spec. This is the behavior followed by `curl` and browsers.
+
+    __Note__: Got never performs method rewriting on `307` and `308` responses, as this is [explicitly prohibited by the specification](https://www.rfc-editor.org/rfc/rfc7231#section-6.4.7).
 
     @default false
     */
@@ -1160,7 +1163,7 @@ export default class Options {
         hooks: Hooks;
         followRedirect: boolean;
         maxRedirects: number;
-        cache: string | boolean | CacheableRequest.StorageAdapter | undefined;
+        cache: string | boolean | StorageAdapter | undefined;
         throwHttpErrors: boolean;
         http2: boolean;
         allowGetBody: boolean;

package/dist/source/core/options.js

@@ -1004,7 +1004,7 @@ export default class Options {
     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).
+    This is in accordance with [the spec](https://tools.ietf.org/html/rfc7231#section-6.4.4). You can optionally turn on this behavior also for other redirect codes - see `methodRewriting`.
 
     @default true
     */
@@ -1133,7 +1133,7 @@ export default class Options {
     However, the [HTTP/2 specification](https://tools.ietf.org/html/rfc7540#section-8.1.3) says that `An HTTP GET request includes request header fields and no payload body`, therefore when using the HTTP/2 protocol this option will have no effect.
     This option is only meant to interact with non-compliant servers when you have no other choice.
 
-    __Note__: The [RFC 7321](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore __it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)__.
+    __Note__: The [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore __it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)__.
 
     @default false
     */
@@ -1164,9 +1164,12 @@ export default class Options {
         }
     }
     /**
-    Specifies if the redirects should be [rewritten as `GET`](https://tools.ietf.org/html/rfc7231#section-6.4).
+    Specifies if the HTTP request method should be [rewritten as `GET`](https://tools.ietf.org/html/rfc7231#section-6.4) on redirects.
 
-    If `false`, when sending a POST request and receiving a `302`, it will resend the body to the new location using the same HTTP method (`POST` in this case).
+    As the [specification](https://tools.ietf.org/html/rfc7231#section-6.4) prefers to rewrite the HTTP method only on `303` responses, this is Got's default behavior.
+    Setting `methodRewriting` to `true` will also rewrite `301` and `302` responses, as allowed by the spec. This is the behavior followed by `curl` and browsers.
+
+    __Note__: Got never performs method rewriting on `307` and `308` responses, as this is [explicitly prohibited by the specification](https://www.rfc-editor.org/rfc/rfc7231#section-6.4.7).
 
     @default false
     */
@@ -1647,6 +1650,5 @@ export default class Options {
         Object.freeze(options.retry.errorCodes);
         Object.freeze(options.retry.methods);
         Object.freeze(options.retry.statusCodes);
-        Object.freeze(options.context);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "12.4.0",
+	"version": "12.5.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -47,11 +47,10 @@
 	"dependencies": {
 		"@sindresorhus/is": "^5.2.0",
 		"@szmarczak/http-timer": "^5.0.1",
-		"@types/cacheable-request": "^6.0.2",
 		"cacheable-lookup": "^6.0.4",
-		"cacheable-request": "^7.0.2",
+		"cacheable-request": "^10.1.2",
 		"decompress-response": "^6.0.0",
-		"form-data-encoder": "^2.1.0",
+		"form-data-encoder": "^2.1.2",
 		"get-stream": "^6.0.1",
 		"http2-wrapper": "^2.1.10",
 		"lowercase-keys": "^3.0.0",
@@ -60,7 +59,7 @@
 	},
 	"devDependencies": {
 		"@hapi/bourne": "^3.0.0",
-		"@sindresorhus/tsconfig": "^2.0.0",
+		"@sindresorhus/tsconfig": "^3.0.1",
 		"@sinonjs/fake-timers": "^9.1.1",
 		"@types/benchmark": "^2.1.2",
 		"@types/express": "^4.17.13",
@@ -72,7 +71,7 @@
 		"@types/sinon": "^10.0.11",
 		"@types/sinonjs__fake-timers": "^8.1.1",
 		"@types/tough-cookie": "^4.0.1",
-		"ava": "^3.15.0",
+		"ava": "^4.3.3",
 		"axios": "^0.27.2",
 		"benchmark": "^2.1.4",
 		"bluebird": "^3.7.2",
@@ -83,7 +82,7 @@
 		"delay": "^5.0.0",
 		"express": "^4.17.3",
 		"form-data": "^4.0.0",
-		"formdata-node": "^4.3.2",
+		"formdata-node": "^5.0.0",
 		"nock": "^13.2.4",
 		"node-fetch": "^3.2.3",
 		"np": "^7.6.0",
@@ -96,10 +95,11 @@
 		"sinon": "^14.0.0",
 		"slow-stream": "0.0.4",
 		"tempy": "^3.0.0",
-		"then-busboy": "^5.1.1",
+		"then-busboy": "^5.2.1",
 		"to-readable-stream": "^3.0.0",
 		"tough-cookie": "4.0.0",
 		"ts-node": "^10.8.2",
+		"type-fest": "^2.19.0",
 		"typescript": "~4.8.2",
 		"xo": "^0.52.2"
 	},
@@ -109,10 +109,6 @@
 			"test/*"
 		],
 		"timeout": "1m",
-		"nonSemVerExperiments": {
-			"nextGenConfig": true,
-			"configurableModuleFormat": true
-		},
 		"extensions": {
 			"ts": "module"
 		},

package/readme.md

@@ -37,15 +37,6 @@
 		<br>
 		<br>
 		<br>
-		<a href="https://keygen.sh">
-			<div>
-				<img src="https://sindresorhus.com/assets/thanks/keygen-logo.svg" width="180" alt="Keygen">
-			</div>
-			<b>A dead-simple software licensing and distribution API built for developers</b>
-		</a>
-		<br>
-		<br>
-		<br>
 		<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-light-mode-only">
 			<div>
 				<img src="https://sindresorhus.com/assets/thanks/anvil-logo-light.svg" width="200" alt="Anvil">
@@ -76,6 +67,20 @@
 		</a>
 		<br>
 		<br>
+		<a href="https://sizzy.co/?utm_campaign=github_repo&utm_source=github&utm_medium=referral&utm_content=got&utm_term=sindre">
+			<div>
+				<img src="https://sindresorhus.com/assets/thanks/sizzy-logo.png" width="240" alt="Sizzy">
+			</div>
+			<div>
+				<sub>
+				<b>Before Sizzy:</b> web development is stressing you out, responsive design is hard, you have an overwhelming amount of opened tabs & apps.
+				<br>
+				<b>After Sizzy:</b> all the tools you need in one place, responsive design is a breeze, no more context switching.
+				</sub>
+			</div>
+		</a>
+		<br>
+		<br>
 		<br>
 		<br>
 	</p>