This repository has been archived by the owner on Jul 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 258
/
unnecessary_nullable_analyzer.dart
305 lines (252 loc) · 9.26 KB
/
unnecessary_nullable_analyzer.dart
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
294
295
296
297
298
299
300
301
302
303
304
305
// ignore_for_file: deprecated_member_use
import 'dart:io';
import 'package:analyzer/dart/analysis/analysis_context.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/dart/element/nullability_suffix.dart';
// ignore: implementation_imports
import 'package:analyzer/src/dart/element/element.dart';
import 'package:collection/collection.dart';
import 'package:path/path.dart';
import 'package:source_span/source_span.dart';
import '../../config_builder/config_builder.dart';
import '../../config_builder/models/analysis_options.dart';
import '../../reporters/models/reporter.dart';
import '../../utils/analyzer_utils.dart';
import '../../utils/flutter_types_utils.dart';
import '../../utils/suppression.dart';
import 'declarations_visitor.dart';
import 'invocations_visitor.dart';
import 'models/invocations_usage.dart';
import 'models/unnecessary_nullable_file_report.dart';
import 'models/unnecessary_nullable_issue.dart';
import 'reporters/reporter_factory.dart';
import 'reporters/unnecessary_nullable_report_params.dart';
import 'unnecessary_nullable_analysis_config.dart';
import 'unnecessary_nullable_config.dart';
/// The analyzer responsible for collecting unnecessary nullable parameters reports.
class UnnecessaryNullableAnalyzer {
static const _ignoreName = 'unnecessary-nullable';
const UnnecessaryNullableAnalyzer();
/// Returns a reporter for the given [name]. Use the reporter
/// to convert analysis reports to console, JSON or other supported format.
Reporter<UnnecessaryNullableFileReport, void,
UnnecessaryNullableReportParams>? getReporter({
required String name,
required IOSink output,
}) =>
reporter(
name: name,
output: output,
);
/// Returns a list of unnecessary nullable parameters reports
/// for analyzing all files in the given [folders].
/// The analysis is configured with the [config].
Future<Iterable<UnnecessaryNullableFileReport>> runCliAnalysis(
Iterable<String> folders,
String rootFolder,
UnnecessaryNullableConfig config, {
String? sdkPath,
}) async {
final collection =
createAnalysisContextCollection(folders, rootFolder, sdkPath);
final invocationsUsages = InvocationsUsage();
final declarationsUsages = <String, DeclarationUsages>{};
for (final context in collection.contexts) {
final unnecessaryNullableAnalysisConfig =
_getAnalysisConfig(context, rootFolder, config);
final filePaths = getFilePaths(
folders,
context,
rootFolder,
unnecessaryNullableAnalysisConfig.globalExcludes,
);
final analyzedFiles =
filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
for (final filePath in analyzedFiles) {
final unit = await context.currentSession.getResolvedUnit(filePath);
final invocationsUsage = _analyzeInvocationsUsage(unit);
if (invocationsUsage != null) {
invocationsUsages.merge(invocationsUsage);
}
if (!unnecessaryNullableAnalysisConfig.analyzerExcludedPatterns
.any((pattern) => pattern.matches(filePath))) {
declarationsUsages[filePath] = _analyzeDeclarationsUsage(unit);
}
}
}
if (!config.isMonorepo) {
invocationsUsages.exports.forEach(declarationsUsages.remove);
}
return _getReports(invocationsUsages, declarationsUsages, rootFolder);
}
UnnecessaryNullableAnalysisConfig _getAnalysisConfig(
AnalysisContext context,
String rootFolder,
UnnecessaryNullableConfig config,
) {
final analysisOptions = analysisOptionsFromContext(context) ??
analysisOptionsFromFilePath(rootFolder, context);
final contextConfig =
ConfigBuilder.getUnnecessaryNullableConfigFromOption(analysisOptions)
.merge(config);
return ConfigBuilder.getUnnecessaryNullableConfig(
contextConfig,
rootFolder,
);
}
InvocationsUsage? _analyzeInvocationsUsage(SomeResolvedUnitResult unit) {
if (unit is ResolvedUnitResult) {
final visitor = InvocationsVisitor();
unit.unit.visitChildren(visitor);
return visitor.invocationsUsages;
}
return null;
}
DeclarationUsages _analyzeDeclarationsUsage(SomeResolvedUnitResult unit) {
if (unit is ResolvedUnitResult) {
final suppression = Suppression(unit.content, unit.lineInfo);
final isSuppressed = suppression.isSuppressed(_ignoreName);
if (isSuppressed) {
return {};
}
final visitor = DeclarationsVisitor(suppression, _ignoreName);
unit.unit.visitChildren(visitor);
return visitor.declarations;
}
return {};
}
Iterable<UnnecessaryNullableFileReport> _getReports(
InvocationsUsage invocationsUsage,
Map<String, DeclarationUsages> declarationsByPath,
String rootFolder,
) {
final unnecessaryNullableReports = <UnnecessaryNullableFileReport>[];
declarationsByPath.forEach((path, elements) {
final issues = <UnnecessaryNullableIssue>[];
for (final entry in elements.entries) {
final issue = _getUnnecessaryNullableIssues(
invocationsUsage,
entry.key,
entry.value,
);
if (issue != null) {
issues.add(issue);
}
}
final relativePath = relative(path, from: rootFolder);
if (issues.isNotEmpty) {
unnecessaryNullableReports.add(UnnecessaryNullableFileReport(
path: path,
relativePath: relativePath,
issues: issues,
));
}
});
return unnecessaryNullableReports;
}
UnnecessaryNullableIssue? _getUnnecessaryNullableIssues(
InvocationsUsage invocationsUsage,
Element element,
Iterable<FormalParameter> parameters,
) {
final usages = invocationsUsage.elements[element];
final unit = element.thisOrAncestorOfType<CompilationUnitElement>();
if (usages == null || unit == null) {
return null;
}
final markedParameters = <FormalParameter>{};
final notNamedParameters =
parameters.where((parameter) => !parameter.isNamed).toList();
for (final usage in usages) {
final namedArguments =
usage.arguments.whereType<NamedExpression>().toList();
final notNamedArguments =
usage.arguments.whereNot((arg) => arg is NamedExpression).toList();
for (final parameter in parameters) {
final relatedArgument = _findRelatedArgument(
parameter,
namedArguments,
notNamedArguments,
notNamedParameters,
);
if (relatedArgument == null ||
_shouldMarkParameterAsNullable(relatedArgument)) {
markedParameters.add(parameter);
}
}
}
final unnecessaryNullable = parameters.where(
(parameter) =>
!_shouldIgnoreWidgetKey(parameter) &&
!markedParameters.contains(parameter) &&
parameter.declaredElement?.type.nullabilitySuffix ==
NullabilitySuffix.question,
);
if (unnecessaryNullable.isEmpty) {
return null;
}
return _createUnnecessaryNullableIssue(
element as ElementImpl,
unit,
unnecessaryNullable,
);
}
Expression? _findRelatedArgument(
FormalParameter parameter,
List<Expression> namedArguments,
List<Expression> notNamedArguments,
List<FormalParameter> notNamedParameters,
) {
if (parameter.isNamed) {
return namedArguments.firstWhereOrNull((arg) =>
arg is NamedExpression &&
arg.name.label.name == parameter.identifier?.name);
}
final parameterIndex = notNamedParameters.indexOf(parameter);
return notNamedArguments
.whereNot((element) => element is NamedExpression)
.firstWhereIndexedOrNull((index, _) => index == parameterIndex);
}
bool _shouldMarkParameterAsNullable(Expression argument) {
if (argument is NamedExpression) {
return _shouldMarkParameterAsNullable(argument.expression);
}
final staticType = argument.staticType;
final isNullable = argument is NullLiteral ||
(staticType != null &&
(staticType.isDynamic ||
staticType.nullabilitySuffix == NullabilitySuffix.question));
return isNullable;
}
UnnecessaryNullableIssue _createUnnecessaryNullableIssue(
ElementImpl element,
CompilationUnitElement unit,
Iterable<FormalParameter> parameters,
) {
final offset = element.codeOffset!;
final lineInfo = unit.lineInfo;
final offsetLocation = lineInfo.getLocation(offset);
final sourceUrl = element.source!.uri;
return UnnecessaryNullableIssue(
declarationName: element.displayName,
declarationType: element.kind.displayName,
parameters: parameters.map((parameter) => parameter.toString()),
location: SourceLocation(
offset,
sourceUrl: sourceUrl,
line: offsetLocation.lineNumber,
column: offsetLocation.columnNumber,
),
);
}
bool _shouldIgnoreWidgetKey(FormalParameter parameter) {
final closestDeclaration = parameter.parent?.parent;
if (closestDeclaration is ConstructorDeclaration) {
return parameter.identifier?.name == 'key' &&
isWidgetOrSubclass(closestDeclaration.declaredElement?.returnType);
}
return false;
}
}