analyzer: Deprecate AnalysisError in favor of Diagnostic

Work towards #60635

Change-Id: If9bbc96beed95129b099588c5bd9728afda8e392
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/426902
Reviewed-by: Nate Bosch <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Bob Nystrom <[email protected]>
Reviewed-by: Paul Berry <[email protected]>

Author: srawlins

pkg/analysis_server/test/src/services/correction/fix/merge_combinators_test.dart

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/error/codes.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
@@ -554,8 +555,8 @@ import 'other.dart' show FutureOr, Completer, Timer;
 }
 
 abstract class _MergeCombinatorTest extends FixProcessorErrorCodeTest {
-  bool diagnosticCodeFilter(AnalysisError e) {
-    return e.errorCode == diagnosticCode;
+  bool diagnosticCodeFilter(Diagnostic d) {
+    return d.errorCode == diagnosticCode;
   }
 
   @override

pkg/analyzer/CHANGELOG.md

@@ -8,6 +8,7 @@
 * Deprecate `XyzElement2` classes; use `XyzElement` instead.
 * Deprecate `AnalysisError.correction` field; use
   `AnalysisError.correctionMessage` instead.
+* Deprecate `AnalysisError`; use `Diagnostic` instead.
 * Deprecate `ErrorCode`; use `DiagnosticCode` instead.
 * Deprecate `ErrorSeverity`; use `DiagnosticSeverity` instead.
 * Deprecate `ErrorType`; use `DiagnosticType` instead.

pkg/analyzer/api.txt

@@ -4415,7 +4415,7 @@ package:analyzer/error/error.dart:
     type (getter: DiagnosticType)
     url (getter: String?)
     == (method: bool Function(Object))
-  AnalysisError (type alias for Diagnostic)
+  AnalysisError (type alias for Diagnostic, deprecated)
   ErrorCode (type alias for DiagnosticCode, deprecated)
   ErrorSeverity (type alias for DiagnosticSeverity, deprecated)
   ErrorType (type alias for DiagnosticType, deprecated)

pkg/analyzer/lib/dart/analysis/results.dart

@@ -8,7 +8,7 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type_provider.dart';
 import 'package:analyzer/dart/element/type_system.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:meta/meta.dart';
@@ -27,7 +27,7 @@ abstract class AnalysisResult {
 /// Clients may not extend, implement or mix-in this class.
 abstract class AnalysisResultWithErrors implements FileResult {
   /// The analysis errors that were computed during analysis.
-  List<AnalysisError> get errors;
+  List<Diagnostic> get errors;
 }
 
 /// The type of [InvalidResult] returned when the given URI cannot be resolved.
@@ -253,7 +253,7 @@ abstract class ParseStringResult {
   String get content;
 
   /// The analysis errors that were computed during analysis.
-  List<AnalysisError> get errors;
+  List<Diagnostic> get errors;
 
   /// Information about lines in the content.
   LineInfo get lineInfo;

pkg/analyzer/lib/dart/element/element.dart

@@ -54,7 +54,7 @@ import 'package:analyzer/dart/element/scope.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/dart/element/type_provider.dart';
 import 'package:analyzer/dart/element/type_system.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/dart/constant/evaluation.dart';
@@ -705,7 +705,7 @@ abstract class ElementAnnotation implements ConstantEvaluationTarget {
   ///
   /// If a value has been produced but no errors were generated, then the
   /// list will be empty.
-  List<AnalysisError>? get constantEvaluationErrors;
+  List<Diagnostic>? get constantEvaluationErrors;
 
   /// Returns the element referenced by this annotation.
   ///

pkg/analyzer/lib/error/error.dart

@@ -57,4 +57,5 @@ HashMap<String, DiagnosticCode> _computeUniqueNameToCodeMap() {
 }
 
 /// A deprecated name for [Diagnostic]. Please use [Diagnostic].
+@Deprecated("Use 'Diagnostic' instead.")
 typedef AnalysisError = Diagnostic;

pkg/analyzer/lib/error/listener.dart

@@ -16,15 +16,15 @@ import 'package:analyzer/src/utilities/extensions/collection.dart';
 import 'package:meta/meta.dart';
 import 'package:source_span/source_span.dart';
 
-/// An object that listens for [AnalysisError]s being produced by the analysis
+/// An object that listens for [Diagnostic]s being produced by the analysis
 /// engine.
 abstract class AnalysisErrorListener {
   /// An error listener that ignores errors that are reported to it.
   static final AnalysisErrorListener NULL_LISTENER = _NullErrorListener();
 
   /// This method is invoked when an [error] has been found by the analysis
   /// engine.
-  void onError(AnalysisError error);
+  void onError(Diagnostic error);
 }
 
 /// An [AnalysisErrorListener] that keeps track of whether any error has been
@@ -37,7 +37,7 @@ class BooleanErrorListener implements AnalysisErrorListener {
   bool get errorReported => _errorReported;
 
   @override
-  void onError(AnalysisError error) {
+  void onError(Diagnostic error) {
     _errorReported = true;
   }
 }
@@ -182,7 +182,7 @@ class ErrorReporter {
     contextMessages ??= [];
     contextMessages.addAll(convertTypeNames(arguments));
     _errorListener.onError(
-      AnalysisError.tmp(
+      Diagnostic.tmp(
         source: _source,
         offset: offset,
         length: length,
@@ -233,42 +233,42 @@ class ErrorReporter {
   }
 
   /// Report the given [error].
-  void reportError(AnalysisError error) {
+  void reportError(Diagnostic error) {
     _errorListener.onError(error);
   }
 }
 
 /// An error listener that will record the errors that are reported to it in a
 /// way that is appropriate for caching those errors within an analysis context.
 class RecordingErrorListener implements AnalysisErrorListener {
-  Set<AnalysisError>? _errors;
+  Set<Diagnostic>? _errors;
 
   /// Return the errors collected by the listener.
-  List<AnalysisError> get errors {
+  List<Diagnostic> get errors {
     if (_errors == null) {
       return const [];
     }
     return _errors!.toList();
   }
 
   /// Return the errors collected by the listener for the given [source].
-  List<AnalysisError> getErrorsForSource(Source source) {
+  List<Diagnostic> getErrorsForSource(Source source) {
     if (_errors == null) {
       return const [];
     }
     return _errors!.where((error) => error.source == source).toList();
   }
 
   @override
-  void onError(AnalysisError error) {
+  void onError(Diagnostic error) {
     (_errors ??= {}).add(error);
   }
 }
 
 /// An [AnalysisErrorListener] that ignores error.
 class _NullErrorListener implements AnalysisErrorListener {
   @override
-  void onError(AnalysisError event) {
+  void onError(Diagnostic event) {
     // Ignore errors
   }
 }

pkg/analyzer_cli/lib/src/analyzer_impl.dart

@@ -6,6 +6,7 @@ import 'dart:io';
 
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
@@ -182,8 +183,8 @@ class AnalyzerImpl {
     return computeMaxErrorSeverity();
   }
 
-  DiagnosticSeverity? _defaultSeverityProcessor(AnalysisError error) =>
-      determineProcessedSeverity(error, options, analysisOptions);
+  DiagnosticSeverity? _defaultSeverityProcessor(Diagnostic diagnostic) =>
+      determineProcessedSeverity(diagnostic, options, analysisOptions);
 
   /// Returns true if we want to report diagnostics for this library.
   bool _isAnalyzedLibrary(LibraryElement library) {

pkg/analyzer_cli/lib/src/driver.dart

@@ -6,6 +6,7 @@ import 'dart:io' as io;
 
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/sdk/build_sdk_summary.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
@@ -180,11 +181,11 @@ class Driver implements CommandLineStarter {
     // Note: This references analysisDriver via closure, so it will change over
     // time during the following analysis.
     SeverityProcessor defaultSeverityProcessor;
-    defaultSeverityProcessor = (AnalysisError error) {
-      var filePath = error.source.fullName;
+    defaultSeverityProcessor = (Diagnostic diagnostic) {
+      var filePath = diagnostic.source.fullName;
       var file = analysisDriver!.resourceProvider.getFile(filePath);
       return determineProcessedSeverity(
-        error,
+        diagnostic,
         options,
         analysisDriver!.getAnalysisOptionsForFile(file),
       );
@@ -307,7 +308,7 @@ class Driver implements CommandLineStarter {
             }
           }
         } else if (file_paths.isPubspecYaml(pathContext, path)) {
-          var errors = <AnalysisError>[];
+          var diagnostics = <Diagnostic>[];
           try {
             var file = resourceProvider.getFile(path);
             var analysisOptions = analysisDriver.currentSession.analysisContext
@@ -316,7 +317,7 @@ class Driver implements CommandLineStarter {
             var node = loadYamlNode(content, sourceUrl: file.toUri());
 
             if (node is YamlMap) {
-              errors.addAll(
+              diagnostics.addAll(
                 validatePubspec(
                   contents: node,
                   source: FileSource(file),
@@ -325,8 +326,8 @@ class Driver implements CommandLineStarter {
                 ),
               );
             }
-            if (errors.isNotEmpty) {
-              for (var error in errors) {
+            if (diagnostics.isNotEmpty) {
+              for (var error in diagnostics) {
                 var severity =
                     determineProcessedSeverity(
                       error,
@@ -345,7 +346,7 @@ class Driver implements CommandLineStarter {
                   lineInfo: lineInfo,
                   isLibrary: true,
                   isPart: false,
-                  errors: errors,
+                  errors: diagnostics,
                   analysisOptions: analysisOptions,
                 ),
               ]);

pkg/analyzer_cli/lib/src/error_formatter.dart

@@ -5,6 +5,7 @@
 import 'dart:convert';
 
 import 'package:analyzer/dart/analysis/results.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/dart/analysis/driver_based_analysis_context.dart';
@@ -28,13 +29,13 @@ String _relative(String file) {
   return file.startsWith(path.current) ? path.relative(file) : file;
 }
 
-/// Returns the given error's severity.
-DiagnosticSeverity _severityIdentity(AnalysisError error) =>
-    error.errorCode.errorSeverity;
+/// Returns the given diagnostic's severity.
+DiagnosticSeverity _severityIdentity(Diagnostic diagnostic) =>
+    diagnostic.errorCode.errorSeverity;
 
-/// Returns desired severity for the given [error] (or `null` if it's to be
+/// Returns desired severity for the given [diagnostic] (or `null` if it's to be
 /// suppressed).
-typedef SeverityProcessor = DiagnosticSeverity? Function(AnalysisError error);
+typedef SeverityProcessor = DiagnosticSeverity? Function(Diagnostic diagnostic);
 
 /// Analysis statistics counter.
 class AnalysisStats {
@@ -103,7 +104,7 @@ class AnalysisStats {
   }
 }
 
-/// An [AnalysisError] with line and column information.
+/// A [Diagnostic] with line and column information.
 class CLIError implements Comparable<CLIError> {
   final String severity;
   final String sourcePath;
@@ -174,7 +175,7 @@ class ContextMessage {
   ContextMessage(this.filePath, this.message, this.line, this.column);
 }
 
-/// Helper for formatting [AnalysisError]s.
+/// Helper for formatting [Diagnostic]s.
 ///
 /// The two format options are a user consumable format and a machine consumable
 /// format.
@@ -194,34 +195,34 @@ abstract class ErrorFormatter {
   /// Call to write any batched up errors from [formatErrors].
   void flush();
 
-  Future<void> formatError(
-    Map<AnalysisError, ErrorsResult> errorToLine,
-    AnalysisError error,
+  Future<void> formatDiagnostic(
+    Map<Diagnostic, ErrorsResult> errorToLine,
+    Diagnostic error,
   );
 
   Future<void> formatErrors(List<ErrorsResult> results) async {
     stats.unfilteredCount += results.length;
 
-    var errors = <AnalysisError>[];
-    var errorToLine = <AnalysisError, ErrorsResult>{};
+    var diagnostics = <Diagnostic>[];
+    var diagnosticToLine = <Diagnostic, ErrorsResult>{};
     for (var result in results) {
       for (var error in result.errors) {
         if (_computeSeverity(error) != null) {
-          errors.add(error);
-          errorToLine[error] = result;
+          diagnostics.add(error);
+          diagnosticToLine[error] = result;
         }
       }
     }
 
-    for (var error in errors) {
-      await formatError(errorToLine, error);
+    for (var error in diagnostics) {
+      await formatDiagnostic(diagnosticToLine, error);
     }
   }
 
-  /// Compute the severity for this [error] or `null` if this error should be
-  /// filtered.
-  DiagnosticSeverity? _computeSeverity(AnalysisError error) =>
-      _severityProcessor(error);
+  /// Compute the severity for this [diagnostic] or `null` if this error should
+  /// be filtered.
+  DiagnosticSeverity? _computeSeverity(Diagnostic diagnostic) =>
+      _severityProcessor(diagnostic);
 }
 
 class HumanErrorFormatter extends ErrorFormatter {
@@ -287,9 +288,9 @@ class HumanErrorFormatter extends ErrorFormatter {
   }
 
   @override
-  Future<void> formatError(
-    Map<AnalysisError, ErrorsResult> errorToLine,
-    AnalysisError error,
+  Future<void> formatDiagnostic(
+    Map<Diagnostic, ErrorsResult> errorToLine,
+    Diagnostic error,
   ) async {
     var source = error.source;
     var result = errorToLine[error]!;
@@ -369,9 +370,9 @@ class JsonErrorFormatter extends ErrorFormatter {
   void flush() {}
 
   @override
-  Future<void> formatError(
-    Map<AnalysisError, ErrorsResult> errorToLine,
-    AnalysisError error,
+  Future<void> formatDiagnostic(
+    Map<Diagnostic, ErrorsResult> errorToLine,
+    Diagnostic error,
   ) async {
     throw UnsupportedError('Cannot format a single error');
   }
@@ -461,7 +462,7 @@ class MachineErrorFormatter extends ErrorFormatter {
   static final int _slashCodeUnit = '\\'.codeUnitAt(0);
   static final int _newline = '\n'.codeUnitAt(0);
   static final int _return = '\r'.codeUnitAt(0);
-  final Set<AnalysisError> _seenErrors = <AnalysisError>{};
+  final Set<Diagnostic> _seenDiagnostics = <Diagnostic>{};
 
   MachineErrorFormatter(
     super.out,
@@ -474,12 +475,12 @@ class MachineErrorFormatter extends ErrorFormatter {
   void flush() {}
 
   @override
-  Future<void> formatError(
-    Map<AnalysisError, ErrorsResult> errorToLine,
-    AnalysisError error,
+  Future<void> formatDiagnostic(
+    Map<Diagnostic, ErrorsResult> errorToLine,
+    Diagnostic error,
   ) async {
     // Ensure we don't over-report (#36062).
-    if (!_seenErrors.add(error)) {
+    if (!_seenDiagnostics.add(error)) {
       return;
     }
     var source = error.source;