search

eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
448 stars 22 forks source link

[#173] cleanup event api #180

Closed elfenpiff closed 2 months ago

elfenpiff commented 2 months ago

Notes for Reviewer

Pre-Review Checklist for the PR Author

  1. [x] Add sensible notes for the reviewer
  2. [x] PR title is short, expressive and meaningful
  3. [x] Relevant issues are linked in the References section
  4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [x] Tests follow the best practice for testing
  8. [x] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [x] All open points are addressed and tracked via issues

References

Closes #173

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 91.56627% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 78.54%. Comparing base (aeb96a6) to head (d25b7df). Report is 1 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180/graphs/tree.svg?width=650&height=150&src=pr&token=FN3YFXTJCI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #180 +/- ## ========================================== + Coverage 78.33% 78.54% +0.20% ========================================== Files 181 181 Lines 19734 19837 +103 ========================================== + Hits 15458 15580 +122 + Misses 4276 4257 -19 ``` | [Files](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) | Coverage Δ | | |---|---|---| | [iceoryx2-bb/testing/src/watchdog.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-bb%2Ftesting%2Fsrc%2Fwatchdog.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvdGVzdGluZy9zcmMvd2F0Y2hkb2cucnM=) | `93.33% <100.00%> (ø)` | | | [iceoryx2-cal/src/event/common.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fevent%2Fcommon.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9ldmVudC9jb21tb24ucnM=) | `85.60% <100.00%> (+1.33%)` | :arrow_up: | | [iceoryx2-cal/src/event/id\_tracker/bit\_set.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fevent%2Fid_tracker%2Fbit_set.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9ldmVudC9pZF90cmFja2VyL2JpdF9zZXQucnM=) | `84.21% <100.00%> (ø)` | | | [iceoryx2/src/config.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fconfig.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL2NvbmZpZy5ycw==) | `65.17% <100.00%> (-0.59%)` | :arrow_down: | | [iceoryx2/src/port/notifier.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fport%2Fnotifier.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3BvcnQvbm90aWZpZXIucnM=) | `82.78% <100.00%> (+2.50%)` | :arrow_up: | | [iceoryx2/src/port/publisher.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fport%2Fpublisher.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3BvcnQvcHVibGlzaGVyLnJz) | `82.89% <ø> (ø)` | | | [iceoryx2/src/service/builder/event.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fservice%2Fbuilder%2Fevent.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3NlcnZpY2UvYnVpbGRlci9ldmVudC5ycw==) | `70.14% <100.00%> (+1.96%)` | :arrow_up: | | [iceoryx2-cal/src/event/mod.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fevent%2Fmod.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9ldmVudC9tb2QucnM=) | `44.44% <66.66%> (ø)` | | | [iceoryx2-cal/src/event/unix\_datagram\_socket.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fevent%2Funix_datagram_socket.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9ldmVudC91bml4X2RhdGFncmFtX3NvY2tldC5ycw==) | `82.94% <96.96%> (+3.80%)` | :arrow_up: | | [iceoryx2-cal/src/event/process\_local.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fevent%2Fprocess_local.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9ldmVudC9wcm9jZXNzX2xvY2FsLnJz) | `86.13% <91.66%> (+1.51%)` | :arrow_up: | | ... and [2 more](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/180/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)
elBoberido commented 2 months ago

Can you increase the watchdog timeout of the bitset_tests bit_set_concurrent_set_and_reset_works test to 100 seconds. It seems the performance in the debug builds on aarch64 is quite low and the test sometimes hits the 60 seconds limit.

Could you also add Corrupted to the list of expected creation errors in service_tests.rs. The main branch on Windows failed with that error code.

elfenpiff commented 2 months ago

Can you increase the watchdog timeout of the bitset_tests bit_set_concurrent_set_and_reset_works test to 100 seconds. It seems the performance in the debug builds on aarch64 is quite low and the test sometimes hits the 60 seconds limit.

Could you also add Corrupted to the list of expected creation errors in service_tests.rs. The main branch on Windows failed with that error code.

I doubled the watchdog timeout and increased the github CI timeout to 90 minutes since the main branch on windows hit that timeout. I did not add Corrupted since it was already listed in the errors - or maybe can you give me a pointer what and where exactly you would like to have?