From 502ae6c663e9b96950d1b474fbec7cf200e4e8a1 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 14 Feb 2017 16:54:37 +0000
Subject: [PATCH] Comment

---
 synapse/storage/event_push_actions.py | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/synapse/storage/event_push_actions.py b/synapse/storage/event_push_actions.py
index db20b7de2..ea6722df6 100644
--- a/synapse/storage/event_push_actions.py
+++ b/synapse/storage/event_push_actions.py
@@ -26,30 +26,37 @@ import ujson as json
 logger = logging.getLogger(__name__)
 
 
-DEFAULT_NOTIF_ACITON = ["notify", {"set_tweak": "highlight", "value": False}]
-DEFAULT_HIGHLIGHT_ACITON = [
+DEFAULT_NOTIF_ACTION = ["notify", {"set_tweak": "highlight", "value": False}]
+DEFAULT_HIGHLIGHT_ACTION = [
     "notify", {"set_tweak": "sound", "value": "default"}, {"set_tweak": "highlight"}
 ]
 
 
 def _serialize_action(actions, is_highlight):
+    """Custom serializer for actions. This allows us to "compress" common actions.
+
+    We use the fact that most users have the same actions for notifs (and for
+    highlights). We replaces these default actions with the emtpy string.
+    """
     if is_highlight:
-        if actions == DEFAULT_HIGHLIGHT_ACITON:
-            return ""
+        if actions == DEFAULT_HIGHLIGHT_ACTION:
+            return ""  # We use empty string as the column is non-NULL
     else:
-        if actions == DEFAULT_NOTIF_ACITON:
+        if actions == DEFAULT_NOTIF_ACTION:
             return ""
     return json.dumps(actions)
 
 
 def _deserialize_action(actions, is_highlight):
+    """Custom deserializer for actions. This allows us to "compress" common actions
+    """
     if actions:
         return json.loads(actions)
 
     if is_highlight:
-        return DEFAULT_HIGHLIGHT_ACITON
+        return DEFAULT_HIGHLIGHT_ACTION
     else:
-        return DEFAULT_NOTIF_ACITON
+        return DEFAULT_NOTIF_ACTION
 
 
 class EventPushActionsStore(SQLBaseStore):