test: add test cases for partially consumed and cancelled request body

Author: usualoma

README.md

@@ -128,7 +128,7 @@ serve({
 ### `autoCleanupIncoming`
 
 The default value is `true`. The Node.js Adapter automatically cleans up (explicitly call `destroy()` method) if application is not finished to consume the incoming request. If you don't want to do that, set `false`.
-If the application accepts connections from arbitrary clients, this cleanup must be done otherwise incomplete requests from clients may cause the application to stop responding. If your application only accepts connections from trusted clients, such as in a reverse proxy environment, you can improve performance by setting it to false.
+If the application accepts connections from arbitrary clients, this cleanup must be done otherwise incomplete requests from clients may cause the application to stop responding. If your application only accepts connections from trusted clients, such as in a reverse proxy environment and there is no process that returns a response without reading the body of the POST request all the way through, you can improve performance by setting it to false.
 
 ```ts
 serve({

test/app.ts

@@ -0,0 +1,69 @@
+import { Response as PonyfillResponse } from '@whatwg-node/fetch'
+import { Hono } from 'hono'
+
+export const app = new Hono()
+
+app.get('/', (c) => c.text('Hello! Node!'))
+app.get('/url', (c) => c.text(c.req.url))
+
+app.get('/posts', (c) => {
+  return c.text(`Page ${c.req.query('page')}`)
+})
+app.get('/user-agent', (c) => {
+  return c.text(c.req.header('user-agent') as string)
+})
+app.post('/posts', (c) => {
+  return c.redirect('/posts')
+})
+app.post('/body-consumed', async (c) => {
+  return c.text(`Body length: ${(await c.req.text()).length}`)
+})
+app.post('/no-body-consumed', (c) => {
+  if (!c.req.raw.body) {
+    // force create new request object
+    throw new Error('No body consumed')
+  }
+  return c.text('No body consumed')
+})
+app.post('/body-cancelled', (c) => {
+  if (!c.req.raw.body) {
+    // force create new request object
+    throw new Error('No body consumed')
+  }
+  c.req.raw.body.cancel()
+  return c.text('Body cancelled')
+})
+app.post('/partially-consumed', async (c) => {
+  if (!c.req.raw.body) {
+    // force create new request object
+    throw new Error('No body consumed')
+  }
+  const reader = c.req.raw.body.getReader()
+  await reader.read() // read only one chunk
+  return c.text('Partially consumed')
+})
+app.post('/partially-consumed-and-cancelled', async (c) => {
+  if (!c.req.raw.body) {
+    // force create new request object
+    throw new Error('No body consumed')
+  }
+  const reader = c.req.raw.body.getReader()
+  await reader.read() // read only one chunk
+  reader.cancel()
+  return c.text('Partially consumed and cancelled')
+})
+app.delete('/posts/:id', (c) => {
+  return c.text(`DELETE ${c.req.param('id')}`)
+})
+// @ts-expect-error the response is string
+app.get('/invalid', () => {
+  return '<h1>HTML</h1>'
+})
+app.get('/ponyfill', () => {
+  return new PonyfillResponse('Pony')
+})
+
+app.on('trace', '/', (c) => {
+  const headers = c.req.raw.headers // build new request object
+  return c.text(`headers: ${JSON.stringify(headers)}`)
+})

test/server.test.ts

@@ -1,4 +1,3 @@
-import { Response as PonyfillResponse } from '@whatwg-node/fetch'
 import { Hono } from 'hono'
 import { basicAuth } from 'hono/basic-auth'
 import { compress } from 'hono/compress'
@@ -13,37 +12,9 @@ import { GlobalRequest, Request as LightweightRequest, getAbortController } from
 import { GlobalResponse, Response as LightweightResponse } from '../src/response'
 import { createAdaptorServer, serve } from '../src/server'
 import type { HttpBindings } from '../src/types'
+import { app } from './app'
 
 describe('Basic', () => {
-  const app = new Hono()
-  app.get('/', (c) => c.text('Hello! Node!'))
-  app.get('/url', (c) => c.text(c.req.url))
-
-  app.get('/posts', (c) => {
-    return c.text(`Page ${c.req.query('page')}`)
-  })
-  app.get('/user-agent', (c) => {
-    return c.text(c.req.header('user-agent') as string)
-  })
-  app.post('/posts', (c) => {
-    return c.redirect('/posts')
-  })
-  app.delete('/posts/:id', (c) => {
-    return c.text(`DELETE ${c.req.param('id')}`)
-  })
-  // @ts-expect-error the response is string
-  app.get('/invalid', () => {
-    return '<h1>HTML</h1>'
-  })
-  app.get('/ponyfill', () => {
-    return new PonyfillResponse('Pony')
-  })
-
-  app.on('trace', '/', (c) => {
-    const headers = c.req.raw.headers // build new request object
-    return c.text(`headers: ${JSON.stringify(headers)}`)
-  })
-
   const server = createAdaptorServer(app)
 
   it('Should return 200 response - GET /', async () => {
@@ -82,6 +53,60 @@ describe('Basic', () => {
     expect(res.headers['location']).toBe('/posts')
   })
 
+  it('Should return 200 response - POST /no-body-consumed', async () => {
+    const res = await request(server).post('/no-body-consumed').send('')
+    expect(res.status).toBe(200)
+    expect(res.text).toBe('No body consumed')
+  })
+
+  it('Should return 200 response - POST /body-cancelled', async () => {
+    const res = await request(server).post('/body-cancelled').send('')
+    expect(res.status).toBe(200)
+    expect(res.text).toBe('Body cancelled')
+  })
+
+  it('Should return 200 response - POST /partially-consumed', async () => {
+    const buffer = Buffer.alloc(1024 * 10) // large buffer
+    const res = await new Promise<any>((resolve, reject) => {
+      const req = request(server)
+        .post('/partially-consumed')
+        .set('Content-Length', buffer.length.toString())
+
+      req.write(buffer)
+      req.end((err, res) => {
+        if (err) {
+          reject(err)
+        } else {
+          resolve(res)
+        }
+      })
+    })
+
+    expect(res.status).toBe(200)
+    expect(res.text).toBe('Partially consumed')
+  })
+
+  it('Should return 200 response - POST /partially-consumed-and-cancelled', async () => {
+    const buffer = Buffer.alloc(1) // A large buffer will not make the test go far, so keep it small because it won't go far.
+    const res = await new Promise<any>((resolve, reject) => {
+      const req = request(server)
+        .post('/partially-consumed-and-cancelled')
+        .set('Content-Length', buffer.length.toString())
+
+      req.write(buffer)
+      req.end((err, res) => {
+        if (err) {
+          reject(err)
+        } else {
+          resolve(res)
+        }
+      })
+    })
+
+    expect(res.status).toBe(200)
+    expect(res.text).toBe('Partially consumed and cancelled')
+  })
+
   it('Should return 201 response - DELETE /posts/123', async () => {
     const res = await request(server).delete('/posts/123')
     expect(res.status).toBe(200)