msw 0.46.1 → 0.47.2

package/README.md

@@ -5,15 +5,12 @@
 </p>
 
 <h1 align="center">Mock Service Worker</h1>
-<p align="center">Mock Service Worker (MSW) is an API mocking library for browser and Node.js.</p>
+<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://circleci.com/gh/mswjs/msw" target="_blank">
-    <img src="https://img.shields.io/circleci/project/github/mswjs/msw/master.svg?style=for-the-badge&color=black" alt="Build status" />
-  </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>
@@ -27,8 +24,8 @@
 ## Features
 
 - **Seamless**. A dedicated layer of requests interception at your disposal. Keep your application's code and tests unaware of whether something is mocked or not.
-- **Deviation-free**. Request the same production resources and test the actual behavior of your app. Augment an existing API, or design it as you go, when there is none.
-- **Familiar & Powerful**. Use [Express](https://github.com/expressjs/express)-like routing syntax to capture outgoing requests. Use parameters, wildcards, and regular expressions to match requests, and respond with necessary status codes, headers, cookies, delays, or completely custom resolvers.
+- **Deviation-free**. Request the same production resources and test the actual behavior of your app. Augment an existing API, or design it as you go when there is none.
+- **Familiar & Powerful**. Use [Express](https://github.com/expressjs/express)-like routing syntax to capture requests. Use parameters, wildcards, and regular expressions to match requests, and respond with necessary status codes, headers, cookies, delays, or completely custom resolvers.
 
 ---
 
@@ -38,6 +35,8 @@
 
 ## Documentation
 
+This README will give you a brief overview on the library but there's no better place to start with Mock Service Worker than its official documentation.
+
 - [Documentation](https://mswjs.io/docs)
 - [**Getting started**](https://mswjs.io/docs/getting-started/install)
 - [Recipes](https://mswjs.io/docs/recipes)
@@ -54,27 +53,27 @@
 
 ### How does it work?
 
-Browser usage is what sets Mock Service Worker apart from other tools. Utilizing the [Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API), which can intercept requests for the purpose of caching, Mock Service Worker responds to captured requests with your mock definition on the network level. This way your application knows nothing about the mocking.
+In-browser usage is what sets Mock Service Worker apart from other tools. Utilizing the [Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API), which can intercept requests for the purpose of caching, Mock Service Worker responds to captured requests with your mock definition on the network level. This way your application knows nothing about the mocking.
 
-**Watch a 30 seconds explanation on how Mock Service Worker works in a browser:**
+**Take a look at this quick presentation on how Mock Service Worker functions in a browser:**
 
 [![What is Mock Service Worker?](https://raw.githubusercontent.com/mswjs/msw/main/media/msw-video-thumbnail.jpg)](https://youtu.be/HcQCqboatZk)
 
 ### How is it different?
 
-- Intercepts requests on the network level, not the application level.
-- If you think of your application as a box, Mock Service Worker lives in its own box next to yours, instead of opening and altering it for the purpose of mocking.
-- Agnostic of request-issuing libraries, so you can use it with `fetch`, `axios`, `react-query`, you-name-it.
-- The same mock definition can be reused for unit, integration, E2E testing, and debugging.
+- This library intercepts requests on the network level, which means _after_ they have been performed and "left" your application. As a result, the entirety of your code runs, giving you more confidence when mocking;
+- Imagine your application as a box. Every API mocking library out there opens your box and removes the part that does the request, placing a blackbox in its stead. Mock Service Worker leaves your box intact, 1-1 as it is in production. Instead, MSW lives in a separate box next to yours;
+- No more stubbing of `fetch`, `axios`, `react-query`, you-name-it;
+- You can reuse the same mock definition for the unit, integration, and E2E testing. Did we mention local development and debugging? Yep. All running against the same network description without the need for adapters of bloated configurations.
 
 ### Usage example
 
 ```js
 // src/mocks.js
-// 1. Import mocking utils.
+// 1. Import the library.
 import { setupWorker, rest } from 'msw'
 
-// 2. Define request handlers and response resolvers.
+// 2. Describe network behavior with request handlers.
 const worker = setupWorker(
   rest.get('https://github.com/octocat', (req, res, ctx) => {
     return res(
@@ -87,7 +86,7 @@ const worker = setupWorker(
   }),
 )
 
-// 3. Start the Service Worker.
+// 3. Start request interception by starting the Service Worker.
 worker.start()
 ```
 
@@ -95,103 +94,96 @@ Performing a `GET https://github.com/octocat` request in your application will r
 
 ![Chrome DevTools Network screenshot with the request mocked](https://github.com/mswjs/msw/blob/main/media/msw-quick-look-network.png?raw=true)
 
-> **Tip:** Did you know that although Service Worker runs in a separate thread, your mock definition executes on the client-side? That way you can use the same languages (i.e. TypeScript), third-party libraries, and internal logic in mocks.
+> **Tip:** Did you know that although Service Worker runs in a separate thread, your mock definition executes entirely on the client? This way you can use the same languages, like TypeScript, third-party libraries, and internal logic to create the mocks you need.
 
-## Node
+## Node.js
 
 - [Learn more about using MSW in Node.js](https://mswjs.io/docs/getting-started/integrate/node)
 - [`setupServer` API](https://mswjs.io/docs/api/setup-server)
 
 ### How does it work?
 
-Although Service Worker is a browser-specific API, this library allows reusing of the same mock definition to have API mocking in Node.js through augmenting native request issuing modules.
+There's no such thing as Service Workers in Node.js. Instead, MSW implements a [low-level interception algorithm](https://github.com/mswjs/interceptors) that can utilize the very same request handlers you have for the browser. This blends the boundary between environments, allowing you to focus on your network behaviors.
 
 ### How is it different?
 
-- Prevents from stubbing `fetch`/`axios`/etc. as a part of your test, allowing you to treat API mocking as a pre-requisite and focus on what actually matters during testing.
-- The same mock definition you use for local development can be reused for testing.
+- Does not stub `fetch`, `axios`, etc. As a result, your tests know _nothing_ about mocking;
+- You can reuse the same request handlers for local development and debugging, as well as for testing. Truly a single source of truth for your network behavior across all environments and all tools.
 
 ### Usage example
 
-Here's an example of an actual integration test in Jest that uses [React Testing Library](https://github.com/testing-library/react-testing-library) and Mock Service Worker:
+Take a look at the example of an integration test in Jest that uses [React Testing Library](https://github.com/testing-library/react-testing-library) and Mock Service Worker:
 
 ```js
-// test/LoginForm.test.js
-import '@testing-library/jest-dom'
+// test/Dashboard.test.js
+
 import React from 'react'
 import { rest } from 'msw'
 import { setupServer } from 'msw/node'
-import { render, screen } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
-import Login from '../src/components/Login'
+import { render, screen, waitFor } from '@testing-library/react'
+import Dashboard from '../src/components/Dashboard'
 
 const server = setupServer(
-  rest.post('/login', (req, res, ctx) => {
-    // Respond with a mocked user token that gets persisted
-    // in the `sessionStorage` by the `Login` component.
-    return res(ctx.json({ token: 'mocked_user_token' }))
+  // Describe network behavior with request handlers.
+  // Tip: move the handlers into their own module and
+  // import it across your browser and Node.js setups!
+  rest.get('/posts', (req, res, ctx) => {
+    return res(
+      ctx.json([
+        {
+          id: 'f8dd058f-9006-4174-8d49-e3086bc39c21',
+          title: `Avoid Nesting When You're Testing`,
+        },
+        {
+          id: '8ac96078-6434-4959-80ed-cc834e7fef61',
+          title: `How I Built A Modern Website In 2021`,
+        },
+      ]),
+    )
   }),
 )
 
-// Enable API mocking before tests.
+// Enable request interception.
 beforeAll(() => server.listen())
 
-// Reset any runtime request handlers we may add during the tests.
+// Reset handlers so that each test could alter them
+// without affecting other, unrelated tests.
 afterEach(() => server.resetHandlers())
 
-// Disable API mocking after the tests are done.
+// Don't forget to clean up afterwards.
 afterAll(() => server.close())
 
-test('allows the user to log in', async () => {
-  render(<Login />)
-  userEvent.type(
-    screen.getByRole('textbox', { name: /username/i }),
-    'john.maverick',
-  )
-  userEvent.type(
-    screen.getByRole('textbox', { name: /password/i }),
-    'super-secret',
-  )
-  userEvent.click(screen.getByText(/submit/i))
-  const alert = await screen.findByRole('alert')
-
-  // Assert successful login state
-  expect(alert).toHaveTextContent(/welcome/i)
-  expect(window.sessionStorage.getItem('token')).toEqual(fakeUserResponse.token)
-})
+it('displays the list of recent posts', async () => {
+  render(<Dashboard />)
 
-test('handles login exception', () => {
-  server.use(
-    rest.post('/login', (req, res, ctx) => {
-      // Respond with "500 Internal Server Error" status for this test.
-      return res(
-        ctx.status(500),
-        ctx.json({ message: 'Internal Server Error' }),
-      )
-    }),
-  )
-
-  render(<Login />)
-  userEvent.type(
-    screen.getByRole('textbox', { name: /username/i }),
-    'john.maverick',
-  )
-  userEvent.type(
-    screen.getByRole('textbox', { name: /password/i }),
-    'super-secret',
-  )
-  userEvent.click(screen.getByText(/submit/i))
-
-  // Assert meaningful error message shown to the user
-  expect(alert).toHaveTextContent(/sorry, something went wrong/i)
-  expect(window.sessionStorage.getItem('token')).toBeNull()
+  // 🕗 Wait for the posts request to be finished.
+  await waitFor(() => {
+    expect(
+      screen.getByLabelText('Fetching latest posts...'),
+    ).not.toBeInTheDocument()
+  })
+
+  // ✅ Assert that the correct posts have loaded.
+  expect(
+    screen.getByRole('link', { name: /Avoid Nesting When You're Testing/ }),
+  ).toBeVisible()
+
+  expect(
+    screen.getByRole('link', { name: /How I Built A Modern Website In 2021/ }),
+  ).toBeVisible()
 })
 ```
 
-> **Tip:** Did you know that although the API is called `setupServer`, there are no actual servers involved? The name is chosen for familiarity, and the API is designed to resemble operating with an actual server.
+> Don't get overwhelmed! We've prepared a step-by-step [**Getting started**](https://mswjs.io/docs/getting-started/install) tutorial that you can follow to learn how to integrate Mock Service Worker into your project.
+
+Despite the API being called `setupServer`, there are no actual servers involved! The name was chosen for familiarity, and the API was designed to resemble operating with an actual server.
 
 ## Sponsors
 
+Mock Service Worker is trusted by hundreds of thousands of engineers around the globe. It's used by companies like Google, Microsoft, Spotify, Amazon, and countless others. Despite that, this library remains a hobby project maintained in spare time and has no opportunity to financially support even a single full-time contributor.
+
+**You can change that!** Consider [sponsoring the effort](https://github.com/sponsors/mswjs) behind one of the most innovative approaches around API mocking. Raise a topic of open source sponsorships with your boss and colleagues. Let's build sustainable open source together!
+
 ### Golden Sponsors
 
 > Become our first golden sponsor and get featured right here, enjoying other perks like issue prioritization and a personal consulting session with us.
@@ -227,6 +219,8 @@ test('handles login exception', () => {
 
 ## Awards & Mentions
 
+We've been extremely humbled to receive awards and mentions from the community for all the innovation and reach Mock Service Worker brings to the JavaScript ecosystem.
+
 <table>
   <tr valign="middle">
     <td width="124">

package/lib/{glossary-c690f512.d.ts → glossary-dc3fd077.d.ts}

@@ -253,7 +253,7 @@ declare abstract class RequestHandler<HandlerInfo extends RequestHandlerDefaultI
     /**
      * Print out the successfully handled request.
      */
-    abstract log(request: Request, response: SerializedResponse<any>, handler: this, parsedResult: ParsedResult): void;
+    abstract log(request: Request, response: SerializedResponse<any>, parsedResult: ParsedResult): void;
     /**
      * Parse the captured request to extract additional information from it.
      * Parsed result is then exposed to other methods of this request handler.
@@ -349,7 +349,7 @@ interface SetupServerApi {
      */
     resetHandlers(...nextHandlers: RequestHandler[]): void;
     /**
-     * Returns a readonly list of cyurrently active request handlers.
+     * Returns a readonly list of currently active request handlers.
      * @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()`}
      */
     listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, MockedRequest<DefaultBodyType>, any, MockedRequest<DefaultBodyType>>>;

package/lib/iife/index.js

@@ -467,7 +467,7 @@ var MockServiceWorker = (() => {
       Object.defineProperty(exports, "__esModule", { value: true });
       exports.headersToObject = void 0;
       var singleValueHeaders = ["user-agent"];
-      function headersToObject(headers) {
+      function headersToObject2(headers) {
         var headersObject = {};
         headers.forEach(function(value, name) {
           var isMultiValue = !singleValueHeaders.includes(name.toLowerCase()) && value.includes(",");
@@ -477,7 +477,7 @@ var MockServiceWorker = (() => {
         });
         return headersObject;
       }
-      exports.headersToObject = headersToObject;
+      exports.headersToObject = headersToObject2;
     }
   });
 
@@ -628,13 +628,13 @@ var MockServiceWorker = (() => {
       Object.defineProperty(exports, "__esModule", { value: true });
       exports.flattenHeadersObject = void 0;
       var reduceHeadersObject_1 = require_reduceHeadersObject();
-      function flattenHeadersObject(headersObject) {
+      function flattenHeadersObject2(headersObject) {
         return reduceHeadersObject_1.reduceHeadersObject(headersObject, function(headers, name, value) {
           headers[name] = [].concat(value).join("; ");
           return headers;
         }, {});
       }
-      exports.flattenHeadersObject = flattenHeadersObject;
+      exports.flattenHeadersObject = flattenHeadersObject2;
     }
   });
 
@@ -5318,12 +5318,12 @@ var MockServiceWorker = (() => {
       Object.defineProperty(exports, "__esModule", { value: true });
       exports.getArrayBuffer = exports.decodeBuffer = exports.encodeBuffer = void 0;
       var web_encoding_1 = require_lib8();
-      function encodeBuffer2(text2) {
+      function encodeBuffer3(text2) {
         var encoder = new web_encoding_1.TextEncoder();
         var encoded = encoder.encode(text2);
         return getArrayBuffer(encoded);
       }
-      exports.encodeBuffer = encodeBuffer2;
+      exports.encodeBuffer = encodeBuffer3;
       function decodeBuffer2(buffer, encoding) {
         var decoder = new web_encoding_1.TextDecoder(encoding);
         return decoder.decode(buffer);
@@ -12728,10 +12728,7 @@ spurious results.`);
       const statusColor = getStatusCodeColor(response2.status);
       console.groupCollapsed(devUtils.formatMessage("%s %s %s (%c%s%c)"), getTimestamp(), request.method, publicUrl, `color:${statusColor}`, `${response2.status} ${response2.statusText}`, "color:inherit");
       console.log("Request", loggedRequest);
-      console.log("Handler:", {
-        mask: this.info.path,
-        resolver: this.resolver
-      });
+      console.log("Handler:", this);
       console.log("Response", loggedResponse);
       console.groupEnd();
     }
@@ -12833,7 +12830,7 @@ Consider naming this operation or using "graphql.operation" request handler to i
       const hasMatchingOperationName = this.info.operationName instanceof RegExp ? this.info.operationName.test(parsedResult.operationName || "") : parsedResult.operationName === this.info.operationName;
       return hasMatchingUrl.matches && hasMatchingOperationType && hasMatchingOperationName;
     }
-    log(request, response2, handler, parsedRequest) {
+    log(request, response2, parsedRequest) {
       const loggedRequest = prepareRequest(request);
       const loggedResponse = prepareResponse(response2);
       const statusColor = getStatusCodeColor(response2.status);
@@ -12964,7 +12961,7 @@ Read more: https://mswjs.io/docs/getting-started/mocks`
 
   // src/utils/handleRequest.ts
   async function handleRequest(request, handlers, options, emitter, handleRequestOptions) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f;
     emitter.emit("request:start", request);
     if (request.headers.get("x-msw-bypass") === "true") {
       emitter.emit("request:end", request);
@@ -13005,11 +13002,21 @@ Read more: https://mswjs.io/docs/getting-started/mocks`
     const requiredLookupResult = lookupResult;
     const transformedResponse = ((_e = handleRequestOptions == null ? void 0 : handleRequestOptions.transformResponse) == null ? void 0 : _e.call(handleRequestOptions, response2)) || response2;
     (_f = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponse) == null ? void 0 : _f.call(handleRequestOptions, transformedResponse, requiredLookupResult);
-    (_g = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponseSent) == null ? void 0 : _g.call(handleRequestOptions, transformedResponse, requiredLookupResult);
     emitter.emit("request:end", request);
     return transformedResponse;
   }
 
+  // src/utils/logging/serializeResponse.ts
+  var import_headers_polyfill8 = __toESM(require_lib());
+  function serializeResponse(source) {
+    return {
+      status: source.status,
+      statusText: source.statusText,
+      headers: (0, import_headers_polyfill8.flattenHeadersObject)((0, import_headers_polyfill8.headersToObject)(source.headers)),
+      body: source.body
+    };
+  }
+
   // src/setupWorker/start/createRequestListener.ts
   var createRequestListener = (context, options) => {
     return async (event, message) => {
@@ -13021,7 +13028,7 @@ Read more: https://mswjs.io/docs/getting-started/mocks`
           onPassthroughResponse() {
             messageChannel.postMessage("NOT_FOUND");
           },
-          async onMockedResponse(response2) {
+          async onMockedResponse(response2, { handler, publicRequest, parsedRequest }) {
             if (response2.body instanceof ReadableStream) {
               throw new Error(devUtils.formatMessage('Failed to construct a mocked response with a "ReadableStream" body: mocked streams are not supported. Follow https://github.com/mswjs/msw/issues/1336 for more details.'));
             }
@@ -13031,12 +13038,11 @@ Read more: https://mswjs.io/docs/getting-started/mocks`
             messageChannel.postMessage("MOCK_RESPONSE", __spreadProps(__spreadValues({}, response2), {
               body: responseBody
             }), [responseBodyBuffer]);
-          },
-          onMockedResponseSent(response2, { handler, publicRequest, parsedRequest }) {
-            if (options.quiet) {
-              return;
+            if (!options.quiet) {
+              context.emitter.once("response:mocked", (response3) => {
+                handler.log(publicRequest, serializeResponse(response3), parsedRequest);
+              });
             }
-            handler.log(publicRequest, response2, handler, parsedRequest);
           }
         });
       } catch (error2) {
@@ -13262,11 +13268,44 @@ If this message still persists after updating, please report an issue: https://g
   }
 
   // src/setupWorker/start/createFallbackRequestListener.ts
-  var import_interceptors3 = __toESM(require_lib9());
+  var import_interceptors4 = __toESM(require_lib9());
   var import_fetch3 = __toESM(require_fetch());
   var import_XMLHttpRequest = __toESM(require_XMLHttpRequest());
+
+  // src/utils/request/createResponseFromIsomorphicResponse.ts
+  var import_interceptors3 = __toESM(require_lib9());
+  var noop = () => {
+    throw new Error("Not implemented");
+  };
+  function createResponseFromIsomorphicResponse(response2) {
+    return __spreadProps(__spreadValues({}, response2), {
+      ok: response2.status >= 200 && response2.status < 300,
+      url: "",
+      type: "default",
+      status: response2.status,
+      statusText: response2.statusText,
+      headers: response2.headers,
+      body: new ReadableStream(),
+      redirected: response2.headers.get("Location") != null,
+      async text() {
+        return response2.body || "";
+      },
+      async json() {
+        return JSON.parse(response2.body || "");
+      },
+      async arrayBuffer() {
+        return (0, import_interceptors3.encodeBuffer)(response2.body || "");
+      },
+      bodyUsed: false,
+      formData: noop,
+      blob: noop,
+      clone: noop
+    });
+  }
+
+  // src/setupWorker/start/createFallbackRequestListener.ts
   function createFallbackRequestListener(context, options) {
-    const interceptor = new import_interceptors3.BatchInterceptor({
+    const interceptor = new import_interceptors4.BatchInterceptor({
       name: "fallback",
       interceptors: [new import_fetch3.FetchInterceptor(), new import_XMLHttpRequest.XMLHttpRequestInterceptor()]
     });
@@ -13284,9 +13323,11 @@ If this message still persists after updating, please report an issue: https://g
             delay: response3.delay
           };
         },
-        onMockedResponseSent(response3, { handler, publicRequest, parsedRequest }) {
+        onMockedResponse(_, { handler, publicRequest, parsedRequest }) {
           if (!options.quiet) {
-            handler.log(publicRequest, response3, handler, parsedRequest);
+            context.emitter.once("response:mocked", (response3) => {
+              handler.log(publicRequest, serializeResponse(response3), parsedRequest);
+            });
           }
         }
       });
@@ -13294,6 +13335,17 @@ If this message still persists after updating, please report an issue: https://g
         request.respondWith(response2);
       }
     });
+    interceptor.on("response", (request, response2) => {
+      if (!request.id) {
+        return;
+      }
+      const browserResponse = createResponseFromIsomorphicResponse(response2);
+      if (response2.headers.get("x-powered-by") === "msw") {
+        context.emitter.emit("response:mocked", browserResponse, request.id);
+      } else {
+        context.emitter.emit("response:bypass", browserResponse, request.id);
+      }
+    });
     interceptor.apply();
     return interceptor;
   }