fix: Output ROOT file closing on destruct

[paulgessinger]

While I believe the writing should happen in endRun, I've seen
segfaults when ROOT's exit handler tries to close them and sees
corrupted memory. This PR should fix that for these two classes.

Summary by CodeRabbit

• Bug Fixes

  • Improved resource management by ensuring output files are properly closed in destructors, preventing potential memory leaks and file access issues.
  • Simplified logic in the endRun method by removing redundant file closure calls.

• Refactor

  • Updated destructors for RootTrajectoryStatesWriter and RootTrajectorySummaryWriter to enhance error handling and resource management.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.43%. Comparing base (5ad6aa7) to head (318e72b).
Report is 2092 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1296   +/-   ##
=======================================
  Coverage   47.43%   47.43%           
=======================================
  Files         375      375           
  Lines       19785    19785           
  Branches     9290     9290           
=======================================
  Hits         9385     9385           
  Misses       4020     4020           
  Partials     6380     6380           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[AJPfleger]

Does this problem affect only these two classes? I am asking, because we use the same approach for some/all other writer-classes.

[paulgessinger]

We certainly could. I saw crashes for these two classes specifically, so those are the ones I touched for now.

[AJPfleger]

The changes look good to me, but I think we should do one of the following:

• Check and adapt the other writer-classes
• Open an Issue to not forget about ^ in the future

[paulgessinger]

We could extend the scope of #881 for this purpose, @AJPfleger?

[AJPfleger]

Yes, #881 seems well suited.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

In the realm of file management within the Acts Examples project, two Root-based writer classes have undergone subtle refinements. The RootTrajectoryStatesWriter and RootTrajectorySummaryWriter classes now feature enhanced destructor logic, ensuring proper file closure and preventing potential resource leaks through a simple yet effective null check before closing output files.

Changes

File	Change Summary
Examples/Io/Root/src/RootTrajectoryStatesWriter.cpp	Destructor modified to safely close m_outputFile if open
Examples/Io/Root/src/RootTrajectorySummaryWriter.cpp	Destructor updated with similar file closure mechanism

Poem

Bytes and files, a Jedi's dance 🌟
Closing resources with gentle glance
Memory leaks, we shall prevent
In destructor's wise intent
Code flows smooth, the Force is strong! 💻🚀

- Wisdom of the coding Jedi 🧘‍♂️

---

📜 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 5ad6aa7 and 318e72b.

📒 Files selected for processing (2)

• Examples/Io/Root/src/RootTrajectoryStatesWriter.cpp (1 hunks)
• Examples/Io/Root/src/RootTrajectorySummaryWriter.cpp (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.