event_bus_utils.py 10.4 KB
Newer Older
1 2
import os
import pika
3
import logging
4
import threading
5
import traceback
6 7 8 9 10 11 12

# for using it as library and as a __main__
try:
    from messages import *
except:
    from .messages import *

Federico Sismondi's avatar
Federico Sismondi committed
13
VERSION = '0.0.9'
14
AMQP_EXCHANGE = 'amq.topic'
Federico Sismondi's avatar
Federico Sismondi committed
15
MAX_LOG_LINE_LENGTH = 120
16 17 18 19 20


class AmqpSynchCallTimeoutError(Exception):
    pass

21

22
class AmqpListener(threading.Thread):
23
    DEFAULT_TOPIC_SUSBCRIPTIONS = ['#']
24
    DEFAULT_EXCHAGE = 'amq.topic'
25
    DEFAULT_AMQP_URL = 'amqp://guest:guest@locahost/'
26

27
    def __init__(self, amqp_url, amqp_exchange, callback, topics=None, use_message_typing=True):
28

29 30 31 32 33
        self.COMPONENT_ID = 'amqp_listener_%s' % str(uuid.uuid4())[:8]

        self.connection = None
        self.channel = None
        self.services_queue_name = 'services_queue@%s' % self.COMPONENT_ID
34
        self.use_message_typing = use_message_typing
35

36 37 38
        threading.Thread.__init__(self)

        if callback is None:
39
            self.message_dispatcher = AmqpListener.default_message_handler
40
        else:
41
            self.message_dispatcher = callback
42

43 44 45 46
        if topics:  # subscribe only to passed list
            self.topics = topics
        else:
            self.topics = self.DEFAULT_TOPIC_SUSBCRIPTIONS
47 48 49 50 51 52

        if amqp_exchange:
            self.exchange = amqp_exchange
        else:
            self.exchange = self.DEFAULT_EXCHAGE

53 54 55 56 57 58 59
        if amqp_url:
            self.amqp_url = amqp_url
        else:
            self.amqp_url = self.DEFAULT_AMQP_URL

        self.amqp_connect()

60
    @classmethod
61
    def default_message_handler(cls, message_as_dict):
62
        clean_dict = dict((k, v) for k, v in message_as_dict.items() if v)
Federico Sismondi's avatar
Federico Sismondi committed
63 64
        print('-' * 120)
        print('%s : %s' % ('routing_key', clean_dict.pop('routing_key')))
Federico Sismondi's avatar
Federico Sismondi committed
65 66
        print('-' * 120)
        print(json.dumps(clean_dict, indent=4, sort_keys=True))
67

68 69 70 71
    def amqp_connect(self):
        self.connection = pika.BlockingConnection(pika.URLParameters(self.amqp_url))
        self.channel = self.connection.channel()

72 73 74 75 76
        # queues & default exchange declaration
        self.channel.queue_declare(queue=self.services_queue_name,
                                   auto_delete=True,
                                   arguments={'x-max-length': 200})

77
        for t in self.topics:
78 79
            self.channel.queue_bind(exchange=self.exchange,
                                    queue=self.services_queue_name,
80
                                    routing_key=t)
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        # Hello world message
        m = MsgTestingToolComponentReady(
            component=self.COMPONENT_ID,
            description="%s is READY" % self.COMPONENT_ID

        )

        self.channel.basic_publish(
            body=m.to_json(),
            routing_key=m.routing_key,
            exchange=self.exchange,
            properties=pika.BasicProperties(
                content_type='application/json',
            )
        )

        self.channel.basic_qos(prefetch_count=1)
        self.channel.basic_consume(self.on_request, queue=self.services_queue_name)

    def stop(self):
        self.channel.queue_delete(self.services_queue_name)
        self.channel.stop_consuming()
        self.connection.close()

    def on_request(self, ch, method, props, body):

107 108
        if self.use_message_typing:
            try:
109
                m = Message.load_from_pika(method, props, body)
110
                if m is None:
111
                    raise Exception("Couldnt build message from json %s, rkey: %s " % (body, method.routing_key))
112
                m.routing_key = method.routing_key
Federico Sismondi's avatar
Federico Sismondi committed
113
                logging.debug('Message in bus: %s' % repr(m)[:MAX_LOG_LINE_LENGTH])
114 115 116 117 118 119 120 121 122 123 124 125 126
                self.message_dispatcher(m)

            except NonCompliantMessageFormatError as e:
                logging.error('%s got a non compliant message error %s' % (self.__class__.__name__, e))

            except Exception as e:
                logging.error(e)
                logging.error('message received:\n\tr_key: %s\n\t%s' % (method.routing_key, body))
                raise e

            finally:
                ch.basic_ack(delivery_tag=method.delivery_tag)
        else:
127 128 129 130 131 132 133 134 135 136 137 138

            props_dict = {
                'content_type': props.content_type,
                'delivery_mode': props.delivery_mode,
                'correlation_id': props.correlation_id,
                'reply_to': props.reply_to,
                'message_id': props.message_id,
                'timestamp': props.timestamp,
                'user_id': props.user_id,
                'app_id': props.app_id,
            }

139
            body_dict = json.loads(body.decode('utf-8'), object_pairs_hook=OrderedDict)
140
            ch.basic_ack(delivery_tag=method.delivery_tag)
141
            text_based_message_representation = OrderedDict()
142
            text_based_message_representation.update({'routing_key': method.routing_key})
143 144 145
            text_based_message_representation.update(props_dict)
            text_based_message_representation.update(body_dict)
            self.message_dispatcher(text_based_message_representation)
146 147

    def run(self):
148
        logging.info("Starting thread listening on the event bus on topics %s" % self.topics)
149

150 151 152
        for i in range(1, 4):
            try:
                self.channel.start_consuming()
153 154 155 156 157 158 159 160

            except (pika.exceptions.ConnectionClosed,
                    pika.exceptions.ChannelError,
                    pika.exceptions.ChannelClosed) as err:

                logging.error('[AmqpListener] Unexpected connection closed, reconnecting %s/%s' % (i, 4))
                logging.error(traceback.format_exc())
                self.amqp_connect()
161

Federico Sismondi's avatar
Federico Sismondi committed
162
        logging.info('%s says Bye byes!' % self.COMPONENT_ID)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189


def publish_message(connection, message):
    """
    Publishes message into the correct topic (uses Message object metadata)
    Creates temporary channel on it's own
    Connection must be a pika.BlockingConnection
    """
    channel = None

    try:
        channel = connection.channel()

        properties = pika.BasicProperties(**message.get_properties())

        channel.basic_publish(
            exchange=AMQP_EXCHANGE,
            routing_key=message.routing_key,
            properties=properties,
            body=message.to_json(),
        )

    finally:
        if channel and channel.is_open:
            channel.close()


190
def amqp_request(connection, request_message, component_id, retries=10):
191 192 193 194 195 196 197 198 199 200 201
    """
    Publishes message into the correct topic (uses Message object metadata)
    Returns reply message.
    Uses reply_to and corr id amqp's properties for matching the reply
    Creates temporary channel, and queues on it's own
    Connection must be a pika.BlockingConnection
    """

    # check first that sender didnt forget about reply to and corr id
    assert request_message.reply_to
    assert request_message.correlation_id
202 203 204
    assert retries > 0

    time_between_requests = 0.5
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

    channel = None

    try:
        response = None
        reply_queue_name = 'amqp_rpc_%s@%s' % (str(uuid.uuid4())[:8], component_id)

        channel = connection.channel()
        result = channel.queue_declare(queue=reply_queue_name, auto_delete=True)
        callback_queue = result.method.queue

        # bind and listen to reply_to topic
        channel.queue_bind(
            exchange=AMQP_EXCHANGE,
            queue=callback_queue,
            routing_key=request_message.reply_to
        )

        channel.basic_publish(
            exchange=AMQP_EXCHANGE,
            routing_key=request_message.routing_key,
            properties=pika.BasicProperties(**request_message.get_properties()),
            body=request_message.to_json(),
        )

        time.sleep(0.2)
231
        retries_left = retries
232 233

        while retries_left > 0:
234
            time.sleep(time_between_requests)
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
            method, props, body = channel.basic_get(reply_queue_name)
            if method:
                channel.basic_ack(method.delivery_tag)
                if hasattr(props, 'correlation_id') and props.correlation_id == request_message.correlation_id:
                    break
            retries_left -= 1

        if retries_left > 0:

            body_dict = json.loads(body.decode('utf-8'), object_pairs_hook=OrderedDict)
            response = MsgReply(request_message, **body_dict)

        else:
            # clean up
            channel.queue_delete(reply_queue_name)
            raise AmqpSynchCallTimeoutError(
                "Response timeout! rkey: %s , request type: %s" % (
                    request_message.routing_key,
253
                    type(request_message)
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
                )
            )

        return response

    finally:
        if channel and channel.is_open:
            # clean up
            channel.queue_delete(reply_queue_name)
            channel.close()


if __name__ == '__main__':

    try:
        AMQP_EXCHANGE = str(os.environ['AMQP_EXCHANGE'])
    except KeyError as e:
        AMQP_EXCHANGE = "amq.topic"

    try:
        AMQP_URL = str(os.environ['AMQP_URL'])
        print('Env vars for AMQP connection succesfully imported')

    except KeyError as e:
        AMQP_URL = "amqp://guest:guest@localhost/"


    def callback_function(message_received):
        print("Callback function received: \n\t" + repr(message_received))

284

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    # EXAMPLE ON AMQP LISTENER

    # # amqp listener example:
    # amqp_listener_thread = AmqpListener(
    #     amqp_url=AMQP_URL,
    #     amqp_exchange=AMQP_EXCHANGE,
    #     callback=callback_function,
    #     topics='#'
    # )
    #
    # try:
    #     amqp_listener_thread.start()
    # except Exception as e:
    #     print(e)
    #
    # # publish message example
    # retries_left = 3
    # while retries_left > 0:
    #     try:
    #         connection = pika.BlockingConnection(pika.URLParameters(AMQP_URL))
    #         m = MsgTest()
    #         publish_message(connection, m)
    #         break
    #     except pika.exceptions.ConnectionClosed:
    #         retries_left -= 1
    #         print('retrying..')
    #         time.sleep(0.2)
    #
    # # example of a request sent into the bus
    # m = MsgTestSuiteGetTestCases()
    # try:
    #     r = amqp_request(connection, m, 'someImaginaryComponent')
    #     print("This is the response I got:\n\t" + repr(r))
    #
    # except AmqpSynchCallTimeoutError as e:
    #     print("Nobody answered to our request :'(")


    # EXAMPLE ON REQUEST REPLY FOR UI BUTTONS:
    con = pika.BlockingConnection(pika.URLParameters(AMQP_URL))
    channel = con.channel()

    ui_request = MsgUiRequestConfirmationButton()
328 329 330
    print("publishing .. %s" % repr(ui_request))
    ui_reply = amqp_request(con, ui_request, 'dummy_component')
    print(repr(ui_reply))