Merge branch 'ee-44998-split-admin-settings-into-multiple-sub-pages' into 'master'

EE Port: Split admin settings into subpages

See merge request gitlab-org/gitlab-ee!7371

app/assets/javascripts/pages/admin/application_settings/index.js

 import initSettingsPanels from '~/settings_panels';
 import projectSelect from '~/project_select';
-import UsagePingPayload from './usage_ping_payload';
 
 document.addEventListener('DOMContentLoaded', () => {
   // Initialize expandable settings panels
   initSettingsPanels();
   projectSelect();
-  new UsagePingPayload(
-    document.querySelector('.js-usage-ping-payload-trigger'),
-    document.querySelector('.js-usage-ping-payload'),
-  ).init();
 });

app/assets/javascripts/pages/admin/application_settings/metrics_and_profiling/index.js

+import UsagePingPayload from './../usage_ping_payload';
+
+document.addEventListener('DOMContentLoaded', () => {
+  new UsagePingPayload(
+    document.querySelector('.js-usage-ping-payload-trigger'),
+    document.querySelector('.js-usage-ping-payload'),
+  ).init();
+});

app/controllers/admin/application_settings_controller.rb

 class Admin::ApplicationSettingsController < Admin::ApplicationController
+  include InternalRedirect
   prepend EE::Admin::ApplicationSettingsController
 
   before_action :set_application_setting
@@ -6,6 +7,33 @@ class Admin::ApplicationSettingsController < Admin::ApplicationController
   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
+
+  def geo
+  end
+
+  def preferences
+  end
+
   def update
     successful = ApplicationSettings::UpdateService
       .new(@application_setting, current_user, application_setting_params)
@@ -15,10 +43,12 @@ class Admin::ApplicationSettingsController < Admin::ApplicationController
       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 admin_application_settings_path, notice: 'Application settings saved successfully' }
+        format.html { redirect_to redirect_path, notice: 'Application settings saved successfully' }
       else
         format.json { head :bad_request }
         format.html { render :show }

app/controllers/concerns/internal_redirect.rb

@@ -37,4 +37,10 @@ module InternalRedirect
     path_with_query = [uri.path, uri.query].compact.join('?')
     [path_with_query, uri.fragment].compact.join("#")
   end
+
+  def referer_path(request)
+    return unless request.referer.presence
+
+    URI(request.referer).path
+  end
 end

app/helpers/application_helper.rb

@@ -9,7 +9,15 @@ module ApplicationHelper
   # See https://docs.gitlab.com/ee/development/ee_features.html#code-in-app-views
   # rubocop: disable CodeReuse/ActiveRecord
   def render_if_exists(partial, locals = {})
-    render(partial, locals) if lookup_context.exists?(partial, [], true)
+    render(partial, locals) if partial_exists?(partial)
+  end
+
+  def partial_exists?(partial)
+    lookup_context.exists?(partial, [], true)
+  end
+
+  def template_exists?(template)
+    lookup_context.exists?(template, [], false)
   end
   # rubocop: enable CodeReuse/ActiveRecord
 

app/helpers/application_settings_helper.rb

@@ -265,4 +265,8 @@ module ApplicationSettingsHelper
       :web_ide_clientside_preview_enabled
     ]
   end
+
+  def expanded_by_default?
+    Rails.env.test?
+  end
 end

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

+- breadcrumb_title _("CI/CD")
+- page_title _("CI/CD")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-ci-cd.no-animate#js-ci-cd-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Continuous Integration and Deployment')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Auto DevOps, runners and job artifacts')
+  .settings-content
+    = render 'ci_cd'
+
+- if Gitlab.config.registry.enabled
+  %section.settings.as-registry.no-animate#js-registry-settings{ class: ('expanded' if expanded_by_default?) }
+    .settings-header
+      %h4
+        = _('Container Registry')
+      %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+        = expanded_by_default? ? _('Collapse') : _('Expand')
+      %p
+        = _('Various container registry settings.')
+    .settings-content
+      = render 'registry'

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

+- breadcrumb_title _("Integrations")
+- page_title _("Integrations")
+- @content_class = "limit-container-width" unless fluid_layout
+
+= render_if_exists 'admin/application_settings/elasticsearch_form', expanded: expanded_by_default?
+
+%section.settings.as-plantuml.no-animate#js-plantuml-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('PlantUML')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Allow rendering of PlantUML diagrams in Asciidoc documents.')
+  .settings-content
+    = render 'plantuml'
+
+= render_if_exists 'admin/application_settings/slack', expanded: expanded_by_default?
+
+%section.settings.as-third-party-offers.no-animate#js-third-party-offers-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Third party offers')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Control the display of third party offers.')
+  .settings-content
+    = render 'third_party_offers', application_setting: @application_setting
+
+= render_if_exists 'admin/application_settings/snowplow', expanded: expanded_by_default?

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

+- breadcrumb_title _("Metrics and profiling")
+- page_title _("Metrics and profiling")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-influx.no-animate#js-influx-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Metrics - Influx')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable and configure InfluxDB metrics.')
+  .settings-content
+    = render 'influx'
+
+%section.settings.as-prometheus.no-animate#js-prometheus-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Metrics - Prometheus')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable and configure Prometheus metrics.')
+  .settings-content
+    = render 'prometheus'
+
+%section.settings.as-performance-bar.no-animate#js-performance-bar-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Profiling - Performance bar')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable the Performance Bar for a given group.')
+      = link_to icon('question-circle'), help_page_path('administration/monitoring/performance/performance_bar')
+  .settings-content
+    = render 'performance_bar'
+
+%section.settings.as-usage.no-animate#js-usage-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header#usage-statistics
+    %h4
+      = _('Usage statistics')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable or disable version check and usage ping.')
+  .settings-content
+    = render 'usage'
+
+= render_if_exists 'admin/application_settings/pseudonymizer_settings', expanded: expanded_by_default?

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

+- breadcrumb_title _("Network")
+- page_title _("Network")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-performance.no-animate#js-performance-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Performance optimization')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Various settings that affect GitLab performance.')
+  .settings-content
+    = render 'performance'
+
+%section.settings.as-ip-limits.no-animate#js-ip-limits-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('User and IP Rate Limits')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Configure limits for web and API requests.')
+  .settings-content
+    = render 'ip_limits'
+
+%section.settings.as-outbound.no-animate#js-outbound-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Outbound requests')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Allow requests to the local network from hooks and services.')
+  .settings-content
+    = render 'outbound'

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

+- breadcrumb_title _("Preferences")
+- page_title _("Preferences")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-email.no-animate#js-email-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Email')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Various email settings.')
+  .settings-content
+    = render 'email'
+
+%section.settings.as-help-page.no-animate#js-help-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Help page')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Help page text and support page url.')
+  .settings-content
+    = render 'help_page'
+
+%section.settings.as-pages.no-animate#js-pages-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Pages')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Size and domain settings for static websites')
+  .settings-content
+    = render 'pages'
+
+%section.settings.as-realtime.no-animate#js-realtime-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Real-time features')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Change this value to influence how frequently the GitLab UI polls for updates.')
+  .settings-content
+    = render 'realtime'
+
+%section.settings.as-background.no-animate#js-background-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Background jobs')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Configure Sidekiq job throttling.')
+  .settings-content
+    = render 'background_jobs'
+
+%section.settings.as-gitaly.no-animate#js-gitaly-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Gitaly')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Configure Gitaly timeouts.')
+  .settings-content
+    = render 'gitaly'

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

+- breadcrumb_title _("Reporting")
+- page_title _("Reporting")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-spam.no-animate#js-spam-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Spam and Anti-bot Protection')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable reCAPTCHA or Akismet and set IP limits.')
+  .settings-content
+    = render 'spam'
+
+%section.settings.as-abuse.no-animate#js-abuse-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Abuse reports')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Set notification email for abuse reports.')
+  .settings-content
+    = render 'abuse'
+
+%section.settings.as-logging.no-animate#js-logging-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Error Reporting and Logging')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Enable Sentry for error reporting and logging.')
+  .settings-content
+    = render 'logging'

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

+- breadcrumb_title _("Repository")
+- page_title _("Repository")
+- @content_class = "limit-container-width" unless fluid_layout
+
+%section.settings.as-mirror.no-animate#js-mirror-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Repository mirror')
+    %button.btn.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? 'Collapse' : 'Expand'
+    %p
+      = _('Configure push mirrors.')
+  .settings-content
+    = render partial: 'repository_mirrors_form'
+
+%section.settings.as-repository-storage.no-animate#js-repository-storage-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Repository storage')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Configure storage path and circuit breaker settings.')
+  .settings-content
+    = render 'repository_storage'
+
+%section.settings.as-repository-check.no-animate#js-repository-check-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Repository maintenance')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Configure automatic git checks and housekeeping on repositories.')
+  .settings-content
+    = render 'repository_check'

app/views/layouts/nav/sidebar/_admin.html.haml

@@ -246,10 +246,54 @@
             = sprite_icon('settings')
           %span.nav-item-name
             = _('Settings')
-        %ul.sidebar-sub-level-items.is-fly-out-only
+
+        %ul.sidebar-sub-level-items
           = nav_link(controller: :application_settings, html_options: { class: "fly-out-top-item" } ) do
             = link_to admin_application_settings_path do
               %strong.fly-out-top-item-name
                 = _('Settings')
+            %li.divider.fly-out-top-item
+            = nav_link(path: 'application_settings#show') do
+              = link_to admin_application_settings_path, title: _('General') do
+                %span
+                  = _('General')
+            = nav_link(path: 'application_settings#integrations') do
+              = link_to integrations_admin_application_settings_path, title: _('Integrations') do
+                %span
+                  = _('Integrations')
+            = nav_link(path: 'application_settings#repository') do
+              = link_to repository_admin_application_settings_path, title: _('Repository') do
+                %span
+                  = _('Repository')
+            - if template_exists?('admin/application_settings/templates')
+              = nav_link(path: 'application_settings#templates') do
+                = link_to templates_admin_application_settings_path, title: _('Templates') do
+                  %span
+                    = _('Templates')
+            = nav_link(path: 'application_settings#ci_cd') do
+              = link_to ci_cd_admin_application_settings_path, title: _('CI/CD') do
+                %span
+                  = _('CI/CD')
+            = nav_link(path: 'application_settings#reporting') do
+              = link_to reporting_admin_application_settings_path, title: _('Reporting') do
+                %span
+                  = _('Reporting')
+            = nav_link(path: 'application_settings#metrics_and_profiling') do
+              = link_to metrics_and_profiling_admin_application_settings_path, title: _('Metrics and profiling') do
+                %span
+                  = _('Metrics and profiling')
+            = nav_link(path: 'application_settings#network') do
+              = link_to network_admin_application_settings_path, title: _('Network') do
+                %span
+                  = _('Network')
+            - if template_exists?('admin/application_settings/geo')
+              = nav_link(path: 'application_settings#geo') do
+                = link_to geo_admin_application_settings_path, title: _('Geo') do
+                  %span
+                    = _('Geo')
+            = nav_link(path: 'application_settings#preferences') do
+              = link_to preferences_admin_application_settings_path, title: _('Preferences') do
+                %span
+                  = _('Preferences')
 
     = render 'shared/sidebar_toggle_button'

config/routes/admin.rb

@@ -124,6 +124,7 @@ namespace :admin do
     put :reset_runners_token
     put :reset_health_check_token
     put :clear_repository_check_states
+    get :integrations, :repository, :templates, :ci_cd, :reporting, :metrics_and_profiling, :network, :geo, :preferences
   end
 
   ## EE-specific

ee/app/views/admin/application_settings/geo.html.haml

+- breadcrumb_title "Geo"
+- page_title "Geo"
+- @content_class = "limit-container-width" unless fluid_layout
+
+= render_if_exists 'admin/application_settings/geo', expanded: expanded_by_default?

ee/app/views/admin/application_settings/templates.html.haml

+- breadcrumb_title "Templates"
+- page_title "Templates"
+- @content_class = "limit-container-width" unless fluid_layout
+
+= render_if_exists 'admin/application_settings/templates', expanded: expanded_by_default?
+
+= render_if_exists 'admin/application_settings/custom_templates_form', expanded: expanded_by_default?

ee/spec/features/admin/admin_settings_spec.rb

@@ -7,10 +7,10 @@ describe 'Admin updates EE-only settings' do
     stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false')
     sign_in(create(:admin))
     allow(License).to receive(:feature_available?).and_return(true)
-    visit admin_application_settings_path
   end
 
   it 'Modify GitLab Geo settings' do
+    visit geo_admin_application_settings_path
     page.within('.as-geo') do
       fill_in 'Connection timeout', with: 15
       click_button 'Save changes'
@@ -21,6 +21,7 @@ describe 'Admin updates EE-only settings' do
   end
 
   it 'Enable external authentication' do
+    visit admin_application_settings_path
     page.within('.as-external-auth') do
       check 'Enable classification control using an external service'
       fill_in 'Default classification label', with: 'default'
@@ -31,6 +32,7 @@ describe 'Admin updates EE-only settings' do
   end
 
   it 'Enable elastic search indexing' do
+    visit integrations_admin_application_settings_path
     page.within('.as-elasticsearch') do
       check 'Elasticsearch indexing'
       click_button 'Save changes'
@@ -41,8 +43,9 @@ describe 'Admin updates EE-only settings' do
   end
 
   it 'Enable Slack application' do
+    visit integrations_admin_application_settings_path
     allow(Gitlab).to receive(:com?).and_return(true)
-    visit admin_application_settings_path
+    visit integrations_admin_application_settings_path
 
     page.within('.as-slack') do
       check 'Enable Slack application'
@@ -51,4 +54,22 @@ describe 'Admin updates EE-only settings' do
 
     expect(page).to have_content "Application settings saved successfully"
   end
+
+  context 'Templates page' do
+    before do
+      visit templates_admin_application_settings_path
+    end
+
+    it 'Render "Templates" section' do
+      page.within('.as-visibility-access') do
+        expect(page).to have_content "Templates"
+      end
+    end
+
+    it 'Render "Custom project templates" section' do
+      page.within('.as-custom-project-templates') do
+        expect(page).to have_content "Custom project templates"
+      end
+    end
+  end
 end

ee/spec/features/ci_shared_runner_settings_spec.rb

@@ -47,7 +47,7 @@ describe 'CI shared runner settings' do
   end
 
   def set_admin_shared_runners_minutes(limit)
-    visit admin_application_settings_path
+    visit ci_cd_admin_application_settings_path
 
     page.within('.as-ci-cd') do
       fill_in 'application_setting_shared_runners_minutes', with: limit

locale/gitlab.pot

@@ -2115,15 +2115,12 @@ msgstr ""
 msgid "Configure limits for web and API requests."
 msgstr ""
 
-msgid "Configure push and pull mirrors."
+msgid "Configure push mirrors."
 msgstr ""
 
 msgid "Configure storage path and circuit breaker settings."
 msgstr ""
 
-msgid "Configure the %{link} integration."
-msgstr ""
-
 msgid "Configure the way a user creates a new account."
 msgstr ""
 
@@ -3347,6 +3344,9 @@ msgstr ""
 msgid "Generate a default set of labels"
 msgstr ""
 
+msgid "Geo"
+msgstr ""
+
 msgid "Geo Nodes"
 msgstr ""
 
@@ -4678,6 +4678,9 @@ msgstr ""
 msgid "Metrics - Prometheus"
 msgstr ""
 
+msgid "Metrics and profiling"
+msgstr ""
+
 msgid "Metrics|Business"
 msgstr ""
 
@@ -6307,6 +6310,9 @@ msgstr ""
 msgid "Repo by URL"
 msgstr ""
 
+msgid "Reporting"
+msgstr ""
+
 msgid "Reports|%{failedString} and %{resolvedString}"
 msgstr ""
 

qa/qa/page/admin/settings/main.rb

@@ -6,11 +6,11 @@ module QA
           include QA::Page::Settings::Common
 
           view 'app/views/admin/application_settings/show.html.haml' do
-            element :repository_storage_settings
+            element :terms_settings
           end
 
           def expand_repository_storage(&block)
-            expand_section(:repository_storage_settings) do
+            expand_section(:terms_settings) do
               RepositoryStorage.perform(&block)
             end
           end

spec/features/admin/admin_uses_repository_checks_spec.rb

@@ -33,7 +33,7 @@ describe 'Admin uses repository checks' do
   end
 
   it 'to clear all repository checks', :js do
-    visit admin_application_settings_path
+    visit repository_admin_application_settings_path
 
     expect(RepositoryCheck::ClearWorker).to receive(:perform_async)