[20823] Example refactor: Content filter #4859

elianalf · 2024-05-28T07:19:31Z

Description

This PR is part of a suite of PR which would make a refactor in the repository examples.
It is intended to apply to most of the examples, by making them homogeneous, more understandable, and more specific to the case they were meant to be.
In this content filter example, the main changes are:

Add customizable lower-bound and upper-bound options of the filter as arguments. In case of Custom filter, they represent the maximum and minimum values of the message indexes that are filtered-out through the filter. In case of Default filter they represent the maximum and minimum value message indexes that are read.
Add option filter Default, Custom or None

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.
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.
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.
N/A 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

Good job ! really nice example refactor.
Apart from the suggestions, we would need to update the README.md of the example and pass uncrustify

examples/cpp/content_filter/main.cpp

examples/cpp/content_filter/CLIParser.hpp

examples/cpp/content_filter/CMakeLists.txt

examples/cpp/content_filter/HelloWorld.hpp

test/examples/test_examples.py

Mario-DL · 2024-06-04T15:05:49Z

Also, we would need to update versions.md

Mario-DL

I think we are getting there ! Leaving some comments.
In addition

We would also take the chance for renaming MyCustomFitler to CustomContentFilter or something like that as well as the factory.
We will need to rebase master and split the test case

examples/cpp/content_filter/Application.hpp

examples/cpp/content_filter/CLIParser.hpp

examples/cpp/content_filter/SubscriberApp.cpp

examples/cpp/content_filter/README.md

examples/cpp/content_filter/SubscriberApp.cpp

test/examples/test_examples.py

Mario-DL

Just one suggestion !
Also, please, put the static cast in CLIParser.hpp(230,54): warning C4244: '=': conversion from 'int' to 'uint16_t' to prevent windows from complaining

examples/cpp/content_filter/CLIParser.hpp

Mario-DL

LGTM with green CI !
Gj @elianalf

… the example Signed-off-by: elianalf <[email protected]>

Signed-off-by: elianalf <[email protected]>

…for writer side filtering Signed-off-by: elianalf <[email protected]>

Signed-off-by: elianalf <[email protected]>

…to allowing the writer side filtering Signed-off-by: elianalf <[email protected]>

Signed-off-by: elianalf <[email protected]>

elianalf · 2024-06-17T05:41:59Z

CI passed at the previous commit. The last commit only add the license comment.

Signed-off-by: elianalf <[email protected]>

Mario-DL

LGTM ! Latest commit only adding licenses, ci was green

elianalf added this to the v3.0.0 milestone May 28, 2024

elianalf added the needs-review PR that is ready to be reviewed label May 30, 2024

elianalf force-pushed the feature/example_refactor/content_filtering branch 2 times, most recently from 8bdb05a to 29d638f Compare May 31, 2024 07:14

Mario-DL requested changes Jun 4, 2024

View reviewed changes

Mario-DL removed the needs-review PR that is ready to be reviewed label Jun 4, 2024

elianalf force-pushed the feature/example_refactor/content_filtering branch 4 times, most recently from 30cb7ac to 558593c Compare June 5, 2024 15:10

JesusPoderoso mentioned this pull request Jun 10, 2024

Bugfix: LifespanQoSExample Using the api incorrectly #4912

Closed

15 tasks

elianalf force-pushed the feature/example_refactor/content_filtering branch 2 times, most recently from 35872ef to 0b0f246 Compare June 10, 2024 07:25

elianalf requested a review from Mario-DL June 10, 2024 07:26

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

Mario-DL requested changes Jun 10, 2024

View reviewed changes

elianalf force-pushed the feature/example_refactor/content_filtering branch 6 times, most recently from 4c91c10 to 76f132b Compare June 12, 2024 05:22

elianalf requested a review from Mario-DL June 12, 2024 05:24

Mario-DL requested changes Jun 12, 2024

View reviewed changes

examples/cpp/content_filter/CLIParser.hpp Show resolved Hide resolved

elianalf requested a review from Mario-DL June 12, 2024 13:05

Mario-DL previously approved these changes Jun 12, 2024

View reviewed changes

elianalf dismissed Mario-DL’s stale review via 35c7314 June 12, 2024 14:45

elianalf requested a review from Mario-DL June 12, 2024 14:45

Mario-DL approved these changes Jun 13, 2024

View reviewed changes

elianalf added 20 commits June 14, 2024 13:55

Refs #20823 Add customizable lower bound and upper bound arguments to…

6ab1e13

… the example Signed-off-by: elianalf <[email protected]>

Refs #20823: Add changes to version.md

df118d1

Signed-off-by: elianalf <[email protected]>

Refs #20823: Initialize interval in publisher

52a5059

Signed-off-by: elianalf <[email protected]>

Refs #20823: Apply suggestion

8147cd7

Signed-off-by: elianalf <[email protected]>

Refs #20823: Apply suggestion: Update Readme.md

cbcfebc

Signed-off-by: elianalf <[email protected]>

Refs #20823: Add option none filter

37f55b9

Signed-off-by: elianalf <[email protected]>

Refs #20823: Set datareader and datawriter qos to meet the condition …

07a03a5

…for writer side filtering Signed-off-by: elianalf <[email protected]>

Refs #20823: Apply suggestions: Add filtering on the writer side

386711d

Signed-off-by: elianalf <[email protected]>

Refs #20823: Uncrustify

96c9974

Signed-off-by: elianalf <[email protected]>

Refs #20823: Change guard name and custom filter classes name

db4bab5

Signed-off-by: elianalf <[email protected]>

Refs #20823 Apply suggestions

f7bdff4

Signed-off-by: elianalf <[email protected]>

Refs #20823: Update ReadMe

60e37dc

Signed-off-by: elianalf <[email protected]>

Refs #20823: Add new arguments to set a custom filter expression and …

45259f1

…to allowing the writer side filtering Signed-off-by: elianalf <[email protected]>

Refs #20823: add transient and ralible as arguments

6d85676

Signed-off-by: elianalf <[email protected]>

Refs #20823: Split and modify test

ba9928f

Signed-off-by: elianalf <[email protected]>

Refs #20823: uncrustify

77b52f0

Signed-off-by: elianalf <[email protected]>

Refs #20823: Solve windows warning

5d9028b

Signed-off-by: elianalf <[email protected]>

Refs #20823: Remove argument --reliable --transient-local

8a4411b

Signed-off-by: elianalf <[email protected]>

Refs #20823: Add the right includes

0e6a0e5

Signed-off-by: elianalf <[email protected]>

Refs #20823: Remove folders that were added during the rebase

62dd37e

Signed-off-by: elianalf <[email protected]>

elianalf force-pushed the feature/example_refactor/content_filtering branch from da99050 to 62dd37e Compare June 14, 2024 11:56

elianalf requested a review from Mario-DL June 14, 2024 11:56

Refs #20823: Add license

4dac17a

Signed-off-by: elianalf <[email protected]>

elianalf force-pushed the feature/example_refactor/content_filtering branch from 66de49c to 4dac17a Compare June 17, 2024 05:46

Mario-DL approved these changes Jun 17, 2024

View reviewed changes

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 Jun 17, 2024

EduPonz merged commit 984405b into master Jun 17, 2024
2 of 3 checks passed

EduPonz deleted the feature/example_refactor/content_filtering branch June 17, 2024 06:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[20823] Example refactor: Content filter #4859

[20823] Example refactor: Content filter #4859

elianalf commented May 28, 2024 •

edited by Mario-DL

Loading

Mario-DL left a comment

Mario-DL commented Jun 4, 2024

Mario-DL left a comment •

edited

Loading

Mario-DL left a comment

Mario-DL left a comment

elianalf commented Jun 17, 2024

Mario-DL left a comment

[20823] Example refactor: Content filter #4859

[20823] Example refactor: Content filter #4859

Conversation

elianalf commented May 28, 2024 • edited by Mario-DL Loading

Description

Contributor Checklist

Reviewer Checklist

Mario-DL left a comment

Choose a reason for hiding this comment

Mario-DL commented Jun 4, 2024

Mario-DL left a comment • edited Loading

Choose a reason for hiding this comment

Mario-DL left a comment

Choose a reason for hiding this comment

Mario-DL left a comment

Choose a reason for hiding this comment

elianalf commented Jun 17, 2024

Mario-DL left a comment

Choose a reason for hiding this comment

elianalf commented May 28, 2024 •

edited by Mario-DL

Loading

Mario-DL left a comment •

edited

Loading