@mswjs/interceptors 0.22.11 → 0.22.13

package/lib/node/RemoteHttpInterceptor.js

@@ -3,7 +3,7 @@
 var _chunkRJMXHEGJjs = require('./chunk-RJMXHEGJ.js');
 
 
-var _chunk7XU7Q63Wjs = require('./chunk-7XU7Q63W.js');
+var _chunkBGW7OOI4js = require('./chunk-BGW7OOI4.js');
 
 
 var _chunk2OJRZCGSjs = require('./chunk-2OJRZCGS.js');
@@ -23,7 +23,7 @@ var RemoteHttpInterceptor = class extends _chunkRJMXHEGJjs.BatchInterceptor {
     super({
       name: "remote-interceptor",
       interceptors: [
-        new (0, _chunk7XU7Q63Wjs.ClientRequestInterceptor)(),
+        new (0, _chunkBGW7OOI4js.ClientRequestInterceptor)(),
         new (0, _chunk2OJRZCGSjs.XMLHttpRequestInterceptor)()
       ]
     });

package/lib/node/RemoteHttpInterceptor.mjs

@@ -3,7 +3,7 @@ import {
 } from "./chunk-SBAVVQIW.mjs";
 import {
   ClientRequestInterceptor
-} from "./chunk-XVHIXGXD.mjs";
+} from "./chunk-JRKMZWAD.mjs";
 import {
   XMLHttpRequestInterceptor
 } from "./chunk-RL5IV5PL.mjs";

package/lib/node/{chunk-7XU7Q63W.js → chunk-BGW7OOI4.js}

@@ -323,6 +323,11 @@ var _NodeClientRequest = class extends _http.ClientRequest {
   }
   respondWith(mockedResponse) {
     this.logger.info("responding with a mocked response...", mockedResponse);
+    Object.defineProperties(this, {
+      writableFinished: { value: true },
+      writableEnded: { value: true }
+    });
+    this.emit("finish");
     const { status, statusText, headers, body } = mockedResponse;
     this.response.statusCode = status;
     this.response.statusMessage = statusText;
@@ -336,37 +341,33 @@ var _NodeClientRequest = class extends _http.ClientRequest {
       });
     }
     this.logger.info("mocked response headers ready:", headers);
-    const isResponseStreamRead = new (0, _deferredpromise.DeferredPromise)();
-    const closeResponseStream = () => {
-      this.logger.info("closing response stream...");
-      this.response.push(null);
-      this.response.complete = true;
-      isResponseStreamRead.resolve();
-      this.logger.info("closed response stream!");
+    const isResponseStreamFinished = new (0, _deferredpromise.DeferredPromise)();
+    const finishResponseStream = () => {
+      this.logger.info("finished response stream!");
+      isResponseStreamFinished.resolve();
     };
     if (body) {
       const bodyReader = body.getReader();
       const readNextChunk = async () => {
         const { done, value } = await bodyReader.read();
         if (done) {
-          closeResponseStream();
+          finishResponseStream();
           return;
         }
-        this.response.push(value);
+        this.response.emit("data", value);
         return readNextChunk();
       };
       readNextChunk();
     } else {
-      closeResponseStream();
+      finishResponseStream();
     }
-    isResponseStreamRead.then(() => {
-      this.res = this.response;
-      this.finished = true;
-      Object.defineProperty(this, "writableEnded", {
-        value: true
-      });
-      this.emit("finish");
-      this.emit("response", this.response);
+    this.res = this.response;
+    this.emit("response", this.response);
+    isResponseStreamFinished.then(() => {
+      this.logger.info("finalizing response...");
+      this.response.push(null);
+      this.response.complete = true;
+      this.response.emit("end");
       this.terminate();
     });
   }

package/lib/node/{chunk-XVHIXGXD.mjs → chunk-JRKMZWAD.mjs}

@@ -323,6 +323,11 @@ var _NodeClientRequest = class extends ClientRequest {
   }
   respondWith(mockedResponse) {
     this.logger.info("responding with a mocked response...", mockedResponse);
+    Object.defineProperties(this, {
+      writableFinished: { value: true },
+      writableEnded: { value: true }
+    });
+    this.emit("finish");
     const { status, statusText, headers, body } = mockedResponse;
     this.response.statusCode = status;
     this.response.statusMessage = statusText;
@@ -336,37 +341,33 @@ var _NodeClientRequest = class extends ClientRequest {
       });
     }
     this.logger.info("mocked response headers ready:", headers);
-    const isResponseStreamRead = new DeferredPromise();
-    const closeResponseStream = () => {
-      this.logger.info("closing response stream...");
-      this.response.push(null);
-      this.response.complete = true;
-      isResponseStreamRead.resolve();
-      this.logger.info("closed response stream!");
+    const isResponseStreamFinished = new DeferredPromise();
+    const finishResponseStream = () => {
+      this.logger.info("finished response stream!");
+      isResponseStreamFinished.resolve();
     };
     if (body) {
       const bodyReader = body.getReader();
       const readNextChunk = async () => {
         const { done, value } = await bodyReader.read();
         if (done) {
-          closeResponseStream();
+          finishResponseStream();
           return;
         }
-        this.response.push(value);
+        this.response.emit("data", value);
         return readNextChunk();
       };
       readNextChunk();
     } else {
-      closeResponseStream();
+      finishResponseStream();
     }
-    isResponseStreamRead.then(() => {
-      this.res = this.response;
-      this.finished = true;
-      Object.defineProperty(this, "writableEnded", {
-        value: true
-      });
-      this.emit("finish");
-      this.emit("response", this.response);
+    this.res = this.response;
+    this.emit("response", this.response);
+    isResponseStreamFinished.then(() => {
+      this.logger.info("finalizing response...");
+      this.response.push(null);
+      this.response.complete = true;
+      this.response.emit("end");
       this.terminate();
     });
   }

package/lib/node/interceptors/ClientRequest/index.js

@@ -1,8 +1,8 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk7XU7Q63Wjs = require('../../chunk-7XU7Q63W.js');
+var _chunkBGW7OOI4js = require('../../chunk-BGW7OOI4.js');
 require('../../chunk-ZJOF5MEZ.js');
 require('../../chunk-6KJ5M2VR.js');
 
 
-exports.ClientRequestInterceptor = _chunk7XU7Q63Wjs.ClientRequestInterceptor;
+exports.ClientRequestInterceptor = _chunkBGW7OOI4js.ClientRequestInterceptor;

package/lib/node/interceptors/ClientRequest/index.mjs

@@ -1,6 +1,6 @@
 import {
   ClientRequestInterceptor
-} from "../../chunk-XVHIXGXD.mjs";
+} from "../../chunk-JRKMZWAD.mjs";
 import "../../chunk-STA6QBYM.mjs";
 import "../../chunk-3V5OWTY7.mjs";
 export {

package/lib/node/presets/node.js

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk7XU7Q63Wjs = require('../chunk-7XU7Q63W.js');
+var _chunkBGW7OOI4js = require('../chunk-BGW7OOI4.js');
 
 
 var _chunk2OJRZCGSjs = require('../chunk-2OJRZCGS.js');
@@ -11,7 +11,7 @@ require('../chunk-6KJ5M2VR.js');
 
 // src/presets/node.ts
 var node_default = [
-  new (0, _chunk7XU7Q63Wjs.ClientRequestInterceptor)(),
+  new (0, _chunkBGW7OOI4js.ClientRequestInterceptor)(),
   new (0, _chunk2OJRZCGSjs.XMLHttpRequestInterceptor)()
 ];
 

package/lib/node/presets/node.mjs

@@ -1,6 +1,6 @@
 import {
   ClientRequestInterceptor
-} from "../chunk-XVHIXGXD.mjs";
+} from "../chunk-JRKMZWAD.mjs";
 import {
   XMLHttpRequestInterceptor
 } from "../chunk-RL5IV5PL.mjs";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mswjs/interceptors",
   "description": "Low-level HTTP/HTTPS/XHR/fetch request interception library.",
-  "version": "0.22.11",
+  "version": "0.22.13",
   "main": "./lib/node/index.js",
   "module": "./lib/node/index.mjs",
   "types": "./lib/node/index.d.ts",
@@ -138,7 +138,7 @@
   },
   "dependencies": {
     "@open-draft/deferred-promise": "^2.1.0",
-    "@open-draft/logger": "^0.2.0",
+    "@open-draft/logger": "^0.3.0",
     "@open-draft/until": "^2.0.0",
     "headers-polyfill": "^3.1.0",
     "outvariant": "^1.2.1",

package/src/interceptors/ClientRequest/NodeClientRequest.test.ts

@@ -62,22 +62,29 @@ it('gracefully finishes the request when it has a mocked response', async () =>
   request.end()
 
   const responseReceived = new DeferredPromise<IncomingMessage>()
+
   request.on('response', async (response) => {
     responseReceived.resolve(response)
   })
   const response = await responseReceived
 
-  // Request must be marked as finished.
-  expect(request.finished).toEqual(true)
-  expect(request.writableEnded).toEqual(true)
-  expect(request.writableFinished).toEqual(true)
-  expect(request.writableCorked).toEqual(0)
-
-  expect(response.statusCode).toEqual(301)
-  expect(response.headers).toHaveProperty('x-custom-header', 'yes')
+  // Request must be marked as finished as soon as it's sent.
+  expect(request.writableEnded).toBe(true)
+  expect(request.writableFinished).toBe(true)
+  expect(request.writableCorked).toBe(0)
 
+  /**
+   * Consume the response body, which will handle the "data" and "end"
+   * events of the incoming message. After this point, the response is finished.
+   */
   const text = await getIncomingMessageBody(response)
-  expect(text).toEqual('mocked-response')
+
+  // Response must be marked as finished as soon as its done.
+  expect(request['response'].complete).toBe(true)
+
+  expect(response.statusCode).toBe(301)
+  expect(response.headers).toHaveProperty('x-custom-header', 'yes')
+  expect(text).toBe('mocked-response')
 })
 
 it('responds with a mocked response when requesting an existing hostname', async () => {
@@ -102,10 +109,10 @@ it('responds with a mocked response when requesting an existing hostname', async
   })
   const response = await responseReceived
 
-  expect(response.statusCode).toEqual(201)
+  expect(response.statusCode).toBe(201)
 
   const text = await getIncomingMessageBody(response)
-  expect(text).toEqual('mocked-response')
+  expect(text).toBe('mocked-response')
 })
 
 it('performs the request as-is given resolver returned no mocked response', async () => {
@@ -128,15 +135,15 @@ it('performs the request as-is given resolver returned no mocked response', asyn
   })
   const response = await responseReceived
 
-  expect(request.finished).toEqual(true)
-  expect(request.writableEnded).toEqual(true)
+  expect(request.finished).toBe(true)
+  expect(request.writableEnded).toBe(true)
 
-  expect(response.statusCode).toEqual(200)
-  expect(response.statusMessage).toEqual('OK')
+  expect(response.statusCode).toBe(200)
+  expect(response.statusMessage).toBe('OK')
   expect(response.headers).toHaveProperty('x-powered-by', 'Express')
 
   const text = await getIncomingMessageBody(response)
-  expect(text).toEqual('original-response')
+  expect(text).toBe('original-response')
 })
 
 it('emits the ENOTFOUND error connecting to a non-existing hostname given no mocked response', async () => {
@@ -153,8 +160,8 @@ it('emits the ENOTFOUND error connecting to a non-existing hostname given no moc
   })
   const error = await errorReceived
 
-  expect(error.code).toEqual('ENOTFOUND')
-  expect(error.syscall).toEqual('getaddrinfo')
+  expect(error.code).toBe('ENOTFOUND')
+  expect(error.syscall).toBe('getaddrinfo')
 })
 
 it('emits the ECONNREFUSED error connecting to an inactive server given no mocked response', async () => {
@@ -177,10 +184,10 @@ it('emits the ECONNREFUSED error connecting to an inactive server given no mocke
 
   const error = await errorReceived
 
-  expect(error.code).toEqual('ECONNREFUSED')
-  expect(error.syscall).toEqual('connect')
-  expect(error.address).toEqual('127.0.0.1')
-  expect(error.port).toEqual(12345)
+  expect(error.code).toBe('ECONNREFUSED')
+  expect(error.syscall).toBe('connect')
+  expect(error.address).toBe('127.0.0.1')
+  expect(error.port).toBe(12345)
 })
 
 it('does not emit ENOTFOUND error connecting to an inactive server given mocked response', async () => {
@@ -209,8 +216,8 @@ it('does not emit ENOTFOUND error connecting to an inactive server given mocked
   const response = await responseReceived
 
   expect(handleError).not.toHaveBeenCalled()
-  expect(response.statusCode).toEqual(200)
-  expect(response.statusMessage).toEqual('Works')
+  expect(response.statusCode).toBe(200)
+  expect(response.statusMessage).toBe('Works')
 })
 
 it('does not emit ECONNREFUSED error connecting to an inactive server given mocked response', async () => {
@@ -241,8 +248,8 @@ it('does not emit ECONNREFUSED error connecting to an inactive server given mock
   const response = await responseReceived
 
   expect(handleError).not.toHaveBeenCalled()
-  expect(response.statusCode).toEqual(200)
-  expect(response.statusMessage).toEqual('Works')
+  expect(response.statusCode).toBe(200)
+  expect(response.statusMessage).toBe('Works')
 })
 
 it('sends the request body to the server given no mocked response', async () => {
@@ -270,10 +277,10 @@ it('sends the request body to the server given no mocked response', async () =>
   })
   const response = await responseReceived
 
-  expect(response.statusCode).toEqual(200)
+  expect(response.statusCode).toBe(200)
 
   const text = await getIncomingMessageBody(response)
-  expect(text).toEqual('onetwothree')
+  expect(text).toBe('onetwothree')
 })
 
 it('does not send request body to the original server given mocked response', async () => {
@@ -303,8 +310,8 @@ it('does not send request body to the original server given mocked response', as
   })
   const response = await responseReceived
 
-  expect(response.statusCode).toEqual(301)
+  expect(response.statusCode).toBe(301)
 
   const text = await getIncomingMessageBody(response)
-  expect(text).toEqual('mock created!')
+  expect(text).toBe('mock created!')
 })

package/src/interceptors/ClientRequest/NodeClientRequest.ts

@@ -370,6 +370,20 @@ export class NodeClientRequest extends ClientRequest {
   private respondWith(mockedResponse: Response): void {
     this.logger.info('responding with a mocked response...', mockedResponse)
 
+    /**
+     * Mark the request as finished right before streaming back the response.
+     * This is not entirely conventional but this will allow the consumer to
+     * modify the outoging request in the interceptor.
+     *
+     * The request is finished when its headers and bodies have been sent.
+     * @see https://nodejs.org/api/http.html#event-finish
+     */
+    Object.defineProperties(this, {
+      writableFinished: { value: true },
+      writableEnded: { value: true },
+    })
+    this.emit('finish')
+
     const { status, statusText, headers, body } = mockedResponse
     this.response.statusCode = status
     this.response.statusMessage = statusText
@@ -392,18 +406,11 @@ export class NodeClientRequest extends ClientRequest {
     }
     this.logger.info('mocked response headers ready:', headers)
 
-    const isResponseStreamRead = new DeferredPromise<void>()
-
-    const closeResponseStream = () => {
-      this.logger.info('closing response stream...')
-
-      // Push "null" to indicate that the response body is complete
-      // and shouldn't be written to anymore.
-      this.response.push(null)
-      this.response.complete = true
+    const isResponseStreamFinished = new DeferredPromise<void>()
 
-      isResponseStreamRead.resolve()
-      this.logger.info('closed response stream!')
+    const finishResponseStream = () => {
+      this.logger.info('finished response stream!')
+      isResponseStreamFinished.resolve()
     }
 
     if (body) {
@@ -412,38 +419,41 @@ export class NodeClientRequest extends ClientRequest {
         const { done, value } = await bodyReader.read()
 
         if (done) {
-          closeResponseStream()
+          finishResponseStream()
           return
         }
 
-        // this.response.push(Buffer.from(body))
-        this.response.push(value)
+        this.response.emit('data', value)
 
         return readNextChunk()
       }
 
       readNextChunk()
     } else {
-      closeResponseStream()
+      finishResponseStream()
     }
 
-    isResponseStreamRead.then(() => {
-      /**
-       * Set the internal "res" property to the mocked "OutgoingMessage"
-       * to make the "ClientRequest" instance think there's data received
-       * from the socket.
-       * @see https://github.com/nodejs/node/blob/9c405f2591f5833d0247ed0fafdcd68c5b14ce7a/lib/_http_client.js#L501
-       */
-      // @ts-ignore
-      this.res = this.response
+    /**
+     * Set the internal "res" property to the mocked "OutgoingMessage"
+     * to make the "ClientRequest" instance think there's data received
+     * from the socket.
+     * @see https://github.com/nodejs/node/blob/9c405f2591f5833d0247ed0fafdcd68c5b14ce7a/lib/_http_client.js#L501
+     *
+     * Set the response immediately so the interceptor could stream data
+     * chunks to the request client as they come in.
+     */
+    // @ts-ignore
+    this.res = this.response
+    this.emit('response', this.response)
 
-      this.finished = true
-      Object.defineProperty(this, 'writableEnded', {
-        value: true,
-      })
+    isResponseStreamFinished.then(() => {
+      this.logger.info('finalizing response...')
 
-      this.emit('finish')
-      this.emit('response', this.response)
+      // Push "null" to indicate that the response body is complete
+      // and shouldn't be written to anymore.
+      this.response.push(null)
+      this.response.complete = true
+      this.response.emit('end')
 
       this.terminate()
     })