A platform for community discussion. Free, open, simple.
FIX: Clean localized tag names (#38488)
Natalie Tayc5b25e313e6e
diff --git a/app/models/tag_localization.rb b/app/models/tag_localization.rbindex 324c0600216..8ee4031f97f 100644--- a/app/models/tag_localization.rb+++ b/app/models/tag_localization.rb@@ -5,10 +5,18 @@ class TagLocalization < ActiveRecord::Basebelongs_to :tag+ before_validation :clean_name+validates :locale, presence: true, length: { maximum: 20 }validates :name, presence: truevalidates :tag_id, uniqueness: { scope: :locale }validates :description, length: { maximum: 1000 }++ private++ def clean_name+ self.name = DiscourseTagging.clean_tag(name) if name.present?+ endend# == Schema Informationdiff --git a/db/post_migrate/20260311064518_clean_existing_tag_localization_names.rb b/db/post_migrate/20260311064518_clean_existing_tag_localization_names.rbnew file mode 100644index 00000000000..b511acd9a71--- /dev/null+++ b/db/post_migrate/20260311064518_clean_existing_tag_localization_names.rb@@ -0,0 +1,40 @@+# frozen_string_literal: true++class CleanExistingTagLocalizationNames < ActiveRecord::Migration[7.2]+ # matches DiscourseTagging::TAGS_FILTER_REGEXP plus whitespace and consecutive dashes+ VIOLATING_PATTERN = %q{[/:?#\[\]@!$&'()*+,;=.%\\`^\s|{}"<>]|--}++ def up+ conditions = ["name ~ :pattern OR name != TRIM(name)"]+ params = { pattern: VIOLATING_PATTERN }++ conditions << "name != LOWER(name)" if SiteSetting.force_lowercase_tags++ max_length = SiteSetting.max_tag_length+ conditions << "LENGTH(name) > :max_length"+ params[:max_length] = max_length++ query = <<~SQL+ SELECT id, name FROM tag_localizations+ WHERE #{conditions.join(" OR ")}+ SQL++ DB+ .query(query, **params)+ .each do |row|+ cleaned = DiscourseTagging.clean_tag(row.name)+ next if cleaned == row.name+ next if cleaned.blank?++ DB.exec(+ "UPDATE tag_localizations SET name = :name WHERE id = :id",+ name: cleaned,+ id: row.id,+ )+ end+ end++ def down+ raise ActiveRecord::IrreversibleMigration+ end+enddiff --git a/spec/db/post_migrate/20260311064518_clean_existing_tag_localization_names_spec.rb b/spec/db/post_migrate/20260311064518_clean_existing_tag_localization_names_spec.rbnew file mode 100644index 00000000000..d713340a6ff--- /dev/null+++ b/spec/db/post_migrate/20260311064518_clean_existing_tag_localization_names_spec.rb@@ -0,0 +1,77 @@+# frozen_string_literal: true++require Rails.root.join("db/post_migrate/20260311064518_clean_existing_tag_localization_names.rb")++describe CleanExistingTagLocalizationNames do+ fab!(:tag)++ before do+ @original_verbose = ActiveRecord::Migration.verbose+ ActiveRecord::Migration.verbose = false+ end++ after { ActiveRecord::Migration.verbose = @original_verbose }++ def insert_localization(locale, name)+ DB.query_single(+ "INSERT INTO tag_localizations (tag_id, locale, name, created_at, updated_at) VALUES (:tag_id, :locale, :name, NOW(), NOW()) RETURNING id",+ tag_id: tag.id,+ locale: locale,+ name: name,+ ).first+ end++ def name_for(id)+ DB.query_single("SELECT name FROM tag_localizations WHERE id = :id", id: id).first+ end++ it "cleans names with special characters" do+ loc = insert_localization("nl", 'mijn-naam" (123)')++ described_class.new.up++ expect(name_for(loc)).to eq("mijn-naam-123")+ end++ it "replaces whitespace with dashes" do+ loc = insert_localization("nl", "finances & accounting")++ described_class.new.up++ expect(name_for(loc)).to eq("finances-accounting")+ end++ it "lowercases when force_lowercase_tags is enabled" do+ SiteSetting.force_lowercase_tags = true+ loc = insert_localization("nl", "MyTag")++ described_class.new.up++ expect(name_for(loc)).to eq("mytag")+ end++ it "truncates names exceeding max_tag_length" do+ SiteSetting.max_tag_length = 10+ loc = insert_localization("nl", "a" * 20)++ described_class.new.up++ expect(name_for(loc).length).to eq(10)+ end++ it "skips clean names" do+ loc = insert_localization("ja", "猫タグ")++ described_class.new.up++ expect(name_for(loc)).to eq("猫タグ")+ end++ it "does not blank out names that clean to empty" do+ loc = insert_localization("nl", "\"'()")++ described_class.new.up++ expect(name_for(loc)).to eq("\"'()")+ end+enddiff --git a/spec/models/tag_localization_spec.rb b/spec/models/tag_localization_spec.rbindex cb0ad183cff..de55838e551 100644--- a/spec/models/tag_localization_spec.rb+++ b/spec/models/tag_localization_spec.rb@@ -3,6 +3,33 @@describe TagLocalization dofab!(:tag)+ describe "name cleaning" do+ it "strips special characters from the name" do+ localization = Fabricate(:tag_localization, tag:, locale: "nl", name: 'mijn-naam" (123)')++ expect(localization.name).to eq("mijn-naam-123")+ end++ it "replaces whitespace with dashes" do+ localization = Fabricate(:tag_localization, tag:, locale: "nl", name: "finances & accounting")++ expect(localization.name).to eq("finances-accounting")+ end++ it "preserves unicode word characters" do+ localization = Fabricate(:tag_localization, tag:, locale: "ja", name: "猫タグ")++ expect(localization.name).to eq("猫タグ")+ end++ it "cleans name on update" do+ localization = Fabricate(:tag_localization, tag:, locale: "nl", name: "clean-name")+ localization.update!(name: 'dirty name" (test)')++ expect(localization.name).to eq("dirty-name-test")+ end+ end+describe "validations" doit "validates presence of name and locale" dolocalization = TagLocalization.new(tag:)diff --git a/spec/requests/tag_localizations_controller_spec.rb b/spec/requests/tag_localizations_controller_spec.rbindex 2c9887cfbf6..be2833ac0b2 100644--- a/spec/requests/tag_localizations_controller_spec.rb+++ b/spec/requests/tag_localizations_controller_spec.rb@@ -60,6 +60,18 @@ describe TagLocalizationsController doexpect(localization).to have_attributes(locale:, name:, description:, tag_id: tag.id)end+ it "cleans the localized name" do+ post "/tag_localizations/create_or_update.json",+ params: {+ tag_id: tag.id,+ locale:,+ name: 'mijn-naam" (123)',+ }++ expect(response.status).to eq(201)+ expect(TagLocalization.last.name).to eq("mijn-naam-123")+ end+it "creates localization without description" doexpect {post "/tag_localizations/create_or_update.json",diff --git a/spec/services/tag_settings_updater_spec.rb b/spec/services/tag_settings_updater_spec.rbindex 462cceef8a2..dca7751607e 100644--- a/spec/services/tag_settings_updater_spec.rb+++ b/spec/services/tag_settings_updater_spec.rb@@ -121,12 +121,12 @@ describe TagSettingsUpdater doloc = TagLocalization.find_by(tag_id: tag.id, locale: "de")expect(loc).to be_present- expect(loc.name).to eq("German Name")+ expect(loc.name).to eq("german-name")expect(loc.description).to eq("German Desc")endit "updates existing localizations" do- TagLocalization.create!(tag_id: tag.id, locale: "fr", name: "Old", description: "Old Desc")+ TagLocalization.create!(tag_id: tag.id, locale: "fr", name: "old", description: "Old Desc")TagSettingsUpdater.update(tag,@@ -135,18 +135,18 @@ describe TagSettingsUpdater do)loc = TagLocalization.find_by(tag_id: tag.id, locale: "fr")- expect(loc.name).to eq("New")+ expect(loc.name).to eq("new")expect(loc.description).to eq("New Desc")endit "removes localizations not in the submitted list" do- TagLocalization.create!(tag_id: tag.id, locale: "es", name: "Spanish", description: "")- TagLocalization.create!(tag_id: tag.id, locale: "it", name: "Italian", description: "")+ TagLocalization.create!(tag_id: tag.id, locale: "es", name: "spanish", description: "")+ TagLocalization.create!(tag_id: tag.id, locale: "it", name: "italian", description: "")TagSettingsUpdater.update(tag,admin,- { localizations: [{ locale: "es", name: "Spanish Updated", description: "" }] },+ { localizations: [{ locale: "es", name: "spanish-updated", description: "" }] },)expect(TagLocalization.find_by(tag_id: tag.id, locale: "es")).to be_present