Merge branch 'mc/feature/add-limit-offset-branch-names-graphql' into 'master'

Add offset and limit parameters to names resolver

See merge request gitlab-org/gitlab!61061

app/finders/repositories/branch_names_finder.rb

@@ -10,9 +10,9 @@ module Repositories
     end
 
     def execute
-      return unless search
+      return unless search && offset && limit
 
-      repository.search_branch_names(search)
+      repository.search_branch_names(search).lazy.drop(offset).take(limit) # rubocop:disable CodeReuse/ActiveRecord
     end
 
     private
@@ -20,5 +20,13 @@ module Repositories
     def search
       @params[:search].presence
     end
+
+    def offset
+      @params[:offset]
+    end
+
+    def limit
+      @params[:limit]
+    end
   end
 end

app/graphql/resolvers/repository_branch_names_resolver.rb

@@ -10,8 +10,16 @@ module Resolvers
       required: true,
       description: 'The pattern to search for branch names by.'
 
-    def resolve(search_pattern:)
-      Repositories::BranchNamesFinder.new(object, search: search_pattern).execute
+    argument :offset, GraphQL::INT_TYPE,
+      required: true,
+      description: 'The number of branch names to skip.'
+
+    argument :limit, GraphQL::INT_TYPE,
+      required: true,
+      description: 'The number of branch names to return.'
+
+    def resolve(search_pattern:, offset:, limit:)
+      Repositories::BranchNamesFinder.new(object, offset: offset, limit: limit, search: search_pattern).execute
     end
   end
 end

changelogs/unreleased/mc-feature-add-limit-offset-branch-names-graphql.yml

+---
+title: Add offset and limit to branch names resolver.
+merge_request: 61061
+author:
+type: changed

doc/api/graphql/reference/index.md

@@ -11760,6 +11760,8 @@ Returns [`[String!]`](#string).
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
+| <a id="repositorybranchnameslimit"></a>`limit` | [`Int!`](#int) | The number of branch names to return. |
+| <a id="repositorybranchnamesoffset"></a>`offset` | [`Int!`](#int) | The number of branch names to skip. |
 | <a id="repositorybranchnamessearchpattern"></a>`searchPattern` | [`String!`](#string) | The pattern to search for branch names by. |
 
 ##### `Repository.tree`

spec/finders/repositories/branch_names_finder_spec.rb

@@ -5,21 +5,34 @@ require 'spec_helper'
 RSpec.describe Repositories::BranchNamesFinder do
   let(:project) { create(:project, :repository) }
 
-  let(:branch_names_finder) { described_class.new(project.repository, search: 'conflict-*') }
-
   describe '#execute' do
-    subject(:execute) { branch_names_finder.execute }
-
-    it 'filters branch names' do
-      expect(execute).to contain_exactly(
-        'conflict-binary-file',
-        'conflict-resolvable',
-        'conflict-contains-conflict-markers',
-        'conflict-missing-side',
-        'conflict-start',
-        'conflict-non-utf8',
-        'conflict-too-large'
+    it 'returns all filtered branch names' do
+      expect(create_branch_names_finder(0, 100).execute).to contain_exactly(
+        'snippet/edit-file',
+        'snippet/multiple-files',
+        'snippet/no-files',
+        'snippet/rename-and-edit-file',
+        'snippet/single-file'
       )
     end
+
+    it 'returns a limited number of offset filtered branch names' do
+      starting_names = create_branch_names_finder(0, 3).execute
+      offset_names = create_branch_names_finder(3, 2).execute
+
+      expect(starting_names.count).to eq(3)
+      expect(offset_names.count).to eq(2)
+
+      expect(offset_names).not_to include(*starting_names)
+
+      all_names = create_branch_names_finder(0, 100).execute
+      expect(all_names).to contain_exactly(*starting_names, *offset_names)
+    end
+
+    private
+
+    def create_branch_names_finder(offset, limit)
+      described_class.new(project.repository, search: 'snippet/*', offset: offset, limit: limit)
+    end
   end
 end

spec/graphql/resolvers/repository_branch_names_resolver_spec.rb

@@ -8,29 +8,50 @@ RSpec.describe Resolvers::RepositoryBranchNamesResolver do
   let(:project) { create(:project, :repository) }
 
   describe '#resolve' do
-    subject(:resolve_branch_names) do
-      resolve(
-        described_class,
-        obj: project.repository,
-        args: { search_pattern: pattern },
-        ctx: { current_user: project.creator }
-      )
-    end
-
     context 'with empty search pattern' do
       let(:pattern) { '' }
 
       it 'returns nil' do
-        expect(resolve_branch_names).to eq(nil)
+        expect(resolve_branch_names(pattern, 0, 100)).to eq(nil)
       end
     end
 
     context 'with a valid search pattern' do
-      let(:pattern) { 'mas*' }
+      let(:pattern) { 'snippet/*' }
 
       it 'returns matching branches' do
-        expect(resolve_branch_names).to match_array(['master'])
+        expect(resolve_branch_names(pattern, 0, 100)).to contain_exactly(
+          'snippet/edit-file',
+          'snippet/multiple-files',
+          'snippet/no-files',
+          'snippet/rename-and-edit-file',
+          'snippet/single-file'
+        )
+      end
+
+      it 'properly offsets and limits branch name results' do
+        starting_names = resolve_branch_names(pattern, 0, 3)
+        offset_names = resolve_branch_names(pattern, 3, 2)
+
+        expect(starting_names.count).to eq(3)
+        expect(offset_names.count).to eq(2)
+
+        expect(offset_names).not_to include(*starting_names)
+
+        all_names = resolve_branch_names(pattern, 0, 100)
+        expect(all_names).to contain_exactly(*starting_names, *offset_names)
       end
     end
   end
+
+  private
+
+  def resolve_branch_names(pattern, offset, limit)
+    resolve(
+      described_class,
+      obj: project.repository,
+      args: { search_pattern: pattern, offset: offset, limit: limit },
+      ctx: { current_user: project.creator }
+    )
+  end
 end