refactor: apply changes from review

Signed-off-by: Jose Faria <[email protected]>

Author: jncfa

rosbag2_cpp/src/rosbag2_cpp/cache/circular_message_cache.cpp

@@ -42,15 +42,8 @@ CircularMessageCache::~CircularMessageCache()
 
 bool CircularMessageCache::push(std::shared_ptr<const rosbag2_storage::SerializedBagMessage> msg)
 {
-  if (msg == nullptr) {
-    return false;
-  }
-
   std::lock_guard<std::mutex> cache_lock(producer_buffer_mutex_);
-  producer_buffer_->push(msg);
-  // Always return true since circular message cache drops old messages by design and it
-  // shouldn't be counted as a lost messages.
-  return true;
+  return producer_buffer_->push(msg);
 }
 
 std::shared_ptr<CacheBufferInterface> CircularMessageCache::get_consumer_buffer()

rosbag2_cpp/src/rosbag2_cpp/cache/message_cache_circular_buffer.cpp

@@ -32,13 +32,14 @@ MessageCacheCircularBuffer::MessageCacheCircularBuffer(size_t max_cache_size)
 
 bool MessageCacheCircularBuffer::push(CacheBufferInterface::buffer_element_t msg)
 {
-  if (msg == nullptr) {
+  if (!msg || !msg->serialized_data) {
+    ROSBAG2_CPP_LOG_ERROR("Attempted to push null message into circular buffer. Dropping message!");
     return false;
   }
 
   // Drop message if it exceeds the buffer size
   if (msg->serialized_data->buffer_length > max_bytes_size_) {
-    ROSBAG2_CPP_LOG_WARN_STREAM("Last message exceeds snapshot buffer size. Dropping message!");
+    ROSBAG2_CPP_LOG_WARN("Last message exceeds snapshot buffer size. Dropping message!");
     return false;
   }
 

rosbag2_cpp/test/rosbag2_cpp/test_circular_message_cache.cpp

@@ -133,3 +133,12 @@ TEST_F(CircularMessageCacheTest, circular_message_cache_ensure_empty) {
   EXPECT_THAT(circular_message_cache->get_consumer_buffer()->size(), Eq(0u));
   circular_message_cache->release_consumer_buffer();
 }
+
+TEST_F(CircularMessageCacheTest, circular_message_cache_rejects_null_message) {
+  auto circular_message_cache_ = std::make_shared<rosbag2_cpp::cache::CircularMessageCache>(
+  cache_size_);
+
+  bool result = true;
+  ASSERT_NO_THROW(result = circular_message_cache_->push(nullptr));
+  EXPECT_FALSE(result);
+}

rosbag2_cpp/test/rosbag2_cpp/test_message_cache.cpp

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 #include <gmock/gmock.h>
-#include <gtest/gtest.h>
+
 #include <chrono>
 #include <numeric>
 #include <memory>
@@ -23,7 +23,6 @@
 #include <vector>
 #include <thread>
 
-#include "rosbag2_cpp/cache/message_cache_circular_buffer.hpp"
 #include "rosbag2_storage/ros_helper.hpp"
 #include "rosbag2_storage/serialized_bag_message.hpp"
 
@@ -106,19 +105,4 @@ TEST_F(MessageCacheTest, message_cache_writes_full_producer_buffer) {
 
   mock_cache_consumer->stop();
   EXPECT_EQ(consumed_message_count, message_count - should_be_dropped_count);
-}
-
-class MessageCacheCircularBufferTest : public testing::Test {
-protected:
-  MessageCacheCircularBufferTest()
-  : buffer_(1024) {}
-  rosbag2_cpp::cache::MessageCacheCircularBuffer buffer_;
-};
-
-TEST_F(MessageCacheCircularBufferTest, PushNullptrCausesCrash) {
-  bool result = true;
-  ASSERT_NO_THROW({
-    result = buffer_.push(nullptr);
-  });
-  EXPECT_FALSE(result);
-}
+}