Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
cpojer committed May 5, 2020
1 parent 01d916a commit 5f9a046
Showing 1 changed file with 16 additions and 22 deletions.
38 changes: 16 additions & 22 deletions website/blog/2020-05-06-jest-26.md
Expand Up @@ -7,7 +7,7 @@ authorFBID: 100000023028168

# Jest 26: Tick Tock

When we started rebuilding Jest five years ago our goal was to provide a batteries-included zero-configuration test runner that is approachable for beginners, extensible for almost all testing use cases and scalable to large projects. One of the most important releases was [Jest 15](https://jestjs.io/blog/2016/09/01/jest-15) which tied all the bits and pieces together and provided great defaults that allowed people to install and run Jest often without any setup. However, this approach has a big downside as Jest installs a lot of dependencies into your projects that you may not need.
When we started rebuilding Jest five years ago our goal was to provide a batteries-included zero-configuration test runner that is approachable for beginners, extensible for almost all testing use cases and scalable to large projects. One of the instrumental releases was [Jest 15](https://jestjs.io/blog/2016/09/01/jest-15) which tied everything together and provided good defaults that allowed people to run Jest often without any setup. However, this approach has a big downside as Jest installs a lot of dependencies into your projects that you may not need.

We are now beginning to address this shortcoming and are working on reducing Jest’s install size while keeping it approachable and extensible. We have made the following breaking changes in Jest 26:

Expand All @@ -19,9 +19,9 @@ We are now beginning to address this shortcoming and are working on reducing Jes

With the above changes Jest 26 is now 4 MiB smaller than Jest 25.5.4 (53 → 49 MiB). Please keep in mind that many dependencies like Babel are likely already part of your project. Jest's own size was reduced by 1.2 MiB (4.3 -> 3.1 MiB).

While this is a good start, it isn’t enough to make Jest meaningfully leaner. We are planning on gradually reducing Jest's and its dependency tree size by about 70%. Most of the changes to reduce Jest’s default setup will be small breaking changes and we want to bring the community with us as much as possible. Therefore we will make the following changes in Jest 27 and Jest 28 using a [“Tick-Tock" release process](https://en.wikipedia.org/wiki/Tick%E2%80%93tock_model):
While this is a good start, it isn’t enough to make Jest meaningfully leaner. We are planning on gradually reducing Jest's and its dependency tree size by up to 70%. Most of the changes to reduce Jest’s default setup will be small breaking changes and we want to bring the community with us as much as possible. Therefore we will make the following changes in Jest 27 and Jest 28 using a [“Tick-Tock" release process](https://en.wikipedia.org/wiki/Tick%E2%80%93tock_model):

- Jest 27 will ship with a new test runner (`jest-circus`) and the Node.js environment by default. `jest-jasmine2` and `jest-environment-jsdom` will still be bundled so users can keep using them by changing one-line each in the configuration.
- Jest 27 will ship with a new test runner "`jest-circus`" and the Node.js environment by default. `jest-jasmine2` and `jest-environment-jsdom` will still be bundled so users can keep using them by changing one-line each in the configuration.
- Jest 28 will remove `jest-jasmine2` and `jest-environment-jsdom` from the default distribution of Jest. The packages will still be actively maintained as part of the Jest project and be published separately. Users will need to install these packages to use them.

Upon upgrading to these major releases, Jest will guide you through the necessary changes. If you’d like to get ahead and migrate to the new defaults now, and your project does not require a DOM environment, you can upgrade to Jest 26 and add the following configuration options:
Expand All @@ -37,35 +37,30 @@ Upon upgrading to these major releases, Jest will guide you through the necessar

Jest will continue to ship with `babel-jest` enabled by default. It currently powers a few Jest features beyond compiling modern JavaScript syntax to something understood by current versions of Node.js and browsers: It also powers Jest's code coverage and mocking of ES modules. Jest currently ships with experimental support for [V8 coverage](/blog/2020/01/21/jest-25#v8-code-coverage) and native support for ES Modules (more on that below!). It is not possible to mock static ES Modules per the specification without transforming the code first, so we will be encouraging patterns that work without the transformation we use Babel for today. Once V8 coverage and native ESM support stabilizes in Jest, we will also be able remove `babel-jest` as a default but we will keep maintaining it.

## New implementation of fake timers
## New fake timers

Since 2017 we've been wanting to swap out Jest's implementation of fake timer with the more feature-complete implementation of Lolex - with Jest 26 this is finally happening! It took so long Lolex has even been renamed in the meantime to `@sinonjs/fake-timers`. It has taken so long since we wanted to make sure the implementation was solid and was usable for all the use cases Jest already supported. We're now confident it is stable enough for everybody to use.
With Jest 26 we are shipping a new implementation of fake timers based on `@sinonjs/fake-timers`. We've wanted to do this for years and are happy this has finally progressed far enough to support all of Jest's existing fake timer use cases.

The new implementation comes with some extra features, such as mocking `Date`, `queueMicrotask` and more, see their [readme](https://github.com/sinonjs/fake-timers/blob/master/README.md) for more details. We're calling the APIs through the Jest APIs you already know, so keep calling `jest.runAllTimers()` etc. like you've been doing. The docs as always are available [here](https://jestjs.io/docs/en/timer-mocks) on our website.
The new implementation comes with extra features such as mocking `Date`, `queueMicrotask` and more, see [this README](https://github.com/sinonjs/fake-timers/blob/master/README.md). It works transparently using the existing timer APIs like `jest.runAllTimers()` – check out the documentation [on our website](https://jestjs.io/docs/en/timer-mocks).

While we are confident this implementation is ready for prime time, we don't want to force people to rewrite their tests if they depend on Jest's current implementation to work, so for Jest 26 this new implementation will remain _opt-in_. Activate it by calling `jest.useFakeTimers('modern')` or by passing `modern` as the option in your config if you currently have `fake` there.
We are confident this implementation is ready for prime time, however we don't want to force people to rewrite their tests if they depend on subtle differences between the old and new implementation. In Jest 26, this new implementation will remain *opt-in* and can be activated by calling `jest.useFakeTimers('modern')` or by passing `modern` to the `timers` option in your config if you opted all tests into fake timers previously.

We will continue to support the legacy implementation going forward, but we will swap the default over to the "modern" timers in Jest 27. At that time you can opt-in to the legacy implementation by specifying `jest.useFakeTimers('legacy')`. If you know _now_ that you want to keep using the legacy implementation, you can specify that today and not have to change anything when Jest 27 comes around.
In Jest 27 we will swap the default to the new "modern" implementation but we will keep supporting and maintaining the legacy implementation which can be used by calling `jest.useFakeTimers('legacy')`. If you are unsure whether you'll be able to upgrade all your tests by the time Jest 27 rolls out, you can add this to your tests now to keep the old behavior.

Huge thanks to [Carl-Erik Kopseng](https://github.com/fatso83), [Benjamin Gruenbaum](https://github.com/benjamingr) and other maintainers of `@sinonjs/fake-timers` for their help and patience when working with us to make this happen!
We'd like to thank [Carl-Erik Kopseng](https://github.com/fatso83), [Benjamin Gruenbaum](https://github.com/benjamingr) and other maintainers of `@sinonjs/fake-timers` for their help and patience when working with us to make this happen! *Exciting*.

## New way to consume Jest - `@jest/globals`
## A new way to consume Jest - `@jest/globals`

Jest has used the widely known `describe`, `it`, `test` and `expect` globals throughout its lifetime - it's a widely used pattern, it's very easy to get started quickly and we all like the ease globals offers us when writing code. That said, we've heard (loud and clear) that many people don't like globals and that they'd like to import the functions in their tests instead.
Jest has relied on globals popularized by the Jasmine testing framework and others such as `describe`, `it`, `test` and `expect`. While this is a widely used patterns, many people have expressed their preference for importing testing related functions instead. To support this use case, we added a new package `@jest/globals` that can be used to import testing functions: `import {expect, jest, test} from '@jest/globals';`.

With Jest 26<sup>\*</sup>, this is now a possibility through the use of a new package called `@jest/globals`. So now you can do `import { expect, jest, test } from '@jest/globals';` in your tests to your heart's content!

A couple of quick caveats:

1. The globals still exist in the environment - we will introduce a `noGlobals` mode in the future for those who wants no globals whatsoever
1. There's currently no clean way to add custom matchers to the TypeScript definitions. Help appreciated fixing that.
1. If you do `const {jest} = require('@jest/globals')` - i.e. don't use transpiled (or native) `import` syntax, you will get declaration errors as we still inject `jest` into the module scope of every file. The `noGlobals` mode will alleviate this issue

<sup>\*</sup>) This was released in 25.5, but we didn't blog about it!
Caveats:
* Currently the globals still exist in the environment but we will introduce a mode to disable globals in the future. Similarly, you cannot use `const jest = require('@jest/globals')` as you'll get declaration orders because the `jest` variable is still a global for now.
* There is currently no way to add custom matchers to the TypeScript definitions when using globals like this.
* While this allows running tests without globals, it does not allow running tests without Jest's test runner at this time.

## Native ESM support

As mentioned in the [Jest 25 blog post](/blog/2020/01/21/jest-25#ecmascript-modules-support) we have begun exploring native support for ECMAScript Modules. This work started shipping in Jest 25.3, and has received bug fixes and features in every release since. We're still some distance away from it stabilizing, but any and all help testing it would be highly appreciated! For an overview of the current state you can check out [this issue](https://github.com/facebook/jest/issues/9430), or browse all issues with that label [ES Modules](https://github.com/facebook/jest/labels/ES%20Modules).
As mentioned in the [Jest 25 blog post](/blog/2020/01/21/jest-25#ecmascript-modules-support) we have been working on native support for ECMAScript Modules. It is not stable yet but it is ready to be tested. We'd love to hear your feedback and bug reports! For an overview of the current state you can check out [this issue](https://github.com/facebook/jest/issues/9430), or browse all issues with that label [ES Modules](https://github.com/facebook/jest/labels/ES%20Modules).

## Other Breaking Changes in Jest 26

Expand All @@ -75,7 +70,6 @@ As mentioned in the [Jest 25 blog post](/blog/2020/01/21/jest-25#ecmascript-modu
- `[jest-haste-map]` Removed `providesModuleNodeModules` ([#8535](https://github.com/facebook/jest/pull/8535))
- `[jest-circus]` Fail tests if a test takes a done callback and have return values ([#9129](https://github.com/facebook/jest/pull/9129))
- `[jest-circus]` Throw a proper error if a test / hooks is defined asynchronously ([#8096](https://github.com/facebook/jest/pull/8096))
- **_TODO_**

## Stay Safe

Expand Down

0 comments on commit 5f9a046

Please sign in to comment.