A platform for community discussion. Free, open, simple.
FIX: Enforce dependencies when enabling upcoming changes (#43689)
Penar Musaraj4e10ccc071f8
diff --git a/app/services/upcoming_changes/notify_promotion.rb b/app/services/upcoming_changes/notify_promotion.rbindex d5cb81392e9..6211356dbc0 100644--- a/app/services/upcoming_changes/notify_promotion.rb+++ b/app/services/upcoming_changes/notify_promotion.rb@@ -36,6 +36,7 @@ class UpcomingChanges::NotifyPromotionpolicy :setting_is_availablepolicy :change_should_be_displayed+ policy :change_dependencies_metpolicy :meets_or_exceeds_statuspolicy :promotion_not_already_handledpolicy :admin_has_not_manually_toggled@@ -66,6 +67,10 @@ class UpcomingChanges::NotifyPromotionUpcomingChanges::ConditionalDisplay.should_display?(params.setting_name)end+ def change_dependencies_met(params:)+ UpcomingChanges.change_dependencies_met?(params.setting_name)+ end+def meets_or_exceeds_status(params:)UpcomingChanges.meets_or_exceeds_status?(params.setting_name,diff --git a/lib/upcoming_changes.rb b/lib/upcoming_changes.rbindex ef08744b39b..37cc2c79e9a 100644--- a/lib/upcoming_changes.rb+++ b/lib/upcoming_changes.rb@@ -54,6 +54,7 @@ module UpcomingChanges# local logins via email are possible. Must stay visible once enabled so# admins can still find and disable it.def self.should_display_enable_local_logins_via_code?+ return true if SiteSetting.current[:enable_local_logins_via_code]return true if UpcomingChanges.enabled?(:enable_local_logins_via_code)SiteSetting.enable_local_logins && SiteSetting.enable_local_logins_via_email &&@@ -254,6 +255,8 @@ module UpcomingChanges# untouched, so the change resumes when the plugin is re-enabled.return false if !owning_plugin_enabled?(change_setting_name)+ return false if !change_dependencies_met?(change_setting_name)+# An admin has modified the setting and a value is stored# in the database, since the default for upcoming changes# is false.@@ -557,9 +560,8 @@ module UpcomingChangesend# Whether the settings the change itself depends_on (in site_settings.yml)- # currently hold the values the change needs. Used by the admin UI to warn- # admins when a change's prerequisites are not met, since enabling the change- # would have no effect (or be rejected by a validator) until they are.+ # currently hold the values the change needs. Unmet prerequisites prevent+ # the change from taking effect, even after automatic promotion or opt-in.def self.change_dependencies_met?(change_setting_name)dependencies = settings_provider.type_supervisor.dependencies[change_setting_name.to_sym]return true if dependencies.blank?diff --git a/spec/lib/upcoming_changes_spec.rb b/spec/lib/upcoming_changes_spec.rbindex 404944a4962..edb81f65fed 100644--- a/spec/lib/upcoming_changes_spec.rb+++ b/spec/lib/upcoming_changes_spec.rb@@ -529,6 +529,60 @@ RSpec.describe UpcomingChanges doUpcomingChanges.clear_caches!end+ context "when the change has setting dependencies" do+ let(:setting_name) { :enable_local_logins_via_code }++ before do+ mock_upcoming_change_metadata(enable_local_logins_via_code: { status: :beta })+ SiteSetting.promote_upcoming_changes_on_status = :beta+ end++ it "disables auto-promoted code login for anonymous and registered users when email login is disabled" do+ SiteSetting.enable_local_logins_via_email = false++ expect(described_class.change_dependencies_met?(setting_name)).to eq(false)+ expect(described_class.enabled?(setting_name)).to eq(false)+ expect(SiteSetting.enable_local_logins_via_code).to eq(false)+ expect(described_class.enabled_for_user?(setting_name, nil)).to eq(false)+ expect(described_class.enabled_for_user?(setting_name, Fabricate(:user))).to eq(false)+ end++ it "disables auto-promoted code login when local login is disabled" do+ SiteSetting.enable_local_logins = false++ expect(described_class.enabled?(setting_name)).to eq(false)+ end++ it "resumes automatic promotion when dependencies are restored" do+ SiteSetting.enable_local_logins_via_email = false+ expect(described_class.enabled?(setting_name)).to eq(false)++ SiteSetting.enable_local_logins_via_email = true++ expect(described_class.enabled?(setting_name)).to eq(true)+ expect(described_class.enabled_for_user?(setting_name, nil)).to eq(true)+ end++ it "preserves a manual opt-in while dependencies are disabled" do+ SiteSetting.promote_upcoming_changes_on_status = :never+ SiteSetting.enable_local_logins_via_code = true+ SiteSetting.enable_local_logins_via_email = false++ expect(described_class.enabled?(setting_name)).to eq(false)++ SiteSetting.enable_local_logins_via_email = true++ expect(described_class.enabled?(setting_name)).to eq(true)+ end++ it "keeps permanent changes disabled when dependencies are unmet" do+ mock_upcoming_change_metadata(enable_local_logins_via_code: { status: :permanent })+ SiteSetting.enable_local_logins_via_email = false++ expect(described_class.enabled?(setting_name)).to eq(false)+ end+ end+context "when the owning plugin is not configurable" dolet(:plugin_setting_name) { :enable_experimental_sample_plugin_feature }diff --git a/spec/requests/session_controller_spec.rb b/spec/requests/session_controller_spec.rbindex d5a6eaf2939..fd4d7e8ac36 100644--- a/spec/requests/session_controller_spec.rb+++ b/spec/requests/session_controller_spec.rb@@ -568,20 +568,20 @@ RSpec.describe SessionController docontext "when local logins are disabled" dobefore { SiteSetting.enable_local_logins = false }- it "returns a 403" do+ it "returns a 404 because login via code is unavailable" dopost "/session/login-code.json", params: { email: user.email }- expect(response.status).to eq(403)+ expect(response.status).to eq(404)endendcontext "when email login is disabled" dobefore { SiteSetting.enable_local_logins_via_email = false }- it "returns a 403" do+ it "returns a 404 because login via code is unavailable" dopost "/session/login-code.json", params: { email: user.email }- expect(response.status).to eq(403)+ expect(response.status).to eq(404)endend@@ -821,20 +821,20 @@ RSpec.describe SessionController docontext "when local logins are disabled" dobefore { SiteSetting.enable_local_logins = false }- it "returns a 403" do+ it "returns a 404 because login via code is unavailable" dopost "/session/login-code/verify.json", params: { email: user.email, code: "123456" }- expect(response.status).to eq(403)+ expect(response.status).to eq(404)endendcontext "when email login is disabled" dobefore { SiteSetting.enable_local_logins_via_email = false }- it "returns a 403" do+ it "returns a 404 because login via code is unavailable" dopost "/session/login-code/verify.json", params: { email: user.email, code: "123456" }- expect(response.status).to eq(403)+ expect(response.status).to eq(404)endenddiff --git a/spec/services/upcoming_changes/notify_promotion_spec.rb b/spec/services/upcoming_changes/notify_promotion_spec.rbindex d946c3ce25c..464c277e60e 100644--- a/spec/services/upcoming_changes/notify_promotion_spec.rb+++ b/spec/services/upcoming_changes/notify_promotion_spec.rb@@ -105,6 +105,34 @@ RSpec.describe UpcomingChanges::NotifyPromotion doendend+ context "when the change dependencies are not met" do+ let(:setting_name) { :set_locale_from_cookie }++ before do+ SiteSetting.allow_user_locale = false+ mock_upcoming_change_metadata(+ set_locale_from_cookie: {+ impact: "feature,all_members",+ status: :stable,+ },+ )+ end++ it { is_expected.to fail_a_policy(:change_dependencies_met) }++ it "does not notify admins, record a promotion, or trigger an enabled event" do+ events = nil++ expect {+ events = DiscourseEvent.track_events(:upcoming_change_enabled) { result }+ }.to not_change { Notification.count }.and(not_change { UpcomingChangeEvent.count }).and(+ not_change { UserHistory.count },+ )++ expect(events).to be_empty+ end+ end+context "when the change has already been promoted" dolet(:changes_already_promoted) { [:enable_upload_debug_mode] }