Skip to content

Commit 3133dfa

Browse files
lunaruanlunaruan
authored
DevTools] e2e Regression Testing App (#24619)
This PR adds an e2e regression app to the react-devtools-shell package. This app: * Has an app.js and an appLegacy.js entrypoint because apps prior to React 18 need to use ReactDOM.render. These files will create and render multiple test apps (though they currently only render the List) * Moved the ListApp out of the e2e folder and into an e2e-apps folder so that both e2e and e2e-regression can use the same test apps * Creates a ListAppLegacy app because prior to React 16.8 hooks didn't exist. * Added a devtools file for the e2e-regression * Modifies the webpack config so that the e2e-regression React app can use different a different React version than DevTools
1 parent 1328ff7 commit 3133dfa

File tree

10 files changed

+358
-90
lines changed

10 files changed

+358
-90
lines changed

‎packages/react-devtools-shell/e2e-regression.html

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf8">
5+
<title>React DevTools</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<style>
8+
* {
9+
box-sizing: border-box;
10+
}
11+
body {
12+
margin: 0;
13+
padding: 0;
14+
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,
15+
sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
16+
font-size: 12px;
17+
line-height: 1.5;
18+
}
19+
#iframe {
20+
position: absolute;
21+
top: 0;
22+
left: 0;
23+
width: 100vw;
24+
height: 50vh;
25+
}
26+
#devtools {
27+
position: absolute;
28+
bottom: 0;
29+
left: 0;
30+
width: 100vw;
31+
height: 50vh;
32+
}
33+
</style>
34+
</head>
35+
<body>
36+
<iframe id="iframe"></iframe>
37+
<div id="devtools"></div>
38+
<script src="dist/e2e-devtools-regression.js"></script>
39+
</body>
40+
</html>

‎packages/react-devtools-shell/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
<a href="/multi.html">multi DevTools</a>
5252
|
5353
<a href="/e2e.html">e2e tests</a>
54+
<a href="/e2e-regression.html">e2e regression tests</a>
5455
</span>
5556
</div>
5657

‎packages/react-devtools-shell/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
},
88
"dependencies": {
99
"immutable": "^4.0.0-rc.12",
10-
"react-native-web": "0.0.0-26873b469"
10+
"react-native-web": "0.0.0-26873b469",
11+
"semver": "^6.3.0"
1112
},
1213
"devDependencies": {
1314
"@babel/core": "^7.11.1",

‎packages/react-devtools-shell/src/e2e/apps/ListApp.js renamed to ‎packages/react-devtools-shell/src/e2e-apps/ListApp.js

File renamed without changes.

‎packages/react-devtools-shell/src/e2e-apps/ListAppLegacy.js

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* Copyright (c) Facebook, Inc. and its affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow
8+
*/
9+
10+
import * as React from 'react';
11+
12+
export default function App() {
13+
return <List />;
14+
}
15+
16+
class List extends React.Component {
17+
constructor(props) {
18+
super(props);
19+
this.state = {
20+
items: ['one', 'two', 'three'],
21+
};
22+
}
23+
24+
addItem = () => {
25+
if (this.inputRef && this.inputRef.value) {
26+
this.setState({items: [...this.state.items, this.inputRef.value]});
27+
this.inputRef.value = '';
28+
}
29+
};
30+
31+
render() {
32+
return (
33+
<div>
34+
<input
35+
data-testname="AddItemInput"
36+
value={this.state.text}
37+
onChange={this.onInputChange}
38+
ref={c => (this.inputRef = c)}
39+
/>
40+
<button data-testname="AddItemButton" onClick={this.addItem}>
41+
Add Item
42+
</button>
43+
<ul data-testname="List">
44+
{this.state.items.map((label, index) => (
45+
<ListItem key={index} label={label} />
46+
))}
47+
</ul>
48+
</div>
49+
);
50+
}
51+
}
52+
53+
function ListItem({label}) {
54+
return <li data-testname="ListItem">{label}</li>;
55+
}

‎packages/react-devtools-shell/src/e2e-regression/app-legacy.js

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/** @flow */
2+
3+
// This test harness mounts each test app as a separate root to test multi-root applications.
4+
5+
import * as React from 'react';
6+
import * as ReactDOM from 'react-dom';
7+
import {gte} from 'semver';
8+
import ListApp from '../e2e-apps/ListApp';
9+
import ListAppLegacy from '../e2e-apps/ListAppLegacy';
10+
const version = process.env.E2E_APP_REACT_VERSION;
11+
12+
function mountApp(App) {
13+
const container = document.createElement('div');
14+
15+
((document.body: any): HTMLBodyElement).appendChild(container);
16+
17+
ReactDOM.render(<App />, container);
18+
}
19+
function mountTestApp() {
20+
// ListApp has hooks, which aren't available until 16.8.0
21+
mountApp(gte(version, '16.8.0') ? ListApp : ListAppLegacy);
22+
}
23+
24+
mountTestApp();
25+
26+
// ReactDOM Test Selector APIs used by Playwright e2e tests
27+
// If they don't exist, we mock them
28+
window.parent.REACT_DOM_APP = {
29+
createTestNameSelector: name => `[data-testname="${name}"]`,
30+
findAllNodes: (container, nodes) =>
31+
container.querySelectorAll(nodes.join(' ')),
32+
...ReactDOM,
33+
};

‎packages/react-devtools-shell/src/e2e-regression/app.js

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/** @flow */
2+
3+
// This test harness mounts each test app as a separate root to test multi-root applications.
4+
5+
import * as React from 'react';
6+
import * as ReactDOM from 'react-dom';
7+
import {createRoot} from 'react-dom/client';
8+
import ListApp from '../e2e-apps/ListApp';
9+
10+
function mountApp(App) {
11+
const container = document.createElement('div');
12+
13+
((document.body: any): HTMLBodyElement).appendChild(container);
14+
15+
const root = createRoot(container);
16+
root.render(<App />);
17+
}
18+
function mountTestApp() {
19+
mountApp(ListApp);
20+
}
21+
22+
mountTestApp();
23+
24+
// ReactDOM Test Selector APIs used by Playwright e2e tests
25+
window.parent.REACT_DOM_APP = ReactDOM;

‎packages/react-devtools-shell/src/e2e-regression/devtools.js

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
import * as React from 'react';
2+
import * as ReactDOM from 'react-dom';
3+
import {createRoot} from 'react-dom/client';
4+
import {
5+
activate as activateBackend,
6+
initialize as initializeBackend,
7+
} from 'react-devtools-inline/backend';
8+
import {initialize as createDevTools} from 'react-devtools-inline/frontend';
9+
10+
// This is a pretty gross hack to make the runtime loaded named-hooks-code work.
11+
// TODO (Webpack 5) Hoepfully we can remove this once we upgrade to Webpack 5.
12+
// $FlowFixMer
13+
__webpack_public_path__ = '/dist/'; // eslint-disable-line no-undef
14+
15+
// TODO (Webpack 5) Hopefully we can remove this prop after the Webpack 5 migration.
16+
function hookNamesModuleLoaderFunction() {
17+
return import('react-devtools-inline/hookNames');
18+
}
19+
20+
function inject(contentDocument, sourcePath, callback) {
21+
const script = contentDocument.createElement('script');
22+
script.onload = callback;
23+
script.src = sourcePath;
24+
25+
((contentDocument.body: any): HTMLBodyElement).appendChild(script);
26+
}
27+
28+
function init(appIframe, devtoolsContainer, appSource) {
29+
const {contentDocument, contentWindow} = appIframe;
30+
31+
initializeBackend(contentWindow);
32+
33+
const DevTools = createDevTools(contentWindow);
34+
35+
inject(contentDocument, appSource, () => {
36+
// $FlowFixMe Flow doesn't know about createRoot() yet.
37+
createRoot(devtoolsContainer).render(
38+
<DevTools
39+
hookNamesModuleLoaderFunction={hookNamesModuleLoaderFunction}
40+
showTabBar={true}
41+
/>,
42+
);
43+
});
44+
45+
activateBackend(contentWindow);
46+
}
47+
48+
const iframe = document.getElementById('iframe');
49+
const devtoolsContainer = document.getElementById('devtools');
50+
51+
init(iframe, devtoolsContainer, 'dist/e2e-app-regression.js');
52+
53+
// ReactDOM Test Selector APIs used by Playwright e2e tests
54+
window.parent.REACT_DOM_DEVTOOLS = ReactDOM;

‎packages/react-devtools-shell/src/e2e/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const container = document.createElement('div');
1212

1313
// TODO We may want to parameterize this app
1414
// so that it can load things other than just ToDoList.
15-
const App = require('./apps/ListApp').default;
15+
const App = require('../e2e-apps/ListApp').default;
1616

1717
const root = createRoot(container);
1818
root.render(<App />);

0 commit comments

Comments
 (0)