Merge branch '247636-fix-logging-search-scope' into 'master'

Search: Log search.scope for the default scope

See merge request gitlab-org/gitlab!54684

app/controllers/search_controller.rb

@@ -125,7 +125,7 @@ class SearchController < ApplicationController
     payload[:metadata] ||= {}
     payload[:metadata]['meta.search.group_id'] = params[:group_id]
     payload[:metadata]['meta.search.project_id'] = params[:project_id]
-    payload[:metadata]['meta.search.scope'] = params[:scope]
+    payload[:metadata]['meta.search.scope'] = params[:scope] || @scope
     payload[:metadata]['meta.search.filters.confidential'] = params[:confidential]
     payload[:metadata]['meta.search.filters.state'] = params[:state]
     payload[:metadata]['meta.search.force_search_results'] = params[:force_search_results]

changelogs/unreleased/247636-fix-logging-search-scope.yml

+---
+title: 'Search: Log search.scope for the default scope'
+merge_request: 54684
+author:
+type: fixed

spec/controllers/search_controller_spec.rb

@@ -261,23 +261,29 @@ RSpec.describe SearchController do
 
     describe '#append_info_to_payload' do
       it 'appends search metadata for logging' do
-        last_payload = nil
-        original_append_info_to_payload = controller.method(:append_info_to_payload)
-
-        expect(controller).to receive(:append_info_to_payload) do |payload|
-          original_append_info_to_payload.call(payload)
-          last_payload = payload
+        expect(controller).to receive(:append_info_to_payload).and_wrap_original do |method, payload|
+          method.call(payload)
+
+          expect(payload[:metadata]['meta.search.group_id']).to eq('123')
+          expect(payload[:metadata]['meta.search.project_id']).to eq('456')
+          expect(payload[:metadata]).not_to have_key('meta.search.search')
+          expect(payload[:metadata]['meta.search.scope']).to eq('issues')
+          expect(payload[:metadata]['meta.search.force_search_results']).to eq('true')
+          expect(payload[:metadata]['meta.search.filters.confidential']).to eq('true')
+          expect(payload[:metadata]['meta.search.filters.state']).to eq('true')
         end
 
         get :show, params: { scope: 'issues', search: 'hello world', group_id: '123', project_id: '456', confidential: true, state: true, force_search_results: true }
+      end
+
+      it 'appends the default scope in meta.search.scope' do
+        expect(controller).to receive(:append_info_to_payload).and_wrap_original do |method, payload|
+          method.call(payload)
+
+          expect(payload[:metadata]['meta.search.scope']).to eq('projects')
+        end
 
-        expect(last_payload[:metadata]['meta.search.group_id']).to eq('123')
-        expect(last_payload[:metadata]['meta.search.project_id']).to eq('456')
-        expect(last_payload[:metadata]).not_to have_key('meta.search.search')
-        expect(last_payload[:metadata]['meta.search.scope']).to eq('issues')
-        expect(last_payload[:metadata]['meta.search.force_search_results']).to eq('true')
-        expect(last_payload[:metadata]['meta.search.filters.confidential']).to eq('true')
-        expect(last_payload[:metadata]['meta.search.filters.state']).to eq('true')
+        get :show, params: { search: 'hello world', group_id: '123', project_id: '456' }
       end
     end
   end