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

Simplify emulated_hue exposed entities cache #109890

Merged
merged 1 commit into from Feb 10, 2024
Merged

Simplify emulated_hue exposed entities cache #109890

merged 1 commit into from Feb 10, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Feb 7, 2024

Proposed change

Also avoids holding stale States in memory which can prevent garbage collection of linked contexts

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 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:

Also avoids holding stale States in memory which can prevent
garbage collection of linked contexts
@home-assistant
Copy link

home-assistant bot commented Feb 7, 2024

Hey there @Tho85, mind taking a look at this pull request as it has been labeled with an integration (emulated_hue) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of emulated_hue can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign emulated_hue Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@bdraco bdraco marked this pull request as ready for review February 7, 2024 17:58
return [
entity_id
for entity_id in self.entities
if (state := state_machine.get(entity_id)) and self.is_state_exposed(state)
Copy link
Member

Choose a reason for hiding this comment

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

We're caching something here that relies on he state machine. I know that's existing code but that seems weird ?

Copy link
Member Author

@bdraco bdraco Feb 9, 2024

Choose a reason for hiding this comment

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

The cache gets cleared in the function below it when needed. We watch when new states are being added and removed to/from the state machine in async_setup and clear the cache when they are.

Copy link
Member Author

Choose a reason for hiding this comment

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

We only use the cache to figure out what is exposed. The state machine still gets polled every api request unfortunately


def create_list_of_entities(config: Config, request: web.Request) -> dict[str, Any]:
    """Create a list of all entities."""
    hass: core.HomeAssistant = request.app["hass"]
    return {
        config.entity_id_to_number(entity_id): state_to_json(config, state)
        for entity_id in config.get_exposed_entity_ids()
        if (state := hass.states.get(entity_id))
    }

That could watch states and only do state_to_json when they actually change.. but thats something for the future, and now I'm a bit off topic

@balloob balloob merged commit 567a179 into dev Feb 10, 2024
23 checks passed
@balloob balloob deleted the emulated_hue_states branch February 10, 2024 02:43
@github-actions github-actions bot locked and limited conversation to collaborators Feb 11, 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.

None yet

2 participants