[refactor] reorder and comment events

Reorder blocks of events, and comment about which user-specific info
it's being emitted with them.

1 files changed, 45 insertions, 40 deletions

diff --git a/src/leap/common/events/catalog.py b/src/leap/common/events/catalog.py
index 8bddd2c..6a09495 100644
--- a/src/leap/common/events/catalog.py
+++ b/src/leap/common/events/catalog.py
@@ -24,49 +24,54 @@ Events catalog.
 EVENTS = [
     "CLIENT_SESSION_ID",
     "CLIENT_UID",
-    "IMAP_CLIENT_LOGIN",
-    "IMAP_SERVICE_FAILED_TO_START",
-    "IMAP_SERVICE_STARTED",
-    "IMAP_UNHANDLED_ERROR",
-    "KEYMANAGER_DONE_UPLOADING_KEYS",
-    "KEYMANAGER_FINISHED_KEY_GENERATION",
-    "KEYMANAGER_KEY_FOUND",
-    "KEYMANAGER_KEY_NOT_FOUND",
-    "KEYMANAGER_LOOKING_FOR_KEY",
-    "KEYMANAGER_STARTED_KEY_GENERATION",
-    "MAIL_FETCHED_INCOMING",
-    "MAIL_MSG_DECRYPTED",
-    "MAIL_MSG_DELETED_INCOMING",
-    "MAIL_MSG_PROCESSING",
-    "MAIL_MSG_SAVED_LOCALLY",
-    "MAIL_UNREAD_MESSAGES",
     "RAISE_WINDOW",
-    "SMTP_CONNECTION_LOST",
-    "SMTP_END_ENCRYPT_AND_SIGN",
-    "SMTP_END_SIGN",
-    "SMTP_RECIPIENT_ACCEPTED_ENCRYPTED",
-    "SMTP_RECIPIENT_ACCEPTED_UNENCRYPTED",
-    "SMTP_RECIPIENT_REJECTED",
-    "SMTP_SEND_MESSAGE_ERROR",
-    "SMTP_SEND_MESSAGE_START",
-    "SMTP_SEND_MESSAGE_SUCCESS",
-    "SMTP_SERVICE_FAILED_TO_START",
-    "SMTP_SERVICE_STARTED",
-    "SMTP_START_ENCRYPT_AND_SIGN",
-    "SMTP_START_SIGN",
-    "SOLEDAD_CREATING_KEYS",
-    "SOLEDAD_DONE_CREATING_KEYS",
-    "SOLEDAD_DONE_DATA_SYNC",
-    "SOLEDAD_DONE_DOWNLOADING_KEYS",
-    "SOLEDAD_DONE_UPLOADING_KEYS",
-    "SOLEDAD_DOWNLOADING_KEYS",
-    "SOLEDAD_INVALID_AUTH_TOKEN",
-    "SOLEDAD_NEW_DATA_TO_SYNC",
-    "SOLEDAD_SYNC_RECEIVE_STATUS",
-    "SOLEDAD_SYNC_SEND_STATUS",
-    "SOLEDAD_UPLOADING_KEYS",
     "UPDATER_DONE_UPDATING",
     "UPDATER_NEW_UPDATES",
+
+    "KEYMANAGER_DONE_UPLOADING_KEYS",  # (address)
+    "KEYMANAGER_FINISHED_KEY_GENERATION",  # (address)
+    "KEYMANAGER_KEY_FOUND",  # (address)
+    "KEYMANAGER_KEY_NOT_FOUND",  # (address)
+    "KEYMANAGER_LOOKING_FOR_KEY",  # (address)
+    "KEYMANAGER_STARTED_KEY_GENERATION",  # (address)
+
+    "SOLEDAD_CREATING_KEYS",  # {uuid, userid}
+    "SOLEDAD_DONE_CREATING_KEYS",  # {uuid, userid}
+    "SOLEDAD_DONE_DATA_SYNC",  # {uuid, userid}
+    "SOLEDAD_DONE_DOWNLOADING_KEYS",  # {uuid, userid}
+    "SOLEDAD_DONE_UPLOADING_KEYS",  # {uuid, userid}
+    "SOLEDAD_DOWNLOADING_KEYS",  # {uuid, userid}
+    "SOLEDAD_INVALID_AUTH_TOKEN",  # {uuid, userid}
+    "SOLEDAD_SYNC_RECEIVE_STATUS",  # {uuid, userid}
+    "SOLEDAD_SYNC_SEND_STATUS",  # {uuid, userid}
+    "SOLEDAD_UPLOADING_KEYS",  # {uuid, userid}
+    "SOLEDAD_NEW_DATA_TO_SYNC",
+
+    "MAIL_FETCHED_INCOMING",  # (userid)
+    "MAIL_MSG_DECRYPTED",  # (userid)
+    "MAIL_MSG_DELETED_INCOMING",  # (userid)
+    "MAIL_MSG_PROCESSING",  # (userid)
+    "MAIL_MSG_SAVED_LOCALLY",  # (userid)
+    "MAIL_UNREAD_MESSAGES",  # (userid)
+
+    "IMAP_SERVICE_STARTED",
+    "IMAP_SERVICE_FAILED_TO_START",
+    "IMAP_UNHANDLED_ERROR",
+    "IMAP_CLIENT_LOGIN",  # (username)
+
+    "SMTP_SERVICE_STARTED",
+    "SMTP_SERVICE_FAILED_TO_START",
+    "SMTP_START_ENCRYPT_AND_SIGN",  # (from_addr)
+    "SMTP_END_ENCRYPT_AND_SIGN",  # (from_addr)
+    "SMTP_START_SIGN",  # (from_addr)
+    "SMTP_END_SIGN",  # (from_addr)
+    "SMTP_SEND_MESSAGE_START",  # (from_addr)
+    "SMTP_SEND_MESSAGE_SUCCESS",  # (from_addr)
+    "SMTP_RECIPIENT_ACCEPTED_ENCRYPTED",  # (userid, dest)
+    "SMTP_RECIPIENT_ACCEPTED_UNENCRYPTED",  # (userid, dest)
+    "SMTP_CONNECTION_LOST",  # (userid, dest)
+    "SMTP_RECIPIENT_REJECTED",  # (userid, dest)
+    "SMTP_SEND_MESSAGE_ERROR",  # (userid, dest)
 ]