fix: support Readable as request body (#527)

Co-authored-by: Michael Solomon <[email protected]>

src/interceptors/ClientRequest/MockHttpSocket.ts

@@ -335,7 +335,14 @@ export class MockHttpSocket extends MockSocket {
     // this ensures that each request gets its own stream.
     // One Socket instance can only handle one request at a time.
     if (canHaveBody) {
-      this.requestStream = new Readable()
+      this.requestStream = new Readable({
+        /**
+         * @note Provide the `read()` method so a `Readable` could be
+         * used as the actual request body (the stream calls "read()").
+         * We control the queue in the onRequestBody/End functions.
+         */
+        read: () => {},
+      })
     }
 
     const requestId = randomUUID()

src/interceptors/Socket/MockSocket.ts

@@ -34,7 +34,7 @@ export class MockSocket extends net.Socket {
   public write(...args: Array<unknown>): boolean {
     const [chunk, encoding, callback] = normalizeWriteArgs(args as WriteArgs)
     this.options.write(chunk, encoding, callback)
-    return false
+    return true
   }
 
   public end(...args: Array<unknown>) {

test/modules/http/compliance/http-req-write.test.ts

@@ -1,12 +1,13 @@
 /**
  * @vitest-environment node
  */
+import { Readable } from 'node:stream'
 import { vi, it, expect, beforeAll, afterEach, afterAll } from 'vitest'
 import http from 'node:http'
 import express from 'express'
 import { HttpServer } from '@open-draft/test-server/http'
 import { ClientRequestInterceptor } from '../../../../src/interceptors/ClientRequest'
-import { waitForClientRequest } from '../../../helpers'
+import { sleep, waitForClientRequest } from '../../../helpers'
 
 const httpServer = new HttpServer((app) => {
   app.post('/resource', express.text({ type: '*/*' }), (req, res) => {
@@ -93,6 +94,31 @@ it('writes Buffer request body', async () => {
   expect(await text()).toEqual(expectedBody)
 })
 
+it('supports Readable as the request body', async () => {
+  const req = http.request(httpServer.http.url('/resource'), {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  })
+
+  const input = ['hello', ' ', 'world', null]
+  const readable = new Readable({
+    read: async function() {
+      await sleep(10)
+      this.push(input.shift())
+    },
+  })
+
+  readable.pipe(req)
+
+  const { text } = await waitForClientRequest(req)
+  const expectedBody = 'hello world'
+
+  expect(interceptedRequestBody).toHaveBeenCalledWith(expectedBody)
+  expect(await text()).toEqual(expectedBody)
+})
+
 it('calls the callback when writing an empty string', async () => {
   const request = http.request(httpServer.http.url('/resource'), {
     method: 'POST',

test/modules/http/regressions/http-concurrent-same-host.test.ts

@@ -10,8 +10,6 @@ let requests: Array<Request> = []
 
 const interceptor = new ClientRequestInterceptor()
 interceptor.on('request', ({ request }) => {
-  console.log('REQUEST', request.method, request.url)
-
   requests.push(request)
   request.respondWith(new Response())
 })