Update application settings using correct action

Updating multiple application settings panels through
a single action causes the incorrect action to be shown
when there are errors.  Instead, make each panel action
handle both updating and display.

app/controllers/admin/application_settings_controller.rb

@@ -6,56 +6,19 @@ class Admin::ApplicationSettingsController < Admin::ApplicationController
   before_action :set_application_setting
   before_action :whitelist_query_limiting, only: [:usage_data]
 
-  def show
-  end
-
-  def integrations
-  end
-
-  def repository
-  end
-
-  def templates
-  end
-
-  def ci_cd
-  end
-
-  def reporting
-  end
-
-  def metrics_and_profiling
-  end
-
-  def network
-  end
+  VALID_SETTING_PANELS = %w(show integrations repository templates
+                            ci_cd reporting metrics_and_profiling
+                            network geo preferences).freeze
 
-  def geo
+  def show
   end
 
-  def preferences
+  (VALID_SETTING_PANELS - %w(show)).each do |action|
+    define_method(action) { perform_update if submitted? }
   end
 
   def update
-    successful = ApplicationSettings::UpdateService
-      .new(@application_setting, current_user, application_setting_params)
-      .execute
-
-    if recheck_user_consent?
-      session[:ask_for_usage_stats_consent] = current_user.requires_usage_stats_consent?
-    end
-
-    redirect_path = referer_path(request) || admin_application_settings_path
-
-    respond_to do |format|
-      if successful
-        format.json { head :ok }
-        format.html { redirect_to redirect_path, notice: _('Application settings saved successfully') }
-      else
-        format.json { head :bad_request }
-        format.html { render :show }
-      end
-    end
+    perform_update
   end
 
   def usage_data
@@ -149,6 +112,38 @@ class Admin::ApplicationSettingsController < Admin::ApplicationController
     ]
   end
 
+  def submitted?
+    request.patch?
+  end
+
+  def perform_update
+    successful = ApplicationSettings::UpdateService
+      .new(@application_setting, current_user, application_setting_params)
+      .execute
+
+    if recheck_user_consent?
+      session[:ask_for_usage_stats_consent] = current_user.requires_usage_stats_consent?
+    end
+
+    redirect_path = referer_path(request) || admin_application_settings_path
+
+    respond_to do |format|
+      if successful
+        format.json { head :ok }
+        format.html { redirect_to redirect_path, notice: _('Application settings saved successfully') }
+      else
+        format.json { head :bad_request }
+        format.html { render_update_error }
+      end
+    end
+  end
+
+  def render_update_error
+    action = VALID_SETTING_PANELS.include?(action_name) ? action_name : :show
+
+    render action
+  end
+
   def lets_encrypt_visible_attributes
     return [] unless Feature.enabled?(:pages_auto_ssl)
 

app/views/admin/application_settings/_abuse.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-abuse-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: reporting_admin_application_settings_path(anchor: 'js-abuse-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_ci_cd.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-ci-cd-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: ci_cd_admin_application_settings_path(anchor: 'js-ci-cd-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_email.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-email-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-email-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_gitaly.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-gitaly-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-gitaly-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_help_page.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-help-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-help-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_influx.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-influx-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: metrics_and_profiling_admin_application_settings_path(anchor: 'js-influx-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_ip_limits.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-ip-limits-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: network_admin_application_settings_path(anchor: 'js-ip-limits-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_localization.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-localization-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-localization-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_logging.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-logging-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: reporting_admin_application_settings_path(anchor: 'js-logging-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %p

app/views/admin/application_settings/_outbound.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-outbound-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: network_admin_application_settings_path(anchor: 'js-outbound-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_pages.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-pages-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-pages-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_performance.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-performance-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: network_admin_application_settings_path(anchor: 'js-performance-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_performance_bar.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-performance-bar-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: metrics_and_profiling_admin_application_settings_path(anchor: 'js-performance-bar-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_plantuml.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-plantuml-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: integrations_admin_application_settings_path(anchor: 'js-plantuml-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_prometheus.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-prometheus-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: metrics_and_profiling_admin_application_settings_path(anchor: 'js-prometheus-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_realtime.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-realtime-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: preferences_admin_application_settings_path(anchor: 'js-realtime-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_registry.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-registry-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: ci_cd_admin_application_settings_path(anchor: 'js-registry-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_repository_check.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-repository-check-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: repository_admin_application_settings_path(anchor: 'js-repository-check-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_repository_mirrors_form.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-mirror-settings') do |f|
+= form_for @application_setting, url: repository_admin_application_settings_path(anchor: 'js-mirror-settings') do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_repository_storage.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-repository-storage-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: repository_admin_application_settings_path(anchor: 'js-repository-storage-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_spam.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-spam-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: reporting_admin_application_settings_path(anchor: 'js-spam-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

app/views/admin/application_settings/_third_party_offers.html.haml

 - application_setting = local_assigns.fetch(:application_setting)
 
-= form_for application_setting, url: admin_application_settings_path(anchor: 'js-third-party-offers-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for application_setting, url: integrations_admin_application_settings_path(anchor: 'js-third-party-offers-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(application_setting)
 
   %fieldset

app/views/admin/application_settings/_usage.html.haml

-= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-usage-settings'), html: { class: 'fieldset-form' } do |f|
+= form_for @application_setting, url: metrics_and_profiling_admin_application_settings_path(anchor: 'js-usage-settings'), html: { class: 'fieldset-form' } do |f|
   = form_errors(@application_setting)
 
   %fieldset

changelogs/unreleased/57973-errors-in-application-settings-panel-shows-wrong-panel.yml

+---
+title: Show poper panel when validation error occurs in admin settings panels
+merge_request: 25434
+author:
+type: fixed

config/routes/admin.rb

@@ -110,7 +110,7 @@ namespace :admin do
     put :reset_registration_token
     put :reset_health_check_token
     put :clear_repository_check_states
-    get :integrations, :repository, :templates, :ci_cd, :reporting, :metrics_and_profiling, :network, :geo, :preferences
+    match :integrations, :repository, :templates, :ci_cd, :reporting, :metrics_and_profiling, :network, :geo, :preferences, via: [:get, :patch]
     get :lets_encrypt_terms_of_service
   end
 

spec/controllers/admin/application_settings_controller_spec.rb

@@ -116,6 +116,34 @@ describe Admin::ApplicationSettingsController do
         end
       end
     end
+
+    describe 'verify panel actions' do
+      shared_examples 'renders correct panels' do
+        it 'renders correct action on error' do
+          allow_any_instance_of(ApplicationSettings::UpdateService).to receive(:execute).and_return(false)
+
+          patch action, params: { application_setting: { unused_param: true } }
+
+          expect(subject).to render_template(action)
+        end
+
+        it 'redirects to same panel on success' do
+          allow_any_instance_of(ApplicationSettings::UpdateService).to receive(:execute).and_return(true)
+          referer_path = public_send("#{action}_admin_application_settings_path")
+          request.env["HTTP_REFERER"] = referer_path
+
+          patch action, params: { application_setting: { unused_param: true } }
+
+          expect(subject).to redirect_to(referer_path)
+        end
+      end
+
+      (Admin::ApplicationSettingsController::VALID_SETTING_PANELS - %w(show templates geo)).each do |valid_action|
+        it_behaves_like 'renders correct panels' do
+          let(:action) { valid_action }
+        end
+      end
+    end
   end
 
   describe 'PUT #reset_registration_token' do

spec/features/admin/admin_settings_spec.rb

@@ -379,6 +379,27 @@ describe 'Admin updates settings' do
       expect(page).to have_content "Application settings saved successfully"
     end
 
+    it 'Change Real-time features settings' do
+      page.within('.as-realtime') do
+        fill_in 'Polling interval multiplier', with: 5.0
+        click_button 'Save changes'
+      end
+
+      expect(Gitlab::CurrentSettings.polling_interval_multiplier).to eq 5.0
+      expect(page).to have_content "Application settings saved successfully"
+    end
+
+    it 'shows an error when validation fails' do
+      page.within('.as-realtime') do
+        fill_in 'Polling interval multiplier', with: -1.0
+        click_button 'Save changes'
+      end
+
+      expect(Gitlab::CurrentSettings.polling_interval_multiplier).not_to eq(-1.0)
+      expect(page)
+        .to have_content "The form contains the following error: Polling interval multiplier must be greater than or equal to 0"
+    end
+
     context 'When pages_auto_ssl is enabled' do
       before do
         stub_feature_flags(pages_auto_ssl: true)