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

Significantly reduce websocket api connection auth phase latency #108564

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jan 21, 2024

Proposed change

I started looking at the auth phase timings as a result of testing #108428 and noticed initial auth on the websocket connection took about 35-60ms locally.

Since the auth phase has exclusive control over the websocket until ActiveConnection is created, we can bypass the queue and send messages right away. This reduces the latency and reconnect time since we do not have to wait for the background processing of the queue to send the auth required/ok messages.

Additionally we now only start the queue consumer aka _writer if auth is successful since we no longer need it for auth failure cases. This saves some cpu cycles if there are a lot of failed auth attempts (ie brute force attacks).

locally its much faster
Screenshot 2024-01-20 at 11 27 19 PM

remote on local network is almost as good
Screenshot 2024-01-20 at 11 26 04 PM

and remote ~4000 miles away with >100ms ping time
Screenshot 2024-01-20 at 11 27 19 PM

On average this saves ~30ms of latency on reconnect/wake

My test install also has aiohttp 3.10.x and jpadilla/pyjwt#940 which also helps improve the performance

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:

Since the auth phase has exclusive control over the websocket
until ActiveConnection is created, we can bypass the queue and
send messages right away. This reduces the latancy and reconnect
time since we do not have to wait for the background processing
of the queue to send the auth ok message.
@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.
  • @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.

@bdraco bdraco changed the title Significantly reduce websocket api connection auth phase latancy Significantly reduce websocket api connection auth phase latency Jan 21, 2024
@bdraco bdraco marked this pull request as ready for review January 21, 2024 09:58
@bdraco bdraco requested a review from a team as a code owner January 21, 2024 09:58
Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

Sweet

@balloob balloob merged commit dbb5645 into dev Jan 22, 2024
53 checks passed
@balloob balloob deleted the reduce_websocket_connection_setup_latency branch January 22, 2024 03:33
@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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants