@mswjs/interceptors 0.23.0 → 0.24.1

package/README.md

@@ -206,7 +206,7 @@ All HTTP request interceptors emit a "request" event. In the listener to this ev
 > There are many ways to describe a request in Node.js but this library coerces different request definitions to a single specification-compliant `Request` instance to make the handling consistent.
 
 ```js
-interceptor.on('reqest', ({ request, requestId }) => {
+interceptor.on('request', ({ request, requestId }) => {
   console.log(request.method, request.url)
 })
 ```

package/lib/{node/chunk-IHW3ERPT.js → browser/chunk-3LFH2WCF.js}

@@ -1,12 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkMPFSBY4Sjs = require('./chunk-MPFSBY4S.js');
-
-// src/shims/webEncoding.ts
-var TextEncoder = typeof globalThis.TextEncoder === "undefined" ? _chunkMPFSBY4Sjs.__require.call(void 0, "util").TextEncoder : globalThis.TextEncoder;
-var TextDecoder = typeof globalThis.TextDecoder === "undefined" ? _chunkMPFSBY4Sjs.__require.call(void 0, "util").TextDecoder : globalThis.TextDecoder;
-
-// src/utils/bufferUtils.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/utils/bufferUtils.ts
 var encoder = new TextEncoder();
 function encodeBuffer(text) {
   return encoder.encode(text);

package/lib/{node/chunk-MPFSBY4S.js → browser/chunk-4CFMDU7Z.js}

@@ -1,10 +1,5 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw new Error('Dynamic require of "' + x + '" is not supported');
-});
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/glossary.ts
+var IS_PATCHED_MODULE = Symbol("isPatchedModule");
 
 // src/Interceptor.ts
 var _logger = require('@open-draft/logger');
@@ -71,6 +66,11 @@ var AsyncEventEmitter = class extends _stricteventemitter.Emitter {
     });
     return super.emit(eventName, ...data);
   }
+  /**
+   * Returns a promise that resolves when all the listeners for the given event
+   * has been called. Awaits asynchronous listeners.
+   * If the event has no listeners, resolves immediately.
+   */
   async untilIdle(eventName, filter = () => true) {
     const listenersQueue = this.queue.get(eventName) || [];
     await Promise.all(
@@ -112,6 +112,11 @@ var AsyncEventEmitter = class extends _stricteventemitter.Emitter {
     this.readyState = "ACTIVE" /* ACTIVE */;
     logger.info("set state to:", this.readyState);
   }
+  /**
+   * Deactivate this event emitter.
+   * Deactivated emitter can no longer emit and listen to events
+   * and needs to be activated again in order to do so.
+   */
   deactivate() {
     const logger = this.logger.extend("deactivate");
     logger.info("removing all listeners...");
@@ -126,7 +131,10 @@ var AsyncEventEmitter = class extends _stricteventemitter.Emitter {
 
 // src/Interceptor.ts
 function getGlobalSymbol(symbol) {
-  return globalThis[symbol] || void 0;
+  return (
+    // @ts-ignore https://github.com/Microsoft/TypeScript/issues/24587
+    globalThis[symbol] || void 0
+  );
 }
 function setGlobalSymbol(symbol, value) {
   globalThis[symbol] = value;
@@ -152,9 +160,17 @@ var Interceptor = class {
     this.emitter.setMaxListeners(0);
     this.logger.info("constructing the interceptor...");
   }
+  /**
+   * Determine if this interceptor can be applied
+   * in the current environment.
+   */
   checkEnvironment() {
     return true;
   }
+  /**
+   * Apply this interceptor to the current process.
+   * Returns an already running interceptor instance if it's present.
+   */
   apply() {
     const logger = this.logger.extend("apply");
     logger.info("applying the interceptor...");
@@ -189,8 +205,16 @@ var Interceptor = class {
     this.setInstance();
     this.readyState = "APPLIED" /* APPLIED */;
   }
+  /**
+   * Setup the module augments and stubs necessary for this interceptor.
+   * This method is not run if there's a running interceptor instance
+   * to prevent instantiating an interceptor multiple times.
+   */
   setup() {
   }
+  /**
+   * Listen to the interceptor's public events.
+   */
   on(eventName, listener) {
     const logger = this.logger.extend("on");
     if (this.readyState === "DISPOSING" /* DISPOSING */ || this.readyState === "DISPOSED" /* DISPOSED */) {
@@ -200,6 +224,9 @@ var Interceptor = class {
     logger.info('adding "%s" event listener:', eventName, listener.name);
     this.emitter.on(eventName, listener);
   }
+  /**
+   * Disposes of any side-effects this interceptor has introduced.
+   */
   dispose() {
     const logger = this.logger.extend("dispose");
     if (this.readyState === "DISPOSED" /* DISPOSED */) {
@@ -248,4 +275,4 @@ var Interceptor = class {
 
 
 
-exports.__require = __require; exports.getGlobalSymbol = getGlobalSymbol; exports.deleteGlobalSymbol = deleteGlobalSymbol; exports.InterceptorReadyState = InterceptorReadyState; exports.Interceptor = Interceptor;
+exports.IS_PATCHED_MODULE = IS_PATCHED_MODULE; exports.getGlobalSymbol = getGlobalSymbol; exports.deleteGlobalSymbol = deleteGlobalSymbol; exports.InterceptorReadyState = InterceptorReadyState; exports.Interceptor = Interceptor;

package/lib/{node/chunk-LTX5IGCQ.mjs → browser/chunk-7II4SWKS.mjs}

@@ -1,11 +1,3 @@
-import {
-  __require
-} from "./chunk-Y5QA6OEZ.mjs";
-
-// src/shims/webEncoding.ts
-var TextEncoder = typeof globalThis.TextEncoder === "undefined" ? __require("util").TextEncoder : globalThis.TextEncoder;
-var TextDecoder = typeof globalThis.TextDecoder === "undefined" ? __require("util").TextDecoder : globalThis.TextDecoder;
-
 // src/utils/bufferUtils.ts
 var encoder = new TextEncoder();
 function encodeBuffer(text) {

package/lib/browser/{chunk-DWXGORCS.mjs → chunk-BRIUGDYQ.mjs}

@@ -2,7 +2,7 @@ import {
   decodeBuffer,
   encodeBuffer,
   toArrayBuffer
-} from "./chunk-MQA5WAD4.mjs";
+} from "./chunk-7II4SWKS.mjs";
 import {
   toInteractiveRequest,
   uuidv4
@@ -10,7 +10,7 @@ import {
 import {
   IS_PATCHED_MODULE,
   Interceptor
-} from "./chunk-MW6NCDWE.mjs";
+} from "./chunk-GXJLJMOT.mjs";
 
 // src/interceptors/XMLHttpRequest/index.ts
 import { invariant as invariant2 } from "outvariant";
@@ -20,7 +20,7 @@ import { until } from "@open-draft/until";
 
 // src/interceptors/XMLHttpRequest/XMLHttpRequestController.ts
 import { invariant } from "outvariant";
-import { headersToString } from "headers-polyfill";
+import { isNodeProcess } from "is-node-process";
 
 // src/interceptors/XMLHttpRequest/utils/concatArrayBuffer.ts
 function concatArrayBuffer(left, right) {
@@ -202,17 +202,34 @@ function parseJson(data) {
 }
 
 // src/interceptors/XMLHttpRequest/utils/createResponse.ts
-import { stringToHeaders } from "headers-polyfill";
-function createResponse(request, responseBody) {
-  return new Response(responseBody, {
+var statusCodesWithoutBody = [204, 205, 304];
+function createResponse(request, body) {
+  const responseBodyOrNull = statusCodesWithoutBody.includes(request.status) ? null : body;
+  return new Response(responseBodyOrNull, {
     status: request.status,
     statusText: request.statusText,
-    headers: stringToHeaders(request.getAllResponseHeaders())
+    headers: createHeadersFromXMLHttpReqestHeaders(
+      request.getAllResponseHeaders()
+    )
   });
 }
+function createHeadersFromXMLHttpReqestHeaders(headersString) {
+  const headers = new Headers();
+  const lines = headersString.split(/[\r\n]+/);
+  for (const line of lines) {
+    if (line.trim() === "") {
+      continue;
+    }
+    const [name, ...parts] = line.split(": ");
+    const value = parts.join(": ");
+    headers.append(name, value);
+  }
+  return headers;
+}
 
 // src/interceptors/XMLHttpRequest/XMLHttpRequestController.ts
 var IS_MOCKED_RESPONSE = Symbol("isMockedResponse");
+var IS_NODE = isNodeProcess();
 var XMLHttpRequestController = class {
   constructor(initialRequest, logger) {
     this.initialRequest = initialRequest;
@@ -220,6 +237,7 @@ var XMLHttpRequestController = class {
     this.method = "GET";
     this.url = null;
     this.events = /* @__PURE__ */ new Map();
+    this.requestId = uuidv4();
     this.requestHeaders = new Headers();
     this.responseBuffer = new Uint8Array();
     this.request = createProxy(initialRequest, {
@@ -242,7 +260,6 @@ var XMLHttpRequestController = class {
         switch (methodName) {
           case "open": {
             const [method, url] = args;
-            this.requestId = uuidv4();
             if (typeof url === "undefined") {
               this.method = "GET";
               this.url = toAbsoluteUrl(method);
@@ -275,6 +292,11 @@ var XMLHttpRequestController = class {
               if (typeof this.onResponse !== "undefined") {
                 const fetchResponse = createResponse(
                   this.request,
+                  /**
+                   * The `response` property is the right way to read
+                   * the ambiguous response body, as the request's "responseType" may differ.
+                   * @see https://xhr.spec.whatwg.org/#the-response-attribute
+                   */
                   this.request.response
                 );
                 this.onResponse.call(this, {
@@ -296,7 +318,9 @@ var XMLHttpRequestController = class {
                   "request callback settled but request has not been handled (readystate %d), performing as-is...",
                   this.request.readyState
                 );
-                this.request.setRequestHeader("X-Request-Id", this.requestId);
+                if (IS_NODE) {
+                  this.request.setRequestHeader("X-Request-Id", this.requestId);
+                }
                 return invoke();
               }
             });
@@ -315,6 +339,10 @@ var XMLHttpRequestController = class {
     this.events.set(eventName, nextEvents);
     this.logger.info('registered event "%s"', eventName, listener.name);
   }
+  /**
+   * Responds to the current request with the given
+   * Fetch API `Response` instance.
+   */
   respondWith(response) {
     this.logger.info(
       "responding with a mocked response: %d %s",
@@ -350,7 +378,10 @@ var XMLHttpRequestController = class {
             this.logger.info("headers not received yet, returning empty string");
             return "";
           }
-          const allHeaders = headersToString(response.headers);
+          const headersList = Array.from(response.headers.entries());
+          const allHeaders = headersList.map(([headerName, headerValue]) => {
+            return `${headerName}: ${headerValue}`;
+          }).join("\r\n");
           this.logger.info("resolved all response headers to", allHeaders);
           return allHeaders;
         }
@@ -373,7 +404,12 @@ var XMLHttpRequestController = class {
         get: () => this.responseXML
       }
     });
-    const totalResponseBodyLength = response.headers.has("Content-Length") ? Number(response.headers.get("Content-Length")) : void 0;
+    const totalResponseBodyLength = response.headers.has("Content-Length") ? Number(response.headers.get("Content-Length")) : (
+      /**
+       * @todo Infer the response body length from the response body.
+       */
+      void 0
+    );
     this.logger.info("calculated response body length", totalResponseBodyLength);
     this.trigger("loadstart", {
       loaded: 0,
@@ -504,6 +540,9 @@ var XMLHttpRequestController = class {
     this.trigger("error");
     this.trigger("loadend");
   }
+  /**
+   * Transitions this request's `readyState` to the given one.
+   */
   setReadyState(nextReadyState) {
     this.logger.info(
       "setReadyState: %d -> %d",
@@ -521,6 +560,9 @@ var XMLHttpRequestController = class {
       this.trigger("readystatechange");
     }
   }
+  /**
+   * Triggers given event on the `XMLHttpRequest` instance.
+   */
   trigger(eventName, options) {
     const callback = this.request[`on${eventName}`];
     const event = createEvent(this.request, eventName, options);
@@ -540,11 +582,17 @@ var XMLHttpRequestController = class {
       }
     }
   }
+  /**
+   * Converts this `XMLHttpRequest` instance into a Fetch API `Request` instance.
+   */
   toFetchApiRequest() {
     this.logger.info("converting request to a Fetch API Request...");
     const fetchRequest = new Request(this.url.href, {
       method: this.method,
       headers: this.requestHeaders,
+      /**
+       * @see https://xhr.spec.whatwg.org/#cross-origin-credentials
+       */
       credentials: this.request.withCredentials ? "include" : "same-origin",
       body: ["GET", "HEAD"].includes(this.method) ? null : this.requestBody
     });
@@ -578,6 +626,7 @@ function toAbsoluteUrl(url) {
 }
 function define(target, property, value) {
   Reflect.defineProperty(target, property, {
+    // Ensure writable properties to allow redefining readonly properties.
     writable: true,
     enumerable: true,
     value

package/lib/browser/{chunk-MW6NCDWE.mjs → chunk-GXJLJMOT.mjs}

@@ -1,8 +1,3 @@
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __commonJS = (cb, mod) => function __require() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-};
-
 // src/glossary.ts
 var IS_PATCHED_MODULE = Symbol("isPatchedModule");
 
@@ -71,6 +66,11 @@ var AsyncEventEmitter = class extends Emitter {
     });
     return super.emit(eventName, ...data);
   }
+  /**
+   * Returns a promise that resolves when all the listeners for the given event
+   * has been called. Awaits asynchronous listeners.
+   * If the event has no listeners, resolves immediately.
+   */
   async untilIdle(eventName, filter = () => true) {
     const listenersQueue = this.queue.get(eventName) || [];
     await Promise.all(
@@ -112,6 +112,11 @@ var AsyncEventEmitter = class extends Emitter {
     this.readyState = "ACTIVE" /* ACTIVE */;
     logger.info("set state to:", this.readyState);
   }
+  /**
+   * Deactivate this event emitter.
+   * Deactivated emitter can no longer emit and listen to events
+   * and needs to be activated again in order to do so.
+   */
   deactivate() {
     const logger = this.logger.extend("deactivate");
     logger.info("removing all listeners...");
@@ -126,7 +131,10 @@ var AsyncEventEmitter = class extends Emitter {
 
 // src/Interceptor.ts
 function getGlobalSymbol(symbol) {
-  return globalThis[symbol] || void 0;
+  return (
+    // @ts-ignore https://github.com/Microsoft/TypeScript/issues/24587
+    globalThis[symbol] || void 0
+  );
 }
 function setGlobalSymbol(symbol, value) {
   globalThis[symbol] = value;
@@ -152,9 +160,17 @@ var Interceptor = class {
     this.emitter.setMaxListeners(0);
     this.logger.info("constructing the interceptor...");
   }
+  /**
+   * Determine if this interceptor can be applied
+   * in the current environment.
+   */
   checkEnvironment() {
     return true;
   }
+  /**
+   * Apply this interceptor to the current process.
+   * Returns an already running interceptor instance if it's present.
+   */
   apply() {
     const logger = this.logger.extend("apply");
     logger.info("applying the interceptor...");
@@ -189,8 +205,16 @@ var Interceptor = class {
     this.setInstance();
     this.readyState = "APPLIED" /* APPLIED */;
   }
+  /**
+   * Setup the module augments and stubs necessary for this interceptor.
+   * This method is not run if there's a running interceptor instance
+   * to prevent instantiating an interceptor multiple times.
+   */
   setup() {
   }
+  /**
+   * Listen to the interceptor's public events.
+   */
   on(eventName, listener) {
     const logger = this.logger.extend("on");
     if (this.readyState === "DISPOSING" /* DISPOSING */ || this.readyState === "DISPOSED" /* DISPOSED */) {
@@ -200,6 +224,9 @@ var Interceptor = class {
     logger.info('adding "%s" event listener:', eventName, listener.name);
     this.emitter.on(eventName, listener);
   }
+  /**
+   * Disposes of any side-effects this interceptor has introduced.
+   */
   dispose() {
     const logger = this.logger.extend("dispose");
     if (this.readyState === "DISPOSED" /* DISPOSED */) {
@@ -243,7 +270,6 @@ var Interceptor = class {
 };
 
 export {
-  __commonJS,
   IS_PATCHED_MODULE,
   getGlobalSymbol,
   deleteGlobalSymbol,

package/lib/browser/{chunk-AKTXHQ7X.mjs → chunk-KSCN3JS4.mjs}

@@ -5,9 +5,10 @@ import {
 import {
   IS_PATCHED_MODULE,
   Interceptor
-} from "./chunk-MW6NCDWE.mjs";
+} from "./chunk-GXJLJMOT.mjs";
 
 // src/interceptors/fetch/index.ts
+import { DeferredPromise } from "@open-draft/deferred-promise";
 import { invariant } from "outvariant";
 import { until } from "@open-draft/until";
 var _FetchInterceptor = class extends Interceptor {
@@ -38,18 +39,31 @@ var _FetchInterceptor = class extends Interceptor {
         requestId
       });
       this.logger.info("awaiting for the mocked response...");
+      const signal = interactiveRequest.signal;
+      const requestAborted = new DeferredPromise();
+      signal.addEventListener(
+        "abort",
+        () => {
+          requestAborted.reject(signal.reason);
+        },
+        { once: true }
+      );
       const resolverResult = await until(async () => {
-        await this.emitter.untilIdle(
+        const allListenersResolved = this.emitter.untilIdle(
           "request",
           ({ args: [{ requestId: pendingRequestId }] }) => {
             return pendingRequestId === requestId;
           }
         );
+        await Promise.race([requestAborted, allListenersResolved]);
         this.logger.info("all request listeners have been resolved!");
         const [mockedResponse2] = await interactiveRequest.respondWith.invoked();
         this.logger.info("event.respondWith called with:", mockedResponse2);
         return mockedResponse2;
       });
+      if (requestAborted.state === "rejected") {
+        return Promise.reject(requestAborted.rejectionReason);
+      }
       if (resolverResult.error) {
         const error = Object.assign(new TypeError("Failed to fetch"), {
           cause: resolverResult.error

package/lib/browser/{chunk-3GCTA2IC.js → chunk-XAQQ5IUC.js}

@@ -5,12 +5,13 @@ var _chunkPCFJD76Xjs = require('./chunk-PCFJD76X.js');
 
 
 
-var _chunk7VJMJSIJjs = require('./chunk-7VJMJSIJ.js');
+var _chunk4CFMDU7Zjs = require('./chunk-4CFMDU7Z.js');
 
 // src/interceptors/fetch/index.ts
+var _deferredpromise = require('@open-draft/deferred-promise');
 var _outvariant = require('outvariant');
 var _until = require('@open-draft/until');
-var _FetchInterceptor = class extends _chunk7VJMJSIJjs.Interceptor {
+var _FetchInterceptor = class extends _chunk4CFMDU7Zjs.Interceptor {
   constructor() {
     super(_FetchInterceptor.symbol);
   }
@@ -20,7 +21,7 @@ var _FetchInterceptor = class extends _chunk7VJMJSIJjs.Interceptor {
   setup() {
     const pureFetch = globalThis.fetch;
     _outvariant.invariant.call(void 0, 
-      !pureFetch[_chunk7VJMJSIJjs.IS_PATCHED_MODULE],
+      !pureFetch[_chunk4CFMDU7Zjs.IS_PATCHED_MODULE],
       'Failed to patch the "fetch" module: already patched.'
     );
     globalThis.fetch = async (input, init) => {
@@ -38,18 +39,31 @@ var _FetchInterceptor = class extends _chunk7VJMJSIJjs.Interceptor {
         requestId
       });
       this.logger.info("awaiting for the mocked response...");
+      const signal = interactiveRequest.signal;
+      const requestAborted = new (0, _deferredpromise.DeferredPromise)();
+      signal.addEventListener(
+        "abort",
+        () => {
+          requestAborted.reject(signal.reason);
+        },
+        { once: true }
+      );
       const resolverResult = await _until.until.call(void 0, async () => {
-        await this.emitter.untilIdle(
+        const allListenersResolved = this.emitter.untilIdle(
           "request",
           ({ args: [{ requestId: pendingRequestId }] }) => {
             return pendingRequestId === requestId;
           }
         );
+        await Promise.race([requestAborted, allListenersResolved]);
         this.logger.info("all request listeners have been resolved!");
         const [mockedResponse2] = await interactiveRequest.respondWith.invoked();
         this.logger.info("event.respondWith called with:", mockedResponse2);
         return mockedResponse2;
       });
+      if (requestAborted.state === "rejected") {
+        return Promise.reject(requestAborted.rejectionReason);
+      }
       if (resolverResult.error) {
         const error = Object.assign(new TypeError("Failed to fetch"), {
           cause: resolverResult.error
@@ -88,13 +102,13 @@ var _FetchInterceptor = class extends _chunk7VJMJSIJjs.Interceptor {
         return response;
       });
     };
-    Object.defineProperty(globalThis.fetch, _chunk7VJMJSIJjs.IS_PATCHED_MODULE, {
+    Object.defineProperty(globalThis.fetch, _chunk4CFMDU7Zjs.IS_PATCHED_MODULE, {
       enumerable: true,
       configurable: true,
       value: true
     });
     this.subscriptions.push(() => {
-      Object.defineProperty(globalThis.fetch, _chunk7VJMJSIJjs.IS_PATCHED_MODULE, {
+      Object.defineProperty(globalThis.fetch, _chunk4CFMDU7Zjs.IS_PATCHED_MODULE, {
         value: void 0
       });
       globalThis.fetch = pureFetch;