jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-22 20:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Limit autogenerated entity_id string length (#69739)

Browse Source
This commit is contained in:
Dave T 2022-04-22 06:39:51 +01:00 committed by GitHub
parent 7b75a16745
commit 70e125850c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
homeassistant/helpers/entity_registry.py
View File

@ -290,7 +290,7 @@ class EntityRegistry:
if len(domain) > MAX_LENGTH_STATE_DOMAIN: if len(domain) > MAX_LENGTH_STATE_DOMAIN:
raise MaxLengthExceeded(domain, "domain", MAX_LENGTH_STATE_DOMAIN) raise MaxLengthExceeded(domain, "domain", MAX_LENGTH_STATE_DOMAIN)
test_string = preferred_string test_string = preferred_string[:MAX_LENGTH_STATE_ENTITY_ID]
if not known_object_ids: if not known_object_ids:
known_object_ids = {} known_object_ids = {}
@ -301,11 +301,9 @@ class EntityRegistry:
or not self.hass.states.async_available(test_string) or not self.hass.states.async_available(test_string)
): ):
tries += 1 tries += 1
test_string = f"{preferred_string}_{tries}" len_suffix = len(str(tries)) + 1
test_string = (
if len(test_string) > MAX_LENGTH_STATE_ENTITY_ID: f"{preferred_string[:MAX_LENGTH_STATE_ENTITY_ID-len_suffix]}_{tries}"
raise MaxLengthExceeded(
test_string, "generated_entity_id", MAX_LENGTH_STATE_ENTITY_ID
) )
return test_string return test_string

28
tests/helpers/test_entity_registry.py
View File

@ -1119,22 +1119,13 @@ async def test_disabled_entities_excluded_from_entity_list(hass, registry):
async def test_entity_max_length_exceeded(hass, registry): async def test_entity_max_length_exceeded(hass, registry):
"""Test that an exception is raised when the max character length is exceeded.""" """Test that an exception is raised when the max character length is exceeded."""
long_entity_id_name = ( long_domain_name = (
"1234567890123456789012345678901234567890123456789012345678901234567890" "1234567890123456789012345678901234567890123456789012345678901234567890"
"1234567890123456789012345678901234567890123456789012345678901234567890" "1234567890123456789012345678901234567890123456789012345678901234567890"
"1234567890123456789012345678901234567890123456789012345678901234567890" "1234567890123456789012345678901234567890123456789012345678901234567890"
"1234567890123456789012345678901234567890123456789012345678901234567890" "1234567890123456789012345678901234567890123456789012345678901234567890"
) )
with pytest.raises(MaxLengthExceeded) as exc_info:
registry.async_generate_entity_id("sensor", long_entity_id_name)
assert exc_info.value.property_name == "generated_entity_id"
assert exc_info.value.max_length == 255
assert exc_info.value.value == f"sensor.{long_entity_id_name}"
# Try again but against the domain
long_domain_name = long_entity_id_name
with pytest.raises(MaxLengthExceeded) as exc_info: with pytest.raises(MaxLengthExceeded) as exc_info:
registry.async_generate_entity_id(long_domain_name, "sensor") registry.async_generate_entity_id(long_domain_name, "sensor")
@ -1150,14 +1141,15 @@ async def test_entity_max_length_exceeded(hass, registry):
"1234567890123456789012345678901234567" "1234567890123456789012345678901234567"
) )
with pytest.raises(MaxLengthExceeded) as exc_info: known = []
registry.async_generate_entity_id( new_id = registry.async_generate_entity_id("sensor", long_entity_id_name, known)
"sensor", long_entity_id_name, [f"sensor.{long_entity_id_name}"] assert new_id == "sensor." + long_entity_id_name[: 255 - 7]
) known.append(new_id)
new_id = registry.async_generate_entity_id("sensor", long_entity_id_name, known)
assert exc_info.value.property_name == "generated_entity_id" assert new_id == "sensor." + long_entity_id_name[: 255 - 7 - 2] + "_2"
assert exc_info.value.max_length == 255 known.append(new_id)
assert exc_info.value.value == f"sensor.{long_entity_id_name}_2" new_id = registry.async_generate_entity_id("sensor", long_entity_id_name, known)
assert new_id == "sensor." + long_entity_id_name[: 255 - 7 - 2] + "_3"
async def test_resolve_entity_ids(hass, registry): async def test_resolve_entity_ids(hass, registry):