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

Improve websocket throughput and reduce latency #92967

Merged
merged 11 commits into from May 12, 2023
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 11, 2023

Proposed change

related issue #90281

Since we have only one consumer we can make the implementation use a simple deque and asyncio.Future to wake the consumer when the deque is changed.

The tests were a bit light in some places so I added some more coverage as well.

_send_message fell off all the py-spys after this change. The execution flow is now much simplier:
send_message

The writer gets a similar improvement where nearly all the overhead is send_str

write_is_almost_all_aiohttp

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:

@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.

@bdraco
Copy link
Member Author

bdraco commented May 11, 2023

Put on my production. I ran py-spy. The flames with the queue inserts where before are gone. So no need to profile as this is going to make a significant difference in throughput.

@bdraco bdraco marked this pull request as ready for review May 12, 2023 02:59
@bdraco bdraco requested a review from a team as a code owner May 12, 2023 02:59
@bdraco bdraco changed the title Improve websocket throughput Improve websocket throughput and reduce latency May 12, 2023
Copy link
Contributor

@Noltari Noltari left a comment

Choose a reason for hiding this comment

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

Awesome!

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.

Looks good! Some minor suggestions on commenting the code.

homeassistant/components/websocket_api/http.py Outdated Show resolved Hide resolved
@bdraco
Copy link
Member Author

bdraco commented May 12, 2023

Thanks. Added some comments to better explain what is going on here.

@bdraco
Copy link
Member Author

bdraco commented May 12, 2023

Note to future per discord discussion

Most of the remaining overhead is in aiohttp https://github.com/aio-libs/aiohttp/blob/b2a7983aed047e36c3418e788096d7f46cea7e1e/aiohttp/http_websocket.py#L594

Some of that should improve in cpython 3.12 but the bulk of the run time is now compression which we can do little about (unless we can optimize libz).

@bdraco bdraco merged commit 8711735 into dev May 12, 2023
52 checks passed
@bdraco bdraco deleted the websocket_throughput branch May 12, 2023 15:13
@elupus
Copy link
Contributor

elupus commented May 13, 2023

This is crazy! How can a core concept like asyncio.Queue be a place to performance optimize. Feel like that should be raised to cpython level.

@bdraco
Copy link
Member Author

bdraco commented May 13, 2023

This one surprised me as well. I think asyncio.Queue is well written, and there aren't many obvious opportunities to optimize it further as the cost is mostly the synchronization overhead to allow for multiple consumers and producers which we didn't need here.

@github-actions github-actions bot locked and limited conversation to collaborators May 14, 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

4 participants