snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

web/tests/message_list.test.cjs

@@ -0,0 +1,560 @@
+"use strict";
+
+const assert = require("node:assert/strict");
+
+const {mock_esm, set_global, zrequire} = require("./lib/namespace.cjs");
+const {make_stub} = require("./lib/stub.cjs");
+const {run_test} = require("./lib/test.cjs");
+const blueslip = require("./lib/zblueslip.cjs");
+
+// These unit tests for web/src/message_list.ts emphasize the model-ish
+// aspects of the MessageList class.  We have to stub out a few functions
+// related to views and events to get the tests working.
+
+const noop = function () {};
+
+const document_events = [];
+set_global("document", {
+    to_$() {
+        return {
+            trigger(event) {
+                document_events.push(event);
+            },
+        };
+    },
+});
+
+const activity_ui = mock_esm("../src/activity_ui");
+const narrow_state = mock_esm("../src/narrow_state");
+const stream_data = mock_esm("../src/stream_data");
+
+const {MessageList} = zrequire("message_list");
+const {MessageListData} = zrequire("message_list_data");
+function MessageListView() {
+    return {
+        maybe_rerender: noop,
+        append: noop,
+        prepend: noop,
+        clear_rendering_state: noop,
+        is_current_message_list: () => true,
+        get_boundary_message_info_with_meaningful_historical: () => undefined,
+    };
+}
+mock_esm("../src/message_list_view", {
+    MessageListView,
+});
+
+mock_esm("../src/people.ts", {
+    maybe_get_user_by_id: noop,
+});
+
+const {Filter} = zrequire("filter");
+const {set_current_user} = zrequire("state_data");
+
+const current_user = {};
+set_current_user(current_user);
+
+run_test("basics", ({override}) => {
+    override(activity_ui, "rerender_user_sidebar_participants", noop);
+    const filter = new Filter([]);
+
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter,
+        }),
+    });
+
+    const messages = [
+        {
+            id: 50,
+            content: "fifty",
+        },
+        {
+            id: 60,
+        },
+        {
+            id: 70,
+        },
+        {
+            id: 80,
+        },
+    ];
+
+    assert.equal(list.empty(), true);
+
+    list.append(messages, true);
+
+    assert.equal(list.num_items(), 4);
+    assert.equal(list.empty(), false);
+    assert.equal(list.first().id, 50);
+    assert.equal(list.last().id, 80);
+
+    assert.equal(list.get(50).content, "fifty");
+
+    assert.equal(list.closest_id(49), 50);
+    assert.equal(list.closest_id(50), 50);
+    assert.equal(list.closest_id(51), 50);
+    assert.equal(list.closest_id(59), 60);
+    assert.equal(list.closest_id(60), 60);
+    assert.equal(list.closest_id(61), 60);
+
+    assert.deepEqual(list.all_messages(), messages);
+
+    document_events.length = 0;
+    list.select_id(50);
+
+    assert.equal(document_events.length, 1);
+    assert.equal(document_events[0].type, "message_selected.zulip");
+    assert.equal(list.selected_id(), 50);
+    assert.equal(list.selected_idx(), 0);
+
+    list.advance_past_messages([60, 80]);
+    assert.equal(list.selected_id(), 60);
+    assert.equal(list.selected_idx(), 1);
+
+    // Make sure not rerendered when reselected
+    let num_renders = 0;
+    list.rerender = function () {
+        num_renders += 1;
+    };
+    list.reselect_selected_id();
+    assert.equal(document_events.length, 2);
+    assert.equal(document_events[1].type, "message_selected.zulip");
+    assert.equal(num_renders, 0);
+    assert.equal(list.selected_id(), 60);
+
+    const old_messages = [
+        {
+            id: 30,
+        },
+        {
+            id: 40,
+        },
+    ];
+    list.add_messages(old_messages);
+    assert.equal(list.first().id, 30);
+    assert.equal(list.last().id, 80);
+
+    const new_messages = [
+        {
+            id: 90,
+        },
+    ];
+    list.append(new_messages, true);
+    assert.equal(list.last().id, 90);
+
+    list.view.clear_table = function () {};
+
+    list.remove_and_rerender([60]);
+    const removed = list.all_messages().filter((msg) => msg.id !== 60);
+    assert.deepEqual(list.all_messages(), removed);
+
+    list.clear();
+    assert.deepEqual(list.all_messages(), []);
+});
+
+run_test("prev_next", () => {
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+
+    assert.equal(list.prev(), undefined);
+    assert.equal(list.next(), undefined);
+    assert.equal(list.is_at_end(), false);
+
+    // try to confuse things with bogus selected id
+    list.data.set_selected_id(33);
+    assert.equal(list.prev(), undefined);
+    assert.equal(list.next(), undefined);
+    assert.equal(list.is_at_end(), false);
+
+    const messages = [{id: 30}, {id: 40}, {id: 50}, {id: 60}];
+    list.append(messages, true);
+    assert.equal(list.prev(), undefined);
+    assert.equal(list.next(), undefined);
+
+    // The next case is for defensive code.
+    list.data.set_selected_id(45);
+    assert.equal(list.prev(), undefined);
+    assert.equal(list.next(), undefined);
+    assert.equal(list.is_at_end(), false);
+
+    list.data.set_selected_id(30);
+    assert.equal(list.prev(), undefined);
+    assert.equal(list.next(), 40);
+
+    list.data.set_selected_id(50);
+    assert.equal(list.prev(), 40);
+    assert.equal(list.next(), 60);
+    assert.equal(list.is_at_end(), false);
+
+    list.data.set_selected_id(60);
+    assert.equal(list.prev(), 50);
+    assert.equal(list.next(), undefined);
+    assert.equal(list.is_at_end(), true);
+});
+
+run_test("message_range", () => {
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+
+    const messages = [{id: 30}, {id: 40}, {id: 50}, {id: 60}];
+    list.append(messages, true);
+    assert.deepEqual(list.message_range(2, 30), [{id: 30}]);
+    assert.deepEqual(list.message_range(2, 31), [{id: 30}, {id: 40}]);
+    assert.deepEqual(list.message_range(30, 40), [{id: 30}, {id: 40}]);
+    assert.deepEqual(list.message_range(31, 39), [{id: 40}]);
+    assert.deepEqual(list.message_range(31, 1000), [{id: 40}, {id: 50}, {id: 60}]);
+    blueslip.expect("error", "message_range given a start of -1");
+    assert.deepEqual(list.message_range(-1, 40), [{id: 30}, {id: 40}]);
+});
+
+run_test("change_message_id", () => {
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+    list.data._add_to_hash([
+        {id: 10.5, content: "good job"},
+        {id: 20.5, content: "ok!"},
+    ]);
+
+    // local to local
+    list.change_message_id(10.5, 11.5);
+    assert.equal(list.get(11.5).content, "good job");
+
+    list.change_message_id(11.5, 11);
+    assert.equal(list.get(11).content, "good job");
+
+    list.change_message_id(20.5, 10);
+    assert.equal(list.get(10).content, "ok!");
+
+    // test nonexistent id
+    assert.equal(list.change_message_id(13, 15), undefined);
+});
+
+run_test("last_sent_by_me", ({override}) => {
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+    const items = [
+        {
+            id: 1,
+            sender_id: 3,
+        },
+        {
+            id: 2,
+            sender_id: 3,
+        },
+        {
+            id: 3,
+            sender_id: 6,
+        },
+    ];
+
+    list.append(items);
+    override(current_user, "user_id", 3);
+    // Look for the last message where user_id == 3 (our ID)
+    assert.equal(list.get_last_message_sent_by_me().id, 2);
+});
+
+run_test("local_echo", () => {
+    let list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+    list.append([
+        {id: 10},
+        {id: 20},
+        {id: 30},
+        {id: 20.02},
+        {id: 20.03},
+        {id: 40},
+        {id: 50},
+        {id: 60},
+    ]);
+    list._local_only = {20.02: {id: 20.02}, 20.03: {id: 20.03}};
+
+    assert.equal(list.closest_id(10), 10);
+    assert.equal(list.closest_id(20), 20);
+    assert.equal(list.closest_id(30), 30);
+    assert.equal(list.closest_id(20.02), 20.02);
+    assert.equal(list.closest_id(20.03), 20.03);
+    assert.equal(list.closest_id(29), 30);
+    assert.equal(list.closest_id(40), 40);
+    assert.equal(list.closest_id(50), 50);
+    assert.equal(list.closest_id(60), 60);
+
+    assert.equal(list.closest_id(60), 60);
+    assert.equal(list.closest_id(21), 20);
+    assert.equal(list.closest_id(29), 30);
+    assert.equal(list.closest_id(31), 30);
+    assert.equal(list.closest_id(54), 50);
+    assert.equal(list.closest_id(58), 60);
+
+    list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+    list.append([
+        {id: 10},
+        {id: 20},
+        {id: 30},
+        {id: 20.02},
+        {id: 20.03},
+        {id: 40},
+        {id: 50},
+        {id: 50.01},
+        {id: 50.02},
+        {id: 60},
+    ]);
+    list._local_only = {
+        20.02: {id: 20.02},
+        20.03: {id: 20.03},
+        50.01: {id: 50.01},
+        50.02: {id: 50.02},
+    };
+
+    assert.equal(list.closest_id(10), 10);
+    assert.equal(list.closest_id(20), 20);
+    assert.equal(list.closest_id(30), 30);
+    assert.equal(list.closest_id(20.02), 20.02);
+    assert.equal(list.closest_id(20.03), 20.03);
+    assert.equal(list.closest_id(40), 40);
+    assert.equal(list.closest_id(50), 50);
+    assert.equal(list.closest_id(60), 60);
+
+    assert.equal(list.closest_id(60), 60);
+    assert.equal(list.closest_id(21), 20);
+    assert.equal(list.closest_id(29), 30);
+    assert.equal(list.closest_id(31), 30);
+    assert.equal(list.closest_id(47), 50);
+    assert.equal(list.closest_id(51), 50.02);
+    assert.equal(list.closest_id(59), 60);
+    assert.equal(list.closest_id(50.01), 50.01);
+});
+
+run_test("bookend", ({override}) => {
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter: new Filter([]),
+        }),
+    });
+
+    list.view.clear_trailing_bookend = noop;
+    list.is_combined_feed_view = false;
+
+    override(narrow_state, "stream_id", () => 5);
+
+    let is_subscribed = true;
+    let invite_only = false;
+
+    override(stream_data, "is_subscribed", () => is_subscribed);
+    override(stream_data, "get_sub_by_id", () => ({invite_only, name: "IceCream"}));
+    override(stream_data, "can_toggle_subscription", () => true);
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, true);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, false);
+    }
+
+    list.view.get_boundary_message_info_with_meaningful_historical = () => ({
+        message_container: {
+            msg: {
+                historical: false,
+            },
+        },
+    });
+
+    is_subscribed = false;
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, false);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, false);
+    }
+
+    list.view.get_boundary_message_info_with_meaningful_historical = () => ({
+        message_container: {
+            msg: {
+                historical: false,
+            },
+        },
+    });
+
+    is_subscribed = false;
+    list.empty = () => false;
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, false);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, true);
+    }
+
+    // Test when the stream is privates (invite only)
+    invite_only = true;
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, false);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, true);
+    }
+
+    list.view.get_boundary_message_info_with_meaningful_historical = () => ({
+        message_container: {
+            msg: {
+                historical: true,
+            },
+        },
+    });
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, false);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, false);
+    }
+
+    // When no rendered message has a meaningful `historical` flag
+    // (e.g., they were all moved from another channel), we don't know
+    // whether the user just unsubscribed, so we don't claim they did.
+    list.view.get_boundary_message_info_with_meaningful_historical = () => undefined;
+
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 1);
+        const bookend = stub.get_args(
+            "stream_id",
+            "stream_name",
+            "subscribed",
+            "deactivated",
+            "just_unsubscribed",
+        );
+        assert.equal(bookend.stream_id, 5);
+        assert.equal(bookend.stream_name, "IceCream");
+        assert.equal(bookend.subscribed, false);
+        assert.equal(bookend.deactivated, false);
+        assert.equal(bookend.just_unsubscribed, false);
+    }
+
+    // If the user is not subscribed and cannot subscribe to the
+    // private channel, no bookend is shown.
+    override(stream_data, "can_toggle_subscription", () => false);
+    {
+        const stub = make_stub();
+        list.view.render_trailing_bookend = stub.f;
+        list.update_trailing_bookend();
+        assert.equal(stub.num_calls, 0);
+    }
+});
+
+run_test("add_remove_rerender", ({override}) => {
+    override(activity_ui, "rerender_user_sidebar_participants", noop);
+
+    const filter = new Filter([]);
+    const list = new MessageList({
+        data: new MessageListData({
+            excludes_muted_topics: false,
+            filter,
+        }),
+    });
+
+    const messages = [{id: 1}, {id: 2}, {id: 3}];
+
+    list.add_messages(messages, {}, true);
+    assert.equal(list.num_items(), 3);
+
+    {
+        const stub = make_stub();
+        list.rerender = stub.f;
+        const message_ids = messages.map((msg) => msg.id);
+        list.remove_and_rerender(message_ids);
+        assert.equal(stub.num_calls, 1);
+        assert.equal(list.num_items(), 0);
+    }
+});