msw 2.2.4 → 2.2.6

package/lib/mockServiceWorker.js

@@ -2,13 +2,14 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (2.2.4).
+ * 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.6'
+const INTEGRITY_CHECKSUM = '26357c79639bfa20d64c0efca2a87423'
 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
     }
@@ -202,13 +206,6 @@ async function getResponse(event, client, requestId) {
     return passthrough()
   }
 
-  // Bypass requests with the explicit bypass header.
-  // Such requests can be issued by "ctx.fetch()".
-  const mswIntention = request.headers.get('x-msw-intention')
-  if (['bypass', 'passthrough'].includes(mswIntention)) {
-    return passthrough()
-  }
-
   // Notify the client that a request has been intercepted.
   const requestBuffer = await request.arrayBuffer()
   const clientMessage = await sendToClient(
@@ -240,7 +237,7 @@ async function getResponse(event, client, requestId) {
       return respondWithMock(clientMessage.data)
     }
 
-    case 'MOCK_NOT_FOUND': {
+    case 'PASSTHROUGH': {
       return passthrough()
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "2.2.4",
+  "version": "2.2.6",
   "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",

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/createRequestListener.ts

@@ -48,7 +48,7 @@ export const createRequestListener = (
         context.emitter,
         {
           onPassthroughResponse() {
-            messageChannel.postMessage('NOT_FOUND')
+            messageChannel.postMessage('PASSTHROUGH')
           },
           async onMockedResponse(response, { handler, parsedResult }) {
             // Clone the mocked response so its body could be read

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

@@ -21,6 +21,8 @@ export function createResponseListener(context: SetupWorkerInternalContext) {
     const request = context.requests.get(requestId)!
     context.requests.delete(requestId)
 
+    console.log('RESPONSE LISTENER', responseJson, context.requests)
+
     /**
      * CORS requests with `mode: "no-cors"` result in "opaque" responses.
      * That kind of responses cannot be manipulated in JavaScript due

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/setupWorker/start/utils/createMessageChannel.ts

@@ -16,7 +16,7 @@ interface WorkerChannelEventsMap {
     data: StringifiedResponse,
     transfer?: [ReadableStream<Uint8Array>],
   ]
-  NOT_FOUND: []
+  PASSTHROUGH: []
 }
 
 export class WorkerChannel {

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/bypass.test.ts

@@ -45,3 +45,25 @@ it('returns bypassed request given request instance', async () => {
     'x-msw-intention': 'bypass',
   })
 })
+
+it('allows modifying the bypassed request instance', async () => {
+  const original = new Request('http://localhost/resource', {
+    method: 'POST',
+    body: 'hello world',
+  })
+  const request = bypass(original, {
+    method: 'PUT',
+    headers: { 'x-modified-header': 'yes' },
+  })
+
+  expect(request.method).toBe('PUT')
+  expect(Object.fromEntries(request.headers.entries())).toEqual({
+    'x-msw-intention': 'bypass',
+    'x-modified-header': 'yes',
+  })
+  expect(original.bodyUsed).toBe(false)
+  expect(request.bodyUsed).toBe(false)
+
+  expect(await request.text()).toBe('hello world')
+  expect(original.bodyUsed).toBe(false)
+})

package/src/core/bypass.ts

@@ -15,7 +15,15 @@ export type BypassRequestInput = string | URL | Request
  * @see {@link https://mswjs.io/docs/api/bypass `bypass()` API reference}
  */
 export function bypass(input: BypassRequestInput, init?: RequestInit): Request {
-  const request = input instanceof Request ? input : new Request(input, init)
+  // Always create a new Request instance.
+  // This way, the "init" modifications will propagate
+  // to the bypass request instance automatically.
+  const request = new Request(
+    // If given a Request instance, clone it not to exhaust
+    // the original request's body.
+    input instanceof Request ? input.clone() : input,
+    init,
+  )
 
   invariant(
     !request.bodyUsed,

package/src/core/utils/handleRequest.ts

@@ -52,7 +52,7 @@ export async function handleRequest(
 ): Promise<Response | undefined> {
   emitter.emit('request:start', { request, requestId })
 
-  // Perform bypassed requests (i.e. issued via "ctx.fetch") as-is.
+  // Perform bypassed requests (i.e. wrapped in "bypass()") as-is.
   if (request.headers.get('x-msw-intention') === 'bypass') {
     emitter.emit('request:end', { request, requestId })
     handleRequestOptions?.onPassthroughResponse?.(request)

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
     }
@@ -202,13 +206,6 @@ async function getResponse(event, client, requestId) {
     return passthrough()
   }
 
-  // Bypass requests with the explicit bypass header.
-  // Such requests can be issued by "ctx.fetch()".
-  const mswIntention = request.headers.get('x-msw-intention')
-  if (['bypass', 'passthrough'].includes(mswIntention)) {
-    return passthrough()
-  }
-
   // Notify the client that a request has been intercepted.
   const requestBuffer = await request.arrayBuffer()
   const clientMessage = await sendToClient(
@@ -240,7 +237,7 @@ async function getResponse(event, client, requestId) {
       return respondWithMock(clientMessage.data)
     }
 
-    case 'MOCK_NOT_FOUND': {
+    case 'PASSTHROUGH': {
       return passthrough()
     }
   }

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
-}