Use native FormData global instead of form-data-encoder

Fixes #2077

Author: sindresorhus

documentation/2-options.md

@@ -296,7 +296,7 @@ stream.on('data', console.log);
 
 ### `body`
 
-**Type: `string | Buffer | TypedArray | stream.Readable | Generator | AsyncGenerator | Iterable | AsyncIterable | FormData` or [`form-data` instance](https://github.com/form-data/form-data)**
+**Type: `string | Buffer | TypedArray | stream.Readable | Generator | AsyncGenerator | Iterable | AsyncIterable | FormData`**
 
 The payload to send.
 
@@ -365,12 +365,10 @@ await got.post('https://httpbin.org/anything', {
 });
 ```
 
-Since Got 12, you can use spec-compliant [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) objects as request body, such as [`formdata-node`](https://github.com/octet-stream/form-data) or [`formdata-polyfill`](https://github.com/jimmywarting/FormData):
+You can use [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) objects as request body:
 
 ```js
 import got from 'got';
-import {FormData} from 'formdata-node'; // or:
-// import {FormData} from 'formdata-polyfill/esm.min.js';
 
 const form = new FormData();
 form.set('greeting', 'Hello, world!');

package.json

@@ -57,7 +57,6 @@
 		"cacheable-request": "^13.0.18",
 		"chunk-data": "^0.1.0",
 		"decompress-response": "^10.0.0",
-		"form-data-encoder": "^4.1.0",
 		"http2-wrapper": "^2.2.1",
 		"keyv": "^5.6.0",
 		"lowercase-keys": "^4.0.1",
@@ -89,8 +88,6 @@
 		"delay": "^7.0.0",
 		"expect-type": "^1.3.0",
 		"express": "^5.2.1",
-		"form-data": "^4.0.5",
-		"formdata-node": "^6.0.3",
 		"get-stream": "^9.0.1",
 		"nock": "^14.0.11",
 		"node-fetch": "^3.3.2",

readme.md

@@ -359,7 +359,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 
 [Click here][InstallSizeOfTheDependencies] to see the install size of the Got dependencies.
 
-[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@7.0.0,@szmarczak/http-timer@5.0.1,cacheable-lookup@7.0.0,cacheable-request@12.0.1,decompress-response@6.0.0,form-data-encoder@4.0.2,http2-wrapper@2.2.1,lowercase-keys@3.0.0,p-cancelable@4.0.1,responselike@3.0.0,type-fest@4.19.0
+[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@7.0.0,@szmarczak/http-timer@5.0.1,cacheable-lookup@7.0.0,cacheable-request@12.0.1,decompress-response@6.0.0,http2-wrapper@2.2.1,lowercase-keys@3.0.0,p-cancelable@4.0.1,responselike@3.0.0,type-fest@4.19.0
 
 ## Maintainers
 

source/as-promise/index.ts

@@ -214,7 +214,7 @@ export default function asPromise<T>(firstRequest?: Request): CancelableRequest<
 
 				const newBody = request.options.body;
 
-				if (previousBody === newBody && is.nodeStream(newBody)) {
+				if (previousBody === newBody && (is.nodeStream(newBody) || newBody instanceof ReadableStream)) {
 					error.message = 'Cannot retry with consumed body stream';
 
 					onError(error);

source/core/index.ts

@@ -15,11 +15,9 @@ import decompressResponse from 'decompress-response';
 import type {KeyvStoreAdapter} from 'keyv';
 import type KeyvType from 'keyv';
 import is, {isBuffer} from '@sindresorhus/is';
-import {FormDataEncoder, isFormData as isFormDataLike} from 'form-data-encoder';
 import type ResponseLike from 'responselike';
 import timer, {type ClientRequestWithTimings, type Timings, type IncomingMessageWithTimings} from './utils/timer.js';
 import getBodySize from './utils/get-body-size.js';
-import isFormData from './utils/is-form-data.js';
 import proxyEvents from './utils/proxy-events.js';
 import timedOut, {TimeoutError as TimedOutTimeoutError} from './timed-out.js';
 import urlToOptions from './utils/url-to-options.js';
@@ -772,24 +770,17 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 			const noContentType = !is.string(headers['content-type']);
 
 			if (isBody) {
-				// Body is spec-compliant FormData
-				if (isFormDataLike(options.body)) {
-					const encoder = new FormDataEncoder(options.body);
+				// Native FormData
+				if (options.body instanceof FormData) {
+					const response = new Response(options.body);
 
 					if (noContentType) {
-						headers['content-type'] = encoder.headers['Content-Type'];
+						headers['content-type'] = response.headers.get('content-type') ?? 'multipart/form-data';
 					}
 
-					if ('Content-Length' in encoder.headers) {
-						headers['content-length'] = encoder.headers['Content-Length'];
-					}
-
-					options.body = encoder.encode();
-				}
-
-				// Special case for https://github.com/form-data/form-data
-				if (isFormData(options.body) && noContentType) {
-					headers['content-type'] = `multipart/form-data; boundary=${options.body.getBoundary()}`;
+					options.body = response.body!;
+				} else if (Object.prototype.toString.call(options.body) === '[object FormData]') {
+					throw new TypeError('Non-native FormData is not supported. Use globalThis.FormData instead.');
 				}
 			} else if (isForm) {
 				if (noContentType) {
@@ -811,7 +802,7 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 				options.body = options.stringifyJson(json);
 			}
 
-			const uploadBodySize = await getBodySize(options.body, options.headers);
+			const uploadBodySize = getBodySize(options.body, options.headers);
 
 			// See https://tools.ietf.org/html/rfc7230#section-3.3.2
 			// A user agent SHOULD send a Content-Length in a request message when

source/core/options.ts

@@ -16,7 +16,6 @@ import is, {assert} from '@sindresorhus/is';
 import lowercaseKeys from 'lowercase-keys';
 import CacheableLookup from 'cacheable-lookup';
 import http2wrapper, {type ClientHttp2Session} from 'http2-wrapper';
-import {isFormData, type FormDataLike} from 'form-data-encoder';
 import type {KeyvStoreAdapter} from 'keyv';
 import type KeyvType from 'keyv';
 import type ResponseLike from 'responselike';
@@ -1634,7 +1633,7 @@ export default class Options {
 
 	__Note #4__: This option is not enumerable and will not be merged with the instance defaults.
 
-	The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / typed array ([`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), etc.) / [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) / [`form-data` instance](https://github.com/form-data/form-data), and `content-length` and `transfer-encoding` are not manually set in `options.headers`.
+	The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / typed array ([`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), etc.), and `content-length` and `transfer-encoding` are not manually set in `options.headers`.
 
 	Since Got 12, the `content-length` is not automatically set when `body` is a `fs.createReadStream`.
 
@@ -1655,12 +1654,12 @@ export default class Options {
 	});
 	```
 	*/
-	get body(): string | Uint8Array | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | ArrayBufferView | undefined {
+	get body(): string | Uint8Array | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormData | ArrayBufferView | undefined {
 		return this._internals.body;
 	}
 
-	set body(value: string | Uint8Array | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | ArrayBufferView | undefined) {
-		assertAny('body', [is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, is.iterable, is.asyncIterable, isFormData, is.typedArray, is.undefined], value);
+	set body(value: string | Uint8Array | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormData | ArrayBufferView | undefined) {
+		assertAny('body', [is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, is.iterable, is.asyncIterable, is.typedArray, is.undefined], value);
 
 		if (is.nodeStream(value)) {
 			assert.truthy(value.readable);

source/core/utils/get-body-size.ts

@@ -1,9 +1,7 @@
-import {promisify} from 'node:util';
 import type {ClientRequestArgs} from 'node:http';
 import is from '@sindresorhus/is';
-import isFormData from './is-form-data.js';
 
-export default async function getBodySize(body: unknown, headers: ClientRequestArgs['headers']): Promise<number | undefined> {
+export default function getBodySize(body: unknown, headers: ClientRequestArgs['headers']): number | undefined {
 	if (headers && 'content-length' in headers) {
 		return Number(headers['content-length']);
 	}
@@ -24,21 +22,5 @@ export default async function getBodySize(body: unknown, headers: ClientRequestA
 		return (body as ArrayBufferView).byteLength;
 	}
 
-	if (isFormData(body)) {
-		try {
-			return await promisify(body.getLength.bind(body))();
-		} catch (error: unknown) {
-			const typedError = error as Error;
-			throw new Error('Cannot determine content-length for form-data with stream(s) of unknown length. '
-				+ 'This is a limitation of the `form-data` package. '
-				+ 'To fix this, either:\n'
-				+ '1. Use the `knownLength` option when appending streams:\n'
-				+ '   form.append(\'file\', stream, {knownLength: 12345});\n'
-				+ '2. Switch to spec-compliant FormData (formdata-node package)\n'
-				+ 'See: https://github.com/form-data/form-data#alternative-submission-methods\n'
-				+ `Original error: ${typedError.message}`);
-		}
-	}
-
 	return undefined;
 }

source/core/utils/is-form-data.ts

@@ -4,9 +4,6 @@ import fs from 'node:fs';
 import path from 'node:path';
 import test from 'ava';
 import type {Handler} from 'express';
-import FormData from 'form-data';
-import {FormDataEncoder} from 'form-data-encoder';
-import {FormData as FormDataNode} from 'formdata-node';
 import got, {type Headers} from '../source/index.js';
 import withServer from './helpers/with-server.js';
 
@@ -159,68 +156,31 @@ test('form manual `content-type` header', withServer, async (t, server, got) =>
 	t.is(headers['content-type'], 'custom');
 });
 
-test('form-data manual `content-type` header', withServer, async (t, server, got) => {
+test('sets `content-type` header for native FormData', withServer, async (t, server, got) => {
 	server.post('/', echoHeaders);
 
-	const form = new FormData();
-	form.append('a', 'b');
-	const {body} = await got.post({
-		headers: {
-			'content-type': 'custom',
-		},
-		body: form,
-	});
-	const headers = JSON.parse(body);
-	t.is(headers['content-type'], 'custom');
-});
-
-test('form-data automatic `content-type` header', withServer, async (t, server, got) => {
-	server.post('/', echoHeaders);
-
-	const form = new FormData();
-	form.append('a', 'b');
-	const {body} = await got.post({
-		body: form,
-	});
-	const headers = JSON.parse(body);
-	t.is(headers['content-type'], `multipart/form-data; boundary=${form.getBoundary()}`);
-});
-
-test('form-data sets `content-length` header', withServer, async (t, server, got) => {
-	server.post('/', echoHeaders);
-
-	const form = new FormData();
-	form.append('a', 'b');
-	const {body} = await got.post({body: form});
-	const headers = JSON.parse(body);
-	t.is(headers['content-length'], '157');
-});
-
-test('sets `content-type` header for spec-compliant FormData', withServer, async (t, server, got) => {
-	server.post('/', echoHeaders);
-
-	const form = new FormDataNode();
+	const form = new globalThis.FormData();
 	form.set('a', 'b');
 	const {body} = await got.post({body: form});
 	const headers = JSON.parse(body);
 	t.true((headers['content-type'] as string).startsWith('multipart/form-data'));
 });
 
-test('sets `content-length` header for spec-compliant FormData', withServer, async (t, server, got) => {
+test('native FormData uses chunked transfer-encoding instead of content-length', withServer, async (t, server, got) => {
 	server.post('/', echoHeaders);
 
-	const form = new FormDataNode();
+	const form = new globalThis.FormData();
 	form.set('a', 'b');
-	const encoder = new FormDataEncoder(form);
 	const {body} = await got.post({body: form});
 	const headers = JSON.parse(body);
-	t.is(headers['content-length'], encoder.headers['Content-Length']);
+	t.is(headers['content-length'], undefined);
+	t.is(headers['transfer-encoding'], 'chunked');
 });
 
-test('manual `content-type` header should be allowed with spec-compliant FormData', withServer, async (t, server, got) => {
+test('manual `content-type` header should be allowed with native FormData', withServer, async (t, server, got) => {
 	server.post('/', echoHeaders);
 
-	const form = new FormDataNode();
+	const form = new globalThis.FormData();
 	form.set('a', 'b');
 	const {body} = await got.post({
 		headers: {

test/headers.ts

@@ -3,7 +3,6 @@ import {Agent as HttpAgent} from 'node:http';
 import test from 'ava';
 import nock from 'nock';
 import getStream from 'get-stream';
-import FormData from 'form-data';
 import sinon from 'sinon';
 import delay from 'delay';
 import type {Handler} from 'express';
@@ -452,8 +451,8 @@ test('returning HTTP response from a beforeRequest hook', withServer, async (t,
 test('returning HTTP response from a beforeRequest hook with FormData body', withServer, async (t, server, got) => {
 	server.post('/', echoBody);
 
-	const form = new FormData();
-	form.append('field', 'value');
+	const form = new globalThis.FormData();
+	form.set('field', 'value');
 
 	const data = await got.post({
 		body: form,
@@ -632,8 +631,8 @@ test('beforeRetry allows stream body if different from original', withServer, as
 	});
 
 	const generateBody = () => {
-		const form = new FormData();
-		form.append('A', 'B');
+		const form = new globalThis.FormData();
+		form.set('A', 'B');
 		return form;
 	};
 
@@ -645,9 +644,7 @@ test('beforeRetry allows stream body if different from original', withServer, as
 		hooks: {
 			beforeRetry: [
 				({options}) => {
-					const form = generateBody();
-					options.body = form;
-					options.headers['content-type'] = `multipart/form-data; boundary=${form.getBoundary()}`;
+					options.body = generateBody();
 					options.headers.foo = 'bar';
 				},
 			],