Split out _SingleBuild as Build and BuildImpl as BuildSeries. (#3927)

Author: davidmorgan

build_runner/lib/src/daemon/daemon_builder.dart

@@ -19,7 +19,7 @@ import 'package:build_runner_core/build_runner_core.dart'
 // ignore: implementation_imports
 import 'package:build_runner_core/src/generate/build_definition.dart';
 // ignore: implementation_imports
-import 'package:build_runner_core/src/generate/build_impl.dart';
+import 'package:build_runner_core/src/generate/build_series.dart';
 import 'package:stream_transform/stream_transform.dart';
 import 'package:watcher/watcher.dart';
 
@@ -36,7 +36,7 @@ import 'change_providers.dart';
 class BuildRunnerDaemonBuilder implements DaemonBuilder {
   final _buildResults = StreamController<BuildResults>();
 
-  final BuildImpl _builder;
+  final BuildSeries _buildSeries;
   final BuildOptions _buildOptions;
   final StreamController<ServerLog> _outputStreamController;
   final ChangeProvider changeProvider;
@@ -47,7 +47,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
   final Stream<ServerLog> logs;
 
   BuildRunnerDaemonBuilder._(
-    this._builder,
+    this._buildSeries,
     this._buildOptions,
     this._outputStreamController,
     this.changeProvider,
@@ -60,7 +60,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
   @override
   Stream<BuildResults> get builds => _buildResults.stream;
 
-  FinalizedReader get reader => _builder.finalizedReader;
+  FinalizedReader get reader => _buildSeries.finalizedReader;
 
   final _buildScriptUpdateCompleter = Completer<void>();
   Future<void> get buildScriptUpdated => _buildScriptUpdateCompleter.future;
@@ -79,7 +79,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
             .toList();
 
     if (!_buildOptions.skipBuildScriptCheck &&
-        _builder.buildScriptUpdates!.hasBeenUpdated(
+        _buildSeries.buildScriptUpdates!.hasBeenUpdated(
           changes.map<AssetId>((change) => change.id).toSet(),
         )) {
       if (!_buildScriptUpdateCompleter.isCompleted) {
@@ -131,7 +131,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
 
     try {
       var mergedChanges = collectChanges([changes]);
-      var result = await _builder.run(
+      var result = await _buildSeries.run(
         mergedChanges,
         buildDirs: buildDirs,
         buildFilters: buildFilters,
@@ -190,7 +190,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
 
   @override
   Future<void> stop() async {
-    await _builder.beforeExit();
+    await _buildSeries.beforeExit();
     await _buildOptions.logListener.cancel();
   }
 
@@ -279,7 +279,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
       logPerformanceDir: daemonOptions.logPerformanceDir,
     );
 
-    var builder = await BuildImpl.create(
+    var buildSeries = await BuildSeries.create(
       buildOptions,
       daemonEnvironment,
       builders,
@@ -300,7 +300,7 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
         .asyncWhere(
           (change) => shouldProcess(
             change,
-            builder.assetGraph,
+            buildSeries.assetGraph,
             buildOptions,
             // Assume we will create an outputDir.
             true,
@@ -316,11 +316,11 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
             ? AutoChangeProviderImpl(graphEvents())
             : ManualChangeProviderImpl(
               AssetTracker(daemonEnvironment.reader, buildOptions.targetGraph),
-              builder.assetGraph,
+              buildSeries.assetGraph,
             );
 
     return BuildRunnerDaemonBuilder._(
-      builder,
+      buildSeries,
       buildOptions,
       outputStreamController,
       changeProvider,

build_runner/lib/src/generate/watch_impl.dart

@@ -11,7 +11,7 @@ import 'package:build_runner_core/build_runner_core.dart';
 // ignore: implementation_imports
 import 'package:build_runner_core/src/asset_graph/graph.dart';
 // ignore: implementation_imports
-import 'package:build_runner_core/src/generate/build_impl.dart';
+import 'package:build_runner_core/src/generate/build_series.dart';
 import 'package:crypto/crypto.dart';
 import 'package:logging/logging.dart';
 import 'package:stream_transform/stream_transform.dart';
@@ -159,9 +159,9 @@ WatchImpl _runWatch(
 );
 
 class WatchImpl implements BuildState {
-  BuildImpl? _build;
+  BuildSeries? _buildSeries;
 
-  AssetGraph? get assetGraph => _build?.assetGraph;
+  AssetGraph? get assetGraph => _buildSeries?.assetGraph;
 
   final String? _configKey;
 
@@ -250,7 +250,7 @@ class WatchImpl implements BuildState {
     var controller = StreamController<BuildResult>();
 
     Future<BuildResult> doBuild(List<List<AssetChange>> changes) async {
-      var build = _build!;
+      var build = _buildSeries!;
       _logger
         ..info('${'-' * 72}\n')
         ..info('Starting Build\n');
@@ -362,7 +362,7 @@ class WatchImpl implements BuildState {
         })
         .onDone(() async {
           await currentBuild;
-          await _build?.beforeExit();
+          await _buildSeries?.beforeExit();
           if (!controller.isClosed) await controller.close();
           _logger.info('Builds finished. Safe to exit\n');
         });
@@ -387,10 +387,10 @@ class WatchImpl implements BuildState {
       }
 
       BuildResult firstBuild;
-      BuildImpl? build;
+      BuildSeries? build;
       try {
         build =
-            _build = await BuildImpl.create(
+            _buildSeries = await BuildSeries.create(
               options,
               watcherEnvironment,
               builders,

…er_core/lib/src/generate/build_impl.dart …_runner_core/lib/src/generate/build.dartbuild_runner_core/lib/src/generate/build_impl.dart renamed to build_runner_core/lib/src/generate/build.dart build_runner_core/lib/src/generate/build_impl.dart renamed to build_runner_core/lib/src/generate/build.dart

@@ -16,26 +16,23 @@ import 'package:logging/logging.dart';
 import 'package:path/path.dart' as p;
 import 'package:watcher/watcher.dart';
 
-import '../asset/finalized_reader.dart';
 import '../asset/writer.dart';
 import '../asset_graph/graph.dart';
 import '../asset_graph/node.dart';
 import '../asset_graph/optional_output_tracker.dart';
-import '../changes/build_script_updates.dart';
 import '../environment/build_environment.dart';
 import '../logging/build_for_input_logger.dart';
 import '../logging/failure_reporter.dart';
 import '../logging/human_readable_duration.dart';
 import '../logging/logging.dart';
-import '../package_graph/apply_builders.dart';
 import '../package_graph/package_graph.dart';
 import '../package_graph/target_graph.dart';
 import '../performance_tracking/performance_tracking_resolvers.dart';
 import '../util/build_dirs.dart';
 import '../util/constants.dart';
-import 'build_definition.dart';
 import 'build_directory.dart';
 import 'build_result.dart';
+import 'build_series.dart';
 import 'finalized_assets_view.dart';
 import 'heartbeat.dart';
 import 'input_tracker.dart';
@@ -46,103 +43,8 @@ import 'single_step_reader_writer.dart';
 
 final _logger = Logger('Build');
 
-Set<String> _buildPaths(Set<BuildDirectory> buildDirs) =>
-    // The empty string means build everything.
-    buildDirs.any((b) => b.directory == '')
-        ? <String>{}
-        : buildDirs.map((b) => b.directory).toSet();
-
-class BuildImpl {
-  final BuildEnvironment _environment;
-  final AssetGraph assetGraph;
-  final BuildScriptUpdates? buildScriptUpdates;
-  final BuildOptions _options;
-  final List<BuildPhase> _buildPhases;
-
-  final FinalizedReader finalizedReader;
-  final AssetReaderWriter _readerWriter;
-  final RunnerAssetWriter _deleteWriter;
-  final ResourceManager _resourceManager = ResourceManager();
-
-  Future<void> beforeExit() => _resourceManager.beforeExit();
-
-  BuildImpl._(
-    this._environment,
-    this.assetGraph,
-    this.buildScriptUpdates,
-    this._options,
-    this._buildPhases,
-    this.finalizedReader,
-  ) : _deleteWriter = _environment.writer.copyWith(
-        generatedAssetHider: assetGraph,
-      ),
-      _readerWriter = _environment.reader.copyWith(
-        generatedAssetHider: assetGraph,
-        cache:
-            _options.enableLowResourcesMode
-                ? const PassthroughFilesystemCache()
-                : InMemoryFilesystemCache(),
-      );
-
-  Future<BuildResult> run(
-    Map<AssetId, ChangeType> updates, {
-    Set<BuildDirectory> buildDirs = const <BuildDirectory>{},
-    Set<BuildFilter> buildFilters = const {},
-  }) {
-    finalizedReader.reset(_buildPaths(buildDirs), buildFilters);
-    return _SingleBuild(this, buildDirs, buildFilters).run(updates)
-      ..whenComplete(_options.resolvers.reset);
-  }
-
-  static Future<BuildImpl> create(
-    BuildOptions options,
-    BuildEnvironment environment,
-    List<BuilderApplication> builders,
-    Map<String, Map<String, dynamic>> builderConfigOverrides, {
-    bool isReleaseBuild = false,
-  }) async {
-    // Don't allow any changes to the generated asset directory after this
-    // point.
-    lockGeneratedOutputDirectory();
-
-    var buildPhases = await createBuildPhases(
-      options.targetGraph,
-      builders,
-      builderConfigOverrides,
-      isReleaseBuild,
-    );
-    if (buildPhases.isEmpty) {
-      _logger.severe('Nothing can be built, yet a build was requested.');
-    }
-    var buildDefinition = await BuildDefinition.prepareWorkspace(
-      environment,
-      options,
-      buildPhases,
-    );
-    var finalizedReader = FinalizedReader(
-      environment.reader.copyWith(
-        generatedAssetHider: buildDefinition.assetGraph,
-      ),
-      buildDefinition.assetGraph,
-      options.targetGraph,
-      buildPhases,
-      options.packageGraph.root.name,
-    );
-    var build = BuildImpl._(
-      environment,
-      buildDefinition.assetGraph,
-      buildDefinition.buildScriptUpdates,
-      options,
-      buildPhases,
-      finalizedReader,
-    );
-    return build;
-  }
-}
-
-/// Performs a single build and manages state that only lives for a single
-/// build.
-class _SingleBuild {
+/// A single build.
+class Build {
   final AssetGraph _assetGraph;
   final Set<BuildFilter> _buildFilters;
   final List<BuildPhase> _buildPhases;
@@ -167,26 +69,26 @@ class _SingleBuild {
 
   late final HungActionsHeartbeat hungActionsHeartbeat;
 
-  _SingleBuild(
-    BuildImpl buildImpl,
+  Build(
+    BuildSeries buildSeries,
     Set<BuildDirectory> buildDirs,
     Set<BuildFilter> buildFilters,
-  ) : _assetGraph = buildImpl.assetGraph,
+  ) : _assetGraph = buildSeries.assetGraph,
       _buildFilters = buildFilters,
-      _buildPhases = buildImpl._buildPhases,
-      _environment = buildImpl._environment,
-      _packageGraph = buildImpl._options.packageGraph,
-      _targetGraph = buildImpl._options.targetGraph,
+      _buildPhases = buildSeries.buildPhases,
+      _environment = buildSeries.environment,
+      _packageGraph = buildSeries.options.packageGraph,
+      _targetGraph = buildSeries.options.targetGraph,
       _performanceTracker =
-          buildImpl._options.trackPerformance
+          buildSeries.options.trackPerformance
               ? BuildPerformanceTracker()
               : BuildPerformanceTracker.noOp(),
-      _readerWriter = buildImpl._readerWriter,
-      _deleteWriter = buildImpl._deleteWriter,
-      _resolvers = buildImpl._options.resolvers,
-      _resourceManager = buildImpl._resourceManager,
+      _readerWriter = buildSeries.readerWriter,
+      _deleteWriter = buildSeries.deleteWriter,
+      _resolvers = buildSeries.options.resolvers,
+      _resourceManager = buildSeries.resourceManager,
       _buildDirs = buildDirs,
-      _logPerformanceDir = buildImpl._options.logPerformanceDir {
+      _logPerformanceDir = buildSeries.options.logPerformanceDir {
     hungActionsHeartbeat = HungActionsHeartbeat(() {
       final message = StringBuffer();
       const actionsToLogMax = 5;
@@ -211,7 +113,7 @@ class _SingleBuild {
     var optionalOutputTracker = OptionalOutputTracker(
       _assetGraph,
       _targetGraph,
-      _buildPaths(_buildDirs),
+      BuildDirectory.buildPaths(_buildDirs),
       _buildFilters,
       _buildPhases,
     );
@@ -389,7 +291,7 @@ class _SingleBuild {
         .toList(growable: false)) {
       if (!shouldBuildForDirs(
         node.id,
-        buildDirs: _buildPaths(_buildDirs),
+        buildDirs: BuildDirectory.buildPaths(_buildDirs),
         buildFilters: _buildFilters,
         phase: phase,
         targetGraph: _targetGraph,

build_runner_core/lib/src/generate/build_directory.dart

@@ -15,6 +15,12 @@ class BuildDirectory {
 
   @override
   int get hashCode => Object.hash(directory, outputLocation);
+
+  static Set<String> buildPaths(Set<BuildDirectory> buildDirs) =>
+      // The empty string means build everything.
+      buildDirs.any((b) => b.directory == '')
+          ? <String>{}
+          : buildDirs.map((b) => b.directory).toSet();
 }
 
 class OutputLocation {

build_runner_core/lib/src/generate/build_runner.dart

@@ -10,12 +10,12 @@ import 'package:watcher/watcher.dart';
 import '../environment/build_environment.dart';
 import '../package_graph/apply_builders.dart';
 import 'build_directory.dart';
-import 'build_impl.dart';
 import 'build_result.dart';
+import 'build_series.dart';
 import 'options.dart';
 
 class BuildRunner {
-  final BuildImpl _build;
+  final BuildSeries _build;
   BuildRunner._(this._build);
 
   Future<void> beforeExit() => _build.beforeExit();
@@ -34,7 +34,7 @@ class BuildRunner {
     bool isReleaseBuild = false,
   }) async {
     return BuildRunner._(
-      await BuildImpl.create(
+      await BuildSeries.create(
         options,
         environment,
         builders,