Add timeout to model pulling (#3277)

Due to limitations in libgit2 we are not able to use it simultaneously
with https proxy:
libgit2/libgit2#7072

* Fix env leaking tests

Ticket:CVS-166568



* Timeout for Windows does not work either

Author: atobiszei

WORKSPACE

@@ -487,8 +487,8 @@ load("@//third_party/llm_engine:llm_engine.bzl", "llm_engine")
 llm_engine()
 
 ### Libgit2
-load("@//third_party/libgt2:libgt2_engine.bzl", "libgt2_engine")
-libgt2_engine()
+load("@//third_party/libgit2:libgit2_engine.bzl", "libgit2_engine")
+libgit2_engine()
 
 load("@//third_party/drogon:drogon.bzl", "drogon_cpp")
 drogon_cpp()

src/BUILD

@@ -700,7 +700,7 @@ cc_library(
             "//:ovms_dependencies", # TODO dispose or replace
             "//src/kfserving_api:kfserving_api_cpp",
             "capimodule",
-            "//src/libgt2:hf_pull_model_module",
+            "//src/pull_module:hf_pull_model_module",
             "predict_request_validation_utils", # to be removed when capi has its own lib and added there @atobisze
             "kfs_backend_impl",
             "tfs_backend_impl",
@@ -3076,9 +3076,10 @@ cc_library(
     linkopts = [],
     deps = [
         ":test_utils",
-        "//src/libgt2:libgt2",
-        "//src/libgt2:hf_pull_model_module",
+        "//src/pull_module:libgit2",
+        "//src/pull_module:hf_pull_model_module",
         "//src:ovms_lib",
+        "libovmsstring_utils",
         "@com_google_googletest//:gtest",
     ],
     local_defines = COMMON_LOCAL_DEFINES,

src/libgt2/hf_pull_model_module.cpp

@@ -28,19 +28,18 @@ LINKOPTS_ADJUSTED = COMMON_STATIC_LIBS_LINKOPTS + select({
 })
 
 cc_library(
-    name = "libgt2",
-    srcs = ["libgt2.cpp"],
-    hdrs = ["libgt2.hpp"],
+    name = "libgit2",
+    srcs = ["libgit2.cpp"],
+    hdrs = ["libgit2.hpp"],
     deps =  [
-        "@libgt2_engine//:libgt2_engine",
+        "@libgit2_engine//:libgit2_engine",
         "@ovms//src:libovmslogging",
         "@ovms//src:libovmsstatus",
         "@ovms//src:libovmsstring_utils",
     ],
     visibility = ["//visibility:public"],
     copts = COPTS_ADJUSTED,
     linkopts = LINKOPTS_ADJUSTED,
-    alwayslink = 1,
     local_defines = COMMON_LOCAL_DEFINES,
 )
 
@@ -49,7 +48,7 @@ cc_library(
     srcs = ["hf_pull_model_module.cpp"],
     hdrs = ["hf_pull_model_module.hpp"],
     deps =  [
-        ":libgt2",
+        ":libgit2",
         "@ovms//src/graph_export:graph_export",
         "@ovms//src:cpp_headers",
         "@ovms//src:libovmsstring_utils",
@@ -60,6 +59,5 @@ cc_library(
     visibility = ["//visibility:public"],
     copts = COPTS_ADJUSTED,
     linkopts = LINKOPTS_ADJUSTED,
-    alwayslink = 1,
     local_defines = COMMON_LOCAL_DEFINES,
-)
+)

src/libgt2/BUILD renamed to src/pull_module/BUILD

@@ -0,0 +1,152 @@
+//***************************************************************************
+// Copyright 2025 Intel Corporation
+//
+// 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.
+//*****************************************************************************
+#include "hf_pull_model_module.hpp"
+
+#include <string>
+#include <utility>
+#include <variant>
+
+#include "../config.hpp"
+#include "libgit2.hpp"
+#include "../graph_export/graph_export.hpp"
+#include "../logging.hpp"
+#include "../module_names.hpp"
+#include "../status.hpp"
+#include "../stringutils.hpp"
+
+namespace ovms {
+const std::string DEFAULT_EMPTY_ENV_VALUE{""};
+
+const std::string HfPullModelModule::GIT_SERVER_CONNECT_TIMEOUT_ENV{"GIT_SERVER_CONNECT_TIMEOUT_MS"};
+const std::string HfPullModelModule::GIT_SERVER_TIMEOUT_ENV{"GIT_SERVER_TIMEOUT_MS"};
+// GIT_OPT_SET_SERVER_TIMEOUT
+
+static std::string getEnvReturnOrDefaultIfNotSet(const std::string& envName, const std::string& defaultValue = DEFAULT_EMPTY_ENV_VALUE) {
+    std::string value = defaultValue;
+    const char* envValue = std::getenv(envName.c_str());
+    if (envValue) {
+        value = std::string(envValue);
+        SPDLOG_DEBUG("{} environment variable set. Using value: {};", envName, value);
+    } else {
+        SPDLOG_DEBUG("{} environment variable not set. Using default value: {};", envName, defaultValue);
+    }
+    return value;
+}
+
+HfPullModelModule::HfPullModelModule() {}
+
+#define RETURN_IF_ERROR(StatusOr)                       \
+    do {                                                \
+        if (std::holds_alternative<Status>(StatusOr)) { \
+            return std::get<Status>(StatusOr);          \
+        }                                               \
+    } while (0)
+
+static std::variant<ovms::Status, Libgit2Options> prepareLibgit2Opts() {
+    Libgit2Options opts;
+    std::string timeoutString = getEnvReturnOrDefaultIfNotSet(HfPullModelModule::GIT_SERVER_CONNECT_TIMEOUT_ENV, "1000");
+    auto timeoutOpt = ovms::stoi32(timeoutString);
+    if (!timeoutOpt.has_value()) {
+        SPDLOG_ERROR("Set invalid value for libgit2 server connection timeout:{}", timeoutString);
+        return StatusCode::HF_FAILED_TO_INIT_LIBGIT2;
+    }
+    bool isHttpsProxyUsed = !getEnvReturnOrDefaultIfNotSet("https_proxy").empty();
+    if (isHttpsProxyUsed) {
+        if (timeoutOpt.value() != 0)
+            SPDLOG_WARN("We are not able to set connection timeout when proxy is used");
+    } else {
+        opts.serverConnectTimeoutMs = timeoutOpt.value();
+    }
+    timeoutString = getEnvReturnOrDefaultIfNotSet(HfPullModelModule::GIT_SERVER_TIMEOUT_ENV, "0");
+    timeoutOpt = ovms::stoi32(timeoutString);
+    if (!timeoutOpt.has_value()) {
+        SPDLOG_ERROR("Set invalid value for libgit2 server timeout:{}", timeoutString);
+        return StatusCode::HF_FAILED_TO_INIT_LIBGIT2;
+    }
+    opts.serverTimeoutMs = timeoutOpt.value();
+    return opts;
+}
+
+std::variant<ovms::Status, std::unique_ptr<Libgt2InitGuard>> createGuard() {
+    auto optsOrError = prepareLibgit2Opts();
+    RETURN_IF_ERROR(optsOrError);
+    auto initGuard = std::make_unique<Libgt2InitGuard>(std::get<Libgit2Options>(optsOrError));
+    if (initGuard->status < 0) {
+        SPDLOG_ERROR("Failed to init libgit2: {}", initGuard->errMsg.c_str());
+        return StatusCode::HF_FAILED_TO_INIT_LIBGIT2;
+    }
+    return std::move(initGuard);
+}
+
+Status HfPullModelModule::start(const ovms::Config& config) {
+    state = ModuleState::STARTED_INITIALIZE;
+    SPDLOG_INFO("{} starting", HF_MODEL_PULL_MODULE_NAME);
+    auto guardOrError = createGuard();
+    RETURN_IF_ERROR(guardOrError);
+    this->hfSettings = config.getServerSettings().hfSettings;
+    state = ModuleState::INITIALIZED;
+    SPDLOG_INFO("{} started", HF_MODEL_PULL_MODULE_NAME);
+    return StatusCode::OK;
+}
+
+Status HfPullModelModule::clone() const {
+    auto guardOrError = createGuard();
+    if (std::holds_alternative<Status>(guardOrError)) {
+        return std::get<Status>(guardOrError);
+    }
+    HfDownloader hfDownloader(this->hfSettings.sourceModel, this->hfSettings.downloadPath, this->GetHfEndpoint(), this->GetHfToken(), this->GetProxy());
+    auto status = hfDownloader.cloneRepository();
+    if (!status.ok()) {
+        return status;
+    }
+    GraphExport graphExporter;
+    status = graphExporter.createGraphFile(this->hfSettings.downloadPath, this->hfSettings.graphSettings);
+    if (!status.ok()) {
+        return status;
+    }
+    return StatusCode::OK;
+}
+
+const std::string HfPullModelModule::GetProxy() const {
+    return getEnvReturnOrDefaultIfNotSet("https_proxy");
+}
+
+const std::string HfPullModelModule::GetHfToken() const {
+    return getEnvReturnOrDefaultIfNotSet("HF_TOKEN");
+}
+
+const std::string HfPullModelModule::GetHfEndpoint() const {
+    std::string hfEndpoint = getEnvReturnOrDefaultIfNotSet("HF_ENDPOINT", "huggingface.co");
+    if (!endsWith(hfEndpoint, "/")) {
+        hfEndpoint.append("/");
+    }
+    return hfEndpoint;
+}
+
+void HfPullModelModule::shutdown() {
+    if (state == ModuleState::SHUTDOWN)
+        return;
+    state = ModuleState::STARTED_SHUTDOWN;
+    SPDLOG_INFO("{} shutting down", HF_MODEL_PULL_MODULE_NAME);
+    state = ModuleState::SHUTDOWN;
+    SPDLOG_INFO("{} shutdown", HF_MODEL_PULL_MODULE_NAME);
+}
+
+HfPullModelModule::~HfPullModelModule() {
+    this->shutdown();
+}
+
+}  // namespace ovms

src/pull_module/hf_pull_model_module.cpp

@@ -36,5 +36,7 @@ class HfPullModelModule : public Module {
     void shutdown() override;
 
     Status clone() const;
+    static const std::string GIT_SERVER_CONNECT_TIMEOUT_ENV;
+    static const std::string GIT_SERVER_TIMEOUT_ENV;
 };
 }  // namespace ovms