msw 2.2.3 → 2.2.5

package/lib/mockServiceWorker.js

@@ -2,13 +2,14 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (2.2.3).
+ * Mock Service Worker.
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
  */
 
-const INTEGRITY_CHECKSUM = '223d191a56023cd36aa88c802961b911'
+const PACKAGE_VERSION = '2.2.5'
+const INTEGRITY_CHECKSUM = '5db7e6e8385dc04e017ac4823e0e9b29'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()
 
@@ -48,7 +49,10 @@ self.addEventListener('message', async function (event) {
     case 'INTEGRITY_CHECK_REQUEST': {
       sendToClient(client, {
         type: 'INTEGRITY_CHECK_RESPONSE',
-        payload: INTEGRITY_CHECKSUM,
+        payload: {
+          packageVersion: PACKAGE_VERSION,
+          checksum: INTEGRITY_CHECKSUM,
+        },
       })
       break
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
   "main": "./lib/core/index.js",
   "module": "./lib/core/index.mjs",
@@ -73,10 +73,7 @@
     "url": "https://github.com/kettanaito"
   },
   "license": "MIT",
-  "funding": {
-    "type": "opencollective",
-    "url": "https://opencollective.com/mswjs"
-  },
+  "funding": "https://github.com/sponsors/mswjs",
   "files": [
     "config/constants.js",
     "config/scripts/postinstall.js",
@@ -126,7 +123,7 @@
     "@commitlint/cli": "^18.4.4",
     "@commitlint/config-conventional": "^18.4.4",
     "@open-draft/test-server": "^0.4.2",
-    "@ossjs/release": "^0.8.0",
+    "@ossjs/release": "^0.8.1",
     "@playwright/test": "^1.40.1",
     "@swc/core": "^1.3.102",
     "@types/express": "^4.17.21",
@@ -134,8 +131,8 @@
     "@types/glob": "^8.1.0",
     "@types/json-bigint": "^1.0.4",
     "@types/node": "18.x",
-    "@typescript-eslint/eslint-plugin": "^5.11.0",
-    "@typescript-eslint/parser": "^5.11.0",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "@web/dev-server": "^0.1.38",
     "axios": "^1.6.5",
     "babel-minify": "^0.5.1",
@@ -145,7 +142,7 @@
     "cz-conventional-changelog": "3.3.0",
     "esbuild": "^0.19.11",
     "esbuild-loader": "^4.0.2",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "express": "^4.18.2",

package/src/browser/setupWorker/glossary.ts

@@ -54,7 +54,10 @@ export type ServiceWorkerIncomingResponse = Pick<
  */
 export interface ServiceWorkerIncomingEventsMap {
   MOCKING_ENABLED: boolean
-  INTEGRITY_CHECK_RESPONSE: string
+  INTEGRITY_CHECK_RESPONSE: {
+    packageVersion: string
+    checksum: string
+  }
   KEEPALIVE_RESPONSE: never
   REQUEST: ServiceWorkerIncomingRequest
   RESPONSE: ServiceWorkerIncomingResponse

package/src/browser/setupWorker/start/createStartHandler.ts

@@ -1,10 +1,9 @@
-import { until } from '@open-draft/until'
 import { devUtils } from '~/core/utils/internal/devUtils'
 import { getWorkerInstance } from './utils/getWorkerInstance'
 import { enableMocking } from './utils/enableMocking'
 import { SetupWorkerInternalContext, StartHandler } from '../glossary'
 import { createRequestListener } from './createRequestListener'
-import { requestIntegrityCheck } from '../../utils/requestIntegrityCheck'
+import { checkWorkerIntegrity } from '../../utils/checkWorkerIntegrity'
 import { createResponseListener } from './createResponseListener'
 import { validateWorkerScope } from './utils/validateWorkerScope'
 
@@ -74,23 +73,14 @@ Please consider using a custom "serviceWorker.url" option to point to the actual
         window.clearInterval(context.keepAliveInterval)
       })
 
-      // Check if the active Service Worker is the latest published one
-      const integrityCheckResult = await until(() =>
-        requestIntegrityCheck(context, worker),
-      )
-
-      if (integrityCheckResult.error) {
-        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\
-      `)
-      }
+      // Check if the active Service Worker has been generated
+      // by the currently installed version of MSW.
+      await checkWorkerIntegrity(context).catch((error) => {
+        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(error)
+      })
 
       context.keepAliveInterval = window.setInterval(
         () => context.workerChannel.send('KEEPALIVE_REQUEST'),

package/src/browser/utils/checkWorkerIntegrity.ts

@@ -0,0 +1,34 @@
+import { devUtils } from '~/core/utils/internal/devUtils'
+import type { SetupWorkerInternalContext } from '../setupWorker/glossary'
+
+/**
+ * Check whether the registered Service Worker has been
+ * generated by the installed version of the library.
+ * Prints a warning message if the worker scripts mismatch.
+ */
+export async function checkWorkerIntegrity(
+  context: SetupWorkerInternalContext,
+): Promise<void> {
+  // Request the integrity checksum from the registered worker.
+  context.workerChannel.send('INTEGRITY_CHECK_REQUEST')
+
+  const { payload } = await context.events.once('INTEGRITY_CHECK_RESPONSE')
+
+  // Compare the response from the Service Worker and the
+  // global variable set during the build.
+
+  // The integrity is validated based on the worker script's checksum
+  // that's derived from its minified content during the build.
+  // The "SERVICE_WORKER_CHECKSUM" global variable is injected by the build.
+  if (payload.checksum !== SERVICE_WORKER_CHECKSUM) {
+    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.`,
+    )
+  }
+}

package/src/core/utils/HttpResponse/decorators.ts

@@ -1,5 +1,6 @@
 import statuses from '@bundled-es-modules/statuses'
 import type { HttpResponseInit } from '../../HttpResponse'
+import { Headers as HeadersPolyfill } from 'headers-polyfill'
 
 const { message } = statuses
 
@@ -40,10 +41,13 @@ export function decorateResponse(
   // Cookie forwarding is only relevant in the browser.
   if (typeof document !== 'undefined') {
     // Write the mocked response cookies to the document.
-    // Note that Fetch API Headers will concatenate multiple "Set-Cookie"
-    // headers into a single comma-separated string, just as it does
-    // with any other multi-value headers.
-    const responseCookies = init.headers.get('Set-Cookie')?.split(',') || []
+    // Use `headers-polyfill` to get the Set-Cookie header value correctly.
+    // This is an alternative until TypeScript 5.2
+    // and Node.js v20 become the minimum supported version
+    // and getSetCookie in Headers can be used directly.
+    const responseCookies = HeadersPolyfill.prototype.getSetCookie.call(
+      init.headers,
+    )
 
     for (const cookieString of responseCookies) {
       // No need to parse the cookie headers because it's defined

package/src/mockServiceWorker.js

@@ -2,12 +2,13 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (<PACKAGE_VERSION>).
+ * Mock Service Worker.
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
  */
 
+const PACKAGE_VERSION = '<PACKAGE_VERSION>'
 const INTEGRITY_CHECKSUM = '<INTEGRITY_CHECKSUM>'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()
@@ -48,7 +49,10 @@ self.addEventListener('message', async function (event) {
     case 'INTEGRITY_CHECK_REQUEST': {
       sendToClient(client, {
         type: 'INTEGRITY_CHECK_RESPONSE',
-        payload: INTEGRITY_CHECKSUM,
+        payload: {
+          packageVersion: PACKAGE_VERSION,
+          checksum: INTEGRITY_CHECKSUM,
+        },
       })
       break
     }

package/src/browser/utils/requestIntegrityCheck.ts

@@ -1,23 +0,0 @@
-import type { SetupWorkerInternalContext } from '../setupWorker/glossary'
-
-export async function requestIntegrityCheck(
-  context: SetupWorkerInternalContext,
-  serviceWorker: ServiceWorker,
-): Promise<ServiceWorker> {
-  // Signal Service Worker to report back its integrity
-  context.workerChannel.send('INTEGRITY_CHECK_REQUEST')
-
-  const { payload: actualChecksum } = await context.events.once(
-    'INTEGRITY_CHECK_RESPONSE',
-  )
-
-  // Compare the response from the Service Worker and the
-  // global variable set during the build.
-  if (actualChecksum !== SERVICE_WORKER_CHECKSUM) {
-    throw new Error(
-      `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${SERVICE_WORKER_CHECKSUM}).`,
-    )
-  }
-
-  return serviceWorker
-}