mirror of
https://github.com/discourse/discourse.git
synced 2024-12-14 14:03:41 +08:00
769388b8ba
Discourse sent only translation overrides for the current language to the client instead of sending overrides from fallback locales as well. This especially impacted en_GB -> en since most overrides would be done in English instead of English (UK). This also adds lots of tests for previously untested code. There's a small caveat: The client currently doesn't handle fallback locales for MessageFormat strings. That is why overrides for those strings always have a higher priority than regular translations. So, as an example, the lookup order for MessageFormat strings in German is: 1. override for de 2. override for en 3. value from de 4. value from en
198 lines
7.8 KiB
Ruby
198 lines
7.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
describe ExtraLocalesController do
|
|
context 'show' do
|
|
|
|
it "won't work with a weird parameter" do
|
|
get "/extra-locales/-invalid..character!!"
|
|
expect(response.status).to eq(404)
|
|
end
|
|
|
|
it "needs a valid bundle" do
|
|
get "/extra-locales/made-up-bundle"
|
|
expect(response.status).to eq(403)
|
|
end
|
|
|
|
it "requires staff access" do
|
|
get "/extra-locales/admin"
|
|
expect(response.status).to eq(403)
|
|
|
|
get "/extra-locales/wizard"
|
|
expect(response.status).to eq(403)
|
|
end
|
|
|
|
it "requires a valid version" do
|
|
get "/extra-locales/overrides", params: { v: 'a' }
|
|
expect(response.status).to eq(400)
|
|
|
|
get "/extra-locales/overrides?v[foo]=1"
|
|
expect(response.status).to eq(400)
|
|
end
|
|
|
|
context "logged in as a moderator" do
|
|
|
|
let(:moderator) { Fabricate(:moderator) }
|
|
before { sign_in(moderator) }
|
|
|
|
it "caches for 1 year if version is provided and it matches current hash" do
|
|
get "/extra-locales/admin", params: { v: ExtraLocalesController.bundle_js_hash('admin') }
|
|
expect(response.status).to eq(200)
|
|
expect(response.headers["Cache-Control"]).to eq("max-age=31556952, public, immutable")
|
|
end
|
|
|
|
it "does not cache at all if version is invalid" do
|
|
get "/extra-locales/admin", params: { v: 'a' * 32 }
|
|
expect(response.status).to eq(200)
|
|
expect(response.headers["Cache-Control"]).not_to include("max-age", "public", "immutable")
|
|
end
|
|
|
|
context "with plugin" do
|
|
before do
|
|
JsLocaleHelper.clear_cache!
|
|
JsLocaleHelper.expects(:plugin_translations)
|
|
.with(any_of("en", "en_GB"))
|
|
.returns("admin_js" => {
|
|
"admin" => {
|
|
"site_settings" => {
|
|
"categories" => {
|
|
"github_badges" => "GitHub Badges"
|
|
}
|
|
}
|
|
}
|
|
}).at_least_once
|
|
end
|
|
|
|
after do
|
|
JsLocaleHelper.clear_cache!
|
|
end
|
|
|
|
it "includes plugin translations" do
|
|
get "/extra-locales/admin"
|
|
expect(response.status).to eq(200)
|
|
expect(response.body.include?("github_badges")).to eq(true)
|
|
end
|
|
end
|
|
end
|
|
|
|
context "overridden translations" do
|
|
after { I18n.reload! }
|
|
|
|
it "works for anonymous users" do
|
|
TranslationOverride.upsert!(I18n.locale, 'js.some_key', 'client-side translation')
|
|
|
|
get "/extra-locales/overrides", params: { v: ExtraLocalesController.bundle_js_hash('overrides') }
|
|
expect(response.status).to eq(200)
|
|
expect(response.headers["Cache-Control"]).to eq("max-age=31556952, public, immutable")
|
|
end
|
|
|
|
it "returns nothing when there are not overridden translations" do
|
|
get "/extra-locales/overrides"
|
|
expect(response.status).to eq(200)
|
|
expect(response.body).to be_empty
|
|
end
|
|
|
|
context "with translations" do
|
|
it "returns the correct translations" do
|
|
TranslationOverride.upsert!(I18n.locale, 'js.some_key', 'client-side translation')
|
|
TranslationOverride.upsert!(I18n.locale, 'js.client_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
TranslationOverride.upsert!(I18n.locale, 'admin_js.another_key', 'admin client js')
|
|
TranslationOverride.upsert!(I18n.locale, 'server.some_key', 'server-side translation')
|
|
TranslationOverride.upsert!(I18n.locale, 'server.some_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
|
|
get "/extra-locales/overrides"
|
|
expect(response.status).to eq(200)
|
|
expect(response.body).to_not include("server.some_key", "server.some_MF")
|
|
|
|
ctx = MiniRacer::Context.new
|
|
ctx.eval("I18n = {};")
|
|
ctx.eval(response.body)
|
|
|
|
expect(ctx.eval("typeof I18n._mfOverrides['js.client_MF']")).to eq("function")
|
|
expect(ctx.eval("I18n._overrides['#{I18n.locale}']['js.some_key']")).to eq("client-side translation")
|
|
expect(ctx.eval("I18n._overrides['#{I18n.locale}']['js.client_MF'] === undefined")).to eq(true)
|
|
expect(ctx.eval("I18n._overrides['#{I18n.locale}']['admin_js.another_key']")).to eq("admin client js")
|
|
end
|
|
|
|
it "returns overrides from fallback locale" do
|
|
TranslationOverride.upsert!(:en, 'js.some_key', 'some key (en)')
|
|
TranslationOverride.upsert!(:fr, 'js.some_key', 'some key (fr)')
|
|
TranslationOverride.upsert!(:en, 'js.only_en', 'only English')
|
|
TranslationOverride.upsert!(:fr, 'js.only_fr', 'only French')
|
|
TranslationOverride.upsert!(:en, 'js.some_client_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
TranslationOverride.upsert!(:fr, 'js.some_client_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
TranslationOverride.upsert!(:en, 'js.only_en_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
TranslationOverride.upsert!(:fr, 'js.only_fr_MF', '{NUM_RESULTS, plural, one {1 result} other {many} }')
|
|
|
|
SiteSetting.allow_user_locale = true
|
|
user = Fabricate(:user, locale: :fr)
|
|
sign_in(user)
|
|
|
|
get "/extra-locales/overrides"
|
|
expect(response.status).to eq(200)
|
|
|
|
ctx = MiniRacer::Context.new
|
|
ctx.eval("I18n = {};")
|
|
ctx.eval(response.body)
|
|
|
|
overrides = ctx.eval("I18n._overrides")
|
|
expect(overrides.keys).to contain_exactly("en", "fr")
|
|
expect(overrides["en"]).to eq({ 'js.only_en' => 'only English' })
|
|
expect(overrides["fr"]).to eq({ 'js.some_key' => 'some key (fr)', 'js.only_fr' => 'only French' })
|
|
|
|
expect(ctx.eval("Object.keys(I18n._mfOverrides)")).to contain_exactly("js.some_client_MF", "js.only_en_MF", "js.only_fr_MF")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe ".bundle_js_hash" do
|
|
it "doesn't call bundle_js more than once for the same locale and bundle" do
|
|
I18n.locale = :de
|
|
ExtraLocalesController.expects(:bundle_js).with("admin").returns("admin_js DE").once
|
|
expected_hash_de = Digest::MD5.hexdigest("admin_js DE")
|
|
|
|
expect(ExtraLocalesController.bundle_js_hash("admin")).to eq(expected_hash_de)
|
|
expect(ExtraLocalesController.bundle_js_hash("admin")).to eq(expected_hash_de)
|
|
|
|
I18n.locale = :fr
|
|
ExtraLocalesController.expects(:bundle_js).with("admin").returns("admin_js FR").once
|
|
expected_hash_fr = Digest::MD5.hexdigest("admin_js FR")
|
|
|
|
expect(ExtraLocalesController.bundle_js_hash("admin")).to eq(expected_hash_fr)
|
|
expect(ExtraLocalesController.bundle_js_hash("admin")).to eq(expected_hash_fr)
|
|
|
|
I18n.locale = :de
|
|
expect(ExtraLocalesController.bundle_js_hash("admin")).to eq(expected_hash_de)
|
|
|
|
ExtraLocalesController.expects(:bundle_js).with("wizard").returns("wizard_js DE").once
|
|
expected_hash_de = Digest::MD5.hexdigest("wizard_js DE")
|
|
|
|
expect(ExtraLocalesController.bundle_js_hash("wizard")).to eq(expected_hash_de)
|
|
expect(ExtraLocalesController.bundle_js_hash("wizard")).to eq(expected_hash_de)
|
|
end
|
|
end
|
|
|
|
describe ".client_overrides_exist?" do
|
|
after do
|
|
I18n.reload!
|
|
ExtraLocalesController.clear_cache!
|
|
end
|
|
|
|
it "returns false if there are no client-side translation overrides" do
|
|
expect(ExtraLocalesController.client_overrides_exist?).to eq(false)
|
|
|
|
TranslationOverride.upsert!(I18n.locale, 'server.some_key', 'server-side translation')
|
|
expect(ExtraLocalesController.client_overrides_exist?).to eq(false)
|
|
end
|
|
|
|
it "returns true if there are client-side translation overrides" do
|
|
expect(ExtraLocalesController.client_overrides_exist?).to eq(false)
|
|
|
|
TranslationOverride.upsert!(I18n.locale, 'js.some_key', 'client-side translation')
|
|
expect(ExtraLocalesController.client_overrides_exist?).to eq(true)
|
|
end
|
|
end
|
|
end
|