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

Speed up reconnects by caching state serialize #93050

Merged
merged 2 commits into from May 16, 2023
Merged

Speed up reconnects by caching state serialize #93050

merged 2 commits into from May 16, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 14, 2023

Proposed change

This will help with:

  • mobile app reconnects (still uses get_states)
  • frontend reconnects (using subscribe_entities)
  • third party reconnects (most still using get_states)

This solves one of the last performance bottlenecks on the list. This makes a noticeable difference on how fast the frontend can be usable on reconnects. The goal is to be able to load the frontend as fast as possible from phone pickup / unlock / control device. The bulk of the waiting is now on the frontend code (this continues to improve)

This is what the flame graph looks like for restoring a frontend connection before:
Screenshot 2023-05-14 at 1 52 20 AM

After
Screenshot 2023-05-14 at 1 56 08 AM

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 Black (black --fast 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:

This will help with:
- mobile app reconnects (still uses get_states)
- frontend reconnects (using subscribe_entities)
- third party reconnects (most still using get_states)
@home-assistant
Copy link

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

Code owner commands

Code owners of websocket_api 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 websocket_api Removes the current integration label and assignees on the pull request, add the integration domain after the command.

homeassistant/core.py Outdated Show resolved Hide resolved
homeassistant/core.py Outdated Show resolved Hide resolved
homeassistant/core.py Outdated Show resolved Hide resolved
@bdraco bdraco marked this pull request as ready for review May 14, 2023 13:22
@bdraco bdraco requested a review from a team as a code owner May 14, 2023 13:22
@bdraco
Copy link
Member Author

bdraco commented May 15, 2023

Been using this for a bit now. No more delay waiting for the reconnect when opening HA on my phone after the phone has gone to sleep

Copy link
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

LGTM

) -> None:
"""Send handle get states response."""
connection.send_message(
_HANDLE_GET_STATES_TEMPLATE.replace(
Copy link
Member Author

Choose a reason for hiding this comment

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

In a future PR I think we can make this a bit more efficient by making a function and can construct event and result messages without replace. I'm going to explore that and if successful will do a PR that does that for every place we do this. I am not 100% sure it will work, just an idea at this point

@@ -1260,6 +1263,8 @@ def __init__(
self.domain, self.object_id = split_entity_id(self.entity_id)
self._as_dict: ReadOnlyDict[str, Collection[Any]] | None = None
self._as_compressed_state: dict[str, Any] | None = None
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can drop the unserialized cache in a future PR to save a small bit of RAM but need to verify it's always covered by the serialized cache.

@bdraco
Copy link
Member Author

bdraco commented May 16, 2023

Thanks

@bdraco bdraco merged commit 99265a9 into dev May 16, 2023
52 checks passed
@bdraco bdraco deleted the ios_reconnects branch May 16, 2023 07:33
@bdraco
Copy link
Member Author

bdraco commented May 16, 2023

This also eliminated the spikes I would see in my cpu graphs when the desktop or iOS app would reconnect

@Anto79-ops
Copy link

thank you.

@github-actions github-actions bot locked and limited conversation to collaborators May 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants