the-forest/client/node_modules/eslint-plugin-testing-library/rules/await-async-query.js
2024-09-17 20:35:18 -04:00

84 lines
3.6 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
const utils_1 = require("@typescript-eslint/utils");
const create_testing_library_rule_1 = require("../create-testing-library-rule");
const node_utils_1 = require("../node-utils");
exports.RULE_NAME = 'await-async-query';
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'problem',
docs: {
description: 'Enforce promises from async queries to be handled',
recommendedConfig: {
dom: 'error',
angular: 'error',
react: 'error',
vue: 'error',
marko: 'error',
},
},
messages: {
awaitAsyncQuery: 'promise returned from `{{ name }}` query must be handled',
asyncQueryWrapper: 'promise returned from `{{ name }}` wrapper over async query must be handled',
},
schema: [],
},
defaultOptions: [],
create(context, _, helpers) {
const functionWrappersNames = [];
function detectAsyncQueryWrapper(node) {
const innerFunction = (0, node_utils_1.getInnermostReturningFunction)(context, node);
if (innerFunction) {
functionWrappersNames.push((0, node_utils_1.getFunctionName)(innerFunction));
}
}
return {
CallExpression(node) {
const identifierNode = (0, node_utils_1.getDeepestIdentifierNode)(node);
if (!identifierNode) {
return;
}
if (helpers.isAsyncQuery(identifierNode)) {
detectAsyncQueryWrapper(identifierNode);
const closestCallExpressionNode = (0, node_utils_1.findClosestCallExpressionNode)(node, true);
if (!(closestCallExpressionNode === null || closestCallExpressionNode === void 0 ? void 0 : closestCallExpressionNode.parent)) {
return;
}
const references = (0, node_utils_1.getVariableReferences)(context, closestCallExpressionNode.parent);
if (references.length === 0) {
if (!(0, node_utils_1.isPromiseHandled)(identifierNode)) {
context.report({
node: identifierNode,
messageId: 'awaitAsyncQuery',
data: { name: identifierNode.name },
});
return;
}
}
for (const reference of references) {
if (utils_1.ASTUtils.isIdentifier(reference.identifier) &&
!(0, node_utils_1.isPromiseHandled)(reference.identifier)) {
context.report({
node: identifierNode,
messageId: 'awaitAsyncQuery',
data: { name: identifierNode.name },
});
return;
}
}
}
else if (functionWrappersNames.includes(identifierNode.name) &&
!(0, node_utils_1.isPromiseHandled)(identifierNode)) {
context.report({
node: identifierNode,
messageId: 'asyncQueryWrapper',
data: { name: identifierNode.name },
});
}
},
};
},
});