[analysis_server] Migrate Overrides + DocumentationComputer

`DocumentComputer` currently makes use of `asElement2` to allow callers to still pass `Element`s so they can be migrated in separate CLs.

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

Author: DanTup

pkg/analysis_server/analyzer_use_new_elements.txt

@@ -40,6 +40,7 @@ lib/src/computer/computer_color.dart
 lib/src/computer/computer_folding.dart
 lib/src/computer/computer_highlights.dart
 lib/src/computer/computer_outline.dart
+lib/src/computer/computer_overrides.dart
 lib/src/computer/computer_selection_ranges.dart
 lib/src/context_manager.dart
 lib/src/domain_analysis_flags.dart
@@ -173,6 +174,7 @@ lib/src/lsp/semantic_tokens/legend.dart
 lib/src/lsp/semantic_tokens/mapping.dart
 lib/src/lsp/server_capabilities_computer.dart
 lib/src/lsp/snippets.dart
+lib/src/lsp/source_edits.dart
 lib/src/lsp/temporary_overlay_operation.dart
 lib/src/plugin/notification_manager.dart
 lib/src/plugin/plugin_locator.dart

pkg/analysis_server/lib/src/computer/computer_documentation.dart

@@ -3,8 +3,11 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/computer/computer_overrides.dart';
+import 'package:analysis_server/src/utilities/extensions/element.dart';
 import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/src/dartdoc/dartdoc_directive_info.dart';
+import 'package:analyzer/src/utilities/extensions/element.dart';
 
 /// Computes documentation for an [Element].
 class DartDocumentationComputer {
@@ -16,40 +19,49 @@ class DartDocumentationComputer {
     Element elementBeingDocumented, {
     bool includeSummary = false,
   }) {
-    Element? element = elementBeingDocumented;
-    if (element is FieldFormalParameterElement) {
-      element = element.field;
-    }
-    if (element is ParameterElement) {
-      element = element.enclosingElement3;
-    }
+    // TODO(dantup): Remove this temporary implementation used to split
+    //  migration of this class and callers into separate changes.
+    var element2 = elementBeingDocumented.asElement2;
+
+    return element2 != null
+        ? compute2(element2, includeSummary: includeSummary)
+        : null;
+  }
+
+  Documentation? compute2(
+    Element2 elementBeingDocumented, {
+    bool includeSummary = false,
+  }) {
+    var element = switch (elementBeingDocumented) {
+      FieldFormalParameterElement2() => elementBeingDocumented.field2,
+      FormalParameterElement() => elementBeingDocumented.enclosingElement2,
+      _ => elementBeingDocumented,
+    };
     if (element == null) {
       // This can happen when the code is invalid, such as having a field formal
       // parameter for a field that does not exist.
       return null;
     }
 
-    Element? documentedElement;
-    Element? documentedGetter;
+    Element2? documentedElement;
+    Element2? documentedGetter;
 
     // Look for documentation comments of overridden members
     var overridden = findOverriddenElements(element);
     var candidates = [
       element,
       ...overridden.superElements,
       ...overridden.interfaceElements,
-      if (element case PropertyAccessorElement(variable2: var variable?))
-        variable
+      if (element case GetterElement(variable3: var variable?)) variable,
+      if (element case SetterElement(variable3: var variable?)) variable
     ];
     for (var candidate in candidates) {
-      if (candidate.documentationComment != null) {
+      if (candidate.documentationCommentOrNull != null) {
         documentedElement = candidate;
         break;
       }
-      if (documentedGetter == null &&
-          candidate is PropertyAccessorElement &&
-          candidate.isSetter) {
-        var getter = candidate.correspondingGetter;
+      if (documentedGetter == null && candidate is SetterElement) {
+        var getter = candidate.correspondingGetter2;
         if (getter != null && getter.documentationComment != null) {
           documentedGetter = getter;
         }
@@ -62,16 +74,16 @@ class DartDocumentationComputer {
       return null;
     }
 
-    var rawDoc = documentedElement.documentationComment;
+    var rawDoc = documentedElement.documentationCommentOrNull;
     if (rawDoc == null) {
       return null;
     }
     var result =
         dartdocInfo.processDartdoc(rawDoc, includeSummary: includeSummary);
 
-    var documentedElementClass = documentedElement.enclosingElement3;
+    var documentedElementClass = documentedElement.enclosingElement2;
     if (documentedElementClass != null &&
-        documentedElementClass != element.enclosingElement3) {
+        documentedElementClass != element.enclosingElement2) {
       var documentedClass = documentedElementClass.displayName;
       result.full = '${result.full}\n\nCopied from `$documentedClass`.';
     }
@@ -83,11 +95,21 @@ class DartDocumentationComputer {
   /// docs (or `null`) depending on `preference`.
   String? computePreferred(
       Element element, DocumentationPreference preference) {
+    // TODO(dantup): Remove this temporary implementation used to split
+    //  migration of this class and callers into separate changes.
+    var element2 = element.asElement2;
+    return element2 != null ? computePreferred2(element2, preference) : null;
+  }
+
+  /// Compute documentation for [element] and return either the summary or full
+  /// docs (or `null`) depending on `preference`.
+  String? computePreferred2(
+      Element2 element, DocumentationPreference preference) {
     if (preference == DocumentationPreference.none) {
       return null;
     }
 
-    var doc = compute(
+    var doc = compute2(
       element,
       includeSummary: preference == DocumentationPreference.summary,
     );

pkg/analysis_server/lib/src/computer/computer_overrides.dart

@@ -6,14 +6,16 @@ import 'package:analysis_server/src/collections.dart';
 import 'package:analysis_server/src/protocol_server.dart' as proto;
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
+import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
+import 'package:collection/collection.dart';
 
 /// Return the elements that the given [element] overrides.
-OverriddenElements findOverriddenElements(Element element) {
-  if (element.enclosingElement3 is InterfaceElement) {
+OverriddenElements findOverriddenElements(Element2 element) {
+  if (element.enclosingElement2 is InterfaceElement2) {
     return _OverriddenElementsFinder(element).find();
   }
-  return OverriddenElements(element, <Element>[], <Element>[]);
+  return OverriddenElements(element, <Element2>[], <Element2>[]);
 }
 
 /// A computer for class member overrides in a Dart [CompilationUnit].
@@ -40,19 +42,19 @@ class DartUnitOverridesComputer {
   }
 
   /// Add a new [Override] for the declaration with the given name [token].
-  void _addOverride(Token token, Element? element) {
+  void _addOverride(Token token, Element2? element) {
     if (element != null) {
       var overridesResult = _OverriddenElementsFinder(element).find();
       var superElements = overridesResult.superElements;
       var interfaceElements = overridesResult.interfaceElements;
       if (superElements.isNotEmpty || interfaceElements.isNotEmpty) {
         var superMember = superElements.isNotEmpty
             ? proto.newOverriddenMember_fromEngine(
-                superElements.first.nonSynthetic)
+                superElements.first.nonSynthetic2)
             : null;
         var interfaceMembers = interfaceElements
             .map((member) =>
-                proto.newOverriddenMember_fromEngine(member.nonSynthetic))
+                proto.newOverriddenMember_fromEngine(member.nonSynthetic2))
             .toList();
         _overrides.add(proto.Override(token.offset, token.length,
             superclassMember: superMember,
@@ -67,15 +69,15 @@ class DartUnitOverridesComputer {
         if (classMember.isStatic) {
           continue;
         }
-        _addOverride(classMember.name, classMember.declaredElement);
+        _addOverride(classMember.name, classMember.declaredFragment?.element);
       }
       if (classMember is FieldDeclaration) {
         if (classMember.isStatic) {
           continue;
         }
         List<VariableDeclaration> fields = classMember.fields.variables;
         for (var field in fields) {
-          _addOverride(field.name, field.declaredElement);
+          _addOverride(field.name, field.declaredFragment?.element);
         }
       }
     }
@@ -85,58 +87,62 @@ class DartUnitOverridesComputer {
 /// The container with elements that a class member overrides.
 class OverriddenElements {
   /// The element that overrides other class members.
-  final Element element;
+  final Element2 element;
 
   /// The elements that [element] overrides and which is defined in a class that
   /// is a superclass of the class that defines [element].
-  final List<Element> superElements;
+  final List<Element2> superElements;
 
   /// The elements that [element] overrides and which is defined in a class that
   /// which is implemented by the class that defines [element].
-  final List<Element> interfaceElements;
+  final List<Element2> interfaceElements;
 
   OverriddenElements(this.element, this.superElements, this.interfaceElements);
 }
 
 class _OverriddenElementsFinder {
-  Element _seed;
-  LibraryElement _library;
-  InterfaceElement _class;
+  Element2 _seed;
+  LibraryElement2 _library;
+  InterfaceElement2 _class;
   String _name;
   List<ElementKind> _kinds;
 
-  final List<Element> _superElements = <Element>[];
-  final List<Element> _interfaceElements = <Element>[];
-  final Set<InterfaceElement> _visited = {};
+  final List<Element2> _superElements = <Element2>[];
+  final List<Element2> _interfaceElements = <Element2>[];
+  final Set<InterfaceElement2> _visited = {};
 
-  factory _OverriddenElementsFinder(Element seed) {
-    var class_ = seed.enclosingElement3 as InterfaceElement;
-    var library = class_.library;
+  factory _OverriddenElementsFinder(Element2 seed) {
+    var class_ = seed.enclosingElement2 as InterfaceElement2;
+    var library = class_.library2;
     var name = seed.displayName;
     List<ElementKind> kinds;
-    if (seed is FieldElement) {
+    if (seed is FieldElement2) {
       kinds = [
         ElementKind.GETTER,
         if (!seed.isFinal) ElementKind.SETTER,
       ];
-    } else if (seed is MethodElement) {
+    } else if (seed is MethodElement2) {
       kinds = const [ElementKind.METHOD];
-    } else if (seed is PropertyAccessorElement) {
-      kinds = seed.isGetter
-          ? const [ElementKind.GETTER]
-          : const [ElementKind.SETTER];
+    } else if (seed is GetterElement) {
+      kinds = const [ElementKind.GETTER];
+    } else if (seed is SetterElement) {
+      kinds = const [ElementKind.SETTER];
     } else {
       kinds = const [];
     }
     return _OverriddenElementsFinder._(seed, library, class_, name, kinds);
   }
 
   _OverriddenElementsFinder._(
-      this._seed, this._library, this._class, this._name, this._kinds);
+    this._seed,
+    this._library,
+    this._class,
+    this._name,
+    this._kinds,
+  );
 
   /// Add the [OverriddenElements] for this element.
   OverriddenElements find() {
-    _class = _class.augmented.declaration;
     _visited.clear();
     _addSuperOverrides(_class, withThisType: false);
     _visited.clear();
@@ -145,7 +151,7 @@ class _OverriddenElementsFinder {
     return OverriddenElements(_seed, _superElements, _interfaceElements);
   }
 
-  void _addInterfaceOverrides(InterfaceElement? class_, bool checkType) {
+  void _addInterfaceOverrides(InterfaceElement2? class_, bool checkType) {
     if (class_ == null) {
       return;
     }
@@ -161,13 +167,13 @@ class _OverriddenElementsFinder {
     }
     // interfaces
     for (var interfaceType in class_.interfaces) {
-      _addInterfaceOverrides(interfaceType.element, true);
+      _addInterfaceOverrides(interfaceType.element3, true);
     }
     // super
-    _addInterfaceOverrides(class_.supertype?.element, checkType);
+    _addInterfaceOverrides(class_.supertype?.element3, checkType);
   }
 
-  void _addSuperOverrides(InterfaceElement? class_,
+  void _addSuperOverrides(InterfaceElement2? class_,
       {bool withThisType = true}) {
     if (class_ == null) {
       return;
@@ -183,39 +189,47 @@ class _OverriddenElementsFinder {
       }
     }
 
-    _addSuperOverrides(class_.supertype?.element);
+    _addSuperOverrides(class_.supertype?.element3);
     for (var mixin_ in class_.mixins) {
-      _addSuperOverrides(mixin_.element);
+      _addSuperOverrides(mixin_.element3);
     }
-    if (class_ is MixinElement) {
+    if (class_ is MixinElement2) {
       for (var constraint in class_.superclassConstraints) {
-        _addSuperOverrides(constraint.element);
+        _addSuperOverrides(constraint.element3);
       }
     }
   }
 
-  Element? _lookupMember(InterfaceElement classElement) {
-    Element? member;
+  Element2? _lookupMember(InterfaceElement2 classElement) {
+    var name = Name.forLibrary(_library, _name);
+
+    /// Helper to find an element in [elements] that matches [targetName].
+    Element2? findMatchingElement(
+        Iterable<Element2> elements, Name targetName) {
+      return elements.firstWhereOrNull((Element2 element) {
+        var elementName = element.name3;
+        return elementName != null &&
+            Name.forLibrary(element.library2, elementName) == targetName;
+      });
+    }
+
     // method
     if (_kinds.contains(ElementKind.METHOD)) {
-      var augmented = classElement.augmented;
-      member = augmented.lookUpMethod(name: _name, library: _library);
+      var member = findMatchingElement(classElement.methods2, name);
       if (member != null) {
         return member;
       }
     }
     // getter
     if (_kinds.contains(ElementKind.GETTER)) {
-      var augmented = classElement.augmented;
-      member = augmented.lookUpGetter(name: _name, library: _library);
+      var member = findMatchingElement(classElement.getters2, name.forGetter);
       if (member != null) {
         return member;
       }
     }
     // setter
     if (_kinds.contains(ElementKind.SETTER)) {
-      var augmented = classElement.augmented;
-      member = augmented.lookUpSetter(name: '$_name=', library: _library);
+      var member = findMatchingElement(classElement.setters2, name.forSetter);
       if (member != null) {
         return member;
       }

pkg/analysis_server/lib/src/protocol_server.dart

@@ -329,9 +329,9 @@ Location newLocation_fromUnit(
 }
 
 /// Construct based on an element from the analyzer engine.
-OverriddenMember newOverriddenMember_fromEngine(engine.Element member) {
-  var element = convertElement(member);
-  var className = member.enclosingElement3!.displayName;
+OverriddenMember newOverriddenMember_fromEngine(engine.Element2 member) {
+  var element = convertElement2(member);
+  var className = member.enclosingElement2!.displayName;
   return OverriddenMember(element, className);
 }
 

pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_manager.dart

@@ -40,7 +40,7 @@ class TransformSetManager {
   /// Return the transform sets associated with the [library].
   List<TransformSet> forLibrary(LibraryElement2 library) {
     var transformSets = <TransformSet>[];
-    var analysisContext = library.session!.analysisContext;
+    var analysisContext = library.session.analysisContext;
     var workspace = analysisContext.contextRoot.workspace;
     var libraryPath = library.firstFragment.source.fullName;
     var package = workspace.findPackageFor(libraryPath);