Martin Kustermann
4ee6a66270
The change in [0] increased the language version of pkg/dart2wasm. That in return changes how the package is formatted by the autoformatter. This CL runs now the formatter to re-format the code. Unfortunately this makes blame lists worse. But not doing it will make us have to disable auto-formatting before saving files which is very annoying. [0] https://dart-review.googlesource.com/c/sdk/+/487944 Change-Id: I6953fe0d6a824b2b79a26bbadb0bb977cec70b7a Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/490821 Reviewed-by: Slava Egorov <vegorov@google.com> Commit-Queue: Martin Kustermann <kustermann@google.com>
329 lines
11 KiB
Dart
329 lines
11 KiB
Dart
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
import 'dart:io' show Platform;
|
|
|
|
import 'package:_js_interop_checks/js_interop_checks.dart';
|
|
import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
|
|
import 'package:analyzer/dart/analysis/results.dart';
|
|
import 'package:analyzer/diagnostic/diagnostic.dart';
|
|
import 'package:analyzer/src/dart/analysis/driver_based_analysis_context.dart';
|
|
import 'package:collection/collection.dart';
|
|
import 'package:front_end/src/api_prototype/codes.dart'
|
|
show Message, LocatedMessage;
|
|
import 'package:kernel/ast.dart';
|
|
import 'package:kernel/class_hierarchy.dart';
|
|
import 'package:kernel/core_types.dart';
|
|
import 'package:kernel/target/targets.dart' show DiagnosticReporter;
|
|
import 'package:linter/src/diagnostic.dart' as diag;
|
|
import 'package:linter/src/rules/avoid_double_and_int_checks.dart';
|
|
import 'package:linter/src/rules/invalid_runtime_check_with_js_interop_types.dart';
|
|
import 'package:path/path.dart' as p;
|
|
import 'target.dart' show allowedToImportDartFfiOrUsePragmas;
|
|
|
|
/// Used to record the type of error in Flutter telemetry.
|
|
///
|
|
/// DO NOT alter the numeric values or change the meaning of these entries.
|
|
///
|
|
/// It is MUCH better to add new values and deprecate old values.
|
|
/// Consider commenting out the old value line as a tombstone.
|
|
///
|
|
/// Please notify folks in charge of Flutter Web analytics before making any
|
|
/// changes.
|
|
enum _DryRunErrorCode {
|
|
noDartHtml(0),
|
|
noDartJs(1),
|
|
interopChecksError(2),
|
|
// 3, 4, 5 are tombstones. Don't reuse!
|
|
// isTestValueError(3),
|
|
// isTestTypeError(4),
|
|
// isTestGenericTypeError(5),
|
|
invalidRuntimeCheckWithJsInteropTypesDartAsJs(6),
|
|
invalidRuntimeCheckWithJsInteropTypesDartIsJs(7),
|
|
invalidRuntimeCheckWithJsInteropTypesJsAsDart(8),
|
|
invalidRuntimeCheckWithJsInteropTypesJsIsDart(9),
|
|
invalidRuntimeCheckWithJsInteropTypesJsAsIncompatibleJs(10),
|
|
invalidRuntimeCheckWithJsInteropTypesJsIsInconsistentJs(11),
|
|
invalidRuntimeCheckWithJsInteropTypesJsIsUnrelatedJs(12),
|
|
avoidDoubleAndIntChecks(13),
|
|
noPackageJs(14),
|
|
noDartJsUtil(15),
|
|
noDartFfiWithoutFlag(16),
|
|
invalidRuntimeCheckWithJsInteropTypesCatchClauseJsInteropType(17);
|
|
|
|
const _DryRunErrorCode(this.code);
|
|
|
|
final int code;
|
|
}
|
|
|
|
class _DryRunError {
|
|
final _DryRunErrorCode code;
|
|
final String problemMessage;
|
|
final Uri? errorSourceUri;
|
|
final Location? errorLocation;
|
|
|
|
_DryRunError(
|
|
this.code,
|
|
this.problemMessage, {
|
|
this.errorSourceUri,
|
|
this.errorLocation,
|
|
});
|
|
|
|
static String _locationToString(Uri? sourceUri, Location? location) {
|
|
if (sourceUri == null && location == null) return 'unknown location';
|
|
final uri = sourceUri ?? location?.file;
|
|
final lineCol = location != null
|
|
? ' ${location.line}:${location.column}'
|
|
: '';
|
|
return '$uri$lineCol';
|
|
}
|
|
|
|
@override
|
|
String toString() =>
|
|
'${_locationToString(errorSourceUri, errorLocation)} '
|
|
'- $problemMessage (${code.code})';
|
|
}
|
|
|
|
/// Runs several passes over the provided kernel to find any code in the
|
|
/// sources that could block a migration to WASM from JS.
|
|
///
|
|
/// At the end of execution, it emits a summary to stdout that looks like:
|
|
/// ```
|
|
/// Found incompatibilities with WebAssembly.
|
|
///
|
|
/// package:dryrun/test.dart 6:7 - JS interop class 'B' cannot extend Dart class 'A'. (2)
|
|
/// ````
|
|
class DryRunSummarizer {
|
|
final _avoidDoubleAndIntChecks = AvoidDoubleAndIntChecks();
|
|
final _invalidRuntimeCheckWithJSInteropTypes =
|
|
InvalidRuntimeCheckWithJSInteropTypes();
|
|
final Component component;
|
|
final bool enableExperimentalFfi;
|
|
late final CoreTypes coreTypes;
|
|
late final ClassHierarchy classHierarchy;
|
|
|
|
DryRunSummarizer(this.component, {required this.enableExperimentalFfi}) {
|
|
coreTypes = CoreTypes(component);
|
|
classHierarchy = ClassHierarchy(component, coreTypes);
|
|
}
|
|
|
|
static const Map<String, _DryRunErrorCode> _disallowedDartUris = {
|
|
'dart:html': _DryRunErrorCode.noDartHtml,
|
|
'dart:indexed_db': _DryRunErrorCode.noDartHtml,
|
|
'dart:js': _DryRunErrorCode.noDartJs,
|
|
'dart:js_util': _DryRunErrorCode.noDartJsUtil,
|
|
'dart:svg': _DryRunErrorCode.noDartHtml,
|
|
'dart:web_audio': _DryRunErrorCode.noDartHtml,
|
|
'dart:web_gl': _DryRunErrorCode.noDartHtml,
|
|
};
|
|
|
|
static const Map<String, _DryRunErrorCode> _disallowedPackageUris = {
|
|
'package:js/js.dart': _DryRunErrorCode.noPackageJs,
|
|
// Note that we use `noDartJsUtil` as this is just a re-export.
|
|
'package:js/js_util.dart': _DryRunErrorCode.noDartJsUtil,
|
|
};
|
|
|
|
bool _shouldSkipLibrary(Library library) {
|
|
if (library.importUri.scheme == 'dart') return true;
|
|
// Ignore any dry-run analysis within disallowed packages as we check
|
|
// imports of those separately.
|
|
return _disallowedPackageUris.containsKey(library.importUri.toString());
|
|
}
|
|
|
|
List<_DryRunError> _analyzeImports() {
|
|
final errors = <_DryRunError>[];
|
|
|
|
for (final library in component.libraries) {
|
|
final skipLibraryForFfiCheck =
|
|
allowedToImportDartFfiOrUsePragmas(library.importUri) ||
|
|
enableExperimentalFfi;
|
|
final skipLibraryForGeneralChecks = _shouldSkipLibrary(library);
|
|
|
|
for (final dep in library.dependencies) {
|
|
final depLib = dep.importedLibraryReference.asLibrary;
|
|
final depUriString = depLib.importUri.toString();
|
|
if (depUriString == 'dart:ffi') {
|
|
if (!skipLibraryForFfiCheck) {
|
|
errors.add(
|
|
_DryRunError(
|
|
_DryRunErrorCode.noDartFfiWithoutFlag,
|
|
'$depUriString unsupported without --enable-experimental-ffi',
|
|
errorSourceUri: library.importUri,
|
|
errorLocation: dep.location,
|
|
),
|
|
);
|
|
}
|
|
continue;
|
|
}
|
|
if (skipLibraryForGeneralChecks) continue;
|
|
var code =
|
|
_disallowedDartUris[depUriString] ??
|
|
_disallowedPackageUris[depUriString];
|
|
if (code != null) {
|
|
errors.add(
|
|
_DryRunError(
|
|
code,
|
|
'$depUriString unsupported',
|
|
errorSourceUri: library.importUri,
|
|
errorLocation: dep.location,
|
|
),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return errors;
|
|
}
|
|
|
|
List<_DryRunError> _interopChecks() {
|
|
final collector = _CollectingDiagnosticReporter(component);
|
|
final reporter = JsInteropDiagnosticReporter(collector);
|
|
// These checks will already have been done by the CFE but the message
|
|
// format the CFE provides for those errors makes it hard to identify them
|
|
// as interop-specific errors. Instead we rerun and collect any errors here.
|
|
component.accept(
|
|
JsInteropChecks(
|
|
coreTypes,
|
|
classHierarchy,
|
|
reporter,
|
|
JsInteropChecks.getNativeClasses(component),
|
|
isDart2Wasm: true,
|
|
),
|
|
);
|
|
return collector.errors;
|
|
}
|
|
|
|
Future<List<_DryRunError>> _lintChecks() async {
|
|
final errors = <_DryRunError>[];
|
|
|
|
final pathUriMap = <String, Uri>{};
|
|
for (final library in component.libraries) {
|
|
if (_shouldSkipLibrary(library)) continue;
|
|
final uri = library.fileUri;
|
|
pathUriMap[p.normalize(
|
|
p.absolute(uri.toFilePath(windows: Platform.isWindows)),
|
|
)] =
|
|
uri;
|
|
}
|
|
if (pathUriMap.isEmpty) return [];
|
|
|
|
final collection = AnalysisContextCollection(
|
|
includedPaths: pathUriMap.keys.toList(),
|
|
);
|
|
for (var context in collection.contexts) {
|
|
var allOptions =
|
|
(context as DriverBasedAnalysisContext).allAnalysisOptions;
|
|
for (var options in allOptions) {
|
|
options.lintRules = [
|
|
_avoidDoubleAndIntChecks,
|
|
_invalidRuntimeCheckWithJSInteropTypes,
|
|
];
|
|
options.lint = true;
|
|
}
|
|
|
|
for (var filePath in context.contextRoot.analyzedFiles()) {
|
|
final uri = pathUriMap[filePath]!;
|
|
var result = await context.currentSession.getErrors(filePath);
|
|
if (result is ErrorsResult) {
|
|
for (final diagnostic in result.diagnostics) {
|
|
final errorCode = _getDryRunErrorCodeFromDiagnostic(diagnostic);
|
|
if (errorCode != null) {
|
|
errors.add(
|
|
_DryRunError(
|
|
errorCode,
|
|
'${diagnostic.diagnosticCode.lowerCaseName} lint violation: '
|
|
'${diagnostic.message}',
|
|
errorSourceUri: uri,
|
|
errorLocation: component.getLocation(
|
|
uri,
|
|
diagnostic.problemMessage.offset,
|
|
),
|
|
),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
await collection.dispose();
|
|
return errors;
|
|
}
|
|
|
|
_DryRunErrorCode? _getDryRunErrorCodeFromDiagnostic(
|
|
Diagnostic diagnostic,
|
|
) => switch (diagnostic.diagnosticCode) {
|
|
diag.invalidRuntimeCheckWithJsInteropTypesCatchClauseJsInteropType =>
|
|
_DryRunErrorCode
|
|
.invalidRuntimeCheckWithJsInteropTypesCatchClauseJsInteropType,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesDartAsJs =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesDartAsJs,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesDartIsJs =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesDartIsJs,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesJsAsDart =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesJsAsDart,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesJsIsDart =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesJsIsDart,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesJsAsIncompatibleJs =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesJsAsIncompatibleJs,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesJsIsInconsistentJs =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesJsIsInconsistentJs,
|
|
diag.invalidRuntimeCheckWithJsInteropTypesJsIsUnrelatedJs =>
|
|
_DryRunErrorCode.invalidRuntimeCheckWithJsInteropTypesJsIsUnrelatedJs,
|
|
diag.avoidDoubleAndIntChecks => _DryRunErrorCode.avoidDoubleAndIntChecks,
|
|
_ => null,
|
|
};
|
|
|
|
Future<bool> summarize() async {
|
|
final errors = [
|
|
..._analyzeImports(),
|
|
..._interopChecks(),
|
|
...(await _lintChecks()),
|
|
// TODO(srujzs): Add additional number semantics incompatibility checks
|
|
// here.
|
|
];
|
|
|
|
if (errors.isNotEmpty) {
|
|
print('Found incompatibilities with WebAssembly.\n');
|
|
print(errors.join('\n'));
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
class _CollectingDiagnosticReporter
|
|
extends DiagnosticReporter<Message, LocatedMessage> {
|
|
final Component component;
|
|
final List<_DryRunError> errors = <_DryRunError>[];
|
|
|
|
_CollectingDiagnosticReporter(this.component);
|
|
|
|
@override
|
|
void report(
|
|
Message message,
|
|
int charOffset,
|
|
int length,
|
|
Uri? fileUri, {
|
|
List<LocatedMessage>? context,
|
|
}) {
|
|
final libraryUri = fileUri != null
|
|
? component.libraries
|
|
.firstWhereOrNull((e) => e.fileUri == fileUri)
|
|
?.importUri
|
|
: null;
|
|
final location = fileUri != null
|
|
? component.getLocation(fileUri, charOffset)
|
|
: null;
|
|
errors.add(
|
|
_DryRunError(
|
|
_DryRunErrorCode.interopChecksError,
|
|
message.problemMessage,
|
|
errorSourceUri: libraryUri ?? fileUri,
|
|
errorLocation: location,
|
|
),
|
|
);
|
|
}
|
|
}
|