[#18] Adds formatting for services and an additional example #44

hydroid7 · 2023-12-15T09:03:52Z

Notes for Reviewer

Here is the pull request with fixed branch name and better formatting.

Pre-Review Checklist for the PR Author

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

All open points are addressed and tracked via issues

References

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

Closes #29

elfenpiff

Thank you very much for the contribution 😄

Could you please adjust the commit messages and add [#29] as prefix to every commit message.
You can do this by calling git rebase -i HEAD~3, set the commit in editor from pick to edit, adjust the comment with git commit --amend and then call git rebase --continue.

This you can then push with git push -f.

When this is done and the comments are addressed we can merge this thing.

And welcome to the team, you are our first external contributor!

examples/examples/pretty_print.rs

elfenpiff

Looks good. Could you please also add the Display implementation to the port factory of the publish subscribe messaging pattern in src/service/port_factory/publish_subscribe.rs.

elfenpiff · 2023-12-16T23:55:23Z

iceoryx2/src/service/port_factory/event.rs

@@ -127,3 +130,53 @@ impl<'config, Service: service::Details<'config>> PortFactory<'config, Service>
        PortFactoryListener { factory: self }
    }
 }
+
+impl<'config> fmt::Display for PortFactory<'config, zero_copy::Service<'config>> {


I think it would be better to introduce the second generic parameter here: Service: service::Details<'config> and then replace the line f.debug_struct("zero_copy::Service") (136) with

f.debug_struct(format!("{}", core::any::type_name::<Service>()))

With this we reduce the code duplication and when we introduce another service variant we do not have to add here a third version (which may is even forgotten).

@hydroid7 What do you think?

Oh, core::any::type_name is a game changer here! 🎉

elfenpiff · 2023-12-16T23:56:12Z

iceoryx2/src/service/port_factory/event.rs

+    }
+}
+
+impl<'config> fmt::Display for PortFactory<'config, process_local::Service<'config>> {


@hydroid7 If you follow my suggestion from above we can remove this here.

elfenpiff · 2023-12-17T00:08:15Z

@hydroid7 could you please also add this into the doc/release-notes/iceoryx2-unreleased.md release documentation under the features section.

The entry would look somehow like this:

* Add `Display` implementation for `PortFactory` [#29](https://github.com/eclipse-iceoryx/iceoryx2/issues/29)

codecov · 2023-12-17T00:10:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (26d979e) 77.97% compared to head (83cb2eb) 78.14%.
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #44      +/-   ##
==========================================
+ Coverage   77.97%   78.14%   +0.16%     
==========================================
  Files         172      172              
  Lines       18729    18803      +74     
==========================================
+ Hits        14604    14693      +89     
+ Misses       4125     4110      -15

Files	Coverage Δ
iceoryx2/src/service/port_factory/event.rs	`98.21% <100.00%> (+14.21%)`	⬆️
...ryx2/src/service/port_factory/publish_subscribe.rs	`100.00% <100.00%> (+10.00%)`	⬆️

... and 3 files with indirect coverage changes

elBoberido · 2023-12-18T23:19:39Z

I did not review the patch but please don't forget why this is done. We want to replace the custom printing code in these to locations

Pleas change those examples to just use println!("{}", pubsub); and println!("{}", event);

Oh, and the PR and commit messages use the wrong issue number. It's actually #18. #29 was the previous PR.

hydroid7 · 2023-12-19T08:59:19Z

Thank you all for the constructive comments, I rewrote the commit messages, added the feature to the releasenotes, changed the documentation in order to reflect the new Display implementation and added the same for pubsub services.

elBoberido

Only had a look at the release notes. I'll leave the actual code to @elfenpiff

elBoberido · 2023-12-19T15:45:01Z

doc/release-notes/iceoryx2-unreleased.md

@@ -6,7 +6,7 @@

 ### Features

- * Example [#1](https://github.com/larry-robotics/iceoryx2/issues/1)
+ * Add `Display` implementation for `PortFactory` [#29](https://github.com/eclipse-iceoryx/iceoryx2/issues/18)


Suggested change

* Add `Display` implementation for `PortFactory` [#29](https://github.com/eclipse-iceoryx/iceoryx2/issues/18)

* Add `Display` implementation for `PortFactory` [#18](https://github.com/eclipse-iceoryx/iceoryx2/issues/18)

elfenpiff

Looks good, as soon as the issue number in the release notes is corrected we can merge this.

hydroid7 · 2023-12-26T16:18:22Z

Sorry that these took that long, but here they are.

Background for my contributions is that I'm writing a DDS middleware / message broker as my MSc Thesis.
Therefore I was first looking at iceoryx, but it was rather hard to use for someone without extensive knowledge in the project.

elBoberido

Please add [#18] here, similar to the other PR.

elBoberido · 2023-12-30T14:44:15Z

@hydroid7 you need to fix the clippy warnings to make the CI happy

elBoberido · 2024-05-27T21:43:20Z

@hydroid7 do you plan to finish this PR in the near future?

hydroid7 changed the title ~~Adds formatting for services and an additional example~~ [#29] Adds formatting for services and an additional example Dec 15, 2023

elfenpiff requested changes Dec 15, 2023

View reviewed changes

examples/examples/pretty_print.rs Outdated Show resolved Hide resolved

hydroid7 force-pushed the iox2-29-pretty-print-service branch from daa648a to 4f2f242 Compare December 16, 2023 20:32

hydroid7 marked this pull request as ready for review December 16, 2023 21:01

elfenpiff reviewed Dec 16, 2023

View reviewed changes

elBoberido assigned hydroid7 Dec 18, 2023

hydroid7 changed the title ~~[#29] Adds formatting for services and an additional example~~ [#18] Adds formatting for services and an additional example Dec 19, 2023

hydroid7 added 6 commits December 19, 2023 09:56

[eclipse-iceoryx#18] Adds formatting.

57ecbe6

[eclipse-iceoryx#18] Removes unused import from example.

36d75c9

[eclipse-iceoryx#18] Improves formatting.

fef92b9

[eclipse-iceoryx#18] simplifies formatting with generics

8433eeb

[eclipse-iceoryx#18] add Display to pubsub service

0d970cf

[eclipse-iceoryx#18] updates releasenotes with the feature

dafac37

hydroid7 force-pushed the iox2-29-pretty-print-service branch from 4f38d29 to dafac37 Compare December 19, 2023 08:57

[eclipse-iceoryx#18] formats code again

7d4a503

elBoberido reviewed Dec 19, 2023

View reviewed changes

elfenpiff reviewed Dec 19, 2023

View reviewed changes

elBoberido reviewed Dec 27, 2023

View reviewed changes

[eclipse-iceoryx#18] Fix releasenote comment

b7f49c1

hydroid7 force-pushed the iox2-29-pretty-print-service branch from 3f57c5c to b7f49c1 Compare December 28, 2023 19:46

Merge branch 'main' into iox2-29-pretty-print-service

83cb2eb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#18] Adds formatting for services and an additional example #44

[#18] Adds formatting for services and an additional example #44

hydroid7 commented Dec 15, 2023 •

edited

Loading

elfenpiff left a comment •

edited

Loading

elfenpiff left a comment

elfenpiff Dec 16, 2023

hydroid7 Dec 19, 2023

elfenpiff Dec 16, 2023

elfenpiff commented Dec 17, 2023

codecov bot commented Dec 17, 2023 •

edited

Loading

elBoberido commented Dec 18, 2023

hydroid7 commented Dec 19, 2023

elBoberido left a comment

elBoberido Dec 19, 2023

elfenpiff left a comment

hydroid7 commented Dec 26, 2023

elBoberido left a comment

elBoberido commented Dec 30, 2023

elBoberido commented May 27, 2024

	* Add `Display` implementation for `PortFactory` [#29](https://github.com/eclipse-iceoryx/iceoryx2/issues/18)
	* Add `Display` implementation for `PortFactory` [#18](https://github.com/eclipse-iceoryx/iceoryx2/issues/18)

[#18] Adds formatting for services and an additional example #44

Are you sure you want to change the base?

[#18] Adds formatting for services and an additional example #44

Conversation

hydroid7 commented Dec 15, 2023 • edited Loading

Notes for Reviewer

Pre-Review Checklist for the PR Author

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

References

elfenpiff left a comment • edited Loading

Choose a reason for hiding this comment

elfenpiff left a comment

Choose a reason for hiding this comment

elfenpiff Dec 16, 2023

Choose a reason for hiding this comment

hydroid7 Dec 19, 2023

Choose a reason for hiding this comment

elfenpiff Dec 16, 2023

Choose a reason for hiding this comment

elfenpiff commented Dec 17, 2023

codecov bot commented Dec 17, 2023 • edited Loading

Codecov Report

elBoberido commented Dec 18, 2023

hydroid7 commented Dec 19, 2023

elBoberido left a comment

Choose a reason for hiding this comment

elBoberido Dec 19, 2023

Choose a reason for hiding this comment

elfenpiff left a comment

Choose a reason for hiding this comment

hydroid7 commented Dec 26, 2023

elBoberido left a comment

Choose a reason for hiding this comment

elBoberido commented Dec 30, 2023

elBoberido commented May 27, 2024

hydroid7 commented Dec 15, 2023 •

edited

Loading

elfenpiff left a comment •

edited

Loading

codecov bot commented Dec 17, 2023 •

edited

Loading