analyzer: Deprecate Diagnostic.errorCode in favor of diagnosticCode

Work towards #60635

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

Author: srawlins

pkg/analysis_server/lib/src/g3/fixes.dart

@@ -75,7 +75,7 @@ class LintFixTester {
     Diagnostic diagnostic;
     var errors = unitResult.errors;
     if (inFile) {
-      var groups = errors.groupListsBy((error) => error.errorCode);
+      var groups = errors.groupListsBy((error) => error.diagnosticCode);
       if (groups.length != 1) {
         throw StateError(
           'Exactly one error code expected:'
@@ -90,7 +90,7 @@ class LintFixTester {
       diagnostic = errors.single;
     }
 
-    if (diagnostic.errorCode is! LintCode) {
+    if (diagnostic.diagnosticCode is! LintCode) {
       throw StateError('A lint expected: $errors');
     }
 

pkg/analysis_server/lib/src/g3/utilities.dart

@@ -35,13 +35,13 @@ String format(String content, {Version? languageVersion}) {
 /// code. On failure, the result contains the unsorted original code, and the
 /// cause of the failure, a list of [Diagnostic]s.
 ParseStringResult sortDirectives(String contents, {String? fileName}) {
-  var (unit, errors) = _parse(contents, fullName: fileName);
+  var (unit, diagnostics) = _parse(contents, fullName: fileName);
   var parseErrors =
-      errors
+      diagnostics
           .where(
-            (error) =>
-                error.errorCode is ScannerErrorCode ||
-                error.errorCode is ParserErrorCode,
+            (d) =>
+                d.diagnosticCode is ScannerErrorCode ||
+                d.diagnosticCode is ParserErrorCode,
           )
           .toList();
   if (parseErrors.isNotEmpty) {

pkg/analysis_server/lib/src/handler/legacy/edit_get_fixes.dart

@@ -224,7 +224,7 @@ class EditGetFixesHandler extends LegacyHandler
             var parametersFile = '''
 offset: $offset
 error: $error
-error.errorCode: ${error.errorCode}
+error.errorCode: ${error.diagnosticCode}
 ''';
             throw CaughtExceptionWithFiles(exception, stackTrace, {
               file: unitResult.content,

pkg/analysis_server/lib/src/handler/legacy/legacy_handler.dart

@@ -82,9 +82,9 @@ abstract class LegacyHandler {
   /// Return the number of syntactic errors in the list of [diagnostics].
   int numberOfSyntacticErrors(List<Diagnostic> diagnostics) {
     var numScanParseErrors = 0;
-    for (var error in diagnostics) {
-      if (error.errorCode is ScannerErrorCode ||
-          error.errorCode is ParserErrorCode) {
+    for (var diagnostic in diagnostics) {
+      if (diagnostic.diagnosticCode is ScannerErrorCode ||
+          diagnostic.diagnosticCode is ParserErrorCode) {
         numScanParseErrors++;
       }
     }

pkg/analysis_server/lib/src/lsp/handlers/commands/simple_edit_handler.dart

@@ -23,9 +23,9 @@ abstract class SimpleEditCommandHandler<S extends AnalysisServer>
 
   bool hasScanParseErrors(List<engine.Diagnostic> diagnostics) {
     return diagnostics.any(
-      (error) =>
-          error.errorCode is engine.ScannerErrorCode ||
-          error.errorCode is engine.ParserErrorCode,
+      (d) =>
+          d.diagnosticCode is engine.ScannerErrorCode ||
+          d.diagnosticCode is engine.ParserErrorCode,
     );
   }
 

pkg/analysis_server/lib/src/protocol_server.dart

@@ -144,8 +144,8 @@ AnalysisError newAnalysisError_fromEngine(
   engine.Diagnostic diagnostic, [
   engine.DiagnosticSeverity? diagnosticSeverity,
 ]) {
-  var errorCode = diagnostic.errorCode;
-  // prepare location
+  var diagnosticCode = diagnostic.diagnosticCode;
+  // Prepare location.
   Location location;
   {
     var file = diagnostic.source.fullName;
@@ -172,14 +172,14 @@ AnalysisError newAnalysisError_fromEngine(
     );
   }
 
-  // Default to the error's severity if none is specified.
-  diagnosticSeverity ??= errorCode.severity;
+  // Default to the diagnostic's severity if none is specified.
+  diagnosticSeverity ??= diagnosticCode.severity;
 
   // done
   var severity = AnalysisErrorSeverity.values.byName(diagnosticSeverity.name);
-  var type = AnalysisErrorType.values.byName(errorCode.type.name);
+  var type = AnalysisErrorType.values.byName(diagnosticCode.type.name);
   var message = diagnostic.message;
-  var code = errorCode.name.toLowerCase();
+  var code = diagnosticCode.name.toLowerCase();
   List<DiagnosticMessage>? contextMessages;
   if (diagnostic.contextMessages.isNotEmpty) {
     contextMessages =
@@ -188,7 +188,7 @@ AnalysisError newAnalysisError_fromEngine(
             .toList();
   }
   var correction = diagnostic.correctionMessage;
-  var url = errorCode.url;
+  var url = diagnosticCode.url;
   return AnalysisError(
     severity,
     type,

pkg/analysis_server/lib/src/services/completion/statement/statement_completion.dart

@@ -188,7 +188,8 @@ class StatementCompletionProcessor {
     }
     for (var error in statementContext.resolveResult.errors) {
       if (error.offset >= node.offset && error.offset <= node.end) {
-        if (error.errorCode is! HintCode && error.errorCode is! WarningCode) {
+        if (error.diagnosticCode is! HintCode &&
+            error.diagnosticCode is! WarningCode) {
           diagnostics.add(error);
         }
       }
@@ -302,7 +303,7 @@ class StatementCompletionProcessor {
       DiagnosticCode diagnosticCode, {
       Pattern? partialMatch,
     }) {
-      var error = _findError(diagnosticCode, partialMatch: partialMatch);
+      var error = _findDiagnostic(diagnosticCode, partialMatch: partialMatch);
       if (error == null) {
         return null;
       }
@@ -434,7 +435,7 @@ class StatementCompletionProcessor {
     var previousInsertions = _lengthOfInsertions();
     var delta = 0;
     if (diagnostics.isNotEmpty) {
-      var error = _findError(
+      var error = _findDiagnostic(
         ParserErrorCode.EXPECTED_TOKEN,
         partialMatch: "';'",
       );
@@ -751,7 +752,9 @@ class StatementCompletionProcessor {
     var needsParen = false;
     int computeExitPos(FormalParameterList parameters) {
       if (needsParen = parameters.rightParenthesis.isSynthetic) {
-        var error = _findError(ParserErrorCode.MISSING_CLOSING_PARENTHESIS);
+        var error = _findDiagnostic(
+          ParserErrorCode.MISSING_CLOSING_PARENTHESIS,
+        );
         if (error != null) {
           return error.offset - 1;
         }
@@ -790,7 +793,10 @@ class StatementCompletionProcessor {
     if (node is! FunctionDeclarationStatement) {
       return false;
     }
-    var error = _findError(ParserErrorCode.EXPECTED_TOKEN, partialMatch: "';'");
+    var error = _findDiagnostic(
+      ParserErrorCode.EXPECTED_TOKEN,
+      partialMatch: "';'",
+    );
     if (error != null) {
       var src = utils.getNodeText(node);
       var insertOffset = node.functionDeclaration.end - 1;
@@ -922,8 +928,8 @@ class StatementCompletionProcessor {
 
   bool _complete_methodCall(AstNode node) {
     var parenError =
-        _findError(ParserErrorCode.EXPECTED_TOKEN, partialMatch: "')'") ??
-        _findError(ScannerErrorCode.EXPECTED_TOKEN, partialMatch: "')'");
+        _findDiagnostic(ParserErrorCode.EXPECTED_TOKEN, partialMatch: "')'") ??
+        _findDiagnostic(ScannerErrorCode.EXPECTED_TOKEN, partialMatch: "')'");
     if (parenError == null) {
       return false;
     }
@@ -941,7 +947,7 @@ class StatementCompletionProcessor {
     var previousInsertions = _lengthOfInsertions();
     var loc = min(selectionOffset, argList.end - 1);
     var delta = 1;
-    var semicolonError = _findError(
+    var semicolonError = _findDiagnostic(
       ParserErrorCode.EXPECTED_TOKEN,
       partialMatch: "';'",
     );
@@ -980,7 +986,10 @@ class StatementCompletionProcessor {
     if (diagnostics.length != 1) {
       return false;
     }
-    var error = _findError(ParserErrorCode.EXPECTED_TOKEN, partialMatch: "';'");
+    var error = _findDiagnostic(
+      ParserErrorCode.EXPECTED_TOKEN,
+      partialMatch: "';'",
+    );
     if (error != null) {
       var previousInsertions = _lengthOfInsertions();
       // TODO(messick): Fix this to find the correct place in all cases.
@@ -1070,7 +1079,7 @@ class StatementCompletionProcessor {
         var exceptionType = catchNode.exceptionType;
         if (onKeyword != null && exceptionType != null) {
           if (exceptionType.length == 0 ||
-              _findError(
+              _findDiagnostic(
                     CompileTimeErrorCode.NON_TYPE_IN_CATCH_CLAUSE,
                     partialMatch: "name 'catch",
                   ) !=
@@ -1169,11 +1178,14 @@ class StatementCompletionProcessor {
     );
   }
 
-  engine.Diagnostic? _findError(DiagnosticCode code, {Pattern? partialMatch}) {
+  engine.Diagnostic? _findDiagnostic(
+    DiagnosticCode code, {
+    Pattern? partialMatch,
+  }) {
     return diagnostics.firstWhereOrNull(
-      (err) =>
-          err.errorCode == code &&
-          (partialMatch == null ? true : err.message.contains(partialMatch)),
+      (d) =>
+          d.diagnosticCode == code &&
+          (partialMatch == null ? true : d.message.contains(partialMatch)),
     );
   }
 
@@ -1273,7 +1285,7 @@ class StatementCompletionProcessor {
   }
 
   void _removeError(DiagnosticCode diagnosticCode, {Pattern? partialMatch}) {
-    var error = _findError(diagnosticCode, partialMatch: partialMatch);
+    var error = _findDiagnostic(diagnosticCode, partialMatch: partialMatch);
     if (error != null) {
       diagnostics.remove(error);
     }