Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Re-query missing responses after multi request errors #850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2024
Merged

Re-query missing responses after multi request errors #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions kasa/smartprotocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ async def _query(self, request: str | dict, retry_count: int = 3) -> dict:
# make mypy happy, this should never be reached..
raise KasaException("Query reached somehow to unreachable")

async def _execute_multiple_query(self, request: dict, retry_count: int) -> dict:
async def _execute_multiple_query(self, requests: dict, retry_count: int) -> dict:
debug_enabled = _LOGGER.isEnabledFor(logging.DEBUG)
multi_result: dict[str, Any] = {}
smart_method = "multipleRequest"
requests = [
{"method": method, "params": params} for method, params in request.items()
multi_requests = [
{"method": method, "params": params} for method, params in requests.items()
]

end = len(requests)
end = len(multi_requests)
# Break the requests down as there can be a size limit
step = (
self._transport._config.batch_size or self.DEFAULT_MULTI_REQUEST_BATCH_SIZE
)
for i in range(0, end, step):
requests_step = requests[i : i + step]
requests_step = multi_requests[i : i + step]

smart_params = {"requests": requests_step}
smart_request = self.get_smart_request(smart_method, smart_params)
Expand All @@ -146,6 +146,14 @@ async def _execute_multiple_query(self, request: dict, retry_count: int) -> dict
self._handle_response_error_code(response, method, raise_on_error=False)
result = response.get("result", None)
multi_result[method] = result
# Multi requests don't continue after errors so requery any missing
for method, params in requests.items():
if method not in multi_result:
resp = await self._transport.send(
self.get_smart_request(method, params)
)
self._handle_response_error_code(resp, method, raise_on_error=False)
multi_result[method] = resp.get("result")
return multi_result

async def _execute_query(self, request: str | dict, retry_count: int) -> dict:
Expand Down
3 changes: 3 additions & 0 deletions kasa/tests/fakeprotocol_smart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ async def send(self, request: str):
responses = []
for request in params["requests"]:
response = self._send_request(request) # type: ignore[arg-type]
# Devices do not continue after error
if response["error_code"] != 0:
break
response["method"] = request["method"] # type: ignore[index]
responses.append(response)
return {"result": {"responses": responses}, "error_code": 0}
Expand Down
8 changes: 7 additions & 1 deletion kasa/tests/test_smartprotocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ async def test_smart_device_errors(dummy_protocol, mocker, error_code):
async def test_smart_device_errors_in_multiple_request(
dummy_protocol, mocker, error_code
):
mock_request = {
"foobar1": {"foo": "bar", "bar": "foo"},
"foobar2": {"foo": "bar", "bar": "foo"},
"foobar3": {"foo": "bar", "bar": "foo"},
}
mock_response = {
"result": {
"responses": [
Expand All @@ -55,9 +60,10 @@ async def test_smart_device_errors_in_multiple_request(
dummy_protocol._transport, "send", return_value=mock_response
)

resp_dict = await dummy_protocol.query(DUMMY_MULTIPLE_QUERY, retry_count=2)
resp_dict = await dummy_protocol.query(mock_request, retry_count=2)
assert resp_dict["foobar2"] == error_code
assert send_mock.call_count == 1
assert len(resp_dict) == len(mock_request)


@pytest.mark.parametrize("request_size", [1, 3, 5, 10])
Expand Down