feat: status events

[JarbasAl]

split feedback events to allow GUI integration via systemdhooks

similar to what we do for clock sync in raspOVOS OpenVoiceOS/raspOVOS@3ab5f44#diff-390ab68cb47cd597ab61ab48741f9d35ce7a7d514a4a40014df1222d402bead8R8

systemd hooks overview by chatgpt:

---

1. Scripts Before Reboot/Shutdown

To run a script before a system reboot or shutdown:

Create a Systemd Service for Shutdown Hooks

1. Create a service file, e.g., /etc/systemd/system/before-shutdown.service:

   [Unit]
   Description=Run script before shutdown/reboot
   DefaultDependencies=no
   Before=halt.target reboot.target shutdown.target
   
   [Service]
   Type=oneshot
   ExecStart=/path/to/your/script.sh
   
   [Install]
   WantedBy=halt.target reboot.target shutdown.target

2. Reload systemd and enable the service:

   systemctl daemon-reload
   systemctl enable before-shutdown.service

How It Works

• Before=halt.target reboot.target shutdown.target ensures the script runs before these targets are reached.
• ExecStart specifies the script or command to run.

---

2. Scripts Before SSH Enable/Disable

To run a script when the SSH service is enabled or disabled:

Use Systemd Service Drop-Ins

1. Create a drop-in file for sshd.service:

   mkdir -p /etc/systemd/system/ssh.service.d
   nano /etc/systemd/system/ssh.service.d/before-ssh-change.conf

2. Add the following configuration:

   [Service]
   ExecStartPre=/path/to/your/script-before-enable.sh
   ExecStopPost=/path/to/your/script-before-disable.sh

3. Reload systemd:

   systemctl daemon-reload

How It Works

• ExecStartPre runs before SSH starts.
• ExecStopPost runs after SSH stops.

---

Summary by CodeRabbit

• New Features

  • Introduced new event handlers for managing SSH service status and system reboot/shutdown processes.
  • Emitted clear signals for the initiation of reboot and shutdown events.

• Improvements

  • Enhanced type clarity by updating method signatures to explicitly annotate message parameters.
  • Improved organization and clarity of the event handling within the plugin.
  • Renamed and added methods for better clarity on Mycroft service management.

[coderabbitai]

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5b1bea6 and 88cd878.

Walkthrough

The changes in this pull request focus on the SystemEventsPlugin class within the ovos_PHAL_plugin_system module. New event handlers for SSH status changes and system reboot/shutdown processes have been added. Existing methods related to these processes have been modified to emit new events, and method signatures have been updated for type clarity. Additionally, the shutdown method has been enhanced to ensure proper cleanup of event handlers.

Changes

File Path	Change Summary
ovos_PHAL_plugin_system/init.py	- Added methods: handle_ssh_enabled, handle_ssh_disabled, handle_rebooting, handle_shutting_down, handle_mycroft_restart_request - Updated method signatures for several methods to include message: Message - Modified existing methods to emit new events: system.reboot.start, system.shutdown.start - Updated shutdown method to remove event handlers from the bus.

Possibly related PRs

• feat:clock_sync_gui #46: The changes in this PR also modify the SystemEventsPlugin class in the same file, adding a new event handler method, which indicates a direct connection in terms of functionality and structure within the class.

Suggested reviewers

• j1nx
• builderjer

Poem

🐰 In the land of code where rabbits play,
New handlers hop in, brightening the day.
SSH enabled, reboot in sight,
Events now dance, oh what a delight!
With types clarified, the flow is so neat,
A plugin reborn, oh what a treat! 🌟

---

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