Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

actions_popover: Move data to display the popover to a new module. 

Since we are switching to tippyjs to display popovers, extracting
this data in a commit of its own, makes further changes easier to
review and merge.

Also, we could add tests with full coverage on the data
provided to popovers, possibly a good first issue for beginners.
This commit is contained in:
Aman Agrawal 2022-11-24 08:01:49 +00:00 committed by Tim Abbott
parent 8b6dc955f1
commit 4593fcf8d1
3 changed files with 114 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
static/js/popover_menus_data.js Normal file
View File

@ -0,0 +1,111 @@
/* This module provides relevant data to render popovers that require multiple args.
This helps keep the popovers code small and keep it focused on rendering side of things. */
import * as feature_flags from "./feature_flags";
import * as hash_util from "./hash_util";
import {$t} from "./i18n";
import * as message_edit from "./message_edit";
import * as message_lists from "./message_lists";
import * as muted_users from "./muted_users";
import * as narrow_state from "./narrow_state";
import {page_params} from "./page_params";
import * as stream_data from "./stream_data";
export function get_actions_popover_content_context(message_id) {
const message = message_lists.current.get(message_id);
const message_container = message_lists.current.view.message_containers.get(message.id);
const not_spectator = !page_params.is_spectator;
const should_display_hide_option =
muted_users.is_user_muted(message.sender_id) &&
!message_container.is_hidden &&
not_spectator;
const editability = message_edit.get_editability(message);
const can_move_message = message_edit.can_move_message(message);
let editability_menu_item;
let move_message_menu_item;
let view_source_menu_item;
if (editability === message_edit.editability_types.FULL) {
editability_menu_item = $t({defaultMessage: "Edit message"});
if (message.is_stream) {
move_message_menu_item = $t({defaultMessage: "Move messages"});
}
} else if (can_move_message) {
move_message_menu_item = $t({defaultMessage: "Move messages"});
view_source_menu_item = $t({defaultMessage: "View message source"});
} else {
view_source_menu_item = $t({defaultMessage: "View message source"});
}
// We do not offer "Mark as unread" on messages in streams
// that the user is not currently subscribed to. Zulip has an
// invariant that all unread messages must be in streams the
// user is subscribed to, and so the server will ignore any
// messages in such streams; it's better to hint this is not
// useful by not offering the option.
//
// We also require that the message is currently marked as
// read. Theoretically, it could be useful to offer this even
// for a message that is already unread, so you can mark those
// below it as unread; but that's an unlikely situation, and
// showing it can be a confusing source of clutter. We may
// want to revise this algorithm specifically in the context
// of interleaved views.
//
// To work around #22893, we also only offer the option if the
// fetch_status data structure means we'll be able to mark
// everything below the current message as read correctly.
const not_stream_message = message.type !== "stream";
const subscribed_to_stream =
message.type === "stream" && stream_data.is_subscribed(message.stream_id);
const should_display_mark_as_unread =
!message.unread && not_spectator && (not_stream_message || subscribed_to_stream);
const should_display_edit_history_option =
message.edit_history &&
message.edit_history.some(
(entry) =>
entry.prev_content !== undefined ||
entry.prev_stream !== undefined ||
entry.prev_topic !== undefined,
) &&
page_params.realm_allow_edit_history &&
not_spectator;
// Disabling this for /me messages is a temporary workaround
// for the fact that we don't have a styling for how that
// should look. See also condense.js.
const should_display_collapse =
!message.locally_echoed && !message.is_me_message && !message.collapsed && not_spectator;
const should_display_uncollapse =
!message.locally_echoed && !message.is_me_message && message.collapsed;
const should_display_quote_and_reply = message.content !== "<p>(deleted)</p>" && not_spectator;
const conversation_time_uri = hash_util.by_conversation_and_time_url(message);
const should_display_delete_option = message_edit.get_deletability(message) && not_spectator;
const should_display_read_receipts_option =
page_params.realm_enable_read_receipts && not_spectator;
return {
message_id: message.id,
stream_id: message.stream_id,
editability_menu_item,
move_message_menu_item,
should_display_mark_as_unread,
view_source_menu_item,
should_display_collapse,
should_display_uncollapse,
should_display_add_reaction_option: message.sent_by_me,
should_display_edit_history_option,
should_display_hide_option,
conversation_time_uri,
narrowed: narrow_state.active(),
should_display_delete_option,
should_display_read_receipts_option,
should_display_reminder_option: feature_flags.reminders_in_message_action_menu,
should_display_quote_and_reply,
};
}

106
static/js/popovers.js
View File

@ -25,7 +25,6 @@ import * as condense from "./condense";
import {media_breakpoints_num} from "./css_variables";
import * as dialog_widget from "./dialog_widget";
import * as emoji_picker from "./emoji_picker";
import * as feature_flags from "./feature_flags";
import * as giphy from "./giphy";
import * as hash_util from "./hash_util";
import {$t, $t_html} from "./i18n";
@ -36,11 +35,11 @@ import * as message_viewport from "./message_viewport";
import * as muted_users from "./muted_users";
import * as muted_users_ui from "./muted_users_ui";
import * as narrow from "./narrow";
import * as narrow_state from "./narrow_state";
import * as overlays from "./overlays";
import {page_params} from "./page_params";
import * as people from "./people";
import * as popover_menus from "./popover_menus";
import * as popover_menus_data from "./popover_menus_data";
import * as read_receipts from "./read_receipts";
import * as realm_playground from "./realm_playground";
import * as reminder from "./reminder";
@ -50,7 +49,6 @@ import * as settings_bots from "./settings_bots";
import * as settings_config from "./settings_config";
import * as settings_data from "./settings_data";
import * as settings_users from "./settings_users";
import * as stream_data from "./stream_data";
import * as stream_popover from "./stream_popover";
import * as ui_report from "./ui_report";
import * as unread_ops from "./unread_ops";
@ -532,109 +530,9 @@ export function toggle_actions_popover(element, id) {
$(element).closest(".message_row").toggleClass("has_popover has_actions_popover");
message_lists.current.select_id(id);
const not_spectator = !page_params.is_spectator;
const $elt = $(element);
if ($elt.data("popover") === undefined) {
const message = message_lists.current.get(id);
const message_container = message_lists.current.view.message_containers.get(message.id);
const should_display_hide_option =
muted_users.is_user_muted(message.sender_id) &&
!message_container.is_hidden &&
not_spectator;
const editability = message_edit.get_editability(message);
const can_move_message = message_edit.can_move_message(message);
let editability_menu_item;
let move_message_menu_item;
let view_source_menu_item;
if (editability === message_edit.editability_types.FULL) {
editability_menu_item = $t({defaultMessage: "Edit message"});
if (message.is_stream) {
move_message_menu_item = $t({defaultMessage: "Move messages"});
}
} else if (can_move_message) {
move_message_menu_item = $t({defaultMessage: "Move messages"});
view_source_menu_item = $t({defaultMessage: "View message source"});
} else {
view_source_menu_item = $t({defaultMessage: "View message source"});
}
// We do not offer "Mark as unread" on messages in streams
// that the user is not currently subscribed to. Zulip has an
// invariant that all unread messages must be in streams the
// user is subscribed to, and so the server will ignore any
// messages in such streams; it's better to hint this is not
// useful by not offering the option.
//
// We also require that the message is currently marked as
// read. Theoretically, it could be useful to offer this even
// for a message that is already unread, so you can mark those
// below it as unread; but that's an unlikely situation, and
// showing it can be a confusing source of clutter. We may
// want to revise this algorithm specifically in the context
// of interleaved views.
//
// To work around #22893, we also only offer the option if the
// fetch_status data structure means we'll be able to mark
// everything below the current message as read correctly.
const not_stream_message = message.type !== "stream";
const subscribed_to_stream =
message.type === "stream" && stream_data.is_subscribed(message.stream_id);
const should_display_mark_as_unread =
!message.unread && not_spectator && (not_stream_message || subscribed_to_stream);
const should_display_edit_history_option =
message.edit_history &&
message.edit_history.some(
(entry) =>
entry.prev_content !== undefined ||
entry.prev_stream !== undefined ||
entry.prev_topic !== undefined,
) &&
page_params.realm_allow_edit_history &&
not_spectator;
// Disabling this for /me messages is a temporary workaround
// for the fact that we don't have a styling for how that
// should look. See also condense.js.
const should_display_collapse =
!message.locally_echoed &&
!message.is_me_message &&
!message.collapsed &&
not_spectator;
const should_display_uncollapse =
!message.locally_echoed && !message.is_me_message && message.collapsed;
const should_display_quote_and_reply =
message.content !== "<p>(deleted)</p>" && not_spectator;
const conversation_time_uri = hash_util.by_conversation_and_time_url(message);
const should_display_delete_option =
message_edit.get_deletability(message) && not_spectator;
const should_display_read_receipts_option =
page_params.realm_enable_read_receipts && not_spectator;
const args = {
message_id: message.id,
stream_id: message.stream_id,
editability_menu_item,
move_message_menu_item,
should_display_mark_as_unread,
view_source_menu_item,
should_display_collapse,
should_display_uncollapse,
should_display_add_reaction_option: message.sent_by_me,
should_display_edit_history_option,
should_display_hide_option,
conversation_time_uri,
narrowed: narrow_state.active(),
should_display_delete_option,
should_display_read_receipts_option,
should_display_reminder_option: feature_flags.reminders_in_message_action_menu,
should_display_quote_and_reply,
};
const args = popover_menus_data.get_actions_popover_content_context(id);
const ypos = $elt.offset().top;
$elt.popover({

1
tools/test-js-with-node
View File

@ -127,6 +127,7 @@ EXEMPT_FILES = make_set(
"static/js/pm_list_dom.js",
"static/js/poll_widget.js",
"static/js/popover_menus.js",
"static/js/popover_menus_data.js",
"static/js/popovers.js",
"static/js/read_receipts.js",
"static/js/ready.ts",