test(waitFor): Add current behavior for legacy fake timers and requestAnimationFrame

[eps1lon]

Identified the bug when trying out v8 alpha in react-spectrum. Waiting for release of jestjs/jest#11567

What:

Add a test for a bug caused by jestjs/jest#11565

Why:

Hoping that we can work around this bug in any way. Would appreciate if anybody got some insight.

How:

Add a test when where we waitFor requestAnimationFrame

Checklist:

• [ ] Documentation added to the
  docs site
• Tests
• [ ] Typescript definitions updated
• Ready to be merged
  

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 1acae4f:

Sandbox	Source
react-testing-library-examples	Configuration

[codecov]

Codecov Report

Merging #978 (1acae4f) into alpha (fa3b91c) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             alpha      #978   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        25           
  Lines          914       914           
  Branches       286       281    -5     
=========================================
  Hits           914       914           

Flag	Coverage Δ
node-12	100.00% <ø> (ø)
node-14	100.00% <ø> (ø)
node-16	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa3b91c...1acae4f. Read the comment docs.

[eps1lon]

Going to wait for a release of jestjs/jest#11567 which will fix the behavior for legacy timers and break this test.

[eps1lon]

Going to wait for a release of facebook/jest#11567 which will fix the behavior for legacy timers and break this test.

Landing now with a note about future breakage.

[github-actions]

🎉 This PR is included in version 8.0.0-alpha.7 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀