Change rename class member refactoring to allow renaming chained super formal parameters, and renaming field formal parameters to private.

Bug: #60803

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

Author: fshcheglov

pkg/analysis_server/lib/src/services/refactoring/legacy/rename_class_member.dart

@@ -103,21 +103,6 @@ class RenameClassMemberRefactoringImpl extends RenameRefactoringImpl {
         processor.addDeclarationEdit(renameElement.setter);
       } else {
         processor.addDeclarationEdit(renameElement);
-        if (!newName.startsWith('_')) {
-          var interfaceElement = renameElement.enclosingElement;
-          if (interfaceElement is InterfaceElement) {
-            for (var constructor in interfaceElement.constructors) {
-              for (var parameter in constructor.formalParameters) {
-                if (parameter is FieldFormalParameterElement &&
-                    parameter.field == renameElement) {
-                  await searchEngine
-                      .searchReferences(parameter)
-                      .then(processor.addReferenceEdits);
-                }
-              }
-            }
-          }
-        }
       }
     }
     await _updateReferences();
@@ -201,6 +186,10 @@ class RenameClassMemberRefactoringImpl extends RenameRefactoringImpl {
         continue;
       }
 
+      if (element is FormalParameterElement) {
+        continue;
+      }
+
       if (unshadowed.contains(reference.element) &&
           reference.element is ExecutableElement) {
         await _addThisEdit(reference, newName);
@@ -537,6 +526,30 @@ class _RenameClassMemberValidator extends _BaseClassMemberValidator {
     } else {
       elements = {element};
     }
+
+    if (element is FieldElement) {
+      var interfaceElement = element.enclosingElement;
+      if (interfaceElement is InterfaceElement &&
+          interfaceElement is! ExtensionTypeElement) {
+        var formalParameters =
+            interfaceElement.constructors
+                .expand((constructor) => constructor.formalParameters)
+                .whereType<FieldFormalParameterElement>()
+                .where((formalParameter) => formalParameter.field == element)
+                .cast<FormalParameterElement>()
+                .toList();
+
+        // The language doesn't allow private named formal parameters.
+        if (name.startsWith('_')) {
+          formalParameters.removeWhere((formalParameter) {
+            return formalParameter.isNamed;
+          });
+        }
+
+        await addNamedSuperFormalParameters(searchEngine, formalParameters);
+        elements.addAll(formalParameters);
+      }
+    }
   }
 
   /// Fills [references] with all references to [elements].

pkg/analysis_server/lib/src/services/refactoring/legacy/rename_parameter.dart

@@ -133,17 +133,7 @@ class RenameParameterRefactoringImpl extends RenameRefactoringImpl {
     var element = this.element;
     if (element.isNamed) {
       elements = await getHierarchyNamedParameters(searchEngine, element);
-
-      // Iteratively collect superFormalParameter(s) of subclasses.
-      for (var i = 0; i < elements.length; i++) {
-        var element = elements[i];
-        var references = await searchEngine.searchReferences(element);
-        elements.addAll(
-          references
-              .map((match) => match.element)
-              .whereType<analyzer.SuperFormalParameterElement>(),
-        );
-      }
+      await addNamedSuperFormalParameters(searchEngine, elements);
     } else if (element.isPositional) {
       elements = await getHierarchyPositionalParameters(searchEngine, element);
     }

pkg/analysis_server/lib/src/services/search/hierarchy.dart

@@ -7,6 +7,25 @@ import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/src/util/performance/operation_performance.dart';
 
+/// Expand [formalParameters] to include all chains of super formals.
+Future<void> addNamedSuperFormalParameters(
+  SearchEngine searchEngine,
+  List<FormalParameterElement> formalParameters,
+) async {
+  // Indexed-based loop to allow modification while iterating.
+  for (var i = 0; i < formalParameters.length; i++) {
+    var formalParameter = formalParameters[i];
+    if (formalParameter.isNamed) {
+      var references = await searchEngine.searchReferences(formalParameter);
+      formalParameters.addAll(
+        references
+            .map((match) => match.element)
+            .whereType<SuperFormalParameterElement>(),
+      );
+    }
+  }
+}
+
 /// Returns direct children of [parent].
 List<Element> getChildren(Element parent, [String? name]) {
   var children = <Element>[];
@@ -153,9 +172,7 @@ getHierarchyMembersAndParameters(
       subClasses.add(superClass);
     }
     if (member2.isPrivate) {
-      subClasses.removeWhere(
-        (subClass) => subClass.library != member2.library,
-      );
+      subClasses.removeWhere((subClass) => subClass.library != member2.library);
     }
     for (var subClass in subClasses) {
       var subClassMembers = getChildren(subClass, name);

pkg/analysis_server/test/services/refactoring/legacy/rename_class_member_test.dart

@@ -786,6 +786,72 @@ void f() {
 ''');
   }
 
+  Future<void>
+  test_createChange_FieldElement_fieldFormalParameter_named_superChain() async {
+    await indexTestUnit('''
+class A {
+  final int tes^t;
+  A({required this.test});
+}
+
+class B extends A {
+  B({required super.test});
+}
+
+class C extends B {
+  C({required super.test});
+}
+''');
+
+    createRenameRefactoring();
+    expect(refactoring.refactoringName, 'Rename Field');
+    expect(refactoring.elementKindName, 'field');
+    refactoring.newName = 'newName';
+
+    return assertSuccessfulRefactoring('''
+class A {
+  final int newName;
+  A({required this.newName});
+}
+
+class B extends A {
+  B({required super.newName});
+}
+
+class C extends B {
+  C({required super.newName});
+}
+''');
+  }
+
+  Future<void>
+  test_createChange_FieldElement_fieldFormalParameter_positional_toPrivate() async {
+    await indexTestUnit('''
+class A {
+  int te^st;
+  int foo;
+  A(this.test): assert(test != 0), foo = test {
+    test;
+  }
+}
+''');
+    // configure refactoring
+    createRenameRefactoring();
+    expect(refactoring.refactoringName, 'Rename Field');
+    expect(refactoring.oldName, 'test');
+    refactoring.newName = '_test';
+    // validate change
+    return assertSuccessfulRefactoring('''
+class A {
+  int _test;
+  int foo;
+  A(this._test): assert(_test != 0), foo = _test {
+    _test;
+  }
+}
+''');
+  }
+
   Future<void> test_createChange_FieldElement_invocation() async {
     await indexTestUnit('''
 typedef F(a);