Refactor OverridableEnvironment and IOEnvironment into BuildEnvironment. (#3919)

Author: davidmorgan

_test_common/lib/test_environment.dart

@@ -4,6 +4,7 @@
 
 import 'dart:async';
 
+import 'package:build/build.dart';
 import 'package:build_runner_core/build_runner_core.dart';
 import 'package:logging/logging.dart';
 
@@ -16,7 +17,7 @@ import 'common.dart';
 /// To handle prompts you must first set `nextPromptResponse`. Alternatively
 /// you can set `throwOnPrompt` to `true` to emulate a
 /// [NonInteractiveBuildException].
-class TestBuildEnvironment extends BuildEnvironment {
+class TestBuildEnvironment implements BuildEnvironment {
   final TestReaderWriter _readerWriter;
 
   TestReaderWriter get readerWriter => _readerWriter;
@@ -64,4 +65,21 @@ class TestBuildEnvironment extends BuildEnvironment {
     assert(_nextPromptResponse != null);
     return Future.value(_nextPromptResponse);
   }
+
+  @override
+  BuildEnvironment copyWith({
+    void Function(LogRecord)? onLogOverride,
+    RunnerAssetWriter? writer,
+  }) => TestBuildEnvironment(
+    readerWriter: (writer as TestReaderWriter?) ?? _readerWriter,
+    throwOnPrompt: throwOnPrompt,
+  );
+
+  @override
+  Future<BuildResult> finalizeBuild(
+    BuildResult buildResult,
+    FinalizedAssetsView finalizedAssetsView,
+    AssetReader reader,
+    Set<BuildDirectory> buildDirs,
+  ) => Future.value(buildResult);
 }

_test_common/lib/test_phases.dart

@@ -131,11 +131,11 @@ Future<TestBuildersResult> testBuilders(
   });
 
   builderConfigOverrides ??= const {};
-  var environment = OverrideableEnvironment(
-    IOEnvironment(packageGraph),
+  var environment = BuildEnvironment(
+    packageGraph,
     reader: readerWriter,
     writer: readerWriter,
-    onLog: onLog,
+    onLogOverride: onLog,
   );
   var logSubscription = LogSubscription(
     environment,

build/CHANGELOG.md

@@ -4,6 +4,7 @@
 - `AssetNotFoundException` now also reports the missing `path`.
 - Bump the min sdk to 3.7.0.
 - Use `build_test` 3.0.0.
+- Use `build_runner_core` 9.0.0.
 - Add `package:build/src/internal.dart` for use by `build_resolvers`,
   `build_runner_core` and `build_test`.
 - Refactor `PathProvidingAssetReader` to `AssetPathProvider`.

build/pubspec.yaml

@@ -10,7 +10,7 @@ environment:
 dependencies:
   analyzer: '>=6.9.0 <8.0.0'
   async: ^2.5.0
-  build_runner_core: ^8.0.1-wip
+  build_runner_core: ^9.0.0-wip
   convert: ^3.0.0
   crypto: ^3.0.0
   glob: ^2.0.0

build_resolvers/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Bump the min SDK to 3.7.0.
 - Use `build_test` 3.0.0.
+- Use `build_runner_core` 9.0.0.
 - Start using `package:build/src/internal.dart`.
 - Switch `BuildAssetUriResolver` dependency crawl to an iterative
   algorithm, preventing stack overflows.

build_resolvers/pubspec.yaml

@@ -11,7 +11,7 @@ dependencies:
   analyzer: '>=6.9.0 <8.0.0'
   async: ^2.5.0
   build: ^2.4.3-wip
-  build_runner_core: ^8.0.1-wip
+  build_runner_core: ^9.0.0-wip
   collection: ^1.17.0
   convert: ^3.1.1
   crypto: ^3.0.0

build_runner/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Bump the min SDK to 3.7.0.
 - Use `build_test` 3.0.0.
+- Use `build_runner_core` 9.0.0.
 - Start using `package:build/src/internal.dart'.
 - Refactor `MultiPackageAssetReader` to internal `AssetFinder`.
 - `FinalizedReader` no longer implements `AssetReader`.

build_runner/lib/src/daemon/daemon_builder.dart

@@ -243,18 +243,15 @@ class BuildRunnerDaemonBuilder implements DaemonBuilder {
     var expectedDeletes = <AssetId>{};
     var outputStreamController = StreamController<ServerLog>();
 
-    var environment = OverrideableEnvironment(
-      IOEnvironment(
-        packageGraph,
-        outputSymlinksOnly: daemonOptions.outputSymlinksOnly,
-      ),
-      onLog: (record) {
+    var environment = BuildEnvironment(
+      packageGraph,
+      outputSymlinksOnly: daemonOptions.outputSymlinksOnly,
+      onLogOverride: (record) {
         outputStreamController.add(ServerLog.fromLogRecord(record));
       },
     );
 
-    var daemonEnvironment = OverrideableEnvironment(
-      environment,
+    var daemonEnvironment = environment.copyWith(
       writer: (environment.writer as ReaderWriter).copyWith(
         onDelete: expectedDeletes.add,
       ),

build_runner/lib/src/generate/build.dart

@@ -82,15 +82,14 @@ Future<BuildResult> build(
   skipBuildScriptCheck ??= false;
   trackPerformance ??= false;
   verbose ??= false;
-  var environment = OverrideableEnvironment(
-    IOEnvironment(
-      packageGraph,
-      assumeTty: assumeTty,
-      outputSymlinksOnly: outputSymlinksOnly,
-    ),
+  var environment = BuildEnvironment(
+    packageGraph,
+    assumeTty: assumeTty,
+    outputSymlinksOnly: outputSymlinksOnly,
     reader: reader,
     writer: writer,
-    onLog: onLog ?? stdIOLogListener(assumeTty: assumeTty, verbose: verbose),
+    onLogOverride:
+        onLog ?? stdIOLogListener(assumeTty: assumeTty, verbose: verbose),
   );
   var logSubscription = LogSubscription(
     environment,

build_runner/lib/src/generate/watch_impl.dart

@@ -67,15 +67,14 @@ Future<ServeHandler> watch(
   trackPerformance ??= false;
   verbose ??= false;
 
-  var environment = OverrideableEnvironment(
-    IOEnvironment(
-      packageGraph,
-      assumeTty: assumeTty,
-      outputSymlinksOnly: outputSymlinksOnly,
-    ),
+  var environment = BuildEnvironment(
+    packageGraph,
+    assumeTty: assumeTty,
+    outputSymlinksOnly: outputSymlinksOnly,
     reader: reader,
     writer: writer,
-    onLog: onLog ?? stdIOLogListener(assumeTty: assumeTty, verbose: verbose),
+    onLogOverride:
+        onLog ?? stdIOLogListener(assumeTty: assumeTty, verbose: verbose),
   );
   var logSubscription = LogSubscription(
     environment,
@@ -241,8 +240,7 @@ class WatchImpl implements BuildState {
     Future until, {
     bool isReleaseMode = false,
   }) {
-    var watcherEnvironment = OverrideableEnvironment(
-      environment,
+    var watcherEnvironment = environment.copyWith(
       writer: (environment.writer as ReaderWriter).copyWith(
         onDelete: _expectedDeletes.add,
       ),