From f59a234606110a94e4870d3d27cc0773d32beed3 Mon Sep 17 00:00:00 2001
From: Matt Mackay <mattem@gmail.com>
Date: Sat, 19 Nov 2022 08:57:45 -0500
Subject: [PATCH] feat: add option to exit early if analysis cache is discarded

---
 .../build/lib/analysis/AnalysisOptions.java   | 11 +++++++
 .../build/lib/analysis/BuildView.java         | 15 ++-------
 .../AnalysisAndExecutionPhaseRunner.java      | 10 +++---
 .../lib/buildtool/AnalysisPhaseRunner.java    |  9 ++---
 .../build/lib/buildtool/BuildTool.java        |  7 ++--
 .../AnalysisCacheDiscardedException.java      | 33 +++++++++++++++++++
 .../google/devtools/build/lib/skyframe/BUILD  |  1 +
 .../build/lib/skyframe/SkyframeBuildView.java |  7 +++-
 .../devtools/build/lib/util/ExitCode.java     |  3 ++
 src/main/protobuf/failure_details.proto       |  1 +
 .../analysis/util/BuildViewForTesting.java    | 11 +++++--
 11 files changed, 77 insertions(+), 31 deletions(-)
 create mode 100644 src/main/java/com/google/devtools/build/lib/skyframe/AnalysisCacheDiscardedException.java

diff --git a/src/main/java/com/google/devtools/build/lib/analysis/AnalysisOptions.java b/src/main/java/com/google/devtools/build/lib/analysis/AnalysisOptions.java
index f7cc3967b0b436..3cc5941ff8b329 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/AnalysisOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/AnalysisOptions.java
@@ -39,6 +39,17 @@ public class AnalysisOptions extends OptionsBase {
   )
   public boolean discardAnalysisCache;
 
+  @Option(
+      name = "fail_on_analysis_cache_discard",
+      defaultValue = "false",
+      documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+      effectTags = {OptionEffectTag.EAGERNESS_TO_EXIT},
+      help = "If discarding the analysis cache due to a change in the build system, setting this option will cause bazel" +
+              " to exit, rather than continuing with the build. This option has no affect when 'discard_analysis_cache'" +
+              " is also set."
+  )
+  public boolean failOnAnalysisCacheDiscard;
+
   @Option(
     name = "max_config_changes_to_show",
     defaultValue = "3",
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java b/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java
index bf672e8ce0bc4c..23298c2ad7fec4 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java
@@ -79,19 +79,10 @@
 import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
 import com.google.devtools.build.lib.server.FailureDetails.TargetPatterns;
 import com.google.devtools.build.lib.server.FailureDetails.TargetPatterns.Code;
-import com.google.devtools.build.lib.skyframe.AspectKeyCreator;
+import com.google.devtools.build.lib.skyframe.*;
 import com.google.devtools.build.lib.skyframe.AspectKeyCreator.AspectKey;
 import com.google.devtools.build.lib.skyframe.AspectKeyCreator.TopLevelAspectsKey;
-import com.google.devtools.build.lib.skyframe.BuildConfigurationKey;
-import com.google.devtools.build.lib.skyframe.BuildResultListener;
-import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey;
-import com.google.devtools.build.lib.skyframe.CoverageReportValue;
 import com.google.devtools.build.lib.skyframe.RepositoryMappingValue.RepositoryMappingResolutionException;
-import com.google.devtools.build.lib.skyframe.SkyframeAnalysisAndExecutionResult;
-import com.google.devtools.build.lib.skyframe.SkyframeAnalysisResult;
-import com.google.devtools.build.lib.skyframe.SkyframeBuildView;
-import com.google.devtools.build.lib.skyframe.SkyframeExecutor;
-import com.google.devtools.build.lib.skyframe.TargetPatternPhaseValue;
 import com.google.devtools.build.lib.util.AbruptExitException;
 import com.google.devtools.build.lib.util.Pair;
 import com.google.devtools.build.lib.util.RegexFilter;
@@ -222,7 +213,7 @@ public AnalysisResult update(
       @Nullable ExecutionSetup executionSetupCallback,
       @Nullable BuildConfigurationsCreated buildConfigurationsCreatedCallback)
       throws ViewCreationFailedException, InvalidConfigurationException, InterruptedException,
-          BuildFailedException, TestExecException, AbruptExitException {
+          BuildFailedException, TestExecException, AbruptExitException, AnalysisCacheDiscardedException {
     logger.atInfo().log("Starting analysis");
     pollInterruptedStatus();
 
@@ -261,7 +252,7 @@ public AnalysisResult update(
     }
 
     skyframeBuildView.setConfigurations(
-        eventHandler, configurations, viewOptions.maxConfigChangesToShow);
+        eventHandler, configurations, viewOptions.maxConfigChangesToShow, viewOptions.failOnAnalysisCacheDiscard);
 
     eventBus.post(
         new MakeEnvironmentEvent(configurations.getTargetConfiguration().getMakeEnvironment()));
diff --git a/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisAndExecutionPhaseRunner.java b/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisAndExecutionPhaseRunner.java
index 2b31142b4586a5..5248a73267faaf 100644
--- a/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisAndExecutionPhaseRunner.java
+++ b/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisAndExecutionPhaseRunner.java
@@ -45,11 +45,8 @@
 import com.google.devtools.build.lib.runtime.CommandEnvironment;
 import com.google.devtools.build.lib.server.FailureDetails.BuildConfiguration.Code;
 import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
-import com.google.devtools.build.lib.skyframe.BuildInfoCollectionFunction;
-import com.google.devtools.build.lib.skyframe.BuildResultListener;
-import com.google.devtools.build.lib.skyframe.PrecomputedValue;
+import com.google.devtools.build.lib.skyframe.*;
 import com.google.devtools.build.lib.skyframe.RepositoryMappingValue.RepositoryMappingResolutionException;
-import com.google.devtools.build.lib.skyframe.TargetPatternPhaseValue;
 import com.google.devtools.build.lib.skyframe.TopLevelStatusEvents.TopLevelTargetAnalyzedEvent;
 import com.google.devtools.build.lib.util.AbruptExitException;
 import com.google.devtools.build.lib.util.DetailedExitCode;
@@ -81,7 +78,8 @@ static AnalysisAndExecutionResult execute(
       BuildConfigurationsCreated buildConfigurationCreatedCallback)
       throws BuildFailedException, InterruptedException, ViewCreationFailedException,
           TargetParsingException, LoadingFailedException, AbruptExitException,
-          InvalidConfigurationException, TestExecException, RepositoryMappingResolutionException {
+          InvalidConfigurationException, TestExecException, RepositoryMappingResolutionException,
+          AnalysisCacheDiscardedException {
 
     // Compute the heuristic instrumentation filter if needed.
     if (request.needsInstrumentationFilter()) {
@@ -203,7 +201,7 @@ private static AnalysisAndExecutionResult runAnalysisAndExecutionPhase(
       BuildConfigurationsCreated buildConfigurationCreatedCallback)
       throws InterruptedException, InvalidConfigurationException, ViewCreationFailedException,
           BuildFailedException, TestExecException, RepositoryMappingResolutionException,
-          AbruptExitException {
+          AbruptExitException, AnalysisCacheDiscardedException {
     env.getReporter().handle(Event.progress("Loading complete.  Analyzing..."));
 
     ImmutableSet<Label> explicitTargetPatterns =
diff --git a/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisPhaseRunner.java b/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisPhaseRunner.java
index ee5f93c166baa0..cfe3d77de5a0ad 100644
--- a/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisPhaseRunner.java
+++ b/src/main/java/com/google/devtools/build/lib/buildtool/AnalysisPhaseRunner.java
@@ -51,12 +51,9 @@
 import com.google.devtools.build.lib.runtime.CommandEnvironment;
 import com.google.devtools.build.lib.server.FailureDetails.BuildConfiguration.Code;
 import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
+import com.google.devtools.build.lib.skyframe.*;
 import com.google.devtools.build.lib.skyframe.AspectKeyCreator.AspectKey;
-import com.google.devtools.build.lib.skyframe.BuildConfigurationKey;
-import com.google.devtools.build.lib.skyframe.BuildInfoCollectionFunction;
-import com.google.devtools.build.lib.skyframe.PrecomputedValue;
 import com.google.devtools.build.lib.skyframe.RepositoryMappingValue.RepositoryMappingResolutionException;
-import com.google.devtools.build.lib.skyframe.TargetPatternPhaseValue;
 import com.google.devtools.build.lib.skyframe.TopLevelStatusEvents.AspectAnalyzedEvent;
 import com.google.devtools.build.lib.skyframe.TopLevelStatusEvents.TestAnalyzedEvent;
 import com.google.devtools.build.lib.skyframe.TopLevelStatusEvents.TopLevelTargetAnalyzedEvent;
@@ -87,7 +84,7 @@ public static AnalysisResult execute(
       TargetValidator validator)
       throws BuildFailedException, InterruptedException, ViewCreationFailedException,
           TargetParsingException, LoadingFailedException, AbruptExitException,
-          InvalidConfigurationException, RepositoryMappingResolutionException {
+          InvalidConfigurationException, RepositoryMappingResolutionException, AnalysisCacheDiscardedException {
 
     // Target pattern evaluation.
     TargetPatternPhaseValue loadingResult;
@@ -219,7 +216,7 @@ private static AnalysisResult runAnalysisPhase(
       TargetPatternPhaseValue loadingResult,
       BuildOptions targetOptions)
       throws InterruptedException, InvalidConfigurationException,
-          RepositoryMappingResolutionException, ViewCreationFailedException {
+          RepositoryMappingResolutionException, ViewCreationFailedException, AnalysisCacheDiscardedException {
     Stopwatch timer = Stopwatch.createStarted();
     env.getReporter().handle(Event.progress("Loading complete.  Analyzing..."));
 
diff --git a/src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java b/src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java
index c80a40c2134f5f..d6dff15db0ef80 100644
--- a/src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java
+++ b/src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java
@@ -54,6 +54,7 @@
 import com.google.devtools.build.lib.runtime.CommandEnvironment;
 import com.google.devtools.build.lib.server.FailureDetails.ActionQuery;
 import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
+import com.google.devtools.build.lib.skyframe.AnalysisCacheDiscardedException;
 import com.google.devtools.build.lib.skyframe.RepositoryMappingValue.RepositoryMappingResolutionException;
 import com.google.devtools.build.lib.skyframe.SequencedSkyframeExecutor;
 import com.google.devtools.build.lib.skyframe.TargetPatternPhaseValue;
@@ -149,7 +150,7 @@ public void buildTargets(BuildRequest request, BuildResult result, TargetValidat
       throws BuildFailedException, InterruptedException, ViewCreationFailedException,
           TargetParsingException, LoadingFailedException, AbruptExitException,
           InvalidConfigurationException, TestExecException, ExitException,
-          PostExecutionActionGraphDumpException, RepositoryMappingResolutionException {
+          PostExecutionActionGraphDumpException, RepositoryMappingResolutionException, AnalysisCacheDiscardedException {
     try (SilentCloseable c = Profiler.instance().profile("validateOptions")) {
       validateOptions(request);
     }
@@ -307,7 +308,7 @@ private void buildTargetsWithMergedAnalysisExecution(
       BuildOptions buildOptions)
       throws InterruptedException, TargetParsingException, LoadingFailedException,
           AbruptExitException, ViewCreationFailedException, BuildFailedException, TestExecException,
-          InvalidConfigurationException, RepositoryMappingResolutionException {
+          InvalidConfigurationException, RepositoryMappingResolutionException, AnalysisCacheDiscardedException {
 
     // Target pattern evaluation.
     TargetPatternPhaseValue loadingResult;
@@ -546,7 +547,7 @@ public BuildResult processRequest(
       } else {
         result.setCatastrophe();
       }
-    } catch (TargetParsingException | LoadingFailedException e) {
+    } catch (TargetParsingException | LoadingFailedException | AnalysisCacheDiscardedException e) {
       detailedExitCode = e.getDetailedExitCode();
       reportExceptionError(e);
     } catch (RepositoryMappingResolutionException e) {
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/AnalysisCacheDiscardedException.java b/src/main/java/com/google/devtools/build/lib/skyframe/AnalysisCacheDiscardedException.java
new file mode 100644
index 00000000000000..7dabc7f8ba32dc
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/skyframe/AnalysisCacheDiscardedException.java
@@ -0,0 +1,33 @@
+package com.google.devtools.build.lib.skyframe;
+
+import com.google.devtools.build.lib.server.FailureDetails;
+import com.google.devtools.build.lib.util.DetailedExitCode;
+
+/**
+ * An exception thrown when the analysis cache is discarded, and the `fail_on_analysis_cache_discard` option is
+ * set.
+ */
+public class AnalysisCacheDiscardedException extends Exception implements DetailedException {
+  static final String DISCARD_FLAG = "--fail_on_analysis_cache_discard";
+
+  public AnalysisCacheDiscardedException(String diff) {
+    super(String.format("%s, analysis cache would have been discarded and %s is set.", diff, DISCARD_FLAG));
+  }
+
+  @Override
+  public DetailedExitCode getDetailedExitCode() {
+    return DetailedExitCode.of(
+        FailureDetails.FailureDetail
+            .newBuilder()
+            .setMessage(this.getMessage())
+            .setAnalysis(
+                FailureDetails.Analysis
+                    .newBuilder()
+                    .setCode(
+                      FailureDetails.Analysis.Code.ANALYSIS_CACHE_DISCARDED
+                    ).build()
+            )
+            .build()
+    );
+  }
+}
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/BUILD b/src/main/java/com/google/devtools/build/lib/skyframe/BUILD
index 16206bdec9091f..068eef714e93b8 100644
--- a/src/main/java/com/google/devtools/build/lib/skyframe/BUILD
+++ b/src/main/java/com/google/devtools/build/lib/skyframe/BUILD
@@ -21,6 +21,7 @@ java_library(
         "ActionExecutionFunction.java",
         "ActionLookupConflictFindingFunction.java",
         "ActionOutputDirectoryHelper.java",
+        "AnalysisCacheDiscardedException.java",
         "AspectCompletor.java",
         "AspectFunction.java",
         "BazelSkyframeExecutorConstants.java",
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeBuildView.java b/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeBuildView.java
index 31a8ece4011673..13c3ffde3495dc 100644
--- a/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeBuildView.java
+++ b/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeBuildView.java
@@ -273,7 +273,8 @@ private ImmutableSet<OptionDefinition> getNativeCacheInvalidatingDifferences(
   public void setConfigurations(
       EventHandler eventHandler,
       BuildConfigurationCollection configurations,
-      int maxDifferencesToShow) {
+      int maxDifferencesToShow,
+      boolean failOnAnalysisCacheDiscard) throws AnalysisCacheDiscardedException {
     if (skyframeAnalysisWasDiscarded) {
       eventHandler.handle(
           Event.info(
@@ -283,6 +284,10 @@ public void setConfigurations(
     } else {
       String diff = describeConfigurationDifference(configurations, maxDifferencesToShow);
       if (diff != null) {
+        if (failOnAnalysisCacheDiscard) {
+          throw new AnalysisCacheDiscardedException(diff);
+        }
+
         eventHandler.handle(Event.info(diff + ", discarding analysis cache."));
         // Note that clearing the analysis cache is currently required for correctness. It is also
         // helpful to save memory.
diff --git a/src/main/java/com/google/devtools/build/lib/util/ExitCode.java b/src/main/java/com/google/devtools/build/lib/util/ExitCode.java
index f91fffa8ca1ab0..95736b3f520834 100644
--- a/src/main/java/com/google/devtools/build/lib/util/ExitCode.java
+++ b/src/main/java/com/google/devtools/build/lib/util/ExitCode.java
@@ -69,6 +69,9 @@ public final class ExitCode {
       ExitCode.create(45, "PERSISTENT_BUILD_EVENT_SERVICE_UPLOAD_ERROR");
   public static final ExitCode EXTERNAL_DEPS_ERROR = ExitCode.create(48, "EXTERNAL_DEPS_ERROR");
 
+  public static final ExitCode ANALYSIS_CACHE_DISCARD_FAILURE =
+          ExitCode.create(49, "ANALYSIS_CACHE_DISCARD_FAILURE");
+
   /**
    * Creates and returns an ExitCode.  Requires a unique exit code number.
    *
diff --git a/src/main/protobuf/failure_details.proto b/src/main/protobuf/failure_details.proto
index ea0873c3ea9a12..c2648e6c48c900 100644
--- a/src/main/protobuf/failure_details.proto
+++ b/src/main/protobuf/failure_details.proto
@@ -1188,6 +1188,7 @@ message Analysis {
     CONFIGURED_VALUE_CREATION_FAILED = 18 [(metadata) = { exit_code: 1 }];
     INCOMPATIBLE_TARGET_REQUESTED = 19 [(metadata) = { exit_code: 1 }];
     ANALYSIS_FAILURE_PROPAGATION_FAILED = 20 [(metadata) = { exit_code: 1 }];
+    ANALYSIS_CACHE_DISCARDED = 21 [(metadata) = { exit_code: 49 }];
   }
 
   Code code = 1;
diff --git a/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewForTesting.java b/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewForTesting.java
index 4287e5bf46efae..b067afea9127d0 100644
--- a/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewForTesting.java
+++ b/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewForTesting.java
@@ -98,6 +98,7 @@
 import com.google.devtools.build.lib.packages.RawAttributeMapper;
 import com.google.devtools.build.lib.packages.Rule;
 import com.google.devtools.build.lib.packages.Target;
+import com.google.devtools.build.lib.skyframe.AnalysisCacheDiscardedException;
 import com.google.devtools.build.lib.skyframe.AspectKeyCreator;
 import com.google.devtools.build.lib.skyframe.AspectKeyCreator.AspectKey;
 import com.google.devtools.build.lib.skyframe.ConfiguredTargetAndData;
@@ -201,7 +202,7 @@ public AnalysisResult update(
       ExtendedEventHandler eventHandler,
       EventBus eventBus)
       throws ViewCreationFailedException, InterruptedException, InvalidConfigurationException,
-          BuildFailedException, TestExecException, AbruptExitException {
+          BuildFailedException, TestExecException, AbruptExitException, AnalysisCacheDiscardedException {
     populateActionLookupKeyMapAndGetDiff();
     return buildView.update(
         loadingResult,
@@ -229,8 +230,12 @@ public AnalysisResult update(
   /** Sets the configurations. Not thread-safe. */
   public void setConfigurationsForTesting(
       EventHandler eventHandler, BuildConfigurationCollection configurations) {
-    skyframeBuildView.setConfigurations(
-        eventHandler, configurations, /* maxDifferencesToShow */ -1);
+    try {
+      skyframeBuildView.setConfigurations(
+          eventHandler, configurations, /* maxDifferencesToShow */ -1, /* failOnAnalysisCacheDiscard */ false);
+    } catch (AnalysisCacheDiscardedException e) {
+      // Will never throw, as failOnAnalysisCacheDiscard is explicitly set false in the call above.
+    }
   }
 
   public ArtifactFactory getArtifactFactory() {