From 5b706beb303d08e7d03556ba44c2ef33fb0b770d Mon Sep 17 00:00:00 2001 From: Andrew Clark Date: Thu, 25 Jul 2019 16:46:31 -0700 Subject: [PATCH] [scheduler] Yield many times per frame, no rAF Adds experimental flag to yield many times per frame using a message event loop, instead of the current approach of guessing the next vsync and yielding at the end of the frame. This new approach forgoes a `requestAnimationFrame` entirely. It posts a message event and performs a small amount of work (5ms) before yielding to the browser, regardless of where it might be in the vsync cycle. At the end of the event, if there's work left over, it posts another message event. This should keep the main thread responsive even for really high frame rates. It also shouldn't matter if the hardware frame rate changes after page load (our current heuristic only detects if the frame rate increases, not decreases). The main risk is that yielding more often will exacerbate main thread contention with other browser tasks. Let's try it and see. --- .../scheduler/src/SchedulerFeatureFlags.js | 1 + .../SchedulerBrowser-test.internal.js | 422 ++++++++++++++++++ .../src/__tests__/SchedulerBrowser-test.js | 350 --------------- .../src/forks/SchedulerFeatureFlags.www.js | 1 + .../src/forks/SchedulerHostConfig.default.js | 178 +++++--- 5 files changed, 538 insertions(+), 414 deletions(-) create mode 100644 packages/scheduler/src/__tests__/SchedulerBrowser-test.internal.js delete mode 100644 packages/scheduler/src/__tests__/SchedulerBrowser-test.js diff --git a/packages/scheduler/src/SchedulerFeatureFlags.js b/packages/scheduler/src/SchedulerFeatureFlags.js index f63d40693357..60b62662cbf8 100644 --- a/packages/scheduler/src/SchedulerFeatureFlags.js +++ b/packages/scheduler/src/SchedulerFeatureFlags.js @@ -10,3 +10,4 @@ export const enableSchedulerDebugging = false; export const enableIsInputPending = false; export const requestIdleCallbackBeforeFirstFrame = false; export const requestTimerEventBeforeFirstFrame = false; +export const enableMessageLoopImplementation = false; diff --git a/packages/scheduler/src/__tests__/SchedulerBrowser-test.internal.js b/packages/scheduler/src/__tests__/SchedulerBrowser-test.internal.js new file mode 100644 index 000000000000..dba2c3b5da56 --- /dev/null +++ b/packages/scheduler/src/__tests__/SchedulerBrowser-test.internal.js @@ -0,0 +1,422 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * + * @emails react-core + * @jest-environment node + */ + +/* eslint-disable no-for-of-loops/no-for-of-loops */ + +'use strict'; + +let Scheduler; +let runtime; +let performance; +let scheduleCallback; +let NormalPriority; + +// The Scheduler implementation uses browser APIs like `MessageChannel`, +// `requestAnimationFrame`, and `setTimeout` to schedule work on the main +// thread. Most of our tests treat these as implementation details; however, the +// sequence and timing of these APIs are not precisely specified, and can vary +// wildly across browsers. +// +// To prevent regressions, we need the ability to simulate specific edge cases +// that we may encounter in various browsers. +// +// This test suite mocks all browser methods used in our implementation. It +// assumes as little as possible about the order and timing of events. The only +// thing it assumes is that requestAnimationFrame is passed a frame time that is +// equal to or less than the time returned by performance.now. Everything else +// can be controlled at will. +// +// It also includes Scheduler-specific invariants, e.g. only one rAF callback +// can be scheduled at a time. +describe('SchedulerBrowser', () => { + function beforeAndAfterHooks(enableMessageLoopImplementation) { + beforeEach(() => { + jest.resetModules(); + + // Un-mock scheduler + jest.mock('scheduler', () => require.requireActual('scheduler')); + jest.mock('scheduler/src/SchedulerHostConfig', () => + require.requireActual( + 'scheduler/src/forks/SchedulerHostConfig.default.js', + ), + ); + + runtime = installMockBrowserRuntime(); + performance = window.performance; + require('scheduler/src/SchedulerFeatureFlags').enableMessageLoopImplementation = enableMessageLoopImplementation; + Scheduler = require('scheduler'); + scheduleCallback = Scheduler.unstable_scheduleCallback; + NormalPriority = Scheduler.unstable_NormalPriority; + }); + + afterEach(() => { + if (!runtime.isLogEmpty()) { + throw Error('Test exited without clearing log.'); + } + }); + } + + function installMockBrowserRuntime() { + let VSYNC_INTERVAL = 33.33; + + let hasPendingMessageEvent = false; + + let rAFCallbackIDCounter = 0; + let rAFCallback = null; + let isRunningRAFCallback = false; + + let rICCallbackIDCounter = 0; + let rICCallback = null; + + let timerIDCounter = 0; + // let timerIDs = new Map(); + + let eventLog = []; + + const window = {}; + global.window = window; + + let currentTime = 0; + + window.performance = { + now() { + return currentTime; + }, + }; + window.requestAnimationFrame = cb => { + if (rAFCallback !== null) { + throw Error('rAF already scheduled'); + } + if (isRunningRAFCallback) { + log('Request Animation Frame [Reposted]'); + } else { + log('Request Animation Frame'); + } + rAFCallback = cb; + return rAFCallbackIDCounter++; + }; + window.cancelAnimationFrame = id => { + rAFCallback = null; + }; + + window.requestIdleCallback = cb => { + if (rICCallback !== null) { + throw Error('rAF already scheduled'); + } + log('Request Idle Callback'); + rICCallback = cb; + return rICCallbackIDCounter++; + }; + window.cancelIdleCallback = id => { + rICCallback = null; + }; + + window.setTimeout = (cb, delay) => { + const id = timerIDCounter++; + log(`Set Timer`); + // TODO + return id; + }; + window.clearTimeout = id => { + // TODO + }; + + const port1 = {}; + const port2 = { + postMessage() { + if (hasPendingMessageEvent) { + throw Error('Message event already scheduled'); + } + log('Post Message'); + hasPendingMessageEvent = true; + }, + }; + global.MessageChannel = function MessageChannel() { + this.port1 = port1; + this.port2 = port2; + }; + + function ensureLogIsEmpty() { + if (eventLog.length !== 0) { + throw Error('Log is not empty. Call assertLog before continuing.'); + } + } + function setHardwareFrameRate(fps) { + VSYNC_INTERVAL = 1000 / fps; + } + function advanceTime(ms) { + currentTime += ms; + } + function advanceTimeToNextFrame() { + const targetTime = + Math.ceil(currentTime / VSYNC_INTERVAL) * VSYNC_INTERVAL; + if (targetTime === currentTime) { + currentTime += VSYNC_INTERVAL; + } else { + currentTime = targetTime; + } + } + function getMostRecentFrameNumber() { + return Math.floor(currentTime / VSYNC_INTERVAL); + } + function fireMessageEvent() { + ensureLogIsEmpty(); + if (!hasPendingMessageEvent) { + throw Error('No message event was scheduled'); + } + hasPendingMessageEvent = false; + const onMessage = port1.onmessage; + log('Message Event'); + onMessage(); + } + function fireAnimationFrame() { + ensureLogIsEmpty(); + if (isRunningRAFCallback) { + throw Error('Cannot fire animation frame from inside another event.'); + } + if (rAFCallback === null) { + throw Error('No rAF scheduled.'); + } + const mostRecentFrameNumber = getMostRecentFrameNumber(); + const rAFTime = mostRecentFrameNumber * VSYNC_INTERVAL; + const cb = rAFCallback; + rAFCallback = null; + log(`Animation Frame [${mostRecentFrameNumber}]`); + isRunningRAFCallback = true; + try { + cb(rAFTime); + } finally { + isRunningRAFCallback = false; + } + } + function fireRIC() { + ensureLogIsEmpty(); + if (rICCallback === null) { + throw Error('No rIC scheduled.'); + } + const cb = rICCallback; + rICCallback = null; + log('Idle Callback'); + cb(); + } + function log(val) { + eventLog.push(val); + } + function isLogEmpty() { + return eventLog.length === 0; + } + function assertLog(expected) { + const actual = eventLog; + eventLog = []; + expect(actual).toEqual(expected); + } + return { + setHardwareFrameRate, + advanceTime, + advanceTimeToNextFrame, + getMostRecentFrameNumber, + fireMessageEvent, + fireAnimationFrame, + fireRIC, + log, + isLogEmpty, + assertLog, + }; + } + + describe('rAF aligned frame boundaries', () => { + const enableMessageLoopImplementation = false; + beforeAndAfterHooks(enableMessageLoopImplementation); + + it('callback with continuation', () => { + scheduleCallback(NormalPriority, () => { + runtime.log('Task'); + while (!Scheduler.unstable_shouldYield()) { + runtime.advanceTime(1); + } + runtime.log(`Yield at ${performance.now()}ms`); + return () => { + runtime.log('Continuation'); + }; + }); + runtime.assertLog(['Request Animation Frame']); + + runtime.fireAnimationFrame(); + runtime.assertLog([ + 'Animation Frame [0]', + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Task', 'Yield at 34ms']); + + runtime.fireAnimationFrame(); + runtime.assertLog([ + 'Animation Frame [1]', + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Continuation']); + + runtime.advanceTimeToNextFrame(); + runtime.fireAnimationFrame(); + runtime.assertLog(['Animation Frame [2]']); + }); + + it('two rAF calls in the same frame', () => { + scheduleCallback(NormalPriority, () => runtime.log('A')); + runtime.assertLog(['Request Animation Frame']); + runtime.fireAnimationFrame(); + runtime.assertLog([ + 'Animation Frame [0]', + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'A']); + + // The Scheduler queue is now empty. We're still in frame 0. + expect(runtime.getMostRecentFrameNumber()).toBe(0); + + // Post a task to Scheduler. + scheduleCallback(NormalPriority, () => runtime.log('B')); + + // Did not request another animation frame, since one was already scheduled + // during the previous rAF. + runtime.assertLog([]); + + // Fire the animation frame. + runtime.fireAnimationFrame(); + runtime.assertLog([ + 'Animation Frame [0]', + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'B']); + }); + + it('adjusts frame rate by measuring inteval between rAF events', () => { + runtime.setHardwareFrameRate(60); + + scheduleCallback(NormalPriority, () => runtime.log('Tick')); + runtime.assertLog(['Request Animation Frame']); + + // Need to measure two consecutive intervals between frames. + for (let i = 0; i < 2; i++) { + runtime.fireAnimationFrame(); + runtime.assertLog([ + `Animation Frame [${runtime.getMostRecentFrameNumber()}]`, + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Tick']); + scheduleCallback(NormalPriority, () => runtime.log('Tick')); + runtime.advanceTimeToNextFrame(); + } + + // Scheduler should observe that it's receiving rAFs every 16.6 ms and + // adjust its frame rate accordingly. Test by blocking the thread until + // Scheduler tells us to yield. Then measure how much time has elapsed. + const start = performance.now(); + scheduleCallback(NormalPriority, () => { + while (!Scheduler.unstable_shouldYield()) { + runtime.advanceTime(1); + } + }); + runtime.fireAnimationFrame(); + runtime.assertLog([ + `Animation Frame [${runtime.getMostRecentFrameNumber()}]`, + 'Request Animation Frame [Reposted]', + 'Set Timer', + 'Post Message', + ]); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Tick']); + const end = performance.now(); + + // Check how much time elapsed in the frame. + expect(end - start).toEqual(17); + }); + }); + + describe('message event loop', () => { + const enableMessageLoopImplementation = true; + beforeAndAfterHooks(enableMessageLoopImplementation); + + it('task with continutation', () => { + scheduleCallback(NormalPriority, () => { + runtime.log('Task'); + while (!Scheduler.unstable_shouldYield()) { + runtime.advanceTime(1); + } + runtime.log(`Yield at ${performance.now()}ms`); + return () => { + runtime.log('Continuation'); + }; + }); + runtime.assertLog(['Post Message']); + + runtime.fireMessageEvent(); + runtime.assertLog([ + 'Message Event', + 'Task', + 'Yield at 5ms', + 'Post Message', + ]); + + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Continuation']); + }); + + it('task that throws', () => { + scheduleCallback(NormalPriority, () => { + runtime.log('Oops!'); + throw Error('Oops!'); + }); + scheduleCallback(NormalPriority, () => { + runtime.log('Yay'); + }); + runtime.assertLog(['Post Message']); + + expect(() => runtime.fireMessageEvent()).toThrow('Oops!'); + runtime.assertLog(['Message Event', 'Oops!', 'Post Message']); + + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'Yay']); + }); + + it('schedule new task after queue has emptied', () => { + scheduleCallback(NormalPriority, () => { + runtime.log('A'); + }); + + runtime.assertLog(['Post Message']); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'A']); + + scheduleCallback(NormalPriority, () => { + runtime.log('B'); + }); + runtime.assertLog(['Post Message']); + runtime.fireMessageEvent(); + runtime.assertLog(['Message Event', 'B']); + }); + }); +}); diff --git a/packages/scheduler/src/__tests__/SchedulerBrowser-test.js b/packages/scheduler/src/__tests__/SchedulerBrowser-test.js deleted file mode 100644 index 13907ebcbe0f..000000000000 --- a/packages/scheduler/src/__tests__/SchedulerBrowser-test.js +++ /dev/null @@ -1,350 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - * - * @emails react-core - * @jest-environment node - */ - -/* eslint-disable no-for-of-loops/no-for-of-loops */ - -'use strict'; - -let Scheduler; -let runtime; -let performance; -let scheduleCallback; -let NormalPriority; - -// The Scheduler implementation uses browser APIs like `MessageChannel`, -// `requestAnimationFrame`, and `setTimeout` to schedule work on the main -// thread. Most of our tests treat these as implementation details; however, the -// sequence and timing of these APIs are not precisely specified, and can vary -// wildly across browsers. -// -// To prevent regressions, we need the ability to simulate specific edge cases -// that we may encounter in various browsers. -// -// This test suite mocks all browser methods used in our implementation. It -// assumes as little as possible about the order and timing of events. The only -// thing it assumes is that requestAnimationFrame is passed a frame time that is -// equal to or less than the time returned by performance.now. Everything else -// can be controlled at will. -// -// It also includes Scheduler-specific invariants, e.g. only one rAF callback -// can be scheduled at a time. -describe('SchedulerBrowser', () => { - beforeEach(() => { - jest.resetModules(); - - // Un-mock scheduler - jest.mock('scheduler', () => require.requireActual('scheduler')); - jest.mock('scheduler/src/SchedulerHostConfig', () => - require.requireActual( - 'scheduler/src/forks/SchedulerHostConfig.default.js', - ), - ); - - runtime = installMockBrowserRuntime(); - performance = window.performance; - Scheduler = require('scheduler'); - scheduleCallback = Scheduler.unstable_scheduleCallback; - NormalPriority = Scheduler.unstable_NormalPriority; - }); - - afterEach(() => { - if (!runtime.isLogEmpty()) { - throw Error('Test exited without clearing log.'); - } - }); - - function installMockBrowserRuntime() { - let VSYNC_INTERVAL = 33.33; - - let hasPendingMessageEvent = false; - - let rAFCallbackIDCounter = 0; - let rAFCallback = null; - let isRunningRAFCallback = false; - - let rICCallbackIDCounter = 0; - let rICCallback = null; - - let timerIDCounter = 0; - // let timerIDs = new Map(); - - let eventLog = []; - - const window = {}; - global.window = window; - - let currentTime = 0; - - window.performance = { - now() { - return currentTime; - }, - }; - window.requestAnimationFrame = cb => { - if (rAFCallback !== null) { - throw Error('rAF already scheduled'); - } - if (isRunningRAFCallback) { - log('Request Animation Frame [Reposted]'); - } else { - log('Request Animation Frame'); - } - rAFCallback = cb; - return rAFCallbackIDCounter++; - }; - window.cancelAnimationFrame = id => { - rAFCallback = null; - }; - - window.requestIdleCallback = cb => { - if (rICCallback !== null) { - throw Error('rAF already scheduled'); - } - log('Request Idle Callback'); - rICCallback = cb; - return rICCallbackIDCounter++; - }; - window.cancelIdleCallback = id => { - rICCallback = null; - }; - - window.setTimeout = (cb, delay) => { - const id = timerIDCounter++; - log(`Set Timer`); - // TODO - return id; - }; - window.clearTimeout = id => { - // TODO - }; - - const port1 = {}; - const port2 = { - postMessage() { - if (hasPendingMessageEvent) { - throw Error('Message event already scheduled'); - } - log('Post Message'); - hasPendingMessageEvent = true; - }, - }; - global.MessageChannel = function MessageChannel() { - this.port1 = port1; - this.port2 = port2; - }; - - function ensureLogIsEmpty() { - if (eventLog.length !== 0) { - throw Error('Log is not empty. Call assertLog before continuing.'); - } - } - function setHardwareFrameRate(fps) { - VSYNC_INTERVAL = 1000 / fps; - } - function advanceTime(ms) { - currentTime += ms; - } - function advanceTimeToNextFrame() { - const targetTime = - Math.ceil(currentTime / VSYNC_INTERVAL) * VSYNC_INTERVAL; - if (targetTime === currentTime) { - currentTime += VSYNC_INTERVAL; - } else { - currentTime = targetTime; - } - } - function getMostRecentFrameNumber() { - return Math.floor(currentTime / VSYNC_INTERVAL); - } - function fireMessageEvent() { - ensureLogIsEmpty(); - if (!hasPendingMessageEvent) { - throw Error('No message event was scheduled'); - } - hasPendingMessageEvent = false; - const onMessage = port1.onmessage; - log('Message Event'); - onMessage(); - } - function fireAnimationFrame() { - ensureLogIsEmpty(); - if (isRunningRAFCallback) { - throw Error('Cannot fire animation frame from inside another event.'); - } - if (rAFCallback === null) { - throw Error('No rAF scheduled.'); - } - const mostRecentFrameNumber = getMostRecentFrameNumber(); - const rAFTime = mostRecentFrameNumber * VSYNC_INTERVAL; - const cb = rAFCallback; - rAFCallback = null; - log(`Animation Frame [${mostRecentFrameNumber}]`); - isRunningRAFCallback = true; - try { - cb(rAFTime); - } finally { - isRunningRAFCallback = false; - } - } - function fireRIC() { - ensureLogIsEmpty(); - if (rICCallback === null) { - throw Error('No rIC scheduled.'); - } - const cb = rICCallback; - rICCallback = null; - log('Idle Callback'); - cb(); - } - function log(val) { - eventLog.push(val); - } - function isLogEmpty() { - return eventLog.length === 0; - } - function assertLog(expected) { - const actual = eventLog; - eventLog = []; - expect(actual).toEqual(expected); - } - return { - setHardwareFrameRate, - advanceTime, - advanceTimeToNextFrame, - getMostRecentFrameNumber, - fireMessageEvent, - fireAnimationFrame, - fireRIC, - log, - isLogEmpty, - assertLog, - }; - } - - it('callback with continuation', () => { - scheduleCallback(NormalPriority, () => { - runtime.log('Task'); - while (!Scheduler.unstable_shouldYield()) { - runtime.advanceTime(1); - } - runtime.log(`Yield at ${performance.now()}ms`); - return () => { - runtime.log('Continuation'); - }; - }); - runtime.assertLog(['Request Animation Frame']); - - runtime.fireAnimationFrame(); - runtime.assertLog([ - 'Animation Frame [0]', - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'Task', 'Yield at 34ms']); - - runtime.fireAnimationFrame(); - runtime.assertLog([ - 'Animation Frame [1]', - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'Continuation']); - - runtime.advanceTimeToNextFrame(); - runtime.fireAnimationFrame(); - runtime.assertLog(['Animation Frame [2]']); - }); - - it('two rAF calls in the same frame', () => { - scheduleCallback(NormalPriority, () => runtime.log('A')); - runtime.assertLog(['Request Animation Frame']); - runtime.fireAnimationFrame(); - runtime.assertLog([ - 'Animation Frame [0]', - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'A']); - - // The Scheduler queue is now empty. We're still in frame 0. - expect(runtime.getMostRecentFrameNumber()).toBe(0); - - // Post a task to Scheduler. - scheduleCallback(NormalPriority, () => runtime.log('B')); - - // Did not request another animation frame, since one was already scheduled - // during the previous rAF. - runtime.assertLog([]); - - // Fire the animation frame. - runtime.fireAnimationFrame(); - runtime.assertLog([ - 'Animation Frame [0]', - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'B']); - }); - - it('adjusts frame rate by measuring inteval between rAF events', () => { - runtime.setHardwareFrameRate(60); - - scheduleCallback(NormalPriority, () => runtime.log('Tick')); - runtime.assertLog(['Request Animation Frame']); - - // Need to measure two consecutive intervals between frames. - for (let i = 0; i < 2; i++) { - runtime.fireAnimationFrame(); - runtime.assertLog([ - `Animation Frame [${runtime.getMostRecentFrameNumber()}]`, - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'Tick']); - scheduleCallback(NormalPriority, () => runtime.log('Tick')); - runtime.advanceTimeToNextFrame(); - } - - // Scheduler should observe that it's receiving rAFs every 16.6 ms and - // adjust its frame rate accordingly. Test by blocking the thread until - // Scheduler tells us to yield. Then measure how much time has elapsed. - const start = performance.now(); - scheduleCallback(NormalPriority, () => { - while (!Scheduler.unstable_shouldYield()) { - runtime.advanceTime(1); - } - }); - runtime.fireAnimationFrame(); - runtime.assertLog([ - `Animation Frame [${runtime.getMostRecentFrameNumber()}]`, - 'Request Animation Frame [Reposted]', - 'Set Timer', - 'Post Message', - ]); - runtime.fireMessageEvent(); - runtime.assertLog(['Message Event', 'Tick']); - const end = performance.now(); - - // Check how much time elapsed in the frame. - expect(end - start).toEqual(17); - }); -}); diff --git a/packages/scheduler/src/forks/SchedulerFeatureFlags.www.js b/packages/scheduler/src/forks/SchedulerFeatureFlags.www.js index a69932ab7a84..06abe7786b1c 100644 --- a/packages/scheduler/src/forks/SchedulerFeatureFlags.www.js +++ b/packages/scheduler/src/forks/SchedulerFeatureFlags.www.js @@ -11,4 +11,5 @@ export const { enableSchedulerDebugging, requestIdleCallbackBeforeFirstFrame, requestTimerEventBeforeFirstFrame, + enableMessageLoopImplementation, } = require('SchedulerFeatureFlags'); diff --git a/packages/scheduler/src/forks/SchedulerHostConfig.default.js b/packages/scheduler/src/forks/SchedulerHostConfig.default.js index 9bcb51491e6d..8e6afbcc8ad1 100644 --- a/packages/scheduler/src/forks/SchedulerHostConfig.default.js +++ b/packages/scheduler/src/forks/SchedulerHostConfig.default.js @@ -9,6 +9,7 @@ import { enableIsInputPending, requestIdleCallbackBeforeFirstFrame as requestIdleCallbackBeforeFirstFrameFlag, requestTimerEventBeforeFirstFrame, + enableMessageLoopImplementation, } from '../SchedulerFeatureFlags'; // The DOM Scheduler implementation is similar to requestIdleCallback. It @@ -116,14 +117,22 @@ if ( : () => Date.now(); let isRAFLoopRunning = false; + let isMessageLoopRunning = false; let scheduledHostCallback = null; let rAFTimeoutID = -1; let taskTimeoutID = -1; - // We start out assuming that we run at 30fps but then the heuristic tracking - // will adjust this value to a faster fps if we get more frequent animation - // frames. - let frameLength = 33.33; + let frameLength = enableMessageLoopImplementation + ? // We won't attempt to align with the vsync. Instead we'll yield multiple + // times per frame, often enough to keep it responsive even at really + // high frame rates > 120. + 5 + : // Use a heuristic to measure the frame rate and yield at the end of the + // frame. We start out assuming that we run at 30fps but then the + // heuristic tracking will adjust this value to a faster fps if we get + // more frequent animation frames. + 33.33; + let prevRAFTime = -1; let prevRAFInterval = -1; let frameDeadline = 0; @@ -199,31 +208,63 @@ if ( }; const performWorkUntilDeadline = () => { - if (scheduledHostCallback !== null) { - const currentTime = getCurrentTime(); - const hasTimeRemaining = frameDeadline - currentTime > 0; - try { - const hasMoreWork = scheduledHostCallback( - hasTimeRemaining, - currentTime, - ); - if (!hasMoreWork) { - scheduledHostCallback = null; + if (enableMessageLoopImplementation) { + if (scheduledHostCallback !== null) { + const currentTime = getCurrentTime(); + // Yield after `frameLength` ms, regardless of where we are in the vsync + // cycle. This means there's always time remaining at the beginning of + // the message event. + frameDeadline = currentTime + frameLength; + const hasTimeRemaining = true; + try { + const hasMoreWork = scheduledHostCallback( + hasTimeRemaining, + currentTime, + ); + if (!hasMoreWork) { + isMessageLoopRunning = false; + scheduledHostCallback = null; + } else { + // If there's more work, schedule the next message event at the end + // of the preceding one. + port.postMessage(null); + } + } catch (error) { + // If a scheduler task throws, exit the current browser task so the + // error can be observed. + port.postMessage(null); + throw error; + } + } + // Yielding to the browser will give it a chance to paint, so we can + // reset this. + needsPaint = false; + } else { + if (scheduledHostCallback !== null) { + const currentTime = getCurrentTime(); + const hasTimeRemaining = frameDeadline - currentTime > 0; + try { + const hasMoreWork = scheduledHostCallback( + hasTimeRemaining, + currentTime, + ); + if (!hasMoreWork) { + scheduledHostCallback = null; + } + } catch (error) { + // If a scheduler task throws, exit the current browser task so the + // error can be observed, and post a new task as soon as possible + // so we can continue where we left off. + port.postMessage(null); + throw error; } - } catch (error) { - // If a scheduler task throws, exit the current browser task so the - // error can be observed, and post a new task as soon as possible - // so we can continue where we left off. - port.postMessage(null); - throw error; } + // Yielding to the browser will give it a chance to paint, so we can + // reset this. + needsPaint = false; } - // Yielding to the browser will give it a chance to paint, so we can - // reset this. - needsPaint = false; }; - // We use the postMessage trick to defer idle work until after the repaint. const channel = new MessageChannel(); const port = channel.port2; channel.port1.onmessage = performWorkUntilDeadline; @@ -294,57 +335,66 @@ if ( prevRAFTime = rAFTime; frameDeadline = rAFTime + frameLength; + // We use the postMessage trick to defer idle work until after the repaint. port.postMessage(null); }; requestHostCallback = function(callback) { scheduledHostCallback = callback; - if (!isRAFLoopRunning) { - // Start a rAF loop. - isRAFLoopRunning = true; - requestAnimationFrame(rAFTime => { + if (enableMessageLoopImplementation) { + if (!isMessageLoopRunning) { + isMessageLoopRunning = true; + port.postMessage(null); + } + } else { + if (!isRAFLoopRunning) { + // Start a rAF loop. + isRAFLoopRunning = true; + requestAnimationFrame(rAFTime => { + if (requestIdleCallbackBeforeFirstFrame) { + cancelIdleCallback(idleCallbackID); + } + if (requestTimerEventBeforeFirstFrame) { + clearTimeout(idleTimeoutID); + } + onAnimationFrame(rAFTime); + }); + + // If we just missed the last vsync, the next rAF might not happen for + // another frame. To claim as much idle time as possible, post a + // callback with `requestIdleCallback`, which should fire if there's + // idle time left in the frame. + // + // This should only be an issue for the first rAF in the loop; + // subsequent rAFs are scheduled at the beginning of the + // preceding frame. + let idleCallbackID; if (requestIdleCallbackBeforeFirstFrame) { - cancelIdleCallback(idleCallbackID); + idleCallbackID = requestIdleCallback( + function onIdleCallbackBeforeFirstFrame() { + if (requestTimerEventBeforeFirstFrame) { + clearTimeout(idleTimeoutID); + } + frameDeadline = getCurrentTime() + frameLength; + performWorkUntilDeadline(); + }, + ); } + // Alternate strategy to address the same problem. Scheduler a timer + // with no delay. If this fires before the rAF, that likely indicates + // that there's idle time before the next vsync. This isn't always the + // case, but we'll be aggressive and assume it is, as a trade off to + // prevent idle periods. + let idleTimeoutID; if (requestTimerEventBeforeFirstFrame) { - clearTimeout(idleTimeoutID); - } - onAnimationFrame(rAFTime); - }); - - // If we just missed the last vsync, the next rAF might not happen for - // another frame. To claim as much idle time as possible, post a callback - // with `requestIdleCallback`, which should fire if there's idle time left - // in the frame. - // - // This should only be an issue for the first rAF in the loop; subsequent - // rAFs are scheduled at the beginning of the preceding frame. - let idleCallbackID; - if (requestIdleCallbackBeforeFirstFrame) { - idleCallbackID = requestIdleCallback( - function onIdleCallbackBeforeFirstFrame() { - if (requestTimerEventBeforeFirstFrame) { - clearTimeout(idleTimeoutID); + idleTimeoutID = setTimeout(function onTimerEventBeforeFirstFrame() { + if (requestIdleCallbackBeforeFirstFrame) { + cancelIdleCallback(idleCallbackID); } frameDeadline = getCurrentTime() + frameLength; performWorkUntilDeadline(); - }, - ); - } - // Alternate strategy to address the same problem. Scheduler a timer with - // no delay. If this fires before the rAF, that likely indicates that - // there's idle time before the next vsync. This isn't always the case, - // but we'll be aggressive and assume it is, as a trade off to prevent - // idle periods. - let idleTimeoutID; - if (requestTimerEventBeforeFirstFrame) { - idleTimeoutID = setTimeout(function onTimerEventBeforeFirstFrame() { - if (requestIdleCallbackBeforeFirstFrame) { - cancelIdleCallback(idleCallbackID); - } - frameDeadline = getCurrentTime() + frameLength; - performWorkUntilDeadline(); - }, 0); + }, 0); + } } } };