A platform for community discussion. Free, open, simple.
FEATURE: Show notice on site settings that depend on another setting (#39400)
Régis Hanol1119f8a1bd95
diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex 80258c038d3..59158e326ff 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -8880,6 +8880,9 @@ en:site_settings:title: "Site settings"description: "Configure the settings for your Discourse site to customize its appearance, functionality, and user experience."+ depends_on_notice:+ one: "This setting is only applied when %{dependencyLinks} is enabled."+ other: "This setting is only applied when %{dependencyLinks} are enabled."discard:one: "Discard change"other: "Discard changes"diff --git a/frontend/discourse/admin/components/site-setting.gjs b/frontend/discourse/admin/components/site-setting.gjsindex ae1f2ef2d94..f4eeca27c9f 100644--- a/frontend/discourse/admin/components/site-setting.gjs+++ b/frontend/discourse/admin/components/site-setting.gjs@@ -153,6 +153,30 @@ export default class SiteSettingComponent extends Component {return this.setting.upcoming_change_default_override_metadata;}+ get showDependsOnNotice() {+ return this.setting.depends_on?.length > 0;+ }++ get dependsOnNoticeText() {+ const path = basePath();+ const links = this.setting.depends_on+ .map((name, index) => {+ const label = sanitize(+ this.setting.depends_on_humanized_names?.[index] ||+ name.replaceAll("_", " ")+ );+ return `<a href="${path}/admin/site_settings/category/all_results?filter=${encodeURIComponent(name)}">${label}</a>`;+ })+ .join(", ");++ return trustHTML(+ i18n("admin.site_settings.depends_on_notice", {+ count: this.setting.depends_on.length,+ dependencyLinks: links,+ })+ );+ }+get themeSiteSettingWarningText() {return trustHTML(i18n("admin.theme_site_settings.site_setting_warning", {@@ -556,6 +580,14 @@ export default class SiteSettingComponent extends Component {</p></div>{{/if}}+ {{#if this.showDependsOnNotice}}+ <div class="setting-override-warning setting-depends-on-notice">+ <p class="setting-depends-on-notice__text">+ {{icon "link"}}+ {{this.dependsOnNoticeText}}+ </p>+ </div>+ {{/if}}{{/if}}</div>diff --git a/frontend/discourse/tests/integration/components/site-setting-test.gjs b/frontend/discourse/tests/integration/components/site-setting-test.gjsindex 5cf9d27d199..cc25b464efe 100644--- a/frontend/discourse/tests/integration/components/site-setting-test.gjs+++ b/frontend/discourse/tests/integration/components/site-setting-test.gjs@@ -406,6 +406,56 @@ module(assert.dom(".setting-theme-warning__text").includesHtml(expectedText);});++ test("shows notice for settings that depend on another setting", async function (assert) {+ this.set(+ "setting",+ SiteSetting.create({+ setting: "dependent_setting",+ value: "1",+ type: "integer",+ depends_on: ["parent_setting"],+ depends_on_humanized_names: ["Parent setting"],+ })+ );++ await render(+ <template><SiteSettingComponent @setting={{this.setting}} /></template>+ );++ assert+ .dom(".setting-depends-on-notice")+ .exists("notice wrapper is displayed");+ assert+ .dom(".setting-depends-on-notice__text")+ .includesText(+ "This setting is only applied when Parent setting is enabled"+ );+ assert+ .dom(".setting-depends-on-notice__text a")+ .hasAttribute(+ "href",+ "/admin/site_settings/category/all_results?filter=parent_setting"+ )+ .hasText("Parent setting");+ });++ test("does not show the depends_on notice when setting has no dependencies", async function (assert) {+ this.set(+ "setting",+ SiteSetting.create({+ setting: "plain_setting",+ value: "1",+ type: "integer",+ })+ );++ await render(+ <template><SiteSettingComponent @setting={{this.setting}} /></template>+ );++ assert.dom(".setting-depends-on-notice").doesNotExist();+ });});diff --git a/lib/site_setting_extension.rb b/lib/site_setting_extension.rbindex 9228407ee76..31397e1b82e 100644--- a/lib/site_setting_extension.rb+++ b/lib/site_setting_extension.rb@@ -496,9 +496,13 @@ module SiteSettingExtensionrequires_confirmation: requires_confirmation_settings[s],upcoming_change: only_upcoming_changes ? upcoming_change_metadata[s] : nil,themeable: themeable[s],- depends_on: type_supervisor.dependencies[s],}+ if depends_on = type_supervisor.dependencies[s]+ opts_data[:depends_on] = depends_on+ opts_data[:depends_on_humanized_names] = depends_on.map { |dep| humanized_names(dep) }+ end+if upcoming_change_default_override_metadataopts_data[:upcoming_change_default_override_metadatadiff --git a/spec/lib/site_setting_extension_spec.rb b/spec/lib/site_setting_extension_spec.rbindex b0a2aa92c12..e91ec2641a3 100644--- a/spec/lib/site_setting_extension_spec.rb+++ b/spec/lib/site_setting_extension_spec.rb@@ -767,6 +767,12 @@ RSpec.describe SiteSettingExtension dosettings.all_settings.find { |s| s[:setting] == :cool_thing_image },).not_to be_blankend++ it "serializes depends_on and the matching humanized names" do+ setting = settings.all_settings.find { |s| s[:setting] == :cool_thing_image }+ expect(setting[:depends_on]).to eq([:enable_cool_thing])+ expect(setting[:depends_on_humanized_names]).to eq(["Enable cool thing"])+ endendcontext "when the depends_on setting is false" do