Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

messages: Implement per-recipient link preview hiding.

Aadyot1f4bb27444cb5
diff --git a/starlight_help/src/content/docs/image-video-and-website-previews.mdx b/starlight_help/src/content/docs/image-video-and-website-previews.mdx
index cd3b3a9d6b6..964396b6b52 100644
--- a/starlight_help/src/content/docs/image-video-and-website-previews.mdx
+++ b/starlight_help/src/content/docs/image-video-and-website-previews.mdx
@@ -5,14 +5,18 @@ title: Image, video and website previews
import {TabItem, Tabs} from "@astrojs/starlight/components";
import FlattenedSteps from "../../components/FlattenedSteps.astro";
+import KeyboardTip from "../../components/KeyboardTip.astro";
import NavigationSteps from "../../components/NavigationSteps.astro";
import ZulipNote from "../../components/ZulipNote.astro";
+import ZulipTip from "../../components/ZulipTip.astro";
import AdminOnly from "../include/_AdminOnly.mdx";
+import MessageActionsMenu from "../include/_MessageActionsMenu.mdx";
import SaveChanges from "../include/_SaveChanges.mdx";
Zulip displays previews of images, videos, audio files and websites in your
message feed. You can [configure](#configure-how-animated-images-are-played) how
-animated images are previewed.
+animated images are previewed, or [hide link
+previews](#hide-or-show-link-previews-on-a-message) on individual messages.
Organization administrators can:
@@ -52,6 +56,29 @@ viewer](/help/view-images-and-videos).
</TabItem>
</Tabs>
+## Hide or show link previews on a message
+
+If a message shows a [website
+preview](#configure-whether-website-previews-are-shown) or a video preview from
+a site like YouTube or Vimeo that you'd rather not see, you can hide it just for
+yourself, without changing how the message looks for anyone else.
+
+<FlattenedSteps>
+ <MessageActionsMenu />
+
+ 1. Click **Hide link previews**.
+</FlattenedSteps>
+
+<ZulipTip>
+ To bring the previews back, follow the same steps and click **Show link
+ previews**.
+</ZulipTip>
+
+<KeyboardTip>
+ You can use <kbd>Shift</kbd> + <kbd>L</kbd> to hide or show link previews on
+ the selected message.
+</KeyboardTip>
+
## Configure image and video thumbnail size
<AdminOnly />
diff --git a/starlight_help/src/content/docs/keyboard-shortcuts.mdx b/starlight_help/src/content/docs/keyboard-shortcuts.mdx
index 1022ce8a988..3e27c317afb 100644
--- a/starlight_help/src/content/docs/keyboard-shortcuts.mdx
+++ b/starlight_help/src/content/docs/keyboard-shortcuts.mdx
@@ -167,6 +167,7 @@ reference in the Zulip app to add more to your repertoire as needed.
* **React with 👍**: <kbd>+</kbd>
* **Mark as unread from selected message**: <kbd>Shift</kbd> + <kbd>U</kbd>
* **Collapse/show message**: <kbd>-</kbd>
+* **Hide/show link previews**: <kbd>Shift</kbd> + <kbd>L</kbd>
* **Toggle topic mute**: <kbd>Shift</kbd> + <kbd>M</kbd>. This works in both
message views and views that list topics (e.g., [inbox](/help/inbox), [recent
conversations](/help/recent-conversations)). Learn about [muted
diff --git a/web/src/condense.ts b/web/src/condense.ts
index 5cee4c3f171..69af5ddc817 100644
--- a/web/src/condense.ts
+++ b/web/src/condense.ts
@@ -188,7 +188,7 @@ function get_message_height(elem: HTMLElement): number {
return util.the($(elem).find(".message_content")).scrollHeight;
}
-export function condense_and_collapse(elems: JQuery): void {
+export function condense_and_collapse(elems: JQuery | HTMLElement[]): void {
if (message_lists.current === undefined) {
return;
}
diff --git a/web/src/hotkey.ts b/web/src/hotkey.ts
index b2177f94866..b458d9b701e 100644
--- a/web/src/hotkey.ts
+++ b/web/src/hotkey.ts
@@ -48,6 +48,7 @@ import {page_params} from "./page_params.ts";
import * as playground_links_popover from "./playground_links_popover.ts";
import * as pm_list from "./pm_list.ts";
import * as popover_menus from "./popover_menus.ts";
+import * as popover_menus_data from "./popover_menus_data.ts";
import * as popovers from "./popovers.ts";
import * as reactions from "./reactions.ts";
import * as read_receipts from "./read_receipts.ts";
@@ -165,6 +166,7 @@ const KEYDOWN_MAPPINGS: Record<string, Hotkey | Hotkey[]> = {
"Shift+I": {name: "open_inbox", message_view_only: true},
"Shift+J": {name: "vim_page_down", message_view_only: true},
"Shift+K": {name: "vim_page_up", message_view_only: true},
+ "Shift+L": {name: "toggle_link_previews", message_view_only: true},
"Shift+M": {name: "toggle_topic_visibility_policy", message_view_only: true},
"Shift+N": {name: "narrow_to_next_unread_followed_topic", message_view_only: false},
"Shift+P": {name: "narrow_private", message_view_only: true},
@@ -1484,6 +1486,12 @@ function process_hotkey(e: JQuery.KeyDownEvent, hotkey: Hotkey): boolean {
case "toggle_message_collapse":
condense.toggle_collapse(msg);
return true;
+ case "toggle_link_previews": {
+ if (popover_menus_data.can_toggle_link_previews(msg)) {
+ message_actions_popover.toggle_hide_link_previews(msg);
+ }
+ return true;
+ }
case "mark_unread":
unread_ops.mark_as_unread_from_here(msg.id);
return true;
diff --git a/web/src/message_actions_popover.ts b/web/src/message_actions_popover.ts
index c989242fbe0..88aba0895fa 100644
--- a/web/src/message_actions_popover.ts
+++ b/web/src/message_actions_popover.ts
@@ -11,7 +11,9 @@ import {show_copied_confirmation} from "./copied_tooltip.ts";
import * as emoji_picker from "./emoji_picker.ts";
import * as message_delete from "./message_delete.ts";
import * as message_edit from "./message_edit.ts";
+import * as message_flags from "./message_flags.ts";
import * as message_lists from "./message_lists.ts";
+import * as message_live_update from "./message_live_update.ts";
import * as message_report from "./message_report.ts";
import type {Message} from "./message_store.ts";
import * as message_viewport from "./message_viewport.ts";
@@ -113,6 +115,18 @@ export function toggle_message_actions_menu(message: Message): boolean {
return true;
}
+export function toggle_hide_link_previews(message: Message): void {
+ message.hide_link_previews = !message.hide_link_previews;
+ message_live_update.update_hide_link_previews_view([message.id], message.hide_link_previews);
+
+ // Unlike scrolling, this must not mark anything read.
+ assert(message_lists.current !== undefined);
+ message_lists.current.select_id(message.id, {then_scroll: true, mark_read: false});
+
+ const op = message.hide_link_previews ? "add" : "remove";
+ message_flags.send_flag_update_for_messages([message.id], "hide_link_previews", op);
+}
+
export function initialize({
message_reminder_click_handler,
}: {
@@ -256,6 +270,17 @@ export function initialize({
popover_menus.hide_current_popover_if_visible(instance);
});
+ $popper.one("click", ".popover_toggle_hide_link_previews", (e) => {
+ const message_id = Number($(e.currentTarget).attr("data-message-id"));
+ assert(message_lists.current !== undefined);
+ const message = message_lists.current.get(message_id);
+ assert(message !== undefined);
+ toggle_hide_link_previews(message);
+ e.preventDefault();
+ e.stopPropagation();
+ popover_menus.hide_current_popover_if_visible(instance);
+ });
+
$popper.one("click", ".view_read_receipts", (e) => {
const message_id = Number($(e.currentTarget).attr("data-message-id"));
read_receipts.show_user_list(message_id);
diff --git a/web/src/message_live_update.ts b/web/src/message_live_update.ts
index 6b755cd6c38..6a6002637e9 100644
--- a/web/src/message_live_update.ts
+++ b/web/src/message_live_update.ts
@@ -1,3 +1,4 @@
+import * as condense from "./condense.ts";
import * as message_lists from "./message_lists.ts";
import * as message_store from "./message_store.ts";
import * as thumbnail from "./thumbnail.ts";
@@ -79,6 +80,30 @@ export function update_starred_view(message_id: number, new_value: boolean): voi
});
}
+export function update_hide_link_previews_view(message_ids: number[], hide: boolean): void {
+ // Avoid a full re-render, but toggle the link previews in each
+ // message table in which the messages are visible.
+ for (const message_id of message_ids) {
+ update_message_in_all_views(message_id, ($row) => {
+ $row.find(".message_content").toggleClass("hide-link-previews", hide);
+ });
+ }
+
+ if (message_lists.current === undefined) {
+ return;
+ }
+
+ // Hiding a preview changes the message's height, so its condensed
+ // state needs rechecking. Only the current list can be measured.
+ const rows_to_recondense = [];
+ for (const message_id of message_ids) {
+ rows_to_recondense.push(...message_lists.current.get_row(message_id));
+ }
+ if (rows_to_recondense.length > 0) {
+ condense.condense_and_collapse(rows_to_recondense);
+ }
+}
+
export function update_stream_name(stream_id: number, new_name: string): void {
message_store.update_stream_name(stream_id, new_name);
rerender_messages_view();
diff --git a/web/src/message_parser.ts b/web/src/message_parser.ts
index 901dd75d18f..82dcb386e9e 100644
--- a/web/src/message_parser.ts
+++ b/web/src/message_parser.ts
@@ -27,6 +27,18 @@ export function message_has_attachment(message_content: string): boolean {
);
}
+export function message_has_link_preview(message_content: string): boolean {
+ // Inline image and video previews are excluded because Markdown drops
+ // the link when the message body is a bare URL, leaving the preview as
+ // the only content; hiding it would blank the message. Video previews
+ // always keep their link, so they are safe to hide. .vimeo-video is
+ // legacy markup for Vimeo, still present in stored rendered content.
+ return is_element_in_message_content(
+ message_content,
+ ".message_embed, .youtube-video, .embed-video, .vimeo-video",
+ );
+}
+
export function message_has_reaction(message: Message): boolean {
return message.clean_reactions.size > 0;
}
diff --git a/web/src/message_store.ts b/web/src/message_store.ts
index b4323cf2757..64200e8acc5 100644
--- a/web/src/message_store.ts
+++ b/web/src/message_store.ts
@@ -137,6 +137,7 @@ type Booleans = {
stream_wildcard_mentioned: boolean;
topic_wildcard_mentioned: boolean;
collapsed: boolean;
+ hide_link_previews: boolean;
condensed?: boolean;
alerted: boolean;
};
@@ -329,6 +330,7 @@ export function convert_raw_message_to_message_with_booleans(opts: NewMessage):
stream_wildcard_mentioned: convert_flag("stream_wildcard_mentioned"),
topic_wildcard_mentioned: convert_flag("topic_wildcard_mentioned"),
collapsed: convert_flag("collapsed"),
+ hide_link_previews: convert_flag("hide_link_previews"),
alerted: convert_flag("has_alert_word"),
};
diff --git a/web/src/popover_menus_data.ts b/web/src/popover_menus_data.ts
index 3092618ea8d..7fd3b95622a 100644
--- a/web/src/popover_menus_data.ts
+++ b/web/src/popover_menus_data.ts
@@ -11,6 +11,7 @@ import {$t} from "./i18n.ts";
import * as message_delete from "./message_delete.ts";
import * as message_edit from "./message_edit.ts";
import * as message_lists from "./message_lists.ts";
+import * as message_parser from "./message_parser.ts";
import type {Message} from "./message_store.ts";
import * as message_store from "./message_store.ts";
import * as narrow_state from "./narrow_state.ts";
@@ -43,6 +44,8 @@ type ActionPopoverContext = {
should_display_remind_me_option: boolean;
should_display_collapse: boolean;
should_display_uncollapse: boolean;
+ should_display_hide_link_previews: boolean;
+ should_display_show_link_previews: boolean;
should_display_quote_message: boolean;
quote_message_menu_item: string;
forward_message_menu_item: string;
@@ -182,6 +185,24 @@ function get_quote_menu_labels(kind: QuoteMenuSelection["kind"]): {
}
}
+// Shared with the keyboard shortcut, so both are offered in the same cases.
+export function can_toggle_link_previews(message: Message): boolean {
+ if (message.locally_echoed || page_params.is_spectator) {
+ return false;
+ }
+
+ // A collapsed message, and one hidden for a muted sender, show no
+ // body at all, so there is nothing to toggle until it is shown.
+ assert(message_lists.current !== undefined);
+ const message_container = message_lists.current.view.message_containers.get(message.id);
+ if (message.collapsed || message_container === undefined || message_container.is_hidden) {
+ return false;
+ }
+
+ // Parsing the message's HTML is the expensive part, so check it last.
+ return message_parser.message_has_link_preview(message.content);
+}
+
export function get_actions_popover_content_context(
message_id: number,
quote_menu_selection: QuoteMenuSelection,
@@ -251,6 +272,10 @@ export function get_actions_popover_content_context(
should_display_uncollapse = message.collapsed || message_condensed;
}
+ const can_toggle_previews = can_toggle_link_previews(message);
+ const should_display_hide_link_previews = can_toggle_previews && !message.hide_link_previews;
+ const should_display_show_link_previews = can_toggle_previews && message.hide_link_previews;
+
const should_display_quote_message = not_spectator;
const {quote_message_menu_item, forward_message_menu_item} = get_quote_menu_labels(
quote_menu_selection.kind,
@@ -301,6 +326,8 @@ export function get_actions_popover_content_context(
view_source_menu_item,
should_display_collapse,
should_display_uncollapse,
+ should_display_hide_link_previews,
+ should_display_show_link_previews,
should_display_add_reaction_option,
conversation_time_url,
should_display_delete_option,
diff --git a/web/src/server_events_dispatch.js b/web/src/server_events_dispatch.js
index dae4c19817e..10a39efcedf 100644
--- a/web/src/server_events_dispatch.js
+++ b/web/src/server_events_dispatch.js
@@ -1198,6 +1198,22 @@ export function dispatch_normal_event(event) {
condense.update_collapsed_view(message);
}
break;
+ case "hide_link_previews": {
+ const updated_message_ids = [];
+ for (const message_id of event.messages) {
+ const message = message_store.get(message_id);
+ if (message === undefined) {
+ continue;
+ }
+ message.hide_link_previews = new_value;
+ updated_message_ids.push(message_id);
+ }
+ message_live_update.update_hide_link_previews_view(
+ updated_message_ids,
+ new_value,
+ );
+ break;
+ }
}
break;
}
diff --git a/web/styles/rendered_markdown.css b/web/styles/rendered_markdown.css
index ba158432d0c..be273784978 100644
--- a/web/styles/rendered_markdown.css
+++ b/web/styles/rendered_markdown.css
@@ -1059,6 +1059,24 @@
}
}
+.message_content.hide-link-previews {
+ .message_embed,
+ .youtube-video,
+ .embed-video,
+ .vimeo-video {
+ display: none;
+ }
+
+ /* A gallery whose only children are hidden video previews has
+ nothing left but its bottom margin. Galleries that also hold
+ image or video previews must survive, since those stay visible. */
+ .message-thumbnail-gallery:not(
+ :has(> :not(.youtube-video, .embed-video, .vimeo-video))
+ ) {
+ display: none;
+ }
+}
+
.codehilite {
display: block !important;
border: none !important;
diff --git a/web/templates/keyboard_shortcuts.hbs b/web/templates/keyboard_shortcuts.hbs
index 3cb5d891431..35631b8bdf0 100644
--- a/web/templates/keyboard_shortcuts.hbs
+++ b/web/templates/keyboard_shortcuts.hbs
@@ -469,6 +469,10 @@
<td class="definition">{{t 'Collapse/show selected message' }}</td>
<td><span class="hotkey"><kbd>-</kbd></span></td>
</tr>
+ <tr>
+ <td class="definition">{{t 'Hide/show link previews on selected message' }}</td>
+ <td><span class="hotkey"><kbd>Shift</kbd> + <kbd>L</kbd></span></td>
+ </tr>
<tr>
<td class="definition">{{t 'Toggle topic mute' }}</td>
<td><span class="hotkey"><kbd>Shift</kbd> + <kbd>M</kbd></span></td>
diff --git a/web/templates/message_body.hbs b/web/templates/message_body.hbs
index a0b1d764b1e..0ee7c1c5652 100644
--- a/web/templates/message_body.hbs
+++ b/web/templates/message_body.hbs
@@ -18,7 +18,7 @@
<i class="zulip-icon zulip-icon-bot" aria-label="{{t 'Bot' }}"></i>
{{/if}}
{{#if status_message}}
- <span class="message_content rendered_markdown status-message">{{rendered_markdown status_message}}</span>
+ <span class="message_content rendered_markdown status-message{{#if msg/hide_link_previews}} hide-link-previews{{/if}}">{{rendered_markdown status_message}}</span>
{{#if message_edit_notices_for_status_message}}
{{> edited_notice .}}
{{/if}}
@@ -55,7 +55,7 @@
{{#unless status_message}}
{{#unless is_hidden}}
- <div class="message_content rendered_markdown">
+ <div class="message_content rendered_markdown{{#if msg/hide_link_previews}} hide-link-previews{{/if}}">
{{#if use_match_properties}}
{{rendered_markdown msg/match_content}}
{{else}}
diff --git a/web/templates/popovers/message_actions_popover.hbs b/web/templates/popovers/message_actions_popover.hbs
index 3a56db851d3..82792279187 100644
--- a/web/templates/popovers/message_actions_popover.hbs
+++ b/web/templates/popovers/message_actions_popover.hbs
@@ -91,6 +91,20 @@
</a>
</li>
{{/if}}
+ {{#if (or should_display_hide_link_previews should_display_show_link_previews)}}
+ <li role="none" class="link-item popover-menu-list-item">
+ <a role="menuitem" data-message-id="{{message_id}}" class="popover_toggle_hide_link_previews popover-menu-link" tabindex="0">
+ {{#if should_display_hide_link_previews}}
+ <i class="popover-menu-icon zulip-icon zulip-icon-hide" aria-hidden="true"></i>
+ <span class="popover-menu-label">{{t "Hide link previews" }}</span>
+ {{else}}
+ <i class="popover-menu-icon zulip-icon zulip-icon-eye" aria-hidden="true"></i>
+ <span class="popover-menu-label">{{t "Show link previews" }}</span>
+ {{/if}}
+ {{popover_hotkey_hints "Shift" "L"}}
+ </a>
+ </li>
+ {{/if}}
{{#if should_display_collapse}}
<li role="none" class="link-item popover-menu-list-item">
<a role="menuitem" data-message-id="{{message_id}}" class="popover_toggle_collapse popover-menu-link" tabindex="0">
diff --git a/web/tests/dispatch.test.cjs b/web/tests/dispatch.test.cjs
index 606eb8531d5..c89f90e8fa3 100644
--- a/web/tests/dispatch.test.cjs
+++ b/web/tests/dispatch.test.cjs
@@ -1573,6 +1573,46 @@ run_test("update_message (uncollapse)", ({override}) => {
assert.deepEqual(updated_messages, [msg]);
});
+// Stands in for the rendered row, to check the class that hides previews.
+function make_message_row(name) {
+ const $row = $.create(`${name} row`);
+ const $content = $.create(`${name} message_content`);
+ $row.set_find_results(".message_content", $content);
+ return {$row, $content};
+}
+
+function dispatch_link_previews_event(event, override) {
+ const {$row, $content} = make_message_row(`message ${test_message.id}`);
+ const condensed_rows = [];
+ override(message_lists.current, "get_row", () => $row);
+ override(condense, "condense_and_collapse", (rows) => {
+ condensed_rows.push(...rows);
+ });
+ dispatch(event);
+ assert.deepEqual(condensed_rows, [...$row]);
+ return $content;
+}
+
+run_test("update_message (hide link previews)", ({override}) => {
+ const event = event_fixtures.update_message_flags__hide_link_previews_add;
+ const $content = dispatch_link_previews_event(event, override);
+ assert.equal(message_store.get(test_message.id).hide_link_previews, true);
+ assert.ok($content.hasClass("hide-link-previews"));
+});
+
+run_test("update_message (show link previews)", ({override}) => {
+ const event = event_fixtures.update_message_flags__hide_link_previews_remove;
+ const $content = dispatch_link_previews_event(event, override);
+ assert.equal(message_store.get(test_message.id).hide_link_previews, false);
+ assert.ok(!$content.hasClass("hide-link-previews"));
+});
+
+run_test("update_message (link previews on an unknown message)", ({disallow}) => {
+ const event = event_fixtures.update_message_flags__hide_link_previews_add;
+ disallow(condense, "condense_and_collapse");
+ dispatch({...event, messages: [0]});
+});
+
run_test("update_message (wrong data)", () => {
const event = {
...event_fixtures.update_message_flags__starred_add,
diff --git a/web/tests/hotkey.test.cjs b/web/tests/hotkey.test.cjs
index 55cd4f14c29..044e2735dce 100644
--- a/web/tests/hotkey.test.cjs
+++ b/web/tests/hotkey.test.cjs
@@ -73,6 +73,7 @@ const overlays = mock_esm("../src/overlays", {
info_overlay_open: () => false,
message_edit_history_open: () => false,
});
+const popover_menus_data = mock_esm("../src/popover_menus_data");
const popovers = mock_esm("../src/user_card_popover", {
user_sidebar: {
is_open: () => false,
@@ -191,6 +192,7 @@ run_test("mappings", () => {
assert.equal(map_down("Delete").name, "delete");
assert.equal(map_down("Enter", true).name, "enter");
assert.equal(map_down("H", true).name, "view_edit_history");
+ assert.equal(map_down("L", true).name, "toggle_link_previews");
assert.equal(map_down("N", true).name, "narrow_to_next_unread_followed_topic");
assert.deepEqual(
map_down("V", true).map((item) => item.name),
@@ -403,7 +405,7 @@ run_test("unmapped keys return false easily", () => {
// calling any functions outside of hotkey.ts.
// (unless we are editing text)
assert_unmapped("bfo");
- assert_unmapped("BEFLOQTWXZ");
+ assert_unmapped("BEFOQTWXZ");
});
run_test("allow normal typing when editing text", ({override, override_rewire}) => {
@@ -508,7 +510,7 @@ run_test("modal open", ({override}) => {
test_normal_typing();
});
-test_while_not_editing_text("misc", ({override}) => {
+test_while_not_editing_text("misc", ({override, disallow}) => {
// Next, test keys that only work on a selected message.
const message_view_only_keys = "@+>RjJkKsuvVi:GH";
@@ -568,6 +570,18 @@ test_while_not_editing_text("misc", ({override}) => {
}));
assert_unmapped("H");
+ override(message_lists.current, "selected_message", () => ({
+ id: 4,
+ type: "stream",
+ }));
+ override(popover_menus_data, "can_toggle_link_previews", () => true);
+ assert_mapping("L", message_actions_popover, "toggle_hide_link_previews", true);
+
+ // The shortcut is still handled when previews cannot be toggled.
+ override(popover_menus_data, "can_toggle_link_previews", () => false);
+ disallow(message_actions_popover, "toggle_hide_link_previews");
+ assert.ok(process("L", true));
+
override(narrow_state, "narrowed_by_topic_reply", () => true);
assert_mapping("s", message_view, "narrow_by_recipient");
diff --git a/web/tests/lib/events.cjs b/web/tests/lib/events.cjs
index b497ba58cd0..4a86ce84dcd 100644
--- a/web/tests/lib/events.cjs
+++ b/web/tests/lib/events.cjs
@@ -965,6 +965,24 @@ exports.fixtures = {
all: false,
},
+ update_message_flags__hide_link_previews_add: {
+ type: "update_message_flags",
+ op: "add",
+ operation: "add",
+ flag: "hide_link_previews",
+ messages: [exports.test_message.id],
+ all: false,
+ },
+
+ update_message_flags__hide_link_previews_remove: {
+ type: "update_message_flags",
+ op: "remove",
+ operation: "remove",
+ flag: "hide_link_previews",
+ messages: [exports.test_message.id],
+ all: false,
+ },
+
update_message_flags__read: {
type: "update_message_flags",
op: "add",
diff --git a/web/tests/message_events.test.cjs b/web/tests/message_events.test.cjs
index 0694e9d98ce..f6e6f60ba2a 100644
--- a/web/tests/message_events.test.cjs
+++ b/web/tests/message_events.test.cjs
@@ -19,6 +19,7 @@ mock_esm("../src/message_parser", {
message_has_attachment: noop,
message_has_image: noop,
message_has_link: noop,
+ message_has_link_preview: noop,
});
message_lists.current = {};
message_lists.all_rendered_message_lists = () => [message_lists.current];
@@ -155,6 +156,7 @@ run_test("update_messages", ({override, override_rewire}) => {
collapsed: false,
content: "<b>new content</b>",
display_recipient: denmark.name,
+ hide_link_previews: false,
historical: false,
id: 111,
is_stream: true,
diff --git a/web/tests/message_parser.test.cjs b/web/tests/message_parser.test.cjs
new file mode 100644
index 00000000000..180780e33cd
--- /dev/null
+++ b/web/tests/message_parser.test.cjs
@@ -0,0 +1,36 @@
+"use strict";
+
+const assert = require("node:assert/strict");
+
+const {zrequire} = require("./lib/namespace.cjs");
+const {run_test} = require("./lib/test.cjs");
+const {$} = require("./lib/zjquery.cjs");
+
+const message_parser = zrequire("message_parser");
+
+const preview_selector = ".message_embed, .youtube-video, .embed-video, .vimeo-video";
+
+run_test("message_has_link_preview", () => {
+ const embed_content = '<div class="message_embed">preview</div>';
+ $(`<div>${embed_content}</div>`).set_find_results(preview_selector, $.create("embed"));
+ assert.equal(message_parser.message_has_link_preview(embed_content), true);
+
+ const youtube_content = '<div class="youtube-video message_inline_image">preview</div>';
+ $(`<div>${youtube_content}</div>`).set_find_results(preview_selector, $.create("youtube"));
+ assert.equal(message_parser.message_has_link_preview(youtube_content), true);
+
+ const embed_video_content = '<div class="embed-video message_inline_image">preview</div>';
+ $(`<div>${embed_video_content}</div>`).set_find_results(
+ preview_selector,
+ $.create("embed-video"),
+ );
+ assert.equal(message_parser.message_has_link_preview(embed_video_content), true);
+
+ const vimeo_content = '<div class="vimeo-video message_inline_image">preview</div>';
+ $(`<div>${vimeo_content}</div>`).set_find_results(preview_selector, $.create("vimeo"));
+ assert.equal(message_parser.message_has_link_preview(vimeo_content), true);
+
+ const plain_content = "<p>plain text</p>";
+ $(`<div>${plain_content}</div>`).set_find_results(preview_selector, []);
+ assert.equal(message_parser.message_has_link_preview(plain_content), false);
+});
diff --git a/web/tests/popover_menus_data.test.cjs b/web/tests/popover_menus_data.test.cjs
index 71debbdb342..303321e52a4 100644
--- a/web/tests/popover_menus_data.test.cjs
+++ b/web/tests/popover_menus_data.test.cjs
@@ -14,6 +14,10 @@ const {Filter} = zrequire("filter");
const {MessageList} = zrequire("message_list");
const message_lists = zrequire("message_lists");
+const message_parser = mock_esm("../src/message_parser", {
+ message_has_link_preview: () => false,
+});
+
const popover_menus_data = zrequire("popover_menus_data");
const people = zrequire("people");
const user_groups = zrequire("user_groups");
@@ -227,6 +231,7 @@ test("my_message_all_actions", ({override}) => {
stream_id: 1,
unread: false,
collapsed: false,
+ hide_link_previews: false,
not_spectator: true,
submessages: [],
edit_history: [
@@ -252,6 +257,8 @@ test("my_message_all_actions", ({override}) => {
assert.equal(response.view_source_menu_item, undefined);
assert.equal(response.should_display_collapse, true);
assert.equal(response.should_display_uncollapse, false);
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, false);
assert.equal(response.should_display_add_reaction_option, true);
assert.equal(response.conversation_time_url, "conversation_and_time_url");
assert.equal(response.should_display_delete_option, true);
@@ -288,6 +295,93 @@ test("my_message_all_actions", ({override}) => {
);
});
+test("link_preview_actions", ({override}) => {
+ set_page_params_no_edit_restrictions({override});
+ override(realm, "realm_can_delete_any_message_group", everyone.id);
+ override(realm, "realm_can_delete_own_message_group", everyone.id);
+ override(realm, "realm_can_move_messages_between_topics_group", everyone.id);
+ override(current_user, "user_id", me.user_id);
+ override(message_parser, "message_has_link_preview", () => true);
+
+ const list = init_message_list();
+ message_lists.set_current(list);
+
+ function preview_message(id, {collapsed, hide_link_previews, is_hidden = false}) {
+ return {
+ id,
+ type: "stream",
+ sender_id: me.user_id,
+ is_hidden,
+ sent_by_me: true,
+ locally_echoed: false,
+ is_stream: true,
+ stream_id: 1,
+ unread: false,
+ collapsed,
+ hide_link_previews,
+ submessages: [],
+ };
+ }
+
+ // Exercise every combination of the collapsed and hide_link_previews
+ // flags on a message that has a website preview, plus one hidden
+ // for a muted sender.
+ add_message_with_view(list, [
+ preview_message(1, {collapsed: false, hide_link_previews: false}),
+ preview_message(2, {collapsed: false, hide_link_previews: true}),
+ preview_message(3, {collapsed: true, hide_link_previews: false}),
+ preview_message(4, {collapsed: true, hide_link_previews: true}),
+ preview_message(5, {collapsed: false, hide_link_previews: false, is_hidden: true}),
+ ]);
+
+ let response = popover_menus_data.get_actions_popover_content_context(1, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, true);
+ assert.equal(response.should_display_show_link_previews, false);
+
+ response = popover_menus_data.get_actions_popover_content_context(2, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, true);
+
+ // Collapsed message: neither toggle is offered, since the preview is
+ // already hidden along with the rest of the body.
+ response = popover_menus_data.get_actions_popover_content_context(3, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, false);
+
+ response = popover_menus_data.get_actions_popover_content_context(4, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, false);
+
+ // A muted sender's hidden message shows a placeholder, not a preview.
+ response = popover_menus_data.get_actions_popover_content_context(5, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, false);
+
+ // A message with no website preview offers neither toggle.
+ override(message_parser, "message_has_link_preview", () => false);
+ response = popover_menus_data.get_actions_popover_content_context(1, {
+ kind: "full_message",
+ hotkeys_agree: true,
+ });
+ assert.equal(response.should_display_hide_link_previews, false);
+ assert.equal(response.should_display_show_link_previews, false);
+});
+
test("not_my_message_view_actions", ({override}) => {
set_page_params_no_edit_restrictions({override});
// Get message that is only viewable