feat:ovos.common_play.search.populate event

[JarbasAl]

new bus event to allow replacing the search results explicitly, meant for usage by ocp pipeline

fixes handling of Playlist objects when populating playlist/search result, while keeping compat with utils<=0.0.38

companion to OpenVoiceOS/ovos-ocp-audio-plugin#139

Summary by CodeRabbit

• New Features

  • Introduced a method to populate search results with new tracks, allowing for replacement or extension of existing results and sorting by confidence.
  • Enhanced playback functionality to better handle playlists and provide clearer context during playback.

• Bug Fixes

  • Improved error handling for potential import issues, ensuring smoother operation.

[coderabbitai]

Walkthrough

The changes introduce a new method populate_search_results in the OCP class, allowing for the addition and sorting of search results based on confidence. The play method has been updated to better handle track inputs, specifically playlists, and includes error handling for imports. These modifications enhance the functionality of the OCP by improving search result management and playback processes.

Changes

Files	Change Summary
ovos_bus_client/apis/ocp.py	- Added populate_search_results(self, tracks: list, replace: bool = True, sort_by_conf: bool = True, source_message: Optional[Message] = None) method. - Modified play(self, tracks: list, utterance=None, source_message: Optional[Message] = None) method for better track handling and error logging.

Poem

🐰 In the land of code where rabbits play,
New tracks hop in, brightening the day.
With searches refined and playlists in tow,
The OCP dances, putting on a show!
Hopping through changes, we cheer and we sway,
For every new feature, we joyfully say! 🌟

---

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>, please review it.
  -- 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 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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

ovos_bus_client/apis/ocp.py (1)

375-381: Minor: Remove unused variable assignment.

The changes look good, but there's a minor issue flagged by the static analysis tool:

• The e variable is assigned to but never used in the except block.

To fix this, simply remove the assignment to the unused e variable:

-        except ImportError as e:
+        except ImportError:
             LOG.warning("can't handle Playlist results properly, please update ovos-utils to >= 0.1.0")

Tools

Ruff

376-376: ovos_utils.ocp.MediaEntry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.PluginStream imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.dict2entry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

380-380: Local variable e is assigned to but never used

Remove assignment to unused variable e

(F841)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 85205c6 and 441bf2c.

Files selected for processing (1)

• ovos_bus_client/apis/ocp.py (2 hunks)

Additional context used

Ruff

ovos_bus_client/apis/ocp.py

376-376: ovos_utils.ocp.MediaEntry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.PluginStream imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.dict2entry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

380-380: Local variable e is assigned to but never used

Remove assignment to unused variable e

(F841)

Additional comments not posted (2)

ovos_bus_client/apis/ocp.py (2)

347-361: LGTM!

The populate_search_results function looks good. It correctly normalizes the input tracks and emits a bus message to populate the search results with the appropriate options.

---

Line range hint 362-387: The updated play function looks good!

The changes enhance the handling of Playlist objects and provide better context for playback and disambiguation. The function is also backward compatible and handles potential import errors gracefully.

Tools

Ruff

376-376: ovos_utils.ocp.MediaEntry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.PluginStream imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

376-376: ovos_utils.ocp.dict2entry imported but unused; consider using importlib.util.find_spec to test for availability

(F401)

---

380-380: Local variable e is assigned to but never used

Remove assignment to unused variable e

(F841)