oioioi.base.notification

Module Contents

Classes

NotificationHandler

This handler catches all logs and emits a notification

Attributes

logger
thread_data

oioioi.base.notification.logger

oioioi.base.notification.thread_data

class oioioi.base.notification.NotificationHandler(stream=None)

Bases: logging.StreamHandler

This handler catches all logs and emits a notification if a notification type is set in the extra dictionary, in the log record.

loaded_notifications = False

notification_functions

notification_queue_prefix = _notifs_

last_connection_check = 0

conn_try_interval = 30

classmethod _check_connection()

classmethod _send_notification_message(user, message, repeated=False)

classmethod send_notification(user, notification_type, notification_message, notification_message_arguments)

This function sends a notification to the specified user by sending a message to RabbitMQ.

Parameters

• user – User, to whom the notification will be sent.

• notification_type – A string which describes the notification type.

• notification_message – A message to show to the notified user, which will be translated by frontend to their language and interpolated using notification_message_arguments. Remember to mark this message to translate, passing it as argument to _() function, so that the message string will be caught to translate.

• notification_message_arguments –

  A map which contains strings to interpolate notification_message and special optional parameters:

  • ”address” – an absolute link

    (starting with http://) to a page related to the notification, where the user can check the details.

  • ”details” – a short information

    for the user about the event.

  • ”popup” – if set the related dropdown will be opened in ui.

classmethod register_notification(notification_type, notification_function)

Register a specific notification handler function for the specified type of notification, that will be executed each time a log with this notification type is processed.

emit(record)

This function is called each time a message is logged.

In our design, it’s role is to invoke a specific handler for corresponding notification type, registered before via register() function by caller.

Specific notification handler should prepare translated message string, split one event for particular users and execute send_notification() function for each user who should be notified.