Files
zulip/frontend_tests/node_tests/message_events.js
Tim Abbott 0d90bb2569 narrow: Fix messages being cached without flags set.
f0c680e9c0 introduced a call to
message_helper.process_new_message without first calling
message_store.set_message_flags on the message.

This resulted in it being possible as a race, when loading the Zulip
app to a stream/topic/near narrow, for a message to have the
`historical` flag be undefined due to not being initialized.

That invalid state, in turn, resulted in the message_list_view code
path for rendering the message feed incorrectly displaying additional
recipient bars around the message.

We could fix this by just calling message_store.set_message_booleans
in this code path. However, this bug exposes the fact that it's very
fragile to expect every code path to call that function before
message_helper.process_new_message.

So we instead fix this by moving message_store.set_message_booleans
inside message_helper.process_new_message.

One call point of concern in this change is maybe_add_narrow_messages,
which could theoretically reintroduce the double set_message_flags
bugs detailed in 9729b1a4ad. However, I
believe that to not be possible, because that call should never
experience a cache miss.

The other existing code paths were already calling
set_message_booleans immediately before
message_helper.process_new_message. They are still changing here, in
that we now do a cache lookup before attempting to call
set_message_booleans. Because the message booleans do not affect the
cache lookup and the local message object is discarded in case of a
cache hit, this should have no functional impact.

Because I found the existing comment at that call site confusing and
almost proposed removing it as pointless, extend the block comment to
explicitly mention that the purpose is refreshing our object.

Fixes #21503.
2022-03-24 08:10:14 -07:00

158 lines
4.6 KiB
JavaScript

"use strict";
const {strict: assert} = require("assert");
const {mock_esm, zrequire} = require("../zjsunit/namespace");
const {run_test} = require("../zjsunit/test");
const $ = require("../zjsunit/zjquery");
const {page_params} = require("../zjsunit/zpage_params");
const condense = mock_esm("../../static/js/condense");
const message_edit = mock_esm("../../static/js/message_edit");
const message_list = mock_esm("../../static/js/message_list");
const message_lists = mock_esm("../../static/js/message_lists");
const notifications = mock_esm("../../static/js/notifications");
const pm_list = mock_esm("../../static/js/pm_list");
const stream_list = mock_esm("../../static/js/stream_list");
const unread_ui = mock_esm("../../static/js/unread_ui");
message_lists.current = {};
const people = zrequire("people");
const message_events = zrequire("message_events");
const message_helper = zrequire("message_helper");
const stream_data = zrequire("stream_data");
const stream_topic_history = zrequire("stream_topic_history");
const unread = zrequire("unread");
const alice = {
email: "alice@example.com",
user_id: 32,
full_name: "Alice Patel",
};
people.add_active_user(alice);
const denmark = {
subscribed: false,
name: "Denmark",
stream_id: 101,
};
stream_data.add_sub(denmark);
function test_helper(side_effects) {
const events = [];
for (const [module, field] of side_effects) {
module[field] = () => {
events.push([module, field]);
};
}
const self = {};
self.verify = () => {
assert.deepEqual(side_effects, events);
};
return self;
}
run_test("update_messages", () => {
const original_message = {
id: 111,
display_recipient: denmark.name,
flags: ["mentioned"],
sender_id: alice.user_id,
stream_id: denmark.stream_id,
topic: "lunch",
type: "stream",
};
message_helper.process_new_message(original_message);
assert.equal(original_message.mentioned, true);
assert.equal(original_message.unread, true);
assert.deepEqual(stream_topic_history.get_recent_topic_names(denmark.stream_id), ["lunch"]);
unread.update_message_for_mention(original_message);
assert.ok(unread.unread_mentions_counter.has(original_message.id));
const events = [
{
message_id: original_message.id,
flags: [],
orig_content: "old stuff",
content: "**new content**",
rendered_content: "<b>new content</b>",
},
];
message_lists.current.get_row = (message_id) => {
assert.equal(message_id, 111);
return ["row-stub"];
};
message_lists.current.view = {};
let rendered_mgs;
message_lists.current.view.rerender_messages = (msgs_to_rerender, message_content_edited) => {
rendered_mgs = msgs_to_rerender;
assert.equal(message_content_edited, true);
};
const side_effects = [
[condense, "un_cache_message_content_height"],
[message_edit, "end_message_row_edit"],
[notifications, "received_messages"],
[unread_ui, "update_unread_counts"],
[stream_list, "update_streams_sidebar"],
[pm_list, "update_private_messages"],
];
const helper = test_helper(side_effects);
page_params.realm_allow_edit_history = false;
message_list.narrowed = "stub-to-ignore";
const $message_edit_history_modal = $.create("#message-edit-history");
const $modal = $.create("micromodal").addClass("modal--open");
$message_edit_history_modal.set_parents_result(".micromodal", $modal);
// TEST THIS:
message_events.update_messages(events);
assert.ok(!unread.unread_mentions_counter.has(original_message.id));
helper.verify();
assert.deepEqual(rendered_mgs, [
{
alerted: false,
collapsed: false,
content: "<b>new content</b>",
display_recipient: denmark.name,
historical: false,
id: 111,
is_stream: true,
last_edit_timestamp: undefined,
mentioned: false,
mentioned_me_directly: false,
raw_content: "**new content**",
reactions: [],
reply_to: alice.email,
sender_email: alice.email,
sender_full_name: alice.full_name,
sender_id: 32,
sent_by_me: false,
starred: false,
status_emoji_info: undefined,
stream: denmark.name,
stream_id: denmark.stream_id,
topic: "lunch",
type: "stream",
unread: true,
},
]);
});