Decouple RemoteAnalysisMetadataWriter from

RemoteAnalysisCacheClient. These are not always the same backend.

PiperOrigin-RevId: 824469729
Change-Id: I722dae089ff0be71ef9aec86c4fb50a119e2cacd

Author: aoeui

src/main/java/com/google/devtools/build/lib/BUILD

@@ -523,6 +523,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis:remote_analysis_caching_server_state",
         "//src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis:remote_analysis_caching_services_supplier",
         "//src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis:remote_analysis_json_log_writer",
+        "//src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis:remote_analysis_metadata_writer",
         "//src/main/java/com/google/devtools/build/lib/unsafe:string",
         "//src/main/java/com/google/devtools/build/lib/util",
         "//src/main/java/com/google/devtools/build/lib/util:TestType",

src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java

@@ -140,6 +140,7 @@
 import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCachingServerState;
 import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCachingServicesSupplier;
 import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisJsonLogWriter;
+import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisMetadataWriter;
 import com.google.devtools.build.lib.util.AbruptExitException;
 import com.google.devtools.build.lib.util.CrashFailureDetails;
 import com.google.devtools.build.lib.util.DetailedExitCode;
@@ -1087,18 +1088,20 @@ private void tryWriteSkycacheMetadata(
       // This is a blocking call. We cannot finish the build until the metadata has been written
       // and at this point there is nothing else to do in the build that could be done in
       // parallel.
-      success =
-          dependenciesProvider
-              .getAnalysisCacheClient()
-              .addTopLevelTargets(
-                  env.getCommandId().toString(),
-                  skycacheMetadataParams.getEvaluatingVersion(),
-                  skycacheMetadataParams.getConfigurationHash(),
-                  skycacheMetadataParams.getBazelVersion(),
-                  skycacheMetadataParams.getTargets(),
-                  skycacheMetadataParams.getConfigFlags())
-              .get(SkycacheMetadataParams.TIMEOUT.toSeconds(), SECONDS);
-    } catch (TimeoutException | ExecutionException e) {
+      RemoteAnalysisMetadataWriter metadataWriter = dependenciesProvider.getMetadataWriter();
+      if (metadataWriter == null) {
+        message = "MetadataAnalysisCacheWriterService is unavailable";
+      } else {
+        success =
+            metadataWriter.addTopLevelTargets(
+                env.getCommandId().toString(),
+                skycacheMetadataParams.getEvaluatingVersion(),
+                skycacheMetadataParams.getConfigurationHash(),
+                skycacheMetadataParams.getBazelVersion(),
+                skycacheMetadataParams.getTargets(),
+                skycacheMetadataParams.getConfigFlags());
+      }
+    } catch (IOException e) {
       // To avoid build failures for a UX-enhancing feature, errors writing build metadata do not
       // cause the build to fail. Instead, we log the error and rely on external monitoring to
       // detect issues with metadata writes.
@@ -1108,8 +1111,10 @@ private void tryWriteSkycacheMetadata(
       env.getReporter().handle(Event.info("Skycache: Successfully wrote metadata to backend"));
     } else {
       env.getReporter()
-          .handle(Event.warn("Skycache: Failed to write metadata to backend:" + message));
-      logger.atSevere().log("Error writing metadata at end of build: %s", message);
+          .handle(
+              Event.warn(
+                  "Skycache: Failed to write metadata to backend"
+                      + (message != null ? ": " + message : "")));
     }
   }
 
@@ -1278,7 +1283,8 @@ private static class RemoteAnalysisCachingDependenciesProviderImpl
 
     private final Future<ObjectCodecs> objectCodecsFuture;
     private final Future<FingerprintValueService> fingerprintValueServiceFuture;
-    @Nullable private final Future<RemoteAnalysisCacheClient> analysisCacheClient;
+    @Nullable private final Future<? extends RemoteAnalysisCacheClient> analysisCacheClient;
+    @Nullable private final Future<? extends RemoteAnalysisMetadataWriter> metadataWriter;
     @Nullable private volatile AnalysisCacheInvalidator analysisCacheInvalidator;
 
     // Non-final because the top level BuildConfigurationValue is determined just before analysis
@@ -1516,6 +1522,7 @@ private RemoteAnalysisCachingDependenciesProviderImpl(
       servicesSupplier.configure(options, clientId, env.getBuildRequestId(), jsonLogWriter);
       this.fingerprintValueServiceFuture = servicesSupplier.getFingerprintValueService();
       this.analysisCacheClient = servicesSupplier.getAnalysisCacheClient();
+      this.metadataWriter = servicesSupplier.getMetadataWriter();
       this.eventHandler = env.getReporter();
       this.skycacheMetadataParams =
           env.getBlazeWorkspace()
@@ -1654,6 +1661,20 @@ public RemoteAnalysisCacheClient getAnalysisCacheClient() {
       }
     }
 
+    @Override
+    @Nullable
+    public RemoteAnalysisMetadataWriter getMetadataWriter() {
+      if (metadataWriter == null) {
+        return null;
+      }
+      try {
+        return metadataWriter.get(CLIENT_LOOKUP_TIMEOUT_SEC, SECONDS);
+      } catch (InterruptedException | ExecutionException | TimeoutException e) {
+        logger.atWarning().withCause(e).log("Unable to initialize metadata writer");
+        return null;
+      }
+    }
+
     @Nullable
     @Override
     public RemoteAnalysisJsonLogWriter getJsonLogWriter() {

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/BUILD

@@ -34,6 +34,7 @@ java_library(
         ":remote_analysis_cache_client",
         ":remote_analysis_caching_server_state",
         ":remote_analysis_json_log_writer",
+        ":remote_analysis_metadata_writer",
         "//src/main/java/com/google/devtools/build/lib/analysis/config:build_options",
         "//src/main/java/com/google/devtools/build/lib/cmdline",
         "//src/main/java/com/google/devtools/build/lib/skyframe/serialization",
@@ -274,6 +275,7 @@ java_library(
         ":options",
         ":remote_analysis_cache_client",
         ":remote_analysis_json_log_writer",
+        ":remote_analysis_metadata_writer",
         "//src/main/java/com/google/devtools/build/lib/skyframe/serialization",
         "//src/main/java/com/google/devtools/build/lib/util:abrupt_exit_exception",
         "//third_party:guava",
@@ -320,6 +322,11 @@ java_library(
     ],
 )
 
+java_library(
+    name = "remote_analysis_metadata_writer",
+    srcs = ["RemoteAnalysisMetadataWriter.java"],
+)
+
 java_library(
     name = "missing_skyframe_entry_exception",
     srcs = ["MissingSkyframeEntryException.java"],

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/RemoteAnalysisCacheClient.java

@@ -17,7 +17,6 @@
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.devtools.build.lib.events.EventHandler;
 import com.google.protobuf.ByteString;
-import java.util.Collection;
 
 /** Interface to the remote analysis cache. */
 public interface RemoteAnalysisCacheClient {
@@ -34,15 +33,6 @@ record Stats(long bytesSent, long bytesReceived, long requestsSent, long batches
   /** Returns the usage statistics. */
   Stats getStats();
 
-  /** Adds the cached targets into the metadata table */
-  ListenableFuture<Boolean> addTopLevelTargets(
-      String invocationId,
-      long evaluatingVersion,
-      String configurationHash,
-      String bazelVersion,
-      Collection<String> targets,
-      Collection<String> configFlags);
-
   /** Looks up the targets in the metadata table */
   void lookupTopLevelTargets(
       long evaluatingVersion,

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/RemoteAnalysisCachingDependenciesProvider.java

@@ -74,6 +74,8 @@ default boolean isRetrievalEnabled() {
 
   RemoteAnalysisCacheClient getAnalysisCacheClient();
 
+  RemoteAnalysisMetadataWriter getMetadataWriter();
+
   /** Returns the JSON log writer or null if this log is not enabled. */
   @Nullable
   RemoteAnalysisJsonLogWriter getJsonLogWriter();
@@ -158,6 +160,11 @@ public RemoteAnalysisCacheClient getAnalysisCacheClient() {
       throw new UnsupportedOperationException();
     }
 
+    @Override
+    public RemoteAnalysisMetadataWriter getMetadataWriter() {
+      throw new UnsupportedOperationException();
+    }
+
     @Override
     @Nullable
     public RemoteAnalysisJsonLogWriter getJsonLogWriter() {

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/RemoteAnalysisCachingOptions.java

@@ -223,11 +223,7 @@ public RemoteAnalysisCacheModeConverter() {
       defaultValue = "true",
       documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
       effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
-      help =
-          "A flag to switch on/off inserting and querying the metadata db (b/425247333). The idea"
-              + " is for this flag to only exist temporarily for a careful rollout of the feature"
-              + " then be deleted later. For writers it requires passing an analysis cache service"
-              + " address.")
+      help = "A flag to switch on/off inserting and querying the metadata db (b/425247333).")
   public boolean analysisCacheEnableMetadataQueries;
 
   @Option(

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/RemoteAnalysisCachingServicesSupplier.java

@@ -61,7 +61,12 @@ default void configure(
    * <p>This may entail I/O so it is wrapped in a future.
    */
   @Nullable // null if frontier-style invalidation is used instead of the cache service
-  default ListenableFuture<RemoteAnalysisCacheClient> getAnalysisCacheClient() {
+  default ListenableFuture<? extends RemoteAnalysisCacheClient> getAnalysisCacheClient() {
+    return null;
+  }
+
+  @Nullable
+  default ListenableFuture<? extends RemoteAnalysisMetadataWriter> getMetadataWriter() {
     return null;
   }
 

src/main/java/com/google/devtools/build/lib/skyframe/serialization/analysis/RemoteAnalysisMetadataWriter.java

@@ -0,0 +1,30 @@
+// Copyright 2025 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.skyframe.serialization.analysis;
+
+import java.io.IOException;
+import java.util.Collection;
+
+/** Handle to a service that consumes metadata about uploaded analysis values. */
+public interface RemoteAnalysisMetadataWriter {
+  /** Adds the cached targets into the metadata table */
+  boolean addTopLevelTargets(
+      String invocationId,
+      long evaluatingVersion,
+      String configurationHash,
+      String blazeVersion,
+      Collection<String> targets,
+      Collection<String> configFlags)
+      throws IOException;
+}