eslint-plugin-sonarjs
Version:
115 lines (114 loc) • 4.56 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/S2925/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 cypress_js_1 = require("../helpers/cypress.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const test_file_pattern_js_1 = require("../helpers/test-file-pattern.js");
const meta = __importStar(require("./generated-meta.js"));
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, {
messages: {
fixedWait: 'Replace this fixed wait with a synchronization on an observable condition.',
},
}),
create(context) {
if (!(0, test_file_pattern_js_1.isTestRelatedFile)(context.filename, context.settings?.testFileExtensions)) {
return {};
}
return {
CallExpression(node) {
const call = node;
if (!(0, ast_js_1.isMethodCall)(call)) {
return;
}
const property = call.callee.property;
const methodName = property.name;
if (methodName === 'wait' && (0, cypress_js_1.chainStartsWithCy)(call.callee.object)) {
reportCypressWait(context, call, property);
}
else if (methodName === 'waitForTimeout' && (0, ast_js_1.isIdentifier)(call.callee.object, 'page')) {
reportFixedWait(context, property);
}
},
};
},
};
function reportCypressWait(context, call, reportNode) {
const [firstArgument] = call.arguments;
if (!firstArgument) {
return;
}
if (isNumericLiteralOrUnaryNumericLiteral(firstArgument)) {
reportFixedWait(context, reportNode);
return;
}
if (firstArgument.type === 'Identifier') {
const resolved = (0, ast_js_1.getUniqueWriteUsage)(context, firstArgument.name, firstArgument);
if (resolved && isNumericLiteralOrUnaryNumericLiteral(resolved)) {
reportFixedWait(context, reportNode);
}
}
}
function isNumericLiteralOrUnaryNumericLiteral(node) {
return ((0, ast_js_1.isNumberLiteral)(node) ||
(node.type === 'UnaryExpression' &&
(node.operator === '+' || node.operator === '-') &&
(0, ast_js_1.isNumberLiteral)(node.argument)));
}
function reportFixedWait(context, node) {
context.report({
node,
messageId: 'fixedWait',
});
}