feat(kv-ir): Update IrUnitHandlerReq::handle_log_event to accept the log event's index in the stream from the deserializer. (#1237)

Author: hoophalab

components/core/src/clp/ffi/ir_stream/Deserializer.hpp

@@ -1,6 +1,7 @@
 #ifndef CLP_FFI_IR_STREAM_DESERIALIZER_HPP
 #define CLP_FFI_IR_STREAM_DESERIALIZER_HPP
 
+#include <cstddef>
 #include <cstdint>
 #include <memory>
 #include <string>
@@ -196,6 +197,7 @@ class Deserializer {
     IrUnitHandlerType m_ir_unit_handler;
     bool m_is_complete{false};
     [[no_unique_address]] QueryHandlerType m_query_handler;
+    size_t m_next_log_event_idx{0};
 };
 
 /**
@@ -304,6 +306,9 @@ auto Deserializer<IrUnitHandler, QueryHandlerType>::deserialize_next_ir_unit(
                     m_utc_offset
             ))};
 
+            auto const log_event_idx{m_next_log_event_idx};
+            m_next_log_event_idx += 1;
+
             if constexpr (search::IsNonEmptyQueryHandler<QueryHandlerType>::value) {
                 if (search::AstEvaluationResult::True
                     != YSTDLIB_ERROR_HANDLING_TRYX(
@@ -314,7 +319,9 @@ auto Deserializer<IrUnitHandler, QueryHandlerType>::deserialize_next_ir_unit(
                 }
             }
 
-            if (auto const err{m_ir_unit_handler.handle_log_event(std::move(log_event))};
+            if (auto const err{
+                        m_ir_unit_handler.handle_log_event(std::move(log_event), log_event_idx)
+                };
                 IRErrorCode::IRErrorCode_Success != err)
             {
                 return ir_error_code_to_errc(err);

components/core/src/clp/ffi/ir_stream/IrUnitHandlerReq.hpp

@@ -2,6 +2,7 @@
 #define CLP_FFI_IR_STREAM_IRUNITHANDLERREQ_HPP
 
 #include <concepts>
+#include <cstddef>
 #include <memory>
 #include <utility>
 
@@ -23,6 +24,7 @@ template <typename IrUnitHandlerType>
 concept IrUnitHandlerInterfaceReq = requires(
         IrUnitHandlerType handler,
         KeyValuePairLogEvent&& log_event,
+        size_t log_event_idx,
         bool is_auto_generated,
         UtcOffset utc_offset_old,
         UtcOffset utc_offset_new,
@@ -32,10 +34,11 @@ concept IrUnitHandlerInterfaceReq = requires(
     /**
      * Handles a log event IR unit.
      * @param log_event The deserialized result from IR deserializer.
+     * @param log_event_idx The log event index of `log_event` in the stream.
      * @return IRErrorCode::Success on success, user-defined error code on failures.
      */
     {
-        handler.handle_log_event(std::forward<KeyValuePairLogEvent &&>(log_event))
+        handler.handle_log_event(std::forward<KeyValuePairLogEvent &&>(log_event), log_event_idx)
     } -> std::same_as<IRErrorCode>;
 
     /**

components/core/src/clp/ffi/ir_stream/search/test/test_deserializer_integration.cpp

@@ -1,3 +1,4 @@
+#include <cstddef>
 #include <cstdint>
 #include <memory>
 #include <sstream>
@@ -40,7 +41,9 @@ using JsonPair = std::pair<nlohmann::json, nlohmann::json>;
  */
 class IrUnitHandler {
 public:
-    [[nodiscard]] auto handle_log_event(KeyValuePairLogEvent&& log_event) -> IRErrorCode {
+    [[nodiscard]] auto
+    handle_log_event(KeyValuePairLogEvent&& log_event, [[maybe_unused]] size_t log_event_idx)
+            -> IRErrorCode {
         m_deserialized_log_events.emplace_back(std::move(log_event));
         return IRErrorCode::IRErrorCode_Success;
     }

components/core/src/clp_s/JsonParser.cpp

@@ -1,5 +1,6 @@
 #include "JsonParser.hpp"
 
+#include <cstddef>
 #include <cstdint>
 #include <iostream>
 #include <memory>
@@ -45,7 +46,9 @@ namespace clp_s {
  */
 class IrUnitHandler {
 public:
-    [[nodiscard]] auto handle_log_event(KeyValuePairLogEvent&& log_event) -> IRErrorCode {
+    [[nodiscard]] auto
+    handle_log_event(KeyValuePairLogEvent&& log_event, [[maybe_unused]] size_t log_event_idx)
+            -> IRErrorCode {
         m_deserialized_log_event.emplace(std::move(log_event));
         return IRErrorCode::IRErrorCode_Success;
     }

components/core/src/clp_s/kv_ir_search.cpp

@@ -74,7 +74,9 @@ class IrUnitHandler {
     ~IrUnitHandler() = default;
 
     // Methods implementing `IrUnitHandlerInterface`
-    [[nodiscard]] auto handle_log_event(KeyValuePairLogEvent log_event) -> IRErrorCode;
+    [[nodiscard]] auto
+    handle_log_event(KeyValuePairLogEvent log_event, [[maybe_unused]] size_t log_event_idx)
+            -> IRErrorCode;
 
     [[nodiscard]] static auto handle_utc_offset_change(
             [[maybe_unused]] UtcOffset utc_offset_old,
@@ -151,7 +153,10 @@ auto IrUnitHandler::create(
  *   necessary validations are performed.
  */
 // NOLINTNEXTLINE(readability-convert-member-functions-to-static)
-auto IrUnitHandler::handle_log_event(clp::ffi::KeyValuePairLogEvent log_event) -> IRErrorCode {
+auto IrUnitHandler::handle_log_event(
+        clp::ffi::KeyValuePairLogEvent log_event,
+        [[maybe_unused]] size_t log_event_idx
+) -> IRErrorCode {
     auto const serialize_result{log_event.serialize_to_json()};
     if (serialize_result.has_error()) {
         SPDLOG_ERROR(

components/core/tests/test-ffi_IrUnitHandlerReq.cpp

@@ -1,3 +1,4 @@
+#include <cstddef>
 #include <memory>
 #include <optional>
 #include <string_view>
@@ -28,7 +29,9 @@ constexpr std::string_view cTestSchemaTreeNodeKeyName{"test_key"};
 class TrivialIrUnitHandler {
 public:
     // Implements `clp::ffi::ir_stream::IrUnitHandlerReq`
-    [[nodiscard]] auto handle_log_event(KeyValuePairLogEvent&& log_event) -> IRErrorCode {
+    [[nodiscard]] auto
+    handle_log_event(KeyValuePairLogEvent&& log_event, [[maybe_unused]] size_t log_event_idx)
+            -> IRErrorCode {
         m_log_event.emplace(std::move(log_event));
         return IRErrorCode::IRErrorCode_Success;
     }
@@ -98,7 +101,7 @@ auto test_ir_unit_handler_req(clp::ffi::ir_stream::IrUnitHandlerReq auto& handle
     REQUIRE(
             (false == test_log_event_result.has_error()
              && IRErrorCode::IRErrorCode_Success
-                        == handler.handle_log_event(std::move(test_log_event_result.value())))
+                        == handler.handle_log_event(std::move(test_log_event_result.value()), 0))
     );
     REQUIRE(
             (IRErrorCode::IRErrorCode_Success

components/core/tests/test-ir_encoding_methods.cpp

@@ -103,8 +103,11 @@ class UnstructuredLogEvent {
 class IrUnitHandler {
 public:
     // Implements `clp::ffi::ir_stream::IrUnitHandlerReq`
-    [[nodiscard]] auto handle_log_event(KeyValuePairLogEvent&& log_event) -> IRErrorCode {
+    [[nodiscard]] auto
+    handle_log_event(KeyValuePairLogEvent&& log_event, [[maybe_unused]] size_t log_event_idx)
+            -> IRErrorCode {
         m_deserialized_log_events.emplace_back(std::move(log_event));
+        m_deserialized_log_event_indices.emplace_back(log_event_idx);
         return IRErrorCode::IRErrorCode_Success;
     }
 
@@ -152,8 +155,13 @@ class IrUnitHandler {
         return m_deserialized_log_events;
     }
 
+    [[nodiscard]] auto get_deserialized_log_event_indices() const -> vector<size_t> const& {
+        return m_deserialized_log_event_indices;
+    }
+
 private:
     vector<KeyValuePairLogEvent> m_deserialized_log_events;
+    vector<size_t> m_deserialized_log_event_indices;
     bool m_is_complete{false};
 };
 
@@ -1313,6 +1321,10 @@ TEMPLATE_TEST_CASE(
     auto const& deserialized_log_events{ir_unit_handler.get_deserialized_log_events()};
     REQUIRE((expected_auto_gen_and_user_gen_object_pairs.size() == deserialized_log_events.size()));
 
+    auto const& deserialized_log_event_indices{
+            ir_unit_handler.get_deserialized_log_event_indices()
+    };
+
     auto const num_log_events{expected_auto_gen_and_user_gen_object_pairs.size()};
     for (size_t idx{0}; idx < num_log_events; ++idx) {
         auto const& [expected_auto_gen_json_obj, expected_user_gen_json_obj]{
@@ -1339,6 +1351,8 @@ TEMPLATE_TEST_CASE(
         };
         REQUIRE((expected_auto_gen_json_obj == actual_auto_gen_json_obj));
         REQUIRE((expected_user_gen_json_obj == actual_user_gen_json_obj));
+
+        REQUIRE((idx == deserialized_log_event_indices.at(idx)));
     }
 
     auto const eof_result{deserializer.deserialize_next_ir_unit(reader)};