core icon indicating copy to clipboard operation
core copied to clipboard

Add support for eager tasks

Open bdraco opened this issue 4 months ago • 7 comments

Proposed change

python 3.12 supports eager tasks

  • https://docs.python.org/3/library/asyncio-task.html#eager-task-factory
  • https://github.com/python/cpython/issues/97696

There are lots of places were we are unlikely to suspend, but we might suspend so we don't replace with an loop of awaits. In this case creating an eager task makes sense instead. eager start support will be great for reducing latency of icons and translation loading via websocket since we have to create a task in the very rare event they aren't loaded yet.

Type of change

  • [ ] Dependency upgrade
  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New integration (thank you!)
  • [x] 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

  • [x] 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)
  • [x] 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:

bdraco avatar Feb 25 '24 22:02 bdraco

We have races in FAILED tests/components/netatmo/test_init.py::test_setup_component_with_config - assert 8 == 10 FAILED tests/components/eafm/test_sensor.py::test_unload_entry - AttributeError: 'NoneType' object has no attribute 'state' ERROR tests/components/dlna_dmr/test_media_player.py::test_poll_availability - AssertionError

Not so bad.

I'm going to take the entity changes out as they can be sorted out in a future PR

Let's start with websocket tasks instead

bdraco avatar Feb 25 '24 22:02 bdraco

The web socket latency reduction is awesome. The second group now arrives 1ms later than the first group instead of 30ms later

bdraco avatar Feb 25 '24 22:02 bdraco

Assuming the CI passes, I'll pull everything out that actually changes something to an eager task, add coverage, and do follow ups PRs to convert specific areas starting with the websocket

bdraco avatar Feb 25 '24 22:02 bdraco

This would probably help service calls a lot

bdraco avatar Feb 25 '24 23:02 bdraco

            self._hass.async_create_task(
                self._run_service_call_catch_exceptions(coro, service_call),
                f"service call background {service_call.domain}.{service_call.service}",
                eager_start=True,
            )

seems to work ok

bdraco avatar Feb 25 '24 23:02 bdraco

websocket latency reduction can sometimes even deliver in the same millis

bdraco avatar Feb 25 '24 23:02 bdraco

functional testing on 3.11 looks good. I know its going away soon, but fallback still needs to work for a bit

bdraco avatar Feb 26 '24 00:02 bdraco