A platform for community discussion. Free, open, simple.
UX: Make `depends_behavior: hidden` site settings react without a reload (#39403)
Régis Hanol5f0b41013fd3
diff --git a/frontend/discourse/admin/components/admin-area-settings.gjs b/frontend/discourse/admin/components/admin-area-settings.gjsindex 0cc496de63c..17acae2d2ca 100644--- a/frontend/discourse/admin/components/admin-area-settings.gjs+++ b/frontend/discourse/admin/components/admin-area-settings.gjs@@ -2,6 +2,7 @@ import Component from "@glimmer/component";import { tracked } from "@glimmer/tracking";import { action } from "@ember/object";import didUpdate from "@ember/render-modifiers/modifiers/did-update";+import { service } from "@ember/service";import AdminConfigAreaEmptyList from "discourse/admin/components/admin-config-area-empty-list";import AdminFilteredSiteSettings from "discourse/admin/components/admin-filtered-site-settings";import AdminSiteSettingsChangesBanner from "discourse/admin/components/admin-site-settings-changes-banner";@@ -13,6 +14,8 @@ import { bind } from "discourse/lib/decorators";import { i18n } from "discourse-i18n";export default class AdminAreaSettings extends Component {+ @service adminSiteSettingStore;+@tracked settings = [];@tracked loading = false;@@ -45,13 +48,15 @@ export default class AdminAreaSettings extends Component {categories: this.args.categories,},});+ const siteSettings = result.site_settings.map((setting) =>+ SiteSetting.create(setting)+ );+ this.adminSiteSettingStore.register(siteSettings);this.settings = [{name: "All",nameKey: "all_results",- siteSettings: result.site_settings.map((setting) =>- SiteSetting.create(setting)- ),+ siteSettings,},];} catch (error) {diff --git a/frontend/discourse/admin/components/admin-filtered-site-settings.gjs b/frontend/discourse/admin/components/admin-filtered-site-settings.gjsindex f96da6ca2d2..77de63c5c52 100644--- a/frontend/discourse/admin/components/admin-filtered-site-settings.gjs+++ b/frontend/discourse/admin/components/admin-filtered-site-settings.gjs@@ -2,6 +2,7 @@ import Component from "@glimmer/component";import { tracked } from "@glimmer/tracking";import { action } from "@ember/object";import { cancel } from "@ember/runloop";+import { service } from "@ember/service";import { isEmpty } from "@ember/utils";import AdminSiteSettingsFilterControls from "discourse/admin/components/admin-site-settings-filter-controls";import SiteSetting from "discourse/admin/components/site-setting";@@ -12,7 +13,10 @@ import discourseDebounce from "discourse/lib/debounce";import { i18n } from "discourse-i18n";export default class AdminFilteredSiteSettings extends Component {- @tracked visibleSettings;+ @service adminSiteSettingStore;++ @tracked matchedSettings;+ @tracked activeFilter = "";@tracked loading = true;siteSettingFilter = new SiteSettingFilter(this.args.settings);@@ -27,6 +31,12 @@ export default class AdminFilteredSiteSettings extends Component {this._debouncedOnChangeFilter(filterData);}+ get visibleSettings() {+ return this.matchedSettings?.filter((setting) =>+ this.adminSiteSettingStore.isVisible(setting, this.activeFilter)+ );+ }+get noResults() {return isEmpty(this.visibleSettings) && !this.loading;}@@ -43,7 +53,8 @@ export default class AdminFilteredSiteSettings extends Component {filterSettings(filterData) {this.args.onFilterChanged(filterData);- this.visibleSettings = this.siteSettingFilter.filterSettings(+ this.activeFilter = filterData.filter ?? "";+ this.matchedSettings = this.siteSettingFilter.filterSettings(filterData.filter,{includeAllCategory: false,diff --git a/frontend/discourse/admin/components/site-setting.gjs b/frontend/discourse/admin/components/site-setting.gjsindex f4eeca27c9f..7fe5402bfb5 100644--- a/frontend/discourse/admin/components/site-setting.gjs+++ b/frontend/discourse/admin/components/site-setting.gjs@@ -13,7 +13,9 @@ import { isNone } from "@ember/utils";import SettingValidationMessage from "discourse/admin/components/setting-validation-message";import Description from "discourse/admin/components/site-settings/description";import JobStatus from "discourse/admin/components/site-settings/job-status";-import SiteSetting from "discourse/admin/models/site-setting";+import SiteSetting, {+ isSettingValueTrue,+} from "discourse/admin/models/site-setting";import DButton from "discourse/components/d-button";import JsonSchemaEditorModal from "discourse/components/modal/json-schema-editor";import PluginOutlet from "discourse/components/plugin-outlet";@@ -62,6 +64,7 @@ const CUSTOM_TYPES = [export default class SiteSettingComponent extends Component {@service modal;@service router;+ @service adminSiteSettingStore;@service siteSettingChangeTracker;@service messageBus;@service site;@@ -361,7 +364,23 @@ export default class SiteSettingComponent extends Component {}get isDisabled() {- return this.setting.themeable || this.setting.disabled;+ return (+ this.setting.themeable ||+ this.setting.disabled ||+ this.isDisabledByDependency+ );+ }++ get isDisabledByDependency() {+ if (this.setting.depends_behavior !== "hidden") {+ return false;+ }+ return (+ this.setting.depends_on?.some((name) => {+ const parent = this.adminSiteSettingStore.get(name);+ return parent && !isSettingValueTrue(parent.buffered.get("value"));+ }) ?? false+ );}get canUpdate() {@@ -433,6 +452,9 @@ export default class SiteSettingComponent extends Component {@actionchangeValueCallback(value) {this.buffered.set("value", value);+ if (isSettingValueTrue(value)) {+ this.adminSiteSettingStore.reveal(this.setting.setting);+ }}@action@@ -450,6 +472,9 @@ export default class SiteSettingComponent extends Component {resetDefault() {this.buffered.set("value", this.setting.default);this.setting.validationMessage = null;+ if (isSettingValueTrue(this.setting.default)) {+ this.adminSiteSettingStore.reveal(this.setting.setting);+ }}@action@@ -493,7 +518,8 @@ export default class SiteSettingComponent extends Component {class="row setting{{this.typeClass}}{{if this.overridden 'overridden'}}- {{if this.isDisabled 'disabled'}}"+ {{if this.isDisabled 'disabled'}}+ {{if this.isDisabledByDependency 'disabled-by-dependency'}}"...attributes><div class="setting-label">diff --git a/frontend/discourse/admin/components/site-settings/bool.gjs b/frontend/discourse/admin/components/site-settings/bool.gjsindex 73cc6a81138..03b3a65f9bc 100644--- a/frontend/discourse/admin/components/site-settings/bool.gjs+++ b/frontend/discourse/admin/components/site-settings/bool.gjs@@ -2,13 +2,11 @@ import Component from "@glimmer/component";import { on } from "@ember/modifier";import { action } from "@ember/object";import { trustHTML } from "@ember/template";-import { isEmpty } from "@ember/utils";+import { isSettingValueTrue } from "discourse/admin/models/site-setting";export default class Bool extends Component {get enabled() {- return isEmpty(this.args.value)- ? false- : this.args.value.toString() === "true";+ return isSettingValueTrue(this.args.value);}@actiondiff --git a/frontend/discourse/admin/controllers/admin-site-settings-category.js b/frontend/discourse/admin/controllers/admin-site-settings-category.jsindex 4c96de7b87e..1da516f7954 100644--- a/frontend/discourse/admin/controllers/admin-site-settings-category.js+++ b/frontend/discourse/admin/controllers/admin-site-settings-category.js@@ -1,13 +1,20 @@import { tracked } from "@glimmer/tracking";-import Controller from "@ember/controller";+import Controller, { inject as controller } from "@ember/controller";import { dependentKeyCompat } from "@ember/object/compat";+import { service } from "@ember/service";export default class AdminSiteSettingsCategoryController extends Controller {+ @service adminSiteSettingStore;+ @controller adminSiteSettings;+@tracked model;@dependentKeyCompatget filteredSiteSettings() {- return this.model;+ const filter = this.adminSiteSettings.activeFilter;+ return this.model?.filter((setting) =>+ this.adminSiteSettingStore.isVisible(setting, filter)+ );}set filteredSiteSettings(value) {diff --git a/frontend/discourse/admin/controllers/admin-site-settings.js b/frontend/discourse/admin/controllers/admin-site-settings.jsindex 25144423fe1..5be9a3ec754 100644--- a/frontend/discourse/admin/controllers/admin-site-settings.js+++ b/frontend/discourse/admin/controllers/admin-site-settings.js@@ -27,6 +27,15 @@ export default class AdminSiteSettingsController extends Controller {set(this, "model.filtersApplied", value);}+ @computed("model.activeFilter")+ get activeFilter() {+ return this.model?.activeFilter ?? "";+ }++ set activeFilter(value) {+ set(this, "model.activeFilter", value);+ }+@debounce(INPUT_DELAY)filterContent(filterData) {if (this._skipBounce) {diff --git a/frontend/discourse/admin/models/site-setting.js b/frontend/discourse/admin/models/site-setting.jsindex cf767ab7e5b..1bb805758a7 100644--- a/frontend/discourse/admin/models/site-setting.js+++ b/frontend/discourse/admin/models/site-setting.js@@ -10,6 +10,16 @@ import { ajax } from "discourse/lib/ajax";import { bind } from "discourse/lib/decorators";import { i18n } from "discourse-i18n";+/**+ * `true` when a value is the *enabled* state of a bool site setting: boolean+ * `true`, the string `"true"`, or any value whose `String()` is exactly `"true"`.+ * This is not general JS truthiness: `"false"` is not enabled, and is safe+ * for `null` / `undefined` (unlike calling `.toString()` on the value).+ */+export function isSettingValueTrue(value) {+ return String(value) === "true";+}+const AUTO_REFRESH_ON_SAVE = ["logo","mobile_logo",@@ -149,7 +159,7 @@ export default class SiteSetting extends EmberObject {return true;case SITE_SETTING_REQUIRES_CONFIRMATION_TYPES.simple_on_enable: {const val = this.buffered?.get("value");- return val === true || val === "true";+ return isSettingValueTrue(val);}default:return false;diff --git a/frontend/discourse/admin/routes/admin-site-settings.js b/frontend/discourse/admin/routes/admin-site-settings.jsindex 257a134f16a..49f2fb35786 100644--- a/frontend/discourse/admin/routes/admin-site-settings.js+++ b/frontend/discourse/admin/routes/admin-site-settings.js@@ -6,6 +6,7 @@ import DiscourseRoute from "discourse/routes/discourse";import { i18n } from "discourse-i18n";export default class AdminSiteSettingsRoute extends DiscourseRoute {+ @service adminSiteSettingStore;@service siteSettingChangeTracker;queryParams = {@@ -30,7 +31,12 @@ export default class AdminSiteSettingsRoute extends DiscourseRoute {}async model(params) {- this._siteSettings ??= await SiteSetting.findAll();+ if (!this._siteSettings) {+ this._siteSettings = await SiteSetting.findAll();+ this.adminSiteSettingStore.register(+ this._siteSettings.flatMap((category) => category.siteSettings)+ );+ }return {filteredSettings: this.filterSettings(@@ -40,6 +46,7 @@ export default class AdminSiteSettingsRoute extends DiscourseRoute {),filtersApplied:params.filter || params.onlyOverridden || params.dependsOn,+ activeFilter: params.filter ?? "",};}diff --git a/frontend/discourse/admin/services/admin-site-setting-store.js b/frontend/discourse/admin/services/admin-site-setting-store.jsnew file mode 100644index 00000000000..f2d2622cb7e--- /dev/null+++ b/frontend/discourse/admin/services/admin-site-setting-store.js@@ -0,0 +1,69 @@+import { trackedMap, trackedSet } from "@ember/reactive/collections";+import Service from "@ember/service";+import { isSettingValueTrue } from "discourse/admin/models/site-setting";++function normalize(value) {+ return (value ?? "").toLowerCase().replace(/_/g, " ").trim();+}++export default class AdminSiteSettingStore extends Service {+ byName = trackedMap();+ #revealed = trackedSet();++ register(settings) {+ settings.forEach((setting) => {+ this.byName.set(setting.setting, setting);+ });+ this.#computeInitialReveals(settings);+ }++ get(name) {+ return this.byName.get(name);+ }++ isRevealed(setting) {+ return this.#revealed.has(setting.setting);+ }++ isVisible(setting, activeFilter = "") {+ if (setting.depends_behavior !== "hidden") {+ return true;+ }+ if (this.#revealed.has(setting.setting)) {+ return true;+ }+ const filter = normalize(activeFilter);+ return filter !== "" && filter === normalize(setting.setting);+ }++ reveal(name) {+ this.byName.forEach((setting) => {+ if (+ setting.depends_behavior === "hidden" &&+ setting.depends_on?.includes(name)+ ) {+ this.#revealed.add(setting.setting);+ }+ });+ }++ #computeInitialReveals(settings) {+ settings.forEach((setting) => {+ if (+ setting.depends_behavior !== "hidden" ||+ !setting.depends_on?.length+ ) {+ return;+ }+ const allTrue = setting.depends_on.every((name) => {+ const parent = this.byName.get(name);+ return parent ? isSettingValueTrue(parent.value) : true;+ });+ if (allTrue) {+ this.#revealed.add(setting.setting);+ } else {+ this.#revealed.delete(setting.setting);+ }+ });+ }+}diff --git a/frontend/discourse/tests/integration/components/site-setting-test.gjs b/frontend/discourse/tests/integration/components/site-setting-test.gjsindex 234845f1051..59eafddd8d7 100644--- a/frontend/discourse/tests/integration/components/site-setting-test.gjs+++ b/frontend/discourse/tests/integration/components/site-setting-test.gjs@@ -772,3 +772,105 @@ module(});});++module(+ "Integration | Component | SiteSetting | depends_behavior: hidden",+ function (hooks) {+ setupRenderingTest(hooks);++ hooks.beforeEach(function () {+ this.store = this.container.lookup("service:admin-site-setting-store");+ this.parent = SiteSetting.create({+ setting: "parent_flag",+ value: "false",+ default: "false",+ type: "bool",+ });+ this.child = SiteSetting.create({+ setting: "child_value",+ value: "5",+ default: "5",+ type: "integer",+ depends_on: ["parent_flag"],+ depends_behavior: "hidden",+ });+ });++ test("child renders disabled when parent is falsy", async function (assert) {+ this.store.register([this.parent, this.child]);++ await render(+ <template><SiteSettingComponent @setting={{this.child}} /></template>+ );++ assert+ .dom("[data-setting='child_value']")+ .hasClass("disabled-by-dependency");+ assert.dom(".input-setting-integer").hasAttribute("disabled");+ });++ test("child renders enabled when parent is truthy", async function (assert) {+ this.parent.value = "true";+ this.store.register([this.parent, this.child]);++ await render(+ <template><SiteSettingComponent @setting={{this.child}} /></template>+ );++ assert+ .dom("[data-setting='child_value']")+ .hasNoClass("disabled-by-dependency");+ assert.dom(".input-setting-integer").doesNotHaveAttribute("disabled");+ });++ test("toggling parent reactively flips child disabled and latches revealed", async function (assert) {+ this.store.register([this.parent, this.child]);++ await render(+ <template>+ <SiteSettingComponent @setting={{this.parent}} />+ <SiteSettingComponent @setting={{this.child}} />+ </template>+ );++ assert.false(this.store.isRevealed(this.child));+ assert+ .dom("[data-setting='child_value']")+ .hasClass("disabled-by-dependency");++ await click("[data-setting='parent_flag'] input[type=checkbox]");+ assert.true(+ this.store.isRevealed(this.child),+ "revealed latched on toggle-on"+ );+ assert+ .dom("[data-setting='child_value']")+ .hasNoClass("disabled-by-dependency");++ await click("[data-setting='parent_flag'] input[type=checkbox]");+ assert.true(this.store.isRevealed(this.child), "revealed stays latched");+ assert+ .dom("[data-setting='child_value']")+ .hasClass("disabled-by-dependency", "disabled again, not re-hidden");+ });++ test("resetting parent to a truthy default latches revealed", async function (assert) {+ this.parent.default = "true";+ this.store.register([this.parent, this.child]);++ await render(+ <template>+ <SiteSettingComponent @setting={{this.parent}} />+ <SiteSettingComponent @setting={{this.child}} />+ </template>+ );++ await click("[data-setting='parent_flag'] .setting-controls__undo");++ assert.true(this.store.isRevealed(this.child));+ assert+ .dom("[data-setting='child_value']")+ .hasNoClass("disabled-by-dependency");+ });+ }+);diff --git a/frontend/discourse/tests/unit/services/admin-site-setting-store-test.js b/frontend/discourse/tests/unit/services/admin-site-setting-store-test.jsnew file mode 100644index 00000000000..1091f496f63--- /dev/null+++ b/frontend/discourse/tests/unit/services/admin-site-setting-store-test.js@@ -0,0 +1,170 @@+import { getOwner } from "@ember/owner";+import { setupTest } from "ember-qunit";+import { module, test } from "qunit";+import SiteSetting from "discourse/admin/models/site-setting";++function build(attrs) {+ return SiteSetting.create({+ setting: "x",+ value: "",+ type: "integer",+ ...attrs,+ });+}++module("Unit | Service | admin-site-setting-store", function (hooks) {+ setupTest(hooks);++ hooks.beforeEach(function () {+ this.store = getOwner(this).lookup("service:admin-site-setting-store");+ });++ module("isVisible", function () {+ test("non-hidden settings are always visible", function (assert) {+ const s = build({ depends_behavior: null });+ this.store.register([s]);+ assert.true(this.store.isVisible(s));+ assert.true(this.store.isVisible(s, "anything"));+ });++ test("hidden + revealed is visible", function (assert) {+ const parent = build({ setting: "parent", value: "true" });+ const child = build({+ setting: "child",+ depends_on: ["parent"],+ depends_behavior: "hidden",+ });+ this.store.register([parent, child]);+ assert.true(this.store.isVisible(child));+ });++ test("hidden + unrevealed is not visible without a matching filter", function (assert) {+ const s = build({+ setting: "voting_limit",+ depends_on: ["parent"],+ depends_behavior: "hidden",+ });+ this.store.register([build({ setting: "parent", value: "false" }), s]);+ assert.false(this.store.isVisible(s));+ assert.false(this.store.isVisible(s, ""));+ assert.false(this.store.isVisible(s, "voting"));+ });++ test("hidden + unrevealed is visible when filter matches name exactly", function (assert) {+ const s = build({+ setting: "voting_limit",+ depends_on: ["parent"],+ depends_behavior: "hidden",+ });+ this.store.register([build({ setting: "parent", value: "false" }), s]);+ assert.true(this.store.isVisible(s, "voting_limit"));+ assert.true(this.store.isVisible(s, "voting limit"), "spaces normalize");+ assert.true(+ this.store.isVisible(s, " VOTING_LIMIT "),+ "case + whitespace"+ );+ });+ });++ module("register", function () {+ test("populates byName and latches revealed from parent values", function (assert) {+ const parent = build({ setting: "parent_flag", value: "true" });+ const revealed = build({+ setting: "revealed_child",+ depends_on: ["parent_flag"],+ depends_behavior: "hidden",+ });+ const hidden = build({+ setting: "hidden_child",+ depends_on: ["off_flag"],+ depends_behavior: "hidden",+ });+ this.store.register([+ parent,+ revealed,+ hidden,+ build({ setting: "off_flag", value: "false" }),+ ]);++ assert.strictEqual(this.store.get("parent_flag"), parent);+ assert.true(this.store.isRevealed(revealed));+ assert.false(this.store.isRevealed(hidden));+ });++ test("revealed is true when a parent is missing from the store", function (assert) {+ const orphan = build({+ setting: "orphan",+ depends_on: ["missing_parent"],+ depends_behavior: "hidden",+ });+ this.store.register([orphan]);++ assert.true(this.store.isRevealed(orphan));+ });++ test("multi-parent: revealed only if all parents are truthy", function (assert) {+ const allOn = build({+ setting: "all_on",+ depends_on: ["a", "b"],+ depends_behavior: "hidden",+ });+ const oneOff = build({+ setting: "one_off",+ depends_on: ["a", "b"],+ depends_behavior: "hidden",+ });+ this.store.register([+ build({ setting: "a", value: "true" }),+ build({ setting: "b", value: "true" }),+ allOn,+ oneOff,+ ]);+ assert.true(this.store.isRevealed(allOn));++ this.store.register([+ build({ setting: "a", value: "true" }),+ build({ setting: "b", value: "false" }),+ oneOff,+ ]);+ assert.false(this.store.isRevealed(oneOff));+ });+ });++ module("reveal", function () {+ test("reveals hidden-type dependents only", function (assert) {+ const hidden = build({+ setting: "child_a",+ depends_on: ["flag"],+ depends_behavior: "hidden",+ });+ const plain = build({+ setting: "child_b",+ depends_on: ["flag"],+ });+ const unrelated = build({+ setting: "child_c",+ depends_on: ["other"],+ depends_behavior: "hidden",+ });+ this.store.register([+ build({ setting: "flag", value: "false" }),+ build({ setting: "other", value: "false" }),+ hidden,+ plain,+ unrelated,+ ]);++ this.store.reveal("flag");++ assert.true(this.store.isRevealed(hidden), "hidden dependent revealed");+ assert.false(+ this.store.isRevealed(plain),+ "non-hidden dependent untouched"+ );+ assert.false(+ this.store.isRevealed(unrelated),+ "unrelated dependent untouched"+ );+ });+ });+});diff --git a/lib/site_setting_extension.rb b/lib/site_setting_extension.rbindex 31397e1b82e..df35d2a6db3 100644--- a/lib/site_setting_extension.rb+++ b/lib/site_setting_extension.rb@@ -380,16 +380,6 @@ module SiteSettingExtension.select do |setting_name, _|is_hidden = current_hidden_settings.include?(setting_name)- if !is_hidden && type_supervisor.dependencies[setting_name].present? &&- type_supervisor.dependencies.behaviors[setting_name] == :hidden- # Hidden if any of the dependent settings are not true. Use the getter so upcoming- # change settings use their resolved value (promotion status, admin override, etc.).- is_hidden =- !type_supervisor.dependencies[setting_name].all? do |dependency|- respond_to?(dependency) && public_send(dependency)- end- end-next true if !is_hiddennext false if !include_hiddennext true if filter_allowed_hidden.nil?@@ -501,6 +491,7 @@ module SiteSettingExtensionif depends_on = type_supervisor.dependencies[s]opts_data[:depends_on] = depends_onopts_data[:depends_on_humanized_names] = depends_on.map { |dep| humanized_names(dep) }+ opts_data[:depends_behavior] = type_supervisor.dependencies.behaviors[s]endif upcoming_change_default_override_metadatadiff --git a/spec/lib/site_setting_extension_spec.rb b/spec/lib/site_setting_extension_spec.rbindex e91ec2641a3..ad9e3ea7fb1 100644--- a/spec/lib/site_setting_extension_spec.rb+++ b/spec/lib/site_setting_extension_spec.rb@@ -781,8 +781,11 @@ RSpec.describe SiteSettingExtension dosettings.refresh!end- it "is not present in all_settings" do- expect(settings.all_settings.find { |s| s[:setting] == :cool_thing_image }).to be_blank+ it "is still present in all_settings so the UI can reactively hide/disable it" do+ setting = settings.all_settings.find { |s| s[:setting] == :cool_thing_image }+ expect(setting).not_to be_blank+ expect(setting[:depends_on]).to eq([:enable_cool_thing])+ expect(setting[:depends_behavior]).to eq(:hidden)endend@@ -797,8 +800,8 @@ RSpec.describe SiteSettingExtension dosettings.refresh!end- it "is not present in all_settings" do- expect(settings.all_settings.find { |s| s[:setting] == :orphan_setting }).to be_blank+ it "is still present in all_settings (visibility handled client-side)" do+ expect(settings.all_settings.find { |s| s[:setting] == :orphan_setting }).not_to be_blankendend