[kilted] Follow-up on "Fix for multibag replay stagnation (#2158)" (#2182)

* [kilted] Follow-up on "Fix for multibag replay stagnation (#2158)"

- Fix for returning a dangling reference from the
 "Player::get_storage_options()" method
- Also deprecate "Player::get_storage_options()" method in favor of the
 "get_all_storage_options()""

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>

* Remove deprecation warning for the get_storage_options() per code review

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>

---------

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>

Author: MichaelOrlov

rosbag2_transport/src/rosbag2_transport/player.cpp

@@ -241,7 +241,7 @@ class PlayerImpl
   size_t get_number_of_registered_on_play_msg_post_callbacks();
 
   /// \brief Getter for the first of the currently stored storage options
-  /// \return Copy of the first of the currently stored storage options
+  /// \return Reference to the first of the currently stored storage options
   const rosbag2_storage::StorageOptions & get_storage_options();
 
   /// \brief Getter for the currently stored storage options
@@ -435,6 +435,9 @@ class PlayerImpl
       return l->send_timestamp > r->send_timestamp;
     }
   } bag_message_chronological_send_timestamp_comparator;
+
+  // Note: The first_storage_options_ is used as a workaround for deprecated get_storage_options()
+  rosbag2_storage::StorageOptions first_storage_options_;
 };
 
 PlayerImpl::BagMessageComparator PlayerImpl::get_bag_message_comparator(const MessageOrder & order)
@@ -2182,10 +2185,12 @@ void PlayerImpl::publish_clock_update(const rclcpp::Time & time)
 const rosbag2_storage::StorageOptions & PlayerImpl::get_storage_options()
 {
   auto all_storage_options = get_all_storage_options();
-  if (all_storage_options.size() < 1) {
+  if (all_storage_options.empty()) {
     throw std::runtime_error("Storage options not available.");
   }
-  return all_storage_options[0];
+  first_storage_options_ = all_storage_options[0];
+  // Note: Use first_storage_options_ as return value to keep the reference valid
+  return first_storage_options_;
 }
 
 std::vector<rosbag2_storage::StorageOptions> PlayerImpl::get_all_storage_options()