@samitouri / QOS-React-2 / commits / c8deb5db66

fix[ci]: fixed jest configuration not to skip too many devtools tests (#26955)

## Summary Running `yarn test --project devtools --build` currently skips all non-gated (without `@reactVersion` directives) devtools tests. This is not expected behaviour, these changes are fixing it. There were multiple related PRs to it: - https://github.com/facebook/react/pull/26742 - https://github.com/facebook/react/pull/25712 - https://github.com/facebook/react/pull/24555 With these changes, the resulting behaviour will be: - If `REACT_VERSION` env variable is specified: - jest will not include all non-gated test cases in the test run - jest will run only a specific test case, when specified `REACT_VERSION` value satisfies the range defined by `@reactVersion` directives for this test case - If `REACT_VERSION` env variable is not specified, jest will run all non-gated tests: - jest will include all non-gated test cases in the test run - jest will run all non-gated test cases, the only skipped test cases will be those, which specified the range that does not include the next stable version of react, which will be imported from `ReactVersions.js` ## How did you test this change? Running `profilingCache` test suite without specifying `reactVersion` now skips gated (>= 17 & < 18) test <img width="1447" alt="Screenshot 2023-06-15 at 11 18 22" src="https://github.com/facebook/react/assets/28902667/cad58994-2cb3-44b3-9eb2-1699c01a1eb3"> Running `profilingCache` test suite with specifying `reactVersion` to `17` now runs this test case and skips others correctly <img width="1447" alt="Screenshot 2023-06-15 at 11 20 11" src="https://github.com/facebook/react/assets/28902667/d308960a-c172-4422-ba6f-9c0dbcd6f7d5"> Running `yarn test --project devtools ...` without specifying `reactVersion` now runs all non-gated test cases <img width="398" alt="Screenshot 2023-06-15 at 12 25 12" src="https://github.com/facebook/react/assets/28902667/2b329634-0efd-4c4c-b460-889696bbc9e1"> Running `yarn test --project devtools ...` with specifying `reactVersion` (to `17` in this example) now includes only gated tests <img width="414" alt="Screenshot 2023-06-15 at 12 26 31" src="https://github.com/facebook/react/assets/28902667/a702c27e-4c35-4b12-834c-e5bb06728997">

Ruslan Lesiutin committed Jun 22, 2023 at 09:33 UTC c8deb5db660f3f6eeca30d29b4bd48d9e82b3792
6 files changed +21 -35
packages/react-devtools-shared/src/__tests__/profilingCache-test.js
+11 -2
@@ -938,7 +938,8 @@ describe('ProfilingCache', () => {
938 }
939 });
940
941 - // @reactVersion = 17.0
941 + // @reactVersion >= 17
942 + // @reactVersion < 18
943 it('should handle unexpectedly shallow suspense trees', () => {
944 // This test only runs in v17 because it's a regression test for legacy
945 // Suspense behavior, and the implementation details changed in v18.
@@ -967,7 +968,15 @@ describe('ProfilingCache', () => {
968 "passiveEffectDuration": null,
969 "priorityLevel": "Normal",
970 "timestamp": 0,
970 - "updaters": null,
971 + "updaters": [
972 + {
973 + "displayName": "render()",
974 + "hocDisplayNames": null,
975 + "id": 1,
976 + "key": null,
977 + "type": 11,
978 + },
979 + ],
980 },
981 ]
982 `);
packages/react-devtools-shared/src/__tests__/transform-react-version-pragma-test.js
-13
@@ -10,7 +10,6 @@ const semver = require('semver');
10
11 let shouldPass;
12 let isFocused;
13 -let shouldIgnore;
13 describe('transform-react-version-pragma', () => {
14 const originalTest = test;
15
@@ -34,7 +33,6 @@ describe('transform-react-version-pragma', () => {
33 // eslint-disable-next-line no-unused-vars
34 const _test_ignore_for_react_version = (testName, cb) => {
35 originalTest(testName, (...args) => {
37 - shouldIgnore = true;
36 shouldPass = false;
37 return cb(...args);
38 });
@@ -43,7 +41,6 @@ describe('transform-react-version-pragma', () => {
41 beforeEach(() => {
42 shouldPass = null;
43 isFocused = false;
46 - shouldIgnore = false;
44 });
45
46 // @reactVersion >= 17.9
@@ -137,14 +134,4 @@ describe('transform-react-version-pragma', () => {
134 expect(shouldPass).toBe(true);
135 expect(isFocused).toBe(true);
136 });
140 -
141 - test('ignore test if no reactVersion', () => {
142 - expect(shouldPass).toBe(false);
143 - expect(shouldIgnore).toBe(true);
144 - });
145 -
146 - test.only('ignore focused test if no reactVersion', () => {
147 - expect(shouldPass).toBe(false);
148 - expect(shouldIgnore).toBe(true);
149 - });
137 });
scripts/babel/transform-react-version-pragma.js
+3 -2
@@ -5,6 +5,7 @@
5 const getComments = require('./getComments');
6
7 const GATE_VERSION_STR = '@reactVersion ';
8 +const REACT_VERSION_ENV = process.env.REACT_VERSION;
9
10 function transform(babel) {
11 const {types: t} = babel;
@@ -75,7 +76,7 @@ function transform(babel) {
76 ? '_test_react_version_focus'
77 : '_test_react_version';
78 expression.arguments = [condition, ...expression.arguments];
78 - } else {
79 + } else if (REACT_VERSION_ENV) {
80 callee.name = '_test_ignore_for_react_version';
81 }
82 }
@@ -96,7 +97,7 @@ function transform(babel) {
97 t.identifier('_test_react_version_focus'),
98 [condition, ...expression.arguments]
99 );
99 - } else {
100 + } else if (REACT_VERSION_ENV) {
101 statement.expression = t.callExpression(
102 t.identifier('_test_ignore_for_react_version'),
103 expression.arguments
scripts/jest/devtools/setupEnv.js
+3 -3
@@ -1,7 +1,7 @@
1 'use strict';
2
3 const semver = require('semver');
4 -const ReactVersion = require('../../../packages/shared/ReactVersion');
4 +const {ReactVersion} = require('../../../ReactVersions');
5
6 const {
7 DARK_MODE_DIMMED_WARNING_COLOR,
@@ -32,7 +32,7 @@ global.process.env.LIGHT_MODE_DIMMED_ERROR_COLOR =
32 global.process.env.LIGHT_MODE_DIMMED_LOG_COLOR = LIGHT_MODE_DIMMED_LOG_COLOR;
33
34 global._test_react_version = (range, testName, callback) => {
35 - const reactVersion = process.env.REACT_VERSION || ReactVersion.default;
35 + const reactVersion = process.env.REACT_VERSION || ReactVersion;
36 const shouldPass = semver.satisfies(reactVersion, range);
37
38 if (shouldPass) {
@@ -43,7 +43,7 @@ global._test_react_version = (range, testName, callback) => {
43 };
44
45 global._test_react_version_focus = (range, testName, callback) => {
46 - const reactVersion = process.env.REACT_VERSION || ReactVersion.default;
46 + const reactVersion = process.env.REACT_VERSION || ReactVersion;
47 const shouldPass = semver.satisfies(reactVersion, range);
48
49 if (shouldPass) {
scripts/jest/jest-cli.js
+3 -9
@@ -16,8 +16,6 @@ const devToolsConfig = './scripts/jest/config.build-devtools.js';
16 const persistentConfig = './scripts/jest/config.source-persistent.js';
17 const buildConfig = './scripts/jest/config.build.js';
18
19 -const {ReactVersion} = require('../../ReactVersions');
20 -
19 const argv = yargs
20 .parserConfiguration({
21 // Important: This option tells yargs to move all other options not
@@ -181,13 +179,9 @@ function validateOptions() {
179 success = false;
180 }
181
184 - if (argv.reactVersion) {
185 - if (!semver.validRange(argv.reactVersion)) {
186 - success = false;
187 - logError('please specify a valid version range for --reactVersion');
188 - }
189 - } else {
190 - argv.reactVersion = ReactVersion;
182 + if (argv.reactVersion && !semver.validRange(argv.reactVersion)) {
183 + success = false;
184 + logError('please specify a valid version range for --reactVersion');
185 }
186 } else {
187 if (argv.compactConsole) {
scripts/jest/preprocessor.js
+1 -6
@@ -86,12 +86,7 @@ module.exports = {
86 const plugins = (isTestFile ? testOnlyPlugins : sourceOnlyPlugins).concat(
87 babelOptions.plugins
88 );
89 - if (
90 - isTestFile &&
91 - isInDevToolsPackages &&
92 - (process.env.REACT_VERSION ||
93 - filePath.match(/\/transform-react-version-pragma-test/))
94 - ) {
89 + if (isTestFile && isInDevToolsPackages) {
90 plugins.push(pathToTransformReactVersionPragma);
91 }
92 let sourceAst = hermesParser.parse(src, {babel: true});