Exposing jest.runToFrame() from sinon/fake_timers #14598

alexreardon · 2023-10-03T23:27:36Z

linux-foundation-easycla · 2023-10-03T23:27:40Z

The committers listed above are authorized under a signed CLA.

✅ login: alexreardon / name: Alex Reardon (1b7add7, a43bb16, 95a3861, e21c9ca, 362c6ed, ec04c81, 2dd1cb3, e7e5543, d1ae881, 2c69f29, 6498b05, bedecdf, 172718c)

netlify · 2023-10-03T23:27:42Z

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`172718c`
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/651dfdaa9cb2d90008474e14
😎 Deploy Preview	https://deploy-preview-14598--jestjs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

alexreardon · 2023-10-03T23:31:15Z

docs/JestObjectAPI.md

@@ -989,6 +989,16 @@ This function is not available when using legacy fake timers implementation.

 :::

+### `jest.runToFrame()`


Should I add these changes to 29.7 docs or just the base docs like I have now?

Just base 👍

alexreardon · 2023-10-03T23:34:06Z

Update: never mind, I found where this check should happen (jest runtime). I have updated the PR

@SimenB you mentioned that

It should also throw when using legacy timers

I can add that, but I did not see any other cases of that so I have not for now. I can add that if you still want it

alexreardon · 2023-10-04T01:57:37Z

It looks like the build failures are caused by unrelated issues

SimenB

Perfect, thanks!

In addition to my API question, could you add a changelog entry? 🙂

SimenB · 2023-10-04T05:15:08Z

docs/JestObjectAPI.md

@@ -989,6 +989,16 @@ This function is not available when using legacy fake timers implementation.

 :::

+### `jest.runToFrame()`


Should we call it runToNextFrame? runToFrame sounds to me like it'd take which frame (or a number of frames) as an argument

I just mirrored the sinon api without too much thought 😊

runToNextFrame() feels nice and fits with runOnlyPendingTimers().
Another idea: advanceTimersToNextFrame() - fits in with `advanceTimersToNextTimer()

Which do you lean towards? (Or something else?)

yeah, advanceTimersToNextFrame sounds perfect to align with existing functions 👍

hmm? I believe I answered the question? 😅

Sorry, for some reason I didn't see your reply

docs/TimerMocks.md

SimenB · 2023-10-04T05:18:29Z

It looks like the build failures are caused by unrelated issues

Yeah, the windows tests has a bit of flake, unfortunately

mrazauskas · 2023-10-04T06:49:13Z

packages/jest-environment/src/index.ts

@@ -349,6 +349,14 @@ export interface Jest {
   * It is recommended to use `jest.mock()` instead. The `jest.mock()` API's second
   * argument is a module factory instead of the expected exported module object.
   */
+  /**


The above TSDoc belongs to 'setMock'. Would be good to move it down (;

Thanks! Fixed

…guage

alexreardon · 2023-10-05T00:06:58Z

Hi @SimenB,

I think I have addressed all the open feedback. Please take a look and let me know what you think

alexreardon · 2023-10-05T00:08:13Z

docs/TimerMocks.md

+
+In applications, often you want to schedule work inside of an animation frame (with `requestAnimationFrame`). We expose a convenience method `jest.advanceTimersToNextFrame()` to advance all timers enough milliseconds to execute all actively scheduled animation frames.
+
+For mock timing purposes, animation frames are executed every `16ms` (mapping to roughly `60` frames per second) after the clock starts. When you schedule a callback in an animation frame (with `requestAnimationFrame(callback)`), the `callback` will be called when the clock has advanced `16ms`. `jest.advanceTimersToNextFrame()` will advance the clock just enough to get to the next `16ms` increment. If the clock has already advanced `6ms` since a animation frame `callback` was scheduled, then the clock will be advanced by `10ms`.


A added some more detail here to hopefully make things clearer for consumers

SimenB

perfect, thanks!

alexreardon · 2023-10-05T05:18:06Z

Here is a workaround for anybody who needs it before jest.advanceTimersToNextFrame() lands:

// ensure you are using "modern" fake timers
// 1. before doing anything, grab the start time `setStartSystemTime()`
// 2. step through frames by using `advanceTimersToNextFrame()`

let startTime: number | null = null;

/** Record the initial (mocked) system start time 
 * 
 * This is no longer needed once `jest.advanceTimersToNextFrame()` is available
 * https://github.com/jestjs/jest/pull/14598
*/
export function setStartSystemTime() {
  startTime = Date.now();
}

/** Step forward a single animation frame
 * 
 * This is no longer needed once `jest.advanceTimersToNextFrame()` is available
 * https://github.com/jestjs/jest/pull/14598
 */
export function advanceTimersToNextFrame() {
  if(startTime == null) {
     throw new Error('Must call `setStartSystemTime` before using `advanceTimersToNextFrame()`');
  }

  // Stealing logic from sinon fake timers
  // https://github.com/sinonjs/fake-timers/blob/fc312b9ce96a4ea2c7e60bb0cccd2c604b75cdbd/src/fake-timers-src.js#L1102-L1105
  const timePassedInFrame = (Date.now() - startTime) % 16;
  const timeToNextFrame = 16 - timePassedInFrame;
  jest.advanceTimersByTime(timeToNextFrame);
}

SimenB · 2023-10-30T13:37:41Z

https://github.com/jestjs/jest/releases/tag/v30.0.0-alpha.1

github-actions · 2023-11-30T00:08:44Z

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.

alexreardon added 3 commits October 4, 2023 09:23

exposing runToFrame() from sinon/fake-timers

1b7add7

updating sinon integration test

a43bb16

updating timer docs

95a3861

alexreardon commented Oct 3, 2023

View reviewed changes

tweaking docs

e21c9ca

alexreardon mentioned this pull request Oct 3, 2023

[Feature]: Please expose runToFrame() from sinon/fake_timers in @jest/fake-timers #14593

Closed

alexreardon added 2 commits October 4, 2023 10:54

updating doc title

362c6ed

exposing runToFrame from jest runtime

ec04c81

alexreardon changed the title ~~Exposing jest.runToFrame() from sinon/fake_timers in @jest/fake-timers~~ Exposing jest.runToFrame() from sinon/fake_timers Oct 4, 2023

Merge branch 'main' of github.com:jestjs/jest into exposing-run-to-frame

2dd1cb3

SimenB approved these changes Oct 4, 2023

View reviewed changes

mrazauskas reviewed Oct 4, 2023

View reviewed changes

alexreardon added 6 commits October 5, 2023 10:21

renaming to jest.advanceTimersToNextFrame

e7e5543

adding a test for requestAnimationFrame behaviour

d1ae881

adding another test to be super safe. Also improving some testing lan…

2c69f29

…guage

updating description

6498b05

removing duplicate test

bedecdf

updating changelog

172718c

alexreardon commented Oct 5, 2023

View reviewed changes

SimenB approved these changes Oct 5, 2023

View reviewed changes

SimenB merged commit 00ef0ed into jestjs:main Oct 5, 2023
61 of 62 checks passed

nicojs pushed a commit to nicojs/jest that referenced this pull request Oct 13, 2023

feat: add jest.advanceTimersToFrame() (jestjs#14598)

ccc7e4e

github-actions bot locked as resolved and limited conversation to collaborators Nov 30, 2023

alexreardon deleted the exposing-run-to-frame branch August 15, 2024 12:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exposing jest.runToFrame() from sinon/fake_timers #14598

Exposing jest.runToFrame() from sinon/fake_timers #14598

alexreardon commented Oct 3, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 3, 2023 •

edited

Loading

netlify bot commented Oct 3, 2023 •

edited

Loading

alexreardon Oct 3, 2023

SimenB Oct 4, 2023

alexreardon commented Oct 3, 2023 •

edited

Loading

alexreardon commented Oct 4, 2023

SimenB left a comment

SimenB Oct 4, 2023

alexreardon Oct 4, 2023

SimenB Oct 4, 2023

alexreardon Oct 4, 2023

SimenB Oct 4, 2023

alexreardon Oct 4, 2023

SimenB commented Oct 4, 2023

mrazauskas Oct 4, 2023

alexreardon Oct 4, 2023

alexreardon commented Oct 5, 2023

alexreardon Oct 5, 2023

SimenB left a comment

alexreardon commented Oct 5, 2023

SimenB commented Oct 30, 2023

github-actions bot commented Nov 30, 2023

		@@ -989,6 +989,16 @@ This function is not available when using legacy fake timers implementation.

		:::

		### `jest.runToFrame()`


		In applications, often you want to schedule work inside of an animation frame (with `requestAnimationFrame`). We expose a convenience method `jest.advanceTimersToNextFrame()` to advance all timers enough milliseconds to execute all actively scheduled animation frames.

		For mock timing purposes, animation frames are executed every `16ms` (mapping to roughly `60` frames per second) after the clock starts. When you schedule a callback in an animation frame (with `requestAnimationFrame(callback)`), the `callback` will be called when the clock has advanced `16ms`. `jest.advanceTimersToNextFrame()` will advance the clock just enough to get to the next `16ms` increment. If the clock has already advanced `6ms` since a animation frame `callback` was scheduled, then the clock will be advanced by `10ms`.

Exposing jest.runToFrame() from sinon/fake_timers #14598

Exposing jest.runToFrame() from sinon/fake_timers #14598

Conversation

alexreardon commented Oct 3, 2023 • edited Loading

linux-foundation-easycla bot commented Oct 3, 2023 • edited Loading

netlify bot commented Oct 3, 2023 • edited Loading

✅ Deploy Preview for jestjs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexreardon commented Oct 3, 2023 • edited Loading

alexreardon commented Oct 4, 2023

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Oct 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexreardon commented Oct 5, 2023

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

alexreardon commented Oct 5, 2023

SimenB commented Oct 30, 2023

github-actions bot commented Nov 30, 2023

alexreardon commented Oct 3, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 3, 2023 •

edited

Loading

netlify bot commented Oct 3, 2023 •

edited

Loading

alexreardon commented Oct 3, 2023 •

edited

Loading