POST request with ReadStream request body does not return a response

[busma13]

Please avoid duplicates

• I checked all open bugs and none of them matched my problem.

Reproducible test case

https://github.com/busma13/nock-stream-test

Nock Version

13.5.4

Node Version

20.10.0

TypeScript Version

No response

What happened?

I'm using got to send a post request to an api that will upload a file. The request body contains a ReadStream of the file to be uploaded. In my jest test Nock successfully intercepts the request, the InterceptedRequestRouter class calls handleWrite(), but handleEnd() is never called. It will hang until the jest test times out.

If I switch to node version 20.9.0 or previous Nock will successfully read the stream and return a response.

Would you be interested in contributing a fix?

• yes

[mikicho]

@busma13 any chance the regression is in got side? from what I see, handleEnd is never get called.

[busma13]

It could definitely be got not emitting end. I will look into that. Thanks @mikicho

[matt-boris]

Hey @busma13, have you gotten any further with this? We're having a similar issue on taskcluster while trying to upgrade to the latest version of node.

[busma13]

@matt-boris No I haven't, we were okay with disabling the test because the function was covered well in e2e testing, so it lost priority. I wanted to search through the got issues to see if someone else had a similar problem before making my own, but I never finished that. Are you using got to make requests as well?

[matt-boris]

@busma13 yes, we're using got as well.

[stephen-willoughby]

I think this is a got issue and not a nock issue as I did a quick switch to use axios instead of got and it worked

UPDATE: this was using got v13.0.0

[stephen-willoughby]

const nock = require('nock')
const fs = require('fs')
const axios = require('axios')

const myFile = 'somefile.txt'
const host = 'http://example.com'
const path = '/some/path'
const response = { foo: 'bar' }
const options = {
  method: 'post',
  url: host + path,
  body: fs.createReadStream(myFile)
}

nock(host)
  .post(path)
  .reply(200, response)

const run = async () => {
  const { default: got } = await import('got')

  try {
    const result = await got(options)
    console.log(result.body)
  } catch (error) {
    console.error('error')
    console.error(error)
  }
  console.log('complete')
}

run()

As a minimal recreate. The oddness is that if I switch the url to https://httpbin.org/post it works, but if I switch got to axios it works too. Almost as if it's the combination of the two

[mikicho]

Thanks for verifying this!
Can we close this one?

[busma13]

Thanks @stephen-willoughby
Yeah I'll close this.

[stephen-willoughby]

Any chance this could be reopened?

got aren't interested in addressing it. And it seems to specifically be around the use of both got and nock. On sindresorhus/got#2341 someone has suggested a workaround, with a patch of nock, but I've no idea of its validity