Update mark as read stream and topic to use `/messages/flags/narrow` endpoint. #27372

laurynmm · 2023-10-25T15:27:19Z

As part of deprecating legacy unread endpoints (#23598), the web-app frontend code for marking a stream and topic as read should be updated to use the new /messages/flags/narrow endpoint.

Current use of legacy unread endpoints in unread_ops.js, CODE LINK

export function mark_stream_as_read(stream_id, cont) {
    channel.post({
        url: "/json/mark_stream_as_read",
        data: {stream_id},
        success: cont,
    });
}

export function mark_topic_as_read(stream_id, topic, cont) {
    channel.post({
        url: "/json/mark_topic_as_read",
        data: {stream_id, topic_name: topic},
        success: cont,
    });
}

It likely makes sense to reuse/refactor some of the work done for mark_as_unread_from_here to use the new endpoint (see this commit) for these functions.

CZO thread

The text was updated successfully, but these errors were encountered:

zulipbot · 2023-10-25T15:27:21Z

Hello @zulip/server-refactoring members, this issue was labeled with the "area: refactoring" label, so you may want to check it out!

lata-11 · 2023-10-27T11:32:49Z

@zulipbot claim

zulipbot · 2023-10-27T11:32:50Z

Welcome to Zulip, @lata-11! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

Join me on the Zulip developers' server, to get help, chat about this issue, and meet the other developers.
Unwatch this repository, so that you don't get 100 emails a day.

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

zulipbot · 2023-10-29T19:54:58Z

@marco-zan This issue cannot be claimed, as someone else is already working on it. Please see our contributor guide for advice on finding an issue to work on. Thanks!

marco-zan · 2023-10-30T10:11:35Z

Hi @lata-11 sorry to bother you. Speaking on the zulip-chat related thread with the founders i found out how to resolve this issue and actually started working. In fact i am ready to do the first commit to fix the mark stream as read function. If you didn't start working on it yet, can i please claim it?

lata-11 · 2023-10-30T11:10:21Z

Hi @marco-zan, I am still trying to figure out but it seems you had already figured it out. So you can claim it.

lata-11 · 2023-10-30T11:11:00Z

@zulipbot abandon

marco-zan · 2023-10-30T11:13:37Z

Thank you

marco-zan · 2023-10-30T11:13:45Z

@zulipbot claim

The code is heavly inspired by the mark_all_as_read function on the same file and so gains the batch and ui reporting features Partially fixes zulip#27372

Change discussed on the PR, avoids code duplication to mark many messages as read using a narrow and an anchor. The cont attribute is eliminated because it was never used fixes zulip#27372

The code is simple by using mark_bulk_as_read, similarly to mark_stream_as_read but by changing the narrow to also use the topic name. The cont parameter is also removed because it was never used Fixes zulip#27372

zulipbot · 2023-11-24T15:49:10Z

@marco-zan You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!

shubham-padia · 2024-01-13T11:55:29Z

@zulipbot claim

Fixes zulip#27372. This commit refactors mark_all_as_read in unread_ops to mark_stream_topic_or_all_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. I did not create a new function for this task since a lot of the code would have been shared with mark_all_as_read

Fixes zulip#27372. This commit refactors mark_all_as_read in unread_ops to mark_stream_topic_or_all_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. I did not create a new function for this task since a lot of the code would have been shared with mark_all_as_read mark_stream_topic_or_all_as_read will mark all messages as read if no type is provided.

Fixes zulip#27372. This commit refactors the original mark_all_as_read in unread_ops to mark_stream_topic_or_all_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. I did not create a new function for this task since a lot of the code would have been shared with mark_all_as_read

Fixes zulip#27372. This commit refactors the original mark_all_as_read in unread_ops to mark_bulk_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. I did not create a new function for this task since a lot of the code would have been shared with mark_all_as_read

Fixes zulip#27372. This commit refactors the original mark_all_as_read in unread_ops to bulk_mark_mesages_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. I did not create a new function for this task since a lot of the code would have been shared with mark_all_as_read

This commit refactors the original mark_all_as_read in unread_ops to bulk_mark_mesages_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. Fixes zulip#27372.

This commit refactors the original mark_all_as_read in unread_ops to bulk_mark_mesages_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. Fixes #27372.

This commit refactors the original mark_all_as_read in unread_ops to bulk_mark_mesages_as_read to include marking stream/topic as read. The unread_ops API reamins the same to mark stream/topic as read but the underlying implementation now uses a different endpoint. A new function mark_all_as_read has been added so that the unread_ops API remains the same. Fixes zulip#27372.

laurynmm added the area: refactoring label Oct 25, 2023

laurynmm mentioned this issue Oct 26, 2023

Deprecate and remove legacy unread endpoints #23598

Open

laurynmm added the help wanted label Oct 26, 2023

zulipbot assigned lata-11 Oct 27, 2023

zulipbot added the in progress label Oct 27, 2023

zulipbot unassigned lata-11 Oct 30, 2023

zulipbot removed the in progress label Oct 30, 2023

zulipbot assigned marco-zan Oct 30, 2023

zulipbot added the in progress label Oct 30, 2023

marco-zan mentioned this issue Oct 30, 2023

Update the mark_stream_as_read and mark_topic_as_read to use the new api #27441

Closed

12 tasks

zulipbot unassigned marco-zan Nov 28, 2023

zulipbot removed the in progress label Nov 28, 2023

zulipbot assigned shubham-padia Jan 13, 2024

zulipbot added the in progress label Jan 13, 2024

shubham-padia mentioned this issue Jan 13, 2024

unread_ops: Use /messages/flags/narrow to mark stream/topic as read. #28560

Merged

12 tasks

timabbott closed this as completed in #28560 Jan 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update mark as read stream and topic to use `/messages/flags/narrow` endpoint. #27372

Update mark as read stream and topic to use `/messages/flags/narrow` endpoint. #27372

laurynmm commented Oct 25, 2023

zulipbot commented Oct 25, 2023

lata-11 commented Oct 27, 2023

zulipbot commented Oct 27, 2023

zulipbot commented Oct 29, 2023

marco-zan commented Oct 30, 2023

lata-11 commented Oct 30, 2023

lata-11 commented Oct 30, 2023

marco-zan commented Oct 30, 2023

marco-zan commented Oct 30, 2023

zulipbot commented Nov 24, 2023 •

edited

shubham-padia commented Jan 13, 2024

Update mark as read stream and topic to use /messages/flags/narrow endpoint. #27372

Update mark as read stream and topic to use /messages/flags/narrow endpoint. #27372

Comments

laurynmm commented Oct 25, 2023

zulipbot commented Oct 25, 2023

lata-11 commented Oct 27, 2023

zulipbot commented Oct 27, 2023

zulipbot commented Oct 29, 2023

marco-zan commented Oct 30, 2023

lata-11 commented Oct 30, 2023

lata-11 commented Oct 30, 2023

marco-zan commented Oct 30, 2023

marco-zan commented Oct 30, 2023

zulipbot commented Nov 24, 2023 • edited

shubham-padia commented Jan 13, 2024

Update mark as read stream and topic to use `/messages/flags/narrow` endpoint. #27372

Update mark as read stream and topic to use `/messages/flags/narrow` endpoint. #27372

zulipbot commented Nov 24, 2023 •

edited