chore: add simple scanner benchmark (#44)

.github/workflows/ci.yml

@@ -60,6 +60,25 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip" # caching pip dependencies
+      - uses: snok/install-poetry@v1.3.4
+      - name: Install Dependencies
+        run: poetry install
+        shell: bash
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: poetry run pytest tests/ --codspeed
+
   release:
     needs:
       - test

pyproject.toml

@@ -33,6 +33,7 @@ lru-dict = ">=1.2.0"
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0"
 pytest-cov = ">=3,<7"
+pytest-codspeed = "^3.1.0"
 
 [tool.poetry.group.docs]
 optional = true

tests/backend/test_scanner.py

@@ -1,7 +1,9 @@
-from habluetooth import (
-    BaseHaRemoteScanner,
-    HaBluetoothConnector,
+from aioesphomeapi import (
+    BluetoothLERawAdvertisement,
+    BluetoothLERawAdvertisementsResponse,
 )
+from habluetooth import BaseHaRemoteScanner, HaBluetoothConnector
+from pytest_codspeed import BenchmarkFixture
 
 from bleak_esphome.backend.client import ESPHomeClientData
 from bleak_esphome.backend.scanner import ESPHomeScanner
@@ -10,7 +12,33 @@
 ESP_NAME = "proxy"
 
 
-def test_scanner():
+def test_scanner() -> None:
     connector = HaBluetoothConnector(ESPHomeClientData, ESP_MAC_ADDRESS, lambda: True)
     scanner = ESPHomeScanner(ESP_MAC_ADDRESS, ESP_NAME, connector, True)
     assert isinstance(scanner, BaseHaRemoteScanner)
+
+
+def test_scanner_async_on_advertisement(benchmark: BenchmarkFixture) -> None:
+    connector = HaBluetoothConnector(ESPHomeClientData, ESP_MAC_ADDRESS, lambda: True)
+    scanner = ESPHomeScanner(ESP_MAC_ADDRESS, ESP_NAME, connector, True)
+    adv = BluetoothLERawAdvertisementsResponse(
+        advertisements=[
+            BluetoothLERawAdvertisement(
+                address=261602360644300,
+                rssi=-96,
+                address_type=1,
+                data=b"\x02\x01\x04\x03\x03\x07\xfe\x18\xff\x97\x05\x06\x00\x16p%\x00\xca\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x02\n\x00",
+            ),
+            BluetoothLERawAdvertisement(
+                address=246965243285491,
+                rssi=-88,
+                address_type=1,
+                data=b"\x02\x01\x1a\x1b\xffu\x00B\x04\x01\x01o\xe0\x8d\x17\xe7\x0f\xf3\xe2\x8d\x17\xe7\x0f\xf2(\x00\x00\x00\x00\x00\x00",
+            ),
+        ]
+    )
+
+    @benchmark
+    def _benchmark():
+        for _ in range(1000):
+            scanner.async_on_raw_advertisements(adv)

tests/backend/test_scanner_benchmarks.py

@@ -0,0 +1,42 @@
+from aioesphomeapi import (
+    BluetoothLERawAdvertisement,
+    BluetoothLERawAdvertisementsResponse,
+)
+from habluetooth import (
+    BaseHaRemoteScanner,
+    HaBluetoothConnector,
+)
+
+from bleak_esphome.backend.client import ESPHomeClientData
+from bleak_esphome.backend.scanner import ESPHomeScanner
+
+ESP_MAC_ADDRESS = "AA:BB:CC:DD:EE:FF"
+ESP_NAME = "proxy"
+
+
+def test_scanner() -> None:
+    connector = HaBluetoothConnector(ESPHomeClientData, ESP_MAC_ADDRESS, lambda: True)
+    scanner = ESPHomeScanner(ESP_MAC_ADDRESS, ESP_NAME, connector, True)
+    assert isinstance(scanner, BaseHaRemoteScanner)
+
+
+def test_scanner_async_on_advertisement() -> None:
+    connector = HaBluetoothConnector(ESPHomeClientData, ESP_MAC_ADDRESS, lambda: True)
+    scanner = ESPHomeScanner(ESP_MAC_ADDRESS, ESP_NAME, connector, True)
+    adv = BluetoothLERawAdvertisementsResponse(
+        advertisements=[
+            BluetoothLERawAdvertisement(
+                address=261602360644300,
+                rssi=-96,
+                address_type=1,
+                data=b"\x02\x01\x04\x03\x03\x07\xfe\x18\xff\x97\x05\x06\x00\x16p%\x00\xca\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x02\n\x00",
+            ),
+            BluetoothLERawAdvertisement(
+                address=246965243285491,
+                rssi=-88,
+                address_type=1,
+                data=b"\x02\x01\x1a\x1b\xffu\x00B\x04\x01\x01o\xe0\x8d\x17\xe7\x0f\xf3\xe2\x8d\x17\xe7\x0f\xf2(\x00\x00\x00\x00\x00\x00",
+            ),
+        ]
+    )
+    scanner.async_on_raw_advertisements(adv)