opensource/lexical
1
0
Fork 0
mirror of https://github.com/facebook/lexical.git synced 2025-08-06 16:39:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

[lexical] Chore: Change $getTextNodeOffset invariant to warn in prod (error in __DEV__) (#7397)

Browse Source
This commit is contained in:
Bob Ippolito
2025-03-31 09:53:13 -07:00
committed by GitHub
parent 8fc84876d9
commit 1bafc3cdf5
9 changed files with 330 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

216
scripts/error-codes/transform-error-messages.js
View File

@ -50,6 +50,19 @@ function getErrorMap(filepath) {
* @property {boolean} noMinify
*/
const invariantExpressions = [
{
dev: 'formatDevErrorMessage',
name: 'invariant',
prod: 'formatProdErrorMessage',
},
{
dev: 'formatDevErrorMessage',
name: 'devInvariant',
prod: 'formatProdWarningMessage',
},
];
/**
* @param {import('@babel/core')} babel
* @param {Partial<TransformErrorMessagesOptions>} opts
@ -66,120 +79,117 @@ module.exports = function (babel, opts) {
const node = path.node;
const {extractCodes, noMinify} =
/** @type Partial<TransformErrorMessagesOptions> */ (file.opts);
if (path.get('callee').isIdentifier({name: 'invariant'})) {
// Turns this code:
//
// invariant(condition, 'A %s message that contains %s', adj, noun);
//
// into something equivalent to this:
//
// if (!condition) {
// if (__DEV__ || ERR_CODE === undefined) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// } else {
// formatProdErrorMessage(ERR_CODE, adj, noun)
// };
// }
//
// where ERR_CODE is an error code: a unique identifier (a number
// string) that references a verbose error message. The mapping is
// stored in `scripts/error-codes/codes.json`.
const condition = node.arguments[0];
const errorMsgLiteral = evalToString(node.arguments[1]);
const errorMsgExpressions = Array.from(node.arguments.slice(2));
const errorMsgQuasis = errorMsgLiteral
.split('%s')
.map((raw) => t.templateElement({cooked: String.raw({raw}), raw}));
// Outputs:
// `A ${adj} message that contains ${noun}`;
const devMessage = t.templateLiteral(
errorMsgQuasis,
errorMsgExpressions,
);
const parentStatementPath = path.parentPath;
if (parentStatementPath.type !== 'ExpressionStatement') {
throw path.buildCodeFrameError(
'invariant() cannot be called from expression context. Move ' +
'the call to its own statement.',
);
}
// We extract the prodErrorId even if we are not using it
// so we can extractCodes in a non-production build.
let prodErrorId = errorMap.getOrAddToErrorMap(
errorMsgLiteral,
extractCodes,
);
/** @type {babel.types.CallExpression} */
let callExpression;
if (noMinify || prodErrorId === undefined) {
// Error minification is disabled for this build.
for (const {name, dev, prod} of invariantExpressions) {
if (path.get('callee').isIdentifier({name})) {
// Turns this code:
//
// Outputs:
// if (!condition) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// }
const formatDevErrorMessageIdentifier =
helperModuleImports.addDefault(
path,
'shared/formatDevErrorMessage',
{
nameHint: 'formatDevErrorMessage',
},
);
callExpression = t.callExpression(formatDevErrorMessageIdentifier, [
devMessage,
]);
} else {
// Error minification enabled for this build.
// invariant(condition, 'A %s message that contains %s', adj, noun);
//
// into something equivalent to this:
//
// Outputs:
// if (!condition) {
// formatProdErrorMessage(ERR_CODE, adj, noun)
// if (__DEV__ || ERR_CODE === undefined) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// } else {
// formatProdErrorMessage(ERR_CODE, adj, noun)
// };
// }
// Import ReactErrorProd
const formatProdErrorMessageIdentifier =
helperModuleImports.addDefault(
path,
'shared/formatProdErrorMessage',
{
nameHint: 'formatProdErrorMessage',
},
//
// where ERR_CODE is an error code: a unique identifier (a number
// string) that references a verbose error message. The mapping is
// stored in `scripts/error-codes/codes.json`.
const condition = node.arguments[0];
const errorMsgLiteral = evalToString(node.arguments[1]);
const errorMsgExpressions = Array.from(node.arguments.slice(2));
const errorMsgQuasis = errorMsgLiteral
.split('%s')
.map((raw) =>
t.templateElement({cooked: String.raw({raw}), raw}),
);
// Outputs:
// formatProdErrorMessage(ERR_CODE, adj, noun);
callExpression = t.callExpression(
formatProdErrorMessageIdentifier,
[t.numericLiteral(prodErrorId), ...errorMsgExpressions],
// `A ${adj} message that contains ${noun}`;
const devMessage = t.templateLiteral(
errorMsgQuasis,
errorMsgExpressions,
);
}
parentStatementPath.replaceWith(
t.ifStatement(
t.unaryExpression('!', condition),
t.blockStatement([t.expressionStatement(callExpression)]),
),
);
const parentStatementPath = path.parentPath;
if (parentStatementPath.type !== 'ExpressionStatement') {
throw path.buildCodeFrameError(
`${name}() cannot be called from expression context. Move the call to its own statement.`,
);
}
if (!noMinify && prodErrorId === undefined) {
// There is no error code for this message. Add an inline comment
// that flags this as an unminified error. This allows the build
// to proceed, while also allowing a post-build linter to detect it.
//
// Outputs:
// /* FIXME (minify-errors-in-prod): Unminified error message in production build! */
// if (!condition) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// }
parentStatementPath.addComment(
'leading',
'FIXME (minify-errors-in-prod): Unminified error message in production build!',
// We extract the prodErrorId even if we are not using it
// so we can extractCodes in a non-production build.
let prodErrorId = errorMap.getOrAddToErrorMap(
errorMsgLiteral,
extractCodes,
);
/** @type {babel.types.CallExpression} */
let callExpression;
if (noMinify || prodErrorId === undefined) {
// Error minification is disabled for this build.
//
// Outputs:
// if (!condition) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// }
const formatDevErrorMessageIdentifier =
helperModuleImports.addDefault(path, `shared/${dev}`, {
nameHint: dev,
});
callExpression = t.callExpression(
formatDevErrorMessageIdentifier,
[devMessage],
);
} else {
// Error minification enabled for this build.
//
// Outputs:
// if (!condition) {
// formatProdErrorMessage(ERR_CODE, adj, noun)
// }
// Import ReactErrorProd
const formatProdErrorMessageIdentifier =
helperModuleImports.addDefault(path, `shared/${prod}`, {
nameHint: prod,
});
// Outputs:
// formatProdErrorMessage(ERR_CODE, adj, noun);
callExpression = t.callExpression(
formatProdErrorMessageIdentifier,
[t.numericLiteral(prodErrorId), ...errorMsgExpressions],
);
}
parentStatementPath.replaceWith(
t.ifStatement(
t.unaryExpression('!', condition),
t.blockStatement([t.expressionStatement(callExpression)]),
),
);
if (!noMinify && prodErrorId === undefined) {
// There is no error code for this message. Add an inline comment
// that flags this as an unminified error. This allows the build
// to proceed, while also allowing a post-build linter to detect it.
//
// Outputs:
// /* FIXME (minify-errors-in-prod): Unminified error message in production build! */
// if (!condition) {
// formatDevErrorMessage(`A ${adj} message that contains ${noun}`);
// }
parentStatementPath.addComment(
'leading',
'FIXME (minify-errors-in-prod): Unminified error message in production build!',
);
}
return;
}
}
},