zulip/web/tests/unread.test.cjs

"use strict";

const assert = require("node:assert/strict");

const _ = require("lodash");

const {set_global, with_overrides, zrequire} = require("./lib/namespace.cjs");
const {run_test} = require("./lib/test.cjs");

set_global("document", "document-stub");
const {FoldDict} = zrequire("fold_dict");
const message_store = zrequire("message_store");
const user_topics = zrequire("user_topics");
const people = zrequire("people");
const stream_data = zrequire("stream_data");
const sub_store = zrequire("sub_store");
const unread = zrequire("unread");
const {initialize_user_settings} = zrequire("user_settings");

const user_settings = {};
initialize_user_settings({user_settings});

const me = {
    email: "me@example.com",
    user_id: 30,
    full_name: "Me Myself",
};

const anybody = {
    email: "anybody@example.com",
    user_id: 999,
    full_name: "Any Body",
};
people.add_active_user(me);
people.add_active_user(anybody);
people.initialize_current_user(me.user_id);

const social = {
    stream_id: 200,
    name: "social",
    subscribed: true,
    is_muted: false,
};
stream_data.add_sub(social);

function assert_zero_counts(counts) {
    assert.equal(counts.direct_message_count, 0);
    assert.equal(counts.home_unread_messages, 0);
    assert.equal(counts.mentioned_message_count, 0);
    assert.equal(counts.stream_count.size, 0);
    assert.equal(counts.pm_count.size, 0);
}

function test_notifiable_count(home_unread_messages, expected_notifiable_count) {
    with_overrides(({override}) => {
        override(user_settings, "desktop_icon_count_display", 1);
        let notifiable_counts = unread.get_notifiable_count();
        assert.deepEqual(notifiable_counts, home_unread_messages);
        override(user_settings, "desktop_icon_count_display", 2);
        notifiable_counts = unread.get_notifiable_count();
        assert.deepEqual(notifiable_counts, expected_notifiable_count);
        override(user_settings, "desktop_icon_count_display", 3);
        notifiable_counts = unread.get_notifiable_count();
        assert.deepEqual(notifiable_counts, expected_notifiable_count);
        override(user_settings, "desktop_icon_count_display", 4);
        notifiable_counts = unread.get_notifiable_count();
        assert.deepEqual(notifiable_counts, 0);
    });
}

function test(label, f) {
    run_test(label, (helpers) => {
        unread.declare_bankruptcy();
        user_topics.set_user_topics([]);
        f(helpers);
    });
}

test("empty_counts_while_narrowed", () => {
    const counts = unread.get_counts();
    assert_zero_counts(counts);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("empty_counts_while_home", () => {
    const counts = unread.get_counts();
    assert_zero_counts(counts);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("changing_topics", () => {
    // Summary: change the topic of a message from 'lunch'
    // to 'dinner' using update_unread_topics().
    let count = unread.num_unread_for_topic(social.stream_id, "lunch");
    assert.equal(count, 0);

    const stream_id = 100;
    const wrong_stream_id = 110;

    const message = {
        id: 15,
        type: "stream",
        stream_id,
        topic: "luNch",
        unread: true,
    };

    const other_message = {
        id: 16,
        type: "stream",
        stream_id,
        topic: "lunCH",
        unread: true,
    };
    message_store.update_message_cache(message);
    message_store.update_message_cache(other_message);

    assert.deepEqual(unread.get_read_message_ids([15, 16]), [15, 16]);
    assert.deepEqual(unread.get_unread_message_ids([15, 16]), []);
    assert.deepEqual(unread.get_unread_messages([message, other_message]), []);

    let msg_ids = unread.get_msg_ids_for_topic(stream_id, "LuNcH");
    assert.deepEqual(msg_ids, []);

    msg_ids = unread.get_msg_ids_for_stream(stream_id);
    assert.deepEqual(msg_ids, []);

    unread.process_loaded_messages([message, other_message]);

    assert.deepEqual(unread.get_all_msg_ids(), [15, 16]);
    assert.deepEqual(unread.get_read_message_ids([15, 16]), []);
    assert.deepEqual(unread.get_unread_message_ids([15, 16]), [15, 16]);
    assert.deepEqual(unread.get_unread_messages([message, other_message]), [
        message,
        other_message,
    ]);

    count = unread.num_unread_for_topic(stream_id, "Lunch");
    assert.equal(count, 2);
    assert.ok(unread.topic_has_any_unread(stream_id, "lunch"));
    assert.ok(!unread.topic_has_any_unread(wrong_stream_id, "lunch"));
    assert.ok(!unread.topic_has_any_unread(stream_id, "NOT lunch"));

    count = unread.num_unread_for_topic(stream_id, "NOT lunch");
    assert.equal(count, 0);

    msg_ids = unread.get_msg_ids_for_topic(stream_id, "NOT lunch");
    assert.deepEqual(msg_ids, []);

    let event = {
        topic: "dinner",
    };

    unread.update_unread_topics(message, event);

    count = unread.num_unread_for_topic(stream_id, "lUnch");
    assert.equal(count, 1);

    count = unread.num_unread_for_topic(stream_id, "dinner");
    assert.equal(count, 1);

    event = {
        topic: "snack",
    };

    unread.update_unread_topics(other_message, event);

    count = unread.num_unread_for_topic(stream_id, "lunch");
    assert.equal(count, 0);
    assert.ok(!unread.topic_has_any_unread(stream_id, "lunch"));
    assert.ok(!unread.topic_has_any_unread(wrong_stream_id, "lunch"));

    count = unread.num_unread_for_topic(stream_id, "snack");
    assert.equal(count, 1);
    assert.ok(unread.topic_has_any_unread(stream_id, "snack"));
    assert.ok(!unread.topic_has_any_unread(wrong_stream_id, "snack"));

    // Test defensive code.  Trying to update a message we don't know
    // about should be a no-op.
    event = {
        topic: "supper",
    };
    unread.update_unread_topics(other_message, event);

    // Update a message that was never marked as unread.
    const sticky_message = {
        id: 17,
        type: "stream",
        stream_id,
        topic: "sticky",
        unread: true,
    };

    message_store.update_message_cache(message);
    message_store.update_message_cache(other_message);
    message_store.update_message_cache(sticky_message);

    unread.process_loaded_messages([sticky_message]);
    count = unread.num_unread_for_topic(stream_id, "sticky");
    assert.equal(count, 1);
    assert.ok(sticky_message.unread);

    unread.mark_as_read(sticky_message.id);
    count = unread.num_unread_for_topic(stream_id, "sticky");
    assert.equal(count, 0);
    assert.ok(!sticky_message.unread);

    event = {
        topic: "sticky",
    };

    unread.update_unread_topics(sticky_message, event);
    count = unread.num_unread_for_topic(stream_id, "sticky");
    assert.equal(count, 0);

    // cleanup
    unread.mark_as_read(message.id);
    count = unread.num_unread_for_topic(stream_id, "dinner");
    assert.equal(count, 0);

    unread.mark_as_read(other_message.id);
    count = unread.num_unread_for_topic(stream_id, "snack");
    assert.equal(count, 0);

    // test coverage
    unread.update_unread_topics(sticky_message, {});
});

test("muting", () => {
    const stream_id = social.stream_id;
    const unknown_stream_id = 555;

    const message = {
        id: 15,
        type: "stream",
        stream_id,
        topic: "test_muting",
        unread: true,
    };

    unread.process_loaded_messages([message]);
    let counts = unread.get_counts();
    assert.equal(counts.stream_count.get(stream_id).unmuted_count, 1);
    assert.equal(counts.home_unread_messages, 1);
    assert.equal(unread.unread_count_info_for_stream(stream_id).unmuted_count, 1);
    assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), [message.id]);
    test_notifiable_count(counts.home_unread_messages, 0);

    user_topics.update_user_topics(
        social.stream_id,
        social.stream_name,
        "test_muting",
        user_topics.all_visibility_policies.MUTED,
    );
    counts = unread.get_counts();
    assert.equal(counts.stream_count.get(stream_id).unmuted_count, 0);
    assert.equal(counts.home_unread_messages, 0);
    assert.equal(unread.unread_count_info_for_stream(stream_id).unmuted_count, 0);
    assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), []);
    test_notifiable_count(counts.home_unread_messages, 0);

    // we still find the message id here (muting is ignored)
    assert.deepEqual(unread.get_all_msg_ids(), [message.id]);

    assert.deepEqual(unread.unread_count_info_for_stream(unknown_stream_id), {
        unmuted_count: 0,
        muted_count: 0,
        followed_count: 0,
        stream_is_muted: false,
    });
});

test("num_unread_for_topic", () => {
    // Test the num_unread_for_topic() function using many
    // messages.
    const stream_id = 301;
    sub_store.add_hydrated_sub(stream_id, {stream_id, name: "Some stream"});

    let count = unread.num_unread_for_topic(stream_id, "lunch");
    assert.equal(count, 0);

    const message = {
        type: "stream",
        stream_id,
        topic: "LuncH",
        unread: true,
    };

    // Put messages into list in reverse order to try to confuse
    // our sort.
    const num_msgs = 500;
    let i;
    for (i = num_msgs; i > 0; i -= 1) {
        message.id = i;
        message_store.update_message_cache(message);
        unread.process_loaded_messages([message]);
    }

    count = unread.num_unread_for_topic(stream_id, "lunch");
    assert.equal(count, num_msgs);

    let msg_ids = unread.get_msg_ids_for_topic(stream_id, "LuNcH");
    assert.deepEqual(msg_ids, _.range(1, 501));

    msg_ids = unread.get_msg_ids_for_stream(stream_id);
    assert.deepEqual(msg_ids, _.range(1, 501));

    const topic_dict = new FoldDict();

    let missing_topics = unread.get_missing_topics({
        stream_id,
        topic_dict,
    });

    assert.deepEqual(missing_topics, [{pretty_name: "LuncH", message_id: 500}]);

    topic_dict.set("lUNCh", "whatever");

    missing_topics = unread.get_missing_topics({
        stream_id,
        topic_dict,
    });

    assert.deepEqual(missing_topics, []);

    for (i = 0; i < num_msgs; i += 1) {
        message.id = i + 1;
        unread.mark_as_read(message.id);
    }

    count = unread.num_unread_for_topic(stream_id, "lunch");
    assert.equal(count, 0);

    msg_ids = unread.get_msg_ids_for_topic(stream_id, "LuNcH");
    assert.deepEqual(msg_ids, []);

    msg_ids = unread.get_msg_ids_for_stream(stream_id);
    assert.deepEqual(msg_ids, []);
});

test("home_messages", () => {
    const stream_id = 401;
    const sub = {
        stream_id,
        name: "whatever",
        subscribed: true,
        is_muted: false,
    };
    sub_store.add_hydrated_sub(stream_id, sub);

    const message = {
        id: 15,
        type: "stream",
        stream_id,
        topic: "lunch",
        unread: true,
    };

    let counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 0);
    test_notifiable_count(counts.home_unread_messages, 0);

    unread.process_loaded_messages([message]);

    counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 1);
    assert.equal(counts.stream_count.get(stream_id).unmuted_count, 1);
    test_notifiable_count(counts.home_unread_messages, 0);
    unread.mark_as_read(message.id);
    counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 0);
    test_notifiable_count(counts.home_unread_messages, 0);

    unread.process_loaded_messages([message]);
    counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 1);
    test_notifiable_count(counts.home_unread_messages, 0);

    // Now unsubscribe all our streams.
    sub.subscribed = false;
    counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 0);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("phantom_messages", () => {
    const message = {
        id: 999,
        type: "stream",
        stream_id: 555,
        topic: "phantom",
    };
    message_store.update_message_cache(message);
    unread.mark_as_read(message.id);
    const counts = unread.get_counts();
    assert.equal(counts.home_unread_messages, 0);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("private_messages", () => {
    let counts = unread.get_counts();
    assert.equal(counts.direct_message_count, 0);

    const message = {
        id: 15,
        type: "private",
        display_recipient: [{id: anybody.user_id}, {id: me.user_id}],
        unread: true,
    };

    unread.process_loaded_messages([message]);

    counts = unread.get_counts();
    assert.equal(counts.direct_message_count, 1);
    assert.equal(counts.pm_count.get("999"), 1);
    test_notifiable_count(counts.home_unread_messages, 1);
    unread.mark_as_read(message.id);
    counts = unread.get_counts();
    assert.equal(counts.direct_message_count, 0);
    assert.equal(counts.pm_count.get("999"), 0);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("private_messages", () => {
    const alice = {
        email: "alice@example.com",
        user_id: 101,
        full_name: "Alice",
    };
    people.add_active_user(alice);

    const bob = {
        email: "bob@example.com",
        user_id: 102,
        full_name: "Bob",
    };
    people.add_active_user(bob);

    assert.equal(unread.num_unread_for_user_ids_string(alice.user_id.toString()), 0);
    assert.equal(unread.num_unread_for_user_ids_string(bob.user_id.toString()), 0);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(alice.user_id.toString()), []);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(bob.user_id.toString()), []);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(), []);
    assert.deepEqual(unread.get_msg_ids_for_private(), []);

    const message = {
        id: 15,
        display_recipient: [{id: alice.user_id}],
        type: "private",
        unread: true,
        to_user_ids: alice.user_id.toString(),
    };

    const read_message = {
        flags: ["read"],
    };
    unread.process_loaded_messages([message, read_message]);
    assert.equal(unread.num_unread_for_user_ids_string(alice.user_id.toString()), 1);

    assert.equal(unread.num_unread_for_user_ids_string(""), 0);

    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(alice.user_id.toString()), [
        message.id,
    ]);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(bob.user_id.toString()), []);
    assert.deepEqual(unread.get_msg_ids_for_private(), [message.id]);
    assert.deepEqual(unread.get_all_msg_ids(), [message.id]);

    unread.mark_as_read(message.id);
    assert.equal(unread.num_unread_for_user_ids_string(alice.user_id.toString()), 0);
    assert.equal(unread.num_unread_for_user_ids_string(""), 0);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(alice.user_id.toString()), []);
    assert.deepEqual(unread.get_msg_ids_for_user_ids_string(bob.user_id.toString()), []);
    assert.deepEqual(unread.get_msg_ids_for_private(), []);
    assert.deepEqual(unread.get_all_msg_ids(), []);
    const counts = unread.get_counts();
    assert.equal(counts.direct_message_count, 0);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("mentions", () => {
    let counts = unread.get_counts();
    assert.equal(counts.mentioned_message_count, 0);
    assert.deepEqual(unread.get_msg_ids_for_mentions(), []);
    test_notifiable_count(counts.home_unread_messages, 0);

    const muted_stream_id = 900;
    const muted_stream_name = "muted stream for testing unread mentions";
    const unmuted_stream_id = 901;

    sub_store.add_hydrated_sub(muted_stream_id, {
        muted_stream_id,
        name: muted_stream_name,
        subscribed: true,
        is_muted: true,
    });
    sub_store.add_hydrated_sub(unmuted_stream_id, {
        unmuted_stream_id,
        name: "unmuted stream for testing unread mention",
        subscribed: true,
        is_muted: false,
    });

    user_topics.update_user_topics(
        muted_stream_id,
        muted_stream_name,
        "lunch",
        user_topics.all_visibility_policies.MUTED,
    );

    const already_read_message = {
        id: 14,
        type: "stream",
        stream_id: unmuted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: true,
        unread: false,
    };

    const mention_me_message = {
        id: 15,
        type: "stream",
        stream_id: unmuted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: true,
        unread: true,
    };

    const mention_all_message = {
        id: 16,
        type: "stream",
        stream_id: unmuted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: false,
        unread: true,
    };

    // This message shouldn't affect the unread mention counts.
    const muted_mention_all_message = {
        id: 17,
        type: "stream",
        stream_id: muted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: false,
        unread: true,
    };

    const muted_direct_mention_message = {
        id: 18,
        type: "stream",
        stream_id: muted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: true,
        unread: true,
    };

    const private_mention_me_message = {
        id: 19,
        type: "private",
        display_recipient: [{id: anybody.user_id}],
        mentioned: true,
        mentioned_me_directly: true,
        unread: true,
    };

    unread.process_loaded_messages([
        already_read_message,
        mention_me_message,
        mention_all_message,
        muted_mention_all_message,
        muted_direct_mention_message,
        private_mention_me_message,
    ]);

    counts = unread.get_counts();
    assert.equal(counts.mentioned_message_count, 4);
    assert.deepEqual(unread.get_msg_ids_for_mentions(), [
        mention_me_message.id,
        mention_all_message.id,
        muted_direct_mention_message.id,
        private_mention_me_message.id,
    ]);
    assert.deepEqual(unread.get_all_msg_ids(), [
        mention_me_message.id,
        mention_all_message.id,
        muted_mention_all_message.id,
        muted_direct_mention_message.id,
        private_mention_me_message.id,
    ]);
    test_notifiable_count(counts.home_unread_messages, 4);

    unread.mark_as_read(mention_me_message.id);
    unread.mark_as_read(mention_all_message.id);
    unread.mark_as_read(muted_direct_mention_message.id);
    unread.mark_as_read(private_mention_me_message.id);
    counts = unread.get_counts();
    assert.equal(counts.mentioned_message_count, 0);
    test_notifiable_count(counts.home_unread_messages, 0);

    // redundantly read a message to make sure nothing explodes
    unread.mark_as_read(muted_direct_mention_message.id);
    counts = unread.get_counts();
    assert.equal(counts.mentioned_message_count, 0);
});

test("mention updates", () => {
    // Unread message in an unmuted stream.
    const message = {
        id: 17,
        stream_id: 901,
        unread: false,
        type: "stream",
        topic: "hello",
    };

    function test_counted(counted) {
        unread.update_message_for_mention(message);
        assert.equal(unread.unread_mentions_counter.has(message.id), counted);
    }

    test_counted(false);

    message.unread = true;
    message.mentioned = true;
    test_counted(true);

    message.mentioned = false;
    test_counted(false);

    message.mentioned = true;
    test_counted(true);

    message.unread = false;
    test_counted(false);

    message.unread = true;
    test_counted(true);
});

test("stream_has_any_unread_mentions", () => {
    const muted_stream_id = 401;
    user_topics.update_user_topics(
        401,
        "random_stream_name",
        "lunch",
        user_topics.all_visibility_policies.MUTED,
    );

    const mention_me_message = {
        id: 15,
        type: "stream",
        stream_id: 400,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: true,
        unread: true,
    };

    const mention_all_message = {
        id: 16,
        type: "stream",
        stream_id: 400,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: false,
        unread: true,
    };

    // This message's stream_id should not be present in `streams_with_mentions`.
    const muted_mention_all_message = {
        id: 17,
        type: "stream",
        stream_id: muted_stream_id,
        topic: "lunch",
        mentioned: true,
        mentioned_me_directly: false,
        unread: true,
    };

    unread.process_loaded_messages([
        mention_me_message,
        mention_all_message,
        muted_mention_all_message,
    ]);

    assert.equal(unread.stream_has_any_unread_mentions(400), true);
    assert.equal(unread.stream_has_any_unread_mentions(muted_stream_id), false);
});

test("topics with unread mentions", () => {
    const message_with_mention = {
        id: 98,
        type: "stream",
        stream_id: 999,
        topic: "topic with mention",
        mentioned: true,
        mentioned_me_directly: true,
        unread: true,
    };

    const message_without_mention = {
        id: 99,
        type: "stream",
        stream_id: 999,
        topic: "topic without mention",
        mentioned: false,
        mentioned_me_directly: false,
        unread: true,
    };

    unread.process_loaded_messages([message_with_mention, message_without_mention]);
    assert.equal(unread.get_topics_with_unread_mentions(999).size, 1);
    assert.deepEqual(unread.get_topics_with_unread_mentions(999), new Set(["topic with mention"]));
    unread.mark_as_read(message_with_mention.id);
    assert.equal(unread.get_topics_with_unread_mentions(999).size, 0);
    assert.deepEqual(unread.get_topics_with_unread_mentions(999), new Set([]));
});

test("starring", () => {
    // We don't need any setup here, because we just hard code
    // this to [] in the code.
    assert.deepEqual(unread.get_msg_ids_for_starred(), []);
});

test("declare_bankruptcy", () => {
    const message = {
        id: 16,
        type: "whatever",
        stream_id: 1999,
        topic: "whatever",
        mentioned: true,
    };

    unread.process_loaded_messages([message]);

    unread.declare_bankruptcy();

    const counts = unread.get_counts();
    assert_zero_counts(counts);
    test_notifiable_count(counts.home_unread_messages, 0);
});

test("server_counts", () => {
    // note that user_id 30 is "me"

    const unread_params = {
        unread_msgs: {
            pms: [
                {
                    other_user_id: 101,
                    // sender_id is deprecated.
                    sender_id: 101,
                    unread_message_ids: [31, 32, 60, 61, 62, 63],
                },
            ],
            huddles: [
                {
                    user_ids_string: "4,6,30,101",
                    unread_message_ids: [34, 50],
                },
            ],
            streams: [
                {
                    stream_id: 1,
                    topic: "test",
                    unread_message_ids: [33, 35, 36],
                },
            ],
            mentions: [31, 34, 40, 41],
        },
    };

    unread.initialize(unread_params);

    assert.equal(unread.num_unread_for_user_ids_string("101"), 6);
    assert.equal(unread.num_unread_for_user_ids_string("4,6,101"), 2);
    assert.equal(unread.num_unread_for_user_ids_string("30"), 0);

    assert.equal(unread.num_unread_for_topic(0, "bogus"), 0);
    assert.equal(unread.num_unread_for_topic(1, "bogus"), 0);
    assert.equal(unread.num_unread_for_topic(1, "test"), 3);

    assert.equal(unread.unread_mentions_counter.size, 4);

    unread.mark_as_read(40);
    assert.equal(unread.unread_mentions_counter.size, 3);

    unread.mark_as_read(35);
    assert.equal(unread.num_unread_for_topic(1, "test"), 2);

    unread.mark_as_read(34);
    assert.equal(unread.num_unread_for_user_ids_string("4,6,101"), 1);
});

test("empty_cases", () => {
    const stream_id = 999;
    let msg_ids = unread.get_msg_ids_for_topic(stream_id, "LuNcH");
    assert.deepEqual(msg_ids, []);

    msg_ids = unread.get_msg_ids_for_stream(stream_id);
    assert.deepEqual(msg_ids, []);
    assert.deepEqual(unread.get_all_msg_ids(), []);

    const missing_topics = unread.get_missing_topics({
        stream_id,
        topic_dict: "should-never-be-referenced",
    });
    assert.deepEqual(missing_topics, []);
});

test("errors", () => {
    // Test unknown message leads to zero count
    const message = {
        id: 9,
        type: "private",
        display_recipient: [{id: 9999}],
    };

    unread.mark_as_read(message.id);
    const counts = unread.get_counts();
    assert.equal(counts.direct_message_count, 0);
    test_notifiable_count(counts.home_unread_messages, 0);
});