sdk/python/arvados/events.py

   1 import arvados
   2 import config
   3 import errors
   4
   5 import logging
   6 import json
   7 import threading
   8 import time
   9 import os
  10 import re
  11 import ssl
  12 from ws4py.client.threadedclient import WebSocketClient
  13
  14 _logger = logging.getLogger('arvados.events')
  15
  16 class EventClient(WebSocketClient):
  17     def __init__(self, url, filters, on_event, last_log_id):
  18         ssl_options = {'ca_certs': arvados.util.ca_certs_path()}
  19         if config.flag_is_true('ARVADOS_API_HOST_INSECURE'):
  20             ssl_options['cert_reqs'] = ssl.CERT_NONE
  21         else:
  22             ssl_options['cert_reqs'] = ssl.CERT_REQUIRED
  23
  24         # Warning: If the host part of url resolves to both IPv6 and
  25         # IPv4 addresses (common with "localhost"), only one of them
  26         # will be attempted -- and it might not be the right one. See
  27         # ws4py's WebSocketBaseClient.__init__.
  28         super(EventClient, self).__init__(url, ssl_options=ssl_options)
  29         self.filters = filters
  30         self.on_event = on_event
  31         self.last_log_id = last_log_id
  32
  33     def opened(self):
  34         self.subscribe(self.filters, self.last_log_id)
  35
  36     def received_message(self, m):
  37         self.on_event(json.loads(str(m)))
  38
  39     def close_connection(self):
  40         try:
  41             self.sock.shutdown(socket.SHUT_RDWR)
  42             self.sock.close()
  43         except:
  44             pass
  45
  46     def subscribe(self, filters, last_log_id=None):
  47         m = {"method": "subscribe", "filters": filters}
  48         if last_log_id is not None:
  49             m["last_log_id"] = last_log_id
  50         self.send(json.dumps(m))
  51
  52     def unsubscribe(self, filters):
  53         self.send(json.dumps({"method": "unsubscribe", "filters": filters}))
  54
  55 class PollClient(threading.Thread):
  56     def __init__(self, api, filters, on_event, poll_time, last_log_id):
  57         super(PollClient, self).__init__()
  58         self.api = api
  59         if filters:
  60             self.filters = [filters]
  61         else:
  62             self.filters = [[]]
  63         self.on_event = on_event
  64         self.poll_time = poll_time
  65         self.daemon = True
  66         self.stop = threading.Event()
  67         self.last_log_id = last_log_id
  68
  69     def run(self):
  70         self.id = 0
  71         if self.last_log_id != None:
  72             self.id = self.last_log_id
  73         else:
  74             for f in self.filters:
  75                 items = self.api.logs().list(limit=1, order="id desc", filters=f).execute()['items']
  76                 if items:
  77                     if items[0]['id'] > self.id:
  78                         self.id = items[0]['id']
  79
  80         self.on_event({'status': 200})
  81
  82         while not self.stop.isSet():
  83             max_id = self.id
  84             for f in self.filters:
  85                 items = self.api.logs().list(order="id asc", filters=f+[["id", ">", str(self.id)]]).execute()['items']
  86                 for i in items:
  87                     if i['id'] > max_id:
  88                         max_id = i['id']
  89                     self.on_event(i)
  90             self.id = max_id
  91             self.stop.wait(self.poll_time)
  92
  93     def run_forever(self):
  94         # Have to poll here, otherwise KeyboardInterrupt will never get processed.
  95         while not self.stop.is_set():
  96             self.stop.wait(1)
  97
  98     def close(self):
  99         self.stop.set()
 100         try:
 101             self.join()
 102         except RuntimeError:
 103             # "join() raises a RuntimeError if an attempt is made to join the
 104             # current thread as that would cause a deadlock. It is also an
 105             # error to join() a thread before it has been started and attempts
 106             # to do so raises the same exception."
 107             pass
 108
 109     def subscribe(self, filters):
 110         self.on_event({'status': 200})
 111         self.filters.append(filters)
 112
 113     def unsubscribe(self, filters):
 114         del self.filters[self.filters.index(filters)]
 115
 116
 117 def _subscribe_websocket(api, filters, on_event, last_log_id=None):
 118     endpoint = api._rootDesc.get('websocketUrl', None)
 119     if not endpoint:
 120         raise errors.FeatureNotEnabledError(
 121             "Server does not advertise a websocket endpoint")
 122     uri_with_token = "{}?api_token={}".format(endpoint, api.api_token)
 123     client = EventClient(uri_with_token, filters, on_event, last_log_id)
 124     ok = False
 125     try:
 126         client.connect()
 127         ok = True
 128         return client
 129     finally:
 130         if not ok:
 131             client.close_connection()
 132
 133 def subscribe(api, filters, on_event, poll_fallback=15, last_log_id=None):
 134     """
 135     :api:
 136       a client object retrieved from arvados.api(). The caller should not use this client object for anything else after calling subscribe().
 137     :filters:
 138       Initial subscription filters.
 139     :on_event:
 140       The callback when a message is received.
 141     :poll_fallback:
 142       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.
 143     :last_log_id:
 144       Log rows that are newer than the log id
 145     """
 146
 147     if not poll_fallback:
 148         return _subscribe_websocket(api, filters, on_event, last_log_id)
 149
 150     try:
 151         return _subscribe_websocket(api, filters, on_event, last_log_id)
 152     except Exception as e:
 153         _logger.warn("Falling back to polling after websocket error: %s" % e)
 154     p = PollClient(api, filters, on_event, poll_fallback, last_log_id)
 155     p.start()
 156     return p