Improve on_abort handler

This commit is contained in:
Lorenz Diener 2018-06-05 17:37:11 +02:00
pare caba9c5467
commit 57520beea7
S'han modificat 2 arxius amb 43 adicions i 20 eliminacions

Veure arxiu

@ -815,7 +815,8 @@ will return a handle corresponding to the open connection. If, in addition, `asy
the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting
`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made `async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made
to "catch up" - events created while the connection is broken will not be received. If you need to make to "catch up" - events created while the connection is broken will not be received. If you need to make
sure to get absolutely all notifications / deletes / toots, you will have to do that manually. sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g.
using the `on_abort` handler to fill in events since the last received one and then reconnecting.
The connection may be closed at any time by calling the handles close() method. The The connection may be closed at any time by calling the handles close() method. The
current status of the handler thread can be checked with the handles is_alive() function, current status of the handler thread can be checked with the handles is_alive() function,

Veure arxiu

@ -25,8 +25,15 @@ class StreamListener(object):
describing the notification.""" describing the notification."""
pass pass
def on_abort(self): def on_abort(self, err):
"""There was a connection error or read timeout.""" """There was a connection error, read timeout or other error fatal to
the streaming connection. The exception object about to be raised
is passed to this function for reference.
Note that the exception will be raised properly once you return from this
function, so if you are using this handler to reconnect, either never
return or start a thread and then catch and ignore the exception.
"""
pass pass
def on_delete(self, status_id): def on_delete(self, status_id):
@ -55,8 +62,10 @@ class StreamListener(object):
try: try:
line = line_buffer.decode('utf-8') line = line_buffer.decode('utf-8')
except UnicodeDecodeError as err: except UnicodeDecodeError as err:
exception = MastodonMalformedEventError("Malformed UTF-8")
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonMalformedEventError("Malformed UTF-8"), exception,
err err
) )
if line == '': if line == '':
@ -68,15 +77,17 @@ class StreamListener(object):
else: else:
line_buffer.extend(chunk) line_buffer.extend(chunk)
except ChunkedEncodingError as err: except ChunkedEncodingError as err:
self.on_abort() exception = MastodonNetworkError("Server ceased communication.")
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonNetworkError("Server ceased communication."), exception,
err err
) )
except MastodonReadTimeout as err: except MastodonReadTimeout as err:
self.on_abort() exception = MastodonReadTimeout("Timed out while reading from server."),
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonReadTimeout("Timed out while reading from server."), exception,
err err
) )
@ -84,7 +95,12 @@ class StreamListener(object):
if line.startswith(':'): if line.startswith(':'):
self.handle_heartbeat() self.handle_heartbeat()
else: else:
try:
key, value = line.split(': ', 1) key, value = line.split(': ', 1)
except:
exception = MastodonMalformedEventError("Malformed event.")
self.on_abort(exception)
raise exception
# According to the MDN spec, repeating the 'data' key # According to the MDN spec, repeating the 'data' key
# represents a newline(!) # represents a newline(!)
if key in event: if key in event:
@ -99,15 +115,19 @@ class StreamListener(object):
data = event['data'] data = event['data']
payload = json.loads(data, object_hook = Mastodon._Mastodon__json_hooks) payload = json.loads(data, object_hook = Mastodon._Mastodon__json_hooks)
except KeyError as err: except KeyError as err:
exception = MastodonMalformedEventError('Missing field', err.args[0], event)
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonMalformedEventError('Missing field', err.args[0], event), exception,
err err
) )
except ValueError as err: except ValueError as err:
# py2: plain ValueError # py2: plain ValueError
# py3: json.JSONDecodeError, a subclass of ValueError # py3: json.JSONDecodeError, a subclass of ValueError
exception = MastodonMalformedEventError('Bad JSON', data)
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonMalformedEventError('Bad JSON', data), exception,
err err
) )
@ -115,8 +135,10 @@ class StreamListener(object):
try: try:
handler = getattr(self, handler_name) handler = getattr(self, handler_name)
except AttributeError as err: except AttributeError as err:
exception = MastodonMalformedEventError('Bad event type', name)
self.on_abort(exception)
six.raise_from( six.raise_from(
MastodonMalformedEventError('Bad event type', name), exception,
err err
) )
else: else: