mirror of
https://github.com/zebrajr/react.git
synced 2025-12-06 12:20:20 +01:00
## Summary This PR adds a "perf regression tests" page to react-devtools-shell. This page is meant to be used as a performance sanity check we will run whenever we release a new version or finish a major refactor. Similar to other pages in the shell, this page can load the inline version of devtools and a test react app on the same page. But this page does not load devtools automatically like other pages. Instead, it provides a button that allows us to load devtools on-demand, so that we can easily compare perf numbers without devtools against the numbers with devtools. <img width="561" alt="image" src="https://user-images.githubusercontent.com/1001890/184059633-e4f0852c-8464-4d94-8064-1684eee626f4.png"> As a first step, this page currently only contain one test: mount/unmount a large subtree. This is to catch perf issues that devtools can cause on the react applications it's running on, which was once a bug fixed in #24863. In the future, we plan to add: - more test apps covering different scenarios - perf numbers within devtools (e.g. initial load) ## How did you test this change? In order to show this test app can actually catch the perf regression it's aiming at, I reverted #24863 locally. Here is the result: https://user-images.githubusercontent.com/1001890/184059214-9c9b308c-173b-4dd7-b815-46fbd7067073.mov As shown in the video, the time it takes to unmount the large subtree significantly increased after DevTools is loaded. For comparison, here is how it looks like before the fix was reverted: <img width="452" alt="image" src="https://user-images.githubusercontent.com/1001890/184059743-0968bc7d-4ce4-42cd-b04a-f6cbc078d4f4.png"> ## about the `requestAnimationFrame` method For this test, I used `requestAnimationFrame` to catch the time when render and commit are done. It aligns very well with the numbers reported by Chrome DevTools performance profiling. For example, in one run, the numbers reported by my method are <img width="464" alt="image" src="https://user-images.githubusercontent.com/1001890/184060228-990a4c75-f594-411a-9f85-fa5532ec8c37.png"> They are very close to the numbers reported by Chrome profiling: <img width="456" alt="image" src="https://user-images.githubusercontent.com/1001890/184060355-a15d1ec5-c296-4016-9c83-03e761f387e3.png"> <img width="354" alt="image" src="https://user-images.githubusercontent.com/1001890/184060375-19029010-3aed-4a23-890e-397cdba86d9e.png"> `<Profiler>` is not able to catch this issue here. If you are aware of a better way to do this, please kindly share with me.
56 lines
1.6 KiB
JavaScript
56 lines
1.6 KiB
JavaScript
import * as React from 'react';
|
|
import {createRoot} from 'react-dom/client';
|
|
import {
|
|
activate as activateBackend,
|
|
initialize as initializeBackend,
|
|
} from 'react-devtools-inline/backend';
|
|
import {initialize as createDevTools} from 'react-devtools-inline/frontend';
|
|
|
|
// This is a pretty gross hack to make the runtime loaded named-hooks-code work.
|
|
// TODO (Webpack 5) Hoepfully we can remove this once we upgrade to Webpack 5.
|
|
// $FlowFixMe
|
|
__webpack_public_path__ = '/dist/'; // eslint-disable-line no-undef
|
|
|
|
// TODO (Webpack 5) Hopefully we can remove this prop after the Webpack 5 migration.
|
|
function hookNamesModuleLoaderFunction() {
|
|
return import('react-devtools-inline/hookNames');
|
|
}
|
|
|
|
function inject(contentDocument, sourcePath) {
|
|
const script = contentDocument.createElement('script');
|
|
script.src = sourcePath;
|
|
|
|
((contentDocument.body: any): HTMLBodyElement).appendChild(script);
|
|
}
|
|
|
|
function init(
|
|
appSource: string,
|
|
appIframe: HTMLIFrameElement,
|
|
devtoolsContainer: HTMLElement,
|
|
loadDevToolsButton: HTMLButtonElement,
|
|
) {
|
|
const {contentDocument, contentWindow} = appIframe;
|
|
|
|
initializeBackend(contentWindow);
|
|
|
|
inject(contentDocument, appSource);
|
|
|
|
loadDevToolsButton.addEventListener('click', () => {
|
|
const DevTools = createDevTools(contentWindow);
|
|
createRoot(devtoolsContainer).render(
|
|
<DevTools
|
|
hookNamesModuleLoaderFunction={hookNamesModuleLoaderFunction}
|
|
showTabBar={true}
|
|
/>,
|
|
);
|
|
activateBackend(contentWindow);
|
|
});
|
|
}
|
|
|
|
init(
|
|
'dist/perf-regression-app.js',
|
|
document.getElementById('iframe'),
|
|
document.getElementById('devtools'),
|
|
document.getElementById('load-devtools'),
|
|
);
|