Read builder config from AssetReader. (#4096)

davidmorgan · web-flow · commit e453c95fc706 · 2025-07-15T12:05:20.000+02:00
* Read builder config from AssetReader.

* Address review comments.
diff --git a/_test_common/lib/build_configs.dart b/_test_common/lib/build_configs.dart
diff --git a/_test_common/lib/test_phases.dart b/_test_common/lib/test_phases.dart
@@ -5,7 +5,6 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:build/build.dart';
-import 'package:build_config/build_config.dart';
 import 'package:build_runner_core/build_runner_core.dart';
 import 'package:build_test/build_test.dart';
 // ignore: implementation_imports
@@ -78,13 +77,11 @@ Future<TestBuildersResult> testPhases(
   Map<String, /*String|List<int>*/ Object>? outputs,
   PackageGraph? packageGraph,
   BuildStatus status = BuildStatus.success,
-  Map<String, BuildConfig>? overrideBuildConfig,
   // A better way to "silence" logging than setting logLevel to OFF.
   void Function(LogRecord record) onLog = _printOnFailure,
   bool checkBuildStatus = true,
   bool deleteFilesByDefault = true,
   bool enableLowResourcesMode = false,
-  Map<String, Map<String, dynamic>>? builderConfigOverrides,
   bool verbose = false,
   Set<BuildDirectory> buildDirs = const {},
   Set<BuildFilter> buildFilters = const {},
@@ -134,7 +131,6 @@ Future<TestBuildersResult> testPhases(
     }
   });
 
-  builderConfigOverrides ??= const {};
   var environment = BuildEnvironment(
     packageGraph,
     reader: readerWriter,
@@ -147,10 +143,10 @@ Future<TestBuildersResult> testPhases(
   });
 
   var options = await BuildOptions.create(
-    deleteFilesByDefault: deleteFilesByDefault,
     packageGraph: packageGraph,
+    reader: environment.reader,
+    deleteFilesByDefault: deleteFilesByDefault,
     skipBuildScriptCheck: true,
-    overrideBuildConfig: overrideBuildConfig ?? const {},
     enableLowResourcesMode: enableLowResourcesMode,
     logPerformanceDir: logPerformanceDir,
   );
@@ -160,7 +156,7 @@ Future<TestBuildersResult> testPhases(
     options,
     environment,
     builders,
-    builderConfigOverrides,
+    const {},
     isReleaseBuild: false,
   );
   result = await build.run(
diff --git a/build_runner/CHANGELOG.md b/build_runner/CHANGELOG.md
@@ -3,6 +3,7 @@
 - Remove unused deps: `analyzer`, `build_resolvers`, `collection`, `http`,
   `js`, `meta`, `package_config`, `pool`, `web`, `yaml`.
 - Remove unused dev_deps: `http`, `package_config`, `web`.
+- Testing: read build configs using `AssetReader` so they're easier to test.
 
 ## 2.6.0-dev.1
 
diff --git a/build_runner/lib/src/daemon/daemon_builder.dart b/build_runner/lib/src/daemon/daemon_builder.dart
@@ -257,6 +257,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
 
     var buildOptions = await BuildOptions.create(
       packageGraph: packageGraph,
+      reader: daemonEnvironment.reader,
       deleteFilesByDefault: daemonOptions.deleteFilesByDefault,
       overrideBuildConfig: overrideBuildConfig,
       skipBuildScriptCheck: daemonOptions.skipBuildScriptCheck,
diff --git a/build_runner/lib/src/generate/build.dart b/build_runner/lib/src/generate/build.dart
@@ -92,8 +92,9 @@ Future<BuildResult> build(
     b.onLog = onLog;
   });
   var options = await BuildOptions.create(
-    deleteFilesByDefault: deleteFilesByDefault,
     packageGraph: packageGraph,
+    reader: environment.reader,
+    deleteFilesByDefault: deleteFilesByDefault,
     skipBuildScriptCheck: skipBuildScriptCheck,
     overrideBuildConfig: await findBuildConfigOverrides(
       packageGraph,
diff --git a/build_runner/lib/src/generate/watch_impl.dart b/build_runner/lib/src/generate/watch_impl.dart
@@ -82,8 +82,9 @@ Future<ServeHandler> watch(
     configKey: configKey,
   );
   var options = await BuildOptions.create(
-    deleteFilesByDefault: deleteFilesByDefault,
     packageGraph: packageGraph,
+    reader: environment.reader,
+    deleteFilesByDefault: deleteFilesByDefault,
     overrideBuildConfig: overrideBuildConfig,
     debounceDelay: debounceDelay,
     skipBuildScriptCheck: skipBuildScriptCheck,
diff --git a/build_runner/test/build_script_generate/builder_ordering_test.dart b/build_runner/test/build_script_generate/builder_ordering_test.dart
@@ -2,7 +2,6 @@
 // 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:_test_common/build_configs.dart';
 import 'package:build_config/build_config.dart';
 import 'package:build_runner/src/build_script_generate/builder_ordering.dart';
 import 'package:test/test.dart';
@@ -222,3 +221,10 @@ void main() {
     });
   });
 }
+
+Map<String, BuildConfig> parseBuildConfigs(
+  Map<String, Map<String, dynamic>> configs,
+) => {
+  for (final packageName in configs.keys)
+    packageName: BuildConfig.fromMap(packageName, [], configs[packageName]!),
+};
diff --git a/build_runner/test/generate/watch_test.dart b/build_runner/test/generate/watch_test.dart
@@ -5,7 +5,6 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:_test_common/build_configs.dart';
 import 'package:_test_common/common.dart';
 import 'package:async/async.dart';
 import 'package:build/build.dart';
@@ -110,18 +109,17 @@ void main() {
       test('rebuilds on file updates outside hardcoded sources', () async {
         var buildState = await startWatch(
           [copyABuildApplication],
-          {'a|test_files/a.txt': 'a'},
+          {
+            'a|test_files/a.txt': 'a',
+            'a|build.yaml': '''
+targets:
+  a:
+    sources:
+      - test_files/**
+''',
+          },
           readerWriter,
           packageGraph: packageGraph,
-          overrideBuildConfig: parseBuildConfigs({
-            'a': {
-              'targets': {
-                'a': {
-                  'sources': ['test_files/**'],
-                },
-              },
-            },
-          }),
         );
         var results = StreamQueue(buildState.buildResults);
 
@@ -179,18 +177,17 @@ void main() {
       test('rebuilds on new files outside hardcoded sources', () async {
         var buildState = await startWatch(
           [copyABuildApplication],
-          {'a|test_files/a.txt': 'a'},
+          {
+            'a|test_files/a.txt': 'a',
+            'a|build.yaml': '''
+targets:
+  a:
+    sources:
+      - test_files/**
+''',
+          },
           readerWriter,
           packageGraph: packageGraph,
-          overrideBuildConfig: parseBuildConfigs({
-            'a': {
-              'targets': {
-                'a': {
-                  'sources': ['test_files/**'],
-                },
-              },
-            },
-          }),
         );
         var results = StreamQueue(buildState.buildResults);
 
@@ -302,18 +299,18 @@ void main() {
       test('rebuilds on deleted files outside hardcoded sources', () async {
         var buildState = await startWatch(
           [copyABuildApplication],
-          {'a|test_files/a.txt': 'a', 'a|test_files/b.txt': 'b'},
+          {
+            'a|test_files/a.txt': 'a',
+            'a|test_files/b.txt': 'b',
+            'a|build.yaml': '''
+targets:
+  a:
+    sources:
+      - test_files/**
+''',
+          },
           readerWriter,
           packageGraph: packageGraph,
-          overrideBuildConfig: parseBuildConfigs({
-            'a': {
-              'targets': {
-                'a': {
-                  'sources': ['test_files/**'],
-                },
-              },
-            },
-          }),
         );
         var results = StreamQueue(buildState.buildResults);
 
diff --git a/build_runner_core/CHANGELOG.md b/build_runner_core/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 - Removed unused dev_deps: `test_process`.
 - Bug fix: fix incremental build after build with import of missing package.
+- Testing: read build configs using `AssetReader` so they're easier to test.
 
 ## 9.2.0-dev.1
 
diff --git a/build_runner_core/lib/src/generate/options.dart b/build_runner_core/lib/src/generate/options.dart
@@ -143,13 +143,16 @@ class BuildOptions {
 
   /// Creates a [BuildOptions] with sane defaults.
   ///
+  /// Pass [reader] to read `build.yaml` files, otherwise defaults are used.
+  ///
   /// NOTE: If a custom [resolvers] instance is passed it must ensure that it
   /// enables [enabledExperiments] on any analysis options it creates.
   static Future<BuildOptions> create({
+    required PackageGraph packageGraph,
+    AssetReader? reader,
     Duration debounceDelay = const Duration(milliseconds: 250),
     bool deleteFilesByDefault = false,
     bool enableLowResourcesMode = false,
-    required PackageGraph packageGraph,
     Map<String, BuildConfig> overrideBuildConfig = const {},
     bool skipBuildScriptCheck = false,
     bool trackPerformance = false,
@@ -161,18 +164,14 @@ class BuildOptions {
     try {
       targetGraph = await TargetGraph.forPackageGraph(
         packageGraph,
+        reader: reader,
         overrideBuildConfig: overrideBuildConfig,
         defaultRootPackageSources: defaultRootPackageSources,
         requiredSourcePaths: [r'lib/$lib$'],
         requiredRootSourcePaths: [r'$package$', r'lib/$lib$'],
       );
     } on BuildConfigParseException catch (e) {
-      buildLog.error('''
-Failed to parse `build.yaml` for ${e.packageName}.
-
-If you believe you have gotten this message in error, especially if using a new
-feature, you may need to run `dart run build_runner clean` and then rebuild.
-''');
+      buildLog.error(e.toString());
       throw const CannotBuildException();
     }
 
diff --git a/build_runner_core/lib/src/package_graph/target_graph.dart b/build_runner_core/lib/src/package_graph/target_graph.dart
@@ -7,6 +7,7 @@ import 'dart:async';
 import 'package:build/build.dart';
 import 'package:build_config/build_config.dart';
 import 'package:glob/glob.dart';
+import 'package:path/path.dart' as p;
 
 import '../generate/input_matcher.dart';
 import '../generate/options.dart' show defaultNonRootVisibleAssets;
@@ -45,6 +46,9 @@ class TargetGraph {
 
   /// Builds a [TargetGraph] from [packageGraph].
   ///
+  /// Pass [reader] to read package configs. Otherwise, default configs are
+  /// used.
+  ///
   /// The [overrideBuildConfig] map overrides the config for packages by name.
   ///
   /// The [defaultRootPackageSources] is the default `sources` list to use
@@ -57,6 +61,7 @@ class TargetGraph {
   /// warning is logged if this condition is not met.
   static Future<TargetGraph> forPackageGraph(
     PackageGraph packageGraph, {
+    AssetReader? reader,
     Map<String, BuildConfig> overrideBuildConfig = const {},
     required List<String> defaultRootPackageSources,
     List<String> requiredSourcePaths = const [],
@@ -69,7 +74,7 @@ class TargetGraph {
     for (final package in packageGraph.allPackages.values) {
       final config =
           overrideBuildConfig[package.name] ??
-          await _packageBuildConfig(package);
+          await _packageBuildConfig(reader, package);
       List<String> defaultInclude;
       if (package.isRoot) {
         defaultInclude = [
@@ -219,25 +224,38 @@ class TargetNode {
   String toString() => target.key;
 }
 
-Future<BuildConfig> _packageBuildConfig(PackageNode package) async {
-  final dependencyNames = package.dependencies.map((n) => n.name);
+Future<BuildConfig> _packageBuildConfig(
+  AssetReader? reader,
+  PackageNode package,
+) async {
+  final dependencies = [for (final node in package.dependencies) node.name];
   try {
-    return await BuildConfig.fromBuildConfigDir(
-      package.name,
-      dependencyNames,
-      package.path,
-    );
+    final id = AssetId(package.name, 'build.yaml');
+    if (reader != null && await reader.canRead(id)) {
+      return BuildConfig.parse(
+        package.name,
+        dependencies,
+        await reader.readAsString(id),
+        configYamlPath: p.join(package.path, 'build.yaml'),
+      );
+    } else {
+      return BuildConfig.useDefault(package.name, dependencies);
+    }
   } on ArgumentError // ignore: avoid_catching_errors
   catch (e) {
-    throw BuildConfigParseException(package.name, e);
+    throw BuildConfigParseException(package.name, e.toString());
   }
 }
 
 class BuildConfigParseException implements Exception {
   final String packageName;
-  final dynamic exception;
+  final String message;
+
+  BuildConfigParseException(this.packageName, this.message);
 
-  BuildConfigParseException(this.packageName, this.exception);
+  @override
+  String toString() =>
+      'Failed to parse `build.yaml` for $packageName: $message';
 }
 
 /// Returns the [sources] are not included in any [targets].
diff --git a/build_runner_core/test/generate/build_configuration_test.dart b/build_runner_core/test/generate/build_configuration_test.dart
@@ -2,7 +2,6 @@
 // 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:_test_common/build_configs.dart';
 import 'package:_test_common/common.dart';
 import 'package:build/build.dart';
 import 'package:build_runner_core/build_runner_core.dart';
@@ -17,25 +16,22 @@ void main() {
       ),
     );
 
-    final buildConfigs = parseBuildConfigs({
-      'a': {
-        'targets': {
-          'a': {
-            'builders': {
-              'a:optioned_builder': {
-                'options': {'inputExtension': '.matches'},
-              },
-            },
-          },
-        },
-      },
-    });
     await testPhases(
       [
         apply('a:optioned_builder', [copyBuilder], toRoot(), hideOutput: false),
       ],
-      {'a|lib/file.nomatch': 'a', 'a|lib/file.matches': 'b'},
-      overrideBuildConfig: buildConfigs,
+      {
+        'a|lib/file.nomatch': 'a',
+        'a|lib/file.matches': 'b',
+        'a|build.yaml': '''
+targets:
+  a:
+    builders:
+      a:optioned_builder:
+        options:
+          inputExtension: .matches
+''',
+      },
       outputs: {'a|lib/file.copy': 'b'},
     );
   });
diff --git a/build_runner_core/test/generate/build_definition_test.dart b/build_runner_core/test/generate/build_definition_test.dart
@@ -136,6 +136,7 @@ targets:
       var packageGraph = await PackageGraph.forPath(pkgARoot);
       environment = BuildEnvironment(packageGraph);
       options = await BuildOptions.create(
+        reader: environment.reader,
         packageGraph: packageGraph,
         skipBuildScriptCheck: true,
       );
diff --git a/build_runner_core/test/generate/build_test.dart b/build_runner_core/test/generate/build_test.dart
diff --git a/build_test/CHANGELOG.md b/build_test/CHANGELOG.md
diff --git a/build_test/lib/src/test_builder.dart b/build_test/lib/src/test_builder.dart
