Deprecations before build major version release. (#4175)

Author: davidmorgan

_test_common/lib/runner_asset_writer_spy.dart

@@ -3,17 +3,35 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:convert';
 
 import 'package:build/build.dart';
 import 'package:build_runner_core/build_runner_core.dart';
 
-class RunnerAssetWriterSpy extends AssetWriterSpy implements RunnerAssetWriter {
+class RunnerAssetWriterSpy implements RunnerAssetWriter {
   final RunnerAssetWriter _delegate;
+  final _assetsWritten = <AssetId>{};
 
   final _assetsDeleted = <AssetId>{};
   Iterable<AssetId> get assetsDeleted => _assetsDeleted;
 
-  RunnerAssetWriterSpy(this._delegate) : super(_delegate);
+  RunnerAssetWriterSpy(this._delegate);
+
+  @override
+  Future<void> writeAsBytes(AssetId id, List<int> bytes) {
+    _assetsWritten.add(id);
+    return _delegate.writeAsBytes(id, bytes);
+  }
+
+  @override
+  Future<void> writeAsString(
+    AssetId id,
+    String contents, {
+    Encoding encoding = utf8,
+  }) {
+    _assetsWritten.add(id);
+    return _delegate.writeAsString(id, contents, encoding: encoding);
+  }
 
   @override
   Future<void> delete(AssetId id) {

build/CHANGELOG.md

@@ -1,11 +1,15 @@
 ## 3.0.3-wip
 
 - Deprecate `runBuilder`. It has been moved to `package:build_runner_core` and
-  will be deleted from `package:build`. Please note: the currently supported
+  will be removed from `package:build`. Please note: the currently supported
   ways to run builders are using `build_runner` on the command line or
   `build_test` in tests. If you need ongoing support for a different way to run
   builders please get in touch at
   https://github.com/dart-lang/build/discussions.
+- Deprecate `runPostProcessBuilder`. Like `runBuilder`, it has been moved to
+  `package:build_runner_core` and will be removed from `package:build`.
+- Deprecate `AssetWriterSpy`. It will be removed.
+- Deprecate `MultiplexingBuilder`. It will be removed.
 - Use `build_runner_core` 9.3.1.
 
 ## 3.0.2

build/lib/build.dart

@@ -13,10 +13,9 @@ export 'src/builder/exceptions.dart';
 export 'src/builder/file_deleting_builder.dart' show FileDeletingBuilder;
 export 'src/builder/logging.dart' show log;
 export 'src/builder/multiplexing_builder.dart';
-export 'src/builder/post_process_build_step.dart' show PostProcessBuildStep;
-export 'src/builder/post_process_builder.dart'
-    show PostProcessBuilder, PostProcessBuilderFactory;
+export 'src/builder/post_process_build_step.dart';
+export 'src/builder/post_process_builder.dart';
 export 'src/generate/expected_outputs.dart';
 export 'src/generate/run_builder.dart';
-export 'src/generate/run_post_process_builder.dart' show runPostProcessBuilder;
+export 'src/generate/run_post_process_builder.dart';
 export 'src/resource/resource.dart';

build/lib/src/asset/writer.dart

@@ -29,6 +29,7 @@ abstract class AssetWriter {
 }
 
 /// An [AssetWriter] which tracks all [assetsWritten] during its lifetime.
+@Deprecated('This class will be deleted without replacement in 4.0.0.')
 class AssetWriterSpy implements AssetWriter {
   final AssetWriter _delegate;
   final _assetsWritten = <AssetId>{};

build/lib/src/builder/build_step.dart

@@ -135,7 +135,3 @@ abstract class BuildStep implements AssetReader, AssetWriter {
   /// [readAsBytes] or [readAsString].
   Future<PackageConfig> get packageConfig;
 }
-
-abstract class StageTracker {
-  T trackStage<T>(String label, T Function() action, {bool isExternal = false});
-}

build/lib/src/builder/multiplexing_builder.dart

@@ -11,6 +11,7 @@ import 'builder.dart';
 /// **Note**: All builders are ran without ordering guarantees. Thus, none of
 /// the builders can use the outputs of other builders in this group. All
 /// builders must also have distinct outputs.
+@Deprecated('This class will be deleted without replacement in 4.0.0.')
 class MultiplexingBuilder implements Builder {
   final Iterable<Builder> _builders;
 

build/lib/src/builder/post_process_build_step.dart

@@ -5,90 +5,35 @@
 import 'dart:async';
 import 'dart:convert';
 
-import 'package:async/async.dart';
-import 'package:crypto/crypto.dart' show Digest;
+import 'package:crypto/crypto.dart';
 
 import '../../build.dart';
 
-// This is not exported to hack around a package-private constructor.
-PostProcessBuildStep postProcessBuildStep(
-  AssetId inputId,
-  AssetReader reader,
-  AssetWriter writer,
-  void Function(AssetId) addAsset,
-  void Function(AssetId) deleteAsset,
-) => PostProcessBuildStep._(inputId, reader, writer, addAsset, deleteAsset);
-
 /// A simplified [BuildStep] which can only read its primary input, and can't
-/// get a [Resolver] or any [Resource]s, at least for now.
-class PostProcessBuildStep {
-  final AssetId inputId;
-
-  final AssetReader _reader;
-  final AssetWriter _writer;
-  final void Function(AssetId) _addAsset;
-  final void Function(AssetId) _deleteAsset;
-
-  /// The result of any writes which are starting during this step.
-  final _writeResults = <Future<Result<void>>>[];
+/// get a [Resolver] or any [Resource]s.
+abstract class PostProcessBuildStep {
+  AssetId get inputId;
 
-  PostProcessBuildStep._(
-    this.inputId,
-    this._reader,
-    this._writer,
-    this._addAsset,
-    this._deleteAsset,
-  );
+  Future<Digest> digest(AssetId id);
 
-  Future<Digest> digest(AssetId id) =>
-      inputId == id
-          ? _reader.digest(id)
-          : Future.error(InvalidInputException(id));
+  Future<List<int>> readInputAsBytes();
 
-  Future<List<int>> readInputAsBytes() => _reader.readAsBytes(inputId);
+  Future<String> readInputAsString({Encoding encoding = utf8});
 
-  Future<String> readInputAsString({Encoding encoding = utf8}) =>
-      _reader.readAsString(inputId, encoding: encoding);
-
-  Future<void> writeAsBytes(AssetId id, FutureOr<List<int>> bytes) {
-    _addAsset(id);
-    var done = _futureOrWrite(
-      bytes,
-      (List<int> b) => _writer.writeAsBytes(id, b),
-    );
-    _writeResults.add(Result.capture(done));
-    return done;
-  }
+  Future<void> writeAsBytes(AssetId id, FutureOr<List<int>> bytes);
 
   Future<void> writeAsString(
     AssetId id,
     FutureOr<String> content, {
     Encoding encoding = utf8,
-  }) {
-    _addAsset(id);
-    var done = _futureOrWrite(
-      content,
-      (String c) => _writer.writeAsString(id, c, encoding: encoding),
-    );
-    _writeResults.add(Result.capture(done));
-    return done;
-  }
+  });
 
   /// Marks an asset for deletion in the post process step.
-  void deletePrimaryInput() {
-    _deleteAsset(inputId);
-  }
+  void deletePrimaryInput();
 
   /// Waits for work to finish and cleans up resources.
   ///
   /// This method should be called after a build has completed. After the
   /// returned [Future] completes then all outputs have been written.
-  Future<void> complete() async {
-    await Future.wait(_writeResults.map(Result.release));
-  }
+  Future<void> complete();
 }
-
-Future<void> _futureOrWrite<T>(
-  FutureOr<T> content,
-  Future<void> Function(T content) write,
-) => (content is Future<T>) ? content.then(write) : write(content);

build/lib/src/generate/run_builder.dart

@@ -12,13 +12,15 @@ import '../analyzer/resolver.dart';
 import '../asset/id.dart';
 import '../asset/reader.dart';
 import '../asset/writer.dart';
-import '../builder/build_step.dart';
 import '../builder/builder.dart';
 import '../resource/resource.dart';
 
+export 'package:build_runner_core/src/generate/run_builder.dart'
+    show StageTracker;
+
 @Deprecated('''
 This method has moved to `package:build_runner_core` and will be
-deleted from `package:build`.
+removed from `package:build` in 4.0.0.
 
 The currently supported ways to run builders are using `build_runner`
 on the command line or `build_test` in tests. If you need ongoing
@@ -33,7 +35,7 @@ Future<void> runBuilder(
   Resolvers? resolvers, {
   Logger? logger,
   ResourceManager? resourceManager,
-  StageTracker? stageTracker,
+  build_runner_core.StageTracker? stageTracker,
   void Function(AssetId input, Iterable<AssetId> assets)?
   reportUnusedAssetsForInput,
   PackageConfig? packageConfig,

build/lib/src/generate/run_post_process_builder.dart

@@ -2,20 +2,31 @@
 // 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:build_runner_core/build_runner_core.dart';
+// ignore: implementation_imports
+import 'package:build_runner_core/src/generate/run_post_process_builder.dart'
+    as build_runner_core;
 import 'package:logging/logging.dart';
 
 import '../asset/id.dart';
 import '../asset/reader.dart';
 import '../asset/writer.dart';
-import '../builder/post_process_build_step.dart';
+import '../builder/post_process_builder.dart';
 
 /// Run [builder] with [inputId] as the primary input.
 ///
 /// [addAsset] should update the build systems knowledge of what assets exist.
 /// If an asset should not be written this function should throw.
 /// [deleteAsset] should remove the asset from the build system, it will not be
 /// deleted on disk since the `writer` has no mechanism for delete.
+@Deprecated('''
+This method has moved to `package:build_runner_core` and will be
+deleted from `package:build` in 4.0.0.
+
+The currently supported ways to run builders are using `build_runner`
+on the command line or `build_test` in tests. If you need ongoing
+support for a different way to run builders please get in touch at
+https://github.com/dart-lang/build/discussions.
+''')
 Future<void> runPostProcessBuilder(
   PostProcessBuilder builder,
   AssetId inputId,
@@ -24,19 +35,12 @@ Future<void> runPostProcessBuilder(
   Logger logger, {
   required void Function(AssetId) addAsset,
   required void Function(AssetId) deleteAsset,
-}) async {
-  await BuildLogLogger.scopeLogAsync(() async {
-    var buildStep = postProcessBuildStep(
-      inputId,
-      reader,
-      writer,
-      addAsset,
-      deleteAsset,
-    );
-    try {
-      await builder.build(buildStep);
-    } finally {
-      await buildStep.complete();
-    }
-  }, logger);
-}
+}) => build_runner_core.runPostProcessBuilder(
+  builder,
+  inputId,
+  reader,
+  writer,
+  logger,
+  addAsset: addAsset,
+  deleteAsset: deleteAsset,
+);

build_runner_core/CHANGELOG.md

@@ -6,6 +6,7 @@
   `build_test` in tests. If you need ongoing support for a different way to run
   builders please get in touch at
   https://github.com/dart-lang/build/discussions.
+- Similarly, move `runPostProcessBuilder` to here from `package:build`.
 - Use `build_runner` 2.7.1.
 - Remove `overrideGeneratedOutputDirectory`, `pubBinary`.