[ analyzer ] Add support for "Wrap FutureBuilder" code assist

bkonyi · Commit Queue · commit b732a62fd23c · 2025-02-12T13:12:19.000-08:00
Fixes #34364 Change-Id: I53b005fdae61fe84ebc7defd54531df6dcd2a351 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/408341 Auto-Submit: Ben Konyi <bkonyi@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,8 @@
 #### Analyzer
 
 - Added the experimental [`unnecessary_ignore`][] lint rule.
+- Offer additional assist to wrap a Flutter widget with a `FutureBuilder` widget.
+
 
 [`unnecessary_ignore`]: http://dart.dev/lints/unnecessary_ignore
 
diff --git a/pkg/analysis_server/lib/src/services/correction/assist.dart b/pkg/analysis_server/lib/src/services/correction/assist.dart
@@ -301,6 +301,11 @@ abstract final class DartAssistKind {
     DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
     'Wrap with Flexible',
   );
+  static const FLUTTER_WRAP_FUTURE_BUILDER = AssistKind(
+    'dart.assist.flutter.wrap.futureBuilder',
+    DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
+    'Wrap with FutureBuilder',
+  );
   static const FLUTTER_WRAP_PADDING = AssistKind(
     'dart.assist.flutter.wrap.padding',
     DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
diff --git a/pkg/analysis_server/lib/src/services/correction/assist_internal.dart b/pkg/analysis_server/lib/src/services/correction/assist_internal.dart
@@ -54,6 +54,7 @@ import 'package:analysis_server/src/services/correction/dart/flutter_swap_with_c
 import 'package:analysis_server/src/services/correction/dart/flutter_swap_with_parent.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_wrap.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_wrap_builder.dart';
+import 'package:analysis_server/src/services/correction/dart/flutter_wrap_future_builder.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_wrap_generic.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_wrap_stream_builder.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_wrap_value_listenable_builder.dart';
@@ -142,6 +143,7 @@ class AssistProcessor {
     FlutterSwapWithChild.new,
     FlutterSwapWithParent.new,
     FlutterWrapBuilder.new,
+    FlutterWrapFutureBuilder.new,
     FlutterWrapGeneric.new,
     FlutterWrapStreamBuilder.new,
     FlutterWrapValueListenableBuilder.new,
diff --git a/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_builder.dart b/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_builder.dart
@@ -10,6 +10,8 @@ import 'package:analyzer_plugin/utilities/assist/assist.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
 
+// TODO(bkonyi): share common implementation between the various builder wrappers
+// See https://github.com/dart-lang/sdk/issues/60075
 class FlutterWrapBuilder extends ResolvedCorrectionProducer {
   FlutterWrapBuilder({required super.context});
 
diff --git a/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_future_builder.dart b/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_future_builder.dart
@@ -0,0 +1,74 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// 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/services/correction/assist.dart';
+import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
+import 'package:analyzer/src/utilities/extensions/flutter.dart';
+import 'package:analyzer_plugin/utilities/assist/assist.dart';
+import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
+import 'package:analyzer_plugin/utilities/range_factory.dart';
+
+// TODO(bkonyi): share common implementation between the various builder wrappers
+// See https://github.com/dart-lang/sdk/issues/60075
+class FlutterWrapFutureBuilder extends ResolvedCorrectionProducer {
+  FlutterWrapFutureBuilder({required super.context});
+
+  @override
+  CorrectionApplicability get applicability =>
+          // TODO(applicability): comment on why.
+          CorrectionApplicability
+          .singleLocation;
+
+  @override
+  AssistKind get assistKind => DartAssistKind.FLUTTER_WRAP_FUTURE_BUILDER;
+
+  @override
+  Future<void> compute(ChangeBuilder builder) async {
+    var widgetExpr = node.findWidgetExpression;
+    if (widgetExpr == null) {
+      return;
+    }
+    var widgetSrc = utils.getNodeText(widgetExpr);
+
+    var FutureBuilderElement = await sessionHelper.getFlutterClass(
+      'FutureBuilder',
+    );
+    if (FutureBuilderElement == null) {
+      return;
+    }
+
+    await builder.addDartFileEdit(file, (builder) {
+      builder.addReplacement(range.node(widgetExpr), (builder) {
+        builder.writeReference(FutureBuilderElement);
+
+        builder.write('<');
+        builder.addSimpleLinkedEdit('type', 'Object');
+        builder.writeln('>(');
+
+        var indentOld = utils.getLinePrefix(widgetExpr.offset);
+        var indentNew1 = indentOld + utils.oneIndent;
+        var indentNew2 = indentOld + utils.twoIndents;
+
+        builder.write(indentNew1);
+        builder.writeln('future: null,');
+
+        builder.write(indentNew1);
+        builder.writeln('builder: (context, snapshot) {');
+
+        widgetSrc = utils.replaceSourceIndent(widgetSrc, indentOld, indentNew2);
+        builder.write(indentNew2);
+        builder.write('return $widgetSrc');
+        builder.writeln(';');
+
+        builder.write(indentNew1);
+        var addTrailingCommas =
+            getCodeStyleOptions(unitResult.file).addTrailingCommas;
+        builder.writeln('}${addTrailingCommas ? "," : ""}');
+
+        builder.write(indentOld);
+        builder.write(')');
+      });
+    });
+  }
+}
diff --git a/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_stream_builder.dart b/pkg/analysis_server/lib/src/services/correction/dart/flutter_wrap_stream_builder.dart
@@ -10,6 +10,8 @@ import 'package:analyzer_plugin/utilities/assist/assist.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
 
+// TODO(bkonyi): share common implementation between the various builder wrappers
+// See https://github.com/dart-lang/sdk/issues/60075
 class FlutterWrapStreamBuilder extends ResolvedCorrectionProducer {
   FlutterWrapStreamBuilder({required super.context});
 
diff --git a/pkg/analysis_server/test/src/services/correction/assist/flutter_wrap_future_builder_test.dart b/pkg/analysis_server/test/src/services/correction/assist/flutter_wrap_future_builder_test.dart
@@ -0,0 +1,140 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// 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/services/correction/assist.dart';
+import 'package:analyzer_plugin/utilities/assist/assist.dart';
+import 'package:linter/src/lint_names.dart';
+import 'package:test_reflective_loader/test_reflective_loader.dart';
+
+import 'assist_processor.dart';
+
+void main() {
+  defineReflectiveSuite(() {
+    defineReflectiveTests(FlutterWrapFutureBuilderTest);
+  });
+}
+
+@reflectiveTest
+class FlutterWrapFutureBuilderTest extends AssistProcessorTest {
+  @override
+  AssistKind get kind => DartAssistKind.FLUTTER_WRAP_FUTURE_BUILDER;
+
+  @override
+  void setUp() {
+    super.setUp();
+    writeTestPackageConfig(flutter: true);
+  }
+
+  Future<void> test_aroundFutureBuilder() async {
+    await resolveTestCode('''
+import 'package:flutter/widgets.dart';
+
+void f(Future<int> s) {
+  /*caret*/FutureBuilder(
+    future: s,
+    builder: (context, snapshot) => Text(''),
+  );
+}
+''');
+    await assertHasAssist('''
+import 'package:flutter/widgets.dart';
+
+void f(Future<int> s) {
+  FutureBuilder<Object>(
+    future: null,
+    builder: (context, snapshot) {
+      return FutureBuilder(
+        future: s,
+        builder: (context, snapshot) => Text(''),
+      );
+    }
+  );
+}
+''');
+  }
+
+  Future<void> test_aroundText() async {
+    await resolveTestCode('''
+import 'package:flutter/widgets.dart';
+
+void f() {
+  /*caret*/Text('a');
+}
+''');
+    await assertHasAssist('''
+import 'package:flutter/widgets.dart';
+
+void f() {
+  FutureBuilder<Object>(
+    future: null,
+    builder: (context, snapshot) {
+      return Text('a');
+    }
+  );
+}
+''');
+  }
+
+  Future<void> test_trailingComma_disabled() async {
+    // No analysis options.
+    await resolveTestCode('''
+import 'package:flutter/widgets.dart';
+
+class TestWidget extends StatelessWidget {
+  const TestWidget({super.key});
+  @override
+  Widget build(BuildContext context) {
+    return const /*caret*/Text('hi');
+  }
+}
+''');
+    await assertHasAssist('''
+import 'package:flutter/widgets.dart';
+
+class TestWidget extends StatelessWidget {
+  const TestWidget({super.key});
+  @override
+  Widget build(BuildContext context) {
+    return FutureBuilder<Object>(
+      future: null,
+      builder: (context, snapshot) {
+        return const Text('hi');
+      }
+    );
+  }
+}
+''');
+  }
+
+  Future<void> test_trailingComma_enabled() async {
+    createAnalysisOptionsFile(lints: [LintNames.require_trailing_commas]);
+    await resolveTestCode('''
+import 'package:flutter/widgets.dart';
+
+class TestWidget extends StatelessWidget {
+  const TestWidget({super.key});
+  @override
+  Widget build(BuildContext context) {
+    return const /*caret*/Text('hi');
+  }
+}
+''');
+    await assertHasAssist('''
+import 'package:flutter/widgets.dart';
+
+class TestWidget extends StatelessWidget {
+  const TestWidget({super.key});
+  @override
+  Widget build(BuildContext context) {
+    return FutureBuilder<Object>(
+      future: null,
+      builder: (context, snapshot) {
+        return const Text('hi');
+      },
+    );
+  }
+}
+''');
+  }
+}
diff --git a/pkg/analysis_server/test/src/services/correction/assist/test_all.dart b/pkg/analysis_server/test/src/services/correction/assist/test_all.dart
@@ -68,6 +68,7 @@ import 'flutter_wrap_column_test.dart' as flutter_wrap_column;
 import 'flutter_wrap_container_test.dart' as flutter_wrap_container;
 import 'flutter_wrap_expanded_test.dart' as flutter_wrap_expanded;
 import 'flutter_wrap_flexible_test.dart' as flutter_wrap_flexible;
+import 'flutter_wrap_future_builder_test.dart' as flutter_wrap_future_builder;
 import 'flutter_wrap_generic_test.dart' as flutter_wrap_generic;
 import 'flutter_wrap_padding_test.dart' as flutter_wrap_padding;
 import 'flutter_wrap_row_test.dart' as flutter_wrap_row;
@@ -160,6 +161,7 @@ void main() {
     flutter_wrap_container.main();
     flutter_wrap_expanded.main();
     flutter_wrap_flexible.main();
+    flutter_wrap_future_builder.main();
     flutter_wrap_generic.main();
     flutter_wrap_padding.main();
     flutter_wrap_row.main();
diff --git a/pkg/analyzer_utilities/lib/test/mock_packages/package_content/flutter/lib/src/widgets/async.dart b/pkg/analyzer_utilities/lib/test/mock_packages/package_content/flutter/lib/src/widgets/async.dart
@@ -9,10 +9,24 @@ typedef AsyncWidgetBuilder<T> = Widget Function(
 
 class AsyncSnapshot<T> {}
 
-class StreamBuilder<T> {
+class StreamBuilder<T> extends StatefulWidget {
   final T? initialData;
   final AsyncWidgetBuilder<T> builder;
 
   const StreamBuilder(
-      {Key? key, this.initialData, Stream<T>? stream, @required this.builder});
+      {Key? key,
+      this.initialData,
+      required Stream<T>? stream,
+      required this.builder});
+}
+
+class FutureBuilder<T> extends StatefulWidget {
+  final T? initialData;
+  final AsyncWidgetBuilder<T> builder;
+
+  const FutureBuilder(
+      {Key? key,
+      this.initialData,
+      required Future<T>? future,
+      required this.builder});
 }
