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

Iox #415 add event parameter to find service #1058

Conversation

FerdinandSpitzschnueffler
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler commented Jan 31, 2022

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Changelog updated in the unreleased section including API breaking changes
  4. Branch follows the naming format (iox-#123-this-is-a-branch)
  5. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  6. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. Relevant issues are linked
  8. Add sensible notes for the reviewer
  9. All checks have passed (except task-list-completed)
  10. Assign PR to reviewer

Notes for Reviewer

This PR adds an event parameter to the find service methods. The event search inside ServiceRegistry is probably not implemented in the most efficient way, but will be replaced soon when the prefix tree is integrated.

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
    • Each unit test case has a unique UUID
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@codecov
Copy link

codecov bot commented Jan 31, 2022

Codecov Report

Merging #1058 (973d973) into master (7290937) will decrease coverage by 0.03%.
The diff coverage is 46.42%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1058      +/-   ##
==========================================
- Coverage   76.23%   76.20%   -0.04%     
==========================================
  Files         343      343              
  Lines       12953    12971      +18     
  Branches     1863     1868       +5     
==========================================
+ Hits         9875     9884       +9     
- Misses       2463     2473      +10     
+ Partials      615      614       -1     
Flag Coverage Δ
unittests 75.42% <46.42%> (-0.05%) ⬇️
unittests_timing 12.57% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...clude/iceoryx_posh/internal/roudi/port_manager.hpp 100.00% <ø> (ø)
...de/iceoryx_posh/internal/roudi/process_manager.hpp 100.00% <ø> (ø)
...include/iceoryx_posh/runtime/service_discovery.hpp 0.00% <ø> (ø)
iceoryx_posh/source/roudi/port_manager.cpp 78.38% <0.00%> (ø)
iceoryx_posh/source/roudi/process_manager.cpp 57.26% <0.00%> (ø)
iceoryx_posh/source/roudi/roudi.cpp 56.31% <0.00%> (-1.41%) ⬇️
iceoryx_posh/source/runtime/service_discovery.cpp 0.00% <0.00%> (ø)
iceoryx_posh/source/roudi/service_registry.cpp 97.26% <100.00%> (+0.33%) ⬆️
iceoryx_hoofs/source/posix_wrapper/timer.cpp 63.48% <0.00%> (+0.41%) ⬆️

elfenpiff
elfenpiff previously approved these changes Feb 1, 2022
Copy link
Contributor

@elfenpiff elfenpiff left a comment

Choose a reason for hiding this comment

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

Could you please create an issue (or add to some existing issue) that we have to refactor the test_service_discovery.cpp. This is pretty hard to understand and not our standard - but also not part of this PR.

CHANGELOG.md Show resolved Hide resolved
{
cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> intersection;

ServiceDescriptionVector_t serviceInstanceResult;
// Find (K1, K2)
Copy link
Contributor

Choose a reason for hiding this comment

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

Now that event is added could we please remove those runtime big O notation comments.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would appreciate if we could update the big O notation comments instead of removing them. It's helpful for me if you look at the code after some time has passed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't check the O notation for correctness, but the branches where it's noted didn't change. Therefore, no updates needed now. Should be updated (or removed) when the prefix tree is integrated.

Copy link
Contributor

Choose a reason for hiding this comment

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

I will update this/remove as needed.

Copy link
Contributor

@mossmaurice mossmaurice left a comment

Choose a reason for hiding this comment

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

LGTM in general!

{
cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> intersection;

ServiceDescriptionVector_t serviceInstanceResult;
// Find (K1, K2)
Copy link
Contributor

Choose a reason for hiding this comment

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

I would appreciate if we could update the big O notation comments instead of removing them. It's helpful for me if you look at the code after some time has passed.

Signed-off-by: Marika Lehmann <marika.lehmann@apex.ai>
Signed-off-by: Marika Lehmann <marika.lehmann@apex.ai>
Signed-off-by: Marika Lehmann <marika.lehmann@apex.ai>
Signed-off-by: Marika Lehmann <marika.lehmann@apex.ai>
Copy link
Contributor

@MatthiasKillat MatthiasKillat left a comment

Choose a reason for hiding this comment

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

Klugscheißerman approves

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler merged commit c73695f into eclipse-iceoryx:master Feb 4, 2022
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler deleted the iox-#415-add-event-parameter-to-find-service branch February 4, 2022 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

service registry as a built-in topic
4 participants