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.

Sign up for GitHub

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

Jump to bottom

Add cloud tts entity #108293

Merged
merged 6 commits into from
Jan 22, 2024
Merged

Add cloud tts entity #108293

merged 6 commits into from
Jan 22, 2024

Conversation

MartinHjelmare
Copy link
Member

@MartinHjelmare MartinHjelmare commented Jan 18, 2024 •
edited
Loading

Breaking change

Proposed change

  • Add cloud tts entity.
  • Migrate assist pipelines that use the old cloud tts engine to the new cloud tts entity engine.
  • Update synchronization to avoid deadlock, while still making sure that required resources are available.
  • For now, we'll keep the legacy cloud tts provider and set it up to allow users that use the corresponding service to still use that. We haven't decided if and when we want to deprecate that.

TODO:

  • Complete tests
  • Check that no more migration is required.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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
  • I have followed the perfect PR recommendations
  • 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:

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

  • The manifest file 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/cloud, mind taking a look at this pull request as it has been labeled with an integration (cloud) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of cloud can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign cloud Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@MartinHjelmare MartinHjelmare marked this pull request as ready for review January 22, 2024 14:49
emontnemery
emontnemery requested changes Jan 22, 2024
View reviewed changes
homeassistant/components/cloud/__init__.py
@@ -288,9 +288,11 @@ async def async_startup_repairs(_: datetime) -> None:
loaded = False
stt_platform_loaded = asyncio.Event()
tts_platform_loaded = asyncio.Event()
stt_tts_entities_added = asyncio.Event()
hass.data[DATA_PLATFORMS_SETUP] = {
Copy link
Contributor

Choose a reason for hiding this comment

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

This should really be a dataclass instance instead. OK to do in a follow-up if it adds too much noise to this PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I'll clean it up in the next PR.

homeassistant/components/cloud/__init__.py
@@ -330,6 +332,7 @@ async def _on_initialized() -> None:

account_link.async_setup(hass)

# Load legacy tts platform for backwards compatibility.
Copy link
Contributor

Choose a reason for hiding this comment

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

How long do we need to maintain this compatibility? If it can be removed 2025.2 it makes sense to mention that also in this comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

We haven't decided if and when we want to deprecate it.

homeassistant/components/cloud/__init__.py Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 22, 2024 14:59
@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.

@emontnemery emontnemery marked this pull request as ready for review January 22, 2024 15:17
emontnemery
emontnemery approved these changes Jan 22, 2024
View reviewed changes
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @MartinHjelmare 👍

@MartinHjelmare MartinHjelmare merged commit e086cd9 into dev Jan 22, 2024
53 checks passed
@MartinHjelmare MartinHjelmare deleted the add-cloud-tts-entity branch January 22, 2024 16:24
catsmanac pushed a commit to catsmanac/ha-core-dev that referenced this pull request Jan 23, 2024
@MartinHjelmare @catsmanac
Add cloud tts entity (home-assistant#108293)
e86e48f 
* Add cloud tts entity

* Test test_login_view_missing_entity

* Fix pipeline iteration for migration

* Update tests

* Make migration more strict

* Fix docstring
@github-actions github-actions bot locked and limited conversation to collaborators Jan 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@emontnemery emontnemery emontnemery approved these changes

Assignees
No one assigned
Labels
by-code-owner cla-signed core has-tests integration: cloud new-feature Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@MartinHjelmare @emontnemery