analyzer plugins: Move DartFixContext and Impl to server_plugin

* Combine DartFixContext and DartFixContextImpl into one class;
  separation seems unnecessary.
* Change constructor (which was on DartFixContextImpl) to use all
  named parameters.
* Change `resolveResult` field to `resolvedResult`, since the type is
  called `ResolvedUnitResult`.
* Start doc comments with third person verbs [1].


[1]: https://dart.dev/effective-dart/documentation#prefer-starting-function-or-method-comments-with-third-person-verbs

Work towards #53402

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

Author: srawlins

pkg/analysis_server/lib/plugin/edit/fix/fix_dart.dart

@@ -3,9 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
-import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
-import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/instrumentation/service.dart';
@@ -14,7 +12,7 @@ import 'package:analyzer/src/dart/analysis/file_state.dart';
 import 'package:analyzer/src/dart/analysis/performance_logger.dart';
 import 'package:analyzer/src/dart/micro/resolve_file.dart';
 import 'package:analyzer/src/services/top_level_declarations.dart';
-import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:server_plugin/edit/fix/fix.dart';
 
 class CiderErrorFixes {
@@ -52,9 +50,9 @@ class CiderFixesComputer {
           var workspace = DartChangeWorkspace([resolvedUnit.session]);
           var context = _CiderDartFixContextImpl(
             _fileResolver,
-            workspace,
-            resolvedUnit,
-            error,
+            workspace: workspace,
+            resolvedResult: resolvedUnit,
+            error: error,
           );
 
           var fixes = await computeFixes(context);
@@ -71,16 +69,15 @@ class CiderFixesComputer {
   }
 }
 
-class _CiderDartFixContextImpl extends DartFixContextImpl {
+class _CiderDartFixContextImpl extends DartFixContext {
   final FileResolver _fileResolver;
 
   _CiderDartFixContextImpl(
-    this._fileResolver,
-    ChangeWorkspace workspace,
-    ResolvedUnitResult resolvedUnit,
-    AnalysisError error,
-  ) : super(InstrumentationService.NULL_SERVICE, workspace, resolvedUnit,
-            error);
+    this._fileResolver, {
+    required super.workspace,
+    required super.resolvedResult,
+    required super.error,
+  }) : super(instrumentationService: InstrumentationService.NULL_SERVICE);
 
   @override
   Future<Map<LibraryElement, Element>> getTopLevelDeclarations(

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

@@ -15,6 +15,7 @@ import 'package:analyzer/instrumentation/service.dart';
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/src/dart/error/lint_codes.dart';
 import 'package:collection/collection.dart';
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:server_plugin/edit/fix/fix.dart';
 
 /// The root of a set of classes that support testing for lint fixes.
@@ -92,11 +93,11 @@ class LintFixTester {
     }
 
     var workspace = DartChangeWorkspace([analysisSession]);
-    var context = DartFixContextImpl(
-      InstrumentationService.NULL_SERVICE,
-      workspace,
-      unitResult,
-      error,
+    var context = DartFixContext(
+      instrumentationService: InstrumentationService.NULL_SERVICE,
+      workspace: workspace,
+      resolvedResult: unitResult,
+      error: error,
     );
 
     List<Fix> fixes;

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

@@ -10,7 +10,6 @@ import 'package:analysis_server/src/plugin/result_converter.dart';
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analysis_server/src/request_handler_mixin.dart';
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
-import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/fix/analysis_options/fix_generator.dart';
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_generator.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
@@ -29,6 +28,7 @@ import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/file_paths.dart';
 import 'package:analyzer/src/workspace/pub.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 
@@ -178,8 +178,12 @@ class EditGetFixesHandler extends LegacyHandler
           var workspace = DartChangeWorkspace(
             await server.currentSessions,
           );
-          var context = DartFixContextImpl(
-              server.instrumentationService, workspace, result, error);
+          var context = DartFixContext(
+            instrumentationService: server.instrumentationService,
+            workspace: workspace,
+            resolvedResult: result,
+            error: error,
+          );
 
           List<Fix> fixes;
           try {

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

@@ -13,7 +13,6 @@ import 'package:analysis_server/src/protocol_server.dart'
 import 'package:analysis_server/src/services/correction/assist.dart';
 import 'package:analysis_server/src/services/correction/assist_internal.dart';
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
-import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
 import 'package:analysis_server/src/services/refactoring/framework/refactoring_context.dart';
 import 'package:analysis_server/src/services/refactoring/framework/refactoring_processor.dart';
@@ -23,6 +22,7 @@ import 'package:analyzer/dart/analysis/session.dart'
     show InconsistentAnalysisException;
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/src/dart/ast/utilities.dart';
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 
 /// Produces [CodeAction]s from Dart source commands, fixes, assists and
 /// refactors from the server.
@@ -169,8 +169,12 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
             range.start.line > errorEndLine) {
           continue;
         }
-        var context = DartFixContextImpl(
-            server.instrumentationService, workspace, unit, error);
+        var context = DartFixContext(
+          instrumentationService: server.instrumentationService,
+          workspace: workspace,
+          resolvedResult: unit,
+          error: error,
+        );
         final fixes = await computeFixes(context);
         if (fixes.isNotEmpty) {
           final diagnostic = toDiagnostic(

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

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:_fe_analyzer_shared/src/scanner/errors.dart';
-import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/protocol/protocol_generated.dart'
     hide AnalysisOptions;
 import 'package:analysis_server/src/lsp/source_edits.dart';
@@ -12,8 +11,9 @@ import 'package:analysis_server/src/services/correction/dart/abstract_producer.d
 import 'package:analysis_server/src/services/correction/dart/data_driven.dart';
 import 'package:analysis_server/src/services/correction/dart/organize_imports.dart';
 import 'package:analysis_server/src/services/correction/dart/remove_unused_import.dart';
-import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analysis_server/src/services/correction/fix/pubspec/fix_generator.dart';
 import 'package:analysis_server/src/services/correction/fix_processor.dart';
+import 'package:analysis_server/src/services/correction/organize_imports.dart';
 import 'package:analysis_server/src/services/linter/lint_names.dart';
 import 'package:analyzer/dart/analysis/analysis_context.dart';
 import 'package:analyzer/dart/analysis/results.dart';
@@ -48,12 +48,10 @@ import 'package:analyzer_plugin/protocol/protocol_common.dart'
 import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/conflicting_edit_exception.dart';
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 
-import 'fix/pubspec/fix_generator.dart';
-import 'organize_imports.dart';
-
 /// A fix producer that produces changes that will fix multiple diagnostics in
 /// one or more files.
 ///
@@ -596,15 +594,15 @@ class BulkFixProcessor {
     var analysisOptions =
         unit.session.analysisContext.getAnalysisOptionsForFile(unit.file);
 
-    DartFixContextImpl fixContext(
+    DartFixContext fixContext(
       AnalysisError diagnostic, {
       required bool autoTriggered,
     }) {
-      return DartFixContextImpl(
-        instrumentationService,
-        workspace,
-        unit,
-        diagnostic,
+      return DartFixContext(
+        instrumentationService: instrumentationService,
+        workspace: workspace,
+        resolvedResult: unit,
+        error: diagnostic,
         autoTriggered: autoTriggered,
       );
     }

pkg/analysis_server/lib/src/services/correction/bulk_fix_processor.dart

@@ -5,7 +5,6 @@
 import 'dart:math' as math;
 
 import 'package:_fe_analyzer_shared/src/scanner/token.dart';
-import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/src/services/correction/util.dart';
 import 'package:analysis_server/src/utilities/selection.dart';
 import 'package:analyzer/dart/analysis/code_style_options.dart';
@@ -34,6 +33,7 @@ import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
+import 'package:server_plugin/edit/fix/dart_fix_context.dart';
 
 /// An object that can compute a correction (fix or assist) in a Dart file.
 abstract class CorrectionProducer<T extends ParsedUnitResult>
@@ -582,7 +582,7 @@ abstract class _AbstractCorrectionProducer<T extends ParsedUnitResult> {
   AnalysisSessionHelper get sessionHelper => _context.sessionHelper;
 
   bool get strictCasts {
-    var file = _context.dartFixContext?.resolveResult.file;
+    var file = _context.dartFixContext?.resolvedResult.file;
     // TODO(pq): can this ever happen?
     if (file == null) return false;
     var analysisOptions = _context.session.analysisContext

pkg/analysis_server/lib/src/services/correction/dart/abstract_producer.dart

@@ -2,15 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_dart.dart';
-import 'package:analyzer/dart/analysis/results.dart';
-import 'package:analyzer/dart/element/element.dart';
-import 'package:analyzer/error/error.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';
-import 'package:analyzer/src/services/top_level_declarations.dart';
-import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 
 /// An enumeration of quick fix kinds for the errors found in an analysis
@@ -38,59 +29,6 @@ class AnalysisOptionsFixKind {
   );
 }
 
-/// The implementation of [DartFixContext].
-class DartFixContextImpl implements DartFixContext {
-  @override
-  final InstrumentationService instrumentationService;
-
-  @override
-  final ChangeWorkspace workspace;
-
-  @override
-  final ResolvedUnitResult resolveResult;
-
-  @override
-  final AnalysisError error;
-
-  @override
-  final bool autoTriggered;
-
-  DartFixContextImpl(this.instrumentationService, this.workspace,
-      this.resolveResult, this.error,
-      {this.autoTriggered = false});
-
-  @override
-  Future<Map<LibraryElement, Element>> getTopLevelDeclarations(
-      String name) async {
-    return TopLevelDeclarations(resolveResult).withName(name);
-  }
-
-  @override
-  Stream<LibraryElement> librariesWithExtensions(String memberName) async* {
-    var analysisContext = resolveResult.session.analysisContext;
-    var analysisDriver = (analysisContext as DriverBasedAnalysisContext).driver;
-    await analysisDriver.discoverAvailableFiles();
-
-    var fsState = analysisDriver.fsState;
-    var filter = FileStateFilter(
-      fsState.getFileForPath(resolveResult.path),
-    );
-
-    for (var file in fsState.knownFiles.toList()) {
-      if (!filter.shouldInclude(file)) {
-        continue;
-      }
-
-      var elementResult = await analysisDriver.getLibraryByUri(file.uriStr);
-      if (elementResult is! LibraryElementResult) {
-        continue;
-      }
-
-      yield elementResult.element;
-    }
-  }
-}
-
 /// An enumeration of quick fix kinds found in a Dart file.
 class DartFixKind {
   static const ADD_ASYNC = FixKind(
@@ -1911,11 +1849,8 @@ class DartFixKind {
     DartFixKindPriority.IN_FILE,
     "Use x.isNotEmpty instead of '!x.isEmpty' everywhere in file",
   );
-  static const USE_NAMED_CONSTANTS = FixKind(
-    'dart.fix.use.namedConstants',
-    DartFixKindPriority.DEFAULT,
-    'Replace with a predefined named constant'
-  );
+  static const USE_NAMED_CONSTANTS = FixKind('dart.fix.use.namedConstants',
+      DartFixKindPriority.DEFAULT, 'Replace with a predefined named constant');
   static const USE_NOT_EQ_NULL = FixKind(
     'dart.fix.use.notEqNull',
     DartFixKindPriority.DEFAULT,