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

[21751] Discard changes with big key-only payload and no key hash (backport #5262) #5276

Merged
merged 3 commits into from
Oct 4, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 27, 2024

Description

We currently don't have support for key-only payloads bigger than the KEY_HASH length.
Receiving such kind of messages produces a segfault in DataReaderHistory.

This PR adds a regression test reproducing the issue, and fixes it by considering the incoming change as irrelevant.
It has been done this way so it is acknowledged in reliable topics, thus avoiding the offending data to be resent.

@Mergifyio backport 2.14.x 2.10.x

@Mergifyio backport 2.6.x

Contributor Checklist

  • Commit messages follow the project guidelines.

  • The code follows the style guidelines of this project.

  • 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

  • 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.
  • 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.

This is an automatic backport of pull request #5262 done by [Mergify](https://mergify.com).

* Refs #21707. Regression test.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Test both best_effort and reliable.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Fix by considering offending change as irrelevant.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Refactor code in MessageReceiver.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Avoid overriding instanceHandle.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21707. Add TODO so we don't forget to correctly process key-only payloads in the future.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document and improve code in `change_is_relevant_for_filter`.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Document else.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21751. Added static assertions for structure sizes.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 175add5)

# Conflicts:
#	src/cpp/rtps/messages/MessageReceiver.cpp
#	test/blackbox/common/BlackboxTestsTransportUDP.cpp
@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Sep 27, 2024
Copy link
Contributor Author

mergify bot commented Sep 27, 2024

Cherry-pick of 175add5 has failed:

On branch mergify/bp/2.6.x/pr-5262
Your branch is up to date with 'origin/2.6.x'.

You are currently cherry-picking commit 175add5c2.
  (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:   src/cpp/rtps/reader/reader_utils.cpp

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   src/cpp/rtps/messages/MessageReceiver.cpp
	both modified:   test/blackbox/common/BlackboxTestsTransportUDP.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

@Mario-DL
Copy link
Member

Mario-DL commented Oct 3, 2024

@MiguelCompany would you mind addressing the conflicts here ?

Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany removed the conflicts Backport PR wich git cherry pick failed label Oct 3, 2024
@github-actions github-actions bot added the ci-pending PR which CI is running label Oct 3, 2024
Signed-off-by: Mario Dominguez <[email protected]>
@Mario-DL Mario-DL requested review from Mario-DL and removed request for Mario-DL October 3, 2024 15:08
Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

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

LGTM, failed tests unrelated with the fix

@Mario-DL Mario-DL 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 Oct 4, 2024
@MiguelCompany MiguelCompany merged commit cf3f810 into 2.6.x Oct 4, 2024
15 of 17 checks passed
@MiguelCompany MiguelCompany deleted the mergify/bp/2.6.x/pr-5262 branch October 4, 2024 09:43
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.

2 participants