unread: Use some clearer variable names.

This commit is contained in:
evykassirer
2023-12-12 16:45:18 -08:00
committed by Tim Abbott
parent 39936972f7
commit 5c9bb51c5b
5 changed files with 15 additions and 15 deletions

View File

@@ -453,7 +453,7 @@ function reset_data() {
let has_topics_post_filter = false; let has_topics_post_filter = false;
if (unread_stream_msg_count) { if (unread_stream_msg_count) {
for (const [stream_id, topic_dict] of unread_streams_dict) { for (const [stream_id, topic_dict] of unread_streams_dict) {
const stream_unread = unread.num_unread_for_stream(stream_id); const stream_unread = unread.unread_count_info_for_stream(stream_id);
const stream_unread_count = stream_unread.unmuted_count + stream_unread.muted_count; const stream_unread_count = stream_unread.unmuted_count + stream_unread.muted_count;
const stream_key = get_stream_key(stream_id); const stream_key = get_stream_key(stream_id);
if (stream_unread_count > 0) { if (stream_unread_count > 0) {
@@ -1019,7 +1019,7 @@ export function update() {
let has_topics_post_filter = false; let has_topics_post_filter = false;
for (const [stream_id, topic_dict] of unread_streams_dict) { for (const [stream_id, topic_dict] of unread_streams_dict) {
const stream_unread = unread.num_unread_for_stream(stream_id); const stream_unread = unread.unread_count_info_for_stream(stream_id);
const stream_unread_count = stream_unread.unmuted_count + stream_unread.muted_count; const stream_unread_count = stream_unread.unmuted_count + stream_unread.muted_count;
const stream_key = get_stream_key(stream_id); const stream_key = get_stream_key(stream_id);
let stream_post_filter_unread_count = 0; let stream_post_filter_unread_count = 0;

View File

@@ -469,7 +469,7 @@ class StreamSidebarRow {
} }
update_unread_count() { update_unread_count() {
const count = unread.num_unread_for_stream(this.sub.stream_id); const count = unread.unread_count_info_for_stream(this.sub.stream_id);
const stream_has_any_unread_mention_messages = unread.stream_has_any_unread_mentions( const stream_has_any_unread_mention_messages = unread.stream_has_any_unread_mentions(
this.sub.stream_id, this.sub.stream_id,
); );

View File

@@ -307,7 +307,7 @@ class UnreadTopicCounter {
// get_stream_count calculates both the number of // get_stream_count calculates both the number of
// unmuted unread as well as the number of muted // unmuted unread as well as the number of muted
// unreads. // unreads.
res.stream_count.set(stream_id, this.get_stream_count(stream_id)); res.stream_count.set(stream_id, this.get_stream_count_info(stream_id));
res.stream_unread_messages += res.stream_count.get(stream_id).unmuted_count; res.stream_unread_messages += res.stream_count.get(stream_id).unmuted_count;
res.followed_topic_unread_messages += res.followed_topic_unread_messages +=
res.stream_count.get(stream_id).followed_count; res.stream_count.get(stream_id).followed_count;
@@ -358,7 +358,7 @@ class UnreadTopicCounter {
return result; return result;
} }
get_stream_count(stream_id) { get_stream_count_info(stream_id) {
const per_stream_bucketer = this.bucketer.get_bucket(stream_id); const per_stream_bucketer = this.bucketer.get_bucket(stream_id);
if (!per_stream_bucketer) { if (!per_stream_bucketer) {
@@ -896,8 +896,8 @@ export function get_notifiable_count() {
return calculate_notifiable_count(res); return calculate_notifiable_count(res);
} }
export function num_unread_for_stream(stream_id) { export function unread_count_info_for_stream(stream_id) {
return unread_topic_counter.get_stream_count(stream_id); return unread_topic_counter.get_stream_count_info(stream_id);
} }
export function num_unread_for_topic(stream_id, topic_name) { export function num_unread_for_topic(stream_id, topic_name) {

View File

@@ -13,7 +13,7 @@ page_params.is_admin = false;
page_params.realm_users = []; page_params.realm_users = [];
// We use this with override. // We use this with override.
let num_unread_for_stream; let unread_unmuted_count;
let stream_has_any_unread_mentions; let stream_has_any_unread_mentions;
mock_esm("../src/narrow_state", { mock_esm("../src/narrow_state", {
@@ -25,8 +25,8 @@ const scroll_util = mock_esm("../src/scroll_util", {
get_scroll_element: ($element) => $element, get_scroll_element: ($element) => $element,
}); });
mock_esm("../src/unread", { mock_esm("../src/unread", {
num_unread_for_stream: () => ({ unread_count_info_for_stream: () => ({
unmuted_count: num_unread_for_stream, unmuted_count: unread_unmuted_count,
stream_is_muted: false, stream_is_muted: false,
muted_count: 0, muted_count: 0,
}), }),
@@ -75,7 +75,7 @@ function create_devel_sidebar_row({mock_template}) {
return "<devel-sidebar-row-stub>"; return "<devel-sidebar-row-stub>";
}); });
num_unread_for_stream = 42; unread_unmuted_count = 42;
stream_has_any_unread_mentions = false; stream_has_any_unread_mentions = false;
stream_list.create_sidebar_row(devel); stream_list.create_sidebar_row(devel);
assert.equal($devel_count.text(), "42"); assert.equal($devel_count.text(), "42");
@@ -98,7 +98,7 @@ function create_social_sidebar_row({mock_template}) {
return "<social-sidebar-row-stub>"; return "<social-sidebar-row-stub>";
}); });
num_unread_for_stream = 99; unread_unmuted_count = 99;
stream_has_any_unread_mentions = true; stream_has_any_unread_mentions = true;
stream_list.create_sidebar_row(social); stream_list.create_sidebar_row(social);
assert.equal($social_count.text(), "99"); assert.equal($social_count.text(), "99");

View File

@@ -239,7 +239,7 @@ test("muting", () => {
let counts = unread.get_counts(); let counts = unread.get_counts();
assert.equal(counts.stream_count.get(stream_id).unmuted_count, 1); assert.equal(counts.stream_count.get(stream_id).unmuted_count, 1);
assert.equal(counts.home_unread_messages, 1); assert.equal(counts.home_unread_messages, 1);
assert.equal(unread.num_unread_for_stream(stream_id).unmuted_count, 1); assert.equal(unread.unread_count_info_for_stream(stream_id).unmuted_count, 1);
assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), [message.id]); assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), [message.id]);
test_notifiable_count(counts.home_unread_messages, 0); test_notifiable_count(counts.home_unread_messages, 0);
@@ -251,14 +251,14 @@ test("muting", () => {
counts = unread.get_counts(); counts = unread.get_counts();
assert.equal(counts.stream_count.get(stream_id).unmuted_count, 0); assert.equal(counts.stream_count.get(stream_id).unmuted_count, 0);
assert.equal(counts.home_unread_messages, 0); assert.equal(counts.home_unread_messages, 0);
assert.equal(unread.num_unread_for_stream(stream_id).unmuted_count, 0); assert.equal(unread.unread_count_info_for_stream(stream_id).unmuted_count, 0);
assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), []); assert.deepEqual(unread.get_msg_ids_for_stream(stream_id), []);
test_notifiable_count(counts.home_unread_messages, 0); test_notifiable_count(counts.home_unread_messages, 0);
// we still find the message id here (muting is ignored) // we still find the message id here (muting is ignored)
assert.deepEqual(unread.get_all_msg_ids(), [message.id]); assert.deepEqual(unread.get_all_msg_ids(), [message.id]);
assert.equal(unread.num_unread_for_stream(unknown_stream_id), 0); assert.equal(unread.unread_count_info_for_stream(unknown_stream_id), 0);
}); });
test("num_unread_for_topic", () => { test("num_unread_for_topic", () => {