Provide timestamp as argument to rAF callbacks when running Jest tests

[kmagiera]

Summary

This change aligns requestAnimationFrame implementation used in Jest environment with web standard, and with the implementation that runs in the application environment.

As per specification https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#parameters – requestAnimationFrame callback gets a single parameter, which represents the current frame timestamp. The current polyfill maps requestAnimationFrame directly to setTimeout which makes the callback execute without any parameters.

Changelog

[General] [Fixed] - Jest mocked requestAnimationFrame callbacks now receive a timestamp parameter

Test Plan

1. execute jest test suite to make sure nothing breaks
2. add the below code to one of the tests:

jest.useFakeTimers();
requestAnimationFrame((timestamp) => console.log("rAF", timestamp));
jest.runOnlyPendingTimers();
jest.useRealTimers();

this code will print undefined before and numer 0 representing the mocked frame time after this change.

[robhogan]

Thanks for this - completely agree with adding this argument, but IIRC the value should be provided by jest.now(), which should work on both legacy and modern timers independently of selective faking (doNotFake).

[analysis-bot]

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	8,461,869	+182
android	hermes	armeabi-v7a	7,782,462	+196
android	hermes	x86	8,935,119	+158
android	hermes	x86_64	8,793,299	+278
android	jsc	arm64-v8a	9,648,088	+183
android	jsc	armeabi-v7a	8,382,593	+193
android	jsc	x86	9,710,324	+168
android	jsc	x86_64	10,187,446	+282

Base commit: a69a924
Branch: main

[kmagiera]

Thanks for checking this @robhogan. Your suggestion makes sense. I was only testing it with modern timers where performance.now is mocked. Will update the PR after the weekend

[facebook-github-bot]

@robhogan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[facebook-github-bot]

@robhogan merged this pull request in b44fe4d.