Skip to content

Update Coordinator: Only schedule a refresh if listenerrs#34317

Merged
balloob merged 1 commit intodevfrom
fix-update-coordinator-refresh
Apr 16, 2020
Merged

Update Coordinator: Only schedule a refresh if listenerrs#34317
balloob merged 1 commit intodevfrom
fix-update-coordinator-refresh

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented Apr 16, 2020

Breaking change

Proposed change

Data Update Coordinator would always schedule a refresh after a refresh, even if there are no listeners. This could cause a memory leak if the coordinator was no longer used.

Issue found by @bieniu and @amelchio

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

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

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@balloob balloob added this to the 0.108.6 milestone Apr 16, 2020
@probot-home-assistant probot-home-assistant Bot added core small-pr PRs with less than 30 lines. type: bugfix labels Apr 16, 2020
@cgtobi cgtobi changed the title Update Coordinator: Only schedule a refresh if listenerrs Update Coordinator: Only schedule a refresh if listeners Apr 16, 2020
Copy link
Copy Markdown
Contributor

@cgtobi cgtobi left a comment

Choose a reason for hiding this comment

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

LGTM

@balloob balloob changed the title Update Coordinator: Only schedule a refresh if listeners Update Coordinator: Only schedule a refresh if listenerrs Apr 16, 2020
@balloob balloob merged commit ff469cb into dev Apr 16, 2020
@balloob balloob deleted the fix-update-coordinator-refresh branch April 16, 2020 23:44
@balloob balloob mentioned this pull request Apr 17, 2020
@lock lock Bot locked and limited conversation to collaborators Apr 19, 2020
@balloob balloob added the bugfix label May 4, 2020
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.

3 participants