feat: ww verifier

[JarbasAl]

Summary by CodeRabbit

• New Features

  • Added support for wake word verifier plugins, including discovery and loading so third-party verifiers can be integrated.
  • Introduced a verifier interface to standardize verifier implementations.

• Improvements

  • Added new plugin type identifiers for verifier plugins.
  • Improved type safety and annotations across wake word plugin management.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a HotWordVerifier abstract class and verifier plugin support: new plugin enum entries, discovery and loader functions for verifier plugins, and a type annotation change for HotWordEngine.update(chunk: bytes).

Changes

Cohort / File(s)	Summary
Template Definitions ovos_plugin_manager/templates/hotwords.py	Added new abstract class HotWordVerifier with verify(self, chunk: bytes) -> bool. Updated HotWordEngine.update(self, chunk: bytes) signature and added Configuration import.
Plugin Type Registry ovos_plugin_manager/utils/__init__.py	Added WAKEWORD_VERIFIER members to PluginTypes and PluginConfigTypes with values 'opm.wake_word.verifier' and 'opm.wake_word.verifier.config'.
Plugin Loading Utilities ovos_plugin_manager/wakewords.py	Added Type import; imported HotWordVerifier; changed load_wake_word_plugin() return annotation to Type[HotWordEngine]; added find_wake_word_verifier_plugins() and load_wake_word_verifier_plugin(module_name) -> Type[HotWordVerifier].

Sequence Diagram

sequenceDiagram
    participant Client
    participant WakewordsModule
    participant EntryPointRegistry
    participant VerifierPlugin as HotWordVerifier

    Client->>WakewordsModule: find_wake_word_verifier_plugins()
    WakewordsModule->>EntryPointRegistry: query 'opm.wake_word.verifier'
    EntryPointRegistry-->>WakewordsModule: {name: entrypoint, ...}
    WakewordsModule-->>Client: list of verifiers

    Client->>WakewordsModule: load_wake_word_verifier_plugin(module_name)
    WakewordsModule->>EntryPointRegistry: load entrypoint
    EntryPointRegistry-->>VerifierPlugin: Type[HotWordVerifier]
    WakewordsModule-->>Client: verifier class

    Client->>VerifierPlugin: verify(chunk: bytes)
    VerifierPlugin-->>Client: bool

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

• Check HotWordVerifier abstract API and typing consistency with HotWordEngine.
• Verify plugin enum naming and alignment with existing plugin type patterns.
• Validate discovery/loading functions use entrypoints correctly and return expected types.

Poem

🐰 A little verifier hops to the gate,
Listening closely for each wakeful state,
Plugins assemble, tiny and clever,
I twitch my nose — they bind together,
Hooray for checks that make wakewords great!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'feat: ww verifier' is vague and uses unclear abbreviations that don't clearly convey what the feature adds without additional context.	Expand the title to be more descriptive, such as 'feat: add HotWordVerifier plugin system' or 'feat: implement wake word verifier plugin support' to clearly communicate the main feature being added.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8389e6c and 6c2d240.

📒 Files selected for processing (1)

• ovos_plugin_manager/templates/hotwords.py (3 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d179e6 and 8389e6c.

📒 Files selected for processing (3)

• ovos_plugin_manager/templates/hotwords.py (3 hunks)
• ovos_plugin_manager/utils/__init__.py (2 hunks)
• ovos_plugin_manager/wakewords.py (3 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

ovos_plugin_manager/wakewords.py (2)

ovos_plugin_manager/templates/hotwords.py (2)

• HotWordEngine (21-109)
• HotWordVerifier (112-122)

ovos_plugin_manager/utils/__init__.py (3)

• find_plugins (144-173)
• PluginTypes (51-95)
• load_plugin (244-262)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: unit_tests (3.11)
• GitHub Check: unit_tests (3.10)

🔇 Additional comments (8)

ovos_plugin_manager/utils/__init__.py (2)

71-71: LGTM! New plugin type follows the existing pattern.

The WAKEWORD_VERIFIER plugin type is correctly defined and follows the established naming convention.

---

118-118: LGTM! Config type correctly mirrors the plugin type.

The WAKEWORD_VERIFIER config type follows the established pattern of adding .config suffix to the corresponding plugin type.

ovos_plugin_manager/templates/hotwords.py (2)

2-4: LGTM! Imports support improved typing and existing functionality.

The typing imports enhance type safety for the new HotWordVerifier class and updated method signatures, while the Configuration import supports the existing HotWordEngine initialization.

---

88-88: LGTM! Type annotation improves clarity.

Adding the bytes type annotation to the chunk parameter improves type safety and aligns with the method's docstring.

ovos_plugin_manager/wakewords.py (4)

4-4: LGTM! Type import supports improved return type annotations.

The Type import is used appropriately in the return type annotations for plugin loading functions.

---

9-9: LGTM! Import supports verifier plugin loading.

The HotWordVerifier import is correctly added to support the new verifier plugin functionality.

---

22-22: LGTM! Return type annotation improves type safety.

The Type[HotWordEngine] annotation accurately documents that this function returns an uninstantiated class.

---

32-48: LGTM! Verifier plugin functions follow established patterns.

The new find_wake_word_verifier_plugins() and load_wake_word_verifier_plugin() functions correctly mirror the existing wake word plugin functions, using the appropriate WAKEWORD_VERIFIER plugin type and return types.