From 48580ba7a6608c89e91afad4b73f2861aafbd7b2 Mon Sep 17 00:00:00 2001
From: Tom Clegg <tom@curoverse.com>
Date: Sun, 1 Feb 2015 19:21:02 -0500
Subject: [PATCH] 3021: Propagate unhandled exceptions back to the caller
 instead of returning None. Show a warning message only when falling back to
 polling.

---
 sdk/python/arvados/errors.py |  2 ++
 sdk/python/arvados/events.py | 61 +++++++++++++++++++++---------------
 2 files changed, 37 insertions(+), 26 deletions(-)

diff --git a/sdk/python/arvados/errors.py b/sdk/python/arvados/errors.py
index f70fa17149..16f4096572 100644
--- a/sdk/python/arvados/errors.py
+++ b/sdk/python/arvados/errors.py
@@ -74,3 +74,5 @@ class NoKeepServersError(Exception):
     pass
 class StaleWriterStateError(Exception):
     pass
+class FeatureNotEnabledError(Exception):
+    pass
diff --git a/sdk/python/arvados/events.py b/sdk/python/arvados/events.py
index 94dd62b4ed..268692637a 100644
--- a/sdk/python/arvados/events.py
+++ b/sdk/python/arvados/events.py
@@ -1,13 +1,15 @@
-from ws4py.client.threadedclient import WebSocketClient
-import threading
+import arvados
+import config
+import errors
+
+import logging
 import json
-import os
+import threading
 import time
-import ssl
+import os
 import re
-import config
-import logging
-import arvados
+import ssl
+from ws4py.client.threadedclient import WebSocketClient
 
 _logger = logging.getLogger('arvados.events')
 
@@ -110,6 +112,22 @@ class PollClient(threading.Thread):
         del self.filters[self.filters.index(filters)]
 
 
+def _subscribe_websocket(api, filters, on_event):
+    endpoint = api._rootDesc.get('websocketUrl', None)
+    if not endpoint:
+        raise errors.FeatureNotEnabledError(
+            "Server does not advertise a websocket endpoint")
+    uri_with_token = "{}?api_token={}".format(endpoint, api.api_token)
+    client = EventClient(uri_with_token, filters, on_event)
+    ok = False
+    try:
+        client.connect()
+        ok = True
+        return client
+    finally:
+        if not ok:
+            client.close_connection()
+
 def subscribe(api, filters, on_event, poll_fallback=15):
     '''
     api: a client object retrieved from arvados.api(). The caller should not use this client object for anything else after calling subscribe().
@@ -117,22 +135,13 @@ def subscribe(api, filters, on_event, poll_fallback=15):
     on_event: The callback when a message is received.
     poll_fallback: If websockets are not available, fall back to polling every N seconds.  If poll_fallback=False, this will return None if websockets are not available.
     '''
-    ws = None
-    if 'websocketUrl' in api._rootDesc:
-        try:
-            url = "{}?api_token={}".format(api._rootDesc['websocketUrl'], api.api_token)
-            ws = EventClient(url, filters, on_event)
-            ws.connect()
-            return ws
-        except Exception as e:
-            _logger.warn("Got exception %s trying to connect to websockets at %s" % (e, api._rootDesc['websocketUrl']))
-            if ws:
-                ws.close_connection()
-    if poll_fallback:
-        _logger.warn("Websockets not available, falling back to log table polling")
-        p = PollClient(api, filters, on_event, poll_fallback)
-        p.start()
-        return p
-    else:
-        _logger.error("Websockets not available")
-        return None
+    if not poll_fallback:
+        return _subscribe_websocket(api, filters, on_event)
+
+    try:
+        return _subscribe_websocket(api, filters, on_event)
+    except Exception as e:
+        _logger.warn("Falling back to polling after websocket error: %s" % e)
+    p = PollClient(api, filters, on_event, poll_fallback)
+    p.start()
+    return p
-- 
2.30.2