Skip to content

Remove SchedulerHostConfigs #20025

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

Merged
merged 7 commits into from
Nov 2, 2020
Merged

Remove SchedulerHostConfigs #20025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
92691a6
Remove SchedulerHostConfigs
rickhanlonii Oct 14, 2020
c91346b
Fix builds
rickhanlonii Oct 14, 2020
34c4769
Fix forks
rickhanlonii Oct 14, 2020
58a89a6
Move SchedulerNoDom check to npm/index.js
rickhanlonii Oct 20, 2020
1df1e95
Fix tests
rickhanlonii Oct 20, 2020
c0d603d
Add @gate source
rickhanlonii Oct 30, 2020
1527bb9
Gate build-only test to build test runs
rickhanlonii Oct 30, 2020
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
4 changes: 3 additions & 1 deletion packages/react-dom/src/__tests__/ReactTestUtilsActUnmockedScheduler-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
2 changes: 1 addition & 1 deletion packages/react-dom/src/__tests__/ReactUnmockedSchedulerWarning-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
4 changes: 3 additions & 1 deletion packages/react-dom/src/__tests__/ReactUnmockedSchedulerWarning-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
});
Expand Down
2 changes: 1 addition & 1 deletion packages/scheduler/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@

'use strict';

export * from './src/Scheduler';
export * from './src/forks/SchedulerDOM';
4 changes: 3 additions & 1 deletion packages/scheduler/npm/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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');
Copy link
Collaborator

@sebmarkbage sebmarkbage Nov 3, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this pattern because it's the first time we start doing this kind of switching in the npm wrappers and it won't port nicely to ESM. The thing that we do for production is a static switch which we can move into a compiler but we can't do the same for this.

We should move this branching into the implementation which forces us to treat this nicely in an ESM world.

} else if (process.env.NODE_ENV === 'production') {
module.exports = require('./cjs/scheduler.production.min.js');
} else {
module.exports = require('./cjs/scheduler.development.js');
Expand Down
7 changes: 7 additions & 0 deletions packages/scheduler/npm/unstable_no_dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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');
}
1 change: 1 addition & 0 deletions packages/scheduler/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"tracing.js",
"tracing-profiling.js",
"unstable_mock.js",
"unstable_no_dom.js",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered calling the NoDOM version Native since the primary user will be React Native, what do you think about the naming @acdlite?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me the primary purpose is to act as a last resort if you accidentally call this in a Node.js environment, like if you run a test without wrapping in act.

React Native will eventually need its own scheduler, so I'd rather not call this one a React Native scheduler since it's not optimized for that at all.

"unstable_post_task.js",
"cjs/",
"umd/"
Expand Down
5 changes: 0 additions & 5 deletions ...er/src/__tests__/SchedulerBrowser-test.js → ...eduler/src/__tests__/SchedulerDOM-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
0 ...scheduler/src/__tests__/Scheduler-test.js → ...duler/src/__tests__/SchedulerMock-test.js
View file
Open in desktop
File renamed without changes.
7 changes: 2 additions & 5 deletions packages/scheduler/src/__tests__/SchedulerNoDOM-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
24 changes: 19 additions & 5 deletions packages/scheduler/src/__tests__/SchedulerUMDBundle-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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) {
Expand Down
Loading