Fix stream auto-end for empty PATCH/DELETE/OPTIONS

Fixes #2429

Author: sindresorhus

documentation/3-streams.md

@@ -26,6 +26,7 @@ This constructor takes the same arguments as the Got promise.
 **Note:**
 > - While `got.post('https://example.com')` resolves, `got.stream.post('https://example.com')` will hang indefinitely until a body is provided.
 > - If there's no body on purpose, remember to `stream.end()` or set the body option to an empty string.
+> - `got.stream` does not auto-end for `OPTIONS`, `DELETE`, or `PATCH` so you can pipe or write a body without getting `write after end`. Call `stream.end()` when you are not piping a body.
 
 ```js
 import stream from 'node:stream';

source/core/index.ts

@@ -67,8 +67,6 @@ const supportsBrotli = is.string(process.versions.brotli);
 const supportsZstd = is.string(process.versions.zstd);
 
 const methodsWithoutBody: ReadonlySet<string> = new Set(['GET', 'HEAD']);
-// Methods that should auto-end streams when no body is provided
-const methodsWithoutBodyStream: ReadonlySet<string> = new Set(['OPTIONS', 'DELETE', 'PATCH']);
 
 export type GotEventFunction<T> =
 	/**
@@ -1224,9 +1222,8 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 		} 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);
-			const shouldAutoEndStream = methodsWithoutBodyStream.has(this.options.method);
 
-			if ((this._noPipe ?? false) || cannotHaveBody || currentRequest !== this || shouldAutoEndStream) {
+			if ((this._noPipe ?? false) || cannotHaveBody || currentRequest !== this) {
 				currentRequest.end();
 			}
 		} else {

source/types.ts

@@ -250,6 +250,8 @@ export type Got<GotOptions extends ExtendOptions = ExtendOptions> = {
 	- uploadProgress
 	- downloadProgress
 	- error
+
+	Note: For writable request streams, call `stream.end()` when you are not piping a body. `got.stream` does not auto-end for OPTIONS, DELETE, or PATCH so you can pipe or write a body without getting `write after end`.
 	*/
 	stream: GotStream;
 

test/stream.ts

@@ -577,6 +577,7 @@ test('OPTIONS stream without body completes successfully', withServer, async (t,
 	});
 
 	const stream = got.stream({method: 'OPTIONS'});
+	stream.end();
 	await t.notThrowsAsync(getStream(stream));
 });
 
@@ -587,6 +588,7 @@ test('DELETE stream without body completes successfully', withServer, async (t,
 	});
 
 	const stream = got.stream({method: 'DELETE'});
+	stream.end();
 	await t.notThrowsAsync(getStream(stream));
 });
 
@@ -597,10 +599,26 @@ test('PATCH stream without body completes successfully', withServer, async (t, s
 	});
 
 	const stream = got.stream({method: 'PATCH'});
+	stream.end();
 	const data = await getStream(stream);
 	t.is(data, 'patched');
 });
 
+test('PATCH stream waits for piped body', withServer, async (t, server, got) => {
+	server.patch('/', postHandler);
+
+	const destination = new stream.PassThrough();
+	const responsePromise = getStream(destination);
+
+	await streamPipeline(
+		ReadableStream.from(['Hello, world!']),
+		got.stream.patch(''),
+		destination,
+	);
+
+	t.is(await responsePromise, 'Hello, world!');
+});
+
 test('throws error when content-length does not match bytes transferred - stream', withServer, async (t, server, got) => {
 	server.get('/', (_request, response) => {
 		response.writeHead(200, {