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.

Sign up for GitHub

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

Jump to bottom

Add state caching to button entities #108272

Merged
merged 1 commit into from Jan 18, 2024
Merged

Add state caching to button entities #108272

merged 1 commit into from Jan 18, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jan 18, 2024 •
edited

Proposed change

I was suprised to find how many button entities write state because they use a base entity class that writes state when a coordinator or other event happens even though their state does not change unless the button is pressed. I only noticed because I was tracing isoformat calls in the profile and I was a bit confused why there were more coming from buttons than sensor.

The state is now cached to avoid the time conversion each time the state is written

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:

@bdraco
Add state caching to button entities
e4f2534 
I was suprised to find how many button entities write state because
they use a base entity class that writes state when a coordinator or
other event happens even though their state does not change
unless the button is pressed.

The state is now cached to avoid the time conversion each time the state
is written
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (button) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of button 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 button 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 January 18, 2024 03:54
@bdraco bdraco requested a review from a team as a code owner January 18, 2024 03:54
frenck
frenck approved these changes Jan 18, 2024
View reviewed changes
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @bdraco 👍

../Frenck

@frenck frenck merged commit 26cc6a5 into dev Jan 18, 2024
53 checks passed
@frenck frenck deleted the button_avoid_dt_conversions branch January 18, 2024 07:53
bdraco added a commit that referenced this pull request Jan 18, 2024
@bdraco
Ensure button platform does not restore unavailable state
ca42358 
Previously we relied on `dt_util.parse_datetime` returning `None` when
the stored state was `unavailable` since it was not a valid timestamp.
This regressed with #108272. I added an explict test for handling
unavailable
@bdraco bdraco mentioned this pull request Jan 18, 2024
Merged
20 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

Assignees
No one assigned
Labels
cla-signed code-quality core has-tests integration: button Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bdraco @frenck