A platform for community discussion. Free, open, simple.
FIX: Linkify site setting references in dashboard problem messages (#41763)
Régis Hanol1e4e6fe0527b
diff --git a/app/models/admin_notice.rb b/app/models/admin_notice.rbindex 686ac4dd8cd..78f1a77f028 100644--- a/app/models/admin_notice.rb+++ b/app/models/admin_notice.rb@@ -2,7 +2,8 @@class AdminNotice < ActiveRecord::BaseMESSAGE_ALLOWED_TAGS = %w[a pre ul li].freeze- MESSAGE_ALLOWED_ATTRIBUTES = %w[href target rel].freeze+ MESSAGE_ALLOWED_ATTRIBUTES =+ (%w[href target rel] + SiteSettings::LabelFormatter::LINK_ATTRIBUTES).freezeMESSAGE_SANITIZER = Rails::Html::SafeListSanitizer.newvalidates :identifier, presence: true@@ -11,11 +12,14 @@ class AdminNotice < ActiveRecord::Baseenum :subject, %i[problem].freezedef message- MESSAGE_SANITIZER.sanitize(+ translated =I18n.t("dashboard.#{subject}.#{identifier}",**details.symbolize_keys.merge(base_path: Discourse.base_path),- ),+ )++ MESSAGE_SANITIZER.sanitize(+ SiteSettings::LabelFormatter.expand_setting_links(translated),tags: MESSAGE_ALLOWED_TAGS,attributes: MESSAGE_ALLOWED_ATTRIBUTES,)diff --git a/app/models/problem_check.rb b/app/models/problem_check.rbindex b7b6d7f908c..721fe9fe2a0 100644--- a/app/models/problem_check.rb+++ b/app/models/problem_check.rb@@ -220,9 +220,7 @@ class ProblemCheck).symbolize_keysProblem.new(- SiteSettings::LabelFormatter.expand_setting_links(- I18n.t(override_key || translation_key, base_path: Discourse.base_path, **problem_details),- ),+ I18n.t(override_key || translation_key, base_path: Discourse.base_path, **problem_details),priority: config.priority,identifier:,target: target_identifier,diff --git a/frontend/discourse/admin/components/admin-notice.gjs b/frontend/discourse/admin/components/admin-notice.gjsindex 72923b49f96..6976a8678b2 100644--- a/frontend/discourse/admin/components/admin-notice.gjs+++ b/frontend/discourse/admin/components/admin-notice.gjs@@ -2,6 +2,7 @@ import Component from "@glimmer/component";import { action } from "@ember/object";import { service } from "@ember/service";import { trustHTML } from "@ember/template";+import linkifySettingLinks from "discourse/admin/modifiers/linkify-setting-links";import DButton from "discourse/ui-kit/d-button";import dIcon from "discourse/ui-kit/helpers/d-icon";@@ -19,7 +20,7 @@ export default class AdminNotice extends Component {<template><div class="notice">- <div class="message">+ <div class="message" {{linkifySettingLinks @problem.message}}>{{if @icon (dIcon @icon)}}{{trustHTML @problem.message}}</div>diff --git a/frontend/discourse/admin/components/dashboard/site-advice.gjs b/frontend/discourse/admin/components/dashboard/site-advice.gjsindex 200a7713288..f5b4f4e4302 100644--- a/frontend/discourse/admin/components/dashboard/site-advice.gjs+++ b/frontend/discourse/admin/components/dashboard/site-advice.gjs@@ -5,6 +5,7 @@ import { action } from "@ember/object";import { service } from "@ember/service";import { trustHTML } from "@ember/template";import { compare } from "@ember/utils";+import linkifySettingLinks from "discourse/admin/modifiers/linkify-setting-links";import { eq } from "discourse/truth-helpers";import DButton from "discourse/ui-kit/d-button";import dIcon from "discourse/ui-kit/helpers/d-icon";@@ -79,7 +80,10 @@ export default class DashboardSiteAdvice extends Component {class=(concat "db-site-advice__icon --" problem.priority)}}- <div class="db-site-advice__message">+ <div+ class="db-site-advice__message"+ {{linkifySettingLinks problem.message}}+ >{{trustHTML problem.message}}</div>diff --git a/frontend/discourse/tests/integration/components/admin-notice-test.gjs b/frontend/discourse/tests/integration/components/admin-notice-test.gjsnew file mode 100644index 00000000000..67bd2117329--- /dev/null+++ b/frontend/discourse/tests/integration/components/admin-notice-test.gjs@@ -0,0 +1,38 @@+import { getOwner } from "@ember/owner";+import { render } from "@ember/test-helpers";+import { module, test } from "qunit";+import AdminNotice from "discourse/admin/components/admin-notice";+import { setupRenderingTest } from "discourse/tests/helpers/component-test";+import {+ logIn,+ updateCurrentUser,+} from "discourse/tests/helpers/qunit-helpers";++module("Integration | Component | AdminNotice", function (hooks) {+ setupRenderingTest(hooks);++ hooks.beforeEach(function () {+ logIn(getOwner(this));+ updateCurrentUser({ admin: true });+ });++ test("rewrites setting links in the problem message via the modifier", async function (assert) {+ const rewrittenURL =+ "/admin/config/onebox?filter=github_onebox_access_tokens";+ const dataSource = this.owner.lookup("service:admin-search-data-source");+ dataSource.urlForSetting = ({ setting }) =>+ setting === "github_onebox_access_tokens" ? rewrittenURL : null;++ const problem = {+ message:+ 'Configuring <a class="site-setting-link" href="/admin/site_settings/category/all_results?filter=github_onebox_access_tokens" data-setting-name="github_onebox_access_tokens" data-setting-category="onebox">GitHub onebox access tokens</a> raises the limit.',+ };++ await render(<template><AdminNotice @problem={{problem}} /></template>);++ assert+ .dom(".message a.site-setting-link")+ .hasText("GitHub onebox access tokens")+ .hasAttribute("href", rewrittenURL);+ });+});diff --git a/frontend/discourse/tests/integration/components/dashboard/site-advice-test.gjs b/frontend/discourse/tests/integration/components/dashboard/site-advice-test.gjsnew file mode 100644index 00000000000..d094f9ed068--- /dev/null+++ b/frontend/discourse/tests/integration/components/dashboard/site-advice-test.gjs@@ -0,0 +1,44 @@+import { getOwner } from "@ember/owner";+import { render } from "@ember/test-helpers";+import { module, test } from "qunit";+import DashboardSiteAdvice from "discourse/admin/components/dashboard/site-advice";+import { setupRenderingTest } from "discourse/tests/helpers/component-test";+import {+ logIn,+ updateCurrentUser,+} from "discourse/tests/helpers/qunit-helpers";++module("Integration | Component | DashboardSiteAdvice", function (hooks) {+ setupRenderingTest(hooks);++ hooks.beforeEach(function () {+ logIn(getOwner(this));+ updateCurrentUser({ admin: true });+ });++ test("rewrites setting links in problem messages via the modifier", async function (assert) {+ const rewrittenURL =+ "/admin/config/onebox?filter=github_onebox_access_tokens";+ const dataSource = this.owner.lookup("service:admin-search-data-source");+ dataSource.urlForSetting = ({ setting }) =>+ setting === "github_onebox_access_tokens" ? rewrittenURL : null;++ const problems = [+ {+ id: 1,+ priority: "low",+ message:+ 'Configuring <a class="site-setting-link" href="/admin/site_settings/category/all_results?filter=github_onebox_access_tokens" data-setting-name="github_onebox_access_tokens" data-setting-category="onebox">GitHub onebox access tokens</a> raises the limit.',+ },+ ];++ await render(+ <template><DashboardSiteAdvice @problems={{problems}} /></template>+ );++ assert+ .dom(".db-site-advice__message a.site-setting-link")+ .hasText("GitHub onebox access tokens")+ .hasAttribute("href", rewrittenURL);+ });+});diff --git a/lib/site_settings/label_formatter.rb b/lib/site_settings/label_formatter.rbindex 27970f0f019..8ac7dd9350a 100644--- a/lib/site_settings/label_formatter.rb+++ b/lib/site_settings/label_formatter.rb@@ -132,6 +132,14 @@ module SiteSettingsSETTING_LINK_PATTERN = /\{\{setting:([a-z][a-z0-9_]*)\}\}/+ LINK_ATTRIBUTES = %w[+ class+ data-setting-name+ data-setting-area+ data-setting-category+ data-setting-plugin+ ].freeze+class << selfdef description(setting)desc = I18n.t("site_settings.#{setting}", base_path: Discourse.base_path, default: "")diff --git a/spec/models/admin_notice_spec.rb b/spec/models/admin_notice_spec.rbindex 44af14c60e4..a1221ee4fd0 100644--- a/spec/models/admin_notice_spec.rb+++ b/spec/models/admin_notice_spec.rb@@ -4,25 +4,22 @@ RSpec.describe AdminNotice doit { is_expected.to validate_presence_of(:identifier) }describe "#message" do- let(:notice) do- Fabricate(- :admin_notice,- identifier: "test",- subject: "problem",- priority: "high",- details: {- thing: "world",- },- )+ def store_problem_translation(text)+ I18n.backend.store_translations(:en, { "dashboard" => { "problem" => { "test" => text } } })end- before do- I18n.backend.store_translations(- :en,- { "dashboard" => { "problem" => { "test" => "Something is wrong with the %{thing}" } } },- )+ it "interpolates the notice details into the translation" do+ store_problem_translation("Something is wrong with the %{thing}")+ notice = Fabricate(:admin_notice, identifier: "test", details: { thing: "world" })+ expect(notice.message).to eq("Something is wrong with the world")end- it { expect(notice.message).to eq("Something is wrong with the world") }+ it "expands setting markers into links that survive sanitization" do+ store_problem_translation("Configure {{setting:title}} to fix this")+ notice = Fabricate(:admin_notice, identifier: "test")+ expect(notice.message).to eq(+ "Configure #{SiteSettings::LabelFormatter.linkify(:title)} to fix this",+ )+ endendend