DAS plugins: Rename FixContext.error to .diagnostic

Work towards #60635

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

Author: srawlins

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

@@ -38,8 +38,8 @@ abstract class BaseFixProcessorTest extends AbstractSingleUnitTest {
     return DartChangeWorkspace([await session]);
   }
 
-  /// Computes fixes for the given [error] in [testUnit].
-  Future<List<Fix>> _computeFixes(Diagnostic error) async {
+  /// Computes fixes for the given [diagnostic] in [testUnit].
+  Future<List<Fix>> _computeFixes(Diagnostic diagnostic) async {
     var libraryResult = testLibraryResult;
     if (libraryResult == null) {
       return const [];
@@ -49,7 +49,7 @@ abstract class BaseFixProcessorTest extends AbstractSingleUnitTest {
       workspace: await workspace,
       libraryResult: libraryResult,
       unitResult: testAnalysisResult,
-      error: error,
+      error: diagnostic,
     );
     return await computeFixes(context);
   }
@@ -648,9 +648,9 @@ abstract class FixProcessorTest extends BaseFixProcessorTest {
     }
   }
 
-  /// Computes fixes for the given [error] in [testUnit].
+  /// Computes fixes for the given [diagnostic] in [testUnit].
   @override
-  Future<List<Fix>> _computeFixes(Diagnostic error) async {
+  Future<List<Fix>> _computeFixes(Diagnostic diagnostic) async {
     var libraryResult = testLibraryResult;
     if (libraryResult == null) {
       return const [];
@@ -660,7 +660,7 @@ abstract class FixProcessorTest extends BaseFixProcessorTest {
       workspace: await workspace,
       libraryResult: libraryResult,
       unitResult: testAnalysisResult,
-      error: error,
+      error: diagnostic,
     );
     return await computeFixes(context);
   }

pkg/analysis_server_plugin/api.txt

@@ -115,6 +115,7 @@ package:analysis_server_plugin/edit/fix/dart_fix_context.dart:
     new (constructor: DartFixContext Function({bool autoTriggered, CorrectionUtils? correctionUtils, required Diagnostic error, required InstrumentationService instrumentationService, required ResolvedLibraryResult libraryResult, required ResolvedUnitResult unitResult, required ChangeWorkspace workspace}))
     autoTriggered (getter: bool)
     correctionUtils (getter: CorrectionUtils)
+    diagnostic (getter: Diagnostic)
     error (getter: Diagnostic)
     instrumentationService (getter: InstrumentationService)
     libraryResult (getter: ResolvedLibraryResult)
@@ -131,7 +132,8 @@ package:analysis_server_plugin/edit/fix/fix.dart:
     toString (method: String Function())
 package:analysis_server_plugin/edit/fix/fix_context.dart:
   FixContext (class extends Object):
-    error (getter: Diagnostic)
+    diagnostic (getter: Diagnostic)
+    error (getter: Diagnostic, deprecated)
 package:analysis_server_plugin/plugin.dart:
   Plugin (class extends Object):
     new (constructor: Plugin Function())

pkg/analysis_server_plugin/lib/edit/fix/dart_fix_context.dart

@@ -53,17 +53,22 @@ class DartFixContext implements FixContext {
       _cachedTopLevelDeclarations = {};
 
   @override
-  final Diagnostic error;
+  final Diagnostic diagnostic;
 
   DartFixContext({
     required this.instrumentationService,
     required this.workspace,
     required this.libraryResult,
     required this.unitResult,
-    required this.error,
+    // TODO(srawlins): Rename to `diagnostic`.
+    required Diagnostic error,
     this.autoTriggered = false,
     CorrectionUtils? correctionUtils,
-  }) : correctionUtils = correctionUtils ?? CorrectionUtils(unitResult);
+  })  : diagnostic = error,
+        correctionUtils = correctionUtils ?? CorrectionUtils(unitResult);
+
+  @override
+  Diagnostic get error => diagnostic;
 
   /// Returns the mapping from each library (that is available to this context)
   /// to a top-level declaration that is exported (not necessary declared) by

pkg/analysis_server_plugin/lib/edit/fix/fix_context.dart

@@ -10,6 +10,8 @@ import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 /// Clients may not extend, implement or mix-in this class.
 abstract interface class FixContext {
   /// The diagnostic to fix.
-  // TODO(srawlins): Rename to 'diagnostic'.
+  Diagnostic get diagnostic;
+
+  @Deprecated("Use 'diagnostic' instead")
   Diagnostic get error;
 }

pkg/analysis_server_plugin/lib/src/correction/fix_in_file_processor.dart

@@ -26,12 +26,12 @@ final class FixInFileProcessor {
   FixInFileProcessor(this._fixContext, {this.alreadyCalculated});
 
   Future<List<Fix>> compute() async {
-    var error = _fixContext.error;
+    var diagnostic = _fixContext.diagnostic;
 
-    var generators = _getGenerators(error.diagnosticCode);
+    var generators = _getGenerators(diagnostic.diagnosticCode);
 
     String getAlreadyCalculatedValue(ProducerGenerator generator) {
-      return '${generator.hashCode}|${error.diagnosticCode.name}';
+      return '${generator.hashCode}|${diagnostic.diagnosticCode.name}';
     }
 
     // Remove generators for which we've already calculated and we were asked to
@@ -48,7 +48,7 @@ final class FixInFileProcessor {
     }
 
     var diagnostics = _fixContext.unitResult.diagnostics
-        .where((e) => error.diagnosticCode.name == e.diagnosticCode.name);
+        .where((e) => diagnostic.diagnosticCode.name == e.diagnosticCode.name);
     if (diagnostics.length < 2) {
       return const <Fix>[];
     }
@@ -68,28 +68,28 @@ final class FixInFileProcessor {
           workspace: _fixContext.workspace,
           libraryResult: _fixContext.libraryResult,
           unitResult: _fixContext.unitResult,
-          error: error,
+          error: diagnostic,
           correctionUtils: _fixContext.correctionUtils,
         );
-        fixState = await _fixDiagnostic(fixContext, fixState, generator, error);
+        fixState =
+            await _fixDiagnostic(fixContext, fixState, generator, diagnostic);
 
         // The original error was not fixable; continue to next generator.
         if (!(fixState.builder as ChangeBuilderImpl).hasEdits) {
           continue;
         }
 
         // Compute fixes for the rest of the errors.
-        for (var diagnostic in diagnostics.where((item) => item != error)) {
+        for (var d in diagnostics.where((item) => item != diagnostic)) {
           var fixContext = DartFixContext(
             instrumentationService: _fixContext.instrumentationService,
             workspace: _fixContext.workspace,
             libraryResult: _fixContext.libraryResult,
             unitResult: _fixContext.unitResult,
-            error: diagnostic,
+            error: d,
             correctionUtils: _fixContext.correctionUtils,
           );
-          fixState =
-              await _fixDiagnostic(fixContext, fixState, generator, diagnostic);
+          fixState = await _fixDiagnostic(fixContext, fixState, generator, d);
         }
         if (fixState is _NotEmptyFixState) {
           var sourceChange = fixState.builder.sourceChange;

pkg/analysis_server_plugin/lib/src/correction/fix_processor.dart

@@ -81,14 +81,14 @@ class FixProcessor {
   }
 
   Future<void> _addFromProducers() async {
-    var error = _fixContext.error;
+    var diagnostic = _fixContext.diagnostic;
     var context = CorrectionProducerContext.createResolved(
       libraryResult: _fixContext.libraryResult,
       unitResult: _fixContext.unitResult,
       dartFixContext: _fixContext,
-      diagnostic: error,
-      selectionOffset: _fixContext.error.offset,
-      selectionLength: _fixContext.error.length,
+      diagnostic: diagnostic,
+      selectionOffset: _fixContext.diagnostic.offset,
+      selectionLength: _fixContext.diagnostic.length,
     );
 
     Future<void> compute(CorrectionProducer producer) async {
@@ -122,7 +122,7 @@ class FixProcessor {
       }
     }
 
-    var diagnosticCode = error.diagnosticCode;
+    var diagnosticCode = diagnostic.diagnosticCode;
     List<ProducerGenerator>? generators;
     List<MultiProducerGenerator>? multiGenerators;
     if (diagnosticCode is LintCode) {
@@ -157,7 +157,7 @@ class FixProcessor {
         if (producer.fixKind == ignoreErrorAnalysisFileKind) {
           if (alreadyCalculated?.add('${generator.hashCode}|'
                   '${ignoreErrorAnalysisFileKind.id}|'
-                  '${error.diagnosticCode.name}') ==
+                  '${diagnostic.diagnosticCode.name}') ==
               false) {
             // We did this before and was asked to not do it again. Skip.
             continue;