Split queries to avoid overflowing device buffers (#502)

Several KASA devices seem to have pretty strict buffer size limitations on incoming/outgoing data transfers.

Testing on KL125-US and HL103 has shown that sending a request size larger than about ~768 bytes will immediately crash the device. Additionally, a query that generates a response larger than ~4096 bytes will crash the KL125-US. I was unable to generate such a large response to test the HL103.

The KL125-US will only return such large queries when its monthly usage stats have been populated. This means that a new bulb would work fine, but after a month of data collection the bulb would break the 4K limit and start to crash.

To work around this issue, an estimated worst-case response size is calculated before sending a request by summing up all modules estimated response size. If the estimated size is greater than the device's max_response_payload_size then the query will be split into multiple queries.

This PR implements splitting queries expected to have large responses and also removes the module 'skip list' which was a previous workaround to the crash (which worked by simply reducing the number of modules queried, which prevented the overflow) since it is no longer necessary.

This PR does not attempt to address the "input buffer size limit." Thus far this limit has not been an issue.
This commit is contained in:
cobryan05
2023-09-14 13:51:40 -05:00
committed by GitHub
parent 7bb4a456a2
commit a2444da9df
5 changed files with 55 additions and 9 deletions

View File

@@ -28,9 +28,6 @@ from .protocol import TPLinkSmartHomeProtocol
_LOGGER = logging.getLogger(__name__)
# Certain module queries will crash devices; this list skips those queries
MODEL_MODULE_SKIPLIST = {"KL125(US)": ["cloud"]} # Issue #345
class DeviceType(Enum):
"""Device type enum."""
@@ -337,20 +334,32 @@ class SmartDevice:
)
self.add_module("emeter", Emeter(self, self.emeter_type))
request_list = []
est_response_size = 1024 if "system" in req else 0
for module_name, module in self.modules.items():
if not module.is_supported:
_LOGGER.debug("Module %s not supported, skipping" % module)
continue
modules_to_skip = MODEL_MODULE_SKIPLIST.get(self.model, [])
if module_name in modules_to_skip:
_LOGGER.debug(f"Module {module} is excluded for {self.model}, skipping")
continue
est_response_size += module.estimated_query_response_size
if est_response_size > self.max_device_response_size:
request_list.append(req)
req = {}
est_response_size = module.estimated_query_response_size
q = module.query()
_LOGGER.debug("Adding query for %s: %s", module, q)
req = merge(req, q)
request_list.append(req)
self._last_update = await self.protocol.query(req)
responses = [
await self.protocol.query(request) for request in request_list if request
]
update: Dict = {}
for response in responses:
update = {**update, **response}
self._last_update = update
def update_from_discover_info(self, info):
"""Update state from info from the discover call."""
@@ -658,6 +667,11 @@ class SmartDevice:
)
return self.children[index]
@property
def max_device_response_size(self) -> int:
"""Returns the maximum response size the device can safely construct."""
return 16 * 1024
@property
def device_type(self) -> DeviceType:
"""Return the device type."""