prefer-find-by.js
15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getFindByQueryVariant = exports.WAIT_METHODS = 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 = 'prefer-find-by';
exports.WAIT_METHODS = ['waitFor', 'waitForElement', 'wait'];
function getFindByQueryVariant(queryMethod) {
return queryMethod.includes('All') ? 'findAllBy' : 'findBy';
}
exports.getFindByQueryVariant = getFindByQueryVariant;
function findRenderDefinitionDeclaration(scope, query) {
var _a;
if (!scope) {
return null;
}
const variable = scope.variables.find((v) => v.name === query);
if (variable) {
return ((_a = variable.defs
.map(({ name }) => name)
.filter(utils_1.ASTUtils.isIdentifier)
.find(({ name }) => name === query)) !== null && _a !== void 0 ? _a : null);
}
return findRenderDefinitionDeclaration(scope.upper, query);
}
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'suggestion',
docs: {
description: 'Suggest using `find(All)By*` query instead of `waitFor` + `get(All)By*` to wait for elements',
recommendedConfig: {
dom: 'error',
angular: 'error',
react: 'error',
vue: 'error',
marko: 'error',
},
},
messages: {
preferFindBy: 'Prefer `{{queryVariant}}{{queryMethod}}` query over using `{{waitForMethodName}}` + `{{prevQuery}}`',
},
fixable: 'code',
schema: [],
},
defaultOptions: [],
create(context, _, helpers) {
const sourceCode = context.getSourceCode();
function reportInvalidUsage(node, replacementParams) {
const { queryMethod, queryVariant, prevQuery, waitForMethodName, fix } = replacementParams;
context.report({
node,
messageId: 'preferFindBy',
data: {
queryVariant,
queryMethod,
prevQuery,
waitForMethodName,
},
fix,
});
}
function getWrongQueryNameInAssertion(node) {
if (!(0, node_utils_1.isCallExpression)(node.body) ||
!(0, node_utils_1.isMemberExpression)(node.body.callee)) {
return null;
}
if ((0, node_utils_1.isCallExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.arguments[0]) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.arguments[0].callee)) {
return node.body.callee.object.arguments[0].callee.name;
}
if (!utils_1.ASTUtils.isIdentifier(node.body.callee.property)) {
return null;
}
if ((0, node_utils_1.isCallExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.arguments[0].callee) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.arguments[0].callee.property)) {
return node.body.callee.object.arguments[0].callee.property.name;
}
if ((0, node_utils_1.isMemberExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.object.arguments[0].callee) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.object.arguments[0].callee.property)) {
return node.body.callee.object.object.arguments[0].callee.property.name;
}
if ((0, node_utils_1.isMemberExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object.arguments[0]) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.object.arguments[0].callee)) {
return node.body.callee.object.object.arguments[0].callee.name;
}
return node.body.callee.property.name;
}
function getWrongQueryName(node) {
if (!(0, node_utils_1.isCallExpression)(node.body)) {
return null;
}
if (utils_1.ASTUtils.isIdentifier(node.body.callee) &&
helpers.isSyncQuery(node.body.callee)) {
return node.body.callee.name;
}
return getWrongQueryNameInAssertion(node);
}
function getCaller(node) {
if (!(0, node_utils_1.isCallExpression)(node.body) ||
!(0, node_utils_1.isMemberExpression)(node.body.callee)) {
return null;
}
if (utils_1.ASTUtils.isIdentifier(node.body.callee.object)) {
return node.body.callee.object.name;
}
if ((0, node_utils_1.isCallExpression)(node.body.callee.object) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.callee) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.arguments[0].callee) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.arguments[0].callee.object)) {
return node.body.callee.object.arguments[0].callee.object.name;
}
if ((0, node_utils_1.isMemberExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.object.arguments[0].callee) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.object.arguments[0].callee.object)) {
return node.body.callee.object.object.arguments[0].callee.object.name;
}
return null;
}
function isSyncQuery(node) {
if (!(0, node_utils_1.isCallExpression)(node.body)) {
return false;
}
const isQuery = utils_1.ASTUtils.isIdentifier(node.body.callee) &&
helpers.isSyncQuery(node.body.callee);
const isWrappedInPresenceAssert = (0, node_utils_1.isMemberExpression)(node.body.callee) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.arguments[0]) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.arguments[0].callee) &&
helpers.isSyncQuery(node.body.callee.object.arguments[0].callee) &&
helpers.isPresenceAssert(node.body.callee);
const isWrappedInNegatedPresenceAssert = (0, node_utils_1.isMemberExpression)(node.body.callee) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object.arguments[0]) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.object.arguments[0].callee) &&
helpers.isSyncQuery(node.body.callee.object.object.arguments[0].callee) &&
helpers.isPresenceAssert(node.body.callee.object);
return (isQuery || isWrappedInPresenceAssert || isWrappedInNegatedPresenceAssert);
}
function isScreenSyncQuery(node) {
if (!(0, node_utils_1.isArrowFunctionExpression)(node) || !(0, node_utils_1.isCallExpression)(node.body)) {
return false;
}
if (!(0, node_utils_1.isMemberExpression)(node.body.callee) ||
!utils_1.ASTUtils.isIdentifier(node.body.callee.property)) {
return false;
}
if (!utils_1.ASTUtils.isIdentifier(node.body.callee.object) &&
!(0, node_utils_1.isCallExpression)(node.body.callee.object) &&
!(0, node_utils_1.isMemberExpression)(node.body.callee.object)) {
return false;
}
const isWrappedInPresenceAssert = helpers.isPresenceAssert(node.body.callee) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.arguments[0].callee) &&
utils_1.ASTUtils.isIdentifier(node.body.callee.object.arguments[0].callee.object);
const isWrappedInNegatedPresenceAssert = (0, node_utils_1.isMemberExpression)(node.body.callee.object) &&
helpers.isPresenceAssert(node.body.callee.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.body.callee.object.object.arguments[0]) &&
(0, node_utils_1.isMemberExpression)(node.body.callee.object.object.arguments[0].callee);
return (helpers.isSyncQuery(node.body.callee.property) ||
isWrappedInPresenceAssert ||
isWrappedInNegatedPresenceAssert);
}
function getQueryArguments(node) {
if ((0, node_utils_1.isMemberExpression)(node.callee) &&
(0, node_utils_1.isCallExpression)(node.callee.object) &&
(0, node_utils_1.isCallExpression)(node.callee.object.arguments[0])) {
return node.callee.object.arguments[0].arguments;
}
if ((0, node_utils_1.isMemberExpression)(node.callee) &&
(0, node_utils_1.isMemberExpression)(node.callee.object) &&
(0, node_utils_1.isCallExpression)(node.callee.object.object) &&
(0, node_utils_1.isCallExpression)(node.callee.object.object.arguments[0])) {
return node.callee.object.object.arguments[0].arguments;
}
return node.arguments;
}
return {
'AwaitExpression > CallExpression'(node) {
if (!utils_1.ASTUtils.isIdentifier(node.callee) ||
!helpers.isAsyncUtil(node.callee, exports.WAIT_METHODS)) {
return;
}
const argument = node.arguments[0];
if (!(0, node_utils_1.isArrowFunctionExpression)(argument) ||
!(0, node_utils_1.isCallExpression)(argument.body)) {
return;
}
const waitForMethodName = node.callee.name;
if (isScreenSyncQuery(argument)) {
const caller = getCaller(argument);
if (!caller) {
return;
}
const fullQueryMethod = getWrongQueryName(argument);
if (!fullQueryMethod) {
return;
}
const waitOptions = node.arguments[1];
let waitOptionsSourceCode = '';
if ((0, node_utils_1.isObjectExpression)(waitOptions)) {
waitOptionsSourceCode = `, ${sourceCode.getText(waitOptions)}`;
}
const queryVariant = getFindByQueryVariant(fullQueryMethod);
const callArguments = getQueryArguments(argument.body);
const queryMethod = fullQueryMethod.split('By')[1];
if (!queryMethod) {
return;
}
reportInvalidUsage(node, {
queryMethod,
queryVariant,
prevQuery: fullQueryMethod,
waitForMethodName,
fix(fixer) {
const property = argument.body
.callee.property;
if (helpers.isCustomQuery(property)) {
return null;
}
const newCode = `${caller}.${queryVariant}${queryMethod}(${callArguments
.map((callArgNode) => sourceCode.getText(callArgNode))
.join(', ')}${waitOptionsSourceCode})`;
return fixer.replaceText(node, newCode);
},
});
return;
}
if (!isSyncQuery(argument)) {
return;
}
const fullQueryMethod = getWrongQueryName(argument);
if (!fullQueryMethod) {
return;
}
const queryMethod = fullQueryMethod.split('By')[1];
const queryVariant = getFindByQueryVariant(fullQueryMethod);
const callArguments = getQueryArguments(argument.body);
reportInvalidUsage(node, {
queryMethod,
queryVariant,
prevQuery: fullQueryMethod,
waitForMethodName,
fix(fixer) {
if (helpers.isCustomQuery(argument.body
.callee)) {
return null;
}
const findByMethod = `${queryVariant}${queryMethod}`;
const allFixes = [];
const newCode = `${findByMethod}(${callArguments
.map((callArgNode) => sourceCode.getText(callArgNode))
.join(', ')})`;
allFixes.push(fixer.replaceText(node, newCode));
const definition = findRenderDefinitionDeclaration(context.getScope(), fullQueryMethod);
if (!definition) {
return allFixes;
}
if (definition.parent &&
(0, node_utils_1.isObjectPattern)(definition.parent.parent)) {
const allVariableDeclarations = definition.parent.parent;
if (allVariableDeclarations.properties.some((p) => (0, node_utils_1.isProperty)(p) &&
utils_1.ASTUtils.isIdentifier(p.key) &&
p.key.name === findByMethod)) {
return allFixes;
}
const textDestructuring = sourceCode.getText(allVariableDeclarations);
const text = textDestructuring.replace(/(\s*})$/, `, ${findByMethod}$1`);
allFixes.push(fixer.replaceText(allVariableDeclarations, text));
}
return allFixes;
},
});
},
};
},
});