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 message corruption in picotts component #141182

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

lukakama
Copy link

@lukakama lukakama commented Mar 23, 2025

Breaking change

Proposed change

This fixes #93456, by sending the message to pico2wave subprocess using the stdin instead of command line arguments, as command line arguments seem to cause issues without a clear root cause.

Usage of stdin should be security equivalent, if not more secure, to usage of command line argument in shell-less subprocesses.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the [development checklist][dev-checklist]
  • I have followed the [perfect PR recommendations][perfect-pr]
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

  • Documentation added/updated for [www.home-assistant.io][docs-repository]

If the code communicates with devices, web services, or third-party tools:

  • The [manifest file][manifest-docs] has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

  • I have reviewed two other [open pull requests][prs] in this repository.

… the newer subprocess.run method and checking the pico2wave return code.
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lukakama

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@lukakama
Copy link
Author

lukakama commented Mar 23, 2025

I was unable to run the full test suite due a lot of "No module named" errors during tests collection, using the DevContainer environment, regardless installation of all dev and test requirements.
Anyway, there are no test for the picotts platform, so I'm unsure about their usefulness in the context of this PR.

@lukakama lukakama marked this pull request as ready for review March 23, 2025 09:39
@joostlek joostlek requested a review from Copilot April 10, 2025 22:52
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

homeassistant/components/picotts/tts.py:63

  • [nitpick] Consider capturing stderr (e.g., by setting capture_output=True in subprocess.run) and logging it along with the return code to provide clearer diagnostics when pico2wave fails.
if result.returncode != 0:

data = None
try:
if result.returncode != 0:
Copy link
Preview

Copilot AI Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the error branch, the temporary file is not removed, which could lead to resource leaks. Consider adding cleanup logic (e.g., os.remove(fname)) after logging the error.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cryptic spoken output for some PicoTTS calls
1 participant