chore: merge 'fix/form-data-in-response' into main

Author: Gozala

@types/index.d.ts

@@ -85,6 +85,7 @@ interface RequestInit {
 	protocol?: string;
 	size?: number;
 	highWaterMark?: number;
+	insecureHTTPParser?: boolean;
 }
 
 interface ResponseInit {

package.json

@@ -56,7 +56,7 @@
   },
   "devDependencies": {
     "abort-controller": "^3.0.0",
-    "abortcontroller-polyfill": "^1.5.0",
+    "abortcontroller-polyfill": "^1.7.1",
     "busboy": "^0.3.1",
     "c8": "^7.3.0",
     "chai": "^4.2.0",

src/body.js

@@ -62,6 +62,7 @@ export default class Body {
 		}
 
 		this[INTERNALS] = {
+			/** @type {Stream|Buffer|Blob|null} */
 			body,
 			boundary,
 			disturbed: false,
@@ -198,7 +199,7 @@ async function consumeBody(data) {
 
 	try {
 		for await (const chunk of body) {
-			const bytes = typeof chunk === "string" ? Buffer.from(chunk) : chunk
+			const bytes = typeof chunk === 'string' ? Buffer.from(chunk) : chunk;
 			if (data.size > 0 && accumBytes + bytes.byteLength > data.size) {
 				const err = new FetchError(`content size at ${data.url} over limit: ${data.size}`, 'max-size');
 				body.destroy(err);
@@ -321,7 +322,7 @@ export const extractContentType = (body, request) => {
  *
  * ref: https://fetch.spec.whatwg.org/#concept-body-total-bytes
  *
- * @param {any} obj.body Body object from the Body instance.
+ * @param {Body} request Body object from the Body instance.
  * @returns {number | null}
  */
 export const getTotalBytes = request => {

src/index.js

@@ -95,6 +95,30 @@ export default async function fetch(url, options_) {
 			finalize();
 		});
 
+		fixResponseChunkedTransferBadEnding(request_, err => {
+			response.body.destroy(err);
+		});
+
+		/* c8 ignore next 18 */
+		if (process.version < 'v14') {
+			// Before Node.js 14, pipeline() does not fully support async iterators and does not always
+			// properly handle when the socket close/end events are out of order.
+			request_.on('socket', s => {
+				let endedWithEventsCount;
+				s.prependListener('end', () => {
+					endedWithEventsCount = s._eventsCount;
+				});
+				s.prependListener('close', hadError => {
+					// if end happened before close but the socket didn't emit an error, do it now
+					if (response && endedWithEventsCount < s._eventsCount && !hadError) {
+						const err = new Error('Premature close');
+						err.code = 'ERR_STREAM_PREMATURE_CLOSE';
+						response.body.emit('error', err);
+					}
+				});
+			});
+		}
+
 		request_.on('response', response_ => {
 			request_.setTimeout(0);
 			const headers = fromRawHeaders(response_.rawHeaders);
@@ -265,3 +289,31 @@ export default async function fetch(url, options_) {
 		writeToStream(request_, request);
 	});
 }
+
+function fixResponseChunkedTransferBadEnding(request, errorCallback) {
+	const LAST_CHUNK = Buffer.from('0\r\n');
+	let socket;
+
+	request.on('socket', s => {
+		socket = s;
+	});
+
+	request.on('response', response => {
+		const {headers} = response;
+		if (headers['transfer-encoding'] === 'chunked' && !headers['content-length']) {
+			let properLastChunkReceived = false;
+
+			socket.on('data', buf => {
+				properLastChunkReceived = Buffer.compare(buf.slice(-3), LAST_CHUNK) === 0;
+			});
+
+			socket.prependListener('close', () => {
+				if (!properLastChunkReceived) {
+					const err = new Error('Premature close');
+					err.code = 'ERR_STREAM_PREMATURE_CLOSE';
+					errorCallback(err);
+				}
+			});
+		}
+	});
+}

src/utils/is.js

@@ -11,7 +11,7 @@ const NAME = Symbol.toStringTag;
  * ref: https://github.com/node-fetch/node-fetch/issues/296#issuecomment-307598143
  *
  * @param  {*} obj
- * @return {boolean}
+ * @return {object is URLSearchParams}
  */
 export const isURLSearchParameters = object => {
 	return (
@@ -31,7 +31,7 @@ export const isURLSearchParameters = object => {
  * Check if `object` is a W3C `Blob` object (which `File` inherits from)
  *
  * @param  {*} obj
- * @return {boolean}
+ * @return {object is Blob}
  */
 export const isBlob = object => {
 	return (
@@ -52,7 +52,7 @@ export const isBlob = object => {
  * Check if `obj` is a spec-compliant `FormData` object
  *
  * @param {*} object
- * @return {boolean}
+ * @return {object is FormData}
  */
 export function isFormData(object) {
 	return (
@@ -74,7 +74,7 @@ export function isFormData(object) {
  * Check if `obj` is an instance of AbortSignal.
  *
  * @param  {*} obj
- * @return {boolean}
+ * @return {object is AbortSignal}
  */
 export const isAbortSignal = object => {
 	return (

test/form-data.js

@@ -1,6 +1,7 @@
 import FormData from 'formdata-node';
 import Blob from 'fetch-blob';
-import { Response } from '../src/index.js';
+import {Response, Request} from '../src/index.js';
+import {getTotalBytes} from '../src/body.js';
 
 import chai from 'chai';
 
@@ -103,13 +104,29 @@ describe('FormData', () => {
 		expect(String(await read(formDataIterator(form, boundary)))).to.be.equal(expected);
 	});
 
-	it('Response derives content-type from FormData', async () => {
+	it('Response supports FormData body', async () => {
 		const form = new FormData();
 		form.set('blob', new Blob(['Hello, World!'], {type: 'text/plain'}));
 
-		const response = new Response(form)
-		const type = response.headers.get('content-type') || ''
-		expect(type).to.match(/multipart\/form-data;\s*boundary=/)
-		expect(await response.text()).to.have.string('Hello, World!')
+		const response = new Response(form);
+		const type = response.headers.get('content-type') || '';
+		expect(type).to.match(/multipart\/form-data;\s*boundary=/);
+		expect(await response.text()).to.have.string('Hello, World!');
+		// Note: getTotalBytes assumes body could be form data but it never is
+		// because it gets normalized into a stream.
+		expect(getTotalBytes({...response, body: form})).to.be.greaterThan(20);
+	});
+
+	it('Request supports FormData body', async () => {
+		const form = new FormData();
+		form.set('blob', new Blob(['Hello, World!'], {type: 'text/plain'}));
+
+		const request = new Request('https://github.com/node-fetch/', {
+			body: form,
+			method: 'POST'
+		});
+		const type = request.headers.get('content-type') || '';
+		expect(type).to.match(/multipart\/form-data;\s*boundary=/);
+		expect(await request.text()).to.have.string('Hello, World!');
 	});
 });