Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2026-01-29 23:19:59 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix connection indeterminate state on cancellation (#636)

Browse Source 
* Fix connection indeterminate state on cancellation

If the task the query is running in it cancelled, we do
know the state of the connection so we must close. Previously
we would not close on BaseException which could result
in reading the previous response if the previous query was
cancelled after the request had been sent

* add test for cancellation
This commit is contained in:
J. Nick Koston
2024-01-13 07:37:24 -10:00
committed by GitHub
parent 816053fc6e
commit aed67dad16
2 changed files with 102 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
kasa/protocol.py
View File

@@ -200,7 +200,6 @@ class TPLinkSmartHomeProtocol(TPLinkProtocol):
assert self.writer is not None # noqa: S101
assert self.reader is not None # noqa: S101
debug_log = _LOGGER.isEnabledFor(logging.DEBUG)
if debug_log:
_LOGGER.debug("%s >> %s", self._host, request)
self.writer.write(TPLinkSmartHomeProtocol.encrypt(request))
@@ -220,11 +219,17 @@ class TPLinkSmartHomeProtocol(TPLinkProtocol):
async def close(self) -> None:
"""Close the connection."""
writer = self.writer
self.close_without_wait()
if writer:
with contextlib.suppress(Exception):
await writer.wait_closed()
def close_without_wait(self) -> None:
"""Close the connection without waiting for the connection to close."""
writer = self.writer
self.reader = self.writer = None
if writer:
writer.close()
with contextlib.suppress(Exception):
await writer.wait_closed()
def _reset(self) -> None:
"""Clear any varibles that should not survive between loops."""
@@ -266,6 +271,16 @@ class TPLinkSmartHomeProtocol(TPLinkProtocol):
f" {self._host}:{self._port}: {ex}"
) from ex
continue
except BaseException as ex:
# Likely something cancelled the task so we need to close the connection
# as we are not in an indeterminate state
self.close_without_wait()
_LOGGER.debug(
"%s: BaseException during connect, closing connection: %s",
self._host,
ex,
)
raise
try:
assert self.reader is not None # noqa: S101
@@ -283,6 +298,16 @@ class TPLinkSmartHomeProtocol(TPLinkProtocol):
_LOGGER.debug(
"Unable to query the device %s, retrying: %s", self._host, ex
)
except BaseException as ex:
# Likely something cancelled the task so we need to close the connection
# as we are not in an indeterminate state
self.close_without_wait()
_LOGGER.debug(
"%s: BaseException during query, closing connection: %s",
self._host,
ex,
)
raise
# make mypy happy, this should never be reached..
await self.close()