eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
130 lines (129 loc) • 5.35 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
// https://sonarsource.github.io/rspec/#/rspec/S4822/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const meta_js_1 = require("./meta.js");
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, undefined, true),
create(context) {
const services = context.sourceCode.parserServices;
if ((0, index_js_1.isRequiredParserServices)(services)) {
return {
TryStatement: (node) => visitTryStatement(node, context, services),
};
}
return {};
},
};
function visitTryStatement(tryStmt, context, services) {
if (tryStmt.handler) {
// without '.catch()'
const openPromises = [];
// with '.catch()'
const capturedPromises = [];
let hasPotentiallyThrowingCalls = false;
CallLikeExpressionVisitor.getCallExpressions(tryStmt.block, context).forEach(callLikeExpr => {
if (callLikeExpr.type === 'AwaitExpression' ||
!(0, index_js_1.isThenable)(callLikeExpr, services)) {
hasPotentiallyThrowingCalls = true;
return;
}
if (isAwaitLike(callLikeExpr) || isThened(callLikeExpr) || isCatch(callLikeExpr)) {
return;
}
(isCaught(callLikeExpr) ? capturedPromises : openPromises).push(callLikeExpr);
});
if (!hasPotentiallyThrowingCalls) {
checkForWrongCatch(tryStmt, openPromises, context);
checkForUselessCatch(tryStmt, openPromises, capturedPromises, context);
}
}
}
class CallLikeExpressionVisitor {
constructor() {
this.callLikeExpressions = [];
}
static getCallExpressions(node, context) {
const visitor = new CallLikeExpressionVisitor();
visitor.visit(node, context);
return visitor.callLikeExpressions;
}
visit(root, context) {
const visitNode = (node) => {
switch (node.type) {
case 'AwaitExpression':
case 'CallExpression':
case 'NewExpression':
this.callLikeExpressions.push(node);
break;
case 'FunctionDeclaration':
case 'FunctionExpression':
case 'ArrowFunctionExpression':
return;
}
(0, index_js_1.childrenOf)(node, context.sourceCode.visitorKeys).forEach(visitNode);
};
visitNode(root);
}
}
function checkForWrongCatch(tryStmt, openPromises, context) {
if (openPromises.length > 0) {
const ending = openPromises.length > 1 ? 's' : '';
const message = `Consider using 'await' for the promise${ending} inside this 'try' or replace it with 'Promise.prototype.catch(...)' usage${ending}.`;
const token = context.sourceCode.getFirstToken(tryStmt);
(0, index_js_1.report)(context, {
message,
loc: token.loc,
}, openPromises.map(node => (0, index_js_1.toSecondaryLocation)(node, 'Promise')));
}
}
function checkForUselessCatch(tryStmt, openPromises, capturedPromises, context) {
if (openPromises.length === 0 && capturedPromises.length > 0) {
const ending = capturedPromises.length > 1 ? 's' : '';
const message = `Consider removing this 'try' statement as promise${ending} rejection is already captured by '.catch()' method.`;
const token = context.sourceCode.getFirstToken(tryStmt);
(0, index_js_1.report)(context, {
message,
loc: token.loc,
}, capturedPromises.map(node => (0, index_js_1.toSecondaryLocation)(node, 'Caught promise')));
}
}
function isAwaitLike(callExpr) {
return (callExpr.parent &&
(callExpr.parent.type === 'AwaitExpression' || callExpr.parent.type === 'YieldExpression'));
}
function isThened(callExpr) {
return (callExpr.parent &&
callExpr.parent.type === 'MemberExpression' &&
callExpr.parent.property.type === 'Identifier' &&
callExpr.parent.property.name === 'then');
}
function isCaught(callExpr) {
return (callExpr.parent &&
callExpr.parent.type === 'MemberExpression' &&
callExpr.parent.property.type === 'Identifier' &&
callExpr.parent.property.name === 'catch');
}
function isCatch(callExpr) {
return (callExpr.type === 'CallExpression' &&
callExpr.callee.type === 'MemberExpression' &&
callExpr.callee.property.type === 'Identifier' &&
callExpr.callee.property.name === 'catch');
}