fix(cli): add ctrlc listener to kill log loop in --no-tui mode

[MicaiahReid]

Summary by CodeRabbit

• Bug Fixes
  • Enhanced the application's shutdown process to gracefully handle termination signals, ensuring a smoother exit.

[coderabbitai]

Walkthrough

The change integrates signal handling into the log_events function within the CLI module for simnet. It introduces the use of AtomicBool and Arc from std::sync to manage a graceful shutdown when a Ctrl-C signal is received. The main event logging loop now periodically checks a shared flag and exits if signaled, ensuring a clean termination. No modifications were made to exported or public entities.

Changes

File	Change Summary
crates/cli/.../simnet/mod.rs	Added imports for AtomicBool and Arc; implemented a signal handling mechanism by introducing a stop_loop flag in log_events to gracefully exit.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SignalHandler
    participant LogEvents
    User->>SignalHandler: Press Ctrl-C
    SignalHandler-->>LogEvents: Set stop_loop flag (AtomicBool true)
    LogEvents->>LogEvents: Check stop_loop flag in loop
    LogEvents->>LogEvents: Exit loop when flag is true

Loading

Possibly Related PRs

• feat: implement tui #2: This PR also introduces changes to the simnet module, specifically enhancing the log_events function for handling SimnetEvent messages, indicating a strong code-level connection.

Poem

I'm a little bunny with code so bright,
Hopping through functions deep into the night,
When Ctrl-C taps in with a gentle cue,
I gracefully bid the loop adieu.
With Atomic hops and Arc so neat,
My code now skips with a rhythmic beat!
🐰✨

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

crates/cli/src/cli/simnet/mod.rs (1)

197-202: LGTM with suggestions for improvement.

The implementation correctly uses thread-safe primitives for handling Ctrl-C signals. However, consider these improvements:

1. The handler might be called multiple times if Ctrl-C is pressed repeatedly. Consider adding a guard to prevent multiple calls.
2. The handler is not cleaned up when the function exits. Consider implementing cleanup to prevent potential issues in subsequent runs.

Here's a more robust implementation:

-    let stop_loop = Arc::new(AtomicBool::new(false));
-    let do_stop_loop = stop_loop.clone();
-    ctrlc::set_handler(move || {
-        stop_loop.store(true, Ordering::Relaxed);
-    })
-    .expect("Error setting Ctrl-C handler");
+    let stop_loop = Arc::new(AtomicBool::new(false));
+    let do_stop_loop = stop_loop.clone();
+    let prev_handler = ctrlc::set_handler(move || {
+        if !stop_loop.load(Ordering::Relaxed) {
+            stop_loop.store(true, Ordering::Relaxed);
+        }
+    })
+    .expect("Error setting Ctrl-C handler");

Then at the end of the function (before the Ok(())), add:

    // Restore the previous Ctrl-C handler
    drop(prev_handler);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10523d6 and 844aec7.

📒 Files selected for processing (1)

• crates/cli/src/cli/simnet/mod.rs (2 hunks)

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

• GitHub Check: build
• GitHub Check: run_cargo_checks

🔇 Additional comments (2)

crates/cli/src/cli/simnet/mod.rs (2)

4-7: LGTM!

The new imports for AtomicBool and Arc are correctly placed and necessary for implementing thread-safe signal handling.

---

205-207: LGTM!

The loop break condition is correctly implemented using atomic operations.