mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
20886b80d9
For sorting topics in the left sidebar topics list, the "Followed" topics are treated the same as "Unmuted" topics. In a muted stream and not zoomed state: * followed/unmuted topics at the top. In an unmuted stream or zoomed state in a muted stream: * normal recency sorting The reason is that the "Followed" topics have a tier of interest above being unmuted, so they shouldn't lie below the "Unmuted" topics in the list.
381 lines
11 KiB
JavaScript
381 lines
11 KiB
JavaScript
"use strict";
|
|
|
|
const {strict: assert} = require("assert");
|
|
|
|
const _ = require("lodash");
|
|
|
|
const {mock_esm, zrequire} = require("./lib/namespace");
|
|
const {run_test} = require("./lib/test");
|
|
|
|
mock_esm("../src/message_store", {
|
|
get() {
|
|
return {
|
|
stream_id: 556,
|
|
topic: "general",
|
|
};
|
|
},
|
|
});
|
|
const user_topics = mock_esm("../src/user_topics", {
|
|
is_topic_muted() {
|
|
return false;
|
|
},
|
|
is_topic_followed() {
|
|
return false;
|
|
},
|
|
is_topic_unmuted_or_followed() {
|
|
return false;
|
|
},
|
|
});
|
|
const narrow_state = mock_esm("../src/narrow_state", {
|
|
topic() {},
|
|
});
|
|
|
|
const stream_data = zrequire("stream_data");
|
|
const stream_topic_history = zrequire("stream_topic_history");
|
|
const topic_list_data = zrequire("topic_list_data");
|
|
const unread = zrequire("unread");
|
|
|
|
const general = {
|
|
stream_id: 556,
|
|
name: "general",
|
|
};
|
|
|
|
stream_data.add_sub(general);
|
|
|
|
function get_list_info(zoom, search) {
|
|
const stream_id = general.stream_id;
|
|
const zoomed = zoom === undefined ? false : zoom;
|
|
const search_term = search === undefined ? "" : search;
|
|
return topic_list_data.get_list_info(stream_id, zoomed, search_term);
|
|
}
|
|
|
|
function test(label, f) {
|
|
run_test(label, (helpers) => {
|
|
stream_topic_history.reset();
|
|
f(helpers);
|
|
});
|
|
}
|
|
|
|
test("get_list_info w/real stream_topic_history", ({override}) => {
|
|
let list_info;
|
|
const empty_list_info = get_list_info();
|
|
|
|
assert.deepEqual(empty_list_info, {
|
|
items: [],
|
|
more_topics_have_unread_mention_messages: false,
|
|
more_topics_unreads: 0,
|
|
more_topics_unread_count_muted: false,
|
|
num_possible_topics: 0,
|
|
});
|
|
|
|
function add_topic_message(topic_name, message_id) {
|
|
stream_topic_history.add_message({
|
|
stream_id: general.stream_id,
|
|
topic_name,
|
|
message_id,
|
|
});
|
|
}
|
|
for (const i of _.range(10)) {
|
|
let topic_name;
|
|
// All odd topics are resolved.
|
|
if (i % 2) {
|
|
topic_name = "✔ topic ";
|
|
} else {
|
|
topic_name = "topic ";
|
|
}
|
|
add_topic_message(topic_name + i, 1000 + i);
|
|
}
|
|
|
|
override(narrow_state, "topic", () => "topic 6");
|
|
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 8);
|
|
assert.equal(list_info.more_topics_unreads, 0);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, false);
|
|
assert.equal(list_info.num_possible_topics, 10);
|
|
|
|
assert.deepEqual(list_info.items[0], {
|
|
contains_unread_mention: false,
|
|
is_active_topic: false,
|
|
is_muted: false,
|
|
is_followed: false,
|
|
is_unmuted_or_followed: false,
|
|
is_zero: true,
|
|
topic_display_name: "topic 9",
|
|
topic_name: "✔ topic 9",
|
|
topic_resolved_prefix: "✔ ",
|
|
unread: 0,
|
|
url: "#narrow/stream/556-general/topic/.E2.9C.94.20topic.209",
|
|
});
|
|
|
|
assert.deepEqual(list_info.items[1], {
|
|
contains_unread_mention: false,
|
|
is_active_topic: false,
|
|
is_muted: false,
|
|
is_followed: false,
|
|
is_unmuted_or_followed: false,
|
|
is_zero: true,
|
|
topic_display_name: "topic 8",
|
|
topic_name: "topic 8",
|
|
topic_resolved_prefix: "",
|
|
unread: 0,
|
|
url: "#narrow/stream/556-general/topic/topic.208",
|
|
});
|
|
|
|
// If we zoom in, our results are based on topic filter.
|
|
// If topic search input is empty, we show all 10 topics.
|
|
const zoomed = true;
|
|
list_info = get_list_info(zoomed);
|
|
assert.equal(list_info.items.length, 10);
|
|
assert.equal(list_info.more_topics_unreads, 0);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, false);
|
|
assert.equal(list_info.num_possible_topics, 10);
|
|
|
|
add_topic_message("After Brooklyn", 1008);
|
|
add_topic_message("Catering", 1009);
|
|
|
|
// When topic search input is not empty, we show topics
|
|
// based on the search term.
|
|
const search_term = "b,c";
|
|
list_info = get_list_info(zoomed, search_term);
|
|
assert.equal(list_info.items.length, 2);
|
|
assert.equal(list_info.more_topics_unreads, 0);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, false);
|
|
assert.equal(list_info.num_possible_topics, 2);
|
|
});
|
|
|
|
test("get_list_info unreads", ({override}) => {
|
|
let list_info;
|
|
|
|
let message_id = 0;
|
|
for (let i = 15; i >= 0; i -= 1) {
|
|
stream_topic_history.add_message({
|
|
stream_id: general.stream_id,
|
|
message_id: (message_id += 1),
|
|
topic_name: `topic ${i}`,
|
|
});
|
|
}
|
|
|
|
function add_unreads(topic, count) {
|
|
unread.process_loaded_messages(
|
|
Array.from({length: count}, () => ({
|
|
id: (message_id += 1),
|
|
stream_id: general.stream_id,
|
|
topic,
|
|
type: "stream",
|
|
unread: true,
|
|
})),
|
|
);
|
|
}
|
|
|
|
function add_unreads_with_mention(topic, count) {
|
|
unread.process_loaded_messages(
|
|
Array.from({length: count}, () => ({
|
|
id: (message_id += 1),
|
|
stream_id: general.stream_id,
|
|
topic,
|
|
type: "stream",
|
|
unread: true,
|
|
mentioned: true,
|
|
mentioned_me_directly: true,
|
|
})),
|
|
);
|
|
}
|
|
|
|
/*
|
|
We have 16 topics, but we only show up
|
|
to 12 topics, depending on how many have
|
|
unread counts. We only show a max of 8
|
|
fully-read topics.
|
|
|
|
So first we'll get 10 topics, where 2 are
|
|
unread.
|
|
*/
|
|
add_unreads("topic 14", 1);
|
|
add_unreads("topic 13", 1);
|
|
|
|
/*
|
|
We added 1 unread message in 'topic 14',
|
|
but now we would add a unread message
|
|
with `mention` for user, to test
|
|
`more_topics_have_unread_mention_messages`.
|
|
*/
|
|
add_unreads_with_mention("topic 14", 1);
|
|
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 10);
|
|
assert.equal(list_info.more_topics_unreads, 0);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, false);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 4",
|
|
"topic 5",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 13",
|
|
"topic 14",
|
|
],
|
|
);
|
|
|
|
add_unreads("topic 12", 1);
|
|
add_unreads("topic 11", 1);
|
|
add_unreads("topic 10", 1);
|
|
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 12);
|
|
assert.equal(list_info.more_topics_unreads, 2);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, true);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 4",
|
|
"topic 5",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 10",
|
|
"topic 11",
|
|
"topic 12",
|
|
"topic 13",
|
|
],
|
|
);
|
|
|
|
add_unreads("topic 9", 1);
|
|
add_unreads("topic 8", 1);
|
|
|
|
add_unreads("topic 4", 1);
|
|
override(user_topics, "is_topic_muted", (stream_id, topic_name) => {
|
|
assert.equal(stream_id, general.stream_id);
|
|
return topic_name === "topic 4";
|
|
});
|
|
|
|
// muting the stream and unmuting the topic 5
|
|
// this should make topic 5 at top in items array
|
|
general.is_muted = true;
|
|
add_unreads("topic 5", 1);
|
|
override(user_topics, "is_topic_unmuted_or_followed", (stream_id, topic_name) => {
|
|
assert.equal(stream_id, general.stream_id);
|
|
return topic_name === "topic 5";
|
|
});
|
|
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 12);
|
|
assert.equal(list_info.more_topics_unreads, 3);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, true);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
assert.equal(list_info.more_topics_unread_count_muted, false);
|
|
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 5",
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 8",
|
|
"topic 9",
|
|
"topic 10",
|
|
"topic 11",
|
|
"topic 12",
|
|
],
|
|
);
|
|
|
|
// Now test with topics 4/8/9, all the ones with unreads, being muted.
|
|
override(user_topics, "is_topic_muted", (stream_id, topic_name) => {
|
|
assert.equal(stream_id, general.stream_id);
|
|
return ["topic 4", "topic 8", "topic 9"].includes(topic_name);
|
|
});
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 12);
|
|
assert.equal(list_info.more_topics_unreads, 3);
|
|
// Topic 14 now makes it above the "more topics" fold.
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, false);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
assert.equal(list_info.more_topics_unread_count_muted, true);
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 5",
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 10",
|
|
"topic 11",
|
|
"topic 12",
|
|
"topic 13",
|
|
"topic 14",
|
|
],
|
|
);
|
|
|
|
add_unreads_with_mention("topic 8", 1);
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 12);
|
|
assert.equal(list_info.more_topics_unreads, 4);
|
|
// Topic 8's new mention gets counted here.
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, true);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
assert.equal(list_info.more_topics_unread_count_muted, true);
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 5",
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 10",
|
|
"topic 11",
|
|
"topic 12",
|
|
"topic 13",
|
|
"topic 14",
|
|
],
|
|
);
|
|
|
|
// Adding an additional older unmuted topic with unreads should
|
|
// result in just the unmuted unreads being counted.
|
|
add_unreads("topic 15", 15);
|
|
list_info = get_list_info();
|
|
assert.equal(list_info.items.length, 12);
|
|
assert.equal(list_info.more_topics_unreads, 15);
|
|
assert.equal(list_info.more_topics_have_unread_mention_messages, true);
|
|
assert.equal(list_info.num_possible_topics, 16);
|
|
assert.equal(list_info.more_topics_unread_count_muted, false);
|
|
assert.deepEqual(
|
|
list_info.items.map((li) => li.topic_name),
|
|
[
|
|
"topic 5",
|
|
"topic 0",
|
|
"topic 1",
|
|
"topic 2",
|
|
"topic 3",
|
|
"topic 6",
|
|
"topic 7",
|
|
"topic 10",
|
|
"topic 11",
|
|
"topic 12",
|
|
"topic 13",
|
|
"topic 14",
|
|
],
|
|
);
|
|
});
|