Skip to content

Extend WS API result when enabling an entity #42667

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bramkragten merged 6 commits into from
Nov 9, 2020
Merged

Extend WS API result when enabling an entity #42667

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64947ba
Extend WS API result when enabling an entity
emontnemery Oct 31, 2020
cecfe04
Fix tests
emontnemery Oct 31, 2020
1d54b98
Fix tests
emontnemery Oct 31, 2020
515c2c1
Move updated registry entry to sub dict
emontnemery Nov 2, 2020
f7982d7
Address review comments
emontnemery Nov 3, 2020
b461710
Increase test coverage
emontnemery Nov 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions homeassistant/components/config/entity_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""HTTP views to interact with the entity registry."""
import voluptuous as vol

from homeassistant import config_entries
from homeassistant.components import websocket_api
from homeassistant.components.websocket_api.const import ERR_NOT_FOUND
from homeassistant.components.websocket_api.decorators import (
Expand Down Expand Up @@ -114,6 +115,15 @@ async def websocket_update_entity(hass, connection, msg):
websocket_api.error_message(msg["id"], "invalid_info", str(err))
)
else:

@balloob balloob Nov 3, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's drop this else and instead do a return inside the except.

@emontnemery emontnemery Nov 3, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

result = websocket_api.result_message(msg["id"], _entry_ext_dict(entry))
if "disabled_by" in changes and changes["disabled_by"] is None:
config_entry = hass.config_entries.async_get_entry(entry.config_entry_id)
if entry and not config_entry.supports_unload:
result["result"]["requires_restart"] = True
else:
result["result"][
"reload_delay"
] = config_entries.RELOAD_AFTER_UPDATE_DELAY

@emontnemery emontnemery Oct 31, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Maybe the WS response should be reorganized such that the entity_entry is moved to a sub dict:

result = websocket_api.result_message(msg["id"], {"entity_entry":_entry_ext_dict(entry)})

@balloob balloob Nov 2, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, better move the entry to a dict to not conflate keys.

@emontnemery emontnemery Nov 2, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

OK, fixed.

connection.send_message(
websocket_api.result_message(msg["id"], _entry_ext_dict(entry))
)
Expand Down
6 changes: 3 additions & 3 deletions homeassistant/config_entries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@
CONN_CLASS_ASSUMED = "assumed"
CONN_CLASS_UNKNOWN = "unknown"

RELOAD_AFTER_UPDATE_DELAY = 30


class ConfigError(HomeAssistantError):
"""Error while configuring an account."""
Expand Down Expand Up @@ -1109,8 +1111,6 @@ def as_dict(self) -> Dict[str, Any]:
class EntityRegistryDisabledHandler:
"""Handler to handle when entities related to config entries updating disabled_by."""

RELOAD_AFTER_UPDATE_DELAY = 30

def __init__(self, hass: HomeAssistant) -> None:
"""Initialize the handler."""
self.hass = hass
Expand Down Expand Up @@ -1167,7 +1167,7 @@ async def _handle_entry_updated(self, event: Event) -> None:
self._remove_call_later()

self._remove_call_later = self.hass.helpers.event.async_call_later(
self.RELOAD_AFTER_UPDATE_DELAY, self._handle_reload
RELOAD_AFTER_UPDATE_DELAY, self._handle_reload
)

async def _handle_reload(self, _now: Any) -> None:
Expand Down