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.

message_viewport: Move window focus tracking from unread_ops.

Pratik Chandadc257d7c3516
diff --git a/web/src/message_viewport.ts b/web/src/message_viewport.ts
index d5fbb43f937..3ef46a8bd2e 100644
--- a/web/src/message_viewport.ts
+++ b/web/src/message_viewport.ts
@@ -5,6 +5,8 @@ import * as blueslip from "./blueslip.ts";
import * as message_lists from "./message_lists.ts";
import * as message_scroll_state from "./message_scroll_state.ts";
import type {Message} from "./message_store.ts";
+import * as modals from "./modals.ts";
+import * as overlays from "./overlays.ts";
import * as rows from "./rows.ts";
import * as util from "./util.ts";
@@ -16,6 +18,14 @@ export type MessageViewportInfo = {
export const $scroll_container = $(":root");
+// When you start Zulip, window_focused should be true, but it might not be the
+// case after a server-initiated reload.
+let window_focused = document.hasFocus();
+
+function is_window_focused(): boolean {
+ return window_focused;
+}
+
let window_resize_handler: () => void;
export function register_resize_handler(handler: () => void): void {
@@ -70,6 +80,18 @@ export function message_viewport_info(): MessageViewportInfo {
};
}
+export function viewport_is_visible_and_focused(): boolean {
+ if (
+ overlays.any_active() ||
+ modals.any_active() ||
+ !is_window_focused() ||
+ $("#message_feed_container").css("display") === "none"
+ ) {
+ return false;
+ }
+ return true;
+}
+
// Important note: These functions just look at the state of the
// rendered message feed; messages that are not displayed due to a
// limited render window or because they have not been fetched from
@@ -605,6 +627,16 @@ export function can_scroll(): boolean {
}
export function initialize(): void {
+ // These handlers must be placed before all focus handlers in our
+ // application that check is_window_focused.
+ $(window)
+ .on("focus", () => {
+ window_focused = true;
+ })
+ .on("blur", () => {
+ window_focused = false;
+ });
+
// This handler must be placed before all resize handlers in our application
$(window).on("resize", () => {
cached_width.reset();
diff --git a/web/src/unread_ops.ts b/web/src/unread_ops.ts
index 99f89caf23b..b8c5877fde2 100644
--- a/web/src/unread_ops.ts
+++ b/web/src/unread_ops.ts
@@ -20,7 +20,6 @@ import type {Message} from "./message_store.ts";
import * as message_store from "./message_store.ts";
import * as message_viewport from "./message_viewport.ts";
import * as modals from "./modals.ts";
-import * as overlays from "./overlays.ts";
import * as people from "./people.ts";
import * as popup_banners from "./popup_banners.ts";
import * as recent_view_ui from "./recent_view_ui.ts";
@@ -56,20 +55,12 @@ const UNREAD_COUNT_STEP_SIZE = 25;
// reporting the failure.
const MAX_UPDATE_READ_FLAGS_RETRIES = 5;
-// When you start Zulip, window_focused should be true, but it might not be the
-// case after a server-initiated reload.
-let window_focused = document.hasFocus();
-
// Since there's a database index on is:unread, it's a fast
// search query and thus worth including here as an optimization.),
const all_unread_messages_narrow: NarrowTerm[] = [
{operator: "is", operand: "unread", negated: false},
];
-export function is_window_focused(): boolean {
- return window_focused;
-}
-
export function confirm_mark_messages_as_read(): void {
const modal_content_html = render_confirm_mark_messages_as_read();
@@ -843,7 +834,7 @@ function process_scrolled_to_bottom(): void {
export function process_visible(): void {
if (
message_lists.current !== undefined &&
- viewport_is_visible_and_focused() &&
+ message_viewport.viewport_is_visible_and_focused() &&
message_viewport.bottom_rendered_message_visible() &&
message_lists.current.view.is_fetched_end_rendered()
) {
@@ -933,28 +924,10 @@ export function mark_pm_as_read(user_ids_string: string): void {
message_flags.mark_as_read(unread_msg_ids);
}
-export function viewport_is_visible_and_focused(): boolean {
- if (
- overlays.any_active() ||
- modals.any_active() ||
- !is_window_focused() ||
- $("#message_feed_container").css("display") === "none"
- ) {
- return false;
- }
- return true;
-}
-
export function initialize(): void {
- $(window)
- .on("focus", () => {
- window_focused = true;
-
- // Update many places on the DOM to reflect unread
- // counts.
- process_visible();
- })
- .on("blur", () => {
- window_focused = false;
- });
+ $(window).on("focus", () => {
+ // Update many places on the DOM to reflect unread
+ // counts.
+ process_visible();
+ });
}
diff --git a/web/tests/compose.test.cjs b/web/tests/compose.test.cjs
index 36ece952713..5cdb1a8dc7a 100644
--- a/web/tests/compose.test.cjs
+++ b/web/tests/compose.test.cjs
@@ -16,6 +16,7 @@ const {page_params} = require("./lib/zpage_params.cjs");
const user_groups = zrequire("user_groups");
set_global("document", {
+ hasFocus: () => true,
querySelector() {},
});
set_global("navigator", {});
diff --git a/web/tests/compose_actions.test.cjs b/web/tests/compose_actions.test.cjs
index a3f35d56d15..7cc44aee8e4 100644
--- a/web/tests/compose_actions.test.cjs
+++ b/web/tests/compose_actions.test.cjs
@@ -44,7 +44,7 @@ const everyone = make_user_group({
});
user_groups.initialize({realm_user_groups: [nobody, everyone]});
-set_global("document", {});
+set_global("document", {hasFocus: () => true});
set_global("requestAnimationFrame", (func) => func());
diff --git a/web/tests/compose_call.test.cjs b/web/tests/compose_call.test.cjs
index 64c22822265..2a8f29beb58 100644
--- a/web/tests/compose_call.test.cjs
+++ b/web/tests/compose_call.test.cjs
@@ -19,6 +19,7 @@ mock_esm("../src/resize", {
watch_manual_resize() {},
});
set_global("document", {
+ hasFocus: () => true,
querySelector() {},
});
set_global("navigator", {});
diff --git a/web/tests/example7.test.cjs b/web/tests/example7.test.cjs
index 4b5327a53d3..181476187d6 100644
--- a/web/tests/example7.test.cjs
+++ b/web/tests/example7.test.cjs
@@ -3,9 +3,8 @@
const assert = require("node:assert/strict");
const {make_stream} = require("./lib/example_stream.cjs");
-const {mock_esm, set_global, zrequire} = require("./lib/namespace.cjs");
+const {mock_esm, zrequire} = require("./lib/namespace.cjs");
const {run_test, noop} = require("./lib/test.cjs");
-const {$} = require("./lib/zjquery.cjs");
/*
@@ -51,8 +50,6 @@ const {$} = require("./lib/zjquery.cjs");
value.)
*/
-set_global("document", {hasFocus: () => true});
-
const channel = mock_esm("../src/channel");
const desktop_notifications = mock_esm("../src/desktop_notifications");
const message_lists = mock_esm("../src/message_lists");
@@ -101,7 +98,7 @@ run_test("unread_ops", ({override}) => {
unread.process_loaded_messages(test_messages);
// Make our message_viewport appear visible.
- $("#message_feed_container").show();
+ override(message_viewport, "viewport_is_visible_and_focused", () => true);
// Make our "test" message appear visible.
override(message_viewport, "bottom_rendered_message_visible", () => true);
diff --git a/web/tests/message_flags.test.cjs b/web/tests/message_flags.test.cjs
index f67346fe205..3794684a3bd 100644
--- a/web/tests/message_flags.test.cjs
+++ b/web/tests/message_flags.test.cjs
@@ -2,14 +2,12 @@
const assert = require("node:assert/strict");
-const {clock, mock_esm, set_global, with_overrides, zrequire} = require("./lib/namespace.cjs");
+const {clock, mock_esm, with_overrides, zrequire} = require("./lib/namespace.cjs");
const {run_test} = require("./lib/test.cjs");
const channel = mock_esm("../src/channel");
const message_live_update = mock_esm("../src/message_live_update");
-set_global("document", {hasFocus: () => true});
-
mock_esm("../src/starred_messages", {
add() {},
get_count: () => 5,
diff --git a/web/tests/unread_ops.test.cjs b/web/tests/unread_ops.test.cjs
index 37c74bff816..8b332122213 100644
--- a/web/tests/unread_ops.test.cjs
+++ b/web/tests/unread_ops.test.cjs
@@ -2,10 +2,9 @@
const assert = require("node:assert/strict");
-const {set_global, zrequire} = require("./lib/namespace.cjs");
+const {zrequire} = require("./lib/namespace.cjs");
const {run_test} = require("./lib/test.cjs");
-set_global("document", {hasFocus: () => true});
const unread = zrequire("unread");
const unread_ops = zrequire("unread_ops");