Skip to content

[humble] Bugfix for writer not being able to open again after closing (backport #1599) #1653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 16, 2024

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented May 11, 2024

Note: There are no final changes in header files. i.e., ABI/API compatible.


This is an automatic backport of pull request #1635 done by Mergify.

Copy link
Author

mergify bot commented May 11, 2024

Cherry-pick of a360d9b has failed:

On branch mergify/bp/humble/pr-1635
Your branch is up to date with 'origin/humble'.

You are currently cherry-picking commit a360d9b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   rosbag2_compression/test/rosbag2_compression/test_sequential_compression_writer.cpp
	modified:   rosbag2_cpp/include/rosbag2_cpp/writers/sequential_writer.hpp
	modified:   rosbag2_tests/test/rosbag2_tests/test_rosbag2_cpp_api.cpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   rosbag2_compression/src/rosbag2_compression/sequential_compression_writer.cpp
	both modified:   rosbag2_cpp/src/rosbag2_cpp/writer.cpp
	both modified:   rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added the conflicts label May 11, 2024
@mergify mergify bot requested a review from a team as a code owner May 11, 2024 17:12
@mergify mergify bot requested review from gbiggs and jhdcs and removed request for a team May 11, 2024 17:12
@MichaelOrlov MichaelOrlov changed the title [iron] Bugfix for writer not being able to open again after closing (backport #1599) (backport #1635) [humble] Bugfix for writer not being able to open again after closing (backport #1599) May 11, 2024
…backport #1599) (#1635)

* re-applies fixes from #1590 to rolling. Also removes new message definition in sequential writer test for multiple open operations. Also clears topic_names_to_message_definitions_ and handles message_definitions_s underlying container similarly. Lastly, also avoids reset of factory in the compression writer, adds unit test there too.

Signed-off-by: Yannick Schulz <[email protected]>
Signed-off-by: Michael Orlov <[email protected]>

* removes unused compressor_ member from compresser writer class. Also delegates rest of the closing behavior to the base class in close method, as it is handled in the open and write methods of the compression writer

Signed-off-by: Yannick Schulz <[email protected]>

* Remove unrelated delta

- message_definitions_ was intentionally allocated on the stack and
should persist between writer close() and open() because it represents
cache for message definitions which is not changes.

Signed-off-by: Michael Orlov <[email protected]>

* Don't call virtual methods from destructors

Signed-off-by: Michael Orlov <[email protected]>

* Cleanup 'rosbag2_directory_next' after the test run

Signed-off-by: Michael Orlov <[email protected]>

* Protect Writer::open(..) and Writer::close() with mutex on upper level

- Rationale: To avoid race conditions if open(..) and close() could be
ever be called from different threads.

Signed-off-by: Michael Orlov <[email protected]>

* Bugfix for WRITE_SPLIT callback not called for the last compressed file

Signed-off-by: Michael Orlov <[email protected]>

* Bugfix for lost messages from cache when closing compression writer

Signed-off-by: Michael Orlov <[email protected]>

* Address build failure by using rcpputils::fs instead of std::filesystem

- Note: On Iron we haven't migrated to the std::filesystem and using
rcpputils::fs

Signed-off-by: Michael Orlov <[email protected]>

* Adopt failing 'open_succeeds_twice' test for Iron

Signed-off-by: Michael Orlov <[email protected]>

* Return from writer's open() immediately if storage already open

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Yannick Schulz <[email protected]>
Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Yannick Schulz <[email protected]>
(cherry picked from commit a360d9b)

# Conflicts:
#	rosbag2_compression/src/rosbag2_compression/sequential_compression_writer.cpp
#	rosbag2_cpp/src/rosbag2_cpp/writer.cpp
#	rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp
Signed-off-by: Michael Orlov <[email protected]>
- Ensure that writer_ is destructed before intercepted fake_metadata_

Signed-off-by: Michael Orlov <[email protected]>
- Use std::filesystem for temp files and folders operation. For some
reason rcpputils::fs::delete_all(folder_name) wasn't able to delete temp
folder with subfolders.

Signed-off-by: Michael Orlov <[email protected]>
@MichaelOrlov MichaelOrlov force-pushed the mergify/bp/humble/pr-1635 branch from 8c80e55 to e0d3d48 Compare May 16, 2024 02:29
@MichaelOrlov
Copy link
Contributor

Pulls: #1653
Gist: https://gist.githubusercontent.com/MichaelOrlov/7a1c681098d763225a78117058da155f/raw/6b385bf58ed6552907d9ca63de4e45f571411ca8/ros2.repos
BUILD args: --packages-above-and-dependencies rosbag2_cpp rosbag2_compression rosbag2_tests
TEST args: --packages-above rosbag2_cpp rosbag2_compression rosbag2_tests
ROS Distro: humble
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/13906

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@MichaelOrlov MichaelOrlov mentioned this pull request May 16, 2024
- The `serialized_msg2` is not owning the serialized data after the
first call writer.write(serialized_msg2,..). i.e. need to use another
message or another API in test. This is not a bug - this is by design.

Signed-off-by: Michael Orlov <[email protected]>
@MichaelOrlov
Copy link
Contributor

Re-run CI after addressing test failure.
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/13907

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@MichaelOrlov
Copy link
Contributor

Re-run Linux CI. The previous failure was related to the CI infrastructure.

  • Linux Build Status

@MichaelOrlov MichaelOrlov merged commit 72935b8 into humble May 16, 2024
@delete-merged-branch delete-merged-branch bot deleted the mergify/bp/humble/pr-1635 branch May 16, 2024 17:27
emersonknapp added a commit that referenced this pull request Jun 10, 2024
* Link and compile against rosbag2_storage_mcap: Fixed issue 1492 (#1496) (#1498)

Signed-off-by: Alejandro Hernández Cordero <[email protected]>
(cherry picked from commit 7fcb703)

Co-authored-by: Alejandro Hernández Cordero <[email protected]>

* [humble] Bugfix for incorrect playback rate changes when pressing buttons (backport #1513) (#1515)

* Bugfix for incorrect playback rate changes when pressing buttons (#1513)

- Playback rate expected to be changed by 10% with each
increase/decrease step.
- Use +0.1 and -0.1 in decrease/increase rate formula instead of
multiply by factor of the 1.1 and 0.9 respectively.

Signed-off-by: Michael Orlov <[email protected]>
(cherry picked from commit 95f78b6)

# Conflicts:
#	rosbag2_transport/src/rosbag2_transport/player.cpp

* Address merge conflicts after auto-backporting

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* call cv.wait_until only if necessary. (#1521) (#1523)

* call cv.wait_until only if necessary.

Signed-off-by: Tomoya Fujita <[email protected]>

* add comment to avoid extra delay for performance.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit a16704b)

Co-authored-by: Tomoya Fujita <[email protected]>

* [humble] Install signal handlers in recorder only inside record method (backport #1464) (#1526)

* Install signal handlers in recorder only inside record method (#1464)

Signed-off-by: Michael Orlov <[email protected]>
(cherry picked from commit 195e406)

# Conflicts:
#	rosbag2_py/src/rosbag2_py/_transport.cpp

* Address merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* [humble] `Recording stopped` prints only once. (backport #1530) (#1535)

* `Recording stopped` prints only once. (#1530)

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 73b0772)

# Conflicts:
#	rosbag2_transport/src/rosbag2_transport/recorder.cpp

* Address merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* [humble] Give proper log message for `--start-paused` (backport #1537) (#1541)

* Add proper message for --start-paused (#1537)

Signed-off-by: Christoph Froehlich <[email protected]>
(cherry picked from commit 317286c)

# Conflicts:
#	rosbag2_transport/src/rosbag2_transport/recorder.cpp

* Address merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Christoph Fröhlich <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* 0.15.9 (#1551)

* 0.15.9

Signed-off-by: Audrow Nash <[email protected]>

* Update rosbag2_transport/CHANGELOG.rst

Co-authored-by: Michael Orlov <[email protected]>
Signed-off-by: Audrow Nash <[email protected]>

---------

Signed-off-by: Audrow Nash <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* [humble] Add default initialization for CompressionOptions (backport #1539) (#1546)

* Add default initialization for CompressionOptions (#1539)

* feat: add sane defaults for CompressionOptions

Signed-off-by: Arne Böckmann <[email protected]>

* Update rosbag2_compression/include/rosbag2_compression/compression_options.hpp

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Arne Böckmann <[email protected]>

---------

Signed-off-by: Arne Böckmann <[email protected]>
Co-authored-by: Arne Böckmann <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 931bf54)

# Conflicts:
#	rosbag2_compression/include/rosbag2_compression/compression_options.hpp

* Address merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Arne B <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* Fix/zstd vendor does not find system zstd (#1111) (#1560)

cmake did not find the Findzstd.cmake in cmake/Modules

Since we cannot use pkg-config for some Windows issues, the parsing of
the version is done by looking for the string in zstd.h.

Signed-off-by: Matthias Schoepfer <[email protected]>
(cherry picked from commit e7e7269)

Co-authored-by: DasRoteSkelett <[email protected]>

* [humble] Use rw_lock to protect mcap metadata lists. (backport #1561) (#1567)

* Use rw_lock to protect mcap metadata lists. (#1561)

* use rw_lock to protect mcap metadata lists.

Signed-off-by: Tomoya Fujita <[email protected]>

* introduce MCAPStorage::write_lock_free private method.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 90d1da8)

# Conflicts:
#	rosbag2_storage_mcap/src/mcap_storage.cpp

* Resolve merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* Add /bigobj to MSVC compiles. (#1571)

Signed-off-by: Chris Lalancette <[email protected]>

* Fix split by time. (backport #1022) (#1616)

Signed-off-by: Tomoya Fujita <[email protected]>

* [humble] Add BagSplitInfo service call on bag close (backport #1422) (#1637)

* Add BagSplitInfo service call on bag close (#1422)

- Note: The `BagSplitInfo::opened_file` will have empty string to
indicate that it was "bag close" and not bag split event.

Signed-off-by: Michael Orlov <[email protected]>
(cherry picked from commit ba199d0)

# Conflicts:
#	rosbag2_cpp/test/rosbag2_cpp/test_sequential_writer.cpp

* Fix merge conflicts

- Ensure that writer_ is destructed before intercepted fake_metadata_

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* [Humble] Resolve recording option problem (backport #1649) (#1651)

* Resolve recording option problem (#1649)

Signed-off-by: Barry Xu <[email protected]>
(cherry picked from commit 4914ab3)

# Conflicts:
#	ros2bag/ros2bag/verb/record.py

* Fix cherry-pick conflicts for mergify/bp/humble/pr-1649 (#1652)

Signed-off-by: Barry Xu <[email protected]>

---------

Signed-off-by: Barry Xu <[email protected]>
Co-authored-by: Barry Xu <[email protected]>

* [humble] Add --log-level to ros2 bag play and record (#1655)

* Add --log-level to ros2 bag play and record

Co-authored-by: Michael Orlov <[email protected]>
Signed-off-by: Roman Sokolkov <[email protected]>

* Fix missing import

Signed-off-by: Roman Sokolkov <[email protected]>

---------

Signed-off-by: Roman Sokolkov <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

* [humble] Bugfix for writer not being able to open again after closing (backport #1599) (#1653)

* [iron] Bugfix for writer not being able to open again after closing (backport #1599) (#1635)

* re-applies fixes from #1590 to rolling. Also removes new message definition in sequential writer test for multiple open operations. Also clears topic_names_to_message_definitions_ and handles message_definitions_s underlying container similarly. Lastly, also avoids reset of factory in the compression writer, adds unit test there too.

Signed-off-by: Yannick Schulz <[email protected]>
Signed-off-by: Michael Orlov <[email protected]>

* removes unused compressor_ member from compresser writer class. Also delegates rest of the closing behavior to the base class in close method, as it is handled in the open and write methods of the compression writer

Signed-off-by: Yannick Schulz <[email protected]>

* Remove unrelated delta

- message_definitions_ was intentionally allocated on the stack and
should persist between writer close() and open() because it represents
cache for message definitions which is not changes.

Signed-off-by: Michael Orlov <[email protected]>

* Don't call virtual methods from destructors

Signed-off-by: Michael Orlov <[email protected]>

* Cleanup 'rosbag2_directory_next' after the test run

Signed-off-by: Michael Orlov <[email protected]>

* Protect Writer::open(..) and Writer::close() with mutex on upper level

- Rationale: To avoid race conditions if open(..) and close() could be
ever be called from different threads.

Signed-off-by: Michael Orlov <[email protected]>

* Bugfix for WRITE_SPLIT callback not called for the last compressed file

Signed-off-by: Michael Orlov <[email protected]>

* Bugfix for lost messages from cache when closing compression writer

Signed-off-by: Michael Orlov <[email protected]>

* Address build failure by using rcpputils::fs instead of std::filesystem

- Note: On Iron we haven't migrated to the std::filesystem and using
rcpputils::fs

Signed-off-by: Michael Orlov <[email protected]>

* Adopt failing 'open_succeeds_twice' test for Iron

Signed-off-by: Michael Orlov <[email protected]>

* Return from writer's open() immediately if storage already open

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Yannick Schulz <[email protected]>
Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Yannick Schulz <[email protected]>
(cherry picked from commit a360d9b)

# Conflicts:
#	rosbag2_compression/src/rosbag2_compression/sequential_compression_writer.cpp
#	rosbag2_cpp/src/rosbag2_cpp/writer.cpp
#	rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

* Address merge conflicts

Signed-off-by: Michael Orlov <[email protected]>

* Fix for segfault in open_twice test

- Ensure that writer_ is destructed before intercepted fake_metadata_

Signed-off-by: Michael Orlov <[email protected]>

* Fix for "open_succeeds_twice" test failure on second run

- Use std::filesystem for temp files and folders operation. For some
reason rcpputils::fs::delete_all(folder_name) wasn't able to delete temp
folder with subfolders.

Signed-off-by: Michael Orlov <[email protected]>

* Adopt changes in TestRosbag2CPPAPI::minimal_writer_example for humble

- The `serialized_msg2` is not owning the serialized data after the
first call writer.write(serialized_msg2,..). i.e. need to use another
message or another API in test. This is not a bug - this is by design.

Signed-off-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>

---------

Signed-off-by: Michael Orlov <[email protected]>
Signed-off-by: Audrow Nash <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Barry Xu <[email protected]>
Signed-off-by: Roman Sokolkov <[email protected]>
Signed-off-by: Emerson Knapp <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Michael Orlov <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christoph Fröhlich <[email protected]>
Co-authored-by: Audrow Nash <[email protected]>
Co-authored-by: Arne B <[email protected]>
Co-authored-by: DasRoteSkelett <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
Co-authored-by: Barry Xu <[email protected]>
Co-authored-by: Roman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants