invites: Allow user to be invited as a moderator.

This commit adds both frontend and backend code to invite a user as
moderator. We allow only existing owners and admins to invite a user
as a moderator.
This commit is contained in:
sahil839 2021-04-30 18:49:47 +05:30 committed by Tim Abbott
parent a4c3224328
commit e669818544
7 changed files with 47 additions and 5 deletions

View File

@ -10,6 +10,11 @@ below features are supported.
## Changes in Zulip 4.0 ## Changes in Zulip 4.0
**Feature level 61**
* Added support for inviting users as moderators to the invitation
endpoints.
**Feature level 60** **Feature level 60**
* [`POST /register`](/api/register-queue): Added a new boolean field * [`POST /register`](/api/register-queue): Added a new boolean field

View File

@ -40,6 +40,7 @@
<option name="invite_as" value="{{ invite_as.GUEST_USER }}">{{ _('Guests') }}</option> <option name="invite_as" value="{{ invite_as.GUEST_USER }}">{{ _('Guests') }}</option>
<option name="invite_as" selected="selected" value="{{ invite_as.MEMBER }}">{{ _('Members') }}</option> <option name="invite_as" selected="selected" value="{{ invite_as.MEMBER }}">{{ _('Members') }}</option>
{% if is_admin %} {% if is_admin %}
<option name="invite_as" value="{{ invite_as.MODERATOR }}">{{ _('Moderators') }}</option>
<option name="invite_as" value="{{ invite_as.REALM_ADMIN }}">{{ _('Organization administrators') }}</option> <option name="invite_as" value="{{ invite_as.REALM_ADMIN }}">{{ _('Organization administrators') }}</option>
{% endif %} {% endif %}
{% if is_owner %} {% if is_owner %}

View File

@ -12,7 +12,7 @@ the article below describes each in more detail.
* Share a **reusable invitation link**. * Share a **reusable invitation link**.
The last two, invite-based, techniques also allow you to control the The last two, invite-based, techniques also allow you to control the
[role (owner, admin, member, or guest)](/help/roles-and-permissions) that the [role (owner, admin, moderator, member, or guest)](/help/roles-and-permissions) that the
invited people will have. invited people will have.
You can also manage access by You can also manage access by
@ -78,7 +78,7 @@ and reusable invitation links expire 10 days after they are sent.
1. Enter a list of email addresses. 1. Enter a list of email addresses.
1. Decide whether the users should join as [admins, members, or 1. Decide whether the users should join as [admins, moderators, members, or
guests](/help/roles-and-permissions). guests](/help/roles-and-permissions).
1. Select which streams they should join. If you send invitations often, you 1. Select which streams they should join. If you send invitations often, you
@ -100,7 +100,7 @@ and reusable invitation links expire 10 days after they are sent.
1. Click **Generate invite link**. 1. Click **Generate invite link**.
1. Decide whether users using the link should join as [admins, 1. Decide whether users using the link should join as [admins, moderators
members, or guests](/help/roles-and-permissions). members, or guests](/help/roles-and-permissions).
1. Select which streams they should join. If you send invitations often, you 1. Select which streams they should join. If you send invitations often, you

View File

@ -30,7 +30,7 @@ DESKTOP_WARNING_VERSION = "5.2.0"
# #
# Changes should be accompanied by documentation explaining what the # Changes should be accompanied by documentation explaining what the
# new level means in templates/zerver/api/changelog.md. # new level means in templates/zerver/api/changelog.md.
API_FEATURE_LEVEL = 60 API_FEATURE_LEVEL = 61
# Bump the minor PROVISION_VERSION to indicate that folks should provision # Bump the minor PROVISION_VERSION to indicate that folks should provision
# only when going from an old version of the code to a newer version. Bump # only when going from an old version of the code to a newer version. Bump

View File

@ -1713,6 +1713,7 @@ class PreregistrationUser(models.Model):
INVITE_AS = dict( INVITE_AS = dict(
REALM_OWNER=100, REALM_OWNER=100,
REALM_ADMIN=200, REALM_ADMIN=200,
MODERATOR=300,
MEMBER=400, MEMBER=400,
GUEST_USER=600, GUEST_USER=600,
) )

View File

@ -1171,6 +1171,37 @@ class InviteUserTest(InviteUserBase):
) )
self.assert_json_error(response, "Must be an organization administrator") self.assert_json_error(response, "Must be an organization administrator")
def test_successful_invite_user_as_moderator_from_admin_account(self) -> None:
self.login("iago")
invitee = self.nonreg_email("alice")
result = self.invite(
invitee, ["Denmark"], invite_as=PreregistrationUser.INVITE_AS["MODERATOR"]
)
self.assert_json_success(result)
self.assertTrue(find_key_by_email(invitee))
self.submit_reg_form_for_user(invitee, "password")
invitee_profile = self.nonreg_user("alice")
self.assertFalse(invitee_profile.is_realm_admin)
self.assertTrue(invitee_profile.is_moderator)
self.assertFalse(invitee_profile.is_guest)
def test_invite_user_as_moderator_from_normal_account(self) -> None:
self.login("hamlet")
invitee = self.nonreg_email("alice")
response = self.invite(
invitee, ["Denmark"], invite_as=PreregistrationUser.INVITE_AS["MODERATOR"]
)
self.assert_json_error(response, "Must be an organization administrator")
def test_invite_user_as_moderator_from_moderator_account(self) -> None:
self.login("shiva")
invitee = self.nonreg_email("alice")
response = self.invite(
invitee, ["Denmark"], invite_as=PreregistrationUser.INVITE_AS["MODERATOR"]
)
self.assert_json_error(response, "Must be an organization administrator")
def test_invite_user_as_invalid_type(self) -> None: def test_invite_user_as_invalid_type(self) -> None:
""" """
Test inviting a user as invalid type of user i.e. type of invite_as Test inviting a user as invalid type of user i.e. type of invite_as

View File

@ -47,7 +47,11 @@ def invite_users_backend(
return json_error(_("Must be invited as an valid type of user")) return json_error(_("Must be invited as an valid type of user"))
check_if_owner_required(invite_as, user_profile) check_if_owner_required(invite_as, user_profile)
if ( if (
invite_as == PreregistrationUser.INVITE_AS["REALM_ADMIN"] invite_as
in [
PreregistrationUser.INVITE_AS["REALM_ADMIN"],
PreregistrationUser.INVITE_AS["MODERATOR"],
]
and not user_profile.is_realm_admin and not user_profile.is_realm_admin
): ):
return json_error(_("Must be an organization administrator")) return json_error(_("Must be an organization administrator"))