settings: Add initial implementation for custom welcome bot message. #29452

akarsh-jain-790 · 2024-03-25T19:16:04Z

This commit extends the functionality of the Welcome Bot to include the custom welcome message configured by administrators. It ensures that new users receive the additional custom message along with the standard welcome message upon joining the organization.

Fixes: #27663

Screenshots and screen captures:

Screenshot with Checkbox Unchecked:

Organization settings page with the "Add a custom Welcome Bot message for new users" checkbox unchecked.

Screenshot with Checkbox Checked:

Organization settings page with the "Add a custom Welcome Bot message for new users" checkbox checked.

Save button is disabled when textarea is empty.

When attempting to send a Test Custom Welcome Bot Message with an empty message:

When attempting to send a Test Custom Welcome Bot Message with a message:

Screenshot with Custom Welcome Bot Message Included:

Screenshot without Custom Welcome Bot Message:

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-03-25T19:16:11Z

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

akarsh-jain-790 · 2024-03-27T14:11:21Z

The CI pipeline is currently failing due to an issue that I've reported in CZO (https://chat.zulip.org/#narrow/stream/9-issues). Once the PR #29474 is merged, it should resolve the CI failures.

alya · 2024-03-29T06:31:20Z

Thanks! As indicated in the issue, the custom message should be a separate message.

alya · 2024-03-29T06:31:44Z

Also, the field label doesn't match the description in the issue:

Add a "Message text" text box field

prakhar1144

Thanks for keeping the PR updated & sorry for the delay in reviewing it.

prakhar1144 · 2024-05-24T10:16:40Z

zerver/views/custom_welcome_bot_message.py

Maybe, we should better name the file as welcome_bot_custom_message and similar change at other places?

Thank you for the suggestion. I will update the file name to welcome_bot_custom_message and make similar changes in other relevant places.

prakhar1144 · 2024-05-24T10:26:30Z

zerver/lib/onboarding.py

@@ -131,6 +134,35 @@ def send_initial_direct_message(user: UserProfile) -> None:
        disable_external_notifications=True,
    )

+    custom_welcome_bot_message_string = ""
+    custom_welcome_bot_message_text = ""


I think, _string and _text suffix don't create much distinction & are confusing to understand how they differ.

welcome_bot_custom_test_message_content (or simply welcome_bot_test_message_content) & welcome_bot_custom_message_content sounds better?

I'll update the variable names accordingly.

prakhar1144 · 2024-05-24T10:27:17Z

zerver/lib/onboarding.py

+        user.realm.custom_welcome_bot_message_enabled
+        and user.realm.custom_welcome_bot_message is not None
+    ):
+        custom_welcome_bot_message_text = user.realm.custom_welcome_bot_message.strip()


The text stored in database should be stripped before saving.

prakhar1144 · 2024-05-24T10:28:50Z

zerver/lib/onboarding.py

+        custom_welcome_bot_message_text = custom_welcome_bot_message.strip()
+    elif (
+        user.realm.custom_welcome_bot_message_enabled
+        and user.realm.custom_welcome_bot_message is not None


We should use assert user.realm.custom_welcome_bot_message is not None, right ?

prakhar1144 · 2024-05-24T10:30:19Z

zerver/lib/onboarding.py

+
+    if custom_welcome_bot_message_text:
+        custom_welcome_bot_message_string = (
+            _(


This won't get translated properly as it is outside with override_language(user.default_language): block.

Also, recently we have started using remove_single_newlines(), we should use that here.

Thank you for the suggestion. However, the quote\n{realm_custom_welcome_bot_message}\n block requires the newlines to maintain the correct formatting. Using remove_single_newlines here would disrupt the intended structure of the message.

prakhar1144 · 2024-05-24T10:36:19Z

zerver/lib/onboarding.py

+
+        internal_send_private_message(
+            get_system_bot(settings.WELCOME_BOT, user.realm_id),
+            user,


We can use internal_prep_private_message() twice, instead of using internal_send_private_message() twice. and then use do_send_messages([default_message, custom_message]) -- This will save a lot of db queries.

prakhar1144 · 2024-05-24T10:42:35Z

zproject/urls.py

@@ -300,6 +301,8 @@
    ),
    # realm/deactivate -> zerver.views.deactivate_realm
    rest_path("realm/deactivate", POST=deactivate_realm),
+    # realm/test_custom_welcome_bot_message -> zerver.views.send_test_custom_welcome_bot_message


zerver.views.send_test_custom_welcome_bot_message -- no such file exists

My bad, I thought it was a function as the above comment has "deactivate_realm," which is not a file name but a function inside realm.py. I'll correct it. Thanks for pointing it out.

This commit extends the functionality of the Welcome Bot to include the custom welcome message configured by administrators. It ensures that new users receive the additional custom message along with the standard welcome message upon joining the organization. Fixes: zulip#27663

akarsh-jain-790 · 2024-06-24T17:28:04Z

@prakhar1144 I have updated the PR

zulipbot · 2024-06-24T19:41:31Z

Heads up @akarsh-jain-790, 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: XL area: bots area: onboarding priority: high labels Mar 25, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 3 times, most recently from fca5af3 to c7d7fbb Compare March 26, 2024 13:26

zulipbot added the has conflicts label Mar 26, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 2 times, most recently from a4ba94e to bbbf746 Compare March 26, 2024 20:03

zulipbot removed the has conflicts label Mar 26, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 5 times, most recently from 5b5992f to 41d6424 Compare March 27, 2024 13:29

akarsh-jain-790 marked this pull request as ready for review March 27, 2024 13:30

akarsh-jain-790 force-pushed the issue--27663 branch 2 times, most recently from 11f057d to 2b825e7 Compare March 28, 2024 16:12

zulipbot added the has conflicts label Mar 28, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 2 times, most recently from 3f89199 to 64ab80f Compare March 28, 2024 16:44

zulipbot removed the has conflicts label Mar 28, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 2 times, most recently from d50b513 to b9d34b6 Compare March 28, 2024 17:23

akarsh-jain-790 force-pushed the issue--27663 branch from b9d34b6 to bc530be Compare March 29, 2024 12:25

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

zulipbot added the has conflicts label Apr 11, 2024

akarsh-jain-790 force-pushed the issue--27663 branch from cd863c2 to cc732b1 Compare April 14, 2024 07:05

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

akarsh-jain-790 force-pushed the issue--27663 branch from cc732b1 to 88bfd71 Compare April 27, 2024 08:13

zulipbot removed the has conflicts label Apr 27, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 3 times, most recently from 934a475 to eb258c2 Compare April 27, 2024 09:22

zulipbot added the has conflicts label Apr 30, 2024

akarsh-jain-790 force-pushed the issue--27663 branch from eb258c2 to 7187f41 Compare May 22, 2024 18:04

zulipbot added has conflicts and removed has conflicts labels May 22, 2024

akarsh-jain-790 force-pushed the issue--27663 branch from 7187f41 to 19f54ac Compare May 23, 2024 04:32

zulipbot removed the has conflicts label May 23, 2024

akarsh-jain-790 force-pushed the issue--27663 branch 2 times, most recently from ff83508 to 7d34a1b Compare May 24, 2024 06:35

prakhar1144 reviewed May 24, 2024

View reviewed changes

akarsh-jain-790 force-pushed the issue--27663 branch from 7d34a1b to 8c4476b Compare May 29, 2024 09:22

akarsh-jain-790 requested a review from prakhar1144 May 30, 2024 19:55

zulipbot added the has conflicts label Jun 7, 2024

akarsh-jain-790 force-pushed the issue--27663 branch from 8c4476b to 847d3dc Compare June 23, 2024 19:12

zulipbot removed the has conflicts label Jun 23, 2024

akarsh-jain-790 added 2 commits June 24, 2024 09:06

settings: Reorganize organization settings.

93388df

akarsh-jain-790 force-pushed the issue--27663 branch from 847d3dc to 93388df Compare June 24, 2024 03:36

zulipbot added the has conflicts label Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

settings: Add initial implementation for custom welcome bot message. #29452

settings: Add initial implementation for custom welcome bot message. #29452

akarsh-jain-790 commented Mar 25, 2024 •

edited

Loading

zulipbot commented Mar 25, 2024

akarsh-jain-790 commented Mar 27, 2024

alya commented Mar 29, 2024

alya commented Mar 29, 2024

prakhar1144 left a comment

prakhar1144 May 24, 2024

akarsh-jain-790 May 28, 2024

prakhar1144 May 24, 2024

akarsh-jain-790 May 28, 2024

prakhar1144 May 24, 2024

prakhar1144 May 24, 2024

prakhar1144 May 24, 2024

akarsh-jain-790 May 29, 2024

prakhar1144 May 24, 2024

prakhar1144 May 24, 2024

akarsh-jain-790 May 28, 2024

akarsh-jain-790 commented Jun 24, 2024

zulipbot commented Jun 24, 2024

settings: Add initial implementation for custom welcome bot message. #29452

Are you sure you want to change the base?

settings: Add initial implementation for custom welcome bot message. #29452

Conversation

akarsh-jain-790 commented Mar 25, 2024 • edited Loading

Screenshot with Checkbox Unchecked:

Screenshot with Checkbox Checked:

Save button is disabled when textarea is empty.

When attempting to send a Test Custom Welcome Bot Message with an empty message:

When attempting to send a Test Custom Welcome Bot Message with a message:

Screenshot with Custom Welcome Bot Message Included:

Screenshot without Custom Welcome Bot Message:

zulipbot commented Mar 25, 2024

akarsh-jain-790 commented Mar 27, 2024

alya commented Mar 29, 2024

alya commented Mar 29, 2024

prakhar1144 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

Choose a reason for hiding this comment

akarsh-jain-790 commented Jun 24, 2024

zulipbot commented Jun 24, 2024

akarsh-jain-790 commented Mar 25, 2024 •

edited

Loading