Merge branch 'allow-query-jira-projects-by-key-and-name' into 'master'

Query jira projects by key or name

See merge request gitlab-org/gitlab!37799

app/graphql/resolvers/projects/jira_projects_resolver.rb

@@ -16,7 +16,14 @@ module Resolvers
         response = jira_projects(name: name)
 
         if response.success?
-          response.payload[:projects]
+          projects_array = response.payload[:projects]
+
+          GraphQL::Pagination::ArrayConnection.new(
+            projects_array,
+            # override default max_page_size to whatever the size of the response is,
+            # see https://gitlab.com/gitlab-org/gitlab/-/issues/231394
+            args.merge({ max_page_size: projects_array.size })
+          )
         else
           raise Gitlab::Graphql::Errors::BaseError, response.message
         end

app/graphql/types/projects/services/jira_service_type.rb

@@ -13,8 +13,6 @@ module Types
         field :projects,
               Types::Projects::Services::JiraProjectType.connection_type,
               null: true,
-              connection: false,
-              extensions: [Gitlab::Graphql::Extensions::ExternallyPaginatedArrayExtension],
               description: 'List of all Jira projects fetched through Jira REST API',
               resolver: Resolvers::Projects::JiraProjectsResolver
       end

app/services/jira/requests/projects/list_service.rb

@@ -6,7 +6,7 @@ module Jira
       class ListService < Base
         extend ::Gitlab::Utils::Override
 
-        def initialize(jira_service, params: {})
+        def initialize(jira_service, params = {})
           super(jira_service, params)
 
           @query = params[:query]
@@ -33,9 +33,9 @@ module Jira
         end
 
         def match_query?(jira_project)
-          query = query.to_s.downcase
+          downcase_query = query.to_s.downcase
 
-          jira_project&.key&.downcase&.include?(query) || jira_project&.name&.downcase&.include?(query)
+          jira_project&.key&.downcase&.include?(downcase_query) || jira_project&.name&.downcase&.include?(downcase_query)
         end
 
         def empty_payload

changelogs/unreleased/allow-query-jira-projects-by-key-and-name.yml

+---
+title: Query Jira projects by key or name and return all Jira projects in one query
+merge_request: 37799
+author:
+type: fixed

doc/api/graphql/reference/index.md

@@ -1051,7 +1051,6 @@ Autogenerated return type of JiraImportUsers
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
 | `active` | Boolean | Indicates if the service is active |
-| `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API |
 | `type` | String | Class name of the service |
 
 ## JiraUser

spec/graphql/resolvers/projects/jira_projects_resolver_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Resolvers::Projects::JiraProjectsResolver do
       end
     end
 
-    context 'when project has no jira service' do
+    context 'when project has no Jira service' do
       let_it_be(:jira_service) { nil }
 
       context 'when user is a maintainer' do
@@ -29,7 +29,7 @@ RSpec.describe Resolvers::Projects::JiraProjectsResolver do
       end
     end
 
-    context 'when project has jira service' do
+    context 'when project has Jira service' do
       let(:jira_service) { create(:jira_service, project: project) }
 
       context 'when user is a developer' do
@@ -46,10 +46,11 @@ RSpec.describe Resolvers::Projects::JiraProjectsResolver do
         end
 
         context 'when Jira connection is valid' do
-          include_context 'jira projects request context'
+          include_context 'Jira projects request context'
 
-          it 'returns jira projects' do
-            jira_projects = resolve_jira_projects
+          it 'returns Jira projects', :aggregate_failures do
+            resolver = resolve_jira_projects
+            jira_projects = resolver.items
             project_keys = jira_projects.map(&:key)
             project_names = jira_projects.map(&:name)
             project_ids = jira_projects.map(&:id)
@@ -58,6 +59,23 @@ RSpec.describe Resolvers::Projects::JiraProjectsResolver do
             expect(project_keys).to eq(%w(EX ABC))
             expect(project_names).to eq(%w(Example Alphabetical))
             expect(project_ids).to eq(%w(10000 10001))
+            expect(resolver.max_page_size).to eq(2)
+          end
+
+          context 'when filtering projects by name' do
+            it 'returns Jira projects', :aggregate_failures do
+              resolver = resolve_jira_projects({ name: 'ABC' })
+              jira_projects = resolver.items
+              project_keys = jira_projects.map(&:key)
+              project_names = jira_projects.map(&:name)
+              project_ids = jira_projects.map(&:id)
+
+              expect(jira_projects.size).to eq 1
+              expect(project_keys).to eq(%w(ABC))
+              expect(project_names).to eq(%w(Alphabetical))
+              expect(project_ids).to eq(%w(10001))
+              expect(resolver.max_page_size).to eq(1)
+            end
           end
         end
 

spec/requests/api/graphql/project/jira_projects_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe 'query Jira projects' do
   let_it_be(:current_user) { create(:user) }
   let_it_be(:project) { create(:project) }
 
-  include_context 'jira projects request context'
+  include_context 'Jira projects request context'
 
   let(:services) { graphql_data_at(:project, :services, :edges) }
   let(:jira_projects) { services.first.dig('node', 'projects', 'nodes') }

spec/services/jira/requests/projects/list_service_spec.rb

@@ -66,16 +66,28 @@ RSpec.describe Jira::Requests::Projects::ListService do
 
         context 'when the request returns values' do
           before do
-            expect(client).to receive(:get).and_return([{ "key" => 'project1' }, { "key" => 'project2' }])
+            expect(client).to receive(:get).and_return([{ 'key' => 'pr1', 'name' => 'First Project' }, { 'key' => 'pr2', 'name' => 'Second Project' }])
           end
 
-          it 'returns a paylod with jira projets' do
+          it 'returns a paylod with Jira projets' do
             payload = subject.payload
 
             expect(subject.success?).to be_truthy
-            expect(payload[:projects].map(&:key)).to eq(%w(project1 project2))
+            expect(payload[:projects].map(&:key)).to eq(%w(pr1 pr2))
             expect(payload[:is_last]).to be_truthy
           end
+
+          context 'when filtering projects by name' do
+            let(:params) { { query: 'first' } }
+
+            it 'returns a paylod with Jira projets' do
+              payload = subject.payload
+
+              expect(subject.success?).to be_truthy
+              expect(payload[:projects].map(&:key)).to eq(%w(pr1))
+              expect(payload[:is_last]).to be_truthy
+            end
+          end
         end
       end
     end

spec/support/shared_contexts/requests/api/graphql/jira_import/jira_projects_context.rb

 # frozen_string_literal: true
 
-RSpec.shared_context 'jira projects request context' do
+RSpec.shared_context 'Jira projects request context' do
   let(:url) { 'https://jira.example.com' }
   let(:username) { 'jira-username' }
   let(:password) { 'jira-password' }