A platform for community discussion. Free, open, simple.
DEV: Render enum site settings with FormKit (#42397)
Régis Hanola11efb4daec8
diff --git a/frontend/discourse/admin/components/site-setting.gjs b/frontend/discourse/admin/components/site-setting.gjsindex cff59bd706e..7283a048342 100644--- a/frontend/discourse/admin/components/site-setting.gjs+++ b/frontend/discourse/admin/components/site-setting.gjs@@ -791,6 +791,7 @@ export default class SiteSettingComponent extends Component {@disabled={{this.isDisabled}}/></Form>+ {{this.preview}}{{else}}<this.resolvedComponent{{on "keydown" this._handleKeydown}}diff --git a/frontend/discourse/app/components/setting-field/enum.gjs b/frontend/discourse/app/components/setting-field/enum.gjsindex be7ebbd2c50..54d5894ceb8 100644--- a/frontend/discourse/app/components/setting-field/enum.gjs+++ b/frontend/discourse/app/components/setting-field/enum.gjs@@ -30,6 +30,19 @@ export default class SettingFieldEnum extends Component {);}+ get fallbackChoice() {+ const selected = this.selectedValue;++ if (+ selected === "" ||+ this.choices.some(({ value }) => value === selected)+ ) {+ return null;+ }++ return { value: selected, name: selected };+ }+get selectedValue() {return String(this.args.field.value ?? "");}@@ -53,10 +66,15 @@ export default class SettingFieldEnum extends Component {</option>{{/if}}{{#each this.choices as |choice|}}- <select.Option @value={{choice.value}} @selected={{this.selectedValue}}>+ <select.Option @value={{choice.value}}>{{choice.name}}</select.Option>{{/each}}+ {{#if this.fallbackChoice}}+ <select.Option @value={{this.fallbackChoice.value}}>+ {{this.fallbackChoice.name}}+ </select.Option>+ {{/if}}</@field.Control></template>}diff --git a/frontend/discourse/app/components/setting-field/locale-enum.gjs b/frontend/discourse/app/components/setting-field/locale-enum.gjsnew file mode 100644index 00000000000..c850a3b28f8--- /dev/null+++ b/frontend/discourse/app/components/setting-field/locale-enum.gjs@@ -0,0 +1,13 @@+import { service } from "@ember/service";+import EnumControl from "discourse/components/setting-field/enum";++export default class SettingFieldLocaleEnum extends EnumControl {+ @service languageNameLookup;++ get rawChoices() {+ return super.rawChoices.map(({ value }) => ({+ value,+ name: this.languageNameLookup.getLanguageName(value),+ }));+ }+}diff --git a/frontend/discourse/app/lib/setting-field-registry.js b/frontend/discourse/app/lib/setting-field-registry.jsindex 041ffe8128c..bb429e45092 100644--- a/frontend/discourse/app/lib/setting-field-registry.js+++ b/frontend/discourse/app/lib/setting-field-registry.js@@ -5,6 +5,7 @@ import DurationControl from "discourse/components/setting-field/duration";import EnumControl from "discourse/components/setting-field/enum";import GroupListControl from "discourse/components/setting-field/group-list";import IntegerControl from "discourse/components/setting-field/integer";+import LocaleEnumControl from "discourse/components/setting-field/locale-enum";import RadioGroupControl from "discourse/components/setting-field/radio-group";const REGISTRY = {};@@ -81,8 +82,15 @@ registerSettingFieldType("radio-group", {registerSettingFieldType("enum", {...ROW,type: "select",+ adminReady: true,renderer: EnumControl,});+registerSettingFieldType("locale_enum", {+ ...ROW,+ type: "select",+ adminReady: true,+ renderer: LocaleEnumControl,+});registerSettingFieldType("group_list", {...ROW,type: "custom",diff --git a/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs b/frontend/discourse/tests/integration/components/setting-definition-field-test.gjsindex 4969aa3ccdf..7a58b094cd9 100644--- a/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs+++ b/frontend/discourse/tests/integration/components/setting-definition-field-test.gjs@@ -748,4 +748,93 @@ module("Integration | Component | SettingDefinitionField", function (hooks) {assert.dom("[data-name='my_setting']").hasClass("--full");});++ test("enum keeps a stored value that is no longer one of the choices", async function (assert) {+ await render(+ <template>+ <Form @data={{hash my_enum="retired"}} as |form|>+ <SettingDefinitionField+ @definition={{hash+ key="my_enum"+ type="enum"+ label="My enum"+ valid_values=(array+ (hash value="a" name="Apple") (hash value="b" name="Banana")+ )+ }}+ @form={{form}}+ />+ </Form>+ </template>+ );++ assert+ .dom("[data-name='my_enum'] select option[value='retired']")+ .exists("the stored value is offered as its own option");+ assert+ .dom("[data-name='my_enum'] select")+ .hasValue(+ "retired",+ "a native select would otherwise silently fall back to the first option"+ );+ });++ test("enum does not invent an option for a blank value", async function (assert) {+ await render(+ <template>+ <Form @data={{hash my_enum=""}} as |form|>+ <SettingDefinitionField+ @definition={{hash+ key="my_enum"+ type="enum"+ label="My enum"+ allows_none=true+ valid_values=(array+ (hash value="a" name="Apple") (hash value="b" name="Banana")+ )+ }}+ @form={{form}}+ />+ </Form>+ </template>+ );++ assert+ .dom("[data-name='my_enum'] select option")+ .exists({ count: 3 }, "none plus the two real choices");+ });++ test("locale_enum labels each option with its language name", async function (assert) {+ this.siteSettings.available_locales = [+ { value: "en", name: "English (US)" },+ { value: "fr", name: "French (Français)" },+ ];++ await render(+ <template>+ <Form @data={{hash default_locale="fr"}} as |form|>+ <SettingDefinitionField+ @definition={{hash+ key="default_locale"+ type="locale_enum"+ label="Default locale"+ valid_values=(array+ (hash value="en" name="languages.en.name")+ (hash value="fr" name="languages.fr.name")+ )+ }}+ @form={{form}}+ />+ </Form>+ </template>+ );++ assert+ .dom("[data-name='default_locale'] select option[value='fr']")+ .hasText(+ "French (Français)",+ "the localized name is composed with the native name"+ );+ assert.form().field("default_locale").hasValue("fr");+ });});diff --git a/frontend/discourse/tests/integration/components/site-setting-test.gjs b/frontend/discourse/tests/integration/components/site-setting-test.gjsindex 3d9fe8f0232..2a5da6acb26 100644--- a/frontend/discourse/tests/integration/components/site-setting-test.gjs+++ b/frontend/discourse/tests/integration/components/site-setting-test.gjs@@ -307,6 +307,25 @@ module("Integration | Component | SiteSetting", function (hooks) {assert.dom(".form-kit__control-password").hasAttribute("type", "text");});+ test("an enum setting renders its preview and keeps it in sync", async function (assert) {+ await renderSetting({+ setting: "tag_style",+ value: "simple",+ type: "enum",+ preview: '<span class="tag-preview">{{value}}</span>',+ valid_values: [+ { name: "Simple", value: "simple" },+ { name: "Box", value: "box" },+ ],+ });++ assert.dom(".preview .tag-preview").hasText("simple");++ await fillIn(".form-kit__control-select", "box");++ assert.dom(".preview .tag-preview").hasText("box");+ });+test("a secret setting that is also a textarea stays readable", async function (assert) {await renderSetting({setting: "test_setting",@@ -508,10 +527,7 @@ module("Integration | Component | SiteSetting", function (hooks) {],});- const selector = selectKit(".select-kit");-- await selector.expand();- await selector.selectRowByValue("1");+ await fillIn(".form-kit__control-select", "1");assert.dom(".setting-controls__ok")@@ -520,8 +536,7 @@ module("Integration | Component | SiteSetting", function (hooks) {.dom(".setting-controls__cancel").exists("the cancel button is shown after changing the value");- await selector.expand();- await selector.selectRowByValue("2");+ await fillIn(".form-kit__control-select", "2");assert.dom(".setting-controls__ok")diff --git a/frontend/discourse/tests/unit/lib/setting-field-registry-test.js b/frontend/discourse/tests/unit/lib/setting-field-registry-test.jsindex f1d3480574a..cc1ad0a4a09 100644--- a/frontend/discourse/tests/unit/lib/setting-field-registry-test.js+++ b/frontend/discourse/tests/unit/lib/setting-field-registry-test.js@@ -84,6 +84,8 @@ module("Unit | Lib | setting-field-registry", function () {"email","textarea","password",+ "enum",+ "locale_enum",]) {assert.true(resolveSettingFieldType({ type }).adminReady,diff --git a/spec/system/admin_site_setting_enum_spec.rb b/spec/system/admin_site_setting_enum_spec.rbnew file mode 100644index 00000000000..1c604ccef10--- /dev/null+++ b/spec/system/admin_site_setting_enum_spec.rb@@ -0,0 +1,29 @@+# frozen_string_literal: true++describe "Admin site setting enum" do+ let(:settings_page) { PageObjects::Pages::AdminSiteSettings.new }+ fab!(:admin)++ before { sign_in(admin) }++ it "saves a string-valued enum and keeps the preview in sync" do+ settings_page.visit("tag_style")+ settings_page.select_enum_value("tag_style", "box")++ expect(settings_page.find_setting("tag_style")).to have_css(".preview .discourse-tag.box")++ settings_page.save_setting("tag_style")+ page.refresh++ expect(settings_page.enum_setting("tag_style").value).to eq("box")+ end++ it "round-trips an integer-valued enum" do+ settings_page.visit("hide_post_sensitivity")+ settings_page.select_enum_value("hide_post_sensitivity", "0")+ settings_page.save_setting("hide_post_sensitivity")+ page.refresh++ expect(settings_page.enum_setting("hide_post_sensitivity").value).to eq("0")+ end+enddiff --git a/spec/system/admin_site_setting_locale_spec.rb b/spec/system/admin_site_setting_locale_spec.rbindex 6f4b767b903..374cff4ebe0 100644--- a/spec/system/admin_site_setting_locale_spec.rb+++ b/spec/system/admin_site_setting_locale_spec.rb@@ -15,13 +15,17 @@ describe "Admin Site Setting Locales" dosettings_page.visitsettings_page.type_in_search("default locale")- expect(settings_page.find_setting("default_locale")).to have_content("Español")+ expect(settings_page.enum_setting("default_locale").value).to eq("es")settings_page.select_enum_value("default_locale", "en")settings_page.save_setting("default_locale")settings_page.type_in_search("default locale")- expect(settings_page.find_setting("default_locale")).to have_content("Inglés (English)")+ expect(settings_page.enum_setting("default_locale").value).to eq("en")+ expect(settings_page.find_setting("default_locale")).to have_css(+ "option[value='en']",+ text: "Inglés (English)",+ )endenddiff --git a/spec/system/page_objects/pages/admin_site_settings.rb b/spec/system/page_objects/pages/admin_site_settings.rbindex f3b34c9f192..cb72a703d93 100644--- a/spec/system/page_objects/pages/admin_site_settings.rb+++ b/spec/system/page_objects/pages/admin_site_settings.rb@@ -42,15 +42,16 @@ module PageObjectsenddef select_enum_value(setting_name, value)- setting =- PageObjects::Components::SelectKit.new(- ".row.setting[data-setting='#{setting_name}'] .single-select",- )- setting.expand- setting.select_row_by_value(value)+ enum_setting(setting_name).select(value)selfend+ def enum_setting(setting_name)+ PageObjects::Components::FormKitField.new(+ find_setting(setting_name).find("[data-name='#{setting_name}']"),+ )+ end+def has_setting?(setting_name)has_css?(".row.setting[data-setting=\"#{setting_name}\"]")end