Skip to content

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

FIX: Show signup field instructions in the email code signup form (#45121)

Keegan George29c549b9335d
diff --git a/app/assets/stylesheets/common/login/code-login-form.scss b/app/assets/stylesheets/common/login/code-login-form.scss
index d0329524352..e36c4e1bab2 100644
--- a/app/assets/stylesheets/common/login/code-login-form.scss
+++ b/app/assets/stylesheets/common/login/code-login-form.scss
@@ -89,6 +89,7 @@
gap: 0.25em 0.5em;
> label,
+ > .code-login-form__field-instructions,
> .code-login-form__error {
grid-column: 1 / -1;
}
@@ -120,7 +121,9 @@
gap: 0.25em;
}
- &__name {
+ // Outweigh the base input[type="text"] margin-bottom so the name field's
+ // instructions sit as close to the input as the username field's do.
+ &__name[type="text"] {
width: 100%;
margin: 0;
}
@@ -260,6 +263,12 @@
color: var(--primary-high);
}
+ &__field-instructions {
+ font-size: var(--font-down-1);
+ color: var(--primary-medium);
+ overflow-wrap: anywhere;
+ }
+
&__error {
color: var(--danger);
diff --git a/frontend/discourse/app/components/code-login-form.gjs b/frontend/discourse/app/components/code-login-form.gjs
index 5bf0a6b1d2a..7804f6cdbf5 100644
--- a/frontend/discourse/app/components/code-login-form.gjs
+++ b/frontend/discourse/app/components/code-login-form.gjs
@@ -5,6 +5,8 @@ import { action } from "@ember/object";
import { cancel, schedule } from "@ember/runloop";
import { service } from "@ember/service";
import { trustHTML } from "@ember/template";
+import CodeLoginNameField from "discourse/components/code-login-form/name-field";
+import CodeLoginUsernameField from "discourse/components/code-login-form/username-field";
import Form from "discourse/components/form";
import AvatarSelectorModal from "discourse/components/modal/avatar-selector";
import PluginOutlet from "discourse/components/plugin-outlet";
@@ -1263,72 +1265,22 @@ export default class CodeLoginForm extends Component {
'--with-username-generator'
}}"
>
- <div class="code-login-form__username-field">
- <label for="code-login-username">
- {{i18n "code_login.username_label"}}
- </label>
- <div class="code-login-form__username-input">
- <input
- aria-describedby="code-login-username-error"
- aria-invalid={{if this.usernameError "true"}}
- autocomplete="username"
- class="code-login-form__new-account-username
- {{if this.regenerating '--swapping'}}"
- id="code-login-username"
- name="username"
- placeholder={{i18n "code_login.username_placeholder"}}
- type="text"
- value={{this.username}}
- {{on "input" this.usernameChanged}}
- />
- {{#if this.siteSettings.enable_random_usernames}}
- <DButton
- aria-busy={{if this.regenerating "true"}}
- class="btn-default code-login-form__username-regen
- {{if this.regenerating '--rolling'}}"
- @action={{this.regenerateUsername}}
- @ariaLabel="code_login.regenerate_username"
- @icon="dice"
- @title="code_login.regenerate_username"
- />
- {{/if}}
- </div>
- <div
- aria-live="polite"
- class="code-login-form__error"
- id="code-login-username-error"
- role="alert"
- >
- {{this.usernameError}}
- </div>
- </div>
+ <CodeLoginUsernameField
+ @autocomplete="username"
+ @error={{this.usernameError}}
+ @onInput={{this.usernameChanged}}
+ @onRegenerate={{this.regenerateUsername}}
+ @regenerating={{this.regenerating}}
+ @value={{this.username}}
+ />
{{#if this.site.full_name_visible_in_signup}}
- <div class="code-login-form__name-field">
- <label for="code-login-name">
- {{i18n "user.name.title"}}
- </label>
- <input
- aria-describedby="code-login-name-error"
- aria-invalid={{if this.nameError "true"}}
- autocomplete="name"
- class="code-login-form__name"
- id="code-login-name"
- maxlength="255"
- name="name"
- type="text"
- value={{this.name}}
- {{on "input" this.nameChanged}}
- />
- <div
- aria-live="polite"
- class="code-login-form__error"
- id="code-login-name-error"
- role="alert"
- >
- {{this.nameError}}
- </div>
- </div>
+ <CodeLoginNameField
+ @error={{this.nameError}}
+ @onInput={{this.nameChanged}}
+ @required={{this.nameRequired}}
+ @value={{this.name}}
+ />
{{/if}}
{{#if this.showOptionalPassword}}
@@ -1457,47 +1409,15 @@ export default class CodeLoginForm extends Component {
{{/if}}
</button>
- <div class="code-login-form__username-field">
- <label for="code-login-username">
- {{i18n "code_login.username_label"}}
- </label>
- <div class="code-login-form__username-input">
- <input
- aria-describedby="code-login-username-error"
- aria-invalid={{if this.usernameError "true"}}
- autocomplete="off"
- class="code-login-form__new-account-username
- {{if this.regenerating '--swapping'}}"
- disabled={{this.verifying}}
- id="code-login-username"
- name="username"
- placeholder={{i18n "code_login.username_placeholder"}}
- type="text"
- value={{this.username}}
- {{on "input" this.usernameChanged}}
- />
- {{#if this.siteSettings.enable_random_usernames}}
- <DButton
- aria-busy={{if this.regenerating "true"}}
- class="btn-default code-login-form__username-regen
- {{if this.regenerating '--rolling'}}"
- @action={{this.regenerateUsername}}
- @ariaLabel="code_login.regenerate_username"
- @disabled={{this.verifying}}
- @icon="dice"
- @title="code_login.regenerate_username"
- />
- {{/if}}
- </div>
- <div
- aria-live="polite"
- class="code-login-form__error"
- id="code-login-username-error"
- role="alert"
- >
- {{this.usernameError}}
- </div>
- </div>
+ <CodeLoginUsernameField
+ @autocomplete="off"
+ @disabled={{this.verifying}}
+ @error={{this.usernameError}}
+ @onInput={{this.usernameChanged}}
+ @onRegenerate={{this.regenerateUsername}}
+ @regenerating={{this.regenerating}}
+ @value={{this.username}}
+ />
</div>
{{/unless}}
@@ -1535,31 +1455,12 @@ export default class CodeLoginForm extends Component {
{{/unless}}
{{#if this.nameRequired}}
- <div class="code-login-form__name-field">
- <label for="code-login-name">
- {{i18n "user.name.title"}}
- </label>
- <input
- aria-describedby="code-login-name-error"
- aria-invalid={{if this.nameError "true"}}
- autocomplete="name"
- class="code-login-form__name"
- id="code-login-name"
- maxlength="255"
- name="name"
- type="text"
- value={{this.name}}
- {{on "input" this.nameChanged}}
- />
- <div
- aria-live="polite"
- class="code-login-form__error"
- id="code-login-name-error"
- role="alert"
- >
- {{this.nameError}}
- </div>
- </div>
+ <CodeLoginNameField
+ @error={{this.nameError}}
+ @onInput={{this.nameChanged}}
+ @required={{true}}
+ @value={{this.name}}
+ />
{{/if}}
<div class="user-fields">
diff --git a/frontend/discourse/app/components/code-login-form/name-field.gjs b/frontend/discourse/app/components/code-login-form/name-field.gjs
new file mode 100644
index 00000000000..647b2cb752a
--- /dev/null
+++ b/frontend/discourse/app/components/code-login-form/name-field.gjs
@@ -0,0 +1,57 @@
+import Component from "@glimmer/component";
+import { on } from "@ember/modifier";
+import { service } from "@ember/service";
+import { i18n } from "discourse-i18n";
+
+export default class CodeLoginNameField extends Component {
+ @service siteSettings;
+
+ get showInstructions() {
+ return (
+ this.siteSettings.show_signup_form_full_name_instructions &&
+ !this.args.error
+ );
+ }
+
+ get instructions() {
+ return this.args.required
+ ? i18n("user.name.instructions_required")
+ : i18n("user.name.instructions");
+ }
+
+ <template>
+ <div class="code-login-form__name-field">
+ <label for="code-login-name">
+ {{i18n "user.name.title"}}
+ </label>
+ <input
+ aria-describedby="code-login-name-instructions code-login-name-error"
+ aria-invalid={{if @error "true"}}
+ autocomplete="name"
+ class="code-login-form__name"
+ id="code-login-name"
+ maxlength="255"
+ name="name"
+ type="text"
+ value={{@value}}
+ {{on "input" @onInput}}
+ />
+ {{#if this.showInstructions}}
+ <span
+ class="more-info code-login-form__field-instructions"
+ id="code-login-name-instructions"
+ >
+ {{this.instructions}}
+ </span>
+ {{/if}}
+ <div
+ aria-live="polite"
+ class="code-login-form__error"
+ id="code-login-name-error"
+ role="alert"
+ >
+ {{@error}}
+ </div>
+ </div>
+ </template>
+}
diff --git a/frontend/discourse/app/components/code-login-form/username-field.gjs b/frontend/discourse/app/components/code-login-form/username-field.gjs
new file mode 100644
index 00000000000..a7265f4e91b
--- /dev/null
+++ b/frontend/discourse/app/components/code-login-form/username-field.gjs
@@ -0,0 +1,68 @@
+import Component from "@glimmer/component";
+import { on } from "@ember/modifier";
+import { service } from "@ember/service";
+import DButton from "discourse/ui-kit/d-button";
+import { i18n } from "discourse-i18n";
+
+export default class CodeLoginUsernameField extends Component {
+ @service siteSettings;
+
+ get showInstructions() {
+ return (
+ this.siteSettings.show_signup_form_username_instructions &&
+ !this.args.error
+ );
+ }
+
+ <template>
+ <div class="code-login-form__username-field">
+ <label for="code-login-username">
+ {{i18n "code_login.username_label"}}
+ </label>
+ <div class="code-login-form__username-input">
+ <input
+ aria-describedby="code-login-username-instructions code-login-username-error"
+ aria-invalid={{if @error "true"}}
+ autocomplete={{@autocomplete}}
+ class="code-login-form__new-account-username
+ {{if @regenerating '--swapping'}}"
+ disabled={{@disabled}}
+ id="code-login-username"
+ name="username"
+ placeholder={{i18n "code_login.username_placeholder"}}
+ type="text"
+ value={{@value}}
+ {{on "input" @onInput}}
+ />
+ {{#if this.siteSettings.enable_random_usernames}}
+ <DButton
+ aria-busy={{if @regenerating "true"}}
+ class="btn-default code-login-form__username-regen
+ {{if @regenerating '--rolling'}}"
+ @action={{@onRegenerate}}
+ @ariaLabel="code_login.regenerate_username"
+ @disabled={{@disabled}}
+ @icon="dice"
+ @title="code_login.regenerate_username"
+ />
+ {{/if}}
+ </div>
+ {{#if this.showInstructions}}
+ <span
+ class="more-info code-login-form__field-instructions"
+ id="code-login-username-instructions"
+ >
+ {{i18n "user.username.instructions"}}
+ </span>
+ {{/if}}
+ <div
+ aria-live="polite"
+ class="code-login-form__error"
+ id="code-login-username-error"
+ role="alert"
+ >
+ {{@error}}
+ </div>
+ </div>
+ </template>
+}
diff --git a/frontend/discourse/tests/integration/components/code-login-form-test.gjs b/frontend/discourse/tests/integration/components/code-login-form-test.gjs
index 64b2dbf03ce..4a6fd69057b 100644
--- a/frontend/discourse/tests/integration/components/code-login-form-test.gjs
+++ b/frontend/discourse/tests/integration/components/code-login-form-test.gjs
@@ -1152,6 +1152,57 @@ module("Integration | Component | CodeLoginForm", function (hooks) {
assert.dom(".code-login-form__continue-to-site").isDisabled();
});
+ test("shows username instructions when picking a username", async function (assert) {
+ this.siteSettings.show_signup_form_username_instructions = true;
+ stubCodeRequest();
+ pretender.post("/session/login-code/verify", () =>
+ response({
+ username_required: true,
+ username: null,
+ avatar_template: null,
+ can_upload_avatar: true,
+ })
+ );
+
+ await goToCodeStep();
+ await fillIn(".d-otp-input", "123456");
+
+ assert
+ .dom(
+ ".code-login-form__signup-details-step #code-login-username-instructions"
+ )
+ .hasText(i18n("user.username.instructions"));
+ });
+
+ test("shows field instructions on the account details step", async function (assert) {
+ this.siteSettings.show_signup_form_username_instructions = true;
+ this.siteSettings.show_signup_form_full_name_instructions = true;
+ this.site.full_name_visible_in_signup = true;
+ this.site.full_name_required_for_signup = true;
+ this.owner.lookup("service:session-store").setObject({
+ key: "email-code-signup-continuation",
+ value: {
+ email: "[email protected]",
+ expiresAt: Date.now() + 60_000,
+ signupToken: "signup-token",
+ username: "",
+ },
+ });
+
+ await render(<template><CodeLoginForm @context="signup" /></template>);
+
+ assert
+ .dom(
+ ".code-login-form__account-details-step #code-login-username-instructions"
+ )
+ .hasText(i18n("user.username.instructions"));
+ assert
+ .dom(
+ ".code-login-form__account-details-step #code-login-name-instructions"
+ )
+ .hasText(i18n("user.name.instructions_required"));
+ });
+
test("keeps the avatar read-only when it can't be edited", async function (assert) {
stubCodeRequest();
pretender.post("/session/login-code/verify", () =>
diff --git a/frontend/discourse/tests/integration/components/code-login-form/name-field-test.gjs b/frontend/discourse/tests/integration/components/code-login-form/name-field-test.gjs
new file mode 100644
index 00000000000..348ba871a6e
--- /dev/null
+++ b/frontend/discourse/tests/integration/components/code-login-form/name-field-test.gjs
@@ -0,0 +1,57 @@
+import { render } from "@ember/test-helpers";
+import { module, test } from "qunit";
+import CodeLoginNameField from "discourse/components/code-login-form/name-field";
+import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import { i18n } from "discourse-i18n";
+
+const noop = () => {};
+
+module("Integration | Component | CodeLoginNameField", function (hooks) {
+ setupRenderingTest(hooks);
+
+ test("hides instructions by default", async function (assert) {
+ this.siteSettings.show_signup_form_full_name_instructions = false;
+
+ await render(<template><CodeLoginNameField @onInput={{noop}} /></template>);
+
+ assert.dom("#code-login-name").exists();
+ assert.dom("#code-login-name-instructions").doesNotExist();
+ });
+
+ test("shows required instructions when the name is required", async function (assert) {
+ this.siteSettings.show_signup_form_full_name_instructions = true;
+
+ await render(
+ <template>
+ <CodeLoginNameField @onInput={{noop}} @required={{true}} />
+ </template>
+ );
+
+ assert
+ .dom("#code-login-name-instructions")
+ .hasText(i18n("user.name.instructions_required"));
+ });
+
+ test("shows optional instructions when the name is optional", async function (assert) {
+ this.siteSettings.show_signup_form_full_name_instructions = true;
+
+ await render(<template><CodeLoginNameField @onInput={{noop}} /></template>);
+
+ assert
+ .dom("#code-login-name-instructions")
+ .hasText(i18n("user.name.instructions"));
+ });
+
+ test("replaces instructions with the error", async function (assert) {
+ this.siteSettings.show_signup_form_full_name_instructions = true;
+
+ await render(
+ <template>
+ <CodeLoginNameField @error="Name is required" @onInput={{noop}} />
+ </template>
+ );
+
+ assert.dom("#code-login-name-instructions").doesNotExist();
+ assert.dom("#code-login-name-error").hasText("Name is required");
+ });
+});
diff --git a/frontend/discourse/tests/integration/components/code-login-form/username-field-test.gjs b/frontend/discourse/tests/integration/components/code-login-form/username-field-test.gjs
new file mode 100644
index 00000000000..2f4ba34e4c3
--- /dev/null
+++ b/frontend/discourse/tests/integration/components/code-login-form/username-field-test.gjs
@@ -0,0 +1,79 @@
+import { fillIn, render } from "@ember/test-helpers";
+import { module, test } from "qunit";
+import CodeLoginUsernameField from "discourse/components/code-login-form/username-field";
+import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import { i18n } from "discourse-i18n";
+
+const noop = () => {};
+
+module("Integration | Component | CodeLoginUsernameField", function (hooks) {
+ setupRenderingTest(hooks);
+
+ test("hides instructions by default", async function (assert) {
+ this.siteSettings.show_signup_form_username_instructions = false;
+
+ await render(
+ <template><CodeLoginUsernameField @onInput={{noop}} /></template>
+ );
+
+ assert.dom("#code-login-username").exists();
+ assert.dom("#code-login-username-instructions").doesNotExist();
+ });
+
+ test("shows instructions when the site setting is enabled", async function (assert) {
+ this.siteSettings.show_signup_form_username_instructions = true;
+
+ await render(
+ <template><CodeLoginUsernameField @onInput={{noop}} /></template>
+ );
+
+ assert
+ .dom("#code-login-username-instructions")
+ .hasText(i18n("user.username.instructions"));
+ assert
+ .dom("#code-login-username")
+ .hasAttribute(
+ "aria-describedby",
+ "code-login-username-instructions code-login-username-error"
+ );
+ });
+
+ test("replaces instructions with the error", async function (assert) {
+ this.siteSettings.show_signup_form_username_instructions = true;
+
+ await render(
+ <template>
+ <CodeLoginUsernameField @error="Username taken" @onInput={{noop}} />
+ </template>
+ );
+
+ assert.dom("#code-login-username-instructions").doesNotExist();
+ assert.dom("#code-login-username-error").hasText("Username taken");
+ assert.dom("#code-login-username").hasAttribute("aria-invalid", "true");
+ });
+
+ test("passes input and attributes through", async function (assert) {
+ let typed;
+ const onInput = (event) => (typed = event.target.value);
+
+ await render(
+ <template>
+ <CodeLoginUsernameField
+ @autocomplete="off"
+ @disabled={{false}}
+ @onInput={{onInput}}
+ @value="jane"
+ />
+ </template>
+ );
+
+ assert
+ .dom("#code-login-username")
+ .hasValue("jane")
+ .hasAttribute("autocomplete", "off");
+
+ await fillIn("#code-login-username", "joe");
+
+ assert.strictEqual(typed, "joe");
+ });
+});
diff --git a/spec/system/code_signup_spec.rb b/spec/system/code_signup_spec.rb
index 25f0dfda812..263ae05438c 100644
--- a/spec/system/code_signup_spec.rb
+++ b/spec/system/code_signup_spec.rb
@@ -149,6 +149,23 @@ describe "Sign up via email code" do
expect(User.find_by_email("[email protected]").username).to eq("no-random")
end
+ it "shows username instructions when enabled" do
+ SiteSetting.show_signup_form_username_instructions = true
+
+ open_code_signup
+ submit_email("[email protected]")
+ fill_code(latest_emailed_code("[email protected]"))
+
+ expect(page).to have_css(
+ "#code-login-username-instructions",
+ text: I18n.t("js.user.username.instructions"),
+ )
+
+ fill_in("code-login-username", with: "a b")
+ expect(page).to have_css("#code-login-username-error", text: /\S/)
+ expect(page).to have_no_css("#code-login-username-instructions")
+ end
+
it "lets the user choose their initial username when later changes are disabled" do
SiteSetting.username_change_period = 0