-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 ssl
+from ws4py.client.threadedclient import WebSocketClient
_logger = logging.getLogger('arvados.events')
class EventClient(WebSocketClient):
- def __init__(self, url, filters, on_event):
- ssl_options = None
- if re.match(r'(?i)^(true|1|yes)$',
- config.get('ARVADOS_API_HOST_INSECURE', 'no')):
- ssl_options={'cert_reqs': ssl.CERT_NONE}
+ def __init__(self, url, filters, on_event, last_log_id):
+ ssl_options = {'ca_certs': arvados.util.ca_certs_path()}
+ if config.flag_is_true('ARVADOS_API_HOST_INSECURE'):
+ ssl_options['cert_reqs'] = ssl.CERT_NONE
else:
- ssl_options={'cert_reqs': ssl.CERT_REQUIRED}
+ ssl_options['cert_reqs'] = ssl.CERT_REQUIRED
+
+ # Warning: If the host part of url resolves to both IPv6 and
+ # IPv4 addresses (common with "localhost"), only one of them
+ # will be attempted -- and it might not be the right one. See
+ # ws4py's WebSocketBaseClient.__init__.
super(EventClient, self).__init__(url, ssl_options=ssl_options)
self.filters = filters
self.on_event = on_event
+ self.stop = threading.Event()
+ self.last_log_id = last_log_id
def opened(self):
- self.subscribe(self.filters)
+ self.subscribe(self.filters, self.last_log_id)
def received_message(self, m):
self.on_event(json.loads(str(m)))
- def close_connection(self):
- try:
- self.sock.shutdown(socket.SHUT_RDWR)
- self.sock.close()
- except:
- pass
+ def closed(self, code, reason=None):
+ self.stop.set()
+
+ def close(self, code=1000, reason=''):
+ super(EventClient, self).close(code, reason)
+ self.close_connection()
+ while not self.stop.is_set():
+ self.stop.wait(1)
def subscribe(self, filters, last_log_id=None):
m = {"method": "subscribe", "filters": filters}
self.send(json.dumps({"method": "unsubscribe", "filters": filters}))
class PollClient(threading.Thread):
- def __init__(self, api, filters, on_event, poll_time):
+ def __init__(self, api, filters, on_event, poll_time, last_log_id):
+ super(PollClient, self).__init__()
self.api = api
- self.filters = filters
- self.on_event = on_event
- items = self.api.logs().list(limit=1, order=json.dumps(["id desc"]), filters=json.dumps(filters)).execute()['items']
- if len(items) > 0:
- self.id = items[0]["id"]
+ if filters:
+ self.filters = [filters]
else:
- self.id = 0
+ self.filters = [[]]
+ self.on_event = on_event
self.poll_time = poll_time
- self.loop = True
+ self.daemon = True
+ self.stop = threading.Event()
+ self.last_log_id = last_log_id
+
+ def run(self):
+ self.id = 0
+ if self.last_log_id != None:
+ self.id = self.last_log_id
+ else:
+ for f in self.filters:
+ items = self.api.logs().list(limit=1, order="id desc", filters=f).execute()['items']
+ if items:
+ if items[0]['id'] > self.id:
+ self.id = items[0]['id']
+
+ self.on_event({'status': 200})
+
+ while not self.stop.isSet():
+ max_id = self.id
+ for f in self.filters:
+ items = self.api.logs().list(order="id asc", filters=f+[["id", ">", str(self.id)]]).execute()['items']
+ for i in items:
+ if i['id'] > max_id:
+ max_id = i['id']
+ self.on_event(i)
+ self.id = max_id
+ self.stop.wait(self.poll_time)
def run_forever(self):
- while self.loop:
- time.sleep(self.poll_time)
- items = self.api.logs().list(limit=1, order=json.dumps(["id asc"]), filters=json.dumps(self.filters+[["id", ">", str(self.id)]])).execute()['items']
- for i in items:
- self.id = i['id']
- self.on_event(i)
+ # Have to poll here, otherwise KeyboardInterrupt will never get processed.
+ while not self.stop.is_set():
+ self.stop.wait(1)
- def close_connection(self):
- self.loop = False
+ def close(self):
+ self.stop.set()
+ try:
+ self.join()
+ except RuntimeError:
+ # "join() raises a RuntimeError if an attempt is made to join the
+ # current thread as that would cause a deadlock. It is also an
+ # error to join() a thread before it has been started and attempts
+ # to do so raises the same exception."
+ pass
def subscribe(self, filters):
- self.filters += filters
+ self.on_event({'status': 200})
+ self.filters.append(filters)
def unsubscribe(self, filters):
del self.filters[self.filters.index(filters)]
-def subscribe(api, filters, on_event, poll_fallback=15):
- ws = None
+
+def _subscribe_websocket(api, filters, on_event, last_log_id=None):
+ 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, last_log_id)
+ ok = False
try:
- if 'websocketUrl' in api._rootDesc:
- url = "{}?api_token={}".format(api._rootDesc['websocketUrl'], config.get('ARVADOS_API_TOKEN'))
- ws = EventClient(url, filters, on_event)
- ws.connect()
- elif poll_fallback:
- _logger.warn("Web sockets not available, falling back to log table polling")
- ws = PollClient(api, filters, on_event, poll_fallback)
- else:
- _logger.error("Web sockets not available")
- return None
- return ws
- except Exception:
- if ws:
- ws.close_connection()
- if poll_fallback:
- return PollClient(api, filters, on_event, poll_fallback)
- else:
- _logger.error("Web sockets not available at %s" % api._rootDesc['websocketUrl'])
- raise
+ client.connect()
+ ok = True
+ return client
+ finally:
+ if not ok:
+ client.close_connection()
+
+def subscribe(api, filters, on_event, poll_fallback=15, last_log_id=None):
+ """
+ :api:
+ a client object retrieved from arvados.api(). The caller should not use this client object for anything else after calling subscribe().
+ :filters:
+ Initial subscription filters.
+ :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.
+ :last_log_id:
+ Log rows that are newer than the log id
+ """
+
+ if not poll_fallback:
+ return _subscribe_websocket(api, filters, on_event, last_log_id)
+
+ try:
+ return _subscribe_websocket(api, filters, on_event, last_log_id)
+ except Exception as e:
+ _logger.warn("Falling back to polling after websocket error: %s" % e)
+ p = PollClient(api, filters, on_event, poll_fallback, last_log_id)
+ p.start()
+ return p
projects / arvados.git / blobdiff