Merge branch '300203-global-search-timeout-page' into 'master'

Global Search - Timeout Page

See merge request gitlab-org/gitlab!65085

app/controllers/search_controller.rb

@@ -16,6 +16,8 @@ class SearchController < ApplicationController
     search_term_present && !params[:project_id].present?
   end
 
+  rescue_from ActiveRecord::QueryCanceled, with: :render_timeout
+
   layout 'search'
 
   feature_category :global_search
@@ -150,6 +152,15 @@ class SearchController < ApplicationController
 
     redirect_to new_user_session_path, alert: _('You must be logged in to search across all of GitLab')
   end
+
+  def render_timeout(exception)
+    raise exception unless action_name.to_sym == :show
+
+    log_exception(exception)
+
+    @timeout = true
+    render status: :request_timeout
+  end
 end
 
 SearchController.prepend_mod_with('SearchController')

app/helpers/search_helper.rb

@@ -301,7 +301,7 @@ module SearchHelper
 
     if @scope == scope
       li_class = 'active'
-      count = @search_results.formatted_count(scope)
+      count = @timeout ? 0 : @search_results.formatted_count(scope)
     else
       badge_class = 'js-search-count hidden'
       badge_data = { url: search_count_path(search_params) }

app/views/search/_results.html.haml

 - search_bar_classes = 'search-sidebar gl-display-flex gl-flex-direction-column gl-mr-4'
+= render_if_exists 'shared/promotions/promote_advanced_search'
+= render partial: 'search/results_status', locals: { search_service: @search_service } unless @search_objects.to_a.empty?
 
-- if @search_objects.to_a.empty?
-  .gl-md-display-flex
-    - if %w(issues merge_requests).include?(@scope)
-      #js-search-sidebar{ class: search_bar_classes }
-    .gl-w-full.gl-flex-grow-1.gl-overflow-x-hidden
+.results.gl-md-display-flex.gl-mt-3
+  - if %w(issues merge_requests).include?(@scope)
+    #js-search-sidebar{ class: search_bar_classes }
+  .gl-w-full.gl-flex-grow-1.gl-overflow-x-hidden
+    - if @timeout
+      = render partial: "search/results/timeout"
+    - elsif @search_objects.to_a.empty?
       = render partial: "search/results/empty"
-      = render_if_exists 'shared/promotions/promote_advanced_search'
-- else
-  = render partial: 'search/results_status', locals: { search_service: @search_service }
-  = render_if_exists 'shared/promotions/promote_advanced_search'
-
-  .results.gl-md-display-flex.gl-mt-3
-    - if %w(issues merge_requests).include?(@scope)
-      #js-search-sidebar{ class: search_bar_classes }
-    .gl-w-full.gl-flex-grow-1.gl-overflow-x-hidden
+    - else
       - if @scope == 'commits'
         %ul.content-list.commit-list
           = render partial: "search/results/commit", collection: @search_objects

app/views/search/results/_timeout.html.haml

+.gl-display-flex.gl-flex-direction-column.gl-align-items-center
+  %div
+    .svg-content.svg-150
+      = image_tag 'illustrations/search-timeout-md.svg'
+  %div
+    %h4.gl-text-center.gl-font-weight-bold= _('Your search timed out')
+    %p.gl-text-center= _('To resolve this, try to:')
+    %ul
+      %li= html_escape(_('Refine your search criteria (select a %{strong_open}group%{strong_close} and %{strong_open}project%{strong_close} when possible)')) % { strong_open: '<strong>'.html_safe, strong_close: '</strong>'.html_safe }
+      %li= html_escape(_('Use double quotes for multiple keywords, such as %{code_open}"your search"%{code_close}')) % { code_open: '<code>'.html_safe, code_close: '</code>'.html_safe }

ee/spec/features/search/user_searches_for_epics_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe 'User searches for epics', :js do
   end
 
   include_examples 'top right search form'
+  include_examples 'search timeouts', 'epics'
 
   it 'finds an epic' do
     search_for_epic(epic1.title)

locale/gitlab.pot

@@ -26953,6 +26953,9 @@ msgstr ""
 msgid "References"
 msgstr ""
 
+msgid "Refine your search criteria (select a %{strong_open}group%{strong_close} and %{strong_open}project%{strong_close} when possible)"
+msgstr ""
+
 msgid "Refresh"
 msgstr ""
 
@@ -34218,6 +34221,9 @@ msgstr ""
 msgid "To receive alerts from manually configured Prometheus services, add the following URL and Authorization key to your Prometheus webhook config file. Learn more about %{linkStart}configuring Prometheus%{linkEnd} to send alerts to GitLab."
 msgstr ""
 
+msgid "To resolve this, try to:"
+msgstr ""
+
 msgid "To run CI/CD pipelines with JetBrains TeamCity, input the GitLab project details in the TeamCity project Version Control Settings."
 msgstr ""
 
@@ -35474,6 +35480,9 @@ msgstr ""
 msgid "Use custom color #FF0000"
 msgstr ""
 
+msgid "Use double quotes for multiple keywords, such as %{code_open}\"your search\"%{code_close}"
+msgstr ""
+
 msgid "Use hashed storage"
 msgstr ""
 
@@ -38048,6 +38057,9 @@ msgstr ""
 msgid "Your search didn't match any commits. Try a different query."
 msgstr ""
 
+msgid "Your search timed out"
+msgstr ""
+
 msgid "Your sign-in page is %{url}."
 msgstr ""
 

spec/features/search/user_searches_for_code_spec.rb

@@ -37,6 +37,7 @@ RSpec.describe 'User searches for code' do
       end
 
       include_examples 'top right search form'
+      include_examples 'search timeouts', 'blobs'
 
       it 'finds code' do
         fill_in('dashboard_search', with: 'rspec')

spec/features/search/user_searches_for_comments_spec.rb

@@ -13,6 +13,8 @@ RSpec.describe 'User searches for comments' do
     visit(project_path(project))
   end
 
+  include_examples 'search timeouts', 'notes'
+
   context 'when a comment is in commits' do
     context 'when comment belongs to an invalid commit' do
       let(:comment) { create(:note_on_commit, author: user, project: project, commit_id: 12345678, note: 'Bug here') }

spec/features/search/user_searches_for_commits_spec.rb

@@ -14,6 +14,8 @@ RSpec.describe 'User searches for commits', :js do
     visit(search_path(project_id: project.id))
   end
 
+  include_examples 'search timeouts', 'commits'
+
   context 'when searching by SHA' do
     it 'finds a commit and redirects to its page' do
       submit_search(sha)

spec/features/search/user_searches_for_issues_spec.rb

@@ -23,6 +23,7 @@ RSpec.describe 'User searches for issues', :js do
     end
 
     include_examples 'top right search form'
+    include_examples 'search timeouts', 'issues'
 
     it 'finds an issue' do
       search_for_issue(issue1.title)

spec/features/search/user_searches_for_merge_requests_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe 'User searches for merge requests', :js do
   end
 
   include_examples 'top right search form'
+  include_examples 'search timeouts', 'merge_requests'
 
   it 'finds a merge request' do
     search_for_mr(merge_request1.title)

spec/features/search/user_searches_for_milestones_spec.rb

@@ -16,6 +16,7 @@ RSpec.describe 'User searches for milestones', :js do
   end
 
   include_examples 'top right search form'
+  include_examples 'search timeouts', 'milestones'
 
   it 'finds a milestone' do
     fill_in('dashboard_search', with: milestone1.title)

spec/features/search/user_searches_for_projects_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe 'User searches for projects', :js do
       end
 
       include_examples 'top right search form'
+      include_examples 'search timeouts', 'projects'
 
       it 'finds a project' do
         visit(search_path)

spec/features/search/user_searches_for_users_spec.rb

@@ -11,6 +11,8 @@ RSpec.describe 'User searches for users' do
     sign_in(user1)
   end
 
+  include_examples 'search timeouts', 'users'
+
   context 'when on the dashboard' do
     it 'finds the user', :js do
       visit dashboard_projects_path

spec/features/search/user_searches_for_wiki_pages_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe 'User searches for wiki pages', :js do
   end
 
   include_examples 'top right search form'
+  include_examples 'search timeouts', 'wiki_blobs'
 
   shared_examples 'search wiki blobs' do
     it 'finds a page' do

spec/support/shared_examples/features/search/search_timeouts_shared_examples.rb

+# frozen_string_literal: true
+
+RSpec.shared_examples 'search timeouts' do |scope|
+  context 'when search times out' do
+    before do
+      allow_next_instance_of(SearchService) do |service|
+        allow(service).to receive(:search_objects).and_raise(ActiveRecord::QueryCanceled)
+      end
+
+      visit(search_path(search: 'test', scope: scope))
+    end
+
+    it 'renders timeout information' do
+      expect(page).to have_content('Your search timed out')
+    end
+
+    it 'sets tab count to 0' do
+      expect(page.find('.search-filter .active')).to have_text('0')
+    end
+  end
+end