Emit handler complete event for CommonQuery skills (#477)

* Back-port OpenVoiceOS/OVOS-workshop#142 * Resolve license test failure Refactor for upstream ovos-workshop compat. * Troubleshooting compat. with upstream `settings_path` changes * More test failure troubleshooting * Fix bad references to inherited properties * More settings_path troubleshooting --------- Co-authored-by: Daniel McKnight <[email protected]>
NeonGeckoCom · Oct 10, 2023 · d0deade · d0deade
1 parent 7c7bacf
commit d0deade
Show file tree

Hide file tree

Showing 5 changed files with 355 additions and 9 deletions.
diff --git a/.github/workflows/license_tests.yml b/.github/workflows/license_tests.yml
@@ -11,3 +11,4 @@ jobs:
     uses: neongeckocom/.github/.github/workflows/license_tests.yml@master
     with:
       package-extras: audio,configuration,networking
+      packages-exclude: '^(precise-runner|fann2|tqdm|bs4|ovos-phal-plugin|ovos-skill|neon-core|nvidia|neon-phal-plugin|bitstruct|audioread).*'
diff --git a/neon_utils/skills/common_query_skill.py b/neon_utils/skills/common_query_skill.py
@@ -156,6 +156,8 @@ def __handle_query_action(self, message):
         data = message.data.get("callback_data")
         # Invoke derived class to provide playback data
         self.CQS_action(phrase, data)
+        self.bus.emit(message.forward("mycroft.skill.handler.complete",
+                                      {"handler": "common_query"}))
 
     @abstractmethod
     def CQS_match_query_phrase(self, phrase, message):

diff --git a/neon_utils/skills/mycroft_skill.py b/neon_utils/skills/mycroft_skill.py
@@ -35,6 +35,7 @@
 from typing import Optional
 from json_database import JsonStorage
 from ovos_bus_client.message import Message
+from ovos_utils.log import log_deprecation
 from ovos_workshop.skills.mycroft_skill import MycroftSkill
 from ovos_utils.skills.settings import get_local_settings
 
@@ -49,11 +50,21 @@
 class PatchedMycroftSkill(MycroftSkill):
     def __init__(self, name=None, bus=None, *args, **kwargs):
         MycroftSkill.__init__(self, name, bus, *args, **kwargs)
+        log_deprecation("This base class is deprecated. Implement either"
+                        "`NeonSkill` or `OVOSSkill`", "2.0.0")
         # TODO: Should below defaults be global config?
         # allow skills to specify timeout overrides per-skill
         self._speak_timeout = 30
         self._get_response_timeout = 15  # 10 for listener, 5 for STT, then timeout
 
+    @property
+    def settings_path(self):
+        # TODO: Deprecate backwards-compat. wrapper after ovos-workshop 0.0.13
+        try:
+            return super().settings_path
+        except AttributeError:
+            return super()._settings_path
+
     @property
     def location(self):
         """
@@ -67,19 +78,20 @@ def _init_settings(self):
         Extends the default method to handle settingsmeta defaults locally
         """
         super()._init_settings()
-        skill_settings = get_local_settings(self._settings_path)
+        skill_settings = get_local_settings(self.settings_path)
         settings_from_disk = dict(skill_settings)
         self.settings = dict_update_keys(skill_settings,
                                          self._read_default_settings())
         if self.settings != settings_from_disk:
             if isinstance(self.settings, JsonStorage):
                 self.settings.store()
             else:
-                with open(self._settings_path, "w+") as f:
+                with open(self.settings_path, "w+") as f:
                     json.dump(self.settings, f, indent=4)
         self._initial_settings = dict(self.settings)
 
     def _init_settings_manager(self):
+        # TODO: Same as upstream implementation?
         from ovos_workshop.settings import SkillSettingsManager
         self.settings_manager = SkillSettingsManager(self)