msw 2.0.12 → 2.0.13

package/src/mockServiceWorker.js

@@ -0,0 +1,287 @@
+/* eslint-disable */
+/* tslint:disable */
+
+/**
+ * Mock Service Worker (<PACKAGE_VERSION>).
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ * - Please do NOT serve this file on production.
+ */
+
+const INTEGRITY_CHECKSUM = '<INTEGRITY_CHECKSUM>'
+const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
+const activeClientIds = new Set()
+
+self.addEventListener('install', function () {
+  self.skipWaiting()
+})
+
+self.addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
+})
+
+self.addEventListener('message', async function (event) {
+  const clientId = event.source.id
+
+  if (!clientId || !self.clients) {
+    return
+  }
+
+  const client = await self.clients.get(clientId)
+
+  if (!client) {
+    return
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  switch (event.data) {
+    case 'KEEPALIVE_REQUEST': {
+      sendToClient(client, {
+        type: 'KEEPALIVE_RESPONSE',
+      })
+      break
+    }
+
+    case 'INTEGRITY_CHECK_REQUEST': {
+      sendToClient(client, {
+        type: 'INTEGRITY_CHECK_RESPONSE',
+        payload: INTEGRITY_CHECKSUM,
+      })
+      break
+    }
+
+    case 'MOCK_ACTIVATE': {
+      activeClientIds.add(clientId)
+
+      sendToClient(client, {
+        type: 'MOCKING_ENABLED',
+        payload: true,
+      })
+      break
+    }
+
+    case 'MOCK_DEACTIVATE': {
+      activeClientIds.delete(clientId)
+      break
+    }
+
+    case 'CLIENT_CLOSED': {
+      activeClientIds.delete(clientId)
+
+      const remainingClients = allClients.filter((client) => {
+        return client.id !== clientId
+      })
+
+      // Unregister itself when there are no more clients
+      if (remainingClients.length === 0) {
+        self.registration.unregister()
+      }
+
+      break
+    }
+  }
+})
+
+self.addEventListener('fetch', function (event) {
+  const { request } = event
+
+  // Bypass navigation requests.
+  if (request.mode === 'navigate') {
+    return
+  }
+
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been deleted (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  // Generate unique request ID.
+  const requestId = crypto.randomUUID()
+  event.respondWith(handleRequest(event, requestId))
+})
+
+async function handleRequest(event, requestId) {
+  const client = await resolveMainClient(event)
+  const response = await getResponse(event, client, requestId)
+
+  // Send back the response clone for the "response:*" life-cycle events.
+  // Ensure MSW is active and ready to handle the message, otherwise
+  // this message will pend indefinitely.
+  if (client && activeClientIds.has(client.id)) {
+    ;(async function () {
+      const responseClone = response.clone()
+
+      sendToClient(
+        client,
+        {
+          type: 'RESPONSE',
+          payload: {
+            requestId,
+            isMockedResponse: IS_MOCKED_RESPONSE in response,
+            type: responseClone.type,
+            status: responseClone.status,
+            statusText: responseClone.statusText,
+            body: responseClone.body,
+            headers: Object.fromEntries(responseClone.headers.entries()),
+          },
+        },
+        [responseClone.body],
+      )
+    })()
+  }
+
+  return response
+}
+
+// Resolve the main client for the given event.
+// Client that issues a request doesn't necessarily equal the client
+// that registered the worker. It's with the latter the worker should
+// communicate with during the response resolving phase.
+async function resolveMainClient(event) {
+  const client = await self.clients.get(event.clientId)
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
+}
+
+async function getResponse(event, client, requestId) {
+  const { request } = event
+
+  // Clone the request because it might've been already used
+  // (i.e. its body has been read and sent to the client).
+  const requestClone = request.clone()
+
+  function passthrough() {
+    const headers = Object.fromEntries(requestClone.headers.entries())
+
+    // Remove internal MSW request header so the passthrough request
+    // complies with any potential CORS preflight checks on the server.
+    // Some servers forbid unknown request headers.
+    delete headers['x-msw-intention']
+
+    return fetch(requestClone, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
+  if (!client) {
+    return passthrough()
+  }
+
+  // Bypass initial page load requests (i.e. static assets).
+  // The absence of the immediate/parent client in the map of the active clients
+  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+  // and is not ready to handle requests.
+  if (!activeClientIds.has(client.id)) {
+    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(
+    client,
+    {
+      type: 'REQUEST',
+      payload: {
+        id: requestId,
+        url: request.url,
+        mode: request.mode,
+        method: request.method,
+        headers: Object.fromEntries(request.headers.entries()),
+        cache: request.cache,
+        credentials: request.credentials,
+        destination: request.destination,
+        integrity: request.integrity,
+        redirect: request.redirect,
+        referrer: request.referrer,
+        referrerPolicy: request.referrerPolicy,
+        body: requestBuffer,
+        keepalive: request.keepalive,
+      },
+    },
+    [requestBuffer],
+  )
+
+  switch (clientMessage.type) {
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
+    }
+
+    case 'MOCK_NOT_FOUND': {
+      return passthrough()
+    }
+  }
+
+  return passthrough()
+}
+
+function sendToClient(client, message, transferrables = []) {
+  return new Promise((resolve, reject) => {
+    const channel = new MessageChannel()
+
+    channel.port1.onmessage = (event) => {
+      if (event.data && event.data.error) {
+        return reject(event.data.error)
+      }
+
+      resolve(event.data)
+    }
+
+    client.postMessage(
+      message,
+      [channel.port2].concat(transferrables.filter(Boolean)),
+    )
+  })
+}
+
+async function respondWithMock(response) {
+  // Setting response status code to 0 is a no-op.
+  // However, when responding with a "Response.error()", the produced Response
+  // instance will have status code set to 0. Since it's not possible to create
+  // a Response instance with status code 0, handle that use-case separately.
+  if (response.status === 0) {
+    return Response.error()
+  }
+
+  const mockedResponse = new Response(response.body, response)
+
+  Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
+    value: true,
+    enumerable: true,
+  })
+
+  return mockedResponse
+}

package/src/native/index.ts

@@ -0,0 +1,17 @@
+import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'
+import { RequestHandler } from '~/core/handlers/RequestHandler'
+import { SetupServerApi } from '../node/SetupServerApi'
+
+/**
+ * Sets up a requests interception in React Native with the given request handlers.
+ * @param {RequestHandler[]} handlers List of request handlers.
+ *
+ * @see {@link https://mswjs.io/docs/api/setup-server `setupServer()` API reference}
+ */
+export function setupServer(
+  ...handlers: Array<RequestHandler>
+): SetupServerApi {
+  // Provision request interception via patching the `XMLHttpRequest` class only
+  // in React Native. There is no `http`/`https` modules in that environment.
+  return new SetupServerApi([XMLHttpRequestInterceptor], ...handlers)
+}

package/src/node/SetupServerApi.ts

@@ -0,0 +1,113 @@
+import {
+  BatchInterceptor,
+  HttpRequestEventMap,
+  Interceptor,
+  InterceptorReadyState,
+} from '@mswjs/interceptors'
+import { invariant } from 'outvariant'
+import { SetupApi } from '~/core/SetupApi'
+import { RequestHandler } from '~/core/handlers/RequestHandler'
+import { LifeCycleEventsMap, SharedOptions } from '~/core/sharedOptions'
+import { RequiredDeep } from '~/core/typeUtils'
+import { handleRequest } from '~/core/utils/handleRequest'
+import { devUtils } from '~/core/utils/internal/devUtils'
+import { mergeRight } from '~/core/utils/internal/mergeRight'
+import { SetupServer } from './glossary'
+
+const DEFAULT_LISTEN_OPTIONS: RequiredDeep<SharedOptions> = {
+  onUnhandledRequest: 'warn',
+}
+
+export class SetupServerApi
+  extends SetupApi<LifeCycleEventsMap>
+  implements SetupServer
+{
+  protected readonly interceptor: BatchInterceptor<
+    Array<Interceptor<HttpRequestEventMap>>,
+    HttpRequestEventMap
+  >
+  private resolvedOptions: RequiredDeep<SharedOptions>
+
+  constructor(
+    interceptors: Array<{
+      new (): Interceptor<HttpRequestEventMap>
+    }>,
+    ...handlers: Array<RequestHandler>
+  ) {
+    super(...handlers)
+
+    this.interceptor = new BatchInterceptor({
+      name: 'setup-server',
+      interceptors: interceptors.map((Interceptor) => new Interceptor()),
+    })
+    this.resolvedOptions = {} as RequiredDeep<SharedOptions>
+
+    this.init()
+  }
+
+  /**
+   * Subscribe to all requests that are using the interceptor object
+   */
+  private init(): void {
+    this.interceptor.on('request', async ({ request, requestId }) => {
+      const response = await handleRequest(
+        request,
+        requestId,
+        this.currentHandlers,
+        this.resolvedOptions,
+        this.emitter,
+      )
+
+      if (response) {
+        request.respondWith(response)
+      }
+
+      return
+    })
+
+    this.interceptor.on(
+      'response',
+      ({ response, isMockedResponse, request, requestId }) => {
+        this.emitter.emit(
+          isMockedResponse ? 'response:mocked' : 'response:bypass',
+          {
+            response,
+            request,
+            requestId,
+          },
+        )
+      },
+    )
+  }
+
+  public listen(options: Partial<SharedOptions> = {}): void {
+    this.resolvedOptions = mergeRight(
+      DEFAULT_LISTEN_OPTIONS,
+      options,
+    ) as RequiredDeep<SharedOptions>
+
+    // Apply the interceptor when starting the server.
+    this.interceptor.apply()
+
+    this.subscriptions.push(() => {
+      this.interceptor.dispose()
+    })
+
+    // Assert that the interceptor has been applied successfully.
+    // Also guards us from forgetting to call "interceptor.apply()"
+    // as a part of the "listen" method.
+    invariant(
+      [InterceptorReadyState.APPLYING, InterceptorReadyState.APPLIED].includes(
+        this.interceptor.readyState,
+      ),
+      devUtils.formatMessage(
+        'Failed to start "setupServer": the interceptor failed to apply. This is likely an issue with the library and you should report it at "%s".',
+      ),
+      'https://github.com/mswjs/msw/issues/new/choose',
+    )
+  }
+
+  public close(): void {
+    this.dispose()
+  }
+}

package/src/node/glossary.ts

@@ -0,0 +1,62 @@
+import type { PartialDeep } from 'type-fest'
+import {
+  RequestHandler,
+  RequestHandlerDefaultInfo,
+} from '~/core/handlers/RequestHandler'
+import {
+  LifeCycleEventEmitter,
+  LifeCycleEventsMap,
+  SharedOptions,
+} from '~/core/sharedOptions'
+
+export interface SetupServer {
+  /**
+   * Starts requests interception based on the previously provided request handlers.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()` API reference}
+   */
+  listen(options?: PartialDeep<SharedOptions>): void
+
+  /**
+   * Stops requests interception by restoring all augmented modules.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/close `server.close()` API reference}
+   */
+  close(): void
+
+  /**
+   * Prepends given request handlers to the list of existing handlers.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()` API reference}
+   */
+  use(...handlers: Array<RequestHandler>): void
+
+  /**
+   * Marks all request handlers that respond using `res.once()` as unused.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/restore-handlers `server.restore-handlers()` API reference}
+   */
+  restoreHandlers(): void
+
+  /**
+   * Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()` API reference}
+   */
+  resetHandlers(...nextHandlers: Array<RequestHandler>): void
+
+  /**
+   * Returns a readonly list of currently active request handlers.
+   *
+   * @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()` API reference}
+   */
+  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.
+   *
+   * @see {@link https://mswjs.io/docs/api/life-cycle-events Life-cycle Events API reference}
+   */
+  events: LifeCycleEventEmitter<LifeCycleEventsMap>
+}

package/src/node/index.ts

@@ -0,0 +1,3 @@
+export type { SetupServer } from './glossary'
+export { SetupServerApi } from './SetupServerApi'
+export { setupServer } from './setupServer'

package/src/node/setupServer.ts

@@ -0,0 +1,21 @@
+import { ClientRequestInterceptor } from '@mswjs/interceptors/ClientRequest'
+import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'
+import { FetchInterceptor } from '@mswjs/interceptors/fetch'
+import { RequestHandler } from '~/core/handlers/RequestHandler'
+import { SetupServerApi } from './SetupServerApi'
+import { SetupServer } from './glossary'
+
+/**
+ * Sets up a requests interception in Node.js with the given request handlers.
+ * @param {RequestHandler[]} handlers List of request handlers.
+ *
+ * @see {@link https://mswjs.io/docs/api/setup-server `setupServer()` API reference}
+ */
+export const setupServer = (
+  ...handlers: Array<RequestHandler>
+): SetupServer => {
+  return new SetupServerApi(
+    [ClientRequestInterceptor, XMLHttpRequestInterceptor, FetchInterceptor],
+    ...handlers,
+  )
+}

package/src/node/utils/isNodeExceptionLike.ts

@@ -0,0 +1,14 @@
+/**
+ * Determines if the given value is shaped like a Node.js exception.
+ * Node.js exceptions have additional information, like
+ * the `code` and `errno` properties.
+ *
+ * In some environments, particularly jsdom/jest these may not
+ * instances of `Error` or its subclasses, despite being similar
+ * to them.
+ */
+export function isNodeExceptionLike(
+  error: unknown,
+): error is NodeJS.ErrnoException {
+  return !!error && typeof error === 'object' && 'code' in error
+}

package/src/tsconfig.core.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.src.json",
+  "compilerOptions": {
+    "composite": false
+  }
+}

package/src/tsconfig.node.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.node.json",
+  "compilerOptions": {
+    "composite": false
+  }
+}

package/src/tsconfig.node.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.src.json",
+  "compilerOptions": {
+    "types": ["node"]
+  },
+  "include": ["./node", "./native"],
+  "exclude": ["**/*.test.ts"]
+}

package/src/tsconfig.src.json

@@ -0,0 +1,15 @@
+{
+  // Common configuration for everything
+  // living in the "src" directory.
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "composite": true,
+    "baseUrl": "./",
+    "paths": {
+      "~/core": ["core"],
+      "~/core/*": ["core/*"]
+    }
+  },
+  "include": ["../global.d.ts", "./**/*.ts"],
+  "exclude": ["./**/*.test.ts"]
+}