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.

compose: Track preview render counts per preview.

Aman Agrawal2d5491cb03c1
diff --git a/web/src/compose_state.ts b/web/src/compose_state.ts
index 6e2ab11ac77..ca04e0da1a0 100644
--- a/web/src/compose_state.ts
+++ b/web/src/compose_state.ts
@@ -8,7 +8,6 @@ let message_type: "stream" | "private" | undefined;
let recipient_edited_manually = false;
let is_content_unedited_restored_draft = false;
let last_focused_compose_type_input: HTMLTextAreaElement | undefined;
-let preview_render_count = 0;
let is_processing_forward_message = false;
// We use this variable to keep track of whether user has viewed the topic resolved
@@ -77,14 +76,6 @@ export function get_recipient_guest_ids_for_dm_warning(): number[] {
return recipient_guest_ids_for_dm_warning;
}
-export function get_preview_render_count(): number {
- return preview_render_count;
-}
-
-export function set_preview_render_count(count: number): void {
- preview_render_count = count;
-}
-
export function set_is_processing_forward_message(val: boolean): void {
is_processing_forward_message = val;
}
diff --git a/web/src/compose_ui.ts b/web/src/compose_ui.ts
index fa032a05dd2..1b571c5d8d5 100644
--- a/web/src/compose_ui.ts
+++ b/web/src/compose_ui.ts
@@ -17,7 +17,6 @@ import type {Typeahead} from "./bootstrap_typeahead.ts";
import * as bulleted_numbered_list_util from "./bulleted_numbered_list_util.ts";
import * as channel from "./channel.ts";
import * as common from "./common.ts";
-import * as compose_state from "./compose_state.ts";
import type {TypeaheadSuggestion} from "./composebox_typeahead.ts";
import {$t, $t_html} from "./i18n.ts";
import * as linkifiers from "./linkifiers.ts";
@@ -1735,6 +1734,18 @@ function apply_server_preview_render(
apply_preview_render($preview_container, content, rendered_preview_html);
}
+const preview_render_counts = new WeakMap<HTMLElement, number>();
+
+function get_preview_render_count($preview_container: JQuery): number {
+ return preview_render_counts.get(util.the($preview_container)) ?? 0;
+}
+
+function increment_preview_render_count($preview_container: JQuery): number {
+ const preview_render_count = get_preview_render_count($preview_container) + 1;
+ preview_render_counts.set(util.the($preview_container), preview_render_count);
+ return preview_render_count;
+}
+
export function render_and_show_preview(
$preview_container: JQuery,
content: string,
@@ -1745,8 +1756,7 @@ export function render_and_show_preview(
show_spinner = false;
}
- const preview_render_count = compose_state.get_preview_render_count() + 1;
- compose_state.set_preview_render_count(preview_render_count);
+ const preview_render_count = increment_preview_render_count($preview_container);
if (content.length === 0) {
apply_preview_render(
@@ -1775,7 +1785,7 @@ export function render_and_show_preview(
data: {content},
success(response_data) {
if (
- preview_render_count !== compose_state.get_preview_render_count() ||
+ preview_render_count !== get_preview_render_count($preview_container) ||
!$preview_container.hasClass("preview_mode")
) {
// The user is no longer in preview mode or the compose
diff --git a/web/tests/compose_ui.test.cjs b/web/tests/compose_ui.test.cjs
index c4ce05f0301..e6dc2a3228f 100644
--- a/web/tests/compose_ui.test.cjs
+++ b/web/tests/compose_ui.test.cjs
@@ -24,6 +24,10 @@ mock_esm("../src/message_lists", {
current: {},
});
+const rendered_markdown = mock_esm("../src/rendered_markdown");
+const channel = mock_esm("../src/channel");
+const loading = mock_esm("../src/loading");
+
const compose_ui = zrequire("compose_ui");
const linkifiers = zrequire("linkifiers");
const stream_data = zrequire("stream_data");
@@ -1592,3 +1596,54 @@ run_test("maybe_set_compose_textarea_typeahead ignores edit box typeaheads", ()
compose_ui.maybe_set_compose_textarea_typeahead(edit_typeahead);
assert.equal(compose_ui.compose_textarea_typeahead, compose_typeahead);
});
+
+function make_open_preview(selector) {
+ const $container = $(selector);
+ const $spinner = $(`${selector} .markdown_preview_spinner`);
+ const $preview_content = $(`${selector} .preview_content`);
+ $preview_content.set_find_results(
+ ".image-loading-placeholder",
+ $.create(`${selector} no thumbnails`, {elements: []}),
+ );
+ $container.set_find_results(".markdown_preview_spinner", $spinner);
+ $container.set_find_results(".preview_content", $preview_content);
+ $container.addClass("preview_mode");
+ return {$container, $preview_content};
+}
+
+const backend_only_content = "@**topic** draft";
+
+function start_render(override, preview) {
+ let request;
+ override(channel, "post", (payload) => {
+ request = payload;
+ });
+ compose_ui.render_and_show_preview(preview.$container, backend_only_content);
+ return request;
+}
+
+run_test("render response superseded by a newer render is discarded", ({override}) => {
+ override(rendered_markdown, "update_elements", noop);
+ override(loading, "make_indicator", noop);
+ override(loading, "destroy_indicator", noop);
+ const preview = make_open_preview("#compose");
+
+ const first_request = start_render(override, preview);
+ const second_request = start_render(override, preview);
+ second_request.success({msg: "", result: "success", rendered: "<p>second</p>"});
+ first_request.success({msg: "", result: "success", rendered: "<p>first</p>"});
+ assert.equal(preview.$preview_content.html(), "<p>second</p>");
+});
+
+run_test("render of one preview leaves another's render alone", ({override}) => {
+ override(rendered_markdown, "update_elements", noop);
+ override(loading, "make_indicator", noop);
+ override(loading, "destroy_indicator", noop);
+ const compose_preview = make_open_preview("#compose");
+ const edit_preview = make_open_preview(".message_row");
+
+ const compose_request = start_render(override, compose_preview);
+ start_render(override, edit_preview);
+ compose_request.success({msg: "", result: "success", rendered: "<p>compose</p>"});
+ assert.equal(compose_preview.$preview_content.html(), "<p>compose</p>");
+});