eslint-plugin-sonarjs/cjs/S8998/rule.js

SonarJS rules for ESLint

"use strict";
/*
 * 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/S8998/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 mocha_style_test_frameworks_js_1 = require("../helpers/testing/mocha-style-test-frameworks.js");
const meta = __importStar(require("./generated-meta.js"));
const messages = {
    emptyDataset: 'This parameterized test has no cases, so its body never runs.',
};
exports.rule = {
    meta: (0, generate_meta_js_1.generateMeta)(meta, { messages }),
    create(context) {
        const activeFrameworks = (0, mocha_style_test_frameworks_js_1.getParameterizedTestFrameworks)(context);
        if (!Object.values(activeFrameworks).some(Boolean)) {
            return {};
        }
        return {
            CallExpression(node) {
                const dataset = getDataset(node);
                if (dataset === undefined ||
                    !(0, mocha_style_test_frameworks_js_1.hasSupportedParameterizedCallback)(context, node) ||
                    node.arguments.length < 2 ||
                    !(0, mocha_style_test_frameworks_js_1.isSupportedParameterizedDeclaration)(context, node, activeFrameworks)) {
                    return;
                }
                if (isEmptyArray(dataset) || isKnownEmptyDataset(context, dataset)) {
                    context.report({ messageId: 'emptyDataset', node: dataset });
                }
            },
        };
    },
};
function getDataset(node) {
    if (node.callee.type !== 'CallExpression') {
        return undefined;
    }
    const { callee, arguments: args } = node.callee;
    if (callee.type !== 'MemberExpression' ||
        callee.computed ||
        callee.property.type !== 'Identifier' ||
        callee.property.name !== 'each' ||
        args.length === 0) {
        return undefined;
    }
    const [dataset] = args;
    return dataset?.type === 'SpreadElement' ? undefined : dataset;
}
function isEmptyArray(node) {
    if (node === null) {
        return false;
    }
    const unwrapped = (0, ast_js_1.unwrapTypeScriptExpression)(node);
    return unwrapped.type === 'ArrayExpression' && unwrapped.elements.length === 0;
}
function isKnownEmptyDataset(context, dataset) {
    if (dataset.type !== 'Identifier') {
        return false;
    }
    const scope = context.sourceCode.getScope(dataset);
    const variable = (0, ast_js_1.getVariableFromScope)(scope, dataset.name);
    if (variable?.scope.variableScope !== scope.variableScope) {
        return false;
    }
    const datasetStart = dataset.range?.[0];
    if (datasetStart === undefined) {
        return false;
    }
    const writes = variable.references.filter(reference => {
        const writeStart = reference.identifier.range?.[0];
        return (reference.isWrite() &&
            (writeStart === undefined ||
                writeStart < datasetStart ||
                reference.from.variableScope !== variable.scope.variableScope));
    });
    if (writes.length !== 1 || !isEmptyArray(writes[0].writeExpr)) {
        return false;
    }
    return hasNoInterveningReference(variable, writes[0], dataset);
}
function hasNoInterveningReference(variable, write, dataset) {
    const writeStart = write.identifier.range?.[0];
    const datasetStart = dataset.range?.[0];
    if (writeStart === undefined || datasetStart === undefined || writeStart >= datasetStart) {
        return false;
    }
    return !variable.references.some(reference => {
        const start = reference.identifier.range?.[0];
        return (reference !== write &&
            reference.identifier !== dataset &&
            (reference.from.variableScope !== variable.scope.variableScope ||
                (start !== undefined && writeStart < start && start < datasetStart)));
    });
}