msw 0.0.0-fetch.rc-0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018–present Artem Zakharchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,243 @@
+<br />
+
+<p align="center">
+  <img src="media/msw-logo.svg" width="100" alt="Mock Service Worker logo" />
+</p>
+
+<h1 align="center">Mock Service Worker</h1>
+<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://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>
+   <a href="https://kcd.im/discord" target="_blank">
+    <img src="https://img.shields.io/badge/chat-online-green?style=for-the-badge&color=black" alt="Discord server" />
+  </a>
+</p>
+
+<br />
+
+## 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 requests. Use parameters, wildcards, and regular expressions to match requests, and respond with necessary status codes, headers, cookies, delays, or completely custom resolvers.
+
+---
+
+> "_I found MSW and was thrilled that not only could I still see the mocked responses in my DevTools, but that the mocks didn't have to be written in a Service Worker and could instead live alongside the rest of my app. This made it silly easy to adopt. The fact that I can use it for testing as well makes MSW a huge productivity booster._"
+>
+> – [Kent C. Dodds](https://twitter.com/kentcdodds)
+
+## 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)
+- [FAQ](https://mswjs.io/docs/faq)
+
+## Examples
+
+- See the list of [**Usage examples**](https://github.com/mswjs/examples)
+
+## Browser
+
+- [Learn more about using MSW in a browser](https://mswjs.io/docs/getting-started/integrate/browser)
+- [`setupWorker` API](https://mswjs.io/docs/api/setup-worker)
+
+### How does it work?
+
+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.
+
+**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?
+
+- 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 the library.
+import { setupWorker, rest, HttpResponse } from 'msw'
+
+// 2. Describe network behavior with request handlers.
+const worker = setupWorker(
+  rest.get('https://github.com/octocat', ({ request, params, cookies }) => {
+    return HttpResponse.json(
+      {
+        message: 'Mocked response',
+      },
+      {
+        status: 202,
+        statusText: 'Mocked status',
+      },
+    )
+  }),
+)
+
+// 3. Start request interception by starting the Service Worker.
+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:
+
+![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 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.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?
+
+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?
+
+- 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
+
+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/Dashboard.test.js
+
+import React from 'react'
+import { rest, HttpResponse } from 'msw'
+import { setupServer } from 'msw/node'
+import { render, screen, waitFor } from '@testing-library/react'
+import Dashboard from '../src/components/Dashboard'
+
+const server = setupServer(
+  // 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', ({ request, params, cookies }) => {
+    return HttpResponse.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 request interception.
+beforeAll(() => server.listen())
+
+// Reset handlers so that each test could alter them
+// without affecting other, unrelated tests.
+afterEach(() => server.resetHandlers())
+
+// Don't forget to clean up afterwards.
+afterAll(() => server.close())
+
+it('displays the list of recent posts', async () => {
+  render(<Dashboard />)
+
+  // 🕗 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()
+})
+```
+
+> 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.
+>
+> **Learn more on our [GitHub Sponsors profile](https://github.com/sponsors/mswjs)**.
+
+<br />
+
+<a href="https://www.github.com/" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="media/sponsors/github-light.svg" />
+    <img src="media/sponsors/github.svg" alt="GitHub" width="75" />
+  </picture>
+</a>
+
+### Silver Sponsors
+
+> Become our _silver sponsor_ and get your profile image and link featured right here.
+>
+> **Learn more on our [GitHub Sponsors profile](https://github.com/sponsors/mswjs)**.
+
+<br />
+
+<a href="https://www.chromatic.com/" target="_blank">
+  <img src="media/sponsors/chromatic.svg" alt="Chromatic" width="75" />
+</a>
+
+### Bronze Sponsors
+
+> Become our first _bronze sponsor_ and get your profile image and link featured in this section.
+>
+> **Learn more on our [GitHub Sponsors profile](https://github.com/sponsors/mswjs)**.
+
+## 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">
+      <img src="https://raw.githubusercontent.com/mswjs/msw/main/media/tech-radar.png" width="124" alt="Technology Radar">
+    </td>
+    <td>
+      <h4>Solution Worth Pursuing</h4>
+      <p><em><a href="https://www.thoughtworks.com/radar/languages-and-frameworks/mock-service-worker">Technology Radar</a> (2020–2021)</em></p>
+    </td>
+  </tr>
+  <tr>
+    <td width="124">
+      <img src="https://raw.githubusercontent.com/mswjs/msw/main/media/os-awards.png" width="124" alt="Open Source Awards 2020">
+    </td>
+    <td>
+      <h4>The Most Exciting Use of Technology</h4>
+      <p><em><a href="https://osawards.com/javascript/2020">Open Source Awards</a> (2020)</em></p>
+    </td>
+  </tr>
+</table>

package/cli/index.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+const yargs = require('yargs')
+
+yargs
+  .usage('$0 <cmd> [args]')
+  .command(
+    'init <publicDir>',
+    'Initializes Mock Service Worker at the specified directory',
+    (yargs) => {
+      yargs
+        .positional('publicDir', {
+          type: 'string',
+          description: 'Relative path to the public directory',
+          required: true,
+          normalize: true,
+        })
+        .example('init', 'msw init public')
+        .option('save', {
+          type: 'boolean',
+          description: 'Save the worker directory in your package.json',
+        })
+    },
+    require('./init'),
+  )
+  .demandCommand()
+  .help().argv

package/cli/init.js

@@ -0,0 +1,144 @@
+const fs = require('fs')
+const path = require('path')
+const chalk = require('chalk')
+const { until } = require('@open-draft/until')
+const inquirer = require('inquirer')
+const invariant = require('./invariant')
+const { SERVICE_WORKER_BUILD_PATH } = require('../config/constants')
+
+const CWD = process.cwd()
+
+module.exports = async function init(args) {
+  const { publicDir, save } = args
+
+  // When running as a part of "postinstall" script, "cwd" equals the library's directory.
+  // The "postinstall" script resolves the right absolute public directory path.
+  const absolutePublicDir = path.isAbsolute(publicDir)
+    ? publicDir
+    : path.resolve(CWD, publicDir)
+  const relativePublicDir = path.relative(CWD, absolutePublicDir)
+  const dirExists = fs.existsSync(absolutePublicDir)
+
+  if (!dirExists) {
+    // Try to create the directory if it doesn't exist
+    const [createDirectoryError] = await until(() =>
+      fs.promises.mkdir(absolutePublicDir, { recursive: true }),
+    )
+    invariant(
+      createDirectoryError == null,
+      'Failed to create a Service Worker at "%s": directory does not exist and could not be created.\nMake sure to include a relative path to the root directory of your server.\n\nSee the original error below:\n%s',
+      absolutePublicDir,
+      createDirectoryError,
+    )
+  }
+
+  console.log(
+    'Initializing the Mock Service Worker at "%s"...',
+    absolutePublicDir,
+  )
+
+  const serviceWorkerFilename = path.basename(SERVICE_WORKER_BUILD_PATH)
+  const swDestFilepath = path.resolve(absolutePublicDir, serviceWorkerFilename)
+
+  fs.copyFileSync(SERVICE_WORKER_BUILD_PATH, swDestFilepath)
+
+  console.log(`
+${chalk.green('Service Worker successfully created!')}
+${chalk.gray(swDestFilepath)}
+
+Continue by creating a mocking definition module in your application:
+
+${chalk.cyan.bold('https://mswjs.io/docs/getting-started/mocks')}
+`)
+
+  const packageJsonPath = path.resolve(CWD, 'package.json')
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+  const { msw: mswConfig } = packageJson
+
+  if (mswConfig && mswConfig.workerDirectory === relativePublicDir) {
+    return
+  }
+
+  // When called `msw init --no-save` do not show the save suggestions.
+  if (save === false) {
+    return
+  }
+
+  if (!mswConfig) {
+    console.log(`\
+${chalk.cyan('INFO')} In order to ease the future updates to the worker script,
+we recommend saving the path to the worker directory in your package.json.
+        `)
+
+    if (save) {
+      return saveWorkerDirectory(packageJsonPath, relativePublicDir)
+    }
+
+    return promptWorkerDirectoryUpdate(
+      `Do you wish to save "${relativePublicDir}" as the worker directory?`,
+      packageJsonPath,
+      relativePublicDir,
+    )
+  }
+
+  if (mswConfig.workerDirectory !== relativePublicDir) {
+    console.log(
+      `\
+${chalk.yellowBright(
+  'WARN',
+)} The "msw.workerDirectory" in your package.json ("%s")
+is different from the worker directory used right now ("%s").
+    `,
+      mswConfig.workerDirectory,
+      relativePublicDir,
+    )
+
+    if (save) {
+      return saveWorkerDirectory(packageJsonPath, relativePublicDir)
+    }
+
+    return promptWorkerDirectoryUpdate(
+      `Do you wish to use "${relativePublicDir}" instead of "${mswConfig.workerDirectory}" as the worker directory?`,
+      packageJsonPath,
+      relativePublicDir,
+    )
+  }
+}
+
+function saveWorkerDirectory(packageJsonPath, publicDir) {
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+
+  console.log(
+    chalk.gray('Writing "msw.workerDirectory" to "%s"...'),
+    packageJsonPath,
+  )
+
+  const nextPackageJson = Object.assign({}, packageJson, {
+    msw: {
+      workerDirectory: publicDir,
+    },
+  })
+
+  fs.writeFileSync(
+    packageJsonPath,
+    JSON.stringify(nextPackageJson, null, 2),
+    'utf8',
+  )
+}
+
+function promptWorkerDirectoryUpdate(message, packageJsonPath, publicDir) {
+  return inquirer
+    .prompt({
+      type: 'confirm',
+      name: 'saveWorkerDirectory',
+      prefix: chalk.yellowBright('?'),
+      message,
+    })
+    .then((answers) => {
+      if (!answers.saveWorkerDirectory) {
+        return
+      }
+
+      saveWorkerDirectory(packageJsonPath, publicDir)
+    })
+}

package/cli/invariant.js

@@ -0,0 +1,8 @@
+const chalk = require('chalk')
+
+module.exports = function (predicate, message, ...args) {
+  if (!predicate) {
+    console.error(chalk.red(message), ...args)
+    process.exit(1)
+  }
+}

package/config/constants.js

@@ -0,0 +1,18 @@
+const path = require('path')
+
+const SERVICE_WORKER_SOURCE_PATH = path.resolve(
+  __dirname,
+  '../',
+  'src/mockServiceWorker.js',
+)
+
+const SERVICE_WORKER_BUILD_PATH = path.resolve(
+  __dirname,
+  '../lib',
+  path.basename(SERVICE_WORKER_SOURCE_PATH),
+)
+
+module.exports = {
+  SERVICE_WORKER_SOURCE_PATH,
+  SERVICE_WORKER_BUILD_PATH,
+}

package/config/scripts/postinstall.js

@@ -0,0 +1,48 @@
+const fs = require('fs')
+const path = require('path')
+const { execSync } = require('child_process')
+
+// When executing the "postinstall" script, the "process.cwd" equals
+// the package directory, not the parent project where the package is installed.
+// NPM stores the parent project directory in the "INIT_CWD" env variable.
+const parentPackageCwd = process.env.INIT_CWD
+
+function postinstall() {
+  // 1. Check if "package.json" has "msw.workerDirectory" property set.
+  const packageJson = JSON.parse(
+    fs.readFileSync(path.resolve(parentPackageCwd, 'package.json'), 'utf8'),
+  )
+
+  if (!packageJson.msw || !packageJson.msw.workerDirectory) {
+    return
+  }
+
+  // 2. Check if the worker directory is an existing path.
+  const { workerDirectory } = packageJson.msw
+  const absoluteWorkerDirectory = path.resolve(
+    parentPackageCwd,
+    workerDirectory,
+  )
+
+  if (!fs.existsSync(absoluteWorkerDirectory)) {
+    return console.error(
+      `[MSW] Failed to automatically update the worker script at "%s": given path does not exist.`,
+      workerDirectory,
+    )
+  }
+
+  // 3. Update the worker script.
+  const cliExecutable = path.resolve(process.cwd(), 'cli/index.js')
+
+  try {
+    execSync(`node ${cliExecutable} init ${absoluteWorkerDirectory}`, {
+      cwd: parentPackageCwd,
+    })
+  } catch (error) {
+    console.error(
+      `[MSW] Failed to automatically update the worker script:\n${error}`,
+    )
+  }
+}
+
+postinstall()

package/lib/SetupServerApi-3772a5d8.d.ts

@@ -0,0 +1,19 @@
+import { BatchInterceptor, Interceptor, HttpRequestEventMap } from '@mswjs/interceptors';
+import { c as SetupApi, i as ServerLifecycleEventsMap, R as RequestHandler, S as SharedOptions } from './glossary-f5428b2e.js';
+
+declare class SetupServerApi extends SetupApi<ServerLifecycleEventsMap> {
+    protected readonly interceptor: BatchInterceptor<Array<Interceptor<HttpRequestEventMap>>, HttpRequestEventMap>;
+    private resolvedOptions;
+    constructor(interceptors: Array<{
+        new (): Interceptor<HttpRequestEventMap>;
+    }>, ...handlers: Array<RequestHandler>);
+    /**
+     * Subscribe to all requests that are using the interceptor object
+     */
+    private init;
+    listen(options?: Partial<SharedOptions>): void;
+    printHandlers(): void;
+    close(): void;
+}
+
+export { SetupServerApi as S };