Widgets: use received entity state changes for updating if possible #2089
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add a function to widgets implementing the BaseWidgetProvider that is called whenever a new state change for an entity is received. Implemented it by refreshing all widgets (match existing behaviour).
- Only refresh the entity and media widget if the state of the entity they're displaying is changed. For the template widget we don't know since it is rendered on the server so just keep refreshing on any state change (no change). - Allow passing in a suggested entity for updating the view to allow the widgets to re-use the received state update object, removing the need to make another API call if the view is requested as a result from a state update.
jpelgrom
changed the title
JBassett
approved these changes
Dec 30, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Currently, any time an entity state change is received (via the websocket) all widgets data is refreshed and views are updated. While it works to keep the widgets 'live', it is very inefficient, especially if there are a lot of state changes and/or you have a lot of widgets.
This PR proposes a way to use the entity state changes the app already receives to update the widgets more efficiently, specifically:
*Right now that is just the entity state and media player widgets. The template widget is rendered on the server which might be affected by state changes in ways we don't know anything about, so just keep refreshing that as before.
Screenshots
No visible changes
Link to pull request in Documentation repository
Doesn't seem necessary
Any other notes