A body with a Readable can cause uncaughtException

[kanongil]

Describe the bug

• Node.js version: v14.14.0
• OS & version: n/a

If a Readable that has been passed as a body of a request is too quick to finish, got will fail to perform the request, and instead throw an error in an end handler.

Note that in general, it is bad idea to ever throw in an event handler, since it will cause other listeners to not be called, and will likely (as in this case) cause en uncaughtException. The error should probably have been emitted/rejected on the got request instead.

Actual behavior

Process exits with uncaughtException:

<snip>/node_modules/got/dist/source/core/index.js:687
            throw new TypeError('The payload has been already provided');
            ^

TypeError: The payload has been already provided
    at Request.onLockedWrite (<snip>/node_modules/got/dist/source/core/index.js:687:19)
    at onend (_stream_readable.js:684:10)
    at processTicksAndRejections (internal/process/task_queues.js:75:11)

Expected behavior

It actually attempts to post the stream payload.

Code to reproduce

const { Readable } = require('stream');
const Got = require('got');

const stream = new Readable({ read() {} });
const request = Got.post('http://www.google.com', {
    body: stream
});

stream.push('hi');
stream.push(null);
stream.resume();

Checklist

• I have read the documentation.
• I have tried my code with the latest version of Node.js and Got.

[kanongil]

One workaround, is to pipe() the readable to a got stream, instead of passing it as a body. This workaround also gets around the issue in #1503.

[szmarczak]

I'm getting HTTPError: Response code 405 (Method Not Allowed) instead. Can you please post a RunKit example?

[kanongil]

Sure https://runkit.com/kanongil/got-uncaughtexception.

[szmarczak]

Ah indeed, forgot about stream.resume().

[szmarczak]

I think it has something to do with

got/source/core/index.ts

Lines 1399 to 1413 in e0cb820

	this.on('pipe', (source: Writable) => {
	source.prependListener('data', unlockWrite);
	source.on('data', lockWrite);
	source.prependListener('end', unlockWrite);
	source.on('end', lockWrite);
	});
	this.on('unpipe', (source: Writable) => {
	source.off('data', unlockWrite);
	source.off('data', lockWrite);
	source.off('end', unlockWrite);
	source.off('end', lockWrite);
	});