fix: Sequencer run with 0 threads or 0 events #4053

paulgessinger · 2025-01-28T14:34:18Z

This fixes the sequencer when running with 0 events (it would otherwise do a division by zero). It also adds an exception in case it's configured to run with a number that's not -1 or positive (and larger than 0)

Summary by CodeRabbit

Bug Fixes
- Improved error handling in Sequencer constructor to prevent invalid thread configurations
- Added safety check in perEvent function to handle zero events gracefully

This fixes the sequencer when running with 0 events (it would otherwise do a division by zero). It also adds an exception in case it's configured to run with a number that's not -1 or positive (and larger than 0)

coderabbitai · 2025-01-28T14:34:33Z

Walkthrough

Hmm, improvements to the Sequencer class, we have. Enhanced error handling, the constructor now possesses. Validation of thread configuration, added it has. Zero events handling, refined the perEvent function now does. Preventing invalid configurations and potential runtime errors, these changes aim to do. Robust and defensive programming, the path of wisdom it is.

Changes

File	Change Summary
`Examples/Framework/src/Framework/Sequencer.cpp`	- Added validation for `numThreads` in constructor - Throw exception for invalid thread configurations - Modified `perEvent` function to handle zero events scenario

Suggested labels

Component - Examples, automerge

Suggested reviewers

benjaminhuth

Possibly related PRs

fix: Workaround Pythia8 race condition in ttbar physmon #3965: Modifications to numThreads parameter in acts.examples.Sequencer

Poem

In code's vast realm, a guardian stands tall
Sequencer's wisdom, catching errors' call
Threads dance, events flow, validation's might
No zero shall break, no config take flight! 🧘‍♂️🚀

📜 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 679bade and 206f227.

📒 Files selected for processing (1)

Examples/Framework/src/Framework/Sequencer.cpp (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

GitHub Check: unused_files
GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
GitHub Check: macos
GitHub Check: missing_includes
GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
GitHub Check: docs
GitHub Check: linux_ubuntu
GitHub Check: build_debug

🔇 Additional comments (2)

Examples/Framework/src/Framework/Sequencer.cpp (2)

104-108: Wise validation of threads, this is!

Handle invalid configurations gracefully, we now do. Prevent chaos from negative or zero threads, we must.

396-398: Prevent division by zero, we shall!

Handle the case of zero events with grace, we now do. Return "undef/event" instead of attempting the impossible division, we must. Hmmmm.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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.

github-actions · 2025-01-28T15:28:20Z

📊: Physics performance monitoring for `bca4c51`

Full contents

physmon summary

benjaminhuth · 2025-01-28T22:42:51Z

We could also early return from Sequencer::run() in case of 0 events, before the event loop...

paulgessinger · 2025-01-29T07:08:55Z

@benjaminhuth I do want the Sequencer to run the initialization though. I've been using this to measure the wall time of the initialization only.

I can return before we kick off the parallel for, but then that will result in exactly the same behavior as if the parallel for is over 0 entries, and it will also skip the finalize calls.

andiwand

LGTM

do you think it makes sense to try enhance the time measurement capabilities we have to break down the init time and the first event time similar to what is done in Athena?

sonarqubecloud · 2025-01-29T20:03:54Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

acts-project-service · 2025-01-29T23:06:13Z

✅ Athena integration test results [`56d7af9`]

✅ All tests successful

status	job	report
🟢	report_pull_request
🟢	run_workflow_tests_run4_mc
🟢	run_workflow_tests_run2_mc
🟢	run_workflow_tests_run2_data
🟢	run_workflow_tests_run3_mc
🟢	run_workflow_tests_run3_data
🟢	test_ActsDumpGeometryIdentifiers
🟢	test_ActsCheckObjectCountsWorkflowHgtd
🟢	test_ActsCheckObjectCountsCachedWorkflow
🟢	test_ActsCheckObjectCountsWorkflow
🟢	test_ActsEFTrackFit
🟢	test_ActsPersistifySeeds
🟢	test_ActsBenchmarkWithSpot
🟢	test_ActsAnalogueClustering
🟢	test_ActsWorkflowHeavyIons
🟢	test_ActsWorkflowFastTracking
🟢	test_ActsWorkflowCached
🟢	test_ActsWorkflow
🟢	test_ActsValidateAmbiguityResolution
🟢	test_ActsValidateResolvedTracks
🟢	test_ActsValidateTracks
🟢	test_ActsValidateActsCoreSpacePoints
🟢	test_ActsValidateActsSpacePoints
🟢	test_ActsValidateSeeds
🟢	test_ActsValidateOrthogonalSeeds
🟢	test_ActsValidateClusters
🟢	test_ActsPersistifyEDM
🟢	test_ActsGx2fRefitting
🟢	test_ActsGSFRefitting
🟢	test_ActsKfRefitting
🟢	test_ActsExtrapolationAlgTest
🟢	test_ActsITkTest

This fixes the sequencer when running with 0 events (it would otherwise do a division by zero). It also adds an exception in case it's configured to run with a number that's not -1 or positive (and larger than 0)  ## Summary by CodeRabbit - **Bug Fixes** - Improved error handling in Sequencer constructor to prevent invalid thread configurations - Added safety check in `perEvent` function to handle zero events gracefully

fix: Sequencer run with 0 threads or 0 events

206f227

This fixes the sequencer when running with 0 events (it would otherwise do a division by zero). It also adds an exception in case it's configured to run with a number that's not -1 or positive (and larger than 0)

paulgessinger added this to the next milestone Jan 28, 2025

github-actions bot added the Component - Examples Affects the Examples module label Jan 28, 2025

andiwand approved these changes Jan 29, 2025

View reviewed changes

benjaminhuth added the automerge label Jan 29, 2025

Merge branch 'main' into fix/sequencer-zero-threads

bca4c51

kodiakhq bot merged commit 56d7af9 into acts-project:main Jan 29, 2025
42 checks passed

github-actions bot removed the automerge label Jan 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Sequencer run with 0 threads or 0 events #4053

fix: Sequencer run with 0 threads or 0 events #4053

paulgessinger commented Jan 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 28, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jan 28, 2025 •

edited

Loading

benjaminhuth commented Jan 28, 2025

paulgessinger commented Jan 29, 2025 •

edited

Loading

andiwand left a comment

sonarqubecloud bot commented Jan 29, 2025

acts-project-service commented Jan 29, 2025

fix: Sequencer run with 0 threads or 0 events #4053

fix: Sequencer run with 0 threads or 0 events #4053

Conversation

paulgessinger commented Jan 28, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 28, 2025 • edited Loading

Walkthrough

Changes

Suggested labels

Suggested reviewers

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jan 28, 2025 • edited Loading

📊: Physics performance monitoring for bca4c51

physmon summary

benjaminhuth commented Jan 28, 2025

paulgessinger commented Jan 29, 2025 • edited Loading

andiwand left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 29, 2025

Quality Gate passed

acts-project-service commented Jan 29, 2025

✅ Athena integration test results [56d7af9]

✅ All tests successful

paulgessinger commented Jan 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jan 28, 2025 •

edited

Loading

📊: Physics performance monitoring for `bca4c51`

paulgessinger commented Jan 29, 2025 •

edited

Loading

✅ Athena integration test results [`56d7af9`]