[#1911] Add bag concept

[elBoberido]

Notes for Reviewer

This PR adds a Bag concept in order to make the resource owner tracking pluggable.

Pre-Review Checklist for the PR Author

• Add sensible notes for the reviewer
• PR title is short, expressive and meaningful
• Consider switching the PR to a draft (Convert to draft)
  • as draft PR, the CI will be skipped for pushes
• Relevant issues are linked in the References section
• Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
• Commits messages are according to this guideline
  • Commit messages have the issue ID ([#123] Add posix ipc example)
  • Keep in mind to use the same email that was used to sign the Eclipse Contributor Agreement
• Tests follow the best practice for testing
• Changelog updated in the unreleased section including API breaking changes

PR Reviewer Reminders

• 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

References

Closes #1911

[elfenpiff]

Looks good - except the hardest part, the naming ;) .

[elfenpiff]

Should we rename the ContainerState to BagState?

[elBoberido]

I was also thinking about re-exporting all the types from iceoryx2-bb-lock-free in the iceoryx2-cal/bag namespace. Not sure about changing also the iceoryx2-bb-lock-free Container itself right now.

[elfenpiff]

Should we rename the ContainerHandle to BagHandle

[elfenpiff]

Could we rename this: Bag -> BagFamily and the BagAccess is Bag.

The thinking is, that a Bag is a thing that contains T and has the following interface and behavior. But with this is a Bag a trait that defines a type alias and BagAccess is the thing that contains T.

We already have this name scheme in place in iceoryx2. We have for instance a Pointer<T> trait: https://github.com/eclipse-iceoryx/iceoryx2/blob/main/iceoryx2-bb/elementary-traits/src/pointer.rs
and a PointerFamily trait: https://github.com/eclipse-iceoryx/iceoryx2/blob/main/iceoryx2-bb/elementary-traits/src/pointer_family.rs

This reads then in code naturally:

struct SomeThing<P: Pointer> {
  fuu: P<u64>
}

or when you need it more generic:

struct SomeThing<P: PointerFamily> {
  fuu: P::Pointer<u64>,
  bar: P::Pointer<i32>
}

I think I had some discussion with ?Jeff? and a LLM until come to this naming style.

[elBoberido]

Good point

[elfenpiff]

Could we rename all errors to BagAddFailure etc..

[elfenpiff]

This we could rename to Bag and technically T would be the BagType.

[elBoberido]

Just to prevent misunderstanding. This is your suggestion, right

pub trait BagFamily: Debug + 'static {
    type Bag<T: BagType>: Debug

[elfenpiff]

Correct!

[elBoberido]

@elfenpiff this is not nice. We either have to create a BagRemoveError enum and map the errors 1-1 to ContainerRemoveError or rename the error e.g. to HandleNotOwnedByContainer which is a bit less confusing. The former option would add some boilerplate. Alternatively, the Container itself could be renamed.

[elfenpiff]

What about HandleNotOwned, for me this would also be clear. Or HandleNotOwnedByInstance. What do you think?

[codecov]

Codecov Report

❌ Patch coverage is 99.06542% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.52%. Comparing base (933da04) to head (1c69862).
⚠️ Report is 31 commits behind head on main.

Files with missing lines	Patch %	Lines
...2-bb/lock-free/src/mpmc/robust_unique_index_set.rs	96.15%	1 Missing ⚠️
iceoryx2/src/service/dynamic_config/mod.rs	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1926      +/-   ##
==========================================
+ Coverage   76.37%   76.52%   +0.15%     
==========================================
  Files         457      453       -4     
  Lines       46145    46156      +11     
  Branches     1505     1489      -16     
==========================================
+ Hits        35241    35319      +78     
+ Misses       9857     9575     -282     
- Partials     1047     1262     +215     

Flag	Coverage Δ
CPP	62.61% <ø> (ø)
Rust	76.37% <99.06%> (+0.15%)	⬆️

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

Files with missing lines	Coverage Δ
...ceoryx2-bb/elementary-traits/src/zero_copy_send.rs	85.71% <ø> (ø)
iceoryx2-bb/lock-free/src/mpmc/container.rs	97.09% <100.00%> (+0.21%)	⬆️
iceoryx2-cal/src/bag/default_bag.rs	100.00% <100.00%> (ø)
iceoryx2/src/node/mod.rs	65.97% <100.00%> (ø)
iceoryx2/src/port/client.rs	92.99% <100.00%> (ø)
iceoryx2/src/port/listener.rs	90.47% <100.00%> (+0.15%)	⬆️
iceoryx2/src/port/notifier.rs	86.57% <100.00%> (-0.27%)	⬇️
iceoryx2/src/port/publisher.rs	92.32% <100.00%> (ø)
iceoryx2/src/port/reader.rs	87.55% <100.00%> (+0.10%)	⬆️
iceoryx2/src/port/server.rs	92.96% <100.00%> (ø)
... and 20 more

... and 56 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.