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

[RFC] Mock react scheduler module #12684

Closed
wants to merge 6 commits into from
Closed

[RFC] Mock react scheduler module #12684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9488108
Add support for multiple callbacks in ReactScheduler
flarnie Apr 24, 2018
003605c
remove file which was accidentally added
flarnie Apr 24, 2018
48b8164
revert mocking of browser APIs from PR12648
flarnie Apr 24, 2018
8b7ff96
Mock out react-scheduler in renderer tests
flarnie Apr 24, 2018
41e33b8
Configure rollup to treat ReactScheduler as external
flarnie Apr 24, 2018
b17cad8
WIP Configure packaging fixtures to find external 'react-scheduler'
flarnie Apr 24, 2018
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
3 changes: 2 additions & 1 deletion fixtures/packaging/babel-standalone/dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<html>
<body>
<script src="../../../build/dist/react-scheduler.development.js"></script>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Changes adding script tags should not be needed.

<script src="../../../build/dist/react.development.js"></script>
<script src="../../../build/dist/react-dom.development.js"></script>
<script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
Expand All @@ -11,4 +12,4 @@ <h1>Hello World!</h1>,
);
</script>
</body>
</html>
</html>
3 changes: 2 additions & 1 deletion fixtures/packaging/brunch/dev/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"brunch": "^2.9.1",
"javascript-brunch": "^2.0.0",
"react": "link:../../../../build/node_modules/react",
"react-dom": "link:../../../../build/node_modules/react-dom"
"react-dom": "link:../../../../build/node_modules/react-dom",
"react-scheduler": "link:../../../../build/node_modules/react-scheduler"
},
"scripts": {
"build": "rm -rf public && brunch build"
Expand Down
4 changes: 4 additions & 0 deletions fixtures/packaging/brunch/dev/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,6 +1708,10 @@ rc@^1.1.7:
version "0.0.0"
uid ""

"react-scheduler@link:../../../../build/node_modules/react-scheduler":
version "0.0.0"
uid ""

"react@link:../../../../build/node_modules/react":
version "0.0.0"
uid ""
Expand Down
3 changes: 2 additions & 1 deletion fixtures/packaging/brunch/prod/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"brunch": "^2.9.1",
"javascript-brunch": "^2.0.0",
"react": "link:../../../../build/node_modules/react",
"react-dom": "link:../../../../build/node_modules/react-dom"
"react-dom": "link:../../../../build/node_modules/react-dom",
"react-scheduler": "link:../../../../build/node_modules/react-scheduler"
},
"scripts": {
"build": "rm -rf public && brunch build -p"
Expand Down
4 changes: 4 additions & 0 deletions fixtures/packaging/brunch/prod/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,6 +1708,10 @@ rc@^1.1.7:
version "0.0.0"
uid ""

"react-scheduler@link:../../../../build/node_modules/react-scheduler":
version "0.0.0"
uid ""

"react@link:../../../../build/node_modules/react":
version "0.0.0"
uid ""
Expand Down
3 changes: 2 additions & 1 deletion fixtures/packaging/globals/dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<html>
<body>
<script src="../../../build/dist/react-scheduler.development.js"></script>
<script src="../../../build/dist/react.development.js"></script>
<script src="../../../build/dist/react-dom.development.js"></script>
<div id="container"></div>
Expand All @@ -10,4 +11,4 @@
);
</script>
</body>
</html>
</html>
3 changes: 2 additions & 1 deletion fixtures/packaging/globals/prod.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<html>
<body>
<script src="../../../build/dist/react-scheduler.production.min.js"></script>
<script src="../../../build/dist/react.production.min.js"></script>
<script src="../../../build/dist/react-dom.production.min.js"></script>
<div id="container"></div>
Expand All @@ -10,4 +11,4 @@
);
</script>
</body>
</html>
</html>
5 changes: 3 additions & 2 deletions fixtures/packaging/requirejs/dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
requirejs.config({
paths: {
react: '../../../build/dist/react.development',
'react-dom': '../../../build/dist/react-dom.development'
'react-dom': '../../../build/dist/react-dom.development',
'react-scheduler': '../../../build/dist/react-scheduler.development'
}
});

Expand All @@ -18,4 +19,4 @@
});
</script>
</body>
</html>
</html>
5 changes: 3 additions & 2 deletions fixtures/packaging/requirejs/prod.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
requirejs.config({
paths: {
react: '../../../build/dist/react.production.min',
'react-dom': '../../../build/dist/react-dom.production.min'
'react-dom': '../../../build/dist/react-dom.production.min',
'react-scheduler': '../../../build/dist/react-scheduler.production.min'
}
});

Expand All @@ -18,4 +19,4 @@
});
</script>
</body>
</html>
</html>
1 change: 1 addition & 0 deletions fixtures/packaging/rjs/dev/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ module.exports = {
paths: {
react: '../../../../build/dist/react.development',
'react-dom': '../../../../build/dist/react-dom.development',
'react-scheduler': '../../../../build/dist/react-scheduler.development',
},
};
1 change: 1 addition & 0 deletions fixtures/packaging/rjs/prod/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ module.exports = {
paths: {
react: '../../../../build/dist/react.production.min',
'react-dom': '../../../../build/dist/react-dom.production.min',
'react-scheduler': '../../../../build/dist/react-scheduler.production.min',
},
};
1 change: 1 addition & 0 deletions fixtures/packaging/systemjs-builder/dev/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ System.config({
paths: {
react: '../../../../build/dist/react.development.js',
'react-dom': '../../../../build/dist/react-dom.development.js',
'react-scheduler': '../../../../build/dist/react-scheduler.development.js',
},
});
1 change: 1 addition & 0 deletions fixtures/packaging/systemjs-builder/prod/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ System.config({
paths: {
react: '../../../../build/dist/react.production.min.js',
'react-dom': '../../../../build/dist/react-dom.production.min.js',
'react-scheduler': '../../../../build/dist/react-scheduler.production.min.js',
},
});
5 changes: 3 additions & 2 deletions fixtures/packaging/systemjs/dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
System.config({
paths: {
react: '../../../build/dist/react.development.js',
'react-dom': '../../../build/dist/react-dom.development.js'
'react-dom': '../../../build/dist/react-dom.development.js',
'react-scheduler': '../../../build/dist/react-scheduler.development.js'
}
});

Expand All @@ -24,4 +25,4 @@
});
</script>
</body>
</html>
</html>
5 changes: 3 additions & 2 deletions fixtures/packaging/systemjs/prod.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
System.config({
paths: {
react: '../../../build/dist/react.production.min.js',
'react-dom': '../../../build/dist/react-dom.production.min.js'
'react-dom': '../../../build/dist/react-dom.production.min.js',
'react-scheduler': '../../../build/dist/react-scheduler.production.min.js'
}
});

Expand All @@ -24,4 +25,4 @@
});
</script>
</body>
</html>
</html>
80 changes: 47 additions & 33 deletions packages/react-dom/src/__tests__/ReactDOMFiberAsync-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,46 @@ const AsyncMode = React.unstable_AsyncMode;

describe('ReactDOMFiberAsync', () => {
let container;
let scheduledCallback;
let flush;
let now;

beforeEach(() => {
// TODO pull this into helper method, reduce repetition.
// mock the browser APIs which are used in react-scheduler:
// - requestAnimationFrame should pass the DOMHighResTimeStamp argument
// - calling 'window.postMessage' should actually fire postmessage handlers
global.requestAnimationFrame = function(cb) {
return setTimeout(() => {
cb(Date.now());
});
};
const originalAddEventListener = global.addEventListener;
let postMessageCallback;
global.addEventListener = function(eventName, callback, useCapture) {
if (eventName === 'message') {
postMessageCallback = callback;
} else {
originalAddEventListener(eventName, callback, useCapture);
}
};
global.postMessage = function(messageKey, targetOrigin) {
const postMessageEvent = {source: window, data: messageKey};
if (postMessageCallback) {
postMessageCallback(postMessageEvent);
scheduledCallback = null;
flush = function(units = Infinity) {
if (scheduledCallback !== null) {
let didStop = false;
while (scheduledCallback !== null && !didStop) {
const cb = scheduledCallback;
scheduledCallback = null;
cb({
timeRemaining() {
if (units > 0) {
return 999;
}
didStop = true;
return 0;
},
});
units--;
}
}
};
now = 0;

jest.mock('react-scheduler', () => {
return {
now() {
return now;
},
rIC(cb) {
scheduledCallback = cb;
},
cIC() {
scheduledCallback = null;
},
};
});
jest.resetModules();
container = document.createElement('div');
ReactDOM = require('react-dom');
Expand Down Expand Up @@ -100,12 +114,12 @@ describe('ReactDOMFiberAsync', () => {
const root = ReactDOM.unstable_createRoot(container);
root.render(<div>Hi</div>);
expect(container.textContent).toEqual('');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('Hi');

root.render(<div>Bye</div>);
expect(container.textContent).toEqual('Hi');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('Bye');
});

Expand All @@ -122,12 +136,12 @@ describe('ReactDOMFiberAsync', () => {
const root = ReactDOM.unstable_createRoot(container);
root.render(<Component />);
expect(container.textContent).toEqual('');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('0');

instance.setState({step: 1});
expect(container.textContent).toEqual('0');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('1');
});

Expand All @@ -147,11 +161,11 @@ describe('ReactDOMFiberAsync', () => {
</AsyncMode>,
container,
);
jest.runAllTimers();
flush();

instance.setState({step: 1});
expect(container.textContent).toEqual('0');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('1');
});

Expand All @@ -173,11 +187,11 @@ describe('ReactDOMFiberAsync', () => {
</div>,
container,
);
jest.runAllTimers();
flush();

instance.setState({step: 1});
expect(container.textContent).toEqual('0');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('1');
});

Expand Down Expand Up @@ -303,7 +317,7 @@ describe('ReactDOMFiberAsync', () => {
</AsyncMode>,
container,
);
jest.runAllTimers();
flush();

// Updates are async by default
instance.push('A');
Expand All @@ -326,7 +340,7 @@ describe('ReactDOMFiberAsync', () => {
expect(ops).toEqual(['BC']);

// Flush the async updates
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('ABCD');
expect(ops).toEqual(['BC', 'ABCD']);
});
Expand All @@ -353,7 +367,7 @@ describe('ReactDOMFiberAsync', () => {
// Test that a normal update is async
inst.increment();
expect(container.textContent).toEqual('0');
jest.runAllTimers();
flush();
expect(container.textContent).toEqual('1');

let ops = [];
Expand Down
Loading