eslint-plugin-sonarjs/cjs/S9153/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/S9153/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 testing_library_js_1 = require("../helpers/testing-library.js");
const meta = __importStar(require("./generated-meta.js"));
const messages = {
    throwingQuery: 'Use a queryBy* callback so waitForElementToBeRemoved can report a clear error when the element is already absent.',
    asyncQuery: 'A findBy* query returns a promise, not the element required by this disappearance wait.',
};
exports.rule = {
    meta: (0, generate_meta_js_1.generateMeta)(meta, { messages, fixable: 'code' }),
    create(context) {
        if (!(0, testing_library_js_1.importsTestingLibrary)(context)) {
            return {};
        }
        return {
            CallExpression(node) {
                if (node.type !== 'CallExpression' ||
                    !isTestingLibraryBinding(context, node.callee, 'waitForElementToBeRemoved')) {
                    return;
                }
                const firstArgument = node.arguments[0];
                if (!firstArgument || firstArgument.type === 'SpreadElement') {
                    return;
                }
                const directQuery = getQuery(context, firstArgument);
                if (directQuery) {
                    if (directQuery.kind === 'find') {
                        report(context, directQuery, 'asyncQuery');
                    }
                    return;
                }
                const callbackQuery = getSimpleCallbackQuery(context, firstArgument);
                if (!callbackQuery) {
                    return;
                }
                report(context, callbackQuery, callbackQuery.kind === 'get' ? 'throwingQuery' : 'asyncQuery');
            },
        };
    },
};
function getSimpleCallbackQuery(context, node) {
    if ((node.type !== 'ArrowFunctionExpression' && node.type !== 'FunctionExpression') ||
        node.async ||
        node.generator) {
        return null;
    }
    if (node.body.type !== 'BlockStatement') {
        return getQuery(context, node.body);
    }
    if (node.body.body.length !== 1) {
        return null;
    }
    const [statement] = node.body.body;
    if (statement.type !== 'ReturnStatement' || !statement.argument) {
        return null;
    }
    return getQuery(context, statement.argument);
}
function getQuery(context, node) {
    node = (0, ast_js_1.unwrapTypeScriptExpression)(node);
    if (node.type !== 'CallExpression' ||
        !(0, ast_js_1.isDotNotation)(node.callee) ||
        !isTestingLibraryBinding(context, node.callee.object, 'screen')) {
        return null;
    }
    if (/^get(All)?By[A-Z]/.test(node.callee.property.name)) {
        return { kind: 'get', method: node.callee.property };
    }
    if (/^find(All)?By[A-Z]/.test(node.callee.property.name)) {
        return { kind: 'find', method: node.callee.property };
    }
    return null;
}
function isTestingLibraryBinding(context, node, importedName) {
    return (0, testing_library_js_1.isDirectTestingLibraryBinding)(context, node, importedName, {
        allowNamespaceImport: true,
        allowSubpathImport: true,
    });
}
function report(context, query, messageId) {
    context.report({
        node: query.method,
        messageId,
        fix: query.kind === 'get'
            ? (fixer) => fixer.replaceText(query.method, query.method.name.replace(/^get/, 'query'))
            : null,
    });
}