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.

Sign up for GitHub

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

Jump to bottom

[21054] Add XML configuration for FlowControllerDescriptor and remove ThroughputController #4837

Merged
merged 19 commits into from
May 31, 2024
Merged

[21054] Add XML configuration for FlowControllerDescriptor and remove ThroughputController #4837

merged 19 commits into from
May 31, 2024

Conversation

Mario-DL
Copy link
Member

@Mario-DL Mario-DL commented May 23, 2024 •
edited by JesusPoderoso
Loading

Description

This PR removes the deprecated ThroughtputController and ThroughtputController in favor of the flow_controller_descriptor_list and its XML configuration.

Note: In the refactor I doubted how to proceed with the PDP writer modes. Will be discussed with the reviewer

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

@Mario-DL Mario-DL added the doc-pending Issue or PR which is pending to be documented label May 23, 2024
@Mario-DL Mario-DL added this to the v3.0.0 milestone May 23, 2024
@github-actions github-actions bot added the ci-pending PR which CI is running label May 23, 2024
JesusPoderoso

This comment was marked as resolved.

Sign in to view

@Mario-DL Mario-DL force-pushed the feature/21054 branch 2 times, most recently from b329da8 to 5989df4 Compare May 24, 2024 09:18
@Mario-DL Mario-DL requested review from JesusPoderoso and removed request for JesusPoderoso May 24, 2024 09:24
@Mario-DL Mario-DL mentioned this pull request May 24, 2024
Merged
7 tasks
@Mario-DL Mario-DL requested review from JesusPoderoso and removed request for JesusPoderoso May 24, 2024 11:10
@Mario-DL
Refs #21054: Remove ThroughputController* references from project src…
5f1a70c 
…/cpp files (except xmlparser)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Refactor flow_controller names to be std::string
55f677b 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Add flow_controller_descriptor_list to XSD
ae6edd7 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Update XML related source files to the new flow_controll…
0ab07ce 
…er_descriptor_list

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Update unittests
1ac84ec 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Update BlackBox tests
52d4933 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Update FlowControllerExample
313ddad 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Linter
093598a 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Apply partial rev suggestions
b77fc6f 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Remove ThroughputControllerDescriptor.cpp from test source
7176e62 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Set flow_controller_name as optional in .xsd
77a1e2a 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: fix windows unittests
c1f1ce9 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Minor corrections
a4601d7 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Update versions.md
8f19f03 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL Mario-DL requested review from JesusPoderoso and removed request for JesusPoderoso May 27, 2024 06:09
JesusPoderoso
JesusPoderoso previously approved these changes May 27, 2024
View reviewed changes
Copy link
Contributor

@JesusPoderoso JesusPoderoso left a comment

Choose a reason for hiding this comment

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

LGTM with green CI

@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 May 27, 2024
@JesusPoderoso
Copy link
Contributor

@richiprosima please test_3 this

EduPonz
EduPonz requested changes May 28, 2024
View reviewed changes
Copy link
Member

@EduPonz EduPonz left a comment

Choose a reason for hiding this comment

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

I'd like to request two things here:

  • Unit testing for getXMLFlowControllerDescriptorList. It is important to verify the min and max occurrences of the elements. I think right now it'd be possible to add several names to the same descriptor.
  • On the XML snippets, add the thread settings element, Also, in some of them, the scheduling policy is missing. This applies to the Fast DDS docs related PR as well

@EduPonz EduPonz added to-do and removed ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. labels May 28, 2024
@Mario-DL
Refs #21054: Add scheduling policy and thread setting tags to existin…
543d92d 
…g XML flow controller snippets

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL
Refs #21054: Add missing getXMLFlowControllerDescriptorList() unittes…
3041e58 
…ting

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL Mario-DL added ci-pending PR which CI is running and removed to-do labels May 28, 2024
@Mario-DL Mario-DL requested a review from EduPonz May 28, 2024 13:43
@Mario-DL
Refs #21054: Linter
d838ee6 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL Mario-DL requested review from EduPonz and removed request for EduPonz May 28, 2024 14:21
@Mario-DL
Refs #21054: Add checks for repeated tags and test
b54cd25 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL Mario-DL requested review from EduPonz and removed request for EduPonz May 30, 2024 08:13
@EduPonz EduPonz merged commit 15ffc4b into master May 31, 2024
9 of 10 checks passed
@EduPonz EduPonz deleted the feature/21054 branch May 31, 2024 10:42
@Mario-DL Mario-DL mentioned this pull request Jun 5, 2024
Merged
14 tasks
This was referenced Jun 6, 2024
Merged
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EduPonz EduPonz EduPonz approved these changes

@JesusPoderoso JesusPoderoso JesusPoderoso left review comments

Assignees
No one assigned
Labels
ci-pending PR which CI is running
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Mario-DL @JesusPoderoso @EduPonz