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

fix: some blocker reported sonar-cloud issues #4009

Merged

Conversation

asalzburger
Copy link
Contributor

@asalzburger asalzburger commented Jan 9, 2025

Spillover from 2024 - some "blocker" labelled SonarCloud issues fixed.

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Refactor
    • Added noexcept specifications to various move constructors and move assignment operators across multiple classes to improve exception safety and performance.
    • Renamed variables in the ProtoLayerCreatorT class for clarity without altering functionality.
    • Updated the parameter name in the selectModule function for better representation of its purpose.

Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

A comprehensive update to exception safety across multiple files in the Acts library has been implemented. The changes primarily involve adding noexcept specifications to move constructors and move assignment operators in various classes, enhancing the predictability and performance of object movement operations. These modifications span core utility classes, geometry components, and example framework utilities.

Changes

File Change Summary
Core/include/Acts/EventData/VectorMultiTrajectory.hpp Added noexcept to default and move constructors
Core/include/Acts/Geometry/GeometryHierarchyMap.hpp Added noexcept to move constructor and move assignment operator
Core/include/Acts/Utilities/Any.hpp Added noexcept to move constructor
Core/include/Acts/Utilities/MultiIndex.hpp Added noexcept to move assignment operator
Core/include/Acts/Utilities/Result.hpp Added noexcept to move constructors and move assignment operators
Examples/Framework/include/ActsExamples/Utilities/Range.hpp Added noexcept to move constructor and move assignment operator
Plugins/FpeMonitoring/include/Acts/Plugins/FpeMonitoring/FpeMonitor.hpp Added noexcept to move constructor
Examples/Detectors/GenericDetector/include/ActsExamples/GenericDetector/ProtoLayerCreatorT.hpp Renamed variables for clarity
Examples/Framework/include/ActsExamples/EventData/GeometryContainers.hpp Renamed parameter for clarity

Suggested labels

automerge, Changes Performance

Suggested reviewers

  • paulgessinger

Poem

Exceptions tamed, with noexcept might,
Code flows smooth as Jedi's light 🌟
Move constructors dance with grace,
Performance leaps at rapid pace 🚀
Wisdom in each keyword's embrace! 🧘‍♂️


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02e8ee4 and 116e5bd.

📒 Files selected for processing (1)
  • Core/include/Acts/Seeding/BinnedGroupIterator.ipp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Core/include/Acts/Seeding/BinnedGroupIterator.ipp

Finishing Touches

  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d37131 and 02e8ee4.

📒 Files selected for processing (10)
  • Core/include/Acts/EventData/VectorMultiTrajectory.hpp (2 hunks)
  • Core/include/Acts/Geometry/GeometryHierarchyMap.hpp (1 hunks)
  • Core/include/Acts/Seeding/BinnedGroupIterator.ipp (1 hunks)
  • Core/include/Acts/Utilities/Any.hpp (1 hunks)
  • Core/include/Acts/Utilities/MultiIndex.hpp (1 hunks)
  • Core/include/Acts/Utilities/Result.hpp (2 hunks)
  • Examples/Detectors/GenericDetector/include/ActsExamples/GenericDetector/ProtoLayerCreatorT.hpp (4 hunks)
  • Examples/Framework/include/ActsExamples/EventData/GeometryContainers.hpp (2 hunks)
  • Examples/Framework/include/ActsExamples/Utilities/Range.hpp (1 hunks)
  • Plugins/FpeMonitoring/include/Acts/Plugins/FpeMonitoring/FpeMonitor.hpp (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • Core/include/Acts/Utilities/Any.hpp
  • Examples/Detectors/GenericDetector/include/ActsExamples/GenericDetector/ProtoLayerCreatorT.hpp
🧰 Additional context used
📓 Learnings (1)
Core/include/Acts/EventData/VectorMultiTrajectory.hpp (1)
Learnt from: paulgessinger
PR: acts-project/acts#3907
File: Core/include/Acts/EventData/VectorMultiTrajectory.hpp:349-351
Timestamp: 2024-11-26T10:57:04.925Z
Learning: In `VectorMultiTrajectory` class within `Core/include/Acts/EventData/VectorMultiTrajectory.hpp`, the initialization of `m_meas` and `m_measCov` is ensured by the rest of the interface.
🔇 Additional comments (9)
Examples/Framework/include/ActsExamples/Utilities/Range.hpp (1)

30-33: Approve these changes, I do!

Wise addition of noexcept to move operations, this is. Non-throwing, the move operations are, as only iterator members they contain. Follow the path of exception safety, we must.

Plugins/FpeMonitoring/include/Acts/Plugins/FpeMonitoring/FpeMonitor.hpp (1)

Line range hint 48-54: Approve this change, I do!

Correctly marked as noexcept, the move constructor is. Only smart pointer and primitive types it moves. Strong in the ways of exception safety, this code becomes.

Core/include/Acts/Utilities/MultiIndex.hpp (1)

73-73: Approve this change, I do!

Correctly marked as noexcept, the move assignment is. Only primitive type it moves. In harmony with exception safety guidelines, this code now is.

Examples/Framework/include/ActsExamples/EventData/GeometryContainers.hpp (1)

165-165: Approve parameter renaming, I do! More clarity it brings!

Changed from module to sensitive, the parameter name has been. Matches better with its purpose, it does, as a sensitive surface identifier it represents. Updated properly, the documentation has been.

Also applies to: 169-169, 179-181

Core/include/Acts/Geometry/GeometryHierarchyMap.hpp (1)

82-82: Approve these changes, I do! Stronger exception guarantees they bring!

Added noexcept to move operations, wisdom shows. Safer and more efficient, the code becomes. Follow modern C++ best practices, it does.

Also applies to: 85-85

Core/include/Acts/Utilities/Result.hpp (2)

46-46: Approve this change, I do! Better exception guarantees it provides!

Added noexcept to move operations of Result<T,E>, wisdom shows. Safe these operations are, as only moving a variant member they do.

Also applies to: 51-54


360-360: Approve this change too, I do! Consistency it maintains!

Added noexcept to move constructor of Result<void,E>, wisdom shows. Matches the changes in Result<T,E>, it does. Safe the operation is, as only moving an optional member it does.

Core/include/Acts/EventData/VectorMultiTrajectory.hpp (2)

195-195: Approve this change, I do! Clearer guarantees it provides!

Added noexcept to default constructor, wisdom shows. Cannot throw, a default constructor does.


391-392: Approve this change, I do! Consistency with base class it maintains!

Added noexcept to move constructor, wisdom shows. Safe the operation is, as it delegates to base class move constructor which noexcept already is.

@asalzburger asalzburger added this to the next milestone Jan 9, 2025
@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Event Data Model Seeding labels Jan 9, 2025
Copy link

github-actions bot commented Jan 9, 2025

📊: Physics performance monitoring for 920bea8

Full contents

physmon summary

@kodiakhq kodiakhq bot merged commit fe95173 into acts-project:main Jan 9, 2025
42 checks passed
@github-actions github-actions bot removed the automerge label Jan 9, 2025
@acts-project-service
Copy link
Collaborator

🔴 Athena integration test results [fe95173]

Build job with this PR failed!

Please investigate the build job for the pipeline!

@acts-project-service acts-project-service added the Breaks Athena build This PR breaks the Athena build label Jan 9, 2025
@paulgessinger paulgessinger modified the milestones: next, v39.0.0 Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaks Athena build This PR breaks the Athena build Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Event Data Model Seeding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants