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: Ignore failed preview renders that are stale.

Aman Agrawal147ca0186fff
diff --git a/web/src/compose_ui.ts b/web/src/compose_ui.ts
index d36fdf02e2c..4bf7707a260 100644
--- a/web/src/compose_ui.ts
+++ b/web/src/compose_ui.ts
@@ -1757,6 +1757,12 @@ export function render_and_show_preview(
}
const preview_render_count = increment_preview_render_count($preview_container);
+ function response_is_stale(): boolean {
+ return (
+ preview_render_count !== get_preview_render_count($preview_container) ||
+ !$preview_container.hasClass("preview_mode")
+ );
+ }
if (content.length === 0) {
apply_preview_render(
@@ -1784,10 +1790,7 @@ export function render_and_show_preview(
url: "/json/messages/render",
data: {content},
success(response_data) {
- if (
- preview_render_count !== get_preview_render_count($preview_container) ||
- !$preview_container.hasClass("preview_mode")
- ) {
+ if (response_is_stale()) {
// The user is no longer in preview mode or the compose
// input has already been updated with new raw Markdown
// since this rendering request was sent off to the server, so
@@ -1798,6 +1801,9 @@ export function render_and_show_preview(
apply_server_preview_render($preview_container, content, data.rendered);
},
error() {
+ if (response_is_stale()) {
+ return;
+ }
apply_preview_render(
$preview_container,
content,
diff --git a/web/tests/compose_ui.test.cjs b/web/tests/compose_ui.test.cjs
index 00ee7b7a7d6..4ebe9bf866e 100644
--- a/web/tests/compose_ui.test.cjs
+++ b/web/tests/compose_ui.test.cjs
@@ -1635,6 +1635,30 @@ run_test("render response superseded by a newer render is discarded", ({override
assert.equal(preview.$preview_content.html(), "<p>second</p>");
});
+run_test("failed render 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.error();
+ assert.equal(preview.$preview_content.html(), "<p>second</p>");
+});
+
+run_test("failed render after leaving preview mode is discarded", ({override}) => {
+ override(loading, "make_indicator", noop);
+ const preview = make_open_preview("#compose");
+
+ const request = start_render(override, preview);
+ preview.$container.removeClass("preview_mode");
+ preview.$preview_content.html("");
+ request.error();
+ assert.equal(preview.$preview_content.html(), "");
+});
+
run_test("render of one preview leaves another's render alone", ({override}) => {
override(rendered_markdown, "update_elements", noop);
override(loading, "make_indicator", noop);