paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-06 15:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

compose fade: Extract compose_fade_users class.

Browse Source 
We extract compose_fade_users and compose_fade_helper.

This is a pretty verbatim extraction of code, apart from adding a few
exports and changing the callers.

This change makes the buddy_data module no longer sit "above" these
files in the dependency graph (at least not via compose_fade):

    * jquery
    * lodash (not a big deal)
    * compose_state
    * floating_recipient_bar
    * message_viewport
    * rows

The new moules have dependencies that buddy_data already
had directly for other reasons:

    * people
    * util

And then buddy_data still depends on stream_data indirectly through
the compose-fade logic for stream_data. Even without compose-fade, it
would depend indirectly on stream_data via hash_util.

Note that we could have lifted the calls to compose_fade out of
buddy_data to move some dependencies around, but it's useful to have
buddy_data fully encapsulate what goes into the buddy list without
spreading responsibilities to things like activity.js and
buddy_list.js. We can now unit-test the logic at the level of
buddy_data, which is a lot easier than trying to do it via modules
that delegate drawing or do drawing (such as activity.js and
buddy_list.js).

Note that we still don't have 100% line coverage on the
compose_fade.js module, but all the code that we extracted now is
covered, mostly via buddy_data tests.
This commit is contained in:
Steve Howell
2021-03-19 13:38:22 +00:00
committed by Tim Abbott
parent f121e40848
commit 855ac26c48
6 changed files with 250 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
static/js/compose_fade.js
View File

@@ -2,6 +2,8 @@ import $ from "jquery";
import _ from "lodash";
import {buddy_list} from "./buddy_list";
import * as compose_fade_helper from "./compose_fade_helper";
import * as compose_fade_users from "./compose_fade_users";
import * as compose_state from "./compose_state";
import * as floating_recipient_bar from "./floating_recipient_bar";
import * as message_viewport from "./message_viewport";
@@ -10,21 +12,16 @@ import * as rows from "./rows";
import * as stream_data from "./stream_data";
import * as util from "./util";
let focused_recipient;
let normal_display = false;
export function should_fade_message(message) {
return !util.same_recipient(focused_recipient, message);
}
export function set_focused_recipient(msg_type) {
if (msg_type === undefined) {
focused_recipient = undefined;
compose_fade_helper.clear_focused_recipient();
}
// Construct focused_recipient as a mocked up element which has all the
// fields of a message used by util.same_recipient()
focused_recipient = {
const focused_recipient = {
type: msg_type,
};
@@ -43,6 +40,8 @@ export function set_focused_recipient(msg_type) {
focused_recipient.reply_to = reply_to;
focused_recipient.to_user_ids = people.reply_to_to_user_ids_string(reply_to);
}
compose_fade_helper.set_focused_recipient(focused_recipient);
}
function display_messages_normally() {
@@ -74,7 +73,7 @@ function fade_messages() {
for (i = 0; i < visible_groups.length; i += 1) {
first_row = rows.first_message_in_group(visible_groups[i]);
first_message = current_msg_list.get(rows.id(first_row));
should_fade_group = should_fade_message(first_message);
should_fade_group = compose_fade_helper.should_fade_message(first_message);
change_fade_state($(visible_groups[i]), should_fade_group);
}
@@ -98,7 +97,9 @@ function fade_messages() {
// sorted as it would be displayed in the message view
for (i = 0; i < all_groups.length; i += 1) {
const group_elt = $(all_groups[i]);
should_fade_group = should_fade_message(rows.recipient_from_group(group_elt));
should_fade_group = compose_fade_helper.should_fade_message(
rows.recipient_from_group(group_elt),
);
change_fade_state(group_elt, should_fade_group);
}
@@ -110,23 +111,6 @@ function fade_messages() {
);
}
export function would_receive_message(user_id) {
if (focused_recipient.type === "stream") {
const sub = stream_data.get_sub_by_id(focused_recipient.stream_id);
if (!sub) {
// If the stream isn't valid, there is no risk of a mix
// yet, so we sort of "lie" and say they would receive a
// message.
return true;
}
return stream_data.is_user_subscribed(focused_recipient.stream_id, user_id);
}
// PM, so check if the given email is in the recipients list.
return util.is_pm_recipient(user_id, focused_recipient);
}
const user_fade_config = {
get_user_id(li) {
return buddy_list.get_key_from_li({li});
@@ -139,66 +123,17 @@ const user_fade_config = {
},
};
function update_user_row_when_fading(li, conf) {
const user_id = conf.get_user_id(li);
const would_receive = would_receive_message(user_id);
if (would_receive || people.is_my_user_id(user_id)) {
conf.unfade(li);
} else {
conf.fade(li);
}
}
function display_users_normally(items, conf) {
for (const li of items) {
conf.unfade(li);
}
}
function fade_users(items, conf) {
for (const li of items) {
update_user_row_when_fading(li, conf);
}
}
function want_normal_display() {
// If we're not composing show a normal display.
if (focused_recipient === undefined) {
return true;
}
// If the user really hasn't specified anything let, then we want a normal display
if (focused_recipient.type === "stream") {
// If a stream doesn't exist, there is no real chance of a mix, so fading
// is just noise to the user.
if (!stream_data.get_sub_by_id(focused_recipient.stream_id)) {
return true;
}
// This is kind of debatable. If the topic is empty, it could be that
// the user simply hasn't started typing it yet, but disabling fading here
// means the feature doesn't help realms where topics aren't mandatory
// (which is most realms as of this writing).
if (focused_recipient.topic === "") {
return true;
}
}
return focused_recipient.type === "private" && focused_recipient.reply_to === "";
}
function do_update_all() {
const user_items = buddy_list.get_items();
if (want_normal_display()) {
if (compose_fade_helper.want_normal_display()) {
if (!normal_display) {
display_messages_normally();
display_users_normally(user_items, user_fade_config);
compose_fade_users.display_users_normally(user_items, user_fade_config);
}
} else {
fade_messages();
fade_users(user_items, user_fade_config);
compose_fade_users.fade_users(user_items, user_fade_config);
}
}
@@ -208,15 +143,7 @@ function do_update_all() {
export function update_faded_users() {
const user_items = buddy_list.get_items();
update_user_info(user_items, user_fade_config);
}
export function update_user_info(items, conf) {
if (want_normal_display()) {
display_users_normally(items, conf);
} else {
fade_users(items, conf);
}
compose_fade_users.update_user_info(user_items, user_fade_config);
}
// This gets called on keyup events, hence the throttling.
@@ -228,13 +155,13 @@ export function start_compose(msg_type) {
}
export function clear_compose() {
focused_recipient = undefined;
compose_fade_helper.clear_focused_recipient();
display_messages_normally();
update_faded_users();
}
export function update_message_list() {
if (want_normal_display()) {
if (compose_fade_helper.want_normal_display()) {
display_messages_normally();
} else {
fade_messages();
@@ -242,7 +169,7 @@ export function update_message_list() {
}
export function update_rendered_message_groups(message_groups, get_element) {
if (want_normal_display()) {
if (compose_fade_helper.want_normal_display()) {
return;
}
@@ -252,7 +179,7 @@ export function update_rendered_message_groups(message_groups, get_element) {
for (const message_group of message_groups) {
const elt = get_element(message_group);
const first_message = message_group.message_containers[0].msg;
const should_fade = should_fade_message(first_message);
const should_fade = compose_fade_helper.should_fade_message(first_message);
change_fade_state(elt, should_fade);
}
}