Handle colliding aliases for areas (home-assistant#151613)

Author: emontnemery

homeassistant/helpers/area_registry.py

@@ -179,8 +179,7 @@ def _index_entry(self, key: str, entry: AreaEntry) -> None:
             self._floors_index[entry.floor_id][key] = True
         for label in entry.labels:
             self._labels_index[label][key] = True
-        for alias in entry.aliases:
-            normalized_alias = normalize_name(alias)
+        for normalized_alias in {normalize_name(alias) for alias in entry.aliases}:
             self._aliases_index[normalized_alias][key] = True
 
     def _unindex_entry(
@@ -190,8 +189,7 @@ def _unindex_entry(
         super()._unindex_entry(key, replacement_entry)
         entry = self.data[key]
         if aliases := entry.aliases:
-            for alias in aliases:
-                normalized_alias = normalize_name(alias)
+            for normalized_alias in {normalize_name(alias) for alias in aliases}:
                 self._unindex_entry_value(key, normalized_alias, self._aliases_index)
         if labels := entry.labels:
             for label in labels:

tests/helpers/test_area_registry.py

@@ -503,18 +503,43 @@ async def test_async_get_areas_by_alias(
 
     assert len(area_registry.areas) == 2
 
-    alias1_list = area_registry.async_get_areas_by_alias("A l i a s_1")
-    alias2_list = area_registry.async_get_areas_by_alias("A l i a s_2")
-    alias3_list = area_registry.async_get_areas_by_alias("A l i a s_3")
-
-    assert len(alias1_list) == 2
-    assert len(alias2_list) == 1
-    assert len(alias3_list) == 1
-
-    assert area1 in alias1_list
-    assert area1 in alias2_list
-    assert area2 in alias1_list
-    assert area2 in alias3_list
+    assert area_registry.async_get_areas_by_alias("A l i a s_1") == [area1, area2]
+    assert area_registry.async_get_areas_by_alias("A l i a s_2") == [area1]
+    assert area_registry.async_get_areas_by_alias("A l i a s_3")
+
+
+async def test_async_get_areas_by_alias_collisions(
+    area_registry: ar.AreaRegistry,
+) -> None:
+    """Make sure we can get the areas by alias when the aliases have collisions."""
+    area = area_registry.async_create("Mock1")
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == []
+
+    # Add an alias
+    updated_area = area_registry.async_update(area.id, aliases={"alias1"})
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == [updated_area]
+
+    # Add a colliding alias
+    updated_area = area_registry.async_update(area.id, aliases={"alias1", "alias  1"})
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == [updated_area]
+
+    # Add a colliding alias
+    updated_area = area_registry.async_update(
+        area.id, aliases={"alias1", "alias 1", "alias  1"}
+    )
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == [updated_area]
+
+    # Remove a colliding alias
+    updated_area = area_registry.async_update(area.id, aliases={"alias1", "alias  1"})
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == [updated_area]
+
+    # Remove a colliding alias
+    updated_area = area_registry.async_update(area.id, aliases={"alias1"})
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == [updated_area]
+
+    # Remove all aliases
+    updated_area = area_registry.async_update(area.id, aliases={})
+    assert area_registry.async_get_areas_by_alias("A l i a s 1") == []
 
 
 async def test_async_get_area_by_name_not_found(area_registry: ar.AreaRegistry) -> None: