evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix issue registry sending unneeded update events (#98230)

Browse source
This commit is contained in:
Franck Nijhof 2023-08-11 03:57:42 +02:00 • committed by GitHub
parent b653d7f683
commit 296c27859e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
homeassistant/helpers/issue_registry.py
View file

@ -154,7 +154,7 @@ class IssueRegistry:
{"action": "create", "domain": domain, "issue_id": issue_id},
)
else:
issue = self.issues[(domain, issue_id)] = dataclasses.replace(
replacement = dataclasses.replace(
issue,
active=True,
breaks_in_ha_version=breaks_in_ha_version,
@ -167,10 +167,14 @@ class IssueRegistry:
translation_key=translation_key,
translation_placeholders=translation_placeholders,
)
self.hass.bus.async_fire(
EVENT_REPAIRS_ISSUE_REGISTRY_UPDATED,
{"action": "update", "domain": domain, "issue_id": issue_id},
)
# Only fire is something changed
if replacement != issue:
issue = self.issues[(domain, issue_id)] = replacement
self.async_schedule_save()
self.hass.bus.async_fire(
EVENT_REPAIRS_ISSUE_REGISTRY_UPDATED,
{"action": "update", "domain": domain, "issue_id": issue_id},
)
return issue

42
tests/helpers/test_issue_registry.py
View file

@ -109,11 +109,51 @@ async def test_load_issues(hass: HomeAssistant) -> None:
"issue_id": "issue_1",
}
ir.async_delete_issue(hass, issues[2]["domain"], issues[2]["issue_id"])
# Update an issue by creating it again with the same value,
# no update event should be fired, as nothing changed.
ir.async_create_issue(
hass,
issues[2]["domain"],
issues[2]["issue_id"],
breaks_in_ha_version=issues[2]["breaks_in_ha_version"],
is_fixable=issues[2]["is_fixable"],
is_persistent=issues[2]["is_persistent"],
learn_more_url=issues[2]["learn_more_url"],
severity=issues[2]["severity"],
translation_key=issues[2]["translation_key"],
translation_placeholders=issues[2]["translation_placeholders"],
)
await hass.async_block_till_done()
assert len(events) == 5
# Update an issue by creating it again, url changed
ir.async_create_issue(
hass,
issues[2]["domain"],
issues[2]["issue_id"],
breaks_in_ha_version=issues[2]["breaks_in_ha_version"],
is_fixable=issues[2]["is_fixable"],
is_persistent=issues[2]["is_persistent"],
learn_more_url="https://www.example.com/something_changed",
severity=issues[2]["severity"],
translation_key=issues[2]["translation_key"],
translation_placeholders=issues[2]["translation_placeholders"],
)
await hass.async_block_till_done()
assert len(events) == 6
assert events[5].data == {
"action": "update",
"domain": "test",
"issue_id": "issue_3",
}
ir.async_delete_issue(hass, issues[2]["domain"], issues[2]["issue_id"])
await hass.async_block_till_done()
assert len(events) == 7
assert events[6].data == {
"action": "remove",
"domain": "test",
"issue_id": "issue_3",