https://github.com/mswjs/jest-fixed-jsdom

A superset of the JSDOM environment for Jest that respects Node.js globals.
https://github.com/mswjs/jest-fixed-jsdom

environment jest jsdom msw mswjs node testing

Last synced: 4 days ago
JSON representation

A superset of the JSDOM environment for Jest that respects Node.js globals.

• Host: GitHub
• URL: https://github.com/mswjs/jest-fixed-jsdom
• Owner: mswjs
• Created: 2024-03-18T10:49:50.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-11-13T09:43:12.000Z (about 2 months ago)
• Last Synced: 2024-12-22T12:12:22.601Z (11 days ago)
• Topics: environment, jest, jsdom, msw, mswjs, node, testing
• Language: JavaScript
• Homepage: https://npm.im/jest-fixed-jsdom
• Size: 71.3 KB
• Stars: 54
• Watchers: 5
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
jest-fixed-jsdom

A superset of the JSDOM environment for Jest that respects Node.js globals.


> [!WARNING]

> **This package is never meant as a solution to anything**. This is a workaround. Please consider testing browser code in the actual browser. You can do so both in [Vitest](https://vitest.dev/guide/browser/) and in [Playwright](https://playwright.dev/docs/test-components) at the moment.

## Motivation

When you use Jest with JSDOM you are getting a broken test environment. Some Node.js globals cease to exist (e.g. `Request`, `Response`, `TextEncoder`, `TextDecoder`, `ReadableStream`1), while others stop behaving correctly (e.g. `Event`, `MessageEvent`2, `structuredClone()`3). That is caused by `jest-environment-jsdom` and JSDOM relying on polyfills to implement standard APIs that have been available globally both in the browser and in Node.js for years.

Here's a piece of valid JavaScript that works in both the browser and Node.js but fails in Jest/JSDOM:

```js

new TextEncoder().encode('hello')

```

```

ReferenceError: TextEncoder is not defined

```

**We strongly believe that a valid JavaScript code must compile regardless of what test environment you are using**. In fact, having a proper test environment is crucial to get any kind of value from your tests. Jest/JSDOM take that already working environment away from you.

We've built this project aims to fix that problem, restoring the global APIs that are present in both environments, providing better interoperability, stability, and consistent runtime behavior.

## Changes

This project "fixes" the following global APIs, overriding whichever polyfills they have with respective Node.js globals:

- `fetch()`

- `Blob`

- `FormData`

- `Headers`

- `Request`

- `Response`

- `ReadableStream`

- `TextEncoder`

- `TextDecoder`

- `TextEncoderStream`

- `TextDecoderStream`

- `structuredClone()`

- `URL`

- `URLSearchParams`

- `BroadcastChannel`

- `TransformStream`

## Getting started

### Install

```sh

npm i jest-fixed-jsdom --save-dev

```

### Configure Jest

In your `jest.config.js`, set the `testEnvironment` option to `jest-fixed-jsdom`:

```js

// jest.config.js

module.exports = {

  testEnvironment: 'jest-fixed-jsdom',

}

```

> You can use any other `testEnvironmentOptions` you need. Those will be forwarded to the underlying `jest-environment-jsdom`.