feat(fake-timers)!: allow jest.useFakeTimers() and projectConfig.fakeTimers to take an options bag

[mrazauskas]

Resolves #8257 (allows jest.useFakeTimers({timerLimit: 10});)
Resolves #10602 (allows jest.useFakeTimers({advanceTimers: 30, now: new Date('2015-09-25')});)
Resolves #12055 (allows workaround jest.useFakeTimers({doNotFake: ['performance']});)
Closes #11661
Closes #12362
Closes #12452

Summary

As it is mentioned in the linked issues, it would be very useful to allow jest.useFakeTimers() and projectConfig.fakeTimers to take an options object, which would configure underling @sinonjs/fake-timers. E.g. loopLimit, shouldAdvanceTime, toFake and all other options.

ToDo

• unit test for the implementation
• e2e tests for the new API
• documentation
• changelog entry

Test plan

Current and new unit, e2e and type tests should pass.

[Biki-das]

@mrazauskas i had a doubt if you can explain and this is out of this pr, how is the deploy netlify preview configured in the codebase , anyone

[SimenB]

looking good!

[mrazauskas]

@SimenB What if migration guide would be added? See last commit. This is just a draft, to illustrate the idea. Could be moved to separate PR and polished there.

[SimenB]

Yeah, we can do an upgrade guide, I like it! I reverted that commit for now to land this, but a generic "how to upgrade to v28" sounds like a good idea to me! 👍 loooooooots of breaking changes

[SimenB]

This is amazing work @mrazauskas, thank you so much!

[mrazauskas]

Great! I will open a PR with How to Upgrade Guide.

[danny-does-stuff]

Thank you for doing this @mrazauskas ! I've been following #11661 closely, and I'm very happy to see it resolved finally!

[SimenB]

https://github.com/facebook/jest/releases/tag/v28.0.0-alpha.8

[SimenB]

super happy with this diff at work 😀

[mrazauskas]

@SimenB For some reason few recent updates of documentation are not yet included on Jest website. It either fails to rebuild or there are cache problems on my side. Can I ask to take a quick look? (;

[SimenB]

Hmm, something is wrong with the deployment: https://app.netlify.com/sites/jestjs/deploys/624d79914cda8b0008589faa

[SimenB]

@mrazauskas fixed now 🙂 Thanks for noticing!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.