-
Notifications
You must be signed in to change notification settings - Fork 711
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
docs(fakeTimers): Explain how to use fake timers in testing-library #528
Merged
kentcdodds
merged 8 commits into
testing-library:master
from
MatanBobi:pr/explain-fake-timers
Jul 28, 2020
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ab42bbd
docs(fakeTimers): Explain how to use fake timers in testing-library
MatanBobi b03c800
docs(fakeTimers): Fix some phrases and use runOnlyPendingTimers.
MatanBobi bf684ae
docs(fakeTimers): Add a missing space and fix phrasing
MatanBobi f73c0fd
docs(fakeTimers): Multiple fixes for adding fake timers page after re…
MatanBobi 52148f3
Update docs/using-fake-timers.md
MatanBobi 37eadeb
docs(fakeTimers): Rephrase the using section to explain that fake tim…
MatanBobi b41df33
Merge branch 'pr/explain-fake-timers' of github.com:MatanBobi/testing…
MatanBobi 6247670
docs(fakeTimers): Fix small typo
MatanBobi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
id: using-fake-timers | ||
title: Using Fake Timers | ||
sidebar_label: Using Fake Timers | ||
--- | ||
|
||
Using real timers in your tests is problematic since they depend on real time | ||
lapse. | ||
When you depend on real time, your tests can be unpredictable, slow, flaky. This | ||
will also prevent you from making any assumptions about timestamps within | ||
your tests. | ||
|
||
To solve these problems, most testing frameworks offer the option to use fake | ||
timers in your tests so you won't need to rely on real times. | ||
eps1lon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
When using fake timers in your tests, all of the code inside your test uses fake | ||
timers. | ||
The common pattern to setup fake timers is usually within the `beforeEach`, for | ||
example: | ||
|
||
```js | ||
// Fake timers using Jest | ||
beforeEach(() => { | ||
jest.useFakeTimers() | ||
}) | ||
``` | ||
|
||
When using fake timers, you need to remember to restore the timers after your | ||
test runs. | ||
The main reason to do that is to prevent 3rd party libraries running after your | ||
test finishes (e.g cleanup functions), from being coupled to your fake timers | ||
and use real timers instead. | ||
For that you usually call `useRealTimers` in `afterEach`. | ||
It's important to also call `runOnlyPendingTimers` before switching to real | ||
timers. | ||
This will ensure you flush all the pending timers before you switch to real | ||
timers. If you don't progress the timers and just switch to real timers, the | ||
scheduled tasks won't get executed and you'll get an unexpected behavior. | ||
This is mostly important for 3rd parties that schedule tasks without you being | ||
aware of it. | ||
Here's an example of doing that using jest: | ||
|
||
```js | ||
// Running all pending timers and switching to real timers using Jest | ||
afterEach(() => { | ||
jest.runOnlyPendingTimers() | ||
jest.useRealTimers() | ||
}) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like the wording here strongly advises the use of fake timers 100% of the time or as the default. I don't know about anyone else, but fake timers as complexity to test code and only sometimes provide any benefit and I therefore only use them when I really want to fake timers (like a debounce). Either way, I don't think this mentions the drawbacks fairly and I think we should do so. I don't think people should come away from reading this with the ideas that fake timers should be their default way for testing. Maybe we could add a section for when fake timers are worth the trouble?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah you're right, it's pretty misleading, I'll work on that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry it took me some time, I rephrased it.
I think it's still not 100% explanatory though, wasn't really sure how I can expand it..