analysis_server_plugin: Use Diagnostic instead of deprecated AnalysisError

srawlins · Commit Queue · commit c6658d01c7d0 · 2025-05-05T13:55:28.000-07:00
Work towards #60635 Change-Id: Icf4186098ed04f15395aaf06c18772f8fd6ec4b7 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/426560 Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
diff --git a/pkg/analysis_server_plugin/lib/edit/fix/dart_fix_context.dart b/pkg/analysis_server_plugin/lib/edit/fix/dart_fix_context.dart
@@ -6,7 +6,7 @@ import 'package:analysis_server_plugin/edit/fix/fix_context.dart';
 import 'package:analysis_server_plugin/src/correction/change_workspace.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/element/element.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/instrumentation/service.dart';
 import 'package:analyzer/src/dart/analysis/driver_based_analysis_context.dart';
 import 'package:analyzer/src/dart/analysis/file_state_filter.dart';
@@ -49,7 +49,7 @@ class DartFixContext implements FixContext {
       _cachedTopLevelDeclarations = {};
 
   @override
-  final AnalysisError error;
+  final Diagnostic error;
 
   DartFixContext({
     required this.instrumentationService,
diff --git a/pkg/analysis_server_plugin/lib/edit/fix/fix_context.dart b/pkg/analysis_server_plugin/lib/edit/fix/fix_context.dart
@@ -2,13 +2,13 @@
 // 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_plugin/utilities/fixes/fixes.dart';
 
 /// Provides context information for [FixContributor]s.
 ///
 /// Clients may not extend, implement or mix-in this class.
 abstract interface class FixContext {
   /// The error to fix.
-  AnalysisError get error;
+  Diagnostic get error;
 }
diff --git a/pkg/analysis_server_plugin/lib/src/correction/fix_in_file_processor.dart b/pkg/analysis_server_plugin/lib/src/correction/fix_in_file_processor.dart
@@ -6,6 +6,7 @@ import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
 import 'package:analysis_server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:analysis_server_plugin/edit/fix/fix.dart';
 import 'package:analysis_server_plugin/src/correction/fix_generators.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
@@ -69,7 +70,7 @@ final class FixInFileProcessor {
           unitResult: _fixContext.unitResult,
           error: error,
         );
-        fixState = await _fixError(fixContext, fixState, generator, error);
+        fixState = await _fixDiagnostic(fixContext, fixState, generator, error);
 
         // The original error was not fixable; continue to next generator.
         if (!(fixState.builder as ChangeBuilderImpl).hasEdits) {
@@ -85,7 +86,8 @@ final class FixInFileProcessor {
             unitResult: _fixContext.unitResult,
             error: error,
           );
-          fixState = await _fixError(fixContext, fixState, generator, error);
+          fixState =
+              await _fixDiagnostic(fixContext, fixState, generator, error);
         }
         if (fixState is _NotEmptyFixState) {
           var sourceChange = fixState.builder.sourceChange;
@@ -104,11 +106,11 @@ final class FixInFileProcessor {
     return fixes;
   }
 
-  Future<_FixState> _fixError(
+  Future<_FixState> _fixDiagnostic(
     DartFixContext fixContext,
     _FixState fixState,
     ProducerGenerator generator,
-    AnalysisError diagnostic,
+    Diagnostic diagnostic,
   ) async {
     var context = CorrectionProducerContext.createResolved(
       applyingBulkFixes: true,
diff --git a/pkg/analysis_server_plugin/lib/src/correction/ignore_diagnostic.dart b/pkg/analysis_server_plugin/lib/src/correction/ignore_diagnostic.dart
@@ -4,7 +4,7 @@
 
 import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
 import 'package:analysis_server_plugin/edit/dart/dart_fix_kind_priority.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart';
 import 'package:analyzer/src/ignore_comments/ignore_info.dart';
@@ -200,7 +200,7 @@ class IgnoreDiagnosticOnLine extends _DartIgnoreDiagnostic {
     if (_isCodeUnignorable) return;
 
     await builder.addDartFileEdit(file, (builder) {
-      var offset = error.problemMessage.offset;
+      var offset = diagnostic.problemMessage.offset;
       var lineNumber = unitResult.lineInfo.getLocation(offset).lineNumber - 1;
 
       if (lineNumber == 0) {
@@ -234,20 +234,21 @@ abstract class _BaseIgnoreDiagnostic extends ResolvedCorrectionProducer {
       // TODO(applicability): comment on why.
       CorrectionApplicability.singleLocation;
 
-  AnalysisError get error => diagnostic as AnalysisError;
+  @override
+  Diagnostic get diagnostic => super.diagnostic!;
 
   @override
   List<String> get fixArguments => [_code];
 
-  String get _code => error.errorCode.name.toLowerCase();
+  String get _code => diagnostic.errorCode.name.toLowerCase();
 
   /// Returns `true` if any of the following is `true`:
   /// - `error.code` is present in the `cannot-ignore` list.
   /// - `error.code` is already ignored in the `errors` list.
   bool get _isCodeUnignorable {
     var cannotIgnore = (analysisOptions as AnalysisOptionsImpl)
         .unignorableNames
-        .contains(error.errorCode.name);
+        .contains(diagnostic.errorCode.name);
 
     if (cannotIgnore) {
       return true;
@@ -260,7 +261,7 @@ abstract class _BaseIgnoreDiagnostic extends ResolvedCorrectionProducer {
     //       See `ErrorConfig` in `pkg/analyzer/source/error_processor.dart`.
     return analysisOptions.errorProcessors.any(
       (element) =>
-          element.severity == null && element.code == error.errorCode.name,
+          element.severity == null && element.code == diagnostic.errorCode.name,
     );
   }
 }
diff --git a/pkg/analysis_server_plugin/lib/src/plugin_server.dart b/pkg/analysis_server_plugin/lib/src/plugin_server.dart
@@ -18,7 +18,7 @@ import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/error/error.dart';
+import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/overlay_file_system.dart';
@@ -42,7 +42,7 @@ import 'package:analyzer_plugin/protocol/protocol_generated.dart' as protocol;
 import 'package:analyzer_plugin/src/protocol/protocol_internal.dart';
 
 typedef _ErrorAndProtocolError = ({
-  AnalysisError error,
+  Diagnostic diagnostic,
   protocol.AnalysisError protocolError,
 });
 
@@ -180,21 +180,22 @@ class PluginServer {
       return protocol.EditGetFixesResult(const []);
     }
 
-    var lintAtOffset = errors.where((error) => error.error.offset == offset);
+    var lintAtOffset =
+        errors.where((error) => error.diagnostic.offset == offset);
     if (lintAtOffset.isEmpty) return protocol.EditGetFixesResult(const []);
 
     var errorFixesList = <protocol.AnalysisErrorFixes>[];
 
     var workspace = DartChangeWorkspace([analysisContext.currentSession]);
-    for (var (:error, :protocolError) in lintAtOffset) {
+    for (var (:diagnostic, :protocolError) in lintAtOffset) {
       var context = DartFixContext(
         // TODO(srawlins): Use a real instrumentation service. Other
         // implementations get InstrumentationService from AnalysisServer.
         instrumentationService: InstrumentationService.NULL_SERVICE,
         workspace: workspace,
         libraryResult: libraryResult,
         unitResult: unitResult,
-        error: error,
+        error: diagnostic,
       );
 
       List<Fix> fixes;
@@ -394,7 +395,7 @@ class PluginServer {
     var errorsAndProtocolErrors = [
       for (var e in errors)
         (
-          error: e,
+          diagnostic: e,
           protocolError: protocol.AnalysisError(
             protocol.AnalysisErrorSeverity.INFO,
             protocol.AnalysisErrorType.STATIC_WARNING,
@@ -638,14 +639,15 @@ class PluginServer {
       _priorityPaths.any(analysisContext.contextRoot.isAnalyzed);
 
   static protocol.Location _locationFor(
-      CompilationUnit unit, String path, AnalysisError error) {
+      CompilationUnit unit, String path, Diagnostic diagnostic) {
     var lineInfo = unit.lineInfo;
-    var startLocation = lineInfo.getLocation(error.offset);
-    var endLocation = lineInfo.getLocation(error.offset + error.length);
+    var startLocation = lineInfo.getLocation(diagnostic.offset);
+    var endLocation =
+        lineInfo.getLocation(diagnostic.offset + diagnostic.length);
     return protocol.Location(
       path,
-      error.offset,
-      error.length,
+      diagnostic.offset,
+      diagnostic.length,
       startLocation.lineNumber,
       startLocation.columnNumber,
       endLine: endLocation.lineNumber,
