feat:fallback_plugins

[JarbasAl]

similar to WakeWords, allows defining a plugin to load if the primary fails

this is DIFFERENT from fallback TTS/STT, it isnt loaded at same time but instead when main plugin fails to load for any reason

companion to OpenVoiceOS/ovos-plugin-manager#263

Summary by CodeRabbit

• New Features

  • Enhanced microphone configuration with a robust fallback mechanism for improved audio input compatibility.
  • Expanded voice activity detection (VAD) capabilities with additional fallback modules for better speech detection.
  • Updated grapheme-to-phoneme processing for improved phoneme generation accuracy.
  • Enriched translation and language detection modules with fallback configurations for increased resilience.

• Bug Fixes

  • Adjusted initialization of configuration variables to ensure proper data handling.

[coderabbitai]

Walkthrough

The changes include significant updates to the mycroft.conf configuration file, enhancing the structure of microphone, voice activity detection (VAD), and language processing modules. New fallback mechanisms have been introduced for various plugins, improving audio input selection and speech detection reliability. Additionally, the G2P module has been updated to utilize a more advanced processing method. The unit test file has also been modified to reflect a change in the expected data type for a configuration variable.

Changes

Files	Change Summary
ovos_config/mycroft.conf	Enhanced microphone and VAD configurations with fallback mechanisms; updated G2P and translation modules.
test/unittests/test_configuration.py	Modified initialization of thread_config from None to an empty dictionary.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Microphone
    participant VAD
    participant G2P
    participant Translation

    User->>Microphone: Request audio input
    Microphone->>VAD: Process audio for speech detection
    VAD->>G2P: Convert graphemes to phonemes
    G2P->>Translation: Translate phonemes to target language
    Translation-->>User: Deliver translated output

Loading

🐰 In a world of sound and speech,
Fallbacks help us reach,
With plugins lined in a row,
Robustness starts to grow.
A hop, a skip, a leap so bright,
Our voices dance in pure delight! 🎶

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2730583 and 6ce7391.

Files selected for processing (2)

• ovos_config/mycroft.conf (4 hunks)
• test/unittests/test_configuration.py (1 hunks)

Additional comments not posted (12)

test/unittests/test_configuration.py (1)

225-225: LGTM!

The change to initialize thread_config as an empty dictionary instead of None is approved. This aligns with the usage of thread_config in the _wait_for_changes function and improves the code by explicitly initializing it with the expected type.

ovos_config/mycroft.conf (11)

491-493: LGTM!

The changes introduce a robust fallback mechanism for the microphone module. If the primary "ovos-microphone-plugin-sounddevice" fails to load, it will attempt to load "ovos-microphone-plugin-alsa" and then "ovos-microphone-plugin-pyaudio". This improves compatibility across different operating systems.

---

525-543: LGTM!

The changes introduce a layered fallback approach for the VAD module. If the primary "ovos-vad-plugin-silero" fails to load, it will attempt to load "ovos-vad-plugin-precise", then "ovos-vad-plugin-webrtcvad", and finally "ovos-vad-plugin-noise". Each fallback module has its own configuration parameters. This enhances the system's ability to handle various audio conditions and improves speech detection reliability.

---

748-749: LGTM!

The changes introduce a fallback mechanism for the G2P module. If the primary "ovos-g2p-plugin-mimic" fails to load, it will attempt to load the fallback module "ovos-g2p-plugin-heuristic-arpa". This suggests a shift towards a more advanced G2P processing method, potentially improving phoneme generation accuracy.

---

766-766: LGTM!

The change sets the language detection module to "ovos-lang-detector-plugin-server", which uses public servers for language detection.

---

767-768: LGTM!

The changes set the translation module to "ovos-translate-plugin-server", which uses public servers for translation. It also defines a fallback module "ovos-google-translate-plugin" to use if the primary module fails to load. This ensures that if the primary translation module encounters issues, an alternative can be utilized.

---

770-771: LGTM!

The changes define a chain of fallback modules for the language detection module. If the primary module fails to load, it will attempt to load "ovos-google-lang-detector-plugin" and then "ovos-lang-detector-plugin-cld3". This enhances the overall resilience of the language detection system.

---

772-772: LGTM!

The change adds another fallback module to the language detection module chain. If the "ovos-lang-detector-plugin-cld3" module fails to load, it will attempt to load the "ovos-lang-detector-plugin-cld2" module. This further enhances the resilience of the language detection system.

---

773-773: LGTM!

The change adds yet another fallback module to the language detection module chain. If the "ovos-lang-detector-plugin-cld2" module fails to load, it will attempt to load the "ovos-lang-detector-plugin-langdetect" module. This continues to enhance the resilience of the language detection system.

---

774-774: LGTM!

The change adds another fallback module to the language detection module chain. If the "ovos-lang-detector-plugin-langdetect" module fails to load, it will attempt to load the "ovos-lang-detector-plugin-fastlang" module. This further enhances the resilience of the language detection system.

---

775-775: LGTM!

The change adds another fallback module to the language detection module chain. If the "ovos-lang-detector-plugin-fastlang" module fails to load, it will attempt to load the "ovos-lang-detector-plugin-lingua-podre" module. This continues to enhance the resilience of the language detection system.

---

776-776: LGTM!

The change adds a final fallback module to the language detection module chain. If the "ovos-lang-detector-plugin-fastlang" module fails to load, it will attempt to load the "ovos-lang-detect-ngram-lm" module. This completes the chain of fallback modules for the language detection system, ensuring maximum resilience.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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@2730583). Learn more about missing BASE report.

Additional details and impacted files

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

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

[JarbasAl]

note: not a breaking change because this fails to load by default