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 memory leak when importing a platform fails #114602

Merged
merged 3 commits into from
Apr 2, 2024
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 1, 2024

Proposed change

Re-raising ImportError would trigger a memory leak.

I was expecting that storing ImportError was the problem but that seems fine. It was the re-raise here that triggered the leak. By making a new exception it doesn't leak.

If we can't re-raise it there is no reason to store it so I changed to store a bool. That seems much safer as it ensures we don't refactor it later and re-introduce the leak.

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

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

re-raising ImportError would trigger a memory leak
@home-assistant home-assistant bot added bugfix cla-signed core small-pr PRs with less than 30 lines. labels Apr 1, 2024
@bdraco bdraco added this to the 2024.4.0 milestone Apr 1, 2024
tests/test_loader.py Outdated Show resolved Hide resolved
tests/test_loader.py Outdated Show resolved Hide resolved
@bdraco bdraco marked this pull request as ready for review April 2, 2024 00:24
@bdraco bdraco requested a review from a team as a code owner April 2, 2024 00:25
@balloob balloob merged commit b12c69a into dev Apr 2, 2024
35 checks passed
@balloob balloob deleted the import_failure_leak branch April 2, 2024 01:36
balloob pushed a commit that referenced this pull request Apr 2, 2024
* Fix memory leak when importing a platform fails

re-raising ImportError would trigger a memory leak

* fixes, coverage

* Apply suggestions from code review
@github-actions github-actions bot locked and limited conversation to collaborators Apr 3, 2024
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.

Yaml reload causes memory % increase which is not released
3 participants