Skip to content
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

[21649] Correct iterator increment after erasing elements in connected_servers_list #5226

Merged
merged 2 commits into from
Sep 13, 2024

Conversation

LuciaEchevarria99
Copy link
Contributor

@LuciaEchevarria99 LuciaEchevarria99 commented Sep 12, 2024

Description

This PR addresses a critical issue with iterator handling in the loop that processes elements of connected_servers_. The original implementation encountered an assertion failure due to invalid iterator increments after removing elements from the container.

Comment for the reviewer:

  • Alternative approach to fix the problem: Given that the connected_servers_ list is expected to contain at most one element with the matching guidPrefix, another viable solution could be to use a break statement within the if (it->guidPrefix == pdata->m_guid.guidPrefix) condition. This would immediately exit the loop after finding and removing the element, eliminating the need to handle iterator invalidation explicitly.

@Mergifyio backport 2.14.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • NO: Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
    • The team decided internally to add regression test in a follow-up PR
  • N/A: Any new/modified methods have been properly documented using Doxygen.
  • N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • Changes are API compatible.
  • N/A: New feature has been added to the versions.md file (if applicable).
  • N/A: New feature has been documented/Current behavior is correctly described in the documentation.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • N/A: If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@github-actions github-actions bot added the ci-pending PR which CI is running label Sep 12, 2024
@JesusPoderoso JesusPoderoso changed the title [21649] BugFix: Correct iterator increment after erasing elements in connected_servers_ list [21649] Correct iterator increment after erasing elements in connected_servers_list Sep 12, 2024
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woohh! Nice catch!

Is it possible to have a regression test?

src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp Outdated Show resolved Hide resolved
src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp Outdated Show resolved Hide resolved
@LuciaEchevarria99 LuciaEchevarria99 requested review from richiware and removed request for richiware September 12, 2024 10:52
@Mario-DL
Copy link
Member

Mac failed test is a known issue, unrelated to this PR

@JesusPoderoso
Copy link
Contributor

@Mergifyio backport 2.14.x 2.10.x

Copy link
Contributor

mergify bot commented Sep 12, 2024

backport 2.14.x 2.10.x

✅ Backports have been created

@JesusPoderoso JesusPoderoso added ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. and removed ci-pending PR which CI is running labels Sep 13, 2024
@MiguelCompany MiguelCompany merged commit d4d8e54 into master Sep 13, 2024
16 of 17 checks passed
@MiguelCompany MiguelCompany deleted the bugfix/PDPClient_erase-connected_servers_ branch September 13, 2024 05:46
mergify bot pushed a commit that referenced this pull request Sep 13, 2024
…rs_list` (#5226)

* BugFix: Correct iterator increment after erasing elements in connected_servers_ list

Signed-off-by: Lucia Echevarria <[email protected]>

* Refs #21649. Apply suggested changes

Signed-off-by: Lucia Echevarria <[email protected]>

---------

Signed-off-by: Lucia Echevarria <[email protected]>
(cherry picked from commit d4d8e54)

# Conflicts:
#	src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp
mergify bot pushed a commit that referenced this pull request Sep 13, 2024
…rs_list` (#5226)

* BugFix: Correct iterator increment after erasing elements in connected_servers_ list

Signed-off-by: Lucia Echevarria <[email protected]>

* Refs #21649. Apply suggested changes

Signed-off-by: Lucia Echevarria <[email protected]>

---------

Signed-off-by: Lucia Echevarria <[email protected]>
(cherry picked from commit d4d8e54)

# Conflicts:
#	src/cpp/rtps/builtin/discovery/participant/PDPClient.cpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants