A platform for community discussion. Free, open, simple.
FEATURE: Support markdown in tag descriptions (#41996)
David Taylor37b64504c9f8
diff --git a/app/jobs/scheduled/periodical_updates.rb b/app/jobs/scheduled/periodical_updates.rbindex 93818b2641c..d901e066d52 100644--- a/app/jobs/scheduled/periodical_updates.rb+++ b/app/jobs/scheduled/periodical_updates.rb@@ -49,6 +49,19 @@ module Jobs)end+ # rebake out of date tag descriptions+ [Tag, TagLocalization].each do |klass|+ klass+ .rebake_old(250)+ .each do |hash|+ record = hash[:record]+ Discourse.handle_job_exception(+ hash[:ex],+ error_context(args, "Rebaking #{klass.name} id #{record.id}", record_id: record.id),+ )+ end+ end+offset = SiteSetting.max_new_topics.to_ilast_new_topic = Topic.order("created_at desc").offset(offset).select(:created_at).firstSiteSetting.min_new_topics_time = last_new_topic.created_at.to_i if last_new_topicdiff --git a/app/models/concerns/has_cooked_tag_description.rb b/app/models/concerns/has_cooked_tag_description.rbnew file mode 100644index 00000000000..160fa48d127--- /dev/null+++ b/app/models/concerns/has_cooked_tag_description.rb@@ -0,0 +1,47 @@+# frozen_string_literal: true++module HasCookedTagDescription+ extend ActiveSupport::Concern++ BAKED_VERSION = 1+ COOK_OPTIONS = { features: { onebox: false } }.freeze++ def cook_description+ return unless description_changed?++ self.description_cooked = cook_description_html+ self.description_cooked_version = BAKED_VERSION+ end++ def rebake!+ update_columns(+ description_cooked: cook_description_html,+ description_cooked_version: BAKED_VERSION,+ )+ end++ private++ def cook_description_html+ description.present? ? PrettyText.cook(description, COOK_OPTIONS) : nil+ end++ class_methods do+ def rebake_old(limit)+ problems = []++ where(+ "description_cooked_version IS NULL OR description_cooked_version < ?",+ HasCookedTagDescription::BAKED_VERSION,+ )+ .limit(limit)+ .each do |record|+ record.rebake!+ rescue => e+ problems << { record: record, ex: e }+ end++ problems+ end+ end+enddiff --git a/app/models/tag.rb b/app/models/tag.rbindex 522c9f95c0e..031030fe4a2 100644--- a/app/models/tag.rb+++ b/app/models/tag.rb@@ -3,7 +3,7 @@class Tag < ActiveRecord::Baseinclude Searchableinclude HasDestroyedWebHook- include HasSanitizableFields+ include HasCookedTagDescriptioninclude LocalizableRESERVED_TAGS = [@@ -60,7 +60,7 @@ class Tag < ActiveRecord::Basehas_many :embeddable_host_tagshas_many :embeddable_hosts, through: :embeddable_host_tags- before_save :sanitize_description+ before_save :cook_descriptionafter_save :index_searchafter_save :update_synonym_associations@@ -337,10 +337,6 @@ class Tag < ActiveRecord::Basescope.exists?end- def sanitize_description- self.description = sanitize_field(description) if description_changed?- end-def name_validatorerrors.add(:name, :invalid) if name.present? && RESERVED_TAGS.include?(name.strip.downcase)end@@ -350,22 +346,25 @@ end## Table name: tags#-# id :integer not null, primary key-# description :string(1000)-# locale :string(20)-# name :string not null-# pm_topic_count :integer default(0), not null-# public_topic_count :integer default(0), not null-# slug :string default(""), not null-# staff_topic_count :integer default(0), not null-# created_at :datetime not null-# updated_at :datetime not null-# target_tag_id :integer+# id :integer not null, primary key+# description :string(1000)+# description_cooked :string(2000)+# description_cooked_version :integer+# locale :string(20)+# name :string not null+# pm_topic_count :integer default(0), not null+# public_topic_count :integer default(0), not null+# slug :string default(""), not null+# staff_topic_count :integer default(0), not null+# created_at :datetime not null+# updated_at :datetime not null+# target_tag_id :integer## Indexes#-# index_tags_on_lower_name (lower((name)::text)) UNIQUE-# index_tags_on_name (name) UNIQUE-# index_tags_on_slug (slug) WHERE ((slug)::text <> ''::text)-# index_tags_on_target_tag_id (target_tag_id) WHERE (target_tag_id IS NOT NULL)+# index_tags_on_description_cooked_version (description_cooked_version)+# index_tags_on_lower_name (lower((name)::text)) UNIQUE+# index_tags_on_name (name) UNIQUE+# index_tags_on_slug (slug) WHERE ((slug)::text <> ''::text)+# index_tags_on_target_tag_id (target_tag_id) WHERE (target_tag_id IS NOT NULL)#diff --git a/app/models/tag_localization.rb b/app/models/tag_localization.rbindex 89ab326f928..a0ca315b891 100644--- a/app/models/tag_localization.rb+++ b/app/models/tag_localization.rb@@ -2,12 +2,12 @@class TagLocalization < ActiveRecord::Baseinclude LocaleMatchable- include HasSanitizableFields+ include HasCookedTagDescriptionbelongs_to :tagbefore_validation :clean_name- before_save :sanitize_description+ before_save :cook_descriptionvalidates :locale, presence: true, length: { maximum: 20 }validates :name, presence: true@@ -19,26 +19,25 @@ class TagLocalization < ActiveRecord::Basedef clean_nameself.name = DiscourseTagging.clean_tag(name) if name.present?end-- def sanitize_description- self.description = sanitize_field(description) if description_changed?- endend# == Schema Information## Table name: tag_localizations#-# id :bigint not null, primary key-# description :string(1000)-# locale :string(20) not null-# name :string not null-# created_at :datetime not null-# updated_at :datetime not null-# tag_id :bigint not null+# id :bigint not null, primary key+# description :string(1000)+# description_cooked :string(2000)+# description_cooked_version :integer+# locale :string(20) not null+# name :string not null+# created_at :datetime not null+# updated_at :datetime not null+# tag_id :bigint not null## Indexes#-# index_tag_localizations_on_tag_id (tag_id)-# index_tag_localizations_on_tag_id_and_locale (tag_id,locale) UNIQUE+# index_tag_localizations_on_description_cooked_version (description_cooked_version)+# index_tag_localizations_on_tag_id (tag_id)+# index_tag_localizations_on_tag_id_and_locale (tag_id,locale) UNIQUE#diff --git a/app/serializers/tag_localization_serializer.rb b/app/serializers/tag_localization_serializer.rbindex 3282586621f..a7f92754355 100644--- a/app/serializers/tag_localization_serializer.rb+++ b/app/serializers/tag_localization_serializer.rb@@ -1,5 +1,5 @@# frozen_string_literal: trueclass TagLocalizationSerializer < ApplicationSerializer- attributes :id, :tag_id, :locale, :name, :description+ attributes :id, :tag_id, :locale, :name, :description, :description_cookedenddiff --git a/app/serializers/tag_serializer.rb b/app/serializers/tag_serializer.rbindex 89e5409f9a5..26bee6ac6ac 100644--- a/app/serializers/tag_serializer.rb+++ b/app/serializers/tag_serializer.rb@@ -1,7 +1,7 @@# frozen_string_literal: trueclass TagSerializer < ApplicationSerializer- attributes :id, :name, :slug, :topic_count, :staff, :description+ attributes :id, :name, :slug, :topic_count, :staff, :description, :description_cookedhas_many :localizations, serializer: TagLocalizationSerializer, embed: :objects@@ -23,6 +23,14 @@ class TagSerializer < ApplicationSerializertranslated || object.descriptionend+ def description_cooked+ translated =+ if ContentLocalization.show_translated_tag?(object, scope)+ object.get_localization&.description_cooked+ end+ translated || object.description_cooked+ end+def topic_countobject.public_send(Tag.topic_count_column(scope))enddiff --git a/app/serializers/tag_settings_serializer.rb b/app/serializers/tag_settings_serializer.rbindex 1b663d21654..9c974cd8a65 100644--- a/app/serializers/tag_settings_serializer.rb+++ b/app/serializers/tag_settings_serializer.rb@@ -5,6 +5,7 @@ class TagSettingsSerializer < ApplicationSerializer:name,:slug,:description,+ :description_cooked,:synonyms,:tag_group_names,:tag_groups,@@ -27,6 +28,10 @@ class TagSettingsSerializer < ApplicationSerializerobject.descriptionend+ def description_cooked+ object.description_cooked+ end+def synonymsvisible_synonyms.map { |t| { id: t.id, name: t.name } }enddiff --git a/db/migrate/20260723183001_add_description_cooked_to_tags.rb b/db/migrate/20260723183001_add_description_cooked_to_tags.rbnew file mode 100644index 00000000000..b94cb923f70--- /dev/null+++ b/db/migrate/20260723183001_add_description_cooked_to_tags.rb@@ -0,0 +1,12 @@+# frozen_string_literal: true++class AddDescriptionCookedToTags < ActiveRecord::Migration[8.0]+ def change+ add_column :tags, :description_cooked, :string, limit: 2000+ add_column :tags, :description_cooked_version, :integer+ add_column :tag_localizations, :description_cooked, :string, limit: 2000+ add_column :tag_localizations, :description_cooked_version, :integer+ add_index :tags, :description_cooked_version+ add_index :tag_localizations, :description_cooked_version+ end+enddiff --git a/db/structure.sql b/db/structure.sqlindex 55b928f8c15..232f7c5ed16 100644--- a/db/structure.sql+++ b/db/structure.sql@@ -9481,7 +9481,9 @@ CREATE TABLE public.tag_localizations (name character varying NOT NULL,description character varying(1000),created_at timestamp(6) without time zone NOT NULL,- updated_at timestamp(6) without time zone NOT NULL+ updated_at timestamp(6) without time zone NOT NULL,+ description_cooked character varying(2000),+ description_cooked_version integer);@@ -9586,7 +9588,9 @@ CREATE TABLE public.tags (public_topic_count integer DEFAULT 0 NOT NULL,staff_topic_count integer DEFAULT 0 NOT NULL,locale character varying(20),- slug character varying DEFAULT ''::character varying NOT NULL+ slug character varying DEFAULT ''::character varying NOT NULL,+ description_cooked character varying(2000),+ description_cooked_version integer);@@ -21370,6 +21374,13 @@ CREATE INDEX index_tag_group_permissions_on_tag_group_id ON public.tag_group_perCREATE UNIQUE INDEX index_tag_groups_on_lower_name ON public.tag_groups USING btree (lower((name)::text));+--+-- Name: index_tag_localizations_on_description_cooked_version; Type: INDEX; Schema: public; Owner: -+--++CREATE INDEX index_tag_localizations_on_description_cooked_version ON public.tag_localizations USING btree (description_cooked_version);++---- Name: index_tag_localizations_on_tag_id; Type: INDEX; Schema: public; Owner: ---@@ -21405,6 +21416,13 @@ CREATE UNIQUE INDEX index_tag_users_on_user_id_and_tag_id ON public.tag_users USCREATE INDEX index_tag_users_on_user_id_and_tag_id_and_notification_level ON public.tag_users USING btree (user_id, tag_id, notification_level);+--+-- Name: index_tags_on_description_cooked_version; Type: INDEX; Schema: public; Owner: -+--++CREATE INDEX index_tags_on_description_cooked_version ON public.tags USING btree (description_cooked_version);++---- Name: index_tags_on_lower_name; Type: INDEX; Schema: public; Owner: ---@@ -23058,6 +23076,7 @@ INSERT INTO "schema_migrations" (version) VALUES('20260728045008'),('20260727085824'),('20260727035337'),+('20260723183001'),('20260723100008'),('20260723094850'),('20260723013754'),diff --git a/frontend/discourse/app/components/tag-info.gjs b/frontend/discourse/app/components/tag-info.gjsindex 32d277b4478..2a2ce1aa761 100644--- a/frontend/discourse/app/components/tag-info.gjs+++ b/frontend/discourse/app/components/tag-info.gjs@@ -48,9 +48,9 @@ const TagInfo = <template><div class="tag-name-wrapper">{{dDiscourseTag @tagInfo}}</div>- {{#if @tagInfo.description}}+ {{#if @tagInfo.description_cooked}}<div class="tag-description-wrapper">- <span>{{trustHTML @tagInfo.description}}</span>+ <div class="cooked">{{trustHTML @tagInfo.description_cooked}}</div></div>{{/if}}</div>diff --git a/frontend/discourse/app/components/tag-settings.gjs b/frontend/discourse/app/components/tag-settings.gjsindex 9a38ae67cd4..f1e0c39857c 100644--- a/frontend/discourse/app/components/tag-settings.gjs+++ b/frontend/discourse/app/components/tag-settings.gjs@@ -346,13 +346,13 @@ export default class TagSettings extends Component {<form.Field@name="description"- @type="textarea"+ @type="composer"@title={{i18n "tagging.description"}}@format="large"@validation="length:0,1000"as |field|>- <field.Control @height={{80}} />+ <field.Control @height={{200}} /></form.Field><form.Fielddiff --git a/frontend/discourse/app/components/tag-settings/localizations.gjs b/frontend/discourse/app/components/tag-settings/localizations.gjsindex 577a5f8b09b..82de4b3270b 100644--- a/frontend/discourse/app/components/tag-settings/localizations.gjs+++ b/frontend/discourse/app/components/tag-settings/localizations.gjs@@ -80,12 +80,12 @@ export default class TagSettingsLocalizations extends Component {<row.Col @size={{6}}><collection.Field@name="description"- @type="textarea"+ @type="composer"@title={{i18n "tagging.localization.description"}}@validation="length:0,1000"as |field|>- <field.Control @height={{80}} />+ <field.Control @height={{120}} /></collection.Field></row.Col>diff --git a/spec/lib/tag_localization_creator_spec.rb b/spec/lib/tag_localization_creator_spec.rbindex 3bcd4888570..6c4fed6a525 100644--- a/spec/lib/tag_localization_creator_spec.rb+++ b/spec/lib/tag_localization_creator_spec.rb@@ -26,16 +26,17 @@ describe TagLocalizationCreator do)end- it "sanitizes unsafe description HTML", :aggregate_failures do+ it "cooks the description into a safe description_cooked", :aggregate_failures dounsafe_description ='<script>alert("xss")</script><a href="https://example.com" onclick="alert(1)">link</a>'- sanitized_description = Fabricate(:tag, description: unsafe_description).description+ cooked_description = Fabricate(:tag, description: unsafe_description).description_cookedlocalization =described_class.create(tag:, locale:, name:, description: unsafe_description, user:)- expect(localization.description).to eq(sanitized_description)- expect(localization.description).not_to match(/<script|onclick/i)+ expect(localization.description).to eq(unsafe_description)+ expect(localization.description_cooked).to eq(cooked_description)+ expect(localization.description_cooked).not_to match(/<script|onclick/i)endit "creates localization without description" dodiff --git a/spec/models/tag_spec.rb b/spec/models/tag_spec.rbindex e56539c3416..54429878848 100644--- a/spec/models/tag_spec.rb+++ b/spec/models/tag_spec.rb@@ -638,13 +638,56 @@ RSpec.describe Tag doenddescribe "description" do- it "uses the HTMLSanitizer to remove unsafe tags and attributes" do+ it "preserves the raw markdown source and cooks it into a safe description_cooked" do+ tag.description = "Topics about **markdown** and a < b"+ tag.save!++ expect(tag.description).to eq("Topics about **markdown** and a < b")+ expect(tag.description_cooked).to include("<strong>markdown</strong>")+ expect(tag.description_cooked).to include("a < b")+ end++ it "sanitizes unsafe markup when cooking, without mutating the raw source" dotag.description ="<div>hi</div><script>a=0;</script> <a onclick='const a=0;' href=\"https://www.discourse.org\">discourse</a>"tag.save!- expect(tag.description.strip).to eq(- "<div>hi</div>a=0; <a href=\"https://www.discourse.org\">discourse</a>",- )++ expect(tag.description).to include("<script>")+ expect(tag.description_cooked).not_to include("<script>")+ expect(tag.description_cooked).not_to include("onclick")+ expect(tag.description_cooked).to include('href="https://www.discourse.org"')+ end++ it "clears description_cooked when the description is blank" do+ tag.update!(description: "something")+ expect(tag.description_cooked).to be_present++ tag.update!(description: "")+ expect(tag.description_cooked).to be_nil+ end++ it "stamps the baked version on save" do+ tag.update!(description: "**hi**")+ expect(tag.description_cooked_version).to eq(HasCookedTagDescription::BAKED_VERSION)+ end++ describe ".rebake_old" do+ it "reconciles rows with missing or stale cooked HTML and leaves current ones alone" do+ tag.update!(description: "**current**")+ stale = Fabricate(:tag, description: "**stale**")+ stale.update_columns(description_cooked: nil, description_cooked_version: nil)++ expect(Tag.rebake_old(100)).to eq([])++ expect(stale.reload.description_cooked).to include("<strong>stale</strong>")+ expect(stale.description_cooked_version).to eq(HasCookedTagDescription::BAKED_VERSION)+ expect(+ Tag.where(+ "description_cooked_version IS NULL OR description_cooked_version < ?",+ HasCookedTagDescription::BAKED_VERSION,+ ),+ ).to be_empty+ endendenddiff --git a/spec/system/page_objects/pages/tag_settings.rb b/spec/system/page_objects/pages/tag_settings.rbindex a41b70715ea..77e14a22864 100644--- a/spec/system/page_objects/pages/tag_settings.rb+++ b/spec/system/page_objects/pages/tag_settings.rb@@ -60,7 +60,7 @@ module PageObjectsenddef description_textarea- find("textarea[name='description']")+ find(".form-kit__field[data-name='description'] textarea.d-editor-input")enddef fill_name(value)diff --git a/spec/system/tag_settings_spec.rb b/spec/system/tag_settings_spec.rbindex 99bc043cafa..533314d8e4d 100644--- a/spec/system/tag_settings_spec.rb+++ b/spec/system/tag_settings_spec.rb@@ -17,6 +17,9 @@ describe "Tag Settings" dobefore doSiteSetting.tagging_enabled = trueSiteSetting.edit_tags_allowed_groups = "1|2|14"+ [admin, trust_level_4, user].each do |u|+ u.user_option.update!(composition_mode: UserOption.composition_mode_types[:markdown])+ endendcontext "when using the tag settings page" do