react/scripts/babel/transform-react-version-pragma.js
Luna Ruan 7d9e17a982
[DevTools] Add Pragma to Only Run Tests if Version Requirement Satisfied (#24533)
This PR:

Adds a transform-react-version-pragma that transforms // @reactVersion SEMVER_VERSION into _test_react_version(...) and _test_react_version_focus(...) that lets us only run a test if it satisfies the right react version.
Adds _test_react_version and _test_react_version_focus to the devtools setupEnv file
Add a devtools preprocessor file for devtools specific plugins
2022-05-11 12:01:05 -04:00

108 lines
3.3 KiB
JavaScript

'use strict';
/* eslint-disable no-for-of-loops/no-for-of-loops */
const GATE_VERSION_STR = '@reactVersion ';
function transform(babel) {
const {types: t} = babel;
// Runs tests conditionally based on the version of react (semver range) we are running
// Input:
// @reactVersion >= 17.0
// test('some test', () => {/*...*/})
//
// Output:
// @reactVersion >= 17.0
// _test_react_version('>= 17.0', 'some test', () => {/*...*/});
//
// See info about semver ranges here:
// https://www.npmjs.com/package/semver
function buildGateVersionCondition(comments) {
let conditions = null;
for (const line of comments) {
const commentStr = line.value.trim();
if (commentStr.startsWith(GATE_VERSION_STR)) {
const condition = t.stringLiteral(
commentStr.slice(GATE_VERSION_STR.length)
);
if (conditions === null) {
conditions = [condition];
} else {
conditions.push(condition);
}
}
}
if (conditions !== null) {
let condition = conditions[0];
for (let i = 1; i < conditions.length; i++) {
const right = conditions[i];
condition = t.logicalExpression('&&', condition, right);
}
return condition;
} else {
return null;
}
}
return {
name: 'transform-react-version-pragma',
visitor: {
ExpressionStatement(path) {
const statement = path.node;
const expression = statement.expression;
if (expression.type === 'CallExpression') {
const callee = expression.callee;
switch (callee.type) {
case 'Identifier': {
if (
callee.name === 'test' ||
callee.name === 'it' ||
callee.name === 'fit'
) {
const comments = statement.leadingComments;
if (comments !== undefined) {
const condition = buildGateVersionCondition(comments);
if (condition !== null) {
callee.name =
callee.name === 'fit'
? '_test_react_version_focus'
: '_test_react_version';
expression.arguments = [condition, ...expression.arguments];
}
}
}
break;
}
case 'MemberExpression': {
if (
callee.object.type === 'Identifier' &&
(callee.object.name === 'test' ||
callee.object.name === 'it') &&
callee.property.type === 'Identifier' &&
callee.property.name === 'only'
) {
const comments = statement.leadingComments;
if (comments !== undefined) {
const condition = buildGateVersionCondition(comments);
if (condition !== null) {
statement.expression = t.callExpression(
t.identifier('_test_react_version_focus'),
[condition, ...expression.arguments]
);
}
}
}
break;
}
}
}
return;
},
},
};
}
module.exports = transform;