A platform for community discussion. Free, open, simple.
DEV: Add resolve_group_membership functionality to theme settings (#41360)
Martin Brennan7e77ce4bd388
diff --git a/app/models/theme.rb b/app/models/theme.rbindex eaf652ec394..7c8d2bd606a 100644--- a/app/models/theme.rb+++ b/app/models/theme.rb@@ -17,6 +17,7 @@ class Theme < ActiveRecord::Baseuser_selectableupdated_at]+ PRIVATE_CACHED_SETTING_KEYS = %w[theme_uploads theme_uploads_local theme_setting_type_info]class SettingsMigrationError < StandardErrorend@@ -805,21 +806,25 @@ class Theme < ActiveRecord::Basetheme_uploads_local = build_local_theme_uploads_hashsettings_hash["theme_uploads_local"] = theme_uploads_local if theme_uploads_local.present?+ settings_hash["theme_setting_type_info"] = build_theme_setting_type_info_hash if settings.any?+settings_hashendenddef build_settings_hash- hash = {}- settings.each { |name, setting| hash[name] = setting.value }+ settings_hash = {}+ settings.each { |name, setting| settings_hash[name] = setting.value }theme_uploads = build_theme_uploads_hash- hash["theme_uploads"] = theme_uploads if theme_uploads.present?+ settings_hash["theme_uploads"] = theme_uploads if theme_uploads.present?theme_uploads_local = build_local_theme_uploads_hash- hash["theme_uploads_local"] = theme_uploads_local if theme_uploads_local.present?+ settings_hash["theme_uploads_local"] = theme_uploads_local if theme_uploads_local.present?- hash+ settings_hash["theme_setting_type_info"] = build_theme_setting_type_info_hash if settings.any?++ settings_hashenddef build_theme_uploads_hash@@ -842,6 +847,30 @@ class Theme < ActiveRecord::Basehashend+ def build_theme_setting_type_info_hash+ settings.each_with_object({}) do |(name, setting), hash|+ hash[name] = { type: setting.type_name.to_s }.merge(+ setting.opts.compact.except(:description, :max, :min),+ )+ end+ end++ def resolve_group_settings_for_user(settings_hash, guardian)+ resolved_hash = settings_hash.dup++ (cached_settings["theme_setting_type_info"] || []).each do |name, info|+ next unless info[:type] == "list"+ next unless info[:resolve_group_membership]++ # Replace group list with user_in_ prefixed boolean (prevents leaking group IDs)+ group_ids = settings_hash[name].to_s.split("|").map(&:to_i)+ resolved_hash.delete(name)+ resolved_hash[:"user_in_#{name}"] = guardian.in_any_groups?(group_ids)+ end++ resolved_hash+ end+# Retrieves a theme setting## @param setting_name [String, Symbol] The name of the setting to retrieve.@@ -980,7 +1009,7 @@ class Theme < ActiveRecord::Baseendsettings_hash&.each do |name, value|- next if name == "theme_uploads" || name == "theme_uploads_local"+ next if Theme::PRIVATE_CACHED_SETTING_KEYS.include?(name)contents << to_scss_variable(name, value)enddiff --git a/app/serializers/theme_settings_serializer.rb b/app/serializers/theme_settings_serializer.rbindex 28b2512c934..c00d675f550 100644--- a/app/serializers/theme_settings_serializer.rb+++ b/app/serializers/theme_settings_serializer.rb@@ -9,6 +9,7 @@ class ThemeSettingsSerializer < ApplicationSerializer:description,:valid_values,:list_type,+ :resolve_group_membership,:textarea,:json_schema,:objects_schema@@ -99,6 +100,14 @@ class ThemeSettingsSerializer < ApplicationSerializerobject.type == ThemeSetting.types[:string] && object.json_schema.present?end+ def resolve_group_membership+ object.resolve_group_membership?+ end++ def include_resolve_group_membership?+ object.type == ThemeSetting.types[:list] && object.list_type == "group"+ end+privatedef choice_labelsdiff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 281440c155e..12855715002 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -147,6 +147,8 @@ en:string_value_not_valid_max:one: "Value must be at most %{count} character long."other: "Value must be at most %{count} characters long."+ resolve_group_membership_requires_list: "resolve_group_membership can only be used with type: list"+ resolve_group_membership_requires_group_list: "resolve_group_membership requires list_type: group"objects:humanize_required: "The property at JSON Pointer '%{property_json_pointer}' must be present."required: "must be present"diff --git a/lib/application_layout_preloader.rb b/lib/application_layout_preloader.rbindex 66c6eb930df..51d7a2b2a98 100644--- a/lib/application_layout_preloader.rb+++ b/lib/application_layout_preloader.rb@@ -139,7 +139,9 @@ class ApplicationLayoutPreloaderTheme.where(id: ids).each_with_object({}) do |theme, hash|- hash[theme.id] = { name: theme.name, settings: theme.cached_settings }+ settings = theme.cached_settings+ settings = theme.resolve_group_settings_for_user(settings, @guardian)+ hash[theme.id] = { name: theme.name, settings: settings.except("theme_setting_type_info") }end.to_jsonenddiff --git a/lib/tasks/themes.rake b/lib/tasks/themes.rakeindex e81568dfd3e..4051ec2b7d6 100644--- a/lib/tasks/themes.rake+++ b/lib/tasks/themes.rake@@ -72,7 +72,7 @@ task "themes:export_theme_bundle", %i[theme output] => :environment do |task, arcurrent = theme.cached_settingsdefaults = theme.cached_default_settingscurrent.each do |name, value|- next if name == "theme_uploads" || name == "theme_uploads_local"+ next if Theme::PRIVATE_CACHED_SETTING_KEYS.include?(name)parent_settings[name] = value if value != defaults[name]end@@ -98,7 +98,7 @@ task "themes:export_theme_bundle", %i[theme output] => :environment do |task, arcomp_current = comp.cached_settingscomp_defaults = comp.cached_default_settingscomp_current.each do |name, value|- next if name == "theme_uploads" || name == "theme_uploads_local"+ next if Theme::PRIVATE_CACHED_SETTING_KEYS.include?(name)comp_settings[name] = value if value != comp_defaults[name]enddiff --git a/lib/theme_settings_manager.rb b/lib/theme_settings_manager.rbindex e3d9e9b438b..4588883f3ce 100644--- a/lib/theme_settings_manager.rb+++ b/lib/theme_settings_manager.rb@@ -1,7 +1,7 @@# frozen_string_literal: trueclass ThemeSettingsManager- attr_reader :name, :theme, :default+ attr_reader :name, :theme, :default, :optsdef self.typesThemeSetting.typesdiff --git a/lib/theme_settings_manager/list.rb b/lib/theme_settings_manager/list.rbindex 0a83bee35e5..fc3ec037edf 100644--- a/lib/theme_settings_manager/list.rb+++ b/lib/theme_settings_manager/list.rb@@ -4,4 +4,8 @@ class ThemeSettingsManager::List < ThemeSettingsManagerdef list_type@opts[:list_type]end++ def resolve_group_membership?+ @opts[:resolve_group_membership] && list_type == "group"+ endenddiff --git a/lib/theme_settings_parser.rb b/lib/theme_settings_parser.rbindex 823c611890a..8cd9c28e055 100644--- a/lib/theme_settings_parser.rb+++ b/lib/theme_settings_parser.rb@@ -38,6 +38,7 @@ class ThemeSettingsParserendopts[:list_type] = raw_opts[:list_type] if raw_opts[:list_type]+ opts[:resolve_group_membership] = !!raw_opts[:resolve_group_membership]opts[:textarea] = !!raw_opts[:textarea]opts[:json_schema] = raw_opts[:json_schema]diff --git a/lib/theme_settings_validator.rb b/lib/theme_settings_validator.rbindex ea560c4ae72..5a0158c7578 100644--- a/lib/theme_settings_validator.rb+++ b/lib/theme_settings_validator.rb@@ -27,6 +27,8 @@ class ThemeSettingsValidatordef validate_value(value, type, opts)errors = []+ errors.concat(validate_resolve_group_membership(opts, type))+case typewhen types[:enum]if opts[:choices].exclude?(value) && opts[:choices].map(&:to_s).exclude?(value)@@ -60,6 +62,18 @@ class ThemeSettingsValidatorerrorsend+ def validate_resolve_group_membership(opts, type)+ errors = []+ if opts[:resolve_group_membership]+ if type != types[:list]+ errors << I18n.t("themes.settings_errors.resolve_group_membership_requires_list")+ elsif opts[:list_type] != "group"+ errors << I18n.t("themes.settings_errors.resolve_group_membership_requires_group_list")+ end+ end+ errors+ end+privatedef typesdiff --git a/spec/lib/application_layout_preloader_spec.rb b/spec/lib/application_layout_preloader_spec.rbnew file mode 100644index 00000000000..01f7d0f387f--- /dev/null+++ b/spec/lib/application_layout_preloader_spec.rb@@ -0,0 +1,165 @@+# frozen_string_literal: true++RSpec.describe ApplicationLayoutPreloader do+ subject do+ described_class.new(+ guardian: guardian,+ theme_id: theme_id,+ theme_target: :desktop,+ login_method: nil,+ )+ end++ let(:theme_id) { nil }++ describe "#preloaded_data" do+ let(:guardian) { user.guardian }+ let(:preloaded_data) { subject.preloaded_data }++ context "when the user is anonymous" do+ let(:guardian) { Guardian.new }++ it "preloads the anonymous keys" do+ expect(preloaded_data.keys).to contain_exactly(+ "site",+ "siteSettings",+ "themeSiteSettingOverrides",+ "customHTML",+ "banner",+ "customEmoji",+ "isReadOnly",+ "isStaffWritesOnly",+ "activatedThemes",+ "upcomingChanges",+ )+ end+ end++ context "when the user is logged in" do+ fab!(:user)++ it "preloads the current user keys" do+ expect(preloaded_data.keys).to contain_exactly(+ "site",+ "siteSettings",+ "themeSiteSettingOverrides",+ "customHTML",+ "banner",+ "customEmoji",+ "isReadOnly",+ "isStaffWritesOnly",+ "activatedThemes",+ "upcomingChanges",+ "currentUser",+ "topicTrackingStates",+ "topicTrackingStateMeta",+ )+ end+ end++ context "when the user is an admin" do+ fab!(:user, :admin)++ it "preloads the admin keys" do+ expect(preloaded_data.keys).to contain_exactly(+ "site",+ "siteSettings",+ "themeSiteSettingOverrides",+ "customHTML",+ "banner",+ "customEmoji",+ "isReadOnly",+ "isStaffWritesOnly",+ "activatedThemes",+ "upcomingChanges",+ "currentUser",+ "topicTrackingStates",+ "topicTrackingStateMeta",+ "fontMap",+ "visiblePlugins",+ )+ end+ end+ end++ describe "#activated_themes_json" do+ fab!(:user)+ fab!(:theme) { Fabricate(:theme, name: "Parent theme") }+ fab!(:component) { Fabricate(:theme, name: "Theme component", component: true) }+ fab!(:group)+ fab!(:other_group, :group)++ let(:guardian) { user.guardian }+ let(:activated_themes) { JSON.parse(subject.preloaded_data["activatedThemes"]) }++ before do+ theme.set_field(target: :settings, name: :yaml, value: <<~YAML)+ color:+ default: "red"+ allowed_groups:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{group.id}"+ other_allowed_groups:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{other_group.id}"+ YAML++ component.set_field(target: :settings, name: :yaml, value: <<~YAML)+ component_setting:+ default: "enabled"+ YAML++ theme.save!+ component.save!+ group.add(user)+ theme.add_relative_theme!(:child, component)+ end++ context "without a theme id" do+ let(:theme_id) { nil }++ it "returns an empty object" do+ expect(activated_themes).to eq({})+ end+ end++ context "with an active theme" do+ let(:theme_id) { theme.id }++ it "serializes the active theme and components" do+ expect(activated_themes).to eq(+ theme.id.to_s => {+ "name" => "Parent theme",+ "settings" => {+ "color" => "red",+ "user_in_allowed_groups" => true,+ "user_in_other_allowed_groups" => false,+ },+ },+ component.id.to_s => {+ "name" => "Theme component",+ "settings" => {+ "component_setting" => "enabled",+ },+ },+ )+ end+ end++ context "with an anonymous user" do+ let(:guardian) { Guardian.new }+ let(:theme_id) { theme.id }++ it "resolves group settings for the anonymous guardian" do+ expect(activated_themes.dig(theme.id.to_s, "settings")).to include(+ "user_in_allowed_groups" => false,+ "user_in_other_allowed_groups" => false,+ )+ end+ end+ end+enddiff --git a/spec/lib/theme_settings_manager_spec.rb b/spec/lib/theme_settings_manager_spec.rbindex 48fd87c12cc..e786b542937 100644--- a/spec/lib/theme_settings_manager_spec.rb+++ b/spec/lib/theme_settings_manager_spec.rb@@ -141,6 +141,51 @@ RSpec.describe ThemeSettingsManager dolist_setting = theme_settings[:compact_list_setting]expect(list_setting.list_type).to eq("compact")end++ describe "#resolve_group_membership?" do+ it "returns true when opted-in with list_type group" do+ yaml = <<~YAML+ test_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "1|2"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ setting = theme.settings[:test_setting]+ expect(setting.resolve_group_membership?).to eq(true)+ end++ it "returns false when list_type is not group" do+ setting =+ described_class.create(+ :test_setting,+ "a|b",+ ThemeSetting.types[:list],+ theme,+ list_type: "compact",+ resolve_group_membership: true,+ )++ expect(setting.resolve_group_membership?).to eq(false)+ end++ it "returns false when not opted-in" do+ yaml = <<~YAML+ test_setting:+ type: list+ list_type: group+ default: "1|2"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ setting = theme.settings[:test_setting]+ expect(setting.resolve_group_membership?).to eq(false)+ end+ endenddescribe "Upload" dodiff --git a/spec/lib/theme_settings_parser_spec.rb b/spec/lib/theme_settings_parser_spec.rbindex fa0414a29be..67d4f00416d 100644--- a/spec/lib/theme_settings_parser_spec.rb+++ b/spec/lib/theme_settings_parser_spec.rb@@ -88,4 +88,43 @@ RSpec.describe ThemeSettingsParser doexpect(list_type).to eq("compact")endend++ describe "resolve_group_membership" do+ it "parses resolve_group_membership option" do+ yaml = <<~YAML+ groups_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "1|2"+ YAML++ field = ThemeField.create!(theme_id: -1, target_id: 3, name: "yaml", value: yaml)+ parsed = []+ ThemeSettingsParser+ .new(field)+ .load { |name, default, type, opts| parsed << { name: name, opts: opts } }++ setting = parsed.find { |s| s[:name] == :groups_setting }+ expect(setting[:opts][:resolve_group_membership]).to eq(true)+ end++ it "defaults to false when not specified" do+ yaml = <<~YAML+ groups_setting:+ type: list+ list_type: group+ default: "1|2"+ YAML++ field = ThemeField.create!(theme_id: -1, target_id: 3, name: "yaml", value: yaml)+ parsed = []+ ThemeSettingsParser+ .new(field)+ .load { |name, default, type, opts| parsed << { name: name, opts: opts } }++ setting = parsed.find { |s| s[:name] == :groups_setting }+ expect(setting[:opts][:resolve_group_membership]).to eq(false)+ end+ endenddiff --git a/spec/lib/theme_settings_validator_spec.rb b/spec/lib/theme_settings_validator_spec.rbindex 61272d09cfc..6e2ca592ac0 100644--- a/spec/lib/theme_settings_validator_spec.rb+++ b/spec/lib/theme_settings_validator_spec.rb@@ -33,4 +33,54 @@ RSpec.describe ThemeSettingsValidator do)endend++ describe ".validate_resolve_group_membership" do+ it "returns error when resolve_group_membership is true on non-list setting" do+ errors =+ described_class.validate_value(+ "test",+ ThemeSetting.types[:string],+ { resolve_group_membership: true },+ )++ expect(errors).to contain_exactly(+ I18n.t("themes.settings_errors.resolve_group_membership_requires_list"),+ )+ end++ it "returns error when resolve_group_membership is true without list_type group" do+ errors =+ described_class.validate_value(+ "a|b|c",+ ThemeSetting.types[:list],+ { resolve_group_membership: true, list_type: "compact" },+ )++ expect(errors).to contain_exactly(+ I18n.t("themes.settings_errors.resolve_group_membership_requires_group_list"),+ )+ end++ it "returns no errors when resolve_group_membership is true with list_type group" do+ errors =+ described_class.validate_value(+ "1|2|3",+ ThemeSetting.types[:list],+ { resolve_group_membership: true, list_type: "group" },+ )++ expect(errors).to eq([])+ end++ it "returns no errors when resolve_group_membership is false" do+ errors =+ described_class.validate_value(+ "test",+ ThemeSetting.types[:string],+ { resolve_group_membership: false },+ )++ expect(errors).to eq([])+ end+ endenddiff --git a/spec/models/theme_field_spec.rb b/spec/models/theme_field_spec.rbindex 49e8b4a3045..3efaab26c7a 100644--- a/spec/models/theme_field_spec.rb+++ b/spec/models/theme_field_spec.rb@@ -726,6 +726,14 @@ RSpec.describe ThemeField do"theme_uploads_local" => {"test_js" => js_field.javascript_cache.local_url,},+ "theme_setting_type_info" => {+ hello: {+ refresh: false,+ resolve_group_membership: false,+ textarea: false,+ type: "string",+ },+ },)# this is important, we do not want local_js_urls to leak into scss@@ -733,6 +741,7 @@ RSpec.describe ThemeField doexpect(theme.scss_variables).to include("$test_js: unquote(\"#{upload.url}\");")expect(theme.scss_variables).not_to include("theme_uploads")+ expect(theme.scss_variables).not_to include("theme_setting_type_info")endenddiff --git a/spec/models/theme_spec.rb b/spec/models/theme_spec.rbindex 86beda7e472..bc8144c4ce8 100644--- a/spec/models/theme_spec.rb+++ b/spec/models/theme_spec.rb@@ -1638,4 +1638,142 @@ RSpec.describe Theme doexpect(theme.system?).to be falseendend++ describe "#resolve_group_settings_for_user" do+ fab!(:user)+ fab!(:group)+ fab!(:other_group, :group)++ before do+ group.add(user)+ yaml = <<~YAML+ member_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{group.id}"+ non_member_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{other_group.id}"+ no_resolve_setting:+ type: list+ list_type: group+ default: "#{group.id}"+ regular_setting:+ type: string+ default: "test"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!+ end++ it "adds user_in_ prefixed boolean for opted-in settings" do+ guardian = user.guardian+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ expect(resolved_settings[:user_in_member_setting]).to eq(true)+ expect(resolved_settings[:user_in_non_member_setting]).to eq(false)+ expect(resolved_settings).not_to have_key(:user_in_no_resolve_setting)+ expect(resolved_settings).not_to have_key(:user_in_regular_setting)+ end++ it "removes original group list when resolve_group_membership is true" do+ guardian = user.guardian+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ # Settings with resolve_group_membership should have group list removed+ expect(resolved_settings).not_to have_key(:member_setting)+ expect(resolved_settings).not_to have_key(:non_member_setting)+ # Settings without resolve_group_membership keep their values+ expect(resolved_settings[:no_resolve_setting]).to eq(group.id.to_s)+ end++ it "handles anonymous users correctly" do+ guardian = Guardian.new+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ # Anonymous users are not in any groups+ expect(resolved_settings[:user_in_member_setting]).to eq(false)+ expect(resolved_settings[:user_in_non_member_setting]).to eq(false)+ end++ it "handles logged_in_users auto-group correctly" do+ yaml = <<~YAML+ logged_in_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{Group::AUTO_GROUPS[:logged_in_users]}"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ guardian = user.guardian+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ expect(resolved_settings[:user_in_logged_in_setting]).to eq(true)+ end++ it "handles anonymous_users auto-group correctly" do+ yaml = <<~YAML+ anonymous_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{Group::AUTO_GROUPS[:anonymous_users]}"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ guardian = Guardian.new+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ # Anonymous users should be in anonymous_users group+ expect(resolved_settings[:user_in_anonymous_setting]).to eq(true)+ end++ it "handles empty group list" do+ yaml = <<~YAML+ empty_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: ""+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ guardian = user.guardian+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ expect(resolved_settings[:user_in_empty_setting]).to eq(false)+ end++ it "handles multiple groups correctly" do+ yaml = <<~YAML+ multi_group_setting:+ type: list+ list_type: group+ resolve_group_membership: true+ default: "#{group.id}|#{other_group.id}"+ YAML+ theme.set_field(target: :settings, name: "yaml", value: yaml)+ theme.save!++ guardian = user.guardian+ settings = theme.cached_settings+ resolved_settings = theme.resolve_group_settings_for_user(settings, guardian)++ # User is in at least one of the groups+ expect(resolved_settings[:user_in_multi_group_setting]).to eq(true)+ end+ endend