Skip to content
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.

Sign up for GitHub

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

feat: Flush animation frames every 16ms when using legacy timers #11567

Merged
merged 5 commits into from
Jun 14, 2021
Merged

feat: Flush animation frames every 16ms when using legacy timers #11567

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
949ffbf
feat: Flush animation frames every 16ms when using legacy timers
eps1lon Jun 14, 2021
617e340
Add integration test
eps1lon Jun 14, 2021
26dc18c
docs: Link PR
eps1lon Jun 14, 2021
aa748d1
Call with timestamp
eps1lon Jun 14, 2021
806e5fa
Inline required DOM typings
eps1lon Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions e2e/fake-time/legacy/requestAnimationFrame/__tests__/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@

test('requestAnimationFrame', () => {
jest.useFakeTimers('legacy');
let exited = false;
requestAnimationFrame(() => {
exited = true;
let frameTimestamp = -1;
requestAnimationFrame(timestamp => {
frameTimestamp = timestamp;
});

jest.advanceTimersByTime(15);

expect(exited).toBe(false);
expect(frameTimestamp).toBe(-1);

jest.advanceTimersByTime(1);

expect(exited).toBe(true);
expect(frameTimestamp).toBeGreaterThan(15);
});
12 changes: 6 additions & 6 deletions e2e/fake-time/modern/requestAnimationFrame/__tests__/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
'use strict';

test('requestAnimationFrame', () => {
jest.useFakeTimers('legacy');
let exited = false;
requestAnimationFrame(() => {
exited = true;
jest.useFakeTimers('modern');
let frameTimestamp = -1;
requestAnimationFrame(timestamp => {
frameTimestamp = timestamp;
});

jest.advanceTimersByTime(15);

expect(exited).toBe(false);
expect(frameTimestamp).toBe(-1);

jest.advanceTimersByTime(1);

expect(exited).toBe(true);
expect(frameTimestamp).toBeGreaterThan(15);
});
27 changes: 17 additions & 10 deletions packages/jest-fake-timers/src/__tests__/legacyFakeTimers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,12 +667,14 @@ describe('FakeTimers', () => {
});
timers.useFakeTimers();

const runOrder: Array<string> = [];
const runOrder: Array<string | ['animationFrame', number]> = [];
const mock1 = jest.fn(() => runOrder.push('mock1'));
const mock2 = jest.fn(() => runOrder.push('mock2'));
const mock3 = jest.fn(() => runOrder.push('mock3'));
const mock4 = jest.fn(() => runOrder.push('mock4'));
const mockAnimationFrame = jest.fn(() => runOrder.push('animationFrame'));
const mockAnimationFrame = jest.fn(timestamp =>
runOrder.push(['animationFrame', timestamp]),
);

global.setTimeout(mock1, 100);
global.setTimeout(mock2, 0);
Expand All @@ -686,24 +688,29 @@ describe('FakeTimers', () => {
timers.advanceTimersByTime(15);
expect(runOrder).toEqual(['mock2', 'mock3']);

// Move forward to t=17
timers.advanceTimersByTime(2);
expect(runOrder).toEqual(['mock2', 'mock3', 'animationFrame']);
// Move forward to t=16
timers.advanceTimersByTime(1);
expect(runOrder).toEqual(['mock2', 'mock3', ['animationFrame', 16]]);

// Move forward to t=60
timers.advanceTimersByTime(43);
expect(runOrder).toEqual(['mock2', 'mock3', 'animationFrame']);
timers.advanceTimersByTime(44);
expect(runOrder).toEqual(['mock2', 'mock3', ['animationFrame', 16]]);

// Move forward to t=100
timers.advanceTimersByTime(40);
expect(runOrder).toEqual(['mock2', 'mock3', 'animationFrame', 'mock1']);
expect(runOrder).toEqual([
'mock2',
'mock3',
['animationFrame', 16],
'mock1',
]);

// Move forward to t=200
timers.advanceTimersByTime(100);
expect(runOrder).toEqual([
'mock2',
'mock3',
'animationFrame',
['animationFrame', 16],
'mock1',
'mock4',
]);
Expand All @@ -713,7 +720,7 @@ describe('FakeTimers', () => {
expect(runOrder).toEqual([
'mock2',
'mock3',
'animationFrame',
['animationFrame', 16],
'mock1',
'mock4',
'mock4',
Expand Down
5 changes: 4 additions & 1 deletion packages/jest-fake-timers/src/legacyFakeTimers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,10 @@ export default class FakeTimers<TimerRef> {
}

private _fakeRequestAnimationFrame(callback: Callback) {
return this._fakeSetTimeout(callback, 1000 / 60);
return this._fakeSetTimeout(() => {
// TODO: Use performance.now() once it's mocked
callback(this._now);
SimenB marked this conversation as resolved.
Show resolved Hide resolved
}, 1000 / 60);
}

private _fakeSetImmediate(callback: Callback, ...args: Array<any>) {
Expand Down