Merge branch 'main' into helm-remove-dangling-config

Author: junhaoliao

components/core/cmake/Options/options.cmake

@@ -95,6 +95,12 @@ option(
     ON
 )
 
+option(
+    CLP_BUILD_CLP_S_ENABLE_CURL
+    "Include libcurl support for clp-s."
+    ON
+)
+
 # Validates that the `CLP_BUILD_` options required by `TARGET_CLP_BUILD_OPTION` are `ON`.
 #
 # @param {string} TARGET_CLP_BUILD_OPTION
@@ -140,7 +146,6 @@ function(set_clp_binaries_dependencies)
     set_clp_need_flags(
         CLP_NEED_ABSL
         CLP_NEED_BOOST
-        CLP_NEED_CURL
         CLP_NEED_DATE
         CLP_NEED_FMT
         CLP_NEED_LIBARCHIVE
@@ -149,7 +154,6 @@ function(set_clp_binaries_dependencies)
         CLP_NEED_MONGOCXX
         CLP_NEED_MSGPACKCXX
         CLP_NEED_NLOHMANN_JSON
-        CLP_NEED_OPENSSL
         CLP_NEED_SIMDJSON
         CLP_NEED_SPDLOG
         CLP_NEED_SQLITE
@@ -163,6 +167,7 @@ function(validate_clp_tests_dependencies)
     validate_clp_dependencies_for_target(CLP_BUILD_TESTING
         CLP_BUILD_CLP_REGEX_UTILS
         CLP_BUILD_CLP_STRING_UTILS
+        CLP_BUILD_CLP_S_ENABLE_CURL
         CLP_BUILD_CLP_S_SEARCH_AST
         CLP_BUILD_CLP_S_SEARCH_KQL
         CLP_BUILD_CLP_S_SEARCH_SQL
@@ -184,7 +189,6 @@ function(set_clp_tests_dependencies)
         CLP_NEED_MARIADB
         CLP_NEED_MONGOCXX
         CLP_NEED_NLOHMANN_JSON
-        CLP_NEED_OPENSSL
         CLP_NEED_SIMDJSON
         CLP_NEED_SPDLOG
         CLP_NEED_SQLITE
@@ -217,7 +221,6 @@ function(set_clp_s_archivereader_dependencies)
     set_clp_need_flags(
         CLP_NEED_ABSL
         CLP_NEED_BOOST
-        CLP_NEED_CURL
         CLP_NEED_FMT
         CLP_NEED_MSGPACKCXX
         CLP_NEED_NLOHMANN_JSON
@@ -239,7 +242,6 @@ function(set_clp_s_archivewriter_dependencies)
     set_clp_need_flags(
         CLP_NEED_ABSL
         CLP_NEED_BOOST
-        CLP_NEED_CURL
         CLP_NEED_FMT
         CLP_NEED_MSGPACKCXX
         CLP_NEED_NLOHMANN_JSON
@@ -258,12 +260,10 @@ endfunction()
 function(set_clp_s_clp_dependencies_dependencies)
     set_clp_need_flags(
         CLP_NEED_BOOST
-        CLP_NEED_CURL
         CLP_NEED_FMT
         CLP_NEED_LOG_SURGEON
         CLP_NEED_MSGPACKCXX
         CLP_NEED_NLOHMANN_JSON
-        CLP_NEED_OPENSSL
         CLP_NEED_SPDLOG
         CLP_NEED_YSTDLIB
         CLP_NEED_ZSTD
@@ -392,6 +392,13 @@ function(set_clp_s_timestamppattern_dependencies)
     )
 endfunction()
 
+function(set_clp_s_enable_curl_dependencies)
+    set_clp_need_flags(
+        CLP_NEED_CURL
+        CLP_NEED_OPENSSL
+    )
+endfunction()
+
 # Validates that for each target whose `CLP_BUILD_` option is `ON`, the `CLP_BUILD_` options for
 # the target's dependencies are also `ON`; Sets the required `CLP_NEED_` flags for any target that
 # will be built.
@@ -471,6 +478,10 @@ function(validate_and_setup_all_clp_dependency_flags)
         validate_clp_s_timestamppattern_dependencies()
         set_clp_s_timestamppattern_dependencies()
     endif()
+
+    if (CLP_BUILD_CLP_S_ENABLE_CURL)
+        set_clp_s_enable_curl_dependencies()
+    endif()
 endfunction()
 
 function (convert_clp_dependency_properties_to_variables)

components/core/src/clp/NetworkReader.hpp

@@ -66,6 +66,25 @@ class NetworkReader : public ReaderInterface {
         Finished
     };
 
+    /**
+     * CURL error details set by the underlying CURL handler.
+     */
+    class CurlErrorInfo {
+    public:
+        // Constructor
+        CurlErrorInfo(CURLcode code, std::string_view message) : m_code{code}, m_message{message} {}
+
+        // Methods
+        [[nodiscard]] auto code() const -> CURLcode { return m_code; }
+
+        [[nodiscard]] auto message() const -> std::string_view { return m_message; }
+
+    private:
+        // Members
+        CURLcode m_code;
+        std::string_view m_message;
+    };
+
     // Constants
     static constexpr size_t cDefaultBufferPoolSize{8};
     static constexpr size_t cDefaultBufferSize{4096};
@@ -224,16 +243,15 @@ class NetworkReader : public ReaderInterface {
     }
 
     /**
-     * @return The error message set by the underlying CURL handler.
-     * @return std::nullopt if the download is still in-progress or no error has occured.
+     * @return CURL error info if the download has completed with a CURL error.
+     * @return std::nullopt if the download is still in-progress or no error has occurred.
      */
-    [[nodiscard]] auto get_curl_error_msg() const -> std::optional<std::string_view> {
-        if (auto const ret_code{get_curl_ret_code()};
-            false == ret_code.has_value() || CURLE_OK == ret_code.value())
-        {
+    [[nodiscard]] auto get_curl_error_info() const -> std::optional<CurlErrorInfo> {
+        auto const ret_code = get_curl_ret_code();
+        if (false == ret_code.has_value() || CURLcode::CURLE_OK == ret_code.value()) {
             return std::nullopt;
         }
-        return std::string_view{m_curl_error_msg_buf->data()};
+        return CurlErrorInfo{ret_code.value(), std::string_view{m_curl_error_msg_buf->data()}};
     }
 
 private:

components/core/src/clp_s/CMakeLists.txt

@@ -5,21 +5,12 @@ add_subdirectory(timestamp_parser)
 
 set(
         CLP_S_CLP_SOURCES
-        ../clp/aws/AwsAuthenticationSigner.cpp
-        ../clp/aws/AwsAuthenticationSigner.hpp
         ../clp/BoundedReader.cpp
         ../clp/BoundedReader.hpp
         ../clp/BufferedReader.cpp
         ../clp/BufferedReader.hpp
         ../clp/BufferReader.cpp
         ../clp/BufferReader.hpp
-        ../clp/CurlDownloadHandler.cpp
-        ../clp/CurlDownloadHandler.hpp
-        ../clp/CurlEasyHandle.hpp
-        ../clp/CurlGlobalInstance.cpp
-        ../clp/CurlGlobalInstance.hpp
-        ../clp/CurlOperationFailed.hpp
-        ../clp/CurlStringList.hpp
         ../clp/cli_utils.cpp
         ../clp/cli_utils.hpp
         ../clp/Defs.h
@@ -72,8 +63,6 @@ set(
         ../clp/FileReader.hpp
         ../clp/GrepCore.cpp
         ../clp/GrepCore.hpp
-        ../clp/hash_utils.cpp
-        ../clp/hash_utils.hpp
         ../clp/SchemaSearcher.cpp
         ../clp/SchemaSearcher.hpp
         ../clp/ir/constants.hpp
@@ -86,8 +75,6 @@ set(
         ../clp/LogSurgeonReader.hpp
         ../clp/LogTypeDictionaryEntryReq.hpp
         ../clp/LogTypeDictionaryReaderReq.hpp
-        ../clp/NetworkReader.cpp
-        ../clp/NetworkReader.hpp
         ../clp/networking/socket_utils.cpp
         ../clp/networking/socket_utils.hpp
         ../clp/Query.cpp
@@ -122,6 +109,26 @@ set(
         ../clp/WriterInterface.hpp
 )
 
+set(
+        CLP_S_CLP_CURL_SOURCES
+        ../clp/aws/AwsAuthenticationSigner.cpp
+        ../clp/aws/AwsAuthenticationSigner.hpp
+        ../clp/hash_utils.cpp
+        ../clp/hash_utils.hpp
+        ../clp/CurlDownloadHandler.cpp
+        ../clp/CurlDownloadHandler.hpp
+        ../clp/CurlEasyHandle.hpp
+        ../clp/CurlGlobalInstance.cpp
+        ../clp/CurlGlobalInstance.hpp
+        ../clp/CurlOperationFailed.hpp
+        ../clp/CurlStringList.hpp
+        ../clp/NetworkReader.cpp
+        ../clp/NetworkReader.hpp
+)
+if(CLP_BUILD_CLP_S_ENABLE_CURL)
+        list(APPEND CLP_S_CLP_SOURCES ${CLP_S_CLP_CURL_SOURCES})
+endif()
+
 # This library is intended as a temporary stand-in until clp has been packaged into libraries.
 if(CLP_BUILD_CLP_S_CLP_DEPENDENCIES)
         add_library(
@@ -140,14 +147,21 @@ if(CLP_BUILD_CLP_S_CLP_DEPENDENCIES)
                 zstd::libzstd_static
                 PRIVATE
                 Boost::regex
-                ${CURL_LIBRARIES}
                 fmt::fmt
                 msgpack-cxx
                 nlohmann_json::nlohmann_json
-                OpenSSL::Crypto
                 spdlog::spdlog
                 ystdlib::error_handling
         )
+        if(CLP_BUILD_CLP_S_ENABLE_CURL)
+                target_link_libraries(
+                        clp_s_clp_dependencies
+                        PUBLIC
+                        ${CURL_LIBRARIES}
+                        PRIVATE
+                        OpenSSL::Crypto
+                )
+        endif()
 endif()
 
 set(
@@ -218,6 +232,11 @@ if(CLP_BUILD_CLP_S_IO)
                 ${CLP_S_IO_SOURCES}
         )
         add_library(clp_s::io ALIAS clp_s_io)
+        target_compile_definitions(
+                clp_s_io
+                PRIVATE
+                CLP_BUILD_CLP_S_ENABLE_CURL=$<BOOL:${CLP_BUILD_CLP_S_ENABLE_CURL}>
+        )
         target_compile_features(clp_s_io PRIVATE cxx_std_20)
         target_include_directories(clp_s_io PUBLIC ../)
         target_link_libraries(
@@ -280,6 +299,11 @@ if(CLP_BUILD_CLP_S_ARCHIVEWRITER)
                 ${CLP_S_ARCHIVE_WRITER_SOURCES}
         )
         add_library(clp_s::archive_writer ALIAS clp_s_archive_writer)
+        target_compile_definitions(
+                clp_s_archive_writer
+                PRIVATE
+                CLP_BUILD_CLP_S_ENABLE_CURL=$<BOOL:${CLP_BUILD_CLP_S_ENABLE_CURL}>
+        )
         target_compile_features(clp_s_archive_writer PRIVATE cxx_std_20)
         target_include_directories(clp_s_archive_writer PUBLIC ../)
         target_link_libraries(
@@ -296,7 +320,6 @@ if(CLP_BUILD_CLP_S_ARCHIVEWRITER)
                 ystdlib::error_handling
                 PRIVATE
                 Boost::url
-                ${CURL_LIBRARIES}
                 fmt::fmt
                 spdlog::spdlog
         )
@@ -345,6 +368,11 @@ if(CLP_BUILD_CLP_S_ARCHIVEREADER)
                 ${CLP_S_ARCHIVE_READER_SOURCES}
         )
         add_library(clp_s::archive_reader ALIAS clp_s_archive_reader)
+        target_compile_definitions(
+                clp_s_archive_reader
+                PRIVATE
+                CLP_BUILD_CLP_S_ENABLE_CURL=$<BOOL:${CLP_BUILD_CLP_S_ENABLE_CURL}>
+        )
         target_compile_features(clp_s_archive_reader PRIVATE cxx_std_20)
         target_include_directories(clp_s_archive_reader PUBLIC ../)
         target_link_libraries(
@@ -361,7 +389,6 @@ if(CLP_BUILD_CLP_S_ARCHIVEREADER)
                 PRIVATE
                 Boost::url
                 clp_s::clp_dependencies
-                ${CURL_LIBRARIES}
                 fmt::fmt
                 spdlog::spdlog
         )
@@ -438,6 +465,11 @@ if(CLP_BUILD_EXECUTABLES)
                 clp-s.cpp
                 ${CLP_S_EXE_SOURCES}
         )
+        target_compile_definitions(
+                clp-s
+                PRIVATE
+                CLP_BUILD_CLP_S_ENABLE_CURL=$<BOOL:${CLP_BUILD_CLP_S_ENABLE_CURL}>
+        )
         target_compile_features(clp-s PRIVATE cxx_std_20)
         target_include_directories(clp-s PRIVATE ../)
         target_link_libraries(

components/core/src/clp_s/InputConfig.cpp

@@ -14,18 +14,21 @@
 #include <simdjson.h>
 #include <spdlog/spdlog.h>
 
-#include "../clp/aws/AwsAuthenticationSigner.hpp"
 #include "../clp/BufferedReader.hpp"
 #include "../clp/ffi/ir_stream/protocol_constants.hpp"
 #include "../clp/FileReader.hpp"
-#include "../clp/NetworkReader.hpp"
 #include "../clp/ReaderInterface.hpp"
 #include "../clp/spdlog_with_specializations.hpp"
 #include "../clp/streaming_compression/Decompressor.hpp"
 #include "../clp/streaming_compression/zstd/Decompressor.hpp"
 #include "../clp/utf8_utils.hpp"
 #include "Utils.hpp"
 
+#if CLP_BUILD_CLP_S_ENABLE_CURL
+    #include "../clp/aws/AwsAuthenticationSigner.hpp"
+    #include "../clp/NetworkReader.hpp"
+#endif
+
 namespace clp_s {
 auto get_source_for_path(std::string_view const path) -> InputSource {
     try {
@@ -186,6 +189,7 @@ auto try_create_file_reader(std::string_view const file_path)
     }
 }
 
+#if CLP_BUILD_CLP_S_ENABLE_CURL
 auto try_sign_url(std::string& url) -> bool {
     auto const aws_access_key = std::getenv(cAwsAccessKeyIdEnvVar);
     auto const aws_secret_access_key = std::getenv(cAwsSecretAccessKeyEnvVar);
@@ -244,6 +248,15 @@ auto try_create_network_reader(std::string_view const url, NetworkAuthOption con
         return nullptr;
     }
 }
+#else
+auto try_create_network_reader(
+        [[maybe_unused]] std::string_view const url,
+        [[maybe_unused]] NetworkAuthOption const& auth
+) -> std::shared_ptr<clp::ReaderInterface> {
+    SPDLOG_ERROR("This build of clp-s does not support network inputs (libcurl excluded).");
+    return nullptr;
+}
+#endif
 
 auto could_be_zstd(char const* peek_buf, size_t peek_size) -> bool {
     constexpr std::array<char, 4> cZstdMagicNumber = {'\x28', '\xB5', '\x2F', '\xFD'};