msw 2.3.0-ws.rc-1 → 2.3.0-ws.rc-3

package/README.md

@@ -100,7 +100,7 @@ const worker = setupWorker(
 )
 
 // 3. Start request interception by starting the Service Worker.
-worker.start()
+await worker.start()
 ```
 
 Performing a `GET https://github.com/octocat` request in your application will result into a mocked response that you can inspect in your browser's "Network" tab:
@@ -264,9 +264,14 @@ Mock Service Worker is trusted by hundreds of thousands of engineers around the
         <img src="media/sponsors/materialize.svg" alt="Materialize" height="64" />
       </a>
     </td>
-     <td>
+    <td>
       <a href="https://trigger.dev/" target="_blank">
-          <img src="media/sponsors/trigger-dev.png" alt="Trigger.dev" height="64" />
+        <img src="media/sponsors/trigger-dev.png" alt="Trigger.dev" height="64" />
+      </a>
+    </td>
+    <td>
+      <a href="https://vital.io/" target="_blank">
+        <img src="media/sponsors/vital.svg" alt="Vital" width="64" />
       </a>
     </td>
   </tr>

package/cli/init.js

@@ -2,7 +2,7 @@ const fs = require('fs')
 const path = require('path')
 const chalk = require('chalk')
 const { until } = require('@open-draft/until')
-const confirm = require('@inquirer/confirm')
+const confirm = require('@inquirer/confirm').default
 const invariant = require('./invariant')
 const { SERVICE_WORKER_BUILD_PATH } = require('../config/constants')
 

package/lib/browser/index.d.mts

@@ -1,7 +1,7 @@
-import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from '~/core/sharedOptions';
-import { RequestHandler } from '~/core/handlers/RequestHandler';
-import { WebSocketHandler } from '~/core/handlers/WebSocketHandler';
-import { SetupApi } from '~/core/SetupApi';
+import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions";
+import { RequestHandler } from "../core/handlers/RequestHandler";
+import { WebSocketHandler } from "../core/handlers/WebSocketHandler";
+import { SetupApi } from "../core/SetupApi";
 
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
 interface StartOptions extends SharedOptions {

package/lib/browser/index.js

@@ -122,6 +122,9 @@ function isNodeProcess() {
   return false;
 }
 
+// src/browser/setupWorker/start/createStartHandler.ts
+var import_devUtils7 = require("../core/utils/internal/devUtils.js");
+
 // node_modules/.pnpm/@open-draft+until@2.1.0/node_modules/@open-draft/until/lib/index.mjs
 var until = async (promise) => {
   try {
@@ -134,9 +137,6 @@ var until = async (promise) => {
   }
 };
 
-// src/browser/setupWorker/start/createStartHandler.ts
-var import_devUtils6 = require("../core/utils/internal/devUtils.js");
-
 // src/browser/setupWorker/start/utils/getWorkerInstance.ts
 var import_devUtils = require("../core/utils/internal/devUtils.js");
 
@@ -315,7 +315,7 @@ var createRequestListener = (context, options) => {
         context.emitter,
         {
           onPassthroughResponse() {
-            messageChannel.postMessage("NOT_FOUND");
+            messageChannel.postMessage("PASSTHROUGH");
           },
           async onMockedResponse(response, { handler, parsedResult }) {
             const responseClone = response.clone();
@@ -379,21 +379,25 @@ This exception has been gracefully handled as a 500 response, however, it's stro
   };
 };
 
-// src/browser/utils/requestIntegrityCheck.ts
-async function requestIntegrityCheck(context, serviceWorker) {
+// src/browser/utils/checkWorkerIntegrity.ts
+var import_devUtils5 = require("../core/utils/internal/devUtils.js");
+async function checkWorkerIntegrity(context) {
   context.workerChannel.send("INTEGRITY_CHECK_REQUEST");
-  const { payload: actualChecksum } = await context.events.once(
-    "INTEGRITY_CHECK_RESPONSE"
-  );
-  if (actualChecksum !== "223d191a56023cd36aa88c802961b911") {
-    throw new Error(
-      `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"223d191a56023cd36aa88c802961b911"}).`
+  const { payload } = await context.events.once("INTEGRITY_CHECK_RESPONSE");
+  if (payload.checksum !== "26357c79639bfa20d64c0efca2a87423") {
+    import_devUtils5.devUtils.warn(
+      `The currently registered Service Worker has been generated by a different version of MSW (${payload.packageVersion}) and may not be fully compatible with the installed version.
+
+It's recommended you update your worker script by running this command:
+
+  \u2022 npx msw init <PUBLIC_DIR>
+
+You can also automate this process and make the worker script update automatically upon the library installations. Read more: https://mswjs.io/docs/cli/init.`
     );
   }
-  return serviceWorker;
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-UJZOJSMP.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-UJZOJSMP.mjs
 var encoder = new TextEncoder();
 function encodeBuffer(text) {
   return encoder.encode(text);
@@ -419,7 +423,7 @@ function isResponseWithoutBody(status) {
   return RESPONSE_STATUS_CODES_WITHOUT_BODY.has(status);
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-HAGW22AN.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-HAGW22AN.mjs
 var IS_PATCHED_MODULE = Symbol("isPatchedModule");
 
 // node_modules/.pnpm/@open-draft+logger@0.3.0/node_modules/@open-draft/logger/lib/index.mjs
@@ -859,7 +863,8 @@ var _Emitter = class {
 var Emitter = _Emitter;
 Emitter.defaultMaxListeners = 10;
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-SGO3INLV.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-QED3Q6Z2.mjs
+var INTERNAL_REQUEST_ID_HEADER_NAME = "x-interceptors-internal-request-id";
 function getGlobalSymbol(symbol) {
   return (
     // @ts-ignore https://github.com/Microsoft/TypeScript/issues/24587
@@ -1002,8 +1007,11 @@ var Interceptor = class {
     this.logger.info("cleared global instance!", this.symbol.description);
   }
 };
+function createRequestId() {
+  return Math.random().toString(16).slice(2);
+}
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/index.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/index.mjs
 var BatchInterceptor = class extends Interceptor {
   constructor(options) {
     BatchInterceptor.symbol = Symbol(options.name);
@@ -1085,10 +1093,10 @@ function createResponseListener(context) {
 }
 
 // src/browser/setupWorker/start/utils/validateWorkerScope.ts
-var import_devUtils5 = require("../core/utils/internal/devUtils.js");
+var import_devUtils6 = require("../core/utils/internal/devUtils.js");
 function validateWorkerScope(registration, options) {
   if (!options?.quiet && !location.href.startsWith(registration.scope)) {
-    import_devUtils5.devUtils.warn(
+    import_devUtils6.devUtils.warn(
       `Cannot intercept requests on this page because it's outside of the worker's scope ("${registration.scope}"). If you wish to mock API requests on this page, you must resolve this scope issue.
 
 - (Recommended) Register the worker at the root level ("/") of your application.
@@ -1114,14 +1122,14 @@ var createStartHandler = (context) => {
       );
       const [worker, registration] = instance;
       if (!worker) {
-        const missingWorkerMessage = customOptions?.findWorker ? import_devUtils6.devUtils.formatMessage(
+        const missingWorkerMessage = customOptions?.findWorker ? import_devUtils7.devUtils.formatMessage(
           `Failed to locate the Service Worker registration using a custom "findWorker" predicate.
 
 Please ensure that the custom predicate properly locates the Service Worker registration at "%s".
 More details: https://mswjs.io/docs/api/setup-worker/start#findworker
 `,
           options.serviceWorker.url
-        ) : import_devUtils6.devUtils.formatMessage(
+        ) : import_devUtils7.devUtils.formatMessage(
           `Failed to locate the Service Worker registration.
 
 This most likely means that the worker script URL "%s" cannot resolve against the actual public hostname (%s). This may happen if your application runs behind a proxy, or has a dynamic hostname.
@@ -1140,19 +1148,12 @@ Please consider using a custom "serviceWorker.url" option to point to the actual
         }
         window.clearInterval(context.keepAliveInterval);
       });
-      const integrityCheckResult = await until(
-        () => requestIntegrityCheck(context, worker)
-      );
-      if (integrityCheckResult.error) {
-        import_devUtils6.devUtils.error(`Detected outdated Service Worker: ${integrityCheckResult.error.message}
-
-The mocking is still enabled, but it's highly recommended that you update your Service Worker by running:
-
-$ npx msw init <PUBLIC_DIR>
-
-This is necessary to ensure that the Service Worker is in sync with the library to guarantee its stability.
-If this message still persists after updating, please report an issue: https://github.com/open-draft/msw/issues      `);
-      }
+      await checkWorkerIntegrity(context).catch((error2) => {
+        import_devUtils7.devUtils.error(
+          "Error while checking the worker script integrity. Please report this on GitHub (https://github.com/mswjs/msw/issues), including the original error below."
+        );
+        console.error(error2);
+      });
       context.keepAliveInterval = window.setInterval(
         () => context.workerChannel.send("KEEPALIVE_REQUEST"),
         5e3
@@ -1183,16 +1184,16 @@ If this message still persists after updating, please report an issue: https://g
 };
 
 // src/browser/setupWorker/stop/createStop.ts
-var import_devUtils8 = require("../core/utils/internal/devUtils.js");
+var import_devUtils9 = require("../core/utils/internal/devUtils.js");
 
 // src/browser/setupWorker/stop/utils/printStopMessage.ts
-var import_devUtils7 = require("../core/utils/internal/devUtils.js");
+var import_devUtils8 = require("../core/utils/internal/devUtils.js");
 function printStopMessage(args = {}) {
   if (args.quiet) {
     return;
   }
   console.log(
-    `%c${import_devUtils7.devUtils.formatMessage("Mocking disabled.")}`,
+    `%c${import_devUtils8.devUtils.formatMessage("Mocking disabled.")}`,
     "color:orangered;font-weight:bold;"
   );
 }
@@ -1201,7 +1202,7 @@ function printStopMessage(args = {}) {
 var createStop = (context) => {
   return function stop() {
     if (!context.isMockingEnabled) {
-      import_devUtils8.devUtils.warn(
+      import_devUtils9.devUtils.warn(
         'Found a redundant "worker.stop()" call. Note that stopping the worker while mocking already stopped has no effect. Consider removing this "worker.stop()" call.'
       );
       return;
@@ -1294,7 +1295,7 @@ var DeferredPromise = class extends Promise {
   }
 };
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-OUWBQF3Z.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-OUWBQF3Z.mjs
 var RequestController = class {
   constructor(request) {
     this.request = request;
@@ -1332,16 +1333,7 @@ async function emitAsync(emitter, eventName, ...data) {
   }
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-CEKC26XE.mjs
-function uuidv4() {
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function(c) {
-    const r = Math.random() * 16 | 0;
-    const v = c == "x" ? r : r & 3 | 8;
-    return v.toString(16);
-  });
-}
-
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-65OQZE6W.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-3FNUI33J.mjs
 function isPropertyAccessible(obj, key) {
   try {
     obj[key];
@@ -1365,7 +1357,7 @@ var _FetchInterceptor = class extends Interceptor {
   checkEnvironment() {
     return typeof globalThis !== "undefined" && typeof globalThis.fetch !== "undefined";
   }
-  setup() {
+  async setup() {
     const pureFetch = globalThis.fetch;
     invariant(
       !pureFetch[IS_PATCHED_MODULE],
@@ -1373,7 +1365,7 @@ var _FetchInterceptor = class extends Interceptor {
     );
     globalThis.fetch = async (input, init) => {
       var _a;
-      const requestId = uuidv4();
+      const requestId = createRequestId();
       const resolvedInput = typeof input === "string" && typeof location !== "undefined" && !canParseUrl(input) ? new URL(input, location.origin) : input;
       const request = new Request(resolvedInput, init);
       this.logger.info("[%s] %s", request.method, request.url);
@@ -1488,7 +1480,7 @@ function createNetworkError(cause) {
   });
 }
 
-// node_modules/.pnpm/@mswjs+interceptors@0.26.8/node_modules/@mswjs/interceptors/lib/browser/chunk-6ZIL5FW4.mjs
+// node_modules/.pnpm/@mswjs+interceptors@0.26.15/node_modules/@mswjs/interceptors/lib/browser/chunk-VYFS2IF2.mjs
 function concatArrayBuffer(left, right) {
   const result = new Uint8Array(left.byteLength + right.byteLength);
   result.set(left, 0);
@@ -1682,7 +1674,7 @@ var XMLHttpRequestController = class {
     this.method = "GET";
     this.url = null;
     this.events = /* @__PURE__ */ new Map();
-    this.requestId = uuidv4();
+    this.requestId = createRequestId();
     this.requestHeaders = new Headers();
     this.responseBuffer = new Uint8Array();
     this.request = createProxy(initialRequest, {
@@ -1764,7 +1756,10 @@ var XMLHttpRequestController = class {
                   this.request.readyState
                 );
                 if (IS_NODE2) {
-                  this.request.setRequestHeader("X-Request-Id", this.requestId);
+                  this.request.setRequestHeader(
+                    INTERNAL_REQUEST_ID_HEADER_NAME,
+                    this.requestId
+                  );
                 }
                 return invoke();
               }
@@ -2298,7 +2293,7 @@ function createFallbackStop(context) {
 }
 
 // src/browser/setupWorker/setupWorker.ts
-var import_devUtils9 = require("../core/utils/internal/devUtils.js");
+var import_devUtils10 = require("../core/utils/internal/devUtils.js");
 var import_SetupApi = require("../core/SetupApi.js");
 var import_mergeRight2 = require("../core/utils/internal/mergeRight.js");
 
@@ -2318,7 +2313,8 @@ function supportsReadableStreamTransfer() {
 
 // src/browser/setupWorker/setupWorker.ts
 var import_webSocketInterceptor = require("../core/ws/webSocketInterceptor.js");
-var import_handleWebSocketEvent = require("../core/utils/handleWebSocketEvent.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;
@@ -2328,7 +2324,7 @@ var SetupWorkerApi = class extends import_SetupApi.SetupApi {
     super(...handlers);
     invariant(
       !isNodeProcess(),
-      import_devUtils9.devUtils.formatMessage(
+      import_devUtils10.devUtils.formatMessage(
         "Failed to execute `setupWorker` in a non-browser environment. Consider using `setupServer` for Node.js environment instead."
       )
     );
@@ -2426,7 +2422,7 @@ var SetupWorkerApi = class extends import_SetupApi.SetupApi {
   }
   async start(options = {}) {
     if (options.waitUntilReady === true) {
-      import_devUtils9.devUtils.warn(
+      import_devUtils10.devUtils.warn(
         'The "waitUntilReady" option has been deprecated. Please remove it from this "worker.start()" call. Follow the recommended Browser integration (https://mswjs.io/docs/integrations/browser) to eliminate any race conditions between the Service Worker registration and any requests made by your application on initial render.'
       );
     }
@@ -2434,8 +2430,17 @@ var SetupWorkerApi = class extends import_SetupApi.SetupApi {
       DEFAULT_START_OPTIONS,
       options
     );
-    (0, import_handleWebSocketEvent.handleWebSocketEvent)(() => {
-      return this.handlersController.currentHandlers();
+    (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(() => {