Skip to content
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.

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

[doc] add Jest debugging guide (docs/tests/jest.md) #17594

Merged
merged 4 commits into from
Feb 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Run unit tests and the linter with `yarn test`. To run just unit tests, run `yar

You can run the linter by itself with `yarn lint`, and you can automatically fix some lint problems with `yarn lint:fix`. You can also run these two commands just on your local changes to save time with `yarn lint:changed` and `yarn lint:changed:fix` respectively.

For Jest debugging guide using Node.js, see [docs/tests/jest.md](docs/tests/jest.md).

### Running E2E Tests

Our e2e test suite can be run on either Firefox or Chrome.
Expand Down
66 changes: 66 additions & 0 deletions docs/tests/jest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Getting Started

## Running a Jest test

```bash
> yarn jest <path>
```

## Debugging

### Debugging Jest in VS Code

1. Open **VS Code**
DDDDDanica marked this conversation as resolved.
Show resolved Hide resolved
2. Open the “Run and Debug” panel (⇧⌘D)
3. Click the “JavaScript Debug Terminal” button to open the Terminal
4. Run Jest using Node

```bash
> yarn jest --watch <path>
```

Additional methods and information to debug in VS Code can be found [here](https://jestjs.io/docs/troubleshooting#debugging-in-vs-code)

### Debugging Jest on Chrome DevTools

1. Run Jest using Node with the V8 Inspector

```bash
> node --inspect ./node_modules/.bin/jest --watch -i <path>

or

> node --inspect ./node_modules/.bin/jest <path>
```

**Options:**

```jsx
node:

--inspect=[host:]port
Activate inspector on host:port. Default is 127.0.0.1:9229.

V8 Inspector integration allows attaching Chrome DevTools and IDEs
to Node.js instances for debugging and profiling. It uses the
Chrome DevTools Protocol.

jest:

--watch Watch files for changes and rerun tests
related to changed files. If you want to
re-run all tests when a file has changed,
use the `--watchAll` option. [boolean]

-i, --runInBand Run all tests serially in the current
process (rather than creating a worker pool
of child processes that run tests). This is
sometimes useful for debugging, but such use
cases are pretty rare. [boolean]
```


1. Open Chrome DevTools for Node
1. Open a **Chromium** browser
2. Go to [chrome://inspect/#devices](chrome://inspect/#devices)
3. Click “Open dedicated DevTools for Node” link