Handle colliding aliases for floors (home-assistant#151614)

Author: emontnemery

homeassistant/helpers/floor_registry.py

@@ -105,8 +105,7 @@ def __init__(self) -> None:
     def _index_entry(self, key: str, entry: FloorEntry) -> None:
         """Index an entry."""
         super()._index_entry(key, entry)
-        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(
@@ -116,8 +115,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)
 
     def get_floors_for_alias(self, alias: str) -> list[FloorEntry]:

tests/helpers/test_floor_registry.py

@@ -348,18 +348,47 @@ async def test_async_get_floors_by_alias(
     floor1 = floor_registry.async_create("First floor", aliases=("alias_1", "alias_2"))
     floor2 = floor_registry.async_create("Second floor", aliases=("alias_1", "alias_3"))
 
-    alias1_list = floor_registry.async_get_floors_by_alias("A l i a s_1")
-    alias2_list = floor_registry.async_get_floors_by_alias("A l i a s_2")
-    alias3_list = floor_registry.async_get_floors_by_alias("A l i a s_3")
-
-    assert len(alias1_list) == 2
-    assert len(alias2_list) == 1
-    assert len(alias3_list) == 1
-
-    assert floor1 in alias1_list
-    assert floor1 in alias2_list
-    assert floor2 in alias1_list
-    assert floor2 in alias3_list
+    assert floor_registry.async_get_floors_by_alias("A l i a s_1") == [floor1, floor2]
+    assert floor_registry.async_get_floors_by_alias("A l i a s_2") == [floor1]
+    assert floor_registry.async_get_floors_by_alias("A l i a s_3") == [floor2]
+
+
+async def test_async_get_floors_by_alias_collisions(
+    floor_registry: fr.FloorRegistry,
+) -> None:
+    """Make sure we can get the floors by alias when the aliases have collisions."""
+    floor = floor_registry.async_create("First floor")
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == []
+
+    # Add an alias
+    updated_floor = floor_registry.async_update(floor.floor_id, aliases={"alias1"})
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == [updated_floor]
+
+    # Add a colliding alias
+    updated_floor = floor_registry.async_update(
+        floor.floor_id, aliases={"alias1", "alias  1"}
+    )
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == [updated_floor]
+
+    # Add a colliding alias
+    updated_floor = floor_registry.async_update(
+        floor.floor_id, aliases={"alias1", "alias 1", "alias  1"}
+    )
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == [updated_floor]
+
+    # Remove a colliding alias
+    updated_floor = floor_registry.async_update(
+        floor.floor_id, aliases={"alias1", "alias  1"}
+    )
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == [updated_floor]
+
+    # Remove a colliding alias
+    updated_floor = floor_registry.async_update(floor.floor_id, aliases={"alias1"})
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == [updated_floor]
+
+    # Remove all aliases
+    updated_floor = floor_registry.async_update(floor.floor_id, aliases={})
+    assert floor_registry.async_get_floors_by_alias("A l i a s 1") == []
 
 
 async def test_async_get_floor_by_name_not_found(