fix:gui spam

[JarbasAl]

do not spam the bus with GUI messages if disabled in config

companion to OpenVoiceOS/ovos-bus-client#133

Summary by CodeRabbit

• New Features
  • Introduced a new configuration option to suppress GUI-related messages for headless devices, improving performance in non-GUI environments.

[coderabbitai]

Walkthrough

The changes introduced in this pull request add a new configuration option, disable_gui, in the gui section of the mycroft.conf file. This flag allows users to suppress GUI-related bus messages on headless devices, aiming to reduce message bus usage in environments where a graphical user interface is unnecessary. The default setting for disable_gui is false, meaning GUI messages will be emitted unless explicitly disabled.

Changes

File Path	Change Summary
ovos_config/mycroft.conf	Added new configuration option "disable_gui": false in the gui section.

Possibly related PRs

• fix:disable g2p #174: The changes in this PR also involve modifications to the mycroft.conf file, specifically altering configuration settings, which may relate to the overall management of system messages and logging, similar to the introduction of the disable_gui flag in the main PR.

Suggested labels

fix

Suggested reviewers

• goldyfruit
• j1nx

Poem

In the land of code where rabbits play,
A flag was added to brighten the day.
With disable_gui, we hop with glee,
Reducing messages, so light and free!
In headless burrows, we now can thrive,
A simpler bus, keeping us alive! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7242a3e and 3a94929.

📒 Files selected for processing (1)

• ovos_config/mycroft.conf (1 hunks)

🔇 Additional comments (2)

ovos_config/mycroft.conf (2)

658-659: LGTM! Clean formatting and structure.

The placement and formatting of the new configuration section maintains consistency with the rest of the file.

---

660-664: Well documented configuration option.

The new disable_gui flag is:

• Properly documented with clear comments explaining its purpose
• Correctly defaults to false for backward compatibility
• Thoughtfully includes a note about CLI-based GUI clients

Let's verify the impact of this change:

✅ Verification successful

Configuration option is well documented and safely implemented

The verification confirms that:

• The disable_gui flag is only referenced in the configuration file
• The GUI websocket configuration exists but is separate from this flag
• No direct dependencies on GUI messages were found in the codebase
• The default false value ensures backward compatibility
• The documentation clearly explains the implications and considerations

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if any skills rely on GUI messages being always enabled
rg -l "gui\.(show|hide|value|clear)" .

Length of output: 40

---

Script:

#!/bin/bash
# Let's try a broader search for GUI-related code and message bus interactions
rg -l -i "gui.*message" .

# Also search for GUI-related imports and class definitions
ast-grep --pattern 'from ovos_bus_client import Message'

# Check for any GUI-related configuration references
rg -l "disable_gui" .

Length of output: 162

---

Script:

#!/bin/bash
# Let's examine the actual content around GUI-related code in mycroft.conf
rg -C 5 -i "gui.*message|disable_gui" ./ovos_config/mycroft.conf

# Look for any GUI-related message handling or bus events
rg -i "gui\.(show|hide|value|clear|set)" .

# Search for any GUI-related class definitions or methods
ast-grep --pattern 'class $_ {
  $$$
  gui_$_($$$) {
    $$$
  }
  $$$
}'

Length of output: 1148

---

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@7242a3e). Learn more about missing BASE report.

Additional details and impacted files

@@          Coverage Diff          @@
##             dev    #176   +/-   ##
=====================================
  Coverage       ?   0.00%           
=====================================
  Files          ?      10           
  Lines          ?     877           
  Branches       ?       0           
=====================================
  Hits           ?       0           
  Misses         ?     877           
  Partials       ?       0           

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