[DAS] Fixes "Add import" fixes to show relative import for extensions

Fixes: #60972
Change-Id: I3fbde7115d1439a8dd2a6ab588e8c339d66660a5
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/442708
Reviewed-by: Brian Wilkerson <[email protected]>
Auto-Submit: Felipe Morschel <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>

Author: FMorschel

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

@@ -227,6 +227,7 @@ class ImportLibrary extends MultiCorrectionProducer {
     String name,
     List<ElementKind> kinds, {
     String? prefix,
+    bool canBePrefixed = true,
   }) async {
     // Ignore the element if the name is private.
     if (name.startsWith('_')) {
@@ -252,7 +253,6 @@ class ImportLibrary extends MultiCorrectionProducer {
       if (!kinds.contains(element.kind)) {
         continue;
       }
-      var importPrefix = import.prefix?.element;
       // Maybe update a "show"/"hide" directive.
       var (
         combinatorProducer,
@@ -265,7 +265,8 @@ class ImportLibrary extends MultiCorrectionProducer {
         prefix: prefix,
       );
       // Maybe apply a prefix.
-      if (importPrefix != null) {
+      var importPrefix = import.prefix?.element;
+      if (canBePrefixed && importPrefix != null) {
         producers.add(
           _ImportLibraryPrefix(
             libraryElement,
@@ -397,74 +398,52 @@ class ImportLibrary extends MultiCorrectionProducer {
     // additional analysis.
     var foundImport = false;
     var names = <_PrefixedName>[];
+    var extensionsInLibrary =
+        <LibraryImport?, List<InstantiatedExtensionWithMember>>{};
     for (var import in unitResult.libraryFragment.libraryImports) {
-      // prepare element
       var importedLibrary = import.importedLibrary;
       if (importedLibrary == null || importedLibrary != libraryToImport) {
         continue;
       }
       foundImport = true;
-      var instantiatedExtensions = importedLibrary.exportedExtensions
+      extensionsInLibrary[import] = importedLibrary.exportedExtensions
           .havingMemberWithBaseName(memberName)
           .applicableTo(
             targetLibrary: libraryElement2,
             targetType: targetType as TypeImpl,
           );
-      for (var instantiatedExtension in instantiatedExtensions) {
-        // If the import has a combinator that needs to be updated, then offer
-        // to update it.
-        var libraryElement = import.importedLibrary;
-        if (libraryElement == null) {
-          continue;
-        }
+    }
+
+    // If the library at the URI is not already imported, we return a correction
+    // producer that will either add an import or not based on the result of
+    // analyzing the library.
+    if (!foundImport) {
+      extensionsInLibrary[null] = libraryToImport.exportedExtensions
+          .havingMemberWithBaseName(memberName)
+          .applicableTo(
+            targetLibrary: libraryElement2,
+            targetType: targetType as TypeImpl,
+          );
+    }
+    for (var entry in extensionsInLibrary.entries) {
+      var extensionsInLibrary = entry.value;
+      for (var instantiatedExtension in extensionsInLibrary) {
         names.add(
           _PrefixedName(
             name: instantiatedExtension.extension.name!,
             ignorePrefix: true,
             producerGenerators: (prefix, name) async {
-              var producers = <ResolvedCorrectionProducer>[];
-              var (
-                importLibraryCombinator,
-                importLibraryCombinatorMultiple,
-              ) = await _importEditCombinators(
-                import,
-                libraryElement,
-                libraryToImport.uri.toString(),
+              return await _importLibraryForElement(
                 name,
+                prefix: prefix,
+                canBePrefixed: false,
+                [ElementKind.EXTENSION],
               );
-              if (importLibraryCombinator != null) {
-                producers.add(importLibraryCombinator);
-                if (importLibraryCombinatorMultiple != null) {
-                  producers.add(importLibraryCombinatorMultiple);
-                }
-              }
-              return producers;
             },
           ),
         );
       }
     }
-
-    // If the library at the URI is not already imported, we return a correction
-    // producer that will either add an import or not based on the result of
-    // analyzing the library.
-    if (!foundImport) {
-      names.add(
-        _PrefixedName(
-          name: memberName.name,
-          producerGenerators: (prefix, name) async {
-            return [
-              _ImportLibraryContainingExtension(
-                libraryToImport,
-                targetType,
-                memberName,
-                context: context,
-              ),
-            ];
-          },
-        ),
-      );
-    }
     return names;
   }
 
@@ -914,8 +893,7 @@ class _ImportLibraryCombinatorMultiple extends ResolvedCorrectionProducer {
       if (names.isNotEmpty) {
         newCombinatorCode = ' ${keyword.lexeme} ${names.join(', ')}';
       }
-      var libraryPath =
-          unitResult.libraryElement.firstFragment.source.fullName;
+      var libraryPath = unitResult.libraryElement.firstFragment.source.fullName;
       await builder.addDartFileEdit(libraryPath, (builder) {
         builder.addSimpleReplacement(
           SourceRange(offset - 1, length + 1),
@@ -940,55 +918,6 @@ class _ImportLibraryCombinatorMultiple extends ResolvedCorrectionProducer {
   }
 }
 
-/// A correction processor that can add an import of a library containing an
-/// extension, but which does so only if the extension applies to a given type.
-class _ImportLibraryContainingExtension extends ResolvedCorrectionProducer {
-  /// The library defining the extension.
-  LibraryElement library;
-
-  /// The type of the target that the extension must apply to.
-  DartType targetType;
-
-  /// The name of the member that the extension must declare.
-  Name memberName;
-
-  /// The URI that is being proposed for the import directive.
-  String _uriText = '';
-
-  _ImportLibraryContainingExtension(
-    this.library,
-    this.targetType,
-    this.memberName, {
-    required super.context,
-  });
-
-  @override
-  CorrectionApplicability get applicability =>
-      // TODO(applicability): comment on why.
-      CorrectionApplicability.singleLocation;
-
-  @override
-  List<String> get fixArguments => [_uriText];
-
-  @override
-  FixKind get fixKind => DartFixKind.IMPORT_LIBRARY_PROJECT1;
-
-  @override
-  Future<void> compute(ChangeBuilder builder) async {
-    var instantiatedExtensions = library.exportedExtensions
-        .havingMemberWithBaseName(memberName)
-        .applicableTo(
-          targetLibrary: libraryElement2,
-          targetType: targetType as TypeImpl,
-        );
-    if (instantiatedExtensions.isNotEmpty) {
-      await builder.addDartFileEdit(file, (builder) {
-        _uriText = builder.importLibrary(library.uri);
-      });
-    }
-  }
-}
-
 /// A correction processor that can add a prefix to an identifier defined in a
 /// library that is already imported but that is imported with a prefix.
 class _ImportLibraryPrefix extends ResolvedCorrectionProducer {

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

@@ -910,61 +910,91 @@ abstract final class DartFixKind {
     DartFixKindPriority.standard + 5,
     "Use imported library '{0}' with prefix '{1}'",
   );
+
+  /// {@template dart.fix.import.libraryProject1}
+  /// Import defining library.
+  /// {@endtemplate}
   static const IMPORT_LIBRARY_PROJECT1 = FixKind(
     'dart.fix.import.libraryProject1',
     DartFixKindPriority.standard + 3,
     "Import library '{0}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject1}
   static const IMPORT_LIBRARY_PROJECT1_PREFIXED = FixKind(
     'dart.fix.import.libraryProject1Prefixed',
     DartFixKindPriority.standard + 3,
     "Import library '{0}' with prefix '{1}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject1}
   static const IMPORT_LIBRARY_PROJECT1_PREFIXED_SHOW = FixKind(
     'dart.fix.import.libraryProject1PrefixedShow',
     DartFixKindPriority.standard + 3,
     "Import library '{0}' with prefix '{1}' and 'show'",
   );
+
+  /// {@macro dart.fix.import.libraryProject1}
   static const IMPORT_LIBRARY_PROJECT1_SHOW = FixKind(
     'dart.fix.import.libraryProject1Show',
     DartFixKindPriority.standard + 3,
     "Import library '{0}' with 'show'",
   );
+
+  /// {@template dart.fix.import.libraryProject2}
+  /// Import export library.
+  /// {@endtemplate}
   static const IMPORT_LIBRARY_PROJECT2 = FixKind(
     'dart.fix.import.libraryProject2',
     DartFixKindPriority.standard + 2,
     "Import library '{0}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject2}
   static const IMPORT_LIBRARY_PROJECT2_PREFIXED = FixKind(
     'dart.fix.import.libraryProject2Prefixed',
     DartFixKindPriority.standard + 2,
     "Import library '{0}' with prefix '{1}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject2}
   static const IMPORT_LIBRARY_PROJECT2_PREFIXED_SHOW = FixKind(
     'dart.fix.import.libraryProject2PrefixedShow',
     DartFixKindPriority.standard + 2,
     "Import library '{0}' with prefix '{1}' and 'show'",
   );
+
+  /// {@macro dart.fix.import.libraryProject2}
   static const IMPORT_LIBRARY_PROJECT2_SHOW = FixKind(
     'dart.fix.import.libraryProject2Show',
     DartFixKindPriority.standard + 2,
     "Import library '{0}' with 'show'",
   );
+
+  /// {@template dart.fix.import.libraryProject3}
+  /// Import non-API.
+  /// {@endtemplate}
   static const IMPORT_LIBRARY_PROJECT3 = FixKind(
     'dart.fix.import.libraryProject3',
     DartFixKindPriority.standard + 1,
     "Import library '{0}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject3}
   static const IMPORT_LIBRARY_PROJECT3_PREFIXED = FixKind(
     'dart.fix.import.libraryProject3Prefixed',
     DartFixKindPriority.standard + 1,
     "Import library '{0}' with prefix '{1}'",
   );
+
+  /// {@macro dart.fix.import.libraryProject3}
   static const IMPORT_LIBRARY_PROJECT3_PREFIXED_SHOW = FixKind(
     'dart.fix.import.libraryProject3PrefixedShow',
     DartFixKindPriority.standard + 1,
     "Import library '{0}' with prefix '{1}' and 'show'",
   );
+
+  /// {@macro dart.fix.import.libraryProject3}
   static const IMPORT_LIBRARY_PROJECT3_SHOW = FixKind(
     'dart.fix.import.libraryProject3Show',
     DartFixKindPriority.standard + 1,

pkg/analysis_server/test/src/services/correction/fix/import_library_project_test.dart

@@ -469,6 +469,26 @@ class B extends A {
 ''');
   }
 
+  Future<void> test_extension_notImported_lint() async {
+    newFile('$testPackageLibPath/lib.dart', '''
+extension E on int {
+  void m() {}
+}
+''');
+    await resolveTestCode('''
+void f(int o) {
+  o.m();
+}
+''');
+    await assertHasFix('''
+import 'lib.dart';
+
+void f(int o) {
+  o.m();
+}
+''', matchFixMessage: "Import library 'lib.dart'");
+  }
+
   Future<void> test_extension_notImported_method() async {
     newFile('$testPackageLibPath/lib.dart', '''
 extension E on String {
@@ -636,44 +656,6 @@ void f(String s) {
 ''');
   }
 
-  Future<void> test_extension_otherPackage_exported_fromSrc() async {
-    var pkgRootPath = '$packagesRootPath/aaa';
-
-    newFile('$pkgRootPath/lib/a.dart', r'''
-export 'src/b.dart';
-''');
-
-    newFile('$pkgRootPath/lib/src/b.dart', r'''
-extension IntExtension on int {
-  int get foo => 0;
-}
-''');
-
-    writeTestPackageConfig(
-      config:
-          PackageConfigFileBuilder()..add(name: 'aaa', rootPath: pkgRootPath),
-    );
-
-    updateTestPubspecFile('''
-dependencies:
-  aaa: any
-''');
-
-    await resolveTestCode('''
-void f() {
-  0.foo;
-}
-''');
-
-    await assertHasFix('''
-import 'package:aaa/a.dart';
-
-void f() {
-  0.foo;
-}
-''');
-  }
-
   Future<void> test_extensionType_name_notImported() async {
     newFile('$testPackageLibPath/lib.dart', '''
 extension type ET(String it) {}
@@ -2248,6 +2230,44 @@ void f() {}
 ''');
   }
 
+  Future<void> test_extension_otherPackage_exported_fromSrc() async {
+    var pkgRootPath = '$packagesRootPath/aaa';
+
+    newFile('$pkgRootPath/lib/a.dart', r'''
+export 'src/b.dart';
+''');
+
+    newFile('$pkgRootPath/lib/src/b.dart', r'''
+extension IntExtension on int {
+  int get foo => 0;
+}
+''');
+
+    writeTestPackageConfig(
+      config:
+          PackageConfigFileBuilder()..add(name: 'aaa', rootPath: pkgRootPath),
+    );
+
+    updateTestPubspecFile('''
+dependencies:
+  aaa: any
+''');
+
+    await resolveTestCode('''
+void f() {
+  0.foo;
+}
+''');
+
+    await assertHasFix('''
+import 'package:aaa/a.dart';
+
+void f() {
+  0.foo;
+}
+''');
+  }
+
   Future<void> test_lib() async {
     newFile('$packagesRootPath/my_pkg/lib/a.dart', '''
 export 'b.dart';