Store errors in the asset graph instead of separate files. (#4013)

Author: davidmorgan

build_runner_core/CHANGELOG.md

@@ -36,6 +36,7 @@
   in the asset graph.
 - Track resolver dependencies as library cycle graphs.
 - Ignore deprecated analyzer API usages.
+- Store errors in the asset graph instead of separate files.
 
 ## 8.0.0
 

build_runner_core/lib/src/asset_graph/graph_loader.dart

@@ -16,7 +16,6 @@ import '../asset_graph/exceptions.dart';
 import '../asset_graph/graph.dart';
 import '../generate/build_phases.dart';
 import '../generate/exceptions.dart';
-import '../logging/failure_reporter.dart';
 import '../logging/logging.dart';
 import '../package_graph/package_graph.dart';
 import '../util/constants.dart';
@@ -66,7 +65,6 @@ class AssetGraphLoader {
         );
         await Future.wait([
           writer.deleteDirectory(_generatedOutputDirectoryId),
-          FailureReporter.cleanErrorCache(),
         ]);
         return null;
       }
@@ -111,7 +109,6 @@ class AssetGraphLoader {
         writer.delete(assetGraphId),
         cachedGraph.deleteOutputs(packageGraph, writer),
         writer.deleteDirectory(_generatedOutputDirectoryId),
-        FailureReporter.cleanErrorCache(),
       ]);
       if (_runningFromSnapshot) {
         throw const BuildScriptChangedException();
@@ -126,7 +123,6 @@ class AssetGraphLoader {
         writer.delete(assetGraphId),
         cachedGraph.deleteOutputs(packageGraph, writer),
         writer.deleteDirectory(_generatedOutputDirectoryId),
-        FailureReporter.cleanErrorCache(),
       ]);
       if (_runningFromSnapshot) {
         throw const BuildScriptChangedException();

build_runner_core/lib/src/asset_graph/node.dart

@@ -286,6 +286,8 @@ abstract class GeneratedNodeState
   /// [AssetNode.wasOutput].
   bool? get result;
 
+  BuiltList<String> get errors;
+
   factory GeneratedNodeState(void Function(GeneratedNodeStateBuilder) updates) =
       _$GeneratedNodeState;
 

build_runner_core/lib/src/asset_graph/node.g.dart

@@ -25,7 +25,6 @@ import '../asset_graph/post_process_build_step_id.dart';
 import '../changes/asset_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/log_renderer.dart';
 import '../logging/logging.dart';
@@ -72,7 +71,6 @@ class Build {
   final AssetGraph assetGraph;
   final lazyPhases = <String, Future<Iterable<AssetId>>>{};
   final lazyGlobs = <AssetId, Future<void>>{};
-  final failureReporter = FailureReporter();
   int actionsCompletedCount = 0;
   int actionsStartedCount = 0;
   final pendingActions = SplayTreeMap<int, Set<String>>();
@@ -114,6 +112,9 @@ class Build {
   /// checked against the digest from the previous build.
   final Set<AssetId> changedOutputs = {};
 
+  /// Outputs for which errors have been shown.
+  final Set<AssetId> errorsShownOutputs = {};
+
   /// Whether a graph from [previousLibraryCycleGraphLoader] has any changed
   /// transitive source.
   final Map<LibraryCycleGraph, bool> changedGraphs = Map.identity();
@@ -170,12 +171,27 @@ class Build {
       buildPhases,
     );
     if (result.status == BuildStatus.success) {
-      final failures = processedOutputs
-          .map((id) => assetGraph.get(id)!)
-          .where((node) => node.type == NodeType.generated)
-          .where((node) => node.generatedNodeState!.result == false);
+      final failures = <AssetNode>[];
+      for (final output in processedOutputs) {
+        final node = assetGraph.get(output)!;
+        if (node.type != NodeType.generated) continue;
+        if (node.generatedNodeState!.result != false) continue;
+        failures.add(node);
+      }
       if (failures.isNotEmpty) {
-        await failureReporter.reportErrors(failures);
+        for (final failure in failures) {
+          if (errorsShownOutputs.contains(failure.id)) continue;
+          for (final error in failure.generatedNodeState!.errors) {
+            final name = _actionLoggerName(
+              buildPhases.inBuildPhases[failure
+                  .generatedNodeConfiguration!
+                  .phaseNumber],
+              failure.generatedNodeConfiguration!.primaryInput,
+              options.packageGraph.root.name,
+            );
+            _logger.severe('$name (cached)\n$error');
+          }
+        }
         result = BuildResult(
           BuildStatus.failure,
           result.outputs,
@@ -494,7 +510,6 @@ class Build {
       }
 
       await _cleanUpStaleOutputs(builderOutputs);
-      await FailureReporter.clean(phaseNumber, primaryInput);
 
       // Clear input tracking accumulated during `_buildShouldRun`.
       readerWriter.inputTracker.clear();
@@ -630,7 +645,6 @@ class Build {
     readerWriter.inputTracker.clear();
 
     // Clean out the impacts of the previous run.
-    await FailureReporter.clean(phaseNumber, input);
     final existingOutputs = assetGraph.postProcessBuildStepOutputs(
       postProcessBuildStepId,
     );
@@ -738,10 +752,10 @@ class Build {
         // https://github.com/dart-lang/build/issues/3875.
         nodeBuilder.digest = null;
         nodeBuilder.generatedNodeState.result = false;
+        nodeBuilder.generatedNodeState.errors.clear();
       });
       processedOutputs.add(output);
     }
-    await failureReporter.markSkipped(outputs.map((id) => assetGraph.get(id)!));
   }
 
   /// Checks and returns whether any [outputs] need to be updated in
@@ -1191,15 +1205,15 @@ class Build {
   /// - Setting `digest` based on what was written.
   /// - Setting `result` based on action success.
   /// - Setting `inputs` based on `inputTracker` and `unusedAssets`.
-  /// - Storing the error message with the [failureReporter].
+  /// - Setting `errors`.
   /// - Updating `newPrimaryInputs` and `changedOutputs` as needed.
   Future<void> _setOutputsState(
     AssetId input,
     Iterable<AssetId> outputs,
     SingleStepReaderWriter readerWriter,
     InputTracker inputTracker,
     String actionDescription,
-    Iterable<ErrorReport> errors, {
+    Iterable<String> errors, {
     Set<AssetId>? unusedAssets,
   }) async {
     if (outputs.isEmpty) return;
@@ -1232,22 +1246,15 @@ class Build {
         nodeBuilder.generatedNodeState
           ..inputs.replace(usedInputs)
           ..resolverEntrypoints.replace(inputTracker.resolverEntrypoints)
-          ..result = result;
+          ..result = result
+          ..errors.replace(errors);
         nodeBuilder.digest = digest;
       });
 
-      if (!result) {
-        // Mark this output as failed. Transitive outputs will be marked as
-        // failed when they are processed and notice their primary inputs
-        // have failed.
-        await failureReporter.markReported(
-          actionDescription,
-          outputNode,
-          errors,
-        );
-      }
-
       processedOutputs.add(output);
+      if (result == false) {
+        errorsShownOutputs.add(output);
+      }
     }
   }
 

build_runner_core/lib/src/asset_graph/serializers.g.dart

@@ -4,16 +4,15 @@
 
 import 'dart:async';
 
+import 'package:build/build.dart';
 import 'package:logging/logging.dart';
 
-import 'failure_reporter.dart';
-
 /// A delegating [Logger] that records if any logs of level >= [Level.SEVERE]
 /// were seen.
 class BuildForInputLogger implements Logger {
   final Logger _delegate;
 
-  final errorsSeen = <ErrorReport>[];
+  final errorsSeen = <String>[];
 
   BuildForInputLogger(this._delegate);
 
@@ -64,7 +63,7 @@ class BuildForInputLogger implements Logger {
     Zone? zone,
   ]) {
     if (logLevel >= Level.SEVERE) {
-      errorsSeen.add(ErrorReport('$message', '${error ?? ''}', stackTrace));
+      errorsSeen.add(_renderError(message, error, stackTrace));
     }
     _delegate.log(logLevel, message, error, stackTrace, zone);
   }
@@ -80,13 +79,13 @@ class BuildForInputLogger implements Logger {
 
   @override
   void severe(Object? message, [Object? error, StackTrace? stackTrace]) {
-    errorsSeen.add(ErrorReport('$message', '${error ?? ''}', stackTrace));
+    errorsSeen.add(_renderError(message, error, stackTrace));
     _delegate.severe(message, error, stackTrace);
   }
 
   @override
   void shout(Object? message, [Object? error, StackTrace? stackTrace]) {
-    errorsSeen.add(ErrorReport('$message', '${error ?? ''}', stackTrace));
+    errorsSeen.add(_renderError(message, error, stackTrace));
     _delegate.shout(message, error, stackTrace);
   }
 
@@ -96,4 +95,23 @@ class BuildForInputLogger implements Logger {
 
   @override
   Stream<Level?> get onLevelChanged => _delegate.onLevelChanged;
+
+  String _renderError(
+    Object? message, [
+    Object? error,
+    StackTrace? stackTrace,
+  ]) {
+    var result = message?.toString() ?? '';
+    if (error != null) result += '\n$error';
+
+    // Drop stack traces for exception types that can be caused by normal
+    // user input; render stack traces for everything else as they can point to
+    // bugs in generators or in build_runner.
+    if (stackTrace != null &&
+        error is! SyntaxErrorInAssetException &&
+        error is! UnresolvableAssetException) {
+      result += '\n$stackTrace';
+    }
+    return result;
+  }
 }