Fix hang with stream requests without body for methods like OPTIONS

Fixes #2394

When using got.stream() with methods like OPTIONS, DELETE, or PATCH without a body, the request would hang indefinitely. This was because the condition to end the request only checked _cannotHaveBody (GET/HEAD) or _noPipe, missing the case where a stream request has no body to send.

Author: sindresorhus

source/core/index.ts

@@ -168,7 +168,6 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 	private _bodySize?: number;
 	private _unproxyEvents: () => void;
 	private _isFromCache?: boolean;
-	private _cannotHaveBody: boolean;
 	private _triggerRead: boolean;
 	declare private readonly _jobs: Array<() => void>;
 	private _cancelTimeouts: () => void;
@@ -192,7 +191,6 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 		this._uploadedSize = 0;
 		this._stopReading = false;
 		this._pipedServerResponses = new Set<ServerResponse>();
-		this._cannotHaveBody = false;
 		this._unproxyEvents = noop;
 		this._triggerRead = false;
 		this._cancelTimeouts = noop;
@@ -567,8 +565,6 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 		const isBody = !is.undefined(options.body);
 		const cannotHaveBody = methodsWithoutBody.has(options.method) && !(options.method === 'GET' && options.allowGetBody);
 
-		this._cannotHaveBody = cannotHaveBody;
-
 		if (isForm || isJSON || isBody) {
 			if (cannotHaveBody) {
 				throw new TypeError(`The \`${options.method}\` method cannot be used with a body`);
@@ -992,11 +988,15 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 					this._beforeError(error);
 				}
 			})();
-		} else if (!is.undefined(body)) {
+		} else if (is.undefined(body)) {
+			// No body to send, end the request
+			const cannotHaveBody = methodsWithoutBody.has(this.options.method) && !(this.options.method === 'GET' && this.options.allowGetBody);
+			if ((this._noPipe ?? false) || cannotHaveBody || currentRequest !== this) {
+				currentRequest.end();
+			}
+		} else {
 			this._writeRequest(body, undefined, () => {});
 			currentRequest.end();
-		} else if (this._cannotHaveBody || this._noPipe) {
-			currentRequest.end();
 		}
 	}
 

test/stream.ts

@@ -501,3 +501,36 @@ testFunction('it sends a body of file with size on stat = 0', withServer, async
 
 	t.truthy(response.body);
 });
+
+test('OPTIONS stream without body completes successfully', withServer, async (t, server, got) => {
+	server.options('/', (_request, response) => {
+		response.writeHead(200, {
+			allow: 'OPTIONS, GET, HEAD, POST',
+		});
+		response.end();
+	});
+
+	const stream = got.stream({method: 'OPTIONS'});
+	await t.notThrowsAsync(getStream(stream));
+});
+
+test('DELETE stream without body completes successfully', withServer, async (t, server, got) => {
+	server.delete('/', (_request, response) => {
+		response.writeHead(204);
+		response.end();
+	});
+
+	const stream = got.stream({method: 'DELETE'});
+	await t.notThrowsAsync(getStream(stream));
+});
+
+test('PATCH stream without body completes successfully', withServer, async (t, server, got) => {
+	server.patch('/', (_request, response) => {
+		response.writeHead(200);
+		response.end('patched');
+	});
+
+	const stream = got.stream({method: 'PATCH'});
+	const data = await getStream(stream);
+	t.is(data, 'patched');
+});