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 data update coordinator garbage collection #137299

Merged
merged 3 commits into from
Feb 4, 2025
Merged

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Feb 4, 2025

Proposed change

When unloading a config entry, coordinators are automatically "shut down" via

if self.config_entry:
self.config_entry.async_on_unload(self.async_shutdown)

The linked debouncer is also automatically "shut down" via

self._debounced_refresh.async_shutdown()

However, the debouncer holds a hard reference to the coordinator via the coordinator function, both directly and via the HassJob wrapper

self._function = function
if self._job is None or function != self._job.target:
self._job = HassJob(
function,
f"debouncer cooldown={self.cooldown}, immediate={self.immediate}",
)

These hard references prevent both the coordinator and the debouncer from being garbage collected.

Related to #137237

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:
  • Link to developer documentation pull request:
  • Link to frontend 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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

@home-assistant home-assistant bot added bugfix cla-signed core small-pr PRs with less than 30 lines. labels Feb 4, 2025
@epenet epenet marked this pull request as ready for review February 4, 2025 08:58
@epenet epenet requested a review from a team as a code owner February 4, 2025 08:58
Copy link
Contributor

@DCSBL DCSBL 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!

@edenhaus edenhaus added this to the 2025.2.0 milestone Feb 4, 2025
@edenhaus edenhaus merged commit c3b40e6 into dev Feb 4, 2025
46 checks passed
@edenhaus edenhaus deleted the epenet-20250204-0851 branch February 4, 2025 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants