Skip to content

A platform for community discussion. Free, open, simple.

DEV: Allow links to be generated for admin invites (#42557)

Jordan Vidrine17ca928e17c9
diff --git a/app/controllers/invites_controller.rb b/app/controllers/invites_controller.rb
index 29ba52c4716..4fcded5827a 100644
--- a/app/controllers/invites_controller.rb
+++ b/app/controllers/invites_controller.rb
@@ -129,8 +129,7 @@ class InvitesController < ApplicationController
if is_staff_invite
guardian.ensure_can_create_admin_invite!
- if params[:topic_id].present? || params[:group_ids].present? ||
- params[:group_names].present? || params[:domain].present?
+ if params[:topic_id].present? || params[:group_ids].present? || params[:group_names].present?
raise Discourse::InvalidParameters.new(is_admin_invite ? :is_admin : :is_moderator)
end
diff --git a/app/models/invite.rb b/app/models/invite.rb
index 021787f5f25..cb44c82194c 100644
--- a/app/models/invite.rb
+++ b/app/models/invite.rb
@@ -340,7 +340,9 @@ class Invite < ActiveRecord::Base
end
)
- if email.present? && max_redemptions_allowed != 1
+ if (admin? || moderator?) && max_redemptions_allowed != 1
+ errors.add(:max_redemptions_allowed, I18n.t("invite.max_redemptions_allowed_one_staff"))
+ elsif email.present? && max_redemptions_allowed != 1
errors.add(:max_redemptions_allowed, I18n.t("invite.max_redemptions_allowed_one"))
elsif !max_redemptions_allowed.between?(1, limit)
errors.add(
@@ -364,21 +366,27 @@ class Invite < ActiveRecord::Base
end
def ensure_valid_admin_invite
- errors.add(:base, I18n.t("invite.admin_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_admin?) && !invited_by&.admin?
+ # checked when the flag is set or the invite's reach changes (removing
+ # the email or domain restriction widens who can redeem it), but not on
+ # unrelated saves (e.g. marking the invite redeemed) so they don't fail
+ # if the inviter has since been demoted
+ if (
+ new_record? || will_save_change_to_admin? || will_save_change_to_email? ||
+ will_save_change_to_domain?
+ ) && !invited_by&.admin?
errors.add(:base, I18n.t("invite.admin_invite_requires_admin_inviter"))
end
end
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?
+ # checked when the flag is set or the invite's reach changes (removing
+ # the email or domain restriction widens who can redeem it), but not on
+ # unrelated saves (e.g. marking the invite redeemed) so they don't fail
+ # if the inviter has since been demoted
+ if (
+ new_record? || will_save_change_to_moderator? || will_save_change_to_email? ||
+ will_save_change_to_domain?
+ ) && !invited_by&.staff?
errors.add(:base, I18n.t("invite.moderator_invite_requires_staff_inviter"))
end
end
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
index aa5b1cfc498..c97c21544cb 100644
--- a/config/locales/server.en.yml
+++ b/config/locales/server.en.yml
@@ -443,11 +443,10 @@ en:
domain_not_allowed: "Your email cannot be used to redeem this invite."
domain_not_allowed_admin: "This domain cannot be used for invites."
max_redemptions_allowed_one: "for email invites should be 1."
+ max_redemptions_allowed_one_staff: "for admin or moderator invites should be 1."
redemption_count_less_than_max: "should be less than %{max_redemptions_allowed}."
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.gjs
index 2854d921fc4..1d73e92a254 100644
--- a/frontend/discourse/app/components/modal/create-invite-with-roles.gjs
+++ b/frontend/discourse/app/components/modal/create-invite-with-roles.gjs
@@ -47,7 +47,7 @@ export default class CreateInviteWithRoles extends Component {
@tracked screen = FORM;
@tracked role;
@tracked staffRole = "admin";
- @tracked delivery;
+ @tracked delivery = "link";
@tracked submitForcedDisabled = false;
@tracked flashText;
@tracked flashClass = "info";
@@ -113,7 +113,7 @@ export default class CreateInviteWithRoles extends Component {
}
get isEmailDelivery() {
- return this.isAdminInvite || this.delivery === "email";
+ return this.delivery === "email";
}
get inviteCreated() {
@@ -224,6 +224,7 @@ export default class CreateInviteWithRoles extends Component {
get adminFormData() {
const data = {
email: this.invite.email ?? "",
+ domain: this.invite.domain ?? "",
description: this.invite.description ?? "",
customMessage: this.invite.custom_message ?? "",
// seeded from the untracked copy: reading the tracked property here would
@@ -419,7 +420,6 @@ export default class CreateInviteWithRoles extends Component {
async onAdminFormSubmit(data) {
const wasCreated = this.inviteCreated;
const submitData = {
- email: data.email?.trim(),
description: data.description,
custom_message: data.customMessage,
expires_at: this.expiresAtFrom(data),
@@ -433,6 +433,16 @@ export default class CreateInviteWithRoles extends Component {
}
}
+ if (this.delivery === "email") {
+ submitData.email = data.email?.trim();
+ } else {
+ // a cleared field arrives as null, and an undefined value would be
+ // dropped from the request, leaving the existing domain in place
+ submitData.domain = data.domain?.trim() ?? "";
+ submitData.max_redemptions_allowed = data.maxRedemptions;
+ submitData.skip_email = true;
+ }
+
await this.save(submitData, SUMMARY);
}
@@ -606,26 +616,85 @@ export default class CreateInviteWithRoles extends Component {
</form.Field>
{{/unless}}
- <form.Field
- @name="email"
- @type="input-email"
- @title={{this.emailFieldLabel}}
- @validation="required"
- @validate={{this.validateEmail}}
- @format="full"
- as |field|
+ <form.ConditionalContent
+ @activeName={{this.delivery}}
+ @onChange={{this.setDelivery}}
+ as |conditional|
>
- <field.Control
- autofocus="autofocus"
- autocomplete="off"
- data-1p-ignore
- data-lpignore="true"
- disabled={{this.submitDisabled}}
- placeholder={{i18n
- "user.invited.invite_roles.email_placeholder"
- }}
- />
- </form.Field>
+ {{#unless this.inviteCreated}}
+ <fieldset>
+ <legend class="form-kit__fieldset-title">{{i18n
+ "user.invited.invite_roles.invite_by"
+ }}</legend>
+ <conditional.Conditions as |Condition|>
+ <Condition @name="link">{{i18n
+ "user.invited.invite_roles.invite_by_link"
+ }}</Condition>
+ {{#if this.allowEmailInvites}}
+ <Condition @name="email">{{i18n
+ "user.invited.invite_roles.invite_by_email"
+ }}</Condition>
+ {{/if}}
+ </conditional.Conditions>
+ </fieldset>
+ {{/unless}}
+
+ <conditional.Contents as |Content|>
+ <Content @name="link">
+ <form.Field
+ @name="domain"
+ @type="input"
+ @title={{i18n
+ "user.invited.invite_roles.restrict_domain"
+ }}
+ @description={{i18n
+ "user.invited.invite_roles.restrict_domain_help"
+ }}
+ @validate={{if
+ (eq this.delivery "link")
+ this.validateDomain
+ }}
+ @format="full"
+ as |field|
+ >
+ <field.Control
+ autofocus="autofocus"
+ placeholder={{i18n
+ "user.invited.invite_roles.domain_placeholder"
+ }}
+ />
+ </form.Field>
+ </Content>
+
+ <Content @name="email">
+ <form.Field
+ @name="email"
+ @type="input-email"
+ @title={{this.emailFieldLabel}}
+ @description={{i18n
+ "user.invited.invite_roles.member_email_help"
+ }}
+ @validation={{if (eq this.delivery "email") "required"}}
+ @validate={{if
+ (eq this.delivery "email")
+ this.validateEmail
+ }}
+ @format="full"
+ @disabled={{this.inviteCreated}}
+ as |field|
+ >
+ <field.Control
+ autocomplete="off"
+ data-1p-ignore
+ data-lpignore="true"
+ placeholder={{i18n
+ "user.invited.invite_roles.email_placeholder"
+ }}
+ />
+ </form.Field>
+ </Content>
+ </conditional.Contents>
+ </form.ConditionalContent>
{{#if this.showAdvanced}}
<form.Field
diff --git a/frontend/discourse/tests/acceptance/admin-onboarding-banner-test.gjs b/frontend/discourse/tests/acceptance/admin-onboarding-banner-test.gjs
index 4745ce7d36c..5c3b93759ef 100644
--- a/frontend/discourse/tests/acceptance/admin-onboarding-banner-test.gjs
+++ b/frontend/discourse/tests/acceptance/admin-onboarding-banner-test.gjs
@@ -624,6 +624,9 @@ acceptance("Admin - Onboarding Banner - admin invites", function (needs) {
)
.isChecked("defaults to the admins tab");
+ await click(
+ ".create-invite-with-roles-modal .form-kit__inline-radio input[value='email']"
+ );
await fillIn(
".create-invite-with-roles-modal input[name='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.gjs
index af3f3870ea0..e645832a402 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
@@ -57,11 +57,24 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {
assert
.dom("input[name='invite-role'][value='admin']")
.isChecked("defaults to the admins tab");
- assert.true(formKit().hasField("email"), "shows the email field");
- assert.false(
- formKit().hasField("domain"),
- "does not show the domain field"
- );
+ assert
+ .dom(".form-kit__inline-radio input[value='link']")
+ .isChecked("defaults to link delivery");
+ assert
+ .dom("[data-name='domain']")
+ .isVisible("shows the domain field in link mode");
+ assert
+ .dom("[data-name='email']")
+ .isNotVisible("does not show the email field in link mode");
+ assert
+ .dom(".save-invite")
+ .hasText(i18n("user.invited.invite_roles.create_and_copy"));
+
+ await click(".form-kit__inline-radio input[value='email']");
+
+ assert
+ .dom("[data-name='email']")
+ .isVisible("shows the email field in email mode");
assert
.dom(".save-invite")
.hasText(i18n("user.invited.invite_roles.create_and_send"));
@@ -107,6 +120,7 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {
</template>
);
+ await click(".form-kit__inline-radio input[value='email']");
await formKit().field("email").fillIn("[email protected]");
await click(".save-invite");
@@ -164,6 +178,7 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {
"the description tracks the selected staff role"
);
+ await click(".form-kit__inline-radio input[value='email']");
await formKit().field("email").fillIn("[email protected]");
await click(".save-invite");
@@ -186,12 +201,49 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {
</template>
);
+ await click(".form-kit__inline-radio input[value='email']");
await formKit().field("email").fillIn("not-an-email");
await click(".save-invite");
assert.dom(".form-kit__errors").exists("shows a validation error");
});
+ test("creating an admin invite link posts skip_email and is_admin", 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: 47,
+ invite_key: "adm456",
+ link: "http://example.com/invites/adm456",
+ grants_admin: true,
+ max_redemptions_allowed: 1,
+ expires_at: "2100-01-01 00:00",
+ });
+ });
+
+ await render(
+ <template>
+ <CreateInviteWithRoles @inline={{true}} @model={{model}} />
+ </template>
+ );
+
+ await formKit().field("domain").fillIn("example.com");
+ await click(".save-invite");
+
+ assert.strictEqual(requestBody.get("is_admin"), "true");
+ assert.strictEqual(requestBody.get("skip_email"), "true");
+ assert.strictEqual(requestBody.get("domain"), "example.com");
+ assert.strictEqual(requestBody.get("email"), null);
+
+ assert
+ .dom(".create-invite-with-roles-modal__link-share input.invite-link")
+ .hasValue("http://example.com/invites/adm456");
+ });
+
test("creating a member link invite posts skip_email and shows the summary", async function (assert) {
const model = { invites: [] };
@@ -391,4 +443,56 @@ module("Integration | Component | CreateInviteWithRoles", function (hooks) {
.dom(".create-invite-with-roles-modal__summary-rows")
.doesNotIncludeText("google.com", "the restriction is gone");
});
+
+ test("editing a domain-restricted admin invite keeps the domain", async function (assert) {
+ this.currentUser.set("can_create_admin_invite", true);
+ const model = {
+ editing: true,
+ invite: Invite.create({
+ id: 48,
+ invite_key: "adm789",
+ link: "http://example.com/invites/adm789",
+ domain: "example.com",
+ grants_admin: true,
+ max_redemptions_allowed: 1,
+ expires_at: "2100-01-01 00:00",
+ }),
+ };
+
+ let requestBody;
+ pretender.put("/invites/48", (request) => {
+ requestBody = new URLSearchParams(request.requestBody);
+ return response({
+ id: 48,
+ invite_key: "adm789",
+ link: "http://example.com/invites/adm789",
+ domain: "example.com",
+ grants_admin: true,
+ max_redemptions_allowed: 1,
+ expires_at: "2100-01-01 00:00",
+ });
+ });
+
+ await render(
+ <template>
+ <CreateInviteWithRoles @inline={{true}} @model={{model}} />
+ </template>
+ );
+
+ assert
+ .form()
+ .field("domain")
+ .hasValue("example.com", "the existing restriction is pre-filled");
+
+ await click(".save-invite");
+
+ assert.strictEqual(
+ requestBody.get("domain"),
+ "example.com",
+ "the restriction survives an update that doesn't touch it"
+ );
+ assert
+ .dom(".create-invite-with-roles-modal__summary-rows")
+ .includesText("example.com", "the summary still shows the restriction");
+ });
});
diff --git a/spec/models/invite_spec.rb b/spec/models/invite_spec.rb
index d6c5ee51ae5..66fe00b2c1a 100644
--- a/spec/models/invite_spec.rb
+++ b/spec/models/invite_spec.rb
@@ -264,11 +264,19 @@ RSpec.describe Invite do
expect(invite.max_redemptions_allowed).to eq(1)
end
- it "requires an email address" do
- expect { Invite.generate(admin, admin: true) }.to raise_error(
- ActiveRecord::RecordInvalid,
- /#{I18n.t("invite.admin_invite_requires_email")}/,
- )
+ it "creates a single-use invite link when a shareable link is chosen" do
+ invite = Invite.generate(admin, admin: true)
+
+ expect(invite.admin).to eq(true)
+ expect(invite.is_invite_link?).to eq(true)
+ expect(invite.max_redemptions_allowed).to eq(1)
+ end
+
+ it "can be combined with a domain restriction when created as a link" do
+ invite = Invite.generate(admin, domain: "example.com", admin: true)
+
+ expect(invite.admin).to eq(true)
+ expect(invite.domain).to eq("example.com")
end
it "requires the inviter to be an admin" do
@@ -278,9 +286,58 @@ RSpec.describe Invite do
)
end
- it "cannot be combined with a domain restriction" do
- invite = Fabricate.build(:invite, email: nil, domain: "example.com", admin: true)
+ it "requires the inviter to still be an admin when the email is removed" do
+ invite = Invite.generate(admin, email: "[email protected]", admin: true)
+ admin.update!(admin: false)
+
+ invite.email = nil
+ expect(invite).not_to be_valid
+ expect(invite.errors[:base]).to include(
+ I18n.t("invite.admin_invite_requires_admin_inviter"),
+ )
+ end
+
+ it "requires the inviter to still be an admin when the domain restriction is removed" do
+ invite = Invite.generate(admin, domain: "example.com", admin: true)
+ admin.update!(admin: false)
+
+ invite.domain = nil
expect(invite).not_to be_valid
+ expect(invite.errors[:base]).to include(
+ I18n.t("invite.admin_invite_requires_admin_inviter"),
+ )
+ end
+
+ it "requires the inviter to still be an admin when the domain restriction is changed" do
+ invite = Invite.generate(admin, domain: "example.com", admin: true)
+ admin.update!(admin: false)
+
+ invite.domain = "other-example.com"
+ expect(invite).not_to be_valid
+ expect(invite.errors[:base]).to include(
+ I18n.t("invite.admin_invite_requires_admin_inviter"),
+ )
+ end
+
+ it "requires the inviter to still be staff when a moderator invite's domain restriction is removed" do
+ invite = Invite.generate(admin, domain: "example.com", moderator: true)
+ admin.update!(admin: false)
+
+ invite.domain = nil
+ expect(invite).not_to be_valid
+ expect(invite.errors[:base]).to include(
+ I18n.t("invite.moderator_invite_requires_staff_inviter"),
+ )
+ end
+
+ it "must be single-use" do
+ invite = Invite.generate(admin, admin: true)
+
+ invite.max_redemptions_allowed = 2
+ expect(invite).not_to be_valid
+ expect(invite.errors[:max_redemptions_allowed]).to include(
+ I18n.t("invite.max_redemptions_allowed_one_staff"),
+ )
end
it "triggers an event when created" do
diff --git a/spec/requests/invites_controller_spec.rb b/spec/requests/invites_controller_spec.rb
index 6d7dbdb361e..c8833e4688b 100644
--- a/spec/requests/invites_controller_spec.rb
+++ b/spec/requests/invites_controller_spec.rb
@@ -706,7 +706,38 @@ RSpec.describe InvitesController do
expect(response.status).to eq(403)
end
- it "fails when combined with a topic, groups or a domain" do
+ it "creates a single-use admin invite link when no email is given" do
+ sign_in(admin)
+
+ post "/invites.json", params: { is_admin: "true", skip_email: "true" }
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body["grants_admin"]).to eq(true)
+
+ invite = Invite.last
+ expect(invite.admin).to eq(true)
+ expect(invite.email).to eq(nil)
+ expect(invite.max_redemptions_allowed).to eq(1)
+ end
+
+ it "creates an admin invite link restricted to a domain" do
+ sign_in(admin)
+
+ post "/invites.json",
+ params: {
+ is_admin: "true",
+ skip_email: "true",
+ domain: "example.com",
+ }
+
+ expect(response.status).to eq(200)
+
+ invite = Invite.last
+ expect(invite.admin).to eq(true)
+ expect(invite.domain).to eq("example.com")
+ end
+
+ it "fails when combined with a topic or groups" do
sign_in(admin)
topic = Fabricate(:topic)
group = Fabricate(:group)
@@ -726,9 +757,6 @@ RSpec.describe InvitesController do
group_ids: [group.id],
}
expect(response.status).to eq(400)
-
- post "/invites.json", params: { is_admin: "true", domain: "example.com" }
- expect(response.status).to eq(400)
end
it "cannot escalate an existing member invite to admin via #update" do
@@ -775,7 +803,7 @@ RSpec.describe InvitesController do
expect(invite.groups).to be_empty
end
- it "cannot strip the email from an admin invite via #update" do
+ it "can convert an admin email invite into a domain-restricted link via #update" do
sign_in(admin)
post "/invites.json", params: { email: "[email protected]", is_admin: "true" }
@@ -784,11 +812,25 @@ RSpec.describe InvitesController do
put "/invites/#{invite.id}", params: { domain: "example.com" }
- expect(response.status).to eq(422)
- expect(invite.reload.email).to eq("[email protected]")
+ expect(response.status).to eq(200)
+ expect(invite.reload.email).to eq(nil)
+ expect(invite.domain).to eq("example.com")
expect(invite.admin).to eq(true)
end
+ it "cannot raise max_redemptions_allowed on an admin invite via #update" do
+ sign_in(admin)
+
+ post "/invites.json", params: { is_admin: "true", skip_email: "true" }
+ expect(response.status).to eq(200)
+ invite = Invite.last
+
+ put "/invites/#{invite.id}", params: { max_redemptions_allowed: 10 }
+
+ expect(response.status).to eq(422)
+ expect(invite.reload.max_redemptions_allowed).to eq(1)
+ end
+
it "is rate limited" do
sign_in(admin)
RateLimiter.enable
@@ -832,7 +874,21 @@ RSpec.describe InvitesController do
expect(response.status).to eq(403)
end
- it "fails when combined with a topic, groups or a domain" do
+ it "creates a single-use moderator invite link when no email is given" do
+ sign_in(admin)
+
+ post "/invites.json", params: { is_moderator: "true", skip_email: "true" }
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body["grants_moderator"]).to eq(true)
+
+ invite = Invite.last
+ expect(invite.moderator).to eq(true)
+ expect(invite.email).to eq(nil)
+ expect(invite.max_redemptions_allowed).to eq(1)
+ end
+
+ it "fails when combined with a topic or groups" do
sign_in(admin)
topic = Fabricate(:topic)
group = Fabricate(:group)
@@ -852,9 +908,6 @@ RSpec.describe InvitesController do
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
diff --git a/spec/system/create_invite_with_roles_spec.rb b/spec/system/create_invite_with_roles_spec.rb
index a1c439ff640..ed167cb43bd 100644
--- a/spec/system/create_invite_with_roles_spec.rb
+++ b/spec/system/create_invite_with_roles_spec.rb
@@ -40,6 +40,7 @@ describe "Creating invites with roles" do
screenshot_marker(label: "invite-admins-advanced", only: :desktop)
modal.toggle_advanced_options
+ modal.select_delivery("email")
modal.form.field("email").fill_in("[email protected]")
modal.save_button.click
@@ -85,6 +86,7 @@ describe "Creating invites with roles" do
expect(modal).to be_open
expect(modal.selected_role).to eq("admin")
+ modal.select_delivery("email")
modal.form.field("email").fill_in("[email protected]")
modal.save_button.click
expect(modal).to have_summary
@@ -93,6 +95,25 @@ describe "Creating invites with roles" do
expect(banner.step_completed?("invite_collaborators")).to eq(true)
end
+ it "can create an admin invite link with a domain restriction" do
+ cdp.allow_clipboard
+
+ open_invite_modal_for(admin)
+
+ modal.select_role("admin")
+ modal.form.field("domain").fill_in("example.com")
+ modal.save_button.click
+
+ expect(modal).to have_summary
+ cdp.clipboard_has_text?(Invite.last.link)
+
+ invite = Invite.last
+ expect(invite.admin).to eq(true)
+ expect(invite.email).to eq(nil)
+ expect(invite.domain).to eq("example.com")
+ expect(invite.max_redemptions_allowed).to eq(1)
+ end
+
it "can create a member link invite with a domain restriction" do
cdp.allow_clipboard
@@ -139,6 +160,7 @@ describe "Creating invites with roles" do
open_invite_modal_for(admin)
modal.select_role("admin")
+ modal.select_delivery("email")
modal.form.field("email").fill_in("[email protected]")
modal.save_button.click
expect(modal).to have_summary