A platform for community discussion. Free, open, simple.
FEATURE: Allow inviting staff as admins or moderators (#41880)
Keegan George983b7f6dee6b
diff --git a/app/assets/stylesheets/common/modal/create-invite-with-roles.scss b/app/assets/stylesheets/common/modal/create-invite-with-roles.scssindex c426b00a372..fdd52d297aa 100644--- a/app/assets/stylesheets/common/modal/create-invite-with-roles.scss+++ b/app/assets/stylesheets/common/modal/create-invite-with-roles.scss@@ -73,19 +73,22 @@font-size: var(--font-down-1);}- &__delivery {+ &__delivery,+ &__staff-role {margin: 0 0 1em;padding: 0;border: 0;}- &__delivery-label {+ &__delivery-label,+ &__staff-role-label {padding: 0;margin-bottom: 0.5em;font-weight: bold;}- &__delivery-option {+ &__delivery-option,+ &__staff-role-option {display: inline-flex;align-items: center;gap: 0.5em;diff --git a/app/controllers/invites_controller.rb b/app/controllers/invites_controller.rbindex f802dfd9a8d..6416bae07cc 100644--- a/app/controllers/invites_controller.rb+++ b/app/controllers/invites_controller.rb@@ -123,13 +123,15 @@ class InvitesController < ApplicationControllerdef createis_admin_invite = params[:is_admin].to_s == "true"+ is_moderator_invite = params[:is_moderator].to_s == "true"+ is_staff_invite = is_admin_invite || is_moderator_invite- if is_admin_invite+ if is_staff_inviteguardian.ensure_can_create_admin_invite!if params[:topic_id].present? || params[:group_ids].present? ||params[:group_names].present? || params[:domain].present?- raise Discourse::InvalidParameters.new(:is_admin)+ raise Discourse::InvalidParameters.new(is_admin_invite ? :is_admin : :is_moderator)endRateLimiter.new(@@ -171,8 +173,9 @@ class InvitesController < ApplicationControllerskip_email: skip_email_param,invited_by: current_user,custom_message: params[:custom_message],- max_redemptions_allowed: is_admin_invite ? nil : params[:max_redemptions_allowed],+ max_redemptions_allowed: is_staff_invite ? nil : params[:max_redemptions_allowed],admin: is_admin_invite,+ moderator: is_moderator_invite,topic_id: topic&.id,group_ids: groups&.map(&:id),expires_at: params[:expires_at],diff --git a/app/models/invite.rb b/app/models/invite.rbindex 5c0617c0d93..021787f5f25 100644--- a/app/models/invite.rb+++ b/app/models/invite.rb@@ -40,6 +40,7 @@ class Invite < ActiveRecord::Basevalidate :user_doesnt_already_exist, if: :will_save_change_to_email?validate :email_xor_domainvalidate :ensure_valid_admin_invite, if: :admin?+ validate :ensure_valid_moderator_invite, if: :moderator?before_create doself.invite_key ||= SecureRandom.base58(10)@@ -176,9 +177,11 @@ class Invite < ActiveRecord::Baseupdated_at: Time.zone.now,expires_at: opts[:expires_at] || time_zone.now + SiteSetting.invite_expiry_days.days,emailed_status: emailed_status,- # update_columns skips validations, so the inviter check from- # ensure_valid_admin_invite has to be re-applied here+ # update_columns skips validations, so the inviter checks from+ # ensure_valid_admin_invite / ensure_valid_moderator_invite have to be+ # re-applied hereadmin: !!opts[:admin] && !!invited_by&.admin?,+ moderator: !!opts[:moderator] && !!invited_by&.staff?,)elsecreate_args =@@ -202,8 +205,8 @@ class Invite < ActiveRecord::BaseDiscourseEvent.trigger(:admin_invite_created, invite) if invite.admin? && !was_admin- if invite.admin?- # admin invites never carry topic or group associations; clear any left+ if invite.admin? || invite.moderator?+ # staff invites never carry topic or group associations; clear any left# over from a reused member inviteinvite.topic_invites.destroy_allinvite.invited_groups.destroy_all@@ -370,6 +373,16 @@ class Invite < ActiveRecord::Baseendend+ def ensure_valid_moderator_invite+ errors.add(:base, I18n.t("invite.moderator_invite_requires_email")) if email.blank?++ # only checked when the flag is set so that later saves (e.g. marking the+ # invite redeemed) don't fail if the inviter has since been demoted+ if (new_record? || will_save_change_to_moderator?) && !invited_by&.staff?+ errors.add(:base, I18n.t("invite.moderator_invite_requires_staff_inviter"))+ end+ end+def valid_domainreturn if domain.blank?diff --git a/app/models/invite_redeemer.rb b/app/models/invite_redeemer.rbindex f86a0ce069a..7e8581d2192 100644--- a/app/models/invite_redeemer.rb+++ b/app/models/invite_redeemer.rb@@ -246,9 +246,19 @@ class InviteRedeemeradd_user_to_groupssend_welcome_messagenotify_invitee+ grant_moderator_from_invitecreate_admin_grant_confirmationend+ # Moderator invites grant moderator on redemption. Users created from the+ # invite already have the flag set in create_user_from_invite; this covers+ # existing users redeeming the invite.+ def grant_moderator_from_invite+ return if !invite.moderator? || !invite.invited_by&.staff?++ invited_user.grant_moderation! if !invited_user.moderator?+ end+# Admin invites grant moderator right away; full admin requires the inviter# to confirm via the same email confirmation used when granting admin from# the admin user page.diff --git a/app/serializers/invite_serializer.rb b/app/serializers/invite_serializer.rbindex 79c3e72521d..53da8ac5fe3 100644--- a/app/serializers/invite_serializer.rb+++ b/app/serializers/invite_serializer.rb@@ -16,7 +16,8 @@ class InviteSerializer < ApplicationSerializer:updated_at,:expires_at,:expired,- :grants_admin+ :grants_admin,+ :grants_moderatorhas_many :topics, embed: :object, serializer: BasicTopicSerializerhas_many :groups, embed: :object, serializer: BasicGroupSerializer@@ -89,6 +90,14 @@ class InviteSerializer < ApplicationSerializercan_see_invite_details?end+ def grants_moderator+ object.moderator?+ end++ def include_grants_moderator?+ can_see_invite_details?+ end+privatedef can_see_invite_details?diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex 3f6b9c43281..13729182ed9 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -2527,14 +2527,18 @@ en:invite_roles:member_title: "Invite members"- admin_title: "Invite admins"+ admin_title: "Invite staff"edit_title: "Editing invite"created_title: "Invite created"sent_title: "Invitation sent"member_tab: "Members"- admin_tab: "Admins"+ admin_tab: "Staff"member_description: "Invite people to join this site. Share a link or send an email invitation."- admin_description: "Invite people to join your staff as admins. Admins have full access to this site."+ admin_description: "Invite people to join your staff team. Admins have full access to this site."+ moderator_description: "Invite people to join your staff team. Moderators can help manage content and members."+ staff_role_label: "Invite as"+ staff_role_admin: "Admin"+ staff_role_moderator: "Moderator"admin_email_label: "Email address"member_email_label: "Send to"member_email_help: "We'll email an invitation link to this address."@@ -2559,6 +2563,7 @@ en:role: "Role"role_member: "Member"role_admin: "Admin"+ role_moderator: "Moderator"method: "Sharing"method_link: "Shareable link"method_email: "Email"diff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 7e5b491d6e1..a2afad95433 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -437,6 +437,8 @@ en:email_xor_domain: "Email and domain fields are not allowed at the same time"admin_invite_requires_email: "Admin invites must be sent to an email address"admin_invite_requires_admin_inviter: "Only admins can create admin invites"+ moderator_invite_requires_email: "Moderator invites must be sent to an email address"+ moderator_invite_requires_staff_inviter: "Only staff can create moderator invites"existing_user_success: "Invite redeemed successfully"email_invites_disabled: "Sending invite emails is disabled"diff --git a/frontend/discourse/app/components/modal/create-invite-with-roles.gjs b/frontend/discourse/app/components/modal/create-invite-with-roles.gjsindex 89422506c88..c20d41fb493 100644--- a/frontend/discourse/app/components/modal/create-invite-with-roles.gjs+++ b/frontend/discourse/app/components/modal/create-invite-with-roles.gjs@@ -45,6 +45,7 @@ export default class CreateInviteWithRoles extends Component {@tracked showAdvanced = false;@tracked screen = FORM;@tracked role;+ @tracked staffRole = "admin";@tracked delivery;@tracked submitForcedDisabled = false;@tracked flashText;@@ -62,7 +63,9 @@ export default class CreateInviteWithRoles extends Component {super(...arguments);if (this.inviteCreated) {- this.role = this.invite.grants_admin ? "admin" : "member";+ const isStaff = this.invite.grants_admin || this.invite.grants_moderator;+ this.role = isStaff ? "admin" : "member";+ this.staffRole = this.invite.grants_moderator ? "moderator" : "admin";this.delivery = this.invite.email ? "email" : "link";} else {this.role =@@ -126,10 +129,31 @@ export default class CreateInviteWithRoles extends Component {: i18n("user.invited.invite_roles.member_title");}+ get isModeratorInvite() {+ return this.isAdminInvite && this.staffRole === "moderator";+ }++ get staffRoleItems() {+ return [+ {+ value: "admin",+ label: i18n("user.invited.invite_roles.staff_role_admin"),+ },+ {+ value: "moderator",+ label: i18n("user.invited.invite_roles.staff_role_moderator"),+ },+ ];+ }+get roleDescription() {- return this.isAdminInvite- ? i18n("user.invited.invite_roles.admin_description")- : i18n("user.invited.invite_roles.member_description");+ if (!this.isAdminInvite) {+ return i18n("user.invited.invite_roles.member_description");+ }++ return this.isModeratorInvite+ ? i18n("user.invited.invite_roles.moderator_description")+ : i18n("user.invited.invite_roles.admin_description");}get descriptionValidation() {@@ -224,13 +248,23 @@ export default class CreateInviteWithRoles extends Component {return data;}+ get summaryRoleValue() {+ if (this.invite.grants_admin) {+ return i18n("user.invited.invite_roles.summary.role_admin");+ }++ if (this.invite.grants_moderator) {+ return i18n("user.invited.invite_roles.summary.role_moderator");+ }++ return i18n("user.invited.invite_roles.summary.role_member");+ }+get summaryRows() {const rows = [{label: i18n("user.invited.invite_roles.summary.role"),- value: this.invite.grants_admin- ? i18n("user.invited.invite_roles.summary.role_admin")- : i18n("user.invited.invite_roles.summary.role_member"),+ value: this.summaryRoleValue,},{label: i18n("user.invited.invite_roles.summary.method"),@@ -330,6 +364,14 @@ export default class CreateInviteWithRoles extends Component {this.submitForcedDisabled = false;}+ @action+ onStaffRoleChange(value) {+ if (this.inviteCreated) {+ return;+ }+ this.staffRole = value;+ }+@actionsetDelivery(value) {this.delivery = value;@@ -372,7 +414,11 @@ export default class CreateInviteWithRoles extends Component {};if (!wasCreated) {- submitData.is_admin = true;+ if (this.staffRole === "moderator") {+ submitData.is_moderator = true;+ } else {+ submitData.is_admin = true;+ }}await this.save(submitData, SUMMARY);@@ -531,6 +577,30 @@ export default class CreateInviteWithRoles extends Component {class="create-invite-with-roles-modal__admin-form"as |form|>+ {{#unless this.inviteCreated}}+ <fieldset class="create-invite-with-roles-modal__staff-role">+ <legend+ class="create-invite-with-roles-modal__staff-role-label"+ >{{i18n+ "user.invited.invite_roles.staff_role_label"+ }}</legend>+ {{#each this.staffRoleItems as |item|}}+ <label+ class="create-invite-with-roles-modal__staff-role-option"+ >+ <input+ type="radio"+ name="invite-staff-role"+ value={{item.value}}+ checked={{eq this.staffRole item.value}}+ {{on "change" (fn this.onStaffRoleChange item.value)}}+ />+ {{item.label}}+ </label>+ {{/each}}+ </fieldset>+ {{/unless}}+<form.Field@name="email"@type="input-email"diff --git a/frontend/discourse/tests/integration/components/create-invite-with-roles-test.gjs b/frontend/discourse/tests/integration/components/create-invite-with-roles-test.gjsindex 54343fc0bff..9f8e612d2f0 100644--- a/frontend/discourse/tests/integration/components/create-invite-with-roles-test.gjs+++ b/frontend/discourse/tests/integration/components/create-invite-with-roles-test.gjs@@ -125,6 +125,44 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {);});+ test("creating a moderator invite posts is_moderator and shows the summary", async function (assert) {+ this.currentUser.set("can_create_admin_invite", true);+ const model = { defaultRole: "admin", invites: [] };++ let requestBody;+ pretender.post("/invites", (request) => {+ requestBody = new URLSearchParams(request.requestBody);+ return response({+ id: 44,+ invite_key: "mod123",+ link: "http://example.com/invites/mod123",+ email: "[email protected]",+ grants_moderator: true,+ expires_at: "2100-01-01 00:00",+ });+ });++ await render(+ <template>+ <CreateInviteWithRoles @inline={{true}} @model={{model}} />+ </template>+ );++ await click(+ ".create-invite-with-roles-modal__staff-role input[value='moderator']"+ );+ await formKit().field("email").fillIn("[email protected]");+ await click(".save-invite");++ assert.strictEqual(requestBody.get("is_moderator"), "true");+ assert.strictEqual(requestBody.get("is_admin"), null);+ assert.strictEqual(requestBody.get("email"), "[email protected]");++ assert+ .dom(".create-invite-with-roles-modal__sent-to")+ .includesText("[email protected]");+ });+test("validates the admin email address", async function (assert) {this.currentUser.set("can_create_admin_invite", true);const model = { defaultRole: "admin" };diff --git a/spec/models/invite_redeemer_spec.rb b/spec/models/invite_redeemer_spec.rbindex 905c751a631..052f99a496c 100644--- a/spec/models/invite_redeemer_spec.rb+++ b/spec/models/invite_redeemer_spec.rb@@ -729,5 +729,49 @@ RSpec.describe InviteRedeemer doexpect(AdminConfirmation.exists_for?(user.id)).to eq(false)endend++ context "with a moderator invite" do+ fab!(:invite) do+ Fabricate(:invite, email: "[email protected]", moderator: true, invited_by: admin)+ end++ before { SiteSetting.enable_invite_modal_with_roles = true }++ def redeem+ InviteRedeemer.new(+ invite: invite,+ email: invite.email,+ username: "futuremod",+ name: "Future Mod",+ ).redeem+ end++ it "grants moderator without any admin confirmation" do+ user = redeem++ expect(user.moderator).to eq(true)+ expect(user.admin).to eq(false)+ expect(AdminConfirmation.exists_for?(user.id)).to eq(false)+ end++ it "grants moderator when an existing user redeems" do+ existing_user = Fabricate(:user, email: invite.email)++ InviteRedeemer.new(invite: invite, redeeming_user: existing_user).redeem++ expect(existing_user.reload.moderator).to eq(true)+ expect(existing_user.admin).to eq(false)+ expect(AdminConfirmation.exists_for?(existing_user.id)).to eq(false)+ end++ it "does not grant moderator when the inviter is no longer staff" do+ invite.invited_by.update!(admin: false, moderator: false)++ user = redeem++ expect(user.moderator).to eq(false)+ expect(user.admin).to eq(false)+ end+ endendenddiff --git a/spec/models/invite_spec.rb b/spec/models/invite_spec.rbindex dc4223c7c71..d6c5ee51ae5 100644--- a/spec/models/invite_spec.rb+++ b/spec/models/invite_spec.rb@@ -394,7 +394,9 @@ RSpec.describe Invite doendit "will not give the user a moderator flag if the inviter is not staff" do- invite.update!(moderator: true)+ # update_columns skips the ensure_valid_moderator_invite validation so we+ # can exercise the redeemer's own inviter check in isolation+ invite.update_columns(moderator: true)user = invite.redeemexpect(user).not_to be_moderatordiff --git a/spec/requests/api/schemas/json/invite_create_response.json b/spec/requests/api/schemas/json/invite_create_response.jsonindex 6e91890399d..ce53616c431 100644--- a/spec/requests/api/schemas/json/invite_create_response.json+++ b/spec/requests/api/schemas/json/invite_create_response.json@@ -63,6 +63,10 @@"type": "boolean","example": false},+ "grants_moderator": {+ "type": "boolean",+ "example": false+ },"topics": {"type": "array","items": {@@ -93,6 +97,7 @@"expires_at","expired","grants_admin",+ "grants_moderator","topics","groups"]diff --git a/spec/requests/invites_controller_spec.rb b/spec/requests/invites_controller_spec.rbindex e30fad97b6e..b91f3a79c0a 100644--- a/spec/requests/invites_controller_spec.rb+++ b/spec/requests/invites_controller_spec.rb@@ -777,6 +777,61 @@ RSpec.describe InvitesController doendend+ context "with moderator invite" do+ before { SiteSetting.enable_invite_modal_with_roles = true }++ it "creates a single-use moderator invite" do+ sign_in(admin)++ post "/invites.json", params: { email: "[email protected]", is_moderator: "true" }++ expect(response.status).to eq(200)+ expect(response.parsed_body["grants_moderator"]).to eq(true)+ expect(response.parsed_body["grants_admin"]).to eq(false)++ invite = Invite.last+ expect(invite.moderator).to eq(true)+ expect(invite.admin).to eq(false)+ expect(invite.email).to eq("[email protected]")+ expect(invite.max_redemptions_allowed).to eq(1)+ end++ it "fails for moderators and regular users" do+ sign_in(Fabricate(:moderator))+ post "/invites.json", params: { email: "[email protected]", is_moderator: "true" }+ expect(response.status).to eq(403)++ sign_in(user)+ post "/invites.json", params: { email: "[email protected]", is_moderator: "true" }+ expect(response.status).to eq(403)+ end++ it "fails when combined with a topic, groups or a domain" do+ sign_in(admin)+ topic = Fabricate(:topic)+ group = Fabricate(:group)++ post "/invites.json",+ params: {+ email: "[email protected]",+ is_moderator: "true",+ topic_id: topic.id,+ }+ expect(response.status).to eq(400)++ post "/invites.json",+ params: {+ email: "[email protected]",+ is_moderator: "true",+ group_ids: [group.id],+ }+ expect(response.status).to eq(400)++ post "/invites.json", params: { is_moderator: "true", domain: "example.com" }+ expect(response.status).to eq(400)+ end+ end+context "with link invite" doit "works" dosign_in(admin)