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

[#96] decentral service artifact cleanup #97

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Jan 21, 2024

Notes for Reviewer

  • Cleaned up a technical debt, FilePath::path() and FilePath::file_name() are returning a Path or FileName and no longer a slice. Makes it easier to use since it prevents either addition checks or unsafe sections. In some files, those unsafe sections were removed.
  • Introduces process_state.rs in posix, a basic building block to enable process monitoring. When this is merged, a concept in iceoryx2_cal called Monitor will be introduced that will use this and provides a safe user API.

Pre-Review Checklist for the PR Author

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

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Use either 'Closes #123' or 'Relates to #123' to reference the corresponding issue.

Relates to #96

@elfenpiff elfenpiff requested a review from elBoberido January 21, 2024 15:53
@elfenpiff elfenpiff self-assigned this Jan 21, 2024
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch from bda2b3e to c10f2fe Compare January 21, 2024 15:53
Copy link

codecov bot commented Jan 21, 2024

Codecov Report

Attention: 147 lines in your changes are missing coverage. Please review.

Comparison is base (cd4211a) 77.94% compared to head (a3bd5b3) 77.64%.
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #97      +/-   ##
==========================================
- Coverage   77.94%   77.64%   -0.31%     
==========================================
  Files         177      178       +1     
  Lines       18881    19222     +341     
==========================================
+ Hits        14716    14924     +208     
- Misses       4165     4298     +133     
Files Coverage Δ
iceoryx2-bb/posix/src/config.rs 3.75% <ø> (ø)
iceoryx2-bb/system-types/src/file_name.rs 69.56% <100.00%> (+13.04%) ⬆️
iceoryx2-bb/system-types/src/file_path.rs 84.81% <100.00%> (-0.38%) ⬇️
iceoryx2-bb/system-types/src/group_name.rs 100.00% <100.00%> (+18.75%) ⬆️
iceoryx2-bb/system-types/src/user_name.rs 100.00% <100.00%> (+18.75%) ⬆️
...yx2-cal/src/communication_channel/message_queue.rs 78.70% <100.00%> (-0.23%) ⬇️
iceoryx2-cal/src/communication_channel/mod.rs 53.84% <ø> (ø)
iceoryx2-cal/src/dynamic_storage/mod.rs 100.00% <ø> (ø)
...yx2-cal/src/dynamic_storage/posix_shared_memory.rs 93.29% <100.00%> (-0.07%) ⬇️
iceoryx2-cal/src/event/mod.rs 26.31% <ø> (ø)
... and 11 more

... and 3 files with indirect coverage changes

@elfenpiff elfenpiff changed the title Iox2 96 decentral service artifact cleanup [#96] decentral service artifact cleanup Jan 21, 2024
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch 2 times, most recently from 99a6498 to e0f7fbb Compare January 30, 2024 21:04
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

The process_state.rs and its tests are something for tomorrow

iceoryx2-bb/system-types/src/path.rs Outdated Show resolved Hide resolved
iceoryx2-bb/system-types/src/file_path.rs Outdated Show resolved Hide resolved
iceoryx2-bb/system-types/src/file_path.rs Outdated Show resolved Hide resolved
iceoryx2-bb/container/src/semantic_string.rs Show resolved Hide resolved
iceoryx2-bb/container/src/semantic_string.rs Show resolved Hide resolved
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch 2 times, most recently from 4cef9f5 to ca74aea Compare January 30, 2024 22:40
@elfenpiff elfenpiff requested a review from elBoberido February 1, 2024 07:41
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

I need to create a sequence diagram with all the things that could happen during a race between the application and the monitoring process. I somehow have the feeling that it is quite racy and especially when you start multiple applications at once, including the monitoring application, this could lead to unexpected results.

iceoryx2-bb/system-types/src/path.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Show resolved Hide resolved
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch from 2fcf864 to e2b7434 Compare February 3, 2024 00:35
@elfenpiff elfenpiff requested a review from elBoberido February 3, 2024 00:41
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch 2 times, most recently from 2603e18 to fb82e10 Compare February 3, 2024 13:12
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

An interim review. Need to finish process_state_tests.rs

iceoryx2-bb/system-types/src/path.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/file.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/file.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Show resolved Hide resolved
iceoryx2-bb/posix/src/process_state.rs Show resolved Hide resolved
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

Tests look good.

I'm just not sure if the terminology for the file names should be changed to something more generic than .cleaner, e.g. .owner_lock. It acts more or less as the lock file in iceoryx1.

Nothing to block this PR but something to think about.

iceoryx2-bb/posix/tests/process_state_tests.rs Outdated Show resolved Hide resolved
iceoryx2-bb/posix/tests/process_state_tests.rs Outdated Show resolved Hide resolved
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch from fb82e10 to 28a3fc5 Compare February 8, 2024 00:30
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch from 20009e7 to f599d17 Compare February 8, 2024 01:25
@elfenpiff elfenpiff requested a review from elBoberido February 8, 2024 01:25
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch 2 times, most recently from 4982a41 to 24e29e7 Compare February 8, 2024 02:20
…, Guard and their interactions; code readability
@elfenpiff elfenpiff force-pushed the iox2-96-decentral-service-artifact-cleanup branch from 24e29e7 to a3bd5b3 Compare February 8, 2024 02:29
@elfenpiff elfenpiff merged commit 4c39e70 into eclipse-iceoryx:main Feb 8, 2024
20 of 23 checks passed
@elfenpiff elfenpiff deleted the iox2-96-decentral-service-artifact-cleanup branch February 8, 2024 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants