NextApiRequest is not pipe-able readable stream

[xlambda]

NextApiRequest is suposed to be a Readable Stream by extending http.IncomingMessage, but no data sends to the Writable Stream when piping. Sample code:

export default function upload(req:NextApiRequest, res:NextApiResponse) {
  var busboy = new Busboy({ headers: req.headers });
  busboy.on('file', () => console.log("this line of code will not be reached"));
  return req.pipe(busboy);
}

I guess the Readable Stream data is consumed when the body attribute is initiated, so I modify the above code as to

export default function upload(req:NextApiRequest, res:NextApiResponse) {
  var busboy = new Busboy({ headers: req.headers });
  busboy.on('file', () => console.log("OK"));
  const s = new Readable();
  s.push(req.body);
  s.push(null);
  return s.pipe(busboy)
}

and it does work.

[Janpot]

#7661

[huv1k]

Hey @xlambda, you can read stream but you need to provide [config] (https://github.com/zeit/next.js#api-middlewares) to opt-out from body parsing.

export const config = {
  api: {
    bodyParser: false,
  },
}

[Janpot]

@huv1k Would it make sense to add a property in next.config.js that overrides the default values for the config export in all the routes in the project?

// next.config.js
module.exports = {
  defaultRouteConfig: {
    amp: 'hybrid',
    api: {
      bodyParser: false
    }
  }
}

which then still can be overriden on a per route basis

// pages/the-one-that-is-not-amp.js
export const config = {
  amp: false
}

// api/the-one-that-wants-a-parsed-body.js
export const config = {
  api: {
    bodyParser: true
  }
}

Reason is that I might use my own library to parse these requests throughout my project, and it wouldn't be very ergonomic to have to declare this export everywhere.

[huv1k]

Hey @Janpot, we have a plan for this feature

[Janpot]

Is there a ticket I can follow?

[balazsorban44]

This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.