Support (un)resolving topics #1544

rsashank · 2024-09-05T23:11:04Z

What does this PR do, and why?

This PR adds support for (un)resolving topics in ZT via TopicInfoView popup menu when topic is highlighted in left_stream_bar and i key is pressed to toggle topic settings.

Changes with respect to completion candidate PR:

Added support beyond ZFL 183:
Before Zulip 7.0 (feature level 183), the realm_community_topic_editing_limit_seconds property was returned by the response. It was removed because it had not been in use since the realm setting move_messages_within_stream_limit_seconds was introduced in feature level 162.
Changes to tests
Dropped the first commit

External discussion & connections

Discussed in #zulip-terminal in Support (un)resolving topics #T1235 (fix #T1075)
Fully fixes Support (un)resolving topics #1075
Partially fixes issue #
Builds upon previous unmerged work in PR Add support for (un)resolving topics in ZT. #1235
Is a follow-up to work in PR #
Requires merge of PR #
Merge will enable work on #

How did you test this?

Manually - Behavioral changes
Manually - Visual changes
Adapting existing automated tests
Adding automated tests for new behavior (or missing tests)
Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

It is a minimal coherent idea
It has a commit summary following the documented style (title & body)
It has a commit summary describing the motivation and reasoning for the change
It individually passes linting and tests
It contains test additions for any new behavior
It flows clearly from a previous branch commit, and/or prepares for the next commit

Visual changes

The function calls get_latest_message_in_topic to fetch recent message in topic to be (un)resolved. It verifies user and editing conditions using can_user_edit_topic function and finally add or remove RESOLVED_TOPIC_PREFIX from topic name. Fixes zulip#1075. Co-authored-by: Shivam Deotarse <[email protected]>

Tests added. Co-authored-by: Shivam Deotarse <[email protected]>

Co-authored-by: Shivam Deotarse <[email protected]>

Fixes zulip#1075. Co-authored-by: Shivam Deotarse <[email protected]>

neiljp

@rsashank Thanks for the followup 👍

I may have had a few more thoughts, but wanted to get these comments to you before I go to bed :)

Re co-authoring, please note that

Shivam's email doesn't appear to match his original commits
some commits look entirely to be his with no additions; can you cherry-pick those from the original PR instead to indicate that?

neiljp · 2024-09-07T22:26:33Z

zulipterminal/model.py

+        if self.can_user_edit_topic():
+            latest_msg = self.get_latest_message_in_topic(stream_id, topic_name)
+            if latest_msg:
+                time_since_msg_sent = time.time() - latest_msg["timestamp"]
+                # ZFL < 11, community_topic_editing_limit_seconds
+                # was hardcoded as int value in secs eg. 86400s (1 day) or None
+                if 11 <= self.server_feature_level < 162:


To reduce the level of nesting here, consider the matching else blocks for these early conditionals - they're basically error conditions (and we're not handling them, right now!)

In these cases, exiting early after performing those checks means the rest of the function knows it's in a good state and can continue. In terms of indenting, the current indented sections can then become an 'else' but at a non-indented level. (The absence of error handling then becomes fairly obvious too!)

neiljp · 2024-09-07T22:27:03Z

zulipterminal/model.py

+                # ZFL >= 162, realm_move_messages_within_stream_limit_seconds was
+                # introduced in place of realm_community_topic_editing_limit_seconds
+                elif self.server_feature_level >= 162:
+                    edit_time_limit = self.initial_data.get(
+                        "realm_move_messages_within_stream_limit_seconds", None
+                    )
+                else:


This is the new section, and the matching new test case, compared to the previous PR?

neiljp · 2024-09-07T22:35:58Z

tests/model/test_model.py

+        initial_data[
+            "realm_community_topic_editing_limit_seconds"
+        ] = topic_editing_limit_seconds
+        initial_data[
+            "realm_move_messages_within_stream_limit_seconds"
+        ] = move_messages_within_stream_limit_seconds


Strictly this doesn't cover the ZFL 183+ (Zulip 7) situation, where the first of these parameters was removed?

We could treat the two parameters as a patch to initial data via a dict, but unfortunately that then leaves assumptions as to whether the two values are in initial_data, ie. for later versions we strictly want to remove the field.

neiljp · 2024-09-07T22:39:45Z

zulipterminal/model.py

+                # ZFL < 11, community_topic_editing_limit_seconds
+                # was hardcoded as int value in secs eg. 86400s (1 day) or None


This comment seems a little out of position relative to the code? I'd consider reordering the conditional to start with the new maximum, and leave the <11 case to the end with this comment?

neiljp · 2024-09-08T18:25:06Z

tests/model/test_model.py

+        model.get_latest_message_in_topic = mocker.Mock(
+            return_value={
+                "subject": topic_name,
+                "timestamp": timestamp,


This suggests the timestamp in the test should be a latest_message_timestamp, to make the field clearer?

The subject/topic is for the entire topic already, so that's clear enough.

neiljp · 2024-09-08T23:20:46Z

zulipterminal/ui_tools/views.py

+        )
+
+        if self.topic_name.startswith(RESOLVED_TOPIC_PREFIX):
+            self.resolve_topic_setting_btn_lbl = "Unresolve Topic"


I know this was from the previous PR, but let's use button_label in the expanded form.

neiljp · 2024-09-08T23:29:00Z

tests/ui_tools/test_popups.py

+    def test_toggle_resolve_status(self) -> None:
+        resolve_button = self.topic_info_view.widgets[-1]
+        resolve_button._emit("click")
+
+        self.controller.model.toggle_topic_resolve_status.assert_called_once_with(
+            stream_id=self.stream_id, topic_name=self.topic
+        )
+
+        self.controller.exit_popup.assert_called_once()


It looks like you added this extra test, and the one above this?

I'm not sure about using _emit here, at least compared to our normal use of keypress, but that should be fine - what inspired _emit?

neiljp · 2024-09-09T05:18:40Z

zulipterminal/config/keys.py

@@ -312,6 +312,11 @@ class KeyBinding(TypedDict):
        'help_text': 'Show/hide stream information & modify settings',
        'key_category': 'stream_list',
    },
+    'TOPIC_INFO': {
+        'keys': ['i'],
+        'help_text': 'Show/hide topic information & modify settings',


This is only useful for this feature right now, so perhaps we should update this slightly to mention updating the resolve status.

neiljp · 2024-09-09T05:18:58Z

zulipterminal/config/keys.py

@@ -467,6 +472,7 @@ class KeyBinding(TypedDict):
    "msg_actions": "Message actions",
    "stream_list": "Stream list actions",
    "user_list": "User list actions",
+    "topic_actions": "Topic actions",


Topic list actions?

neiljp · 2024-09-09T05:22:39Z

zulipterminal/ui_tools/views.py

+        )
+
+        self.widgets.append(resolve_topic_setting)
+        super().__init__(controller, self.widgets, "TOPIC_INFO", popup_width, title)


This TOPIC_INFO has no meaning here yet. Not sure of the ordering; let's leave it for now.

zulipbot added the size: XL [Automatic label added by zulipbot] label Sep 5, 2024

rsashank force-pushed the un-resolve-topics branch 2 times, most recently from 6e7c245 to fb82ade Compare September 5, 2024 23:21

rsashank and others added 6 commits September 6, 2024 05:00

views: Add TopicInfoView to show pop up menu to change topic settings.

2242552

Tests added. Co-authored-by: Shivam Deotarse <[email protected]>

themes: Add 'area:topic' style for topic info popup menu.

5630d9e

Co-authored-by: Shivam Deotarse <[email protected]>

core: Add show_topic_info function to show TopicInfoView pop up menu.

b84dda6

Co-authored-by: Shivam Deotarse <[email protected]>

keys: Add TOPIC_INFO shortcut using 'i' key to show/hide topic settings.

81c8f93

Co-authored-by: Shivam Deotarse <[email protected]>

buttons: Add TOPIC_INFO shortcut to TopicButton.

a570d28

Fixes zulip#1075. Co-authored-by: Shivam Deotarse <[email protected]>

rsashank force-pushed the un-resolve-topics branch from fb82ade to a570d28 Compare September 5, 2024 23:31

rsashank mentioned this pull request Sep 6, 2024

Add linting for HELP_CATEGORIES #1545

Closed

18 tasks

neiljp reviewed Sep 9, 2024

View reviewed changes

neiljp added PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback version parity: 5 labels Sep 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support (un)resolving topics #1544

Support (un)resolving topics #1544

rsashank commented Sep 5, 2024 •

edited

Loading

neiljp left a comment

neiljp Sep 7, 2024

neiljp Sep 7, 2024

neiljp Sep 7, 2024

neiljp Sep 7, 2024

neiljp Sep 8, 2024

neiljp Sep 8, 2024

neiljp Sep 8, 2024

neiljp Sep 9, 2024

neiljp Sep 9, 2024

neiljp Sep 9, 2024

		# ZFL < 11, community_topic_editing_limit_seconds
		# was hardcoded as int value in secs eg. 86400s (1 day) or None

Support (un)resolving topics #1544

Are you sure you want to change the base?

Support (un)resolving topics #1544

Conversation

rsashank commented Sep 5, 2024 • edited Loading

What does this PR do, and why?

External discussion & connections

How did you test this?

Self-review checklist for each commit

Visual changes

neiljp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rsashank commented Sep 5, 2024 •

edited

Loading