Skip to content

Update MSW usage in "example-intro" #1327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Update MSW usage in "example-intro" #1327

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6e1031
Update MSW usage in "example-intro"
kettanaito Oct 26, 2023
dbd489c
Update docs/react-testing-library/example-intro.mdx
kettanaito Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/react-testing-library/example-intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ See the following sections for a detailed breakdown of the test

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially I wanted to create a warning, but I noticed that we don't explicitly mention that the example uses MSW so I used a note.

Suggested change
:::note
The example uses [MSW (Mock Service Worker)](https://mswjs.io/) to mock HTTP requests.
MSW requires Node.js 18 or later.
:::

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind, it does mention it below the example.
Because I can't add a comment there, the lines at https://github.dev/kettanaito/testing-library-docs/blob/dbd489c8fa229dd43473daf7fd2d205c66fc3288/docs/react-testing-library/example-intro.mdx#L120-L122 should be removed.

Suggested change
:::note
We recommend using the [Mock Service Worker (MSW)](https://github.com/mswjs/msw) library
to declaratively mock API communication in your tests instead of stubbing
`window.fetch`, or relying on third-party adapters.
MSW requires Node.js 18 or later.
:::

```jsx title="__tests__/fetch.test.jsx"
import React from 'react'
import {rest} from 'msw'
import {http, HttpResponse} from 'msw'
import {setupServer} from 'msw/node'
import {render, fireEvent, screen} from '@testing-library/react'
import '@testing-library/jest-dom'
import Fetch from '../fetch'

const server = setupServer(
rest.get('/greeting', (req, res, ctx) => {
return res(ctx.json({greeting: 'hello there'}))
http.get('/greeting', () => {
return HttpResponse.json({greeting: 'hello there'})
}),
)

Expand All @@ -101,8 +101,8 @@ test('loads and displays greeting', async () => {

test('handles server error', async () => {
server.use(
rest.get('/greeting', (req, res, ctx) => {
return res(ctx.status(500))
http.get('/greeting', () => {
return new HttpResponse(null, { status: 500 })
}),
)

Expand Down Expand Up @@ -132,7 +132,7 @@ test('handles server error', async () => {
import React from 'react'

// import API mocking utilities from Mock Service Worker
import {rest} from 'msw'
import {http, HttpResponse} from 'msw'
import {setupServer} from 'msw/node'

// import react-testing methods
Expand Down Expand Up @@ -161,9 +161,9 @@ component makes.
// declare which API requests to mock
const server = setupServer(
// capture "GET /greeting" requests
rest.get('/greeting', (req, res, ctx) => {
http.get('/greeting', (req, res, ctx) => {
// respond using a mocked JSON body
return res(ctx.json({greeting: 'hello there'}))
return HttpResponse.json({greeting: 'hello there'})
}),
)

Expand All @@ -181,8 +181,8 @@ test('handles server error', async () => {
server.use(
// override the initial "GET /greeting" request handler
// to return a 500 Server Error
rest.get('/greeting', (req, res, ctx) => {
return res(ctx.status(500))
http.get('/greeting', (req, res, ctx) => {
return new HttpResponse(null, { status: 500 })
}),
)

Expand Down