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

feat:loading_status_templates #48

Merged
merged 2 commits into from
Dec 26, 2024
Merged

feat:loading_status_templates #48

merged 2 commits into from
Dec 26, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Dec 26, 2024

companion PR OpenVoiceOS/ovos-bus-client#151 + OpenVoiceOS/ovos-gui#68

Summary by CodeRabbit

  • New Features
    • Streamlined GUI interactions for status updates through a unified method.
  • Bug Fixes
    • Enhanced cleanup logic during factory reset to ensure thoroughness.
    • Improved shutdown process by removing event listeners.
  • Chores
    • Removed outdated UI components related to rebooting, restarting, shutting down, and session status.
    • Deleted associated animation files for loading and status indicators.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Warning

Rate limit exceeded

@JarbasAl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 59 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 f9be8c3 and e948e2d.

📒 Files selected for processing (1)
  • requirements.txt (1 hunks)

Walkthrough

The pull request introduces significant changes to the SystemEventsPlugin in the ovos_PHAL_plugin_system module. The modifications primarily focus on streamlining GUI interactions by consolidating status update methods and removing several QML UI components and animation files. The changes aim to standardize how status updates are displayed, with methods now calling a centralized show_status_animation approach. Additionally, the code includes enhanced cleanup logic for factory reset processes and improved event listener management during plugin shutdown.

Changes

File/Path Change Summary
ovos_PHAL_plugin_system/__init__.py - Replaced direct GUI updates with show_status_animation method calls
- Enhanced handle_factory_reset_request with additional cleanup logic
- Updated shutdown method to remove event listeners
ovos_PHAL_plugin_system/ui/ Removed QML files:
- Reboot.qml
- Restart.qml
- Shutdown.qml
- Status.qml
ovos_PHAL_plugin_system/ui/animations/ Deleted animation JSON files:
- loading.json
- status-fail.json
- status-success.json

Poem

🐰 A Rabbit's Ode to Code Cleanup 🔧

Plugins dancing, QMLs fade away,
Animations retired on this coding day,
Streamlined methods, a cleaner design,
With show_status_animation, we now align!
Hop, hop, refactor - code's looking bright! 🚀


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.

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
ovos_PHAL_plugin_system/__init__.py (1)

276-276: Localization consideration for language change message.

While "Language changed to {language_code}" is straightforward, consider making it translatable or localized in case users have not yet switched to the new language. For instance, a user’s UI might still be in a non-English locale while seeing this message in English.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 867f1cc and f9be8c3.

📒 Files selected for processing (8)
  • ovos_PHAL_plugin_system/__init__.py (5 hunks)
  • ovos_PHAL_plugin_system/ui/Reboot.qml (0 hunks)
  • ovos_PHAL_plugin_system/ui/Restart.qml (0 hunks)
  • ovos_PHAL_plugin_system/ui/Shutdown.qml (0 hunks)
  • ovos_PHAL_plugin_system/ui/Status.qml (0 hunks)
  • ovos_PHAL_plugin_system/ui/animations/loading.json (0 hunks)
  • ovos_PHAL_plugin_system/ui/animations/status-fail.json (0 hunks)
  • ovos_PHAL_plugin_system/ui/animations/status-success.json (0 hunks)
💤 Files with no reviewable changes (7)
  • ovos_PHAL_plugin_system/ui/Shutdown.qml
  • ovos_PHAL_plugin_system/ui/animations/status-success.json
  • ovos_PHAL_plugin_system/ui/Restart.qml
  • ovos_PHAL_plugin_system/ui/Status.qml
  • ovos_PHAL_plugin_system/ui/Reboot.qml
  • ovos_PHAL_plugin_system/ui/animations/loading.json
  • ovos_PHAL_plugin_system/ui/animations/status-fail.json
🔇 Additional comments (6)
ovos_PHAL_plugin_system/__init__.py (6)

199-199: Proper notification display logic.

The approach of displaying "Clock Synchronized" using show_status_animation is consistent with the new centralized GUI logic, and clearly indicates success. This helps unify user messaging.


208-208: Consistent success animation for SSH enabling.

Following the same pattern with show_status_animation("SSH Enabled", True) ensures a uniform experience. This is aligned with the newly consolidated status animation approach.


218-218: Visual consistency for SSH disabling.

Passing False to show_status_animation typically suggests a different outcome or color-coded animation (i.e., failure or negative action). Ensure downstream code consistently interprets False.


225-227: Loading animation usage is properly consolidated.

Using show_loading_animation("Rebooting", override_animations=True, override_idle=True) for a forced display is consistent with the newly refactored approach. Good job maintaining a single code path for status display.


246-248: Graceful display flow for shutdown.

Similar to reboot, the enforced loading animation for "Shutting Down" appears consistent with the rest of the approach. This helps ensure a clear user experience when shutting down.


283-285: Consistent forced animation for Mycroft/OVOS restart.

show_loading_animation("Restarting", override_animations=True, override_idle=True) aligns well with the other forced animation calls. This ensures a single code path for various loading states.

@JarbasAl JarbasAl merged commit 62a8fe8 into dev Dec 26, 2024
3 checks passed
@JarbasAl JarbasAl deleted the feat/templs branch December 26, 2024 15:52
NeonDaniel added a commit to NeonGeckoCom/neon-phal-plugin-system that referenced this pull request Dec 27, 2024
Revert Changes from OpenVoiceOS#48 that added ovos-config>0.X dependency
NeonDaniel added a commit to NeonGeckoCom/neon-phal-plugin-system that referenced this pull request Dec 28, 2024
Revert Changes from OpenVoiceOS#48 that added ovos-config>0.X dependency
NeonDaniel added a commit to NeonGeckoCom/neon-phal-plugin-system that referenced this pull request Dec 28, 2024
NeonDaniel added a commit to NeonGeckoCom/neon-phal-plugin-system that referenced this pull request Dec 28, 2024
* Refactor into Neon package
Revert Changes from OpenVoiceOS#48 that added ovos-config>0.X dependency

* Undo changes from OpenVoiceOS#48 that added ovos-config>0.X dependency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant