Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: stop DRY #325

Merged
merged 1 commit into from
Jan 9, 2025
Merged

fix: stop DRY #325

merged 1 commit into from
Jan 9, 2025

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Jan 9, 2025

no need for 2 handlers, decrease complexity

the only difference is an emitted event that is not listened too anywhere

follow up on #323

Summary by CodeRabbit

  • Refactor
    • Updated skill stop event handling to use a more session-aware approach
    • Replaced general stop method with a session-specific stop method

no need for 2 handlers, decrease complexity

the only difference is an emitted event that is not listened too anywhere
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request modifies the event handling for the "mycroft.stop" signal in the OVOSSkill class. The existing _handle_stop method has been removed, and the event registration now points to a new _handle_session_stop method. This change shifts the approach to stopping skills from a general stop action to a more session-aware method of handling stop events, potentially improving how skills manage their state during stop requests.

Changes

File Change Summary
ovos_workshop/skills/ovos.py - Removed _handle_stop method
- Updated event registration for "mycroft.stop" to use _handle_session_stop

Sequence Diagram

sequenceDiagram
    participant Skill
    participant SessionManager
    participant Message

    Message->>Skill: mycroft.stop event
    Skill->>SessionManager: _handle_session_stop()
    SessionManager->>Skill: stop_session()
    Skill-->>Message: Handle stop request
Loading

Possibly related PRs

Suggested labels

fix

Poem

🐰 A rabbit's tale of skill and grace,
Where stop events find their new place,
Sessions dance, control flows neat,
A code refactor, oh so sweet!
Hop along, my digital friend! 🚀


📜 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 4d86161 and 61d1285.

📒 Files selected for processing (1)
  • ovos_workshop/skills/ovos.py (1 hunks)
🔇 Additional comments (1)
ovos_workshop/skills/ovos.py (1)

1169-1169: LGTM! Good improvement in code organization.

The change to use _handle_session_stop for both skill-specific and global stop events is a good improvement that:

  1. Reduces code duplication by eliminating redundant handler
  2. Improves session awareness in stop handling
  3. Maintains the same functionality while reducing complexity

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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
🪧 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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@github-actions github-actions bot added the fix label Jan 9, 2025
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.05%. Comparing base (43bfe5b) to head (61d1285).
Report is 19 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #325      +/-   ##
==========================================
- Coverage   49.27%   49.05%   -0.23%     
==========================================
  Files          37       37              
  Lines        4426     4430       +4     
==========================================
- Hits         2181     2173       -8     
- Misses       2245     2257      +12     

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

@github-actions github-actions bot added fix and removed fix labels Jan 9, 2025
@JarbasAl JarbasAl merged commit 61c3ed4 into dev Jan 9, 2025
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant