Correct and narrow the exception types used in bzlmod skyfunctions.

This is a first step towards bazelbuild#18629.
katre · Jun 9, 2023 · c82c0f2 · c82c0f2
1 parent 7a85e5f
commit c82c0f2
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 31 deletions.
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelDepGraphFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelDepGraphFunction.java
@@ -63,7 +63,7 @@ public BazelDepGraphFunction(Path rootDirectory) {
   @Override
   @Nullable
   public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws BazelDepGraphFunctionException, InterruptedException {
     RootModuleFileValue root =
         (RootModuleFileValue) env.getValue(ModuleFileValue.KEY_FOR_ROOT_MODULE);
     if (root == null) {
@@ -115,8 +115,12 @@ public SkyValue compute(SkyKey skyKey, Environment env)
       }
       depGraph = selectionResult.getResolvedDepGraph();
       if (lockfileMode.equals(LockfileMode.UPDATE)) {
-        BazelLockFileFunction.updateLockedModule(
-            rootDirectory, root.getModuleFileHash(), flags, localOverrideHashes, depGraph);
+        try {
+          BazelLockFileFunction.updateLockedModule(
+              rootDirectory, root.getModuleFileHash(), flags, localOverrideHashes, depGraph);
+        } catch (ExternalDepsException e) {
+          throw new BazelDepGraphFunctionException(e, Transience.PERSISTENT);
+        }
       }
     }
 

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelLockFileFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelLockFileFunction.java
@@ -65,7 +65,7 @@ public BazelLockFileFunction(Path rootDirectory) {
   @Override
   @Nullable
   public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws BazelLockfileFunctionException, InterruptedException {
     RootedPath lockfilePath =
         RootedPath.toRootedPath(Root.fromPath(rootDirectory), LabelConstants.MODULE_LOCKFILE_NAME);
 
@@ -104,7 +104,7 @@ public static void updateLockedModule(
       BzlmodFlagsAndEnvVars flags,
       ImmutableMap<String, String> localOverrideHashes,
       ImmutableMap<ModuleKey, Module> resolvedDepGraph)
-      throws BazelLockfileFunctionException {
+      throws ExternalDepsException {
     RootedPath lockfilePath =
         RootedPath.toRootedPath(Root.fromPath(rootDirectory), LabelConstants.MODULE_LOCKFILE_NAME);
 
@@ -118,16 +118,14 @@ public static void updateLockedModule(
     try {
       FileSystemUtils.writeContent(lockfilePath.asPath(), UTF_8, LOCKFILE_GSON.toJson(value));
     } catch (IOException e) {
-      throw new BazelLockfileFunctionException(
-          ExternalDepsException.withCauseAndMessage(
-              Code.BAD_MODULE, e, "Unable to update the MODULE.bazel.lock file"),
-          Transience.PERSISTENT);
+      throw ExternalDepsException.withCauseAndMessage(
+          Code.BAD_MODULE, e, "Unable to update the MODULE.bazel.lock file");
     }
   }
 
   static final class BazelLockfileFunctionException extends SkyFunctionException {
 
-    BazelLockfileFunctionException(Exception cause, Transience transience) {
+    BazelLockfileFunctionException(ExternalDepsException cause, Transience transience) {
       super(cause, transience);
     }
   }

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleInspectorFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleInspectorFunction.java
@@ -25,7 +25,6 @@
 import com.google.devtools.build.lib.bazel.bzlmod.BazelModuleInspectorValue.AugmentedModule.ResolutionReason;
 import com.google.devtools.build.lib.bazel.bzlmod.ModuleFileValue.RootModuleFileValue;
 import com.google.devtools.build.skyframe.SkyFunction;
-import com.google.devtools.build.skyframe.SkyFunctionException;
 import com.google.devtools.build.skyframe.SkyKey;
 import com.google.devtools.build.skyframe.SkyValue;
 import java.util.HashMap;
@@ -42,8 +41,7 @@ public class BazelModuleInspectorFunction implements SkyFunction {
 
   @Override
   @Nullable
-  public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+  public SkyValue compute(SkyKey skyKey, Environment env) throws InterruptedException {
     RootModuleFileValue root =
         (RootModuleFileValue) env.getValue(ModuleFileValue.KEY_FOR_ROOT_MODULE);
     if (root == null) {

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleResolutionFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleResolutionFunction.java
@@ -67,7 +67,7 @@ public class BazelModuleResolutionFunction implements SkyFunction {
   @Override
   @Nullable
   public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws BazelModuleResolutionFunctionException, InterruptedException {
 
     ClientEnvironmentValue allowedYankedVersionsFromEnv =
         (ClientEnvironmentValue)

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ExternalDepsException.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ExternalDepsException.java
@@ -28,7 +28,7 @@ public class ExternalDepsException extends Exception implements DetailedExceptio
 
   private final DetailedExitCode detailedExitCode;
 
-  public ExternalDepsException(String message, @Nullable Throwable cause, ExternalDeps.Code code) {
+  private ExternalDepsException(String message, @Nullable Throwable cause, ExternalDeps.Code code) {
     super(message, cause);
     detailedExitCode =
         DetailedExitCode.of(

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ModuleFileFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/ModuleFileFunction.java
@@ -92,7 +92,7 @@ public ModuleFileFunction(
   @Nullable
   @Override
   public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws ModuleFileFunctionException, InterruptedException {
     StarlarkSemantics starlarkSemantics = PrecomputedValue.STARLARK_SEMANTICS.get(env);
     if (starlarkSemantics == null) {
       return null;
@@ -144,7 +144,7 @@ public SkyValue compute(SkyKey skyKey, Environment env)
 
   @Nullable
   private SkyValue computeForRootModule(StarlarkSemantics starlarkSemantics, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws ModuleFileFunctionException, InterruptedException {
     RootedPath moduleFilePath =
         RootedPath.toRootedPath(
             Root.fromPath(workspaceRoot), LabelConstants.MODULE_DOT_BAZEL_FILE_NAME);
@@ -331,7 +331,7 @@ private static ModuleFileFunctionException errorf(
 
   static final class ModuleFileFunctionException extends SkyFunctionException {
 
-    ModuleFileFunctionException(Exception cause) {
+    ModuleFileFunctionException(ExternalDepsException cause) {
       super(cause, Transience.TRANSIENT);
     }
   }

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/SingleExtensionEvalFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/SingleExtensionEvalFunction.java
@@ -94,7 +94,7 @@ public void setRepositoryRemoteExecutor(RepositoryRemoteExecutor repositoryRemot
   @Nullable
   @Override
   public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+      throws SingleExtensionEvalFunctionException, InterruptedException {
     StarlarkSemantics starlarkSemantics = PrecomputedValue.STARLARK_SEMANTICS.get(env);
     if (starlarkSemantics == null) {
       return null;
@@ -297,7 +297,11 @@ private ModuleExtensionContext createContext(
 
   static final class SingleExtensionEvalFunctionException extends SkyFunctionException {
 
-    SingleExtensionEvalFunctionException(Exception cause, Transience transience) {
+    SingleExtensionEvalFunctionException(ExternalDepsException cause, Transience transience) {
+      super(cause, transience);
+    }
+
+    SingleExtensionEvalFunctionException(IOException cause, Transience transience) {
       super(cause, transience);
     }
   }

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/SingleExtensionUsagesFunction.java b/src/main/java/com/google/devtools/build/lib/bazel/bzlmod/SingleExtensionUsagesFunction.java
@@ -20,7 +20,6 @@
 
 import com.google.common.collect.ImmutableTable;
 import com.google.devtools.build.skyframe.SkyFunction;
-import com.google.devtools.build.skyframe.SkyFunctionException;
 import com.google.devtools.build.skyframe.SkyKey;
 import com.google.devtools.build.skyframe.SkyValue;
 import javax.annotation.Nullable;
@@ -42,8 +41,7 @@ public class SingleExtensionUsagesFunction implements SkyFunction {
 
   @Override
   @Nullable
-  public SkyValue compute(SkyKey skyKey, Environment env)
-      throws SkyFunctionException, InterruptedException {
+  public SkyValue compute(SkyKey skyKey, Environment env) throws InterruptedException {
     BazelDepGraphValue bazelDepGraphValue =
         (BazelDepGraphValue) env.getValue(BazelDepGraphValue.KEY);
     if (bazelDepGraphValue == null) {

diff --git a/src/test/java/com/google/devtools/build/lib/bazel/bzlmod/BazelLockFileFunctionTest.java b/src/test/java/com/google/devtools/build/lib/bazel/bzlmod/BazelLockFileFunctionTest.java
@@ -27,6 +27,7 @@
 import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
 import com.google.devtools.build.lib.analysis.ServerDirectories;
 import com.google.devtools.build.lib.analysis.util.AnalysisMock;
+import com.google.devtools.build.lib.bazel.bzlmod.BazelLockFileFunction.BazelLockfileFunctionException;
 import com.google.devtools.build.lib.bazel.bzlmod.ModuleFileValue.RootModuleFileValue;
 import com.google.devtools.build.lib.bazel.repository.RepositoryOptions.BazelCompatibilityMode;
 import com.google.devtools.build.lib.bazel.repository.RepositoryOptions.CheckDirectDepsMode;
@@ -63,7 +64,7 @@
 import com.google.devtools.build.skyframe.RecordingDifferencer;
 import com.google.devtools.build.skyframe.SequencedRecordingDifferencer;
 import com.google.devtools.build.skyframe.SkyFunction;
-import com.google.devtools.build.skyframe.SkyFunctionException;
+import com.google.devtools.build.skyframe.SkyFunctionException.Transience;
 import com.google.devtools.build.skyframe.SkyFunctionName;
 import com.google.devtools.build.skyframe.SkyKey;
 import com.google.devtools.build.skyframe.SkyValue;
@@ -164,7 +165,7 @@ public void setup() throws Exception {
                       @Nullable
                       @Override
                       public SkyValue compute(SkyKey skyKey, Environment env)
-                          throws SkyFunctionException, InterruptedException {
+                          throws BazelLockfileFunctionException, InterruptedException {
 
                         UpdateLockFileKey key = (UpdateLockFileKey) skyKey;
                         BzlmodFlagsAndEnvVars flags = BazelDepGraphFunction.getFlagsAndEnvVars(env);
@@ -177,12 +178,16 @@ public SkyValue compute(SkyKey skyKey, Environment env)
                         if (localOverrideHashes == null) {
                           return null;
                         }
-                        BazelLockFileFunction.updateLockedModule(
-                            rootDirectory,
-                            key.moduleHash(),
-                            flags,
-                            localOverrideHashes,
-                            key.depGraph());
+                        try {
+                          BazelLockFileFunction.updateLockedModule(
+                              rootDirectory,
+                              key.moduleHash(),
+                              flags,
+                              localOverrideHashes,
+                              key.depGraph());
+                        } catch (ExternalDepsException e) {
+                          throw new BazelLockfileFunctionException(e, Transience.PERSISTENT);
+                        }
                         return new SkyValue() {};
                       }
                     })