refactor(core): Remove clp::Array and migrate to ystdlib::containers::Array. (#712)

Bill-hbrhbr · web-flow · commit 18ea0290fa46 · 2025-04-14T11:14:36.000-04:00
diff --git a/components/core/CMakeLists.txt b/components/core/CMakeLists.txt
@@ -370,7 +370,6 @@ set(SOURCE_FILES_reducer_unitTest
     )
 
 set(SOURCE_FILES_unitTest
-        src/clp/Array.hpp
         src/clp/aws/AwsAuthenticationSigner.cpp
         src/clp/aws/AwsAuthenticationSigner.hpp
         src/clp/aws/constants.hpp
@@ -598,7 +597,6 @@ set(SOURCE_FILES_unitTest
         submodules/sqlite3/sqlite3ext.h
         tests/LogSuppressor.hpp
         tests/TestOutputCleaner.hpp
-        tests/test-Array.cpp
         tests/test-BoundedReader.cpp
         tests/test-BufferedFileReader.cpp
         tests/test-clp_s-end_to_end.cpp
@@ -663,6 +661,7 @@ target_link_libraries(unitTest
         clp::regex_utils
         clp::string_utils
         yaml-cpp::yaml-cpp
+        ystdlib::containers
         ystdlib::error_handling
         ${LIBLZMA_LIBRARIES}
         ZStd::ZStd
diff --git a/components/core/src/clp/Array.hpp b/components/core/src/clp/Array.hpp
diff --git a/components/core/src/clp/NetworkReader.hpp b/components/core/src/clp/NetworkReader.hpp
@@ -18,8 +18,8 @@
 #include <vector>
 
 #include <curl/curl.h>
+#include <ystdlib/containers/Array.hpp>
 
-#include "Array.hpp"
 #include "CurlDownloadHandler.hpp"
 #include "CurlGlobalInstance.hpp"
 #include "ErrorCode.hpp"
@@ -344,7 +344,7 @@ class NetworkReader : public ReaderInterface {
     size_t m_buffer_size{cDefaultBufferSize};
     size_t m_curr_downloader_buf_idx{0};
 
-    std::vector<Array<char>> m_buffer_pool;
+    std::vector<ystdlib::containers::Array<char>> m_buffer_pool;
     std::queue<BufferView> m_filled_buffer_queue;
     std::optional<BufferView> m_curr_downloader_buf;
     std::optional<BufferView> m_curr_reader_buf;
diff --git a/components/core/src/clp/clg/CMakeLists.txt b/components/core/src/clp/clg/CMakeLists.txt
@@ -139,6 +139,7 @@ target_link_libraries(clg
         ${STD_FS_LIBS}
         clp::string_utils
         yaml-cpp::yaml-cpp
+        ystdlib::containers
         ZStd::ZStd
 )
 # Put the built executable at the root of the build directory
diff --git a/components/core/src/clp/clo/CMakeLists.txt b/components/core/src/clp/clo/CMakeLists.txt
@@ -167,6 +167,7 @@ target_link_libraries(clo
         ${sqlite_LIBRARY_DEPENDENCIES}
         ${STD_FS_LIBS}
         clp::string_utils
+        ystdlib::containers
         ZStd::ZStd
 )
 # Put the built executable at the root of the build directory
diff --git a/components/core/src/clp/clp/CMakeLists.txt b/components/core/src/clp/clp/CMakeLists.txt
@@ -181,6 +181,7 @@ target_link_libraries(clp
         ${STD_FS_LIBS}
         clp::string_utils
         yaml-cpp::yaml-cpp
+        ystdlib::containers
         ZStd::ZStd
 )
 # Put the built executable at the root of the build directory
diff --git a/components/core/src/clp/make_dictionaries_readable/CMakeLists.txt b/components/core/src/clp/make_dictionaries_readable/CMakeLists.txt
@@ -49,6 +49,7 @@ target_link_libraries(make-dictionaries-readable
         log_surgeon::log_surgeon
         spdlog::spdlog
         clp::string_utils
+        ystdlib::containers
         ZStd::ZStd
 )
 # Put the built executable at the root of the build directory
diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp
@@ -3,8 +3,8 @@
 #include <sys/stat.h>
 
 #include <fmt/core.h>
+#include <ystdlib/containers/Array.hpp>
 
-#include "../Array.hpp"
 #include "../FileReader.hpp"
 
 namespace clp::streaming_archive {
@@ -26,7 +26,7 @@ auto ArchiveMetadata::create_from_file(std::string_view file_path) -> ArchiveMet
         throw OperationFailed(clp_rc, __FILENAME__, __LINE__);
     }
 
-    clp::Array<char> buf{static_cast<size_t>(file_stat.st_size)};
+    ystdlib::containers::Array<char> buf(static_cast<size_t>(file_stat.st_size));
     if (auto const clp_rc = file_reader.try_read_exact_length(buf.data(), buf.size());
         clp::ErrorCode::ErrorCode_Success != clp_rc)
     {
diff --git a/components/core/src/clp/streaming_compression/lzma/Compressor.hpp b/components/core/src/clp/streaming_compression/lzma/Compressor.hpp
@@ -5,8 +5,8 @@
 #include <cstdint>
 
 #include <lzma.h>
+#include <ystdlib/containers/Array.hpp>
 
-#include "../../Array.hpp"
 #include "../../ErrorCode.hpp"
 #include "../../TraceableException.hpp"
 #include "../../WriterInterface.hpp"
@@ -37,7 +37,8 @@ class Compressor : public ::clp::streaming_compression::Compressor {
     Compressor() : Compressor{cDefaultCompressionLevel, cDefaultDictionarySize, LZMA_CHECK_CRC64} {}
 
     Compressor(int compression_level, size_t dict_size, lzma_check check)
-            : m_lzma_stream{compression_level, dict_size, check} {}
+            : m_compressed_stream_block_buffer(cCompressedStreamBlockBufferSize),
+              m_lzma_stream{compression_level, dict_size, check} {}
 
     // Destructor
     ~Compressor() override = default;
@@ -224,7 +225,7 @@ class Compressor : public ::clp::streaming_compression::Compressor {
     WriterInterface* m_compressed_stream_writer{nullptr};
 
     // Compressed stream variables
-    Array<uint8_t> m_compressed_stream_block_buffer{cCompressedStreamBlockBufferSize};
+    ystdlib::containers::Array<uint8_t> m_compressed_stream_block_buffer;
     LzmaStream m_lzma_stream;
     size_t m_uncompressed_stream_pos{0};
 };
diff --git a/components/core/src/clp/streaming_compression/zstd/Compressor.cpp b/components/core/src/clp/streaming_compression/zstd/Compressor.cpp
@@ -11,7 +11,8 @@
 
 namespace clp::streaming_compression::zstd {
 Compressor::Compressor()
-        : m_compressed_stream_block{
+        : m_compressed_stream_block_buffer(ZSTD_CStreamOutSize()),
+          m_compressed_stream_block{
                   .dst = m_compressed_stream_block_buffer.data(),
                   .size = m_compressed_stream_block_buffer.size(),
                   .pos = 0
diff --git a/components/core/src/clp/streaming_compression/zstd/Compressor.hpp b/components/core/src/clp/streaming_compression/zstd/Compressor.hpp
@@ -3,9 +3,9 @@
 
 #include <cstddef>
 
+#include <ystdlib/containers/Array.hpp>
 #include <zstd.h>
 
-#include "../../Array.hpp"
 #include "../../ErrorCode.hpp"
 #include "../../TraceableException.hpp"
 #include "../../WriterInterface.hpp"
@@ -98,7 +98,7 @@ class Compressor : public ::clp::streaming_compression::Compressor {
     ZSTD_CStream* m_compression_stream{ZSTD_createCStream()};
     bool m_compression_stream_contains_data{false};
 
-    Array<char> m_compressed_stream_block_buffer{ZSTD_CStreamOutSize()};
+    ystdlib::containers::Array<char> m_compressed_stream_block_buffer;
     ZSTD_outBuffer m_compressed_stream_block;
 
     size_t m_uncompressed_stream_pos{0};
diff --git a/components/core/src/clp/streaming_compression/zstd/Decompressor.cpp b/components/core/src/clp/streaming_compression/zstd/Decompressor.cpp
@@ -12,7 +12,7 @@ namespace clp::streaming_compression::zstd {
 Decompressor::Decompressor()
         : ::clp::streaming_compression::Decompressor{CompressorType::ZSTD},
           m_decompression_stream{ZSTD_createDStream()},
-          m_unused_decompressed_stream_block_buffer{ZSTD_DStreamOutSize()} {
+          m_unused_decompressed_stream_block_buffer(ZSTD_DStreamOutSize()) {
     if (nullptr == m_decompression_stream) {
         SPDLOG_ERROR("streaming_compression::zstd::Decompressor: ZSTD_createDStream() error");
         throw OperationFailed(ErrorCode_Failure, __FILENAME__, __LINE__);
diff --git a/components/core/src/clp/streaming_compression/zstd/Decompressor.hpp b/components/core/src/clp/streaming_compression/zstd/Decompressor.hpp
@@ -5,9 +5,9 @@
 #include <optional>
 #include <string>
 
+#include <ystdlib/containers/Array.hpp>
 #include <zstd.h>
 
-#include "../../Array.hpp"
 #include "../../ReaderInterface.hpp"
 #include "../../ReadOnlyMemoryMappedFile.hpp"
 #include "../../TraceableException.hpp"
@@ -136,14 +136,14 @@ class Decompressor : public ::clp::streaming_compression::Decompressor {
     ReaderInterface* m_reader{nullptr};
     size_t m_reader_initial_pos{0ULL};
 
-    std::optional<Array<char>> m_read_buffer;
+    std::optional<ystdlib::containers::Array<char>> m_read_buffer;
     size_t m_read_buffer_length{0ULL};
 
     ZSTD_inBuffer m_compressed_stream_block{};
 
     size_t m_decompressed_stream_pos{0ULL};
 
-    Array<char> m_unused_decompressed_stream_block_buffer;
+    ystdlib::containers::Array<char> m_unused_decompressed_stream_block_buffer;
 };
 }  // namespace clp::streaming_compression::zstd
 #endif  // CLP_STREAMING_COMPRESSION_ZSTD_DECOMPRESSOR_HPP
diff --git a/components/core/src/clp_s/CMakeLists.txt b/components/core/src/clp_s/CMakeLists.txt
@@ -249,6 +249,7 @@ target_link_libraries(
         simdjson
         spdlog::spdlog
         yaml-cpp::yaml-cpp
+        ystdlib::containers
         ZStd::ZStd
 )
 target_include_directories(clp-s PRIVATE "${PROJECT_SOURCE_DIR}/submodules")
diff --git a/components/core/src/clp_s/indexer/CMakeLists.txt b/components/core/src/clp_s/indexer/CMakeLists.txt
@@ -94,6 +94,7 @@ target_link_libraries(indexer
         simdjson
         spdlog::spdlog
         yaml-cpp::yaml-cpp
+        ystdlib::containers
         ZStd::ZStd
 )
 # Put the built executable at the root of the build directory
diff --git a/components/core/tests/test-Array.cpp b/components/core/tests/test-Array.cpp
diff --git a/components/core/tests/test-FileDescriptorReader.cpp b/components/core/tests/test-FileDescriptorReader.cpp
diff --git a/components/core/tests/test-NetworkReader.cpp b/components/core/tests/test-NetworkReader.cpp
diff --git a/components/core/tests/test-StreamingCompression.cpp b/components/core/tests/test-StreamingCompression.cpp

Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,7 @@ target_link_libraries(clg`
`139`	`139`	`${STD_FS_LIBS}`
`140`	`140`	`clp::string_utils`
`141`	`141`	`yaml-cpp::yaml-cpp`
	`142`	`+ ystdlib::containers`
`142`	`143`	`ZStd::ZStd`
`143`	`144`	`)`
`144`	`145`	`# Put the built executable at the root of the build directory`
Original file line number	Diff line number	Diff line change
`@@ -167,6 +167,7 @@ target_link_libraries(clo`
`167`	`167`	`${sqlite_LIBRARY_DEPENDENCIES}`
`168`	`168`	`${STD_FS_LIBS}`
`169`	`169`	`clp::string_utils`
	`170`	`+ ystdlib::containers`
`170`	`171`	`ZStd::ZStd`
`171`	`172`	`)`
`172`	`173`	`# Put the built executable at the root of the build directory`
Original file line number	Diff line number	Diff line change
`@@ -181,6 +181,7 @@ target_link_libraries(clp`
`181`	`181`	`${STD_FS_LIBS}`
`182`	`182`	`clp::string_utils`
`183`	`183`	`yaml-cpp::yaml-cpp`
	`184`	`+ ystdlib::containers`
`184`	`185`	`ZStd::ZStd`
`185`	`186`	`)`
`186`	`187`	`# Put the built executable at the root of the build directory`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ target_link_libraries(make-dictionaries-readable`
`49`	`49`	`log_surgeon::log_surgeon`
`50`	`50`	`spdlog::spdlog`
`51`	`51`	`clp::string_utils`
	`52`	`+ ystdlib::containers`
`52`	`53`	`ZStd::ZStd`
`53`	`54`	`)`
`54`	`55`	`# Put the built executable at the root of the build directory`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`	`#include <sys/stat.h>`
`4`	`4`
`5`	`5`	`#include <fmt/core.h>`
	`6`	`+#include <ystdlib/containers/Array.hpp>`
`6`	`7`
`7`		`-#include "../Array.hpp"`
`8`	`8`	`#include "../FileReader.hpp"`
`9`	`9`
`10`	`10`	`namespace clp::streaming_archive {`
`@@ -26,7 +26,7 @@ auto ArchiveMetadata::create_from_file(std::string_view file_path) -> ArchiveMet`
`26`	`26`	`throw OperationFailed(clp_rc, __FILENAME__, __LINE__);`
`27`	`27`	`}`
`28`	`28`
`29`		`- clp::Array<char> buf{static_cast<size_t>(file_stat.st_size)};`
	`29`	`+ ystdlib::containers::Array<char> buf(static_cast<size_t>(file_stat.st_size));`
`30`	`30`	`if (auto const clp_rc = file_reader.try_read_exact_length(buf.data(), buf.size());`
`31`	`31`	`clp::ErrorCode::ErrorCode_Success != clp_rc)`
`32`	`32`	`{`