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

chore: Sonar fixes after detector refactor #3968

Merged

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Dec 7, 2024

Blocked by:

Summary by CodeRabbit

  • New Features

    • Enhanced safety in the DD4hepDetector class by using const references in loop iterations.
    • Updated sorting mechanism for several vectors to utilize modern C++ practices.
  • Bug Fixes

    • Adjusted data types in the Config struct of the AlignedDetector class for better performance and accuracy.
    • Removed obsolete member variable from the Config struct in the AlignedDetector class.

Copy link

coderabbitai bot commented Dec 7, 2024

Walkthrough

Changes made, significant they are. In Geant4MaterialRecording, the execute method's signature altered from final to override, allowing derived classes to customize. In AlignedDetector, member variable types in Config changed from std::size_t to unsigned int, and materialDecorator removed. Lastly, in DD4hepDetector, loop variable types adjusted to const auto& for safety, and sorting updated to std::ranges::sort, reflecting modern C++ practices.

Changes

File Path Change Summary
Examples/Algorithms/Geant4/include/ActsExamples/Geant4/Geant4Simulation.hpp Method signature updated: execute from final to override in Geant4MaterialRecording.
Examples/Detectors/ContextualDetector/include/ActsExamples/ContextualDetector/AlignedDetector.hpp Member variable types updated: seed, iovSize, flushSize from std::size_t to unsigned int. materialDecorator removed from Config struct.
Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp Loop variable types changed to const auto& in buildDD4hepGeometry and sortFCChhDetElements. Sorting updated to std::ranges::sort for several vectors.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • AJPfleger
  • andiwand

In code we trust, with changes so bright,
From final to override, a new path in sight.
Types shift and loop safe, modern ways we embrace,
With sorting so sleek, in this code we find grace.
A celebration of changes, let progress take flight! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@paulgessinger paulgessinger added the 🛑 blocked This item is blocked by another item label Dec 7, 2024
@github-actions github-actions bot added this to the next milestone Dec 7, 2024
@github-actions github-actions bot added Component - Core Affects the Core module Infrastructure Changes to build tools, continous integration, ... Component - Examples Affects the Examples module Component - Documentation Affects the documentation labels Dec 7, 2024
@paulgessinger paulgessinger changed the title Chore/sonar post detector refactor chore: Sonar fixes after detector refactor Dec 7, 2024
Copy link

github-actions bot commented Dec 7, 2024

📊: Physics performance monitoring for cbf8f78

Full contents

physmon summary

@paulgessinger paulgessinger force-pushed the chore/sonar-post-detector-refactor branch from ed3e144 to cbf8f78 Compare December 9, 2024 08:12
@github-actions github-actions bot removed Component - Core Affects the Core module Infrastructure Changes to build tools, continous integration, ... Component - Documentation Affects the documentation labels Dec 9, 2024
@paulgessinger paulgessinger removed the 🛑 blocked This item is blocked by another item label Dec 9, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp (1)

121-136: Duplicate sorting logic, I see. Refactor this, we should.

Similar lambda functions, four times repeated they are. A template function or common comparator, better it would be.

+ auto compareDetElements = [](const dd4hep::DetElement& a, 
+                            const dd4hep::DetElement& b) {
+   return (a.id() < b.id());
+ };

- std::ranges::sort(
-     muon, [](const dd4hep::DetElement& a, const dd4hep::DetElement& b) {
-       return (a.id() < b.id());
-     });
+ std::ranges::sort(muon, compareDetElements);

- std::ranges::sort(
-     eCal, [](const dd4hep::DetElement& a, const dd4hep::DetElement& b) {
-       return (a.id() < b.id());
-     });
+ std::ranges::sort(eCal, compareDetElements);

// Apply similar changes to hCal and tracker sorting
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 341d2b0 and cbf8f78.

📒 Files selected for processing (3)
  • Examples/Algorithms/Geant4/include/ActsExamples/Geant4/Geant4Simulation.hpp (1 hunks)
  • Examples/Detectors/ContextualDetector/include/ActsExamples/ContextualDetector/AlignedDetector.hpp (1 hunks)
  • Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp (3 hunks)
🔇 Additional comments (3)
Examples/Detectors/ContextualDetector/include/ActsExamples/ContextualDetector/AlignedDetector.hpp (1)

25-29: Careful with platform compatibility, you must be.

Changed from std::size_t to unsigned int, these configuration parameters have. On 64-bit systems where large values you need, limitations this may bring. Consider these implications, you should:

  • On 64-bit systems, std::size_t is typically 64 bits
  • unsigned int usually 32 bits remains, regardless of platform
Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp (1)

89-90: Wisdom in const-correctness, I sense.

The Force is strong with this change. Using const auto& prevents accidental modifications and improves clarity, it does.

Examples/Algorithms/Geant4/include/ActsExamples/Geant4/Geant4Simulation.hpp (1)

211-211: Changed from final to override, the execute method has. Implications, this brings.

Removed the final specifier, more flexibility it provides. But careful consideration needed:

  • Derived classes may now override this method
  • Ensure documentation reflects this design change
  • Verify all derived classes maintain the contract

Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link

sonarcloud bot commented Dec 9, 2024

@kodiakhq kodiakhq bot merged commit 47db0b9 into acts-project:main Dec 9, 2024
46 checks passed
@github-actions github-actions bot removed the automerge label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants