eslint-plugin-sonarjs/cjs/S9169/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/S9169/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 module_js_1 = require("../helpers/module.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const meta = __importStar(require("./generated-meta.js"));
const MESSAGE = 'Move this call to module scope or replace it with vi.doMock(); vi.mock is hoisted and cannot provide runtime or per-test mocking.';
const VITEST_MOCK_FQNS = new Set(['vitest.vi.mock', 'vitest.vitest.mock']);
const VITEST_NAMESPACE_MEMBERS = new Set(['vi', 'vitest']);
const VITEST_MODULES = ['vitest'];
exports.rule = {
    meta: (0, generate_meta_js_1.generateMeta)(meta),
    create(context) {
        return {
            CallExpression: (node) => {
                const call = node;
                if (isVitestMockCall(context, call) && !isDirectProgramExpression(context, call)) {
                    context.report({ node: call.callee, message: MESSAGE });
                }
            },
        };
    },
};
function isVitestMockCall(context, call) {
    if (call.callee.type !== 'MemberExpression' ||
        call.callee.computed ||
        ('optional' in call.callee && call.callee.optional === true) ||
        ('optional' in call && call.optional === true) ||
        !(0, ast_js_1.isIdentifier)(call.callee.property, 'mock')) {
        return false;
    }
    const fqn = (0, module_js_1.getFullyQualifiedName)(context, call);
    if (fqn !== null && VITEST_MOCK_FQNS.has(fqn)) {
        return true;
    }
    return isGlobalVitestNamespace(context, call.callee.object);
}
function isGlobalVitestNamespace(context, receiver) {
    if (receiver.type !== 'Identifier' || !VITEST_NAMESPACE_MEMBERS.has(receiver.name)) {
        return false;
    }
    const variable = (0, ast_js_1.getVariableFromName)(context, receiver.name, receiver);
    if (variable !== undefined && variable.defs.length > 0) {
        return false;
    }
    return (0, module_js_1.importsOrDependsOnModule)(context, VITEST_MODULES, VITEST_MODULES);
}
function isDirectProgramExpression(context, node) {
    const ancestors = context.sourceCode.getAncestors(node);
    const parent = ancestors.at(-1);
    const grandparent = parent ? context.sourceCode.getAncestors(parent).at(-1) : undefined;
    return (parent?.type === 'ExpressionStatement' &&
        parent.expression === node &&
        grandparent?.type === 'Program');
}