msw 2.3.0-ws.rc-6 → 2.3.1

package/README.md

@@ -17,15 +17,9 @@
 <p align="center">Mock Service Worker (MSW) is a seamless REST/GraphQL API mocking library for browser and Node.js.</p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/msw" target="_blank">
-    <img src="https://img.shields.io/npm/v/msw.svg?style=for-the-badge&label=Latest&color=black" alt="Package version" />
-  </a>
-  <a href="https://www.npmjs.com/package/msw" target="_blank">
-    <img src="https://img.shields.io/npm/dm/msw?style=for-the-badge&color=black" alt="Downloads per month" />
-  </a>
-   <a href="https://kettanaito.com/discord" target="_blank">
-    <img src="https://img.shields.io/badge/chat-online-green?style=for-the-badge&color=black" alt="Discord server" />
-  </a>
+  <a href="https://www.npmjs.com/package/msw" target="_blank"><img src="https://img.shields.io/npm/v/msw.svg?style=for-the-badge&label=Latest&color=black" alt="Package version" /></a>
+  <a href="https://www.npmjs.com/package/msw" target="_blank"><img src="https://img.shields.io/npm/dm/msw?style=for-the-badge&color=black" alt="Downloads per month" /></a>
+   <a href="https://kettanaito.com/discord" target="_blank"><img src="https://img.shields.io/badge/chat-online-green?style=for-the-badge&color=black" alt="Discord server" /></a>
 </p>
 
 <br />

package/lib/browser/index.d.mts

@@ -1,6 +1,5 @@
 import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions";
-import { RequestHandler } from "../core/handlers/RequestHandler";
-import { WebSocketHandler } from "../core/handlers/WebSocketHandler";
+import { RequestHandler, RequestHandlerDefaultInfo } from "../core/handlers/RequestHandler";
 import { SetupApi } from "../core/SetupApi";
 
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
@@ -55,7 +54,7 @@ interface SetupWorker {
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()` API reference}
      */
-    use: (...handlers: Array<RequestHandler | WebSocketHandler>) => void;
+    use: (...handlers: RequestHandler[]) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
      *
@@ -68,13 +67,13 @@ interface SetupWorker {
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` API reference}
      */
-    resetHandlers: (...nextHandlers: Array<RequestHandler | WebSocketHandler>) => void;
+    resetHandlers: (...nextHandlers: RequestHandler[]) => void;
     /**
      * Returns a readonly list of currently active request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()` API reference}
      */
-    listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>;
+    listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, any>>;
     /**
      * Life-cycle events.
      * Life-cycle events allow you to subscribe to the internal library events occurring during the request/response handling.
@@ -89,7 +88,7 @@ declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements Set
     private startHandler;
     private stopHandler;
     private listeners;
-    constructor(...handlers: Array<RequestHandler | WebSocketHandler>);
+    constructor(...handlers: Array<RequestHandler>);
     private createWorkerContext;
     start(options?: StartOptions): StartReturnType;
     stop(): void;
@@ -100,6 +99,6 @@ declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements Set
  *
  * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
  */
-declare function setupWorker(...handlers: Array<RequestHandler | WebSocketHandler>): SetupWorker;
+declare function setupWorker(...handlers: Array<RequestHandler>): SetupWorker;
 
 export { type SetupWorker, SetupWorkerApi, type StartOptions, setupWorker };

package/lib/browser/index.d.ts

@@ -1,6 +1,5 @@
 import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions";
-import { RequestHandler } from "../core/handlers/RequestHandler";
-import { WebSocketHandler } from "../core/handlers/WebSocketHandler";
+import { RequestHandler, RequestHandlerDefaultInfo } from "../core/handlers/RequestHandler";
 import { SetupApi } from "../core/SetupApi";
 
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
@@ -55,7 +54,7 @@ interface SetupWorker {
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()` API reference}
      */
-    use: (...handlers: Array<RequestHandler | WebSocketHandler>) => void;
+    use: (...handlers: RequestHandler[]) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
      *
@@ -68,13 +67,13 @@ interface SetupWorker {
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` API reference}
      */
-    resetHandlers: (...nextHandlers: Array<RequestHandler | WebSocketHandler>) => void;
+    resetHandlers: (...nextHandlers: RequestHandler[]) => void;
     /**
      * Returns a readonly list of currently active request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()` API reference}
      */
-    listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>;
+    listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, any>>;
     /**
      * Life-cycle events.
      * Life-cycle events allow you to subscribe to the internal library events occurring during the request/response handling.
@@ -89,7 +88,7 @@ declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements Set
     private startHandler;
     private stopHandler;
     private listeners;
-    constructor(...handlers: Array<RequestHandler | WebSocketHandler>);
+    constructor(...handlers: Array<RequestHandler>);
     private createWorkerContext;
     start(options?: StartOptions): StartReturnType;
     stop(): void;
@@ -100,6 +99,6 @@ declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements Set
  *
  * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
  */
-declare function setupWorker(...handlers: Array<RequestHandler | WebSocketHandler>): SetupWorker;
+declare function setupWorker(...handlers: Array<RequestHandler>): SetupWorker;
 
 export { type SetupWorker, SetupWorkerApi, type StartOptions, setupWorker };

package/lib/browser/index.js

@@ -397,7 +397,7 @@ You can also automate this process and make the worker script update automatical
   }
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-UJZOJSMP.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-6HYIRFX2.mjs
 var encoder = new TextEncoder();
 function encodeBuffer(text) {
   return encoder.encode(text);
@@ -412,6 +412,17 @@ function toArrayBuffer(array) {
     array.byteOffset + array.byteLength
   );
 }
+
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-OMISYKWR.mjs
+var IS_PATCHED_MODULE = Symbol("isPatchedModule");
+function isPropertyAccessible(obj, key) {
+  try {
+    obj[key];
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
 var RESPONSE_STATUS_CODES_WITHOUT_BODY = /* @__PURE__ */ new Set([
   101,
   103,
@@ -422,9 +433,27 @@ var RESPONSE_STATUS_CODES_WITHOUT_BODY = /* @__PURE__ */ new Set([
 function isResponseWithoutBody(status) {
   return RESPONSE_STATUS_CODES_WITHOUT_BODY.has(status);
 }
-
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-HAGW22AN.mjs
-var IS_PATCHED_MODULE = Symbol("isPatchedModule");
+function createServerErrorResponse(body) {
+  return new Response(
+    JSON.stringify(
+      body instanceof Error ? {
+        name: body.name,
+        message: body.message,
+        stack: body.stack
+      } : body
+    ),
+    {
+      status: 500,
+      statusText: "Unhandled Exception",
+      headers: {
+        "Content-Type": "application/json"
+      }
+    }
+  );
+}
+function isResponseError(response) {
+  return isPropertyAccessible(response, "type") && response.type === "error";
+}
 
 // node_modules/.pnpm/@open-draft+logger@0.3.0/node_modules/@open-draft/logger/lib/index.mjs
 var __defProp2 = Object.defineProperty;
@@ -863,7 +892,7 @@ var _Emitter = class {
 var Emitter = _Emitter;
 Emitter.defaultMaxListeners = 10;
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-QED3Q6Z2.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-QED3Q6Z2.mjs
 var INTERNAL_REQUEST_ID_HEADER_NAME = "x-interceptors-internal-request-id";
 function getGlobalSymbol(symbol) {
   return (
@@ -1011,7 +1040,7 @@ function createRequestId() {
   return Math.random().toString(16).slice(2);
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/index.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/index.mjs
 var BatchInterceptor = class extends Interceptor {
   constructor(options) {
     BatchInterceptor.symbol = Symbol(options.name);
@@ -1185,7 +1214,6 @@ Please consider using a custom "serviceWorker.url" option to point to the actual
 
 // src/browser/setupWorker/stop/createStop.ts
 var import_devUtils9 = require("../core/utils/internal/devUtils.js");
-var import_WebSocketClientManager = require("../core/ws/WebSocketClientManager.js");
 
 // src/browser/setupWorker/stop/utils/printStopMessage.ts
 var import_devUtils8 = require("../core/utils/internal/devUtils.js");
@@ -1211,7 +1239,6 @@ var createStop = (context) => {
     context.workerChannel.send("MOCK_DEACTIVATE");
     context.isMockingEnabled = false;
     window.clearInterval(context.keepAliveInterval);
-    localStorage.removeItem(import_WebSocketClientManager.MSW_WEBSOCKET_CLIENTS_KEY);
     printStopMessage({ quiet: context.startOptions?.quiet });
   };
 };
@@ -1297,7 +1324,7 @@ var DeferredPromise = class extends Promise {
   }
 };
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-OUWBQF3Z.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-OUWBQF3Z.mjs
 var RequestController = class {
   constructor(request) {
     this.request = request;
@@ -1335,15 +1362,7 @@ async function emitAsync(emitter, eventName, ...data) {
   }
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-3FNUI33J.mjs
-function isPropertyAccessible(obj, key) {
-  try {
-    obj[key];
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-MAEPOYB6.mjs
 function canParseUrl(url) {
   try {
     new URL(url);
@@ -1396,64 +1415,113 @@ var _FetchInterceptor = class extends Interceptor {
           { once: true }
         );
       }
-      const resolverResult = await until(async () => {
-        const listenersFinished = emitAsync(this.emitter, "request", {
-          request: interactiveRequest,
-          requestId
+      const responsePromise = new DeferredPromise();
+      const respondWith = (response) => {
+        this.logger.info("responding with a mock response:", response);
+        if (this.emitter.listenerCount("response") > 0) {
+          this.logger.info('emitting the "response" event...');
+          const responseClone = response.clone();
+          this.emitter.emit("response", {
+            response: responseClone,
+            isMockedResponse: true,
+            request: interactiveRequest,
+            requestId
+          });
+        }
+        Object.defineProperty(response, "url", {
+          writable: false,
+          enumerable: true,
+          configurable: false,
+          value: request.url
         });
-        await Promise.race([
-          requestAborted,
-          // Put the listeners invocation Promise in the same race condition
-          // with the request abort Promise because otherwise awaiting the listeners
-          // would always yield some response (or undefined).
-          listenersFinished,
-          requestController.responsePromise
-        ]);
-        this.logger.info("all request listeners have been resolved!");
-        const mockedResponse2 = await requestController.responsePromise;
-        this.logger.info("event.respondWith called with:", mockedResponse2);
-        return mockedResponse2;
-      });
+        responsePromise.resolve(response);
+      };
+      const errorWith = (reason) => {
+        responsePromise.reject(reason);
+      };
+      const resolverResult = await until(
+        async () => {
+          const listenersFinished = emitAsync(this.emitter, "request", {
+            request: interactiveRequest,
+            requestId
+          });
+          await Promise.race([
+            requestAborted,
+            // Put the listeners invocation Promise in the same race condition
+            // with the request abort Promise because otherwise awaiting the listeners
+            // would always yield some response (or undefined).
+            listenersFinished,
+            requestController.responsePromise
+          ]);
+          this.logger.info("all request listeners have been resolved!");
+          const mockedResponse2 = await requestController.responsePromise;
+          this.logger.info("event.respondWith called with:", mockedResponse2);
+          return mockedResponse2;
+        }
+      );
       if (requestAborted.state === "rejected") {
-        return Promise.reject(requestAborted.rejectionReason);
+        this.logger.info(
+          "request has been aborted:",
+          requestAborted.rejectionReason
+        );
+        responsePromise.reject(requestAborted.rejectionReason);
+        return responsePromise;
       }
       if (resolverResult.error) {
-        return Promise.reject(createNetworkError(resolverResult.error));
+        this.logger.info(
+          "request listerner threw an error:",
+          resolverResult.error
+        );
+        if (resolverResult.error instanceof Response) {
+          if (isResponseError(resolverResult.error)) {
+            errorWith(createNetworkError(resolverResult.error));
+          } else {
+            respondWith(resolverResult.error);
+          }
+        }
+        if (this.emitter.listenerCount("unhandledException") > 0) {
+          await emitAsync(this.emitter, "unhandledException", {
+            error: resolverResult.error,
+            request,
+            requestId,
+            controller: {
+              respondWith,
+              errorWith
+            }
+          });
+          if (responsePromise.state !== "pending") {
+            return responsePromise;
+          }
+        }
+        respondWith(createServerErrorResponse(resolverResult.error));
+        return responsePromise;
       }
       const mockedResponse = resolverResult.data;
       if (mockedResponse && !((_a = request.signal) == null ? void 0 : _a.aborted)) {
         this.logger.info("received mocked response:", mockedResponse);
-        if (isPropertyAccessible(mockedResponse, "type") && mockedResponse.type === "error") {
+        if (isResponseError(mockedResponse)) {
           this.logger.info(
             "received a network error response, rejecting the request promise..."
           );
-          return Promise.reject(createNetworkError(mockedResponse));
+          errorWith(createNetworkError(mockedResponse));
+        } else {
+          respondWith(mockedResponse);
         }
-        const responseClone = mockedResponse.clone();
-        this.emitter.emit("response", {
-          response: responseClone,
-          isMockedResponse: true,
-          request: interactiveRequest,
-          requestId
-        });
-        Object.defineProperty(mockedResponse, "url", {
-          writable: false,
-          enumerable: true,
-          configurable: false,
-          value: request.url
-        });
-        return mockedResponse;
+        return responsePromise;
       }
       this.logger.info("no mocked response received!");
       return pureFetch(request).then((response) => {
-        const responseClone = response.clone();
-        this.logger.info("original fetch performed", responseClone);
-        this.emitter.emit("response", {
-          response: responseClone,
-          isMockedResponse: false,
-          request: interactiveRequest,
-          requestId
-        });
+        this.logger.info("original fetch performed", response);
+        if (this.emitter.listenerCount("response") > 0) {
+          this.logger.info('emitting the "response" event...');
+          const responseClone = response.clone();
+          this.emitter.emit("response", {
+            response: responseClone,
+            isMockedResponse: false,
+            request: interactiveRequest,
+            requestId
+          });
+        }
         return response;
       });
     };
@@ -1482,7 +1550,7 @@ function createNetworkError(cause) {
   });
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.27.1/node_modules/@mswjs/interceptors/lib/browser/chunk-VYFS2IF2.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.29.0/node_modules/@mswjs/interceptors/lib/browser/chunk-732REFPX.mjs
 function concatArrayBuffer(left, right) {
   const result = new Uint8Array(left.byteLength + right.byteLength);
   result.set(left, 0);
@@ -2133,7 +2201,31 @@ function createXMLHttpRequestProxy({
             "request listener threw an exception, aborting request...",
             resolverResult.error
           );
-          xhrRequestController.errorWith(resolverResult.error);
+          if (resolverResult.error instanceof Response) {
+            if (isResponseError(resolverResult.error)) {
+              xhrRequestController.errorWith(new TypeError("Network error"));
+            } else {
+              this.respondWith(resolverResult.error);
+            }
+            return;
+          }
+          if (emitter.listenerCount("unhandledException") > 0) {
+            await emitAsync(emitter, "unhandledException", {
+              error: resolverResult.error,
+              request,
+              requestId,
+              controller: {
+                respondWith: xhrRequestController.respondWith.bind(xhrRequestController),
+                errorWith: xhrRequestController.errorWith.bind(xhrRequestController)
+              }
+            });
+            if (originalRequest.readyState > XMLHttpRequest.OPENED) {
+              return;
+            }
+          }
+          xhrRequestController.respondWith(
+            createServerErrorResponse(resolverResult.error)
+          );
           return;
         }
         const mockedResponse = resolverResult.data;
@@ -2143,7 +2235,7 @@ function createXMLHttpRequestProxy({
             mockedResponse.status,
             mockedResponse.statusText
           );
-          if (mockedResponse.type === "error") {
+          if (isResponseError(mockedResponse)) {
             this.logger.info(
               "received a network error response, rejecting the request promise..."
             );
@@ -2314,9 +2406,6 @@ function supportsReadableStreamTransfer() {
 }
 
 // src/browser/setupWorker/setupWorker.ts
-var import_webSocketInterceptor = require("../core/ws/webSocketInterceptor.js");
-var import_handleWebSocketEvent = require("../core/ws/handleWebSocketEvent.js");
-var import_attachWebSocketLogger = require("../core/ws/utils/attachWebSocketLogger.js");
 var SetupWorkerApi = class extends import_SetupApi.SetupApi {
   context;
   startHandler = null;
@@ -2432,22 +2521,6 @@ var SetupWorkerApi = class extends import_SetupApi.SetupApi {
       DEFAULT_START_OPTIONS,
       options
     );
-    (0, import_handleWebSocketEvent.handleWebSocketEvent)({
-      getHandlers: () => {
-        return this.handlersController.currentHandlers();
-      },
-      onMockedConnection: (connection) => {
-        if (!this.context.startOptions.quiet) {
-          (0, import_attachWebSocketLogger.attachWebSocketLogger)(connection);
-        }
-      },
-      onPassthroughConnection() {
-      }
-    });
-    import_webSocketInterceptor.webSocketInterceptor.apply();
-    this.subscriptions.push(() => {
-      import_webSocketInterceptor.webSocketInterceptor.dispose();
-    });
     return await this.startHandler(this.context.startOptions, options);
   }
   stop() {