Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
recent_view: Schedule delayed topic visibility updates itself.
Aman Agrawalc82f596ee4a6
diff --git a/web/src/recent_view_ui.ts b/web/src/recent_view_ui.tsindex cdcdaf27a7e..494afd08123 100644--- a/web/src/recent_view_ui.ts+++ b/web/src/recent_view_ui.ts@@ -1260,7 +1260,11 @@ export function rerender_conversations_with_user(user_id: number): void {}}-export function update_topic_visibility_policy(stream_id: number, topic: string): boolean {+export function schedule_topic_visibility_update(+ stream_id: number,+ topic: string,+ delay_ms: number,+): boolean {const key = recent_view_util.get_topic_key(stream_id, topic);if (!recent_view_data.conversations.has(key)) {// we receive mute request for a topic we are@@ -1268,7 +1272,9 @@ export function update_topic_visibility_policy(stream_id: number, topic: string)return false;}- inplace_rerender(key);+ setTimeout(() => {+ inplace_rerender(key);+ }, delay_ms);return true;}diff --git a/web/src/user_topics_ui.ts b/web/src/user_topics_ui.tsindex f8c23df7a37..e307184c5a9 100644--- a/web/src/user_topics_ui.ts+++ b/web/src/user_topics_ui.ts@@ -17,6 +17,8 @@ import * as unread_ui from "./unread_ui.ts";import * as user_topics from "./user_topics.ts";import type {ServerUserTopic} from "./user_topics.ts";+export const MUTED_TOPIC_UPDATE_DELAY_MS = 500;+function should_add_topic_update_delay(visibility_policy: number): boolean {// If topic visibility related popovers are active, add a delay to all methods that// hide the topic on mute. This allows the switching animations to complete before the@@ -46,37 +48,38 @@ export function handle_topic_updates(// Update the UI after changes in topic visibility policies.user_topics.set_user_topic(user_topic_event);- setTimeout(- () => {- stream_list.update_streams_sidebar();- unread_ui.update_unread_counts();- recent_view_ui.update_topic_visibility_policy(- user_topic_event.stream_id,- user_topic_event.topic_name,- );-- if (!refreshed_current_narrow) {- if (message_lists.current?.data.filter.is_in_home()) {- const is_topic_visible_in_home = user_topics.is_topic_visible_in_home(- user_topic_event.stream_id,- user_topic_event.topic_name,- );- if (- rerender_combined_feed_callback &&- !was_topic_visible_in_home &&- is_topic_visible_in_home- ) {- rerender_combined_feed_callback(message_lists.current);- } else {- message_lists.current.update_muting_and_rerender();- }+ const update_delay_ms = should_add_topic_update_delay(user_topic_event.visibility_policy)+ ? MUTED_TOPIC_UPDATE_DELAY_MS+ : 0;+ recent_view_ui.schedule_topic_visibility_update(+ user_topic_event.stream_id,+ user_topic_event.topic_name,+ update_delay_ms,+ );+ setTimeout(() => {+ stream_list.update_streams_sidebar();+ unread_ui.update_unread_counts();++ if (!refreshed_current_narrow) {+ if (message_lists.current?.data.filter.is_in_home()) {+ const is_topic_visible_in_home = user_topics.is_topic_visible_in_home(+ user_topic_event.stream_id,+ user_topic_event.topic_name,+ );+ if (+ rerender_combined_feed_callback &&+ !was_topic_visible_in_home &&+ is_topic_visible_in_home+ ) {+ rerender_combined_feed_callback(message_lists.current);} else {- message_lists.current?.update_muting_and_rerender();+ message_lists.current.update_muting_and_rerender();}+ } else {+ message_lists.current?.update_muting_and_rerender();}- },- should_add_topic_update_delay(user_topic_event.visibility_policy) ? 500 : 0,- );+ }+ }, update_delay_ms);if (overlays.settings_open() && settings_user_topics.loaded) {const stream_id = user_topic_event.stream_id;diff --git a/web/tests/recent_view.test.cjs b/web/tests/recent_view.test.cjsindex 5fb99776367..35ca2a891ed 100644--- a/web/tests/recent_view.test.cjs+++ b/web/tests/recent_view.test.cjs@@ -3,7 +3,7 @@const assert = require("node:assert/strict");const {make_realm} = require("./lib/example_realm.cjs");-const {mock_esm, zrequire} = require("./lib/namespace.cjs");+const {clock, mock_esm, zrequire} = require("./lib/namespace.cjs");const {run_test, noop} = require("./lib/test.cjs");const {$} = require("./lib/zjquery.cjs");const {page_params} = require("./lib/zpage_params.cjs");@@ -1091,8 +1091,26 @@ test("rerender inserts rows only within the rendered range", ({override}) => {]);});-test("basic assertions", ({mock_template, override_rewire}) => {- override_rewire(rt, "inplace_rerender", noop);+test("a topic's visibility update rerenders its row after the delay", ({override_rewire}) => {+ show_recent_view_with_messages();+ const rerendered_keys = [];+ override_rewire(rt, "inplace_rerender", (key) => {+ rerendered_keys.push(key);+ });++ assert.ok(rt.schedule_topic_visibility_update(stream1, topic1, 500));+ clock.tick(499);+ assert.deepEqual(rerendered_keys, []);+ clock.tick(1);+ assert.deepEqual(rerendered_keys, [get_topic_key(stream1, topic1)]);++ // Recent view has no row to update for a topic it is not tracking.+ assert.ok(!rt.schedule_topic_visibility_update(stream1, "topic-10", 500));+ clock.tick(500);+ assert.deepEqual(rerendered_keys, [get_topic_key(stream1, topic1)]);+});++test("basic assertions", ({mock_template}) => {rt.clear_for_tests();rt.set_filters_for_tests();@@ -1252,14 +1270,6 @@ test("basic assertions", ({mock_template, override_rewire}) => {"1:topic-1","6,7,8",]);-- // update_topic_visibility_policy now relies on external libraries completely- // so we don't need to check anythere here.- generate_topic_data([[1, topic1, 0, all_visibility_policies.INHERIT]]);- $("#search_query").trigger("focus");- assert.equal(rt.update_topic_visibility_policy(stream1, topic1), true);- // a topic gets muted which we are not tracking- assert.equal(rt.update_topic_visibility_policy(stream1, "topic-10"), false);});test("test_reify_local_echo_message", ({mock_template}) => {diff --git a/web/tests/user_topics_ui.test.cjs b/web/tests/user_topics_ui.test.cjsindex 742a493b529..cc3634e6661 100644--- a/web/tests/user_topics_ui.test.cjs+++ b/web/tests/user_topics_ui.test.cjs@@ -3,9 +3,16 @@const assert = require("node:assert/strict");const {make_stream} = require("./lib/example_stream.cjs");-const {zrequire} = require("./lib/namespace.cjs");-const {run_test} = require("./lib/test.cjs");+const {mock_esm, zrequire} = require("./lib/namespace.cjs");+const {run_test, noop} = require("./lib/test.cjs");+const popover_menus = mock_esm("../src/popover_menus", {+ is_topic_menu_popover_displayed: () => false,+ is_visibility_policy_popover_displayed: () => false,+});+const recent_view_ui = mock_esm("../src/recent_view_ui", {+ schedule_topic_visibility_update: noop,+});const user_topics = zrequire("user_topics");const user_topics_ui = zrequire("user_topics_ui");const stream_data = zrequire("stream_data");@@ -103,3 +110,41 @@ test("toggle_topic_visibility_policy", ({override_rewire}) => {user_topics.all_visibility_policies.INHERIT,);});++test("handle_topic_updates delays hiding the topic for popovers", ({override}) => {+ // Recent view is told of the change right away, with the delay it+ // should apply; the other UI updates are scheduled with the same+ // delay, and not run here.+ const scheduled_delays = [];+ override(global, "setTimeout", (_callback, delay) => {+ scheduled_delays.push(delay);+ });+ const recent_view_updates = [];+ override(recent_view_ui, "schedule_topic_visibility_update", (stream_id, topic, delay_ms) => {+ recent_view_updates.push([stream_id, topic, delay_ms]);+ });+ const mute_event = {+ stream_id: design.stream_id,+ topic_name: "java",+ visibility_policy: user_topics.all_visibility_policies.MUTED,+ last_updated: 1,+ };++ user_topics_ui.handle_topic_updates(mute_event);+ assert.ok(user_topics.is_topic_muted(design.stream_id, "java"));+ assert.deepEqual(recent_view_updates, [[design.stream_id, "java", 0]]);+ // The second timer updates background message lists, never delayed.+ assert.deepEqual(scheduled_delays, [0, 0]);++ // With a topic popover open, the muted topic's row waits for the+ // popover to finish closing.+ override(popover_menus, "is_topic_menu_popover_displayed", () => true);+ scheduled_delays.length = 0;+ user_topics_ui.handle_topic_updates(mute_event);+ assert.deepEqual(recent_view_updates.at(-1), [+ design.stream_id,+ "java",+ user_topics_ui.MUTED_TOPIC_UPDATE_DELAY_MS,+ ]);+ assert.deepEqual(scheduled_delays, [user_topics_ui.MUTED_TOPIC_UPDATE_DELAY_MS, 0]);+});