TRACKING: Event handling improvements

[Ezio-Sarthak]

ZT currently handles some common (e.g., message/subscription update) events. To know more about events API, check out the Get events doc :)

Below are some events that might be a good addition:

• alert_words: Alert word handling #588: Alert words handling
• update_display_settings: Handle user update events & consequential UI changes #988: Update user display settings
• update_global_notifications: Update global notifications (currently stream-based priority? Notifications should match the settings in the webapp (e.g. stream-based notifications) #666)
• stream: Adding new stream throws an Keyerror #816: Streams (add, delete, update) (streams: Handle adding/removing stream events. #851)
• attachment: Uploading/Attaching Files #529 Upload/Attachment events
• submessage: Submessages (e.g., polls) (WIP: Barely working zforms support. #287)
• user_status: Handle user update events & consequential UI changes #988: User status updates.
• custom_profile_fields: Custom profile fields (extension of user info popup Feature: Add user info view #848)
• default_streams: Handle Default stream updates (changed by org admin).
• delete_message: Delete message event (first event handling, then feature support; Support receiving message ids to delete in bulk. #690)
• muted_topics: TRACKING: Topic muting improvements #745: Handle Topic muting ([WIP] - Mute topics from within ZT #467/feature: Topic muting #914)
• user_group: User group events (add/modify/delete)
• realm_emoji: Fetch realm emoji in initial register call & update using events #809: Realm emoji events (model: Fetch realm emoji using events #827)
• typing: Handle typing events from multiple users in a PM narrow #992/Add support for typing notifications in streams #1015: Improve typing event handling
• restart: Server restart events (including eg. upgrades, which may trigger ZFL updates & feature support; see #mobile-team>Server feature level)

Despite the above events there are some which might not need attention as of now, however, would be worth mentioning:

• has_zoom_token: Zoom integration (OAuth flow required)
• invites_changed: Event sent to Admin if the set of invitations change
• default_stream_groups: Handling change of default user groups (experimental, not stabilized)
• hotspots: Sent when set of onboarding "hotspots" (for current user) has changed. Might be a potential follow-up of tutorial experience.
• realm_filters/realm_linkifiers: Handle a change of configured linkifiers. (See Migrate from realm_filters event format to new realm_linkifiers format #995 for handling new format events and supporting backwards compatibility).
• realm_domains: Handles change for the set of allowed domains for new users. Might be fruitful after improving support for multiple organizations.
• realm_export: Event sent to users requesting a data export.
• realm_bot: Event responsible to let user administer a newly created bot (see also realm_user).

[zulipbot]

ERROR: Label "area:event handling" does not exist and was thus not added to this issue.

[Ezio-Sarthak]

@zulipbot add "area: event handling"

[neiljp]

Tagged with GSoC, but this is across multiple areas so as per the tracking nature of this issue, this isn't something one person will likely work on.

[abhijeetbodas2001]

realm_filters: Handle a change of configured linkifiers.

I get that this is not a high priority, but whenever in the future ZT adds support for handling events sent after the linkifiers in the realm have changed, we should handle the new realm_linkifiers events, since the realm_filters event type has been deprecated in feature level 54. #995 has more context. Can you update the issue description?

[Ezio-Sarthak]

Thanks! Updated the issue description :)

[neiljp]

Also see zulip/zulip-mobile#3408 for a similar mobile tracking issue.