Use std::shared_ptr for gz::transport::NodeShared
#484
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Addisu Z. Taddese <[email protected]>
Currently, `NodeShared` is never destroyed once it's created. This makes it hard for writing tests that do not interfere with each other. This patch uses a reference counted smart pointer (`std::shared_ptr`) to keep track of `NodeShared` instances, so that it gets properly destroyed when when all `Node` instances, which themselves contain `NodeShared` instances are destroyed. Signed-off-by: Addisu Z. Taddese <[email protected]>
`Node::Shared` is a private function but it's used in `details/Node.hh` in templates which means there could be calls to `Node::Shared` embedded in other libraries. Since we're mainly tracking the number of `Node` instances, and since `Node::Shared` is private, it's okay to use raw pointers internal use. Signed-off-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## gz-transport13 #484 +/- ##
==================================================
+ Coverage 87.69% 87.85% +0.16%
==================================================
Files 59 59
Lines 5704 5708 +4
==================================================
+ Hits 5002 5015 +13
+ Misses 702 693 -9 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]>
ahcorde
approved these changes
Mar 21, 2024
caguero
approved these changes
Mar 21, 2024
8 tasks
azeey
added a commit
to azeey/gz-transport
that referenced
this pull request
Apr 1, 2024
…sim#484)" This reverts commit 42e4210. Signed-off-by: Addisu Z. Taddese <[email protected]>
azeey
added a commit
that referenced
this pull request
Apr 2, 2024
This reverts commit 42e4210. Signed-off-by: Addisu Z. Taddese <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🦟 Bug fix
Summary
Currently,
NodeSharedis never destroyed once it's created. This makesit hard for writing tests that do not interfere with each other. This
patch uses a reference counted smart pointer (
std::shared_ptr) to keeptrack of
NodeSharedinstances, so that it gets properly destroyed whenwhen all
Nodeinstances, which themselves containNodeSharedinstances are destroyed.
This was brought up in gazebosim/gz-sim#2334. The
INTEGRATION_triggered_publishertest fails reliably in my local tests without this gz-transport PR.TODO: This is probably not threadsafe. It's possible to lock a mutex before checking the weak_ptr, but that would make the call toNodeSHared::Instanceslower than the previous implementation since it was usingstd::shared_mutex.Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.