refactor/planned_deprecations

[JarbasAl]

per #226 review

Summary by CodeRabbit

• New Features

  • Improved event handling by transitioning to updated message types that include the skill ID, enhancing specificity and clarity.

• Bug Fixes

  • Removed deprecated message types to prevent potential processing errors and streamline event handling.

• Refactor

  • Simplified event handler methods by eliminating outdated checks and logging related to deprecated message types.

[coderabbitai]

Walkthrough

The changes involve deprecating certain event message types in the _register_system_event_handlers method and related handler methods. Deprecated message types prefixed with "skill.converse" have been removed and replaced with updated types that include the skill ID. This simplifies event handling by ensuring that only messages intended for the current skill instance are processed.

Changes

Files	Change Summary
ovos_workshop/skills/ovos.py	Removed deprecated event message types and replaced them with updated counterparts that include the skill ID. Updated handler methods to process only the new event types.

Poem

🐇 In the meadow where skills do play,
New messages dance, bright as the day.
Old types have hopped away with grace,
Leaving behind a clearer space.
With each change, we leap and cheer,
For a smoother path, we hold so dear! 🌼

---

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

ovos_workshop/skills/ovos.py (1)

Line range hint 2297-2306: Simplification of converse acknowledgment logic approved.

Removing checks for deprecated message types simplifies the method and reduces potential errors. It's recommended to add unit tests to ensure that the new logic correctly handles all scenarios, especially edge cases that might not be immediately obvious.

Would you like me to help create unit tests for this method?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 44d43bd and 50730d6.

Files selected for processing (1)

• ovos_workshop/skills/ovos.py (5 hunks)

Additional comments not posted (1)

ovos_workshop/skills/ovos.py (1)

Line range hint 2151-2166: Refactor of event registration approved.

The changes to use skill-specific event types enhance security and maintainability by ensuring that events are correctly scoped to the skill instance. It's important to verify that all necessary event types are covered and that no functionality is lost due to the removal of the old event types.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@44d43bd). Learn more about missing BASE report.

Additional details and impacted files

@@          Coverage Diff           @@
##             dev     #227   +/-   ##
======================================
  Coverage       ?   52.77%           
======================================
  Files          ?       37           
  Lines          ?     4301           
  Branches       ?        0           
======================================
  Hits           ?     2270           
  Misses         ?     2031           
  Partials       ?        0           

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