Add realm_non_active_users data to initial payload.

We now add `realm_non_active_users` to the result of
`do_events_register` (and thus `page_params`).  It has
the same structure as `realm_users`, but it's for
non-active users.  Clients need data on non-active users
when they process old messages that were sent by those
users when they were active.  Clients can currently get
most of the data they need in the message events, but it
makes for ugly client code.

Fixes #4322

zerver/lib/events.py

@@ -62,12 +62,12 @@ def get_raw_user_data(realm_id):
             is_bot=row['is_bot'],
             full_name=row['full_name'],
             timezone=row['timezone'],
+            is_active = row['is_active'],
         )
 
     return {
         row['id']: user_data(row)
         for row in user_dicts
-        if row['is_active']
     }
 
 def always_want(msg_type):
@@ -275,9 +275,11 @@ def apply_event(state, event, user_profile, include_subscribers):
         person_user_id = person['user_id']
 
         if event['op'] == "add":
+            person = copy.deepcopy(person)
+            person['is_active'] = True
             state['raw_users'][person_user_id] = person
         elif event['op'] == "remove":
-            state['raw_users'].pop(person_user_id, None)
+            state['raw_users'][person_user_id]['is_active'] = False
         elif event['op'] == 'update':
             is_me = (person_user_id == user_profile.id)
 
@@ -573,7 +575,24 @@ def do_events_register(user_profile, user_client, apply_markdown=True,
     See the note above; the same technique applies below.
     '''
     if 'raw_users'in ret:
-        ret['realm_users'] = list(ret['raw_users'].values())
+        user_dicts = list(ret['raw_users'].values())
+
+        ret['realm_users'] = [d for d in user_dicts if d['is_active']]
+        ret['realm_non_active_users'] = [d for d in user_dicts if not d['is_active']]
+
+        '''
+        Be aware that we do intentional aliasing in the below code.
+        We can now safely remove the `is_active` field from all the
+        dicts that got partitioned into the two lists above.
+
+        We remove the field because it's already implied, and sending
+        it to clients makes clients prone to bugs where they "trust"
+        the field but don't actually update in live updates.  It also
+        wastes bandwidth.
+        '''
+        for d in user_dicts:
+            d.pop('is_active')
+
         del ret['raw_users']
 
     if len(events) > 0:

zerver/tests/test_home.py

@@ -129,6 +129,7 @@ class HomeTest(ZulipTestCase):
             "realm_message_retention_days",
             "realm_name",
             "realm_name_changes_disabled",
+            "realm_non_active_users",
             "realm_notifications_stream_id",
             "realm_password_auth_enabled",
             "realm_presence_disabled",