refactor!:deprecate QML upload from bus #120
Conversation
WalkthroughThe changes involve significant modifications to the Changes
Sequence Diagram(s)(No sequence diagrams generated as the changes do not warrant a visual representation of control flow.) Suggested labels
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
companion to OpenVoiceOS/ovos-gui#53 and OpenVoiceOS/ovos-bus-client#120 this should be merged first as it does not require the others to work and does not break anything in the wild
|
marked as breaking because it does change the public api, but nothing in our org is using the removed stuff so it should be safe it may also cause issues in existing docker installs, but GUI in docker never worked quite right, the goal is precisely to make docker work correctly, if all containers are updated this won't cause issues there either |
never worked right, causes more issues than it helps
never worked right, causes more issues than it helps
JarbasAl
force-pushed
the
deprecate_QML_upload
branch
from
346ff66
to
fa11187
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- ovos_bus_client/apis/gui.py (7 hunks)
🧰 Additional context used
🔇 Additional comments (5)
ovos_bus_client/apis/gui.py (5)
105-106: Initialization now includes caching GUI filesThe
__init__method now calls_cache_gui_files(), which caches GUI resources upon initialization. Ensure that this change does not introduce unintended side effects during object creation.Including GUI caching in initialization streamlines resource management. However, please ensure that any exceptions raised during caching are properly handled to prevent initialization failures.
316-316: RaisingValueErrorfor file paths in_normalize_page_nameThe
_normalize_page_namemethod now raises aValueErrorif a file path is provided instead of a resource name. This enforces proper usage of the method.This change improves input validation and prevents potential misuse by ensuring that only resource names (not file paths) are accepted.
319-321: Logging error for deprecated.qmlextension usageThe method logs an error when a page name includes the
.qmlextension, guiding developers to omit the extension.By logging this error, developers are alerted to update their code, aligning with the deprecation of including extensions in resource names.
328-328: Addition ofremove_othersparameter inshow_pagemethodThe
show_pagemethod now includes aremove_othersparameter with a default value ofFalse. This parameter allows control over whether to remove other pages when showing a new one.The addition enhances functionality by providing flexibility in how pages are displayed. Ensure that this parameter is clearly documented for developers.
83-86: Removal ofremote_serverparameter may introduce breaking changesThe
remote_serverparameter has been removed from the__init__method of theGUIInterfaceclass. This alteration changes the public API and can lead to issues if external code relies on this parameter.Please verify that no external code or downstream projects are instantiating
GUIInterfacewith theremote_serverparameter. Run the following script to identify any such instances:
| def _cache_gui_files(self): | ||
| if not self.ui_directories: | ||
| LOG.debug(f"{self.skill_id} has no GUI resources") | ||
| return | ||
|
|
||
| # this path is hardcoded in ovos_gui.constants and follows XDG spec | ||
| GUI_CACHE_PATH = get_xdg_cache_save_path('ovos_gui') | ||
|
|
||
| @remote_url.setter | ||
| def remote_url(self, val: str): | ||
| self.config["remote-server"] = val | ||
| output_path = f"{GUI_CACHE_PATH}/{self.skill_id}" | ||
| if os.path.exists(output_path): | ||
| LOG.info(f"Removing existing {self.skill_id} cached GUI resources before updating") | ||
| shutil.rmtree(output_path) | ||
|
|
||
| for framework, bpath in self.ui_directories.items(): | ||
| if framework == "all": | ||
| LOG.warning(f"'all' is deprecated! ignoring path: {bpath}") | ||
| continue | ||
| shutil.copytree(bpath, f"{output_path}/{framework}") | ||
| LOG.debug(f"Copied {self.skill_id} resources from {bpath} to {output_path}/{framework}") |
There was a problem hiding this comment.
Implement error handling in _cache_gui_files() method
The new _cache_gui_files() method manages the caching of GUI resources. While it performs necessary file operations, it currently lacks comprehensive error handling. Potential issues include permission errors, missing directories, or file copy failures.
To enhance robustness, consider wrapping file operations with try-except blocks and logging any exceptions. For example:
try:
if os.path.exists(output_path):
LOG.info(f"Removing existing {self.skill_id} cached GUI resources before updating")
shutil.rmtree(output_path)
except Exception as e:
LOG.error(f"Error removing existing cache at '{output_path}': {e}")
# ...
try:
shutil.copytree(bpath, f"{output_path}/{framework}")
LOG.debug(f"Copied {self.skill_id} resources from {bpath} to {output_path}/{framework}")
except Exception as e:
LOG.error(f"Error copying resources from '{bpath}' to '{output_path}/{framework}': {e}")
never worked right, causes more issues than it helps
companion to OpenVoiceOS/ovos-gui#53
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
GUIInterfaceclass by eliminating deprecated functionalities, reducing complexity.