Interpret VoiceAssistantCommand(start=False) as abort

[synesthesiam]

We need to be able to distinguish between a pipeline ending because of on-device VAD and being cancelled/aborted because of a new wake-up or button press.

This PR splits these two cases apart as:

• VoiceAssistantCommand(start=False) aborts the pipeline (calls handle_stop(abort=True))
• VoiceAssistantAudio(end=True) stops the pipeline by ending the audio stream (calls handle_stop(abort=False))

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the handle_stop callback function's signature in the aioesphomeapi/client.py file, allowing it to accept a boolean argument. This update enhances the control flow by differentiating between normal stops and aborts in the voice assistant subscription process. Corresponding adjustments are made in the test cases to ensure proper handling and assertions for both scenarios.

Changes

File	Change Summary
aioesphomeapi/client.py	Updated handle_stop to accept a boolean argument; modified calls in subscribe_voice_assistant and _on_voice_assistant_request.
tests/test_client.py	Modified handle_stop to accept a boolean parameter; updated test cases to handle and assert normal stops and aborts.

Assessment against linked issues

Objective	Addressed	Explanation
N/A	❌	No linked issues were provided.

Possibly related issues

• None

Possibly related PRs

• Add handle_announcement_finished callback #954: This PR modifies the subscribe_voice_assistant function, which is directly related to the changes made in this PR regarding the function's parameters and callback handling.

Suggested labels

new-feature

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2a0bbf and 49ae6d6.

Files selected for processing (2)

• aioesphomeapi/client.py (4 hunks)
• tests/test_client.py (15 hunks)

Additional context used

Path-based instructions (2)

aioesphomeapi/client.py (1)

Pattern **: - Do not generate or add any sequence diagrams

tests/test_client.py (1)

Pattern **: - Do not generate or add any sequence diagrams

Additional comments not posted (4)

aioesphomeapi/client.py (2)

Line range hint 1284-1305: Excellent enhancement to the handle_stop callback signature!

The addition of the boolean parameter to differentiate between a normal stop and an abort scenario greatly improves the clarity and control flow of the voice assistant subscription process. This change aligns perfectly with the PR objective to enhance the distinction between the two pipeline end scenarios.

The updated calls to handle_stop within the function, passing True for an abort and False for a normal stop, ensure that the appropriate action is taken based on the scenario.

Overall, this is a well-implemented and valuable improvement to the voice assistant subscription functionality.

---

Line range hint 1346-1356: Proper handling of VoiceAssistantCommand(start=False) as an abort command.

The changes correctly interpret VoiceAssistantCommand(start=False) as an abort command and call handle_stop(True) to properly abort the pipeline in that scenario. This implementation aligns with the PR objective to distinguish between a normal stop and an abort scenario.

Good job on implementing this new behavior!

tests/test_client.py (2)

2238-2242: LGTM!

The handle_stop function correctly handles the new abort parameter to differentiate between a normal stop and an abort. The logic of appending to the respective stops or aborts list based on the abort value is implemented accurately.

---

2322-2326: Duplicate function

This handle_stop function is a duplicate of the one defined earlier at line 2238. It has the same logic of handling the abort parameter.

Consider removing this duplicate function definition to keep the code DRY (Don't Repeat Yourself).

---

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a2a0bbf) to head (49ae6d6).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #957   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines         2641      2641           
=========================================
  Hits          2641      2641           

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