feat: improve performance of filtering apple data (#188)

Author: bdraco

src/habluetooth/manager.pxd

@@ -14,6 +14,12 @@ cdef object BLEDevice
 cdef bint TYPE_CHECKING
 cdef set APPLE_START_BYTES_WANTED
 
+cdef unsigned char APPLE_IBEACON_START_BYTE
+cdef unsigned char APPLE_HOMEKIT_START_BYTE
+cdef unsigned char APPLE_HOMEKIT_NOTIFY_START_BYTE
+cdef unsigned char APPLE_DEVICE_ID_START_BYTE
+cdef unsigned char APPLE_FINDMY_START_BYTE
+
 cdef object APPLE_MFR_ID
 
 @cython.locals(uuids=set)
@@ -73,7 +79,7 @@ cdef class BluetoothManager:
         connectable=bint,
         scanner=BaseHaScanner,
         connectable_scanner=BaseHaScanner,
-        apple_data=bytes,
+        apple_cstr="const unsigned char *",
         bleak_callback=BleakCallback
     )
     cpdef void scanner_adv_received(self, BluetoothServiceInfoBleak service_info)

src/habluetooth/manager.py

@@ -62,13 +62,7 @@
 APPLE_DEVICE_ID_START_BYTE: Final = 0x10  # bluetooth_le_tracker
 APPLE_HOMEKIT_NOTIFY_START_BYTE: Final = 0x11  # homekit_controller
 APPLE_FINDMY_START_BYTE: Final = 0x12  # FindMy network advertisements
-APPLE_START_BYTES_WANTED: Final = {
-    APPLE_IBEACON_START_BYTE,
-    APPLE_HOMEKIT_START_BYTE,
-    APPLE_HOMEKIT_NOTIFY_START_BYTE,
-    APPLE_DEVICE_ID_START_BYTE,
-    APPLE_FINDMY_START_BYTE,
-}
+
 
 _str = str
 
@@ -509,13 +503,19 @@ def scanner_adv_received(self, service_info: BluetoothServiceInfoBleak) -> None:
         # Pre-filter noisy apple devices as they can account for 20-35% of the
         # traffic on a typical network.
         if (
-            len(service_info.manufacturer_data) == 1
-            and not service_info.service_data
+            not service_info.service_data
+            and len(service_info.manufacturer_data) == 1
             and (apple_data := service_info.manufacturer_data.get(APPLE_MFR_ID))
-            is not None
-            and apple_data[0] not in APPLE_START_BYTES_WANTED
         ):
-            return
+            apple_cstr = apple_data
+            if apple_cstr[0] not in {
+                APPLE_IBEACON_START_BYTE,
+                APPLE_HOMEKIT_START_BYTE,
+                APPLE_HOMEKIT_NOTIFY_START_BYTE,
+                APPLE_DEVICE_ID_START_BYTE,
+                APPLE_FINDMY_START_BYTE,
+            }:
+                return
 
         if service_info.connectable:
             old_connectable_service_info = self._connectable_history.get(

tests/test_base_scanner.py

@@ -593,3 +593,50 @@ async def test_merge_manufacturer_data_history_new() -> None:
 
     cancel()
     unsetup()
+
+
+@pytest.mark.usefixtures("enable_bluetooth")
+@pytest.mark.asyncio
+async def test_filter_apple_data() -> None:
+    """Test filtering apple data accepts bytes that start with 01."""
+    manager = get_manager()
+
+    device = generate_ble_device(
+        "44:44:33:11:23:45",
+        "",
+        {},
+        rssi=-60,
+    )
+    device_adv = generate_advertisement_data(
+        local_name="",
+        rssi=-60,
+        manufacturer_data={
+            76: b"\x01\r.\xa9\xb6",
+        },
+        service_uuids=["ef090000-11d6-42ba-93b8-9dd7ec090ab0"],
+        service_data={},
+    )
+
+    connector = HaBluetoothConnector(
+        MockBleakClient, "mock_bleak_client", lambda: False
+    )
+    scanner = FakeScanner("esp32", "esp32", connector, True)
+    details = scanner.details
+    assert details == HaScannerDetails(
+        source=scanner.source,
+        connectable=scanner.connectable,
+        name=scanner.name,
+        adapter=scanner.adapter,
+    )
+    unsetup = scanner.async_setup()
+    cancel = manager.async_register_scanner(scanner)
+
+    scanner.inject_advertisement(device, device_adv)
+
+    data = scanner.discovered_devices_and_advertisement_data
+    discovered_device, discovered_adv_data = data[device.address]
+    assert discovered_device.address == device.address
+    assert discovered_device.name == device.name
+    assert discovered_adv_data.manufacturer_data == device_adv.manufacturer_data
+    unsetup()
+    cancel()