analyzer: Deprecate AnalysisError.correction; simplify other final fields

Work towards #60635

* `AnalysisError._contextMessages` unnecessarily backed the public
  `contextMessages` getter; the field is final so it can be public
  itself.
* `AnalysisError._correctionMessage` unnecessarily backed the public
  `correctionMessage` getter; the field is final so it can be public
  itself.

Change-Id: If269d4ed590ef7df81d9b9e3be03766601526d7f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/425620
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Paul Berry <[email protected]>

Author: srawlins

pkg/analysis_server/lib/src/protocol_server.dart

@@ -186,7 +186,7 @@ AnalysisError newAnalysisError_fromEngine(
             .map((message) => newDiagnosticMessage(result, message))
             .toList();
   }
-  var correction = error.correction;
+  var correction = error.correctionMessage;
   var url = errorCode.url;
   return AnalysisError(
     severity,

pkg/analysis_server/test/protocol_server_test.dart

@@ -112,7 +112,7 @@ class AnalysisErrorTest {
       offset: 10,
       length: 20,
       message: 'my message',
-      correction: 'my correction',
+      correctionMessage: 'my correction',
     );
     var error = newAnalysisError_fromEngine(result, engineError);
     expect(error.toJson(), {
@@ -331,7 +331,7 @@ class MockAnalysisError implements engine.AnalysisError {
   final int? _offset;
   final int? _length;
   final String? _message;
-  final String? _correction;
+
   final DiagnosticMessage? _problemMessage;
   final String? _correctionMessage;
 
@@ -344,20 +344,18 @@ class MockAnalysisError implements engine.AnalysisError {
     int? offset,
     int? length,
     String? message,
-    String? correction,
     DiagnosticMessage? problemMessage,
     String? correctionMessage,
   }) : _source = source,
        _diagnosticCode = errorCode,
        _offset = offset,
        _length = length,
        _message = message,
-       _correction = correction,
        _problemMessage = problemMessage,
        _correctionMessage = correctionMessage;
 
   @override
-  String? get correction => _correction;
+  String? get correction => null;
 
   @override
   String? get correctionMessage => _correctionMessage;

pkg/analysis_server_plugin/lib/src/plugin_server.dart

@@ -401,7 +401,7 @@ class PluginServer {
             _locationFor(currentUnit.unit, path, e),
             e.message,
             e.errorCode.name,
-            correction: e.correction,
+            correction: e.correctionMessage,
             // TODO(srawlins): Use a valid value here.
             hasFix: true,
           )

pkg/analyzer/CHANGELOG.md

@@ -6,6 +6,8 @@
 * Remove `ElementLocation` class, its values are not returned anymore.
 * Deprecated `element2.dart` library, import `element.dart`.
 * Deprecated `XyzElement2` classes, use `XyzElement` instead.
+* Deprecate `AnalysisError.correction` field; use
+  `AnalysisError.correctionMessage` instead.
 
 ## 7.4.1
 * Restore `InstanceElement.augmented` getter.

pkg/analyzer/api.txt

@@ -4351,7 +4351,7 @@ package:analyzer/error/error.dart:
     forValues (constructor: AnalysisError Function({List<DiagnosticMessage> contextMessages, String? correctionMessage, Object? data, required ErrorCode errorCode, required int length, required String message, required int offset, required Source source}))
     tmp (constructor: AnalysisError Function({List<Object?> arguments, List<DiagnosticMessage> contextMessages, Object? data, required ErrorCode errorCode, required int length, required int offset, required Source source}))
     contextMessages (getter: List<DiagnosticMessage>)
-    correction (getter: String?)
+    correction (getter: String?, deprecated)
     correctionMessage (getter: String?)
     data (getter: Object?)
     errorCode (getter: ErrorCode)

pkg/analyzer/lib/error/error.dart

@@ -60,16 +60,14 @@ class AnalysisError implements Diagnostic {
   @override
   final DiagnosticMessage problemMessage;
 
-  /// The context messages associated with the problem. This list will be empty
-  /// if there are no context messages.
-  final List<DiagnosticMessage> _contextMessages;
+  @override
+  final List<DiagnosticMessage> contextMessages;
 
   /// Data associated with this error, specific for [errorCode].
   final Object? data;
 
-  /// The correction to be displayed for this error, or `null` if there is no
-  /// correction information for this error.
-  String? _correctionMessage;
+  @override
+  final String? correctionMessage;
 
   /// The source in which the error occurred, or `null` if unknown.
   final Source source;
@@ -81,12 +79,10 @@ class AnalysisError implements Diagnostic {
     required int length,
     required this.errorCode,
     required String message,
-    String? correctionMessage,
-    List<DiagnosticMessage> contextMessages = const [],
+    this.correctionMessage,
+    this.contextMessages = const [],
     this.data,
-  }) : _correctionMessage = correctionMessage,
-       _contextMessages = contextMessages,
-       problemMessage = DiagnosticMessageImpl(
+  }) : problemMessage = DiagnosticMessageImpl(
          filePath: source.fullName,
          length: length,
          message: message,
@@ -135,16 +131,11 @@ class AnalysisError implements Diagnostic {
     );
   }
 
-  @override
-  List<DiagnosticMessage> get contextMessages => _contextMessages;
-
-  /// Return the template used to create the correction to be displayed for this
-  /// error, or `null` if there is no correction information for this error. The
+  /// The template used to create the correction to be displayed for this error,
+  /// or `null` if there is no correction information for this error. The
   /// correction should indicate how the user can fix the error.
-  String? get correction => _correctionMessage;
-
-  @override
-  String? get correctionMessage => _correctionMessage;
+  @Deprecated("Use 'correctionMessage' instead.")
+  String? get correction => correctionMessage;
 
   @override
   int get hashCode {

pkg/analyzer/lib/src/dart/analysis/driver.dart

@@ -2719,7 +2719,7 @@ class ErrorEncoding {
       length: error.length,
       uniqueName: error.errorCode.uniqueName,
       message: error.message,
-      correction: error.correction ?? '',
+      correction: error.correctionMessage ?? '',
       contextMessages: contextMessages,
     );
   }

pkg/analyzer/tool/api/generate.dart

@@ -46,7 +46,7 @@ Future<String> computeApiTxtContents(String pkgPath) async {
     includedPaths: [packagePath],
     resourceProvider: provider,
   );
-  var context = collection.contexts.single;
+  var context = collection.contexts.first;
   var publicApi = ApiDescription();
   var stringBuffer = StringBuffer();
   printNodes(stringBuffer, await publicApi.build(context));

pkg/analyzer_cli/lib/src/error_formatter.dart

@@ -350,7 +350,7 @@ class HumanErrorFormatter extends ErrorFormatter {
         message: error.message,
         contextMessages: contextMessages,
         errorCode: error.errorCode.name.toLowerCase(),
-        correction: error.correction,
+        correction: error.correctionMessage,
         url: error.errorCode.url,
       ),
     );
@@ -445,7 +445,8 @@ class JsonErrorFormatter extends ErrorFormatter {
             lineInfo,
           ),
           'problemMessage': problemMessage.messageText(includeUrl: true),
-          if (error.correction != null) 'correctionMessage': error.correction,
+          if (error.correctionMessage != null)
+            'correctionMessage': error.correctionMessage,
           if (contextMessages.isNotEmpty) 'contextMessages': contextMessages,
           if (url != null) 'documentation': url,
         });

pkg/analyzer_plugin/lib/utilities/analyzer_converter.dart

@@ -61,7 +61,7 @@ class AnalyzerConverter {
         error.message,
         errorCode.name.toLowerCase(),
         contextMessages: contextMessages,
-        correction: error.correction,
+        correction: error.correctionMessage,
         hasFix: true);
   }