Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

recent_view: Report rows hidden without a rerender.

Aman Agrawal6c884a6f3e24
diff --git a/web/src/recent_view_ui.ts b/web/src/recent_view_ui.ts
index fe4e7435e50..7c997c8cef1 100644
--- a/web/src/recent_view_ui.ts
+++ b/web/src/recent_view_ui.ts
@@ -1161,6 +1161,37 @@ export function filters_should_hide_row(topic_data: ConversationData): boolean {
return false;
}
+// The resort should remove only rows of the conversations being
+// rerendered. Any other row belongs to a conversation that an event hid
+// without rerendering it or redrawing the view.
+function report_rows_hidden_without_rerender(
+ removed_conversations: ConversationData[],
+ rerendered_keys: Set<string>,
+): void {
+ const unexpected_removals = removed_conversations.filter(
+ (conversation) => !rerendered_keys.has(get_conversation_key(conversation)),
+ );
+ if (unexpected_removals.length === 0) {
+ return;
+ }
+ const search_keyword = get_search_keyword();
+ const is_search_redraw_pending = search_keyword !== previous_search_term;
+ if (is_search_redraw_pending) {
+ // The resort also removed the rows that search hides.
+ return;
+ }
+ blueslip.error("Recent view rows hidden without a rerender", {
+ count: unexpected_removals.length,
+ types: [...new Set(unexpected_removals.map((conversation) => conversation.type))],
+ filters: [...filters],
+ dropdown_filters: [...dropdown_filters],
+ has_search_keyword: search_keyword !== "",
+ has_folder_filter:
+ folder_filter_value !==
+ folder_dropdown_widget.FOLDER_FILTERS.ANY_FOLDER_DROPDOWN_OPTION,
+ });
+}
+
function rerender_conversation_rows(row_keys: Set<string>): void {
assert(topics_widget !== undefined);
// Look up the focused row while row_focus still indexes the rows the
@@ -1211,6 +1242,8 @@ function rerender_conversation_rows(row_keys: Set<string>): void {
topics_widget.render();
}
setTimeout(revive_current_focus, 0);
+ // Last, since blueslip.error throws in development.
+ report_rows_hidden_without_rerender(removed_conversations, row_keys);
}
export function bulk_inplace_rerender(row_keys: Set<string>): void {
diff --git a/web/src/server_events_dispatch.js b/web/src/server_events_dispatch.js
index 94b9f463cce..0d1aa758df3 100644
--- a/web/src/server_events_dispatch.js
+++ b/web/src/server_events_dispatch.js
@@ -807,6 +807,9 @@ export function dispatch_normal_event(event) {
);
}
const message_ids = message_store.get_message_ids_in_stream(stream_id);
+ // Redraw first: processing the reads rerenders recent view, which
+ // would report the channel's other rows as hidden without a rerender.
+ recent_view_ui.complete_rerender();
unread_ops.process_read_messages_event(message_ids);
message_events.remove_messages(message_ids);
stream_topic_history.remove_history_for_stream(stream_id);
diff --git a/web/tests/dispatch_subs.test.cjs b/web/tests/dispatch_subs.test.cjs
index 7afaeda06f7..66bf948998b 100644
--- a/web/tests/dispatch_subs.test.cjs
+++ b/web/tests/dispatch_subs.test.cjs
@@ -20,7 +20,7 @@ mock_esm("../src/inbox_ui", {
});
const message_events = mock_esm("../src/message_events");
const overlays = mock_esm("../src/overlays");
-mock_esm("../src/recent_view_ui", {
+const recent_view_ui = mock_esm("../src/recent_view_ui", {
complete_rerender: noop,
});
const settings_org = mock_esm("../src/settings_org");
@@ -252,12 +252,27 @@ test("stream delete (normal)", ({override, override_rewire}) => {
override(stream_list, "update_subscribe_to_more_streams_link", noop);
- override(unread_ops, "process_read_messages_event", noop);
+ // Recent view is redrawn before each channel's reads are processed,
+ // which would otherwise report the channel's rows as hidden.
+ const recent_view_calls = [];
+ override(recent_view_ui, "complete_rerender", () => {
+ recent_view_calls.push("complete_rerender");
+ });
+ override(unread_ops, "process_read_messages_event", () => {
+ recent_view_calls.push("process_read_messages_event");
+ });
override(message_events, "remove_messages", noop);
override(user_group_edit, "update_group_permissions_panel_on_losing_stream_access", noop);
dispatch(event);
assert.deepEqual(removed_stream_ids, [event.stream_ids[0], event.stream_ids[1]]);
+ assert.deepEqual(recent_view_calls, [
+ "complete_rerender",
+ "process_read_messages_event",
+ "complete_rerender",
+ "process_read_messages_event",
+ "complete_rerender",
+ ]);
});
test("stream delete (special streams)", ({override, override_rewire}) => {
diff --git a/web/tests/recent_view.test.cjs b/web/tests/recent_view.test.cjs
index 53400509270..b42626b12ae 100644
--- a/web/tests/recent_view.test.cjs
+++ b/web/tests/recent_view.test.cjs
@@ -5,6 +5,7 @@ const assert = require("node:assert/strict");
const {make_realm} = require("./lib/example_realm.cjs");
const {clock, mock_esm, zrequire} = require("./lib/namespace.cjs");
const {run_test, noop} = require("./lib/test.cjs");
+const blueslip = require("./lib/zblueslip.cjs");
const {$} = require("./lib/zjquery.cjs");
const {page_params} = require("./lib/zpage_params.cjs");
@@ -1142,6 +1143,35 @@ test("a conversation without a row stays unlisted until its visibility update",
assert.ok(!rt.filters_should_hide_row(conversation));
});
+test("rerender reports rows its resort removed without being asked", ({override}) => {
+ // The widget's resort removes the row of a conversation the filters
+ // hide. For any conversation but the one being rerendered, that means
+ // an event hid it without updating the view, which is reported.
+ show_recent_view_with_messages();
+ const muted_key = get_topic_key(stream1, topic7);
+ const visible_key = get_topic_key(stream1, topic1);
+ override(ListWidget, "render_item", noop);
+ override(ListWidget, "get_current_list", () => [conversation_for(topic1)]);
+ override(ListWidget, "filter_and_sort", () => [conversation_for(topic7)]);
+
+ rt.inplace_rerender(muted_key);
+ assert.deepEqual(blueslip.get_test_logs("error"), []);
+
+ blueslip.expect("error", "Recent view rows hidden without a rerender");
+ rt.inplace_rerender(visible_key);
+ const [{more_info}] = blueslip.get_test_logs("error");
+ assert.equal(more_info.count, 1);
+ assert.deepEqual(more_info.types, ["stream"]);
+ blueslip.reset();
+
+ // While a search is being typed, its debounced handler has yet to
+ // redraw the view, and the resort removes the rows it hides as well.
+ $("#recent_view_search").val("half typed");
+ rt.inplace_rerender(visible_key);
+ assert.deepEqual(blueslip.get_test_logs("error"), []);
+ $("#recent_view_search").val("");
+});
+
test("basic assertions", ({mock_template}) => {
rt.clear_for_tests();
rt.set_filters_for_tests();