[21136] Bugfix: Revert XML Flow controller names to `const char*` #4911

Mario-DL · 2024-06-07T07:25:50Z

Description

PR #4893 introduced an ABI break changing the flow controller descriptor names to std::string. This PR reverts that change and handles the flow controller names in a collection within XMLParser. It also defines a clear() method intended to clean the collection upon XMLProfileManager destruction.

Note I introduced a mutex but I dont think it is needed 100% since the XMLParser configuration may be something sequential, but I introduced it anyways.

Important A cherry pick of this PR should be merged in the following backports

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
Any new/modified methods have been properly documented using Doxygen.
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.
NO New feature has been added to the versions.md file (if applicable).
New feature has been documented/Current behavior is correctly described in the documentation.
- Related documentation PR: [21054] Make explicit the need to keep alive the flow controller descriptor name Fast-DDS-docs#806
NO (see PR description) 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.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

JesusPoderoso · 2024-06-07T07:30:50Z

@richiprosima please test this

src/cpp/rtps/xmlparser/XMLElementParser.cpp

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

src/cpp/rtps/xmlparser/XMLElementParser.cpp

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

MiguelCompany

LGTM with green CI

JesusPoderoso · 2024-06-07T09:50:35Z

@richiprosima please test this

EduPonz · 2024-06-08T05:47:36Z

@Mario-DL please remember to cherry-pick this onto the other backports

* Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL · 2024-06-10T10:46:36Z

Cherry picks added 👍🏻

* Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

) * Add XML configuration for FlowControllerDescriptor to 2.x (#4893) * Refs #21136: Replace const char* with string Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update fastRTPS_profiles.xsd Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Implement flow controller descriptor list in XML related source files Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update tests Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: versions.md Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Linter Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Apply rev Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> (cherry picked from commit e6044e0) # Conflicts: # include/fastdds/rtps/flowcontrol/FlowControllerDescriptor.hpp # resources/xsd/fastRTPS_profiles.xsd # test/unittest/dds/profiles/test_xml_profiles.xml # test/unittest/dds/profiles/test_xml_profiles_for_string.xml # test/unittest/xmlparser/XMLParserTests.cpp # test/unittest/xmlparser/XMLProfileParserTests.cpp # test/unittest/xmlparser/test_xml_profile.xml # test/unittest/xmlparser/test_xml_profile_env_var.xml # versions.md * Bugfix: Revert XML Flow controller names to `const char*` (#4911) * Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21244: Solve conflicts and remove threadsettings from flow_controller_descriptor Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> Co-authored-by: Mario Dominguez <mariodominguez@eprosima.com>

) * Add XML configuration for FlowControllerDescriptor to 2.x (#4893) * Refs #21136: Replace const char* with string Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update fastRTPS_profiles.xsd Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Implement flow controller descriptor list in XML related source files Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update tests Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: versions.md Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Linter Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Apply rev Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> (cherry picked from commit e6044e0) # Conflicts: # test/unittest/xmlparser/XMLProfileParserTests.cpp # versions.md * Bugfix: Revert XML Flow controller names to `const char*` (#4911) * Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21310: Fix building Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> Co-authored-by: Mario Dominguez <mariodominguez@eprosima.com>

) * Add XML configuration for FlowControllerDescriptor to 2.x (#4893) * Refs #21136: Replace const char* with string Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update fastRTPS_profiles.xsd Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Implement flow controller descriptor list in XML related source files Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update tests Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: versions.md Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Linter Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Apply rev Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> (cherry picked from commit e6044e0) * Bugfix: Revert XML Flow controller names to `const char*` (#4911) * Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21244: Solve conflicts and remove threadsettings from flow_controller_descriptor Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> Co-authored-by: Mario Dominguez <mariodominguez@eprosima.com>

* Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

) * Add XML configuration for FlowControllerDescriptor to 2.x (#4893) * Refs #21136: Replace const char* with string Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update fastRTPS_profiles.xsd Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Implement flow controller descriptor list in XML related source files Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Update tests Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: versions.md Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Linter Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21136: Apply rev Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Bugfix: Revert XML Flow controller names to `const char*` (#4911) * Refs #21054: Revert to const char* for flow controller names Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Handle flow controller names in a XMLParser collection Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply Miguel suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21054: Apply second suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Fix build after rebase. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Fix XSD schema. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Fix XML files. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Fix unit tests Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Fix xsd. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> Co-authored-by: Miguel Company <miguelcompany@eprosima.com>

Mario-DL added 2 commits June 7, 2024 09:08

Refs #21054: Revert to const char* for flow controller names

3494821

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Refs #21054: Handle flow controller names in a XMLParser collection

0b5b994

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL added this to the v2.14.2 milestone Jun 7, 2024

JesusPoderoso self-requested a review June 7, 2024 07:30

github-actions bot added the ci-pending PR which CI is running label Jun 7, 2024

MiguelCompany requested changes Jun 7, 2024

View reviewed changes

src/cpp/rtps/xmlparser/XMLElementParser.cpp Outdated Show resolved Hide resolved

Refs #21054: Apply Miguel suggestion

1c35ef6

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL force-pushed the bugfix/2.x/21054 branch from bc0df0d to 1c35ef6 Compare June 7, 2024 08:04

Mario-DL requested a review from MiguelCompany June 7, 2024 08:05

MiguelCompany requested changes Jun 7, 2024

View reviewed changes

src/cpp/rtps/xmlparser/XMLElementParser.cpp Outdated Show resolved Hide resolved

MiguelCompany changed the title ~~[21054] Bugfix: Revert XML Flow controller names to const char*~~ [21136] Bugfix: Revert XML Flow controller names to const char* Jun 7, 2024

Refs #21054: Apply second suggestion

07afc3b

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL requested a review from MiguelCompany June 7, 2024 08:46

MiguelCompany approved these changes Jun 7, 2024

View reviewed changes

EduPonz 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 Jun 8, 2024

EduPonz merged commit a1d4cd9 into 2.14.x Jun 8, 2024
13 of 16 checks passed

EduPonz deleted the bugfix/2.x/21054 branch June 8, 2024 05:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[21136] Bugfix: Revert XML Flow controller names to `const char*` #4911

[21136] Bugfix: Revert XML Flow controller names to `const char*` #4911

Mario-DL commented Jun 7, 2024 •

edited by EduPonz

Loading

JesusPoderoso commented Jun 7, 2024

MiguelCompany left a comment

JesusPoderoso commented Jun 7, 2024

EduPonz commented Jun 8, 2024

Mario-DL commented Jun 10, 2024

[21136] Bugfix: Revert XML Flow controller names to const char* #4911

[21136] Bugfix: Revert XML Flow controller names to const char* #4911

Conversation

Mario-DL commented Jun 7, 2024 • edited by EduPonz Loading

Description

Contributor Checklist

Reviewer Checklist

JesusPoderoso commented Jun 7, 2024

MiguelCompany left a comment

Choose a reason for hiding this comment

JesusPoderoso commented Jun 7, 2024

EduPonz commented Jun 8, 2024

Mario-DL commented Jun 10, 2024

[21136] Bugfix: Revert XML Flow controller names to `const char*` #4911

[21136] Bugfix: Revert XML Flow controller names to `const char*` #4911

Mario-DL commented Jun 7, 2024 •

edited by EduPonz

Loading