Dual compile reland (#143262)

This is an attempt at a reland of flutter/flutter#141396 The main changes here that are different than the original PR is fixes to wire up the `flutter test` command properly with the web renderer.
engine-flutter-autoroll · Feb 13, 2024 · 5a9fa1e · 5a9fa1e
1 parent 4f1fc5a
commit 5a9fa1e
Show file tree

Hide file tree

Showing 36 changed files with 989 additions and 465 deletions.
diff --git a/dev/benchmarks/macrobenchmarks/web/index.html b/dev/benchmarks/macrobenchmarks/web/index.html
@@ -6,8 +6,12 @@
 <head>
   <meta charset="UTF-8">
   <title>Web Benchmarks</title>
+  <script src="flutter.js"></script>
 </head>
 <body>
-  <script src="main.dart.js" type="application/javascript"></script>
+  <script>
+    {{flutter_build_config}}
+    _flutter.loader.load();
+  </script>
 </body>
 </html>
diff --git a/dev/devicelab/lib/tasks/web_benchmarks.dart b/dev/devicelab/lib/tasks/web_benchmarks.dart
@@ -39,7 +39,7 @@ Future<TaskResult> runWebBenchmark(WebBenchmarkOptions benchmarkOptions) async {
         '--omit-type-checks',
       ],
       '--dart-define=FLUTTER_WEB_ENABLE_PROFILING=true',
-      '--web-renderer=${benchmarkOptions.webRenderer}',
+      if (!benchmarkOptions.useWasm) '--web-renderer=${benchmarkOptions.webRenderer}',
       '--profile',
       '--no-web-resources-cdn',
       '-t',
@@ -125,7 +125,7 @@ Future<TaskResult> runWebBenchmark(WebBenchmarkOptions benchmarkOptions) async {
         return Response.internalServerError(body: '$error');
       }
     }).add(createBuildDirectoryHandler(
-      path.join(macrobenchmarksDirectory, 'build', benchmarkOptions.useWasm ? 'web_wasm' : 'web'),
+      path.join(macrobenchmarksDirectory, 'build', 'web'),
     ));
 
     server = await io.HttpServer.bind('localhost', benchmarkServerPort);

diff --git a/dev/integration_tests/web_e2e_tests/web/index.html b/dev/integration_tests/web_e2e_tests/web/index.html
@@ -5,14 +5,17 @@
 <html>
     <head>
         <title>Web Integration Tests</title>
-        <script>
-          // Use the local CanvasKit bundle instead of the CDN to reduce test flakiness.
-          window.flutterConfiguration = {
-            canvasKitBaseUrl: "/canvaskit/"
-          };
-        </script>
+        <script src="flutter.js"></script>
     </head>
     <body>
-        <script src="main.dart.js"></script>
+      <script>
+        {{flutter_build_config}}
+        _flutter.loader.load({
+          config: {
+            // Use the local CanvasKit bundle instead of the CDN to reduce test flakiness.
+            canvasKitBaseUrl: "/canvaskit/",
+          },
+        });
+      </script>
     </body>
 </html>
diff --git a/packages/flutter_tools/lib/src/build_info.dart b/packages/flutter_tools/lib/src/build_info.dart
@@ -12,7 +12,6 @@ import 'base/os.dart';
 import 'base/utils.dart';
 import 'convert.dart';
 import 'globals.dart' as globals;
-import 'web/compile.dart';
 
 /// Whether icon font subsetting is enabled by default.
 const bool kIconTreeShakerEnabledDefault = true;
@@ -36,7 +35,6 @@ class BuildInfo {
     List<String>? dartDefines,
     this.bundleSkSLPath,
     List<String>? dartExperiments,
-    this.webRenderer = WebRendererMode.auto,
     required this.treeShakeIcons,
     this.performanceMeasurementFile,
     this.packagesPath = '.dart_tool/package_config.json', // TODO(zanderso): make this required and remove the default.
@@ -131,9 +129,6 @@ class BuildInfo {
   /// A list of Dart experiments.
   final List<String> dartExperiments;
 
-  /// When compiling to web, which web renderer mode we are using (html, canvaskit, auto)
-  final WebRendererMode webRenderer;
-
   /// The name of a file where flutter assemble will output performance
   /// information in a JSON format.
   ///
@@ -803,10 +798,6 @@ HostPlatform getCurrentHostPlatform() {
   return HostPlatform.linux_x64;
 }
 
-FileSystemEntity getWebPlatformBinariesDirectory(Artifacts artifacts, WebRendererMode webRenderer) {
-  return artifacts.getHostArtifact(HostArtifact.webPlatformKernelFolder);
-}
-
 /// Returns the top-level build output directory.
 String getBuildDirectory([Config? config, FileSystem? fileSystem]) {
   // TODO(johnmccutchan): Stop calling this function as part of setting
@@ -849,8 +840,8 @@ String getMacOSBuildDirectory() {
 }
 
 /// Returns the web build output directory.
-String getWebBuildDirectory([bool isWasm = false]) {
-  return globals.fs.path.join(getBuildDirectory(), isWasm ? 'web_wasm' : 'web');
+String getWebBuildDirectory() {
+  return globals.fs.path.join(getBuildDirectory(), 'web');
 }
 
 /// Returns the Linux build output directory.

diff --git a/packages/flutter_tools/lib/src/build_system/build_system.dart b/packages/flutter_tools/lib/src/build_system/build_system.dart
@@ -136,6 +136,15 @@ abstract class Target {
   /// A list of zero or more depfiles, located directly under {BUILD_DIR}.
   List<String> get depfiles => const <String>[];
 
+  /// A string that differentiates different build variants from each other
+  /// with regards to build flags or settings on the target. This string should
+  /// represent each build variant as a different unique value. If this value
+  /// changes between builds, the target will be invalidated and rebuilt.
+  ///
+  /// By default, this returns null, which indicates there is only one build
+  /// variant, and the target won't invalidate or rebuild due to this property.
+  String? get buildKey => null;
+
   /// Whether this target can be executed with the given [environment].
   ///
   /// Returning `true` will cause [build] to be skipped. This is equivalent
@@ -156,6 +165,7 @@ abstract class Target {
       <Node>[
         for (final Target target in dependencies) target._toNode(environment),
       ],
+      buildKey,
       environment,
       inputsFiles.containsNewDepfile,
     );
@@ -181,9 +191,11 @@ abstract class Target {
     for (final File output in outputs) {
       outputPaths.add(output.path);
     }
+    final String? key = buildKey;
     final Map<String, Object> result = <String, Object>{
       'inputs': inputPaths,
       'outputs': outputPaths,
+      if (key != null) 'buildKey': key,
     };
     if (!stamp.existsSync()) {
       stamp.createSync();
@@ -218,6 +230,7 @@ abstract class Target {
   /// This requires constants from the [Environment] to resolve the paths of
   /// inputs and the output stamp.
   Map<String, Object> toJson(Environment environment) {
+    final String? key = buildKey;
     return <String, Object>{
       'name': name,
       'dependencies': <String>[
@@ -229,6 +242,7 @@ abstract class Target {
       'outputs': <String>[
         for (final File file in resolveOutputs(environment).sources) file.path,
       ],
+      if (key != null) 'buildKey': key,
       'stamp': _findStampFile(environment).absolute.path,
     };
   }
@@ -980,50 +994,86 @@ void verifyOutputDirectories(List<File> outputs, Environment environment, Target
 
 /// A node in the build graph.
 class Node {
-  Node(
-    this.target,
-    this.inputs,
-    this.outputs,
-    this.dependencies,
+  factory Node(
+    Target target,
+    List<File> inputs,
+    List<File> outputs,
+    List<Node> dependencies,
+    String? buildKey,
     Environment environment,
-    this.missingDepfile,
+    bool missingDepfile,
   ) {
     final File stamp = target._findStampFile(environment);
+    Map<String, Object?>? stampValues;
 
     // If the stamp file doesn't exist, we haven't run this step before and
     // all inputs were added.
-    if (!stamp.existsSync()) {
-      // No stamp file, not safe to skip.
-      _dirty = true;
-      return;
-    }
-    final String content = stamp.readAsStringSync();
-    // Something went wrong writing the stamp file.
-    if (content.isEmpty) {
-      stamp.deleteSync();
-      // Malformed stamp file, not safe to skip.
-      _dirty = true;
-      return;
-    }
-    Map<String, Object?>? values;
-    try {
-      values = castStringKeyedMap(json.decode(content));
-    } on FormatException {
-      // The json is malformed in some way.
-      _dirty = true;
-      return;
+    if (stamp.existsSync()) {
+      final String content = stamp.readAsStringSync();
+      if (content.isEmpty) {
+        stamp.deleteSync();
+      } else {
+        try {
+          stampValues = castStringKeyedMap(json.decode(content));
+        } on FormatException {
+          // The json is malformed in some way.
+        }
+      }
     }
-    final Object? inputs = values?['inputs'];
-    final Object? outputs = values?['outputs'];
-    if (inputs is List<Object?> && outputs is List<Object?>) {
-      inputs.cast<String?>().whereType<String>().forEach(previousInputs.add);
-      outputs.cast<String?>().whereType<String>().forEach(previousOutputs.add);
-    } else {
-      // The json is malformed in some way.
-      _dirty = true;
+    if (stampValues != null) {
+      final String? previousBuildKey = stampValues['buildKey'] as String?;
+      final Object? stampInputs = stampValues['inputs'];
+      final Object? stampOutputs = stampValues['outputs'];
+      if (stampInputs is List<Object?> && stampOutputs is List<Object?>) {
+        final Set<String> previousInputs = stampInputs.whereType<String>().toSet();
+        final Set<String> previousOutputs = stampOutputs.whereType<String>().toSet();
+        return Node.withStamp(
+          target,
+          inputs,
+          previousInputs,
+          outputs,
+          previousOutputs,
+          dependencies,
+          buildKey,
+          previousBuildKey,
+          missingDepfile,
+        );
+      }
     }
+    return Node.withNoStamp(
+      target,
+      inputs,
+      outputs,
+      dependencies,
+      buildKey,
+      missingDepfile,
+    );
   }
 
+  Node.withNoStamp(
+    this.target,
+    this.inputs,
+    this.outputs,
+    this.dependencies,
+    this.buildKey,
+    this.missingDepfile,
+  ) : previousInputs = <String>{},
+      previousOutputs = <String>{},
+      previousBuildKey = null,
+      _dirty = true;
+
+  Node.withStamp(
+    this.target,
+    this.inputs,
+    this.previousInputs,
+    this.outputs,
+    this.previousOutputs,
+    this.dependencies,
+    this.buildKey,
+    this.previousBuildKey,
+    this.missingDepfile,
+  ) : _dirty = false;
+
   /// The resolved input files.
   ///
   /// These files may not yet exist if they are produced by previous steps.
@@ -1034,6 +1084,11 @@ class Node {
   /// These files may not yet exist if the target hasn't run yet.
   final List<File> outputs;
 
+  /// The current build key of the target
+  ///
+  /// See `buildKey` in the `Target` class for more information.
+  final String? buildKey;
+
   /// Whether this node is missing a depfile.
   ///
   /// This requires an additional pass of source resolution after the target
@@ -1047,10 +1102,15 @@ class Node {
   final List<Node> dependencies;
 
   /// Output file paths from the previous invocation of this build node.
-  final Set<String> previousOutputs = <String>{};
+  final Set<String> previousOutputs;
 
   /// Input file paths from the previous invocation of this build node.
-  final Set<String> previousInputs = <String>{};
+  final Set<String> previousInputs;
+
+  /// The buildKey from the previous invocation of this build node.
+  ///
+  /// See `buildKey` in the `Target` class for more information.
+  final String? previousBuildKey;
 
   /// One or more reasons why a task was invalidated.
   ///
@@ -1074,6 +1134,10 @@ class Node {
     FileSystem fileSystem,
     Logger logger,
   ) {
+    if (buildKey != previousBuildKey) {
+      _invalidate(InvalidatedReasonKind.buildKeyChanged);
+      _dirty = true;
+    }
     final Set<String> currentOutputPaths = <String>{
       for (final File file in outputs) file.path,
     };
@@ -1173,7 +1237,8 @@ class InvalidatedReason {
       InvalidatedReasonKind.inputChanged => 'The following inputs have updated contents: ${data.join(',')}',
       InvalidatedReasonKind.outputChanged => 'The following outputs have updated contents: ${data.join(',')}',
       InvalidatedReasonKind.outputMissing => 'The following outputs were missing: ${data.join(',')}',
-      InvalidatedReasonKind.outputSetChanged => 'The following outputs were removed from the output set: ${data.join(',')}'
+      InvalidatedReasonKind.outputSetChanged => 'The following outputs were removed from the output set: ${data.join(',')}',
+      InvalidatedReasonKind.buildKeyChanged => 'The target build key changed.',
     };
   }
 }
@@ -1195,4 +1260,7 @@ enum InvalidatedReasonKind {
 
   /// The set of expected output files changed.
   outputSetChanged,
+
+  /// The build key changed
+  buildKeyChanged,
 }
diff --git a/packages/flutter_tools/lib/src/build_system/build_targets.dart b/packages/flutter_tools/lib/src/build_system/build_targets.dart
@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import '../base/file_system.dart';
-import '../web/compile.dart';
+import '../web/compiler_config.dart';
 import './build_system.dart';
 
 /// Commonly used build [Target]s.
@@ -14,11 +14,7 @@ abstract class BuildTargets {
   Target get releaseCopyFlutterBundle;
   Target get generateLocalizationsTarget;
   Target get dartPluginRegistrantTarget;
-  Target webServiceWorker(
-    FileSystem fileSystem, {
-    required WebRendererMode webRenderer,
-    required bool isWasm
-  });
+  Target webServiceWorker(FileSystem fileSystem, List<WebCompilerConfig> compileConfigs);
 }
 
 /// BuildTargets that return NoOpTarget for every action.
@@ -38,11 +34,7 @@ class NoOpBuildTargets extends BuildTargets {
   Target get dartPluginRegistrantTarget => const _NoOpTarget();
 
   @override
-  Target webServiceWorker(
-    FileSystem fileSystem, {
-    required WebRendererMode webRenderer,
-    required bool isWasm,
-  }) => const _NoOpTarget();
+  Target webServiceWorker(FileSystem fileSystem, List<WebCompilerConfig> compileConfigs) => const _NoOpTarget();
 }
 
 /// A [Target] that does nothing.