Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

reactions: Delete stale message.reactions after cleaning. 

Also update some comments explaining the core data model and approach
for set_clean_reactions.
This commit is contained in:
Tim Abbott 2022-09-28 17:30:58 -07:00
parent 5bd074bb36
commit 545a31e0b1
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
static/js/reactions.js
View File

@ -438,25 +438,24 @@ export function get_message_reactions(message) {
export function set_clean_reactions(message) { export function set_clean_reactions(message) {
/* /*
The server sends us a single structure for set_clean_reactions processes the raw message.reactions object,
each reaction, even if two users are reacting which will contain one object for each individual reaction, even
with the same emoji. Our first loop creates if two users react with the same emoji.
a map of distinct reactions and a map of
local_id -> user_ids. The `local_id` is
basically a key for the emoji name.
Then in our second loop we build a more compact As output, it sets message.cleaned_reactions, which is a more
data structure that's easier for our message compressed format with one entry per reaction pill that should
list view templates to work with. be displayed visually to users.
*/ */
if (message.clean_reactions) { if (message.clean_reactions) {
return; return;
} }
// This first loop creates a temporary distinct_reactions data
// structure, which will accumulate the set of users who have
// reacted with each distinct reaction.
const distinct_reactions = new Map(); const distinct_reactions = new Map();
const user_map = new Map(); const user_map = new Map();
for (const reaction of message.reactions) { for (const reaction of message.reactions) {
const local_id = get_local_reaction_id(reaction); const local_id = get_local_reaction_id(reaction);
const user_id = reaction.user_id; const user_id = reaction.user_id;
@ -483,16 +482,12 @@ export function set_clean_reactions(message) {
user_ids.push(user_id); user_ids.push(user_id);
} }
/* // TODO: Rather than adding this field to the message object, it
It might feel a little janky to attach clean_reactions // might be cleaner to create an independent map from message_id
directly to the message object, but this allows the // => clean_reactions data for the message, with care being taken
server to send us a new copy of the message, and then // to make sure reify_message_id moves the data structure
the next time we try to get reactions from it, we // properly.
won't have `clean_reactions`, and we will re-process
the server's latest copy of the reactions.
*/
message.clean_reactions = new Map(); message.clean_reactions = new Map();
for (const local_id of distinct_reactions.keys()) { for (const local_id of distinct_reactions.keys()) {
const reaction = distinct_reactions.get(local_id); const reaction = distinct_reactions.get(local_id);
const user_ids = user_map.get(local_id); const user_ids = user_map.get(local_id);
@ -502,6 +497,12 @@ export function set_clean_reactions(message) {
make_clean_reaction({local_id, user_ids, ...reaction}), make_clean_reaction({local_id, user_ids, ...reaction}),
); );
} }
// We don't maintain message.reactions when users react to
// messages we already have a copy of, so it's safest to delete it
// after we've processed the reactions data for a message into the
// clean_reactions data structure, which we do maintain.
delete message.reactions;
} }
function make_clean_reaction({local_id, user_ids, emoji_name, emoji_code, reaction_type}) { function make_clean_reaction({local_id, user_ids, emoji_name, emoji_code, reaction_type}) {