mirror of
https://github.com/zulip/zulip.git
synced 2025-11-08 16:01:58 +00:00
3e9b4a2090
This commit makes it so that muted users never appear in the right sidebar buddy list, filter text or not. The hiding is done in the frontend only, and we still recieve presence data from the server as before, so no extra work is required on unmuting someone, other than to rerender the user list. Long term if we find that there are too many muted users, we may want to optimize how we send presence data, but that is unlikely to happen. The other less extreme option is to gray out muted users, but that cannot be done because it would conflict with the graying out we do for non-recipients when the compose box is open.
516 lines
15 KiB
JavaScript
516 lines
15 KiB
JavaScript
"use strict";
|
|
|
|
const {strict: assert} = require("assert");
|
|
|
|
const _ = require("lodash");
|
|
|
|
const {mock_esm, with_field, zrequire} = require("../zjsunit/namespace");
|
|
const {run_test} = require("../zjsunit/test");
|
|
const blueslip = require("../zjsunit/zblueslip");
|
|
const {page_params} = require("../zjsunit/zpage_params");
|
|
|
|
const timerender = mock_esm("../../static/js/timerender");
|
|
|
|
const compose_fade_helper = zrequire("compose_fade_helper");
|
|
const muting = zrequire("muting");
|
|
const peer_data = zrequire("peer_data");
|
|
const people = zrequire("people");
|
|
const presence = zrequire("presence");
|
|
const stream_data = zrequire("stream_data");
|
|
const sub_store = zrequire("sub_store");
|
|
const user_status = zrequire("user_status");
|
|
const buddy_data = zrequire("buddy_data");
|
|
|
|
// The buddy_data module is mostly tested indirectly through
|
|
// activity.js, but we should feel free to add direct tests
|
|
// here.
|
|
|
|
const selma = {
|
|
user_id: 1000,
|
|
full_name: "Human Selma",
|
|
email: "selma@example.com",
|
|
};
|
|
|
|
const me = {
|
|
user_id: 1001,
|
|
full_name: "Human Myself",
|
|
email: "self@example.com",
|
|
};
|
|
|
|
const alice = {
|
|
email: "alice@zulip.com",
|
|
user_id: 1002,
|
|
full_name: "Alice Smith",
|
|
};
|
|
|
|
const fred = {
|
|
email: "fred@zulip.com",
|
|
user_id: 1003,
|
|
full_name: "Fred Flintstone",
|
|
};
|
|
|
|
const jill = {
|
|
email: "jill@zulip.com",
|
|
user_id: 1004,
|
|
full_name: "Jill Hill",
|
|
};
|
|
|
|
const mark = {
|
|
email: "mark@zulip.com",
|
|
user_id: 1005,
|
|
full_name: "Marky Mark",
|
|
};
|
|
|
|
const old_user = {
|
|
user_id: 9999,
|
|
full_name: "Old User",
|
|
email: "old_user@example.com",
|
|
};
|
|
|
|
const bot = {
|
|
user_id: 55555,
|
|
full_name: "Red Herring Bot",
|
|
email: "bot@example.com",
|
|
is_bot: true,
|
|
bot_owner_id: null,
|
|
};
|
|
|
|
const bot_with_owner = {
|
|
user_id: 55556,
|
|
full_name: "Blue Herring Bot",
|
|
email: "bot_with_owner@example.com",
|
|
is_bot: true,
|
|
bot_owner_id: 1001,
|
|
bot_owner_full_name: "Human Myself",
|
|
};
|
|
|
|
function add_canned_users() {
|
|
people.add_active_user(alice);
|
|
people.add_active_user(bot);
|
|
people.add_active_user(bot_with_owner);
|
|
people.add_active_user(fred);
|
|
people.add_active_user(jill);
|
|
people.add_active_user(mark);
|
|
people.add_active_user(old_user);
|
|
people.add_active_user(selma);
|
|
}
|
|
|
|
function test(label, f) {
|
|
run_test(label, (override) => {
|
|
compose_fade_helper.clear_focused_recipient();
|
|
stream_data.clear_subscriptions();
|
|
peer_data.clear_for_testing();
|
|
user_status.initialize({user_status: {}});
|
|
presence.presence_info.clear();
|
|
people.init();
|
|
people.add_active_user(me);
|
|
people.initialize_current_user(me.user_id);
|
|
muting.set_muted_users([]);
|
|
f(override);
|
|
});
|
|
}
|
|
|
|
test("huddle_fraction_present", () => {
|
|
people.add_active_user(alice);
|
|
people.add_active_user(fred);
|
|
people.add_active_user(jill);
|
|
people.add_active_user(mark);
|
|
|
|
let huddle = "alice@zulip.com,fred@zulip.com,jill@zulip.com,mark@zulip.com";
|
|
huddle = people.emails_strings_to_user_ids_string(huddle);
|
|
|
|
let presence_info = new Map();
|
|
presence_info.set(alice.user_id, {status: "active"}); // counts as present
|
|
presence_info.set(fred.user_id, {status: "idle"}); // does not count as present
|
|
// jill not in list
|
|
presence_info.set(mark.user_id, {status: "offline"}); // does not count
|
|
presence.__Rewire__("presence_info", presence_info);
|
|
|
|
assert.equal(buddy_data.huddle_fraction_present(huddle), 0.5);
|
|
|
|
presence_info = new Map();
|
|
for (const user of [alice, fred, jill, mark]) {
|
|
presence_info.set(user.user_id, {status: "active"}); // counts as present
|
|
}
|
|
presence.__Rewire__("presence_info", presence_info);
|
|
|
|
assert.equal(buddy_data.huddle_fraction_present(huddle), 1);
|
|
|
|
huddle = "alice@zulip.com,fred@zulip.com,jill@zulip.com,mark@zulip.com";
|
|
huddle = people.emails_strings_to_user_ids_string(huddle);
|
|
presence_info = new Map();
|
|
presence_info.set(alice.user_id, {status: "idle"});
|
|
presence_info.set(fred.user_id, {status: "idle"}); // does not count as present
|
|
// jill not in list
|
|
presence_info.set(mark.user_id, {status: "offline"}); // does not count
|
|
presence.__Rewire__("presence_info", presence_info);
|
|
|
|
assert.equal(buddy_data.huddle_fraction_present(huddle), undefined);
|
|
});
|
|
|
|
function set_presence(user_id, status) {
|
|
presence.presence_info.set(user_id, {
|
|
status,
|
|
last_active: 9999,
|
|
});
|
|
}
|
|
|
|
test("user_circle", () => {
|
|
add_canned_users();
|
|
|
|
set_presence(selma.user_id, "active");
|
|
set_presence(me.user_id, "active");
|
|
|
|
assert.equal(buddy_data.get_user_circle_class(selma.user_id), "user_circle_green");
|
|
user_status.set_away(selma.user_id);
|
|
assert.equal(buddy_data.get_user_circle_class(selma.user_id), "user_circle_empty_line");
|
|
user_status.revoke_away(selma.user_id);
|
|
assert.equal(buddy_data.get_user_circle_class(selma.user_id), "user_circle_green");
|
|
|
|
assert.equal(buddy_data.get_user_circle_class(me.user_id), "user_circle_green");
|
|
user_status.set_away(me.user_id);
|
|
assert.equal(buddy_data.get_user_circle_class(me.user_id), "user_circle_empty_line");
|
|
user_status.revoke_away(me.user_id);
|
|
assert.equal(buddy_data.get_user_circle_class(me.user_id), "user_circle_green");
|
|
});
|
|
|
|
test("compose fade interactions (streams)", () => {
|
|
const sub = {
|
|
stream_id: 101,
|
|
name: "Devel",
|
|
subscribed: true,
|
|
};
|
|
stream_data.add_sub(sub);
|
|
stream_data.subscribe_myself(sub);
|
|
|
|
people.add_active_user(fred);
|
|
|
|
set_presence(fred.user_id, "active");
|
|
|
|
function faded() {
|
|
return buddy_data.get_item(fred.user_id).faded;
|
|
}
|
|
|
|
// If we are not narrowed, then we don't fade fred in the buddy list.
|
|
assert.equal(faded(), false);
|
|
|
|
// If we narrow to a stream that fred has not subscribed
|
|
// to, we will fade him.
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "stream",
|
|
stream_id: sub.stream_id,
|
|
topic: "whatever",
|
|
});
|
|
assert.equal(faded(), true);
|
|
|
|
// If we subscribe, we don't fade.
|
|
peer_data.add_subscriber(sub.stream_id, fred.user_id);
|
|
assert.equal(faded(), false);
|
|
|
|
// Test our punting logic.
|
|
const bogus_stream_id = 99999;
|
|
assert.equal(sub_store.get(bogus_stream_id), undefined);
|
|
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "stream",
|
|
stream_id: bogus_stream_id,
|
|
});
|
|
|
|
assert.equal(faded(), false);
|
|
});
|
|
|
|
test("compose fade interactions (missing topic)", () => {
|
|
const sub = {
|
|
stream_id: 102,
|
|
name: "Social",
|
|
subscribed: true,
|
|
};
|
|
stream_data.add_sub(sub);
|
|
stream_data.subscribe_myself(sub);
|
|
|
|
people.add_active_user(fred);
|
|
|
|
set_presence(fred.user_id, "active");
|
|
|
|
function faded() {
|
|
return buddy_data.get_item(fred.user_id).faded;
|
|
}
|
|
|
|
// If we are not narrowed, then we don't fade fred in the buddy list.
|
|
assert.equal(faded(), false);
|
|
|
|
// If we narrow to a stream that fred has not subscribed
|
|
// to, we will fade him.
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "stream",
|
|
stream_id: sub.stream_id,
|
|
topic: "whatever",
|
|
});
|
|
assert.equal(faded(), true);
|
|
|
|
// If the user clears the topic, we won't fade fred.
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "stream",
|
|
stream_id: sub.stream_id,
|
|
topic: "",
|
|
});
|
|
assert.equal(faded(), false);
|
|
});
|
|
|
|
test("compose fade interactions (PMs)", () => {
|
|
people.add_active_user(fred);
|
|
|
|
set_presence(fred.user_id, "active");
|
|
|
|
function faded() {
|
|
return buddy_data.get_item(fred.user_id).faded;
|
|
}
|
|
|
|
// Dont fade if we're not in a narrow.
|
|
assert.equal(faded(), false);
|
|
|
|
// Fade fred if we are narrowed to a PM narrow that does
|
|
// not include him.
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "private",
|
|
to_user_ids: "9999999",
|
|
});
|
|
assert.equal(faded(), true);
|
|
|
|
// Now include fred in a narrow with jill, and we will
|
|
// stop fading him.
|
|
compose_fade_helper.set_focused_recipient({
|
|
type: "private",
|
|
to_user_ids: [fred.user_id, jill.user_id].join(","),
|
|
});
|
|
|
|
assert.equal(faded(), false);
|
|
});
|
|
|
|
test("buddy_status", () => {
|
|
set_presence(selma.user_id, "active");
|
|
set_presence(me.user_id, "active");
|
|
|
|
assert.equal(buddy_data.buddy_status(selma.user_id), "active");
|
|
user_status.set_away(selma.user_id);
|
|
assert.equal(buddy_data.buddy_status(selma.user_id), "away_them");
|
|
user_status.revoke_away(selma.user_id);
|
|
assert.equal(buddy_data.buddy_status(selma.user_id), "active");
|
|
|
|
assert.equal(buddy_data.buddy_status(me.user_id), "active");
|
|
user_status.set_away(me.user_id);
|
|
assert.equal(buddy_data.buddy_status(me.user_id), "away_me");
|
|
user_status.revoke_away(me.user_id);
|
|
assert.equal(buddy_data.buddy_status(me.user_id), "active");
|
|
});
|
|
|
|
test("title_data", () => {
|
|
add_canned_users();
|
|
|
|
// Groups
|
|
let is_group = true;
|
|
const user_ids_string = "9999,1000";
|
|
let expected_group_data = {
|
|
first_line: "Human Selma, Old User",
|
|
second_line: "",
|
|
third_line: "",
|
|
};
|
|
assert.deepEqual(buddy_data.get_title_data(user_ids_string, is_group), expected_group_data);
|
|
|
|
is_group = "";
|
|
|
|
// Bots with owners.
|
|
expected_group_data = {
|
|
first_line: "Blue Herring Bot",
|
|
second_line: "translated: Owner: Human Myself",
|
|
third_line: "",
|
|
};
|
|
assert.deepEqual(
|
|
buddy_data.get_title_data(bot_with_owner.user_id, is_group),
|
|
expected_group_data,
|
|
);
|
|
|
|
// Bots without owners.
|
|
expected_group_data = {
|
|
first_line: "Red Herring Bot",
|
|
second_line: "",
|
|
third_line: "",
|
|
};
|
|
assert.deepEqual(buddy_data.get_title_data(bot.user_id, is_group), expected_group_data);
|
|
|
|
// Individual users.
|
|
user_status.set_status_text({
|
|
user_id: me.user_id,
|
|
status_text: "out to lunch",
|
|
});
|
|
|
|
let expected_data = {
|
|
first_line: "Human Myself",
|
|
second_line: "out to lunch",
|
|
third_line: "translated: Active now",
|
|
show_you: true,
|
|
};
|
|
page_params.user_id = me.user_id;
|
|
assert.deepEqual(buddy_data.get_title_data(me.user_id, is_group), expected_data);
|
|
|
|
expected_data = {
|
|
first_line: "Old User",
|
|
second_line: "translated: Last active: translated: More than 2 weeks ago",
|
|
third_line: "",
|
|
show_you: false,
|
|
};
|
|
assert.deepEqual(buddy_data.get_title_data(old_user.user_id, is_group), expected_data);
|
|
});
|
|
|
|
test("simple search", () => {
|
|
add_canned_users();
|
|
|
|
set_presence(selma.user_id, "active");
|
|
set_presence(me.user_id, "active");
|
|
|
|
const user_ids = buddy_data.get_filtered_and_sorted_user_ids("sel");
|
|
|
|
assert.deepEqual(user_ids, [selma.user_id]);
|
|
});
|
|
|
|
test("muted users excluded from search", () => {
|
|
muting.add_muted_user(selma.user_id);
|
|
|
|
let user_ids = buddy_data.get_filtered_and_sorted_user_ids();
|
|
assert.equal(user_ids.includes(selma.user_id), false);
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("sel");
|
|
assert.deepEqual(user_ids, []);
|
|
|
|
muting.remove_muted_user(selma.user_id);
|
|
});
|
|
|
|
test("bulk_data_hacks", () => {
|
|
// sanity check
|
|
assert.equal(mark.user_id, 1005);
|
|
|
|
for (const i of _.range(mark.user_id + 1, 2000)) {
|
|
const person = {
|
|
user_id: i,
|
|
full_name: `Human ${i}`,
|
|
email: `person${i}@example.com`,
|
|
};
|
|
people.add_active_user(person);
|
|
}
|
|
add_canned_users();
|
|
|
|
// Make 400 of the users active
|
|
set_presence(selma.user_id, "active");
|
|
set_presence(me.user_id, "active");
|
|
|
|
for (const user_id of _.range(1000, 1400)) {
|
|
set_presence(user_id, "active");
|
|
}
|
|
|
|
// And then 300 not active
|
|
for (const user_id of _.range(1400, 1700)) {
|
|
set_presence(user_id, "offline");
|
|
}
|
|
|
|
let user_ids;
|
|
|
|
// Even though we have 1000 users, we only get the 400 active
|
|
// users. This is a consequence of buddy_data.maybe_shrink_list.
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids();
|
|
assert.equal(user_ids.length, 400);
|
|
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("");
|
|
assert.equal(user_ids.length, 400);
|
|
|
|
// We don't match on "so", because it's not at the start of a
|
|
// word in the name/email.
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("so");
|
|
assert.equal(user_ids.length, 0);
|
|
|
|
// We match on "h" for the first name, and the result limit
|
|
// is relaxed for searches. (We exclude "me", though.)
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("h");
|
|
assert.equal(user_ids.length, 996);
|
|
|
|
// We match on "p" for the email.
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("p");
|
|
assert.equal(user_ids.length, 994);
|
|
|
|
// Make our shrink limit higher, and go back to an empty search.
|
|
// We won't get all 1000 users, just the present ones.
|
|
with_field(buddy_data, "max_size_before_shrinking", 50000, () => {
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids("");
|
|
});
|
|
assert.equal(user_ids.length, 700);
|
|
});
|
|
|
|
test("user_status", () => {
|
|
user_status.initialize({user_status: []});
|
|
set_presence(me.user_id, "active");
|
|
assert.equal(buddy_data.get_my_user_status(me.user_id), "translated: (you)");
|
|
user_status.set_away(me.user_id);
|
|
assert.equal(buddy_data.get_my_user_status(me.user_id), "translated: (unavailable)");
|
|
user_status.revoke_away(me.user_id);
|
|
assert.equal(buddy_data.get_my_user_status(me.user_id), "translated: (you)");
|
|
});
|
|
|
|
test("level", () => {
|
|
add_canned_users();
|
|
assert.equal(buddy_data.level(me.user_id), 0);
|
|
assert.equal(buddy_data.level(selma.user_id), 3);
|
|
|
|
const server_time = 9999;
|
|
const info = {
|
|
website: {
|
|
status: "active",
|
|
timestamp: server_time,
|
|
},
|
|
};
|
|
presence.update_info_from_event(me.user_id, info, server_time);
|
|
presence.update_info_from_event(selma.user_id, info, server_time);
|
|
|
|
assert.equal(buddy_data.level(me.user_id), 0);
|
|
assert.equal(buddy_data.level(selma.user_id), 1);
|
|
|
|
user_status.set_away(me.user_id);
|
|
user_status.set_away(selma.user_id);
|
|
|
|
// Selma gets demoted to level 3, but "me"
|
|
// stays in level 0.
|
|
assert.equal(buddy_data.level(me.user_id), 0);
|
|
assert.equal(buddy_data.level(selma.user_id), 3);
|
|
});
|
|
|
|
test("user_last_seen_time_status", (override) => {
|
|
set_presence(selma.user_id, "active");
|
|
set_presence(me.user_id, "active");
|
|
|
|
assert.equal(buddy_data.user_last_seen_time_status(selma.user_id), "translated: Active now");
|
|
|
|
page_params.realm_is_zephyr_mirror_realm = true;
|
|
assert.equal(buddy_data.user_last_seen_time_status(old_user.user_id), "translated: Unknown");
|
|
page_params.realm_is_zephyr_mirror_realm = false;
|
|
assert.equal(
|
|
buddy_data.user_last_seen_time_status(old_user.user_id),
|
|
"translated: More than 2 weeks ago",
|
|
);
|
|
|
|
override(presence, "last_active_date", (user_id) => {
|
|
assert.equal(user_id, old_user.user_id);
|
|
return new Date(1526137743000);
|
|
});
|
|
|
|
override(timerender, "last_seen_status_from_date", (date) => {
|
|
assert.deepEqual(date, new Date(1526137743000));
|
|
return "May 12";
|
|
});
|
|
|
|
assert.equal(buddy_data.user_last_seen_time_status(old_user.user_id), "May 12");
|
|
});
|
|
|
|
test("error handling", (override) => {
|
|
override(presence, "get_user_ids", () => [42]);
|
|
blueslip.expect("error", "Unknown user_id in get_by_user_id: 42");
|
|
blueslip.expect("warn", "Got user_id in presence but not people: 42");
|
|
buddy_data.get_filtered_and_sorted_user_ids();
|
|
});
|