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 websocket and ingress with aiohttp-zlib-ng #103247

Merged
merged 3 commits into from Nov 2, 2023
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 2, 2023

Proposed change

https://github.com/bdraco/aiohttp-zlib-ng
https://github.com/pycompression/python-zlib-ng

zlib-ng was choosen because:

Other alternatives (https://bugs.python.org/issue41566) where not choosen because:

python-isal: https://github.com/pycompression/python-isal: not widely compatible, not a drop-in replacement
libdeflate: no stream implementation, not a drop-in replacement

wheels have built successfully: https://wheels.home-assistant.io/musllinux/

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:

https://github.com/bdraco/aiohttp-zlib-ng
https://github.com/pycompression/python-zlib-ng

zlib-ng was choosen because:

- Its at the point where cloudflare is using it in production
- Its a drop-in replacement for zlib with no code changes needed
- Fedora is talking about making it the default zlib implementation https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/CDNPJ4SOTRQMYVCDI3ZSY4SP4FYESCWD/
- well maintained https://github.com/zlib-ng/zlib-ng/releases
- It has significant performance improvements over stock zlib https://www.phoronix.com/news/Zlib-ng-2.1-Beta

Other alternatives (https://bugs.python.org/issue41566) where not choosen because:

python-isal: https://github.com/pycompression/python-isal: not widely
compatible, not a drop-in replacement
libdeflate: no stream implementation, not a drop-in replacement
@home-assistant
Copy link

home-assistant bot commented Nov 2, 2023

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

Code owner commands

Code owners of http 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 http 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 Nov 2, 2023

anything that is added as a dep to http needs to be a core dep because its too late to import it otherwise

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/bdraco/home-assistant/homeassistant/runner.py", line 17, in <module>
    from . import bootstrap
  File "/Users/bdraco/home-assistant/homeassistant/bootstrap.py", line 20, in <module>
    from .components import http
  File "/Users/bdraco/home-assistant/homeassistant/components/http/__init__.py", line 46, in <module>
    from .auth import async_setup_auth
  File "/Users/bdraco/home-assistant/homeassistant/components/http/auth.py", line 21, in <module>
    from homeassistant.components import websocket_api
  File "/Users/bdraco/home-assistant/homeassistant/components/websocket_api/__init__.py", line 13, in <module>
    from . import commands, connection, const, decorators, http, messages  # noqa: F401
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/bdraco/home-assistant/homeassistant/components/websocket_api/commands.py", line 54, in <module>
    from . import const, decorators, messages
  File "/Users/bdraco/home-assistant/homeassistant/components/websocket_api/decorators.py", line 15, in <module>
    from .connection import ActiveConnection
  File "/Users/bdraco/home-assistant/homeassistant/components/websocket_api/connection.py", line 13, in <module>
    from homeassistant.components.http import current_request
ImportError: cannot import name 'current_request' from partially initialized module 'homeassistant.components.http' (most likely due to a circular import) (/Users/bdraco/home-assistant/homeassistant/components/http/__init__.py)

@bdraco bdraco marked this pull request as ready for review November 2, 2023 17:39
@bdraco bdraco requested a review from a team as a code owner November 2, 2023 17:39
Copy link
Member

@jpbede jpbede left a comment

Choose a reason for hiding this comment

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

I've tested this in my local dev environment and prod environment with addons, everything works fine. No visible break in ingress or websocket while using. Ingress felt more responsive, but haven't measured this.

@bdraco
Copy link
Member Author

bdraco commented Nov 2, 2023

Thanks for testing 👍

@bdraco
Copy link
Member Author

bdraco commented Nov 2, 2023

Pushed to a few more production systems. All good

@bdraco
Copy link
Member Author

bdraco commented Nov 2, 2023

mysql test failure is unrelated. still don't know why that times out.

@bdraco bdraco merged commit 45f5c21 into dev Nov 2, 2023
52 of 53 checks passed
@bdraco bdraco deleted the aiohttp_zlib_ng branch November 2, 2023 20:18
@github-actions github-actions bot locked and limited conversation to collaborators Nov 3, 2023
@sairon
Copy link
Member

sairon commented Dec 21, 2023

This change is probably cause of this regression, where the Core fails to start completely on CPUs that don't support some modern instruction sets used by our zlib-ng build: #105254

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