eslint-plugin-sonarjs
Version:
182 lines (181 loc) • 6.95 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/S8932/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 ast_js_1 = require("../helpers/ast.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const module_js_1 = require("../helpers/module.js");
const meta = __importStar(require("./generated-meta.js"));
const supportedModules = new Set(['lodash', 'lodash-es', 'underscore']);
const methodName = 'memoize';
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, {
messages: {
provideResolver: 'Provide an explicit function to compute the cache key.',
},
}),
create(context) {
return {
CallExpression(node) {
const call = node;
const syntacticMethod = getSyntacticMethodName(call.callee);
if (syntacticMethod === undefined || hasResolver(call)) {
return;
}
const fqn = (0, module_js_1.getFullyQualifiedName)(context, call);
if (fqn === null || !isMemoizeCall(fqn, syntacticMethod)) {
return;
}
const memoizedFunction = resolveMemoizedFunction(context, call.arguments[0]);
if (memoizedFunction !== null && hasMultipleRuntimeParameters(memoizedFunction)) {
context.report({
node: getReportNode(call.callee),
messageId: 'provideResolver',
});
}
},
};
},
};
function hasResolver(call) {
const resolver = call.arguments[1];
if (resolver === undefined) {
return false;
}
if (resolver.type === 'SpreadElement') {
return true;
}
return !isMissingResolver(resolver);
}
function isMissingResolver(node) {
return (0, ast_js_1.isUndefined)(node) || (0, ast_js_1.isNullLiteral)(node) || isVoidExpression(node);
}
function isVoidExpression(node) {
return node.type === 'UnaryExpression' && node.operator === 'void';
}
function resolveMemoizedFunction(context, argument) {
if (argument === undefined || argument.type === 'SpreadElement') {
return null;
}
return ((0, ast_js_1.resolveFunction)(context, argument) ??
(0, ast_js_1.getValueOfExpression)(context, argument, 'ArrowFunctionExpression', true) ??
(0, ast_js_1.getValueOfExpression)(context, argument, 'FunctionExpression', true) ??
null);
}
function hasMultipleRuntimeParameters(functionNode) {
const runtimeParameters = functionNode.params.filter(parameter => !isThisParameter(parameter));
return (runtimeParameters.length >= 2 ||
runtimeParameters.some(parameter => parameter.type === 'RestElement'));
}
function isThisParameter(parameter) {
return (0, ast_js_1.isIdentifier)(parameter, 'this');
}
function getSyntacticMethodName(callee) {
if (callee.type === 'ChainExpression') {
return getSyntacticMethodName(callee.expression);
}
if (callee.type === 'MemberExpression') {
const propertyName = getPropertyName(callee);
if (propertyName === undefined) {
return undefined;
}
if (isCallResult(callee.object) && !(0, module_js_1.isRequire)(callee.object)) {
return undefined;
}
return propertyName === methodName ? methodName : undefined;
}
if (callee.type === 'Identifier' || callee.type === 'CallExpression') {
return null;
}
return undefined;
}
function getPropertyName(member) {
if (!member.computed && (0, ast_js_1.isIdentifier)(member.property)) {
return member.property.name;
}
if (member.computed &&
member.property.type === 'Literal' &&
typeof member.property.value === 'string') {
return member.property.value;
}
return undefined;
}
function isCallResult(node) {
if (node.type === 'ChainExpression') {
return isCallResult(node.expression);
}
return node.type === 'CallExpression';
}
function isMemoizeCall(fullyQualifiedName, syntacticMethod) {
const parts = fullyQualifiedName.replaceAll('/', '.').split('.');
if (parts.length !== 2) {
return false;
}
const [moduleName, qualifier] = parts;
return (supportedModules.has(moduleName) &&
qualifier === methodName &&
(syntacticMethod === null || qualifier === syntacticMethod));
}
function getReportNode(callee) {
if (callee.type === 'ChainExpression') {
return getReportNode(callee.expression);
}
if (callee.type === 'MemberExpression') {
if ((0, ast_js_1.isIdentifier)(callee.property)) {
return callee.property;
}
if (callee.computed && callee.property.type === 'Literal') {
return callee.property;
}
}
return callee;
}