analyzer_plugin: Use Diagnostic instead of deprecated AnalysisError

Work towards #60635

Change-Id: Icf62987d6de7cafb6f6e92076a5fcc2bd48772c5
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/426522
Auto-Submit: Samuel Rawlins <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: srawlins

pkg/analyzer_plugin/lib/plugin/fix_mixin.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/dart/analysis/results.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:analyzer_plugin/plugin/plugin.dart';
 import 'package:analyzer_plugin/protocol/protocol.dart';
@@ -25,13 +25,13 @@ mixin DartFixesMixin implements FixesMixin {
     var offset = parameters.offset;
     var result = await getResolvedUnitResult(path);
     return DartFixesRequestImpl(
-        resourceProvider, offset, _getErrors(offset, result), result);
+        resourceProvider, offset, _getDiagnostics(offset, result), result);
   }
 
-  List<AnalysisError> _getErrors(int offset, ResolvedUnitResult result) {
+  List<Diagnostic> _getDiagnostics(int offset, ResolvedUnitResult result) {
     var lineInfo = result.lineInfo;
     var offsetLine = lineInfo.getLocation(offset).lineNumber;
-    return result.errors.where((AnalysisError error) {
+    return result.errors.where((error) {
       var errorLine = lineInfo.getLocation(error.offset).lineNumber;
       return errorLine == offsetLine;
     }).toList();

pkg/analyzer_plugin/lib/src/utilities/fixes/fixes.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/dart/analysis/results.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart';
 import 'package:analyzer_plugin/utilities/analyzer_converter.dart';
@@ -18,7 +18,7 @@ class DartFixesRequestImpl implements DartFixesRequest {
   final int offset;
 
   @override
-  final List<AnalysisError> errorsToFix;
+  final List<Diagnostic> errorsToFix;
 
   @override
   final ResolvedUnitResult result;
@@ -31,8 +31,8 @@ class DartFixesRequestImpl implements DartFixesRequest {
 /// A concrete implementation of [FixCollector].
 class FixCollectorImpl implements FixCollector {
   /// The list of fixes that have been collected.
-  final Map<AnalysisError, List<PrioritizedSourceChange>> fixMap =
-      <AnalysisError, List<PrioritizedSourceChange>>{};
+  final Map<Diagnostic, List<PrioritizedSourceChange>> fixMap =
+      <Diagnostic, List<PrioritizedSourceChange>>{};
 
   /// Return the fixes that have been collected up to this point.
   List<AnalysisErrorFixes> get fixes {
@@ -46,7 +46,9 @@ class FixCollectorImpl implements FixCollector {
   }
 
   @override
-  void addFix(AnalysisError error, PrioritizedSourceChange change) {
-    fixMap.putIfAbsent(error, () => <PrioritizedSourceChange>[]).add(change);
+  void addFix(Diagnostic diagnostic, PrioritizedSourceChange change) {
+    fixMap
+        .putIfAbsent(diagnostic, () => <PrioritizedSourceChange>[])
+        .add(change);
   }
 }

pkg/analyzer_plugin/lib/utilities/analyzer_converter.dart

@@ -19,20 +19,20 @@ import 'package:path/path.dart' as path;
 ///
 /// Clients may not extend, implement or mix-in this class.
 class AnalyzerConverter {
-  /// Converts the analysis [error] from the 'analyzer' package to an analysis
-  /// error defined by the plugin API.
+  /// Converts the analysis [diagnostic] from the 'analyzer' package to an
+  /// analysis error defined by the plugin API.
   ///
   /// If a [lineInfo] is provided then the error's location will have a start
   /// line and start column. If a [severity] is provided, then it will override
   /// the severity defined by the error.
   plugin.AnalysisError convertAnalysisError(
-    analyzer.AnalysisError error, {
+    analyzer.Diagnostic diagnostic, {
     analyzer.LineInfo? lineInfo,
     analyzer.DiagnosticSeverity? severity,
   }) {
-    var errorCode = error.errorCode;
+    var errorCode = diagnostic.errorCode;
     severity ??= errorCode.errorSeverity;
-    var offset = error.offset;
+    var offset = diagnostic.offset;
     var startLine = -1;
     var startColumn = -1;
     var endLine = -1;
@@ -41,36 +41,36 @@ class AnalyzerConverter {
       var startLocation = lineInfo.getLocation(offset);
       startLine = startLocation.lineNumber;
       startColumn = startLocation.columnNumber;
-      var endLocation = lineInfo.getLocation(offset + error.length);
+      var endLocation = lineInfo.getLocation(offset + diagnostic.length);
       endLine = endLocation.lineNumber;
       endColumn = endLocation.columnNumber;
     }
     List<plugin.DiagnosticMessage>? contextMessages;
-    if (error.contextMessages.isNotEmpty) {
-      contextMessages = error.contextMessages
+    if (diagnostic.contextMessages.isNotEmpty) {
+      contextMessages = diagnostic.contextMessages
           .map((message) =>
               convertDiagnosticMessage(message, lineInfo: lineInfo))
           .toList();
     }
     return plugin.AnalysisError(
         convertErrorSeverity(severity),
         convertErrorType(errorCode.type),
-        plugin.Location(
-            error.source.fullName, offset, error.length, startLine, startColumn,
+        plugin.Location(diagnostic.source.fullName, offset, diagnostic.length,
+            startLine, startColumn,
             endLine: endLine, endColumn: endColumn),
-        error.message,
+        diagnostic.message,
         errorCode.name.toLowerCase(),
         contextMessages: contextMessages,
-        correction: error.correctionMessage,
+        correction: diagnostic.correctionMessage,
         hasFix: true);
   }
 
-  /// Converts the list of analysis [errors] from the 'analyzer' package to a
-  /// list of analysis errors defined by the plugin API.
+  /// Converts the list of analysis [diagnostics] from the 'analyzer' package to
+  /// a list of analysis errors defined by the plugin API.
   ///
   /// The severities of the errors are altered based on [options].
   List<plugin.AnalysisError> convertAnalysisErrors(
-    List<analyzer.AnalysisError> errors, {
+    List<analyzer.Diagnostic> diagnostics, {
     // TODO(srawlins): Make `lineInfo` required and non-nullable, in a breaking
     // change release.
     analyzer.LineInfo? lineInfo,
@@ -79,18 +79,18 @@ class AnalyzerConverter {
     analyzer.AnalysisOptions? options,
   }) {
     var serverErrors = <plugin.AnalysisError>[];
-    for (var error in errors) {
-      var processor = analyzer.ErrorProcessor.getProcessor(options, error);
+    for (var diagnostic in diagnostics) {
+      var processor = analyzer.ErrorProcessor.getProcessor(options, diagnostic);
       if (processor != null) {
         var severity = processor.severity;
         // Errors with null severity are filtered out.
         if (severity != null) {
           // Specified severities override.
-          serverErrors.add(convertAnalysisError(error,
+          serverErrors.add(convertAnalysisError(diagnostic,
               lineInfo: lineInfo, severity: severity));
         }
       } else {
-        serverErrors.add(convertAnalysisError(error, lineInfo: lineInfo));
+        serverErrors.add(convertAnalysisError(diagnostic, lineInfo: lineInfo));
       }
     }
     return serverErrors;

pkg/analyzer_plugin/lib/utilities/fixes/fix_contributor_mixin.dart

@@ -2,7 +2,7 @@
 // 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 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/src/generated/java_core.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
@@ -20,19 +20,20 @@ abstract class FixContributorMixin implements FixContributor {
   /// The collector to which fixes should be added.
   FixCollector? collector;
 
-  /// Add a fix for the given [error]. Use the [kind] of the fix to get the
-  /// message and priority, and use the change [builder] to get the edits that
-  /// comprise the fix. If the message has parameters, then use the list of
+  /// Adds a fix for the given [diagnostic]. Use the [kind] of the fix to get
+  /// the message and priority, and use the change [builder] to get the edits
+  /// that comprise the fix. If the message has parameters, then use the list of
   /// [args] to populate the message.
-  void addFix(AnalysisError error, FixKind kind, ChangeBuilder builder,
+  void addFix(Diagnostic diagnostic, FixKind kind, ChangeBuilder builder,
       {List<Object>? args}) {
     var change = builder.sourceChange;
     if (change.edits.isEmpty) {
       return;
     }
     change.id = kind.id;
     change.message = formatList(kind.message, args);
-    collector?.addFix(error, PrioritizedSourceChange(kind.priority, change));
+    collector?.addFix(
+        diagnostic, PrioritizedSourceChange(kind.priority, change));
   }
 
   @override
@@ -50,7 +51,7 @@ abstract class FixContributorMixin implements FixContributor {
     }
   }
 
-  /// Compute the fixes that are appropriate for the given [error] and add them
-  /// to the fix [collector].
-  Future<void> computeFixesForError(AnalysisError error);
+  /// Computes the fixes that are appropriate for the given [diagnostic] and add
+  /// them to the fix [collector].
+  Future<void> computeFixesForError(Diagnostic diagnostic);
 }

pkg/analyzer_plugin/lib/utilities/fixes/fixes.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/dart/analysis/results.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer_plugin/protocol/protocol.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart';
@@ -23,8 +23,8 @@ abstract class DartFixesRequest implements FixesRequest {
 ///
 /// Clients may not extend, implement or mix-in this class.
 abstract class FixCollector {
-  /// Record a new [change] (fix) associated with the given [error].
-  void addFix(AnalysisError error, PrioritizedSourceChange change);
+  /// Records a new [change] (fix) associated with the given [diagnostic].
+  void addFix(Diagnostic diagnostic, PrioritizedSourceChange change);
 }
 
 /// An object used to produce fixes.
@@ -43,7 +43,7 @@ abstract class FixContributor {
 abstract class FixesRequest {
   /// The analysis error to be fixed, or `null` if the error has not been
   /// determined.
-  List<AnalysisError> get errorsToFix;
+  List<Diagnostic> get errorsToFix;
 
   /// Return the offset within the source for which fixes are being requested.
   int get offset;

pkg/analyzer_plugin/lib/utilities/range_factory.dart

@@ -6,7 +6,7 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/syntactic_entity.dart';
 import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/element/element.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/source/source_range.dart';
 
 /// An instance of [RangeFactory] made available for convenience.
@@ -123,9 +123,10 @@ class RangeFactory {
     return SourceRange(node.offset, node.length);
   }
 
-  /// Return a source range that covers the same range as the given [error].
-  SourceRange error(AnalysisError error) {
-    return SourceRange(error.offset, error.length);
+  /// Returns a source range that covers the same range as the given
+  /// [diagnostic].
+  SourceRange error(Diagnostic diagnostic) {
+    return SourceRange(diagnostic.offset, diagnostic.length);
   }
 
   /// Returns a source range that covers the name of the given [fragment].

pkg/analyzer_plugin/test/plugin/fix_mixin_test.dart

@@ -2,7 +2,7 @@
 // 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 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/error/codes.dart';
 import 'package:analyzer_plugin/plugin/fix_mixin.dart';
@@ -88,14 +88,14 @@ class _TestServerPlugin extends MockServerPlugin with FixesMixin {
   @override
   Future<FixesRequest> getFixesRequest(EditGetFixesParams parameters) async {
     var offset = parameters.offset;
-    var error = AnalysisError.tmp(
+    var diagnostic = Diagnostic.tmp(
       source: MockSource(),
       offset: 0,
       length: 0,
       errorCode: CompileTimeErrorCode.AWAIT_IN_WRONG_CONTEXT,
     );
-    var result =
-        MockResolvedUnitResult(lineInfo: LineInfo([0, 20]), errors: [error]);
-    return DartFixesRequestImpl(resourceProvider, offset, [error], result);
+    var result = MockResolvedUnitResult(
+        lineInfo: LineInfo([0, 20]), errors: [diagnostic]);
+    return DartFixesRequestImpl(resourceProvider, offset, [diagnostic], result);
   }
 }

pkg/analyzer_plugin/test/plugin/mocks.dart

@@ -6,7 +6,7 @@ import 'dart:async';
 
 import 'package:analyzer/dart/analysis/analysis_context.dart';
 import 'package:analyzer/dart/analysis/results.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:analyzer/source/source.dart';
@@ -113,7 +113,7 @@ class MockChannel implements PluginCommunicationChannel {
 
 class MockResolvedUnitResult implements ResolvedUnitResult {
   @override
-  final List<AnalysisError> errors;
+  final List<Diagnostic> errors;
 
   @override
   final LineInfo lineInfo;
@@ -122,7 +122,7 @@ class MockResolvedUnitResult implements ResolvedUnitResult {
   final String path;
 
   MockResolvedUnitResult(
-      {List<AnalysisError>? errors, LineInfo? lineInfo, String? path})
+      {List<Diagnostic>? errors, LineInfo? lineInfo, String? path})
       : errors = errors ?? [],
         lineInfo = lineInfo ?? LineInfo([0]),
         path = path ?? '';

pkg/analyzer_plugin/test/support/abstract_single_unit.dart

@@ -5,7 +5,6 @@
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
-import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/dart/ast/element_locator.dart';
 import 'package:analyzer/src/error/codes.dart';
 import 'package:analyzer/src/test_utilities/find_element2.dart';
@@ -107,7 +106,7 @@ class AbstractSingleUnitTest extends AbstractContextTest {
     testCode = result.content;
     testUnit = result.unit;
     if (verifyNoTestUnitErrors) {
-      expect(result.errors.where((AnalysisError error) {
+      expect(result.errors.where((error) {
         return error.errorCode != WarningCode.DEAD_CODE &&
             error.errorCode != WarningCode.UNUSED_CATCH_CLAUSE &&
             error.errorCode != WarningCode.UNUSED_CATCH_STACK &&