Skip to content

Commit

Permalink
Catch concurrent.futures.CancelledError in websocket code. (#12150)
Browse files Browse the repository at this point in the history
* Catch concurrent.futures.CancelledError in websocket code.

* Added a comment about the use of futures.CancelledError
  • Loading branch information
pelson authored and balloob committed Feb 7, 2018
1 parent 7e246e4 commit 5ba02c5
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions homeassistant/components/websocket_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
https://home-assistant.io/developers/websocket_api/
"""
import asyncio
from concurrent import futures
from contextlib import suppress
from functools import partial
import json
Expand Down Expand Up @@ -120,6 +121,11 @@
TYPE_PING)
}, extra=vol.ALLOW_EXTRA)

# Define the possible errors that occur when connections are cancelled.
# Originally, this was just asyncio.CancelledError, but issue #9546 showed
# that futures.CancelledErrors can also occur in some situations.
CANCELLATION_ERRORS = (asyncio.CancelledError, futures.CancelledError)


def auth_ok_message():
"""Return an auth_ok message."""
Expand Down Expand Up @@ -231,7 +237,7 @@ def log_error(self, message1, message2=''):
def _writer(self):
"""Write outgoing messages."""
# Exceptions if Socket disconnected or cancelled by connection handler
with suppress(RuntimeError, asyncio.CancelledError):
with suppress(RuntimeError, *CANCELLATION_ERRORS):
while not self.wsock.closed:
message = yield from self.to_write.get()
if message is None:
Expand Down Expand Up @@ -363,7 +369,7 @@ def handle_hass_stop(event):
self.log_error(msg)
self._writer_task.cancel()

except asyncio.CancelledError:
except CANCELLATION_ERRORS:
self.debug("Connection cancelled by server")

except asyncio.QueueFull:
Expand Down

0 comments on commit 5ba02c5

Please sign in to comment.