Refactor SchedulerHostConfigs (#20025)

* Remove SchedulerHostConfigs

* Fix builds

* Fix forks

* Move SchedulerNoDom check to npm/index.js

* Fix tests

* Add @GATE source

* Gate build-only test to build test runs

Author: rickhanlonii

packages/react-dom/src/__tests__/ReactTestUtilsActUnmockedScheduler-test.js

@@ -33,7 +33,9 @@ function unmount(dom) {
 
 beforeEach(() => {
   jest.resetModules();
-  jest.unmock('scheduler');
+  jest.mock('scheduler', () =>
+    require.requireActual('scheduler/unstable_no_dom'),
+  );
   yields = [];
   React = require('react');
   ReactDOM = require('react-dom');

packages/react-dom/src/__tests__/ReactUnmockedSchedulerWarning-test.internal.js

@@ -17,7 +17,7 @@ function App() {
 
 beforeEach(() => {
   jest.resetModules();
-  jest.unmock('scheduler');
+  jest.mock('scheduler', () => require('scheduler/unstable_no_dom'));
   React = require('react');
   ReactDOM = require('react-dom');
   ReactFeatureFlags = require('shared/ReactFeatureFlags');

packages/react-dom/src/__tests__/ReactUnmockedSchedulerWarning-test.js

@@ -16,7 +16,9 @@ function App() {
 
 beforeEach(() => {
   jest.resetModules();
-  jest.unmock('scheduler');
+  jest.mock('scheduler', () =>
+    require.requireActual('scheduler/unstable_no_dom'),
+  );
   React = require('react');
   ReactDOM = require('react-dom');
 });

packages/scheduler/index.js

@@ -7,4 +7,4 @@
 
 'use strict';
 
-export * from './src/Scheduler';
+export * from './src/forks/SchedulerDOM';

packages/scheduler/npm/index.js

@@ -1,6 +1,8 @@
 'use strict';
 
-if (process.env.NODE_ENV === 'production') {
+if (typeof window === 'undefined' || typeof MessageChannel !== 'function') {
+  module.exports = require('./unstable_no_dom');
+} else if (process.env.NODE_ENV === 'production') {
   module.exports = require('./cjs/scheduler.production.min.js');
 } else {
   module.exports = require('./cjs/scheduler.development.js');

packages/scheduler/npm/unstable_no_dom.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./cjs/scheduler-unstable_no_dom.production.min.js');
+} else {
+  module.exports = require('./cjs/scheduler-unstable_no_dom.development.js');
+}

packages/scheduler/package.json

@@ -28,6 +28,7 @@
     "tracing.js",
     "tracing-profiling.js",
     "unstable_mock.js",
+    "unstable_no_dom.js",
     "unstable_post_task.js",
     "cjs/",
     "umd/"

packages/scheduler/src/__tests__/SchedulerBrowser-test.js renamed to packages/scheduler/src/__tests__/SchedulerDOM-test.js

@@ -35,11 +35,6 @@ describe('SchedulerBrowser', () => {
 
     // 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 = global.performance;

packages/scheduler/src/__tests__/Scheduler-test.js renamed to packages/scheduler/src/__tests__/SchedulerMock-test.js

@@ -24,11 +24,8 @@ describe('SchedulerNoDOM', () => {
     jest.useFakeTimers();
 
     // Un-mock scheduler
-    jest.mock('scheduler', () => require.requireActual('scheduler'));
-    jest.mock('scheduler/src/SchedulerHostConfig', () =>
-      require.requireActual(
-        'scheduler/src/forks/SchedulerHostConfig.default.js',
-      ),
+    jest.mock('scheduler', () =>
+      require.requireActual('scheduler/unstable_no_dom'),
     );
 
     Scheduler = require('scheduler');

packages/scheduler/src/__tests__/SchedulerNoDOM-test.js

@@ -8,6 +8,13 @@
  */
 'use strict';
 
+class MockMessageChannel {
+  constructor() {
+    this.port1 = jest.fn();
+    this.port2 = jest.fn();
+  }
+}
+
 describe('Scheduling UMD bundle', () => {
   beforeEach(() => {
     // Fool SECRET_INTERNALS object into including UMD forwarding methods.
@@ -16,11 +23,18 @@ describe('Scheduling UMD bundle', () => {
     jest.resetModules();
 
     jest.mock('scheduler', () => require.requireActual('scheduler'));
-    jest.mock('scheduler/src/SchedulerHostConfig', () =>
-      require.requireActual(
-        'scheduler/src/forks/SchedulerHostConfig.default.js',
-      ),
-    );
+
+    // Mock a browser environment since we're testing UMD modules.
+    global.window = {
+      requestAnimationFrame: jest.fn(),
+      cancelAnimationFrame: jest.fn(),
+    };
+    global.MessageChannel = MockMessageChannel;
+  });
+
+  afterEach(() => {
+    global.window = undefined;
+    global.MessageChannel = undefined;
   });
 
   function filterPrivateKeys(name) {

packages/scheduler/src/__tests__/SchedulerUMDBundle-test.internal.js

@@ -10,6 +10,6 @@ export const {
   enableIsInputPending,
   enableSchedulerDebugging,
   enableProfiling: enableProfilingFeatureFlag,
-} = require('SchedulerFeatureFlags');
+} = require('packages/scheduler/src/SchedulerFeatureFlags');
 
 export const enableProfiling = __PROFILE__ && enableProfilingFeatureFlag;

packages/scheduler/src/forks/SchedulerDOM.js

@@ -11,17 +11,8 @@
 import {
   enableSchedulerDebugging,
   enableProfiling,
-} from './SchedulerFeatureFlags';
-import {
-  requestHostCallback,
-  requestHostTimeout,
-  cancelHostTimeout,
-  shouldYieldToHost,
-  getCurrentTime,
-  forceFrameRate,
-  requestPaint,
-} from './SchedulerHostConfig';
-import {push, pop, peek} from './SchedulerMinHeap';
+} from '../SchedulerFeatureFlags';
+import {push, pop, peek} from '../SchedulerMinHeap';
 
 // TODO: Use symbols?
 import {
@@ -30,7 +21,7 @@ import {
   NormalPriority,
   LowPriority,
   IdlePriority,
-} from './SchedulerPriorities';
+} from '../SchedulerPriorities';
 import {
   sharedProfilingBuffer,
   markTaskRun,
@@ -43,7 +34,7 @@ import {
   markTaskStart,
   stopLoggingProfilingEvents,
   startLoggingProfilingEvents,
-} from './SchedulerProfiling';
+} from '../SchedulerProfiling';
 
 // Max 31 bit integer. The max integer size in V8 for 32-bit systems.
 // Math.pow(2, 30) - 1
@@ -78,6 +69,19 @@ var isPerformingWork = false;
 var isHostCallbackScheduled = false;
 var isHostTimeoutScheduled = false;
 
+let getCurrentTime;
+const hasPerformanceNow =
+  typeof performance === 'object' && typeof performance.now === 'function';
+
+if (hasPerformanceNow) {
+  const localPerformance = performance;
+  getCurrentTime = () => localPerformance.now();
+} else {
+  const localDate = Date;
+  const initialTime = localDate.now();
+  getCurrentTime = () => localDate.now() - initialTime;
+}
+
 function advanceTimers(currentTime) {
   // Check for tasks that are no longer delayed and add them to the queue.
   let timer = peek(timerQueue);
@@ -393,7 +397,49 @@ function unstable_getCurrentPriorityLevel() {
   return currentPriorityLevel;
 }
 
-const unstable_requestPaint = requestPaint;
+// If this accidentally gets imported in a non-browser environment, e.g. JavaScriptCore,
+// fallback to a naive implementation.
+let _callback = null;
+let _timeoutID = null;
+const _flushCallback = function() {
+  if (_callback !== null) {
+    try {
+      const currentTime = getCurrentTime();
+      const hasRemainingTime = true;
+      _callback(hasRemainingTime, currentTime);
+      _callback = null;
+    } catch (e) {
+      setTimeout(_flushCallback, 0);
+      throw e;
+    }
+  }
+};
+
+function requestHostCallback(cb) {
+  if (_callback !== null) {
+    // Protect against re-entrancy.
+    setTimeout(requestHostCallback, 0, cb);
+  } else {
+    _callback = cb;
+    setTimeout(_flushCallback, 0);
+  }
+}
+
+function requestHostTimeout(cb, ms) {
+  _timeoutID = setTimeout(cb, ms);
+}
+
+function cancelHostTimeout() {
+  clearTimeout(_timeoutID);
+}
+
+function shouldYieldToHost() {
+  return false;
+}
+
+function forceFrameRate() {}
+
+function requestPaint() {}
 
 export {
   ImmediatePriority as unstable_ImmediatePriority,
@@ -408,7 +454,7 @@ export {
   unstable_wrapCallback,
   unstable_getCurrentPriorityLevel,
   shouldYieldToHost as unstable_shouldYield,
-  unstable_requestPaint,
+  requestPaint as unstable_requestPaint,
   unstable_continueExecution,
   unstable_pauseExecution,
   unstable_getFirstCallbackNode,

packages/scheduler/src/forks/SchedulerFeatureFlags.www.js

@@ -7,7 +7,7 @@
  * @flow
  */
 
-import type {PriorityLevel} from './SchedulerPriorities';
+import type {PriorityLevel} from '../SchedulerPriorities';
 
 declare class TaskController {
   constructor(priority?: string): TaskController;
@@ -27,7 +27,7 @@ import {
   NormalPriority,
   LowPriority,
   IdlePriority,
-} from './SchedulerPriorities';
+} from '../SchedulerPriorities';
 
 export {
   ImmediatePriority as unstable_ImmediatePriority,

packages/scheduler/src/forks/SchedulerHostConfig.default.js

@@ -7,15 +7,4 @@
 
 'use strict';
 
-export * from './src/Scheduler';
-
-export {
-  unstable_flushAllWithoutAsserting,
-  unstable_flushNumberOfYields,
-  unstable_flushExpired,
-  unstable_clearYields,
-  unstable_flushUntilNextPaint,
-  unstable_flushAll,
-  unstable_yieldValue,
-  unstable_advanceTime,
-} from './src/SchedulerHostConfig.js';
+export * from './src/forks/SchedulerMock';

packages/scheduler/src/forks/SchedulerHostConfig.mock.js

@@ -3,8 +3,8 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-throw new Error('This module must be shimmed by a specific build.');
+'use strict';
+
+export * from './src/forks/SchedulerNoDOM';

packages/scheduler/src/forks/SchedulerMock.js

@@ -7,4 +7,4 @@
 
 'use strict';
 
-export * from './src/SchedulerPostTask';
+export * from './src/forks/SchedulerPostTask';

packages/scheduler/src/Scheduler.js renamed to packages/scheduler/src/forks/SchedulerNoDOM.js

@@ -15,11 +15,6 @@ describe('ReactDOMFrameScheduling', () => {
 
     // Un-mock scheduler
     jest.mock('scheduler', () => require.requireActual('scheduler'));
-    jest.mock('scheduler/src/SchedulerHostConfig', () =>
-      require.requireActual(
-        'scheduler/src/forks/SchedulerHostConfig.default.js',
-      ),
-    );
   });
 
   it('warns when requestAnimationFrame is not polyfilled in the browser', () => {
@@ -47,6 +42,7 @@ describe('ReactDOMFrameScheduling', () => {
 
   // We're just testing importing, not using it.
   // It is important because even isomorphic components may import it.
+  // @gate !source
   it('can import findDOMNode in Node environment', () => {
     const previousRAF = global.requestAnimationFrame;
     const previousRIC = global.requestIdleCallback;

packages/scheduler/src/SchedulerPostTask.js renamed to packages/scheduler/src/forks/SchedulerPostTask.js

@@ -74,6 +74,7 @@ function getTestFlags() {
       channel: releaseChannel,
       modern: releaseChannel === 'modern',
       classic: releaseChannel === 'classic',
+      source: !process.env.IS_BUILD,
       www,
 
       ...featureFlags,

packages/scheduler/unstable_mock.js

@@ -4,6 +4,8 @@ const {readdirSync, statSync} = require('fs');
 const {join} = require('path');
 const baseConfig = require('./config.base');
 
+process.env.IS_BUILD = true;
+
 // Find all folders in packages/* with package.json
 const packagesRoot = join(__dirname, '..', '..', 'packages');
 const packages = readdirSync(packagesRoot).filter(dir => {

packages/scheduler/src/SchedulerHostConfig.js renamed to packages/scheduler/unstable_no_dom.js

@@ -96,6 +96,3 @@ jest.mock('shared/ReactSharedInternals', () =>
 );
 
 jest.mock('scheduler', () => require.requireActual('scheduler/unstable_mock'));
-jest.mock('scheduler/src/SchedulerHostConfig', () =>
-  require.requireActual('scheduler/src/forks/SchedulerHostConfig.mock.js')
-);

packages/scheduler/unstable_post_task.js

@@ -1,6 +1,3 @@
 'use strict';
 
 jest.mock('scheduler', () => require.requireActual('scheduler/unstable_mock'));
-jest.mock('scheduler/src/SchedulerHostConfig', () =>
-  require.requireActual('scheduler/src/forks/SchedulerHostConfig.mock.js')
-);

packages/shared/__tests__/ReactDOMFrameScheduling-test.js

@@ -633,6 +633,24 @@ const bundles = [
     externals: [],
   },
 
+  /******* React Scheduler No DOM (experimental) *******/
+  {
+    bundleTypes: [
+      NODE_DEV,
+      NODE_PROD,
+      FB_WWW_DEV,
+      FB_WWW_PROD,
+      FB_WWW_PROFILING,
+      RN_FB_DEV,
+      RN_FB_PROD,
+      RN_FB_PROFILING,
+    ],
+    moduleType: ISOMORPHIC,
+    entry: 'scheduler/unstable_no_dom',
+    global: 'SchedulerNoDOM',
+    externals: [],
+  },
+
   /******* Jest React (experimental) *******/
   {
     bundleTypes: [NODE_DEV, NODE_PROD],

scripts/jest/TestFlags.js

@@ -201,18 +201,6 @@ const forks = Object.freeze({
     return 'scheduler/src/SchedulerFeatureFlags';
   },
 
-  'scheduler/src/SchedulerHostConfig': (bundleType, entry, dependencies) => {
-    if (
-      entry === 'scheduler/unstable_mock' ||
-      entry === 'react-noop-renderer' ||
-      entry === 'react-noop-renderer/persistent' ||
-      entry === 'react-test-renderer'
-    ) {
-      return 'scheduler/src/forks/SchedulerHostConfig.mock';
-    }
-    return 'scheduler/src/forks/SchedulerHostConfig.default';
-  },
-
   'shared/consoleWithStackDev': (bundleType, entry) => {
     switch (bundleType) {
       case FB_WWW_DEV: