fix: stop message.context source/destination

[JarbasAl]

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of stopping skills to ensure that abort and speech stop actions only occur when appropriate, such as during active responses or speech.
• Tests
  • Updated test cases to reflect the refined stop behavior, ensuring messages are only sent under the correct conditions.
• New Features
  • Added support for a dedicated stop event to better manage skill stopping requests.

[coderabbitai]

Walkthrough

The changes update the stop service to handle "stop:skill" events with conditional logic based on utterance state and session activity before emitting stop-related messages. The match methods now return a fixed "stop:skill" type with skill ID in match data. Tests were updated to reflect these conditional emissions and clarify message expectations.

Changes

File(s)	Change Summary
ovos_core/intent_services/stop_service.py	Added handle_skill_stop event handler; refined handle_stop_confirmation to conditionally emit abort, converse timeout, and speech stop messages based on utterance state and session activity; changed match_high and match_low to use fixed "stop:skill" match type with skill ID; registered "stop:skill" event.
test/end2end/test_stop.py	Modified stop test to include source/destination in utterance context; updated expected stop message sequence with conditional comments; added "stop:skill" message expectation; configured keep_original_src to route specific messages to ovos-core only.

Poem

A rabbit pauses, mid-hop, to say:
"Stop now listens in a clever new way!
Only when needed, the messages fly,
No more shouts to the empty sky.
Tests now reflect this gentle care—
Precision in stopping, handled with flair!"
🐇✨

---

📜 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 8360737 and 9b27856.

📒 Files selected for processing (2)

• ovos_core/intent_services/stop_service.py (5 hunks)
• test/end2end/test_stop.py (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• test/end2end/test_stop.py
• ovos_core/intent_services/stop_service.py

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: unit_tests

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

ovos_core/intent_services/stop_service.py (1)

151-164: Session-level is_speaking may stop unrelated audio

if sess.is_speaking: triggers speech.stop irrespective of which skill produced the speech.
Given the TODO comment, this can inadvertently cut off TTS belonging to a different skill that happens to be speaking when the stop confirmation arrives.

Consider adding skill-scoped tracking (e.g. sess.is_speaking_from(skill_id)) before emitting the stop, or move the check to AudioService side.

test/end2end/test_stop.py (1)

198-211: Commented-out Message(...) literals clutter the expected list

Keeping the now-obsolete expectations as commented lines inside the list decreases readability and risks accidental uncommenting/merge conflicts.
Remove them or move the rationale above the list.

-            # if skill is in middle of get_response
-            #Message("mycroft.skills.abort_question", {"skill_id": self.skill_id},
-            #        {"skill_id": self.skill_id}),
...
-            # if skill is executing TTS
-            #Message("mycroft.audio.speech.stop", {"skill_id": self.skill_id},
-            #        {"skill_id": self.skill_id}),

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c904c4 and 8360737.

📒 Files selected for processing (2)

• ovos_core/intent_services/stop_service.py (2 hunks)
• test/end2end/test_stop.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: unit_tests

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
ovos_core/intent_services
service.py
stop_service.py					159-161, 170
Project Total

This report was generated by python-coverage-comment-action