root_maps: Add utility library for handling absent roots sync

1 files changed, 60 insertions, 0 deletions

diff --git a/src/other_tools/root_maps/root_utils.hpp b/src/other_tools/root_maps/root_utils.hpp
new file mode 100644
index 00000000..bf50e04d
--- /dev/null
+++ b/src/other_tools/root_maps/root_utils.hpp
@@ -0,0 +1,60 @@
+// Copyright 2024 Huawei Cloud Computing Technology Co., Ltd.
+//
+// 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.
+
+#ifndef INCLUDED_SRC_OTHER_TOOLS_ROOT_MAPS_ROOT_UTILS_HPP
+#define INCLUDED_SRC_OTHER_TOOLS_ROOT_MAPS_ROOT_UTILS_HPP
+
+#include <optional>
+#include <string>
+
+#include "gsl/gsl"
+#include "src/buildtool/execution_api/common/execution_api.hpp"
+#include "src/buildtool/multithreading/async_map_consumer.hpp"
+
+/// \brief Calls the ServeApi to check whether the serve endpoint has the given
+/// tree available to build against.
+/// \param tree_id The Git-tree identifier.
+/// \param logger An AsyncMapConsumer logger instance.
+/// \returns Nullopt if an error in the ServeApi call ocurred, or a flag stating
+/// whether the serve endpoint knows the tree on ServeApi call success. The
+/// logger is called with fatal ONLY if this method returns nullopt.
+[[nodiscard]] auto CheckServeHasAbsentRoot(
+    std::string const& tree_id,
+    AsyncMapConsumerLoggerPtr const& logger) -> std::optional<bool>;
+
+/// \brief Calls the ServeApi to instruct the serve endpoint to set up a root
+/// defined by a given tree by retrieving it from the remote CAS. This method
+/// ensures the respective tree is in the remote CAS prior to the ServeApi call
+/// by uploading it to the remote CAS if it is missing.
+/// \param tree_id The Git-tree identifier.
+/// \param repo_path Local witnessing Git repository for the tree.
+/// \param remote_api Optional API of the remote-execution endpoint. If nullopt,
+/// skip the upload to the remote CAS; this assumes prior knowledge which
+/// guarantees the tree given by tree_id exists in the remote CAS for the
+/// duration of the subsequent serve API call; this option should be used
+/// carefully, but does result in less remote communication.
+/// \param logger An AsyncMapConsumer logger instance.
+/// \param no_sync_is_fatal If true, report only as a warning the failure of the
+/// serve endpoint to set up the root for this tree; otherwise, this is reported
+/// as fatal.
+/// \returns Status flag, with false if state is deemed fatal, and true
+/// otherwise. Logger is only called with fatal if returning false.
+[[nodiscard]] auto EnsureAbsentRootOnServe(
+    std::string const& tree_id,
+    std::filesystem::path const& repo_path,
+    std::optional<gsl::not_null<IExecutionApi*>> const& remote_api,
+    AsyncMapConsumerLoggerPtr const& logger,
+    bool no_sync_is_fatal) -> bool;
+
+#endif  // INCLUDED_SRC_OTHER_TOOLS_ROOT_MAPS_ROOT_UTILS_HPP