mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-04 13:44:17 +08:00
a2b0c193df
We will be moving towards `type="module"` for all of Discourse's JS bundles in the near future. This commit makes a start by applying the change to translation bundles. This was previously merged, but the lack of `apply_cdn_headers` on the locales controller led to CORS errors on sites with CDNs.
271 lines
9.7 KiB
Ruby
271 lines
9.7 KiB
Ruby
# frozen_string_literal: true
|
||
|
||
RSpec.describe ExtraLocalesController do
|
||
around { |example| allow_missing_translations(&example) }
|
||
|
||
after { ExtraLocalesController.clear_cache!(all_sites: true) }
|
||
|
||
let(:fake_digest) { "a" * 40 }
|
||
|
||
describe "#show" do
|
||
it "won't work with a weird parameter" do
|
||
get "/extra-locales/#{fake_digest}/en/-invalid..character!!.js"
|
||
expect(response.status).to eq(404)
|
||
end
|
||
|
||
it "needs a valid bundle" do
|
||
get "/extra-locales/#{fake_digest}/en/made-up-bundle.js"
|
||
expect(response.status).to eq(404)
|
||
end
|
||
|
||
it "requires a valid digest" do
|
||
get "/extra-locales/ZZZ/en/overrides.js"
|
||
expect(response.status).to eq(400)
|
||
end
|
||
|
||
it "caches for 1 year if version is provided and it matches current hash" do
|
||
get "/extra-locales/#{ExtraLocalesController.bundle_js_hash("admin", locale: :en)}/en/admin.js"
|
||
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/#{fake_digest}/en/admin.js"
|
||
expect(response.status).to eq(200)
|
||
expect(response.headers["Cache-Control"]).not_to include("max-age", "public", "immutable")
|
||
end
|
||
|
||
it "doesn’t generate the bundle twice" do
|
||
described_class.expects(:bundle_js).returns("JS").once
|
||
get "/extra-locales/#{fake_digest}/en/admin.js"
|
||
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 { JsLocaleHelper.clear_cache! }
|
||
|
||
it "includes plugin translations" do
|
||
get "/extra-locales/#{fake_digest}/en/admin.js"
|
||
expect(response.status).to eq(200)
|
||
expect(response.body.include?("github_badges")).to eq(true)
|
||
end
|
||
end
|
||
|
||
context "with 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/#{ExtraLocalesController.bundle_js_hash("overrides", locale: :en)}/en/overrides.js"
|
||
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/#{fake_digest}/en/overrides.js"
|
||
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/#{fake_digest}/en/overrides.js"
|
||
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("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} }",
|
||
)
|
||
|
||
get ExtraLocalesController.url("overrides", locale: :fr)
|
||
|
||
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" },
|
||
)
|
||
end
|
||
end
|
||
end
|
||
|
||
context "when requesting MessageFormat translations" do
|
||
before { JsLocaleHelper.stubs(:output_MF).with("en").returns("MF_TRANSLATIONS") }
|
||
|
||
it "returns the translations properly" do
|
||
get ExtraLocalesController.url("mf")
|
||
expect(response.body).to eq("MF_TRANSLATIONS")
|
||
end
|
||
end
|
||
end
|
||
|
||
describe ".bundle_js_hash" do
|
||
it "doesn't call bundle_js more than once for the same locale and bundle" do
|
||
locale = :de
|
||
ExtraLocalesController.expects(:bundle_js).with("admin", locale:).returns("admin_js DE").once
|
||
expected_hash_de = Digest::SHA1.hexdigest("#{described_class::CACHE_VERSION}|admin_js DE")
|
||
|
||
expect(ExtraLocalesController.bundle_js_hash("admin", locale:)).to eq(expected_hash_de)
|
||
expect(ExtraLocalesController.bundle_js_hash("admin", locale:)).to eq(expected_hash_de)
|
||
|
||
locale = :fr
|
||
ExtraLocalesController.expects(:bundle_js).with("admin", locale:).returns("admin_js FR").once
|
||
expected_hash_fr = Digest::SHA1.hexdigest("#{described_class::CACHE_VERSION}|admin_js FR")
|
||
|
||
expect(ExtraLocalesController.bundle_js_hash("admin", locale:)).to eq(expected_hash_fr)
|
||
expect(ExtraLocalesController.bundle_js_hash("admin", locale:)).to eq(expected_hash_fr)
|
||
|
||
locale = :de
|
||
expect(ExtraLocalesController.bundle_js_hash("admin", locale:)).to eq(expected_hash_de)
|
||
|
||
ExtraLocalesController
|
||
.expects(:bundle_js)
|
||
.with("wizard", locale:)
|
||
.returns("wizard_js DE")
|
||
.once
|
||
expected_hash_de = Digest::SHA1.hexdigest("#{described_class::CACHE_VERSION}|wizard_js DE")
|
||
|
||
expect(ExtraLocalesController.bundle_js_hash("wizard", locale:)).to eq(expected_hash_de)
|
||
expect(ExtraLocalesController.bundle_js_hash("wizard", locale:)).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
|
||
|
||
describe ".bundle_js_with_hash" do
|
||
before { described_class.stubs(:bundle_js).with("admin", locale: :en).returns("JS") }
|
||
|
||
it "returns both JS and its hash for a given bundle" do
|
||
expect(described_class.bundle_js_with_hash("admin", locale: :en)).to eq(
|
||
["JS", Digest::SHA1.hexdigest("#{described_class::CACHE_VERSION}|JS")],
|
||
)
|
||
end
|
||
end
|
||
|
||
describe ".url" do
|
||
it "works" do
|
||
expect(ExtraLocalesController.url("admin")).to match(
|
||
%r{\A/extra-locales/\h{40}/en/admin\.js\z},
|
||
)
|
||
end
|
||
|
||
it "includes subfolder path" do
|
||
set_subfolder "/forum"
|
||
expect(ExtraLocalesController.url("admin")).to start_with("/forum/extra-locales/")
|
||
end
|
||
|
||
it "includes CDN" do
|
||
set_cdn_url "https://cdn.example.com"
|
||
expect(ExtraLocalesController.url("admin")).to start_with(
|
||
"https://cdn.example.com/extra-locales/",
|
||
)
|
||
end
|
||
|
||
it "includes hostname param for site-specific bundles" do
|
||
set_cdn_url "https://cdn.example.com"
|
||
expect(ExtraLocalesController.url("admin")).to start_with(
|
||
"https://cdn.example.com/extra-locales/",
|
||
)
|
||
end
|
||
|
||
it "includes locale correctly" do
|
||
expect(ExtraLocalesController.url("admin")).to include("/en/admin.js")
|
||
I18n.with_locale(:fr) do
|
||
expect(ExtraLocalesController.url("admin")).to include("/fr/admin.js")
|
||
end
|
||
end
|
||
end
|
||
end
|
