eslint-plugin-sonarjs
Version:
319 lines (318 loc) • 11.4 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) SonarSource Sàrl
* mailto:info AT sonarsource DOT com
*
* You can redistribute and/or modify this program under the terms of
* the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
*
* 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/S9339/javascript
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const ast_js_1 = require("../helpers/ast.js");
const module_js_1 = require("../helpers/module.js");
const meta = __importStar(require("./generated-meta.js"));
const AXIOS_MODULE = 'axios';
const AXIOS_ALL = `${AXIOS_MODULE}.all`;
const AXIOS_SPREAD = `${AXIOS_MODULE}.spread`;
const AXIOS_CANCEL_TOKEN = `${AXIOS_MODULE}.CancelToken`;
const AXIOS_CANCEL_TOKEN_SOURCE = `${AXIOS_CANCEL_TOKEN}.source`;
// Positions of the request config argument. The callable axios instance accepts
// either a config object or a URL followed by a config object; body-taking methods
// put the config after the payload.
const AXIOS_CONFIG_ARGUMENT_INDICES = new Map([
[AXIOS_MODULE, [0, 1]],
[`${AXIOS_MODULE}.request`, [0]],
[`${AXIOS_MODULE}.get`, [1]],
[`${AXIOS_MODULE}.delete`, [1]],
[`${AXIOS_MODULE}.head`, [1]],
[`${AXIOS_MODULE}.options`, [1]],
[`${AXIOS_MODULE}.post`, [2]],
[`${AXIOS_MODULE}.put`, [2]],
[`${AXIOS_MODULE}.patch`, [2]],
]);
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, {
hasSuggestions: true,
messages: {
deprecatedHelper: '{{symbol}} is a deprecated Axios helper; {{alternative}} is the native equivalent.',
cancelToken: 'CancelToken is a deprecated Axios API; AbortController is the standard cancellation mechanism.',
suggestAll: 'Replace axios.all() with Promise.all().',
suggestSpread: 'Replace axios.spread() with array destructuring.',
},
}),
create(context) {
return {
CallExpression(node) {
visitCallExpression(context, node);
},
NewExpression(node) {
visitNewExpression(context, node);
},
MemberExpression(node) {
visitMemberExpression(context, node);
},
Property(node) {
visitCancelTokenProperty(context, node);
},
};
},
};
function visitCallExpression(context, call) {
if (hasComputedMember(call.callee) || isCallOfCall(call)) {
return;
}
const fqn = (0, module_js_1.getFullyQualifiedName)(context, call);
if (fqn === AXIOS_ALL) {
reportHelper(context, call, 'axios.all()', 'Promise.all()');
return;
}
if (fqn === AXIOS_SPREAD) {
reportHelper(context, call, 'axios.spread()', 'array destructuring');
return;
}
if (fqn === AXIOS_CANCEL_TOKEN_SOURCE) {
context.report({
node: getCancelTokenSourceReportNode(call.callee),
messageId: 'cancelToken',
});
}
}
function visitNewExpression(context, expression) {
if (hasComputedMember(expression.callee)) {
return;
}
if ((0, module_js_1.getFullyQualifiedName)(context, expression) !== AXIOS_CANCEL_TOKEN) {
return;
}
context.report({
node: getCancelTokenConstructReportNode(expression.callee),
messageId: 'cancelToken',
});
}
function visitMemberExpression(context, member) {
if (member.computed || (0, module_js_1.getFullyQualifiedName)(context, member) !== AXIOS_CANCEL_TOKEN) {
return;
}
if (isCancelTokenMemberCoveredByCallOrConstruct(context, member)) {
return;
}
context.report({
node: getMemberProperty(member),
messageId: 'cancelToken',
});
}
function visitCancelTokenProperty(context, property) {
if (property.computed || !isCancelTokenKey(property.key)) {
return;
}
const argument = getDirectArgumentCall(context, property);
if (argument === null) {
return;
}
const fqn = (0, module_js_1.getFullyQualifiedName)(context, argument.call);
if (fqn === null || !AXIOS_CONFIG_ARGUMENT_INDICES.get(fqn)?.includes(argument.index)) {
return;
}
context.report({
node: property.key,
messageId: 'cancelToken',
});
}
function reportHelper(context, call, symbol, alternative) {
const reportNode = getCalleeReportNode(call.callee);
context.report({
node: reportNode,
messageId: 'deprecatedHelper',
data: { symbol, alternative },
suggest: getHelperSuggestions(context, call, symbol),
});
}
function getHelperSuggestions(context, call, symbol) {
if (symbol === 'axios.all()') {
return isPromiseShadowed(context, call)
? []
: [
{
messageId: 'suggestAll',
fix: (fixer) => fixer.replaceText(call.callee, 'Promise.all'),
},
];
}
const spreadFix = getSpreadFix(context, call);
return spreadFix === null
? []
: [
{
messageId: 'suggestSpread',
fix: spreadFix,
},
];
}
function getSpreadFix(context, call) {
const callback = call.arguments[0];
if (callback?.type !== 'ArrowFunctionExpression') {
return null;
}
const rewritten = rewriteSpreadCallback(context, callback);
if (rewritten === null) {
return null;
}
return (fixer) => fixer.replaceText(call, rewritten);
}
function rewriteSpreadCallback(context, callback) {
if (hasTypeAnnotations(callback) ||
callback.params.length === 0 ||
!callback.params.every(isSimpleIdentifierParam)) {
return null;
}
const names = callback.params.map((param) => param.name);
const pattern = `[${names.join(', ')}]`;
const prefix = callback.async ? 'async ' : '';
return `(${prefix}(${pattern}) => ${formatArrowBody(context, callback)})`;
}
function formatArrowBody(context, callback) {
const bodyText = context.sourceCode.getText(callback.body);
return callback.body.type === 'BlockStatement' ? bodyText : `(${bodyText})`;
}
function isSimpleIdentifierParam(param) {
if (param.type !== 'Identifier') {
return false;
}
const tsParam = param;
return tsParam.typeAnnotation === undefined;
}
// The suggestion rebuilds the arrow from param names and body text, so any type syntax
// living outside those two parts would be silently dropped.
function hasTypeAnnotations(callback) {
const tsCallback = callback;
return tsCallback.returnType !== undefined || tsCallback.typeParameters !== undefined;
}
function isCallOfCall(call) {
return unwrapChain(call.callee).type === 'CallExpression';
}
function unwrapChain(node) {
return node.type === 'ChainExpression' ? unwrapChain(node.expression) : node;
}
function isPromiseShadowed(context, node) {
const variable = (0, ast_js_1.getVariableFromName)(context, 'Promise', node);
return variable !== undefined && variable.defs.length > 0;
}
function hasComputedMember(node) {
if (node.type === 'ChainExpression') {
return hasComputedMember(node.expression);
}
if (node.type === 'MemberExpression') {
return node.computed || hasComputedMember(node.object);
}
return false;
}
function getCalleeReportNode(callee) {
if (callee.type === 'ChainExpression') {
return getCalleeReportNode(callee.expression);
}
if (callee.type === 'MemberExpression') {
return getMemberProperty(callee);
}
return callee;
}
function getCancelTokenSourceReportNode(callee) {
if (callee.type === 'ChainExpression') {
return getCancelTokenSourceReportNode(callee.expression);
}
if (callee.type === 'MemberExpression') {
if (callee.object.type === 'MemberExpression') {
return getMemberProperty(callee.object);
}
return callee.object;
}
return callee;
}
function getCancelTokenConstructReportNode(callee) {
if (callee.type === 'MemberExpression') {
return getMemberProperty(callee);
}
return callee;
}
function getMemberProperty(member) {
return member.property;
}
function isCancelTokenMemberCoveredByCallOrConstruct(context, member) {
const parent = getParent(context, member);
if (parent === undefined) {
return false;
}
if (parent.type === 'NewExpression' && parent.callee === member) {
return true;
}
if (parent.type === 'MemberExpression' &&
parent.object === member &&
!parent.computed &&
(0, ast_js_1.isIdentifier)(parent.property, 'source')) {
const grandParent = getParent(context, parent);
return grandParent?.type === 'CallExpression' && grandParent.callee === parent;
}
return false;
}
function getDirectArgumentCall(context, property) {
const objectExpression = getParent(context, property);
if (objectExpression?.type !== 'ObjectExpression') {
return null;
}
const call = getParent(context, objectExpression);
if (call?.type !== 'CallExpression') {
return null;
}
const index = call.arguments.indexOf(objectExpression);
return index === -1 ? null : { call, index };
}
function isCancelTokenKey(key) {
return ((0, ast_js_1.isIdentifier)(key, 'cancelToken') || (key.type === 'Literal' && key.value === 'cancelToken'));
}
function getParent(context, node) {
const ancestors = context.sourceCode.getAncestors(node);
return ancestors.at(-1);
}