Merge branch '41763-search-api' into 'master'

Search API

Closes #41763

See merge request gitlab-org/gitlab-ce!16878

5 files changed, 145 insertions, 15 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index f3f64244589..e953f3d2eca 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -146,6 +146,7 @@ module API
     mount ::API::Repositories
     mount ::API::Runner
     mount ::API::Runners
+    mount ::API::Search
     mount ::API::Services
     mount ::API::Settings
     mount ::API::SidekiqMetrics
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index e13463ec66b..7838de13c56 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -314,24 +314,20 @@ module API
       end
     end
 
-    class ProjectSnippet < Grape::Entity
+    class Snippet < Grape::Entity
       expose :id, :title, :file_name, :description
       expose :author, using: Entities::UserBasic
       expose :updated_at, :created_at
-
-      expose :web_url do |snippet, options|
+      expose :project_id
+      expose :web_url do |snippet|
         Gitlab::UrlBuilder.build(snippet)
       end
     end
 
-    class PersonalSnippet < Grape::Entity
-      expose :id, :title, :file_name, :description
-      expose :author, using: Entities::UserBasic
-      expose :updated_at, :created_at
+    class ProjectSnippet < Snippet
+    end
 
-      expose :web_url do |snippet|
-        Gitlab::UrlBuilder.build(snippet)
-      end
+    class PersonalSnippet < Snippet
       expose :raw_url do |snippet|
         Gitlab::UrlBuilder.build(snippet) + "/raw"
       end
@@ -1168,5 +1164,14 @@ module API
     class ApplicationWithSecret < Application
       expose :secret
     end
+
+    class Blob < Grape::Entity
+      expose :basename
+      expose :data
+      expose :filename
+      expose :id
+      expose :ref
+      expose :startline
+    end
   end
 end
diff --git a/lib/api/helpers/pagination.rb b/lib/api/helpers/pagination.rb
index bb70370ba77..09805049169 100644
--- a/lib/api/helpers/pagination.rb
+++ b/lib/api/helpers/pagination.rb
@@ -12,13 +12,16 @@ module API
       private
 
       def add_pagination_headers(paginated_data)
-        header 'X-Total',       paginated_data.total_count.to_s
-        header 'X-Total-Pages', total_pages(paginated_data).to_s
         header 'X-Per-Page',    paginated_data.limit_value.to_s
         header 'X-Page',        paginated_data.current_page.to_s
         header 'X-Next-Page',   paginated_data.next_page.to_s
         header 'X-Prev-Page',   paginated_data.prev_page.to_s
         header 'Link',          pagination_links(paginated_data)
+
+        return if data_without_counts?(paginated_data)
+
+        header 'X-Total',       paginated_data.total_count.to_s
+        header 'X-Total-Pages', total_pages(paginated_data).to_s
       end
 
       def pagination_links(paginated_data)
@@ -37,8 +40,10 @@ module API
         request_params[:page] = 1
         links << %(<#{request_url}?#{request_params.to_query}>; rel="first")
 
-        request_params[:page] = total_pages(paginated_data)
-        links << %(<#{request_url}?#{request_params.to_query}>; rel="last")
+        unless data_without_counts?(paginated_data)
+          request_params[:page] = total_pages(paginated_data)
+          links << %(<#{request_url}?#{request_params.to_query}>; rel="last")
+        end
 
         links.join(', ')
       end
@@ -55,6 +60,10 @@ module API
 
         relation
       end
+
+      def data_without_counts?(paginated_data)
+        paginated_data.is_a?(Kaminari::PaginatableWithoutCount)
+      end
     end
   end
 end
diff --git a/lib/api/search.rb b/lib/api/search.rb
new file mode 100644
index 00000000000..9f08fd96a3b
--- /dev/null
+++ b/lib/api/search.rb
@@ -0,0 +1,115 @@
+module API
+  class Search < Grape::API
+    include PaginationParams
+
+    before { authenticate! }
+
+    helpers do
+      SCOPE_ENTITY = {
+        merge_requests: Entities::MergeRequestBasic,
+        issues: Entities::IssueBasic,
+        projects: Entities::BasicProjectDetails,
+        milestones: Entities::Milestone,
+        notes: Entities::Note,
+        commits: Entities::Commit,
+        blobs: Entities::Blob,
+        wiki_blobs: Entities::Blob,
+        snippet_titles: Entities::Snippet,
+        snippet_blobs: Entities::Snippet
+      }.freeze
+
+      def search(additional_params = {})
+        search_params = {
+          scope: params[:scope],
+          search: params[:search],
+          snippets: snippets?,
+          page: params[:page],
+          per_page: params[:per_page]
+        }.merge(additional_params)
+
+        results = SearchService.new(current_user, search_params).search_objects
+
+        process_results(results)
+      end
+
+      def process_results(results)
+        case params[:scope]
+        when 'wiki_blobs'
+          paginate(results).map { |blob| Gitlab::ProjectSearchResults.parse_search_result(blob) }
+        when 'blobs'
+          paginate(results).map { |blob| blob[1] }
+        else
+          paginate(results)
+        end
+      end
+
+      def snippets?
+        %w(snippet_blobs snippet_titles).include?(params[:scope]).to_s
+      end
+
+      def entity
+        SCOPE_ENTITY[params[:scope].to_sym]
+      end
+    end
+
+    resource :search do
+      desc 'Search on GitLab' do
+        detail 'This feature was introduced in GitLab 10.5.'
+      end
+      params do
+        requires :search, type: String, desc: 'The expression it should be searched for'
+        requires :scope,
+          type: String,
+          desc: 'The scope of search, available scopes:
+            projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs',
+          values: %w(projects issues merge_requests milestones snippet_titles snippet_blobs)
+        use :pagination
+      end
+      get do
+        present search, with: entity
+      end
+    end
+
+    resource :groups, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
+      desc 'Search on GitLab' do
+        detail 'This feature was introduced in GitLab 10.5.'
+      end
+      params do
+        requires :id, type: String, desc: 'The ID of a group'
+        requires :search, type: String, desc: 'The expression it should be searched for'
+        requires :scope,
+          type: String,
+          desc: 'The scope of search, available scopes:
+            projects, issues, merge_requests, milestones',
+          values: %w(projects issues merge_requests milestones)
+        use :pagination
+      end
+      get ':id/-/search' do
+        find_group!(params[:id])
+
+        present search(group_id: params[:id]), with: entity
+      end
+    end
+
+    resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
+      desc 'Search on GitLab' do
+        detail 'This feature was introduced in GitLab 10.5.'
+      end
+      params do
+        requires :id, type: String, desc: 'The ID of a project'
+        requires :search, type: String, desc: 'The expression it should be searched for'
+        requires :scope,
+          type: String,
+          desc: 'The scope of search, available scopes:
+            issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs',
+          values: %w(issues merge_requests milestones notes wiki_blobs commits blobs)
+        use :pagination
+      end
+      get ':id/-/search' do
+        find_project!(params[:id])
+
+        present search(project_id: params[:id]), with: entity
+      end
+    end
+  end
+end
diff --git a/lib/api/v3/projects.rb b/lib/api/v3/projects.rb
index c856ba99f09..7d8b1f369fe 100644
--- a/lib/api/v3/projects.rb
+++ b/lib/api/v3/projects.rb
@@ -174,7 +174,7 @@ module API
           use :pagination
         end
         get "/search/:query", requirements: { query: %r{[^/]+} } do
-          search_service = Search::GlobalService.new(current_user, search: params[:query]).execute
+          search_service = ::Search::GlobalService.new(current_user, search: params[:query]).execute
           projects = search_service.objects('projects', params[:page], false)
           projects = projects.reorder(params[:order_by] => params[:sort])