invites: Add option to receive direct notification on accepted invitations. #28819

shashank-23002 · 2024-02-04T13:26:02Z

Previously, when a user's invitation to Zulip was accepted, they received a direct message from welcome bot that their invitations has been accepted. However, some users may not want to receive such a message, e.g. because they are already following new user notifications in a stream, or they simply don't need to know when new users join.

Presently , there is an additional personal notification setting using you which you can decide whether you want to receive direct message from welcome bot when an invited user joins.

Fixes: #20398.

Screenshots and screen captures:

When the button is checked -

The notification bot message popped up for test2.

When the button is unchecked -

The notification bot message didn't pop up for test1.

Screen.Recording.2024-02-04.at.6.10.59.PM.mov

Self-review checklist

Self-reviewed the changes for clarity and maintainability
(variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

Explains differences from previous plans (e.g., issue description).
Highlights technical choices and bugs encountered.
Calls out remaining decisions and concerns.
Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

Each commit is a coherent idea.
Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

Visual appearance of the changes.
Responsiveness and internationalization.
Strings and tooltips.
End-to-end functionality of buttons, interactions and flows.
Corner cases, error conditions, and easily imagined bugs.

zulipbot · 2024-02-04T13:26:10Z

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

alya · 2024-02-06T05:59:48Z

As requested in the PR template, please post screenshots of all your changes in the PR description. It is very difficult to review a video.

shashank-23002 · 2024-02-06T06:21:28Z

Yeah sure, I have updated the PR description to add UI changes.
Though , I haven't removed the video so that complete workflow of the changes can be reviewed.

alya · 2024-02-06T07:32:18Z

Thanks! Looking at the screenshots, in the invite modal, let's move the checkbox to be just below the Emails text box. I've updated the issue as well.

alya · 2024-02-06T07:41:51Z

(I also filed #28834 while looking at this PR.)

shashank-23002 · 2024-02-06T08:00:58Z

Sure, I have updated the code as well as created a PR fixing the new issue.

alya · 2024-02-07T02:36:04Z

Thanks! @sahil839 are you up for reviewing this one? I haven't tested.

sahil839

Posted few comments.

zerver/views/invite.py

zerver/actions/invites.py

web/templates/invite_user_modal.hbs

zerver/models/prereg_users.py

shashank-23002 · 2024-02-14T20:06:40Z

@sahil839 I have addressed the previous feedbacks. Hope that works.

sahil839

@shashank-23002 Posted a few comments related to avoiding passing the paramters where we already have a default for now in tests and migration.

Also, you should add a test for checking that the message is not sent when send_notification is false.

zerver/models/prereg_users.py

zerver/migrations/0498_alter_preregistrationuser_send_notification.py

zerver/tests/test_invite.py

zerver/tests/test_auth_backends.py

zerver/tests/test_i18n.py

web/templates/invite_user_modal.hbs

shashank-23002 · 2024-02-18T10:27:57Z

Thanks @sahil839 for the review. I think I have cleaned up the PR.
Though I am not so used to writing new tests for this kind of feature , would be great if you could provide me a little reference to test this.

sahil839

You need to test whether the message was received by the referrer when send_notification is True and not received when send_notification is False for the invite. You can do this by doing an appropriate query like we do here.

You can read the existing tests and then write the test accordingly.

corporate/tests/test_support_views.py

web/templates/invite_user_modal.hbs

zerver/tests/test_invite.py

shashank-23002 · 2024-04-18T18:28:55Z

Thanks @timabbott I hope the present changes might be good to go.

timabbott · 2024-04-19T23:41:31Z

zerver/views/invite.py

@@ -48,6 +48,9 @@ def invite_users_backend(
    request: HttpRequest,
    user_profile: UserProfile,
    invitee_emails_raw: str = REQ("invitee_emails"),
+    notify_referrer_on_join: bool = REQ(
+        "notify_referrer_on_join", json_validator=check_bool, default=True
+    ),


These REQ parameters are sorted; please preserve that, and take care with similar sorted elements elsewhere when adding something to a list of self-similar things.

timabbott · 2024-04-19T23:42:37Z

zerver/openapi/zulip.yaml

+          type: boolean
+          description: |
+            A boolean specifying whether the referrer has opted to receive direct messages
+            from the notification bot when an invited user joins.


All copies of this should have the Changes entry.

timabbott · 2024-04-19T23:50:27Z

zerver/openapi/zulip.yaml

+                    from the notification bot. If `false` the referrer will not receive a notification for
+                    accepted invitations.
+
+                    **Changes**: New in Zulip 9.0 (feature level 254).


"A boolean indicating whether the referrer would like to receive a direct message from Notification Bot a user account is created using this invitation."

You should also add default: true so that information is displayed, and example: false seems more appropriate given that default.

Please post screenshots of the resulting API documentation once you've fixed this up.

This changes entry should include "Previously, referrers always received such direct messages."

timabbott · 2024-04-19T23:51:46Z

zerver/tests/test_invite.py

+        ).last()
+
+        self.assertIsNone(
+            invite_acceptance_notification_message, "Unexpected referrerr message found."


I don't understand this check; "Unexpected referrerr message found." has a pretty weird typo, and also, it seems like it might be possible for the user to have received some unrelated DM previously?

timabbott · 2024-04-19T23:52:19Z

Overall looks decent; posted a few comments on API documentation.

timabbott · 2024-04-23T18:23:27Z

@shashank-23002 ping on resolving the feedback here.

shashank-23002 · 2024-05-15T14:28:17Z

@timabbott PTAL

timabbott · 2024-05-15T20:14:30Z

Cool thanks for bumping this, I'll see if I can review today.

Previously, when a referrer's invitation to Zulip was accepted, they got a notification from notification-bot indicating their invitation has been accepted. This commit adds an option for referrer to decide whether he wants to receive the direct notification from the notification-bot. Fixes: zulip#20398

shashank-23002 · 2024-05-22T21:46:02Z

@timabbott bumping this thread so that this may not lose track.

zulipbot · 2024-05-23T17:45:31Z

Heads up @shashank-23002, we just merged some commits that conflict with the changes you made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/main branch and resolve your pull request's merge conflicts accordingly.

zulipbot added size: L area: notifications (messages) area: onboarding priority: high labels Feb 4, 2024

shashank-23002 force-pushed the issue-20398 branch 3 times, most recently from 5c4280a to 8cd21af Compare February 6, 2024 05:56

shashank-23002 force-pushed the issue-20398 branch from 8cd21af to d3c28b2 Compare February 6, 2024 08:48

alya added the maintainer review PR is ready for review by Zulip maintainers. label Feb 7, 2024

sahil839 reviewed Feb 9, 2024

View reviewed changes

zerver/views/invite.py Outdated Show resolved Hide resolved

zerver/actions/invites.py Outdated Show resolved Hide resolved

web/templates/invite_user_modal.hbs Outdated Show resolved Hide resolved

zerver/models/prereg_users.py Outdated Show resolved Hide resolved

shashank-23002 force-pushed the issue-20398 branch 3 times, most recently from 99aeaaf to 383656e Compare February 14, 2024 19:43

sahil839 reviewed Feb 15, 2024

View reviewed changes

shashank-23002 force-pushed the issue-20398 branch from 383656e to 6ffe643 Compare February 17, 2024 17:37

zulipbot added size: M and removed size: L labels Feb 17, 2024

sahil839 reviewed Feb 19, 2024

View reviewed changes

corporate/tests/test_support_views.py Outdated Show resolved Hide resolved

web/templates/invite_user_modal.hbs Outdated Show resolved Hide resolved

zerver/tests/test_invite.py Outdated Show resolved Hide resolved

shashank-23002 force-pushed the issue-20398 branch from 6ffe643 to c0a19c4 Compare February 19, 2024 17:47

zulipbot added size: L and removed size: M labels Feb 19, 2024

zulipbot removed the has conflicts label Apr 18, 2024

timabbott reviewed Apr 19, 2024

View reviewed changes

zulipbot added the has conflicts label Apr 21, 2024

shashank-23002 force-pushed the issue-20398 branch from fcc24bc to 20382e6 Compare April 23, 2024 20:37

zulipbot removed the has conflicts label Apr 23, 2024

shashank-23002 force-pushed the issue-20398 branch from 20382e6 to 30a22d1 Compare April 23, 2024 21:02

zulipbot added the has conflicts label Apr 24, 2024

shashank-23002 force-pushed the issue-20398 branch from 30a22d1 to ec67786 Compare April 25, 2024 19:59

zulipbot added has conflicts and removed has conflicts labels Apr 25, 2024

timabbott mentioned this pull request May 8, 2024

Add an option for whether to receive a PM when invited users join #24925

Closed

12 tasks

shashank-23002 force-pushed the issue-20398 branch from ec67786 to 63e88aa Compare May 15, 2024 13:08

zulipbot removed the has conflicts label May 15, 2024

shashank-23002 force-pushed the issue-20398 branch from 63e88aa to 056cf78 Compare May 15, 2024 13:32

zulipbot added the has conflicts label May 16, 2024

shashank-23002 force-pushed the issue-20398 branch from 056cf78 to c324534 Compare May 22, 2024 20:01

shashank-23002 force-pushed the issue-20398 branch from c324534 to 715caef Compare May 22, 2024 20:13

zulipbot removed the has conflicts label May 22, 2024

zulipbot added the has conflicts label May 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

invites: Add option to receive direct notification on accepted invitations. #28819

invites: Add option to receive direct notification on accepted invitations. #28819

shashank-23002 commented Feb 4, 2024 •

edited

zulipbot commented Feb 4, 2024

alya commented Feb 6, 2024

shashank-23002 commented Feb 6, 2024

alya commented Feb 6, 2024

alya commented Feb 6, 2024

shashank-23002 commented Feb 6, 2024 •

edited

alya commented Feb 7, 2024

sahil839 left a comment

shashank-23002 commented Feb 14, 2024

sahil839 left a comment

shashank-23002 commented Feb 18, 2024

sahil839 left a comment

shashank-23002 commented Apr 18, 2024

timabbott Apr 19, 2024 •

edited

timabbott Apr 19, 2024

timabbott Apr 19, 2024

timabbott Apr 19, 2024

timabbott commented Apr 19, 2024

timabbott commented Apr 23, 2024

shashank-23002 commented May 15, 2024

timabbott commented May 15, 2024

shashank-23002 commented May 22, 2024

zulipbot commented May 23, 2024

invites: Add option to receive direct notification on accepted invitations. #28819

Are you sure you want to change the base?

invites: Add option to receive direct notification on accepted invitations. #28819

Conversation

shashank-23002 commented Feb 4, 2024 • edited

zulipbot commented Feb 4, 2024

alya commented Feb 6, 2024

shashank-23002 commented Feb 6, 2024

alya commented Feb 6, 2024

alya commented Feb 6, 2024

shashank-23002 commented Feb 6, 2024 • edited

alya commented Feb 7, 2024

sahil839 left a comment

Choose a reason for hiding this comment

shashank-23002 commented Feb 14, 2024

sahil839 left a comment

Choose a reason for hiding this comment

shashank-23002 commented Feb 18, 2024

sahil839 left a comment

Choose a reason for hiding this comment

shashank-23002 commented Apr 18, 2024

timabbott Apr 19, 2024 • edited

Choose a reason for hiding this comment

timabbott Apr 19, 2024

Choose a reason for hiding this comment

timabbott Apr 19, 2024

Choose a reason for hiding this comment

timabbott Apr 19, 2024

Choose a reason for hiding this comment

timabbott commented Apr 19, 2024

timabbott commented Apr 23, 2024

shashank-23002 commented May 15, 2024

timabbott commented May 15, 2024

shashank-23002 commented May 22, 2024

zulipbot commented May 23, 2024

shashank-23002 commented Feb 4, 2024 •

edited

shashank-23002 commented Feb 6, 2024 •

edited

timabbott Apr 19, 2024 •

edited