Merge pull request #2214 from rosenrot00/fix/per-hub-plugin-state

Isolate plugin runtime state per hub

Author: wills106

custom_components/solax_modbus/__init__.py

@@ -586,7 +586,7 @@ def __init__(
         self.sleepnone: list[str] = []  # sensors that will be cleared in sleepmode
         self.writequeue: dict[tuple[int, int], PendingWrite] = {}  # requests to retry when the inverter wakes
         _LOGGER.debug(f"{self.name}: ready to call plugin to determine inverter type")
-        self.plugin = plugin.plugin_instance  # getPlugin(name).plugin_instance
+        self.plugin = plugin.plugin_instance.create_hub_instance()
         self.plugin_module = plugin  # Store plugin module for accessing module-level functions
         self._validate_register_func = getattr(plugin, "validate_register_data", None)  # Cache function reference
         self.wakeupButton: Any = None

custom_components/solax_modbus/const.py

@@ -1,9 +1,10 @@
 import logging
 import pathlib
 from collections.abc import Callable, Sequence
+from copy import deepcopy
 from dataclasses import dataclass
 from datetime import datetime, timedelta
-from typing import Any
+from typing import Any, Self
 
 from homeassistant.components.button import ButtonEntityDescription
 from homeassistant.components.number import NumberEntityDescription
@@ -153,6 +154,10 @@ class plugin_base:
     auto_default_scangroup: str = SCAN_GROUP_FAST  # only used when default_xxx_scangroup is set to SCAN_GROUP_AUTO
     auto_slow_scangroup: str = SCAN_GROUP_MEDIUM  # only usedwhen default_xxx_scangroup is set to SCAN_GROUP_AUTO
 
+    def create_hub_instance(self) -> Self:
+        """Create an independent runtime plugin instance for one hub."""
+        return deepcopy(self)
+
     def isAwake(self, datadict: dict[str, Any]) -> bool:
         """Check if inverter is awake."""
         return True  # always awake by default

tests/unit/test_plugin_instance_isolation.py

@@ -0,0 +1,87 @@
+"""Tests for per-hub plugin runtime state."""
+
+from dataclasses import replace
+from types import ModuleType, SimpleNamespace
+from typing import Any, cast
+
+from homeassistant.const import CONF_NAME
+
+from custom_components.solax_modbus import SolaXModbusHub
+from custom_components.solax_modbus.const import CONF_INTERFACE, plugin_base
+from custom_components.solax_modbus.plugin_sofar import battery_config as SofarBatteryConfig
+from custom_components.solax_modbus.plugin_sofar import plugin_instance as sofar_template
+from custom_components.solax_modbus.plugin_solinteg import plugin_instance as solinteg_template
+
+
+def make_hub(plugin_template: plugin_base, name: str) -> SolaXModbusHub:
+    """Create a hub without opening a real transport."""
+    plugin_module = cast(ModuleType, SimpleNamespace(plugin_instance=plugin_template))
+    entry = SimpleNamespace(options={CONF_NAME: name, CONF_INTERFACE: "test"})
+    hass = SimpleNamespace()
+    return SolaXModbusHub(cast(Any, hass), plugin_module, cast(Any, entry))
+
+
+def test_hubs_get_independent_plugin_instances() -> None:
+    """Each hub must receive its own plugin runtime object."""
+    first = make_hub(sofar_template, "Sofar 1")
+    second = make_hub(sofar_template, "Sofar 2")
+
+    assert first.plugin is not second.plugin
+    assert first.plugin is not sofar_template
+    assert second.plugin is not sofar_template
+
+    first.plugin.inverter_model = "First model"
+
+    assert second.plugin.inverter_model is None
+    assert sofar_template.inverter_model is None
+
+
+def test_sofar_battery_runtime_state_is_isolated_per_hub() -> None:
+    """Battery discovery state from one Sofar hub must not leak to another."""
+    first = make_hub(sofar_template, "Sofar 1")
+    second = make_hub(sofar_template, "Sofar 2")
+    first_battery_base = first.plugin.BATTERY_CONFIG
+    second_battery_base = second.plugin.BATTERY_CONFIG
+    template_battery_base = sofar_template.BATTERY_CONFIG
+
+    assert first_battery_base is not None
+    assert second_battery_base is not None
+    assert template_battery_base is not None
+    first_battery = cast(SofarBatteryConfig, first_battery_base)
+    second_battery = cast(SofarBatteryConfig, second_battery_base)
+    template_battery = cast(SofarBatteryConfig, template_battery_base)
+    assert first_battery is not second_battery
+    assert first_battery is not template_battery
+
+    first_battery.number_strings = 2
+    first_battery.number_cels_in_parallel = 3
+    first_battery.selected_batt_nr = 1
+    first_battery.selected_batt_pack_nr = 2
+    first_battery.batt_pack_serials[1] = {2: "SOFAR-PACK-1"}
+
+    assert second_battery.number_strings is None
+    assert second_battery.number_cels_in_parallel is None
+    assert second_battery.selected_batt_nr is None
+    assert second_battery.selected_batt_pack_nr is None
+    assert second_battery.batt_pack_serials == {}
+    assert template_battery.batt_pack_serials == {}
+
+
+def test_solinteg_runtime_descriptions_are_isolated_per_hub() -> None:
+    """MPPT-specific description changes must stay local to one Solinteg hub."""
+    first = make_hub(solinteg_template, "Solinteg 1")
+    second = make_hub(solinteg_template, "Solinteg 2")
+    first_index = next(index for index, description in enumerate(first.plugin.SELECT_TYPES) if description.key == "shadow_scan")
+    second_index = next(index for index, description in enumerate(second.plugin.SELECT_TYPES) if description.key == "shadow_scan")
+    template_index = next(index for index, description in enumerate(solinteg_template.SELECT_TYPES) if description.key == "shadow_scan")
+    second_description = second.plugin.SELECT_TYPES[second_index]
+    template_description = solinteg_template.SELECT_TYPES[template_index]
+
+    first.plugin.SELECT_TYPES[first_index] = replace(
+        first.plugin.SELECT_TYPES[first_index],
+        option_dict={0: "off", 1: "mppt1"},
+    )
+
+    assert first.plugin.SELECT_TYPES[first_index].option_dict == {0: "off", 1: "mppt1"}
+    assert second.plugin.SELECT_TYPES[second_index] == second_description
+    assert solinteg_template.SELECT_TYPES[template_index] == template_description

tests/unit/test_plugins_structure.py

@@ -26,9 +26,16 @@ def test_plugin_structure(plugin_module_name: str) -> None:
     # 2. Verify inheritance
     assert isinstance(plugin, plugin_base), f"{plugin_module_name} plugin_instance must inherit from plugin_base"
 
+    runtime_plugin = plugin.create_hub_instance()
+    assert runtime_plugin is not plugin, f"{plugin_module_name} must create a separate runtime plugin per hub"
+
     # 3. Verify attributes
     assert plugin.plugin_name, f"{plugin_module_name} missing plugin_name"
     assert isinstance(plugin.SENSOR_TYPES, list), f"{plugin_module_name} SENSOR_TYPES must be a list"
+    for collection_name in ("SENSOR_TYPES", "BUTTON_TYPES", "NUMBER_TYPES", "SELECT_TYPES", "SWITCH_TYPES", "TIME_TYPES"):
+        assert getattr(runtime_plugin, collection_name) is not getattr(plugin, collection_name), (
+            f"{plugin_module_name} runtime plugin must not share {collection_name} with its template"
+        )
 
     # 4. Verify Entity Integrity (basic check)
     all_entities: list[Any] = (