feat:pipeline plugin factory

[JarbasAl]

partially split into https://github.com/OpenVoiceOS/ovos-core/pull/571

needs https://github.com/OpenVoiceOS/ovos-plugin-manager/pull/270

companion PRS:

• https://github.com/OpenVoiceOS/padacioso/pull/29
• https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/pull/14
• https://github.com/OpenVoiceOS/ovos-adapt-pipeline-plugin/pull/12
• https://github.com/OpenVoiceOS/ovos-common-query-pipeline-plugin/pull/11
• https://github.com/OpenVoiceOS/ovos-padatious-pipeline-plugin/pull/15

moved tests:

• https://github.com/OpenVoiceOS/ovos-padatious-pipeline-plugin/pull/17
• https://github.com/OpenVoiceOS/ovos-adapt-pipeline-plugin/pull/14

Summary by CodeRabbit

• New Features

  • Introduced a modular pipeline approach for improved service handling and configuration.
  • Enhanced flexibility with optional configuration parameters for various services.

• Bug Fixes

  • Improved error handling and logging during fallback attempts.

• Deprecations

  • Several methods and properties have been deprecated, with warnings provided for users to transition to the new pipeline structure.

• Refactor

  • Services have been streamlined and renamed to better reflect their roles within the new architecture.
  • Simplified initialization process in the MiniCroft class for better clarity and efficiency.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request involve a significant refactor of the IntentService and related classes within the ovos_core.intent_services module. The refactor introduces a modular pipeline factory approach, updates method signatures, and deprecates several methods and properties. The ConverseService, FallbackService, and StopService classes have been renamed and modified to align with the new pipeline structure. Import statements have been updated to reflect these changes, and logging for deprecated methods has been implemented to ensure backward compatibility.

Changes

File Path	Change Summary
ovos_core/intent_services/__init__.py	Refactored IntentService to use OVOSPipelineFactory, updated get_pipeline method, deprecated several methods, simplified shutdown process, and updated imports.
ovos_core/intent_services/converse_service.py	Renamed ConverseService to PipelineStageMatcher, updated constructor and method signatures, added deprecated method for backward compatibility, and refined message handling.
ovos_core/intent_services/fallback_service.py	Refactored FallbackService to inherit from PipelineStageConfidenceMatcher, updated method signatures, added deprecated methods for priority handling, and modified fallback configuration handling.
ovos_core/intent_services/stop_service.py	Renamed StopService to inherit from PipelineStageConfidenceMatcher, updated method signatures for priority handling, added deprecated methods, and adjusted import statements.
test/end2end/minicroft.py	Updated MiniCroft initialization to directly instantiate IntentService, removed _register_intent_services method, and streamlined metadata plugin configuration handling.
test/unittests/test_intent_service.py	Modified TestIntentServiceApi to emit messages for registering vocabulary and intents via the bus instead of direct method calls, enhancing the event-driven approach.

Possibly related PRs

• #527: The changes in this PR involve the introduction of a new pipeline structure, which aligns with the refactoring of the IntentService class in the main PR to adopt a modular pipeline architecture.
• #528: This PR modifies the IntentService class and its related components, focusing on the handling of IntentMatch, which is relevant to the changes made in the main PR regarding the handling of skills and intent matching.
• #566: This PR updates the IntentService class to improve the handling of deprecated properties and logging, which is directly related to the changes made in the main PR regarding the deprecation of several service accessors.
• #568: The focus on standardizing language handling in this PR complements the changes in the main PR that streamline the control flow and handling of skills within the IntentService.

Suggested labels

refactor, dependencies

Suggested reviewers

• goldyfruit
• j1nx
• builderjer

Poem

In the burrow deep, where pipelines flow,
A refactor's dance, with a new bright glow.
Services renamed, methods refined,
A modular world, where all's intertwined.
With deprecation warnings, we hop with glee,
In the land of code, it's a sight to see! 🐇✨

---

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

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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[bot]]

Codecov Report

Attention: Patch coverage is 82.00000% with 18 lines in your changes missing coverage. Please review.

Project coverage is 70.24%. Comparing base (23f0bab) to head (8b29a54). Report is 258 commits behind head on dev.

Files with missing lines	Patch %	Lines
ovos_core/intent_services/fallback_service.py	70.96%	9 Missing :warning:
ovos_core/intent_services/stop_service.py	82.75%	5 Missing :warning:
ovos_core/intent_services/__init__.py	88.88%	3 Missing :warning:
ovos_core/intent_services/converse_service.py	92.30%	1 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #570      +/-   ##
==========================================
- Coverage   75.33%   70.24%   -5.10%     
==========================================
  Files          15       15              
  Lines        3094     1576    -1518     
==========================================
- Hits         2331     1107    -1224     
+ Misses        763      469     -294     

Flag	Coverage Δ
unittests	46.95% <82.00%> (-28.39%)	:arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.