From 6c94266bf9f79f514cb388afa3627e2dc6269d8d Mon Sep 17 00:00:00 2001 From: Vector73 Date: Tue, 5 Aug 2025 08:36:51 +0000 Subject: [PATCH] stream_data: Rename `is_stream_archived` function. Renames `is_stream_archived` function to `is_stream_archived_by_id`. --- web/src/message_delete.ts | 2 +- web/src/message_edit.ts | 6 +++--- web/src/message_list_view.ts | 2 +- web/src/popover_menus_data.ts | 2 +- web/src/stream_data.ts | 4 +++- web/src/stream_list.ts | 2 +- web/tests/message_edit.test.cjs | 4 ++-- web/tests/popover_menus_data.test.cjs | 2 +- web/tests/stream_data.test.cjs | 8 ++++---- web/tests/stream_events.test.cjs | 4 ++-- 10 files changed, 19 insertions(+), 17 deletions(-) diff --git a/web/src/message_delete.ts b/web/src/message_delete.ts index 02da99e5b6..e098060463 100644 --- a/web/src/message_delete.ts +++ b/web/src/message_delete.ts @@ -29,7 +29,7 @@ export function is_message_sent_by_my_bot(message: Message): boolean { } export function get_deletability(message: Message): boolean { - if (message.type === "stream" && stream_data.is_stream_archived(message.stream_id)) { + if (message.type === "stream" && stream_data.is_stream_archived_by_id(message.stream_id)) { return false; } if (settings_data.user_can_delete_any_message()) { diff --git a/web/src/message_edit.ts b/web/src/message_edit.ts index c516b2e01a..c571dbaf94 100644 --- a/web/src/message_edit.ts +++ b/web/src/message_edit.ts @@ -104,7 +104,7 @@ export function is_topic_editable(message: Message, edit_limit_seconds_buffer = return false; } - if (message.type === "stream" && stream_data.is_stream_archived(message.stream_id)) { + if (message.type === "stream" && stream_data.is_stream_archived_by_id(message.stream_id)) { return false; } @@ -192,7 +192,7 @@ export function is_content_editable(message: Message, edit_limit_seconds_buffer return false; } - if (message.type === "stream" && stream_data.is_stream_archived(message.stream_id)) { + if (message.type === "stream" && stream_data.is_stream_archived_by_id(message.stream_id)) { return false; } @@ -228,7 +228,7 @@ export function is_stream_editable(message: Message, edit_limit_seconds_buffer = return false; } - if (message.type === "stream" && stream_data.is_stream_archived(message.stream_id)) { + if (message.type === "stream" && stream_data.is_stream_archived_by_id(message.stream_id)) { return false; } diff --git a/web/src/message_list_view.ts b/web/src/message_list_view.ts index f2fa0b938e..14339a0e58 100644 --- a/web/src/message_list_view.ts +++ b/web/src/message_list_view.ts @@ -383,7 +383,7 @@ function populate_group_from_message( const is_empty_string_topic = topic === ""; const match_topic_html = util.get_match_topic(message); const stream_url = hash_util.channel_url_by_user_setting(message.stream_id); - const is_archived = stream_data.is_stream_archived(message.stream_id); + const is_archived = stream_data.is_stream_archived_by_id(message.stream_id); const topic_url = internal_url.by_stream_topic_url( message.stream_id, message.topic, diff --git a/web/src/popover_menus_data.ts b/web/src/popover_menus_data.ts index 44b74dd575..dd8d989c93 100644 --- a/web/src/popover_menus_data.ts +++ b/web/src/popover_menus_data.ts @@ -232,7 +232,7 @@ export function get_actions_popover_content_context(message_id: number): ActionP !message.is_me_message && !is_add_reaction_icon_visible() && not_spectator && - !(stream_id && stream_data.is_stream_archived(stream_id)); + !(stream_id && stream_data.is_stream_archived_by_id(stream_id)); return { message_id: message.id, diff --git a/web/src/stream_data.ts b/web/src/stream_data.ts index 87e58e4bac..ff75295077 100644 --- a/web/src/stream_data.ts +++ b/web/src/stream_data.ts @@ -939,7 +939,9 @@ export function get_stream_privacy_policy(stream_id: number): string { return settings_config.stream_privacy_policy_values.private_with_public_history.code; } -export function is_stream_archived(stream_id: number): boolean { +export function is_stream_archived_by_id(stream_id: number): boolean { + // If you've already got a channel object, you can just use + // `sub.is_archived` directly instead of calling this function. const sub = sub_store.get(stream_id); return sub ? sub.is_archived : false; } diff --git a/web/src/stream_list.ts b/web/src/stream_list.ts index 5b712d96c1..5b55e2e98b 100644 --- a/web/src/stream_list.ts +++ b/web/src/stream_list.ts @@ -739,7 +739,7 @@ export function get_sidebar_stream_topic_info(filter: Filter): { return result; } - if (!stream_data.is_subscribed(stream_id) || stream_data.is_stream_archived(stream_id)) { + if (!stream_data.is_subscribed(stream_id) || stream_data.is_stream_archived_by_id(stream_id)) { return result; } diff --git a/web/tests/message_edit.test.cjs b/web/tests/message_edit.test.cjs index fa06a4d8c7..f0dd6d7b56 100644 --- a/web/tests/message_edit.test.cjs +++ b/web/tests/message_edit.test.cjs @@ -93,7 +93,7 @@ run_test("is_topic_editable", ({override}) => { type: "stream", }; override(realm, "realm_allow_message_editing", true); - override(stream_data, "is_stream_archived", () => false); + override(stream_data, "is_stream_archived_by_id", () => false); override(stream_data, "user_can_move_messages_within_channel", () => true); override(stream_data, "get_sub_by_id", () => ({})); override(stream_data, "is_empty_topic_only_channel", () => false); @@ -153,7 +153,7 @@ run_test("is_stream_editable", ({override}) => { override(stream_data, "user_can_move_messages_out_of_channel", () => true); override(stream_data, "get_sub_by_id", () => ({})); override(current_user, "is_moderator", true); - override(stream_data, "is_stream_archived", () => false); + override(stream_data, "is_stream_archived_by_id", () => false); assert.equal(message_edit.is_stream_editable(message), false); diff --git a/web/tests/popover_menus_data.test.cjs b/web/tests/popover_menus_data.test.cjs index 9317101a37..440fa34134 100644 --- a/web/tests/popover_menus_data.test.cjs +++ b/web/tests/popover_menus_data.test.cjs @@ -53,7 +53,7 @@ mock_esm("../src/hash_util", { }); mock_esm("../src/stream_data", { is_subscribed: () => true, - is_stream_archived: () => false, + is_stream_archived_by_id: () => false, get_sub_by_id: () => noop, user_can_move_messages_within_channel: () => true, is_empty_topic_only_channel: () => false, diff --git a/web/tests/stream_data.test.cjs b/web/tests/stream_data.test.cjs index 9ab245c86a..603ea4335a 100644 --- a/web/tests/stream_data.test.cjs +++ b/web/tests/stream_data.test.cjs @@ -937,10 +937,10 @@ test("mark_archived", () => { assert.ok(stream_data.is_subscribed(canada.stream_id)); assert.equal(stream_data.get_sub("Canada").stream_id, canada.stream_id); assert.equal(sub_store.get(canada.stream_id).name, "Canada"); - assert.equal(stream_data.is_stream_archived(canada.stream_id), false); + assert.equal(stream_data.is_stream_archived_by_id(canada.stream_id), false); stream_data.mark_archived(canada.stream_id); - assert.ok(stream_data.is_stream_archived(canada.stream_id)); + assert.ok(stream_data.is_stream_archived_by_id(canada.stream_id)); assert.ok(stream_data.is_subscribed(canada.stream_id)); assert.ok(stream_data.get_sub("Canada")); assert.ok(sub_store.get(canada.stream_id)); @@ -960,11 +960,11 @@ test("mark_unarchived", () => { }; stream_data.add_sub(canada); - assert.ok(stream_data.is_stream_archived(canada.stream_id)); + assert.ok(stream_data.is_stream_archived_by_id(canada.stream_id)); assert.ok(stream_data.is_subscribed(canada.stream_id)); stream_data.mark_unarchived(canada.stream_id); - assert.ok(!stream_data.is_stream_archived(canada.stream_id)); + assert.ok(!stream_data.is_stream_archived_by_id(canada.stream_id)); assert.ok(stream_data.is_subscribed(canada.stream_id)); const sub = stream_data.get_sub("Canada"); assert.equal(sub.stream_id, canada.stream_id); diff --git a/web/tests/stream_events.test.cjs b/web/tests/stream_events.test.cjs index 487b0e349a..b0d97cfefa 100644 --- a/web/tests/stream_events.test.cjs +++ b/web/tests/stream_events.test.cjs @@ -388,7 +388,7 @@ test("update_property", ({override}) => { stream_events.update_property(stream_id, "is_archived", true); - assert.ok(stream_data.is_stream_archived(stream_id)); + assert.ok(stream_data.is_stream_archived_by_id(stream_id)); assert.ok(stream_data.is_subscribed(stream_id)); const args = stub.get_args("sub"); @@ -418,7 +418,7 @@ test("update_property", ({override}) => { // Unarchive the stream stream_events.update_property(stream_id, "is_archived", false); - assert.ok(!stream_data.is_stream_archived(stream_id)); + assert.ok(!stream_data.is_stream_archived_by_id(stream_id)); assert.ok(stream_data.is_subscribed(stream_id)); const args = stub.get_args("sub");