Fix Gradle warning in a freshly flutter createed Android project (#122290)

Fix Gradle warning in a freshly `flutter create`ed Android project

Author: bartekpacia

dev/benchmarks/complex_layout/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/benchmarks/macrobenchmarks/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/benchmarks/microbenchmarks/android/build.gradle

@@ -45,6 +45,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/benchmarks/multiple_flutters/android/build.gradle

@@ -25,6 +25,6 @@ allprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
-}
+}

dev/benchmarks/platform_views_layout/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/benchmarks/platform_views_layout_hybrid_composition/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/benchmarks/test_apps/stocks/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/abstract_method_smoke_test/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/android_custom_host_app/build.gradle

@@ -19,6 +19,6 @@ allprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/android_embedding_v2_smoke_test/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/android_host_app_v2_embedding/build.gradle

@@ -19,6 +19,6 @@ allprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/android_semantics_testing/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/android_views/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/channels/android/build.gradle

@@ -30,6 +30,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/deferred_components_test/android/build.gradle

@@ -45,6 +45,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/external_ui/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/flavors/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/flutter_gallery/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/gradle_deprecated_settings/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/hybrid_android_views/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/module_host_with_custom_build_v2_embedding/build.gradle

@@ -19,6 +19,6 @@ allprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/non_nullable/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/platform_interaction/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/release_smoke_test/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/spell_check/android/build.gradle

@@ -30,6 +30,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/integration_tests/ui/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/manual_tests/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

dev/tools/bin/generate_gradle_lockfiles.dart

@@ -181,7 +181,7 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }
 ''';

dev/tracing_tests/android/build.gradle

@@ -30,6 +30,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/api/android/build.gradle

@@ -28,6 +28,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/flutter_view/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/hello_world/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/image_list/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/layers/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/platform_channel/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

examples/platform_view/android/build.gradle

@@ -46,6 +46,6 @@ subprojects {
     }
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

packages/flutter_tools/lib/src/android/gradle.dart

@@ -19,6 +19,7 @@ import '../base/logger.dart';
 import '../base/net.dart';
 import '../base/platform.dart';
 import '../base/process.dart';
+import '../base/project_migrator.dart';
 import '../base/terminal.dart';
 import '../base/utils.dart';
 import '../build_info.dart';
@@ -31,6 +32,7 @@ import 'android_builder.dart';
 import 'android_studio.dart';
 import 'gradle_errors.dart';
 import 'gradle_utils.dart';
+import 'migrations/top_level_gradle_build_file_migration.dart';
 import 'multidex.dart';
 
 /// The directory where the APK artifact is generated.
@@ -235,11 +237,17 @@ class AndroidGradleBuilder implements AndroidBuilder {
     int retry = 0,
     @visibleForTesting int? maxRetries,
   }) async {
-
     if (!project.android.isSupportedVersion) {
       _exitWithUnsupportedProjectMessage(_usage, _logger.terminal);
     }
 
+    final List<ProjectMigrator> migrators = <ProjectMigrator>[
+      TopLevelGradleBuildFileMigration(project.android, _logger),
+    ];
+
+    final ProjectMigration migration = ProjectMigration(migrators);
+    migration.run();
+
     final bool usesAndroidX = isAppUsingAndroidX(project.android.hostAppGradleRoot);
     if (usesAndroidX) {
       BuildEvent('app-using-android-x', type: 'gradle', flutterUsage: _usage).send();

packages/flutter_tools/lib/src/android/migrations/top_level_gradle_build_file_migration.dart

@@ -0,0 +1,53 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import '../../base/file_system.dart';
+import '../../base/project_migrator.dart';
+import '../../project.dart';
+
+const String _eagerCleanTaskDeclaration = '''
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}
+''';
+
+const String _lazyCleanTaskDeclaration = '''
+tasks.register("clean", Delete) {
+    delete rootProject.buildDir
+}
+''';
+
+/// Migrate the Gradle "clean" task to use modern, lazy declaration style.
+class TopLevelGradleBuildFileMigration extends ProjectMigrator {
+  TopLevelGradleBuildFileMigration(
+    AndroidProject project,
+    super.logger,
+  ) : _topLevelGradleBuildFile = project.hostAppGradleRoot.childFile('build.gradle');
+
+  final File _topLevelGradleBuildFile;
+
+  @override
+  void migrate() {
+    if (!_topLevelGradleBuildFile.existsSync()) {
+      logger.printTrace('Top-level Gradle build file not found, skipping migration of task "clean".');
+      return;
+    }
+
+    processFileLines(_topLevelGradleBuildFile);
+  }
+
+  @override
+  String migrateFileContents(String fileContents) {
+    final String newContents = fileContents.replaceAll(
+      _eagerCleanTaskDeclaration,
+      _lazyCleanTaskDeclaration,
+    );
+
+    if (newContents != fileContents) {
+      logger.printTrace('Migrating "clean" Gradle task to lazy declaration style.');
+    }
+
+    return newContents;
+  }
+}

packages/flutter_tools/templates/app_shared/android-java.tmpl/build.gradle.tmpl

@@ -26,6 +26,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

packages/flutter_tools/templates/app_shared/android-kotlin.tmpl/build.gradle.tmpl

@@ -26,6 +26,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }