mirror of
https://github.com/discourse/discourse.git
synced 2026-08-06 04:48:33 +08:00
The /about page (unlike /guidelines or /tos) is not backed by a topic, but instead via a bunch of site settings. If it were backed by a topic, localization would be easy as it can just use TopicLocalizations. We also can't swap it out to use a topic, since there are so many fields on the about page that can't be safely contained in a topic. ---------- This PR adds SiteSettingLocalization, allowing new attributes in site settings config for localization. For now this is wired into the About page settings flow: - admins can select a non-default locale on /admin/config/about - only translatable About fields are shown for that locale - localized About values are used on /about and /about.json - company_url can be set manually per locale, but is excluded from automatic translation - ~~AI backfill can translate eligible site setting localizations~~ no backfill (added in https://github.com/discourse/discourse/pull/41123/commits/386c655d2f44aca54440c069bd06ea8007793d84, removed in https://github.com/discourse/discourse/pull/41123/commits/6f8ec9cc43dca4195bda638b1ce980eb68a59941. about page has very non automa-ble fields This intentionally keeps the scope narrow. It does not make every site setting localizable, and any other setting can be localized by adding to that allowlist. Some screenshots |page | 📸 | |--|--| | eng setting | <img width="1278" height="871" alt="Screenshot 2026-06-23 at 11 00 34 PM" src="https://github.com/user-attachments/assets/59431464-fb05-41d9-8c4f-fd9aae7fb45f" /> | ja setting | <img width="1278" height="871" alt="Screenshot 2026-06-23 at 11 01 20 PM" src="https://github.com/user-attachments/assets/73cd2878-f59a-4dc4-a76d-2f46b74a6eed" /> | ja anon about page | <img width="1278" height="871" alt="Screenshot 2026-06-23 at 11 01 48 PM" src="https://github.com/user-attachments/assets/02464a5f-9ca0-4519-9521-be41498c1967" />
177 lines
5.3 KiB
Ruby
Vendored
177 lines
5.3 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
describe SiteSettingLocalization do
|
|
before { SiteSetting.content_localization_enabled = true }
|
|
|
|
describe ".value_for" do
|
|
it "returns the localized setting value for the locale" do
|
|
SiteSetting.site_description = "English description"
|
|
described_class.create!(setting_name: "site_description", locale: "ja", value: "日本語の説明")
|
|
|
|
expect(described_class.value_for(:site_description, locale: "ja")).to eq("日本語の説明")
|
|
end
|
|
|
|
it "falls back to the site setting value" do
|
|
SiteSetting.site_description = "English description"
|
|
|
|
expect(described_class.value_for(:site_description, locale: "ja")).to eq(
|
|
"English description",
|
|
)
|
|
end
|
|
|
|
it "falls back to the site setting value when the localized value is blank" do
|
|
SiteSetting.site_description = "English description"
|
|
localization =
|
|
described_class.create!(setting_name: "site_description", locale: "ja", value: "日本語の説明")
|
|
localization.update_column(:value, "")
|
|
|
|
expect(described_class.value_for(:site_description, locale: "ja")).to eq(
|
|
"English description",
|
|
)
|
|
end
|
|
|
|
it "falls back to a matching base locale" do
|
|
SiteSetting.site_description = "English description"
|
|
described_class.create!(
|
|
setting_name: "site_description",
|
|
locale: "pt",
|
|
value: "Descrição em português",
|
|
)
|
|
|
|
expect(described_class.value_for(:site_description, locale: "pt_BR")).to eq(
|
|
"Descrição em português",
|
|
)
|
|
end
|
|
|
|
it "normalizes hyphenated locale names" do
|
|
SiteSetting.site_description = "English description"
|
|
described_class.create!(
|
|
setting_name: "site_description",
|
|
locale: "pt-BR",
|
|
value: "Descrição brasileira",
|
|
)
|
|
|
|
expect(described_class.value_for(:site_description, locale: "pt-BR")).to eq(
|
|
"Descrição brasileira",
|
|
)
|
|
end
|
|
|
|
it "returns the site setting value when showing original content" do
|
|
SiteSetting.site_description = "English description"
|
|
described_class.create!(setting_name: "site_description", locale: "ja", value: "日本語の説明")
|
|
|
|
expect(described_class.value_for(:site_description, locale: "ja", show_original: true)).to eq(
|
|
"English description",
|
|
)
|
|
end
|
|
|
|
it "returns cooked content for markdown settings" do
|
|
localization =
|
|
described_class.create!(
|
|
setting_name: "extended_site_description",
|
|
locale: "ja",
|
|
value: "これは **説明** です",
|
|
)
|
|
|
|
expect(
|
|
described_class.value_for(:extended_site_description, locale: "ja", cooked: true),
|
|
).to eq(localization.cooked)
|
|
end
|
|
end
|
|
|
|
it "rejects settings outside the allowlist" do
|
|
localization =
|
|
described_class.new(setting_name: "contact_email", locale: "ja", value: "example@example.com")
|
|
|
|
expect(localization).to be_invalid
|
|
end
|
|
|
|
it "rejects settings that are not displayed as localized content" do
|
|
expect(described_class.localizable?("company_url")).to eq(false)
|
|
end
|
|
|
|
it "returns only valid localizable settings" do
|
|
described_class.register(:missing_site_setting)
|
|
|
|
expect(described_class.localizable?("title")).to eq(true)
|
|
expect(described_class.localizable?("missing_site_setting")).to eq(false)
|
|
ensure
|
|
described_class.registered_settings.delete("missing_site_setting")
|
|
end
|
|
|
|
it "loads localizable setting metadata from site settings" do
|
|
expect(SiteSetting.localizable_settings).to include(
|
|
"title" => {
|
|
max_length: 255,
|
|
},
|
|
"site_description" => {
|
|
max_length: 1000,
|
|
},
|
|
"extended_site_description" => {
|
|
cooked: true,
|
|
max_length: 10_000,
|
|
},
|
|
)
|
|
|
|
expect(described_class.localizable_settings).to include(
|
|
"title" => {
|
|
max_length: 255,
|
|
},
|
|
"site_description" => {
|
|
max_length: 1000,
|
|
},
|
|
"extended_site_description" => {
|
|
cooked: true,
|
|
max_length: 10_000,
|
|
},
|
|
)
|
|
end
|
|
|
|
it "removes metadata when a setting is reloaded without localizable options" do
|
|
SiteSetting.send(
|
|
:setting,
|
|
:temporary_localizable_setting,
|
|
"default",
|
|
type: :string,
|
|
localizable: {
|
|
max_length: 20,
|
|
},
|
|
)
|
|
|
|
expect(SiteSetting.localizable_settings).to include(
|
|
"temporary_localizable_setting" => {
|
|
max_length: 20,
|
|
},
|
|
)
|
|
|
|
SiteSetting.send(:setting, :temporary_localizable_setting, "default", type: :string)
|
|
|
|
expect(SiteSetting.localizable_settings).not_to have_key("temporary_localizable_setting")
|
|
end
|
|
|
|
it "rejects cooked content for plain text settings" do
|
|
localization =
|
|
described_class.new(
|
|
setting_name: "site_description",
|
|
locale: "ja",
|
|
value: "日本語の説明",
|
|
cooked: "<p>日本語の説明</p>",
|
|
)
|
|
|
|
expect(localization).to be_invalid
|
|
end
|
|
|
|
it "regenerates cooked content from the setting value" do
|
|
localization =
|
|
described_class.create!(
|
|
setting_name: "extended_site_description",
|
|
locale: "ja",
|
|
value: "これは **安全** です",
|
|
)
|
|
|
|
localization.update!(cooked: "<script>alert('xss')</script>")
|
|
|
|
expect(localization.reload.cooked).to include("<strong>安全</strong>")
|
|
expect(localization.cooked).not_to include("<script>")
|
|
end
|
|
end
|