Body timeout not working #3297

Activity

1. caldrjir

   added

   bugSomething isn't workingSomething isn't working

   on May 24, 2024
2. mcollina commented on May 26, 2024

   

   mcollina

   on May 26, 2024

   SponsorMember

   More actions

   Can you please include a server as well in your example? Otherwise reproducing it is network dependent.
3. sandratatarevicova commented on May 27, 2024

   

   sandratatarevicova

   on May 27, 2024

   More actions

   See the example below.

   const fs = require('node:fs');
   const { pipeline } = require('node:stream/promises');
   const http = require('node:http');
   const { request } = require('undici');
   
   const server = http.createServer((req, res) => {
       res.writeHead(200);
       setTimeout(() => {
           res.end();
           console.log('Request closed after 10 seconds');
       }, 10000);
       const writeZeroes = () => {
           res.write(Buffer.alloc(1024, 0));
           setImmediate(writeZeroes);
       };
       writeZeroes();
   });
   
   server.listen();
   const serverUrl = `http://localhost:${server.address().port}`;
   console.log(`Server listening on ${serverUrl}`);
   
   async function test() {
       const { body } = await request(serverUrl, {
           throwOnError: true,
           bodyTimeout: 1000,
       });
       console.log('Reading body...');
       await pipeline(body, fs.createWriteStream('/tmp/body-timeout-test'));
       console.log('Reading body finished');
   }
   
   test();

   Output:

   Server listening on http://localhost:63483
   Reading body...
   Request closed after 10 seconds
   Reading body finished
   

   Reading the response body should timeout after 1 second, but it does not.

   👍React with 👍1Reacted by Jiří Caldr
4. metcoder95 commented on May 28, 2024

   

   metcoder95

   on May 28, 2024

   Last edited by metcoder95

   Member

   More actions

   If I'm not mistaken, the bodyTimeout is only applied on idle situations between receiving body's data.
   As you keep writing to the socket in an interval, and for instance the client keeps receiving data from the server, the timeout is reset on every new chunk, delaying its effect.

   e.g. if I alter your example like this:

   const fs = require('node:fs')
   const { pipeline } = require('node:stream/promises')
   const http = require('node:http')
   const { request } = require('undici')
   
   const server = http.createServer((req, res) => {
     res.writeHead(200)
     setTimeout(() => {
       res.end()
       console.log('Request closed after 10 seconds')
     }, 10000).unref()
     const writeZeroes = () => {
       res.write(Buffer.alloc(1024, 0))
       setInterval(writeZeroes, 2000)
     }
     writeZeroes()
   })
   
   server.listen(0, () => {
     const serverUrl = `http://localhost:${server.address().port}`
     console.log(`Server listening on ${serverUrl}`)
   
     async function test () {
       console.log('Sending request...')
       const { body } = await request(serverUrl, {
         throwOnError: true,
         bodyTimeout: 1000
       })
       console.log('Reading body...')
       await pipeline(body, fs.createWriteStream('/tmp/body-timeout-test'))
       console.log('Reading body finished')
     }
   
     test()
   })

   Then the timeout will effectively apply.

   You can use AbortSignal.timeout to enforce a specific timeout independent of the bodyTimeout one
5. sandratatarevicova commented on May 28, 2024

   

   sandratatarevicova

   on May 28, 2024

   More actions

   Thank you, we will try the AbortSignal, but I think the documentation is a bit misleading:

   • bodyTimeout number | null (optional) - The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use 0 to disable it entirely. Defaults to 300 seconds.

   Based on this, I would expect the request to be aborted after the timeout.

   👍React with 👍1Reacted by jakecastelli
6. metcoder95 commented on May 29, 2024

   

   metcoder95

   on May 29, 2024

   Member

   More actions

   See what you mean, a PR to support us improving the docs is always welcomed!
7. metcoder95

   closed this as completedin #3324on Jun 13, 2024