Skip to content

A platform for community discussion. Free, open, simple.

FIX: Recompile core stylesheets when the palette or fonts change

Régis Hanol6ba633dbf565
diff --git a/config/initializers/014-track-setting-changes.rb b/config/initializers/014-track-setting-changes.rb
index d95599351b7..b1bf930ffd4 100644
--- a/config/initializers/014-track-setting-changes.rb
+++ b/config/initializers/014-track-setting-changes.rb
@@ -31,7 +31,7 @@ DiscourseEvent.on(:site_setting_changed) do |name, old_value, new_value|
end
end
- Stylesheet::Manager.clear_color_scheme_cache! if %i[base_font heading_font].include?(name)
+ Stylesheet::Manager.cache.clear if %i[base_font heading_font default_theme_id].include?(name)
Report.clear_cache(:storage_stats) if %i[backup_location s3_backup_bucket].include?(name)
diff --git a/lib/stylesheet/compiler.rb b/lib/stylesheet/compiler.rb
index 8c96a8974fb..bb3d0672b28 100644
--- a/lib/stylesheet/compiler.rb
+++ b/lib/stylesheet/compiler.rb
@@ -34,7 +34,7 @@ module Stylesheet
file += "@import \"#{asset}\";\n"
case asset.to_s
- when "embed", "publish"
+ when *Importer::FONT_TARGETS
file += importer.font
when "wizard"
file += importer.wizard_fonts
diff --git a/lib/stylesheet/importer.rb b/lib/stylesheet/importer.rb
index 006cc56b579..07b384c2ed1 100644
--- a/lib/stylesheet/importer.rb
+++ b/lib/stylesheet/importer.rb
@@ -7,6 +7,7 @@ module Stylesheet
include GlobalPath
THEME_TARGETS = %w[embedded_theme common_theme mobile_theme desktop_theme]
+ FONT_TARGETS = %w[embed publish]
def self.plugin_assets
@plugin_assets ||= {}
diff --git a/lib/stylesheet/manager/builder.rb b/lib/stylesheet/manager/builder.rb
index 818e5baadef..5407bdf098f 100644
--- a/lib/stylesheet/manager/builder.rb
+++ b/lib/stylesheet/manager/builder.rb
@@ -245,21 +245,37 @@ class Stylesheet::Manager::Builder
end
def default_digest
- Digest::SHA1.hexdigest "default-#{Stylesheet::Manager.fs_asset_cachebuster}-#{plugins_digest}-#{current_hostname}"
+ Digest::SHA1.hexdigest "default-#{Stylesheet::Manager.fs_asset_cachebuster}-#{plugins_digest}-#{current_hostname}-#{GlobalSetting.cdn_url}-#{default_palette_digest}-#{font_targets_digest}"
+ end
+
+ def default_palette_digest
+ scheme = Theme.find_default&.color_scheme
+ "#{scheme&.id}-#{scheme&.version}"
+ end
+
+ def font_targets_digest
+ if Stylesheet::Importer::FONT_TARGETS.include?(@target.to_s.delete_suffix("_rtl"))
+ fonts_digest
+ else
+ ""
+ end
+ end
+
+ def fonts_digest
+ "#{SiteSetting.base_font}-#{SiteSetting.heading_font}"
end
def color_scheme_digest
cs = @color_scheme || theme&.color_scheme
- fonts = "#{SiteSetting.base_font}-#{SiteSetting.heading_font}"
-
digest_string = "#{current_hostname}-"
if cs
theme_color_defs = resolve_baked_field(:common, :color_definitions)
digest_string +=
- "#{RailsMultisite::ConnectionManagement.current_db}-#{cs&.id}-#{cs&.version}-#{theme_color_defs}-#{Stylesheet::Manager.fs_asset_cachebuster}-#{fonts}"
+ "#{RailsMultisite::ConnectionManagement.current_db}-#{cs&.id}-#{cs&.version}-#{theme_color_defs}-#{Stylesheet::Manager.fs_asset_cachebuster}-#{fonts_digest}"
else
- digest_string += "defaults-#{Stylesheet::Manager.fs_asset_cachebuster}-#{fonts}"
+ digest_string += "defaults-#{Stylesheet::Manager.fs_asset_cachebuster}-#{fonts_digest}"
+ digest_string += "-#{default_palette_digest}" if theme&.component
if cdn_url = GlobalSetting.cdn_url
digest_string += "-#{cdn_url}"
diff --git a/spec/lib/stylesheet/manager_spec.rb b/spec/lib/stylesheet/manager_spec.rb
index 7a03d5df493..14a666c2387 100644
--- a/spec/lib/stylesheet/manager_spec.rb
+++ b/spec/lib/stylesheet/manager_spec.rb
@@ -18,6 +18,16 @@ RSpec.describe Stylesheet::Manager do
expect(link).not_to eq("")
end
+ describe "#stylesheet_details" do
+ it "refreshes hrefs when a font setting changes" do
+ href = manager.stylesheet_details(:embed)[0][:new_href]
+
+ SiteSetting.base_font = DiscourseFonts.fonts[2][:key]
+
+ expect(manager.stylesheet_details(:embed)[0][:new_href]).not_to eq(href)
+ end
+ end
+
describe "Builder#compile" do
it "hydrates from StylesheetCache instead of recompiling when the file is missing" do
builder = Stylesheet::Manager::Builder.new(target: :common, manager: manager)
@@ -481,6 +491,33 @@ RSpec.describe Stylesheet::Manager do
expect(builder.digest).to eq(builder.default_digest)
end
+ it "accounts for the default theme's color scheme in default and component digests" do
+ scheme = Fabricate(:color_scheme)
+ SiteSetting.default_theme_id = Fabricate(:theme, color_scheme: scheme).id
+ component = Fabricate(:theme, component: true)
+ common = -> { Stylesheet::Manager::Builder.new(target: :common, manager: manager).digest }
+ component_common = -> do
+ Stylesheet::Manager::Builder.new(
+ target: :common_theme,
+ theme: component,
+ manager: manager,
+ ).digest
+ end
+
+ expect {
+ ColorSchemeRevisor.revise(scheme, { colors: [{ name: "primary", hex: "CC0000" }] })
+ }.to change(&common).and change(&component_common)
+ end
+
+ it "accounts for fonts in the default digest of font-bearing targets only" do
+ embed = -> { Stylesheet::Manager::Builder.new(target: :embed, manager: manager).digest }
+ common = -> { Stylesheet::Manager::Builder.new(target: :common, manager: manager).digest }
+
+ expect { SiteSetting.base_font = DiscourseFonts.fonts[2][:key] }.to change(
+ &embed
+ ).and not_change(&common)
+ end
+
it "returns different digest based on hostname" do
theme = Fabricate(:theme)