[analysis_server] Fix an edit conflict renaming folders containing files that reference siblings

Renaming a folder with files that referenced each other would fail with edit conflicts. The pass over the first file would update the reference to the other (going from "a.dart" to "../old/a.dart" as if the other file wasn't moving too) and then then when processing the second file, it would try to update the import back.

It doesn't seem to ever make sense to update relative paths when the "other" file is also in the folder being renamed, so this skips them.

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

Author: DanTup

pkg/analysis_server/lib/src/services/refactoring/move_file.dart

@@ -26,7 +26,14 @@ class MoveFileRefactoringImpl extends RefactoringImpl
   late AnalysisDriver driver;
   late AnalysisSession _session;
 
+  /// The path provided by the client to be renamed from.
+  ///
+  /// May be a file or folder path.
   late String oldFile;
+
+  /// The path provided by the client to be renamed to.
+  ///
+  /// May be a file or folder path.
   late String newFile;
 
   final packagePrefixedStringPattern = RegExp(r'''^r?['"]+package:''');
@@ -144,6 +151,19 @@ class MoveFileRefactoringImpl extends RefactoringImpl
         await changeBuilder.addDartFileEdit(definingUnitResult.path, (builder) {
           for (var directive in definingUnitResult.unit.directives) {
             if (directive is UriBasedDirective) {
+              // If the import is relative and the referenced file is also in
+              // the moved folder, no update is necessary.
+              var uriContent = directive.uriContent;
+              var uriFullPath = directive.uriSource?.fullName;
+              if (uriContent != null &&
+                  uriFullPath != null &&
+                  pathContext.isRelative(uriContent) &&
+                  // `oldFile` is used here and not `oldDir` because we care
+                  // about whether this is within the folder being renamed, not
+                  // the folder for this specific resource.
+                  pathContext.isWithin(oldFile, uriFullPath)) {
+                continue;
+              }
               _updateUriReference(builder, directive, oldDir, newDir);
             }
           }
@@ -174,6 +194,16 @@ class MoveFileRefactoringImpl extends RefactoringImpl
         await refactoringWorkspace.searchEngine.searchReferences(element);
     var references = getSourceReferences(matches);
     for (var reference in references) {
+      // If the import is relative and the referencing file is also in
+      // the moved folder, no update is necessary.
+      var uriFullPath = reference.file;
+      if (!_isPackageReference(reference) &&
+          // `oldFile` is used here and not `oldDir` because we care
+          // about whether this is within the folder being renamed, not
+          // the folder for this specific resource.
+          pathContext.isWithin(oldFile, uriFullPath)) {
+        continue;
+      }
       await changeBuilder.addDartFileEdit(reference.file, (builder) {
         var newUri = _computeNewUri(reference, newPath);
         builder.addSimpleReplacement(reference.range, "'$newUri'");

pkg/analysis_server/test/services/refactoring/move_file_test.dart

@@ -375,6 +375,22 @@ import 'package:test/new/nested/d.dart';
             '${convertPath('/tmp')} does not belong to an analysis root.');
   }
 
+  Future<void> test_folder_siblingFiles() async {
+    testFile = convertPath('/home/test/lib/old/a.dart');
+    final pathB = convertPath('/home/test/lib/old/b.dart');
+    addSource(pathB, '');
+    await resolveTestCode('''
+import 'a.dart';
+''');
+    // Rename the whole 'old' folder to 'new''.
+    _createRefactoring('/home/test/lib/new', oldFile: '/home/test/lib/old');
+    await _assertSuccessfulRefactoring();
+    // No changes, because import was a relative path and both files are inside
+    // the renamed folder.
+    assertNoFileChange(testFile);
+    assertNoFileChange(pathB);
+  }
+
   Future<void> test_nonexistent_file_returns_failure() async {
     await resolveTestFile();
     _createRefactoring(convertPath('/home/test/test_missing_new.dart'),