TypeError: Response body object should not be disturbed or locked #1695

RobertSasak · 2023-11-14T10:50:21Z

What version of Hono are you using?

3.9.0

What runtime/platform is your app running on?

Firebase functions

What steps can reproduce the bug?

Here is a simple example with POST end point.

import { getRequestListener } from '@hono/node-server'
import { Hono } from 'hono'

const app = new Hono()

app.post('/hello', async (c) => {
  return c.text('Hello World!')
})

export const web = onRequest(getRequestListener(app.fetch))

What is the expected behavior?

Requst should reach Heno and Hello World should appear.

What do you see instead?

There is an following silent error 500 when doing a POST request with payload. By placing an console.log in https://github.com/honojs/node-server/blob/3575d60a15e345700b81e22376825e98b0a69ebe/src/listener.ts#L42 it is possible to see this error.

TypeError: Response body object should not be disturbed or locked
    at extractBody (node:internal/deps/undici/undici:6433:17)
    at new Request (node:internal/deps/undici/undici:7314:48)
    at /<path>/functions/node_modules/@hono/node-server/dist/listener.js:48:33
    at /<path>/functions/lib/functions/src/index.js:79:64
    at /<path>/functions/node_modules/firebase-functions/lib/v2/providers/https.js:57:29
    at cors (/<path>/functions/node_modules/cors/lib/index.js:188:7)
    at /<path>/functions/node_modules/cors/lib/index.js:224:17
    at originCallback (/<path>/functions/node_modules/cors/lib/index.js:214:15)
    at /<path>/functions/node_modules/cors/lib/index.js:219:13
    at optionsCallback (/<path>/functions/node_modules/cors/lib/index.js:199:9)

Additional information

Similar issue is documented here honojs/node-server#84

As far as I understand the issue occurs in https://github.com/honojs/node-server/blob/3575d60a15e345700b81e22376825e98b0a69ebe/src/listener.ts#L40 . Here the new Request is created from incoming request.

Firebase use expressjs to process all request and also expose Express JS Request object as an incoming. However this request is already "processed" and the actual body stream is already read.

So when on line https://github.com/honojs/node-server/blob/3575d60a15e345700b81e22376825e98b0a69ebe/src/listener.ts#L38 the read stream is create there is nothing to read.

I am not sure if this is an issue of Hono or how to approach it.

My workaround is to patch listner file and restore body from rawBody.

diff --git a/node_modules/@hono/node-server/dist/listener.js b/node_modules/@hono/node-server/dist/listener.js
index 3f5eaf7..e3541d0 100644
--- a/node_modules/@hono/node-server/dist/listener.js
+++ b/node_modules/@hono/node-server/dist/listener.js
@@ -38,7 +38,14 @@ const getRequestListener = (fetchCallback) => {
       headers: headerRecord
     };
     if (!(method === "GET" || method === "HEAD")) {
-      init.body = import_node_stream.Readable.toWeb(incoming);
+      // init.body = import_node_stream.Readable.toWeb(incoming);
+      init.body = new ReadableStream({
+        start(controller){
+          controller.enqueue(incoming.rawBody);
+          // controller.enqueue('{"c":"d"}');
+            controller.close();
+        }
+      });
       init.duplex = "half";
     }
     let res;

The text was updated successfully, but these errors were encountered:

yusukebe · 2023-11-14T11:35:32Z

Hi @RobertSasak,

Thank you for creating this. Since it's an issue with @hono/node-server (it's fine to create the issue here), could you first provide the version number of your @hono/node-server?

RobertSasak · 2023-11-14T13:09:15Z

Originaly I tested on 1.2.0. I have updated to 1.2.2 just now and the issue still occurs.

AverageHelper · 2023-11-23T19:40:13Z

I'm having this issue as well. Seems to have to do with that Readable.toWeb call.

Tested on Node 18.17.1, hono 3.10.2, @hono/node-server 1.2.3.

AverageHelper · 2023-11-24T05:56:23Z

The above workaround doesn't seem to work in my case. The Request gets constructed just fine, but when my handler calls c.req.json(), a TypeError: Received non-Uint8Array chunk is thrown.

ZanzyTHEbar · 2024-01-12T19:01:52Z

any head-way on this?

HananoshikaYomaru · 2024-01-18T03:47:59Z

c.req.json() and c.req.valid("json") don't work and make it almost unusable.

noidwasavailable · 2024-02-08T06:43:40Z

Is there an update to this?

Looks like this might be related to: vercel/next.js#50166 and FirebaseExtended/firebase-framework-tools#122

cogoo · 2024-04-02T21:23:53Z

I had this identical issue with using vercel funcitons.

I found a solution that might help you further debug the problem.

A similar issue highlights the code in the vercel dev serve that causese the issue:
honojs/node-server#84 (comment)

The issue can be resolved by setting the following environment variable in your local environment file:

NODEJS_HELPERS="0"

It might be worth checking if Firebase Functions has similar behaviour

yusukebe · 2024-04-09T08:48:56Z

Hi. Is this problem still happening? I don't have an environment for Firebase. If it's not resolved, I'll make it and try to investigate.

remorses · 2024-06-04T16:39:18Z

This problem still happens when you cancel a request that is in progress

Bobetti · 2024-08-05T12:40:34Z

has the exact same error using npm - 10.5.0, "vercel": "^35.2.3", "hono": "^4.5.1", "@hono/node-server": "^1.12.0",
Switched over to bun, no such error anymore.

Bobetti · 2024-08-19T08:39:20Z

using npm i vercel@latest and "@hono/node-server/vercel" - any request to the hono server ends up with

Error occurs if request contains payload, in my case simple json.

@yusukebe Is it hono problem or vercel problem?

NODEJS_HELPERS=0 not helping

Bobetti · 2024-08-19T09:20:11Z

I also noticed that if i turn off cors middleware, and the post route looks like this:

.post("/pricing", async (c) => {      

        // const body = await c.req.json();

        return c.json({ success: true });
    });

Everything works.

But as soon as I turn on cors - I get the error: "Response body object should not be disturbed or locked".
If I turn off cors but uncomment the above line const body = await c.req.json(); i get the same error.

Bobetti · 2024-08-26T09:00:43Z

@yusukebe As I see, no responses in this thread. Does it mean, that HonoJs is just not compatible with Vercel's node js environment? And there is no point in waiting for the fast solution and better to move to another framework?

Tried Elysia JS, but they have errors in sample code which are not fixed for half a year: Type error on sample code elysiajs/eden#45
Tried Fastify JS, but they have compatibility issues with vercel typescript versions: Fastify typescript compatibility fastify/fastify#5639
Tried Hono JS: but current error doesn't allow to move forward with the development
Next is Nest JS. Let's find out what I can find there...

yusukebe · 2024-08-26T11:41:10Z

@Bobetti

Sorry for the lack of response. If you can share a minimal repo to reproduce it, I can investigate.

Bobetti · 2024-08-26T12:18:59Z

@yusukebe
Here is the minimal project: https://www.dropbox.com/scl/fi/4qwy7ckiql8uiu8cyr4ot/hono-vercel.zip?rlkey=trq71faz162w5zbpk2rptb6q2&dl=0

I removed vercel info and node modules.

Request I'm sending from svelte application using this code (using hono RPC):

const makeRequest = async () => {

		console.log('makeRequest');


		try {
			const dataClient = hc<ApiPricingRoutes>('/');
			const api = dataClient.api;
			const res = await api.pricing.$post({
				json: {
					countryCode: 'Estonia',
					startDateUtc: '2024-07-25T21:00:00.000Z',
					endDateUtc: '2024-07-26T20:59:59.999Z'
				}
			});

			if (!res.ok) {
				const errorText = 'Request failed: ' + res.statusText;
				toast.error(errorText);
				return;
			}

			const result = await res.json();
			toast.success('Request successful: ');
		} catch (error) {
			console.error('There was a problem with the fetch operation:', error);
		}
	};

Thank you very much for your help @yusukebe

P.S.

Error itself:

yusukebe · 2024-08-30T06:37:58Z

@Bobetti

I've tried it, but I can't understand how to reproduce it. And this project is not minimal. I'm sorry, but I can't help you.

Bobetti · 2024-08-30T10:59:26Z

@yusukebe What does it mean you can't reproduce it? I tried it using macbook M2 air, I tried it using windows 10 machine. Always the same result. I even installed Thunder Client in VS Code to make requests without svelte client. And the result is always the same:

Is it really working for you?
Did you use vercel node.js, see after nr 4, as written here: https://hono.dev/docs/getting-started/vercel

Exactly the same request in Thunder client, working perfectly using NestJS.

May be you need some more data?

yusukebe · 2024-08-30T12:43:21Z

Hi @Bobetti

Sorry, it is reproduced. This is a Vercel matter. The stream of IncomingMessage from Vercel has already been used. The reason for this is that incoming.complete is true. I thought we could prevent it with the option NODEJS_HELPERS=0, but it does not affect it. This is Vercel matter, so it's difficult to fix it in Hono-side.

Bobetti · 2024-08-30T13:16:35Z

@yusukebe thank you very much for your help.

maxweisel · 2024-09-23T23:57:53Z

We're hitting this same issue (we do not use vercel or other middleware that adds helpers). It seems specific to sockets getting closed while the request handler is still trying to fulfill the request. Specifically canceling existing requests leads to this bug:

node:internal/deps/undici/undici:5312
          throw new TypeError(
          ^

TypeError: Response body object should not be disturbed or locked
    at extractBody (node:internal/deps/undici/undici:5312:17)
    at new Request (node:internal/deps/undici/undici:9492:48)
    at new Request (file:///usr/src/app/node_modules/@hono/node-server/dist/index.mjs:29:5)
    at newRequestFromIncoming (file:///usr/src/app/node_modules/@hono/node-server/dist/index.mjs:60:10)
    at [getRequestCache] (file:///usr/src/app/node_modules/@hono/node-server/dist/index.mjs:81:35)
    at [getAbortController] (file:///usr/src/app/node_modules/@hono/node-server/dist/index.mjs:76:26)
    at ServerResponse.<anonymous> (file:///usr/src/app/node_modules/@hono/node-server/dist/index.mjs:404:34)
    at ServerResponse.emit (node:events:519:28)
    at emitCloseNT (node:_http_server:1020:10)
    at TLSSocket.onServerResponseClose (node:_http_server:278:5)

This is running in docker on linux.

yusukebe · 2024-09-24T02:55:51Z

Hi @maxweisel

Can you provide a minimal project to reproduce it? It's better it work on my MacOS machine(not on docker) if possible.

ivank · 2024-10-03T13:58:21Z

Also experiencing this when functions are deployed to google functions.

import { getRequestListener } from '@hono/node-server';
import { http } from '@google-cloud/functions-framework';
import { app } from './app';

http('handler', getRequestListener(app.fetch));

With the following code, any post is not working when deployed to google functions (gen2).
I think it is the way google "prefetches" the data for the functions rather than streaming it in.

elct9620 · 2024-10-20T13:41:40Z

Update:

Set NODEJS_HELPERS=0 is resolved my issue.

Add into .env.local does not work, I have to use the Vercel dashboard to add it. And vercel env pull and update .env.local to NODEJS_HELPERS="0"

If NODEJS_HELPERS="0" is configured correctly, the c.env.incoming.body will become undefined

I have the same issue on Vercel, there are some test cases to reproduce it.

✅ Do nothing

app.post("/debug", (c) => {
    return c.json({});
});

✅ Print context

app.post("/debug", (c) => {
    console.log(c);
    return c.json({});
});

❌ Print request

app.post("/debug", (c) => {
    console.log(c.req);
    return c.json({});
});

I want to process c.req.json() to get the request body but Hono cannot build c.req, the error message is Error: TypeError: Response body object should not be disturbed or locked

✅ Use `c.env.incoming.body`

To verify the bodyParser is disabled correctly, I tried another way when I printed context.

app.post("/debug", (c) => {
    console.log(c.env.incoming.body);
    return c.json({});
});

The body is an object depending on the request method.

curl localhost:3000 --data '{}' => [Object: null prototype] { '{}': '' }
curl localhost:3000 --data '{}' --H 'Content-Type: application/json' => {}

Then, I expected the bodyParser isn't disabled. According to this discussion in Next.js. I guess Vercel expects us to process it twice.

My environment is

// index.ts

// ...
export const config = {
    api: {
        bodyParser: false,
    },
};

export default handle(app);

And build with tsup --entry.index src/index.ts --clean --format cjs --out-dir api and I am sure the api/index.js is exported config

// ...

// src/index.ts
var import_vercel = require("@hono/node-server/vercel");
var config = {
  api: {
    bodyParser: false
  }
};
var src_default = (0, import_vercel.handle)(app_default);
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
  config
});

techwithanirudh · 2024-10-27T15:18:26Z

Hi, @yusukebe! I'm having a similar issue while using hono and deploying to firebase functions.

Any help would be appreciated!

RobertSasak added the bug label Nov 14, 2023

RobertSasak mentioned this issue Nov 14, 2023

Support for Firebase Functions #1358

Closed

yusukebe mentioned this issue Aug 4, 2024

CORS No 'Access-Control-Allow-Origin' header #3214

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeError: Response body object should not be disturbed or locked #1695

TypeError: Response body object should not be disturbed or locked #1695

RobertSasak commented Nov 14, 2023

yusukebe commented Nov 14, 2023

RobertSasak commented Nov 14, 2023

AverageHelper commented Nov 23, 2023

AverageHelper commented Nov 24, 2023

ZanzyTHEbar commented Jan 12, 2024

HananoshikaYomaru commented Jan 18, 2024

noidwasavailable commented Feb 8, 2024

cogoo commented Apr 2, 2024

yusukebe commented Apr 9, 2024

remorses commented Jun 4, 2024

Bobetti commented Aug 5, 2024

Bobetti commented Aug 19, 2024 •

edited

Loading

Bobetti commented Aug 19, 2024 •

edited

Loading

Bobetti commented Aug 26, 2024

yusukebe commented Aug 26, 2024

Bobetti commented Aug 26, 2024 •

edited

Loading

yusukebe commented Aug 30, 2024

Bobetti commented Aug 30, 2024

yusukebe commented Aug 30, 2024

Bobetti commented Aug 30, 2024

maxweisel commented Sep 23, 2024

yusukebe commented Sep 24, 2024

ivank commented Oct 3, 2024

elct9620 commented Oct 20, 2024 •

edited

Loading

techwithanirudh commented Oct 27, 2024

TypeError: Response body object should not be disturbed or locked #1695

TypeError: Response body object should not be disturbed or locked #1695

Comments

RobertSasak commented Nov 14, 2023

What version of Hono are you using?

What runtime/platform is your app running on?

What steps can reproduce the bug?

What is the expected behavior?

What do you see instead?

Additional information

yusukebe commented Nov 14, 2023

RobertSasak commented Nov 14, 2023

AverageHelper commented Nov 23, 2023

AverageHelper commented Nov 24, 2023

ZanzyTHEbar commented Jan 12, 2024

HananoshikaYomaru commented Jan 18, 2024

noidwasavailable commented Feb 8, 2024

cogoo commented Apr 2, 2024

yusukebe commented Apr 9, 2024

remorses commented Jun 4, 2024

Bobetti commented Aug 5, 2024

Bobetti commented Aug 19, 2024 • edited Loading

Bobetti commented Aug 19, 2024 • edited Loading

Bobetti commented Aug 26, 2024

yusukebe commented Aug 26, 2024

Bobetti commented Aug 26, 2024 • edited Loading

yusukebe commented Aug 30, 2024

Bobetti commented Aug 30, 2024

yusukebe commented Aug 30, 2024

Bobetti commented Aug 30, 2024

maxweisel commented Sep 23, 2024

yusukebe commented Sep 24, 2024

ivank commented Oct 3, 2024

elct9620 commented Oct 20, 2024 • edited Loading

✅ Do nothing

✅ Print context

❌ Print request

✅ Use c.env.incoming.body

techwithanirudh commented Oct 27, 2024

Bobetti commented Aug 19, 2024 •

edited

Loading

Bobetti commented Aug 19, 2024 •

edited

Loading

Bobetti commented Aug 26, 2024 •

edited

Loading

elct9620 commented Oct 20, 2024 •

edited

Loading

✅ Use `c.env.incoming.body`