mirror of
https://github.com/zulip/zulip.git
synced 2025-11-11 09:27:43 +00:00
14396c3e32
In the next commit we're going to change what the
server sends for the following:
- page_params
- server responses to /json/users/me/presence
We will **not** yet be changing the format of the data
that we get in events when users update their presence.
It's also just a bit in flux what our final formats
will be for various presence payloads, and different
optimizations may lead us to use different data
structures in different payloads.
So for now we decouple these two things:
raw_info: this is intended to represent a
snapshot of the latest data from the
server, including some data like
timestamps that are only used
in downstream calculations and not
user-facing
exports.presence_info: this is calculated
info for modules like buddy_data that
just need to know active vs. idle and
last_active_date
Another change that happens here is we rename
set_info_for_user to update_info_for_event,
which just makes it clear that the function
expects data in the "event" format (as opposed
to the format for page_params or server
responses).
As of now keeping the intermediate raw_info data
around feels slightly awkward, because we just
immediately calculate presence_info for any kind
of update. This may be sorta surprising if you
just skim the code and see the various timeout
constants. You would think we might be automatically
expiring "active" statuses in the client due to
the simple passage of time, but in fact the precise
places we do this are all triggered by new data
from the server and we re-calculate statuses
immediately.
(There are indirect ways that clients
have timing logic, since they ask the
server for new data at various intervals, but a
smarter client could simply expire users on its
own, or at least with a more efficient transfer
of info between it and the server. One of
the thing that complicates client-side logic
is that server and client clocks may be out
of sync. Also, it's not inherently super expensive
to get updates from the server.)
295 lines
8.8 KiB
JavaScript
295 lines
8.8 KiB
JavaScript
const _page_params = {};
|
|
|
|
set_global('blueslip', global.make_zblueslip());
|
|
|
|
set_global('page_params', _page_params);
|
|
set_global('i18n', global.stub_i18n);
|
|
set_global('$', global.make_zjquery());
|
|
zrequire('people');
|
|
zrequire('presence');
|
|
zrequire('util');
|
|
zrequire('user_status');
|
|
|
|
zrequire('buddy_data');
|
|
set_global('timerender', {});
|
|
|
|
// 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 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 make_people() {
|
|
for (const i of _.range(1002, 2000)) {
|
|
const person = {
|
|
user_id: i,
|
|
full_name: `Human ${i}`,
|
|
email: `person${i}@example.com`,
|
|
};
|
|
people.add_in_realm(person);
|
|
}
|
|
|
|
people.add_in_realm(bot);
|
|
people.add_in_realm(bot_with_owner);
|
|
people.add_in_realm(selma);
|
|
people.add_in_realm(me);
|
|
people.add_in_realm(old_user);
|
|
|
|
people.initialize_current_user(me.user_id);
|
|
}
|
|
|
|
|
|
function activate_people() {
|
|
presence.presence_info.clear();
|
|
|
|
function set_presence(user_id, status) {
|
|
presence.presence_info.set(user_id, {
|
|
status: status,
|
|
last_active: 9999,
|
|
});
|
|
}
|
|
|
|
// 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');
|
|
}
|
|
}
|
|
|
|
|
|
make_people();
|
|
activate_people();
|
|
|
|
run_test('user_circle', () => {
|
|
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');
|
|
});
|
|
|
|
run_test('buddy_status', () => {
|
|
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');
|
|
});
|
|
|
|
run_test('title_data', () => {
|
|
// 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',
|
|
|
|
};
|
|
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: '',
|
|
};
|
|
assert.deepEqual(buddy_data.get_title_data(old_user.user_id, is_group), expected_data);
|
|
});
|
|
|
|
run_test('simple search', () => {
|
|
const user_ids = buddy_data.get_filtered_and_sorted_user_ids('sel');
|
|
|
|
assert.deepEqual(user_ids, [selma.user_id]);
|
|
});
|
|
|
|
run_test('bulk_data_hacks', () => {
|
|
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, 999);
|
|
|
|
// We match on "p" for the email.
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids('p');
|
|
assert.equal(user_ids.length, 998);
|
|
|
|
|
|
// Make our shrink limit higher, and go back to an empty search.
|
|
// We won't get all 1000 users, just the present ones.
|
|
buddy_data.max_size_before_shrinking = 50000;
|
|
|
|
user_ids = buddy_data.get_filtered_and_sorted_user_ids('');
|
|
assert.equal(user_ids.length, 700);
|
|
});
|
|
|
|
run_test('level', () => {
|
|
assert.equal(buddy_data.my_user_status(me.user_id), 'translated: (you)');
|
|
user_status.set_away(me.user_id);
|
|
assert.equal(buddy_data.my_user_status(me.user_id), 'translated: (unavailable)');
|
|
user_status.revoke_away(me.user_id);
|
|
assert.equal(buddy_data.my_user_status(me.user_id), 'translated: (you)');
|
|
});
|
|
|
|
run_test('level', () => {
|
|
presence.presence_info.clear();
|
|
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);
|
|
});
|
|
|
|
run_test('user_last_seen_time_status', () => {
|
|
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');
|
|
|
|
presence.last_active_date = (user_id) => {
|
|
assert.equal(user_id, old_user.user_id);
|
|
|
|
return {
|
|
clone: () => 'date-stub',
|
|
};
|
|
};
|
|
|
|
timerender.last_seen_status_from_date = (date) => {
|
|
assert.equal(date, 'date-stub');
|
|
return 'May 12';
|
|
};
|
|
|
|
assert.equal(buddy_data.user_last_seen_time_status(old_user.user_id),
|
|
'May 12');
|
|
|
|
});
|
|
|
|
run_test('error handling', () => {
|
|
presence.get_user_ids = () => [42];
|
|
blueslip.set_test_data('error', 'Unknown user_id in get_by_user_id: 42');
|
|
blueslip.set_test_data('warn', 'Got user_id in presence but not people: 42');
|
|
buddy_data.get_filtered_and_sorted_user_ids();
|
|
assert.equal(blueslip.get_test_logs('error').length, 1);
|
|
assert.equal(blueslip.get_test_logs('warn').length, 1);
|
|
});
|