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

Fix shutdown being delayed for cancelling tasks #93287

Merged
merged 3 commits into from May 21, 2023
Merged

Fix shutdown being delayed for cancelling tasks #93287

merged 3 commits into from May 21, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 19, 2023

Breaking change

Home Assistant will no longer wait for cancelling tasks at shutdown when running with cpython 3.11 or later.

Proposed change

cpython 3.11 introduced the concept of cancelling
https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancelling

Once a task is being cancelled we should no longer block waiting for it since we can end up waiting multiple minutes for a long polling http request, udp discovery, etc that has already received cancellation but cancellation has not fully propagated to full stack. This is common with anyio since it won't finish the cancellation until the timeout expires.

Fixes

2023-05-19 18:52:49.856 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='c200 background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.858 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='HD-IPC background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.859 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='e1 reolink background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.860 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='Amcrest background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.860 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='LC background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.861 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='flux_led-discovery' coro=<async_setup.<locals>._async_discovery() running at /usr/src/homeassistant/homeassistant/components/flux_led/__init__.py:97> wait_for=<_GatheringFuture pending cb=[Task.task_wakeup()]> cb=[set.remove(), set.remove()]>

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:

Pythnon 3.11 introduced the concept of cancelling
https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancelling

Once a task is being cancelled we should no longer block waiting
for it.

Fixes
```
2023-05-19 18:52:49.856 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='c200 background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.858 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='HD-IPC background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.859 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='e1 reolink background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.860 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='Amcrest background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.860 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='LC background pull messages' coro=<PullPointManager._async_pull_messages() running at /usr/src/homeassistant/homeassistant/components/onvif/event.py:354> wait_for=<Future cancelled> cb=[set.remove(), set.remove()]>
2023-05-19 18:52:49.861 WARNING (MainThread) [homeassistant.core] Shutdown stage 0: still running: <Task cancelling name='flux_led-discovery' coro=<async_setup.<locals>._async_discovery() running at /usr/src/homeassistant/homeassistant/components/flux_led/__init__.py:97> wait_for=<_GatheringFuture pending cb=[Task.task_wakeup()]> cb=[set.remove(), set.remove()]>
@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels May 19, 2023
@bdraco bdraco changed the title Do not block for cancelling tasks Fix shutdown being delayed for cancelling tasks May 19, 2023
@bdraco bdraco marked this pull request as ready for review May 19, 2023 21:57
@bdraco bdraco requested review from epenet and a team as code owners May 19, 2023 21:57
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

LGTM, thanks, @bdraco 👍

../Frenck

@frenck frenck merged commit 780f9bc into dev May 21, 2023
52 checks passed
@frenck frenck deleted the cancelling_tasks branch May 21, 2023 12:17
@bdraco
Copy link
Member Author

bdraco commented May 21, 2023

thanks

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

Successfully merging this pull request may close these issues.

None yet

3 participants