Welcome to mirror list, hosted at ThFree Co, Russian Federation.

work_items_by_reference_spec.rb « graphql « api « requests « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: ad2303a81e7a5f453bad6f566c461322f558bca9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'find work items by reference', feature_category: :portfolio_management do
  include GraphqlHelpers

  let_it_be(:current_user) { create(:user) }
  let_it_be(:project) { create(:project, :repository, :public) }
  let_it_be(:group2) { create(:group, :public) }
  let_it_be(:project2) { create(:project, :repository, :public, group: group2) }
  let_it_be(:private_project2) { create(:project, :repository, :private, group: group2) }
  let_it_be(:work_item) { create(:work_item, :task, project: project2) }
  let_it_be(:private_work_item) { create(:work_item, :task, project: private_project2) }

  let(:references) { [work_item.to_reference(full: true), private_work_item.to_reference(full: true)] }

  shared_examples 'response with matching work items' do
    it 'returns accessible work item' do
      post_graphql(query, current_user: current_user)

      expected_items = items.map { |item| a_graphql_entity_for(item) }
      expect(graphql_data_at('workItemsByReference', 'nodes')).to match(expected_items)
    end
  end

  context 'when user has access only to public work items' do
    it_behaves_like 'a working graphql query that returns data' do
      before do
        post_graphql(query, current_user: current_user)
      end
    end

    it_behaves_like 'response with matching work items' do
      let(:items) { [work_item] }
    end

    it 'avoids N+1 queries', :use_sql_query_cache do
      post_graphql(query, current_user: current_user) # warm up

      control_count = ActiveRecord::QueryRecorder.new(skip_cached: false) do
        post_graphql(query, current_user: current_user)
      end
      expect(graphql_data_at('workItemsByReference', 'nodes').size).to eq(1)

      extra_work_items = create_list(:work_item, 2, :task, project: project2)
      refs = references + extra_work_items.map { |item| item.to_reference(full: true) }

      expect do
        post_graphql(query(refs: refs), current_user: current_user)
      end.not_to exceed_all_query_limit(control_count)
      expect(graphql_data_at('workItemsByReference', 'nodes').size).to eq(3)
    end
  end

  context 'when user has access to work items in private project' do
    before_all do
      private_project2.add_guest(current_user)
    end

    it_behaves_like 'response with matching work items' do
      let(:items) { [private_work_item, work_item] }
    end
  end

  context 'when refs includes links' do
    let_it_be(:work_item_with_url) { create(:work_item, :task, project: project2) }
    let(:references) { [work_item.to_reference(full: true), Gitlab::UrlBuilder.build(work_item_with_url)] }

    it_behaves_like 'response with matching work items' do
      let(:items) { [work_item_with_url, work_item] }
    end
  end

  context 'when refs includes a short reference present in the context project' do
    let_it_be(:same_project_work_item) { create(:work_item, :task, project: project) }
    let(:references) { ["##{same_project_work_item.iid}"] }

    it_behaves_like 'response with matching work items' do
      let(:items) { [same_project_work_item] }
    end
  end

  context 'when user cannot access context namespace' do
    it 'returns error' do
      post_graphql(query(namespace_path: private_project2.full_path), current_user: current_user)

      expect(graphql_data_at('workItemsByReference')).to be_nil
      expect(graphql_errors).to contain_exactly(a_hash_including(
        'message' => a_string_including("you don't have permission to perform this action"),
        'path' => %w[workItemsByReference]
      ))
    end
  end

  context 'when the context is a group' do
    it 'returns empty result' do
      group2.add_guest(current_user)
      post_graphql(query(namespace_path: group2.full_path), current_user: current_user)

      expect_graphql_errors_to_be_empty
      expect(graphql_data_at('workItemsByReference', 'nodes')).to be_empty
    end
  end

  context 'when there are more than the max allowed references' do
    let(:references_limit) { ::Resolvers::WorkItemReferencesResolver::REFERENCES_LIMIT }
    let(:references) { (0..references_limit).map { |n| "##{n}" } }
    let(:error_msg) do
      "Number of references exceeds the limit. " \
        "Please provide no more than #{references_limit} references at the same time."
    end

    it 'returns an error message' do
      post_graphql(query, current_user: current_user)

      expect_graphql_errors_to_include(error_msg)
    end
  end

  def query(namespace_path: project.full_path, refs: references)
    fields = <<~GRAPHQL
      nodes {
        #{all_graphql_fields_for('WorkItem', max_depth: 2)}
      }
    GRAPHQL

    graphql_query_for('workItemsByReference', { contextNamespacePath: namespace_path, refs: refs }, fields)
  end
end