Add entity_ids filter on get_states websocket command #141237
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
home-assistant
bot
added
integration: websocket_api
new-feature
small-pr
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
home-assistant
bot
added
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
The get_states endpoint currently returns the entire list of states, which can be overwhelm small devices unable to parse hundreds of kB of JSON. This commit adds an entity_ids filter on this endpoint.
ugomeda
force-pushed
the
um/feature-ws-states-entity-id-filter
branch
from
7cf6cf8 to
c23abc0
Compare
ugomeda
changed the title
| vol.Required("type"): "get_states", | ||
| vol.Optional("entity_ids"): cv.entity_ids, | ||
| } | ||
| ) | ||
| def handle_get_states( | ||
| hass: HomeAssistant, connection: ActiveConnection, msg: dict[str, Any] | ||
| ) -> None: | ||
| """Handle get states command.""" | ||
| states = _async_get_allowed_states(hass, connection) |
There was a problem hiding this comment.
It would be much more efficient to filter them in this function and only return the ones they want vs fetching them all and than filtering them out.
Alternative you could use the same pattern already used for subscribe_enitites so we don't have two different way to filter entities
There was a problem hiding this comment.
After thinking about this, I think the subscribe entities pattern is better, since when we optimize that one, this one could get optimized as well without having to work on it twice
There was a problem hiding this comment.
I could modify the _async_get_allowed_states method to add an entity_id argument. If provided, if would call hass.states.get() for each entity instead of async_all .
This would improve performance for handle_subscribe_entities.
Edit: there is no async_get, i'm not sure this is even a valid option
There was a problem hiding this comment.
I think thats a good next step. For the first iteration, lets uses the entity filer like subscribe_entities does
Proposed change
The get_states endpoint currently returns the entire list of states, which can overwhelm small devices unable to parse hundreds of kB of JSON. This commit adds an entity_ids filter on this endpoint.
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: