[analysis_server] Use public (non-src) URIs for Flutter snippet imports

Fixes #49081.

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

Author: DanTup

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

@@ -5,7 +5,6 @@
 import 'package:analysis_server/plugin/edit/fix/fix_core.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/dart/top_level_declarations.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';
@@ -15,6 +14,7 @@ import 'package:analyzer/source/line_info.dart';
 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';
 
 class CiderErrorFixes {

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

@@ -519,6 +519,9 @@ class CompletionHandler extends MessageHandler<CompletionParams, CompletionList>
         try {
           unrankedResults =
               await performance.runAsync('getSnippets', (performance) async {
+            // TODO(dantup): Pass `fuzzy` into here so we can filter snippets
+            //  before computing them to avoid looking up Element->Public Library
+            //  if they won't be included.
             final snippets = await _getDartSnippetItems(
               clientCapabilities: capabilities,
               unit: unit,

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

@@ -4,13 +4,13 @@
 
 import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/src/services/correction/fix/dart/extensions.dart';
-import 'package:analysis_server/src/services/correction/fix/dart/top_level_declarations.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';
 import 'package:analyzer/src/error/codes.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';
 

pkg/analysis_server/lib/src/services/snippets/dart/flutter_stateful_widget.dart

@@ -31,7 +31,9 @@ class FlutterStatefulWidget extends FlutterSnippetProducer
     final classStatefulWidget = this.classStatefulWidget!;
     final classState = this.classState!;
 
-    await builder.addDartFileEdit(request.filePath, (builder) {
+    await builder.addDartFileEdit(request.filePath, (builder) async {
+      await addImports(builder);
+
       builder.addReplacement(request.replacementRange, (builder) {
         // Write the StatefulWidget class
         builder.writeClassDeclaration(

pkg/analysis_server/lib/src/services/snippets/dart/flutter_stateful_widget_with_animation.dart

@@ -37,7 +37,9 @@ class FlutterStatefulWidgetWithAnimationController
     final classSingleTickerProviderStateMixin =
         this.classSingleTickerProviderStateMixin!;
 
-    await builder.addDartFileEdit(request.filePath, (builder) {
+    await builder.addDartFileEdit(request.filePath, (builder) async {
+      await addImports(builder);
+
       builder.addReplacement(request.replacementRange, (builder) {
         // Write the StatefulWidget class
         builder.writeClassDeclaration(

pkg/analysis_server/lib/src/services/snippets/dart/flutter_stateless_widget.dart

@@ -28,7 +28,9 @@ class FlutterStatelessWidget extends FlutterSnippetProducer
     // Checked by isValid().
     final classStatelessWidget = this.classStatelessWidget!;
 
-    await builder.addDartFileEdit(request.filePath, (builder) {
+    await builder.addDartFileEdit(request.filePath, (builder) async {
+      await addImports(builder);
+
       builder.addReplacement(request.replacementRange, (builder) {
         builder.writeClassDeclaration(
           widgetClassName,

pkg/analysis_server/lib/src/services/snippets/snippet_producer.dart

@@ -13,6 +13,8 @@ import 'package:analyzer/dart/element/nullability_suffix.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/src/dart/analysis/session_helper.dart';
 import 'package:analyzer/src/lint/linter.dart';
+import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_dart.dart'
+    show DartFileEditBuilderImpl;
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart';
 import 'package:meta/meta.dart';
 
@@ -50,13 +52,38 @@ abstract class FlutterSnippetProducer extends DartSnippetProducer {
   late ClassElement? classWidget;
   late ClassElement? classPlaceholder;
 
+  /// Elements that need to be imported for generated code to be valid.
+  ///
+  /// Calling [getClass] or [getMixin] records elements in this set.
+  /// Calling [addImports] will add any required imports to the supplied
+  /// builder.
+  final Set<Element> _requiredElementImports = {};
+
   FlutterSnippetProducer(super.request);
 
-  Future<ClassElement?> getClass(String name) =>
-      sessionHelper.getClass(flutter.widgetsUri, name);
+  /// Adds public imports for any elements fetched by [getClass] and [getMixin]
+  /// to [builder].
+  Future<void> addImports(DartFileEditBuilder builder) async {
+    final dartBuilder = builder as DartFileEditBuilderImpl;
+    await Future.wait(
+        _requiredElementImports.map(dartBuilder.importElementLibrary));
+  }
 
-  Future<MixinElement?> getMixin(String name) =>
-      sessionHelper.getMixin(flutter.widgetsUri, name);
+  Future<ClassElement?> getClass(String name) async {
+    final class_ = await sessionHelper.getClass(flutter.widgetsUri, name);
+    if (class_ != null) {
+      _requiredElementImports.add(class_);
+    }
+    return class_;
+  }
+
+  Future<MixinElement?> getMixin(String name) async {
+    final mixin = await sessionHelper.getMixin(flutter.widgetsUri, name);
+    if (mixin != null) {
+      _requiredElementImports.add(mixin);
+    }
+    return mixin;
+  }
 
   DartType getType(
     InterfaceElement classElement, [

pkg/analysis_server/test/lsp/completion_dart_test.dart

@@ -3731,8 +3731,7 @@ void f() {
 class FlutterSnippetCompletionTest extends SnippetCompletionTest {
   /// Standard import statements expected for basic Widgets.
   String get expectedImports => '''
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';''';
+import 'package:flutter/widgets.dart';''';
 
   /// Nullability suffix expected in this test class.
   ///
@@ -4007,9 +4006,7 @@ class FlutterSnippetCompletionWithoutNullSafetyTest
     extends FlutterSnippetCompletionTest {
   @override
   String get expectedImports => '''
-import 'package:flutter/src/foundation/key.dart';
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';''';
+import 'package:flutter/widgets.dart';''';
 
   @override
   String get expectedNullableSuffix => '';

pkg/analysis_server/test/services/snippets/dart/flutter_stateful_widget_test.dart

@@ -4,6 +4,7 @@
 
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analysis_server/src/services/snippets/dart/flutter_stateful_widget.dart';
+import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -38,9 +39,7 @@ class FlutterStatefulWidgetTest extends FlutterSnippetProducerTest {
       code = SourceEdit.applySequence(code, edit.edits);
     }
     expect(code, '''
-import 'package:flutter/src/foundation/key.dart';
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
+import 'package:flutter/widgets.dart';
 
 class MyWidget extends StatefulWidget {
   const MyWidget({Key? key}) : super(key: key);
@@ -69,44 +68,22 @@ class _MyWidgetState extends State<MyWidget> {
     final snippet = await expectValidSnippet('^');
     expect(snippet.prefix, prefix);
     expect(snippet.label, label);
-    var code = '';
-    expect(snippet.change.edits, hasLength(1));
-    for (var edit in snippet.change.edits) {
-      code = SourceEdit.applySequence(code, edit.edits);
-    }
-    expect(code, '''
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
+    final expected = TestCode.parse('''
+import 'package:flutter/widgets.dart';
 
-class MyWidget extends StatefulWidget {
-  const MyWidget({super.key});
+class /*0*/MyWidget extends StatefulWidget {
+  const /*1*/MyWidget({super.key});
 
   @override
-  State<MyWidget> createState() => _MyWidgetState();
+  State</*2*/MyWidget> createState() => _/*3*/MyWidgetState();
 }
 
-class _MyWidgetState extends State<MyWidget> {
+class _/*4*/MyWidgetState extends State</*5*/MyWidget> {
   @override
   Widget build(BuildContext context) {
-    return const Placeholder();
+    return /*[0*/const Placeholder()/*0]*/;
   }
 }''');
-    expect(snippet.change.selection!.file, testFile);
-    expect(snippet.change.selection!.offset, 358);
-    expect(snippet.change.selectionLength, 19);
-    expect(snippet.change.linkedEditGroups.map((group) => group.toJson()), [
-      {
-        'positions': [
-          {'file': testFile, 'offset': 115},
-          {'file': testFile, 'offset': 157},
-          {'file': testFile, 'offset': 201},
-          {'file': testFile, 'offset': 229},
-          {'file': testFile, 'offset': 256},
-          {'file': testFile, 'offset': 284},
-        ],
-        'length': 8,
-        'suggestions': []
-      }
-    ]);
+    assertFlutterSnippetChange(snippet.change, 'MyWidget', expected);
   }
 }

pkg/analysis_server/test/services/snippets/dart/flutter_stateful_widget_with_animation_controller_test.dart

@@ -4,6 +4,7 @@
 
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analysis_server/src/services/snippets/dart/flutter_stateful_widget_with_animation.dart';
+import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -39,11 +40,7 @@ class FlutterStatefulWidgetWithAnimationControllerTest
       code = SourceEdit.applySequence(code, edit.edits);
     }
     expect(code, '''
-import 'package:flutter/src/animation/animation_controller.dart';
-import 'package:flutter/src/foundation/key.dart';
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
-import 'package:flutter/src/widgets/ticker_provider.dart';
+import 'package:flutter/widgets.dart';
 
 class MyWidget extends StatefulWidget {
   const MyWidget({Key? key}) : super(key: key);
@@ -87,25 +84,17 @@ class _MyWidgetState extends State<MyWidget>
     final snippet = await expectValidSnippet('^');
     expect(snippet.prefix, prefix);
     expect(snippet.label, label);
-    var code = '';
-    expect(snippet.change.edits, hasLength(1));
-    for (var edit in snippet.change.edits) {
-      code = SourceEdit.applySequence(code, edit.edits);
-    }
-    expect(code, '''
-import 'package:flutter/src/animation/animation_controller.dart';
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
-import 'package:flutter/src/widgets/ticker_provider.dart';
+    final expected = TestCode.parse('''
+import 'package:flutter/widgets.dart';
 
-class MyWidget extends StatefulWidget {
-  const MyWidget({super.key});
+class /*0*/MyWidget extends StatefulWidget {
+  const /*1*/MyWidget({super.key});
 
   @override
-  State<MyWidget> createState() => _MyWidgetState();
+  State</*2*/MyWidget> createState() => _/*3*/MyWidgetState();
 }
 
-class _MyWidgetState extends State<MyWidget>
+class _/*4*/MyWidgetState extends State</*5*/MyWidget>
     with SingleTickerProviderStateMixin {
   late AnimationController _controller;
 
@@ -123,25 +112,9 @@ class _MyWidgetState extends State<MyWidget>
 
   @override
   Widget build(BuildContext context) {
-    return const Placeholder();
+    return /*[0*/const Placeholder()/*0]*/;
   }
 }''');
-    expect(snippet.change.selection!.file, testFile);
-    expect(snippet.change.selection!.offset, 761);
-    expect(snippet.change.selectionLength, 19);
-    expect(snippet.change.linkedEditGroups.map((group) => group.toJson()), [
-      {
-        'positions': [
-          {'file': testFile, 'offset': 240},
-          {'file': testFile, 'offset': 282},
-          {'file': testFile, 'offset': 326},
-          {'file': testFile, 'offset': 354},
-          {'file': testFile, 'offset': 381},
-          {'file': testFile, 'offset': 409},
-        ],
-        'length': 8,
-        'suggestions': []
-      }
-    ]);
+    assertFlutterSnippetChange(snippet.change, 'MyWidget', expected);
   }
 }

pkg/analysis_server/test/services/snippets/dart/flutter_stateless_widget_test.dart

@@ -2,8 +2,8 @@
 // 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/src/protocol_server.dart';
 import 'package:analysis_server/src/services/snippets/dart/flutter_stateless_widget.dart';
+import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -32,24 +32,18 @@ class FlutterStatelessWidgetTest extends FlutterSnippetProducerTest {
     final snippet = await expectValidSnippet('^');
     expect(snippet.prefix, prefix);
     expect(snippet.label, label);
-    var code = '';
-    expect(snippet.change.edits, hasLength(1));
-    for (var edit in snippet.change.edits) {
-      code = SourceEdit.applySequence(code, edit.edits);
-    }
-    expect(code, '''
-import 'package:flutter/src/foundation/key.dart';
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
-
-class MyWidget extends StatelessWidget {
-  const MyWidget({Key? key}) : super(key: key);
+    final expected = TestCode.parse('''
+import 'package:flutter/widgets.dart';
+
+class /*0*/MyWidget extends StatelessWidget {
+  const /*1*/MyWidget({Key? key}) : super(key: key);
 
   @override
   Widget build(BuildContext context) {
-    return const Placeholder();
+    return /*[0*/const Placeholder()/*0]*/;
   }
 }''');
+    assertFlutterSnippetChange(snippet.change, 'MyWidget', expected);
   }
 
   Future<void> test_notValid_notFlutterProject() async {
@@ -64,35 +58,17 @@ class MyWidget extends StatelessWidget {
     final snippet = await expectValidSnippet('^');
     expect(snippet.prefix, prefix);
     expect(snippet.label, label);
-    var code = '';
-    expect(snippet.change.edits, hasLength(1));
-    for (var edit in snippet.change.edits) {
-      code = SourceEdit.applySequence(code, edit.edits);
-    }
-    expect(code, '''
-import 'package:flutter/src/widgets/framework.dart';
-import 'package:flutter/src/widgets/placeholder.dart';
-
-class MyWidget extends StatelessWidget {
-  const MyWidget({super.key});
+    final expected = TestCode.parse('''
+import 'package:flutter/widgets.dart';
+
+class /*0*/MyWidget extends StatelessWidget {
+  const /*1*/MyWidget({super.key});
 
   @override
   Widget build(BuildContext context) {
-    return const Placeholder();
+    return /*[0*/const Placeholder()/*0]*/;
   }
 }''');
-    expect(snippet.change.selection!.file, testFile);
-    expect(snippet.change.selection!.offset, 244);
-    expect(snippet.change.selectionLength, 19);
-    expect(snippet.change.linkedEditGroups.map((group) => group.toJson()), [
-      {
-        'positions': [
-          {'file': testFile, 'offset': 115},
-          {'file': testFile, 'offset': 158},
-        ],
-        'length': 8,
-        'suggestions': []
-      }
-    ]);
+    assertFlutterSnippetChange(snippet.change, 'MyWidget', expected);
   }
 }