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 task leak on config entry unload/retry #96981

Merged
merged 1 commit into from Jul 21, 2023
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jul 21, 2023

Proposed change

Since the task was added to self._tasks without a task.add_done_callback(self._tasks.remove) each unload/retry would leak a new set of tasks.

Depending on how often config entries reloaded or retried this was a slow leak or a fast one. In my case it was a slow leak because I only had one config entry that was retrying over and over again. See the profile in #96980 for more details.

regressed in #91531

fixes #96980 likely also fixes #93713

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:

Since the task was added to self._tasks without a `task.add_done_callback(self._tasks.remove)`
each unload/retry would leak a new set of tasks
@bdraco bdraco added this to the 2023.7.3 milestone Jul 21, 2023
@home-assistant home-assistant bot added bugfix cla-signed core small-pr PRs with less than 30 lines. labels Jul 21, 2023
@bdraco bdraco mentioned this pull request Jul 21, 2023
@bdraco bdraco marked this pull request as ready for review July 21, 2023 00:22
@bdraco bdraco requested a review from a team as a code owner July 21, 2023 00:22
@bdraco
Copy link
Member Author

bdraco commented Jul 21, 2023

manually confirmed leak is gone with

@@ -696,9 +696,16 @@ class ConfigEntry:
         for task in self._background_tasks:
             task.cancel(cancel_message)
 
-        _, pending = await asyncio.wait(
-            [*self._tasks, *self._background_tasks], timeout=10
+        tasks = [*self._tasks, *self._background_tasks]
+        if tasks:
+            _LOGGER.warning(
+                "Config entry %s with domain %s is being unloaded, waiting for tasks: %s, background tasks: %s",
+                self.entry_id,
+                self.domain,
+                self._tasks,
+                self._background_tasks,
             )
+        _, pending = await asyncio.wait(tasks, timeout=10)
 
         for task in pending:
             _LOGGER.warning(
@@ -917,7 +924,17 @@ class ConfigEntriesFlowManager(data_entry_flow.FlowManager):

tasks no longer build up

@balloob balloob merged commit 9fba687 into dev Jul 21, 2023
51 checks passed
@balloob balloob deleted the fix_task_leak_on_setup_retry branch July 21, 2023 01:00
frenck pushed a commit that referenced this pull request Jul 21, 2023
Since the task was added to self._tasks without a `task.add_done_callback(self._tasks.remove)`
each unload/retry would leak a new set of tasks
@github-actions github-actions bot locked and limited conversation to collaborators Jul 22, 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.

Config entry tasks are being leaked Homeassistant container memory leak - Out of Memory
3 participants