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

refactor(parbase): Improve logging in FairParSet #1551

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

ChristianTackeGSI
Copy link
Member

@ChristianTackeGSI ChristianTackeGSI commented Jun 6, 2024

And re-arrange some if statements

See-Also: #1541

Included one commit from #1552


Checklist:

Copy link

coderabbitai bot commented Jun 6, 2024

Walkthrough

Walkthrough

The updates primarily focus on replacing standard output (cout) with logging using fairlogger/Logger.h across multiple files. Changes also include adapting variable types for improved consistency, enhancing error handling, and the addition of new methods to bolster functionality and maintainability.

Changes

Files Change Summaries
.../FairDetParRootFileIo.cxx Replaced cout with LOG(info) for logging, early return handling for key absence.
.../FairParSet.cxx Updated variable types, added CallInitIO method, modified methods for enhanced error handling and logging.
.../FairParSet.h Changed data types of several variables and method parameters from Int_t to int and Bool_t to bool.
.../FairRuntimeDb.cxx Replaced cout with logging, added logging for initialization details, improved error handling.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 000612a and ba0f92d.

Files selected for processing (4)
  • fairroot/parbase/FairDetParRootFileIo.cxx (2 hunks)
  • fairroot/parbase/FairParSet.cxx (4 hunks)
  • fairroot/parbase/FairParSet.h (4 hunks)
  • fairroot/parbase/FairRuntimeDb.cxx (1 hunks)
Additional comments not posted (9)
fairroot/parbase/FairParSet.h (3)

23-26: Update member variable types to standard C++ types.

The changes from Int_t to int and Bool_t to bool improve code readability and consistency.


32-32: Update constructor parameter type to standard C++ type.

The change from Bool_t to bool for the owner parameter improves code readability and consistency.


Line range hint 48-70: Update function parameter types to standard C++ types.

The changes from Int_t to int and Bool_t to bool for function parameters improve code readability and consistency.

fairroot/parbase/FairDetParRootFileIo.cxx (1)

33-34: Add necessary imports for logging.

The imports for fairlogger/Logger.h and fmt/core.h are necessary for the improved logging functionality.

fairroot/parbase/FairParSet.cxx (3)

2-2: Update copyright year.

The update to the copyright year is appropriate and ensures the code is up-to-date.


Line range hint 17-17: Update constructor parameter type to standard C++ type.

The change from Bool_t to bool for the owner parameter improves code readability and consistency.


62-75: Improve logging and error handling in the init method.

The changes to integrate fairlogger for logging and improve error handling in the init method are well-implemented. The use of CallInitIO to handle I/O initialization is a good practice.

fairroot/parbase/FairRuntimeDb.cxx (2)

Line range hint 24-25: Add necessary imports for logging.

The imports for fairlogger/Logger.h and fmt/core.h are necessary for the improved logging functionality.


529-557: Improve logging and error handling in the initContainers method.

The changes to integrate fairlogger for logging and improve error handling in the initContainers method are well-implemented. The detailed logging messages provide better traceability.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 2

fairroot/parbase/FairParSet.h Show resolved Hide resolved
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

@ChristianTackeGSI ChristianTackeGSI marked this pull request as ready for review June 21, 2024 14:40
@ChristianTackeGSI
Copy link
Member Author

@karabowi I included one of your commits from #1552.

I have also added even more LOG(info) instead of cout.

A current, typical output can be seen for example here:
https://cdash.gsi.de/testDetails.php?test=20858392&build=463833

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

fairroot/parbase/FairParSet.h Show resolved Hide resolved
fairroot/parbase/FairDetParRootFileIo.cxx Show resolved Hide resolved
fairroot/parbase/FairParSet.cxx Show resolved Hide resolved
@karabowi karabowi merged commit 1750b27 into FairRootGroup:dev Jul 12, 2024
30 checks passed
@ChristianTackeGSI ChristianTackeGSI deleted the pr/parbase branch July 12, 2024 15:55
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