listener: add back support for TIMEOUT special event

This reverts commit be3b868.

Signed-off-by: Sumner Evans <me@sumnerevans.com>

Author: sumnerevans

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.5.5
+
+* Add back support for the `TIMEOUT` special event. All other errors still need
+  to be handled by API consumers.
+
 # v0.5.4
 
 * Fix the `__license__` property in the package.

linkedin_messaging/__init__.py

@@ -4,7 +4,7 @@
 from .linkedin import ChallengeException, LinkedInMessaging
 
 __title__ = "linkedin_messaging"
-__version__ = "0.5.4"
+__version__ = "0.5.5"
 __description__ = "An unofficial API for interacting with LinkedIn Messaging"
 
 __license__ = "Apache License 2.0"

linkedin_messaging/linkedin.py

@@ -498,14 +498,16 @@ def add_event_listener(
         payload_key: str,
         fn: Union[
             Callable[[RealTimeEventStreamEvent], Awaitable[None]],
+            Callable[[asyncio.exceptions.TimeoutError], Awaitable[None]],
             Callable[[Exception], Awaitable[None]],
         ],
     ):
         """
-        There is one special event type:
+        There are two special event types:
 
         * ``ALL_EVENTS`` - an event fired on every event, and which contains the entirety of the
           raw event payload
+        * ``TIMEOUT`` - an event fired if the event listener connection times out
         """
         self.event_listeners[payload_key].append(fn)
 
@@ -561,6 +563,14 @@ async def start_listener(self):
         while True:
             try:
                 await self._listen_to_event_stream()
+            except asyncio.exceptions.TimeoutError as te:
+                # Special handling for TIMEOUT handler.
+                if timeout_handlers := self.event_listeners.get("TIMEOUT"):
+                    for handler in timeout_handlers:
+                        try:
+                            await handler(te)
+                        except Exception:
+                            logging.exception(f"Handler {handler} failed to handle {te}")
             except Exception as e:
                 logging.exception(f"Got exception in listener: {e}")
                 raise