analyzer: Deprecate AnalysisResultWithErrors.errors in favor of .diagnostics

Also rename UnitAnalysisResult.errors (package-private API) to .diagnostics

Work towards #60635

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

Author: srawlins

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

@@ -45,24 +45,24 @@ class CiderFixesComputer {
     var lineInfo = resolvedUnit.lineInfo;
 
     await _logger.runAsync('Compute fixes', () async {
-      for (var error in resolvedUnit.errors) {
-        var errorLine = lineInfo.getLocation(error.offset).lineNumber;
-        if (errorLine == lineNumber) {
+      for (var diagnostic in resolvedUnit.diagnostics) {
+        var diagnosticLine = lineInfo.getLocation(diagnostic.offset).lineNumber;
+        if (diagnosticLine == lineNumber) {
           var workspace = DartChangeWorkspace([resolvedUnit.session]);
           var context = _CiderDartFixContextImpl(
             _fileResolver,
             workspace: workspace,
             libraryResult: resolvedLibrary,
             unitResult: resolvedUnit,
-            error: error,
+            error: diagnostic,
           );
 
           var fixes = await computeFixes(context);
           fixes.sort(Fix.compareFixes);
 
           result.add(
             CiderErrorFixes(
-              diagnostic: error,
+              diagnostic: diagnostic,
               fixes: fixes,
               lineInfo: lineInfo,
             ),

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

@@ -73,7 +73,7 @@ class LintFixTester {
     var unitResult = resolvedLibrary.unitWithPath(path)!;
 
     Diagnostic diagnostic;
-    var errors = unitResult.errors;
+    var errors = unitResult.diagnostics;
     if (inFile) {
       var groups = errors.groupListsBy((error) => error.diagnosticCode);
       if (groups.length != 1) {

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

@@ -127,7 +127,7 @@ class EditGetFixesHandler extends LegacyHandler
     );
     var sdkVersionConstraint =
         (package is PubPackage) ? package.sdkVersionConstraint : null;
-    var errors = analyzeAnalysisOptions(
+    var diagnostics = analyzeAnalysisOptions(
       FileSource(optionsFile),
       content,
       sourceFactory,
@@ -138,10 +138,10 @@ class EditGetFixesHandler extends LegacyHandler
     if (options == null) {
       return errorFixesList;
     }
-    for (var error in errors) {
+    for (var diagnostic in diagnostics) {
       var generator = AnalysisOptionsFixGenerator(
         resourceProvider,
-        error,
+        diagnostic,
         content,
         options,
       );
@@ -160,10 +160,10 @@ class EditGetFixesHandler extends LegacyHandler
           lineInfo: lineInfo,
           isLibrary: true,
           isPart: false,
-          errors: errors,
+          diagnostics: diagnostics,
           analysisOptions: analysisOptions,
         );
-        var serverError = newAnalysisError_fromEngine(result, error);
+        var serverError = newAnalysisError_fromEngine(result, diagnostic);
         var errorFixes = AnalysisErrorFixes(serverError);
         errorFixesList.add(errorFixes);
         for (var fix in fixes) {
@@ -188,16 +188,16 @@ class EditGetFixesHandler extends LegacyHandler
       var unitResult = libraryResult.unitWithPath(file)!;
       var lineInfo = unitResult.lineInfo;
       var requestLine = lineInfo.getLocation(offset).lineNumber;
-      for (var error in unitResult.errors) {
-        var errorLine = lineInfo.getLocation(error.offset).lineNumber;
+      for (var diagnostic in unitResult.diagnostics) {
+        var errorLine = lineInfo.getLocation(diagnostic.offset).lineNumber;
         if (errorLine == requestLine) {
           var workspace = DartChangeWorkspace(await server.currentSessions);
           var context = DartFixContext(
             instrumentationService: server.instrumentationService,
             workspace: workspace,
             libraryResult: libraryResult,
             unitResult: unitResult,
-            error: error,
+            error: diagnostic,
           );
 
           List<Fix> fixes;
@@ -223,8 +223,8 @@ class EditGetFixesHandler extends LegacyHandler
           } catch (exception, stackTrace) {
             var parametersFile = '''
 offset: $offset
-error: $error
-error.errorCode: ${error.diagnosticCode}
+error: $diagnostic
+error.errorCode: ${diagnostic.diagnosticCode}
 ''';
             throw CaughtExceptionWithFiles(exception, stackTrace, {
               file: unitResult.content,
@@ -234,7 +234,10 @@ error.errorCode: ${error.diagnosticCode}
 
           if (fixes.isNotEmpty) {
             fixes.sort(Fix.compareFixes);
-            var serverError = newAnalysisError_fromEngine(unitResult, error);
+            var serverError = newAnalysisError_fromEngine(
+              unitResult,
+              diagnostic,
+            );
             var errorFixes = AnalysisErrorFixes(serverError);
             errorFixesList.add(errorFixes);
             for (var fix in fixes) {
@@ -282,16 +285,16 @@ error.errorCode: ${error.diagnosticCode}
     }
 
     var analysisOptions = fileResult.analysisOptions;
-    var errors = validatePubspec(
+    var diagnostics = validatePubspec(
       contents: node,
       source: FileSource(pubspecFile),
       provider: resourceProvider,
       analysisOptions: analysisOptions,
     );
-    for (var error in errors) {
+    for (var diagnostic in diagnostics) {
       var generator = PubspecFixGenerator(
         resourceProvider,
-        error,
+        diagnostic,
         content,
         node,
       );
@@ -310,10 +313,10 @@ error.errorCode: ${error.diagnosticCode}
           lineInfo: lineInfo,
           isLibrary: true,
           isPart: false,
-          errors: errors,
+          diagnostics: diagnostics,
           analysisOptions: analysisOptions,
         );
-        var serverError = newAnalysisError_fromEngine(result, error);
+        var serverError = newAnalysisError_fromEngine(result, diagnostic);
         var errorFixes = AnalysisErrorFixes(serverError);
         errorFixesList.add(errorFixes);
         for (var fix in fixes) {

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

@@ -49,9 +49,9 @@ class EditOrganizeDirectivesHandler extends LegacyHandler {
     var fileStamp = -1;
     var code = result.content;
     var unit = result.unit;
-    var errors = result.errors;
-    // check if there are scan/parse errors in the file
-    var numScanParseErrors = numberOfSyntacticErrors(errors);
+    var diagnostics = result.diagnostics;
+    // Check if there are scan/parse errors in the file.
+    var numScanParseErrors = numberOfSyntacticErrors(diagnostics);
     if (numScanParseErrors != 0) {
       sendResponse(
         Response.organizeDirectivesError(
@@ -62,7 +62,7 @@ class EditOrganizeDirectivesHandler extends LegacyHandler {
       return;
     }
     // do organize
-    var sorter = ImportOrganizer(code, unit, errors);
+    var sorter = ImportOrganizer(code, unit, diagnostics);
     var edits = sorter.organize();
     var fileEdit = SourceFileEdit(file, fileStamp, edits: edits);
     sendResult(EditOrganizeDirectivesResult(fileEdit));

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

@@ -50,9 +50,9 @@ class EditSortMembersHandler extends LegacyHandler {
     var fileStamp = -1;
     var code = result.content;
     var unit = result.unit;
-    var errors = result.errors;
+    var diagnostics = result.diagnostics;
     // Check if there are scan/parse errors in the file.
-    var numScanParseErrors = numberOfSyntacticErrors(errors);
+    var numScanParseErrors = numberOfSyntacticErrors(diagnostics);
     if (numScanParseErrors != 0) {
       sendResponse(
         Response.sortMembersParseErrors(request, numScanParseErrors),

pkg/analysis_server/lib/src/lsp/handlers/code_actions/abstract_code_actions_producer.dart

@@ -245,7 +245,7 @@ abstract class AbstractCodeActionsProducer
       lineInfo: lineInfo,
       isLibrary: true,
       isPart: false,
-      errors: diagnostics,
+      diagnostics: diagnostics,
       analysisOptions: analysisOptions,
     );
   }

pkg/analysis_server/lib/src/lsp/handlers/code_actions/dart.dart

@@ -212,7 +212,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
           willBeDeduplicated ? {} : null;
       var workspace = DartChangeWorkspace(await server.currentSessions);
       CorrectionUtils? correctionUtils;
-      for (var error in unitResult.errors) {
+      for (var error in unitResult.diagnostics) {
         // Return fixes for any part of the line where a diagnostic is.
         // If a diagnostic spans multiple lines, the fix will be included for
         // all of those lines.

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

@@ -52,7 +52,7 @@ class OrganizeImportsCommandHandler extends SimpleEditCommandHandler {
       var code = result.content;
       var unit = result.unit;
 
-      if (hasScanParseErrors(result.errors)) {
+      if (hasScanParseErrors(result.diagnostics)) {
         if (autoTriggered) {
           return success(null);
         }
@@ -66,7 +66,7 @@ class OrganizeImportsCommandHandler extends SimpleEditCommandHandler {
         );
       }
 
-      var organizer = ImportOrganizer(code, unit, result.errors);
+      var organizer = ImportOrganizer(code, unit, result.diagnostics);
       var edits = organizer.organize();
 
       if (edits.isEmpty) {

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

@@ -65,7 +65,7 @@ class SortMembersCommandHandler extends SimpleEditCommandHandler {
     var code = result.content;
     var unit = result.unit;
 
-    if (hasScanParseErrors(result.errors)) {
+    if (hasScanParseErrors(result.diagnostics)) {
       if (autoTriggered) {
         return success(null);
       }

pkg/analysis_server/lib/src/lsp/handlers/handler_format_on_type.dart

@@ -38,7 +38,7 @@ class FormatOnTypeHandler
     }
 
     var result = await server.getParsedUnit(path);
-    if (result == null || result.errors.isNotEmpty) {
+    if (result == null || result.diagnostics.isNotEmpty) {
       return success(null);
     }