forked from typescript-eslint/typescript-eslint
/
no-misused-promises.ts
254 lines (229 loc) · 7.43 KB
/
no-misused-promises.ts
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
import { TSESLint, TSESTree } from '@typescript-eslint/experimental-utils';
import * as tsutils from 'tsutils';
import ts from 'typescript';
import * as util from '../util';
type Options = [
{
checks: ('conditional' | 'void-return')[];
}
];
export default util.createRule<Options, 'conditional' | 'voidReturn'>({
name: 'no-misused-promises',
meta: {
docs: {
description: 'Avoid using promises in places not designed to handle them',
category: 'Best Practices',
recommended: false,
},
messages: {
voidReturn:
'Promise returned in function argument where a void return was expected.',
conditional: 'Expected non-Promise value in a boolean conditional.',
},
schema: [
{
type: 'object',
properties: {
checks: {
type: 'array',
items: {
type: 'string',
enum: ['conditional', 'void-return'],
},
},
},
},
],
type: 'problem',
},
defaultOptions: [
{
checks: ['conditional', 'void-return'],
},
],
create(context, [{ checks }]) {
const parserServices = util.getParserServices(context);
const checker = parserServices.program.getTypeChecker();
const conditionalChecks: TSESLint.RuleListener = {
ConditionalExpression(node) {
checkConditional(node.test);
},
DoWhileStatement(node) {
checkConditional(node.test);
},
ForStatement(node) {
if (node.test) {
checkConditional(node.test);
}
},
IfStatement(node) {
checkConditional(node.test);
},
LogicalExpression(node) {
// We only check the lhs of a logical expression because the rhs might
// be the return value of a short circuit expression.
checkConditional(node.left);
},
UnaryExpression(node) {
if (node.operator === '!') {
checkConditional(node.argument);
}
},
WhileStatement(node) {
checkConditional(node.test);
},
};
const voidReturnChecks: TSESLint.RuleListener = {
CallExpression(node) {
checkArguments(node);
},
NewExpression(node) {
checkArguments(node);
},
};
function checkConditional(node: TSESTree.Expression) {
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(node);
if (isAlwaysThenable(checker, tsNode)) {
context.report({
messageId: 'conditional',
node,
});
}
}
function checkArguments(
node: TSESTree.CallExpression | TSESTree.NewExpression,
) {
const tsNode = parserServices.esTreeNodeToTSNodeMap.get<
ts.CallExpression | ts.NewExpression
>(node);
const voidParams = voidFunctionParams(checker, tsNode);
if (voidParams.size === 0) {
return;
}
for (const [index, argument] of node.arguments.entries()) {
if (!voidParams.has(index)) {
continue;
}
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(argument);
if (returnsThenable(checker, tsNode as ts.Expression)) {
context.report({
messageId: 'voidReturn',
node: argument,
});
}
}
}
return {
...(checks.includes('conditional') ? conditionalChecks : {}),
...(checks.includes('void-return') ? voidReturnChecks : {}),
};
},
});
// Variation on the thenable check which requires all forms of the type (read:
// alternates in a union) to be thenable. Otherwise, you might be trying to
// check if something is defined or undefined and get caught because one of the
// branches is thenable.
function isAlwaysThenable(checker: ts.TypeChecker, node: ts.Node) {
const type = checker.getTypeAtLocation(node);
outer: for (const subType of tsutils.unionTypeParts(
checker.getApparentType(type),
)) {
const thenProp = subType.getProperty('then');
// If one of the alternates has no then property, it is not thenable in all
// cases.
if (thenProp === undefined) {
return false;
}
// We walk through each variation of the then property. Since we know it
// exists at this point, we just need at least one of the alternates to
// be of the right form to consider it thenable.
const thenType = checker.getTypeOfSymbolAtLocation(thenProp, node);
for (const subType of tsutils.unionTypeParts(thenType)) {
for (const signature of subType.getCallSignatures()) {
if (
signature.parameters.length !== 0 &&
isFunctionParam(checker, signature.parameters[0], node)
) {
continue outer;
}
}
}
// If no flavors of the then property are thenable, we don't consider the
// overall type to be thenable
return false;
}
// If all variants are considered thenable (i.e. haven't returned false), we
// consider the overall type thenable
return true;
}
function isFunctionParam(
checker: ts.TypeChecker,
param: ts.Symbol,
node: ts.Node,
): boolean {
const type: ts.Type | undefined = checker.getApparentType(
checker.getTypeOfSymbolAtLocation(param, node),
);
for (const subType of tsutils.unionTypeParts(type)) {
if (subType.getCallSignatures().length !== 0) {
return true;
}
}
return false;
}
// Get the positions of parameters which are void functions (and not also
// thenable functions). These are the candidates for the void-return check at
// the current call site.
function voidFunctionParams(
checker: ts.TypeChecker,
node: ts.CallExpression | ts.NewExpression,
) {
const voidReturnIndices = new Set<number>();
const thenableReturnIndices = new Set<number>();
const type = checker.getTypeAtLocation(node.expression);
for (const subType of tsutils.unionTypeParts(type)) {
// Standard function calls and `new` have two different types of signatures
const signatures = ts.isCallExpression(node)
? subType.getCallSignatures()
: subType.getConstructSignatures();
for (const signature of signatures) {
for (const [index, parameter] of signature.parameters.entries()) {
const type = checker.getTypeOfSymbolAtLocation(
parameter,
node.expression,
);
for (const subType of tsutils.unionTypeParts(type)) {
for (const signature of subType.getCallSignatures()) {
const returnType = signature.getReturnType();
if (tsutils.isTypeFlagSet(returnType, ts.TypeFlags.Void)) {
voidReturnIndices.add(index);
} else if (
tsutils.isThenableType(checker, node.expression, returnType)
) {
thenableReturnIndices.add(index);
}
}
}
}
}
}
// If a certain positional argument accepts both thenable and void returns,
// a promise-returning function is valid
for (const thenable of thenableReturnIndices) {
voidReturnIndices.delete(thenable);
}
return voidReturnIndices;
}
// Returns true if the expression is a function that returns a thenable
function returnsThenable(checker: ts.TypeChecker, node: ts.Expression) {
const type = checker.getApparentType(checker.getTypeAtLocation(node));
for (const subType of tsutils.unionTypeParts(type)) {
for (const signature of subType.getCallSignatures()) {
const returnType = signature.getReturnType();
if (tsutils.isThenableType(checker, node, returnType)) {
return true;
}
}
}
return false;
}